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)
    ...

1. See AddProfileKeyResponseTypeDef

# add_profile_key method usage example with argument unpacking

kwargs: AddProfileKeyRequestRequestTypeDef = {  # (1)
    "ProfileId": ...,
    "KeyName": ...,
    "Values": ...,
    "DomainName": ...,
}

parent.add_profile_key(**kwargs)

1. See AddProfileKeyRequestRequestTypeDef

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)
    ...

1. See AttributeDetailsTypeDef
2. See StatisticType
3. See ConditionsTypeDef
4. 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)

1. See CreateCalculatedAttributeDefinitionRequestRequestTypeDef

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)
    Tags: Mapping[str, str] = ...,
) -> CreateDomainResponseTypeDef:  # (2)
    ...

1. See MatchingRequestTypeDef
2. See CreateDomainResponseTypeDef

# create_domain method usage example with argument unpacking

kwargs: CreateDomainRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "DefaultExpirationDays": ...,
}

parent.create_domain(**kwargs)

1. See CreateDomainRequestRequestTypeDef

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)
    ...

1. See WorkflowTypeType
2. See IntegrationConfigTypeDef
3. See CreateIntegrationWorkflowResponseTypeDef

# create_integration_workflow method usage example with argument unpacking

kwargs: CreateIntegrationWorkflowRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "WorkflowType": ...,
    "IntegrationConfig": ...,
    "ObjectTypeName": ...,
    "RoleArn": ...,
}

parent.create_integration_workflow(**kwargs)

1. See CreateIntegrationWorkflowRequestRequestTypeDef

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)
    ...

1. See PartyTypeType
2. See GenderType
3. See AddressTypeDef
4. See AddressTypeDef
5. See AddressTypeDef
6. See AddressTypeDef
7. See CreateProfileResponseTypeDef

# create_profile method usage example with argument unpacking

kwargs: CreateProfileRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.create_profile(**kwargs)

1. See CreateProfileRequestRequestTypeDef

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)

1. See DeleteCalculatedAttributeDefinitionRequestRequestTypeDef

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)
    ...

1. See DeleteDomainResponseTypeDef

# delete_domain method usage example with argument unpacking

kwargs: DeleteDomainRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.delete_domain(**kwargs)

1. See DeleteDomainRequestRequestTypeDef

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)
    ...

1. See DeleteIntegrationResponseTypeDef

# delete_integration method usage example with argument unpacking

kwargs: DeleteIntegrationRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "Uri": ...,
}

parent.delete_integration(**kwargs)

1. See DeleteIntegrationRequestRequestTypeDef

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)
    ...

1. See DeleteProfileResponseTypeDef

# delete_profile method usage example with argument unpacking

kwargs: DeleteProfileRequestRequestTypeDef = {  # (1)
    "ProfileId": ...,
    "DomainName": ...,
}

parent.delete_profile(**kwargs)

1. See DeleteProfileRequestRequestTypeDef

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)
    ...

1. See DeleteProfileKeyResponseTypeDef

# delete_profile_key method usage example with argument unpacking

kwargs: DeleteProfileKeyRequestRequestTypeDef = {  # (1)
    "ProfileId": ...,
    "KeyName": ...,
    "Values": ...,
    "DomainName": ...,
}

parent.delete_profile_key(**kwargs)

1. See DeleteProfileKeyRequestRequestTypeDef

delete_profile_object

Removes an object associated with a profile of a given ProfileObjectType.

Type annotations and code completion for boto3.client("customer-profiles").delete_profile_object method. boto3 documentation

# delete_profile_object method definition

def delete_profile_object(
    self,
    *,
    ProfileId: str,
    ProfileObjectUniqueKey: str,
    ObjectTypeName: str,
    DomainName: str,
) -> DeleteProfileObjectResponseTypeDef:  # (1)
    ...

1. See DeleteProfileObjectResponseTypeDef

# delete_profile_object method usage example with argument unpacking

kwargs: DeleteProfileObjectRequestRequestTypeDef = {  # (1)
    "ProfileId": ...,
    "ProfileObjectUniqueKey": ...,
    "ObjectTypeName": ...,
    "DomainName": ...,
}

parent.delete_profile_object(**kwargs)

1. See DeleteProfileObjectRequestRequestTypeDef

delete_profile_object_type

Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type.

Type annotations and code completion for boto3.client("customer-profiles").delete_profile_object_type method. boto3 documentation

# delete_profile_object_type method definition

def delete_profile_object_type(
    self,
    *,
    DomainName: str,
    ObjectTypeName: str,
) -> DeleteProfileObjectTypeResponseTypeDef:  # (1)
    ...

1. See DeleteProfileObjectTypeResponseTypeDef

# delete_profile_object_type method usage example with argument unpacking

kwargs: DeleteProfileObjectTypeRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "ObjectTypeName": ...,
}

parent.delete_profile_object_type(**kwargs)

1. See DeleteProfileObjectTypeRequestRequestTypeDef

delete_workflow

Deletes the specified workflow and all its corresponding resources.

Type annotations and code completion for boto3.client("customer-profiles").delete_workflow method. boto3 documentation

# delete_workflow method definition

def delete_workflow(
    self,
    *,
    DomainName: str,
    WorkflowId: str,
) -> Dict[str, Any]:
    ...

# delete_workflow method usage example with argument unpacking

kwargs: DeleteWorkflowRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "WorkflowId": ...,
}

parent.delete_workflow(**kwargs)

1. See DeleteWorkflowRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("customer-profiles").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_auto_merging_preview

Tests the auto-merging settings of your Identity Resolution Job without merging your data.

Type annotations and code completion for boto3.client("customer-profiles").get_auto_merging_preview method. boto3 documentation

# get_auto_merging_preview method definition

def get_auto_merging_preview(
    self,
    *,
    DomainName: str,
    Consolidation: ConsolidationTypeDef,  # (1)
    ConflictResolution: ConflictResolutionTypeDef,  # (2)
    MinAllowedConfidenceScoreForMerging: float = ...,
) -> GetAutoMergingPreviewResponseTypeDef:  # (3)
    ...

1. See ConsolidationTypeDef
2. See ConflictResolutionTypeDef
3. See GetAutoMergingPreviewResponseTypeDef

# get_auto_merging_preview method usage example with argument unpacking

kwargs: GetAutoMergingPreviewRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "Consolidation": ...,
    "ConflictResolution": ...,
}

parent.get_auto_merging_preview(**kwargs)

1. See GetAutoMergingPreviewRequestRequestTypeDef

get_calculated_attribute_definition

Provides more information on a calculated attribute definition for Customer Profiles.

Type annotations and code completion for boto3.client("customer-profiles").get_calculated_attribute_definition method. boto3 documentation

# get_calculated_attribute_definition method definition

def get_calculated_attribute_definition(
    self,
    *,
    DomainName: str,
    CalculatedAttributeName: str,
) -> GetCalculatedAttributeDefinitionResponseTypeDef:  # (1)
    ...

1. See GetCalculatedAttributeDefinitionResponseTypeDef

# get_calculated_attribute_definition method usage example with argument unpacking

kwargs: GetCalculatedAttributeDefinitionRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "CalculatedAttributeName": ...,
}

parent.get_calculated_attribute_definition(**kwargs)

1. See GetCalculatedAttributeDefinitionRequestRequestTypeDef

get_calculated_attribute_for_profile

Retrieve a calculated attribute for a customer profile.

Type annotations and code completion for boto3.client("customer-profiles").get_calculated_attribute_for_profile method. boto3 documentation

# get_calculated_attribute_for_profile method definition

def get_calculated_attribute_for_profile(
    self,
    *,
    DomainName: str,
    ProfileId: str,
    CalculatedAttributeName: str,
) -> GetCalculatedAttributeForProfileResponseTypeDef:  # (1)
    ...

1. See GetCalculatedAttributeForProfileResponseTypeDef

# get_calculated_attribute_for_profile method usage example with argument unpacking

kwargs: GetCalculatedAttributeForProfileRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "ProfileId": ...,
    "CalculatedAttributeName": ...,
}

parent.get_calculated_attribute_for_profile(**kwargs)

1. See GetCalculatedAttributeForProfileRequestRequestTypeDef

get_domain

Returns information about a specific domain.

Type annotations and code completion for boto3.client("customer-profiles").get_domain method. boto3 documentation

# get_domain method definition

def get_domain(
    self,
    *,
    DomainName: str,
) -> GetDomainResponseTypeDef:  # (1)
    ...

1. See GetDomainResponseTypeDef

# get_domain method usage example with argument unpacking

kwargs: GetDomainRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.get_domain(**kwargs)

1. See GetDomainRequestRequestTypeDef

get_identity_resolution_job

Returns information about an Identity Resolution Job in a specific domain.

Type annotations and code completion for boto3.client("customer-profiles").get_identity_resolution_job method. boto3 documentation

# get_identity_resolution_job method definition

def get_identity_resolution_job(
    self,
    *,
    DomainName: str,
    JobId: str,
) -> GetIdentityResolutionJobResponseTypeDef:  # (1)
    ...

1. See GetIdentityResolutionJobResponseTypeDef

# get_identity_resolution_job method usage example with argument unpacking

kwargs: GetIdentityResolutionJobRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "JobId": ...,
}

parent.get_identity_resolution_job(**kwargs)

1. See GetIdentityResolutionJobRequestRequestTypeDef

get_integration

Returns an integration for a domain.

Type annotations and code completion for boto3.client("customer-profiles").get_integration method. boto3 documentation

# get_integration method definition

def get_integration(
    self,
    *,
    DomainName: str,
    Uri: str,
) -> GetIntegrationResponseTypeDef:  # (1)
    ...

1. See GetIntegrationResponseTypeDef

# get_integration method usage example with argument unpacking

kwargs: GetIntegrationRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "Uri": ...,
}

parent.get_integration(**kwargs)

1. See GetIntegrationRequestRequestTypeDef

get_matches

Before calling this API, use CreateDomain or UpdateDomain to enable identity resolution: set Matching to tr...

Type annotations and code completion for boto3.client("customer-profiles").get_matches method. boto3 documentation

# get_matches method definition

def get_matches(
    self,
    *,
    DomainName: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> GetMatchesResponseTypeDef:  # (1)
    ...

1. See GetMatchesResponseTypeDef

# get_matches method usage example with argument unpacking

kwargs: GetMatchesRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.get_matches(**kwargs)

1. See GetMatchesRequestRequestTypeDef

get_profile_object_type

Returns the object types for a specific domain.

Type annotations and code completion for boto3.client("customer-profiles").get_profile_object_type method. boto3 documentation

# get_profile_object_type method definition

def get_profile_object_type(
    self,
    *,
    DomainName: str,
    ObjectTypeName: str,
) -> GetProfileObjectTypeResponseTypeDef:  # (1)
    ...

1. See GetProfileObjectTypeResponseTypeDef

# get_profile_object_type method usage example with argument unpacking

kwargs: GetProfileObjectTypeRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "ObjectTypeName": ...,
}

parent.get_profile_object_type(**kwargs)

1. See GetProfileObjectTypeRequestRequestTypeDef

get_profile_object_type_template

Returns the template information for a specific object type.

Type annotations and code completion for boto3.client("customer-profiles").get_profile_object_type_template method. boto3 documentation

# get_profile_object_type_template method definition

def get_profile_object_type_template(
    self,
    *,
    TemplateId: str,
) -> GetProfileObjectTypeTemplateResponseTypeDef:  # (1)
    ...

1. See GetProfileObjectTypeTemplateResponseTypeDef

# get_profile_object_type_template method usage example with argument unpacking

kwargs: GetProfileObjectTypeTemplateRequestRequestTypeDef = {  # (1)
    "TemplateId": ...,
}

parent.get_profile_object_type_template(**kwargs)

1. See GetProfileObjectTypeTemplateRequestRequestTypeDef

get_workflow

Get details of specified workflow.

Type annotations and code completion for boto3.client("customer-profiles").get_workflow method. boto3 documentation

# get_workflow method definition

def get_workflow(
    self,
    *,
    DomainName: str,
    WorkflowId: str,
) -> GetWorkflowResponseTypeDef:  # (1)
    ...

1. See GetWorkflowResponseTypeDef

# get_workflow method usage example with argument unpacking

kwargs: GetWorkflowRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "WorkflowId": ...,
}

parent.get_workflow(**kwargs)

1. See GetWorkflowRequestRequestTypeDef

get_workflow_steps

Get granular list of steps in workflow.

Type annotations and code completion for boto3.client("customer-profiles").get_workflow_steps method. boto3 documentation

# get_workflow_steps method definition

def get_workflow_steps(
    self,
    *,
    DomainName: str,
    WorkflowId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> GetWorkflowStepsResponseTypeDef:  # (1)
    ...

1. See GetWorkflowStepsResponseTypeDef

# get_workflow_steps method usage example with argument unpacking

kwargs: GetWorkflowStepsRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "WorkflowId": ...,
}

parent.get_workflow_steps(**kwargs)

1. See GetWorkflowStepsRequestRequestTypeDef

list_account_integrations

Lists all of the integrations associated to a specific URI in the AWS account.

Type annotations and code completion for boto3.client("customer-profiles").list_account_integrations method. boto3 documentation

# list_account_integrations method definition

def list_account_integrations(
    self,
    *,
    Uri: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    IncludeHidden: bool = ...,
) -> ListAccountIntegrationsResponseTypeDef:  # (1)
    ...

1. See ListAccountIntegrationsResponseTypeDef

# list_account_integrations method usage example with argument unpacking

kwargs: ListAccountIntegrationsRequestRequestTypeDef = {  # (1)
    "Uri": ...,
}

parent.list_account_integrations(**kwargs)

1. See ListAccountIntegrationsRequestRequestTypeDef

list_calculated_attribute_definitions

Lists calculated attribute definitions for Customer Profiles See also: AWS API Documentation.

Type annotations and code completion for boto3.client("customer-profiles").list_calculated_attribute_definitions method. boto3 documentation

# list_calculated_attribute_definitions method definition

def list_calculated_attribute_definitions(
    self,
    *,
    DomainName: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListCalculatedAttributeDefinitionsResponseTypeDef:  # (1)
    ...

1. See ListCalculatedAttributeDefinitionsResponseTypeDef

# list_calculated_attribute_definitions method usage example with argument unpacking

kwargs: ListCalculatedAttributeDefinitionsRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.list_calculated_attribute_definitions(**kwargs)

1. See ListCalculatedAttributeDefinitionsRequestRequestTypeDef

list_calculated_attributes_for_profile

Retrieve a list of calculated attributes for a customer profile.

Type annotations and code completion for boto3.client("customer-profiles").list_calculated_attributes_for_profile method. boto3 documentation

# list_calculated_attributes_for_profile method definition

def list_calculated_attributes_for_profile(
    self,
    *,
    DomainName: str,
    ProfileId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListCalculatedAttributesForProfileResponseTypeDef:  # (1)
    ...

1. See ListCalculatedAttributesForProfileResponseTypeDef

# list_calculated_attributes_for_profile method usage example with argument unpacking

kwargs: ListCalculatedAttributesForProfileRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "ProfileId": ...,
}

parent.list_calculated_attributes_for_profile(**kwargs)

1. See ListCalculatedAttributesForProfileRequestRequestTypeDef

list_domains

Returns a list of all the domains for an AWS account that have been created.

Type annotations and code completion for boto3.client("customer-profiles").list_domains method. boto3 documentation

# list_domains method definition

def list_domains(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDomainsResponseTypeDef:  # (1)
    ...

1. See ListDomainsResponseTypeDef

# list_domains method usage example with argument unpacking

kwargs: ListDomainsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_domains(**kwargs)

1. See ListDomainsRequestRequestTypeDef

list_identity_resolution_jobs

Lists all of the Identity Resolution Jobs in your domain.

Type annotations and code completion for boto3.client("customer-profiles").list_identity_resolution_jobs method. boto3 documentation

# list_identity_resolution_jobs method definition

def list_identity_resolution_jobs(
    self,
    *,
    DomainName: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListIdentityResolutionJobsResponseTypeDef:  # (1)
    ...

1. See ListIdentityResolutionJobsResponseTypeDef

# list_identity_resolution_jobs method usage example with argument unpacking

kwargs: ListIdentityResolutionJobsRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.list_identity_resolution_jobs(**kwargs)

1. See ListIdentityResolutionJobsRequestRequestTypeDef

list_integrations

Lists all of the integrations in your domain.

Type annotations and code completion for boto3.client("customer-profiles").list_integrations method. boto3 documentation

# list_integrations method definition

def list_integrations(
    self,
    *,
    DomainName: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    IncludeHidden: bool = ...,
) -> ListIntegrationsResponseTypeDef:  # (1)
    ...

1. See ListIntegrationsResponseTypeDef

# list_integrations method usage example with argument unpacking

kwargs: ListIntegrationsRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.list_integrations(**kwargs)

1. See ListIntegrationsRequestRequestTypeDef

list_profile_object_type_templates

Lists all of the template information for object types.

Type annotations and code completion for boto3.client("customer-profiles").list_profile_object_type_templates method. boto3 documentation

# list_profile_object_type_templates method definition

def list_profile_object_type_templates(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListProfileObjectTypeTemplatesResponseTypeDef:  # (1)
    ...

1. See ListProfileObjectTypeTemplatesResponseTypeDef

# list_profile_object_type_templates method usage example with argument unpacking

kwargs: ListProfileObjectTypeTemplatesRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_profile_object_type_templates(**kwargs)

1. See ListProfileObjectTypeTemplatesRequestRequestTypeDef

list_profile_object_types

Lists all of the templates available within the service.

Type annotations and code completion for boto3.client("customer-profiles").list_profile_object_types method. boto3 documentation

# list_profile_object_types method definition

def list_profile_object_types(
    self,
    *,
    DomainName: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListProfileObjectTypesResponseTypeDef:  # (1)
    ...

1. See ListProfileObjectTypesResponseTypeDef

# list_profile_object_types method usage example with argument unpacking

kwargs: ListProfileObjectTypesRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.list_profile_object_types(**kwargs)

1. See ListProfileObjectTypesRequestRequestTypeDef

list_profile_objects

Returns a list of objects associated with a profile of a given ProfileObjectType.

Type annotations and code completion for boto3.client("customer-profiles").list_profile_objects method. boto3 documentation

# list_profile_objects method definition

def list_profile_objects(
    self,
    *,
    DomainName: str,
    ObjectTypeName: str,
    ProfileId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    ObjectFilter: ObjectFilterTypeDef = ...,  # (1)
) -> ListProfileObjectsResponseTypeDef:  # (2)
    ...

1. See ObjectFilterTypeDef
2. See ListProfileObjectsResponseTypeDef

# list_profile_objects method usage example with argument unpacking

kwargs: ListProfileObjectsRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "ObjectTypeName": ...,
    "ProfileId": ...,
}

parent.list_profile_objects(**kwargs)

1. See ListProfileObjectsRequestRequestTypeDef

list_tags_for_resource

Displays the tags associated with an Amazon Connect Customer Profiles resource.

Type annotations and code completion for boto3.client("customer-profiles").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

list_workflows

Query to list all workflows.

Type annotations and code completion for boto3.client("customer-profiles").list_workflows method. boto3 documentation

# list_workflows method definition

def list_workflows(
    self,
    *,
    DomainName: str,
    WorkflowType: WorkflowTypeType = ...,  # (1)
    Status: StatusType = ...,  # (2)
    QueryStartDate: Union[datetime, str] = ...,
    QueryEndDate: Union[datetime, str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListWorkflowsResponseTypeDef:  # (3)
    ...

1. See WorkflowTypeType
2. See StatusType
3. See ListWorkflowsResponseTypeDef

# list_workflows method usage example with argument unpacking

kwargs: ListWorkflowsRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.list_workflows(**kwargs)

1. See ListWorkflowsRequestRequestTypeDef

merge_profiles

Runs an AWS Lambda job that does the following: * All the profileKeys in the ProfileToBeMerged will be moved to the main profile.

Type annotations and code completion for boto3.client("customer-profiles").merge_profiles method. boto3 documentation

# merge_profiles method definition

def merge_profiles(
    self,
    *,
    DomainName: str,
    MainProfileId: str,
    ProfileIdsToBeMerged: Sequence[str],
    FieldSourceProfileIds: FieldSourceProfileIdsTypeDef = ...,  # (1)
) -> MergeProfilesResponseTypeDef:  # (2)
    ...

1. See FieldSourceProfileIdsTypeDef
2. See MergeProfilesResponseTypeDef

# merge_profiles method usage example with argument unpacking

kwargs: MergeProfilesRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "MainProfileId": ...,
    "ProfileIdsToBeMerged": ...,
}

parent.merge_profiles(**kwargs)

1. See MergeProfilesRequestRequestTypeDef

put_integration

Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.

Type annotations and code completion for boto3.client("customer-profiles").put_integration method. boto3 documentation

# put_integration method definition

def put_integration(
    self,
    *,
    DomainName: str,
    Uri: str = ...,
    ObjectTypeName: str = ...,
    Tags: Mapping[str, str] = ...,
    FlowDefinition: FlowDefinitionTypeDef = ...,  # (1)
    ObjectTypeNames: Mapping[str, str] = ...,
) -> PutIntegrationResponseTypeDef:  # (2)
    ...

1. See FlowDefinitionTypeDef
2. See PutIntegrationResponseTypeDef

# put_integration method usage example with argument unpacking

kwargs: PutIntegrationRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.put_integration(**kwargs)

1. See PutIntegrationRequestRequestTypeDef

put_profile_object

Adds additional objects to customer profiles of a given ObjectType.

Type annotations and code completion for boto3.client("customer-profiles").put_profile_object method. boto3 documentation

# put_profile_object method definition

def put_profile_object(
    self,
    *,
    ObjectTypeName: str,
    Object: str,
    DomainName: str,
) -> PutProfileObjectResponseTypeDef:  # (1)
    ...

1. See PutProfileObjectResponseTypeDef

# put_profile_object method usage example with argument unpacking

kwargs: PutProfileObjectRequestRequestTypeDef = {  # (1)
    "ObjectTypeName": ...,
    "Object": ...,
    "DomainName": ...,
}

parent.put_profile_object(**kwargs)

1. See PutProfileObjectRequestRequestTypeDef

put_profile_object_type

Defines a ProfileObjectType.

Type annotations and code completion for boto3.client("customer-profiles").put_profile_object_type method. boto3 documentation

# put_profile_object_type method definition

def put_profile_object_type(
    self,
    *,
    DomainName: str,
    ObjectTypeName: str,
    Description: str,
    TemplateId: str = ...,
    ExpirationDays: int = ...,
    EncryptionKey: str = ...,
    AllowProfileCreation: bool = ...,
    SourceLastUpdatedTimestampFormat: str = ...,
    Fields: Mapping[str, ObjectTypeFieldTypeDef] = ...,  # (1)
    Keys: Mapping[str, Sequence[ObjectTypeKeyTypeDef]] = ...,  # (2)
    Tags: Mapping[str, str] = ...,
) -> PutProfileObjectTypeResponseTypeDef:  # (3)
    ...

1. See ObjectTypeFieldTypeDef
2. See ObjectTypeKeyTypeDef
3. See PutProfileObjectTypeResponseTypeDef

# put_profile_object_type method usage example with argument unpacking

kwargs: PutProfileObjectTypeRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "ObjectTypeName": ...,
    "Description": ...,
}

parent.put_profile_object_type(**kwargs)

1. See PutProfileObjectTypeRequestRequestTypeDef

search_profiles

Searches for profiles within a specific domain using one or more predefined search keys (e.g., _fullName, _phone, _email, _account, etc.) and/or custom- defined search keys.

Type annotations and code completion for boto3.client("customer-profiles").search_profiles method. boto3 documentation

# search_profiles method definition

def search_profiles(
    self,
    *,
    DomainName: str,
    KeyName: str,
    Values: Sequence[str],
    NextToken: str = ...,
    MaxResults: int = ...,
    AdditionalSearchKeys: Sequence[AdditionalSearchKeyTypeDef] = ...,  # (1)
    LogicalOperator: logicalOperatorType = ...,  # (2)
) -> SearchProfilesResponseTypeDef:  # (3)
    ...

1. See AdditionalSearchKeyTypeDef
2. See logicalOperatorType
3. See SearchProfilesResponseTypeDef

# search_profiles method usage example with argument unpacking

kwargs: SearchProfilesRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "KeyName": ...,
    "Values": ...,
}

parent.search_profiles(**kwargs)

1. See SearchProfilesRequestRequestTypeDef

tag_resource

Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource.

Type annotations and code completion for boto3.client("customer-profiles").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes one or more tags from the specified Amazon Connect Customer Profiles resource.

Type annotations and code completion for boto3.client("customer-profiles").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_calculated_attribute_definition

Updates an existing calculated attribute definition.

Type annotations and code completion for boto3.client("customer-profiles").update_calculated_attribute_definition method. boto3 documentation

# update_calculated_attribute_definition method definition

def update_calculated_attribute_definition(
    self,
    *,
    DomainName: str,
    CalculatedAttributeName: str,
    DisplayName: str = ...,
    Description: str = ...,
    Conditions: ConditionsTypeDef = ...,  # (1)
) -> UpdateCalculatedAttributeDefinitionResponseTypeDef:  # (2)
    ...

1. See ConditionsTypeDef
2. See UpdateCalculatedAttributeDefinitionResponseTypeDef

# update_calculated_attribute_definition method usage example with argument unpacking

kwargs: UpdateCalculatedAttributeDefinitionRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "CalculatedAttributeName": ...,
}

parent.update_calculated_attribute_definition(**kwargs)

1. See UpdateCalculatedAttributeDefinitionRequestRequestTypeDef

update_domain

Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.

Type annotations and code completion for boto3.client("customer-profiles").update_domain method. boto3 documentation

# update_domain method definition

def update_domain(
    self,
    *,
    DomainName: str,
    DefaultExpirationDays: int = ...,
    DefaultEncryptionKey: str = ...,
    DeadLetterQueueUrl: str = ...,
    Matching: MatchingRequestTypeDef = ...,  # (1)
    Tags: Mapping[str, str] = ...,
) -> UpdateDomainResponseTypeDef:  # (2)
    ...

1. See MatchingRequestTypeDef
2. See UpdateDomainResponseTypeDef

# update_domain method usage example with argument unpacking

kwargs: UpdateDomainRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.update_domain(**kwargs)

1. See UpdateDomainRequestRequestTypeDef

update_profile

Updates the properties of a profile.

Type annotations and code completion for boto3.client("customer-profiles").update_profile method. boto3 documentation

# update_profile method definition

def update_profile(
    self,
    *,
    DomainName: str,
    ProfileId: str,
    AdditionalInformation: str = ...,
    AccountNumber: 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: UpdateAddressTypeDef = ...,  # (3)
    ShippingAddress: UpdateAddressTypeDef = ...,  # (3)
    MailingAddress: UpdateAddressTypeDef = ...,  # (3)
    BillingAddress: UpdateAddressTypeDef = ...,  # (3)
    Attributes: Mapping[str, str] = ...,
    PartyTypeString: str = ...,
    GenderString: str = ...,
) -> UpdateProfileResponseTypeDef:  # (7)
    ...

1. See PartyTypeType
2. See GenderType
3. See UpdateAddressTypeDef
4. See UpdateAddressTypeDef
5. See UpdateAddressTypeDef
6. See UpdateAddressTypeDef
7. See UpdateProfileResponseTypeDef

# update_profile method usage example with argument unpacking

kwargs: UpdateProfileRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "ProfileId": ...,
}

parent.update_profile(**kwargs)

1. See UpdateProfileRequestRequestTypeDef