AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . connect ]

describe-data-table

Description

Returns all properties for a data table except for attributes and values. All properties from CreateDataTable are returned as well as properties for region replication, versioning, and system tables. “Describe” is a deprecated term but is allowed to maintain consistency with existing operations.

See also: AWS API Documentation

Synopsis

  describe-data-table
--instance-id <value>
--data-table-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--instance-id (string)

The unique identifier for the Amazon Connect instance.

--data-table-id (string)

The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If no alias is provided, the default behavior is identical to providing the $LATEST alias.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

DataTable -> (structure)

The complete data table information including metadata, configuration, and versioning details.

Name -> (string)

The human-readable name of the data table. Must be unique within the instance and conform to Connect naming standards.

Id -> (string)

The unique identifier for the data table. Does not include version aliases.

Arn -> (string)

The Amazon Resource Name (ARN) for the data table. Does not include version aliases.

TimeZone -> (string)

The IANA timezone identifier used when resolving time based dynamic values. Required even if no time slices are specified.

Description -> (string)

An optional description of the data table’s purpose and contents.

ValueLockLevel -> (string)

The data level that concurrent value edits are locked on. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE, and NONE. Determines how concurrent edits are handled when multiple users attempt to modify values simultaneously.

LockVersion -> (structure)

The lock version information used for optimistic locking and table versioning. Changes with each update to prevent concurrent modification conflicts.

DataTable -> (string)

The lock version for the data table itself. Used for optimistic locking and table versioning. Changes with each update to the table’s metadata or structure.

Attribute -> (string)

The lock version for a specific attribute. When the ValueLockLevel is ATTRIBUTE, this version changes when any value for the attribute changes. For other lock levels, it only changes when the attribute’s properties are directly updated.

PrimaryValues -> (string)

The lock version for a specific set of primary values (record). This includes the default record even if the table does not have any primary attributes. Used for record-level locking.

Value -> (string)

The lock version for a specific value. Changes each time the individual value is modified. Used for the finest-grained locking control.

Version -> (string)

A unique identifier and alias for customer managed versions (not $LATEST or $SAVED).

VersionDescription -> (string)

A description of the customer managed version.

Status -> (string)

The current status of the data table. One of PUBLISHED or SAVED.

CreatedTime -> (timestamp)

The timestamp when the data table was created.

LastModifiedTime -> (timestamp)

The timestamp when the data table or any of its properties were last modified.

LastModifiedRegion -> (string)

The Amazon Web Services Region where the data table was last modified, used for region replication.

Tags -> (map)

Key-value pairs for attribute based access control (TBAC or ABAC) and organization.

key -> (string)

value -> (string)