+ 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.1.0).
+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 |
+
|---|---|
| + | 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 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 |
+
| + | The location of a CA Bundle to use when validating SSL certificates. +The |
+
| + | 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. + |
+
| + | Use a The Choices: +
|
+
| + | 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 The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. +Support for the |
+
| + | The name of the table to describe. + |
+
| + | 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 The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. + |
+
| + | The AWS region to use. +For global services such as IAM, Route53 and CloudFront, region is ignored. +The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. +The Support for the |
+
| + | 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 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 |
+
| + | 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 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 |
+
| + | When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. +Choices: +
|
+
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 |
+
|---|---|
| + | The returned table params from the describe API call. +Returned: success + |
+
| + | Contains information about the table archive. +Returned: if any, on table + |
+
| + | The Amazon Resource Name (ARN) of the backup the table was archived to, when applicable in the archival reason. +Returned: always + |
+
| + | The date and time when table archival was initiated by DynamoDB, in UNIX epoch time format. +Returned: always + |
+
| + | The reason DynamoDB archived the table. +Returned: always +Sample: |
+
| + | A list of attributes for describing the key schema for the table and indexes. +Returned: always + |
+
| + | A name for the attribute. +Returned: always + |
+
| + | The data type for the attribute, S (String), N (Number) and B (Binary). +Returned: always + |
+
| + | Controls how you are charged for read and write throughput and how you manage capacity. +Returned: always + |
+
| + | The date and time when the table was created, in UNIX epoch time format. +Returned: always + |
+
| + | Indicates whether deletion protection is enabled (true) or disabled (false) on the table. +Returned: always +Sample: |
+
| + | The global secondary indexes of table. +Returned: if any, on the table + |
+
| + | Represents the version of global tables in use, if the table is replicated across AWS Regions. +Returned: if the table is replicated + |
+
| + | The number of items in the specified table. +Returned: always + |
+
| + | 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 + |
+
| + | The name of a key attribute. +Returned: always + |
+
| + | The role that this key attribute will assume, ‘HASH’ for partition key, ‘RANGE’ for sort key +Returned: always + |
+
| + | The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table. +Returned: if any on the table + |
+
| + | A timestamp, in ISO 8601 format, for this stream. +Returned: if any on the table + |
+
| + | Represents one or more local secondary indexes on the table. +Returned: if any, on the table + |
+
| + | The provisioned throughput settings for the table. +Returned: always +Sample: |
+
| + | Represents replicas of the table. +Returned: if any on the table + |
+
| + | Point in time or source backup time. +Returned: if any, on table + |
+
| + | Indicates if a restore is in progress or not. +Returned: if any, on table + |
+
| + | The Amazon Resource Name (ARN) of the backup from which the table was restored. +Returned: if any, on the table + |
+
| + | The ARN of the source table of the backup that is being restored. +Returned: if any, on the table + |
+
| + | The description of the server-side encryption status on the specified table. +Returned: if any, on table +Sample: |
+
| + | The current DynamoDB Streams configuration for the table. +Returned: if any, on the table + |
+
| + | Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table. +Returned: always +Sample: |
+
| + | 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: |
+
| + | The Amazon Resource Name (ARN) that uniquely identifies the table. +Returned: always + |
+
| + | The table class of the specified table. +Returned: if any on the table +Sample: |
+
| + | Unique identifier for the table for which the backup was created. +Returned: always + |
+
| + | The name of the table. +Returned: always + |
+
| + | The total size of the specified table, in bytes. +Returned: always + |
+
| + | The current state of the table. +Returned: always +Sample: |
+
| + | A dict of tags associated with the DynamoDB table. +Returned: always + |
+