Skip to content

put_domain_object_type async

put_domain_object_type(
    domain_name: name,
    object_type_name: typeName,
    fields: DomainObjectTypeFields,
    *,
    config_overrides: Optional[AsyncCustomerProfilesClientConfig] = None,
    description: Optional[sensitiveString1To10000] = None,
    encryption_key: Optional[encryptionKey] = None,
    tags: Optional[TagMap] = None,
) -> PutDomainObjectTypeResponse

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

Parameters:

  • domain_name (name) –

    The unique name of the domain.

  • object_type_name (typeName) –

    The unique name of the domain object type.

  • description (Optional[sensitiveString1To10000], default: None ) –

    The description of the domain object type.

  • encryption_key (Optional[encryptionKey], default: None ) –

    The customer provided KMS key used to encrypt this type of domain object.

  • fields (DomainObjectTypeFields) –

    A map of field names to their corresponding domain object type field definitions.

  • tags (Optional[TagMap], default: None ) –

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

Raises:

Source code in docs_src/capo_customer_profiles/_services/async_customer_profiles.py
async def put_domain_object_type(
    self,
    domain_name: "capo_customer_profiles.types.name.name",
    object_type_name: "capo_customer_profiles.types.type_name.typeName",
    fields: "capo_customer_profiles.types.domain_object_type_fields.DomainObjectTypeFields",
    *,
    config_overrides: Optional[AsyncCustomerProfilesClientConfig] = None,
    description: Optional[
        "capo_customer_profiles.types.sensitive_string1_to10000.sensitiveString1To10000"
    ] = None,
    encryption_key: Optional[
        "capo_customer_profiles.types.encryption_key.encryptionKey"
    ] = None,
    tags: Optional["capo_customer_profiles.types.tag_map.TagMap"] = None,
) -> "capo_customer_profiles.types.put_domain_object_type_response.PutDomainObjectTypeResponse":
    """<p>Create/Update a DomainObjectType in a Customer Profiles domain. To create a new DomainObjectType, Data Store needs to be enabled on the Domain.</p>

    Args:
        domain_name: <p>The unique name of the domain.</p>
        object_type_name: <p>The unique name of the domain object type.</p>
        description: <p>The description of the domain object type.</p>
        encryption_key: <p>The customer provided KMS key used to encrypt this type of domain object.</p>
        fields: <p>A map of field names to their corresponding domain object type field definitions.</p>
        tags: <p>The tags used to organize, track, or control access for this resource.</p>

    Raises:
        capo_customer_profiles.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_customer_profiles.errors.bad_request_exception.BadRequestException: <p>The input you provided is invalid.</p>
        capo_customer_profiles.errors.internal_server_exception.InternalServerException: <p>An internal service error occurred.</p>
        capo_customer_profiles.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource does not exist, or access was denied.</p>
        capo_customer_profiles.errors.throttling_exception.ThrottlingException: <p>You exceeded the maximum number of requests.</p>
        capo_customer_profiles.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_customer_profiles.types.put_domain_object_type_request.PutDomainObjectTypeRequest]",
    ) -> AsyncOperationResponse[
        "capo_customer_profiles.types.put_domain_object_type_response.PutDomainObjectTypeResponse"
    ]:
        import capo_customer_profiles._operations.customer_profiles_20200815.put_domain_object_type

        (
            output,
            http_response,
        ) = await capo_customer_profiles._operations.customer_profiles_20200815.put_domain_object_type.async_put_domain_object_type(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_customer_profiles.types.put_domain_object_type_request.PutDomainObjectTypeRequest",
    ) -> dict[str, Any]:
        import capo_customer_profiles.types.put_domain_object_type_request

        return capo_customer_profiles.types.put_domain_object_type_request.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_customer_profiles.types.put_domain_object_type_response.PutDomainObjectTypeResponse",
    ) -> dict[str, Any]:
        import capo_customer_profiles.types.put_domain_object_type_response

        return capo_customer_profiles.types.put_domain_object_type_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "PutDomainObjectType",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_customer_profiles.types.put_domain_object_type_request.PutDomainObjectTypeRequest = {
        "domain_name": domain_name,
        "object_type_name": object_type_name,
        "fields": fields,
    }
    if description is not None:
        input_["description"] = description
    if encryption_key is not None:
        input_["encryption_key"] = encryption_key
    if tags is not None:
        input_["tags"] = tags

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output