CustomerProfiles / Client / list_domain_object_types

list_domain_object_types¶

CustomerProfiles.Client.list_domain_object_types(**kwargs)¶

List all DomainObjectType(s) in a Customer Profiles domain.

Request Syntax

response = client.list_domain_object_types(
    DomainName='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

DomainName (string) –
[REQUIRED]

The unique name of the domain.
MaxResults (integer) – The maximum number of domain object types returned per page.
NextToken (string) – The pagination token from the previous call to ListDomainObjectTypes.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- Items (list) –
  
  The list of domain object types.
  - (dict) –
    
    Represents an item in the list of domain object types, containing basic information about a specific object type within a domain.
    - ObjectTypeName (string) –
      
      The name that identifies the object type within the domain.
    - Description (string) –
      
      A description explaining the purpose and characteristics of this object type.
    - CreatedAt (datetime) –
      
      The timestamp of when the domain object type was created.
    - LastUpdatedAt (datetime) –
      
      The timestamp of when the domain object type was most recently edited.
    - Tags (dict) –
      
      The tags used to organize, track, or control access for this resource.
      - (string) –
        
        (string) –
- NextToken (string) –
  
  The pagination token from the previous call to ListDomainObjectTypes.

Exceptions

CustomerProfiles.Client.exceptions.BadRequestException
CustomerProfiles.Client.exceptions.AccessDeniedException
CustomerProfiles.Client.exceptions.ResourceNotFoundException
CustomerProfiles.Client.exceptions.ThrottlingException
CustomerProfiles.Client.exceptions.InternalServerException