List DynamoDB tables

Retrieve a list of DynamoDB tables.

Query Parameters

limit int64
Limits the size of the response on each page to the specified number of items.
start string
Sets the page number used to browse the collection. Pages are indexed starting from 1 (i.e., ?start=1).

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
environment_id	$eq	The Clumio-assigned ID of the AWS environment.
name	$contains	The AWS-assigned name of this resource. For example, `?filter={"name":{"$contains":"dev"}}` retrieves all DynamoDB tables with "dev" in their name.
table_native_id	$eq	The AWS-assigned ID of the DynamoDB Table. For example, `?filter={"table_native_id":{"$eq":"07463bd7-7b66-4748-921c-25c9a83c6c3c"}}`
aws_region	$eq	The AWS region of a given account to which this resource belongs. For example, `?filter={"account_native_id":{"$eq":"789901323485"}, "aws_region":{"$eq":"us-east-1"}}` retrieves DynamoDB tables in region us-east-1 in account 789901323485.
account_native_id	$eq	The AWS-assigned ID of the account to which this resource belongs. For example, `?filter={"account_native_id":{"$eq":"789901323485"}}` retrieves DynamoDB tables across all regions in account 789901323485.
tags.id	$all	The Clumio-assigned ID(s) of AWS tag(s) applied to this resource. For example, `?filter={"tags.id":{"$all":["c764b152-5819-11ea-bb9f-b2e1c9a040ad","c764abb6-5819-11ea-bb9f-b2e1c9a040ad"]}}` retrieves all DynamoDB tables that are associated with the 2 AWS tags identified by these IDs. If multiple tags are specified, all of them must be applied to the same DynamoDB table.
protection_info.policy_id	$eq	The Clumio-assigned ID of the policy protecting this resource.
protection_status	$in	The protection status of this resource. Possible values include `protected`, `unprotected`, and `unsupported`.
deactivated	$eq	Filter assets protected by a deactivated policy.
backup_status	$in	The backup status of this resource. Possible values include `success`, `partial_success`, `failure` and `no_backup`.
is_deleted	$eq,$in	The deletion status of this resource. If not specified, retrieves only active DynamoDB tables. `?filter={"is_deleted":{"$in":["true","false"]}}`

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-policy-definition	Embeds the definition of the policy associated with this resource. Unprotected resources will not have an associated policy. For example, `?embed=read-policy-definition`

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-dynamodb-tables=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-policy-definition Embeds the associated policy of a protected resource in the response if requested using the `embed` query parameter. Unprotected resources will not have an associated policy.
Embeds the associated policy of a protected resource in the response if requested using the embed query parameter. Unprotected resources will not have an associated policy.
_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.
create-backup-aws-dynamodb-table 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.
list-backup-aws-dynamodb-tables 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.
read-policy-definition object
A HATEOAS link to the policy protecting this resource. Will be omitted for unprotected entities.
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.
restore-aws-dynamodb-table 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_native_id string
The AWS-assigned ID of the account associated with the DynamoDB table.
aws_region string
The AWS region associated with the DynamoDB table.
backup_status_info object
The backup status information applied to this resource.
backup_status string
BackupStatus is the status of the backup. Possible values are success, partial_success, failure, no_backup, and unknown. This value depends on lookback_days. If not specified, then this field has a value of unknown.
last_failed_policy_start_timestamp string
The last failed policy start time. Represented in RFC-3339 format.
last_successful_policy_start_timestamp string
The last successful policy start time. Represented in RFC-3339 format.
operation_info_list object[]
The policy operation information of the backups.
backup_status string
BackupStatus is the status of the backup. Possible values are success, partial_success, failure, no_backup, and unknown. This value depends on lookback_days. If not specified, then this field has a value of unknown.
last_failed_policy_start_timestamp string
The last failed policy start time. Represented in RFC-3339 format.
last_successful_policy_start_timestamp string
The last successful policy start time. Represented in RFC-3339 format.
operation string
The policy operation type.
billing_mode string
The billing mode of the DynamoDB table. Possible values are PROVISIONED or PAY_PER_REQUEST. For POST /restores/aws/dynamodb, this is defaulted to the configuration of source table if both 'billing_mode' and 'provisioned_throughput' are empty or null.
deletion_timestamp string
The timestamp of when the table was deleted. Represented in RFC-3339 format. If this table has not been deleted, then this field has a value of null.
direct_assignment_policy_id string
The Clumio-assigned ID of the policy directly assigned to the entity.
earliest_continuous_snapshot_restorable_timestamp string
The earliest continuous snapshot restorable time of the DynamoDB table for Point-in-time restore. Represented in RFC-3339 format. If PITR is not enabled for the table, then this field has a value of null.
environment_id string
The Clumio-assigned ID of the AWS environment associated with the DynamoDB table.
global_secondary_indexes object[]
Describes the global secondary indexes of the DynamoDB table. For POST /restores/aws/dynamodb, a subset of the source tables' global_secondary_indexes can be specified. The restored table will not have any global secondary indexes if this is specified empty or null.
index_name string
The name of the global secondary index.
key_schema object[]
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types.
attribute_name string
The name of a key attribute.
key_type string
The role that this key attribute will assume. Possible values include: HASH - partition key and RANGE - sort key.
projection object
Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
non_key_attributes string[]
Represents the non-key attribute names which will be projected into the index. For POST /restores/aws/dynamodb, this must be empty if 'projection_type' is ALL or KEYS_ONLY, and non-empty if 'projection_type' is INCLUDE.
projection_type string
The set of attributes that are projected into the index. Valid Values: ALL, KEYS_ONLY, INCLUDE.
provisioned_throughput object
Represents the provisioned throughput settings for a DynamoDB table.
read_capacity_units int64
The maximum number of strongly consistent reads consumed per second.
write_capacity_units int64
The maximum number of writes consumed per second.
global_table_version string
Describes the version of global tables in use, if the table is replicated across AWS Regions. If the table is not a global table, then this field has a value of null. Possible values are 2017.11.29 or 2019.11.21. For POST /restores/aws/dynamodb, the version is defaulted to 2019.11.21.
has_direct_assignment boolean
Determines whether the table has a direct assignment.
id string
The Clumio-assigned ID of the DynamoDB table.
is_deleted boolean
Determines whether the DynamoDB table has been deleted. If true, the table has been deleted.
is_supported boolean
Determines whether the DynamoDB table is supported for backups.
item_count int64
The number of items in the DynamoDB table.
last_snapshot_timestamp string
The timestamp of the most recent snapshot of the DynamoDB table taken as part of AwsSnapMgr. Represented in RFC-3339 format. If the table has never been snapshotted, then this field has a value of null.
latest_continuous_snapshot_restorable_timestamp string
The latest continuous snapshot restorable time of the DynamoDB table for Point-in-time restore. Represented in RFC-3339 format. If PITR is not enabled for the table, then this field has a value of null.
local_secondary_indexes object[]
Describes the local secondary indexes of the DynamoDB table. For POST /restores/aws/dynamodb, a subset of the source tables' local_secondary_indexes can be specified. The restored table will not have any local secondary indexes if this is specified empty or null.
index_name string
The name of the local secondary index
key_schema object[]
The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types.
attribute_name string
The name of a key attribute.
key_type string
The role that this key attribute will assume. Possible values include: HASH - partition key and RANGE - sort key.
projection object
Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
non_key_attributes string[]
Represents the non-key attribute names which will be projected into the index. For POST /restores/aws/dynamodb, this must be empty if 'projection_type' is ALL or KEYS_ONLY, and non-empty if 'projection_type' is INCLUDE.
projection_type string
The set of attributes that are projected into the index. Valid Values: ALL, KEYS_ONLY, INCLUDE.
name string
The AWS-assigned name of the DynamoDB table.
organizational_unit_id string
The Clumio-assigned ID of the organizational unit associated with the DynamoDB table.
pitr_status boolean
Indicates whether DynamoDB Continuous Backup (PITR) is enabled (true) or disabled (false) on the table. For POST /restores/aws/dynamodb, this is defaulted to the value set in backup if null.
protection_info object
The protection policy applied to this resource. If the resource is not protected, then this field has a value of null.
inheriting_entity_id string
The ID of the entity from which protection was inherited. If protection was not inherited, then this field has a value of null.
inheriting_entity_type string
The type of entity from which protection was inherited. If protection was not inherited, then this field has a value of null.
Entities from which protection can be inherited include the following:

Inheriting Entity Type Details
aws_tag AWS tag.
policy_id string
A system-generated ID assigned to the policy protecting this resource.
protection_status string
The protection status of the DynamoDB table. Possible values include "protected", "unprotected", and "unsupported". If the DynamoDB table does not support backups, then this field has a value of unsupported.
provisioned_throughput object
Represents the provisioned throughput settings for a DynamoDB table.
read_capacity_units int64
The maximum number of strongly consistent reads consumed per second.
write_capacity_units int64
The maximum number of writes consumed per second.
replicas object[]
Describes the replicas of the table, if the table is replicated across AWS Regions. Not applicable for POST /restores/aws/dynamodb currently, but will be used to specify the replication group information in a future release.
global_secondary_indexes object[]
The replica-specific global secondary index settings.
index_name string
The name of the global secondary index.
provisioned_throughput_override object
Replica-specific provisioned throughput settings. If not specified, uses the source table's provisioned throughput settings.
read_capacity_units int64
The maximum number of strongly consistent reads consumed per second.
kms_master_key_id string
The AWS KMS key of the replica that will be used for AWS KMS encryption.
provisioned_throughput_override object
Replica-specific provisioned throughput settings. If not specified, uses the source table's provisioned throughput settings.
read_capacity_units int64
The maximum number of strongly consistent reads consumed per second.
region_name string
The name of the Region.
size int64
The size of the DynamoDB table. Measured in bytes (B).
sse_specification object
Represents the server-side encryption settings for a table.
kms_key_type string
The server-side encryption KMS key type. This field will only be populated for GET /datasources/aws/dynamodb-tables/{table_id} and GET /backups/aws/dynamodb-tables/{backup_id}. For POST /restores/aws/dynamodb, kms_master_key_id must be specified in case of CUSTOMER_MANAGED. Possible values include: DEFAULT, AWS_MANAGED, CUSTOMER_MANAGED.
kms_master_key_id string
The AWS KMS customer master key (CMK) ARN that is used to encrypt the table. If this field is null, server-side encryption is the default encryption (AWS owned CMK). Otherwise, an AWS-managed or customer-managed CMK exists having these values. For POST /restores/aws/dynamodb, use key ID, Amazon Resource Name (ARN), alias name or alias ARN to specify a key to be used for encrypting the restored table. In case of default encryption (AWS owned CMK), specify this as null.
stream_specification object
Represents the DynamoDB Streams configuration for a table in DynamoDB. and the data type (S for string, N for number, B for binary).
enabled boolean
Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
view_type string
When an item in the table is modified, ViewType determines what information is written to the stream for this table. Valid values for ViewType are:

KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.
table_arn string
The AWS-assigned ARN of the DynamoDB table.
table_class string
The table class of the DynamoDB table. Possible values are STANDARD or STANDARD_INFREQUENT_ACCESS. For POST /restores/aws/dynamodb, this is defaulted to the STANDARD storage class if empty.
table_keys object
Represents the DynamoDB table keys.
partition_key object
Represents the attributes within a DynamoDB table by the name and the data type (S for string, N for number, B for binary).
name string
type string
sort_key object
Represents the attributes within a DynamoDB table by the name and the data type (S for string, N for number, B for binary).
name string
type string
table_native_id string
The AWS-assigned ID of the DynamoDB table.
table_status string
The current state of the table.
tags object[]
The AWS tags applied to the DynamoDB table.
id string
The Clumio-assigned ID of the AWS tag.
key string
The AWS-assigned tag key.
key_id string
The Clumio-assigned ID of the AWS key.
value string
The AWS-assigned tag value.
unsupported_reason string
The reason why protection is not available. If the table is supported, then this field has a value of null.
_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.
_last object
The HATEOAS link to the last 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.
_prev object
The HATEOAS link to the previous 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 number used to get this response. Pages are indexed starting from 1 (i.e., "start": "1").
total_count int64
The total number of items, summed across all pages.
total_pages_count int64
The total number of pages of results.

Inheriting Entity Type	Details
aws_tag	AWS tag.

{
  "_embedded": {
    "items": [
      {
        "_embedded": {},
        "_links": {
          "_self": {
            "href": "string",
            "templated": true,
            "type": "string"
          },
          "create-backup-aws-dynamodb-table": {
            "href": "string",
            "templated": true,
            "type": "string"
          },
          "list-backup-aws-dynamodb-tables": {
            "href": "string",
            "templated": true,
            "type": "string"
          },
          "read-policy-definition": {
            "href": "string",
            "templated": true,
            "type": "string"
          },
          "restore-aws-dynamodb-table": {
            "href": "string",
            "templated": true,
            "type": "string"
          }
        },
        "account_native_id": "string",
        "aws_region": "string",
        "backup_status_info": {
          "backup_status": "string",
          "last_failed_policy_start_timestamp": "string",
          "last_successful_policy_start_timestamp": "string",
          "operation_info_list": [
            {
              "backup_status": "string",
              "last_failed_policy_start_timestamp": "string",
              "last_successful_policy_start_timestamp": "string",
              "operation": "string"
            }
          ]
        },
        "billing_mode": "string",
        "deletion_timestamp": "string",
        "direct_assignment_policy_id": "string",
        "earliest_continuous_snapshot_restorable_timestamp": "string",
        "environment_id": "string",
        "global_secondary_indexes": [
          {
            "index_name": "string",
            "key_schema": [
              {
                "attribute_name": "string",
                "key_type": "string"
              }
            ],
            "projection": {
              "non_key_attributes": [
                "string"
              ],
              "projection_type": "string"
            },
            "provisioned_throughput": {
              "read_capacity_units": 0,
              "write_capacity_units": 0
            }
          }
        ],
        "global_table_version": "string",
        "has_direct_assignment": true,
        "id": "string",
        "is_deleted": true,
        "is_supported": true,
        "item_count": 0,
        "last_snapshot_timestamp": "string",
        "latest_continuous_snapshot_restorable_timestamp": "string",
        "local_secondary_indexes": [
          {
            "index_name": "string",
            "key_schema": [
              {
                "attribute_name": "string",
                "key_type": "string"
              }
            ],
            "projection": {
              "non_key_attributes": [
                "string"
              ],
              "projection_type": "string"
            }
          }
        ],
        "name": "string",
        "organizational_unit_id": "string",
        "pitr_status": true,
        "protection_info": {
          "inheriting_entity_id": "string",
          "inheriting_entity_type": "string",
          "policy_id": "string"
        },
        "protection_status": "string",
        "provisioned_throughput": {
          "read_capacity_units": 0,
          "write_capacity_units": 0
        },
        "replicas": [
          {
            "global_secondary_indexes": [
              {
                "index_name": "string",
                "provisioned_throughput_override": {
                  "read_capacity_units": 0
                }
              }
            ],
            "kms_master_key_id": "string",
            "provisioned_throughput_override": {
              "read_capacity_units": 0
            },
            "region_name": "string"
          }
        ],
        "size": 0,
        "sse_specification": {
          "kms_key_type": "string",
          "kms_master_key_id": "string"
        },
        "stream_specification": {
          "enabled": true,
          "view_type": "string"
        },
        "table_arn": "string",
        "table_class": "string",
        "table_keys": {
          "partition_key": {
            "name": "string",
            "type": "string"
          },
          "sort_key": {
            "name": "string",
            "type": "string"
          }
        },
        "table_native_id": "string",
        "table_status": "string",
        "tags": [
          {
            "id": "string",
            "key": "string",
            "key_id": "string",
            "value": "string"
          }
        ],
        "unsupported_reason": "string"
      }
    ]
  },
  "_links": {
    "_first": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_last": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_next": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_prev": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "current_count": 0,
  "limit": 0,
  "start": "string",
  "total_count": 0,
  "total_pages_count": 0
}

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"
    }
  ]
}

GET /datasources/aws/dynamodb-tables

Authorization

Request

Click Edit to configure Base URL

https://us-west-2.api.clumio.com

Bearer Token

limit — query

start — query

filter — query

embed — query

lookback_days — query

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/dynamodb-tables' \
-H 'Accept: application/api.clumio.aws-dynamodb-tables=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/dynamodb-tables' \
-H 'Accept: application/api.clumio.aws-dynamodb-tables=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/dynamodb-tables' \
-H 'Accept: application/api.clumio.aws-dynamodb-tables=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/dynamodb-tables' \
-H 'Accept: application/api.clumio.aws-dynamodb-tables=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/dynamodb-tables' \
-H 'Accept: application/api.clumio.aws-dynamodb-tables=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/dynamodb-tables' \
-H 'Accept: application/api.clumio.aws-dynamodb-tables=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/dynamodb-tables' \
-H 'Accept: application/api.clumio.aws-dynamodb-tables=v1+json' \
-H 'Authorization: Bearer <TOKEN>'