Connect / Client / batch_describe_data_table_value

batch_describe_data_table_value¶

Connect.Client.batch_describe_data_table_value(**kwargs)¶

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.

Request Syntax

response = client.batch_describe_data_table_value(
    InstanceId='string',
    DataTableId='string',
    Values=[
        {
            'PrimaryValues': [
                {
                    'AttributeName': 'string',
                    'Value': 'string'
                },
            ],
            'AttributeName': 'string'
        },
    ]
)

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 identifiers to retrieve, each specifying primary values and attribute names.
- (dict) –
  
  A data table value identifier.
  - PrimaryValues (list) –
    
    The identifier’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.
  - AttributeName (string) – [REQUIRED]
    
    The identifier’s attribute name.

Return type:

dict

Returns:

Response Syntax

{
    'Successful': [
        {
            'RecordId': 'string',
            'AttributeId': 'string',
            'PrimaryValues': [
                {
                    'AttributeName': 'string',
                    'AttributeId': 'string',
                    'Value': 'string'
                },
            ],
            'AttributeName': 'string',
            'Value': 'string',
            'LockVersion': {
                'DataTable': 'string',
                'Attribute': 'string',
                'PrimaryValues': 'string',
                'Value': 'string'
            },
            'LastModifiedTime': datetime(2015, 1, 1),
            'LastModifiedRegion': 'string'
        },
    ],
    'Failed': [
        {
            'PrimaryValues': [
                {
                    'AttributeName': 'string',
                    'Value': 'string'
                },
            ],
            'AttributeName': 'string',
            'Message': 'string'
        },
    ]
}

Response Structure

(dict) –
- Successful (list) –
  
  A list of successfully retrieved values with their data, metadata, and lock version information.
  - (dict) –
    
    A batch describe data table value success result.
    - RecordId (string) –
      
      The result’s record ID.
    - AttributeId (string) –
      
      The result’s attribute ID.
    - PrimaryValues (list) –
      
      The result’s primary values.
      - (dict) –
        
        A primary value response.
        
        AttributeName (string) –
        
        The value’s attribute name.
        
        AttributeId (string) –
        
        The value’s attribute ID.
        
        Value (string) –
        
        The value’s value.
    - AttributeName (string) –
      
      The result’s attribute name.
    - Value (string) –
      
      The result’s value.
    - LockVersion (dict) –
      
      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 (datetime) –
      
      The result’s last modified time.
    - LastModifiedRegion (string) –
      
      The result’s last modified region.
- Failed (list) –
  
  A list of values that failed to be retrieved with error messages explaining the failure reason.
  - (dict) –
    
    A batch describe data table value failure result.
    - PrimaryValues (list) –
      
      The result’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 result’s attribute name.
    - Message (string) –
      
      The result’s message.

batch_describe_data_table_value¶

Request Syntax

Response Syntax

Response Structure

Exceptions