Interface CustomerProfilesClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface CustomerProfilesClient
extends AwsClient

Service client for accessing Customer Profiles. This can be created using the static builder() method. Connect Customer Customer Profiles

• Customer Profiles actions

• Customer Profiles data types

Connect Customer 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 Connect Customer contact center.

For more information about the Connect Customer Customer Profiles feature, see Use Customer Profiles in the Connect Customer Administrator's Guide.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default AddProfileKeyResponse	addProfileKey(Consumer<AddProfileKeyRequest.Builder> addProfileKeyRequest)	Associates a new key value with a specific profile, such as a Contact Record ContactId.
default AddProfileKeyResponse	addProfileKey(AddProfileKeyRequest addProfileKeyRequest)	Associates a new key value with a specific profile, such as a Contact Record ContactId.
default BatchGetCalculatedAttributeForProfileResponse	batchGetCalculatedAttributeForProfile(Consumer<BatchGetCalculatedAttributeForProfileRequest.Builder> batchGetCalculatedAttributeForProfileRequest)	Fetch the possible attribute values given the attribute name.
default BatchGetCalculatedAttributeForProfileResponse	batchGetCalculatedAttributeForProfile(BatchGetCalculatedAttributeForProfileRequest batchGetCalculatedAttributeForProfileRequest)	Fetch the possible attribute values given the attribute name.
default BatchGetProfileResponse	batchGetProfile(Consumer<BatchGetProfileRequest.Builder> batchGetProfileRequest)	Get a batch of profiles.
default BatchGetProfileResponse	batchGetProfile(BatchGetProfileRequest batchGetProfileRequest)	Get a batch of profiles.
static CustomerProfilesClientBuilder	builder()	Create a builder that can be used to configure and create a CustomerProfilesClient.
static CustomerProfilesClient	create()	Create a CustomerProfilesClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateCalculatedAttributeDefinitionResponse	createCalculatedAttributeDefinition(Consumer<CreateCalculatedAttributeDefinitionRequest.Builder> createCalculatedAttributeDefinitionRequest)	Creates a new calculated attribute definition.
default CreateCalculatedAttributeDefinitionResponse	createCalculatedAttributeDefinition(CreateCalculatedAttributeDefinitionRequest createCalculatedAttributeDefinitionRequest)	Creates a new calculated attribute definition.
default CreateDomainResponse	createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest)	Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys.
default CreateDomainResponse	createDomain(CreateDomainRequest createDomainRequest)	Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys.
default CreateDomainLayoutResponse	createDomainLayout(Consumer<CreateDomainLayoutRequest.Builder> createDomainLayoutRequest)	Creates the layout to view data for a specific domain.
default CreateDomainLayoutResponse	createDomainLayout(CreateDomainLayoutRequest createDomainLayoutRequest)	Creates the layout to view data for a specific domain.
default CreateEventStreamResponse	createEventStream(Consumer<CreateEventStreamRequest.Builder> createEventStreamRequest)	Creates an event stream, which is a subscription to real-time events, such as when profiles are created and updated through Connect Customer Customer Profiles.
default CreateEventStreamResponse	createEventStream(CreateEventStreamRequest createEventStreamRequest)	Creates an event stream, which is a subscription to real-time events, such as when profiles are created and updated through Connect Customer Customer Profiles.
default CreateEventTriggerResponse	createEventTrigger(Consumer<CreateEventTriggerRequest.Builder> createEventTriggerRequest)	Creates an event trigger, which specifies the rules when to perform action based on customer's ingested data.
default CreateEventTriggerResponse	createEventTrigger(CreateEventTriggerRequest createEventTriggerRequest)	Creates an event trigger, which specifies the rules when to perform action based on customer's ingested data.
default CreateIntegrationWorkflowResponse	createIntegrationWorkflow(Consumer<CreateIntegrationWorkflowRequest.Builder> createIntegrationWorkflowRequest)	Creates an integration workflow.
default CreateIntegrationWorkflowResponse	createIntegrationWorkflow(CreateIntegrationWorkflowRequest createIntegrationWorkflowRequest)	Creates an integration workflow.
default CreateProfileResponse	createProfile(Consumer<CreateProfileRequest.Builder> createProfileRequest)	Creates a standard profile.
default CreateProfileResponse	createProfile(CreateProfileRequest createProfileRequest)	Creates a standard profile.
default CreateRecommenderResponse	createRecommender(Consumer<CreateRecommenderRequest.Builder> createRecommenderRequest)	Creates a recommender
default CreateRecommenderResponse	createRecommender(CreateRecommenderRequest createRecommenderRequest)	Creates a recommender
default CreateRecommenderFilterResponse	createRecommenderFilter(Consumer<CreateRecommenderFilterRequest.Builder> createRecommenderFilterRequest)	Creates a recommender filter.
default CreateRecommenderFilterResponse	createRecommenderFilter(CreateRecommenderFilterRequest createRecommenderFilterRequest)	Creates a recommender filter.
default CreateRecommenderSchemaResponse	createRecommenderSchema(Consumer<CreateRecommenderSchemaRequest.Builder> createRecommenderSchemaRequest)	Creates a recommender schema.
default CreateRecommenderSchemaResponse	createRecommenderSchema(CreateRecommenderSchemaRequest createRecommenderSchemaRequest)	Creates a recommender schema.
default CreateSegmentDefinitionResponse	createSegmentDefinition(Consumer<CreateSegmentDefinitionRequest.Builder> createSegmentDefinitionRequest)	Creates a segment definition associated to the given domain.
default CreateSegmentDefinitionResponse	createSegmentDefinition(CreateSegmentDefinitionRequest createSegmentDefinitionRequest)	Creates a segment definition associated to the given domain.
default CreateSegmentEstimateResponse	createSegmentEstimate(Consumer<CreateSegmentEstimateRequest.Builder> createSegmentEstimateRequest)	Creates a segment estimate query.
default CreateSegmentEstimateResponse	createSegmentEstimate(CreateSegmentEstimateRequest createSegmentEstimateRequest)	Creates a segment estimate query.
default CreateSegmentSnapshotResponse	createSegmentSnapshot(Consumer<CreateSegmentSnapshotRequest.Builder> createSegmentSnapshotRequest)	Triggers a job to export a segment to a specified destination.
default CreateSegmentSnapshotResponse	createSegmentSnapshot(CreateSegmentSnapshotRequest createSegmentSnapshotRequest)	Triggers a job to export a segment to a specified destination.
default CreateUploadJobResponse	createUploadJob(Consumer<CreateUploadJobRequest.Builder> createUploadJobRequest)	Creates an Upload job to ingest data for segment imports.
default CreateUploadJobResponse	createUploadJob(CreateUploadJobRequest createUploadJobRequest)	Creates an Upload job to ingest data for segment imports.
default DeleteCalculatedAttributeDefinitionResponse	deleteCalculatedAttributeDefinition(Consumer<DeleteCalculatedAttributeDefinitionRequest.Builder> deleteCalculatedAttributeDefinitionRequest)	Deletes an existing calculated attribute definition.
default DeleteCalculatedAttributeDefinitionResponse	deleteCalculatedAttributeDefinition(DeleteCalculatedAttributeDefinitionRequest deleteCalculatedAttributeDefinitionRequest)	Deletes an existing calculated attribute definition.
default DeleteDomainResponse	deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest)	Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.
default DeleteDomainResponse	deleteDomain(DeleteDomainRequest deleteDomainRequest)	Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.
default DeleteDomainLayoutResponse	deleteDomainLayout(Consumer<DeleteDomainLayoutRequest.Builder> deleteDomainLayoutRequest)	Deletes the layout used to view data for a specific domain.
default DeleteDomainLayoutResponse	deleteDomainLayout(DeleteDomainLayoutRequest deleteDomainLayoutRequest)	Deletes the layout used to view data for a specific domain.
default DeleteDomainObjectTypeResponse	deleteDomainObjectType(Consumer<DeleteDomainObjectTypeRequest.Builder> deleteDomainObjectTypeRequest)	Delete a DomainObjectType for the given Domain and ObjectType name.
default DeleteDomainObjectTypeResponse	deleteDomainObjectType(DeleteDomainObjectTypeRequest deleteDomainObjectTypeRequest)	Delete a DomainObjectType for the given Domain and ObjectType name.
default DeleteEventStreamResponse	deleteEventStream(Consumer<DeleteEventStreamRequest.Builder> deleteEventStreamRequest)	Disables and deletes the specified event stream.
default DeleteEventStreamResponse	deleteEventStream(DeleteEventStreamRequest deleteEventStreamRequest)	Disables and deletes the specified event stream.
default DeleteEventTriggerResponse	deleteEventTrigger(Consumer<DeleteEventTriggerRequest.Builder> deleteEventTriggerRequest)	Disable and deletes the Event Trigger.
default DeleteEventTriggerResponse	deleteEventTrigger(DeleteEventTriggerRequest deleteEventTriggerRequest)	Disable and deletes the Event Trigger.
default DeleteIntegrationResponse	deleteIntegration(Consumer<DeleteIntegrationRequest.Builder> deleteIntegrationRequest)	Removes an integration from a specific domain.
default DeleteIntegrationResponse	deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest)	Removes an integration from a specific domain.
default DeleteProfileResponse	deleteProfile(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest)	Deletes the standard customer profile and all data pertaining to the profile.
default DeleteProfileResponse	deleteProfile(DeleteProfileRequest deleteProfileRequest)	Deletes the standard customer profile and all data pertaining to the profile.
default DeleteProfileKeyResponse	deleteProfileKey(Consumer<DeleteProfileKeyRequest.Builder> deleteProfileKeyRequest)	Removes a searchable key from a customer profile.
default DeleteProfileKeyResponse	deleteProfileKey(DeleteProfileKeyRequest deleteProfileKeyRequest)	Removes a searchable key from a customer profile.
default DeleteProfileObjectResponse	deleteProfileObject(Consumer<DeleteProfileObjectRequest.Builder> deleteProfileObjectRequest)	Removes an object associated with a profile of a given ProfileObjectType.
default DeleteProfileObjectResponse	deleteProfileObject(DeleteProfileObjectRequest deleteProfileObjectRequest)	Removes an object associated with a profile of a given ProfileObjectType.
default DeleteProfileObjectTypeResponse	deleteProfileObjectType(Consumer<DeleteProfileObjectTypeRequest.Builder> deleteProfileObjectTypeRequest)	Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type.
default DeleteProfileObjectTypeResponse	deleteProfileObjectType(DeleteProfileObjectTypeRequest deleteProfileObjectTypeRequest)	Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type.
default DeleteRecommenderResponse	deleteRecommender(Consumer<DeleteRecommenderRequest.Builder> deleteRecommenderRequest)	Deletes a recommender.
default DeleteRecommenderResponse	deleteRecommender(DeleteRecommenderRequest deleteRecommenderRequest)	Deletes a recommender.
default DeleteRecommenderFilterResponse	deleteRecommenderFilter(Consumer<DeleteRecommenderFilterRequest.Builder> deleteRecommenderFilterRequest)	Deletes a recommender filter from a domain.
default DeleteRecommenderFilterResponse	deleteRecommenderFilter(DeleteRecommenderFilterRequest deleteRecommenderFilterRequest)	Deletes a recommender filter from a domain.
default DeleteRecommenderSchemaResponse	deleteRecommenderSchema(Consumer<DeleteRecommenderSchemaRequest.Builder> deleteRecommenderSchemaRequest)	Deletes a recommender schema from a domain.
default DeleteRecommenderSchemaResponse	deleteRecommenderSchema(DeleteRecommenderSchemaRequest deleteRecommenderSchemaRequest)	Deletes a recommender schema from a domain.
default DeleteSegmentDefinitionResponse	deleteSegmentDefinition(Consumer<DeleteSegmentDefinitionRequest.Builder> deleteSegmentDefinitionRequest)	Deletes a segment definition from the domain.
default DeleteSegmentDefinitionResponse	deleteSegmentDefinition(DeleteSegmentDefinitionRequest deleteSegmentDefinitionRequest)	Deletes a segment definition from the domain.
default DeleteWorkflowResponse	deleteWorkflow(Consumer<DeleteWorkflowRequest.Builder> deleteWorkflowRequest)	Deletes the specified workflow and all its corresponding resources.
default DeleteWorkflowResponse	deleteWorkflow(DeleteWorkflowRequest deleteWorkflowRequest)	Deletes the specified workflow and all its corresponding resources.
default DetectProfileObjectTypeResponse	detectProfileObjectType(Consumer<DetectProfileObjectTypeRequest.Builder> detectProfileObjectTypeRequest)	The process of detecting profile object type mapping by using given objects.
default DetectProfileObjectTypeResponse	detectProfileObjectType(DetectProfileObjectTypeRequest detectProfileObjectTypeRequest)	The process of detecting profile object type mapping by using given objects.
default GetAutoMergingPreviewResponse	getAutoMergingPreview(Consumer<GetAutoMergingPreviewRequest.Builder> getAutoMergingPreviewRequest)	Tests the auto-merging settings of your Identity Resolution Job without merging your data.
default GetAutoMergingPreviewResponse	getAutoMergingPreview(GetAutoMergingPreviewRequest getAutoMergingPreviewRequest)	Tests the auto-merging settings of your Identity Resolution Job without merging your data.
default GetCalculatedAttributeDefinitionResponse	getCalculatedAttributeDefinition(Consumer<GetCalculatedAttributeDefinitionRequest.Builder> getCalculatedAttributeDefinitionRequest)	Provides more information on a calculated attribute definition for Customer Profiles.
default GetCalculatedAttributeDefinitionResponse	getCalculatedAttributeDefinition(GetCalculatedAttributeDefinitionRequest getCalculatedAttributeDefinitionRequest)	Provides more information on a calculated attribute definition for Customer Profiles.
default GetCalculatedAttributeForProfileResponse	getCalculatedAttributeForProfile(Consumer<GetCalculatedAttributeForProfileRequest.Builder> getCalculatedAttributeForProfileRequest)	Retrieve a calculated attribute for a customer profile.
default GetCalculatedAttributeForProfileResponse	getCalculatedAttributeForProfile(GetCalculatedAttributeForProfileRequest getCalculatedAttributeForProfileRequest)	Retrieve a calculated attribute for a customer profile.
default GetDomainResponse	getDomain(Consumer<GetDomainRequest.Builder> getDomainRequest)	Returns information about a specific domain.
default GetDomainResponse	getDomain(GetDomainRequest getDomainRequest)	Returns information about a specific domain.
default GetDomainLayoutResponse	getDomainLayout(Consumer<GetDomainLayoutRequest.Builder> getDomainLayoutRequest)	Gets the layout to view data for a specific domain.
default GetDomainLayoutResponse	getDomainLayout(GetDomainLayoutRequest getDomainLayoutRequest)	Gets the layout to view data for a specific domain.
default GetDomainObjectTypeResponse	getDomainObjectType(Consumer<GetDomainObjectTypeRequest.Builder> getDomainObjectTypeRequest)	Return a DomainObjectType for the input Domain and ObjectType names.
default GetDomainObjectTypeResponse	getDomainObjectType(GetDomainObjectTypeRequest getDomainObjectTypeRequest)	Return a DomainObjectType for the input Domain and ObjectType names.
default GetEventStreamResponse	getEventStream(Consumer<GetEventStreamRequest.Builder> getEventStreamRequest)	Returns information about the specified event stream in a specific domain.
default GetEventStreamResponse	getEventStream(GetEventStreamRequest getEventStreamRequest)	Returns information about the specified event stream in a specific domain.
default GetEventTriggerResponse	getEventTrigger(Consumer<GetEventTriggerRequest.Builder> getEventTriggerRequest)	Get a specific Event Trigger from the domain.
default GetEventTriggerResponse	getEventTrigger(GetEventTriggerRequest getEventTriggerRequest)	Get a specific Event Trigger from the domain.
default GetIdentityResolutionJobResponse	getIdentityResolutionJob(Consumer<GetIdentityResolutionJobRequest.Builder> getIdentityResolutionJobRequest)	Returns information about an Identity Resolution Job in a specific domain.
default GetIdentityResolutionJobResponse	getIdentityResolutionJob(GetIdentityResolutionJobRequest getIdentityResolutionJobRequest)	Returns information about an Identity Resolution Job in a specific domain.
default GetIntegrationResponse	getIntegration(Consumer<GetIntegrationRequest.Builder> getIntegrationRequest)	Returns an integration for a domain.
default GetIntegrationResponse	getIntegration(GetIntegrationRequest getIntegrationRequest)	Returns an integration for a domain.
default GetMatchesResponse	getMatches(Consumer<GetMatchesRequest.Builder> getMatchesRequest)	Before calling this API, use CreateDomain or UpdateDomain to enable identity resolution: set Matching to true.
default GetMatchesResponse	getMatches(GetMatchesRequest getMatchesRequest)	Before calling this API, use CreateDomain or UpdateDomain to enable identity resolution: set Matching to true.
default GetObjectTypeAttributeStatisticsResponse	getObjectTypeAttributeStatistics(Consumer<GetObjectTypeAttributeStatisticsRequest.Builder> getObjectTypeAttributeStatisticsRequest)	The GetObjectTypeAttributeValues API delivers statistical insights about attributes within a specific object type, but is exclusively available for domains with data store enabled.
default GetObjectTypeAttributeStatisticsResponse	getObjectTypeAttributeStatistics(GetObjectTypeAttributeStatisticsRequest getObjectTypeAttributeStatisticsRequest)	The GetObjectTypeAttributeValues API delivers statistical insights about attributes within a specific object type, but is exclusively available for domains with data store enabled.
default GetProfileHistoryRecordResponse	getProfileHistoryRecord(Consumer<GetProfileHistoryRecordRequest.Builder> getProfileHistoryRecordRequest)	Returns a history record for a specific profile, for a specific domain.
default GetProfileHistoryRecordResponse	getProfileHistoryRecord(GetProfileHistoryRecordRequest getProfileHistoryRecordRequest)	Returns a history record for a specific profile, for a specific domain.
default GetProfileObjectTypeResponse	getProfileObjectType(Consumer<GetProfileObjectTypeRequest.Builder> getProfileObjectTypeRequest)	Returns the object types for a specific domain.
default GetProfileObjectTypeResponse	getProfileObjectType(GetProfileObjectTypeRequest getProfileObjectTypeRequest)	Returns the object types for a specific domain.
default GetProfileObjectTypeTemplateResponse	getProfileObjectTypeTemplate(Consumer<GetProfileObjectTypeTemplateRequest.Builder> getProfileObjectTypeTemplateRequest)	Returns the template information for a specific object type.
default GetProfileObjectTypeTemplateResponse	getProfileObjectTypeTemplate(GetProfileObjectTypeTemplateRequest getProfileObjectTypeTemplateRequest)	Returns the template information for a specific object type.
default GetProfileRecommendationsResponse	getProfileRecommendations(Consumer<GetProfileRecommendationsRequest.Builder> getProfileRecommendationsRequest)	Fetches the recommendations for a profile in the input Customer Profiles domain.
default GetProfileRecommendationsResponse	getProfileRecommendations(GetProfileRecommendationsRequest getProfileRecommendationsRequest)	Fetches the recommendations for a profile in the input Customer Profiles domain.
default GetRecommenderResponse	getRecommender(Consumer<GetRecommenderRequest.Builder> getRecommenderRequest)	Retrieves a recommender.
default GetRecommenderResponse	getRecommender(GetRecommenderRequest getRecommenderRequest)	Retrieves a recommender.
default GetRecommenderFilterResponse	getRecommenderFilter(Consumer<GetRecommenderFilterRequest.Builder> getRecommenderFilterRequest)	Retrieves information about a specific recommender filter in a domain.
default GetRecommenderFilterResponse	getRecommenderFilter(GetRecommenderFilterRequest getRecommenderFilterRequest)	Retrieves information about a specific recommender filter in a domain.
default GetRecommenderSchemaResponse	getRecommenderSchema(Consumer<GetRecommenderSchemaRequest.Builder> getRecommenderSchemaRequest)	Retrieves information about a specific recommender schema in a domain.
default GetRecommenderSchemaResponse	getRecommenderSchema(GetRecommenderSchemaRequest getRecommenderSchemaRequest)	Retrieves information about a specific recommender schema in a domain.
default GetSegmentDefinitionResponse	getSegmentDefinition(Consumer<GetSegmentDefinitionRequest.Builder> getSegmentDefinitionRequest)	Gets a segment definition from the domain.
default GetSegmentDefinitionResponse	getSegmentDefinition(GetSegmentDefinitionRequest getSegmentDefinitionRequest)	Gets a segment definition from the domain.
default GetSegmentEstimateResponse	getSegmentEstimate(Consumer<GetSegmentEstimateRequest.Builder> getSegmentEstimateRequest)	Gets the result of a segment estimate query.
default GetSegmentEstimateResponse	getSegmentEstimate(GetSegmentEstimateRequest getSegmentEstimateRequest)	Gets the result of a segment estimate query.
default GetSegmentMembershipResponse	getSegmentMembership(Consumer<GetSegmentMembershipRequest.Builder> getSegmentMembershipRequest)	Determines if the given profiles are within a segment.
default GetSegmentMembershipResponse	getSegmentMembership(GetSegmentMembershipRequest getSegmentMembershipRequest)	Determines if the given profiles are within a segment.
default GetSegmentSnapshotResponse	getSegmentSnapshot(Consumer<GetSegmentSnapshotRequest.Builder> getSegmentSnapshotRequest)	Retrieve the latest status of a segment snapshot.
default GetSegmentSnapshotResponse	getSegmentSnapshot(GetSegmentSnapshotRequest getSegmentSnapshotRequest)	Retrieve the latest status of a segment snapshot.
default GetSimilarProfilesResponse	getSimilarProfiles(Consumer<GetSimilarProfilesRequest.Builder> getSimilarProfilesRequest)	Returns a set of profiles that belong to the same matching group using the matchId or profileId.
default GetSimilarProfilesResponse	getSimilarProfiles(GetSimilarProfilesRequest getSimilarProfilesRequest)	Returns a set of profiles that belong to the same matching group using the matchId or profileId.
default GetSimilarProfilesIterable	getSimilarProfilesPaginator(Consumer<GetSimilarProfilesRequest.Builder> getSimilarProfilesRequest)	This is a variant of getSimilarProfiles(software.amazon.awssdk.services.customerprofiles.model.GetSimilarProfilesRequest) operation.
default GetSimilarProfilesIterable	getSimilarProfilesPaginator(GetSimilarProfilesRequest getSimilarProfilesRequest)	This is a variant of getSimilarProfiles(software.amazon.awssdk.services.customerprofiles.model.GetSimilarProfilesRequest) operation.
default GetUploadJobResponse	getUploadJob(Consumer<GetUploadJobRequest.Builder> getUploadJobRequest)	This API retrieves the details of a specific upload job.
default GetUploadJobResponse	getUploadJob(GetUploadJobRequest getUploadJobRequest)	This API retrieves the details of a specific upload job.
default GetUploadJobPathResponse	getUploadJobPath(Consumer<GetUploadJobPathRequest.Builder> getUploadJobPathRequest)	This API retrieves the pre-signed URL and client token for uploading the file associated with the upload job.
default GetUploadJobPathResponse	getUploadJobPath(GetUploadJobPathRequest getUploadJobPathRequest)	This API retrieves the pre-signed URL and client token for uploading the file associated with the upload job.
default GetWorkflowResponse	getWorkflow(Consumer<GetWorkflowRequest.Builder> getWorkflowRequest)	Get details of specified workflow.
default GetWorkflowResponse	getWorkflow(GetWorkflowRequest getWorkflowRequest)	Get details of specified workflow.
default GetWorkflowStepsResponse	getWorkflowSteps(Consumer<GetWorkflowStepsRequest.Builder> getWorkflowStepsRequest)	Get granular list of steps in workflow.
default GetWorkflowStepsResponse	getWorkflowSteps(GetWorkflowStepsRequest getWorkflowStepsRequest)	Get granular list of steps in workflow.
default ListAccountIntegrationsResponse	listAccountIntegrations(Consumer<ListAccountIntegrationsRequest.Builder> listAccountIntegrationsRequest)	Lists all of the integrations associated to a specific URI in the AWS account.
default ListAccountIntegrationsResponse	listAccountIntegrations(ListAccountIntegrationsRequest listAccountIntegrationsRequest)	Lists all of the integrations associated to a specific URI in the AWS account.
default ListCalculatedAttributeDefinitionsResponse	listCalculatedAttributeDefinitions(Consumer<ListCalculatedAttributeDefinitionsRequest.Builder> listCalculatedAttributeDefinitionsRequest)	Lists calculated attribute definitions for Customer Profiles
default ListCalculatedAttributeDefinitionsResponse	listCalculatedAttributeDefinitions(ListCalculatedAttributeDefinitionsRequest listCalculatedAttributeDefinitionsRequest)	Lists calculated attribute definitions for Customer Profiles
default ListCalculatedAttributesForProfileResponse	listCalculatedAttributesForProfile(Consumer<ListCalculatedAttributesForProfileRequest.Builder> listCalculatedAttributesForProfileRequest)	Retrieve a list of calculated attributes for a customer profile.
default ListCalculatedAttributesForProfileResponse	listCalculatedAttributesForProfile(ListCalculatedAttributesForProfileRequest listCalculatedAttributesForProfileRequest)	Retrieve a list of calculated attributes for a customer profile.
default ListDomainLayoutsResponse	listDomainLayouts(Consumer<ListDomainLayoutsRequest.Builder> listDomainLayoutsRequest)	Lists the existing layouts that can be used to view data for a specific domain.
default ListDomainLayoutsResponse	listDomainLayouts(ListDomainLayoutsRequest listDomainLayoutsRequest)	Lists the existing layouts that can be used to view data for a specific domain.
default ListDomainLayoutsIterable	listDomainLayoutsPaginator(Consumer<ListDomainLayoutsRequest.Builder> listDomainLayoutsRequest)	This is a variant of listDomainLayouts(software.amazon.awssdk.services.customerprofiles.model.ListDomainLayoutsRequest) operation.
default ListDomainLayoutsIterable	listDomainLayoutsPaginator(ListDomainLayoutsRequest listDomainLayoutsRequest)	This is a variant of listDomainLayouts(software.amazon.awssdk.services.customerprofiles.model.ListDomainLayoutsRequest) operation.
default ListDomainObjectTypesResponse	listDomainObjectTypes(Consumer<ListDomainObjectTypesRequest.Builder> listDomainObjectTypesRequest)	List all DomainObjectType(s) in a Customer Profiles domain.
default ListDomainObjectTypesResponse	listDomainObjectTypes(ListDomainObjectTypesRequest listDomainObjectTypesRequest)	List all DomainObjectType(s) in a Customer Profiles domain.
default ListDomainObjectTypesIterable	listDomainObjectTypesPaginator(Consumer<ListDomainObjectTypesRequest.Builder> listDomainObjectTypesRequest)	This is a variant of listDomainObjectTypes(software.amazon.awssdk.services.customerprofiles.model.ListDomainObjectTypesRequest) operation.
default ListDomainObjectTypesIterable	listDomainObjectTypesPaginator(ListDomainObjectTypesRequest listDomainObjectTypesRequest)	This is a variant of listDomainObjectTypes(software.amazon.awssdk.services.customerprofiles.model.ListDomainObjectTypesRequest) operation.
default ListDomainsResponse	listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest)	Returns a list of all the domains for an AWS account that have been created.
default ListDomainsResponse	listDomains(ListDomainsRequest listDomainsRequest)	Returns a list of all the domains for an AWS account that have been created.
default ListEventStreamsResponse	listEventStreams(Consumer<ListEventStreamsRequest.Builder> listEventStreamsRequest)	Returns a list of all the event streams in a specific domain.
default ListEventStreamsResponse	listEventStreams(ListEventStreamsRequest listEventStreamsRequest)	Returns a list of all the event streams in a specific domain.
default ListEventStreamsIterable	listEventStreamsPaginator(Consumer<ListEventStreamsRequest.Builder> listEventStreamsRequest)	This is a variant of listEventStreams(software.amazon.awssdk.services.customerprofiles.model.ListEventStreamsRequest) operation.
default ListEventStreamsIterable	listEventStreamsPaginator(ListEventStreamsRequest listEventStreamsRequest)	This is a variant of listEventStreams(software.amazon.awssdk.services.customerprofiles.model.ListEventStreamsRequest) operation.
default ListEventTriggersResponse	listEventTriggers(Consumer<ListEventTriggersRequest.Builder> listEventTriggersRequest)	List all Event Triggers under a domain.
default ListEventTriggersResponse	listEventTriggers(ListEventTriggersRequest listEventTriggersRequest)	List all Event Triggers under a domain.
default ListEventTriggersIterable	listEventTriggersPaginator(Consumer<ListEventTriggersRequest.Builder> listEventTriggersRequest)	This is a variant of listEventTriggers(software.amazon.awssdk.services.customerprofiles.model.ListEventTriggersRequest) operation.
default ListEventTriggersIterable	listEventTriggersPaginator(ListEventTriggersRequest listEventTriggersRequest)	This is a variant of listEventTriggers(software.amazon.awssdk.services.customerprofiles.model.ListEventTriggersRequest) operation.
default ListIdentityResolutionJobsResponse	listIdentityResolutionJobs(Consumer<ListIdentityResolutionJobsRequest.Builder> listIdentityResolutionJobsRequest)	Lists all of the Identity Resolution Jobs in your domain.
default ListIdentityResolutionJobsResponse	listIdentityResolutionJobs(ListIdentityResolutionJobsRequest listIdentityResolutionJobsRequest)	Lists all of the Identity Resolution Jobs in your domain.
default ListIntegrationsResponse	listIntegrations(Consumer<ListIntegrationsRequest.Builder> listIntegrationsRequest)	Lists all of the integrations in your domain.
default ListIntegrationsResponse	listIntegrations(ListIntegrationsRequest listIntegrationsRequest)	Lists all of the integrations in your domain.
default ListObjectTypeAttributesResponse	listObjectTypeAttributes(Consumer<ListObjectTypeAttributesRequest.Builder> listObjectTypeAttributesRequest)	Fetch the possible attribute values given the attribute name.
default ListObjectTypeAttributesResponse	listObjectTypeAttributes(ListObjectTypeAttributesRequest listObjectTypeAttributesRequest)	Fetch the possible attribute values given the attribute name.
default ListObjectTypeAttributesIterable	listObjectTypeAttributesPaginator(Consumer<ListObjectTypeAttributesRequest.Builder> listObjectTypeAttributesRequest)	This is a variant of listObjectTypeAttributes(software.amazon.awssdk.services.customerprofiles.model.ListObjectTypeAttributesRequest) operation.
default ListObjectTypeAttributesIterable	listObjectTypeAttributesPaginator(ListObjectTypeAttributesRequest listObjectTypeAttributesRequest)	This is a variant of listObjectTypeAttributes(software.amazon.awssdk.services.customerprofiles.model.ListObjectTypeAttributesRequest) operation.
default ListObjectTypeAttributeValuesResponse	listObjectTypeAttributeValues(Consumer<ListObjectTypeAttributeValuesRequest.Builder> listObjectTypeAttributeValuesRequest)	The ListObjectTypeAttributeValues API provides access to the most recent distinct values for any specified attribute, making it valuable for real-time data validation and consistency checks within your object types.
default ListObjectTypeAttributeValuesResponse	listObjectTypeAttributeValues(ListObjectTypeAttributeValuesRequest listObjectTypeAttributeValuesRequest)	The ListObjectTypeAttributeValues API provides access to the most recent distinct values for any specified attribute, making it valuable for real-time data validation and consistency checks within your object types.
default ListProfileAttributeValuesResponse	listProfileAttributeValues(Consumer<ListProfileAttributeValuesRequest.Builder> listProfileAttributeValuesRequest)	Fetch the possible attribute values given the attribute name.
default ListProfileAttributeValuesResponse	listProfileAttributeValues(ListProfileAttributeValuesRequest listProfileAttributeValuesRequest)	Fetch the possible attribute values given the attribute name.
default ListProfileHistoryRecordsResponse	listProfileHistoryRecords(Consumer<ListProfileHistoryRecordsRequest.Builder> listProfileHistoryRecordsRequest)	Returns a list of history records for a specific profile, for a specific domain.
default ListProfileHistoryRecordsResponse	listProfileHistoryRecords(ListProfileHistoryRecordsRequest listProfileHistoryRecordsRequest)	Returns a list of history records for a specific profile, for a specific domain.
default ListProfileObjectsResponse	listProfileObjects(Consumer<ListProfileObjectsRequest.Builder> listProfileObjectsRequest)	Returns a list of objects associated with a profile of a given ProfileObjectType.
default ListProfileObjectsResponse	listProfileObjects(ListProfileObjectsRequest listProfileObjectsRequest)	Returns a list of objects associated with a profile of a given ProfileObjectType.
default ListProfileObjectTypesResponse	listProfileObjectTypes(Consumer<ListProfileObjectTypesRequest.Builder> listProfileObjectTypesRequest)	Lists all of the templates available within the service.
default ListProfileObjectTypesResponse	listProfileObjectTypes(ListProfileObjectTypesRequest listProfileObjectTypesRequest)	Lists all of the templates available within the service.
default ListProfileObjectTypeTemplatesResponse	listProfileObjectTypeTemplates(Consumer<ListProfileObjectTypeTemplatesRequest.Builder> listProfileObjectTypeTemplatesRequest)	Lists all of the template information for object types.
default ListProfileObjectTypeTemplatesResponse	listProfileObjectTypeTemplates(ListProfileObjectTypeTemplatesRequest listProfileObjectTypeTemplatesRequest)	Lists all of the template information for object types.
default ListRecommenderFiltersResponse	listRecommenderFilters(Consumer<ListRecommenderFiltersRequest.Builder> listRecommenderFiltersRequest)	Returns a list of recommender filters in the specified domain.
default ListRecommenderFiltersResponse	listRecommenderFilters(ListRecommenderFiltersRequest listRecommenderFiltersRequest)	Returns a list of recommender filters in the specified domain.
default ListRecommenderFiltersIterable	listRecommenderFiltersPaginator(Consumer<ListRecommenderFiltersRequest.Builder> listRecommenderFiltersRequest)	This is a variant of listRecommenderFilters(software.amazon.awssdk.services.customerprofiles.model.ListRecommenderFiltersRequest) operation.
default ListRecommenderFiltersIterable	listRecommenderFiltersPaginator(ListRecommenderFiltersRequest listRecommenderFiltersRequest)	This is a variant of listRecommenderFilters(software.amazon.awssdk.services.customerprofiles.model.ListRecommenderFiltersRequest) operation.
default ListRecommenderRecipesResponse	listRecommenderRecipes(Consumer<ListRecommenderRecipesRequest.Builder> listRecommenderRecipesRequest)	Returns a list of available recommender recipes that can be used to create recommenders.
default ListRecommenderRecipesResponse	listRecommenderRecipes(ListRecommenderRecipesRequest listRecommenderRecipesRequest)	Returns a list of available recommender recipes that can be used to create recommenders.
default ListRecommenderRecipesIterable	listRecommenderRecipesPaginator(Consumer<ListRecommenderRecipesRequest.Builder> listRecommenderRecipesRequest)	This is a variant of listRecommenderRecipes(software.amazon.awssdk.services.customerprofiles.model.ListRecommenderRecipesRequest) operation.
default ListRecommenderRecipesIterable	listRecommenderRecipesPaginator(ListRecommenderRecipesRequest listRecommenderRecipesRequest)	This is a variant of listRecommenderRecipes(software.amazon.awssdk.services.customerprofiles.model.ListRecommenderRecipesRequest) operation.
default ListRecommendersResponse	listRecommenders(Consumer<ListRecommendersRequest.Builder> listRecommendersRequest)	Returns a list of recommenders in the specified domain.
default ListRecommendersResponse	listRecommenders(ListRecommendersRequest listRecommendersRequest)	Returns a list of recommenders in the specified domain.
default ListRecommenderSchemasResponse	listRecommenderSchemas(Consumer<ListRecommenderSchemasRequest.Builder> listRecommenderSchemasRequest)	Returns a list of recommender schemas in the specified domain.
default ListRecommenderSchemasResponse	listRecommenderSchemas(ListRecommenderSchemasRequest listRecommenderSchemasRequest)	Returns a list of recommender schemas in the specified domain.
default ListRecommenderSchemasIterable	listRecommenderSchemasPaginator(Consumer<ListRecommenderSchemasRequest.Builder> listRecommenderSchemasRequest)	This is a variant of listRecommenderSchemas(software.amazon.awssdk.services.customerprofiles.model.ListRecommenderSchemasRequest) operation.
default ListRecommenderSchemasIterable	listRecommenderSchemasPaginator(ListRecommenderSchemasRequest listRecommenderSchemasRequest)	This is a variant of listRecommenderSchemas(software.amazon.awssdk.services.customerprofiles.model.ListRecommenderSchemasRequest) operation.
default ListRecommendersIterable	listRecommendersPaginator(Consumer<ListRecommendersRequest.Builder> listRecommendersRequest)	This is a variant of listRecommenders(software.amazon.awssdk.services.customerprofiles.model.ListRecommendersRequest) operation.
default ListRecommendersIterable	listRecommendersPaginator(ListRecommendersRequest listRecommendersRequest)	This is a variant of listRecommenders(software.amazon.awssdk.services.customerprofiles.model.ListRecommendersRequest) operation.
default ListRuleBasedMatchesResponse	listRuleBasedMatches(Consumer<ListRuleBasedMatchesRequest.Builder> listRuleBasedMatchesRequest)	Returns a set of MatchIds that belong to the given domain.
default ListRuleBasedMatchesResponse	listRuleBasedMatches(ListRuleBasedMatchesRequest listRuleBasedMatchesRequest)	Returns a set of MatchIds that belong to the given domain.
default ListRuleBasedMatchesIterable	listRuleBasedMatchesPaginator(Consumer<ListRuleBasedMatchesRequest.Builder> listRuleBasedMatchesRequest)	This is a variant of listRuleBasedMatches(software.amazon.awssdk.services.customerprofiles.model.ListRuleBasedMatchesRequest) operation.
default ListRuleBasedMatchesIterable	listRuleBasedMatchesPaginator(ListRuleBasedMatchesRequest listRuleBasedMatchesRequest)	This is a variant of listRuleBasedMatches(software.amazon.awssdk.services.customerprofiles.model.ListRuleBasedMatchesRequest) operation.
default ListSegmentDefinitionsResponse	listSegmentDefinitions(Consumer<ListSegmentDefinitionsRequest.Builder> listSegmentDefinitionsRequest)	Lists all segment definitions under a domain.
default ListSegmentDefinitionsResponse	listSegmentDefinitions(ListSegmentDefinitionsRequest listSegmentDefinitionsRequest)	Lists all segment definitions under a domain.
default ListSegmentDefinitionsIterable	listSegmentDefinitionsPaginator(Consumer<ListSegmentDefinitionsRequest.Builder> listSegmentDefinitionsRequest)	This is a variant of listSegmentDefinitions(software.amazon.awssdk.services.customerprofiles.model.ListSegmentDefinitionsRequest) operation.
default ListSegmentDefinitionsIterable	listSegmentDefinitionsPaginator(ListSegmentDefinitionsRequest listSegmentDefinitionsRequest)	This is a variant of listSegmentDefinitions(software.amazon.awssdk.services.customerprofiles.model.ListSegmentDefinitionsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Displays the tags associated with an Amazon Connect Customer Profiles resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Displays the tags associated with an Amazon Connect Customer Profiles resource.
default ListUploadJobsResponse	listUploadJobs(Consumer<ListUploadJobsRequest.Builder> listUploadJobsRequest)	This API retrieves a list of upload jobs for the specified domain.
default ListUploadJobsResponse	listUploadJobs(ListUploadJobsRequest listUploadJobsRequest)	This API retrieves a list of upload jobs for the specified domain.
default ListUploadJobsIterable	listUploadJobsPaginator(Consumer<ListUploadJobsRequest.Builder> listUploadJobsRequest)	This is a variant of listUploadJobs(software.amazon.awssdk.services.customerprofiles.model.ListUploadJobsRequest) operation.
default ListUploadJobsIterable	listUploadJobsPaginator(ListUploadJobsRequest listUploadJobsRequest)	This is a variant of listUploadJobs(software.amazon.awssdk.services.customerprofiles.model.ListUploadJobsRequest) operation.
default ListWorkflowsResponse	listWorkflows(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest)	Query to list all workflows.
default ListWorkflowsResponse	listWorkflows(ListWorkflowsRequest listWorkflowsRequest)	Query to list all workflows.
default MergeProfilesResponse	mergeProfiles(Consumer<MergeProfilesRequest.Builder> mergeProfilesRequest)	Runs an AWS Lambda job that does the following:
default MergeProfilesResponse	mergeProfiles(MergeProfilesRequest mergeProfilesRequest)	Runs an AWS Lambda job that does the following:
default PutDomainObjectTypeResponse	putDomainObjectType(Consumer<PutDomainObjectTypeRequest.Builder> putDomainObjectTypeRequest)	Create/Update a DomainObjectType in a Customer Profiles domain.
default PutDomainObjectTypeResponse	putDomainObjectType(PutDomainObjectTypeRequest putDomainObjectTypeRequest)	Create/Update a DomainObjectType in a Customer Profiles domain.
default PutIntegrationResponse	putIntegration(Consumer<PutIntegrationRequest.Builder> putIntegrationRequest)	Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.
default PutIntegrationResponse	putIntegration(PutIntegrationRequest putIntegrationRequest)	Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.
default PutProfileObjectResponse	putProfileObject(Consumer<PutProfileObjectRequest.Builder> putProfileObjectRequest)	Adds additional objects to customer profiles of a given ObjectType.
default PutProfileObjectResponse	putProfileObject(PutProfileObjectRequest putProfileObjectRequest)	Adds additional objects to customer profiles of a given ObjectType.
default PutProfileObjectTypeResponse	putProfileObjectType(Consumer<PutProfileObjectTypeRequest.Builder> putProfileObjectTypeRequest)	Defines a ProfileObjectType.
default PutProfileObjectTypeResponse	putProfileObjectType(PutProfileObjectTypeRequest putProfileObjectTypeRequest)	Defines a ProfileObjectType.
default SearchProfilesResponse	searchProfiles(Consumer<SearchProfilesRequest.Builder> searchProfilesRequest)	Searches for profiles within a specific domain using one or more predefined search keys (e.g., _fullName, _phone, _email, _account, etc.) and/or custom-defined search keys.
default SearchProfilesResponse	searchProfiles(SearchProfilesRequest searchProfilesRequest)	Searches for profiles within a specific domain using one or more predefined search keys (e.g., _fullName, _phone, _email, _account, etc.) and/or custom-defined search keys.
default CustomerProfilesServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartRecommenderResponse	startRecommender(Consumer<StartRecommenderRequest.Builder> startRecommenderRequest)	Starts a recommender that was previously stopped.
default StartRecommenderResponse	startRecommender(StartRecommenderRequest startRecommenderRequest)	Starts a recommender that was previously stopped.
default StartUploadJobResponse	startUploadJob(Consumer<StartUploadJobRequest.Builder> startUploadJobRequest)	This API starts the processing of an upload job to ingest profile data.
default StartUploadJobResponse	startUploadJob(StartUploadJobRequest startUploadJobRequest)	This API starts the processing of an upload job to ingest profile data.
default StopRecommenderResponse	stopRecommender(Consumer<StopRecommenderRequest.Builder> stopRecommenderRequest)	Stops a recommender, suspending its ability to generate recommendations.
default StopRecommenderResponse	stopRecommender(StopRecommenderRequest stopRecommenderRequest)	Stops a recommender, suspending its ability to generate recommendations.
default StopUploadJobResponse	stopUploadJob(Consumer<StopUploadJobRequest.Builder> stopUploadJobRequest)	This API stops the processing of an upload job.
default StopUploadJobResponse	stopUploadJob(StopUploadJobRequest stopUploadJobRequest)	This API stops the processing of an upload job.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes one or more tags from the specified Amazon Connect Customer Profiles resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes one or more tags from the specified Amazon Connect Customer Profiles resource.
default UpdateCalculatedAttributeDefinitionResponse	updateCalculatedAttributeDefinition(Consumer<UpdateCalculatedAttributeDefinitionRequest.Builder> updateCalculatedAttributeDefinitionRequest)	Updates an existing calculated attribute definition.
default UpdateCalculatedAttributeDefinitionResponse	updateCalculatedAttributeDefinition(UpdateCalculatedAttributeDefinitionRequest updateCalculatedAttributeDefinitionRequest)	Updates an existing calculated attribute definition.
default UpdateDomainResponse	updateDomain(Consumer<UpdateDomainRequest.Builder> updateDomainRequest)	Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.
default UpdateDomainResponse	updateDomain(UpdateDomainRequest updateDomainRequest)	Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.
default UpdateDomainLayoutResponse	updateDomainLayout(Consumer<UpdateDomainLayoutRequest.Builder> updateDomainLayoutRequest)	Updates the layout used to view data for a specific domain.
default UpdateDomainLayoutResponse	updateDomainLayout(UpdateDomainLayoutRequest updateDomainLayoutRequest)	Updates the layout used to view data for a specific domain.
default UpdateEventTriggerResponse	updateEventTrigger(Consumer<UpdateEventTriggerRequest.Builder> updateEventTriggerRequest)	Update the properties of an Event Trigger.
default UpdateEventTriggerResponse	updateEventTrigger(UpdateEventTriggerRequest updateEventTriggerRequest)	Update the properties of an Event Trigger.
default UpdateProfileResponse	updateProfile(Consumer<UpdateProfileRequest.Builder> updateProfileRequest)	Updates the properties of a profile.
default UpdateProfileResponse	updateProfile(UpdateProfileRequest updateProfileRequest)	Updates the properties of a profile.
default UpdateRecommenderResponse	updateRecommender(Consumer<UpdateRecommenderRequest.Builder> updateRecommenderRequest)	Updates the properties of an existing recommender, allowing you to modify its configuration and description.
default UpdateRecommenderResponse	updateRecommender(UpdateRecommenderRequest updateRecommenderRequest)	Updates the properties of an existing recommender, allowing you to modify its configuration and description.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

addProfileKey

default AddProfileKeyResponse addProfileKey(AddProfileKeyRequest addProfileKeyRequest)
                                     throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

Parameters:

addProfileKeyRequest -

Returns:

Result of the AddProfileKey operation returned by the service.

See Also:

• AWS API Documentation

addProfileKey

default AddProfileKeyResponse addProfileKey(Consumer<AddProfileKeyRequest.Builder> addProfileKeyRequest)
                                     throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

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

Parameters:

addProfileKeyRequest - A Consumer that will call methods on AddProfileKeyRequest.Builder to create a request.

Returns:

Result of the AddProfileKey operation returned by the service.

See Also:

• AWS API Documentation

batchGetCalculatedAttributeForProfile

default BatchGetCalculatedAttributeForProfileResponse batchGetCalculatedAttributeForProfile(BatchGetCalculatedAttributeForProfileRequest batchGetCalculatedAttributeForProfileRequest)
                                                                                     throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Fetch the possible attribute values given the attribute name.

Parameters:

batchGetCalculatedAttributeForProfileRequest -

Returns:

Result of the BatchGetCalculatedAttributeForProfile operation returned by the service.

See Also:

• AWS API Documentation

batchGetCalculatedAttributeForProfile

default BatchGetCalculatedAttributeForProfileResponse batchGetCalculatedAttributeForProfile(Consumer<BatchGetCalculatedAttributeForProfileRequest.Builder> batchGetCalculatedAttributeForProfileRequest)
                                                                                     throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Fetch the possible attribute values given the attribute name.

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

Parameters:

batchGetCalculatedAttributeForProfileRequest - A Consumer that will call methods on BatchGetCalculatedAttributeForProfileRequest.Builder to create a request.

Returns:

Result of the BatchGetCalculatedAttributeForProfile operation returned by the service.

See Also:

• AWS API Documentation

batchGetProfile

default BatchGetProfileResponse batchGetProfile(BatchGetProfileRequest batchGetProfileRequest)
                                         throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Get a batch of profiles.

Parameters:

batchGetProfileRequest -

Returns:

Result of the BatchGetProfile operation returned by the service.

See Also:

• AWS API Documentation

batchGetProfile

default BatchGetProfileResponse batchGetProfile(Consumer<BatchGetProfileRequest.Builder> batchGetProfileRequest)
                                         throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Get a batch of profiles.

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

Parameters:

batchGetProfileRequest - A Consumer that will call methods on BatchGetProfileRequest.Builder to create a request.

Returns:

Result of the BatchGetProfile operation returned by the service.

See Also:

• AWS API Documentation

createCalculatedAttributeDefinition

default CreateCalculatedAttributeDefinitionResponse createCalculatedAttributeDefinition(CreateCalculatedAttributeDefinitionRequest createCalculatedAttributeDefinitionRequest)
                                                                                 throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

Parameters:

createCalculatedAttributeDefinitionRequest -

Returns:

Result of the CreateCalculatedAttributeDefinition operation returned by the service.

See Also:

• AWS API Documentation

createCalculatedAttributeDefinition

default CreateCalculatedAttributeDefinitionResponse createCalculatedAttributeDefinition(Consumer<CreateCalculatedAttributeDefinitionRequest.Builder> createCalculatedAttributeDefinitionRequest)
                                                                                 throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

Result of the CreateCalculatedAttributeDefinition operation returned by the service.

See Also:

• AWS API Documentation

createDomain

default CreateDomainResponse createDomain(CreateDomainRequest createDomainRequest)
                                   throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys. You can create multiple domains, and each domain can have multiple third-party integrations.

Each Connect Customer instance can be associated with only one domain. Multiple Connect Customer 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.

It is not possible to associate a Customer Profiles domain with an Amazon Connect Instance directly from the API. If you would like to create a domain and associate a Customer Profiles domain, use the Amazon Connect admin website. For more information, see Enable Customer Profiles.

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

Parameters:

createDomainRequest -

Returns:

Result of the CreateDomain operation returned by the service.

See Also:

• AWS API Documentation

createDomain

default CreateDomainResponse createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest)
                                   throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys. You can create multiple domains, and each domain can have multiple third-party integrations.

Each Connect Customer instance can be associated with only one domain. Multiple Connect Customer 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.

It is not possible to associate a Customer Profiles domain with an Amazon Connect Instance directly from the API. If you would like to create a domain and associate a Customer Profiles domain, use the Amazon Connect admin website. For more information, see Enable Customer Profiles.

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

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

Parameters:

createDomainRequest - A Consumer that will call methods on CreateDomainRequest.Builder to create a request.

Returns:

Result of the CreateDomain operation returned by the service.

See Also:

• AWS API Documentation

createDomainLayout

default CreateDomainLayoutResponse createDomainLayout(CreateDomainLayoutRequest createDomainLayoutRequest)
                                               throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Creates the layout to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

Parameters:

createDomainLayoutRequest -

Returns:

Result of the CreateDomainLayout operation returned by the service.

See Also:

• AWS API Documentation

createDomainLayout

default CreateDomainLayoutResponse createDomainLayout(Consumer<CreateDomainLayoutRequest.Builder> createDomainLayoutRequest)
                                               throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Creates the layout to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

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

Parameters:

createDomainLayoutRequest - A Consumer that will call methods on CreateDomainLayoutRequest.Builder to create a request.

Returns:

Result of the CreateDomainLayout operation returned by the service.

See Also:

• AWS API Documentation

createEventStream

default CreateEventStreamResponse createEventStream(CreateEventStreamRequest createEventStreamRequest)
                                             throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

Parameters:

createEventStreamRequest -

Returns:

Result of the CreateEventStream operation returned by the service.

See Also:

• AWS API Documentation

createEventStream

default CreateEventStreamResponse createEventStream(Consumer<CreateEventStreamRequest.Builder> createEventStreamRequest)
                                             throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Creates an event stream, which is a subscription to real-time events, such as when profiles are created and updated through Connect Customer 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:

Result of the CreateEventStream operation returned by the service.

See Also:

• AWS API Documentation

createEventTrigger

default CreateEventTriggerResponse createEventTrigger(CreateEventTriggerRequest createEventTriggerRequest)
                                               throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Creates an event trigger, which specifies the rules when to perform action based on customer's ingested data.

Each event stream can be associated with only one integration in the same region and AWS account as the event stream.

Parameters:

createEventTriggerRequest -

Returns:

Result of the CreateEventTrigger operation returned by the service.

See Also:

• AWS API Documentation

createEventTrigger

default CreateEventTriggerResponse createEventTrigger(Consumer<CreateEventTriggerRequest.Builder> createEventTriggerRequest)
                                               throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Creates an event trigger, which specifies the rules when to perform action based on customer's ingested data.

Each event stream can be associated with only one integration in the same region and AWS account as the event stream.

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

Parameters:

createEventTriggerRequest - A Consumer that will call methods on CreateEventTriggerRequest.Builder to create a request.

Returns:

Result of the CreateEventTrigger operation returned by the service.

See Also:

• AWS API Documentation

createIntegrationWorkflow

default CreateIntegrationWorkflowResponse createIntegrationWorkflow(CreateIntegrationWorkflowRequest createIntegrationWorkflowRequest)
                                                             throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

Parameters:

createIntegrationWorkflowRequest -

Returns:

Result of the CreateIntegrationWorkflow operation returned by the service.

See Also:

• AWS API Documentation

createIntegrationWorkflow

default CreateIntegrationWorkflowResponse createIntegrationWorkflow(Consumer<CreateIntegrationWorkflowRequest.Builder> createIntegrationWorkflowRequest)
                                                             throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

Parameters:

createIntegrationWorkflowRequest - A Consumer that will call methods on CreateIntegrationWorkflowRequest.Builder to create a request.

Returns:

Result of the CreateIntegrationWorkflow operation returned by the service.

See Also:

• AWS API Documentation

createProfile

default CreateProfileResponse createProfile(CreateProfileRequest createProfileRequest)
                                     throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Creates a standard profile.

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

Parameters:

createProfileRequest -

Returns:

Result of the CreateProfile operation returned by the service.

See Also:

• AWS API Documentation

createProfile

default CreateProfileResponse createProfile(Consumer<CreateProfileRequest.Builder> createProfileRequest)
                                     throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Creates a standard profile.

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

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

Parameters:

createProfileRequest - A Consumer that will call methods on CreateProfileRequest.Builder to create a request.

Returns:

Result of the CreateProfile operation returned by the service.

See Also:

• AWS API Documentation

createRecommender

default CreateRecommenderResponse createRecommender(CreateRecommenderRequest createRecommenderRequest)
                                             throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Creates a recommender

Parameters:

createRecommenderRequest -

Returns:

Result of the CreateRecommender operation returned by the service.

See Also:

• AWS API Documentation

createRecommender

default CreateRecommenderResponse createRecommender(Consumer<CreateRecommenderRequest.Builder> createRecommenderRequest)
                                             throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Creates a recommender

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

Parameters:

createRecommenderRequest - A Consumer that will call methods on CreateRecommenderRequest.Builder to create a request.

Returns:

Result of the CreateRecommender operation returned by the service.

See Also:

• AWS API Documentation

createRecommenderFilter

default CreateRecommenderFilterResponse createRecommenderFilter(CreateRecommenderFilterRequest createRecommenderFilterRequest)
                                                         throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Creates a recommender filter. A recommender filter specifies which items to include or exclude from recommendations.

Parameters:

createRecommenderFilterRequest -

Returns:

Result of the CreateRecommenderFilter operation returned by the service.

See Also:

• AWS API Documentation

createRecommenderFilter

default CreateRecommenderFilterResponse createRecommenderFilter(Consumer<CreateRecommenderFilterRequest.Builder> createRecommenderFilterRequest)
                                                         throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Creates a recommender filter. A recommender filter specifies which items to include or exclude from recommendations.

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

Parameters:

createRecommenderFilterRequest - A Consumer that will call methods on CreateRecommenderFilterRequest.Builder to create a request.

Returns:

Result of the CreateRecommenderFilter operation returned by the service.

See Also:

• AWS API Documentation

createRecommenderSchema

default CreateRecommenderSchemaResponse createRecommenderSchema(CreateRecommenderSchemaRequest createRecommenderSchemaRequest)
                                                         throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Creates a recommender schema. A recommender schema defines the set of data columns available for training recommenders and filters under a domain.

Parameters:

createRecommenderSchemaRequest -

Returns:

Result of the CreateRecommenderSchema operation returned by the service.

See Also:

• AWS API Documentation

createRecommenderSchema

default CreateRecommenderSchemaResponse createRecommenderSchema(Consumer<CreateRecommenderSchemaRequest.Builder> createRecommenderSchemaRequest)
                                                         throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Creates a recommender schema. A recommender schema defines the set of data columns available for training recommenders and filters under a domain.

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

Parameters:

createRecommenderSchemaRequest - A Consumer that will call methods on CreateRecommenderSchemaRequest.Builder to create a request.

Returns:

Result of the CreateRecommenderSchema operation returned by the service.

See Also:

• AWS API Documentation

createSegmentDefinition

default CreateSegmentDefinitionResponse createSegmentDefinition(CreateSegmentDefinitionRequest createSegmentDefinitionRequest)
                                                         throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Creates a segment definition associated to the given domain.

Parameters:

createSegmentDefinitionRequest -

Returns:

Result of the CreateSegmentDefinition operation returned by the service.

See Also:

• AWS API Documentation

createSegmentDefinition

default CreateSegmentDefinitionResponse createSegmentDefinition(Consumer<CreateSegmentDefinitionRequest.Builder> createSegmentDefinitionRequest)
                                                         throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Creates a segment definition associated to the given domain.

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

Parameters:

createSegmentDefinitionRequest - A Consumer that will call methods on CreateSegmentDefinitionRequest.Builder to create a request.

Returns:

Result of the CreateSegmentDefinition operation returned by the service.

See Also:

• AWS API Documentation

createSegmentEstimate

default CreateSegmentEstimateResponse createSegmentEstimate(CreateSegmentEstimateRequest createSegmentEstimateRequest)
                                                     throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Creates a segment estimate query.

Parameters:

createSegmentEstimateRequest -

Returns:

Result of the CreateSegmentEstimate operation returned by the service.

See Also:

• AWS API Documentation

createSegmentEstimate

default CreateSegmentEstimateResponse createSegmentEstimate(Consumer<CreateSegmentEstimateRequest.Builder> createSegmentEstimateRequest)
                                                     throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Creates a segment estimate query.

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

Parameters:

createSegmentEstimateRequest - A Consumer that will call methods on CreateSegmentEstimateRequest.Builder to create a request.

Returns:

Result of the CreateSegmentEstimate operation returned by the service.

See Also:

• AWS API Documentation

createSegmentSnapshot

default CreateSegmentSnapshotResponse createSegmentSnapshot(CreateSegmentSnapshotRequest createSegmentSnapshotRequest)
                                                     throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Triggers a job to export a segment to a specified destination.

Parameters:

createSegmentSnapshotRequest -

Returns:

Result of the CreateSegmentSnapshot operation returned by the service.

See Also:

• AWS API Documentation

createSegmentSnapshot

default CreateSegmentSnapshotResponse createSegmentSnapshot(Consumer<CreateSegmentSnapshotRequest.Builder> createSegmentSnapshotRequest)
                                                     throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Triggers a job to export a segment to a specified destination.

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

Parameters:

createSegmentSnapshotRequest - A Consumer that will call methods on CreateSegmentSnapshotRequest.Builder to create a request.

Returns:

Result of the CreateSegmentSnapshot operation returned by the service.

See Also:

• AWS API Documentation

createUploadJob

default CreateUploadJobResponse createUploadJob(CreateUploadJobRequest createUploadJobRequest)
                                         throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Creates an Upload job to ingest data for segment imports. The metadata is created for the job with the provided field mapping and unique key.

Parameters:

createUploadJobRequest -

Returns:

Result of the CreateUploadJob operation returned by the service.

See Also:

• AWS API Documentation

createUploadJob

default CreateUploadJobResponse createUploadJob(Consumer<CreateUploadJobRequest.Builder> createUploadJobRequest)
                                         throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Creates an Upload job to ingest data for segment imports. The metadata is created for the job with the provided field mapping and unique key.

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

Parameters:

createUploadJobRequest - A Consumer that will call methods on CreateUploadJobRequest.Builder to create a request.

Returns:

Result of the CreateUploadJob operation returned by the service.

See Also:

• AWS API Documentation

deleteCalculatedAttributeDefinition

default DeleteCalculatedAttributeDefinitionResponse deleteCalculatedAttributeDefinition(DeleteCalculatedAttributeDefinitionRequest deleteCalculatedAttributeDefinitionRequest)
                                                                                 throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

Parameters:

deleteCalculatedAttributeDefinitionRequest -

Returns:

Result of the DeleteCalculatedAttributeDefinition operation returned by the service.

See Also:

• AWS API Documentation

deleteCalculatedAttributeDefinition

default DeleteCalculatedAttributeDefinitionResponse deleteCalculatedAttributeDefinition(Consumer<DeleteCalculatedAttributeDefinitionRequest.Builder> deleteCalculatedAttributeDefinitionRequest)
                                                                                 throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

Parameters:

deleteCalculatedAttributeDefinitionRequest - A Consumer that will call methods on DeleteCalculatedAttributeDefinitionRequest.Builder to create a request.

Returns:

Result of the DeleteCalculatedAttributeDefinition operation returned by the service.

See Also:

• AWS API Documentation

deleteDomain

default DeleteDomainResponse deleteDomain(DeleteDomainRequest deleteDomainRequest)
                                   throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

Parameters:

deleteDomainRequest -

Returns:

Result of the DeleteDomain operation returned by the service.

See Also:

• AWS API Documentation

deleteDomain

default DeleteDomainResponse deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest)
                                   throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

Parameters:

deleteDomainRequest - A Consumer that will call methods on DeleteDomainRequest.Builder to create a request.

Returns:

Result of the DeleteDomain operation returned by the service.

See Also:

• AWS API Documentation

deleteDomainLayout

default DeleteDomainLayoutResponse deleteDomainLayout(DeleteDomainLayoutRequest deleteDomainLayoutRequest)
                                               throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Deletes the layout used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

Parameters:

deleteDomainLayoutRequest -

Returns:

Result of the DeleteDomainLayout operation returned by the service.

See Also:

• AWS API Documentation

deleteDomainLayout

default DeleteDomainLayoutResponse deleteDomainLayout(Consumer<DeleteDomainLayoutRequest.Builder> deleteDomainLayoutRequest)
                                               throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Deletes the layout used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

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

Parameters:

deleteDomainLayoutRequest - A Consumer that will call methods on DeleteDomainLayoutRequest.Builder to create a request.

Returns:

Result of the DeleteDomainLayout operation returned by the service.

See Also:

• AWS API Documentation

deleteDomainObjectType

default DeleteDomainObjectTypeResponse deleteDomainObjectType(DeleteDomainObjectTypeRequest deleteDomainObjectTypeRequest)
                                                       throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Delete a DomainObjectType for the given Domain and ObjectType name.

Parameters:

deleteDomainObjectTypeRequest -

Returns:

Result of the DeleteDomainObjectType operation returned by the service.

See Also:

• AWS API Documentation

deleteDomainObjectType

default DeleteDomainObjectTypeResponse deleteDomainObjectType(Consumer<DeleteDomainObjectTypeRequest.Builder> deleteDomainObjectTypeRequest)
                                                       throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Delete a DomainObjectType for the given Domain and ObjectType name.

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

Parameters:

deleteDomainObjectTypeRequest - A Consumer that will call methods on DeleteDomainObjectTypeRequest.Builder to create a request.

Returns:

Result of the DeleteDomainObjectType operation returned by the service.

See Also:

• AWS API Documentation

deleteEventStream

default DeleteEventStreamResponse deleteEventStream(DeleteEventStreamRequest deleteEventStreamRequest)
                                             throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Disables and deletes the specified event stream.

Parameters:

deleteEventStreamRequest -

Returns:

Result of the DeleteEventStream operation returned by the service.

See Also:

• AWS API Documentation

deleteEventStream

default DeleteEventStreamResponse deleteEventStream(Consumer<DeleteEventStreamRequest.Builder> deleteEventStreamRequest)
                                             throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Disables and deletes the specified event stream.

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

Parameters:

deleteEventStreamRequest - A Consumer that will call methods on DeleteEventStreamRequest.Builder to create a request.

Returns:

Result of the DeleteEventStream operation returned by the service.

See Also:

• AWS API Documentation

deleteEventTrigger

default DeleteEventTriggerResponse deleteEventTrigger(DeleteEventTriggerRequest deleteEventTriggerRequest)
                                               throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Disable and deletes the Event Trigger.

You cannot delete an Event Trigger with an active Integration associated.

Parameters:

deleteEventTriggerRequest -

Returns:

Result of the DeleteEventTrigger operation returned by the service.

See Also:

• AWS API Documentation

deleteEventTrigger

default DeleteEventTriggerResponse deleteEventTrigger(Consumer<DeleteEventTriggerRequest.Builder> deleteEventTriggerRequest)
                                               throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Disable and deletes the Event Trigger.

You cannot delete an Event Trigger with an active Integration associated.

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

Parameters:

deleteEventTriggerRequest - A Consumer that will call methods on DeleteEventTriggerRequest.Builder to create a request.

Returns:

Result of the DeleteEventTrigger operation returned by the service.

See Also:

• AWS API Documentation

deleteIntegration

default DeleteIntegrationResponse deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest)
                                             throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Removes an integration from a specific domain.

Parameters:

deleteIntegrationRequest -

Returns:

Result of the DeleteIntegration operation returned by the service.

See Also:

• AWS API Documentation

deleteIntegration

default DeleteIntegrationResponse deleteIntegration(Consumer<DeleteIntegrationRequest.Builder> deleteIntegrationRequest)
                                             throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Removes an integration from a specific domain.

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

Parameters:

deleteIntegrationRequest - A Consumer that will call methods on DeleteIntegrationRequest.Builder to create a request.

Returns:

Result of the DeleteIntegration operation returned by the service.

See Also:

• AWS API Documentation

deleteProfile

default DeleteProfileResponse deleteProfile(DeleteProfileRequest deleteProfileRequest)
                                     throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

Parameters:

deleteProfileRequest -

Returns:

Result of the DeleteProfile operation returned by the service.

See Also:

• AWS API Documentation

deleteProfile

default DeleteProfileResponse deleteProfile(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest)
                                     throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

Parameters:

deleteProfileRequest - A Consumer that will call methods on DeleteProfileRequest.Builder to create a request.

Returns:

Result of the DeleteProfile operation returned by the service.

See Also:

• AWS API Documentation

deleteProfileKey

default DeleteProfileKeyResponse deleteProfileKey(DeleteProfileKeyRequest deleteProfileKeyRequest)
                                           throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Removes a searchable key from a customer profile.

Parameters:

deleteProfileKeyRequest -

Returns:

Result of the DeleteProfileKey operation returned by the service.

See Also:

• AWS API Documentation

deleteProfileKey

default DeleteProfileKeyResponse deleteProfileKey(Consumer<DeleteProfileKeyRequest.Builder> deleteProfileKeyRequest)
                                           throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Removes a searchable key from a customer profile.

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

Parameters:

deleteProfileKeyRequest - A Consumer that will call methods on DeleteProfileKeyRequest.Builder to create a request.

Returns:

Result of the DeleteProfileKey operation returned by the service.

See Also:

• AWS API Documentation

deleteProfileObject

default DeleteProfileObjectResponse deleteProfileObject(DeleteProfileObjectRequest deleteProfileObjectRequest)
                                                 throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

Parameters:

deleteProfileObjectRequest -

Returns:

Result of the DeleteProfileObject operation returned by the service.

See Also:

• AWS API Documentation

deleteProfileObject

default DeleteProfileObjectResponse deleteProfileObject(Consumer<DeleteProfileObjectRequest.Builder> deleteProfileObjectRequest)
                                                 throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

Parameters:

deleteProfileObjectRequest - A Consumer that will call methods on DeleteProfileObjectRequest.Builder to create a request.

Returns:

Result of the DeleteProfileObject operation returned by the service.

See Also:

• AWS API Documentation

deleteProfileObjectType

default DeleteProfileObjectTypeResponse deleteProfileObjectType(DeleteProfileObjectTypeRequest deleteProfileObjectTypeRequest)
                                                         throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

Parameters:

deleteProfileObjectTypeRequest -

Returns:

Result of the DeleteProfileObjectType operation returned by the service.

See Also:

• AWS API Documentation

deleteProfileObjectType

default DeleteProfileObjectTypeResponse deleteProfileObjectType(Consumer<DeleteProfileObjectTypeRequest.Builder> deleteProfileObjectTypeRequest)
                                                         throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

Parameters:

deleteProfileObjectTypeRequest - A Consumer that will call methods on DeleteProfileObjectTypeRequest.Builder to create a request.

Returns:

Result of the DeleteProfileObjectType operation returned by the service.

See Also:

• AWS API Documentation

deleteRecommender

default DeleteRecommenderResponse deleteRecommender(DeleteRecommenderRequest deleteRecommenderRequest)
                                             throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Deletes a recommender.

Parameters:

deleteRecommenderRequest -

Returns:

Result of the DeleteRecommender operation returned by the service.

See Also:

• AWS API Documentation

deleteRecommender

default DeleteRecommenderResponse deleteRecommender(Consumer<DeleteRecommenderRequest.Builder> deleteRecommenderRequest)
                                             throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Deletes a recommender.

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

Parameters:

deleteRecommenderRequest - A Consumer that will call methods on DeleteRecommenderRequest.Builder to create a request.

Returns:

Result of the DeleteRecommender operation returned by the service.

See Also:

• AWS API Documentation

deleteRecommenderFilter

default DeleteRecommenderFilterResponse deleteRecommenderFilter(DeleteRecommenderFilterRequest deleteRecommenderFilterRequest)
                                                         throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Deletes a recommender filter from a domain.

Parameters:

deleteRecommenderFilterRequest -

Returns:

Result of the DeleteRecommenderFilter operation returned by the service.

See Also:

• AWS API Documentation

deleteRecommenderFilter

default DeleteRecommenderFilterResponse deleteRecommenderFilter(Consumer<DeleteRecommenderFilterRequest.Builder> deleteRecommenderFilterRequest)
                                                         throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Deletes a recommender filter from a domain.

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

Parameters:

deleteRecommenderFilterRequest - A Consumer that will call methods on DeleteRecommenderFilterRequest.Builder to create a request.

Returns:

Result of the DeleteRecommenderFilter operation returned by the service.

See Also:

• AWS API Documentation

deleteRecommenderSchema

default DeleteRecommenderSchemaResponse deleteRecommenderSchema(DeleteRecommenderSchemaRequest deleteRecommenderSchemaRequest)
                                                         throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Deletes a recommender schema from a domain.

Parameters:

deleteRecommenderSchemaRequest -

Returns:

Result of the DeleteRecommenderSchema operation returned by the service.

See Also:

• AWS API Documentation

deleteRecommenderSchema

default DeleteRecommenderSchemaResponse deleteRecommenderSchema(Consumer<DeleteRecommenderSchemaRequest.Builder> deleteRecommenderSchemaRequest)
                                                         throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Deletes a recommender schema from a domain.

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

Parameters:

deleteRecommenderSchemaRequest - A Consumer that will call methods on DeleteRecommenderSchemaRequest.Builder to create a request.

Returns:

Result of the DeleteRecommenderSchema operation returned by the service.

See Also:

• AWS API Documentation

deleteSegmentDefinition

default DeleteSegmentDefinitionResponse deleteSegmentDefinition(DeleteSegmentDefinitionRequest deleteSegmentDefinitionRequest)
                                                         throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Deletes a segment definition from the domain.

Parameters:

deleteSegmentDefinitionRequest -

Returns:

Result of the DeleteSegmentDefinition operation returned by the service.

See Also:

• AWS API Documentation

deleteSegmentDefinition

default DeleteSegmentDefinitionResponse deleteSegmentDefinition(Consumer<DeleteSegmentDefinitionRequest.Builder> deleteSegmentDefinitionRequest)
                                                         throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Deletes a segment definition from the domain.

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

Parameters:

deleteSegmentDefinitionRequest - A Consumer that will call methods on DeleteSegmentDefinitionRequest.Builder to create a request.

Returns:

Result of the DeleteSegmentDefinition operation returned by the service.

See Also:

• AWS API Documentation

deleteWorkflow

default DeleteWorkflowResponse deleteWorkflow(DeleteWorkflowRequest deleteWorkflowRequest)
                                       throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

Parameters:

deleteWorkflowRequest -

Returns:

Result of the DeleteWorkflow operation returned by the service.

See Also:

• AWS API Documentation

deleteWorkflow

default DeleteWorkflowResponse deleteWorkflow(Consumer<DeleteWorkflowRequest.Builder> deleteWorkflowRequest)
                                       throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

Parameters:

deleteWorkflowRequest - A Consumer that will call methods on DeleteWorkflowRequest.Builder to create a request.

Returns:

Result of the DeleteWorkflow operation returned by the service.

See Also:

• AWS API Documentation

detectProfileObjectType

default DetectProfileObjectTypeResponse detectProfileObjectType(DetectProfileObjectTypeRequest detectProfileObjectTypeRequest)
                                                         throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

Parameters:

detectProfileObjectTypeRequest -

Returns:

Result of the DetectProfileObjectType operation returned by the service.

See Also:

• AWS API Documentation

detectProfileObjectType

default DetectProfileObjectTypeResponse detectProfileObjectType(Consumer<DetectProfileObjectTypeRequest.Builder> detectProfileObjectTypeRequest)
                                                         throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

Parameters:

detectProfileObjectTypeRequest - A Consumer that will call methods on DetectProfileObjectTypeRequest.Builder to create a request.

Returns:

Result of the DetectProfileObjectType operation returned by the service.

See Also:

• AWS API Documentation

getAutoMergingPreview

default GetAutoMergingPreviewResponse getAutoMergingPreview(GetAutoMergingPreviewRequest getAutoMergingPreviewRequest)
                                                     throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

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

Parameters:

getAutoMergingPreviewRequest -

Returns:

Result of the GetAutoMergingPreview operation returned by the service.

See Also:

• AWS API Documentation

getAutoMergingPreview

default GetAutoMergingPreviewResponse getAutoMergingPreview(Consumer<GetAutoMergingPreviewRequest.Builder> getAutoMergingPreviewRequest)
                                                     throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

We strongly recommend you use this API to do a dry run of the automerging process before running the Identity Resolution Job. Include at least two matching attributes. If your matching list includes too few attributes (such as only FirstName or 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:

Result of the GetAutoMergingPreview operation returned by the service.

See Also:

• AWS API Documentation

getCalculatedAttributeDefinition

default GetCalculatedAttributeDefinitionResponse getCalculatedAttributeDefinition(GetCalculatedAttributeDefinitionRequest getCalculatedAttributeDefinitionRequest)
                                                                           throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

Parameters:

getCalculatedAttributeDefinitionRequest -

Returns:

Result of the GetCalculatedAttributeDefinition operation returned by the service.

See Also:

• AWS API Documentation

getCalculatedAttributeDefinition

default GetCalculatedAttributeDefinitionResponse getCalculatedAttributeDefinition(Consumer<GetCalculatedAttributeDefinitionRequest.Builder> getCalculatedAttributeDefinitionRequest)
                                                                           throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

Parameters:

getCalculatedAttributeDefinitionRequest - A Consumer that will call methods on GetCalculatedAttributeDefinitionRequest.Builder to create a request.

Returns:

Result of the GetCalculatedAttributeDefinition operation returned by the service.

See Also:

• AWS API Documentation

getCalculatedAttributeForProfile

default GetCalculatedAttributeForProfileResponse getCalculatedAttributeForProfile(GetCalculatedAttributeForProfileRequest getCalculatedAttributeForProfileRequest)
                                                                           throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Retrieve a calculated attribute for a customer profile.

Parameters:

getCalculatedAttributeForProfileRequest -

Returns:

Result of the GetCalculatedAttributeForProfile operation returned by the service.

See Also:

• AWS API Documentation

getCalculatedAttributeForProfile

default GetCalculatedAttributeForProfileResponse getCalculatedAttributeForProfile(Consumer<GetCalculatedAttributeForProfileRequest.Builder> getCalculatedAttributeForProfileRequest)
                                                                           throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Retrieve a calculated attribute for a customer profile.

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

Parameters:

getCalculatedAttributeForProfileRequest - A Consumer that will call methods on GetCalculatedAttributeForProfileRequest.Builder to create a request.

Returns:

Result of the GetCalculatedAttributeForProfile operation returned by the service.

See Also:

• AWS API Documentation

getDomain

default GetDomainResponse getDomain(GetDomainRequest getDomainRequest)
                             throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Returns information about a specific domain.

Parameters:

getDomainRequest -

Returns:

Result of the GetDomain operation returned by the service.

See Also:

• AWS API Documentation

getDomain

default GetDomainResponse getDomain(Consumer<GetDomainRequest.Builder> getDomainRequest)
                             throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Returns information about a specific domain.

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

Parameters:

getDomainRequest - A Consumer that will call methods on GetDomainRequest.Builder to create a request.

Returns:

Result of the GetDomain operation returned by the service.

See Also:

• AWS API Documentation

getDomainLayout

default GetDomainLayoutResponse getDomainLayout(GetDomainLayoutRequest getDomainLayoutRequest)
                                         throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Gets the layout to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

Parameters:

getDomainLayoutRequest -

Returns:

Result of the GetDomainLayout operation returned by the service.

See Also:

• AWS API Documentation

getDomainLayout

default GetDomainLayoutResponse getDomainLayout(Consumer<GetDomainLayoutRequest.Builder> getDomainLayoutRequest)
                                         throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Gets the layout to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

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

Parameters:

getDomainLayoutRequest - A Consumer that will call methods on GetDomainLayoutRequest.Builder to create a request.

Returns:

Result of the GetDomainLayout operation returned by the service.

See Also:

• AWS API Documentation

getDomainObjectType

default GetDomainObjectTypeResponse getDomainObjectType(GetDomainObjectTypeRequest getDomainObjectTypeRequest)
                                                 throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Return a DomainObjectType for the input Domain and ObjectType names.

Parameters:

getDomainObjectTypeRequest -

Returns:

Result of the GetDomainObjectType operation returned by the service.

See Also:

• AWS API Documentation

getDomainObjectType

default GetDomainObjectTypeResponse getDomainObjectType(Consumer<GetDomainObjectTypeRequest.Builder> getDomainObjectTypeRequest)
                                                 throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Return a DomainObjectType for the input Domain and ObjectType names.

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

Parameters:

getDomainObjectTypeRequest - A Consumer that will call methods on GetDomainObjectTypeRequest.Builder to create a request.

Returns:

Result of the GetDomainObjectType operation returned by the service.

See Also:

• AWS API Documentation

getEventStream

default GetEventStreamResponse getEventStream(GetEventStreamRequest getEventStreamRequest)
                                       throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

Parameters:

getEventStreamRequest -

Returns:

Result of the GetEventStream operation returned by the service.

See Also:

• AWS API Documentation

getEventStream

default GetEventStreamResponse getEventStream(Consumer<GetEventStreamRequest.Builder> getEventStreamRequest)
                                       throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

Parameters:

getEventStreamRequest - A Consumer that will call methods on GetEventStreamRequest.Builder to create a request.

Returns:

Result of the GetEventStream operation returned by the service.

See Also:

• AWS API Documentation

getEventTrigger

default GetEventTriggerResponse getEventTrigger(GetEventTriggerRequest getEventTriggerRequest)
                                         throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Get a specific Event Trigger from the domain.

Parameters:

getEventTriggerRequest -

Returns:

Result of the GetEventTrigger operation returned by the service.

See Also:

• AWS API Documentation

getEventTrigger

default GetEventTriggerResponse getEventTrigger(Consumer<GetEventTriggerRequest.Builder> getEventTriggerRequest)
                                         throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Get a specific Event Trigger from the domain.

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

Parameters:

getEventTriggerRequest - A Consumer that will call methods on GetEventTriggerRequest.Builder to create a request.

Returns:

Result of the GetEventTrigger operation returned by the service.

See Also:

• AWS API Documentation

getIdentityResolutionJob

default GetIdentityResolutionJobResponse getIdentityResolutionJob(GetIdentityResolutionJobRequest getIdentityResolutionJobRequest)
                                                           throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

Parameters:

getIdentityResolutionJobRequest -

Returns:

Result of the GetIdentityResolutionJob operation returned by the service.

See Also:

• AWS API Documentation

getIdentityResolutionJob

default GetIdentityResolutionJobResponse getIdentityResolutionJob(Consumer<GetIdentityResolutionJobRequest.Builder> getIdentityResolutionJobRequest)
                                                           throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

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

Parameters:

getIdentityResolutionJobRequest - A Consumer that will call methods on GetIdentityResolutionJobRequest.Builder to create a request.

Returns:

Result of the GetIdentityResolutionJob operation returned by the service.

See Also:

• AWS API Documentation

getIntegration

default GetIntegrationResponse getIntegration(GetIntegrationRequest getIntegrationRequest)
                                       throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Returns an integration for a domain.

Parameters:

getIntegrationRequest -

Returns:

Result of the GetIntegration operation returned by the service.

See Also:

• AWS API Documentation

getIntegration

default GetIntegrationResponse getIntegration(Consumer<GetIntegrationRequest.Builder> getIntegrationRequest)
                                       throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Returns an integration for a domain.

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

Parameters:

getIntegrationRequest - A Consumer that will call methods on GetIntegrationRequest.Builder to create a request.

Returns:

Result of the GetIntegration operation returned by the service.

See Also:

• AWS API Documentation

getMatches

default GetMatchesResponse getMatches(GetMatchesRequest getMatchesRequest)
                               throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

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

After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in 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:

Result of the GetMatches operation returned by the service.

See Also:

• AWS API Documentation

getMatches

default GetMatchesResponse getMatches(Consumer<GetMatchesRequest.Builder> getMatchesRequest)
                               throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

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

After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in 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:

Result of the GetMatches operation returned by the service.

See Also:

• AWS API Documentation

getObjectTypeAttributeStatistics

default GetObjectTypeAttributeStatisticsResponse getObjectTypeAttributeStatistics(GetObjectTypeAttributeStatisticsRequest getObjectTypeAttributeStatisticsRequest)
                                                                           throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

The GetObjectTypeAttributeValues API delivers statistical insights about attributes within a specific object type, but is exclusively available for domains with data store enabled. This API performs daily calculations to provide statistical information about your attribute values, helping you understand patterns and trends in your data. The statistical calculations are performed once per day, providing a consistent snapshot of your attribute data characteristics.

You'll receive null values in two scenarios:

During the first period after enabling data vault (unless a calculation cycle occurs, which happens once daily).

For attributes that don't contain numeric values.

Parameters:

getObjectTypeAttributeStatisticsRequest -

Returns:

Result of the GetObjectTypeAttributeStatistics operation returned by the service.

See Also:

• AWS API Documentation

getObjectTypeAttributeStatistics

default GetObjectTypeAttributeStatisticsResponse getObjectTypeAttributeStatistics(Consumer<GetObjectTypeAttributeStatisticsRequest.Builder> getObjectTypeAttributeStatisticsRequest)
                                                                           throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

The GetObjectTypeAttributeValues API delivers statistical insights about attributes within a specific object type, but is exclusively available for domains with data store enabled. This API performs daily calculations to provide statistical information about your attribute values, helping you understand patterns and trends in your data. The statistical calculations are performed once per day, providing a consistent snapshot of your attribute data characteristics.

You'll receive null values in two scenarios:

During the first period after enabling data vault (unless a calculation cycle occurs, which happens once daily).

For attributes that don't contain numeric values.

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

Parameters:

getObjectTypeAttributeStatisticsRequest - A Consumer that will call methods on GetObjectTypeAttributeStatisticsRequest.Builder to create a request.

Returns:

Result of the GetObjectTypeAttributeStatistics operation returned by the service.

See Also:

• AWS API Documentation

getProfileHistoryRecord

default GetProfileHistoryRecordResponse getProfileHistoryRecord(GetProfileHistoryRecordRequest getProfileHistoryRecordRequest)
                                                         throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Returns a history record for a specific profile, for a specific domain.

Parameters:

getProfileHistoryRecordRequest -

Returns:

Result of the GetProfileHistoryRecord operation returned by the service.

See Also:

• AWS API Documentation

getProfileHistoryRecord

default GetProfileHistoryRecordResponse getProfileHistoryRecord(Consumer<GetProfileHistoryRecordRequest.Builder> getProfileHistoryRecordRequest)
                                                         throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Returns a history record for a specific profile, for a specific domain.

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

Parameters:

getProfileHistoryRecordRequest - A Consumer that will call methods on GetProfileHistoryRecordRequest.Builder to create a request.

Returns:

Result of the GetProfileHistoryRecord operation returned by the service.

See Also:

• AWS API Documentation

getProfileObjectType

default GetProfileObjectTypeResponse getProfileObjectType(GetProfileObjectTypeRequest getProfileObjectTypeRequest)
                                                   throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Returns the object types for a specific domain.

Parameters:

getProfileObjectTypeRequest -

Returns:

Result of the GetProfileObjectType operation returned by the service.

See Also:

• AWS API Documentation

getProfileObjectType

default GetProfileObjectTypeResponse getProfileObjectType(Consumer<GetProfileObjectTypeRequest.Builder> getProfileObjectTypeRequest)
                                                   throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Returns the object types for a specific domain.

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

Parameters:

getProfileObjectTypeRequest - A Consumer that will call methods on GetProfileObjectTypeRequest.Builder to create a request.

Returns:

Result of the GetProfileObjectType operation returned by the service.

See Also:

• AWS API Documentation

getProfileObjectTypeTemplate

default GetProfileObjectTypeTemplateResponse getProfileObjectTypeTemplate(GetProfileObjectTypeTemplateRequest getProfileObjectTypeTemplateRequest)
                                                                   throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Returns the template information for a specific object type.

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

Parameters:

getProfileObjectTypeTemplateRequest -

Returns:

Result of the GetProfileObjectTypeTemplate operation returned by the service.

See Also:

• AWS API Documentation

getProfileObjectTypeTemplate

default GetProfileObjectTypeTemplateResponse getProfileObjectTypeTemplate(Consumer<GetProfileObjectTypeTemplateRequest.Builder> getProfileObjectTypeTemplateRequest)
                                                                   throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Returns the template information for a specific object type.

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

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

Parameters:

getProfileObjectTypeTemplateRequest - A Consumer that will call methods on GetProfileObjectTypeTemplateRequest.Builder to create a request.

Returns:

Result of the GetProfileObjectTypeTemplate operation returned by the service.

See Also:

• AWS API Documentation

getProfileRecommendations

default GetProfileRecommendationsResponse getProfileRecommendations(GetProfileRecommendationsRequest getProfileRecommendationsRequest)
                                                             throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Fetches the recommendations for a profile in the input Customer Profiles domain. Fetches all the profile recommendations

Parameters:

getProfileRecommendationsRequest -

Returns:

Result of the GetProfileRecommendations operation returned by the service.

See Also:

• AWS API Documentation

getProfileRecommendations

default GetProfileRecommendationsResponse getProfileRecommendations(Consumer<GetProfileRecommendationsRequest.Builder> getProfileRecommendationsRequest)
                                                             throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Fetches the recommendations for a profile in the input Customer Profiles domain. Fetches all the profile recommendations

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

Parameters:

getProfileRecommendationsRequest - A Consumer that will call methods on GetProfileRecommendationsRequest.Builder to create a request.

Returns:

Result of the GetProfileRecommendations operation returned by the service.

See Also:

• AWS API Documentation

getRecommender

default GetRecommenderResponse getRecommender(GetRecommenderRequest getRecommenderRequest)
                                       throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Retrieves a recommender.

Parameters:

getRecommenderRequest -

Returns:

Result of the GetRecommender operation returned by the service.

See Also:

• AWS API Documentation

getRecommender

default GetRecommenderResponse getRecommender(Consumer<GetRecommenderRequest.Builder> getRecommenderRequest)
                                       throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Retrieves a recommender.

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

Parameters:

getRecommenderRequest - A Consumer that will call methods on GetRecommenderRequest.Builder to create a request.

Returns:

Result of the GetRecommender operation returned by the service.

See Also:

• AWS API Documentation

getRecommenderFilter

default GetRecommenderFilterResponse getRecommenderFilter(GetRecommenderFilterRequest getRecommenderFilterRequest)
                                                   throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Retrieves information about a specific recommender filter in a domain.

Parameters:

getRecommenderFilterRequest -

Returns:

Result of the GetRecommenderFilter operation returned by the service.

See Also:

• AWS API Documentation

getRecommenderFilter

default GetRecommenderFilterResponse getRecommenderFilter(Consumer<GetRecommenderFilterRequest.Builder> getRecommenderFilterRequest)
                                                   throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Retrieves information about a specific recommender filter in a domain.

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

Parameters:

getRecommenderFilterRequest - A Consumer that will call methods on GetRecommenderFilterRequest.Builder to create a request.

Returns:

Result of the GetRecommenderFilter operation returned by the service.

See Also:

• AWS API Documentation

getRecommenderSchema

default GetRecommenderSchemaResponse getRecommenderSchema(GetRecommenderSchemaRequest getRecommenderSchemaRequest)
                                                   throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Retrieves information about a specific recommender schema in a domain.

Parameters:

getRecommenderSchemaRequest -

Returns:

Result of the GetRecommenderSchema operation returned by the service.

See Also:

• AWS API Documentation

getRecommenderSchema

default GetRecommenderSchemaResponse getRecommenderSchema(Consumer<GetRecommenderSchemaRequest.Builder> getRecommenderSchemaRequest)
                                                   throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Retrieves information about a specific recommender schema in a domain.

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

Parameters:

getRecommenderSchemaRequest - A Consumer that will call methods on GetRecommenderSchemaRequest.Builder to create a request.

Returns:

Result of the GetRecommenderSchema operation returned by the service.

See Also:

• AWS API Documentation

getSegmentDefinition

default GetSegmentDefinitionResponse getSegmentDefinition(GetSegmentDefinitionRequest getSegmentDefinitionRequest)
                                                   throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Gets a segment definition from the domain.

Parameters:

getSegmentDefinitionRequest -

Returns:

Result of the GetSegmentDefinition operation returned by the service.

See Also:

• AWS API Documentation

getSegmentDefinition

default GetSegmentDefinitionResponse getSegmentDefinition(Consumer<GetSegmentDefinitionRequest.Builder> getSegmentDefinitionRequest)
                                                   throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Gets a segment definition from the domain.

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

Parameters:

getSegmentDefinitionRequest - A Consumer that will call methods on GetSegmentDefinitionRequest.Builder to create a request.

Returns:

Result of the GetSegmentDefinition operation returned by the service.

See Also:

• AWS API Documentation

getSegmentEstimate

default GetSegmentEstimateResponse getSegmentEstimate(GetSegmentEstimateRequest getSegmentEstimateRequest)
                                               throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Gets the result of a segment estimate query.

Parameters:

getSegmentEstimateRequest -

Returns:

Result of the GetSegmentEstimate operation returned by the service.

See Also:

• AWS API Documentation

getSegmentEstimate

default GetSegmentEstimateResponse getSegmentEstimate(Consumer<GetSegmentEstimateRequest.Builder> getSegmentEstimateRequest)
                                               throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Gets the result of a segment estimate query.

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

Parameters:

getSegmentEstimateRequest - A Consumer that will call methods on GetSegmentEstimateRequest.Builder to create a request.

Returns:

Result of the GetSegmentEstimate operation returned by the service.

See Also:

• AWS API Documentation

getSegmentMembership

default GetSegmentMembershipResponse getSegmentMembership(GetSegmentMembershipRequest getSegmentMembershipRequest)
                                                   throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Determines if the given profiles are within a segment.

Parameters:

getSegmentMembershipRequest -

Returns:

Result of the GetSegmentMembership operation returned by the service.

See Also:

• AWS API Documentation

getSegmentMembership

default GetSegmentMembershipResponse getSegmentMembership(Consumer<GetSegmentMembershipRequest.Builder> getSegmentMembershipRequest)
                                                   throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Determines if the given profiles are within a segment.

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

Parameters:

getSegmentMembershipRequest - A Consumer that will call methods on GetSegmentMembershipRequest.Builder to create a request.

Returns:

Result of the GetSegmentMembership operation returned by the service.

See Also:

• AWS API Documentation

getSegmentSnapshot

default GetSegmentSnapshotResponse getSegmentSnapshot(GetSegmentSnapshotRequest getSegmentSnapshotRequest)
                                               throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Retrieve the latest status of a segment snapshot.

Parameters:

getSegmentSnapshotRequest -

Returns:

Result of the GetSegmentSnapshot operation returned by the service.

See Also:

• AWS API Documentation

getSegmentSnapshot

default GetSegmentSnapshotResponse getSegmentSnapshot(Consumer<GetSegmentSnapshotRequest.Builder> getSegmentSnapshotRequest)
                                               throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Retrieve the latest status of a segment snapshot.

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

Parameters:

getSegmentSnapshotRequest - A Consumer that will call methods on GetSegmentSnapshotRequest.Builder to create a request.

Returns:

Result of the GetSegmentSnapshot operation returned by the service.

See Also:

• AWS API Documentation

getSimilarProfiles

default GetSimilarProfilesResponse getSimilarProfiles(GetSimilarProfilesRequest getSimilarProfilesRequest)
                                               throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Returns a set of profiles that belong to the same matching group using the matchId 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:

Result of the GetSimilarProfiles operation returned by the service.

See Also:

• AWS API Documentation

getSimilarProfiles

default GetSimilarProfilesResponse getSimilarProfiles(Consumer<GetSimilarProfilesRequest.Builder> getSimilarProfilesRequest)
                                               throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Returns a set of profiles that belong to the same matching group using the matchId 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:

Result of the GetSimilarProfiles operation returned by the service.

See Also:

• AWS API Documentation

getSimilarProfilesPaginator

default GetSimilarProfilesIterable getSimilarProfilesPaginator(GetSimilarProfilesRequest getSimilarProfilesRequest)
                                                        throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This is a variant of getSimilarProfiles(software.amazon.awssdk.services.customerprofiles.model.GetSimilarProfilesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.customerprofiles.paginators.GetSimilarProfilesIterable responses = client.getSimilarProfilesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.customerprofiles.paginators.GetSimilarProfilesIterable responses = client
             .getSimilarProfilesPaginator(request);
     for (software.amazon.awssdk.services.customerprofiles.model.GetSimilarProfilesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.customerprofiles.paginators.GetSimilarProfilesIterable responses = client.getSimilarProfilesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

Parameters:

getSimilarProfilesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getSimilarProfilesPaginator

default GetSimilarProfilesIterable getSimilarProfilesPaginator(Consumer<GetSimilarProfilesRequest.Builder> getSimilarProfilesRequest)
                                                        throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This is a variant of getSimilarProfiles(software.amazon.awssdk.services.customerprofiles.model.GetSimilarProfilesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.customerprofiles.paginators.GetSimilarProfilesIterable responses = client.getSimilarProfilesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.customerprofiles.paginators.GetSimilarProfilesIterable responses = client
             .getSimilarProfilesPaginator(request);
     for (software.amazon.awssdk.services.customerprofiles.model.GetSimilarProfilesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.customerprofiles.paginators.GetSimilarProfilesIterable responses = client.getSimilarProfilesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

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 custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getUploadJob

default GetUploadJobResponse getUploadJob(GetUploadJobRequest getUploadJobRequest)
                                   throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This API retrieves the details of a specific upload job.

Parameters:

getUploadJobRequest -

Returns:

Result of the GetUploadJob operation returned by the service.

See Also:

• AWS API Documentation

getUploadJob

default GetUploadJobResponse getUploadJob(Consumer<GetUploadJobRequest.Builder> getUploadJobRequest)
                                   throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This API retrieves the details of a specific upload job.

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

Parameters:

getUploadJobRequest - A Consumer that will call methods on GetUploadJobRequest.Builder to create a request.

Returns:

Result of the GetUploadJob operation returned by the service.

See Also:

• AWS API Documentation

getUploadJobPath

default GetUploadJobPathResponse getUploadJobPath(GetUploadJobPathRequest getUploadJobPathRequest)
                                           throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This API retrieves the pre-signed URL and client token for uploading the file associated with the upload job.

Parameters:

getUploadJobPathRequest -

Returns:

Result of the GetUploadJobPath operation returned by the service.

See Also:

• AWS API Documentation

getUploadJobPath

default GetUploadJobPathResponse getUploadJobPath(Consumer<GetUploadJobPathRequest.Builder> getUploadJobPathRequest)
                                           throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This API retrieves the pre-signed URL and client token for uploading the file associated with the upload job.

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

Parameters:

getUploadJobPathRequest - A Consumer that will call methods on GetUploadJobPathRequest.Builder to create a request.

Returns:

Result of the GetUploadJobPath operation returned by the service.

See Also:

• AWS API Documentation

getWorkflow

default GetWorkflowResponse getWorkflow(GetWorkflowRequest getWorkflowRequest)
                                 throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Get details of specified workflow.

Parameters:

getWorkflowRequest -

Returns:

Result of the GetWorkflow operation returned by the service.

See Also:

• AWS API Documentation

getWorkflow

default GetWorkflowResponse getWorkflow(Consumer<GetWorkflowRequest.Builder> getWorkflowRequest)
                                 throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Get details of specified workflow.

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

Parameters:

getWorkflowRequest - A Consumer that will call methods on GetWorkflowRequest.Builder to create a request.

Returns:

Result of the GetWorkflow operation returned by the service.

See Also:

• AWS API Documentation

getWorkflowSteps

default GetWorkflowStepsResponse getWorkflowSteps(GetWorkflowStepsRequest getWorkflowStepsRequest)
                                           throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Get granular list of steps in workflow.

Parameters:

getWorkflowStepsRequest -

Returns:

Result of the GetWorkflowSteps operation returned by the service.

See Also:

• AWS API Documentation

getWorkflowSteps

default GetWorkflowStepsResponse getWorkflowSteps(Consumer<GetWorkflowStepsRequest.Builder> getWorkflowStepsRequest)
                                           throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Get granular list of steps in workflow.

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

Parameters:

getWorkflowStepsRequest - A Consumer that will call methods on GetWorkflowStepsRequest.Builder to create a request.

Returns:

Result of the GetWorkflowSteps operation returned by the service.

See Also:

• AWS API Documentation

listAccountIntegrations

default ListAccountIntegrationsResponse listAccountIntegrations(ListAccountIntegrationsRequest listAccountIntegrationsRequest)
                                                         throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

Parameters:

listAccountIntegrationsRequest -

Returns:

Result of the ListAccountIntegrations operation returned by the service.

See Also:

• AWS API Documentation

listAccountIntegrations

default ListAccountIntegrationsResponse listAccountIntegrations(Consumer<ListAccountIntegrationsRequest.Builder> listAccountIntegrationsRequest)
                                                         throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

Parameters:

listAccountIntegrationsRequest - A Consumer that will call methods on ListAccountIntegrationsRequest.Builder to create a request.

Returns:

Result of the ListAccountIntegrations operation returned by the service.

See Also:

• AWS API Documentation

listCalculatedAttributeDefinitions

default ListCalculatedAttributeDefinitionsResponse listCalculatedAttributeDefinitions(ListCalculatedAttributeDefinitionsRequest listCalculatedAttributeDefinitionsRequest)
                                                                               throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Lists calculated attribute definitions for Customer Profiles

Parameters:

listCalculatedAttributeDefinitionsRequest -

Returns:

Result of the ListCalculatedAttributeDefinitions operation returned by the service.

See Also:

• AWS API Documentation

listCalculatedAttributeDefinitions

default ListCalculatedAttributeDefinitionsResponse listCalculatedAttributeDefinitions(Consumer<ListCalculatedAttributeDefinitionsRequest.Builder> listCalculatedAttributeDefinitionsRequest)
                                                                               throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Lists calculated attribute definitions for Customer Profiles

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

Parameters:

listCalculatedAttributeDefinitionsRequest - A Consumer that will call methods on ListCalculatedAttributeDefinitionsRequest.Builder to create a request.

Returns:

Result of the ListCalculatedAttributeDefinitions operation returned by the service.

See Also:

• AWS API Documentation

listCalculatedAttributesForProfile

default ListCalculatedAttributesForProfileResponse listCalculatedAttributesForProfile(ListCalculatedAttributesForProfileRequest listCalculatedAttributesForProfileRequest)
                                                                               throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Retrieve a list of calculated attributes for a customer profile.

Parameters:

listCalculatedAttributesForProfileRequest -

Returns:

Result of the ListCalculatedAttributesForProfile operation returned by the service.

See Also:

• AWS API Documentation

listCalculatedAttributesForProfile

default ListCalculatedAttributesForProfileResponse listCalculatedAttributesForProfile(Consumer<ListCalculatedAttributesForProfileRequest.Builder> listCalculatedAttributesForProfileRequest)
                                                                               throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Retrieve a list of calculated attributes for a customer profile.

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

Parameters:

listCalculatedAttributesForProfileRequest - A Consumer that will call methods on ListCalculatedAttributesForProfileRequest.Builder to create a request.

Returns:

Result of the ListCalculatedAttributesForProfile operation returned by the service.

See Also:

• AWS API Documentation

listDomainLayouts

default ListDomainLayoutsResponse listDomainLayouts(ListDomainLayoutsRequest listDomainLayoutsRequest)
                                             throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Lists the existing layouts that can be used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

Parameters:

listDomainLayoutsRequest -

Returns:

Result of the ListDomainLayouts operation returned by the service.

See Also:

• AWS API Documentation

listDomainLayouts

default ListDomainLayoutsResponse listDomainLayouts(Consumer<ListDomainLayoutsRequest.Builder> listDomainLayoutsRequest)
                                             throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Lists the existing layouts that can be used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

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

Parameters:

listDomainLayoutsRequest - A Consumer that will call methods on ListDomainLayoutsRequest.Builder to create a request.

Returns:

Result of the ListDomainLayouts operation returned by the service.

See Also:

• AWS API Documentation

listDomainLayoutsPaginator

default ListDomainLayoutsIterable listDomainLayoutsPaginator(ListDomainLayoutsRequest listDomainLayoutsRequest)
                                                      throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This is a variant of listDomainLayouts(software.amazon.awssdk.services.customerprofiles.model.ListDomainLayoutsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListDomainLayoutsIterable responses = client.listDomainLayoutsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.customerprofiles.paginators.ListDomainLayoutsIterable responses = client
             .listDomainLayoutsPaginator(request);
     for (software.amazon.awssdk.services.customerprofiles.model.ListDomainLayoutsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListDomainLayoutsIterable responses = client.listDomainLayoutsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

Parameters:

listDomainLayoutsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDomainLayoutsPaginator

default ListDomainLayoutsIterable listDomainLayoutsPaginator(Consumer<ListDomainLayoutsRequest.Builder> listDomainLayoutsRequest)
                                                      throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This is a variant of listDomainLayouts(software.amazon.awssdk.services.customerprofiles.model.ListDomainLayoutsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListDomainLayoutsIterable responses = client.listDomainLayoutsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.customerprofiles.paginators.ListDomainLayoutsIterable responses = client
             .listDomainLayoutsPaginator(request);
     for (software.amazon.awssdk.services.customerprofiles.model.ListDomainLayoutsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListDomainLayoutsIterable responses = client.listDomainLayoutsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

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

Parameters:

listDomainLayoutsRequest - A Consumer that will call methods on ListDomainLayoutsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDomainObjectTypes

default ListDomainObjectTypesResponse listDomainObjectTypes(ListDomainObjectTypesRequest listDomainObjectTypesRequest)
                                                     throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

List all DomainObjectType(s) in a Customer Profiles domain.

Parameters:

listDomainObjectTypesRequest -

Returns:

Result of the ListDomainObjectTypes operation returned by the service.

See Also:

• AWS API Documentation

listDomainObjectTypes

default ListDomainObjectTypesResponse listDomainObjectTypes(Consumer<ListDomainObjectTypesRequest.Builder> listDomainObjectTypesRequest)
                                                     throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

List all DomainObjectType(s) in a Customer Profiles domain.

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

Parameters:

listDomainObjectTypesRequest - A Consumer that will call methods on ListDomainObjectTypesRequest.Builder to create a request.

Returns:

Result of the ListDomainObjectTypes operation returned by the service.

See Also:

• AWS API Documentation

listDomainObjectTypesPaginator

default ListDomainObjectTypesIterable listDomainObjectTypesPaginator(ListDomainObjectTypesRequest listDomainObjectTypesRequest)
                                                              throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This is a variant of listDomainObjectTypes(software.amazon.awssdk.services.customerprofiles.model.ListDomainObjectTypesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListDomainObjectTypesIterable responses = client.listDomainObjectTypesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.customerprofiles.paginators.ListDomainObjectTypesIterable responses = client
             .listDomainObjectTypesPaginator(request);
     for (software.amazon.awssdk.services.customerprofiles.model.ListDomainObjectTypesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListDomainObjectTypesIterable responses = client.listDomainObjectTypesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

Parameters:

listDomainObjectTypesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDomainObjectTypesPaginator

default ListDomainObjectTypesIterable listDomainObjectTypesPaginator(Consumer<ListDomainObjectTypesRequest.Builder> listDomainObjectTypesRequest)
                                                              throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This is a variant of listDomainObjectTypes(software.amazon.awssdk.services.customerprofiles.model.ListDomainObjectTypesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListDomainObjectTypesIterable responses = client.listDomainObjectTypesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.customerprofiles.paginators.ListDomainObjectTypesIterable responses = client
             .listDomainObjectTypesPaginator(request);
     for (software.amazon.awssdk.services.customerprofiles.model.ListDomainObjectTypesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListDomainObjectTypesIterable responses = client.listDomainObjectTypesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

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

Parameters:

listDomainObjectTypesRequest - A Consumer that will call methods on ListDomainObjectTypesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDomains

default ListDomainsResponse listDomains(ListDomainsRequest listDomainsRequest)
                                 throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

Parameters:

listDomainsRequest -

Returns:

Result of the ListDomains operation returned by the service.

See Also:

• AWS API Documentation

listDomains

default ListDomainsResponse listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest)
                                 throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

Parameters:

listDomainsRequest - A Consumer that will call methods on ListDomainsRequest.Builder to create a request.

Returns:

Result of the ListDomains operation returned by the service.

See Also:

• AWS API Documentation

listEventStreams

default ListEventStreamsResponse listEventStreams(ListEventStreamsRequest listEventStreamsRequest)
                                           throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

Parameters:

listEventStreamsRequest -

Returns:

Result of the ListEventStreams operation returned by the service.

See Also:

• AWS API Documentation

listEventStreams

default ListEventStreamsResponse listEventStreams(Consumer<ListEventStreamsRequest.Builder> listEventStreamsRequest)
                                           throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

Parameters:

listEventStreamsRequest - A Consumer that will call methods on ListEventStreamsRequest.Builder to create a request.

Returns:

Result of the ListEventStreams operation returned by the service.

See Also:

• AWS API Documentation

listEventStreamsPaginator

default ListEventStreamsIterable listEventStreamsPaginator(ListEventStreamsRequest listEventStreamsRequest)
                                                    throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This is a variant of listEventStreams(software.amazon.awssdk.services.customerprofiles.model.ListEventStreamsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListEventStreamsIterable responses = client.listEventStreamsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.customerprofiles.paginators.ListEventStreamsIterable responses = client
             .listEventStreamsPaginator(request);
     for (software.amazon.awssdk.services.customerprofiles.model.ListEventStreamsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListEventStreamsIterable responses = client.listEventStreamsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

Parameters:

listEventStreamsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listEventStreamsPaginator

default ListEventStreamsIterable listEventStreamsPaginator(Consumer<ListEventStreamsRequest.Builder> listEventStreamsRequest)
                                                    throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This is a variant of listEventStreams(software.amazon.awssdk.services.customerprofiles.model.ListEventStreamsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListEventStreamsIterable responses = client.listEventStreamsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.customerprofiles.paginators.ListEventStreamsIterable responses = client
             .listEventStreamsPaginator(request);
     for (software.amazon.awssdk.services.customerprofiles.model.ListEventStreamsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListEventStreamsIterable responses = client.listEventStreamsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

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

Parameters:

listEventStreamsRequest - A Consumer that will call methods on ListEventStreamsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listEventTriggers

default ListEventTriggersResponse listEventTriggers(ListEventTriggersRequest listEventTriggersRequest)
                                             throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

List all Event Triggers under a domain.

Parameters:

listEventTriggersRequest -

Returns:

Result of the ListEventTriggers operation returned by the service.

See Also:

• AWS API Documentation

listEventTriggers

default ListEventTriggersResponse listEventTriggers(Consumer<ListEventTriggersRequest.Builder> listEventTriggersRequest)
                                             throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

List all Event Triggers under a domain.

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

Parameters:

listEventTriggersRequest - A Consumer that will call methods on ListEventTriggersRequest.Builder to create a request.

Returns:

Result of the ListEventTriggers operation returned by the service.

See Also:

• AWS API Documentation

listEventTriggersPaginator

default ListEventTriggersIterable listEventTriggersPaginator(ListEventTriggersRequest listEventTriggersRequest)
                                                      throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This is a variant of listEventTriggers(software.amazon.awssdk.services.customerprofiles.model.ListEventTriggersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListEventTriggersIterable responses = client.listEventTriggersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.customerprofiles.paginators.ListEventTriggersIterable responses = client
             .listEventTriggersPaginator(request);
     for (software.amazon.awssdk.services.customerprofiles.model.ListEventTriggersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListEventTriggersIterable responses = client.listEventTriggersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

Parameters:

listEventTriggersRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listEventTriggersPaginator

default ListEventTriggersIterable listEventTriggersPaginator(Consumer<ListEventTriggersRequest.Builder> listEventTriggersRequest)
                                                      throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This is a variant of listEventTriggers(software.amazon.awssdk.services.customerprofiles.model.ListEventTriggersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListEventTriggersIterable responses = client.listEventTriggersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.customerprofiles.paginators.ListEventTriggersIterable responses = client
             .listEventTriggersPaginator(request);
     for (software.amazon.awssdk.services.customerprofiles.model.ListEventTriggersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListEventTriggersIterable responses = client.listEventTriggersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

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

Parameters:

listEventTriggersRequest - A Consumer that will call methods on ListEventTriggersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listIdentityResolutionJobs

default ListIdentityResolutionJobsResponse listIdentityResolutionJobs(ListIdentityResolutionJobsRequest listIdentityResolutionJobsRequest)
                                                               throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

Parameters:

listIdentityResolutionJobsRequest -

Returns:

Result of the ListIdentityResolutionJobs operation returned by the service.

See Also:

• AWS API Documentation

listIdentityResolutionJobs

default ListIdentityResolutionJobsResponse listIdentityResolutionJobs(Consumer<ListIdentityResolutionJobsRequest.Builder> listIdentityResolutionJobsRequest)
                                                               throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

Parameters:

listIdentityResolutionJobsRequest - A Consumer that will call methods on ListIdentityResolutionJobsRequest.Builder to create a request.

Returns:

Result of the ListIdentityResolutionJobs operation returned by the service.

See Also:

• AWS API Documentation

listIntegrations

default ListIntegrationsResponse listIntegrations(ListIntegrationsRequest listIntegrationsRequest)
                                           throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Lists all of the integrations in your domain.

Parameters:

listIntegrationsRequest -

Returns:

Result of the ListIntegrations operation returned by the service.

See Also:

• AWS API Documentation

listIntegrations

default ListIntegrationsResponse listIntegrations(Consumer<ListIntegrationsRequest.Builder> listIntegrationsRequest)
                                           throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Lists all of the integrations in your domain.

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

Parameters:

listIntegrationsRequest - A Consumer that will call methods on ListIntegrationsRequest.Builder to create a request.

Returns:

Result of the ListIntegrations operation returned by the service.

See Also:

• AWS API Documentation

listObjectTypeAttributeValues

default ListObjectTypeAttributeValuesResponse listObjectTypeAttributeValues(ListObjectTypeAttributeValuesRequest listObjectTypeAttributeValuesRequest)
                                                                     throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

The ListObjectTypeAttributeValues API provides access to the most recent distinct values for any specified attribute, making it valuable for real-time data validation and consistency checks within your object types. This API works across domain, supporting both custom and standard object types. The API accepts the object type name, attribute name, and domain name as input parameters and returns values up to the storage limit of approximately 350KB.

Parameters:

listObjectTypeAttributeValuesRequest -

Returns:

Result of the ListObjectTypeAttributeValues operation returned by the service.

See Also:

• AWS API Documentation

listObjectTypeAttributeValues

default ListObjectTypeAttributeValuesResponse listObjectTypeAttributeValues(Consumer<ListObjectTypeAttributeValuesRequest.Builder> listObjectTypeAttributeValuesRequest)
                                                                     throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

The ListObjectTypeAttributeValues API provides access to the most recent distinct values for any specified attribute, making it valuable for real-time data validation and consistency checks within your object types. This API works across domain, supporting both custom and standard object types. The API accepts the object type name, attribute name, and domain name as input parameters and returns values up to the storage limit of approximately 350KB.

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

Parameters:

listObjectTypeAttributeValuesRequest - A Consumer that will call methods on ListObjectTypeAttributeValuesRequest.Builder to create a request.

Returns:

Result of the ListObjectTypeAttributeValues operation returned by the service.

See Also:

• AWS API Documentation

listObjectTypeAttributes

default ListObjectTypeAttributesResponse listObjectTypeAttributes(ListObjectTypeAttributesRequest listObjectTypeAttributesRequest)
                                                           throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Fetch the possible attribute values given the attribute name.

Parameters:

listObjectTypeAttributesRequest -

Returns:

Result of the ListObjectTypeAttributes operation returned by the service.

See Also:

• AWS API Documentation

listObjectTypeAttributes

default ListObjectTypeAttributesResponse listObjectTypeAttributes(Consumer<ListObjectTypeAttributesRequest.Builder> listObjectTypeAttributesRequest)
                                                           throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Fetch the possible attribute values given the attribute name.

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

Parameters:

listObjectTypeAttributesRequest - A Consumer that will call methods on ListObjectTypeAttributesRequest.Builder to create a request.

Returns:

Result of the ListObjectTypeAttributes operation returned by the service.

See Also:

• AWS API Documentation

listObjectTypeAttributesPaginator

default ListObjectTypeAttributesIterable listObjectTypeAttributesPaginator(ListObjectTypeAttributesRequest listObjectTypeAttributesRequest)
                                                                    throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This is a variant of listObjectTypeAttributes(software.amazon.awssdk.services.customerprofiles.model.ListObjectTypeAttributesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListObjectTypeAttributesIterable responses = client.listObjectTypeAttributesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.customerprofiles.paginators.ListObjectTypeAttributesIterable responses = client
             .listObjectTypeAttributesPaginator(request);
     for (software.amazon.awssdk.services.customerprofiles.model.ListObjectTypeAttributesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListObjectTypeAttributesIterable responses = client.listObjectTypeAttributesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

Parameters:

listObjectTypeAttributesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listObjectTypeAttributesPaginator

default ListObjectTypeAttributesIterable listObjectTypeAttributesPaginator(Consumer<ListObjectTypeAttributesRequest.Builder> listObjectTypeAttributesRequest)
                                                                    throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This is a variant of listObjectTypeAttributes(software.amazon.awssdk.services.customerprofiles.model.ListObjectTypeAttributesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListObjectTypeAttributesIterable responses = client.listObjectTypeAttributesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.customerprofiles.paginators.ListObjectTypeAttributesIterable responses = client
             .listObjectTypeAttributesPaginator(request);
     for (software.amazon.awssdk.services.customerprofiles.model.ListObjectTypeAttributesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListObjectTypeAttributesIterable responses = client.listObjectTypeAttributesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

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

Parameters:

listObjectTypeAttributesRequest - A Consumer that will call methods on ListObjectTypeAttributesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listProfileAttributeValues

default ListProfileAttributeValuesResponse listProfileAttributeValues(ListProfileAttributeValuesRequest listProfileAttributeValuesRequest)
                                                               throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Fetch the possible attribute values given the attribute name.

Parameters:

listProfileAttributeValuesRequest -

Returns:

Result of the ListProfileAttributeValues operation returned by the service.

See Also:

• AWS API Documentation

listProfileAttributeValues

default ListProfileAttributeValuesResponse listProfileAttributeValues(Consumer<ListProfileAttributeValuesRequest.Builder> listProfileAttributeValuesRequest)
                                                               throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Fetch the possible attribute values given the attribute name.

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

Parameters:

listProfileAttributeValuesRequest - A Consumer that will call methods on ListProfileAttributeValuesRequest.Builder to create a request.

Returns:

Result of the ListProfileAttributeValues operation returned by the service.

See Also:

• AWS API Documentation

listProfileHistoryRecords

default ListProfileHistoryRecordsResponse listProfileHistoryRecords(ListProfileHistoryRecordsRequest listProfileHistoryRecordsRequest)
                                                             throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Returns a list of history records for a specific profile, for a specific domain.

Parameters:

listProfileHistoryRecordsRequest -

Returns:

Result of the ListProfileHistoryRecords operation returned by the service.

See Also:

• AWS API Documentation

listProfileHistoryRecords

default ListProfileHistoryRecordsResponse listProfileHistoryRecords(Consumer<ListProfileHistoryRecordsRequest.Builder> listProfileHistoryRecordsRequest)
                                                             throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Returns a list of history records for a specific profile, for a specific domain.

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

Parameters:

listProfileHistoryRecordsRequest - A Consumer that will call methods on ListProfileHistoryRecordsRequest.Builder to create a request.

Returns:

Result of the ListProfileHistoryRecords operation returned by the service.

See Also:

• AWS API Documentation

listProfileObjectTypeTemplates

default ListProfileObjectTypeTemplatesResponse listProfileObjectTypeTemplates(ListProfileObjectTypeTemplatesRequest listProfileObjectTypeTemplatesRequest)
                                                                       throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Lists all of the template information for object types.

Parameters:

listProfileObjectTypeTemplatesRequest -

Returns:

Result of the ListProfileObjectTypeTemplates operation returned by the service.

See Also:

• AWS API Documentation

listProfileObjectTypeTemplates

default ListProfileObjectTypeTemplatesResponse listProfileObjectTypeTemplates(Consumer<ListProfileObjectTypeTemplatesRequest.Builder> listProfileObjectTypeTemplatesRequest)
                                                                       throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Lists all of the template information for object types.

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

Parameters:

listProfileObjectTypeTemplatesRequest - A Consumer that will call methods on ListProfileObjectTypeTemplatesRequest.Builder to create a request.

Returns:

Result of the ListProfileObjectTypeTemplates operation returned by the service.

See Also:

• AWS API Documentation

listProfileObjectTypes

default ListProfileObjectTypesResponse listProfileObjectTypes(ListProfileObjectTypesRequest listProfileObjectTypesRequest)
                                                       throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Lists all of the templates available within the service.

Parameters:

listProfileObjectTypesRequest -

Returns:

Result of the ListProfileObjectTypes operation returned by the service.

See Also:

• AWS API Documentation

listProfileObjectTypes

default ListProfileObjectTypesResponse listProfileObjectTypes(Consumer<ListProfileObjectTypesRequest.Builder> listProfileObjectTypesRequest)
                                                       throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Lists all of the templates available within the service.

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

Parameters:

listProfileObjectTypesRequest - A Consumer that will call methods on ListProfileObjectTypesRequest.Builder to create a request.

Returns:

Result of the ListProfileObjectTypes operation returned by the service.

See Also:

• AWS API Documentation

listProfileObjects

default ListProfileObjectsResponse listProfileObjects(ListProfileObjectsRequest listProfileObjectsRequest)
                                               throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

Parameters:

listProfileObjectsRequest -

Returns:

Result of the ListProfileObjects operation returned by the service.

See Also:

• AWS API Documentation

listProfileObjects

default ListProfileObjectsResponse listProfileObjects(Consumer<ListProfileObjectsRequest.Builder> listProfileObjectsRequest)
                                               throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

Parameters:

listProfileObjectsRequest - A Consumer that will call methods on ListProfileObjectsRequest.Builder to create a request.

Returns:

Result of the ListProfileObjects operation returned by the service.

See Also:

• AWS API Documentation

listRecommenderFilters

default ListRecommenderFiltersResponse listRecommenderFilters(ListRecommenderFiltersRequest listRecommenderFiltersRequest)
                                                       throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Returns a list of recommender filters in the specified domain.

Parameters:

listRecommenderFiltersRequest -

Returns:

Result of the ListRecommenderFilters operation returned by the service.

See Also:

• AWS API Documentation

listRecommenderFilters

default ListRecommenderFiltersResponse listRecommenderFilters(Consumer<ListRecommenderFiltersRequest.Builder> listRecommenderFiltersRequest)
                                                       throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Returns a list of recommender filters in the specified domain.

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

Parameters:

listRecommenderFiltersRequest - A Consumer that will call methods on ListRecommenderFiltersRequest.Builder to create a request.

Returns:

Result of the ListRecommenderFilters operation returned by the service.

See Also:

• AWS API Documentation

listRecommenderFiltersPaginator

default ListRecommenderFiltersIterable listRecommenderFiltersPaginator(ListRecommenderFiltersRequest listRecommenderFiltersRequest)
                                                                throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This is a variant of listRecommenderFilters(software.amazon.awssdk.services.customerprofiles.model.ListRecommenderFiltersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListRecommenderFiltersIterable responses = client.listRecommenderFiltersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.customerprofiles.paginators.ListRecommenderFiltersIterable responses = client
             .listRecommenderFiltersPaginator(request);
     for (software.amazon.awssdk.services.customerprofiles.model.ListRecommenderFiltersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListRecommenderFiltersIterable responses = client.listRecommenderFiltersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

Parameters:

listRecommenderFiltersRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listRecommenderFiltersPaginator

default ListRecommenderFiltersIterable listRecommenderFiltersPaginator(Consumer<ListRecommenderFiltersRequest.Builder> listRecommenderFiltersRequest)
                                                                throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This is a variant of listRecommenderFilters(software.amazon.awssdk.services.customerprofiles.model.ListRecommenderFiltersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListRecommenderFiltersIterable responses = client.listRecommenderFiltersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.customerprofiles.paginators.ListRecommenderFiltersIterable responses = client
             .listRecommenderFiltersPaginator(request);
     for (software.amazon.awssdk.services.customerprofiles.model.ListRecommenderFiltersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListRecommenderFiltersIterable responses = client.listRecommenderFiltersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

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

Parameters:

listRecommenderFiltersRequest - A Consumer that will call methods on ListRecommenderFiltersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listRecommenderRecipes

default ListRecommenderRecipesResponse listRecommenderRecipes(ListRecommenderRecipesRequest listRecommenderRecipesRequest)
                                                       throws InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Returns a list of available recommender recipes that can be used to create recommenders.

Parameters:

listRecommenderRecipesRequest -

Returns:

Result of the ListRecommenderRecipes operation returned by the service.

See Also:

• AWS API Documentation

listRecommenderRecipes

default ListRecommenderRecipesResponse listRecommenderRecipes(Consumer<ListRecommenderRecipesRequest.Builder> listRecommenderRecipesRequest)
                                                       throws InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Returns a list of available recommender recipes that can be used to create recommenders.

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

Parameters:

listRecommenderRecipesRequest - A Consumer that will call methods on ListRecommenderRecipesRequest.Builder to create a request.

Returns:

Result of the ListRecommenderRecipes operation returned by the service.

See Also:

• AWS API Documentation

listRecommenderRecipesPaginator

default ListRecommenderRecipesIterable listRecommenderRecipesPaginator(ListRecommenderRecipesRequest listRecommenderRecipesRequest)
                                                                throws InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This is a variant of listRecommenderRecipes(software.amazon.awssdk.services.customerprofiles.model.ListRecommenderRecipesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListRecommenderRecipesIterable responses = client.listRecommenderRecipesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.customerprofiles.paginators.ListRecommenderRecipesIterable responses = client
             .listRecommenderRecipesPaginator(request);
     for (software.amazon.awssdk.services.customerprofiles.model.ListRecommenderRecipesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListRecommenderRecipesIterable responses = client.listRecommenderRecipesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

Parameters:

listRecommenderRecipesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listRecommenderRecipesPaginator

default ListRecommenderRecipesIterable listRecommenderRecipesPaginator(Consumer<ListRecommenderRecipesRequest.Builder> listRecommenderRecipesRequest)
                                                                throws InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This is a variant of listRecommenderRecipes(software.amazon.awssdk.services.customerprofiles.model.ListRecommenderRecipesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListRecommenderRecipesIterable responses = client.listRecommenderRecipesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.customerprofiles.paginators.ListRecommenderRecipesIterable responses = client
             .listRecommenderRecipesPaginator(request);
     for (software.amazon.awssdk.services.customerprofiles.model.ListRecommenderRecipesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListRecommenderRecipesIterable responses = client.listRecommenderRecipesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

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

Parameters:

listRecommenderRecipesRequest - A Consumer that will call methods on ListRecommenderRecipesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listRecommenderSchemas

default ListRecommenderSchemasResponse listRecommenderSchemas(ListRecommenderSchemasRequest listRecommenderSchemasRequest)
                                                       throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Returns a list of recommender schemas in the specified domain.

Parameters:

listRecommenderSchemasRequest -

Returns:

Result of the ListRecommenderSchemas operation returned by the service.

See Also:

• AWS API Documentation

listRecommenderSchemas

default ListRecommenderSchemasResponse listRecommenderSchemas(Consumer<ListRecommenderSchemasRequest.Builder> listRecommenderSchemasRequest)
                                                       throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Returns a list of recommender schemas in the specified domain.

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

Parameters:

listRecommenderSchemasRequest - A Consumer that will call methods on ListRecommenderSchemasRequest.Builder to create a request.

Returns:

Result of the ListRecommenderSchemas operation returned by the service.

See Also:

• AWS API Documentation

listRecommenderSchemasPaginator

default ListRecommenderSchemasIterable listRecommenderSchemasPaginator(ListRecommenderSchemasRequest listRecommenderSchemasRequest)
                                                                throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This is a variant of listRecommenderSchemas(software.amazon.awssdk.services.customerprofiles.model.ListRecommenderSchemasRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListRecommenderSchemasIterable responses = client.listRecommenderSchemasPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.customerprofiles.paginators.ListRecommenderSchemasIterable responses = client
             .listRecommenderSchemasPaginator(request);
     for (software.amazon.awssdk.services.customerprofiles.model.ListRecommenderSchemasResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListRecommenderSchemasIterable responses = client.listRecommenderSchemasPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

Parameters:

listRecommenderSchemasRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listRecommenderSchemasPaginator

default ListRecommenderSchemasIterable listRecommenderSchemasPaginator(Consumer<ListRecommenderSchemasRequest.Builder> listRecommenderSchemasRequest)
                                                                throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This is a variant of listRecommenderSchemas(software.amazon.awssdk.services.customerprofiles.model.ListRecommenderSchemasRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListRecommenderSchemasIterable responses = client.listRecommenderSchemasPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.customerprofiles.paginators.ListRecommenderSchemasIterable responses = client
             .listRecommenderSchemasPaginator(request);
     for (software.amazon.awssdk.services.customerprofiles.model.ListRecommenderSchemasResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListRecommenderSchemasIterable responses = client.listRecommenderSchemasPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

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

Parameters:

listRecommenderSchemasRequest - A Consumer that will call methods on ListRecommenderSchemasRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listRecommenders

default ListRecommendersResponse listRecommenders(ListRecommendersRequest listRecommendersRequest)
                                           throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Returns a list of recommenders in the specified domain.

Parameters:

listRecommendersRequest -

Returns:

Result of the ListRecommenders operation returned by the service.

See Also:

• AWS API Documentation

listRecommenders

default ListRecommendersResponse listRecommenders(Consumer<ListRecommendersRequest.Builder> listRecommendersRequest)
                                           throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Returns a list of recommenders in the specified domain.

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

Parameters:

listRecommendersRequest - A Consumer that will call methods on ListRecommendersRequest.Builder to create a request.

Returns:

Result of the ListRecommenders operation returned by the service.

See Also:

• AWS API Documentation

listRecommendersPaginator

default ListRecommendersIterable listRecommendersPaginator(ListRecommendersRequest listRecommendersRequest)
                                                    throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This is a variant of listRecommenders(software.amazon.awssdk.services.customerprofiles.model.ListRecommendersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListRecommendersIterable responses = client.listRecommendersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.customerprofiles.paginators.ListRecommendersIterable responses = client
             .listRecommendersPaginator(request);
     for (software.amazon.awssdk.services.customerprofiles.model.ListRecommendersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListRecommendersIterable responses = client.listRecommendersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

Parameters:

listRecommendersRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listRecommendersPaginator

default ListRecommendersIterable listRecommendersPaginator(Consumer<ListRecommendersRequest.Builder> listRecommendersRequest)
                                                    throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This is a variant of listRecommenders(software.amazon.awssdk.services.customerprofiles.model.ListRecommendersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListRecommendersIterable responses = client.listRecommendersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.customerprofiles.paginators.ListRecommendersIterable responses = client
             .listRecommendersPaginator(request);
     for (software.amazon.awssdk.services.customerprofiles.model.ListRecommendersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListRecommendersIterable responses = client.listRecommendersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

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

Parameters:

listRecommendersRequest - A Consumer that will call methods on ListRecommendersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listRuleBasedMatches

default ListRuleBasedMatchesResponse listRuleBasedMatches(ListRuleBasedMatchesRequest listRuleBasedMatchesRequest)
                                                   throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

Parameters:

listRuleBasedMatchesRequest -

Returns:

Result of the ListRuleBasedMatches operation returned by the service.

See Also:

• AWS API Documentation

listRuleBasedMatches

default ListRuleBasedMatchesResponse listRuleBasedMatches(Consumer<ListRuleBasedMatchesRequest.Builder> listRuleBasedMatchesRequest)
                                                   throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

Parameters:

listRuleBasedMatchesRequest - A Consumer that will call methods on ListRuleBasedMatchesRequest.Builder to create a request.

Returns:

Result of the ListRuleBasedMatches operation returned by the service.

See Also:

• AWS API Documentation

listRuleBasedMatchesPaginator

default ListRuleBasedMatchesIterable listRuleBasedMatchesPaginator(ListRuleBasedMatchesRequest listRuleBasedMatchesRequest)
                                                            throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This is a variant of listRuleBasedMatches(software.amazon.awssdk.services.customerprofiles.model.ListRuleBasedMatchesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListRuleBasedMatchesIterable responses = client.listRuleBasedMatchesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.customerprofiles.paginators.ListRuleBasedMatchesIterable responses = client
             .listRuleBasedMatchesPaginator(request);
     for (software.amazon.awssdk.services.customerprofiles.model.ListRuleBasedMatchesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListRuleBasedMatchesIterable responses = client.listRuleBasedMatchesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

Parameters:

listRuleBasedMatchesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listRuleBasedMatchesPaginator

default ListRuleBasedMatchesIterable listRuleBasedMatchesPaginator(Consumer<ListRuleBasedMatchesRequest.Builder> listRuleBasedMatchesRequest)
                                                            throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This is a variant of listRuleBasedMatches(software.amazon.awssdk.services.customerprofiles.model.ListRuleBasedMatchesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListRuleBasedMatchesIterable responses = client.listRuleBasedMatchesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.customerprofiles.paginators.ListRuleBasedMatchesIterable responses = client
             .listRuleBasedMatchesPaginator(request);
     for (software.amazon.awssdk.services.customerprofiles.model.ListRuleBasedMatchesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListRuleBasedMatchesIterable responses = client.listRuleBasedMatchesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

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 custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSegmentDefinitions

default ListSegmentDefinitionsResponse listSegmentDefinitions(ListSegmentDefinitionsRequest listSegmentDefinitionsRequest)
                                                       throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Lists all segment definitions under a domain.

Parameters:

listSegmentDefinitionsRequest -

Returns:

Result of the ListSegmentDefinitions operation returned by the service.

See Also:

• AWS API Documentation

listSegmentDefinitions

default ListSegmentDefinitionsResponse listSegmentDefinitions(Consumer<ListSegmentDefinitionsRequest.Builder> listSegmentDefinitionsRequest)
                                                       throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Lists all segment definitions under a domain.

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

Parameters:

listSegmentDefinitionsRequest - A Consumer that will call methods on ListSegmentDefinitionsRequest.Builder to create a request.

Returns:

Result of the ListSegmentDefinitions operation returned by the service.

See Also:

• AWS API Documentation

listSegmentDefinitionsPaginator

default ListSegmentDefinitionsIterable listSegmentDefinitionsPaginator(ListSegmentDefinitionsRequest listSegmentDefinitionsRequest)
                                                                throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This is a variant of listSegmentDefinitions(software.amazon.awssdk.services.customerprofiles.model.ListSegmentDefinitionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListSegmentDefinitionsIterable responses = client.listSegmentDefinitionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.customerprofiles.paginators.ListSegmentDefinitionsIterable responses = client
             .listSegmentDefinitionsPaginator(request);
     for (software.amazon.awssdk.services.customerprofiles.model.ListSegmentDefinitionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListSegmentDefinitionsIterable responses = client.listSegmentDefinitionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

Parameters:

listSegmentDefinitionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSegmentDefinitionsPaginator

default ListSegmentDefinitionsIterable listSegmentDefinitionsPaginator(Consumer<ListSegmentDefinitionsRequest.Builder> listSegmentDefinitionsRequest)
                                                                throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This is a variant of listSegmentDefinitions(software.amazon.awssdk.services.customerprofiles.model.ListSegmentDefinitionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListSegmentDefinitionsIterable responses = client.listSegmentDefinitionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.customerprofiles.paginators.ListSegmentDefinitionsIterable responses = client
             .listSegmentDefinitionsPaginator(request);
     for (software.amazon.awssdk.services.customerprofiles.model.ListSegmentDefinitionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListSegmentDefinitionsIterable responses = client.listSegmentDefinitionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

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

Parameters:

listSegmentDefinitionsRequest - A Consumer that will call methods on ListSegmentDefinitionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws InternalServerException,
BadRequestException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws InternalServerException,
BadRequestException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listUploadJobs

default ListUploadJobsResponse listUploadJobs(ListUploadJobsRequest listUploadJobsRequest)
                                       throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This API retrieves a list of upload jobs for the specified domain.

Parameters:

listUploadJobsRequest -

Returns:

Result of the ListUploadJobs operation returned by the service.

See Also:

• AWS API Documentation

listUploadJobs

default ListUploadJobsResponse listUploadJobs(Consumer<ListUploadJobsRequest.Builder> listUploadJobsRequest)
                                       throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This API retrieves a list of upload jobs for the specified domain.

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

Parameters:

listUploadJobsRequest - A Consumer that will call methods on ListUploadJobsRequest.Builder to create a request.

Returns:

Result of the ListUploadJobs operation returned by the service.

See Also:

• AWS API Documentation

listUploadJobsPaginator

default ListUploadJobsIterable listUploadJobsPaginator(ListUploadJobsRequest listUploadJobsRequest)
                                                throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This is a variant of listUploadJobs(software.amazon.awssdk.services.customerprofiles.model.ListUploadJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListUploadJobsIterable responses = client.listUploadJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.customerprofiles.paginators.ListUploadJobsIterable responses = client
             .listUploadJobsPaginator(request);
     for (software.amazon.awssdk.services.customerprofiles.model.ListUploadJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListUploadJobsIterable responses = client.listUploadJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

Parameters:

listUploadJobsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listUploadJobsPaginator

default ListUploadJobsIterable listUploadJobsPaginator(Consumer<ListUploadJobsRequest.Builder> listUploadJobsRequest)
                                                throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This is a variant of listUploadJobs(software.amazon.awssdk.services.customerprofiles.model.ListUploadJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListUploadJobsIterable responses = client.listUploadJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.customerprofiles.paginators.ListUploadJobsIterable responses = client
             .listUploadJobsPaginator(request);
     for (software.amazon.awssdk.services.customerprofiles.model.ListUploadJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.customerprofiles.paginators.ListUploadJobsIterable responses = client.listUploadJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

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

Parameters:

listUploadJobsRequest - A Consumer that will call methods on ListUploadJobsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listWorkflows

default ListWorkflowsResponse listWorkflows(ListWorkflowsRequest listWorkflowsRequest)
                                     throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Query to list all workflows.

Parameters:

listWorkflowsRequest -

Returns:

Result of the ListWorkflows operation returned by the service.

See Also:

• AWS API Documentation

listWorkflows

default ListWorkflowsResponse listWorkflows(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest)
                                     throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Query to list all workflows.

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

Parameters:

listWorkflowsRequest - A Consumer that will call methods on ListWorkflowsRequest.Builder to create a request.

Returns:

Result of the ListWorkflows operation returned by the service.

See Also:

• AWS API Documentation

mergeProfiles

default MergeProfilesResponse mergeProfiles(MergeProfilesRequest mergeProfilesRequest)
                                     throws BadRequestException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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:

Result of the MergeProfiles operation returned by the service.

See Also:

• AWS API Documentation

mergeProfiles

default MergeProfilesResponse mergeProfiles(Consumer<MergeProfilesRequest.Builder> mergeProfilesRequest)
                                     throws BadRequestException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Runs an AWS Lambda job that does the following:

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:

Result of the MergeProfiles operation returned by the service.

See Also:

• AWS API Documentation

putDomainObjectType

default PutDomainObjectTypeResponse putDomainObjectType(PutDomainObjectTypeRequest putDomainObjectTypeRequest)
                                                 throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Create/Update a DomainObjectType in a Customer Profiles domain. To create a new DomainObjectType, Data Store needs to be enabled on the Domain.

Parameters:

putDomainObjectTypeRequest -

Returns:

Result of the PutDomainObjectType operation returned by the service.

See Also:

• AWS API Documentation

putDomainObjectType

default PutDomainObjectTypeResponse putDomainObjectType(Consumer<PutDomainObjectTypeRequest.Builder> putDomainObjectTypeRequest)
                                                 throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Create/Update a DomainObjectType in a Customer Profiles domain. To create a new DomainObjectType, Data Store needs to be enabled on the Domain.

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

Parameters:

putDomainObjectTypeRequest - A Consumer that will call methods on PutDomainObjectTypeRequest.Builder to create a request.

Returns:

Result of the PutDomainObjectType operation returned by the service.

See Also:

• AWS API Documentation

putIntegration

default PutIntegrationResponse putIntegration(PutIntegrationRequest putIntegrationRequest)
                                       throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

An integration can belong to only one domain.

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

Parameters:

putIntegrationRequest -

Returns:

Result of the PutIntegration operation returned by the service.

See Also:

• AWS API Documentation

putIntegration

default PutIntegrationResponse putIntegration(Consumer<PutIntegrationRequest.Builder> putIntegrationRequest)
                                       throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

An integration can belong to only one domain.

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

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

Parameters:

putIntegrationRequest - A Consumer that will call methods on PutIntegrationRequest.Builder to create a request.

Returns:

Result of the PutIntegration operation returned by the service.

See Also:

• AWS API Documentation

putProfileObject

default PutProfileObjectResponse putProfileObject(PutProfileObjectRequest putProfileObjectRequest)
                                           throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Adds additional objects to customer profiles of a given ObjectType.

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

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

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

Parameters:

putProfileObjectRequest -

Returns:

Result of the PutProfileObject operation returned by the service.

See Also:

• AWS API Documentation

putProfileObject

default PutProfileObjectResponse putProfileObject(Consumer<PutProfileObjectRequest.Builder> putProfileObjectRequest)
                                           throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Adds additional objects to customer profiles of a given ObjectType.

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

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

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

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

Parameters:

putProfileObjectRequest - A Consumer that will call methods on PutProfileObjectRequest.Builder to create a request.

Returns:

Result of the PutProfileObject operation returned by the service.

See Also:

• AWS API Documentation

putProfileObjectType

default PutProfileObjectTypeResponse putProfileObjectType(PutProfileObjectTypeRequest putProfileObjectTypeRequest)
                                                   throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Defines a ProfileObjectType.

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

Parameters:

putProfileObjectTypeRequest -

Returns:

Result of the PutProfileObjectType operation returned by the service.

See Also:

• AWS API Documentation

putProfileObjectType

default PutProfileObjectTypeResponse putProfileObjectType(Consumer<PutProfileObjectTypeRequest.Builder> putProfileObjectTypeRequest)
                                                   throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Defines a ProfileObjectType.

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

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

Parameters:

putProfileObjectTypeRequest - A Consumer that will call methods on PutProfileObjectTypeRequest.Builder to create a request.

Returns:

Result of the PutProfileObjectType operation returned by the service.

See Also:

• AWS API Documentation

searchProfiles

default SearchProfilesResponse searchProfiles(SearchProfilesRequest searchProfilesRequest)
                                       throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

Result of the SearchProfiles operation returned by the service.

See Also:

• AWS API Documentation

searchProfiles

default SearchProfilesResponse searchProfiles(Consumer<SearchProfilesRequest.Builder> searchProfilesRequest)
                                       throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

Result of the SearchProfiles operation returned by the service.

See Also:

• AWS API Documentation

startRecommender

default StartRecommenderResponse startRecommender(StartRecommenderRequest startRecommenderRequest)
                                           throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Starts a recommender that was previously stopped. Starting a recommender resumes its ability to generate recommendations.

Parameters:

startRecommenderRequest -

Returns:

Result of the StartRecommender operation returned by the service.

See Also:

• AWS API Documentation

startRecommender

default StartRecommenderResponse startRecommender(Consumer<StartRecommenderRequest.Builder> startRecommenderRequest)
                                           throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Starts a recommender that was previously stopped. Starting a recommender resumes its ability to generate recommendations.

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

Parameters:

startRecommenderRequest - A Consumer that will call methods on StartRecommenderRequest.Builder to create a request.

Returns:

Result of the StartRecommender operation returned by the service.

See Also:

• AWS API Documentation

startUploadJob

default StartUploadJobResponse startUploadJob(StartUploadJobRequest startUploadJobRequest)
                                       throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This API starts the processing of an upload job to ingest profile data.

Parameters:

startUploadJobRequest -

Returns:

Result of the StartUploadJob operation returned by the service.

See Also:

• AWS API Documentation

startUploadJob

default StartUploadJobResponse startUploadJob(Consumer<StartUploadJobRequest.Builder> startUploadJobRequest)
                                       throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This API starts the processing of an upload job to ingest profile data.

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

Parameters:

startUploadJobRequest - A Consumer that will call methods on StartUploadJobRequest.Builder to create a request.

Returns:

Result of the StartUploadJob operation returned by the service.

See Also:

• AWS API Documentation

stopRecommender

default StopRecommenderResponse stopRecommender(StopRecommenderRequest stopRecommenderRequest)
                                         throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Stops a recommender, suspending its ability to generate recommendations. The recommender can be restarted later using StartRecommender.

Parameters:

stopRecommenderRequest -

Returns:

Result of the StopRecommender operation returned by the service.

See Also:

• AWS API Documentation

stopRecommender

default StopRecommenderResponse stopRecommender(Consumer<StopRecommenderRequest.Builder> stopRecommenderRequest)
                                         throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Stops a recommender, suspending its ability to generate recommendations. The recommender can be restarted later using StartRecommender.

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

Parameters:

stopRecommenderRequest - A Consumer that will call methods on StopRecommenderRequest.Builder to create a request.

Returns:

Result of the StopRecommender operation returned by the service.

See Also:

• AWS API Documentation

stopUploadJob

default StopUploadJobResponse stopUploadJob(StopUploadJobRequest stopUploadJobRequest)
                                     throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This API stops the processing of an upload job.

Parameters:

stopUploadJobRequest -

Returns:

Result of the StopUploadJob operation returned by the service.

See Also:

• AWS API Documentation

stopUploadJob

default StopUploadJobResponse stopUploadJob(Consumer<StopUploadJobRequest.Builder> stopUploadJobRequest)
                                     throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

This API stops the processing of an upload job.

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

Parameters:

stopUploadJobRequest - A Consumer that will call methods on StopUploadJobRequest.Builder to create a request.

Returns:

Result of the StopUploadJob operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws InternalServerException,
BadRequestException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

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

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

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws InternalServerException,
BadRequestException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

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

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

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

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws InternalServerException,
BadRequestException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws InternalServerException,
BadRequestException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateCalculatedAttributeDefinition

default UpdateCalculatedAttributeDefinitionResponse updateCalculatedAttributeDefinition(UpdateCalculatedAttributeDefinitionRequest updateCalculatedAttributeDefinitionRequest)
                                                                                 throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

Parameters:

updateCalculatedAttributeDefinitionRequest -

Returns:

Result of the UpdateCalculatedAttributeDefinition operation returned by the service.

See Also:

• AWS API Documentation

updateCalculatedAttributeDefinition

default UpdateCalculatedAttributeDefinitionResponse updateCalculatedAttributeDefinition(Consumer<UpdateCalculatedAttributeDefinitionRequest.Builder> updateCalculatedAttributeDefinitionRequest)
                                                                                 throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

Parameters:

updateCalculatedAttributeDefinitionRequest - A Consumer that will call methods on UpdateCalculatedAttributeDefinitionRequest.Builder to create a request.

Returns:

Result of the UpdateCalculatedAttributeDefinition operation returned by the service.

See Also:

• AWS API Documentation

updateDomain

default UpdateDomainResponse updateDomain(UpdateDomainRequest updateDomainRequest)
                                   throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

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

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

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

Parameters:

updateDomainRequest -

Returns:

Result of the UpdateDomain operation returned by the service.

See Also:

• AWS API Documentation

updateDomain

default UpdateDomainResponse updateDomain(Consumer<UpdateDomainRequest.Builder> updateDomainRequest)
                                   throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

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

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

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

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

Parameters:

updateDomainRequest - A Consumer that will call methods on UpdateDomainRequest.Builder to create a request.

Returns:

Result of the UpdateDomain operation returned by the service.

See Also:

• AWS API Documentation

updateDomainLayout

default UpdateDomainLayoutResponse updateDomainLayout(UpdateDomainLayoutRequest updateDomainLayoutRequest)
                                               throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Updates the layout used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

Parameters:

updateDomainLayoutRequest -

Returns:

Result of the UpdateDomainLayout operation returned by the service.

See Also:

• AWS API Documentation

updateDomainLayout

default UpdateDomainLayoutResponse updateDomainLayout(Consumer<UpdateDomainLayoutRequest.Builder> updateDomainLayoutRequest)
                                               throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Updates the layout used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

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

Parameters:

updateDomainLayoutRequest - A Consumer that will call methods on UpdateDomainLayoutRequest.Builder to create a request.

Returns:

Result of the UpdateDomainLayout operation returned by the service.

See Also:

• AWS API Documentation

updateEventTrigger

default UpdateEventTriggerResponse updateEventTrigger(UpdateEventTriggerRequest updateEventTriggerRequest)
                                               throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Update the properties of an Event Trigger.

Parameters:

updateEventTriggerRequest -

Returns:

Result of the UpdateEventTrigger operation returned by the service.

See Also:

• AWS API Documentation

updateEventTrigger

default UpdateEventTriggerResponse updateEventTrigger(Consumer<UpdateEventTriggerRequest.Builder> updateEventTriggerRequest)
                                               throws BadRequestException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Update the properties of an Event Trigger.

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

Parameters:

updateEventTriggerRequest - A Consumer that will call methods on UpdateEventTriggerRequest.Builder to create a request.

Returns:

Result of the UpdateEventTrigger operation returned by the service.

See Also:

• AWS API Documentation

updateProfile

default UpdateProfileResponse updateProfile(UpdateProfileRequest updateProfileRequest)
                                     throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

Parameters:

updateProfileRequest -

Returns:

Result of the UpdateProfile operation returned by the service.

See Also:

• AWS API Documentation

updateProfile

default UpdateProfileResponse updateProfile(Consumer<UpdateProfileRequest.Builder> updateProfileRequest)
                                     throws BadRequestException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

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

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

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

Parameters:

updateProfileRequest - A Consumer that will call methods on UpdateProfileRequest.Builder to create a request.

Returns:

Result of the UpdateProfile operation returned by the service.

See Also:

• AWS API Documentation

updateRecommender

default UpdateRecommenderResponse updateRecommender(UpdateRecommenderRequest updateRecommenderRequest)
                                             throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Updates the properties of an existing recommender, allowing you to modify its configuration and description.

Parameters:

updateRecommenderRequest -

Returns:

Result of the UpdateRecommender operation returned by the service.

See Also:

• AWS API Documentation

updateRecommender

default UpdateRecommenderResponse updateRecommender(Consumer<UpdateRecommenderRequest.Builder> updateRecommenderRequest)
                                             throws ResourceNotFoundException,
InternalServerException,
BadRequestException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CustomerProfilesException

Updates the properties of an existing recommender, allowing you to modify its configuration and description.

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

Parameters:

updateRecommenderRequest - A Consumer that will call methods on UpdateRecommenderRequest.Builder to create a request.

Returns:

Result of the UpdateRecommender operation returned by the service.

See Also:

• AWS API Documentation

create

static CustomerProfilesClient create()

Create a CustomerProfilesClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static CustomerProfilesClientBuilder builder()

Create a builder that can be used to configure and create a CustomerProfilesClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

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