Skip to content

PutProfileObjectTypeResponse

Source code in docs_src/capo_customer_profiles/types/put_profile_object_type_response.py
class PutProfileObjectTypeResponse(TypedDict, closed=True):
    object_type_name: "capo_customer_profiles.types.type_name.typeName"
    """<p>The name of the profile object type.</p>"""
    description: "capo_customer_profiles.types.sensitive_text.sensitiveText"
    """<p>Description of the profile object type.</p>"""
    template_id: NotRequired["capo_customer_profiles.types.name.name"]
    """<p>A unique identifier for the object template.</p>"""
    expiration_days: NotRequired[
        "capo_customer_profiles.types.expiration_days_integer.expirationDaysInteger"
    ]
    """<p>The number of days until the data in the object expires.</p>"""
    encryption_key: NotRequired[
        "capo_customer_profiles.types.encryption_key.encryptionKey"
    ]
    """<p>The customer-provided key to encrypt the profile object that will be created in this profile object type.</p>"""
    allow_profile_creation: "capo_customer_profiles.types.boolean.boolean"
    """<p>Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is <code>FALSE</code>. If the AllowProfileCreation flag is set to <code>FALSE</code>, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to <code>TRUE</code>, and if no match is found, then the service creates a new standard profile.</p>"""
    source_last_updated_timestamp_format: NotRequired[
        "capo_customer_profiles.types.string1_to255.string1To255"
    ]
    """<p>The format of your <code>sourceLastUpdatedTimestamp</code> that was previously set up in fields that were parsed using <a href="https://docs.oracle.com/javase/10/docs/api/java/text/SimpleDateFormat.html">SimpleDateFormat</a>. If you have <code>sourceLastUpdatedTimestamp</code> in your field, you must set up <code>sourceLastUpdatedTimestampFormat</code>.</p>"""
    max_profile_object_count: NotRequired[
        "capo_customer_profiles.types.min_size1.minSize1"
    ]
    """<p>The amount of profile object max count assigned to the object type.</p>"""
    max_available_profile_object_count: NotRequired[
        "capo_customer_profiles.types.min_size0.minSize0"
    ]
    """<p>The amount of provisioned profile object max count available.</p>"""
    source_priority: NotRequired["capo_customer_profiles.types.min_size1.minSize1"]
    """<p>An integer that determines the priority of this object type when data from multiple sources is ingested. Lower values take priority. Object types without a specified source priority default to the lowest priority.</p>"""
    fields: NotRequired["capo_customer_profiles.types.field_map.FieldMap"]
    """<p>A map of the name and ObjectType field.</p>"""
    keys: NotRequired["capo_customer_profiles.types.key_map.KeyMap"]
    """<p>A list of unique keys that can be used to map data to the profile.</p>"""
    created_at: NotRequired["capo_customer_profiles.types.timestamp.timestamp"]
    """<p>The timestamp of when the domain was created.</p>"""
    last_updated_at: NotRequired["capo_customer_profiles.types.timestamp.timestamp"]
    """<p>The timestamp of when the domain was most recently edited.</p>"""
    tags: NotRequired["capo_customer_profiles.types.tag_map.TagMap"]
    """<p>The tags used to organize, track, or control access for this resource.</p>"""

allow_profile_creation instance-attribute

allow_profile_creation: boolean

Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.

created_at instance-attribute

created_at: NotRequired[timestamp]

The timestamp of when the domain was created.

description instance-attribute

description: sensitiveText

Description of the profile object type.

encryption_key instance-attribute

encryption_key: NotRequired[encryptionKey]

The customer-provided key to encrypt the profile object that will be created in this profile object type.

expiration_days instance-attribute

expiration_days: NotRequired[expirationDaysInteger]

The number of days until the data in the object expires.

fields instance-attribute

fields: NotRequired[FieldMap]

A map of the name and ObjectType field.

keys instance-attribute

keys: NotRequired[KeyMap]

A list of unique keys that can be used to map data to the profile.

last_updated_at instance-attribute

last_updated_at: NotRequired[timestamp]

The timestamp of when the domain was most recently edited.

max_available_profile_object_count instance-attribute

max_available_profile_object_count: NotRequired[minSize0]

The amount of provisioned profile object max count available.

max_profile_object_count instance-attribute

max_profile_object_count: NotRequired[minSize1]

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

object_type_name instance-attribute

object_type_name: typeName

The name of the profile object type.

source_last_updated_timestamp_format instance-attribute

source_last_updated_timestamp_format: NotRequired[string1To255]

The format of your sourceLastUpdatedTimestamp that was previously set up in fields that were parsed using SimpleDateFormat. If you have sourceLastUpdatedTimestamp in your field, you must set up sourceLastUpdatedTimestampFormat.

source_priority instance-attribute

source_priority: NotRequired[minSize1]

An integer that determines the priority of this object type when data from multiple sources is ingested. Lower values take priority. Object types without a specified source priority default to the lowest priority.

tags instance-attribute

tags: NotRequired[TagMap]

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

template_id instance-attribute

template_id: NotRequired[name]

A unique identifier for the object template.