delete_profile_key ¶

delete_profile_key(
    profile_id: uuid,
    key_name: name,
    values: requestValueList,
    domain_name: name,
    *,
    config_overrides: Optional[CustomerProfilesClientConfig] = None,
) -> DeleteProfileKeyResponse

Removes a searchable key from a customer profile.

Parameters:

profile_id (uuid) –

The unique identifier of a customer profile.
key_name (name) –

A searchable identifier of a customer profile.
values (requestValueList) –

A list of key values.
domain_name (name) –

The unique name of the domain.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
BadRequestException –

The input you provided is invalid.
InternalServerException –

An internal service error occurred.
ResourceNotFoundException –

The requested resource does not exist, or access was denied.
ThrottlingException –

You exceeded the maximum number of requests.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_customer_profiles/_services/customer_profiles.py

def delete_profile_key(
    self,
    profile_id: "capo_customer_profiles.types.uuid.uuid",
    key_name: "capo_customer_profiles.types.name.name",
    values: "capo_customer_profiles.types.request_value_list.requestValueList",
    domain_name: "capo_customer_profiles.types.name.name",
    *,
    config_overrides: Optional[CustomerProfilesClientConfig] = None,
) -> "capo_customer_profiles.types.delete_profile_key_response.DeleteProfileKeyResponse":
    """<p>Removes a searchable key from a customer profile.</p>

    Args:
        profile_id: <p>The unique identifier of a customer profile.</p>
        key_name: <p>A searchable identifier of a customer profile.</p>
        values: <p>A list of key values.</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_key_request.DeleteProfileKeyRequest]",
    ) -> OperationResponse[
        "capo_customer_profiles.types.delete_profile_key_response.DeleteProfileKeyResponse"
    ]:
        import capo_customer_profiles._operations.customer_profiles_20200815.delete_profile_key

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteProfileKey")
    )
    input_: capo_customer_profiles.types.delete_profile_key_request.DeleteProfileKeyRequest = {
        "profile_id": profile_id,
        "key_name": key_name,
        "values": values,
        "domain_name": domain_name,
    }

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