Skip to content

delete_profile

delete_profile(
    profile_id: uuid,
    domain_name: name,
    *,
    config_overrides: Optional[CustomerProfilesClientConfig] = None,
) -> DeleteProfileResponse

Deletes the standard customer profile and all data pertaining to the profile.

Parameters:

  • profile_id (uuid) –

    The unique identifier of a customer profile.

  • domain_name (name) –

    The unique name of the domain.

Raises:

Source code in docs_src/capo_customer_profiles/_services/customer_profiles.py
def delete_profile(
    self,
    profile_id: "capo_customer_profiles.types.uuid.uuid",
    domain_name: "capo_customer_profiles.types.name.name",
    *,
    config_overrides: Optional[CustomerProfilesClientConfig] = None,
) -> "capo_customer_profiles.types.delete_profile_response.DeleteProfileResponse":
    """<p>Deletes the standard customer profile and all data pertaining to the profile.</p>

    Args:
        profile_id: <p>The unique identifier of a customer profile.</p>
        domain_name: <p>The unique name of the domain.</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_request.DeleteProfileRequest]",
    ) -> OperationResponse[
        "capo_customer_profiles.types.delete_profile_response.DeleteProfileResponse"
    ]:
        import capo_customer_profiles._operations.customer_profiles_20200815.delete_profile

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteProfile")
    )
    input_: capo_customer_profiles.types.delete_profile_request.DeleteProfileRequest = {
        "profile_id": profile_id,
        "domain_name": domain_name,
    }

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