Interface CustomerProfilesClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Amazon Connect Customer Profiles is a unified customer profile for your contact center that has pre-built connectors powered by AppFlow that make it easy to combine customer information from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center. If you're new to Amazon Connect, you might find it helpful to review the Amazon Connect Administrator Guide.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault AddProfileKeyResponse
addProfileKey
(Consumer<AddProfileKeyRequest.Builder> addProfileKeyRequest) Associates a new key value with a specific profile, such as a Contact Record ContactId.default AddProfileKeyResponse
addProfileKey
(AddProfileKeyRequest addProfileKeyRequest) Associates a new key value with a specific profile, such as a Contact Record ContactId.builder()
Create a builder that can be used to configure and create aCustomerProfilesClient
.static CustomerProfilesClient
create()
Create aCustomerProfilesClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createCalculatedAttributeDefinition
(Consumer<CreateCalculatedAttributeDefinitionRequest.Builder> createCalculatedAttributeDefinitionRequest) Creates a new calculated attribute definition.createCalculatedAttributeDefinition
(CreateCalculatedAttributeDefinitionRequest createCalculatedAttributeDefinitionRequest) Creates a new calculated attribute definition.default CreateDomainResponse
createDomain
(Consumer<CreateDomainRequest.Builder> createDomainRequest) Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys.default CreateDomainResponse
createDomain
(CreateDomainRequest createDomainRequest) Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys.default CreateEventStreamResponse
createEventStream
(Consumer<CreateEventStreamRequest.Builder> createEventStreamRequest) 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.default CreateEventStreamResponse
createEventStream
(CreateEventStreamRequest createEventStreamRequest) 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.createIntegrationWorkflow
(Consumer<CreateIntegrationWorkflowRequest.Builder> createIntegrationWorkflowRequest) Creates an integration workflow.createIntegrationWorkflow
(CreateIntegrationWorkflowRequest createIntegrationWorkflowRequest) Creates an integration workflow.default CreateProfileResponse
createProfile
(Consumer<CreateProfileRequest.Builder> createProfileRequest) Creates a standard profile.default CreateProfileResponse
createProfile
(CreateProfileRequest createProfileRequest) Creates a standard profile.deleteCalculatedAttributeDefinition
(Consumer<DeleteCalculatedAttributeDefinitionRequest.Builder> deleteCalculatedAttributeDefinitionRequest) Deletes an existing calculated attribute definition.deleteCalculatedAttributeDefinition
(DeleteCalculatedAttributeDefinitionRequest deleteCalculatedAttributeDefinitionRequest) Deletes an existing calculated attribute definition.default DeleteDomainResponse
deleteDomain
(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest) Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.default DeleteDomainResponse
deleteDomain
(DeleteDomainRequest deleteDomainRequest) Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.default DeleteEventStreamResponse
deleteEventStream
(Consumer<DeleteEventStreamRequest.Builder> deleteEventStreamRequest) Disables and deletes the specified event stream.default DeleteEventStreamResponse
deleteEventStream
(DeleteEventStreamRequest deleteEventStreamRequest) Disables and deletes the specified event stream.default DeleteIntegrationResponse
deleteIntegration
(Consumer<DeleteIntegrationRequest.Builder> deleteIntegrationRequest) Removes an integration from a specific domain.default DeleteIntegrationResponse
deleteIntegration
(DeleteIntegrationRequest deleteIntegrationRequest) Removes an integration from a specific domain.default DeleteProfileResponse
deleteProfile
(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest) Deletes the standard customer profile and all data pertaining to the profile.default DeleteProfileResponse
deleteProfile
(DeleteProfileRequest deleteProfileRequest) Deletes the standard customer profile and all data pertaining to the profile.default DeleteProfileKeyResponse
deleteProfileKey
(Consumer<DeleteProfileKeyRequest.Builder> deleteProfileKeyRequest) Removes a searchable key from a customer profile.default DeleteProfileKeyResponse
deleteProfileKey
(DeleteProfileKeyRequest deleteProfileKeyRequest) Removes a searchable key from a customer profile.default DeleteProfileObjectResponse
deleteProfileObject
(Consumer<DeleteProfileObjectRequest.Builder> deleteProfileObjectRequest) Removes an object associated with a profile of a given ProfileObjectType.default DeleteProfileObjectResponse
deleteProfileObject
(DeleteProfileObjectRequest deleteProfileObjectRequest) Removes an object associated with a profile of a given ProfileObjectType.default DeleteProfileObjectTypeResponse
deleteProfileObjectType
(Consumer<DeleteProfileObjectTypeRequest.Builder> deleteProfileObjectTypeRequest) Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type.default DeleteProfileObjectTypeResponse
deleteProfileObjectType
(DeleteProfileObjectTypeRequest deleteProfileObjectTypeRequest) Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type.default DeleteWorkflowResponse
deleteWorkflow
(Consumer<DeleteWorkflowRequest.Builder> deleteWorkflowRequest) Deletes the specified workflow and all its corresponding resources.default DeleteWorkflowResponse
deleteWorkflow
(DeleteWorkflowRequest deleteWorkflowRequest) Deletes the specified workflow and all its corresponding resources.default DetectProfileObjectTypeResponse
detectProfileObjectType
(Consumer<DetectProfileObjectTypeRequest.Builder> detectProfileObjectTypeRequest) The process of detecting profile object type mapping by using given objects.default DetectProfileObjectTypeResponse
detectProfileObjectType
(DetectProfileObjectTypeRequest detectProfileObjectTypeRequest) The process of detecting profile object type mapping by using given objects.default GetAutoMergingPreviewResponse
getAutoMergingPreview
(Consumer<GetAutoMergingPreviewRequest.Builder> getAutoMergingPreviewRequest) Tests the auto-merging settings of your Identity Resolution Job without merging your data.default GetAutoMergingPreviewResponse
getAutoMergingPreview
(GetAutoMergingPreviewRequest getAutoMergingPreviewRequest) Tests the auto-merging settings of your Identity Resolution Job without merging your data.getCalculatedAttributeDefinition
(Consumer<GetCalculatedAttributeDefinitionRequest.Builder> getCalculatedAttributeDefinitionRequest) Provides more information on a calculated attribute definition for Customer Profiles.getCalculatedAttributeDefinition
(GetCalculatedAttributeDefinitionRequest getCalculatedAttributeDefinitionRequest) Provides more information on a calculated attribute definition for Customer Profiles.getCalculatedAttributeForProfile
(Consumer<GetCalculatedAttributeForProfileRequest.Builder> getCalculatedAttributeForProfileRequest) Retrieve a calculated attribute for a customer profile.getCalculatedAttributeForProfile
(GetCalculatedAttributeForProfileRequest getCalculatedAttributeForProfileRequest) Retrieve a calculated attribute for a customer profile.default GetDomainResponse
getDomain
(Consumer<GetDomainRequest.Builder> getDomainRequest) Returns information about a specific domain.default GetDomainResponse
getDomain
(GetDomainRequest getDomainRequest) Returns information about a specific domain.default GetEventStreamResponse
getEventStream
(Consumer<GetEventStreamRequest.Builder> getEventStreamRequest) Returns information about the specified event stream in a specific domain.default GetEventStreamResponse
getEventStream
(GetEventStreamRequest getEventStreamRequest) Returns information about the specified event stream in a specific domain.default GetIdentityResolutionJobResponse
getIdentityResolutionJob
(Consumer<GetIdentityResolutionJobRequest.Builder> getIdentityResolutionJobRequest) Returns information about an Identity Resolution Job in a specific domain.default GetIdentityResolutionJobResponse
getIdentityResolutionJob
(GetIdentityResolutionJobRequest getIdentityResolutionJobRequest) Returns information about an Identity Resolution Job in a specific domain.default GetIntegrationResponse
getIntegration
(Consumer<GetIntegrationRequest.Builder> getIntegrationRequest) Returns an integration for a domain.default GetIntegrationResponse
getIntegration
(GetIntegrationRequest getIntegrationRequest) Returns an integration for a domain.default GetMatchesResponse
getMatches
(Consumer<GetMatchesRequest.Builder> getMatchesRequest) Before calling this API, use CreateDomain or UpdateDomain to enable identity resolution: setMatching
to true.default GetMatchesResponse
getMatches
(GetMatchesRequest getMatchesRequest) Before calling this API, use CreateDomain or UpdateDomain to enable identity resolution: setMatching
to true.default GetProfileObjectTypeResponse
getProfileObjectType
(Consumer<GetProfileObjectTypeRequest.Builder> getProfileObjectTypeRequest) Returns the object types for a specific domain.default GetProfileObjectTypeResponse
getProfileObjectType
(GetProfileObjectTypeRequest getProfileObjectTypeRequest) Returns the object types for a specific domain.getProfileObjectTypeTemplate
(Consumer<GetProfileObjectTypeTemplateRequest.Builder> getProfileObjectTypeTemplateRequest) Returns the template information for a specific object type.getProfileObjectTypeTemplate
(GetProfileObjectTypeTemplateRequest getProfileObjectTypeTemplateRequest) Returns the template information for a specific object type.default GetSimilarProfilesResponse
getSimilarProfiles
(Consumer<GetSimilarProfilesRequest.Builder> getSimilarProfilesRequest) Returns a set of profiles that belong to the same matching group using thematchId
orprofileId
.default GetSimilarProfilesResponse
getSimilarProfiles
(GetSimilarProfilesRequest getSimilarProfilesRequest) Returns a set of profiles that belong to the same matching group using thematchId
orprofileId
.default GetWorkflowResponse
getWorkflow
(Consumer<GetWorkflowRequest.Builder> getWorkflowRequest) Get details of specified workflow.default GetWorkflowResponse
getWorkflow
(GetWorkflowRequest getWorkflowRequest) Get details of specified workflow.default GetWorkflowStepsResponse
getWorkflowSteps
(Consumer<GetWorkflowStepsRequest.Builder> getWorkflowStepsRequest) Get granular list of steps in workflow.default GetWorkflowStepsResponse
getWorkflowSteps
(GetWorkflowStepsRequest getWorkflowStepsRequest) Get granular list of steps in workflow.default ListAccountIntegrationsResponse
listAccountIntegrations
(Consumer<ListAccountIntegrationsRequest.Builder> listAccountIntegrationsRequest) Lists all of the integrations associated to a specific URI in the AWS account.default ListAccountIntegrationsResponse
listAccountIntegrations
(ListAccountIntegrationsRequest listAccountIntegrationsRequest) Lists all of the integrations associated to a specific URI in the AWS account.listCalculatedAttributeDefinitions
(Consumer<ListCalculatedAttributeDefinitionsRequest.Builder> listCalculatedAttributeDefinitionsRequest) Lists calculated attribute definitions for Customer ProfileslistCalculatedAttributeDefinitions
(ListCalculatedAttributeDefinitionsRequest listCalculatedAttributeDefinitionsRequest) Lists calculated attribute definitions for Customer ProfileslistCalculatedAttributesForProfile
(Consumer<ListCalculatedAttributesForProfileRequest.Builder> listCalculatedAttributesForProfileRequest) Retrieve a list of calculated attributes for a customer profile.listCalculatedAttributesForProfile
(ListCalculatedAttributesForProfileRequest listCalculatedAttributesForProfileRequest) Retrieve a list of calculated attributes for a customer profile.default ListDomainsResponse
listDomains
(Consumer<ListDomainsRequest.Builder> listDomainsRequest) Returns a list of all the domains for an AWS account that have been created.default ListDomainsResponse
listDomains
(ListDomainsRequest listDomainsRequest) Returns a list of all the domains for an AWS account that have been created.default ListEventStreamsResponse
listEventStreams
(Consumer<ListEventStreamsRequest.Builder> listEventStreamsRequest) Returns a list of all the event streams in a specific domain.default ListEventStreamsResponse
listEventStreams
(ListEventStreamsRequest listEventStreamsRequest) Returns a list of all the event streams in a specific domain.default ListEventStreamsIterable
listEventStreamsPaginator
(Consumer<ListEventStreamsRequest.Builder> listEventStreamsRequest) This is a variant oflistEventStreams(software.amazon.awssdk.services.customerprofiles.model.ListEventStreamsRequest)
operation.default ListEventStreamsIterable
listEventStreamsPaginator
(ListEventStreamsRequest listEventStreamsRequest) This is a variant oflistEventStreams(software.amazon.awssdk.services.customerprofiles.model.ListEventStreamsRequest)
operation.listIdentityResolutionJobs
(Consumer<ListIdentityResolutionJobsRequest.Builder> listIdentityResolutionJobsRequest) Lists all of the Identity Resolution Jobs in your domain.listIdentityResolutionJobs
(ListIdentityResolutionJobsRequest listIdentityResolutionJobsRequest) Lists all of the Identity Resolution Jobs in your domain.default ListIntegrationsResponse
listIntegrations
(Consumer<ListIntegrationsRequest.Builder> listIntegrationsRequest) Lists all of the integrations in your domain.default ListIntegrationsResponse
listIntegrations
(ListIntegrationsRequest listIntegrationsRequest) Lists all of the integrations in your domain.default ListProfileObjectsResponse
listProfileObjects
(Consumer<ListProfileObjectsRequest.Builder> listProfileObjectsRequest) Returns a list of objects associated with a profile of a given ProfileObjectType.default ListProfileObjectsResponse
listProfileObjects
(ListProfileObjectsRequest listProfileObjectsRequest) Returns a list of objects associated with a profile of a given ProfileObjectType.default ListProfileObjectTypesResponse
listProfileObjectTypes
(Consumer<ListProfileObjectTypesRequest.Builder> listProfileObjectTypesRequest) Lists all of the templates available within the service.default ListProfileObjectTypesResponse
listProfileObjectTypes
(ListProfileObjectTypesRequest listProfileObjectTypesRequest) Lists all of the templates available within the service.listProfileObjectTypeTemplates
(Consumer<ListProfileObjectTypeTemplatesRequest.Builder> listProfileObjectTypeTemplatesRequest) Lists all of the template information for object types.listProfileObjectTypeTemplates
(ListProfileObjectTypeTemplatesRequest listProfileObjectTypeTemplatesRequest) Lists all of the template information for object types.default ListRuleBasedMatchesResponse
listRuleBasedMatches
(Consumer<ListRuleBasedMatchesRequest.Builder> listRuleBasedMatchesRequest) Returns a set ofMatchIds
that belong to the given domain.default ListRuleBasedMatchesResponse
listRuleBasedMatches
(ListRuleBasedMatchesRequest listRuleBasedMatchesRequest) Returns a set ofMatchIds
that belong to the given domain.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Displays the tags associated with an Amazon Connect Customer Profiles resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Displays the tags associated with an Amazon Connect Customer Profiles resource.default ListWorkflowsResponse
listWorkflows
(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest) Query to list all workflows.default ListWorkflowsResponse
listWorkflows
(ListWorkflowsRequest listWorkflowsRequest) Query to list all workflows.default MergeProfilesResponse
mergeProfiles
(Consumer<MergeProfilesRequest.Builder> mergeProfilesRequest) Runs an AWS Lambda job that does the following:default MergeProfilesResponse
mergeProfiles
(MergeProfilesRequest mergeProfilesRequest) Runs an AWS Lambda job that does the following:default PutIntegrationResponse
putIntegration
(Consumer<PutIntegrationRequest.Builder> putIntegrationRequest) Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.default PutIntegrationResponse
putIntegration
(PutIntegrationRequest putIntegrationRequest) Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.default PutProfileObjectResponse
putProfileObject
(Consumer<PutProfileObjectRequest.Builder> putProfileObjectRequest) Adds additional objects to customer profiles of a given ObjectType.default PutProfileObjectResponse
putProfileObject
(PutProfileObjectRequest putProfileObjectRequest) Adds additional objects to customer profiles of a given ObjectType.default PutProfileObjectTypeResponse
putProfileObjectType
(Consumer<PutProfileObjectTypeRequest.Builder> putProfileObjectTypeRequest) Defines a ProfileObjectType.default PutProfileObjectTypeResponse
putProfileObjectType
(PutProfileObjectTypeRequest putProfileObjectTypeRequest) Defines a ProfileObjectType.default SearchProfilesResponse
searchProfiles
(Consumer<SearchProfilesRequest.Builder> searchProfilesRequest) 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.default SearchProfilesResponse
searchProfiles
(SearchProfilesRequest searchProfilesRequest) 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.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from the specified Amazon Connect Customer Profiles resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes one or more tags from the specified Amazon Connect Customer Profiles resource.updateCalculatedAttributeDefinition
(Consumer<UpdateCalculatedAttributeDefinitionRequest.Builder> updateCalculatedAttributeDefinitionRequest) Updates an existing calculated attribute definition.updateCalculatedAttributeDefinition
(UpdateCalculatedAttributeDefinitionRequest updateCalculatedAttributeDefinitionRequest) Updates an existing calculated attribute definition.default UpdateDomainResponse
updateDomain
(Consumer<UpdateDomainRequest.Builder> updateDomainRequest) Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.default UpdateDomainResponse
updateDomain
(UpdateDomainRequest updateDomainRequest) Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.default UpdateProfileResponse
updateProfile
(Consumer<UpdateProfileRequest.Builder> updateProfileRequest) Updates the properties of a profile.default UpdateProfileResponse
updateProfile
(UpdateProfileRequest updateProfileRequest) Updates the properties of a profile.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
addProfileKey
default AddProfileKeyResponse addProfileKey(AddProfileKeyRequest addProfileKeyRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Associates a new key value with a specific profile, such as a Contact Record ContactId.
A profile object can have a single unique key and any number of additional keys that can be used to identify the profile that it belongs to.
- Parameters:
addProfileKeyRequest
-- Returns:
- Result of the AddProfileKey operation returned by the service.
- See Also:
-
addProfileKey
default AddProfileKeyResponse addProfileKey(Consumer<AddProfileKeyRequest.Builder> addProfileKeyRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Associates a new key value with a specific profile, such as a Contact Record ContactId.
A profile object can have a single unique key and any number of additional keys that can be used to identify the profile that it belongs to.
This is a convenience which creates an instance of the
AddProfileKeyRequest.Builder
avoiding the need to create one manually viaAddProfileKeyRequest.builder()
- Parameters:
addProfileKeyRequest
- AConsumer
that will call methods onAddProfileKeyRequest.Builder
to create a request.- Returns:
- Result of the AddProfileKey operation returned by the service.
- See Also:
-
createCalculatedAttributeDefinition
default CreateCalculatedAttributeDefinitionResponse createCalculatedAttributeDefinition(CreateCalculatedAttributeDefinitionRequest createCalculatedAttributeDefinitionRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Creates a new calculated attribute definition. After creation, new object data ingested into Customer Profiles will be included in the calculated attribute, which can be retrieved for a profile using the GetCalculatedAttributeForProfile API. Defining a calculated attribute makes it available for all profiles within a domain. Each calculated attribute can only reference one
ObjectType
and at most, two fields from thatObjectType
.- Parameters:
createCalculatedAttributeDefinitionRequest
-- Returns:
- Result of the CreateCalculatedAttributeDefinition operation returned by the service.
- See Also:
-
createCalculatedAttributeDefinition
default CreateCalculatedAttributeDefinitionResponse createCalculatedAttributeDefinition(Consumer<CreateCalculatedAttributeDefinitionRequest.Builder> createCalculatedAttributeDefinitionRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Creates a new calculated attribute definition. After creation, new object data ingested into Customer Profiles will be included in the calculated attribute, which can be retrieved for a profile using the GetCalculatedAttributeForProfile API. Defining a calculated attribute makes it available for all profiles within a domain. Each calculated attribute can only reference one
ObjectType
and at most, two fields from thatObjectType
.
This is a convenience which creates an instance of the
CreateCalculatedAttributeDefinitionRequest.Builder
avoiding the need to create one manually viaCreateCalculatedAttributeDefinitionRequest.builder()
- Parameters:
createCalculatedAttributeDefinitionRequest
- AConsumer
that will call methods onCreateCalculatedAttributeDefinitionRequest.Builder
to create a request.- Returns:
- Result of the CreateCalculatedAttributeDefinition operation returned by the service.
- See Also:
-
createDomain
default CreateDomainResponse createDomain(CreateDomainRequest createDomainRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys. You can create multiple domains, and each domain can have multiple third-party integrations.
Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain.
Use this API or UpdateDomain to enable identity resolution: set
Matching
to true.To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply.
- Parameters:
createDomainRequest
-- Returns:
- Result of the CreateDomain operation returned by the service.
- See Also:
-
createDomain
default CreateDomainResponse createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys. You can create multiple domains, and each domain can have multiple third-party integrations.
Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain.
Use this API or UpdateDomain to enable identity resolution: set
Matching
to true.To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply.
This is a convenience which creates an instance of the
CreateDomainRequest.Builder
avoiding the need to create one manually viaCreateDomainRequest.builder()
- Parameters:
createDomainRequest
- AConsumer
that will call methods onCreateDomainRequest.Builder
to create a request.- Returns:
- Result of the CreateDomain operation returned by the service.
- See Also:
-
createEventStream
default CreateEventStreamResponse createEventStream(CreateEventStreamRequest createEventStreamRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException 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.
Each event stream can be associated with only one Kinesis Data Stream destination in the same region and Amazon Web Services account as the customer profiles domain
- Parameters:
createEventStreamRequest
-- Returns:
- Result of the CreateEventStream operation returned by the service.
- See Also:
-
createEventStream
default CreateEventStreamResponse createEventStream(Consumer<CreateEventStreamRequest.Builder> createEventStreamRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException 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.
Each event stream can be associated with only one Kinesis Data Stream destination in the same region and Amazon Web Services account as the customer profiles domain
This is a convenience which creates an instance of the
CreateEventStreamRequest.Builder
avoiding the need to create one manually viaCreateEventStreamRequest.builder()
- Parameters:
createEventStreamRequest
- AConsumer
that will call methods onCreateEventStreamRequest.Builder
to create a request.- Returns:
- Result of the CreateEventStream operation returned by the service.
- See Also:
-
createIntegrationWorkflow
default CreateIntegrationWorkflowResponse createIntegrationWorkflow(CreateIntegrationWorkflowRequest createIntegrationWorkflowRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Creates an integration workflow. An integration workflow is an async process which ingests historic data and sets up an integration for ongoing updates. The supported Amazon AppFlow sources are Salesforce, ServiceNow, and Marketo.
- Parameters:
createIntegrationWorkflowRequest
-- Returns:
- Result of the CreateIntegrationWorkflow operation returned by the service.
- See Also:
-
createIntegrationWorkflow
default CreateIntegrationWorkflowResponse createIntegrationWorkflow(Consumer<CreateIntegrationWorkflowRequest.Builder> createIntegrationWorkflowRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Creates an integration workflow. An integration workflow is an async process which ingests historic data and sets up an integration for ongoing updates. The supported Amazon AppFlow sources are Salesforce, ServiceNow, and Marketo.
This is a convenience which creates an instance of the
CreateIntegrationWorkflowRequest.Builder
avoiding the need to create one manually viaCreateIntegrationWorkflowRequest.builder()
- Parameters:
createIntegrationWorkflowRequest
- AConsumer
that will call methods onCreateIntegrationWorkflowRequest.Builder
to create a request.- Returns:
- Result of the CreateIntegrationWorkflow operation returned by the service.
- See Also:
-
createProfile
default CreateProfileResponse createProfile(CreateProfileRequest createProfileRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Creates a standard profile.
A standard profile represents the following attributes for a customer profile in a domain.
- Parameters:
createProfileRequest
-- Returns:
- Result of the CreateProfile operation returned by the service.
- See Also:
-
createProfile
default CreateProfileResponse createProfile(Consumer<CreateProfileRequest.Builder> createProfileRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Creates a standard profile.
A standard profile represents the following attributes for a customer profile in a domain.
This is a convenience which creates an instance of the
CreateProfileRequest.Builder
avoiding the need to create one manually viaCreateProfileRequest.builder()
- Parameters:
createProfileRequest
- AConsumer
that will call methods onCreateProfileRequest.Builder
to create a request.- Returns:
- Result of the CreateProfile operation returned by the service.
- See Also:
-
deleteCalculatedAttributeDefinition
default DeleteCalculatedAttributeDefinitionResponse deleteCalculatedAttributeDefinition(DeleteCalculatedAttributeDefinitionRequest deleteCalculatedAttributeDefinitionRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Deletes an existing calculated attribute definition. Note that deleting a default calculated attribute is possible, however once deleted, you will be unable to undo that action and will need to recreate it on your own using the CreateCalculatedAttributeDefinition API if you want it back.
- Parameters:
deleteCalculatedAttributeDefinitionRequest
-- Returns:
- Result of the DeleteCalculatedAttributeDefinition operation returned by the service.
- See Also:
-
deleteCalculatedAttributeDefinition
default DeleteCalculatedAttributeDefinitionResponse deleteCalculatedAttributeDefinition(Consumer<DeleteCalculatedAttributeDefinitionRequest.Builder> deleteCalculatedAttributeDefinitionRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Deletes an existing calculated attribute definition. Note that deleting a default calculated attribute is possible, however once deleted, you will be unable to undo that action and will need to recreate it on your own using the CreateCalculatedAttributeDefinition API if you want it back.
This is a convenience which creates an instance of the
DeleteCalculatedAttributeDefinitionRequest.Builder
avoiding the need to create one manually viaDeleteCalculatedAttributeDefinitionRequest.builder()
- Parameters:
deleteCalculatedAttributeDefinitionRequest
- AConsumer
that will call methods onDeleteCalculatedAttributeDefinitionRequest.Builder
to create a request.- Returns:
- Result of the DeleteCalculatedAttributeDefinition operation returned by the service.
- See Also:
-
deleteDomain
default DeleteDomainResponse deleteDomain(DeleteDomainRequest deleteDomainRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.
- Parameters:
deleteDomainRequest
-- Returns:
- Result of the DeleteDomain operation returned by the service.
- See Also:
-
deleteDomain
default DeleteDomainResponse deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.
This is a convenience which creates an instance of the
DeleteDomainRequest.Builder
avoiding the need to create one manually viaDeleteDomainRequest.builder()
- Parameters:
deleteDomainRequest
- AConsumer
that will call methods onDeleteDomainRequest.Builder
to create a request.- Returns:
- Result of the DeleteDomain operation returned by the service.
- See Also:
-
deleteEventStream
default DeleteEventStreamResponse deleteEventStream(DeleteEventStreamRequest deleteEventStreamRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Disables and deletes the specified event stream.
- Parameters:
deleteEventStreamRequest
-- Returns:
- Result of the DeleteEventStream operation returned by the service.
- See Also:
-
deleteEventStream
default DeleteEventStreamResponse deleteEventStream(Consumer<DeleteEventStreamRequest.Builder> deleteEventStreamRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Disables and deletes the specified event stream.
This is a convenience which creates an instance of the
DeleteEventStreamRequest.Builder
avoiding the need to create one manually viaDeleteEventStreamRequest.builder()
- Parameters:
deleteEventStreamRequest
- AConsumer
that will call methods onDeleteEventStreamRequest.Builder
to create a request.- Returns:
- Result of the DeleteEventStream operation returned by the service.
- See Also:
-
deleteIntegration
default DeleteIntegrationResponse deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Removes an integration from a specific domain.
- Parameters:
deleteIntegrationRequest
-- Returns:
- Result of the DeleteIntegration operation returned by the service.
- See Also:
-
deleteIntegration
default DeleteIntegrationResponse deleteIntegration(Consumer<DeleteIntegrationRequest.Builder> deleteIntegrationRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Removes an integration from a specific domain.
This is a convenience which creates an instance of the
DeleteIntegrationRequest.Builder
avoiding the need to create one manually viaDeleteIntegrationRequest.builder()
- Parameters:
deleteIntegrationRequest
- AConsumer
that will call methods onDeleteIntegrationRequest.Builder
to create a request.- Returns:
- Result of the DeleteIntegration operation returned by the service.
- See Also:
-
deleteProfile
default DeleteProfileResponse deleteProfile(DeleteProfileRequest deleteProfileRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Deletes the standard customer profile and all data pertaining to the profile.
- Parameters:
deleteProfileRequest
-- Returns:
- Result of the DeleteProfile operation returned by the service.
- See Also:
-
deleteProfile
default DeleteProfileResponse deleteProfile(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Deletes the standard customer profile and all data pertaining to the profile.
This is a convenience which creates an instance of the
DeleteProfileRequest.Builder
avoiding the need to create one manually viaDeleteProfileRequest.builder()
- Parameters:
deleteProfileRequest
- AConsumer
that will call methods onDeleteProfileRequest.Builder
to create a request.- Returns:
- Result of the DeleteProfile operation returned by the service.
- See Also:
-
deleteProfileKey
default DeleteProfileKeyResponse deleteProfileKey(DeleteProfileKeyRequest deleteProfileKeyRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Removes a searchable key from a customer profile.
- Parameters:
deleteProfileKeyRequest
-- Returns:
- Result of the DeleteProfileKey operation returned by the service.
- See Also:
-
deleteProfileKey
default DeleteProfileKeyResponse deleteProfileKey(Consumer<DeleteProfileKeyRequest.Builder> deleteProfileKeyRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Removes a searchable key from a customer profile.
This is a convenience which creates an instance of the
DeleteProfileKeyRequest.Builder
avoiding the need to create one manually viaDeleteProfileKeyRequest.builder()
- Parameters:
deleteProfileKeyRequest
- AConsumer
that will call methods onDeleteProfileKeyRequest.Builder
to create a request.- Returns:
- Result of the DeleteProfileKey operation returned by the service.
- See Also:
-
deleteProfileObject
default DeleteProfileObjectResponse deleteProfileObject(DeleteProfileObjectRequest deleteProfileObjectRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Removes an object associated with a profile of a given ProfileObjectType.
- Parameters:
deleteProfileObjectRequest
-- Returns:
- Result of the DeleteProfileObject operation returned by the service.
- See Also:
-
deleteProfileObject
default DeleteProfileObjectResponse deleteProfileObject(Consumer<DeleteProfileObjectRequest.Builder> deleteProfileObjectRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Removes an object associated with a profile of a given ProfileObjectType.
This is a convenience which creates an instance of the
DeleteProfileObjectRequest.Builder
avoiding the need to create one manually viaDeleteProfileObjectRequest.builder()
- Parameters:
deleteProfileObjectRequest
- AConsumer
that will call methods onDeleteProfileObjectRequest.Builder
to create a request.- Returns:
- Result of the DeleteProfileObject operation returned by the service.
- See Also:
-
deleteProfileObjectType
default DeleteProfileObjectTypeResponse deleteProfileObjectType(DeleteProfileObjectTypeRequest deleteProfileObjectTypeRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type. It also disables integrations from this specific ProfileObjectType. In addition, it scrubs all of the fields of the standard profile that were populated from this ProfileObjectType.
- Parameters:
deleteProfileObjectTypeRequest
-- Returns:
- Result of the DeleteProfileObjectType operation returned by the service.
- See Also:
-
deleteProfileObjectType
default DeleteProfileObjectTypeResponse deleteProfileObjectType(Consumer<DeleteProfileObjectTypeRequest.Builder> deleteProfileObjectTypeRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type. It also disables integrations from this specific ProfileObjectType. In addition, it scrubs all of the fields of the standard profile that were populated from this ProfileObjectType.
This is a convenience which creates an instance of the
DeleteProfileObjectTypeRequest.Builder
avoiding the need to create one manually viaDeleteProfileObjectTypeRequest.builder()
- Parameters:
deleteProfileObjectTypeRequest
- AConsumer
that will call methods onDeleteProfileObjectTypeRequest.Builder
to create a request.- Returns:
- Result of the DeleteProfileObjectType operation returned by the service.
- See Also:
-
deleteWorkflow
default DeleteWorkflowResponse deleteWorkflow(DeleteWorkflowRequest deleteWorkflowRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Deletes the specified workflow and all its corresponding resources. This is an async process.
- Parameters:
deleteWorkflowRequest
-- Returns:
- Result of the DeleteWorkflow operation returned by the service.
- See Also:
-
deleteWorkflow
default DeleteWorkflowResponse deleteWorkflow(Consumer<DeleteWorkflowRequest.Builder> deleteWorkflowRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Deletes the specified workflow and all its corresponding resources. This is an async process.
This is a convenience which creates an instance of the
DeleteWorkflowRequest.Builder
avoiding the need to create one manually viaDeleteWorkflowRequest.builder()
- Parameters:
deleteWorkflowRequest
- AConsumer
that will call methods onDeleteWorkflowRequest.Builder
to create a request.- Returns:
- Result of the DeleteWorkflow operation returned by the service.
- See Also:
-
detectProfileObjectType
default DetectProfileObjectTypeResponse detectProfileObjectType(DetectProfileObjectTypeRequest detectProfileObjectTypeRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException The process of detecting profile object type mapping by using given objects.
- Parameters:
detectProfileObjectTypeRequest
-- Returns:
- Result of the DetectProfileObjectType operation returned by the service.
- See Also:
-
detectProfileObjectType
default DetectProfileObjectTypeResponse detectProfileObjectType(Consumer<DetectProfileObjectTypeRequest.Builder> detectProfileObjectTypeRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException The process of detecting profile object type mapping by using given objects.
This is a convenience which creates an instance of the
DetectProfileObjectTypeRequest.Builder
avoiding the need to create one manually viaDetectProfileObjectTypeRequest.builder()
- Parameters:
detectProfileObjectTypeRequest
- AConsumer
that will call methods onDetectProfileObjectTypeRequest.Builder
to create a request.- Returns:
- Result of the DetectProfileObjectType operation returned by the service.
- See Also:
-
getAutoMergingPreview
default GetAutoMergingPreviewResponse getAutoMergingPreview(GetAutoMergingPreviewRequest getAutoMergingPreviewRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly selects a sample of matching groups from the existing matching results, and applies the automerging settings that you provided. You can then view the number of profiles in the sample, the number of matches, and the number of profiles identified to be merged. This enables you to evaluate the accuracy of the attributes in your matching list.
You can't view which profiles are matched and would be merged.
We strongly recommend you use this API to do a dry run of the automerging process before running the Identity Resolution Job. Include at least two matching attributes. If your matching list includes too few attributes (such as only
FirstName
or onlyLastName
), there may be a large number of matches. This increases the chances of erroneous merges.- Parameters:
getAutoMergingPreviewRequest
-- Returns:
- Result of the GetAutoMergingPreview operation returned by the service.
- See Also:
-
getAutoMergingPreview
default GetAutoMergingPreviewResponse getAutoMergingPreview(Consumer<GetAutoMergingPreviewRequest.Builder> getAutoMergingPreviewRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly selects a sample of matching groups from the existing matching results, and applies the automerging settings that you provided. You can then view the number of profiles in the sample, the number of matches, and the number of profiles identified to be merged. This enables you to evaluate the accuracy of the attributes in your matching list.
You can't view which profiles are matched and would be merged.
We strongly recommend you use this API to do a dry run of the automerging process before running the Identity Resolution Job. Include at least two matching attributes. If your matching list includes too few attributes (such as only
FirstName
or onlyLastName
), there may be a large number of matches. This increases the chances of erroneous merges.
This is a convenience which creates an instance of the
GetAutoMergingPreviewRequest.Builder
avoiding the need to create one manually viaGetAutoMergingPreviewRequest.builder()
- Parameters:
getAutoMergingPreviewRequest
- AConsumer
that will call methods onGetAutoMergingPreviewRequest.Builder
to create a request.- Returns:
- Result of the GetAutoMergingPreview operation returned by the service.
- See Also:
-
getCalculatedAttributeDefinition
default GetCalculatedAttributeDefinitionResponse getCalculatedAttributeDefinition(GetCalculatedAttributeDefinitionRequest getCalculatedAttributeDefinitionRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Provides more information on a calculated attribute definition for Customer Profiles.
- Parameters:
getCalculatedAttributeDefinitionRequest
-- Returns:
- Result of the GetCalculatedAttributeDefinition operation returned by the service.
- See Also:
-
getCalculatedAttributeDefinition
default GetCalculatedAttributeDefinitionResponse getCalculatedAttributeDefinition(Consumer<GetCalculatedAttributeDefinitionRequest.Builder> getCalculatedAttributeDefinitionRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Provides more information on a calculated attribute definition for Customer Profiles.
This is a convenience which creates an instance of the
GetCalculatedAttributeDefinitionRequest.Builder
avoiding the need to create one manually viaGetCalculatedAttributeDefinitionRequest.builder()
- Parameters:
getCalculatedAttributeDefinitionRequest
- AConsumer
that will call methods onGetCalculatedAttributeDefinitionRequest.Builder
to create a request.- Returns:
- Result of the GetCalculatedAttributeDefinition operation returned by the service.
- See Also:
-
getCalculatedAttributeForProfile
default GetCalculatedAttributeForProfileResponse getCalculatedAttributeForProfile(GetCalculatedAttributeForProfileRequest getCalculatedAttributeForProfileRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Retrieve a calculated attribute for a customer profile.
- Parameters:
getCalculatedAttributeForProfileRequest
-- Returns:
- Result of the GetCalculatedAttributeForProfile operation returned by the service.
- See Also:
-
getCalculatedAttributeForProfile
default GetCalculatedAttributeForProfileResponse getCalculatedAttributeForProfile(Consumer<GetCalculatedAttributeForProfileRequest.Builder> getCalculatedAttributeForProfileRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Retrieve a calculated attribute for a customer profile.
This is a convenience which creates an instance of the
GetCalculatedAttributeForProfileRequest.Builder
avoiding the need to create one manually viaGetCalculatedAttributeForProfileRequest.builder()
- Parameters:
getCalculatedAttributeForProfileRequest
- AConsumer
that will call methods onGetCalculatedAttributeForProfileRequest.Builder
to create a request.- Returns:
- Result of the GetCalculatedAttributeForProfile operation returned by the service.
- See Also:
-
getDomain
default GetDomainResponse getDomain(GetDomainRequest getDomainRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Returns information about a specific domain.
- Parameters:
getDomainRequest
-- Returns:
- Result of the GetDomain operation returned by the service.
- See Also:
-
getDomain
default GetDomainResponse getDomain(Consumer<GetDomainRequest.Builder> getDomainRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Returns information about a specific domain.
This is a convenience which creates an instance of the
GetDomainRequest.Builder
avoiding the need to create one manually viaGetDomainRequest.builder()
- Parameters:
getDomainRequest
- AConsumer
that will call methods onGetDomainRequest.Builder
to create a request.- Returns:
- Result of the GetDomain operation returned by the service.
- See Also:
-
getEventStream
default GetEventStreamResponse getEventStream(GetEventStreamRequest getEventStreamRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Returns information about the specified event stream in a specific domain.
- Parameters:
getEventStreamRequest
-- Returns:
- Result of the GetEventStream operation returned by the service.
- See Also:
-
getEventStream
default GetEventStreamResponse getEventStream(Consumer<GetEventStreamRequest.Builder> getEventStreamRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Returns information about the specified event stream in a specific domain.
This is a convenience which creates an instance of the
GetEventStreamRequest.Builder
avoiding the need to create one manually viaGetEventStreamRequest.builder()
- Parameters:
getEventStreamRequest
- AConsumer
that will call methods onGetEventStreamRequest.Builder
to create a request.- Returns:
- Result of the GetEventStream operation returned by the service.
- See Also:
-
getIdentityResolutionJob
default GetIdentityResolutionJobResponse getIdentityResolutionJob(GetIdentityResolutionJobRequest getIdentityResolutionJobRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Returns information about an Identity Resolution Job in a specific domain.
Identity Resolution Jobs are set up using the Amazon Connect admin console. For more information, see Use Identity Resolution to consolidate similar profiles.
- Parameters:
getIdentityResolutionJobRequest
-- Returns:
- Result of the GetIdentityResolutionJob operation returned by the service.
- See Also:
-
getIdentityResolutionJob
default GetIdentityResolutionJobResponse getIdentityResolutionJob(Consumer<GetIdentityResolutionJobRequest.Builder> getIdentityResolutionJobRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Returns information about an Identity Resolution Job in a specific domain.
Identity Resolution Jobs are set up using the Amazon Connect admin console. For more information, see Use Identity Resolution to consolidate similar profiles.
This is a convenience which creates an instance of the
GetIdentityResolutionJobRequest.Builder
avoiding the need to create one manually viaGetIdentityResolutionJobRequest.builder()
- Parameters:
getIdentityResolutionJobRequest
- AConsumer
that will call methods onGetIdentityResolutionJobRequest.Builder
to create a request.- Returns:
- Result of the GetIdentityResolutionJob operation returned by the service.
- See Also:
-
getIntegration
default GetIntegrationResponse getIntegration(GetIntegrationRequest getIntegrationRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Returns an integration for a domain.
- Parameters:
getIntegrationRequest
-- Returns:
- Result of the GetIntegration operation returned by the service.
- See Also:
-
getIntegration
default GetIntegrationResponse getIntegration(Consumer<GetIntegrationRequest.Builder> getIntegrationRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Returns an integration for a domain.
This is a convenience which creates an instance of the
GetIntegrationRequest.Builder
avoiding the need to create one manually viaGetIntegrationRequest.builder()
- Parameters:
getIntegrationRequest
- AConsumer
that will call methods onGetIntegrationRequest.Builder
to create a request.- Returns:
- Result of the GetIntegration operation returned by the service.
- See Also:
-
getMatches
default GetMatchesResponse getMatches(GetMatchesRequest getMatchesRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Before calling this API, use CreateDomain or UpdateDomain to enable identity resolution: set
Matching
to true.GetMatches returns potentially matching profiles, based on the results of the latest run of a machine learning process.
The process of matching duplicate profiles. If
Matching
=true
, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured
ExportingConfig
in theMatchingRequest
, you can download the results from S3.Amazon Connect uses the following profile attributes to identify matches:
-
PhoneNumber
-
HomePhoneNumber
-
BusinessPhoneNumber
-
MobilePhoneNumber
-
EmailAddress
-
PersonalEmailAddress
-
BusinessEmailAddress
-
FullName
For example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different casing email addresses such as JOHN_DOE@ANYCOMPANY.COM and johndoe@anycompany.com, or different phone number formats such as 555-010-0000 and +1-555-010-0000—can be detected as belonging to the same customer John Doe and merged into a unified profile.
- Parameters:
getMatchesRequest
-- Returns:
- Result of the GetMatches operation returned by the service.
- See Also:
-
-
getMatches
default GetMatchesResponse getMatches(Consumer<GetMatchesRequest.Builder> getMatchesRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Before calling this API, use CreateDomain or UpdateDomain to enable identity resolution: set
Matching
to true.GetMatches returns potentially matching profiles, based on the results of the latest run of a machine learning process.
The process of matching duplicate profiles. If
Matching
=true
, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured
ExportingConfig
in theMatchingRequest
, you can download the results from S3.Amazon Connect uses the following profile attributes to identify matches:
-
PhoneNumber
-
HomePhoneNumber
-
BusinessPhoneNumber
-
MobilePhoneNumber
-
EmailAddress
-
PersonalEmailAddress
-
BusinessEmailAddress
-
FullName
For example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different casing email addresses such as JOHN_DOE@ANYCOMPANY.COM and johndoe@anycompany.com, or different phone number formats such as 555-010-0000 and +1-555-010-0000—can be detected as belonging to the same customer John Doe and merged into a unified profile.
This is a convenience which creates an instance of the
GetMatchesRequest.Builder
avoiding the need to create one manually viaGetMatchesRequest.builder()
- Parameters:
getMatchesRequest
- AConsumer
that will call methods onGetMatchesRequest.Builder
to create a request.- Returns:
- Result of the GetMatches operation returned by the service.
- See Also:
-
-
getProfileObjectType
default GetProfileObjectTypeResponse getProfileObjectType(GetProfileObjectTypeRequest getProfileObjectTypeRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Returns the object types for a specific domain.
- Parameters:
getProfileObjectTypeRequest
-- Returns:
- Result of the GetProfileObjectType operation returned by the service.
- See Also:
-
getProfileObjectType
default GetProfileObjectTypeResponse getProfileObjectType(Consumer<GetProfileObjectTypeRequest.Builder> getProfileObjectTypeRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Returns the object types for a specific domain.
This is a convenience which creates an instance of the
GetProfileObjectTypeRequest.Builder
avoiding the need to create one manually viaGetProfileObjectTypeRequest.builder()
- Parameters:
getProfileObjectTypeRequest
- AConsumer
that will call methods onGetProfileObjectTypeRequest.Builder
to create a request.- Returns:
- Result of the GetProfileObjectType operation returned by the service.
- See Also:
-
getProfileObjectTypeTemplate
default GetProfileObjectTypeTemplateResponse getProfileObjectTypeTemplate(GetProfileObjectTypeTemplateRequest getProfileObjectTypeTemplateRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Returns the template information for a specific object type.
A template is a predefined ProfileObjectType, such as “Salesforce-Account” or “Salesforce-Contact.” When a user sends a ProfileObject, using the PutProfileObject API, with an ObjectTypeName that matches one of the TemplateIds, it uses the mappings from the template.
- Parameters:
getProfileObjectTypeTemplateRequest
-- Returns:
- Result of the GetProfileObjectTypeTemplate operation returned by the service.
- See Also:
-
getProfileObjectTypeTemplate
default GetProfileObjectTypeTemplateResponse getProfileObjectTypeTemplate(Consumer<GetProfileObjectTypeTemplateRequest.Builder> getProfileObjectTypeTemplateRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Returns the template information for a specific object type.
A template is a predefined ProfileObjectType, such as “Salesforce-Account” or “Salesforce-Contact.” When a user sends a ProfileObject, using the PutProfileObject API, with an ObjectTypeName that matches one of the TemplateIds, it uses the mappings from the template.
This is a convenience which creates an instance of the
GetProfileObjectTypeTemplateRequest.Builder
avoiding the need to create one manually viaGetProfileObjectTypeTemplateRequest.builder()
- Parameters:
getProfileObjectTypeTemplateRequest
- AConsumer
that will call methods onGetProfileObjectTypeTemplateRequest.Builder
to create a request.- Returns:
- Result of the GetProfileObjectTypeTemplate operation returned by the service.
- See Also:
-
getSimilarProfiles
default GetSimilarProfilesResponse getSimilarProfiles(GetSimilarProfilesRequest getSimilarProfilesRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Returns a set of profiles that belong to the same matching group using the
matchId
orprofileId
. You can also specify the type of matching that you want for finding similar profiles using eitherRULE_BASED_MATCHING
orML_BASED_MATCHING
.- Parameters:
getSimilarProfilesRequest
-- Returns:
- Result of the GetSimilarProfiles operation returned by the service.
- See Also:
-
getSimilarProfiles
default GetSimilarProfilesResponse getSimilarProfiles(Consumer<GetSimilarProfilesRequest.Builder> getSimilarProfilesRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Returns a set of profiles that belong to the same matching group using the
matchId
orprofileId
. You can also specify the type of matching that you want for finding similar profiles using eitherRULE_BASED_MATCHING
orML_BASED_MATCHING
.
This is a convenience which creates an instance of the
GetSimilarProfilesRequest.Builder
avoiding the need to create one manually viaGetSimilarProfilesRequest.builder()
- Parameters:
getSimilarProfilesRequest
- AConsumer
that will call methods onGetSimilarProfilesRequest.Builder
to create a request.- Returns:
- Result of the GetSimilarProfiles operation returned by the service.
- See Also:
-
getWorkflow
default GetWorkflowResponse getWorkflow(GetWorkflowRequest getWorkflowRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Get details of specified workflow.
- Parameters:
getWorkflowRequest
-- Returns:
- Result of the GetWorkflow operation returned by the service.
- See Also:
-
getWorkflow
default GetWorkflowResponse getWorkflow(Consumer<GetWorkflowRequest.Builder> getWorkflowRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Get details of specified workflow.
This is a convenience which creates an instance of the
GetWorkflowRequest.Builder
avoiding the need to create one manually viaGetWorkflowRequest.builder()
- Parameters:
getWorkflowRequest
- AConsumer
that will call methods onGetWorkflowRequest.Builder
to create a request.- Returns:
- Result of the GetWorkflow operation returned by the service.
- See Also:
-
getWorkflowSteps
default GetWorkflowStepsResponse getWorkflowSteps(GetWorkflowStepsRequest getWorkflowStepsRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Get granular list of steps in workflow.
- Parameters:
getWorkflowStepsRequest
-- Returns:
- Result of the GetWorkflowSteps operation returned by the service.
- See Also:
-
getWorkflowSteps
default GetWorkflowStepsResponse getWorkflowSteps(Consumer<GetWorkflowStepsRequest.Builder> getWorkflowStepsRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Get granular list of steps in workflow.
This is a convenience which creates an instance of the
GetWorkflowStepsRequest.Builder
avoiding the need to create one manually viaGetWorkflowStepsRequest.builder()
- Parameters:
getWorkflowStepsRequest
- AConsumer
that will call methods onGetWorkflowStepsRequest.Builder
to create a request.- Returns:
- Result of the GetWorkflowSteps operation returned by the service.
- See Also:
-
listAccountIntegrations
default ListAccountIntegrationsResponse listAccountIntegrations(ListAccountIntegrationsRequest listAccountIntegrationsRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Lists all of the integrations associated to a specific URI in the AWS account.
- Parameters:
listAccountIntegrationsRequest
-- Returns:
- Result of the ListAccountIntegrations operation returned by the service.
- See Also:
-
listAccountIntegrations
default ListAccountIntegrationsResponse listAccountIntegrations(Consumer<ListAccountIntegrationsRequest.Builder> listAccountIntegrationsRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Lists all of the integrations associated to a specific URI in the AWS account.
This is a convenience which creates an instance of the
ListAccountIntegrationsRequest.Builder
avoiding the need to create one manually viaListAccountIntegrationsRequest.builder()
- Parameters:
listAccountIntegrationsRequest
- AConsumer
that will call methods onListAccountIntegrationsRequest.Builder
to create a request.- Returns:
- Result of the ListAccountIntegrations operation returned by the service.
- See Also:
-
listCalculatedAttributeDefinitions
default ListCalculatedAttributeDefinitionsResponse listCalculatedAttributeDefinitions(ListCalculatedAttributeDefinitionsRequest listCalculatedAttributeDefinitionsRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Lists calculated attribute definitions for Customer Profiles
- Parameters:
listCalculatedAttributeDefinitionsRequest
-- Returns:
- Result of the ListCalculatedAttributeDefinitions operation returned by the service.
- See Also:
-
listCalculatedAttributeDefinitions
default ListCalculatedAttributeDefinitionsResponse listCalculatedAttributeDefinitions(Consumer<ListCalculatedAttributeDefinitionsRequest.Builder> listCalculatedAttributeDefinitionsRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Lists calculated attribute definitions for Customer Profiles
This is a convenience which creates an instance of the
ListCalculatedAttributeDefinitionsRequest.Builder
avoiding the need to create one manually viaListCalculatedAttributeDefinitionsRequest.builder()
- Parameters:
listCalculatedAttributeDefinitionsRequest
- AConsumer
that will call methods onListCalculatedAttributeDefinitionsRequest.Builder
to create a request.- Returns:
- Result of the ListCalculatedAttributeDefinitions operation returned by the service.
- See Also:
-
listCalculatedAttributesForProfile
default ListCalculatedAttributesForProfileResponse listCalculatedAttributesForProfile(ListCalculatedAttributesForProfileRequest listCalculatedAttributesForProfileRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Retrieve a list of calculated attributes for a customer profile.
- Parameters:
listCalculatedAttributesForProfileRequest
-- Returns:
- Result of the ListCalculatedAttributesForProfile operation returned by the service.
- See Also:
-
listCalculatedAttributesForProfile
default ListCalculatedAttributesForProfileResponse listCalculatedAttributesForProfile(Consumer<ListCalculatedAttributesForProfileRequest.Builder> listCalculatedAttributesForProfileRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Retrieve a list of calculated attributes for a customer profile.
This is a convenience which creates an instance of the
ListCalculatedAttributesForProfileRequest.Builder
avoiding the need to create one manually viaListCalculatedAttributesForProfileRequest.builder()
- Parameters:
listCalculatedAttributesForProfileRequest
- AConsumer
that will call methods onListCalculatedAttributesForProfileRequest.Builder
to create a request.- Returns:
- Result of the ListCalculatedAttributesForProfile operation returned by the service.
- See Also:
-
listDomains
default ListDomainsResponse listDomains(ListDomainsRequest listDomainsRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Returns a list of all the domains for an AWS account that have been created.
- Parameters:
listDomainsRequest
-- Returns:
- Result of the ListDomains operation returned by the service.
- See Also:
-
listDomains
default ListDomainsResponse listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Returns a list of all the domains for an AWS account that have been created.
This is a convenience which creates an instance of the
ListDomainsRequest.Builder
avoiding the need to create one manually viaListDomainsRequest.builder()
- Parameters:
listDomainsRequest
- AConsumer
that will call methods onListDomainsRequest.Builder
to create a request.- Returns:
- Result of the ListDomains operation returned by the service.
- See Also:
-
listEventStreams
default ListEventStreamsResponse listEventStreams(ListEventStreamsRequest listEventStreamsRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Returns a list of all the event streams in a specific domain.
- Parameters:
listEventStreamsRequest
-- Returns:
- Result of the ListEventStreams operation returned by the service.
- See Also:
-
listEventStreams
default ListEventStreamsResponse listEventStreams(Consumer<ListEventStreamsRequest.Builder> listEventStreamsRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Returns a list of all the event streams in a specific domain.
This is a convenience which creates an instance of the
ListEventStreamsRequest.Builder
avoiding the need to create one manually viaListEventStreamsRequest.builder()
- Parameters:
listEventStreamsRequest
- AConsumer
that will call methods onListEventStreamsRequest.Builder
to create a request.- Returns:
- Result of the ListEventStreams operation returned by the service.
- See Also:
-
listEventStreamsPaginator
default ListEventStreamsIterable listEventStreamsPaginator(ListEventStreamsRequest listEventStreamsRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException This is a variant of
listEventStreams(software.amazon.awssdk.services.customerprofiles.model.ListEventStreamsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.customerprofiles.paginators.ListEventStreamsIterable responses = client.listEventStreamsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.customerprofiles.paginators.ListEventStreamsIterable responses = client .listEventStreamsPaginator(request); for (software.amazon.awssdk.services.customerprofiles.model.ListEventStreamsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.customerprofiles.paginators.ListEventStreamsIterable responses = client.listEventStreamsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEventStreams(software.amazon.awssdk.services.customerprofiles.model.ListEventStreamsRequest)
operation.- Parameters:
listEventStreamsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEventStreamsPaginator
default ListEventStreamsIterable listEventStreamsPaginator(Consumer<ListEventStreamsRequest.Builder> listEventStreamsRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException This is a variant of
listEventStreams(software.amazon.awssdk.services.customerprofiles.model.ListEventStreamsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.customerprofiles.paginators.ListEventStreamsIterable responses = client.listEventStreamsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.customerprofiles.paginators.ListEventStreamsIterable responses = client .listEventStreamsPaginator(request); for (software.amazon.awssdk.services.customerprofiles.model.ListEventStreamsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.customerprofiles.paginators.ListEventStreamsIterable responses = client.listEventStreamsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEventStreams(software.amazon.awssdk.services.customerprofiles.model.ListEventStreamsRequest)
operation.
This is a convenience which creates an instance of the
ListEventStreamsRequest.Builder
avoiding the need to create one manually viaListEventStreamsRequest.builder()
- Parameters:
listEventStreamsRequest
- AConsumer
that will call methods onListEventStreamsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listIdentityResolutionJobs
default ListIdentityResolutionJobsResponse listIdentityResolutionJobs(ListIdentityResolutionJobsRequest listIdentityResolutionJobsRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by
JobStartTime
.- Parameters:
listIdentityResolutionJobsRequest
-- Returns:
- Result of the ListIdentityResolutionJobs operation returned by the service.
- See Also:
-
listIdentityResolutionJobs
default ListIdentityResolutionJobsResponse listIdentityResolutionJobs(Consumer<ListIdentityResolutionJobsRequest.Builder> listIdentityResolutionJobsRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by
JobStartTime
.
This is a convenience which creates an instance of the
ListIdentityResolutionJobsRequest.Builder
avoiding the need to create one manually viaListIdentityResolutionJobsRequest.builder()
- Parameters:
listIdentityResolutionJobsRequest
- AConsumer
that will call methods onListIdentityResolutionJobsRequest.Builder
to create a request.- Returns:
- Result of the ListIdentityResolutionJobs operation returned by the service.
- See Also:
-
listIntegrations
default ListIntegrationsResponse listIntegrations(ListIntegrationsRequest listIntegrationsRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Lists all of the integrations in your domain.
- Parameters:
listIntegrationsRequest
-- Returns:
- Result of the ListIntegrations operation returned by the service.
- See Also:
-
listIntegrations
default ListIntegrationsResponse listIntegrations(Consumer<ListIntegrationsRequest.Builder> listIntegrationsRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Lists all of the integrations in your domain.
This is a convenience which creates an instance of the
ListIntegrationsRequest.Builder
avoiding the need to create one manually viaListIntegrationsRequest.builder()
- Parameters:
listIntegrationsRequest
- AConsumer
that will call methods onListIntegrationsRequest.Builder
to create a request.- Returns:
- Result of the ListIntegrations operation returned by the service.
- See Also:
-
listProfileObjectTypeTemplates
default ListProfileObjectTypeTemplatesResponse listProfileObjectTypeTemplates(ListProfileObjectTypeTemplatesRequest listProfileObjectTypeTemplatesRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Lists all of the template information for object types.
- Parameters:
listProfileObjectTypeTemplatesRequest
-- Returns:
- Result of the ListProfileObjectTypeTemplates operation returned by the service.
- See Also:
-
listProfileObjectTypeTemplates
default ListProfileObjectTypeTemplatesResponse listProfileObjectTypeTemplates(Consumer<ListProfileObjectTypeTemplatesRequest.Builder> listProfileObjectTypeTemplatesRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Lists all of the template information for object types.
This is a convenience which creates an instance of the
ListProfileObjectTypeTemplatesRequest.Builder
avoiding the need to create one manually viaListProfileObjectTypeTemplatesRequest.builder()
- Parameters:
listProfileObjectTypeTemplatesRequest
- AConsumer
that will call methods onListProfileObjectTypeTemplatesRequest.Builder
to create a request.- Returns:
- Result of the ListProfileObjectTypeTemplates operation returned by the service.
- See Also:
-
listProfileObjectTypes
default ListProfileObjectTypesResponse listProfileObjectTypes(ListProfileObjectTypesRequest listProfileObjectTypesRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Lists all of the templates available within the service.
- Parameters:
listProfileObjectTypesRequest
-- Returns:
- Result of the ListProfileObjectTypes operation returned by the service.
- See Also:
-
listProfileObjectTypes
default ListProfileObjectTypesResponse listProfileObjectTypes(Consumer<ListProfileObjectTypesRequest.Builder> listProfileObjectTypesRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Lists all of the templates available within the service.
This is a convenience which creates an instance of the
ListProfileObjectTypesRequest.Builder
avoiding the need to create one manually viaListProfileObjectTypesRequest.builder()
- Parameters:
listProfileObjectTypesRequest
- AConsumer
that will call methods onListProfileObjectTypesRequest.Builder
to create a request.- Returns:
- Result of the ListProfileObjectTypes operation returned by the service.
- See Also:
-
listProfileObjects
default ListProfileObjectsResponse listProfileObjects(ListProfileObjectsRequest listProfileObjectsRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Returns a list of objects associated with a profile of a given ProfileObjectType.
- Parameters:
listProfileObjectsRequest
-- Returns:
- Result of the ListProfileObjects operation returned by the service.
- See Also:
-
listProfileObjects
default ListProfileObjectsResponse listProfileObjects(Consumer<ListProfileObjectsRequest.Builder> listProfileObjectsRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Returns a list of objects associated with a profile of a given ProfileObjectType.
This is a convenience which creates an instance of the
ListProfileObjectsRequest.Builder
avoiding the need to create one manually viaListProfileObjectsRequest.builder()
- Parameters:
listProfileObjectsRequest
- AConsumer
that will call methods onListProfileObjectsRequest.Builder
to create a request.- Returns:
- Result of the ListProfileObjects operation returned by the service.
- See Also:
-
listRuleBasedMatches
default ListRuleBasedMatchesResponse listRuleBasedMatches(ListRuleBasedMatchesRequest listRuleBasedMatchesRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Returns a set of
MatchIds
that belong to the given domain.- Parameters:
listRuleBasedMatchesRequest
-- Returns:
- Result of the ListRuleBasedMatches operation returned by the service.
- See Also:
-
listRuleBasedMatches
default ListRuleBasedMatchesResponse listRuleBasedMatches(Consumer<ListRuleBasedMatchesRequest.Builder> listRuleBasedMatchesRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Returns a set of
MatchIds
that belong to the given domain.
This is a convenience which creates an instance of the
ListRuleBasedMatchesRequest.Builder
avoiding the need to create one manually viaListRuleBasedMatchesRequest.builder()
- Parameters:
listRuleBasedMatchesRequest
- AConsumer
that will call methods onListRuleBasedMatchesRequest.Builder
to create a request.- Returns:
- Result of the ListRuleBasedMatches operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, BadRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, CustomerProfilesException Displays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalServerException, BadRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, CustomerProfilesException Displays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listWorkflows
default ListWorkflowsResponse listWorkflows(ListWorkflowsRequest listWorkflowsRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Query to list all workflows.
- Parameters:
listWorkflowsRequest
-- Returns:
- Result of the ListWorkflows operation returned by the service.
- See Also:
-
listWorkflows
default ListWorkflowsResponse listWorkflows(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Query to list all workflows.
This is a convenience which creates an instance of the
ListWorkflowsRequest.Builder
avoiding the need to create one manually viaListWorkflowsRequest.builder()
- Parameters:
listWorkflowsRequest
- AConsumer
that will call methods onListWorkflowsRequest.Builder
to create a request.- Returns:
- Result of the ListWorkflows operation returned by the service.
- See Also:
-
mergeProfiles
default MergeProfilesResponse mergeProfiles(MergeProfilesRequest mergeProfilesRequest) throws BadRequestException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Runs an AWS Lambda job that does the following:
-
All the profileKeys in the
ProfileToBeMerged
will be moved to the main profile. -
All the objects in the
ProfileToBeMerged
will be moved to the main profile. -
All the
ProfileToBeMerged
will be deleted at the end. -
All the profileKeys in the
ProfileIdsToBeMerged
will be moved to the main profile. -
Standard fields are merged as follows:
-
Fields are always "union"-ed if there are no conflicts in standard fields or attributeKeys.
-
When there are conflicting fields:
-
If no
SourceProfileIds
entry is specified, the main Profile value is always taken. -
If a
SourceProfileIds
entry is specified, the specified profileId is always taken, even if it is a NULL value.
-
-
You can use MergeProfiles together with GetMatches, which returns potentially matching profiles, or use it with the results of another matching system. After profiles have been merged, they cannot be separated (unmerged).
- Parameters:
mergeProfilesRequest
-- Returns:
- Result of the MergeProfiles operation returned by the service.
- See Also:
-
-
mergeProfiles
default MergeProfilesResponse mergeProfiles(Consumer<MergeProfilesRequest.Builder> mergeProfilesRequest) throws BadRequestException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Runs an AWS Lambda job that does the following:
-
All the profileKeys in the
ProfileToBeMerged
will be moved to the main profile. -
All the objects in the
ProfileToBeMerged
will be moved to the main profile. -
All the
ProfileToBeMerged
will be deleted at the end. -
All the profileKeys in the
ProfileIdsToBeMerged
will be moved to the main profile. -
Standard fields are merged as follows:
-
Fields are always "union"-ed if there are no conflicts in standard fields or attributeKeys.
-
When there are conflicting fields:
-
If no
SourceProfileIds
entry is specified, the main Profile value is always taken. -
If a
SourceProfileIds
entry is specified, the specified profileId is always taken, even if it is a NULL value.
-
-
You can use MergeProfiles together with GetMatches, which returns potentially matching profiles, or use it with the results of another matching system. After profiles have been merged, they cannot be separated (unmerged).
This is a convenience which creates an instance of the
MergeProfilesRequest.Builder
avoiding the need to create one manually viaMergeProfilesRequest.builder()
- Parameters:
mergeProfilesRequest
- AConsumer
that will call methods onMergeProfilesRequest.Builder
to create a request.- Returns:
- Result of the MergeProfiles operation returned by the service.
- See Also:
-
-
putIntegration
default PutIntegrationResponse putIntegration(PutIntegrationRequest putIntegrationRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.
An integration can belong to only one domain.
To add or remove tags on an existing Integration, see TagResource / UntagResource.
- Parameters:
putIntegrationRequest
-- Returns:
- Result of the PutIntegration operation returned by the service.
- See Also:
-
putIntegration
default PutIntegrationResponse putIntegration(Consumer<PutIntegrationRequest.Builder> putIntegrationRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.
An integration can belong to only one domain.
To add or remove tags on an existing Integration, see TagResource / UntagResource.
This is a convenience which creates an instance of the
PutIntegrationRequest.Builder
avoiding the need to create one manually viaPutIntegrationRequest.builder()
- Parameters:
putIntegrationRequest
- AConsumer
that will call methods onPutIntegrationRequest.Builder
to create a request.- Returns:
- Result of the PutIntegration operation returned by the service.
- See Also:
-
putProfileObject
default PutProfileObjectResponse putProfileObject(PutProfileObjectRequest putProfileObjectRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Adds additional objects to customer profiles of a given ObjectType.
When adding a specific profile object, like a Contact Record, an inferred profile can get created if it is not mapped to an existing profile. The resulting profile will only have a phone number populated in the standard ProfileObject. Any additional Contact Records with the same phone number will be mapped to the same inferred profile.
When a ProfileObject is created and if a ProfileObjectType already exists for the ProfileObject, it will provide data to a standard profile depending on the ProfileObjectType definition.
PutProfileObject needs an ObjectType, which can be created using PutProfileObjectType.
- Parameters:
putProfileObjectRequest
-- Returns:
- Result of the PutProfileObject operation returned by the service.
- See Also:
-
putProfileObject
default PutProfileObjectResponse putProfileObject(Consumer<PutProfileObjectRequest.Builder> putProfileObjectRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Adds additional objects to customer profiles of a given ObjectType.
When adding a specific profile object, like a Contact Record, an inferred profile can get created if it is not mapped to an existing profile. The resulting profile will only have a phone number populated in the standard ProfileObject. Any additional Contact Records with the same phone number will be mapped to the same inferred profile.
When a ProfileObject is created and if a ProfileObjectType already exists for the ProfileObject, it will provide data to a standard profile depending on the ProfileObjectType definition.
PutProfileObject needs an ObjectType, which can be created using PutProfileObjectType.
This is a convenience which creates an instance of the
PutProfileObjectRequest.Builder
avoiding the need to create one manually viaPutProfileObjectRequest.builder()
- Parameters:
putProfileObjectRequest
- AConsumer
that will call methods onPutProfileObjectRequest.Builder
to create a request.- Returns:
- Result of the PutProfileObject operation returned by the service.
- See Also:
-
putProfileObjectType
default PutProfileObjectTypeResponse putProfileObjectType(PutProfileObjectTypeRequest putProfileObjectTypeRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Defines a ProfileObjectType.
To add or remove tags on an existing ObjectType, see TagResource/UntagResource.
- Parameters:
putProfileObjectTypeRequest
-- Returns:
- Result of the PutProfileObjectType operation returned by the service.
- See Also:
-
putProfileObjectType
default PutProfileObjectTypeResponse putProfileObjectType(Consumer<PutProfileObjectTypeRequest.Builder> putProfileObjectTypeRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Defines a ProfileObjectType.
To add or remove tags on an existing ObjectType, see TagResource/UntagResource.
This is a convenience which creates an instance of the
PutProfileObjectTypeRequest.Builder
avoiding the need to create one manually viaPutProfileObjectTypeRequest.builder()
- Parameters:
putProfileObjectTypeRequest
- AConsumer
that will call methods onPutProfileObjectTypeRequest.Builder
to create a request.- Returns:
- Result of the PutProfileObjectType operation returned by the service.
- See Also:
-
searchProfiles
default SearchProfilesResponse searchProfiles(SearchProfilesRequest searchProfilesRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException 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. A search key is a data type pair that consists of a
KeyName
andValues
list.This operation supports searching for profiles with a minimum of 1 key-value(s) pair and up to 5 key-value(s) pairs using either
AND
orOR
logic.- Parameters:
searchProfilesRequest
-- Returns:
- Result of the SearchProfiles operation returned by the service.
- See Also:
-
searchProfiles
default SearchProfilesResponse searchProfiles(Consumer<SearchProfilesRequest.Builder> searchProfilesRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException 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. A search key is a data type pair that consists of a
KeyName
andValues
list.This operation supports searching for profiles with a minimum of 1 key-value(s) pair and up to 5 key-value(s) pairs using either
AND
orOR
logic.
This is a convenience which creates an instance of the
SearchProfilesRequest.Builder
avoiding the need to create one manually viaSearchProfilesRequest.builder()
- Parameters:
searchProfilesRequest
- AConsumer
that will call methods onSearchProfilesRequest.Builder
to create a request.- Returns:
- Result of the SearchProfiles operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException, BadRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, CustomerProfilesException Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.
Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InternalServerException, BadRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, CustomerProfilesException Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.
Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException, BadRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, CustomerProfilesException Removes one or more tags from the specified Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InternalServerException, BadRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, CustomerProfilesException Removes one or more tags from the specified Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateCalculatedAttributeDefinition
default UpdateCalculatedAttributeDefinitionResponse updateCalculatedAttributeDefinition(UpdateCalculatedAttributeDefinitionRequest updateCalculatedAttributeDefinitionRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Updates an existing calculated attribute definition. When updating the Conditions, note that increasing the date range of a calculated attribute will not trigger inclusion of historical data greater than the current date range.
- Parameters:
updateCalculatedAttributeDefinitionRequest
-- Returns:
- Result of the UpdateCalculatedAttributeDefinition operation returned by the service.
- See Also:
-
updateCalculatedAttributeDefinition
default UpdateCalculatedAttributeDefinitionResponse updateCalculatedAttributeDefinition(Consumer<UpdateCalculatedAttributeDefinitionRequest.Builder> updateCalculatedAttributeDefinitionRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Updates an existing calculated attribute definition. When updating the Conditions, note that increasing the date range of a calculated attribute will not trigger inclusion of historical data greater than the current date range.
This is a convenience which creates an instance of the
UpdateCalculatedAttributeDefinitionRequest.Builder
avoiding the need to create one manually viaUpdateCalculatedAttributeDefinitionRequest.builder()
- Parameters:
updateCalculatedAttributeDefinitionRequest
- AConsumer
that will call methods onUpdateCalculatedAttributeDefinitionRequest.Builder
to create a request.- Returns:
- Result of the UpdateCalculatedAttributeDefinition operation returned by the service.
- See Also:
-
updateDomain
default UpdateDomainResponse updateDomain(UpdateDomainRequest updateDomainRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.
After a domain is created, the name can’t be changed.
Use this API or CreateDomain to enable identity resolution: set
Matching
to true.To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply.
To add or remove tags on an existing Domain, see TagResource/UntagResource.
- Parameters:
updateDomainRequest
-- Returns:
- Result of the UpdateDomain operation returned by the service.
- See Also:
-
updateDomain
default UpdateDomainResponse updateDomain(Consumer<UpdateDomainRequest.Builder> updateDomainRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.
After a domain is created, the name can’t be changed.
Use this API or CreateDomain to enable identity resolution: set
Matching
to true.To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply.
To add or remove tags on an existing Domain, see TagResource/UntagResource.
This is a convenience which creates an instance of the
UpdateDomainRequest.Builder
avoiding the need to create one manually viaUpdateDomainRequest.builder()
- Parameters:
updateDomainRequest
- AConsumer
that will call methods onUpdateDomainRequest.Builder
to create a request.- Returns:
- Result of the UpdateDomain operation returned by the service.
- See Also:
-
updateProfile
default UpdateProfileResponse updateProfile(UpdateProfileRequest updateProfileRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Updates the properties of a profile. The ProfileId is required for updating a customer profile.
When calling the UpdateProfile API, specifying an empty string value means that any existing value will be removed. Not specifying a string value means that any value already there will be kept.
- Parameters:
updateProfileRequest
-- Returns:
- Result of the UpdateProfile operation returned by the service.
- See Also:
-
updateProfile
default UpdateProfileResponse updateProfile(Consumer<UpdateProfileRequest.Builder> updateProfileRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException Updates the properties of a profile. The ProfileId is required for updating a customer profile.
When calling the UpdateProfile API, specifying an empty string value means that any existing value will be removed. Not specifying a string value means that any value already there will be kept.
This is a convenience which creates an instance of the
UpdateProfileRequest.Builder
avoiding the need to create one manually viaUpdateProfileRequest.builder()
- Parameters:
updateProfileRequest
- AConsumer
that will call methods onUpdateProfileRequest.Builder
to create a request.- Returns:
- Result of the UpdateProfile operation returned by the service.
- See Also:
-
create
Create aCustomerProfilesClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aCustomerProfilesClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-