Connect / Client / evaluate_data_table_values

evaluate_data_table_values

Connect.Client.evaluate_data_table_values(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.evaluate_data_table_values(
    InstanceId='string',
    DataTableId='string',
    Values=[
        {
            'PrimaryValues': [
                {
                    'AttributeName': 'string',
                    'Value': 'string'
                },
            ],
            'AttributeNames': [
                'string',
            ]
        },
    ],
    TimeZone='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

    The unique identifier for the Amazon Connect instance.

  • DataTableId (string) –

    [REQUIRED]

    The unique identifier for the data table. Must also accept the table ARN with or without a version alias.

  • Values (list) –

    [REQUIRED]

    A list of value evaluation sets specifying which primary values and attributes to evaluate.

    • (dict) –

      A data table value evaluation set.

      • PrimaryValues (list) –

        The set’s primary values.

        • (dict) –

          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.

          • 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) –

  • TimeZone (string) – Optional IANA timezone identifier to use when resolving time based dynamic values. Defaults to the data table time zone if not provided.

  • NextToken (string) – Specify the pagination token from a previous request to retrieve the next page of results.

  • MaxResults (integer) – The maximum number of data table values to return in one page of results.

Return type:

dict

Returns:

Response Syntax

{
    'Values': [
        {
            'RecordId': 'string',
            'PrimaryValues': [
                {
                    'AttributeName': 'string',
                    'Value': 'string'
                },
            ],
            'AttributeName': 'string',
            'ValueType': 'TEXT'|'NUMBER'|'BOOLEAN'|'TEXT_LIST'|'NUMBER_LIST',
            'Found': True|False,
            'Error': True|False,
            'EvaluatedValue': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Values (list) –

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

      • (dict) –

        A data table evaluated value.

        • RecordId (string) –

          The value’s record ID.

        • PrimaryValues (list) –

          The value’s primary values.

          • (dict) –

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

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

            • Value (string) –

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

          The value’s attribute name.

        • ValueType (string) –

          The value’s value type.

        • Found (boolean) –

          The value’s found.

        • Error (boolean) –

          The value’s error.

        • EvaluatedValue (string) –

          The value’s evaluated value.

    • NextToken (string) –

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

Exceptions