CustomerProfiles / Client / list_object_type_attribute_values

list_object_type_attribute_values

CustomerProfiles.Client.list_object_type_attribute_values(**kwargs)

The ListObjectTypeAttributeValues API provides access to the most recent distinct values for any specified attribute, making it valuable for real-time data validation and consistency checks within your object types. This API works across domain, supporting both custom and standard object types. The API accepts the object type name, attribute name, and domain name as input parameters and returns values up to the storage limit of approximately 350KB.

See also: AWS API Documentation

Request Syntax

response = client.list_object_type_attribute_values(
    NextToken='string',
    MaxResults=123,
    DomainName='string',
    ObjectTypeName='string',
    AttributeName='string'
)
Parameters:

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

  • MaxResults (integer) – The maximum number of objects returned per page. Valid Range: Minimum value of 1. Maximum value of 100. If not provided default as 100.

  • DomainName (string) –

    [REQUIRED]

    The unique name of the domain.

  • ObjectTypeName (string) –

    [REQUIRED]

    The unique name of the domain object type.

  • AttributeName (string) –

    [REQUIRED]

    The attribute name.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'Value': 'string',
            'LastUpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Items (list) –

      A list of unique attribute values sorted on the basis of LastUpdatedAt.

      • (dict) –

        Represents an item in the list of object type attribute values with its associated metadata.

        • Value (string) –

          The actual value of the object type attribute.

        • LastUpdatedAt (datetime) –

          The timestamp of when the object type attribute value was most recently updated.

    • NextToken (string) –

      The pagination token from the previous call to call ListObjectTypeAttributeValues.

Exceptions

  • CustomerProfiles.Client.exceptions.BadRequestException

  • CustomerProfiles.Client.exceptions.ResourceNotFoundException

  • CustomerProfiles.Client.exceptions.AccessDeniedException

  • CustomerProfiles.Client.exceptions.ThrottlingException

  • CustomerProfiles.Client.exceptions.InternalServerException