Inventory

List EC2 instances#

GET /api/organizations/{organization_id}/inventory/ec2

Your EC2 on-demand instances.

Parameters

NameInTypeDescription
organization_idpathstring (uuid)The organization's ID, from the organizations list. Required.
accountquerystring, repeatableOnly the records in these AWS accounts, by 12-digit account ID.
regionquerystring, repeatableOnly the records in these regions. One of 33 values, like us-east-1.
statequerystring, repeatableOnly the records in these states. One of pending, running, shutting-down, stopped, stopping, terminated.
lifecyclequerystring, repeatableOnly the instances with these lifecycles. One of capacity-block, reserved, scheduled, spot, standard.
outdatedquerybooleanOnly previous-generation resources (true), or only current ones (false).

Response

  • summary (object): Totals for the matching records.

    • total (integer): How many records match.
    • accounts (integer): How many accounts they span.
    • regions (integer): How many regions they span.
  • instances (array of objects): The matching instances.

    • id (string): Unique EC2 instance identifier.
    • type (string): EC2 instance type.
    • region (string): AWS region where the instance is located. One of 33 values, like us-east-1.
    • platform (string): Operating system platform.
    • launch_time (string): When the instance last started (ISO 8601); AWS resets it at each stop and start, so it is not the creation date.
    • lifecycle (string): Instance lifecycle type. One of capacity-block, reserved, scheduled, spot, standard.
    • monitoring (string): CloudWatch detailed monitoring status. One of disabled, disabling, enabled, pending.
    • outdated (boolean): Whether the instance type belongs to a previous-generation family superseded by newer generations.
    • managed_by (string): Management method. One of autoscaling, ecs, eks, elasticbeanstalk, standalone.
    • state (string): Current state of the instance. One of pending, running, shutting-down, stopped, stopping, terminated.
    • price (number): Cost of a full month (730 hours) at the on-demand list price, or the latest spot price for a spot instance. It ignores the state and the hours it ran, so a stopped instance still shows a full month.
    • ri_coverage_percentage (number): How much of its usage Reserved Instances covered so far this month, from 0 to 100. AWS reports coverage about 2 days late, so 0 can also mean it has not reported yet.
    • sp_coverage_percentage (number): How much of its usage Savings Plans covered so far this month, from 0 to 100. AWS reports coverage about 2 days late, so 0 can also mean it has not reported yet.
    • tags (map of strings): Key-value pairs assigned to the instance.
    • account_id (string): The 12-digit ID of the AWS account it belongs to.

Errors: 401, 403, 404, 422, 429. See errors.

List RDS instances#

GET /api/organizations/{organization_id}/inventory/rds

Your RDS on-demand instances.

Parameters

NameInTypeDescription
organization_idpathstring (uuid)The organization's ID, from the organizations list. Required.
accountquerystring, repeatableOnly the records in these AWS accounts, by 12-digit account ID.
regionquerystring, repeatableOnly the records in these regions. One of 33 values, like us-east-1.

Response

  • summary (object): Totals for the matching records.

    • total (integer): How many records match.
    • accounts (integer): How many accounts they span.
    • regions (integer): How many regions they span.
  • instances (array of objects): The matching instances.

    • id (string): Unique RDS database instance identifier.
    • type (string): RDS instance type.
    • region (string): AWS region where the instance is located. One of 33 values, like us-east-1.
    • platform (string): Database engine type.
    • platform_version (string): Database engine version.
    • multi_az (boolean): Whether Multi-AZ deployment is enabled.
    • aurora_io (boolean): Whether Aurora I/O-Optimized is enabled.
    • launch_time (string): When the instance was created (ISO 8601).
    • outdated (boolean): Whether the instance type is outdated.
    • performance_insights_enabled (boolean): Whether Performance Insights is enabled.
    • encrypted (boolean): Whether the database is encrypted.
    • price (number): Price for a full month (730 hours) at the on-demand list rate; ignores the hours actually run.
    • ri_coverage_percentage (number): How much of its usage Reserved Instances covered so far this month, from 0 to 100. AWS reports coverage about 2 days late, so 0 can also mean it has not reported yet.
    • sp_coverage_percentage (number): How much of its usage Savings Plans covered so far this month, from 0 to 100. AWS reports coverage about 2 days late, so 0 can also mean it has not reported yet.
    • tags (map of strings): Key-value pairs assigned to the instance.
    • support_status (string): Version support: standard, extended (AWS charges for Extended Support, ESS), or unsupported (retired). One of standard, extended, unsupported.
    • account_id (string): The 12-digit ID of the AWS account it belongs to.

Errors: 401, 403, 404, 422, 429. See errors.

List ElastiCache clusters#

GET /api/organizations/{organization_id}/inventory/elasticache

Your ElastiCache clusters.

Parameters

NameInTypeDescription
organization_idpathstring (uuid)The organization's ID, from the organizations list. Required.
accountquerystring, repeatableOnly the records in these AWS accounts, by 12-digit account ID.
regionquerystring, repeatableOnly the records in these regions. One of 33 values, like us-east-1.
statequerystring, repeatableOnly the records in these states.

Response

  • summary (object): Totals for the matching records.

    • total (integer): How many records match.
    • accounts (integer): How many accounts they span.
    • regions (integer): How many regions they span.
  • clusters (array of objects): The matching clusters.

    • id (string): Unique ElastiCache cluster identifier.
    • region (string): AWS region where the cluster is located. One of 33 values, like us-east-1.
    • type (string): Cache node instance type.
    • platform (string): Cache engine type.
    • nodes_count (number): Number of cache nodes in the cluster.
    • launch_time (string): When the cluster was created (ISO 8601).
    • transit_encryption_enabled (boolean): Whether transit encryption is enabled.
    • at_rest_encryption_enabled (boolean): Whether at-rest encryption is enabled.
    • state (string): Current state of the cluster.
    • outdated (boolean): Whether the instance type is outdated.
    • price (number): Price for a full month (730 hours) at the on-demand list rate, for all nodes; ignores the hours actually run.
    • ri_coverage_percentage (number): How much of its usage Reserved Instances covered so far this month, from 0 to 100. AWS reports coverage about 2 days late, so 0 can also mean it has not reported yet.
    • sp_coverage_percentage (number): How much of its usage Savings Plans covered so far this month, from 0 to 100. AWS reports coverage about 2 days late, so 0 can also mean it has not reported yet.
    • tags (map of strings): Key-value pairs assigned to the cluster.
    • account_id (string): The 12-digit ID of the AWS account it belongs to.

Errors: 401, 403, 404, 422, 429. See errors.

List OpenSearch domains#

GET /api/organizations/{organization_id}/inventory/opensearch

Your OpenSearch domains.

Parameters

NameInTypeDescription
organization_idpathstring (uuid)The organization's ID, from the organizations list. Required.
accountquerystring, repeatableOnly the records in these AWS accounts, by 12-digit account ID.
regionquerystring, repeatableOnly the records in these regions. One of 33 values, like us-east-1.

Response

  • summary (object): Totals for the matching records.

    • total (integer): How many records match.
    • accounts (integer): How many accounts they span.
    • regions (integer): How many regions they span.
  • clusters (array of objects): The matching clusters.

    • id (string): Unique cluster identifier in format account_id/domain_name.
    • region (string): AWS region where the cluster is located. One of 33 values, like us-east-1.
    • data_nodes_type (string): Instance type for data nodes.
    • data_nodes_count (number): Number of data nodes in the cluster.
    • master_nodes_type (string): Instance type for dedicated master nodes.
    • master_nodes_count (number): Number of dedicated master nodes.
    • warm_nodes_type (string): Instance type for warm storage nodes, or "N/A" if not used.
    • warm_nodes_count (number): Number of warm storage nodes in the cluster.
    • platform (string): Search engine platform (e.g., Elasticsearch, OpenSearch).
    • platform_version (string): Search engine version (e.g., 2.13).
    • at_rest_encryption_enabled (boolean): Whether at-rest encryption is enabled.
    • node_to_node_encryption_enabled (boolean): Whether node-to-node encryption is enabled.
    • multi_az (boolean): Whether Multi-AZ deployment is enabled.
    • price (number): Price for a full month (730 hours) at the on-demand list rate, for all data, master and warm nodes; ignores the hours actually run.
    • ri_coverage_percentage (number): How much of its usage Reserved Instances covered so far this month, from 0 to 100. AWS reports coverage about 2 days late, so 0 can also mean it has not reported yet.
    • sp_coverage_percentage (number): How much of its usage Savings Plans covered so far this month, from 0 to 100. AWS reports coverage about 2 days late, so 0 can also mean it has not reported yet.
    • tags (map of strings): Key-value pairs assigned to the domain.
    • support_status (string): Version support: standard, extended (AWS charges for Extended Support, ESS), or unsupported (retired). One of standard, extended, unsupported.
    • account_id (string): The 12-digit ID of the AWS account it belongs to.

Errors: 401, 403, 404, 422, 429. See errors.

List OpenSearch nodes#

GET /api/organizations/{organization_id}/inventory/opensearch/nodes

The nodes of your OpenSearch domains, each with its cluster_id.

Parameters

NameInTypeDescription
organization_idpathstring (uuid)The organization's ID, from the organizations list. Required.
accountquerystring, repeatableOnly the records in these AWS accounts, by 12-digit account ID.
regionquerystring, repeatableOnly the records in these regions.
statequerystring, repeatableOnly the records in these states.
rolequerystring, repeatableOnly the nodes with these roles.
clusterquerystring, repeatableOnly the records of these clusters, by cluster ID.

Response

  • summary (object): Totals for the matching records.

    • total (integer): How many records match.
    • clusters (integer): How many clusters they span.
    • accounts (integer): How many accounts they span.
    • regions (integer): How many regions they span.
  • nodes (array of objects): The matching nodes.

    • id (string): Node identifier.
    • role (string): Node role: data, master, or ultrawarm.
    • availability_zone (string): Availability zone that holds the node.
    • type (string): Instance type of the node, for example r6g.large.search.
    • status (string): Node status: active, standby, or notavailable.
    • storage_type (string): Storage backing: instance or ebs.
    • storage_volume_type (string): EBS volume type, empty for instance storage.
    • storage_size (string): Storage size attached to the node.
    • price (number): Estimated monthly cost of this node.
    • cluster_id (string): The ID of the cluster it belongs to.
    • account_id (string): The 12-digit ID of the AWS account it belongs to.
    • region (string): The region of the cluster it belongs to.

Errors: 401, 403, 404, 422, 429. See errors.

List EKS clusters#

GET /api/organizations/{organization_id}/inventory/eks

Your EKS clusters.

Parameters

NameInTypeDescription
organization_idpathstring (uuid)The organization's ID, from the organizations list. Required.
accountquerystring, repeatableOnly the records in these AWS accounts, by 12-digit account ID.
regionquerystring, repeatableOnly the records in these regions. One of 33 values, like us-east-1.
statequerystring, repeatableOnly the records in these states.

Response

  • summary (object): Totals for the matching records.

    • total (integer): How many records match.
    • accounts (integer): How many accounts they span.
    • regions (integer): How many regions they span.
  • clusters (array of objects): The matching clusters.

    • id (string): Cluster name.
    • arn (string): AWS Amazon Resource Name (ARN) for the cluster.
    • region (string): AWS region where the cluster is located. One of 33 values, like us-east-1.
    • version (string): Kubernetes version running on the cluster.
    • platform_version (string): EKS platform version.
    • status (string): Current status of the cluster.
    • endpoint (string): Kubernetes API server endpoint.
    • price (number): Estimated monthly control plane cost.
    • created_at (string): When the cluster was created (ISO 8601).
    • tags (map of strings): Key-value pairs assigned to the cluster.
    • support_status (string): Version support: standard, extended (AWS charges for Extended Support, ESS), or unsupported (retired). One of standard, extended, unsupported.
    • node_groups (array of objects)

      • id (string): Node group name.
      • arn (string): AWS Amazon Resource Name (ARN) for the node group.
      • region (string): AWS region where the node group is located. One of 33 values, like us-east-1.
      • version (string): Kubernetes version running on the node group.
      • status (string): Current status of the node group.
      • capacity_type (string): Capacity type (ON_DEMAND, SPOT, CAPACITY_BLOCK).
      • ami_type (string): AMI type used by the node group.
      • instance_types (array of strings): EC2 instance types configured for the node group.
      • disk_size (number): Disk size in GiB for worker nodes.
      • scaling_min (number): Minimum number of nodes.
      • scaling_max (number): Maximum number of nodes.
      • scaling_desired (number): Desired number of nodes.
      • labels (map of strings): Kubernetes labels assigned to nodes.
      • auto_scaling_group_names (array of strings): Auto Scaling groups EKS built for this node group.
      • outdated (boolean): True when at least one type in instance_types is previous-generation; the other types can be current.
      • price (number): Estimated monthly cost.
      • created_at (string): When the node group was created (ISO 8601).
      • tags (map of strings): Key-value pairs assigned to the node group.
    • account_id (string): The 12-digit ID of the AWS account it belongs to.

Errors: 401, 403, 404, 422, 429. See errors.

List EKS node groups#

GET /api/organizations/{organization_id}/inventory/eks/nodegroups

The node groups of your EKS clusters, each with its cluster_id.

Parameters

NameInTypeDescription
organization_idpathstring (uuid)The organization's ID, from the organizations list. Required.
accountquerystring, repeatableOnly the records in these AWS accounts, by 12-digit account ID.
regionquerystring, repeatableOnly the records in these regions. One of 33 values, like us-east-1.
statequerystring, repeatableOnly the records in these states.
capacityquerystring, repeatableOnly the node groups with these capacity types.
clusterquerystring, repeatableOnly the records of these clusters, by cluster ID.
outdatedquerybooleanOnly previous-generation resources (true), or only current ones (false).

Response

  • summary (object): Totals for the matching records.

    • total (integer): How many records match.
    • clusters (integer): How many clusters they span.
    • accounts (integer): How many accounts they span.
    • regions (integer): How many regions they span.
  • node_groups (array of objects): The matching node groups.

    • id (string): Node group name.
    • arn (string): AWS Amazon Resource Name (ARN) for the node group.
    • region (string): The region of the cluster it belongs to.
    • version (string): Kubernetes version running on the node group.
    • status (string): Current status of the node group.
    • capacity_type (string): Capacity type (ON_DEMAND, SPOT, CAPACITY_BLOCK).
    • ami_type (string): AMI type used by the node group.
    • instance_types (array of strings): EC2 instance types configured for the node group.
    • disk_size (number): Disk size in GiB for worker nodes.
    • scaling_min (number): Minimum number of nodes.
    • scaling_max (number): Maximum number of nodes.
    • scaling_desired (number): Desired number of nodes.
    • labels (map of strings): Kubernetes labels assigned to nodes.
    • auto_scaling_group_names (array of strings): Auto Scaling groups EKS built for this node group.
    • outdated (boolean): True when at least one type in instance_types is previous-generation; the other types can be current.
    • price (number): Estimated monthly cost.
    • created_at (string): When the node group was created (ISO 8601).
    • tags (map of strings): Key-value pairs assigned to the node group.
    • cluster_id (string): The ID of the cluster it belongs to.
    • account_id (string): The 12-digit ID of the AWS account it belongs to.

Errors: 401, 403, 404, 422, 429. See errors.

List EBS volumes#

GET /api/organizations/{organization_id}/inventory/ebs

Your EBS volumes.

Parameters

NameInTypeDescription
organization_idpathstring (uuid)The organization's ID, from the organizations list. Required.
accountquerystring, repeatableOnly the records in these AWS accounts, by 12-digit account ID.
regionquerystring, repeatableOnly the records in these regions. One of 98 values, like af-south-1.
statequerystring, repeatableOnly the records in these states. One of available, creating, deleted, deleting, error, in-use.

Response

  • summary (object): Totals for the matching records.

    • total (integer): How many records match.
    • accounts (integer): How many accounts they span.
    • regions (integer): How many regions they span.
  • volumes (array of objects): The matching volumes.

    • id (string): Unique EBS volume identifier.
    • type (string): Volume type. One of gp2, gp3, io1, io2, sc1, st1, standard.
    • region (string): AWS region where the volume is located. One of 98 values, like af-south-1.
    • size (number): Volume size in gigabytes (GB).
    • encrypted (boolean): Whether the volume is encrypted.
    • state (string): Current state of the volume. One of available, creating, deleted, deleting, error, in-use.
    • launch_time (string): When the volume was created (ISO 8601).
    • iops (number): Provisioned IOPS (Input/Output Operations Per Second).
    • throughput (number): Throughput performance in MB/s.
    • outdated (boolean): Whether the volume type is outdated and upgradable.
    • price (number): Monthly cost of the volume.
    • tags (map of strings): Key-value pairs assigned to the volume.
    • account_id (string): The 12-digit ID of the AWS account it belongs to.

Errors: 401, 403, 404, 422, 429. See errors.

List S3 buckets#

GET /api/organizations/{organization_id}/inventory/s3

Your S3 buckets.

Parameters

NameInTypeDescription
organization_idpathstring (uuid)The organization's ID, from the organizations list. Required.
accountquerystring, repeatableOnly the records in these AWS accounts, by 12-digit account ID.
regionquerystring, repeatableOnly the records in these regions.

Response

  • summary (object): Totals for the matching records.

    • total (integer): How many records match.
    • accounts (integer): How many accounts they span.
    • regions (integer): How many regions they span.
  • buckets (array of objects): The matching buckets.

    • name (string): Globally unique bucket name.
    • region (string): AWS region the bucket resides in.
    • creation_date (string): When the bucket was created.
    • versioning_enabled (boolean): Whether object versioning is enabled.
    • encryption (string or null): Default server-side encryption algorithm, or null when unencrypted.
    • tags (map of strings): Bucket tags.
    • lifecycle_rules (array of objects)

      • id (string or null): Rule identifier.
      • status (string): 'Enabled' or 'Disabled'.
      • prefix (string or null): Object key prefix the rule applies to.
      • current_version_expiration_days (number or null): Days after which the current object version expires.
      • current_version_expiration_date (string or null): Date on which the current object version expires.
      • previous_versions_expiration_days (number or null): Days after which superseded (noncurrent) versions are permanently deleted.
      • transitions (array of objects)

        • storage_class (string or null): Destination storage class.
        • days (number or null): Days after object creation before transitioning.
        • date (string or null): Absolute date on which to transition.
      • previous_versions_transitions (array of objects)

        • storage_class (string or null): Destination storage class.
        • days (number or null): Days after object creation before transitioning.
        • date (string or null): Absolute date on which to transition.
    • account_id (string): The 12-digit ID of the AWS account it belongs to.

Errors: 401, 403, 404, 422, 429. See errors.

Get CPU utilization#

GET /api/organizations/{organization_id}/inventory/metrics/cpu_utilization

One resource's average CPU utilization for each hour, from the start of the month two months ago.

Parameters

NameInTypeDescription
organization_idpathstring (uuid)The organization's ID, from the organizations list. Required.
accountquerystringThe resource's AWS account ID. Required.
regionquerystringThe resource's region. Required.
namespacequerystringThe CloudWatch namespace of the resource. Required. One of AWS/EC2, AWS/RDS, AWS/ElastiCache.
resourcequerystringThe resource's id, as its inventory endpoint returns it. Required.

Response

  • datapoints (array of objects): The matching datapoints.

    • timestamp (string (date-time)): The start of the hour.
    • value (number): The average CPU utilization in that hour, from 0 to 100.

Errors: 401, 403, 404, 422, 429. See errors.