Package software.amazon.awssdk.services.customerprofiles

Interface CustomerProfilesAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface CustomerProfilesAsyncClient extends AwsClient
Service client for accessing Customer Profiles asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call. Amazon Connect Customer Profiles

Amazon Connect Customer Profiles is a unified customer profile for your contact center that has pre-built connectors powered by AppFlow that make it easy to combine customer information from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center. If you're new to Amazon Connect, you might find it helpful to review the Amazon Connect Administrator Guide.

  • Field Details

  • Method Details

    • addProfileKey

      default CompletableFuture<AddProfileKeyResponse> addProfileKey(AddProfileKeyRequest addProfileKeyRequest)

      Associates a new key value with a specific profile, such as a Contact Record ContactId.

      A profile object can have a single unique key and any number of additional keys that can be used to identify the profile that it belongs to.

      Parameters:
      addProfileKeyRequest -
      Returns:
      A Java Future containing the result of the AddProfileKey operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • addProfileKey

      default CompletableFuture<AddProfileKeyResponse> addProfileKey(Consumer<AddProfileKeyRequest.Builder> addProfileKeyRequest)

      Associates a new key value with a specific profile, such as a Contact Record ContactId.

      A profile object can have a single unique key and any number of additional keys that can be used to identify the profile that it belongs to.


      This is a convenience which creates an instance of the AddProfileKeyRequest.Builder avoiding the need to create one manually via AddProfileKeyRequest.builder()

      Parameters:
      addProfileKeyRequest - A Consumer that will call methods on AddProfileKeyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AddProfileKey operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createCalculatedAttributeDefinition

      default CompletableFuture<CreateCalculatedAttributeDefinitionResponse> createCalculatedAttributeDefinition(CreateCalculatedAttributeDefinitionRequest createCalculatedAttributeDefinitionRequest)

      Creates a new calculated attribute definition. After creation, new object data ingested into Customer Profiles will be included in the calculated attribute, which can be retrieved for a profile using the GetCalculatedAttributeForProfile API. Defining a calculated attribute makes it available for all profiles within a domain. Each calculated attribute can only reference one ObjectType and at most, two fields from that ObjectType.

      Parameters:
      createCalculatedAttributeDefinitionRequest -
      Returns:
      A Java Future containing the result of the CreateCalculatedAttributeDefinition operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createCalculatedAttributeDefinition

      default CompletableFuture<CreateCalculatedAttributeDefinitionResponse> createCalculatedAttributeDefinition(Consumer<CreateCalculatedAttributeDefinitionRequest.Builder> createCalculatedAttributeDefinitionRequest)

      Creates a new calculated attribute definition. After creation, new object data ingested into Customer Profiles will be included in the calculated attribute, which can be retrieved for a profile using the GetCalculatedAttributeForProfile API. Defining a calculated attribute makes it available for all profiles within a domain. Each calculated attribute can only reference one ObjectType and at most, two fields from that ObjectType.


      This is a convenience which creates an instance of the CreateCalculatedAttributeDefinitionRequest.Builder avoiding the need to create one manually via CreateCalculatedAttributeDefinitionRequest.builder()

      Parameters:
      createCalculatedAttributeDefinitionRequest - A Consumer that will call methods on CreateCalculatedAttributeDefinitionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateCalculatedAttributeDefinition operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createDomain

      default CompletableFuture<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. You can create multiple domains, and each domain can have multiple third-party integrations.

      Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain.

      Use this API or UpdateDomain to enable identity resolution: set Matching to true.

      To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply.

      Parameters:
      createDomainRequest -
      Returns:
      A Java Future containing the result of the CreateDomain operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createDomain

      default CompletableFuture<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. You can create multiple domains, and each domain can have multiple third-party integrations.

      Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain.

      Use this API or UpdateDomain to enable identity resolution: set Matching to true.

      To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply.


      This is a convenience which creates an instance of the CreateDomainRequest.Builder avoiding the need to create one manually via CreateDomainRequest.builder()

      Parameters:
      createDomainRequest - A Consumer that will call methods on CreateDomainRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDomain operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createEventStream

      default CompletableFuture<CreateEventStreamResponse> createEventStream(CreateEventStreamRequest createEventStreamRequest)

      Creates an event stream, which is a subscription to real-time events, such as when profiles are created and updated through Amazon Connect Customer Profiles.

      Each event stream can be associated with only one Kinesis Data Stream destination in the same region and Amazon Web Services account as the customer profiles domain

      Parameters:
      createEventStreamRequest -
      Returns:
      A Java Future containing the result of the CreateEventStream operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createEventStream

      default CompletableFuture<CreateEventStreamResponse> createEventStream(Consumer<CreateEventStreamRequest.Builder> createEventStreamRequest)

      Creates an event stream, which is a subscription to real-time events, such as when profiles are created and updated through Amazon Connect Customer Profiles.

      Each event stream can be associated with only one Kinesis Data Stream destination in the same region and Amazon Web Services account as the customer profiles domain


      This is a convenience which creates an instance of the CreateEventStreamRequest.Builder avoiding the need to create one manually via CreateEventStreamRequest.builder()

      Parameters:
      createEventStreamRequest - A Consumer that will call methods on CreateEventStreamRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateEventStream operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createIntegrationWorkflow

      default CompletableFuture<CreateIntegrationWorkflowResponse> createIntegrationWorkflow(CreateIntegrationWorkflowRequest createIntegrationWorkflowRequest)

      Creates an integration workflow. An integration workflow is an async process which ingests historic data and sets up an integration for ongoing updates. The supported Amazon AppFlow sources are Salesforce, ServiceNow, and Marketo.

      Parameters:
      createIntegrationWorkflowRequest -
      Returns:
      A Java Future containing the result of the CreateIntegrationWorkflow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createIntegrationWorkflow

      default CompletableFuture<CreateIntegrationWorkflowResponse> createIntegrationWorkflow(Consumer<CreateIntegrationWorkflowRequest.Builder> createIntegrationWorkflowRequest)

      Creates an integration workflow. An integration workflow is an async process which ingests historic data and sets up an integration for ongoing updates. The supported Amazon AppFlow sources are Salesforce, ServiceNow, and Marketo.


      This is a convenience which creates an instance of the CreateIntegrationWorkflowRequest.Builder avoiding the need to create one manually via CreateIntegrationWorkflowRequest.builder()

      Parameters:
      createIntegrationWorkflowRequest - A Consumer that will call methods on CreateIntegrationWorkflowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateIntegrationWorkflow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createProfile

      default CompletableFuture<CreateProfileResponse> createProfile(CreateProfileRequest createProfileRequest)

      Creates a standard profile.

      A standard profile represents the following attributes for a customer profile in a domain.

      Parameters:
      createProfileRequest -
      Returns:
      A Java Future containing the result of the CreateProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createProfile

      default CompletableFuture<CreateProfileResponse> createProfile(Consumer<CreateProfileRequest.Builder> createProfileRequest)

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

      Parameters:
      createProfileRequest - A Consumer that will call methods on CreateProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteCalculatedAttributeDefinition

      default CompletableFuture<DeleteCalculatedAttributeDefinitionResponse> deleteCalculatedAttributeDefinition(DeleteCalculatedAttributeDefinitionRequest deleteCalculatedAttributeDefinitionRequest)

      Deletes an existing calculated attribute definition. Note that deleting a default calculated attribute is possible, however once deleted, you will be unable to undo that action and will need to recreate it on your own using the CreateCalculatedAttributeDefinition API if you want it back.

      Parameters:
      deleteCalculatedAttributeDefinitionRequest -
      Returns:
      A Java Future containing the result of the DeleteCalculatedAttributeDefinition operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteCalculatedAttributeDefinition

      default CompletableFuture<DeleteCalculatedAttributeDefinitionResponse> deleteCalculatedAttributeDefinition(Consumer<DeleteCalculatedAttributeDefinitionRequest.Builder> deleteCalculatedAttributeDefinitionRequest)

      Deletes an existing calculated attribute definition. Note that deleting a default calculated attribute is possible, however once deleted, you will be unable to undo that action and will need to recreate it on your own using the CreateCalculatedAttributeDefinition API if you want it back.


      This is a convenience which creates an instance of the DeleteCalculatedAttributeDefinitionRequest.Builder avoiding the need to create one manually via DeleteCalculatedAttributeDefinitionRequest.builder()

      Parameters:
      deleteCalculatedAttributeDefinitionRequest - A Consumer that will call methods on DeleteCalculatedAttributeDefinitionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteCalculatedAttributeDefinition operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteDomain

      default CompletableFuture<DeleteDomainResponse> deleteDomain(DeleteDomainRequest deleteDomainRequest)

      Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.

      Parameters:
      deleteDomainRequest -
      Returns:
      A Java Future containing the result of the DeleteDomain operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteDomain

      default CompletableFuture<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.


      This is a convenience which creates an instance of the DeleteDomainRequest.Builder avoiding the need to create one manually via DeleteDomainRequest.builder()

      Parameters:
      deleteDomainRequest - A Consumer that will call methods on DeleteDomainRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteDomain operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteEventStream

      default CompletableFuture<DeleteEventStreamResponse> deleteEventStream(DeleteEventStreamRequest deleteEventStreamRequest)

      Disables and deletes the specified event stream.

      Parameters:
      deleteEventStreamRequest -
      Returns:
      A Java Future containing the result of the DeleteEventStream operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteEventStream

      default CompletableFuture<DeleteEventStreamResponse> deleteEventStream(Consumer<DeleteEventStreamRequest.Builder> deleteEventStreamRequest)

      Disables and deletes the specified event stream.


      This is a convenience which creates an instance of the DeleteEventStreamRequest.Builder avoiding the need to create one manually via DeleteEventStreamRequest.builder()

      Parameters:
      deleteEventStreamRequest - A Consumer that will call methods on DeleteEventStreamRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteEventStream operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteIntegration

      default CompletableFuture<DeleteIntegrationResponse> deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest)

      Removes an integration from a specific domain.

      Parameters:
      deleteIntegrationRequest -
      Returns:
      A Java Future containing the result of the DeleteIntegration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteIntegration

      default CompletableFuture<DeleteIntegrationResponse> deleteIntegration(Consumer<DeleteIntegrationRequest.Builder> deleteIntegrationRequest)

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

      Parameters:
      deleteIntegrationRequest - A Consumer that will call methods on DeleteIntegrationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteIntegration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteProfile

      default CompletableFuture<DeleteProfileResponse> deleteProfile(DeleteProfileRequest deleteProfileRequest)

      Deletes the standard customer profile and all data pertaining to the profile.

      Parameters:
      deleteProfileRequest -
      Returns:
      A Java Future containing the result of the DeleteProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteProfile

      default CompletableFuture<DeleteProfileResponse> deleteProfile(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest)

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

      Parameters:
      deleteProfileRequest - A Consumer that will call methods on DeleteProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteProfileKey

      default CompletableFuture<DeleteProfileKeyResponse> deleteProfileKey(DeleteProfileKeyRequest deleteProfileKeyRequest)

      Removes a searchable key from a customer profile.

      Parameters:
      deleteProfileKeyRequest -
      Returns:
      A Java Future containing the result of the DeleteProfileKey operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteProfileKey

      default CompletableFuture<DeleteProfileKeyResponse> deleteProfileKey(Consumer<DeleteProfileKeyRequest.Builder> deleteProfileKeyRequest)

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

      Parameters:
      deleteProfileKeyRequest - A Consumer that will call methods on DeleteProfileKeyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteProfileKey operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteProfileObject

      default CompletableFuture<DeleteProfileObjectResponse> deleteProfileObject(DeleteProfileObjectRequest deleteProfileObjectRequest)

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

      Parameters:
      deleteProfileObjectRequest -
      Returns:
      A Java Future containing the result of the DeleteProfileObject operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteProfileObject

      default CompletableFuture<DeleteProfileObjectResponse> deleteProfileObject(Consumer<DeleteProfileObjectRequest.Builder> deleteProfileObjectRequest)

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

      Parameters:
      deleteProfileObjectRequest - A Consumer that will call methods on DeleteProfileObjectRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteProfileObject operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteProfileObjectType

      default CompletableFuture<DeleteProfileObjectTypeResponse> deleteProfileObjectType(DeleteProfileObjectTypeRequest deleteProfileObjectTypeRequest)

      Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type. It also disables integrations from this specific ProfileObjectType. In addition, it scrubs all of the fields of the standard profile that were populated from this ProfileObjectType.

      Parameters:
      deleteProfileObjectTypeRequest -
      Returns:
      A Java Future containing the result of the DeleteProfileObjectType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteProfileObjectType

      default CompletableFuture<DeleteProfileObjectTypeResponse> deleteProfileObjectType(Consumer<DeleteProfileObjectTypeRequest.Builder> deleteProfileObjectTypeRequest)

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

      Parameters:
      deleteProfileObjectTypeRequest - A Consumer that will call methods on DeleteProfileObjectTypeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteProfileObjectType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteWorkflow

      default CompletableFuture<DeleteWorkflowResponse> deleteWorkflow(DeleteWorkflowRequest deleteWorkflowRequest)

      Deletes the specified workflow and all its corresponding resources. This is an async process.

      Parameters:
      deleteWorkflowRequest -
      Returns:
      A Java Future containing the result of the DeleteWorkflow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteWorkflow

      default CompletableFuture<DeleteWorkflowResponse> deleteWorkflow(Consumer<DeleteWorkflowRequest.Builder> deleteWorkflowRequest)

      Deletes the specified workflow and all its corresponding resources. This is an async process.


      This is a convenience which creates an instance of the DeleteWorkflowRequest.Builder avoiding the need to create one manually via DeleteWorkflowRequest.builder()

      Parameters:
      deleteWorkflowRequest - A Consumer that will call methods on DeleteWorkflowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteWorkflow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • detectProfileObjectType

      default CompletableFuture<DetectProfileObjectTypeResponse> detectProfileObjectType(DetectProfileObjectTypeRequest detectProfileObjectTypeRequest)

      The process of detecting profile object type mapping by using given objects.

      Parameters:
      detectProfileObjectTypeRequest -
      Returns:
      A Java Future containing the result of the DetectProfileObjectType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • detectProfileObjectType

      default CompletableFuture<DetectProfileObjectTypeResponse> detectProfileObjectType(Consumer<DetectProfileObjectTypeRequest.Builder> detectProfileObjectTypeRequest)

      The process of detecting profile object type mapping by using given objects.


      This is a convenience which creates an instance of the DetectProfileObjectTypeRequest.Builder avoiding the need to create one manually via DetectProfileObjectTypeRequest.builder()

      Parameters:
      detectProfileObjectTypeRequest - A Consumer that will call methods on DetectProfileObjectTypeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DetectProfileObjectType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getAutoMergingPreview

      default CompletableFuture<GetAutoMergingPreviewResponse> getAutoMergingPreview(GetAutoMergingPreviewRequest getAutoMergingPreviewRequest)

      Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly selects a sample of matching groups from the existing matching results, and applies the automerging settings that you provided. You can then view the number of profiles in the sample, the number of matches, and the number of profiles identified to be merged. This enables you to evaluate the accuracy of the attributes in your matching list.

      You can't view which profiles are matched and would be merged.

      We strongly recommend you use this API to do a dry run of the automerging process before running the Identity Resolution Job. Include at least two matching attributes. If your matching list includes too few attributes (such as only FirstName or only LastName), there may be a large number of matches. This increases the chances of erroneous merges.

      Parameters:
      getAutoMergingPreviewRequest -
      Returns:
      A Java Future containing the result of the GetAutoMergingPreview operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getAutoMergingPreview

      default CompletableFuture<GetAutoMergingPreviewResponse> getAutoMergingPreview(Consumer<GetAutoMergingPreviewRequest.Builder> getAutoMergingPreviewRequest)

      Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly selects a sample of matching groups from the existing matching results, and applies the automerging settings that you provided. You can then view the number of profiles in the sample, the number of matches, and the number of profiles identified to be merged. This enables you to evaluate the accuracy of the attributes in your matching list.

      You can't view which profiles are matched and would be merged.

      We strongly recommend you use this API to do a dry run of the automerging process before running the Identity Resolution Job. Include at least two matching attributes. If your matching list includes too few attributes (such as only FirstName or only LastName), there may be a large number of matches. This increases the chances of erroneous merges.


      This is a convenience which creates an instance of the GetAutoMergingPreviewRequest.Builder avoiding the need to create one manually via GetAutoMergingPreviewRequest.builder()

      Parameters:
      getAutoMergingPreviewRequest - A Consumer that will call methods on GetAutoMergingPreviewRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAutoMergingPreview operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getCalculatedAttributeDefinition

      default CompletableFuture<GetCalculatedAttributeDefinitionResponse> getCalculatedAttributeDefinition(GetCalculatedAttributeDefinitionRequest getCalculatedAttributeDefinitionRequest)

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

      Parameters:
      getCalculatedAttributeDefinitionRequest -
      Returns:
      A Java Future containing the result of the GetCalculatedAttributeDefinition operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getCalculatedAttributeDefinition

      default CompletableFuture<GetCalculatedAttributeDefinitionResponse> getCalculatedAttributeDefinition(Consumer<GetCalculatedAttributeDefinitionRequest.Builder> getCalculatedAttributeDefinitionRequest)

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


      This is a convenience which creates an instance of the GetCalculatedAttributeDefinitionRequest.Builder avoiding the need to create one manually via GetCalculatedAttributeDefinitionRequest.builder()

      Parameters:
      getCalculatedAttributeDefinitionRequest - A Consumer that will call methods on GetCalculatedAttributeDefinitionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetCalculatedAttributeDefinition operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getCalculatedAttributeForProfile

      default CompletableFuture<GetCalculatedAttributeForProfileResponse> getCalculatedAttributeForProfile(GetCalculatedAttributeForProfileRequest getCalculatedAttributeForProfileRequest)

      Retrieve a calculated attribute for a customer profile.

      Parameters:
      getCalculatedAttributeForProfileRequest -
      Returns:
      A Java Future containing the result of the GetCalculatedAttributeForProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getCalculatedAttributeForProfile

      default CompletableFuture<GetCalculatedAttributeForProfileResponse> getCalculatedAttributeForProfile(Consumer<GetCalculatedAttributeForProfileRequest.Builder> getCalculatedAttributeForProfileRequest)

      Retrieve a calculated attribute for a customer profile.


      This is a convenience which creates an instance of the GetCalculatedAttributeForProfileRequest.Builder avoiding the need to create one manually via GetCalculatedAttributeForProfileRequest.builder()

      Parameters:
      getCalculatedAttributeForProfileRequest - A Consumer that will call methods on GetCalculatedAttributeForProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetCalculatedAttributeForProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getDomain

      default CompletableFuture<GetDomainResponse> getDomain(GetDomainRequest getDomainRequest)

      Returns information about a specific domain.

      Parameters:
      getDomainRequest -
      Returns:
      A Java Future containing the result of the GetDomain operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getDomain

      default CompletableFuture<GetDomainResponse> getDomain(Consumer<GetDomainRequest.Builder> getDomainRequest)

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

      Parameters:
      getDomainRequest - A Consumer that will call methods on GetDomainRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDomain operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getEventStream

      default CompletableFuture<GetEventStreamResponse> getEventStream(GetEventStreamRequest getEventStreamRequest)

      Returns information about the specified event stream in a specific domain.

      Parameters:
      getEventStreamRequest -
      Returns:
      A Java Future containing the result of the GetEventStream operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getEventStream

      default CompletableFuture<GetEventStreamResponse> getEventStream(Consumer<GetEventStreamRequest.Builder> getEventStreamRequest)

      Returns information about the specified event stream in a specific domain.


      This is a convenience which creates an instance of the GetEventStreamRequest.Builder avoiding the need to create one manually via GetEventStreamRequest.builder()

      Parameters:
      getEventStreamRequest - A Consumer that will call methods on GetEventStreamRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetEventStream operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getIdentityResolutionJob

      default CompletableFuture<GetIdentityResolutionJobResponse> getIdentityResolutionJob(GetIdentityResolutionJobRequest getIdentityResolutionJobRequest)

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

      Identity Resolution Jobs are set up using the Amazon Connect admin console. For more information, see Use Identity Resolution to consolidate similar profiles.

      Parameters:
      getIdentityResolutionJobRequest -
      Returns:
      A Java Future containing the result of the GetIdentityResolutionJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getIdentityResolutionJob

      default CompletableFuture<GetIdentityResolutionJobResponse> getIdentityResolutionJob(Consumer<GetIdentityResolutionJobRequest.Builder> getIdentityResolutionJobRequest)

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

      Identity Resolution Jobs are set up using the Amazon Connect admin console. For more information, see Use Identity Resolution to consolidate similar profiles.


      This is a convenience which creates an instance of the GetIdentityResolutionJobRequest.Builder avoiding the need to create one manually via GetIdentityResolutionJobRequest.builder()

      Parameters:
      getIdentityResolutionJobRequest - A Consumer that will call methods on GetIdentityResolutionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetIdentityResolutionJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getIntegration

      default CompletableFuture<GetIntegrationResponse> getIntegration(GetIntegrationRequest getIntegrationRequest)

      Returns an integration for a domain.

      Parameters:
      getIntegrationRequest -
      Returns:
      A Java Future containing the result of the GetIntegration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getIntegration

      default CompletableFuture<GetIntegrationResponse> getIntegration(Consumer<GetIntegrationRequest.Builder> getIntegrationRequest)

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

      Parameters:
      getIntegrationRequest - A Consumer that will call methods on GetIntegrationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetIntegration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getMatches

      default CompletableFuture<GetMatchesResponse> getMatches(GetMatchesRequest getMatchesRequest)

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

      GetMatches returns potentially matching profiles, based on the results of the latest run of a machine learning process.

      The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.

      After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.

      Amazon Connect uses the following profile attributes to identify matches:

      • PhoneNumber

      • HomePhoneNumber

      • BusinessPhoneNumber

      • MobilePhoneNumber

      • EmailAddress

      • PersonalEmailAddress

      • BusinessEmailAddress

      • FullName

      For example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different casing email addresses such as JOHN_DOE@ANYCOMPANY.COM and johndoe@anycompany.com, or different phone number formats such as 555-010-0000 and +1-555-010-0000—can be detected as belonging to the same customer John Doe and merged into a unified profile.

      Parameters:
      getMatchesRequest -
      Returns:
      A Java Future containing the result of the GetMatches operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getMatches

      default CompletableFuture<GetMatchesResponse> getMatches(Consumer<GetMatchesRequest.Builder> getMatchesRequest)

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

      GetMatches returns potentially matching profiles, based on the results of the latest run of a machine learning process.

      The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.

      After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.

      Amazon Connect uses the following profile attributes to identify matches:

      • PhoneNumber

      • HomePhoneNumber

      • BusinessPhoneNumber

      • MobilePhoneNumber

      • EmailAddress

      • PersonalEmailAddress

      • BusinessEmailAddress

      • FullName

      For example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different casing email addresses such as JOHN_DOE@ANYCOMPANY.COM and johndoe@anycompany.com, or different phone number formats such as 555-010-0000 and +1-555-010-0000—can be detected as belonging to the same customer John Doe and merged into a unified profile.


      This is a convenience which creates an instance of the GetMatchesRequest.Builder avoiding the need to create one manually via GetMatchesRequest.builder()

      Parameters:
      getMatchesRequest - A Consumer that will call methods on GetMatchesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetMatches operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getProfileObjectType

      default CompletableFuture<GetProfileObjectTypeResponse> getProfileObjectType(GetProfileObjectTypeRequest getProfileObjectTypeRequest)

      Returns the object types for a specific domain.

      Parameters:
      getProfileObjectTypeRequest -
      Returns:
      A Java Future containing the result of the GetProfileObjectType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getProfileObjectType

      default CompletableFuture<GetProfileObjectTypeResponse> getProfileObjectType(Consumer<GetProfileObjectTypeRequest.Builder> getProfileObjectTypeRequest)

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

      Parameters:
      getProfileObjectTypeRequest - A Consumer that will call methods on GetProfileObjectTypeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetProfileObjectType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getProfileObjectTypeTemplate

      default CompletableFuture<GetProfileObjectTypeTemplateResponse> getProfileObjectTypeTemplate(GetProfileObjectTypeTemplateRequest getProfileObjectTypeTemplateRequest)

      Returns the template information for a specific object type.

      A template is a predefined ProfileObjectType, such as “Salesforce-Account” or “Salesforce-Contact.” When a user sends a ProfileObject, using the PutProfileObject API, with an ObjectTypeName that matches one of the TemplateIds, it uses the mappings from the template.

      Parameters:
      getProfileObjectTypeTemplateRequest -
      Returns:
      A Java Future containing the result of the GetProfileObjectTypeTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getProfileObjectTypeTemplate

      default CompletableFuture<GetProfileObjectTypeTemplateResponse> getProfileObjectTypeTemplate(Consumer<GetProfileObjectTypeTemplateRequest.Builder> getProfileObjectTypeTemplateRequest)

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

      Parameters:
      getProfileObjectTypeTemplateRequest - A Consumer that will call methods on GetProfileObjectTypeTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetProfileObjectTypeTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getSimilarProfiles

      default CompletableFuture<GetSimilarProfilesResponse> getSimilarProfiles(GetSimilarProfilesRequest getSimilarProfilesRequest)

      Returns a set of profiles that belong to the same matching group using the matchId or profileId. You can also specify the type of matching that you want for finding similar profiles using either RULE_BASED_MATCHING or ML_BASED_MATCHING.

      Parameters:
      getSimilarProfilesRequest -
      Returns:
      A Java Future containing the result of the GetSimilarProfiles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getSimilarProfiles

      default CompletableFuture<GetSimilarProfilesResponse> getSimilarProfiles(Consumer<GetSimilarProfilesRequest.Builder> getSimilarProfilesRequest)

      Returns a set of profiles that belong to the same matching group using the matchId or profileId. You can also specify the type of matching that you want for finding similar profiles using either RULE_BASED_MATCHING or ML_BASED_MATCHING.


      This is a convenience which creates an instance of the GetSimilarProfilesRequest.Builder avoiding the need to create one manually via GetSimilarProfilesRequest.builder()

      Parameters:
      getSimilarProfilesRequest - A Consumer that will call methods on GetSimilarProfilesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSimilarProfiles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getWorkflow

      default CompletableFuture<GetWorkflowResponse> getWorkflow(GetWorkflowRequest getWorkflowRequest)

      Get details of specified workflow.

      Parameters:
      getWorkflowRequest -
      Returns:
      A Java Future containing the result of the GetWorkflow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getWorkflow

      default CompletableFuture<GetWorkflowResponse> getWorkflow(Consumer<GetWorkflowRequest.Builder> getWorkflowRequest)

      Get details of specified workflow.


      This is a convenience which creates an instance of the GetWorkflowRequest.Builder avoiding the need to create one manually via GetWorkflowRequest.builder()

      Parameters:
      getWorkflowRequest - A Consumer that will call methods on GetWorkflowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetWorkflow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getWorkflowSteps

      default CompletableFuture<GetWorkflowStepsResponse> getWorkflowSteps(GetWorkflowStepsRequest getWorkflowStepsRequest)

      Get granular list of steps in workflow.

      Parameters:
      getWorkflowStepsRequest -
      Returns:
      A Java Future containing the result of the GetWorkflowSteps operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getWorkflowSteps

      default CompletableFuture<GetWorkflowStepsResponse> getWorkflowSteps(Consumer<GetWorkflowStepsRequest.Builder> getWorkflowStepsRequest)

      Get granular list of steps in workflow.


      This is a convenience which creates an instance of the GetWorkflowStepsRequest.Builder avoiding the need to create one manually via GetWorkflowStepsRequest.builder()

      Parameters:
      getWorkflowStepsRequest - A Consumer that will call methods on GetWorkflowStepsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetWorkflowSteps operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listAccountIntegrations

      default CompletableFuture<ListAccountIntegrationsResponse> listAccountIntegrations(ListAccountIntegrationsRequest listAccountIntegrationsRequest)

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

      Parameters:
      listAccountIntegrationsRequest -
      Returns:
      A Java Future containing the result of the ListAccountIntegrations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listAccountIntegrations

      default CompletableFuture<ListAccountIntegrationsResponse> listAccountIntegrations(Consumer<ListAccountIntegrationsRequest.Builder> listAccountIntegrationsRequest)

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

      Parameters:
      listAccountIntegrationsRequest - A Consumer that will call methods on ListAccountIntegrationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAccountIntegrations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listCalculatedAttributeDefinitions

      default CompletableFuture<ListCalculatedAttributeDefinitionsResponse> listCalculatedAttributeDefinitions(ListCalculatedAttributeDefinitionsRequest listCalculatedAttributeDefinitionsRequest)

      Lists calculated attribute definitions for Customer Profiles

      Parameters:
      listCalculatedAttributeDefinitionsRequest -
      Returns:
      A Java Future containing the result of the ListCalculatedAttributeDefinitions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listCalculatedAttributeDefinitions

      default CompletableFuture<ListCalculatedAttributeDefinitionsResponse> listCalculatedAttributeDefinitions(Consumer<ListCalculatedAttributeDefinitionsRequest.Builder> listCalculatedAttributeDefinitionsRequest)

      Lists calculated attribute definitions for Customer Profiles


      This is a convenience which creates an instance of the ListCalculatedAttributeDefinitionsRequest.Builder avoiding the need to create one manually via ListCalculatedAttributeDefinitionsRequest.builder()

      Parameters:
      listCalculatedAttributeDefinitionsRequest - A Consumer that will call methods on ListCalculatedAttributeDefinitionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListCalculatedAttributeDefinitions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listCalculatedAttributesForProfile

      default CompletableFuture<ListCalculatedAttributesForProfileResponse> listCalculatedAttributesForProfile(ListCalculatedAttributesForProfileRequest listCalculatedAttributesForProfileRequest)

      Retrieve a list of calculated attributes for a customer profile.

      Parameters:
      listCalculatedAttributesForProfileRequest -
      Returns:
      A Java Future containing the result of the ListCalculatedAttributesForProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listCalculatedAttributesForProfile

      default CompletableFuture<ListCalculatedAttributesForProfileResponse> listCalculatedAttributesForProfile(Consumer<ListCalculatedAttributesForProfileRequest.Builder> listCalculatedAttributesForProfileRequest)

      Retrieve a list of calculated attributes for a customer profile.


      This is a convenience which creates an instance of the ListCalculatedAttributesForProfileRequest.Builder avoiding the need to create one manually via ListCalculatedAttributesForProfileRequest.builder()

      Parameters:
      listCalculatedAttributesForProfileRequest - A Consumer that will call methods on ListCalculatedAttributesForProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListCalculatedAttributesForProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listDomains

      default CompletableFuture<ListDomainsResponse> listDomains(ListDomainsRequest listDomainsRequest)

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

      Parameters:
      listDomainsRequest -
      Returns:
      A Java Future containing the result of the ListDomains operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listDomains

      default CompletableFuture<ListDomainsResponse> listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest)

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

      Parameters:
      listDomainsRequest - A Consumer that will call methods on ListDomainsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDomains operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listEventStreams

      default CompletableFuture<ListEventStreamsResponse> listEventStreams(ListEventStreamsRequest listEventStreamsRequest)

      Returns a list of all the event streams in a specific domain.

      Parameters:
      listEventStreamsRequest -
      Returns:
      A Java Future containing the result of the ListEventStreams operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listEventStreams

      default CompletableFuture<ListEventStreamsResponse> listEventStreams(Consumer<ListEventStreamsRequest.Builder> listEventStreamsRequest)

      Returns a list of all the event streams in a specific domain.


      This is a convenience which creates an instance of the ListEventStreamsRequest.Builder avoiding the need to create one manually via ListEventStreamsRequest.builder()

      Parameters:
      listEventStreamsRequest - A Consumer that will call methods on ListEventStreamsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListEventStreams operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listEventStreamsPaginator

      default ListEventStreamsPublisher listEventStreamsPaginator(ListEventStreamsRequest listEventStreamsRequest)

      This is a variant of listEventStreams(software.amazon.awssdk.services.customerprofiles.model.ListEventStreamsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.customerprofiles.paginators.ListEventStreamsPublisher publisher = client.listEventStreamsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.customerprofiles.paginators.ListEventStreamsPublisher publisher = client.listEventStreamsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.customerprofiles.model.ListEventStreamsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.customerprofiles.model.ListEventStreamsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listEventStreams(software.amazon.awssdk.services.customerprofiles.model.ListEventStreamsRequest) operation.

      Parameters:
      listEventStreamsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listEventStreamsPaginator

      default ListEventStreamsPublisher listEventStreamsPaginator(Consumer<ListEventStreamsRequest.Builder> listEventStreamsRequest)

      This is a variant of listEventStreams(software.amazon.awssdk.services.customerprofiles.model.ListEventStreamsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.customerprofiles.paginators.ListEventStreamsPublisher publisher = client.listEventStreamsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.customerprofiles.paginators.ListEventStreamsPublisher publisher = client.listEventStreamsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.customerprofiles.model.ListEventStreamsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.customerprofiles.model.ListEventStreamsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listEventStreams(software.amazon.awssdk.services.customerprofiles.model.ListEventStreamsRequest) operation.


      This is a convenience which creates an instance of the ListEventStreamsRequest.Builder avoiding the need to create one manually via ListEventStreamsRequest.builder()

      Parameters:
      listEventStreamsRequest - A Consumer that will call methods on ListEventStreamsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listIdentityResolutionJobs

      default CompletableFuture<ListIdentityResolutionJobsResponse> listIdentityResolutionJobs(ListIdentityResolutionJobsRequest listIdentityResolutionJobsRequest)

      Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by JobStartTime.

      Parameters:
      listIdentityResolutionJobsRequest -
      Returns:
      A Java Future containing the result of the ListIdentityResolutionJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listIdentityResolutionJobs

      default CompletableFuture<ListIdentityResolutionJobsResponse> listIdentityResolutionJobs(Consumer<ListIdentityResolutionJobsRequest.Builder> listIdentityResolutionJobsRequest)

      Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by JobStartTime.


      This is a convenience which creates an instance of the ListIdentityResolutionJobsRequest.Builder avoiding the need to create one manually via ListIdentityResolutionJobsRequest.builder()

      Parameters:
      listIdentityResolutionJobsRequest - A Consumer that will call methods on ListIdentityResolutionJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListIdentityResolutionJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listIntegrations

      default CompletableFuture<ListIntegrationsResponse> listIntegrations(ListIntegrationsRequest listIntegrationsRequest)

      Lists all of the integrations in your domain.

      Parameters:
      listIntegrationsRequest -
      Returns:
      A Java Future containing the result of the ListIntegrations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listIntegrations

      default CompletableFuture<ListIntegrationsResponse> listIntegrations(Consumer<ListIntegrationsRequest.Builder> listIntegrationsRequest)

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

      Parameters:
      listIntegrationsRequest - A Consumer that will call methods on ListIntegrationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListIntegrations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listProfileObjectTypeTemplates

      default CompletableFuture<ListProfileObjectTypeTemplatesResponse> listProfileObjectTypeTemplates(ListProfileObjectTypeTemplatesRequest listProfileObjectTypeTemplatesRequest)

      Lists all of the template information for object types.

      Parameters:
      listProfileObjectTypeTemplatesRequest -
      Returns:
      A Java Future containing the result of the ListProfileObjectTypeTemplates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listProfileObjectTypeTemplates

      default CompletableFuture<ListProfileObjectTypeTemplatesResponse> listProfileObjectTypeTemplates(Consumer<ListProfileObjectTypeTemplatesRequest.Builder> listProfileObjectTypeTemplatesRequest)

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

      Parameters:
      listProfileObjectTypeTemplatesRequest - A Consumer that will call methods on ListProfileObjectTypeTemplatesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListProfileObjectTypeTemplates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listProfileObjectTypes

      default CompletableFuture<ListProfileObjectTypesResponse> listProfileObjectTypes(ListProfileObjectTypesRequest listProfileObjectTypesRequest)

      Lists all of the templates available within the service.

      Parameters:
      listProfileObjectTypesRequest -
      Returns:
      A Java Future containing the result of the ListProfileObjectTypes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listProfileObjectTypes

      default CompletableFuture<ListProfileObjectTypesResponse> listProfileObjectTypes(Consumer<ListProfileObjectTypesRequest.Builder> listProfileObjectTypesRequest)

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

      Parameters:
      listProfileObjectTypesRequest - A Consumer that will call methods on ListProfileObjectTypesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListProfileObjectTypes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listProfileObjects

      default CompletableFuture<ListProfileObjectsResponse> listProfileObjects(ListProfileObjectsRequest listProfileObjectsRequest)

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

      Parameters:
      listProfileObjectsRequest -
      Returns:
      A Java Future containing the result of the ListProfileObjects operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listProfileObjects

      default CompletableFuture<ListProfileObjectsResponse> listProfileObjects(Consumer<ListProfileObjectsRequest.Builder> listProfileObjectsRequest)

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

      Parameters:
      listProfileObjectsRequest - A Consumer that will call methods on ListProfileObjectsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListProfileObjects operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listRuleBasedMatches

      default CompletableFuture<ListRuleBasedMatchesResponse> listRuleBasedMatches(ListRuleBasedMatchesRequest listRuleBasedMatchesRequest)

      Returns a set of MatchIds that belong to the given domain.

      Parameters:
      listRuleBasedMatchesRequest -
      Returns:
      A Java Future containing the result of the ListRuleBasedMatches operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listRuleBasedMatches

      default CompletableFuture<ListRuleBasedMatchesResponse> listRuleBasedMatches(Consumer<ListRuleBasedMatchesRequest.Builder> listRuleBasedMatchesRequest)

      Returns a set of MatchIds that belong to the given domain.


      This is a convenience which creates an instance of the ListRuleBasedMatchesRequest.Builder avoiding the need to create one manually via ListRuleBasedMatchesRequest.builder()

      Parameters:
      listRuleBasedMatchesRequest - A Consumer that will call methods on ListRuleBasedMatchesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListRuleBasedMatches operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Displays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

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

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listWorkflows

      default CompletableFuture<ListWorkflowsResponse> listWorkflows(ListWorkflowsRequest listWorkflowsRequest)

      Query to list all workflows.

      Parameters:
      listWorkflowsRequest -
      Returns:
      A Java Future containing the result of the ListWorkflows operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listWorkflows

      default CompletableFuture<ListWorkflowsResponse> listWorkflows(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest)

      Query to list all workflows.


      This is a convenience which creates an instance of the ListWorkflowsRequest.Builder avoiding the need to create one manually via ListWorkflowsRequest.builder()

      Parameters:
      listWorkflowsRequest - A Consumer that will call methods on ListWorkflowsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListWorkflows operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • mergeProfiles

      default CompletableFuture<MergeProfilesResponse> mergeProfiles(MergeProfilesRequest mergeProfilesRequest)

      Runs an AWS Lambda job that does the following:

      1. All the profileKeys in the ProfileToBeMerged will be moved to the main profile.

      2. All the objects in the ProfileToBeMerged will be moved to the main profile.

      3. All the ProfileToBeMerged will be deleted at the end.

      4. All the profileKeys in the ProfileIdsToBeMerged will be moved to the main profile.

      5. Standard fields are merged as follows:

        1. Fields are always "union"-ed if there are no conflicts in standard fields or attributeKeys.

        2. When there are conflicting fields:

          1. If no SourceProfileIds entry is specified, the main Profile value is always taken.

          2. If a SourceProfileIds entry is specified, the specified profileId is always taken, even if it is a NULL value.

      You can use MergeProfiles together with GetMatches, which returns potentially matching profiles, or use it with the results of another matching system. After profiles have been merged, they cannot be separated (unmerged).

      Parameters:
      mergeProfilesRequest -
      Returns:
      A Java Future containing the result of the MergeProfiles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • mergeProfiles

      default CompletableFuture<MergeProfilesResponse> mergeProfiles(Consumer<MergeProfilesRequest.Builder> mergeProfilesRequest)

      Runs an AWS Lambda job that does the following:

      1. All the profileKeys in the ProfileToBeMerged will be moved to the main profile.

      2. All the objects in the ProfileToBeMerged will be moved to the main profile.

      3. All the ProfileToBeMerged will be deleted at the end.

      4. All the profileKeys in the ProfileIdsToBeMerged will be moved to the main profile.

      5. Standard fields are merged as follows:

        1. Fields are always "union"-ed if there are no conflicts in standard fields or attributeKeys.

        2. When there are conflicting fields:

          1. If no SourceProfileIds entry is specified, the main Profile value is always taken.

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

      Parameters:
      mergeProfilesRequest - A Consumer that will call methods on MergeProfilesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the MergeProfiles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putIntegration

      default CompletableFuture<PutIntegrationResponse> putIntegration(PutIntegrationRequest putIntegrationRequest)

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

      An integration can belong to only one domain.

      To add or remove tags on an existing Integration, see TagResource / UntagResource.

      Parameters:
      putIntegrationRequest -
      Returns:
      A Java Future containing the result of the PutIntegration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putIntegration

      default CompletableFuture<PutIntegrationResponse> putIntegration(Consumer<PutIntegrationRequest.Builder> putIntegrationRequest)

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

      An integration can belong to only one domain.

      To add or remove tags on an existing Integration, see TagResource / UntagResource.


      This is a convenience which creates an instance of the PutIntegrationRequest.Builder avoiding the need to create one manually via PutIntegrationRequest.builder()

      Parameters:
      putIntegrationRequest - A Consumer that will call methods on PutIntegrationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutIntegration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putProfileObject

      default CompletableFuture<PutProfileObjectResponse> putProfileObject(PutProfileObjectRequest putProfileObjectRequest)

      Adds additional objects to customer profiles of a given ObjectType.

      When adding a specific profile object, like a Contact Record, an inferred profile can get created if it is not mapped to an existing profile. The resulting profile will only have a phone number populated in the standard ProfileObject. Any additional Contact Records with the same phone number will be mapped to the same inferred profile.

      When a ProfileObject is created and if a ProfileObjectType already exists for the ProfileObject, it will provide data to a standard profile depending on the ProfileObjectType definition.

      PutProfileObject needs an ObjectType, which can be created using PutProfileObjectType.

      Parameters:
      putProfileObjectRequest -
      Returns:
      A Java Future containing the result of the PutProfileObject operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putProfileObject

      default CompletableFuture<PutProfileObjectResponse> putProfileObject(Consumer<PutProfileObjectRequest.Builder> putProfileObjectRequest)

      Adds additional objects to customer profiles of a given ObjectType.

      When adding a specific profile object, like a Contact Record, an inferred profile can get created if it is not mapped to an existing profile. The resulting profile will only have a phone number populated in the standard ProfileObject. Any additional Contact Records with the same phone number will be mapped to the same inferred profile.

      When a ProfileObject is created and if a ProfileObjectType already exists for the ProfileObject, it will provide data to a standard profile depending on the ProfileObjectType definition.

      PutProfileObject needs an ObjectType, which can be created using PutProfileObjectType.


      This is a convenience which creates an instance of the PutProfileObjectRequest.Builder avoiding the need to create one manually via PutProfileObjectRequest.builder()

      Parameters:
      putProfileObjectRequest - A Consumer that will call methods on PutProfileObjectRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutProfileObject operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putProfileObjectType

      default CompletableFuture<PutProfileObjectTypeResponse> putProfileObjectType(PutProfileObjectTypeRequest putProfileObjectTypeRequest)

      Defines a ProfileObjectType.

      To add or remove tags on an existing ObjectType, see TagResource/UntagResource.

      Parameters:
      putProfileObjectTypeRequest -
      Returns:
      A Java Future containing the result of the PutProfileObjectType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putProfileObjectType

      default CompletableFuture<PutProfileObjectTypeResponse> putProfileObjectType(Consumer<PutProfileObjectTypeRequest.Builder> putProfileObjectTypeRequest)

      Defines a ProfileObjectType.

      To add or remove tags on an existing ObjectType, see TagResource/UntagResource.


      This is a convenience which creates an instance of the PutProfileObjectTypeRequest.Builder avoiding the need to create one manually via PutProfileObjectTypeRequest.builder()

      Parameters:
      putProfileObjectTypeRequest - A Consumer that will call methods on PutProfileObjectTypeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutProfileObjectType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • searchProfiles

      default CompletableFuture<SearchProfilesResponse> searchProfiles(SearchProfilesRequest searchProfilesRequest)

      Searches for profiles within a specific domain using one or more predefined search keys (e.g., _fullName, _phone, _email, _account, etc.) and/or custom-defined search keys. A search key is a data type pair that consists of a KeyName and Values list.

      This operation supports searching for profiles with a minimum of 1 key-value(s) pair and up to 5 key-value(s) pairs using either AND or OR logic.

      Parameters:
      searchProfilesRequest -
      Returns:
      A Java Future containing the result of the SearchProfiles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • searchProfiles

      default CompletableFuture<SearchProfilesResponse> searchProfiles(Consumer<SearchProfilesRequest.Builder> searchProfilesRequest)

      Searches for profiles within a specific domain using one or more predefined search keys (e.g., _fullName, _phone, _email, _account, etc.) and/or custom-defined search keys. A search key is a data type pair that consists of a KeyName and Values list.

      This operation supports searching for profiles with a minimum of 1 key-value(s) pair and up to 5 key-value(s) pairs using either AND or OR logic.


      This is a convenience which creates an instance of the SearchProfilesRequest.Builder avoiding the need to create one manually via SearchProfilesRequest.builder()

      Parameters:
      searchProfilesRequest - A Consumer that will call methods on SearchProfilesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchProfiles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.

      Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.

      You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

      You can associate as many as 50 tags with a resource.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

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

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes one or more tags from the specified Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

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

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateCalculatedAttributeDefinition

      default CompletableFuture<UpdateCalculatedAttributeDefinitionResponse> updateCalculatedAttributeDefinition(UpdateCalculatedAttributeDefinitionRequest updateCalculatedAttributeDefinitionRequest)

      Updates an existing calculated attribute definition. When updating the Conditions, note that increasing the date range of a calculated attribute will not trigger inclusion of historical data greater than the current date range.

      Parameters:
      updateCalculatedAttributeDefinitionRequest -
      Returns:
      A Java Future containing the result of the UpdateCalculatedAttributeDefinition operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateCalculatedAttributeDefinition

      default CompletableFuture<UpdateCalculatedAttributeDefinitionResponse> updateCalculatedAttributeDefinition(Consumer<UpdateCalculatedAttributeDefinitionRequest.Builder> updateCalculatedAttributeDefinitionRequest)

      Updates an existing calculated attribute definition. When updating the Conditions, note that increasing the date range of a calculated attribute will not trigger inclusion of historical data greater than the current date range.


      This is a convenience which creates an instance of the UpdateCalculatedAttributeDefinitionRequest.Builder avoiding the need to create one manually via UpdateCalculatedAttributeDefinitionRequest.builder()

      Parameters:
      updateCalculatedAttributeDefinitionRequest - A Consumer that will call methods on UpdateCalculatedAttributeDefinitionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateCalculatedAttributeDefinition operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateDomain

      default CompletableFuture<UpdateDomainResponse> updateDomain(UpdateDomainRequest updateDomainRequest)

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

      After a domain is created, the name can’t be changed.

      Use this API or CreateDomain to enable identity resolution: set Matching to true.

      To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply.

      To add or remove tags on an existing Domain, see TagResource/UntagResource.

      Parameters:
      updateDomainRequest -
      Returns:
      A Java Future containing the result of the UpdateDomain operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateDomain

      default CompletableFuture<UpdateDomainResponse> updateDomain(Consumer<UpdateDomainRequest.Builder> updateDomainRequest)

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

      After a domain is created, the name can’t be changed.

      Use this API or CreateDomain to enable identity resolution: set Matching to true.

      To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply.

      To add or remove tags on an existing Domain, see TagResource/UntagResource.


      This is a convenience which creates an instance of the UpdateDomainRequest.Builder avoiding the need to create one manually via UpdateDomainRequest.builder()

      Parameters:
      updateDomainRequest - A Consumer that will call methods on UpdateDomainRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateDomain operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateProfile

      default CompletableFuture<UpdateProfileResponse> updateProfile(UpdateProfileRequest updateProfileRequest)

      Updates the properties of a profile. The ProfileId is required for updating a customer profile.

      When calling the UpdateProfile API, specifying an empty string value means that any existing value will be removed. Not specifying a string value means that any value already there will be kept.

      Parameters:
      updateProfileRequest -
      Returns:
      A Java Future containing the result of the UpdateProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateProfile

      default CompletableFuture<UpdateProfileResponse> updateProfile(Consumer<UpdateProfileRequest.Builder> updateProfileRequest)

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

      Parameters:
      updateProfileRequest - A Consumer that will call methods on UpdateProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • serviceClientConfiguration

      default CustomerProfilesServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static CustomerProfilesAsyncClient create()
      Create a CustomerProfilesAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static CustomerProfilesAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a CustomerProfilesAsyncClient.