[ 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 | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--instance-id (string) [required]

The unique identifier for the Amazon Connect instance.

Constraints:

• min: 1
• max: 100

--data-table-id (string) [required]

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.

Constraints:

• min: 1
• max: 256

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
• yaml
• yaml-stream

--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.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

DataTable -> (structure)

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

Name -> (string) [required]

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

Constraints:

• min: 1
• max: 127
• pattern: ^[\p{L}\p{Z}\p{N}\-_.:=@'|]+$

Id -> (string) [required]

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

Constraints:

• min: 1
• max: 256

Arn -> (string) [required]

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

TimeZone -> (string) [required]

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.

Constraints:

• min: 0
• max: 250
• pattern: ^[\\P{C}\r\n\t]+$

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.

Possible values:

• NONE
• DATA_TABLE
• PRIMARY_VALUE
• ATTRIBUTE
• VALUE

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).

Constraints:

• min: 0
• max: 128

VersionDescription -> (string)

A description of the customer managed version.

Constraints:

• min: 0
• max: 250
• pattern: ^[\\P{C}\r\n\t]+$

Status -> (string)

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

Possible values:

• PUBLISHED

CreatedTime -> (timestamp)

The timestamp when the data table was created.

LastModifiedTime -> (timestamp) [required]

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

LastModifiedRegion -> (string)

The AWS region where the data table was last modified, used for region replication.

Constraints:

• pattern: [a-z]{2}(-[a-z]+){1,2}(-[0-9])?

Tags -> (map)

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

Constraints:

• min: 1
• max: 50

key -> (string)

Constraints:

• min: 1
• max: 128
• pattern: ^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$

value -> (string)

Constraints:

• max: 256