List AWS environments

Returns a list of AWS environments.

Query Parameters

limit int64
Limits the size of the response on each page to the specified number of items.
start string
Sets the page token used to browse the collection. Leave this parameter empty to get the first page. Other pages can be traversed using HATEOAS links.

filter string

Narrows down the results to only the items that satisfy the filter criteria. The following table lists the supported filter fields for this resource and the filter conditions that can be applied on those fields:

Field	Filter Condition	Description
account_native_id	$eq, $begins_with	The AWS-assigned ID of the account associated with the environment. For example, `?filter={"account_native_id":{"$eq":"891106098885"}}`
aws_region	$eq	The AWS region associated with the environment. For example, `?filter={"aws_region":{"$eq":"us-west-2"}}`.
connection_status	$eq	The status of the connection to the environment, which is mediated by a CloudFormation stack. Possible values include "installed". For example, `?filter={"connection_status":{"$eq":"installed"}}`
services_enabled	$contains	The AWS services enabled for this environment. This is case insensitive. Possible values include "EBS", "RDS" and "DynamoDB". For example, `?filter={"services_enabled":{"$contains":"RDS"}}`.

For more information about filtering, refer to the Filtering section of this guide.

embed string

Embeds the details of each associated resource. Set the parameter to one of the following embeddable links to include additional details associated with the resource.

Embeddable Link	Description
read-aws-environment-ebs-volumes-protection-stats	Embeds protection stats about EBS Volumes for each AWS environment into the response. For example, `?embed=read-aws-environment-ebs-volumes-protection-stats`
read-aws-environment-ec2-instances-protection-stats	Embeds protection stats about EC2 Instance for each AWS environment into the response. For example, `?embed=read-aws-environment-ec2-instances-protection-stats`
read-aws-environment-ec2-mssql-protection-stats	Embeds protection stats about EC2 MSSQL for each AWS environment into the response. For example, `?embed=read-aws-environment-ec2-mssql-protection-stats`
read-aws-environment-rds-resources-protection-stats	Embeds protection stats about RDS Instance for each AWS environment into the response. For example, `?embed=read-aws-environment-rds-resources-protection-stats`
read-aws-environment-dynamodb-tables-protection-stats	Embeds protection stats about DynamoDB tables for each AWS environment into the response. For example, `?embed=read-aws-environment-dynamodb-tables-protection-stats`
read-aws-environment-protection-groups-protection-stats	Embeds protection stats about Protection Group for each AWS environment into the response. For example, `?embed=read-aws-environment-protection-groups-protection-stats`
read-aws-environments-backup-status-stats	Embeds backup statistics for each AWS environment into the response. For example, `?embed=read-aws-environments-backup-status-stats`

For more information about embedded links, refer to the Embedding Referenced Resources section of this guide.

lookback_days int64
Calculate backup status for the last lookback_days days.

Responses

200
default

Success

application/api.clumio.aws-environments=v1+json

Schema
Example (from schema)

Schema

_embedded object
Embedded responses related to the resource.
items object[]
A collection of requested items.
_embedded object
Embedded responses related to the resource.
read-aws-environments-backup-status-stats
Backup statistics for each AWS environment.
_links object
URLs to pages related to the resource.
_self object
The HATEOAS link to this resource.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
read-organizational-unit object
A resource-specific HATEOAS link.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
account_name string
The name given to the account.
account_native_id string
The AWS-assigned ID of the account associated with the environment.
aws_az string[]
The valid AWS availability zones for the environment. For example, us_west-2a.
aws_region string
The AWS region associated with the environment. For example, us-west-2.
config object
The consolidated configuration of the Clumio Cloud Protect and Clumio Cloud Discover products for this connection. If this connection is deprecated to use unconsolidated configuration, then this field has a value of null.
asset_types_enabled string[]
The asset types supported on the current version of the feature
dynamodb object
DynamodbAssetInfo The installed information for the DynamoDB feature.
installed_template_version string
The current version of the feature.
ebs object
EbsAssetInfo The installed information for the EBS feature.
installed_template_version string
The current version of the feature.
ec2 object
Ec2AssetInfo The installed information for the EC2 feature.
installed_template_version string
The current version of the feature.
ec2_mssql object
EC2MSSQLProtectConfig The installed information for the EC2_MSSQL feature.
installed_template_version string
The current version of the feature.
installed_template_version string
The current version of the feature.
rds object
RdsAssetInfo The installed information for the RDS feature.
installed_template_version string
The current version of the feature.
s3 object
S3AssetInfo The installed information for the S3 feature.
installed_template_version string
The current version of the feature.
warm_tier_protect object
The configuration of the Clumio Cloud Warm-Tier Protect product for this connection.
dynamodb object
DynamodbAssetInfo The installed information for the DynamoDB feature.
installed_template_version string
The current version of the feature.
installed_template_version string
The current version of the feature.
connection_group_id string
Clumio assigned ID of the associated connection group (if any).
connection_id string
The Clumio-assigned ID of the connection associated with the environment.
connection_management_status string
Possible values: [managed, unmanaged]
Management status of connection for the environment.
connection_status string
The status of the connection to the environment.
description string
The user-provided account description.
id string
The Clumio-assigned ID of the environment.
organizational_unit_id string
The Clumio-assigned ID of the organizational unit associated with the environment.
services_enabled string[]
The AWS services enabled for this environment. Possible values include "ebs", "rds" and "dynamodb".
template_version int64
The Clumio CloudFormation template version used to deploy the CloudFormation stack.
_links object
URLs to pages related to the resource.
_first object
The HATEOAS link to the first page of results.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
_next object
The HATEOAS link to the next page of results.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
_self object
The HATEOAS link to this resource.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
current_count int64
The number of items listed on the current page.
limit int64
The maximum number of items displayed per page in the response.
start string
The page token used to get this response.

{
  "_embedded": {
    "items": [
      {
        "_embedded": {},
        "_links": {
          "_self": {
            "href": "string",
            "templated": true,
            "type": "string"
          },
          "read-organizational-unit": {
            "href": "string",
            "templated": true,
            "type": "string"
          }
        },
        "account_name": "string",
        "account_native_id": "string",
        "aws_az": [
          "string"
        ],
        "aws_region": "string",
        "config": {
          "asset_types_enabled": [
            "string"
          ],
          "dynamodb": {
            "installed_template_version": "string"
          },
          "ebs": {
            "installed_template_version": "string"
          },
          "ec2": {
            "installed_template_version": "string"
          },
          "ec2_mssql": {
            "installed_template_version": "string"
          },
          "installed_template_version": "string",
          "rds": {
            "installed_template_version": "string"
          },
          "s3": {
            "installed_template_version": "string"
          },
          "warm_tier_protect": {
            "dynamodb": {
              "installed_template_version": "string"
            },
            "installed_template_version": "string"
          }
        },
        "connection_group_id": "string",
        "connection_id": "string",
        "connection_management_status": "managed",
        "connection_status": "string",
        "description": "string",
        "id": "string",
        "organizational_unit_id": "string",
        "services_enabled": [
          "string"
        ],
        "template_version": 0
      }
    ]
  },
  "_links": {
    "_first": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_next": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "current_count": 0,
  "limit": 0,
  "start": "string"
}

Error

application/json

Schema
Example (from schema)

Schema

errors object[]
A list of errors encountered during runtime.
error_code uint32
error_message string
The reason for the error.

{
  "errors": [
    {
      "error_code": 0,
      "error_message": "string"
    }
  ]
}

List AWS environments​

List AWS environments