CustomerProfiles / Client / list_profile_object_types

list_profile_object_types#

CustomerProfiles.Client.list_profile_object_types(**kwargs)#

Lists all of the templates available within the service.

See also: AWS API Documentation

Request Syntax

response = client.list_profile_object_types(
    DomainName='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The unique name of the domain.

  • NextToken (string) – Identifies the next page of results to return.

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

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'ObjectTypeName': 'string',
            'Description': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'LastUpdatedAt': datetime(2015, 1, 1),
            'MaxProfileObjectCount': 123,
            'MaxAvailableProfileObjectCount': 123,
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Items (list) –

      The list of ListProfileObjectTypes instances.

      • (dict) –

        A ProfileObjectType instance.

        • ObjectTypeName (string) –

          The name of the profile object type.

        • Description (string) –

          Description of the profile object type.

        • CreatedAt (datetime) –

          The timestamp of when the domain was created.

        • LastUpdatedAt (datetime) –

          The timestamp of when the domain was most recently edited.

        • MaxProfileObjectCount (integer) –

          The amount of profile object max count assigned to the object type.

        • MaxAvailableProfileObjectCount (integer) –

          The amount of provisioned profile object max count available.

        • Tags (dict) –

          The tags used to organize, track, or control access for this resource.

          • (string) –

            • (string) –

    • NextToken (string) –

      Identifies the next page of results to return.

Exceptions

  • CustomerProfiles.Client.exceptions.BadRequestException

  • CustomerProfiles.Client.exceptions.ResourceNotFoundException

  • CustomerProfiles.Client.exceptions.AccessDeniedException

  • CustomerProfiles.Client.exceptions.ThrottlingException

  • CustomerProfiles.Client.exceptions.InternalServerException