CustomerProfiles / Client / put_domain_object_type

put_domain_object_type¶

CustomerProfiles.Client.put_domain_object_type(**kwargs)¶

Create/Update a DomainObjectType in a Customer Profiles domain. To create a new DomainObjectType, Data Store needs to be enabled on the Domain.

Request Syntax

response = client.put_domain_object_type(
    DomainName='string',
    ObjectTypeName='string',
    Description='string',
    EncryptionKey='string',
    Fields={
        'string': {
            'Source': 'string',
            'Target': 'string',
            'ContentType': 'STRING'|'NUMBER',
            'FeatureType': 'TEXTUAL'|'CATEGORICAL'
        }
    },
    Tags={
        'string': 'string'
    }
)

Parameters:

DomainName (string) –
[REQUIRED]

The unique name of the domain.
ObjectTypeName (string) –
[REQUIRED]

The unique name of the domain object type.
Description (string) – The description of the domain object type.
EncryptionKey (string) – The customer provided KMS key used to encrypt this type of domain object.
Fields (dict) –
[REQUIRED]

A map of field names to their corresponding domain object type field definitions.
- (string) –
  - (dict) –
    
    The standard domain object type.
    - Source (string) – [REQUIRED]
      
      The expression that defines how to extract the field value from the source object.>
    - Target (string) – [REQUIRED]
      
      The expression that defines where the field value should be placed in the standard domain object.
    - ContentType (string) –
      
      The content type of the field.
    - FeatureType (string) –
      
      The semantic meaning of the field.
Tags (dict) –
The tags used to organize, track, or control access for this resource.
- (string) –
  - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'ObjectTypeName': 'string',
    'Description': 'string',
    'EncryptionKey': 'string',
    'Fields': {
        'string': {
            'Source': 'string',
            'Target': 'string',
            'ContentType': 'STRING'|'NUMBER',
            'FeatureType': 'TEXTUAL'|'CATEGORICAL'
        }
    },
    'CreatedAt': datetime(2015, 1, 1),
    'LastUpdatedAt': datetime(2015, 1, 1),
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) –
- ObjectTypeName (string) –
  
  The unique name of the domain object type.
- Description (string) –
  
  The description of the domain object type.
- EncryptionKey (string) –
  
  The customer provided KMS key used to encrypt this type of domain object.
- Fields (dict) –
  
  A map of field names to their corresponding domain object type field definitions.
  - (string) –
    - (dict) –
      
      The standard domain object type.
      - Source (string) –
        
        The expression that defines how to extract the field value from the source object.>
      - Target (string) –
        
        The expression that defines where the field value should be placed in the standard domain object.
      - ContentType (string) –
        
        The content type of the field.
      - FeatureType (string) –
        
        The semantic meaning of the field.
- 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) –

Exceptions

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