CustomerProfiles / Client / delete_profile_key

delete_profile_key

CustomerProfiles.Client.delete_profile_key(**kwargs)

Removes a searchable key from a customer profile.

See also: AWS API Documentation

Request Syntax

response = client.delete_profile_key(
    ProfileId='string',
    KeyName='string',
    Values=[
        'string',
    ],
    DomainName='string'
)

Parameters:

• ProfileId (string) –

  [REQUIRED]

  The unique identifier of a customer profile.

• KeyName (string) –

  [REQUIRED]

  A searchable identifier of a customer profile.

• Values (list) –

  [REQUIRED]

  A list of key values.

  • (string) –

• DomainName (string) –

  [REQUIRED]

  The unique name of the domain.

Return type:

dict

Returns:

Response Syntax

{
    'Message': 'string'
}

Response Structure

• (dict) –

  • Message (string) –

    A message that indicates the delete request is done.

Exceptions

• CustomerProfiles.Client.exceptions.BadRequestException

• CustomerProfiles.Client.exceptions.AccessDeniedException

• CustomerProfiles.Client.exceptions.ResourceNotFoundException

• CustomerProfiles.Client.exceptions.ThrottlingException

• CustomerProfiles.Client.exceptions.InternalServerException