CustomerProfilesClient#
Index > CustomerProfiles > CustomerProfilesClient
Auto-generated documentation for CustomerProfiles type annotations stubs module mypy-boto3-customer-profiles.
CustomerProfilesClient#
Type annotations and code completion for boto3.client("customer-profiles")
.
boto3 documentation
# CustomerProfilesClient usage example
from boto3.session import Session
from mypy_boto3_customer_profiles.client import CustomerProfilesClient
def get_customer-profiles_client() -> CustomerProfilesClient:
return Session().client("customer-profiles")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("customer-profiles").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("customer-profiles")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.BadRequestException,
client.exceptions.ClientError,
client.exceptions.InternalServerException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ThrottlingException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_customer_profiles.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
add_profile_key#
Associates a new key value with a specific profile, such as a Contact Record ContactId.
Type annotations and code completion for boto3.client("customer-profiles").add_profile_key
method.
boto3 documentation
# add_profile_key method definition
def add_profile_key(
self,
*,
ProfileId: str,
KeyName: str,
Values: Sequence[str],
DomainName: str,
) -> AddProfileKeyResponseTypeDef: # (1)
...
# add_profile_key method usage example with argument unpacking
kwargs: AddProfileKeyRequestRequestTypeDef = { # (1)
"ProfileId": ...,
"KeyName": ...,
"Values": ...,
"DomainName": ...,
}
parent.add_profile_key(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("customer-profiles").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("customer-profiles").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_calculated_attribute_definition#
Creates a new calculated attribute definition.
Type annotations and code completion for boto3.client("customer-profiles").create_calculated_attribute_definition
method.
boto3 documentation
# create_calculated_attribute_definition method definition
def create_calculated_attribute_definition(
self,
*,
DomainName: str,
CalculatedAttributeName: str,
AttributeDetails: AttributeDetailsTypeDef, # (1)
Statistic: StatisticType, # (2)
DisplayName: str = ...,
Description: str = ...,
Conditions: ConditionsTypeDef = ..., # (3)
Tags: Mapping[str, str] = ...,
) -> CreateCalculatedAttributeDefinitionResponseTypeDef: # (4)
...
- See AttributeDetailsTypeDef
- See StatisticType
- See ConditionsTypeDef
- See CreateCalculatedAttributeDefinitionResponseTypeDef
# create_calculated_attribute_definition method usage example with argument unpacking
kwargs: CreateCalculatedAttributeDefinitionRequestRequestTypeDef = { # (1)
"DomainName": ...,
"CalculatedAttributeName": ...,
"AttributeDetails": ...,
"Statistic": ...,
}
parent.create_calculated_attribute_definition(**kwargs)
create_domain#
Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys.
Type annotations and code completion for boto3.client("customer-profiles").create_domain
method.
boto3 documentation
# create_domain method definition
def create_domain(
self,
*,
DomainName: str,
DefaultExpirationDays: int,
DefaultEncryptionKey: str = ...,
DeadLetterQueueUrl: str = ...,
Matching: MatchingRequestTypeDef = ..., # (1)
RuleBasedMatching: RuleBasedMatchingRequestTypeDef = ..., # (2)
Tags: Mapping[str, str] = ...,
) -> CreateDomainResponseTypeDef: # (3)
...
# create_domain method usage example with argument unpacking
kwargs: CreateDomainRequestRequestTypeDef = { # (1)
"DomainName": ...,
"DefaultExpirationDays": ...,
}
parent.create_domain(**kwargs)
create_event_stream#
Creates an event stream, which is a subscription to real-time events, such as when profiles are created and updated through Amazon Connect Customer Profiles.
Type annotations and code completion for boto3.client("customer-profiles").create_event_stream
method.
boto3 documentation
# create_event_stream method definition
def create_event_stream(
self,
*,
DomainName: str,
Uri: str,
EventStreamName: str,
Tags: Mapping[str, str] = ...,
) -> CreateEventStreamResponseTypeDef: # (1)
...
# create_event_stream method usage example with argument unpacking
kwargs: CreateEventStreamRequestRequestTypeDef = { # (1)
"DomainName": ...,
"Uri": ...,
"EventStreamName": ...,
}
parent.create_event_stream(**kwargs)
create_integration_workflow#
Creates an integration workflow.
Type annotations and code completion for boto3.client("customer-profiles").create_integration_workflow
method.
boto3 documentation
# create_integration_workflow method definition
def create_integration_workflow(
self,
*,
DomainName: str,
WorkflowType: WorkflowTypeType, # (1)
IntegrationConfig: IntegrationConfigTypeDef, # (2)
ObjectTypeName: str,
RoleArn: str,
Tags: Mapping[str, str] = ...,
) -> CreateIntegrationWorkflowResponseTypeDef: # (3)
...
# create_integration_workflow method usage example with argument unpacking
kwargs: CreateIntegrationWorkflowRequestRequestTypeDef = { # (1)
"DomainName": ...,
"WorkflowType": ...,
"IntegrationConfig": ...,
"ObjectTypeName": ...,
"RoleArn": ...,
}
parent.create_integration_workflow(**kwargs)
create_profile#
Creates a standard profile.
Type annotations and code completion for boto3.client("customer-profiles").create_profile
method.
boto3 documentation
# create_profile method definition
def create_profile(
self,
*,
DomainName: str,
AccountNumber: str = ...,
AdditionalInformation: str = ...,
PartyType: PartyTypeType = ..., # (1)
BusinessName: str = ...,
FirstName: str = ...,
MiddleName: str = ...,
LastName: str = ...,
BirthDate: str = ...,
Gender: GenderType = ..., # (2)
PhoneNumber: str = ...,
MobilePhoneNumber: str = ...,
HomePhoneNumber: str = ...,
BusinessPhoneNumber: str = ...,
EmailAddress: str = ...,
PersonalEmailAddress: str = ...,
BusinessEmailAddress: str = ...,
Address: AddressTypeDef = ..., # (3)
ShippingAddress: AddressTypeDef = ..., # (3)
MailingAddress: AddressTypeDef = ..., # (3)
BillingAddress: AddressTypeDef = ..., # (3)
Attributes: Mapping[str, str] = ...,
PartyTypeString: str = ...,
GenderString: str = ...,
) -> CreateProfileResponseTypeDef: # (7)
...
- See PartyTypeType
- See GenderType
- See AddressTypeDef
- See AddressTypeDef
- See AddressTypeDef
- See AddressTypeDef
- See CreateProfileResponseTypeDef
# create_profile method usage example with argument unpacking
kwargs: CreateProfileRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.create_profile(**kwargs)
delete_calculated_attribute_definition#
Deletes an existing calculated attribute definition.
Type annotations and code completion for boto3.client("customer-profiles").delete_calculated_attribute_definition
method.
boto3 documentation
# delete_calculated_attribute_definition method definition
def delete_calculated_attribute_definition(
self,
*,
DomainName: str,
CalculatedAttributeName: str,
) -> Dict[str, Any]:
...
# delete_calculated_attribute_definition method usage example with argument unpacking
kwargs: DeleteCalculatedAttributeDefinitionRequestRequestTypeDef = { # (1)
"DomainName": ...,
"CalculatedAttributeName": ...,
}
parent.delete_calculated_attribute_definition(**kwargs)
delete_domain#
Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.
Type annotations and code completion for boto3.client("customer-profiles").delete_domain
method.
boto3 documentation
# delete_domain method definition
def delete_domain(
self,
*,
DomainName: str,
) -> DeleteDomainResponseTypeDef: # (1)
...
# delete_domain method usage example with argument unpacking
kwargs: DeleteDomainRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.delete_domain(**kwargs)
delete_event_stream#
Disables and deletes the specified event stream.
Type annotations and code completion for boto3.client("customer-profiles").delete_event_stream
method.
boto3 documentation
# delete_event_stream method definition
def delete_event_stream(
self,
*,
DomainName: str,
EventStreamName: str,
) -> Dict[str, Any]:
...
# delete_event_stream method usage example with argument unpacking
kwargs: DeleteEventStreamRequestRequestTypeDef = { # (1)
"DomainName": ...,
"EventStreamName": ...,
}
parent.delete_event_stream(**kwargs)
delete_integration#
Removes an integration from a specific domain.
Type annotations and code completion for boto3.client("customer-profiles").delete_integration
method.
boto3 documentation
# delete_integration method definition
def delete_integration(
self,
*,
DomainName: str,
Uri: str,
) -> DeleteIntegrationResponseTypeDef: # (1)
...
# delete_integration method usage example with argument unpacking
kwargs: DeleteIntegrationRequestRequestTypeDef = { # (1)
"DomainName": ...,
"Uri": ...,
}
parent.delete_integration(**kwargs)
delete_profile#
Deletes the standard customer profile and all data pertaining to the profile.
Type annotations and code completion for boto3.client("customer-profiles").delete_profile
method.
boto3 documentation
# delete_profile method definition
def delete_profile(
self,
*,
ProfileId: str,
DomainName: str,
) -> DeleteProfileResponseTypeDef: # (1)
...
# delete_profile method usage example with argument unpacking
kwargs: DeleteProfileRequestRequestTypeDef = { # (1)
"ProfileId": ...,
"DomainName": ...,
}
parent.delete_profile(**kwargs)
delete_profile_key#
Removes a searchable key from a customer profile.
Type annotations and code completion for boto3.client("customer-profiles").delete_profile_key
method.
boto3 documentation
# delete_profile_key method definition
def delete_profile_key(
self,
*,
ProfileId: str,
KeyName: str,
Values: Sequence[str],
DomainName: str,
) -> DeleteProfileKeyResponseTypeDef: # (1)
...