batch-describe-data-table-value¶

Description¶

Retrieves multiple values from a data table without evaluating expressions. Returns the raw stored values along with metadata such as lock versions and modification timestamps. “Describe” is a deprecated term but is allowed to maintain consistency with existing operations.

Synopsis¶

  batch-describe-data-table-value
--instance-id <value>
--data-table-id <value>
--values <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.

Constraints:

min: 1

max: 256

--values (list) [required]

A list of value identifiers to retrieve, each specifying primary values and attribute names.

(structure)

A data table value identifier.

PrimaryValues -> (list)

The identifier’s primary values.

(structure)

Represents a primary key value used to identify a specific record in a data table. Primary values are used in combination to create unique record identifiers when a table has multiple primary attributes.

AttributeName -> (string) [required]

The name of the primary attribute that this value belongs to.

Constraints:

min: 1

max: 127

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

Value -> (string) [required]

The actual value for the primary attribute. Must be provided as a string regardless of the attribute’s value type. Primary values cannot be expressions and must be explicitly specified.

AttributeName -> (string) [required]

The identifier’s attribute name.

Constraints:

min: 1

max: 127

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

Shorthand Syntax:

PrimaryValues=[{AttributeName=string,Value=string},{AttributeName=string,Value=string}],AttributeName=string ...

JSON Syntax:

[
  {
    "PrimaryValues": [
      {
        "AttributeName": "string",
        "Value": "string"
      }
      ...
    ],
    "AttributeName": "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.

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

Successful -> (list)

A list of successfully retrieved values with their data, metadata, and lock version information.

(structure)

A batch describe data table value success result.

RecordId -> (string) [required]

The result’s record ID.

Constraints:

min: 1

max: 256

AttributeId -> (string) [required]

The result’s attribute ID.

Constraints:

min: 1

max: 256

PrimaryValues -> (list) [required]

The result’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 result’s attribute name.

Constraints:

min: 1

max: 127

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

Value -> (string)

The result’s value.

LockVersion -> (structure) [required]

The result’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 result’s last modified time.

LastModifiedRegion -> (string)

The result’s last modified region.

Constraints:

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

Failed -> (list)

A list of values that failed to be retrieved with error messages explaining the failure reason.

(structure)

A batch describe data table value failure result.

PrimaryValues -> (list) [required]

The result’s primary values.

(structure)

Represents a primary key value used to identify a specific record in a data table. Primary values are used in combination to create unique record identifiers when a table has multiple primary attributes.

AttributeName -> (string) [required]

The name of the primary attribute that this value belongs to.

Constraints:

min: 1

max: 127

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

Value -> (string) [required]

The actual value for the primary attribute. Must be provided as a string regardless of the attribute’s value type. Primary values cannot be expressions and must be explicitly specified.

AttributeName -> (string) [required]

The result’s attribute name.

Constraints:

min: 1

max: 127

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

Message -> (string) [required]

The result’s message.

Table of Contents

Feedback

User Guide