Client: Aws\CustomerProfiles\CustomerProfilesClient

Service ID: customer-profiles

Version: 2020-08-15

This page describes the parameters and results for the operations of the Amazon Connect Customer Profiles (2020-08-15), and shows how to use the Aws\CustomerProfiles\CustomerProfilesClient object to call the described operations. This documentation is specific to the 2020-08-15 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AddProfileKey ( array $params = [] )

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

AssociateStreamForSegments ( array $params = [] )

Associates an Amazon Kinesis data stream to receive segment membership events for a given domain.

BatchGetCalculatedAttributeForProfile ( array $params = [] )

Fetch the possible attribute values given the attribute name.

BatchGetProfile ( array $params = [] )

Get a batch of profiles.

BatchPutProfileObject ( array $params = [] )

Adds multiple profile objects to a domain of a given ObjectType in a single API call.

CreateCalculatedAttributeDefinition ( array $params = [] )

Creates a new calculated attribute definition.

CreateDomain ( array $params = [] )

Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys.

CreateDomainLayout ( array $params = [] )

Creates the layout to view data for a specific domain.

CreateEventStream ( array $params = [] )

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.

CreateEventTrigger ( array $params = [] )

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

CreateIntegrationWorkflow ( array $params = [] )

Creates an integration workflow.

CreateProfile ( array $params = [] )

Creates a standard profile.

CreateRecommender ( array $params = [] )

Creates a recommender

CreateRecommenderFilter ( array $params = [] )

Creates a recommender filter.

CreateRecommenderSchema ( array $params = [] )

Creates a recommender schema.

CreateSegmentDefinition ( array $params = [] )

Creates a segment definition associated to the given domain.

CreateSegmentEstimate ( array $params = [] )

Creates a segment estimate query.

CreateSegmentSnapshot ( array $params = [] )

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

CreateUploadJob ( array $params = [] )

Creates an Upload job to ingest data for segment imports.

DeleteCalculatedAttributeDefinition ( array $params = [] )

Deletes an existing calculated attribute definition.

DeleteDomain ( array $params = [] )

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

DeleteDomainLayout ( array $params = [] )

Deletes the layout used to view data for a specific domain.

DeleteDomainObjectType ( array $params = [] )

Delete a DomainObjectType for the given Domain and ObjectType name.

DeleteEventStream ( array $params = [] )

Disables and deletes the specified event stream.

DeleteEventTrigger ( array $params = [] )

Disable and deletes the Event Trigger.

DeleteIntegration ( array $params = [] )

Removes an integration from a specific domain.

DeleteProfile ( array $params = [] )

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

DeleteProfileKey ( array $params = [] )

Removes a searchable key from a customer profile.

DeleteProfileObject ( array $params = [] )

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

DeleteProfileObjectType ( array $params = [] )

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

DeleteRecommender ( array $params = [] )

Deletes a recommender.

DeleteRecommenderFilter ( array $params = [] )

Deletes a recommender filter from a domain.

DeleteRecommenderSchema ( array $params = [] )

Deletes a recommender schema from a domain.

DeleteSegmentDefinition ( array $params = [] )

Deletes a segment definition from the domain.

DeleteSegmentSubscription ( array $params = [] )

Deletes a segment subscription for membership events.

DeleteWorkflow ( array $params = [] )

Deletes the specified workflow and all its corresponding resources.

DetectProfileObjectType ( array $params = [] )

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

DisassociateStreamForSegments ( array $params = [] )

Disassociates the Amazon Kinesis data stream configured for segment membership events.

GetAutoMergingPreview ( array $params = [] )

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

GetCalculatedAttributeDefinition ( array $params = [] )

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

GetCalculatedAttributeForProfile ( array $params = [] )

Retrieve a calculated attribute for a customer profile.

GetDomain ( array $params = [] )

Returns information about a specific domain.

GetDomainLayout ( array $params = [] )

Gets the layout to view data for a specific domain.

GetDomainObjectType ( array $params = [] )

Return a DomainObjectType for the input Domain and ObjectType names.

GetEventStream ( array $params = [] )

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

GetEventTrigger ( array $params = [] )

Get a specific Event Trigger from the domain.

GetIdentityResolutionJob ( array $params = [] )

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

GetIntegration ( array $params = [] )

Returns an integration for a domain.

GetMatches ( array $params = [] )

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

GetObjectTypeAttributeStatistics ( array $params = [] )

The GetObjectTypeAttributeValues API delivers statistical insights about attributes within a specific object type, but is exclusively available for domains with data store enabled.

GetProfileHistoryRecord ( array $params = [] )

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

GetProfileObjectType ( array $params = [] )

Returns the object types for a specific domain.

GetProfileObjectTypeTemplate ( array $params = [] )

Returns the template information for a specific object type.

GetProfileRecommendations ( array $params = [] )

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

GetRecommender ( array $params = [] )

Retrieves a recommender.

GetRecommenderFilter ( array $params = [] )

Retrieves information about a specific recommender filter in a domain.

GetRecommenderSchema ( array $params = [] )

Retrieves information about a specific recommender schema in a domain.

GetSegmentDefinition ( array $params = [] )

Gets a segment definition from the domain.

GetSegmentEstimate ( array $params = [] )

Gets the result of a segment estimate query.

GetSegmentMembership ( array $params = [] )

Determines if the given profiles are within a segment.

GetSegmentSnapshot ( array $params = [] )

Retrieve the latest status of a segment snapshot.

GetSegmentSubscription ( array $params = [] )

Returns the current subscription configuration, execution schedule, and status for segment membership events.

GetSimilarProfiles ( array $params = [] )

Returns a set of profiles that belong to the same matching group using the matchId or profileId.

GetStreamForSegments ( array $params = [] )

Returns information about the segment membership event stream configured for a specific domain, including the stream state and associated segments.

GetUploadJob ( array $params = [] )

This API retrieves the details of a specific upload job.

GetUploadJobPath ( array $params = [] )

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

GetWorkflow ( array $params = [] )

Get details of specified workflow.

GetWorkflowSteps ( array $params = [] )

Get granular list of steps in workflow.

ListAccountIntegrations ( array $params = [] )

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

ListCalculatedAttributeDefinitions ( array $params = [] )

Lists calculated attribute definitions for Customer Profiles

ListCalculatedAttributesForProfile ( array $params = [] )

Retrieve a list of calculated attributes for a customer profile.

ListDomainLayouts ( array $params = [] )

Lists the existing layouts that can be used to view data for a specific domain.

ListDomainObjectTypes ( array $params = [] )

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

ListDomains ( array $params = [] )

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

ListEventStreams ( array $params = [] )

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

ListEventTriggers ( array $params = [] )

List all Event Triggers under a domain.

ListIdentityResolutionJobs ( array $params = [] )

Lists all of the Identity Resolution Jobs in your domain.

ListIntegrations ( array $params = [] )

Lists all of the integrations in your domain.

ListObjectTypeAttributeValues ( array $params = [] )

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.

ListObjectTypeAttributes ( array $params = [] )

Fetch the possible attribute values given the attribute name.

ListProfileAttributeValues ( array $params = [] )

Fetch the possible attribute values given the attribute name.

ListProfileHistoryRecords ( array $params = [] )

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

ListProfileObjectTypeTemplates ( array $params = [] )

Lists all of the template information for object types.

ListProfileObjectTypes ( array $params = [] )

Lists all of the templates available within the service.

ListProfileObjects ( array $params = [] )

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

ListRecommenderFilters ( array $params = [] )

Returns a list of recommender filters in the specified domain.

ListRecommenderRecipes ( array $params = [] )

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

ListRecommenderSchemas ( array $params = [] )

Returns a list of recommender schemas in the specified domain.

ListRecommenders ( array $params = [] )

Returns a list of recommenders in the specified domain.

ListRuleBasedMatches ( array $params = [] )

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

ListSegmentDefinitions ( array $params = [] )

Lists all segment definitions under a domain.

ListSegmentSubscriptionEvents ( array $params = [] )

Returns the most recent membership events for a segment.

ListTagsForResource ( array $params = [] )

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

ListUploadJobs ( array $params = [] )

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

ListWorkflows ( array $params = [] )

Query to list all workflows.

MergeProfiles ( array $params = [] )

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

PutDomainObjectType ( array $params = [] )

Create/Update a DomainObjectType in a Customer Profiles domain.

PutIntegration ( array $params = [] )

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

PutProfileObject ( array $params = [] )

Adds additional objects to customer profiles of a given ObjectType.

PutProfileObjectType ( array $params = [] )

Defines a ProfileObjectType.

PutSegmentSubscription ( array $params = [] )

Creates or updates a segment subscription for membership events.

SearchProfiles ( array $params = [] )

Searches for profiles within a specific domain using one or more predefined search keys (e.

StartRecommender ( array $params = [] )

Starts a recommender that was previously stopped.

StartUploadJob ( array $params = [] )

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

StopRecommender ( array $params = [] )

Stops a recommender, suspending its ability to generate recommendations.

StopUploadJob ( array $params = [] )

This API stops the processing of an upload job.

TagResource ( array $params = [] )

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

UntagResource ( array $params = [] )

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

UpdateCalculatedAttributeDefinition ( array $params = [] )

Updates an existing calculated attribute definition.

UpdateDomain ( array $params = [] )

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

UpdateDomainLayout ( array $params = [] )

Updates the layout used to view data for a specific domain.

UpdateEventTrigger ( array $params = [] )

Update the properties of an Event Trigger.

UpdateProfile ( array $params = [] )

Updates the properties of a profile.

UpdateRecommender ( array $params = [] )

Updates the properties of an existing recommender, allowing you to modify its configuration and description.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

GetSimilarProfiles

ListDomainLayouts

ListDomainObjectTypes

ListEventStreams

ListEventTriggers

ListObjectTypeAttributes

ListRecommenderFilters

ListRecommenderRecipes

ListRecommenderSchemas

ListRecommenders

ListRuleBasedMatches

ListSegmentDefinitions

ListSegmentSubscriptionEvents

ListUploadJobs

$result = $client->addProfileKey([/* ... */]);
$promise = $client->addProfileKeyAsync([/* ... */]);

$result = $client->addProfileKey([
    'DomainName' => '<string>', // REQUIRED
    'KeyName' => '<string>', // REQUIRED
    'ProfileId' => '<string>', // REQUIRED
    'Values' => ['<string>', ...], // REQUIRED
]);

[
    'KeyName' => '<string>',
    'Values' => ['<string>', ...],
]

$result = $client->associateStreamForSegments([/* ... */]);
$promise = $client->associateStreamForSegmentsAsync([/* ... */]);

$result = $client->associateStreamForSegments([
    'DestinationArn' => '<string>', // REQUIRED
    'DestinationRoleArn' => '<string>', // REQUIRED
    'DomainName' => '<string>', // REQUIRED
]);

[]

$result = $client->batchGetCalculatedAttributeForProfile([/* ... */]);
$promise = $client->batchGetCalculatedAttributeForProfileAsync([/* ... */]);

$result = $client->batchGetCalculatedAttributeForProfile([
    'CalculatedAttributeName' => '<string>', // REQUIRED
    'ConditionOverrides' => [
        'Range' => [
            'End' => <integer>,
            'Start' => <integer>, // REQUIRED
            'Unit' => 'DAYS', // REQUIRED
        ],
    ],
    'DomainName' => '<string>', // REQUIRED
    'ProfileIds' => ['<string>', ...], // REQUIRED
]);