AddProfileKey

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

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

The input you provided is invalid.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

CreateCalculatedAttributeDefinition

$result = $client->createCalculatedAttributeDefinition([/* ... */]);
$promise = $client->createCalculatedAttributeDefinitionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createCalculatedAttributeDefinition([
    'AttributeDetails' => [ // REQUIRED
        'Attributes' => [ // REQUIRED
            [
                'Name' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'Expression' => '<string>', // REQUIRED
    ],
    'CalculatedAttributeName' => '<string>', // REQUIRED
    'Conditions' => [
        'ObjectCount' => <integer>,
        'Range' => [
            'Unit' => 'DAYS', // REQUIRED
            'Value' => <integer>, // REQUIRED
        ],
        'Threshold' => [
            'Operator' => 'EQUAL_TO|GREATER_THAN|LESS_THAN|NOT_EQUAL_TO', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
    ],
    'Description' => '<string>',
    'DisplayName' => '<string>',
    'DomainName' => '<string>', // REQUIRED
    'Statistic' => 'FIRST_OCCURRENCE|LAST_OCCURRENCE|COUNT|SUM|MINIMUM|MAXIMUM|AVERAGE|MAX_OCCURRENCE', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'AttributeDetails' => [
        'Attributes' => [
            [
                'Name' => '<string>',
            ],
            // ...
        ],
        'Expression' => '<string>',
    ],
    'CalculatedAttributeName' => '<string>',
    'Conditions' => [
        'ObjectCount' => <integer>,
        'Range' => [
            'Unit' => 'DAYS',
            'Value' => <integer>,
        ],
        'Threshold' => [
            'Operator' => 'EQUAL_TO|GREATER_THAN|LESS_THAN|NOT_EQUAL_TO',
            'Value' => '<string>',
        ],
    ],
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'DisplayName' => '<string>',
    'LastUpdatedAt' => <DateTime>,
    'Statistic' => 'FIRST_OCCURRENCE|LAST_OCCURRENCE|COUNT|SUM|MINIMUM|MAXIMUM|AVERAGE|MAX_OCCURRENCE',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

CreateDomain

$result = $client->createDomain([/* ... */]);
$promise = $client->createDomainAsync([/* ... */]);

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

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

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

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

Parameter Syntax

$result = $client->createDomain([
    'DeadLetterQueueUrl' => '<string>',
    'DefaultEncryptionKey' => '<string>',
    'DefaultExpirationDays' => <integer>, // REQUIRED
    'DomainName' => '<string>', // REQUIRED
    'Matching' => [
        'AutoMerging' => [
            'ConflictResolution' => [
                'ConflictResolvingModel' => 'RECENCY|SOURCE', // REQUIRED
                'SourceName' => '<string>',
            ],
            'Consolidation' => [
                'MatchingAttributesList' => [ // REQUIRED
                    ['<string>', ...],
                    // ...
                ],
            ],
            'Enabled' => true || false, // REQUIRED
            'MinAllowedConfidenceScoreForMerging' => <float>,
        ],
        'Enabled' => true || false, // REQUIRED
        'ExportingConfig' => [
            'S3Exporting' => [
                'S3BucketName' => '<string>', // REQUIRED
                'S3KeyName' => '<string>',
            ],
        ],
        'JobSchedule' => [
            'DayOfTheWeek' => 'SUNDAY|MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY', // REQUIRED
            'Time' => '<string>', // REQUIRED
        ],
    ],
    'RuleBasedMatching' => [
        'AttributeTypesSelector' => [
            'Address' => ['<string>', ...],
            'AttributeMatchingModel' => 'ONE_TO_ONE|MANY_TO_MANY', // REQUIRED
            'EmailAddress' => ['<string>', ...],
            'PhoneNumber' => ['<string>', ...],
        ],
        'ConflictResolution' => [
            'ConflictResolvingModel' => 'RECENCY|SOURCE', // REQUIRED
            'SourceName' => '<string>',
        ],
        'Enabled' => true || false, // REQUIRED
        'ExportingConfig' => [
            'S3Exporting' => [
                'S3BucketName' => '<string>', // REQUIRED
                'S3KeyName' => '<string>',
            ],
        ],
        'MatchingRules' => [
            [
                'Rule' => ['<string>', ...], // REQUIRED
            ],
            // ...
        ],
        'MaxAllowedRuleLevelForMatching' => <integer>,
        'MaxAllowedRuleLevelForMerging' => <integer>,
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'CreatedAt' => <DateTime>,
    'DeadLetterQueueUrl' => '<string>',
    'DefaultEncryptionKey' => '<string>',
    'DefaultExpirationDays' => <integer>,
    'DomainName' => '<string>',
    'LastUpdatedAt' => <DateTime>,
    'Matching' => [
        'AutoMerging' => [
            'ConflictResolution' => [
                'ConflictResolvingModel' => 'RECENCY|SOURCE',
                'SourceName' => '<string>',
            ],
            'Consolidation' => [
                'MatchingAttributesList' => [
                    ['<string>', ...],
                    // ...
                ],
            ],
            'Enabled' => true || false,
            'MinAllowedConfidenceScoreForMerging' => <float>,
        ],
        'Enabled' => true || false,
        'ExportingConfig' => [
            'S3Exporting' => [
                'S3BucketName' => '<string>',
                'S3KeyName' => '<string>',
            ],
        ],
        'JobSchedule' => [
            'DayOfTheWeek' => 'SUNDAY|MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY',
            'Time' => '<string>',
        ],
    ],
    'RuleBasedMatching' => [
        'AttributeTypesSelector' => [
            'Address' => ['<string>', ...],
            'AttributeMatchingModel' => 'ONE_TO_ONE|MANY_TO_MANY',
            'EmailAddress' => ['<string>', ...],
            'PhoneNumber' => ['<string>', ...],
        ],
        'ConflictResolution' => [
            'ConflictResolvingModel' => 'RECENCY|SOURCE',
            'SourceName' => '<string>',
        ],
        'Enabled' => true || false,
        'ExportingConfig' => [
            'S3Exporting' => [
                'S3BucketName' => '<string>',
                'S3KeyName' => '<string>',
            ],
        ],
        'MatchingRules' => [
            [
                'Rule' => ['<string>', ...],
            ],
            // ...
        ],
        'MaxAllowedRuleLevelForMatching' => <integer>,
        'MaxAllowedRuleLevelForMerging' => <integer>,
        'Status' => 'PENDING|IN_PROGRESS|ACTIVE',
    ],
    'Tags' => ['<string>', ...],
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

CreateEventStream

$result = $client->createEventStream([/* ... */]);
$promise = $client->createEventStreamAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->createEventStream([
    'DomainName' => '<string>', // REQUIRED
    'EventStreamName' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
    'Uri' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EventStreamArn' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

CreateIntegrationWorkflow

$result = $client->createIntegrationWorkflow([/* ... */]);
$promise = $client->createIntegrationWorkflowAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createIntegrationWorkflow([
    'DomainName' => '<string>', // REQUIRED
    'IntegrationConfig' => [ // REQUIRED
        'AppflowIntegration' => [
            'Batches' => [
                [
                    'EndTime' => <integer || string || DateTime>, // REQUIRED
                    'StartTime' => <integer || string || DateTime>, // REQUIRED
                ],
                // ...
            ],
            'FlowDefinition' => [ // REQUIRED
                'Description' => '<string>',
                'FlowName' => '<string>', // REQUIRED
                'KmsArn' => '<string>', // REQUIRED
                'SourceFlowConfig' => [ // REQUIRED
                    'ConnectorProfileName' => '<string>',
                    'ConnectorType' => 'Salesforce|Marketo|Zendesk|Servicenow|S3', // REQUIRED
                    'IncrementalPullConfig' => [
                        'DatetimeTypeFieldName' => '<string>',
                    ],
                    'SourceConnectorProperties' => [ // REQUIRED
                        'Marketo' => [
                            'Object' => '<string>', // REQUIRED
                        ],
                        'S3' => [
                            'BucketName' => '<string>', // REQUIRED
                            'BucketPrefix' => '<string>',
                        ],
                        'Salesforce' => [
                            'EnableDynamicFieldUpdate' => true || false,
                            'IncludeDeletedRecords' => true || false,
                            'Object' => '<string>', // REQUIRED
                        ],
                        'ServiceNow' => [
                            'Object' => '<string>', // REQUIRED
                        ],
                        'Zendesk' => [
                            'Object' => '<string>', // REQUIRED
                        ],
                    ],
                ],
                'Tasks' => [ // REQUIRED
                    [
                        'ConnectorOperator' => [
                            'Marketo' => 'PROJECTION|LESS_THAN|GREATER_THAN|BETWEEN|ADDITION|MULTIPLICATION|DIVISION|SUBTRACTION|MASK_ALL|MASK_FIRST_N|MASK_LAST_N|VALIDATE_NON_NULL|VALIDATE_NON_ZERO|VALIDATE_NON_NEGATIVE|VALIDATE_NUMERIC|NO_OP',
                            'S3' => 'PROJECTION|LESS_THAN|GREATER_THAN|BETWEEN|LESS_THAN_OR_EQUAL_TO|GREATER_THAN_OR_EQUAL_TO|EQUAL_TO|NOT_EQUAL_TO|ADDITION|MULTIPLICATION|DIVISION|SUBTRACTION|MASK_ALL|MASK_FIRST_N|MASK_LAST_N|VALIDATE_NON_NULL|VALIDATE_NON_ZERO|VALIDATE_NON_NEGATIVE|VALIDATE_NUMERIC|NO_OP',
                            'Salesforce' => 'PROJECTION|LESS_THAN|CONTAINS|GREATER_THAN|BETWEEN|LESS_THAN_OR_EQUAL_TO|GREATER_THAN_OR_EQUAL_TO|EQUAL_TO|NOT_EQUAL_TO|ADDITION|MULTIPLICATION|DIVISION|SUBTRACTION|MASK_ALL|MASK_FIRST_N|MASK_LAST_N|VALIDATE_NON_NULL|VALIDATE_NON_ZERO|VALIDATE_NON_NEGATIVE|VALIDATE_NUMERIC|NO_OP',
                            'ServiceNow' => 'PROJECTION|CONTAINS|LESS_THAN|GREATER_THAN|BETWEEN|LESS_THAN_OR_EQUAL_TO|GREATER_THAN_OR_EQUAL_TO|EQUAL_TO|NOT_EQUAL_TO|ADDITION|MULTIPLICATION|DIVISION|SUBTRACTION|MASK_ALL|MASK_FIRST_N|MASK_LAST_N|VALIDATE_NON_NULL|VALIDATE_NON_ZERO|VALIDATE_NON_NEGATIVE|VALIDATE_NUMERIC|NO_OP',
                            'Zendesk' => 'PROJECTION|GREATER_THAN|ADDITION|MULTIPLICATION|DIVISION|SUBTRACTION|MASK_ALL|MASK_FIRST_N|MASK_LAST_N|VALIDATE_NON_NULL|VALIDATE_NON_ZERO|VALIDATE_NON_NEGATIVE|VALIDATE_NUMERIC|NO_OP',
                        ],
                        'DestinationField' => '<string>',
                        'SourceFields' => ['<string>', ...], // REQUIRED
                        'TaskProperties' => ['<string>', ...],
                        'TaskType' => 'Arithmetic|Filter|Map|Mask|Merge|Truncate|Validate', // REQUIRED
                    ],
                    // ...
                ],
                'TriggerConfig' => [ // REQUIRED
                    'TriggerProperties' => [
                        'Scheduled' => [
                            'DataPullMode' => 'Incremental|Complete',
                            'FirstExecutionFrom' => <integer || string || DateTime>,
                            'ScheduleEndTime' => <integer || string || DateTime>,
                            'ScheduleExpression' => '<string>', // REQUIRED
                            'ScheduleOffset' => <integer>,
                            'ScheduleStartTime' => <integer || string || DateTime>,
                            'Timezone' => '<string>',
                        ],
                    ],
                    'TriggerType' => 'Scheduled|Event|OnDemand', // REQUIRED
                ],
            ],
        ],
    ],
    'ObjectTypeName' => '<string>', // REQUIRED
    'RoleArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
    'WorkflowType' => 'APPFLOW_INTEGRATION', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Message' => '<string>',
    'WorkflowId' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

CreateProfile

$result = $client->createProfile([/* ... */]);
$promise = $client->createProfileAsync([/* ... */]);

Creates a standard profile.

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

Parameter Syntax

$result = $client->createProfile([
    'AccountNumber' => '<string>',
    'AdditionalInformation' => '<string>',
    'Address' => [
        'Address1' => '<string>',
        'Address2' => '<string>',
        'Address3' => '<string>',
        'Address4' => '<string>',
        'City' => '<string>',
        'Country' => '<string>',
        'County' => '<string>',
        'PostalCode' => '<string>',
        'Province' => '<string>',
        'State' => '<string>',
    ],
    'Attributes' => ['<string>', ...],
    'BillingAddress' => [
        'Address1' => '<string>',
        'Address2' => '<string>',
        'Address3' => '<string>',
        'Address4' => '<string>',
        'City' => '<string>',
        'Country' => '<string>',
        'County' => '<string>',
        'PostalCode' => '<string>',
        'Province' => '<string>',
        'State' => '<string>',
    ],
    'BirthDate' => '<string>',
    'BusinessEmailAddress' => '<string>',
    'BusinessName' => '<string>',
    'BusinessPhoneNumber' => '<string>',
    'DomainName' => '<string>', // REQUIRED
    'EmailAddress' => '<string>',
    'FirstName' => '<string>',
    'Gender' => 'MALE|FEMALE|UNSPECIFIED',
    'GenderString' => '<string>',
    'HomePhoneNumber' => '<string>',
    'LastName' => '<string>',
    'MailingAddress' => [
        'Address1' => '<string>',
        'Address2' => '<string>',
        'Address3' => '<string>',
        'Address4' => '<string>',
        'City' => '<string>',
        'Country' => '<string>',
        'County' => '<string>',
        'PostalCode' => '<string>',
        'Province' => '<string>',
        'State' => '<string>',
    ],
    'MiddleName' => '<string>',
    'MobilePhoneNumber' => '<string>',
    'PartyType' => 'INDIVIDUAL|BUSINESS|OTHER',
    'PartyTypeString' => '<string>',
    'PersonalEmailAddress' => '<string>',
    'PhoneNumber' => '<string>',
    'ShippingAddress' => [
        'Address1' => '<string>',
        'Address2' => '<string>',
        'Address3' => '<string>',
        'Address4' => '<string>',
        'City' => '<string>',
        'Country' => '<string>',
        'County' => '<string>',
        'PostalCode' => '<string>',
        'Province' => '<string>',
        'State' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'ProfileId' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

DeleteCalculatedAttributeDefinition

$result = $client->deleteCalculatedAttributeDefinition([/* ... */]);
$promise = $client->deleteCalculatedAttributeDefinitionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteCalculatedAttributeDefinition([
    'CalculatedAttributeName' => '<string>', // REQUIRED
    'DomainName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

DeleteDomain

$result = $client->deleteDomain([/* ... */]);
$promise = $client->deleteDomainAsync([/* ... */]);

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Message' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

DeleteEventStream

$result = $client->deleteEventStream([/* ... */]);
$promise = $client->deleteEventStreamAsync([/* ... */]);

Disables and deletes the specified event stream.

Parameter Syntax

$result = $client->deleteEventStream([
    'DomainName' => '<string>', // REQUIRED
    'EventStreamName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

DeleteIntegration

$result = $client->deleteIntegration([/* ... */]);
$promise = $client->deleteIntegrationAsync([/* ... */]);

Removes an integration from a specific domain.

Parameter Syntax

$result = $client->deleteIntegration([
    'DomainName' => '<string>', // REQUIRED
    'Uri' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Message' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

DeleteProfile

$result = $client->deleteProfile([/* ... */]);
$promise = $client->deleteProfileAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteProfile([
    'DomainName' => '<string>', // REQUIRED
    'ProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Message' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

DeleteProfileKey

$result = $client->deleteProfileKey([/* ... */]);
$promise = $client->deleteProfileKeyAsync([/* ... */]);

Removes a searchable key from a customer profile.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Message' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

DeleteProfileObject

$result = $client->deleteProfileObject([/* ... */]);
$promise = $client->deleteProfileObjectAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteProfileObject([
    'DomainName' => '<string>', // REQUIRED
    'ObjectTypeName' => '<string>', // REQUIRED
    'ProfileId' => '<string>', // REQUIRED
    'ProfileObjectUniqueKey' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Message' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

DeleteProfileObjectType

$result = $client->deleteProfileObjectType([/* ... */]);
$promise = $client->deleteProfileObjectTypeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteProfileObjectType([
    'DomainName' => '<string>', // REQUIRED
    'ObjectTypeName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Message' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

DeleteWorkflow

$result = $client->deleteWorkflow([/* ... */]);
$promise = $client->deleteWorkflowAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteWorkflow([
    'DomainName' => '<string>', // REQUIRED
    'WorkflowId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

DetectProfileObjectType

$result = $client->detectProfileObjectType([/* ... */]);
$promise = $client->detectProfileObjectTypeAsync([/* ... */]);

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

Parameter Syntax

$result = $client->detectProfileObjectType([
    'DomainName' => '<string>', // REQUIRED
    'Objects' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DetectedProfileObjectTypes' => [
        [
            'Fields' => [
                '<name>' => [
                    'ContentType' => 'STRING|NUMBER|PHONE_NUMBER|EMAIL_ADDRESS|NAME',
                    'Source' => '<string>',
                    'Target' => '<string>',
                ],
                // ...
            ],
            'Keys' => [
                '<name>' => [
                    [
                        'FieldNames' => ['<string>', ...],
                        'StandardIdentifiers' => ['<string>', ...],
                    ],
                    // ...
                ],
                // ...
            ],
            'SourceLastUpdatedTimestampFormat' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

GetAutoMergingPreview

$result = $client->getAutoMergingPreview([/* ... */]);
$promise = $client->getAutoMergingPreviewAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getAutoMergingPreview([
    'ConflictResolution' => [ // REQUIRED
        'ConflictResolvingModel' => 'RECENCY|SOURCE', // REQUIRED
        'SourceName' => '<string>',
    ],
    'Consolidation' => [ // REQUIRED
        'MatchingAttributesList' => [ // REQUIRED
            ['<string>', ...],
            // ...
        ],
    ],
    'DomainName' => '<string>', // REQUIRED
    'MinAllowedConfidenceScoreForMerging' => <float>,
]);

Parameter Details

Result Syntax

[
    'DomainName' => '<string>',
    'NumberOfMatchesInSample' => <integer>,
    'NumberOfProfilesInSample' => <integer>,
    'NumberOfProfilesWillBeMerged' => <integer>,
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

GetCalculatedAttributeDefinition

$result = $client->getCalculatedAttributeDefinition([/* ... */]);
$promise = $client->getCalculatedAttributeDefinitionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getCalculatedAttributeDefinition([
    'CalculatedAttributeName' => '<string>', // REQUIRED
    'DomainName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AttributeDetails' => [
        'Attributes' => [
            [
                'Name' => '<string>',
            ],
            // ...
        ],
        'Expression' => '<string>',
    ],
    'CalculatedAttributeName' => '<string>',
    'Conditions' => [
        'ObjectCount' => <integer>,
        'Range' => [
            'Unit' => 'DAYS',
            'Value' => <integer>,
        ],
        'Threshold' => [
            'Operator' => 'EQUAL_TO|GREATER_THAN|LESS_THAN|NOT_EQUAL_TO',
            'Value' => '<string>',
        ],
    ],
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'DisplayName' => '<string>',
    'LastUpdatedAt' => <DateTime>,
    'Statistic' => 'FIRST_OCCURRENCE|LAST_OCCURRENCE|COUNT|SUM|MINIMUM|MAXIMUM|AVERAGE|MAX_OCCURRENCE',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

GetCalculatedAttributeForProfile

$result = $client->getCalculatedAttributeForProfile([/* ... */]);
$promise = $client->getCalculatedAttributeForProfileAsync([/* ... */]);

Retrieve a calculated attribute for a customer profile.

Parameter Syntax

$result = $client->getCalculatedAttributeForProfile([
    'CalculatedAttributeName' => '<string>', // REQUIRED
    'DomainName' => '<string>', // REQUIRED
    'ProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CalculatedAttributeName' => '<string>',
    'DisplayName' => '<string>',
    'IsDataPartial' => '<string>',
    'Value' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

GetDomain

$result = $client->getDomain([/* ... */]);
$promise = $client->getDomainAsync([/* ... */]);

Returns information about a specific domain.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CreatedAt' => <DateTime>,
    'DeadLetterQueueUrl' => '<string>',
    'DefaultEncryptionKey' => '<string>',
    'DefaultExpirationDays' => <integer>,
    'DomainName' => '<string>',
    'LastUpdatedAt' => <DateTime>,
    'Matching' => [
        'AutoMerging' => [
            'ConflictResolution' => [
                'ConflictResolvingModel' => 'RECENCY|SOURCE',
                'SourceName' => '<string>',
            ],
            'Consolidation' => [
                'MatchingAttributesList' => [
                    ['<string>', ...],
                    // ...
                ],
            ],
            'Enabled' => true || false,
            'MinAllowedConfidenceScoreForMerging' => <float>,
        ],
        'Enabled' => true || false,
        'ExportingConfig' => [
            'S3Exporting' => [
                'S3BucketName' => '<string>',
                'S3KeyName' => '<string>',
            ],
        ],
        'JobSchedule' => [
            'DayOfTheWeek' => 'SUNDAY|MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY',
            'Time' => '<string>',
        ],
    ],
    'RuleBasedMatching' => [
        'AttributeTypesSelector' => [
            'Address' => ['<string>', ...],
            'AttributeMatchingModel' => 'ONE_TO_ONE|MANY_TO_MANY',
            'EmailAddress' => ['<string>', ...],
            'PhoneNumber' => ['<string>', ...],
        ],
        'ConflictResolution' => [
            'ConflictResolvingModel' => 'RECENCY|SOURCE',
            'SourceName' => '<string>',
        ],
        'Enabled' => true || false,
        'ExportingConfig' => [
            'S3Exporting' => [
                'S3BucketName' => '<string>',
                'S3KeyName' => '<string>',
            ],
        ],
        'MatchingRules' => [
            [
                'Rule' => ['<string>', ...],
            ],
            // ...
        ],
        'MaxAllowedRuleLevelForMatching' => <integer>,
        'MaxAllowedRuleLevelForMerging' => <integer>,
        'Status' => 'PENDING|IN_PROGRESS|ACTIVE',
    ],
    'Stats' => [
        'MeteringProfileCount' => <integer>,
        'ObjectCount' => <integer>,
        'ProfileCount' => <integer>,
        'TotalSize' => <integer>,
    ],
    'Tags' => ['<string>', ...],
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

GetEventStream

$result = $client->getEventStream([/* ... */]);
$promise = $client->getEventStreamAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getEventStream([
    'DomainName' => '<string>', // REQUIRED
    'EventStreamName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CreatedAt' => <DateTime>,
    'DestinationDetails' => [
        'Message' => '<string>',
        'Status' => 'HEALTHY|UNHEALTHY',
        'UnhealthySince' => <DateTime>,
        'Uri' => '<string>',
    ],
    'DomainName' => '<string>',
    'EventStreamArn' => '<string>',
    'State' => 'RUNNING|STOPPED',
    'StoppedSince' => <DateTime>,
    'Tags' => ['<string>', ...],
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

GetIdentityResolutionJob

$result = $client->getIdentityResolutionJob([/* ... */]);
$promise = $client->getIdentityResolutionJobAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getIdentityResolutionJob([
    'DomainName' => '<string>', // REQUIRED
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AutoMerging' => [
        'ConflictResolution' => [
            'ConflictResolvingModel' => 'RECENCY|SOURCE',
            'SourceName' => '<string>',
        ],
        'Consolidation' => [
            'MatchingAttributesList' => [
                ['<string>', ...],
                // ...
            ],
        ],
        'Enabled' => true || false,
        'MinAllowedConfidenceScoreForMerging' => <float>,
    ],
    'DomainName' => '<string>',
    'ExportingLocation' => [
        'S3Exporting' => [
            'S3BucketName' => '<string>',
            'S3KeyName' => '<string>',
        ],
    ],
    'JobEndTime' => <DateTime>,
    'JobExpirationTime' => <DateTime>,
    'JobId' => '<string>',
    'JobStartTime' => <DateTime>,
    'JobStats' => [
        'NumberOfMatchesFound' => <integer>,
        'NumberOfMergesDone' => <integer>,
        'NumberOfProfilesReviewed' => <integer>,
    ],
    'LastUpdatedAt' => <DateTime>,
    'Message' => '<string>',
    'Status' => 'PENDING|PREPROCESSING|FIND_MATCHING|MERGING|COMPLETED|PARTIAL_SUCCESS|FAILED',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

GetIntegration

$result = $client->getIntegration([/* ... */]);
$promise = $client->getIntegrationAsync([/* ... */]);

Returns an integration for a domain.

Parameter Syntax

$result = $client->getIntegration([
    'DomainName' => '<string>', // REQUIRED
    'Uri' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CreatedAt' => <DateTime>,
    'DomainName' => '<string>',
    'IsUnstructured' => true || false,
    'LastUpdatedAt' => <DateTime>,
    'ObjectTypeName' => '<string>',
    'ObjectTypeNames' => ['<string>', ...],
    'Tags' => ['<string>', ...],
    'Uri' => '<string>',
    'WorkflowId' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

GetMatches

$result = $client->getMatches([/* ... */]);
$promise = $client->getMatchesAsync([/* ... */]);

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

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

Amazon Connect 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.

Parameter Syntax

$result = $client->getMatches([
    'DomainName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'MatchGenerationDate' => <DateTime>,
    'Matches' => [
        [
            'ConfidenceScore' => <float>,
            'MatchId' => '<string>',
            'ProfileIds' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'PotentialMatches' => <integer>,
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

GetProfileObjectType

$result = $client->getProfileObjectType([/* ... */]);
$promise = $client->getProfileObjectTypeAsync([/* ... */]);

Returns the object types for a specific domain.

Parameter Syntax

$result = $client->getProfileObjectType([
    'DomainName' => '<string>', // REQUIRED
    'ObjectTypeName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AllowProfileCreation' => true || false,
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'EncryptionKey' => '<string>',
    'ExpirationDays' => <integer>,
    'Fields' => [
        '<name>' => [
            'ContentType' => 'STRING|NUMBER|PHONE_NUMBER|EMAIL_ADDRESS|NAME',
            'Source' => '<string>',
            'Target' => '<string>',
        ],
        // ...
    ],
    'Keys' => [
        '<name>' => [
            [
                'FieldNames' => ['<string>', ...],
                'StandardIdentifiers' => ['<string>', ...],
            ],
            // ...
        ],
        // ...
    ],
    'LastUpdatedAt' => <DateTime>,
    'ObjectTypeName' => '<string>',
    'SourceLastUpdatedTimestampFormat' => '<string>',
    'Tags' => ['<string>', ...],
    'TemplateId' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

GetProfileObjectTypeTemplate

$result = $client->getProfileObjectTypeTemplate([/* ... */]);
$promise = $client->getProfileObjectTypeTemplateAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getProfileObjectTypeTemplate([
    'TemplateId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AllowProfileCreation' => true || false,
    'Fields' => [
        '<name>' => [
            'ContentType' => 'STRING|NUMBER|PHONE_NUMBER|EMAIL_ADDRESS|NAME',
            'Source' => '<string>',
            'Target' => '<string>',
        ],
        // ...
    ],
    'Keys' => [
        '<name>' => [
            [
                'FieldNames' => ['<string>', ...],
                'StandardIdentifiers' => ['<string>', ...],
            ],
            // ...
        ],
        // ...
    ],
    'SourceLastUpdatedTimestampFormat' => '<string>',
    'SourceName' => '<string>',
    'SourceObject' => '<string>',
    'TemplateId' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

GetSimilarProfiles

$result = $client->getSimilarProfiles([/* ... */]);
$promise = $client->getSimilarProfilesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getSimilarProfiles([
    'DomainName' => '<string>', // REQUIRED
    'MatchType' => 'RULE_BASED_MATCHING|ML_BASED_MATCHING', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SearchKey' => '<string>', // REQUIRED
    'SearchValue' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ConfidenceScore' => <float>,
    'MatchId' => '<string>',
    'MatchType' => 'RULE_BASED_MATCHING|ML_BASED_MATCHING',
    'NextToken' => '<string>',
    'ProfileIds' => ['<string>', ...],
    'RuleLevel' => <integer>,
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

GetWorkflow

$result = $client->getWorkflow([/* ... */]);
$promise = $client->getWorkflowAsync([/* ... */]);

Get details of specified workflow.

Parameter Syntax

$result = $client->getWorkflow([
    'DomainName' => '<string>', // REQUIRED
    'WorkflowId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Attributes' => [
        'AppflowIntegration' => [
            'ConnectorProfileName' => '<string>',
            'RoleArn' => '<string>',
            'SourceConnectorType' => 'Salesforce|Marketo|Zendesk|Servicenow|S3',
        ],
    ],
    'ErrorDescription' => '<string>',
    'LastUpdatedAt' => <DateTime>,
    'Metrics' => [
        'AppflowIntegration' => [
            'RecordsProcessed' => <integer>,
            'StepsCompleted' => <integer>,
            'TotalSteps' => <integer>,
        ],
    ],
    'StartDate' => <DateTime>,
    'Status' => 'NOT_STARTED|IN_PROGRESS|COMPLETE|FAILED|SPLIT|RETRY|CANCELLED',
    'WorkflowId' => '<string>',
    'WorkflowType' => 'APPFLOW_INTEGRATION',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

GetWorkflowSteps

$result = $client->getWorkflowSteps([/* ... */]);
$promise = $client->getWorkflowStepsAsync([/* ... */]);

Get granular list of steps in workflow.

Parameter Syntax

$result = $client->getWorkflowSteps([
    'DomainName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'WorkflowId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'AppflowIntegration' => [
                'BatchRecordsEndTime' => '<string>',
                'BatchRecordsStartTime' => '<string>',
                'CreatedAt' => <DateTime>,
                'ExecutionMessage' => '<string>',
                'FlowName' => '<string>',
                'LastUpdatedAt' => <DateTime>,
                'RecordsProcessed' => <integer>,
                'Status' => 'NOT_STARTED|IN_PROGRESS|COMPLETE|FAILED|SPLIT|RETRY|CANCELLED',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'WorkflowId' => '<string>',
    'WorkflowType' => 'APPFLOW_INTEGRATION',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

ListAccountIntegrations

$result = $client->listAccountIntegrations([/* ... */]);
$promise = $client->listAccountIntegrationsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listAccountIntegrations([
    'IncludeHidden' => true || false,
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Uri' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'CreatedAt' => <DateTime>,
            'DomainName' => '<string>',
            'IsUnstructured' => true || false,
            'LastUpdatedAt' => <DateTime>,
            'ObjectTypeName' => '<string>',
            'ObjectTypeNames' => ['<string>', ...],
            'Tags' => ['<string>', ...],
            'Uri' => '<string>',
            'WorkflowId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

ListCalculatedAttributeDefinitions

$result = $client->listCalculatedAttributeDefinitions([/* ... */]);
$promise = $client->listCalculatedAttributeDefinitionsAsync([/* ... */]);

Lists calculated attribute definitions for Customer Profiles

Parameter Syntax

$result = $client->listCalculatedAttributeDefinitions([
    'DomainName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'CalculatedAttributeName' => '<string>',
            'CreatedAt' => <DateTime>,
            'Description' => '<string>',
            'DisplayName' => '<string>',
            'LastUpdatedAt' => <DateTime>,
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

ListCalculatedAttributesForProfile

$result = $client->listCalculatedAttributesForProfile([/* ... */]);
$promise = $client->listCalculatedAttributesForProfileAsync([/* ... */]);

Retrieve a list of calculated attributes for a customer profile.

Parameter Syntax

$result = $client->listCalculatedAttributesForProfile([
    'DomainName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'CalculatedAttributeName' => '<string>',
            'DisplayName' => '<string>',
            'IsDataPartial' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

ListDomains

$result = $client->listDomains([/* ... */]);
$promise = $client->listDomainsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listDomains([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'CreatedAt' => <DateTime>,
            'DomainName' => '<string>',
            'LastUpdatedAt' => <DateTime>,
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

ListEventStreams

$result = $client->listEventStreams([/* ... */]);
$promise = $client->listEventStreamsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listEventStreams([
    'DomainName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'DestinationSummary' => [
                'Status' => 'HEALTHY|UNHEALTHY',
                'UnhealthySince' => <DateTime>,
                'Uri' => '<string>',
            ],
            'DomainName' => '<string>',
            'EventStreamArn' => '<string>',
            'EventStreamName' => '<string>',
            'State' => 'RUNNING|STOPPED',
            'StoppedSince' => <DateTime>,
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

ListIdentityResolutionJobs

$result = $client->listIdentityResolutionJobs([/* ... */]);
$promise = $client->listIdentityResolutionJobsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listIdentityResolutionJobs([
    'DomainName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'IdentityResolutionJobsList' => [
        [
            'DomainName' => '<string>',
            'ExportingLocation' => [
                'S3Exporting' => [
                    'S3BucketName' => '<string>',
                    'S3KeyName' => '<string>',
                ],
            ],
            'JobEndTime' => <DateTime>,
            'JobId' => '<string>',
            'JobStartTime' => <DateTime>,
            'JobStats' => [
                'NumberOfMatchesFound' => <integer>,
                'NumberOfMergesDone' => <integer>,
                'NumberOfProfilesReviewed' => <integer>,
            ],
            'Message' => '<string>',
            'Status' => 'PENDING|PREPROCESSING|FIND_MATCHING|MERGING|COMPLETED|PARTIAL_SUCCESS|FAILED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

ListIntegrations

$result = $client->listIntegrations([/* ... */]);
$promise = $client->listIntegrationsAsync([/* ... */]);

Lists all of the integrations in your domain.

Parameter Syntax

$result = $client->listIntegrations([
    'DomainName' => '<string>', // REQUIRED
    'IncludeHidden' => true || false,
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'CreatedAt' => <DateTime>,
            'DomainName' => '<string>',
            'IsUnstructured' => true || false,
            'LastUpdatedAt' => <DateTime>,
            'ObjectTypeName' => '<string>',
            'ObjectTypeNames' => ['<string>', ...],
            'Tags' => ['<string>', ...],
            'Uri' => '<string>',
            'WorkflowId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

ListProfileObjectTypeTemplates

$result = $client->listProfileObjectTypeTemplates([/* ... */]);
$promise = $client->listProfileObjectTypeTemplatesAsync([/* ... */]);

Lists all of the template information for object types.

Parameter Syntax

$result = $client->listProfileObjectTypeTemplates([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'SourceName' => '<string>',
            'SourceObject' => '<string>',
            'TemplateId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

ListProfileObjectTypes

$result = $client->listProfileObjectTypes([/* ... */]);
$promise = $client->listProfileObjectTypesAsync([/* ... */]);

Lists all of the templates available within the service.

Parameter Syntax

$result = $client->listProfileObjectTypes([
    'DomainName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'CreatedAt' => <DateTime>,
            'Description' => '<string>',
            'LastUpdatedAt' => <DateTime>,
            'ObjectTypeName' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

ListProfileObjects

$result = $client->listProfileObjects([/* ... */]);
$promise = $client->listProfileObjectsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listProfileObjects([
    'DomainName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ObjectFilter' => [
        'KeyName' => '<string>', // REQUIRED
        'Values' => ['<string>', ...], // REQUIRED
    ],
    'ObjectTypeName' => '<string>', // REQUIRED
    'ProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'Object' => '<string>',
            'ObjectTypeName' => '<string>',
            'ProfileObjectUniqueKey' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

ListRuleBasedMatches

$result = $client->listRuleBasedMatches([/* ... */]);
$promise = $client->listRuleBasedMatchesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listRuleBasedMatches([
    'DomainName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'MatchIds' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

An internal service error occurred.

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

ListWorkflows

$result = $client->listWorkflows([/* ... */]);
$promise = $client->listWorkflowsAsync([/* ... */]);

Query to list all workflows.

Parameter Syntax

$result = $client->listWorkflows([
    'DomainName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'QueryEndDate' => <integer || string || DateTime>,
    'QueryStartDate' => <integer || string || DateTime>,
    'Status' => 'NOT_STARTED|IN_PROGRESS|COMPLETE|FAILED|SPLIT|RETRY|CANCELLED',
    'WorkflowType' => 'APPFLOW_INTEGRATION',
]);

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'CreatedAt' => <DateTime>,
            'LastUpdatedAt' => <DateTime>,
            'Status' => 'NOT_STARTED|IN_PROGRESS|COMPLETE|FAILED|SPLIT|RETRY|CANCELLED',
            'StatusDescription' => '<string>',
            'WorkflowId' => '<string>',
            'WorkflowType' => 'APPFLOW_INTEGRATION',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

MergeProfiles

$result = $client->mergeProfiles([/* ... */]);
$promise = $client->mergeProfilesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->mergeProfiles([
    'DomainName' => '<string>', // REQUIRED
    'FieldSourceProfileIds' => [
        'AccountNumber' => '<string>',
        'AdditionalInformation' => '<string>',
        'Address' => '<string>',
        'Attributes' => ['<string>', ...],
        'BillingAddress' => '<string>',
        'BirthDate' => '<string>',
        'BusinessEmailAddress' => '<string>',
        'BusinessName' => '<string>',
        'BusinessPhoneNumber' => '<string>',
        'EmailAddress' => '<string>',
        'FirstName' => '<string>',
        'Gender' => '<string>',
        'HomePhoneNumber' => '<string>',
        'LastName' => '<string>',
        'MailingAddress' => '<string>',
        'MiddleName' => '<string>',
        'MobilePhoneNumber' => '<string>',
        'PartyType' => '<string>',
        'PersonalEmailAddress' => '<string>',
        'PhoneNumber' => '<string>',
        'ShippingAddress' => '<string>',
    ],
    'MainProfileId' => '<string>', // REQUIRED
    'ProfileIdsToBeMerged' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Message' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

PutIntegration

$result = $client->putIntegration([/* ... */]);
$promise = $client->putIntegrationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putIntegration([
    'DomainName' => '<string>', // REQUIRED
    'FlowDefinition' => [
        'Description' => '<string>',
        'FlowName' => '<string>', // REQUIRED
        'KmsArn' => '<string>', // REQUIRED
        'SourceFlowConfig' => [ // REQUIRED
            'ConnectorProfileName' => '<string>',
            'ConnectorType' => 'Salesforce|Marketo|Zendesk|Servicenow|S3', // REQUIRED
            'IncrementalPullConfig' => [
                'DatetimeTypeFieldName' => '<string>',
            ],
            'SourceConnectorProperties' => [ // REQUIRED
                'Marketo' => [
                    'Object' => '<string>', // REQUIRED
                ],
                'S3' => [
                    'BucketName' => '<string>', // REQUIRED
                    'BucketPrefix' => '<string>',
                ],
                'Salesforce' => [
                    'EnableDynamicFieldUpdate' => true || false,
                    'IncludeDeletedRecords' => true || false,
                    'Object' => '<string>', // REQUIRED
                ],
                'ServiceNow' => [
                    'Object' => '<string>', // REQUIRED
                ],
                'Zendesk' => [
                    'Object' => '<string>', // REQUIRED
                ],
            ],
        ],
        'Tasks' => [ // REQUIRED
            [
                'ConnectorOperator' => [
                    'Marketo' => 'PROJECTION|LESS_THAN|GREATER_THAN|BETWEEN|ADDITION|MULTIPLICATION|DIVISION|SUBTRACTION|MASK_ALL|MASK_FIRST_N|MASK_LAST_N|VALIDATE_NON_NULL|VALIDATE_NON_ZERO|VALIDATE_NON_NEGATIVE|VALIDATE_NUMERIC|NO_OP',
                    'S3' => 'PROJECTION|LESS_THAN|GREATER_THAN|BETWEEN|LESS_THAN_OR_EQUAL_TO|GREATER_THAN_OR_EQUAL_TO|EQUAL_TO|NOT_EQUAL_TO|ADDITION|MULTIPLICATION|DIVISION|SUBTRACTION|MASK_ALL|MASK_FIRST_N|MASK_LAST_N|VALIDATE_NON_NULL|VALIDATE_NON_ZERO|VALIDATE_NON_NEGATIVE|VALIDATE_NUMERIC|NO_OP',
                    'Salesforce' => 'PROJECTION|LESS_THAN|CONTAINS|GREATER_THAN|BETWEEN|LESS_THAN_OR_EQUAL_TO|GREATER_THAN_OR_EQUAL_TO|EQUAL_TO|NOT_EQUAL_TO|ADDITION|MULTIPLICATION|DIVISION|SUBTRACTION|MASK_ALL|MASK_FIRST_N|MASK_LAST_N|VALIDATE_NON_NULL|VALIDATE_NON_ZERO|VALIDATE_NON_NEGATIVE|VALIDATE_NUMERIC|NO_OP',
                    'ServiceNow' => 'PROJECTION|CONTAINS|LESS_THAN|GREATER_THAN|BETWEEN|LESS_THAN_OR_EQUAL_TO|GREATER_THAN_OR_EQUAL_TO|EQUAL_TO|NOT_EQUAL_TO|ADDITION|MULTIPLICATION|DIVISION|SUBTRACTION|MASK_ALL|MASK_FIRST_N|MASK_LAST_N|VALIDATE_NON_NULL|VALIDATE_NON_ZERO|VALIDATE_NON_NEGATIVE|VALIDATE_NUMERIC|NO_OP',
                    'Zendesk' => 'PROJECTION|GREATER_THAN|ADDITION|MULTIPLICATION|DIVISION|SUBTRACTION|MASK_ALL|MASK_FIRST_N|MASK_LAST_N|VALIDATE_NON_NULL|VALIDATE_NON_ZERO|VALIDATE_NON_NEGATIVE|VALIDATE_NUMERIC|NO_OP',
                ],
                'DestinationField' => '<string>',
                'SourceFields' => ['<string>', ...], // REQUIRED
                'TaskProperties' => ['<string>', ...],
                'TaskType' => 'Arithmetic|Filter|Map|Mask|Merge|Truncate|Validate', // REQUIRED
            ],
            // ...
        ],
        'TriggerConfig' => [ // REQUIRED
            'TriggerProperties' => [
                'Scheduled' => [
                    'DataPullMode' => 'Incremental|Complete',
                    'FirstExecutionFrom' => <integer || string || DateTime>,
                    'ScheduleEndTime' => <integer || string || DateTime>,
                    'ScheduleExpression' => '<string>', // REQUIRED
                    'ScheduleOffset' => <integer>,
                    'ScheduleStartTime' => <integer || string || DateTime>,
                    'Timezone' => '<string>',
                ],
            ],
            'TriggerType' => 'Scheduled|Event|OnDemand', // REQUIRED
        ],
    ],
    'ObjectTypeName' => '<string>',
    'ObjectTypeNames' => ['<string>', ...],
    'Tags' => ['<string>', ...],
    'Uri' => '<string>',
]);

Parameter Details

Result Syntax

[
    'CreatedAt' => <DateTime>,
    'DomainName' => '<string>',
    'IsUnstructured' => true || false,
    'LastUpdatedAt' => <DateTime>,
    'ObjectTypeName' => '<string>',
    'ObjectTypeNames' => ['<string>', ...],
    'Tags' => ['<string>', ...],
    'Uri' => '<string>',
    'WorkflowId' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

PutProfileObject

$result = $client->putProfileObject([/* ... */]);
$promise = $client->putProfileObjectAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putProfileObject([
    'DomainName' => '<string>', // REQUIRED
    'Object' => '<string>', // REQUIRED
    'ObjectTypeName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ProfileObjectUniqueKey' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

PutProfileObjectType

$result = $client->putProfileObjectType([/* ... */]);
$promise = $client->putProfileObjectTypeAsync([/* ... */]);

Defines a ProfileObjectType.

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

Parameter Syntax

$result = $client->putProfileObjectType([
    'AllowProfileCreation' => true || false,
    'Description' => '<string>', // REQUIRED
    'DomainName' => '<string>', // REQUIRED
    'EncryptionKey' => '<string>',
    'ExpirationDays' => <integer>,
    'Fields' => [
        '<name>' => [
            'ContentType' => 'STRING|NUMBER|PHONE_NUMBER|EMAIL_ADDRESS|NAME',
            'Source' => '<string>',
            'Target' => '<string>',
        ],
        // ...
    ],
    'Keys' => [
        '<name>' => [
            [
                'FieldNames' => ['<string>', ...],
                'StandardIdentifiers' => ['<string>', ...],
            ],
            // ...
        ],
        // ...
    ],
    'ObjectTypeName' => '<string>', // REQUIRED
    'SourceLastUpdatedTimestampFormat' => '<string>',
    'Tags' => ['<string>', ...],
    'TemplateId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AllowProfileCreation' => true || false,
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'EncryptionKey' => '<string>',
    'ExpirationDays' => <integer>,
    'Fields' => [
        '<name>' => [
            'ContentType' => 'STRING|NUMBER|PHONE_NUMBER|EMAIL_ADDRESS|NAME',
            'Source' => '<string>',
            'Target' => '<string>',
        ],
        // ...
    ],
    'Keys' => [
        '<name>' => [
            [
                'FieldNames' => ['<string>', ...],
                'StandardIdentifiers' => ['<string>', ...],
            ],
            // ...
        ],
        // ...
    ],
    'LastUpdatedAt' => <DateTime>,
    'ObjectTypeName' => '<string>',
    'SourceLastUpdatedTimestampFormat' => '<string>',
    'Tags' => ['<string>', ...],
    'TemplateId' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

SearchProfiles

$result = $client->searchProfiles([/* ... */]);
$promise = $client->searchProfilesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->searchProfiles([
    'AdditionalSearchKeys' => [
        [
            'KeyName' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'DomainName' => '<string>', // REQUIRED
    'KeyName' => '<string>', // REQUIRED
    'LogicalOperator' => 'AND|OR',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Values' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'AccountNumber' => '<string>',
            'AdditionalInformation' => '<string>',
            'Address' => [
                'Address1' => '<string>',
                'Address2' => '<string>',
                'Address3' => '<string>',
                'Address4' => '<string>',
                'City' => '<string>',
                'Country' => '<string>',
                'County' => '<string>',
                'PostalCode' => '<string>',
                'Province' => '<string>',
                'State' => '<string>',
            ],
            'Attributes' => ['<string>', ...],
            'BillingAddress' => [
                'Address1' => '<string>',
                'Address2' => '<string>',
                'Address3' => '<string>',
                'Address4' => '<string>',
                'City' => '<string>',
                'Country' => '<string>',
                'County' => '<string>',
                'PostalCode' => '<string>',
                'Province' => '<string>',
                'State' => '<string>',
            ],
            'BirthDate' => '<string>',
            'BusinessEmailAddress' => '<string>',
            'BusinessName' => '<string>',
            'BusinessPhoneNumber' => '<string>',
            'EmailAddress' => '<string>',
            'FirstName' => '<string>',
            'FoundByItems' => [
                [
                    'KeyName' => '<string>',
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
            'Gender' => 'MALE|FEMALE|UNSPECIFIED',
            'GenderString' => '<string>',
            'HomePhoneNumber' => '<string>',
            'LastName' => '<string>',
            'MailingAddress' => [
                'Address1' => '<string>',
                'Address2' => '<string>',
                'Address3' => '<string>',
                'Address4' => '<string>',
                'City' => '<string>',
                'Country' => '<string>',
                'County' => '<string>',
                'PostalCode' => '<string>',
                'Province' => '<string>',
                'State' => '<string>',
            ],
            'MiddleName' => '<string>',
            'MobilePhoneNumber' => '<string>',
            'PartyType' => 'INDIVIDUAL|BUSINESS|OTHER',
            'PartyTypeString' => '<string>',
            'PersonalEmailAddress' => '<string>',
            'PhoneNumber' => '<string>',
            'ProfileId' => '<string>',
            'ShippingAddress' => [
                'Address1' => '<string>',
                'Address2' => '<string>',
                'Address3' => '<string>',
                'Address4' => '<string>',
                'City' => '<string>',
                'Country' => '<string>',
                'County' => '<string>',
                'PostalCode' => '<string>',
                'Province' => '<string>',
                'State' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

An internal service error occurred.

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

An internal service error occurred.

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

UpdateCalculatedAttributeDefinition

$result = $client->updateCalculatedAttributeDefinition([/* ... */]);
$promise = $client->updateCalculatedAttributeDefinitionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateCalculatedAttributeDefinition([
    'CalculatedAttributeName' => '<string>', // REQUIRED
    'Conditions' => [
        'ObjectCount' => <integer>,
        'Range' => [
            'Unit' => 'DAYS', // REQUIRED
            'Value' => <integer>, // REQUIRED
        ],
        'Threshold' => [
            'Operator' => 'EQUAL_TO|GREATER_THAN|LESS_THAN|NOT_EQUAL_TO', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
    ],
    'Description' => '<string>',
    'DisplayName' => '<string>',
    'DomainName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AttributeDetails' => [
        'Attributes' => [
            [
                'Name' => '<string>',
            ],
            // ...
        ],
        'Expression' => '<string>',
    ],
    'CalculatedAttributeName' => '<string>',
    'Conditions' => [
        'ObjectCount' => <integer>,
        'Range' => [
            'Unit' => 'DAYS',
            'Value' => <integer>,
        ],
        'Threshold' => [
            'Operator' => 'EQUAL_TO|GREATER_THAN|LESS_THAN|NOT_EQUAL_TO',
            'Value' => '<string>',
        ],
    ],
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'DisplayName' => '<string>',
    'LastUpdatedAt' => <DateTime>,
    'Statistic' => 'FIRST_OCCURRENCE|LAST_OCCURRENCE|COUNT|SUM|MINIMUM|MAXIMUM|AVERAGE|MAX_OCCURRENCE',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

UpdateDomain

$result = $client->updateDomain([/* ... */]);
$promise = $client->updateDomainAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateDomain([
    'DeadLetterQueueUrl' => '<string>',
    'DefaultEncryptionKey' => '<string>',
    'DefaultExpirationDays' => <integer>,
    'DomainName' => '<string>', // REQUIRED
    'Matching' => [
        'AutoMerging' => [
            'ConflictResolution' => [
                'ConflictResolvingModel' => 'RECENCY|SOURCE', // REQUIRED
                'SourceName' => '<string>',
            ],
            'Consolidation' => [
                'MatchingAttributesList' => [ // REQUIRED
                    ['<string>', ...],
                    // ...
                ],
            ],
            'Enabled' => true || false, // REQUIRED
            'MinAllowedConfidenceScoreForMerging' => <float>,
        ],
        'Enabled' => true || false, // REQUIRED
        'ExportingConfig' => [
            'S3Exporting' => [
                'S3BucketName' => '<string>', // REQUIRED
                'S3KeyName' => '<string>',
            ],
        ],
        'JobSchedule' => [
            'DayOfTheWeek' => 'SUNDAY|MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY', // REQUIRED
            'Time' => '<string>', // REQUIRED
        ],
    ],
    'RuleBasedMatching' => [
        'AttributeTypesSelector' => [
            'Address' => ['<string>', ...],
            'AttributeMatchingModel' => 'ONE_TO_ONE|MANY_TO_MANY', // REQUIRED
            'EmailAddress' => ['<string>', ...],
            'PhoneNumber' => ['<string>', ...],
        ],
        'ConflictResolution' => [
            'ConflictResolvingModel' => 'RECENCY|SOURCE', // REQUIRED
            'SourceName' => '<string>',
        ],
        'Enabled' => true || false, // REQUIRED
        'ExportingConfig' => [
            'S3Exporting' => [
                'S3BucketName' => '<string>', // REQUIRED
                'S3KeyName' => '<string>',
            ],
        ],
        'MatchingRules' => [
            [
                'Rule' => ['<string>', ...], // REQUIRED
            ],
            // ...
        ],
        'MaxAllowedRuleLevelForMatching' => <integer>,
        'MaxAllowedRuleLevelForMerging' => <integer>,
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'CreatedAt' => <DateTime>,
    'DeadLetterQueueUrl' => '<string>',
    'DefaultEncryptionKey' => '<string>',
    'DefaultExpirationDays' => <integer>,
    'DomainName' => '<string>',
    'LastUpdatedAt' => <DateTime>,
    'Matching' => [
        'AutoMerging' => [
            'ConflictResolution' => [
                'ConflictResolvingModel' => 'RECENCY|SOURCE',
                'SourceName' => '<string>',
            ],
            'Consolidation' => [
                'MatchingAttributesList' => [
                    ['<string>', ...],
                    // ...
                ],
            ],
            'Enabled' => true || false,
            'MinAllowedConfidenceScoreForMerging' => <float>,
        ],
        'Enabled' => true || false,
        'ExportingConfig' => [
            'S3Exporting' => [
                'S3BucketName' => '<string>',
                'S3KeyName' => '<string>',
            ],
        ],
        'JobSchedule' => [
            'DayOfTheWeek' => 'SUNDAY|MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY',
            'Time' => '<string>',
        ],
    ],
    'RuleBasedMatching' => [
        'AttributeTypesSelector' => [
            'Address' => ['<string>', ...],
            'AttributeMatchingModel' => 'ONE_TO_ONE|MANY_TO_MANY',
            'EmailAddress' => ['<string>', ...],
            'PhoneNumber' => ['<string>', ...],
        ],
        'ConflictResolution' => [
            'ConflictResolvingModel' => 'RECENCY|SOURCE',
            'SourceName' => '<string>',
        ],
        'Enabled' => true || false,
        'ExportingConfig' => [
            'S3Exporting' => [
                'S3BucketName' => '<string>',
                'S3KeyName' => '<string>',
            ],
        ],
        'MatchingRules' => [
            [
                'Rule' => ['<string>', ...],
            ],
            // ...
        ],
        'MaxAllowedRuleLevelForMatching' => <integer>,
        'MaxAllowedRuleLevelForMerging' => <integer>,
        'Status' => 'PENDING|IN_PROGRESS|ACTIVE',
    ],
    'Tags' => ['<string>', ...],
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

ResourceNotFoundException:

The requested resource does not exist, or access was denied.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

An internal service error occurred.

UpdateProfile

$result = $client->updateProfile([/* ... */]);
$promise = $client->updateProfileAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateProfile([
    'AccountNumber' => '<string>',
    'AdditionalInformation' => '<string>',
    'Address' => [
        'Address1' => '<string>',
        'Address2' => '<string>',
        'Address3' => '<string>',
        'Address4' => '<string>',
        'City' => '<string>',
        'Country' => '<string>',
        'County' => '<string>',
        'PostalCode' => '<string>',
        'Province' => '<string>',
        'State' => '<string>',
    ],
    'Attributes' => ['<string>', ...],
    'BillingAddress' => [
        'Address1' => '<string>',
        'Address2' => '<string>',
        'Address3' => '<string>',
        'Address4' => '<string>',
        'City' => '<string>',
        'Country' => '<string>',
        'County' => '<string>',
        'PostalCode' => '<string>',
        'Province' => '<string>',
        'State' => '<string>',
    ],
    'BirthDate' => '<string>',
    'BusinessEmailAddress' => '<string>',
    'BusinessName' => '<string>',
    'BusinessPhoneNumber' => '<string>',
    'DomainName' => '<string>', // REQUIRED
    'EmailAddress' => '<string>',
    'FirstName' => '<string>',
    'Gender' => 'MALE|FEMALE|UNSPECIFIED',
    'GenderString' => '<string>',
    'HomePhoneNumber' => '<string>',
    'LastName' => '<string>',
    'MailingAddress' => [
        'Address1' => '<string>',
        'Address2' => '<string>',
        'Address3' => '<string>',
        'Address4' => '<string>',
        'City' => '<string>',
        'Country' => '<string>',
        'County' => '<string>',
        'PostalCode' => '<string>',
        'Province' => '<string>',
        'State' => '<string>',
    ],
    'MiddleName' => '<string>',
    'MobilePhoneNumber' => '<string>',
    'PartyType' => 'INDIVIDUAL|BUSINESS|OTHER',
    'PartyTypeString' => '<string>',
    'PersonalEmailAddress' => '<string>',
    'PhoneNumber' => '<string>',
    'ProfileId' => '<string>', // REQUIRED
    'ShippingAddress' => [
        'Address1' => '<string>',
        'Address2' => '<string>',
        'Address3' => '<string>',
        'Address4' => '<string>',
        'City' => '<string>',
        'Country' => '<string>',
        'County' => '<string>',
        'PostalCode' => '<string>',
        'Province' => '<string>',
        'State' => '<string>',
    ],
]);

Parameter Details