@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface CustomerProfilesClient extends SdkClient
builder() method.
Welcome to the Amazon Connect Customer Profiles API Reference. This guide provides information about the Amazon Connect Customer Profiles API, including supported operations, data types, parameters, and schemas.
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 also review the Amazon Connect Administrator Guide.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AddProfileKeyResponse |
addProfileKey(AddProfileKeyRequest addProfileKeyRequest)
Associates a new key value with a specific profile, such as a Contact Trace Record (CTR) ContactId.
|
default AddProfileKeyResponse |
addProfileKey(Consumer<AddProfileKeyRequest.Builder> addProfileKeyRequest)
Associates a new key value with a specific profile, such as a Contact Trace Record (CTR) ContactId.
|
static CustomerProfilesClientBuilder |
builder()
Create a builder that can be used to configure and create a
CustomerProfilesClient. |
static CustomerProfilesClient |
create()
Create a
CustomerProfilesClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
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 CreateProfileResponse |
createProfile(Consumer<CreateProfileRequest.Builder> createProfileRequest)
Creates a standard profile.
|
default CreateProfileResponse |
createProfile(CreateProfileRequest createProfileRequest)
Creates a standard profile.
|
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 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 GetDomainResponse |
getDomain(Consumer<GetDomainRequest.Builder> getDomainRequest)
Returns information about a specific domain.
|
default GetDomainResponse |
getDomain(GetDomainRequest getDomainRequest)
Returns information about 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)
This API is in preview release for Amazon Connect and subject to change.
|
default GetMatchesResponse |
getMatches(GetMatchesRequest getMatchesRequest)
This API is in preview release for Amazon Connect and subject to change.
|
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.
|
default GetProfileObjectTypeTemplateResponse |
getProfileObjectTypeTemplate(Consumer<GetProfileObjectTypeTemplateRequest.Builder> getProfileObjectTypeTemplateRequest)
Returns the template information for a specific object type.
|
default GetProfileObjectTypeTemplateResponse |
getProfileObjectTypeTemplate(GetProfileObjectTypeTemplateRequest getProfileObjectTypeTemplateRequest)
Returns the template information for a specific object type.
|
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.
|
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 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.
|
default ListProfileObjectTypeTemplatesResponse |
listProfileObjectTypeTemplates(Consumer<ListProfileObjectTypeTemplatesRequest.Builder> listProfileObjectTypeTemplatesRequest)
Lists all of the template information for object types.
|
default ListProfileObjectTypeTemplatesResponse |
listProfileObjectTypeTemplates(ListProfileObjectTypeTemplatesRequest listProfileObjectTypeTemplatesRequest)
Lists all of the template information for object types.
|
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 MergeProfilesResponse |
mergeProfiles(Consumer<MergeProfilesRequest.Builder> mergeProfilesRequest)
This API is in preview release for Amazon Connect and subject to change.
|
default MergeProfilesResponse |
mergeProfiles(MergeProfilesRequest mergeProfilesRequest)
This API is in preview release for Amazon Connect and subject to change.
|
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 name using name, phone number, email address, account number, or a
custom defined index.
|
default SearchProfilesResponse |
searchProfiles(SearchProfilesRequest searchProfilesRequest)
Searches for profiles within a specific domain name using name, phone number, email address, account number, or a
custom defined index.
|
static ServiceMetadata |
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.
|
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.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static CustomerProfilesClient create()
CustomerProfilesClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static CustomerProfilesClientBuilder builder()
CustomerProfilesClient.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 Trace Record (CTR) 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.
addProfileKeyRequest - BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 Trace Record (CTR) 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 via AddProfileKeyRequest.builder()
addProfileKeyRequest - A Consumer that will call methods on AddProfileKeyRequest.Builder to create a request.BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createDomainRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
This is a convenience which creates an instance of the CreateDomainRequest.Builder avoiding the need to
create one manually via CreateDomainRequest.builder()
createDomainRequest - A Consumer that will call methods on CreateDomainRequest.Builder to create a request.BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createProfileRequest - BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via CreateProfileRequest.builder()
createProfileRequest - A Consumer that will call methods on CreateProfileRequest.Builder to create a request.BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteDomainRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteDomainRequest.builder()
deleteDomainRequest - A Consumer that will call methods on DeleteDomainRequest.Builder to create a request.BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteIntegrationResponse deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException
Removes an integration from a specific domain.
deleteIntegrationRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteIntegrationRequest.builder()
deleteIntegrationRequest - A Consumer that will call methods on DeleteIntegrationRequest.Builder to create a request.BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteProfileRequest - BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteProfileRequest.builder()
deleteProfileRequest - A Consumer that will call methods on DeleteProfileRequest.Builder to create a request.BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteProfileKeyResponse deleteProfileKey(DeleteProfileKeyRequest deleteProfileKeyRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException
Removes a searchable key from a customer profile.
deleteProfileKeyRequest - BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteProfileKeyRequest.builder()
deleteProfileKeyRequest - A Consumer that will call methods on DeleteProfileKeyRequest.Builder to create a request.BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteProfileObjectResponse deleteProfileObject(DeleteProfileObjectRequest deleteProfileObjectRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException
Removes an object associated with a profile of a given ProfileObjectType.
deleteProfileObjectRequest - BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteProfileObjectRequest.builder()
deleteProfileObjectRequest - A Consumer that will call methods on DeleteProfileObjectRequest.Builder to create a
request.BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteProfileObjectTypeRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteProfileObjectTypeRequest.builder()
deleteProfileObjectTypeRequest - A Consumer that will call methods on DeleteProfileObjectTypeRequest.Builder to create a
request.BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDomainResponse getDomain(GetDomainRequest getDomainRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException
Returns information about a specific domain.
getDomainRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via GetDomainRequest.builder()
getDomainRequest - A Consumer that will call methods on GetDomainRequest.Builder to create a request.BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetIntegrationResponse getIntegration(GetIntegrationRequest getIntegrationRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException
Returns an integration for a domain.
getIntegrationRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via GetIntegrationRequest.builder()
getIntegrationRequest - A Consumer that will call methods on GetIntegrationRequest.Builder to create a request.BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetMatchesResponse getMatches(GetMatchesRequest getMatchesRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException
This API is in preview release for Amazon Connect and subject to change.
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.
Amazon Connect runs a batch process every Saturday at 12AM UTC to identify matching profiles. The results are returned up to seven days after the Saturday run.
Amazon Connect uses the following profile attributes to identify matches:
PhoneNumber
HomePhoneNumber
BusinessPhoneNumber
MobilePhoneNumber
EmailAddress
PersonalEmailAddress
BusinessEmailAddress
FullName
BusinessName
getMatchesRequest - BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetMatchesResponse getMatches(Consumer<GetMatchesRequest.Builder> getMatchesRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException
This API is in preview release for Amazon Connect and subject to change.
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.
Amazon Connect runs a batch process every Saturday at 12AM UTC to identify matching profiles. The results are returned up to seven days after the Saturday run.
Amazon Connect uses the following profile attributes to identify matches:
PhoneNumber
HomePhoneNumber
BusinessPhoneNumber
MobilePhoneNumber
EmailAddress
PersonalEmailAddress
BusinessEmailAddress
FullName
BusinessName
This is a convenience which creates an instance of the GetMatchesRequest.Builder avoiding the need to
create one manually via GetMatchesRequest.builder()
getMatchesRequest - A Consumer that will call methods on GetMatchesRequest.Builder to create a request.BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetProfileObjectTypeResponse getProfileObjectType(GetProfileObjectTypeRequest getProfileObjectTypeRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException
Returns the object types for a specific domain.
getProfileObjectTypeRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via GetProfileObjectTypeRequest.builder()
getProfileObjectTypeRequest - A Consumer that will call methods on GetProfileObjectTypeRequest.Builder to create a
request.BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
getProfileObjectTypeTemplateRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via GetProfileObjectTypeTemplateRequest.builder()
getProfileObjectTypeTemplateRequest - A Consumer that will call methods on GetProfileObjectTypeTemplateRequest.Builder to create
a request.BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listAccountIntegrationsRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListAccountIntegrationsRequest.builder()
listAccountIntegrationsRequest - A Consumer that will call methods on ListAccountIntegrationsRequest.Builder to create a
request.BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listDomainsRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListDomainsRequest.builder()
listDomainsRequest - A Consumer that will call methods on ListDomainsRequest.Builder to create a request.BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListIntegrationsResponse listIntegrations(ListIntegrationsRequest listIntegrationsRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException
Lists all of the integrations in your domain.
listIntegrationsRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListIntegrationsRequest.builder()
listIntegrationsRequest - A Consumer that will call methods on ListIntegrationsRequest.Builder to create a request.BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListProfileObjectTypeTemplatesResponse listProfileObjectTypeTemplates(ListProfileObjectTypeTemplatesRequest listProfileObjectTypeTemplatesRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException
Lists all of the template information for object types.
listProfileObjectTypeTemplatesRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListProfileObjectTypeTemplatesRequest.builder()
listProfileObjectTypeTemplatesRequest - A Consumer that will call methods on ListProfileObjectTypeTemplatesRequest.Builder to
create a request.BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListProfileObjectTypesResponse listProfileObjectTypes(ListProfileObjectTypesRequest listProfileObjectTypesRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException
Lists all of the templates available within the service.
listProfileObjectTypesRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListProfileObjectTypesRequest.builder()
listProfileObjectTypesRequest - A Consumer that will call methods on ListProfileObjectTypesRequest.Builder to create a
request.BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listProfileObjectsRequest - BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListProfileObjectsRequest.builder()
listProfileObjectsRequest - A Consumer that will call methods on ListProfileObjectsRequest.Builder to create a
request.BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listTagsForResourceRequest - InternalServerException - An internal service error occurred.BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.InternalServerException - An internal service error occurred.BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault MergeProfilesResponse mergeProfiles(MergeProfilesRequest mergeProfilesRequest) throws BadRequestException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException
This API is in preview release for Amazon Connect and subject to change.
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).
mergeProfilesRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault MergeProfilesResponse mergeProfiles(Consumer<MergeProfilesRequest.Builder> mergeProfilesRequest) throws BadRequestException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException
This API is in preview release for Amazon Connect and subject to change.
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 via MergeProfilesRequest.builder()
mergeProfilesRequest - A Consumer that will call methods on MergeProfilesRequest.Builder to create a request.BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
putIntegrationRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
This is a convenience which creates an instance of the PutIntegrationRequest.Builder avoiding the need to
create one manually via PutIntegrationRequest.builder()
putIntegrationRequest - A Consumer that will call methods on PutIntegrationRequest.Builder to create a request.BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 Trace Record (CTR), 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 CTRs 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.
putProfileObjectRequest - BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 Trace Record (CTR), 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 CTRs 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 via PutProfileObjectRequest.builder()
putProfileObjectRequest - A Consumer that will call methods on PutProfileObjectRequest.Builder to create a request.BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutProfileObjectTypeResponse putProfileObjectType(PutProfileObjectTypeRequest putProfileObjectTypeRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException
Defines a ProfileObjectType.
putProfileObjectTypeRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutProfileObjectTypeResponse putProfileObjectType(Consumer<PutProfileObjectTypeRequest.Builder> putProfileObjectTypeRequest) throws BadRequestException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException
Defines a ProfileObjectType.
This is a convenience which creates an instance of the PutProfileObjectTypeRequest.Builder avoiding the
need to create one manually via PutProfileObjectTypeRequest.builder()
putProfileObjectTypeRequest - A Consumer that will call methods on PutProfileObjectTypeRequest.Builder to create a
request.BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchProfilesResponse searchProfiles(SearchProfilesRequest searchProfilesRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException
Searches for profiles within a specific domain name using name, phone number, email address, account number, or a custom defined index.
searchProfilesRequest - BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchProfilesResponse searchProfiles(Consumer<SearchProfilesRequest.Builder> searchProfilesRequest) throws BadRequestException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, CustomerProfilesException
Searches for profiles within a specific domain name using name, phone number, email address, account number, or a custom defined index.
This is a convenience which creates an instance of the SearchProfilesRequest.Builder avoiding the need to
create one manually via SearchProfilesRequest.builder()
searchProfilesRequest - A Consumer that will call methods on SearchProfilesRequest.Builder to create a request.BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
tagResourceRequest - InternalServerException - An internal service error occurred.BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.InternalServerException - An internal service error occurred.BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
untagResourceRequest - InternalServerException - An internal service error occurred.BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.InternalServerException - An internal service error occurred.BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
updateDomainRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
This is a convenience which creates an instance of the UpdateDomainRequest.Builder avoiding the need to
create one manually via UpdateDomainRequest.builder()
updateDomainRequest - A Consumer that will call methods on UpdateDomainRequest.Builder to create a request.BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
updateProfileRequest - BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UpdateProfileRequest.builder()
updateProfileRequest - A Consumer that will call methods on UpdateProfileRequest.Builder to create a request.BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CustomerProfilesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2021. All rights reserved.