community.aws.dynamodb_table_info module – Returns information about a Dynamo DB table

Note

This module is part of the community.aws collection (version 7.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.aws. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.aws.dynamodb_table_info.

New in community.aws 7.2.0

Synopsis

  • Returns information about the Dynamo DB table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.6

  • boto3 >= 1.26.0

  • botocore >= 1.29.0

Parameters

Parameter

Comments

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

AWS access key ID.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variables may also be used in decreasing order of preference.

The aws_access_key and profile options are mutually exclusive.

The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK.

The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_ACCESS_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

aws_ca_bundle

path

The location of a CA Bundle to use when validating SSL certificates.

The AWS_CA_BUNDLE environment variable may also be used.

aws_config

dictionary

A dictionary to modify the botocore configuration.

Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

debug_botocore_endpoint_logs

boolean

Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook.

The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.

Choices:

  • false ← (default)

  • true

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS.

The AWS_URL or EC2_URL environment variables may also be used, in decreasing order of preference.

The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_URL environment variable has been deprecated and will be removed in a release after 2024-12-01.

name

string / required

The name of the table to describe.

profile

aliases: aws_profile

string

A named AWS profile to use for authentication.

See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

The AWS_PROFILE environment variable may also be used.

The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.

region

aliases: aws_region, ec2_region

string

The AWS region to use.

For global services such as IAM, Route53 and CloudFront, region is ignored.

The AWS_REGION or EC2_REGION environment variables may also be used.

See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

The ec2_region alias has been deprecated and will be removed in a release after 2024-12-01

Support for the EC2_REGION environment variable has been deprecated and will be removed in a release after 2024-12-01.

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

AWS secret access key.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variables may also be used in decreasing order of preference.

The secret_key and profile options are mutually exclusive.

The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK.

The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

AWS STS session token for use with temporary credentials.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variables may also be used in decreasing order of preference.

The security_token and profile options are mutually exclusive.

Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0.

The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY and AWS_SECURITY_TOKEN environment variables has been deprecated and will be removed in a release after 2024-12-01.

validate_certs

boolean

When set to false, SSL certificates will not be validated for communication with the AWS APIs.

Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead.

Choices:

  • false

  • true ← (default)

Notes

Note

  • Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.

  • The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.

Examples

- name: Return information about the DynamoDB table named 'my-table'
  community.aws.dynamodb_table_info:
    name: my-table

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

table

complex

The returned table params from the describe API call.

Returned: success

archival_summary

complex

Contains information about the table archive.

Returned: if any, on table

archival_backup_arn

string

The Amazon Resource Name (ARN) of the backup the table was archived to, when applicable in the archival reason.

Returned: always

archival_date_time

string

The date and time when table archival was initiated by DynamoDB, in UNIX epoch time format.

Returned: always

archival_reason

string

The reason DynamoDB archived the table.

Returned: always

Sample: "INACCESSIBLE_ENCRYPTION_CREDENTIALS"

attribute_definitions

complex

A list of attributes for describing the key schema for the table and indexes.

Returned: always

attribute_name

string

A name for the attribute.

Returned: always

attribute_type

string

The data type for the attribute, S (String), N (Number) and B (Binary).

Returned: always

billing_mode

string

Controls how you are charged for read and write throughput and how you manage capacity.

Returned: always

creation_date_time

string

The date and time when the table was created, in UNIX epoch time format.

Returned: always

deletion_protection_enabled

boolean

Indicates whether deletion protection is enabled (true) or disabled (false) on the table.

Returned: always

Sample: true

global_secondary_indexes

list / elements=dictionary

The global secondary indexes of table.

Returned: if any, on the table

global_table_version

string

Represents the version of global tables in use, if the table is replicated across AWS Regions.

Returned: if the table is replicated

item_count

integer

The number of items in the specified table.

Returned: always

key_schema

complex

A list of key schemas that specify the attributes that make up the primary key of a table, or the key attributes of an index.

Returned: always

attribute_name

string

The name of a key attribute.

Returned: always

key_type

string

The role that this key attribute will assume, ‘HASH’ for partition key, ‘RANGE’ for sort key

Returned: always

latest_stream_arn

string

The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.

Returned: if any on the table

latest_stream_label

string

A timestamp, in ISO 8601 format, for this stream.

Returned: if any on the table

local_secondary_indexes

list / elements=dictionary

Represents one or more local secondary indexes on the table.

Returned: if any, on the table

provisioned_throughput

dictionary

The provisioned throughput settings for the table.

Returned: always

Sample: {"number_of_decreases_today": 0, "read_capacity_units": 1, "write_capacity_units": 1}

replicas

list / elements=dictionary

Represents replicas of the table.

Returned: if any on the table

restore_date_time

string

Point in time or source backup time.

Returned: if any, on table

restore_in_progress

boolean

Indicates if a restore is in progress or not.

Returned: if any, on table

source_backup_arn

string

The Amazon Resource Name (ARN) of the backup from which the table was restored.

Returned: if any, on the table

source_table_arn

string

The ARN of the source table of the backup that is being restored.

Returned: if any, on the table

sse_description

dictionary

The description of the server-side encryption status on the specified table.

Returned: if any, on table

Sample: {}

stream_specification

complex

The current DynamoDB Streams configuration for the table.

Returned: if any, on the table

stream_enabled

boolean

Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

Returned: always

Sample: true

stream_view_type

string

When an item in the table is modified, stream_view_type determines what information is written to the stream for this table.

Returned: always

Sample: "KEYS_ONLY"

table_arn

string

The Amazon Resource Name (ARN) that uniquely identifies the table.

Returned: always

table_class

string

The table class of the specified table.

Returned: if any on the table

Sample: "STANDARD_INFREQUENT_ACCESS"

table_id

string

Unique identifier for the table for which the backup was created.

Returned: always

table_name

string

The name of the table.

Returned: always

table_size_bytes

integer

The total size of the specified table, in bytes.

Returned: always

table_status

string

The current state of the table.

Returned: always

Sample: "ACTIVE"

tags

dictionary

A dict of tags associated with the DynamoDB table.

Returned: always

Authors

  • Aubin Bikouo (@abikouo)