Connect / Paginator / ListDataTableValues

ListDataTableValues

class Connect.Paginator.ListDataTableValues

paginator = client.get_paginator('list_data_table_values')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Connect.Client.list_data_table_values().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    DataTableId='string',
    RecordIds=[
        'string',
    ],
    PrimaryAttributeValues=[
        {
            'AttributeName': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• InstanceId (string) –

  [REQUIRED]

  The unique identifier for the Amazon Connect instance.

• DataTableId (string) –

  [REQUIRED]

  The unique identifier for the data table whose values should be listed.

• RecordIds (list) –

  Optional list of specific record IDs to retrieve values for.

  • (string) –

• PrimaryAttributeValues (list) –

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

  • (dict) –

    A primary attribute value filter.

    • AttributeName (string) – [REQUIRED]

      The filter’s attribute name.

    • Values (list) – [REQUIRED]

      The filter’s values.

      • (string) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'Values': [
        {
            'RecordId': 'string',
            'AttributeId': 'string',
            'PrimaryValues': [
                {
                    'AttributeName': 'string',
                    'AttributeId': 'string',
                    'Value': 'string'
                },
            ],
            'AttributeName': 'string',
            'ValueType': 'TEXT'|'NUMBER'|'BOOLEAN'|'TEXT_LIST'|'NUMBER_LIST',
            'Value': 'string',
            'LockVersion': {
                'DataTable': 'string',
                'Attribute': 'string',
                'PrimaryValues': 'string',
                'Value': 'string'
            },
            'LastModifiedTime': datetime(2015, 1, 1),
            'LastModifiedRegion': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • Values (list) –

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

    • (dict) –

      A data table value summary.

      • RecordId (string) –

        The summary’s record ID.

      • AttributeId (string) –

        The summary’s attribute ID.

      • PrimaryValues (list) –

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

      • ValueType (string) –

        The summary’s value type.

      • Value (string) –

        The summary’s value.

      • LockVersion (dict) –

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

        The summary’s last modified time.

      • LastModifiedRegion (string) –

        The summary’s last modified region.