evaluate-data-table-values¶

Description¶

Evaluates values at the time of the request and returns them. It considers the request’s timezone or the table’s timezone, in that order, when accessing time based tables. When a value is accessed, the accessor’s identity and the time of access are saved alongside the value to help identify values that are actively in use. The term “Batch” is not included in the operation name since it does not meet all the criteria for a batch operation as specified in Batch Operations: AWS API Standards.

Synopsis¶

  evaluate-data-table-values
--instance-id <value>
--data-table-id <value>
--values <value>
[--time-zone <value>]
[--next-token <value>]
[--max-results <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 evaluation sets specifying which primary values and attributes to evaluate.

(structure)

A data table value evaluation set.

PrimaryValues -> (list)

The set’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.

AttributeNames -> (list) [required]

The set’s attribute names.

(string)

Constraints:

min: 1

max: 127

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

Shorthand Syntax:

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

JSON Syntax:

[
  {
    "PrimaryValues": [
      {
        "AttributeName": "string",
        "Value": "string"
      }
      ...
    ],
    "AttributeNames": ["string", ...]
  }
  ...
]

--time-zone (string)

Optional IANA timezone identifier to use when resolving time based dynamic values. Defaults to the data table time zone if not provided.

--next-token (string)

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

--max-results (integer)

The maximum number of data table values to return in one page of results.

Constraints:

min: 1

max: 100

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

Values -> (list)

A list of evaluated values with their computed results, error information, and metadata.

(structure)

A data table evaluated value.

RecordId -> (string) [required]

The value’s record ID.

Constraints:

min: 1

max: 256

PrimaryValues -> (list) [required]

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

Constraints:

min: 1

max: 127

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

ValueType -> (string) [required]

The value’s value type.

Possible values:

TEXT

NUMBER

BOOLEAN

TEXT_LIST

NUMBER_LIST

Found -> (boolean) [required]

The value’s found.

Error -> (boolean) [required]

The value’s error.

EvaluatedValue -> (string) [required]

The value’s evaluated value.

NextToken -> (string)