Skip to content

delete_profile_object_type

delete_profile_object_type(
    domain_name: name,
    object_type_name: typeName,
    *,
    config_overrides: Optional[CustomerProfilesClientConfig] = None,
) -> DeleteProfileObjectTypeResponse

Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type. It also disables integrations from this specific ProfileObjectType. In addition, it scrubs all of the fields of the standard profile that were populated from this ProfileObjectType.

Parameters:

  • domain_name (name) –

    The unique name of the domain.

  • object_type_name (typeName) –

    The name of the profile object type.

Raises:

Source code in docs_src/capo_customer_profiles/_services/customer_profiles.py
def delete_profile_object_type(
    self,
    domain_name: "capo_customer_profiles.types.name.name",
    object_type_name: "capo_customer_profiles.types.type_name.typeName",
    *,
    config_overrides: Optional[CustomerProfilesClientConfig] = None,
) -> "capo_customer_profiles.types.delete_profile_object_type_response.DeleteProfileObjectTypeResponse":
    """<p>Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type. It also disables integrations from this specific ProfileObjectType. In addition, it scrubs all of the fields of the standard profile that were populated from this ProfileObjectType.</p>

    Args:
        domain_name: <p>The unique name of the domain.</p>
        object_type_name: <p>The name of the profile object type.</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.
    """

    def _handler(
        req: "OperationRequest[capo_customer_profiles.types.delete_profile_object_type_request.DeleteProfileObjectTypeRequest]",
    ) -> OperationResponse[
        "capo_customer_profiles.types.delete_profile_object_type_response.DeleteProfileObjectTypeResponse"
    ]:
        import capo_customer_profiles._operations.customer_profiles_20200815.delete_profile_object_type

        output, http_response = (
            capo_customer_profiles._operations.customer_profiles_20200815.delete_profile_object_type.delete_profile_object_type(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteProfileObjectType")
    )
    input_: capo_customer_profiles.types.delete_profile_object_type_request.DeleteProfileObjectTypeRequest = {
        "domain_name": domain_name,
        "object_type_name": object_type_name,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output