CustomerProfiles / Client / list_profile_objects

list_profile_objects#

CustomerProfiles.Client.list_profile_objects(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

  • NextToken (string) – The pagination token from the previous call to ListProfileObjects.

  • MaxResults (integer) – The maximum number of objects returned per page.

  • DomainName (string) –

    [REQUIRED]

    The unique name of the domain.

  • ObjectTypeName (string) –

    [REQUIRED]

    The name of the profile object type.

  • ProfileId (string) –

    [REQUIRED]

    The unique identifier of a customer profile.

  • ObjectFilter (dict) –

    Applies a filter to the response to include profile objects with the specified index values. This filter is only supported for ObjectTypeName _asset, _case and _order.

    • KeyName (string) – [REQUIRED]

      A searchable identifier of a standard profile object. The predefined keys you can use to search for _asset include: _assetId, _assetName, _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) –

Return type:

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

  • CustomerProfiles.Client.exceptions.BadRequestException

  • CustomerProfiles.Client.exceptions.AccessDeniedException

  • CustomerProfiles.Client.exceptions.ResourceNotFoundException

  • CustomerProfiles.Client.exceptions.ThrottlingException

  • CustomerProfiles.Client.exceptions.InternalServerException