Connect / Paginator / SearchDataTables

SearchDataTables¶

class Connect.Paginator.SearchDataTables¶

paginator = client.get_paginator('search_data_tables')

paginate(**kwargs)¶

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

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    SearchFilter={
        'AttributeFilter': {
            'OrConditions': [
                {
                    'TagConditions': [
                        {
                            'TagKey': 'string',
                            'TagValue': 'string'
                        },
                    ]
                },
            ],
            'AndCondition': {
                'TagConditions': [
                    {
                        'TagKey': 'string',
                        'TagValue': 'string'
                    },
                ]
            },
            'TagCondition': {
                'TagKey': 'string',
                'TagValue': 'string'
            }
        }
    },
    SearchCriteria={
        'OrConditions': [
            {'... recursive ...'},
        ],
        'AndConditions': [
            {'... recursive ...'},
        ],
        'StringCondition': {
            'FieldName': 'string',
            'Value': 'string',
            'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
        }
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

InstanceId (string) –
[REQUIRED]

The unique identifier for the Amazon Connect instance to search within.
SearchFilter (dict) –
Optional filters to apply to the search results, such as tag-based filtering for attribute-based access control.
- AttributeFilter (dict) –
  
  An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR or AND (List of List) input where:
  - The top level list specifies conditions that need to be applied with OR operator.
  - The inner list specifies conditions that need to be applied with AND operator.
  - OrConditions (list) –
    
    A list of conditions which would be applied together with an OR condition.
    - (dict) –
      
      A list of conditions which would be applied together with an AND condition.
      - TagConditions (list) –
        
        A leaf node condition which can be used to specify a tag condition.
        
        (dict) –
        
        A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
        
        TagKey (string) –
        
        The tag key in the tag condition.
        
        TagValue (string) –
        
        The tag value in the tag condition.
  - AndCondition (dict) –
    
    A list of conditions which would be applied together with an AND condition.
    - TagConditions (list) –
      
      A leaf node condition which can be used to specify a tag condition.
      - (dict) –
        
        A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
        
        TagKey (string) –
        
        The tag key in the tag condition.
        
        TagValue (string) –
        
        The tag value in the tag condition.
  - TagCondition (dict) –
    
    A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
    - TagKey (string) –
      
      The tag key in the tag condition.
    - TagValue (string) –
      
      The tag value in the tag condition.
SearchCriteria (dict) –
Search criteria including string conditions for matching table names, descriptions, or resource IDs. Supports STARTS_WITH, CONTAINS, and EXACT comparison types.
- OrConditions (list) –
  
  The criteria’s or conditions.
  - (dict) –
    
    A data table search criteria.
- AndConditions (list) –
  
  The criteria’s and conditions.
  - (dict) –
    
    A data table search criteria.
- StringCondition (dict) –
  
  A leaf node condition which can be used to specify a string condition.
  - FieldName (string) –
    
    The name of the field in the string condition.
  - Value (string) –
    
    The value of the string.
  - ComparisonType (string) –
    
    The type of comparison to be made when evaluating the string condition.
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

{
    'DataTables': [
        {
            'Name': 'string',
            'Id': 'string',
            'Arn': 'string',
            'TimeZone': 'string',
            'Description': 'string',
            'ValueLockLevel': 'NONE'|'DATA_TABLE'|'PRIMARY_VALUE'|'ATTRIBUTE'|'VALUE',
            'LockVersion': {
                'DataTable': 'string',
                'Attribute': 'string',
                'PrimaryValues': 'string',
                'Value': 'string'
            },
            'Version': 'string',
            'VersionDescription': 'string',
            'Status': 'PUBLISHED',
            'CreatedTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'LastModifiedRegion': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'ApproximateTotalCount': 123
}

Response Structure

(dict) –
- DataTables (list) –
  
  An array of data tables matching the search criteria with the same structure as DescribeTable except Version, VersionDescription, and LockVersion are omitted.
  - (dict) –
    
    Represents a data table in Amazon Connect. A data table is a JSON-like data structure where attributes and values are dynamically set by customers. Customers can reference table values within call flows, applications, views, and workspaces to pinpoint dynamic configuration that changes their contact center’s behavior in a predetermined and safe way.
    - Name (string) –
      
      The human-readable name of the data table. Must be unique within the instance and conform to Connect naming standards.
    - Id (string) –
      
      The unique identifier for the data table. Does not include version aliases.
    - Arn (string) –
      
      The Amazon Resource Name (ARN) for the data table. Does not include version aliases.
    - TimeZone (string) –
      
      The IANA timezone identifier used when resolving time based dynamic values. Required even if no time slices are specified.
    - Description (string) –
      
      An optional description of the data table’s purpose and contents.
    - ValueLockLevel (string) –
      
      The data level that concurrent value edits are locked on. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE, and NONE. Determines how concurrent edits are handled when multiple users attempt to modify values simultaneously.
    - LockVersion (dict) –
      
      The lock version information used for optimistic locking and table versioning. Changes with each update to prevent concurrent modification conflicts.
      - 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.
    - Version (string) –
      
      A unique identifier and alias for customer managed versions (not $LATEST or $SAVED).
    - VersionDescription (string) –
      
      A description of the customer managed version.
    - Status (string) –
      
      The current status of the data table. One of PUBLISHED or SAVED.
    - CreatedTime (datetime) –
      
      The timestamp when the data table was created.
    - LastModifiedTime (datetime) –
      
      The timestamp when the data table or any of its properties were last modified.
    - LastModifiedRegion (string) –
      
      The AWS region where the data table was last modified, used for region replication.
    - Tags (dict) –
      
      Key-value pairs for attribute based access control (TBAC or ABAC) and organization.
      - (string) –
        
        (string) –
- ApproximateTotalCount (integer) –
  
  The approximate number of data tables that matched the search criteria.