:doc:`Connect <../../connect>` / Client / list_data_table_primary_values

******************************
list_data_table_primary_values
******************************



.. py:method:: Connect.Client.list_data_table_primary_values(**kwargs)

  

  Lists all primary value combinations for a given data table. Returns the unique combinations of primary attribute values that identify records in the table. Up to 100 records are returned per request.

  

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


  **Request Syntax**
  ::

    response = client.list_data_table_primary_values(
        InstanceId='string',
        DataTableId='string',
        RecordIds=[
            'string',
        ],
        PrimaryAttributeValues=[
            {
                'AttributeName': 'string',
                'Values': [
                    'string',
                ]
            },
        ],
        NextToken='string',
        MaxResults=123
    )
    
  :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 NextToken: string
  :param NextToken: 

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

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of data table primary values to return in one page of results.

    

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

    
    ::

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

    

    - *(dict) --* 
      

      - **NextToken** *(string) --* 

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

        
      

      - **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.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`Connect.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`Connect.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Connect.Client.exceptions.InternalServiceException`

  
  *   :py:class:`Connect.Client.exceptions.ThrottlingException`

  
  *   :py:class:`Connect.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Connect.Client.exceptions.InvalidParameterException`

  