:doc:`CustomerProfiles <../../customer-profiles>` / Client / list_profile_objects

********************
list_profile_objects
********************



.. py:method:: CustomerProfiles.Client.list_profile_objects(**kwargs)

  

  Returns a list of objects associated with a profile of a given ProfileObjectType.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListProfileObjects>`_  


  **Request Syntax**
  ::

    response = client.list_profile_objects(
        NextToken='string',
        MaxResults=123,
        DomainName='string',
        ObjectTypeName='string',
        ProfileId='string',
        ObjectFilter={
            'KeyName': 'string',
            'Values': [
                'string',
            ]
        }
    )
    
  :type NextToken: string
  :param NextToken: 

    The pagination token from the previous call to ListProfileObjects.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of objects returned per page.

    

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

    The unique name of the domain.

    

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

    The name of the profile object type.

    

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

    The unique identifier of a customer profile.

    

  
  :type ObjectFilter: dict
  :param ObjectFilter: 

    Applies a filter to the response to include profile objects with the specified index values.

    

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

      A searchable identifier of a profile object. The predefined keys you can use to search for ``_asset`` include: ``_assetId``, ``_assetName``, and ``_serialNumber``. The predefined keys you can use to search for ``_case`` include: ``_caseId``. The predefined keys you can use to search for ``_order`` include: ``_orderId``.

      

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

      A list of key values.

      

    
      - *(string) --* 

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

    
    ::

      {
          'Items': [
              {
                  'ObjectTypeName': 'string',
                  'ProfileObjectUniqueKey': 'string',
                  'Object': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Items** *(list) --* 

        The list of ListProfileObject instances.

        
        

        - *(dict) --* 

          A ProfileObject in a list of ProfileObjects.

          
          

          - **ObjectTypeName** *(string) --* 

            Specifies the kind of object being added to a profile, such as "Salesforce-Account."

            
          

          - **ProfileObjectUniqueKey** *(string) --* 

            The unique identifier of the ProfileObject generated by the service.

            
          

          - **Object** *(string) --* 

            A JSON representation of a ProfileObject that belongs to a profile.

            
      
    
      

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

        The pagination token from the previous call to ListProfileObjects.

        
  
  **Exceptions**
  
  *   :py:class:`CustomerProfiles.Client.exceptions.BadRequestException`

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

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

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

  
  *   :py:class:`CustomerProfiles.Client.exceptions.InternalServerException`

  