:doc:`Connect <../../connect>` / Paginator / ListDataTablePrimaryValues

**************************
ListDataTablePrimaryValues
**************************



.. py:class:: Connect.Paginator.ListDataTablePrimaryValues

  ::

    
    paginator = client.get_paginator('list_data_table_primary_values')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`Connect.Client.list_data_table_primary_values`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListDataTablePrimaryValues>`_    


    **Request Syntax**
    ::

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

      The unique identifier for the Amazon Connect instance.

      

    
    :type DataTableId: string
    :param DataTableId: **[REQUIRED]** 

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

      

    
    :type RecordIds: list
    :param RecordIds: 

      Optional list of specific record IDs to retrieve. Used for CloudFormation to effectively describe records by ID. If NextToken is provided, this parameter is ignored.

      

    
      - *(string) --* 

      
  
    :type PrimaryAttributeValues: list
    :param PrimaryAttributeValues: 

      Optional filter to retrieve primary values matching specific criteria.

      

    
      - *(dict) --* 

        A primary attribute value filter.

        

      
        - **AttributeName** *(string) --* **[REQUIRED]** 

          The filter's attribute name.

          

        
        - **Values** *(list) --* **[REQUIRED]** 

          The filter's values.

          

        
          - *(string) --* 

          
      
      
  
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'PrimaryValuesList': [
                {
                    'RecordId': 'string',
                    'PrimaryValues': [
                        {
                            'AttributeName': 'string',
                            'AttributeId': 'string',
                            'Value': 'string'
                        },
                    ],
                    'LastModifiedTime': datetime(2015, 1, 1),
                    'LastModifiedRegion': 'string'
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **PrimaryValuesList** *(list) --* 

          A list of primary value combinations with their record IDs and modification metadata.

          
          

          - *(dict) --* 

            A record primary value.

            
            

            - **RecordId** *(string) --* 

              The value's record ID.

              
            

            - **PrimaryValues** *(list) --* 

              The value'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.

                  
            
          
            

            - **LastModifiedTime** *(datetime) --* 

              The value's last modified time.

              
            

            - **LastModifiedRegion** *(string) --* 

              The value's last modified region.

              
        
      
    