list-data-table-values¶

Description¶

Lists values stored in a data table with optional filtering by record IDs or primary attribute values. Returns the raw stored values along with metadata such as lock versions and modification timestamps.

Synopsis¶

  list-data-table-values
--instance-id <value>
--data-table-id <value>
[--record-ids <value>]
[--primary-attribute-values <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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>]
[--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 whose values should be listed.

Constraints:

min: 1

max: 256

--record-ids (list)

Optional list of specific record IDs to retrieve values for.

(string)

Constraints:

min: 1

max: 256

Syntax:

"string" "string" ...

--primary-attribute-values (list)

Optional filter to retrieve values for records matching specific primary attribute criteria.

(structure)

A primary attribute value filter.

AttributeName -> (string) [required]

The filter’s attribute name.

Constraints:

min: 1

max: 127

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

Values -> (list) [required]

The filter’s values.

(string)

Shorthand Syntax:

AttributeName=string,Values=string,string ...

JSON Syntax:

[
  {
    "AttributeName": "string",
    "Values": ["string", ...]
  }
  ...
]

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

NextToken -> (string)

Specify the pagination token from a previous request to retrieve the next page of results.

Values -> (list)

A list of data table values with their associated metadata, lock versions, and modification details.

(structure)

A data table value summary.

RecordId -> (string)

The summary’s record ID.

Constraints:

min: 1

max: 256

AttributeId -> (string)

The summary’s attribute ID.

Constraints:

min: 1

max: 256

PrimaryValues -> (list) [required]

The summary’s primary values.

(structure)

A primary value response.

AttributeName -> (string)

The value’s attribute name.

Constraints:

min: 1

max: 127

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

AttributeId -> (string)

The value’s attribute ID.

Constraints:

min: 1

max: 256

Value -> (string)

The value’s value.

AttributeName -> (string) [required]

The summary’s attribute name.

Constraints:

min: 1

max: 127

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

ValueType -> (string) [required]

The summary’s value type.

Possible values:

TEXT

NUMBER

BOOLEAN

TEXT_LIST

NUMBER_LIST

Value -> (string) [required]

The summary’s value.

LockVersion -> (structure)

The summary’s lock version.

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.

LastModifiedTime -> (timestamp)

The summary’s last modified time.

LastModifiedRegion -> (string)

The summary’s last modified region.

Constraints:

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

Table of Contents

Feedback

User Guide