# Amazon Connect Customer Profiles The following actions are supported by Amazon Connect Customer Profiles: + [AddProfileKey](API_connect-customer-profiles_AddProfileKey.md) + [BatchGetCalculatedAttributeForProfile](API_connect-customer-profiles_BatchGetCalculatedAttributeForProfile.md) + [BatchGetProfile](API_connect-customer-profiles_BatchGetProfile.md) + [CreateCalculatedAttributeDefinition](API_connect-customer-profiles_CreateCalculatedAttributeDefinition.md) + [CreateDomain](API_connect-customer-profiles_CreateDomain.md) + [CreateDomainLayout](API_connect-customer-profiles_CreateDomainLayout.md) + [CreateEventStream](API_connect-customer-profiles_CreateEventStream.md) + [CreateEventTrigger](API_connect-customer-profiles_CreateEventTrigger.md) + [CreateIntegrationWorkflow](API_connect-customer-profiles_CreateIntegrationWorkflow.md) + [CreateProfile](API_connect-customer-profiles_CreateProfile.md) + [CreateRecommender](API_connect-customer-profiles_CreateRecommender.md) + [CreateRecommenderFilter](API_connect-customer-profiles_CreateRecommenderFilter.md) + [CreateRecommenderSchema](API_connect-customer-profiles_CreateRecommenderSchema.md) + [CreateSegmentDefinition](API_connect-customer-profiles_CreateSegmentDefinition.md) + [CreateSegmentEstimate](API_connect-customer-profiles_CreateSegmentEstimate.md) + [CreateSegmentSnapshot](API_connect-customer-profiles_CreateSegmentSnapshot.md) + [CreateUploadJob](API_connect-customer-profiles_CreateUploadJob.md) + [DeleteCalculatedAttributeDefinition](API_connect-customer-profiles_DeleteCalculatedAttributeDefinition.md) + [DeleteDomain](API_connect-customer-profiles_DeleteDomain.md) + [DeleteDomainLayout](API_connect-customer-profiles_DeleteDomainLayout.md) + [DeleteDomainObjectType](API_connect-customer-profiles_DeleteDomainObjectType.md) + [DeleteEventStream](API_connect-customer-profiles_DeleteEventStream.md) + [DeleteEventTrigger](API_connect-customer-profiles_DeleteEventTrigger.md) + [DeleteIntegration](API_connect-customer-profiles_DeleteIntegration.md) + [DeleteProfile](API_connect-customer-profiles_DeleteProfile.md) + [DeleteProfileKey](API_connect-customer-profiles_DeleteProfileKey.md) + [DeleteProfileObject](API_connect-customer-profiles_DeleteProfileObject.md) + [DeleteProfileObjectType](API_connect-customer-profiles_DeleteProfileObjectType.md) + [DeleteRecommender](API_connect-customer-profiles_DeleteRecommender.md) + [DeleteRecommenderFilter](API_connect-customer-profiles_DeleteRecommenderFilter.md) + [DeleteRecommenderSchema](API_connect-customer-profiles_DeleteRecommenderSchema.md) + [DeleteSegmentDefinition](API_connect-customer-profiles_DeleteSegmentDefinition.md) + [DeleteWorkflow](API_connect-customer-profiles_DeleteWorkflow.md) + [DetectProfileObjectType](API_connect-customer-profiles_DetectProfileObjectType.md) + [GetAutoMergingPreview](API_connect-customer-profiles_GetAutoMergingPreview.md) + [GetCalculatedAttributeDefinition](API_connect-customer-profiles_GetCalculatedAttributeDefinition.md) + [GetCalculatedAttributeForProfile](API_connect-customer-profiles_GetCalculatedAttributeForProfile.md) + [GetDomain](API_connect-customer-profiles_GetDomain.md) + [GetDomainLayout](API_connect-customer-profiles_GetDomainLayout.md) + [GetDomainObjectType](API_connect-customer-profiles_GetDomainObjectType.md) + [GetEventStream](API_connect-customer-profiles_GetEventStream.md) + [GetEventTrigger](API_connect-customer-profiles_GetEventTrigger.md) + [GetIdentityResolutionJob](API_connect-customer-profiles_GetIdentityResolutionJob.md) + [GetIntegration](API_connect-customer-profiles_GetIntegration.md) + [GetMatches](API_connect-customer-profiles_GetMatches.md) + [GetObjectTypeAttributeStatistics](API_connect-customer-profiles_GetObjectTypeAttributeStatistics.md) + [GetProfileHistoryRecord](API_connect-customer-profiles_GetProfileHistoryRecord.md) + [GetProfileObjectType](API_connect-customer-profiles_GetProfileObjectType.md) + [GetProfileObjectTypeTemplate](API_connect-customer-profiles_GetProfileObjectTypeTemplate.md) + [GetProfileRecommendations](API_connect-customer-profiles_GetProfileRecommendations.md) + [GetRecommender](API_connect-customer-profiles_GetRecommender.md) + [GetRecommenderFilter](API_connect-customer-profiles_GetRecommenderFilter.md) + [GetRecommenderSchema](API_connect-customer-profiles_GetRecommenderSchema.md) + [GetSegmentDefinition](API_connect-customer-profiles_GetSegmentDefinition.md) + [GetSegmentEstimate](API_connect-customer-profiles_GetSegmentEstimate.md) + [GetSegmentMembership](API_connect-customer-profiles_GetSegmentMembership.md) + [GetSegmentSnapshot](API_connect-customer-profiles_GetSegmentSnapshot.md) + [GetSimilarProfiles](API_connect-customer-profiles_GetSimilarProfiles.md) + [GetUploadJob](API_connect-customer-profiles_GetUploadJob.md) + [GetUploadJobPath](API_connect-customer-profiles_GetUploadJobPath.md) + [GetWorkflow](API_connect-customer-profiles_GetWorkflow.md) + [GetWorkflowSteps](API_connect-customer-profiles_GetWorkflowSteps.md) + [ListAccountIntegrations](API_connect-customer-profiles_ListAccountIntegrations.md) + [ListCalculatedAttributeDefinitions](API_connect-customer-profiles_ListCalculatedAttributeDefinitions.md) + [ListCalculatedAttributesForProfile](API_connect-customer-profiles_ListCalculatedAttributesForProfile.md) + [ListDomainLayouts](API_connect-customer-profiles_ListDomainLayouts.md) + [ListDomainObjectTypes](API_connect-customer-profiles_ListDomainObjectTypes.md) + [ListDomains](API_connect-customer-profiles_ListDomains.md) + [ListEventStreams](API_connect-customer-profiles_ListEventStreams.md) + [ListEventTriggers](API_connect-customer-profiles_ListEventTriggers.md) + [ListIdentityResolutionJobs](API_connect-customer-profiles_ListIdentityResolutionJobs.md) + [ListIntegrations](API_connect-customer-profiles_ListIntegrations.md) + [ListObjectTypeAttributes](API_connect-customer-profiles_ListObjectTypeAttributes.md) + [ListObjectTypeAttributeValues](API_connect-customer-profiles_ListObjectTypeAttributeValues.md) + [ListProfileAttributeValues](API_connect-customer-profiles_ListProfileAttributeValues.md) + [ListProfileHistoryRecords](API_connect-customer-profiles_ListProfileHistoryRecords.md) + [ListProfileObjects](API_connect-customer-profiles_ListProfileObjects.md) + [ListProfileObjectTypes](API_connect-customer-profiles_ListProfileObjectTypes.md) + [ListProfileObjectTypeTemplates](API_connect-customer-profiles_ListProfileObjectTypeTemplates.md) + [ListRecommenderFilters](API_connect-customer-profiles_ListRecommenderFilters.md) + [ListRecommenderRecipes](API_connect-customer-profiles_ListRecommenderRecipes.md) + [ListRecommenders](API_connect-customer-profiles_ListRecommenders.md) + [ListRecommenderSchemas](API_connect-customer-profiles_ListRecommenderSchemas.md) + [ListRuleBasedMatches](API_connect-customer-profiles_ListRuleBasedMatches.md) + [ListSegmentDefinitions](API_connect-customer-profiles_ListSegmentDefinitions.md) + [ListTagsForResource](API_connect-customer-profiles_ListTagsForResource.md) + [ListUploadJobs](API_connect-customer-profiles_ListUploadJobs.md) + [ListWorkflows](API_connect-customer-profiles_ListWorkflows.md) + [MergeProfiles](API_connect-customer-profiles_MergeProfiles.md) + [PutDomainObjectType](API_connect-customer-profiles_PutDomainObjectType.md) + [PutIntegration](API_connect-customer-profiles_PutIntegration.md) + [PutProfileObject](API_connect-customer-profiles_PutProfileObject.md) + [PutProfileObjectType](API_connect-customer-profiles_PutProfileObjectType.md) + [SearchProfiles](API_connect-customer-profiles_SearchProfiles.md) + [StartRecommender](API_connect-customer-profiles_StartRecommender.md) + [StartUploadJob](API_connect-customer-profiles_StartUploadJob.md) + [StopRecommender](API_connect-customer-profiles_StopRecommender.md) + [StopUploadJob](API_connect-customer-profiles_StopUploadJob.md) + [TagResource](API_connect-customer-profiles_TagResource.md) + [UntagResource](API_connect-customer-profiles_UntagResource.md) + [UpdateCalculatedAttributeDefinition](API_connect-customer-profiles_UpdateCalculatedAttributeDefinition.md) + [UpdateDomain](API_connect-customer-profiles_UpdateDomain.md) + [UpdateDomainLayout](API_connect-customer-profiles_UpdateDomainLayout.md) + [UpdateEventTrigger](API_connect-customer-profiles_UpdateEventTrigger.md) + [UpdateProfile](API_connect-customer-profiles_UpdateProfile.md) + [UpdateRecommender](API_connect-customer-profiles_UpdateRecommender.md) # AddProfileKey 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. ## Request Syntax ``` POST /domains/DomainName/profiles/keys HTTP/1.1 Content-type: application/json { "KeyName": "string", "ProfileId": "string", "Values": [ "string" ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_AddProfileKey_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [KeyName](#API_connect-customer-profiles_AddProfileKey_RequestSyntax) ** A searchable identifier of a customer profile. The predefined keys you can use include: \$1account, \$1profileId, \$1assetId, \$1caseId, \$1orderId, \$1fullName, \$1phone, \$1email, \$1ctrContactId, \$1marketoLeadId, \$1salesforceAccountId, \$1salesforceContactId, \$1salesforceAssetId, \$1zendeskUserId, \$1zendeskExternalId, \$1zendeskTicketId, \$1serviceNowSystemId, \$1serviceNowIncidentId, \$1segmentUserId, \$1shopifyCustomerId, \$1shopifyOrderId. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [ProfileId](#API_connect-customer-profiles_AddProfileKey_RequestSyntax) ** The unique identifier of a customer profile. Type: String Pattern: `[a-f0-9]{32}` Required: Yes ** [Values](#API_connect-customer-profiles_AddProfileKey_RequestSyntax) ** A list of key values. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "KeyName": "string", "Values": [ "string" ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [KeyName](#API_connect-customer-profiles_AddProfileKey_ResponseSyntax) ** A searchable identifier of a customer profile. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [Values](#API_connect-customer-profiles_AddProfileKey_ResponseSyntax) ** A list of key values. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 255. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## Examples ### Example This example illustrates one usage of AddProfileKey. #### Sample Request ``` POST /v1/domains/ExampleDomainName/profiles/keys Content-type: application/json { "ProfileId": "3991a7d959d248bba82546b2dEXAMPLE", "KeyName": "_ctrContactId", "Values": ["valueOfTheContactId"] } ``` #### Sample Response ``` Content-type: application/json { "KeyName": "_ctrContactId", "Values": ["valueOfTheContactId"] } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/AddProfileKey) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/AddProfileKey) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/AddProfileKey) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/AddProfileKey) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/AddProfileKey) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/AddProfileKey) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/AddProfileKey) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/AddProfileKey) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/AddProfileKey) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/AddProfileKey) # BatchGetCalculatedAttributeForProfile Fetch the possible attribute values given the attribute name. ## Request Syntax ``` POST /domains/DomainName/calculated-attributes/CalculatedAttributeName/batch-get-for-profiles HTTP/1.1 Content-type: application/json { "ConditionOverrides": { "Range": { "End": number, "Start": number, "Unit": "string" } }, "ProfileIds": [ "string" ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [CalculatedAttributeName](#API_connect-customer-profiles_BatchGetCalculatedAttributeForProfile_RequestSyntax) ** The unique name of the calculated attribute. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` Required: Yes ** [DomainName](#API_connect-customer-profiles_BatchGetCalculatedAttributeForProfile_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [ConditionOverrides](#API_connect-customer-profiles_BatchGetCalculatedAttributeForProfile_RequestSyntax) ** Overrides the condition block within the original calculated attribute definition. Type: [ConditionOverrides](API_connect-customer-profiles_ConditionOverrides.md) object Required: No ** [ProfileIds](#API_connect-customer-profiles_BatchGetCalculatedAttributeForProfile_RequestSyntax) ** List of unique identifiers for customer profiles to retrieve. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 100 items. Pattern: `[a-f0-9]{32}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CalculatedAttributeValues": [ { "CalculatedAttributeName": "string", "DisplayName": "string", "IsDataPartial": "string", "LastObjectTimestamp": number, "ProfileId": "string", "Value": "string" } ], "ConditionOverrides": { "Range": { "End": number, "Start": number, "Unit": "string" } }, "Errors": [ { "Code": "string", "Message": "string", "ProfileId": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CalculatedAttributeValues](#API_connect-customer-profiles_BatchGetCalculatedAttributeForProfile_ResponseSyntax) ** List of calculated attribute values retrieved. Type: Array of [CalculatedAttributeValue](API_connect-customer-profiles_CalculatedAttributeValue.md) objects ** [ConditionOverrides](#API_connect-customer-profiles_BatchGetCalculatedAttributeForProfile_ResponseSyntax) ** Overrides the condition block within the original calculated attribute definition. Type: [ConditionOverrides](API_connect-customer-profiles_ConditionOverrides.md) object ** [Errors](#API_connect-customer-profiles_BatchGetCalculatedAttributeForProfile_ResponseSyntax) ** List of errors for calculated attribute values that could not be retrieved. Type: Array of [BatchGetCalculatedAttributeForProfileError](API_connect-customer-profiles_BatchGetCalculatedAttributeForProfileError.md) objects ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/BatchGetCalculatedAttributeForProfile) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/BatchGetCalculatedAttributeForProfile) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/BatchGetCalculatedAttributeForProfile) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/BatchGetCalculatedAttributeForProfile) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/BatchGetCalculatedAttributeForProfile) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/BatchGetCalculatedAttributeForProfile) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/BatchGetCalculatedAttributeForProfile) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/BatchGetCalculatedAttributeForProfile) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/BatchGetCalculatedAttributeForProfile) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/BatchGetCalculatedAttributeForProfile) # BatchGetProfile Get a batch of profiles. ## Request Syntax ``` POST /domains/DomainName/batch-get-profiles HTTP/1.1 Content-type: application/json { "ProfileIds": [ "string" ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_BatchGetProfile_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [ProfileIds](#API_connect-customer-profiles_BatchGetProfile_RequestSyntax) ** List of unique identifiers for customer profiles to retrieve. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Pattern: `[a-f0-9]{32}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Errors": [ { "Code": "string", "Message": "string", "ProfileId": "string" } ], "Profiles": [ { "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" : "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", "EngagementPreferences": { "Email": [ { "ContactType": "string", "KeyName": "string", "KeyValue": "string", "ProfileId": "string" } ], "Phone": [ { "ContactType": "string", "KeyName": "string", "KeyValue": "string", "ProfileId": "string" } ] }, "FirstName": "string", "FoundByItems": [ { "KeyName": "string", "Values": [ "string" ] } ], "Gender": "string", "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": "string", "PartyTypeString": "string", "PersonalEmailAddress": "string", "PhoneNumber": "string", "ProfileId": "string", "ProfileType": "string", "ShippingAddress": { "Address1": "string", "Address2": "string", "Address3": "string", "Address4": "string", "City": "string", "Country": "string", "County": "string", "PostalCode": "string", "Province": "string", "State": "string" } } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Errors](#API_connect-customer-profiles_BatchGetProfile_ResponseSyntax) ** For information about the errors that are common to all actions, see [Common Errors](https://docs.aws.amazon.com/connect/latest/APIReference/CommonErrors.html). Type: Array of [BatchGetProfileError](API_connect-customer-profiles_BatchGetProfileError.md) objects ** [Profiles](#API_connect-customer-profiles_BatchGetProfile_ResponseSyntax) ** Array of Profile Objects. Type: Array of [Profile](API_connect-customer-profiles_Profile.md) objects ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/BatchGetProfile) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/BatchGetProfile) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/BatchGetProfile) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/BatchGetProfile) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/BatchGetProfile) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/BatchGetProfile) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/BatchGetProfile) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/BatchGetProfile) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/BatchGetProfile) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/BatchGetProfile) # CreateCalculatedAttributeDefinition 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](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetCalculatedAttributeForProfile.html) 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`. ## Request Syntax ``` POST /domains/DomainName/calculated-attributes/CalculatedAttributeName HTTP/1.1 Content-type: application/json { "AttributeDetails": { "Attributes": [ { "Name": "string" } ], "Expression": "string" }, "Conditions": { "ObjectCount": number, "Range": { "TimestampFormat": "string", "TimestampSource": "string", "Unit": "string", "Value": number, "ValueRange": { "End": number, "Start": number } }, "Threshold": { "Operator": "string", "Value": "string" } }, "Description": "string", "DisplayName": "string", "Filter": { "Groups": [ { "Dimensions": [ { "Attributes": { "string" : { "DimensionType": "string", "Values": [ "string" ] } } } ], "Type": "string" } ], "Include": "string" }, "Statistic": "string", "Tags": { "string" : "string" }, "UseHistoricalData": boolean } ``` ## URI Request Parameters The request uses the following URI parameters. ** [CalculatedAttributeName](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) ** The unique name of the calculated attribute. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` Required: Yes ** [DomainName](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [AttributeDetails](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) ** Mathematical expression and a list of attribute items specified in that expression. Type: [AttributeDetails](API_connect-customer-profiles_AttributeDetails.md) object Required: Yes ** [Conditions](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) ** The conditions including range, object count, and threshold for the calculated attribute. Type: [Conditions](API_connect-customer-profiles_Conditions.md) object Required: No ** [Description](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) ** The description of the calculated attribute. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Required: No ** [DisplayName](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) ** The display name of the calculated attribute. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-\s]*$` Required: No ** [Filter](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) ** Defines how to filter incoming objects to include part of the Calculated Attribute. Type: [Filter](API_connect-customer-profiles_Filter.md) object Required: No ** [Statistic](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) ** The aggregation operation to perform for the calculated attribute. Type: String Valid Values: `FIRST_OCCURRENCE | LAST_OCCURRENCE | COUNT | SUM | MINIMUM | MAXIMUM | AVERAGE | MAX_OCCURRENCE` Required: Yes ** [Tags](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. Required: No ** [UseHistoricalData](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) ** Whether historical data ingested before the Calculated Attribute was created should be included in calculations. Type: Boolean Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "AttributeDetails": { "Attributes": [ { "Name": "string" } ], "Expression": "string" }, "CalculatedAttributeName": "string", "Conditions": { "ObjectCount": number, "Range": { "TimestampFormat": "string", "TimestampSource": "string", "Unit": "string", "Value": number, "ValueRange": { "End": number, "Start": number } }, "Threshold": { "Operator": "string", "Value": "string" } }, "CreatedAt": number, "Description": "string", "DisplayName": "string", "Filter": { "Groups": [ { "Dimensions": [ { "Attributes": { "string" : { "DimensionType": "string", "Values": [ "string" ] } } } ], "Type": "string" } ], "Include": "string" }, "LastUpdatedAt": number, "Readiness": { "Message": "string", "ProgressPercentage": number }, "Statistic": "string", "Status": "string", "Tags": { "string" : "string" }, "UseHistoricalData": boolean } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AttributeDetails](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) ** Mathematical expression and a list of attribute items specified in that expression. Type: [AttributeDetails](API_connect-customer-profiles_AttributeDetails.md) object ** [CalculatedAttributeName](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) ** The unique name of the calculated attribute. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` ** [Conditions](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) ** The conditions including range, object count, and threshold for the calculated attribute. Type: [Conditions](API_connect-customer-profiles_Conditions.md) object ** [CreatedAt](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) ** The timestamp of when the calculated attribute definition was created. Type: Timestamp ** [Description](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) ** The description of the calculated attribute. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. ** [DisplayName](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) ** The display name of the calculated attribute. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-\s]*$` ** [Filter](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) ** The filter that was used as part of the request. Type: [Filter](API_connect-customer-profiles_Filter.md) object ** [LastUpdatedAt](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) ** The timestamp of when the calculated attribute definition was most recently edited. Type: Timestamp ** [Readiness](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) ** Information indicating if the Calculated Attribute is ready for use by confirming all historical data has been processed and reflected. Type: [Readiness](API_connect-customer-profiles_Readiness.md) object ** [Statistic](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) ** The aggregation operation to perform for the calculated attribute. Type: String Valid Values: `FIRST_OCCURRENCE | LAST_OCCURRENCE | COUNT | SUM | MINIMUM | MAXIMUM | AVERAGE | MAX_OCCURRENCE` ** [Status](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) ** Status of the Calculated Attribute creation (whether all historical data has been indexed.) Type: String Valid Values: `PREPARING | IN_PROGRESS | COMPLETED | FAILED` ** [Tags](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ** [UseHistoricalData](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) ** Whether historical data ingested before the Calculated Attribute was created should be included in calculations. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) # CreateDomain 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](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html) to enable [identity resolution](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html): set `Matching` to true. To prevent cross-service impersonation when you call this API, see [Cross-service confused deputy prevention](https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html) for sample policies that you should apply. **Note** It is not possible to associate a Customer Profiles domain with an Amazon Connect Instance directly from the API. If you would like to create a domain and associate a Customer Profiles domain, use the Amazon Connect admin website. For more information, see [Enable Customer Profiles](https://docs.aws.amazon.com/connect/latest/adminguide/enable-customer-profiles.html#enable-customer-profiles-step1). Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain. ## Request Syntax ``` POST /domains/DomainName HTTP/1.1 Content-type: application/json { "DataStore": { "Enabled": boolean }, "DeadLetterQueueUrl": "string", "DefaultEncryptionKey": "string", "DefaultExpirationDays": number, "Matching": { "AutoMerging": { "ConflictResolution": { "ConflictResolvingModel": "string", "SourceName": "string" }, "Consolidation": { "MatchingAttributesList": [ [ "string" ] ] }, "Enabled": boolean, "MinAllowedConfidenceScoreForMerging": number }, "Enabled": boolean, "ExportingConfig": { "S3Exporting": { "S3BucketName": "string", "S3KeyName": "string" } }, "JobSchedule": { "DayOfTheWeek": "string", "Time": "string" } }, "RuleBasedMatching": { "AttributeTypesSelector": { "Address": [ "string" ], "AttributeMatchingModel": "string", "EmailAddress": [ "string" ], "PhoneNumber": [ "string" ] }, "ConflictResolution": { "ConflictResolvingModel": "string", "SourceName": "string" }, "Enabled": boolean, "ExportingConfig": { "S3Exporting": { "S3BucketName": "string", "S3KeyName": "string" } }, "MatchingRules": [ { "Rule": [ "string" ] } ], "MaxAllowedRuleLevelForMatching": number, "MaxAllowedRuleLevelForMerging": number }, "Tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_CreateDomain_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [DataStore](#API_connect-customer-profiles_CreateDomain_RequestSyntax) ** Set to true to enabled data store for this domain. Type: [DataStoreRequest](API_connect-customer-profiles_DataStoreRequest.md) object Required: No ** [DeadLetterQueueUrl](#API_connect-customer-profiles_CreateDomain_RequestSyntax) ** The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Required: No ** [DefaultEncryptionKey](#API_connect-customer-profiles_CreateDomain_RequestSyntax) ** The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Required: No ** [DefaultExpirationDays](#API_connect-customer-profiles_CreateDomain_RequestSyntax) ** The default number of days until the data within the domain expires. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1098. Required: Yes ** [Matching](#API_connect-customer-profiles_CreateDomain_RequestSyntax) ** The process of matching duplicate profiles. If `Matching` = `true`, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the Identity Resolution Job completes, use the [GetMatches](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html) API to return and review the results. Or, if you have configured `ExportingConfig` in the `MatchingRequest`, you can download the results from S3. Type: [MatchingRequest](API_connect-customer-profiles_MatchingRequest.md) object Required: No ** [RuleBasedMatching](#API_connect-customer-profiles_CreateDomain_RequestSyntax) ** The process of matching duplicate profiles using the Rule-Based matching. If `RuleBasedMatching` = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the `RuleBasedMatchingRequest`. You can use the `ListRuleBasedMatches` and `GetSimilarProfiles` API to return and review the results. Also, if you have configured `ExportingConfig` in the `RuleBasedMatchingRequest`, you can download the results from S3. Type: [RuleBasedMatchingRequest](API_connect-customer-profiles_RuleBasedMatchingRequest.md) object Required: No ** [Tags](#API_connect-customer-profiles_CreateDomain_RequestSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreatedAt": number, "DataStore": { "Enabled": boolean, "Readiness": { "Message": "string", "ProgressPercentage": number } }, "DeadLetterQueueUrl": "string", "DefaultEncryptionKey": "string", "DefaultExpirationDays": number, "DomainName": "string", "LastUpdatedAt": number, "Matching": { "AutoMerging": { "ConflictResolution": { "ConflictResolvingModel": "string", "SourceName": "string" }, "Consolidation": { "MatchingAttributesList": [ [ "string" ] ] }, "Enabled": boolean, "MinAllowedConfidenceScoreForMerging": number }, "Enabled": boolean, "ExportingConfig": { "S3Exporting": { "S3BucketName": "string", "S3KeyName": "string" } }, "JobSchedule": { "DayOfTheWeek": "string", "Time": "string" } }, "RuleBasedMatching": { "AttributeTypesSelector": { "Address": [ "string" ], "AttributeMatchingModel": "string", "EmailAddress": [ "string" ], "PhoneNumber": [ "string" ] }, "ConflictResolution": { "ConflictResolvingModel": "string", "SourceName": "string" }, "Enabled": boolean, "ExportingConfig": { "S3Exporting": { "S3BucketName": "string", "S3KeyName": "string" } }, "MatchingRules": [ { "Rule": [ "string" ] } ], "MaxAllowedRuleLevelForMatching": number, "MaxAllowedRuleLevelForMerging": number, "Status": "string" }, "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedAt](#API_connect-customer-profiles_CreateDomain_ResponseSyntax) ** The timestamp of when the domain was created. Type: Timestamp ** [DataStore](#API_connect-customer-profiles_CreateDomain_ResponseSyntax) ** The data store. Type: [DataStoreResponse](API_connect-customer-profiles_DataStoreResponse.md) object ** [DeadLetterQueueUrl](#API_connect-customer-profiles_CreateDomain_ResponseSyntax) ** The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. ** [DefaultEncryptionKey](#API_connect-customer-profiles_CreateDomain_ResponseSyntax) ** The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. ** [DefaultExpirationDays](#API_connect-customer-profiles_CreateDomain_ResponseSyntax) ** The default number of days until the data within the domain expires. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1098. ** [DomainName](#API_connect-customer-profiles_CreateDomain_ResponseSyntax) ** The unique name of the domain. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [LastUpdatedAt](#API_connect-customer-profiles_CreateDomain_ResponseSyntax) ** The timestamp of when the domain was most recently edited. Type: Timestamp ** [Matching](#API_connect-customer-profiles_CreateDomain_ResponseSyntax) ** The process of matching duplicate profiles. If `Matching` = `true`, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the Identity Resolution Job completes, use the [GetMatches](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html) API to return and review the results. Or, if you have configured `ExportingConfig` in the `MatchingRequest`, you can download the results from S3. Type: [MatchingResponse](API_connect-customer-profiles_MatchingResponse.md) object ** [RuleBasedMatching](#API_connect-customer-profiles_CreateDomain_ResponseSyntax) ** The process of matching duplicate profiles using the Rule-Based matching. If `RuleBasedMatching` = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the `RuleBasedMatchingRequest`. You can use the `ListRuleBasedMatches` and `GetSimilarProfiles` API to return and review the results. Also, if you have configured `ExportingConfig` in the `RuleBasedMatchingRequest`, you can download the results from S3. Type: [RuleBasedMatchingResponse](API_connect-customer-profiles_RuleBasedMatchingResponse.md) object ** [Tags](#API_connect-customer-profiles_CreateDomain_ResponseSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## Examples ### Example This example illustrates one usage of CreateDomain. #### Sample Request ``` POST /v1/domains/ExampleDomainName Content-type: application/json { "DeadLetterQueueUrl": "arn:aws:sqs:us-east-1:123456789012:DLQName", "DefaultEncryptionKey": "arn:aws:kms:us-east-1:123456789012:key/1988472d-6b77-4bb6-ae39-efce5EXAMPLE", "DefaultExpirationDays": 1098, "DomainName":"ExampleDomainName" } ``` #### Sample Response ``` Content-type: application/json { "DeadLetterQueueUrl": "arn:aws:sqs:us-east-1:123456789012:DLQName", "CreatedAt": 1479249799770, "DefaultEncryptionKey":"arn:aws:kms:us-east-1:123456789012:key/1988472d-6b77-4bb6-ae39-efce5EXAMPLE", "DefaultExpirationDays": 1098, "LastUpdatedAt":1479249799770, "DomainName": "ExampleDomainName" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/CreateDomain) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/CreateDomain) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/CreateDomain) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/CreateDomain) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/CreateDomain) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/CreateDomain) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/CreateDomain) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/CreateDomain) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/CreateDomain) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/CreateDomain) # CreateDomainLayout Creates the layout to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website. ## Request Syntax ``` POST /domains/DomainName/layouts/LayoutDefinitionName HTTP/1.1 Content-type: application/json { "Description": "string", "DisplayName": "string", "IsDefault": boolean, "Layout": "string", "LayoutType": "string", "Tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_CreateDomainLayout_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [LayoutDefinitionName](#API_connect-customer-profiles_CreateDomainLayout_RequestSyntax) ** The unique name of the layout. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Description](#API_connect-customer-profiles_CreateDomainLayout_RequestSyntax) ** The description of the layout Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Required: Yes ** [DisplayName](#API_connect-customer-profiles_CreateDomainLayout_RequestSyntax) ** The display name of the layout Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-\s]*$` Required: Yes ** [IsDefault](#API_connect-customer-profiles_CreateDomainLayout_RequestSyntax) ** If set to true for a layout, this layout will be used by default to view data. If set to false, then the layout will not be used by default, but it can be used to view data by explicitly selecting it in the console. Type: Boolean Required: No ** [Layout](#API_connect-customer-profiles_CreateDomainLayout_RequestSyntax) ** A customizable layout that can be used to view data under a Customer Profiles domain. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000000. Required: Yes ** [LayoutType](#API_connect-customer-profiles_CreateDomainLayout_RequestSyntax) ** The type of layout that can be used to view data under a Customer Profiles domain. Type: String Valid Values: `PROFILE_EXPLORER` Required: Yes ** [Tags](#API_connect-customer-profiles_CreateDomainLayout_RequestSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreatedAt": number, "Description": "string", "DisplayName": "string", "IsDefault": boolean, "LastUpdatedAt": number, "Layout": "string", "LayoutDefinitionName": "string", "LayoutType": "string", "Tags": { "string" : "string" }, "Version": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedAt](#API_connect-customer-profiles_CreateDomainLayout_ResponseSyntax) ** The timestamp of when the layout was created. Type: Timestamp ** [Description](#API_connect-customer-profiles_CreateDomainLayout_ResponseSyntax) ** The description of the layout Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. ** [DisplayName](#API_connect-customer-profiles_CreateDomainLayout_ResponseSyntax) ** The display name of the layout Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-\s]*$` ** [IsDefault](#API_connect-customer-profiles_CreateDomainLayout_ResponseSyntax) ** If set to true for a layout, this layout will be used by default to view data. If set to false, then the layout will not be used by default, but it can be used to view data by explicitly selecting it in the console. Type: Boolean ** [LastUpdatedAt](#API_connect-customer-profiles_CreateDomainLayout_ResponseSyntax) ** The timestamp of when the layout was most recently updated. Type: Timestamp ** [Layout](#API_connect-customer-profiles_CreateDomainLayout_ResponseSyntax) ** A customizable layout that can be used to view data under Customer Profiles domain. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000000. ** [LayoutDefinitionName](#API_connect-customer-profiles_CreateDomainLayout_ResponseSyntax) ** The unique name of the layout. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [LayoutType](#API_connect-customer-profiles_CreateDomainLayout_ResponseSyntax) ** The type of layout that can be used to view data under customer profiles domain. Type: String Valid Values: `PROFILE_EXPLORER` ** [Tags](#API_connect-customer-profiles_CreateDomainLayout_ResponseSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ** [Version](#API_connect-customer-profiles_CreateDomainLayout_ResponseSyntax) ** The version used to create layout. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/CreateDomainLayout) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/CreateDomainLayout) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/CreateDomainLayout) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/CreateDomainLayout) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/CreateDomainLayout) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/CreateDomainLayout) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/CreateDomainLayout) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/CreateDomainLayout) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/CreateDomainLayout) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/CreateDomainLayout) # CreateEventStream 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 AWS account as the customer profiles domain ## Request Syntax ``` POST /domains/DomainName/event-streams/EventStreamName HTTP/1.1 Content-type: application/json { "Tags": { "string" : "string" }, "Uri": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_CreateEventStream_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [EventStreamName](#API_connect-customer-profiles_CreateEventStream_RequestSyntax) ** The name of the event stream. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Tags](#API_connect-customer-profiles_CreateEventStream_RequestSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. Required: No ** [Uri](#API_connect-customer-profiles_CreateEventStream_RequestSyntax) ** The StreamARN of the destination to deliver profile events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "EventStreamArn": "string", "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [EventStreamArn](#API_connect-customer-profiles_CreateEventStream_ResponseSyntax) ** A unique identifier for the event stream. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [Tags](#API_connect-customer-profiles_CreateEventStream_ResponseSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/CreateEventStream) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/CreateEventStream) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/CreateEventStream) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/CreateEventStream) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/CreateEventStream) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/CreateEventStream) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/CreateEventStream) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/CreateEventStream) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/CreateEventStream) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/CreateEventStream) # CreateEventTrigger Creates an event trigger, which specifies the rules when to perform action based on customer's ingested data. Each event stream can be associated with only one integration in the same region and AWS account as the event stream. ## Request Syntax ``` POST /domains/DomainName/event-triggers/EventTriggerName HTTP/1.1 Content-type: application/json { "Description": "string", "EventTriggerConditions": [ { "EventTriggerDimensions": [ { "ObjectAttributes": [ { "ComparisonOperator": "string", "FieldName": "string", "Source": "string", "Values": [ "string" ] } ] } ], "LogicalOperator": "string" } ], "EventTriggerLimits": { "EventExpiration": number, "Periods": [ { "MaxInvocationsPerProfile": number, "Unit": "string", "Unlimited": boolean, "Value": number } ] }, "ObjectTypeName": "string", "SegmentFilter": "string", "Tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_CreateEventTrigger_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [EventTriggerName](#API_connect-customer-profiles_CreateEventTrigger_RequestSyntax) ** The unique name of the event trigger. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Description](#API_connect-customer-profiles_CreateEventTrigger_RequestSyntax) ** The description of the event trigger. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Required: No ** [EventTriggerConditions](#API_connect-customer-profiles_CreateEventTrigger_RequestSyntax) ** A list of conditions that determine when an event should trigger the destination. Type: Array of [EventTriggerCondition](API_connect-customer-profiles_EventTriggerCondition.md) objects Array Members: Minimum number of 1 item. Maximum number of 5 items. Required: Yes ** [EventTriggerLimits](#API_connect-customer-profiles_CreateEventTrigger_RequestSyntax) ** Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods. Type: [EventTriggerLimits](API_connect-customer-profiles_EventTriggerLimits.md) object Required: No ** [ObjectTypeName](#API_connect-customer-profiles_CreateEventTrigger_RequestSyntax) ** The unique name of the object type. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` Required: Yes ** [SegmentFilter](#API_connect-customer-profiles_CreateEventTrigger_RequestSyntax) ** The destination is triggered only for profiles that meet the criteria of a segment definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: No ** [Tags](#API_connect-customer-profiles_CreateEventTrigger_RequestSyntax) ** An array of key-value pairs to apply to this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreatedAt": number, "Description": "string", "EventTriggerConditions": [ { "EventTriggerDimensions": [ { "ObjectAttributes": [ { "ComparisonOperator": "string", "FieldName": "string", "Source": "string", "Values": [ "string" ] } ] } ], "LogicalOperator": "string" } ], "EventTriggerLimits": { "EventExpiration": number, "Periods": [ { "MaxInvocationsPerProfile": number, "Unit": "string", "Unlimited": boolean, "Value": number } ] }, "EventTriggerName": "string", "LastUpdatedAt": number, "ObjectTypeName": "string", "SegmentFilter": "string", "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedAt](#API_connect-customer-profiles_CreateEventTrigger_ResponseSyntax) ** The timestamp of when the event trigger was created. Type: Timestamp ** [Description](#API_connect-customer-profiles_CreateEventTrigger_ResponseSyntax) ** The description of the event trigger. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. ** [EventTriggerConditions](#API_connect-customer-profiles_CreateEventTrigger_ResponseSyntax) ** A list of conditions that determine when an event should trigger the destination. Type: Array of [EventTriggerCondition](API_connect-customer-profiles_EventTriggerCondition.md) objects Array Members: Minimum number of 1 item. Maximum number of 5 items. ** [EventTriggerLimits](#API_connect-customer-profiles_CreateEventTrigger_ResponseSyntax) ** Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods. Type: [EventTriggerLimits](API_connect-customer-profiles_EventTriggerLimits.md) object ** [EventTriggerName](#API_connect-customer-profiles_CreateEventTrigger_ResponseSyntax) ** The unique name of the event trigger. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [LastUpdatedAt](#API_connect-customer-profiles_CreateEventTrigger_ResponseSyntax) ** The timestamp of when the event trigger was most recently updated. Type: Timestamp ** [ObjectTypeName](#API_connect-customer-profiles_CreateEventTrigger_ResponseSyntax) ** The unique name of the object type. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` ** [SegmentFilter](#API_connect-customer-profiles_CreateEventTrigger_ResponseSyntax) ** The destination is triggered only for profiles that meet the criteria of a segment definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [Tags](#API_connect-customer-profiles_CreateEventTrigger_ResponseSyntax) ** An array of key-value pairs to apply to this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/CreateEventTrigger) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/CreateEventTrigger) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/CreateEventTrigger) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/CreateEventTrigger) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/CreateEventTrigger) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/CreateEventTrigger) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/CreateEventTrigger) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/CreateEventTrigger) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/CreateEventTrigger) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/CreateEventTrigger) # CreateIntegrationWorkflow 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. ## Request Syntax ``` POST /domains/DomainName/workflows/integrations HTTP/1.1 Content-type: application/json { "IntegrationConfig": { "AppflowIntegration": { "Batches": [ { "EndTime": number, "StartTime": number } ], "FlowDefinition": { "Description": "string", "FlowName": "string", "KmsArn": "string", "SourceFlowConfig": { "ConnectorProfileName": "string", "ConnectorType": "string", "IncrementalPullConfig": { "DatetimeTypeFieldName": "string" }, "SourceConnectorProperties": { "Marketo": { "Object": "string" }, "S3": { "BucketName": "string", "BucketPrefix": "string" }, "Salesforce": { "EnableDynamicFieldUpdate": boolean, "IncludeDeletedRecords": boolean, "Object": "string" }, "ServiceNow": { "Object": "string" }, "Zendesk": { "Object": "string" } } }, "Tasks": [ { "ConnectorOperator": { "Marketo": "string", "S3": "string", "Salesforce": "string", "ServiceNow": "string", "Zendesk": "string" }, "DestinationField": "string", "SourceFields": [ "string" ], "TaskProperties": { "string" : "string" }, "TaskType": "string" } ], "TriggerConfig": { "TriggerProperties": { "Scheduled": { "DataPullMode": "string", "FirstExecutionFrom": number, "ScheduleEndTime": number, "ScheduleExpression": "string", "ScheduleOffset": number, "ScheduleStartTime": number, "Timezone": "string" } }, "TriggerType": "string" } } } }, "ObjectTypeName": "string", "RoleArn": "string", "Tags": { "string" : "string" }, "WorkflowType": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_CreateIntegrationWorkflow_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [IntegrationConfig](#API_connect-customer-profiles_CreateIntegrationWorkflow_RequestSyntax) ** Configuration data for integration workflow. Type: [IntegrationConfig](API_connect-customer-profiles_IntegrationConfig.md) object Required: Yes ** [ObjectTypeName](#API_connect-customer-profiles_CreateIntegrationWorkflow_RequestSyntax) ** The name of the profile object type. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` Required: Yes ** [RoleArn](#API_connect-customer-profiles_CreateIntegrationWorkflow_RequestSyntax) ** The Amazon Resource Name (ARN) of the IAM role. Customer Profiles assumes this role to create resources on your behalf as part of workflow execution. Type: String Length Constraints: Maximum length of 512. Pattern: `arn:aws:iam:.*:[0-9]+:.*` Required: Yes ** [Tags](#API_connect-customer-profiles_CreateIntegrationWorkflow_RequestSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. Required: No ** [WorkflowType](#API_connect-customer-profiles_CreateIntegrationWorkflow_RequestSyntax) ** The type of workflow. The only supported value is APPFLOW\$1INTEGRATION. Type: String Valid Values: `APPFLOW_INTEGRATION` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Message": "string", "WorkflowId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Message](#API_connect-customer-profiles_CreateIntegrationWorkflow_ResponseSyntax) ** A message indicating create request was received. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [WorkflowId](#API_connect-customer-profiles_CreateIntegrationWorkflow_ResponseSyntax) ** Unique identifier for the workflow. Type: String Pattern: `[a-f0-9]{32}` ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/CreateIntegrationWorkflow) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/CreateIntegrationWorkflow) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/CreateIntegrationWorkflow) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/CreateIntegrationWorkflow) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/CreateIntegrationWorkflow) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/CreateIntegrationWorkflow) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/CreateIntegrationWorkflow) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/CreateIntegrationWorkflow) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/CreateIntegrationWorkflow) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/CreateIntegrationWorkflow) # CreateProfile Creates a standard profile. A standard profile represents the following attributes for a customer profile in a domain. ## Request Syntax ``` POST /domains/DomainName/profiles HTTP/1.1 Content-type: application/json { "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" : "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", "EngagementPreferences": { "Email": [ { "ContactType": "string", "KeyName": "string", "KeyValue": "string", "ProfileId": "string" } ], "Phone": [ { "ContactType": "string", "KeyName": "string", "KeyValue": "string", "ProfileId": "string" } ] }, "FirstName": "string", "Gender": "string", "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": "string", "PartyTypeString": "string", "PersonalEmailAddress": "string", "PhoneNumber": "string", "ProfileType": "string", "ShippingAddress": { "Address1": "string", "Address2": "string", "Address3": "string", "Address4": "string", "City": "string", "Country": "string", "County": "string", "PostalCode": "string", "Province": "string", "State": "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_CreateProfile_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [AccountNumber](#API_connect-customer-profiles_CreateProfile_RequestSyntax) ** An account number that you have assigned to the customer. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** [AdditionalInformation](#API_connect-customer-profiles_CreateProfile_RequestSyntax) ** Any additional information relevant to the customer’s profile. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Required: No ** [Address](#API_connect-customer-profiles_CreateProfile_RequestSyntax) ** A generic address associated with the customer that is not mailing, shipping, or billing. Type: [Address](API_connect-customer-profiles_Address.md) object Required: No ** [Attributes](#API_connect-customer-profiles_CreateProfile_RequestSyntax) ** A key value pair of attributes of a customer profile. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 255. Value Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** [BillingAddress](#API_connect-customer-profiles_CreateProfile_RequestSyntax) ** The customer’s billing address. Type: [Address](API_connect-customer-profiles_Address.md) object Required: No ** [BirthDate](#API_connect-customer-profiles_CreateProfile_RequestSyntax) ** The customer’s birth date. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** [BusinessEmailAddress](#API_connect-customer-profiles_CreateProfile_RequestSyntax) ** The customer’s business email address. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** [BusinessName](#API_connect-customer-profiles_CreateProfile_RequestSyntax) ** The name of the customer’s business. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** [BusinessPhoneNumber](#API_connect-customer-profiles_CreateProfile_RequestSyntax) ** The customer’s business phone number. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** [EmailAddress](#API_connect-customer-profiles_CreateProfile_RequestSyntax) ** The customer’s email address, which has not been specified as a personal or business address. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** [EngagementPreferences](#API_connect-customer-profiles_CreateProfile_RequestSyntax) ** Object that defines the preferred methods of engagement, per channel. Type: [EngagementPreferences](API_connect-customer-profiles_EngagementPreferences.md) object Required: No ** [FirstName](#API_connect-customer-profiles_CreateProfile_RequestSyntax) ** The customer’s first name. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** [Gender](#API_connect-customer-profiles_CreateProfile_RequestSyntax) ** *This parameter has been deprecated.* The gender with which the customer identifies. Type: String Valid Values: `MALE | FEMALE | UNSPECIFIED` Required: No ** [GenderString](#API_connect-customer-profiles_CreateProfile_RequestSyntax) ** An alternative to `Gender` which accepts any string as input. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** [HomePhoneNumber](#API_connect-customer-profiles_CreateProfile_RequestSyntax) ** The customer’s home phone number. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** [LastName](#API_connect-customer-profiles_CreateProfile_RequestSyntax) ** The customer’s last name. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** [MailingAddress](#API_connect-customer-profiles_CreateProfile_RequestSyntax) ** The customer’s mailing address. Type: [Address](API_connect-customer-profiles_Address.md) object Required: No ** [MiddleName](#API_connect-customer-profiles_CreateProfile_RequestSyntax) ** The customer’s middle name. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** [MobilePhoneNumber](#API_connect-customer-profiles_CreateProfile_RequestSyntax) ** The customer’s mobile phone number. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** [PartyType](#API_connect-customer-profiles_CreateProfile_RequestSyntax) ** *This parameter has been deprecated.* The type of profile used to describe the customer. Type: String Valid Values: `INDIVIDUAL | BUSINESS | OTHER` Required: No ** [PartyTypeString](#API_connect-customer-profiles_CreateProfile_RequestSyntax) ** An alternative to `PartyType` which accepts any string as input. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** [PersonalEmailAddress](#API_connect-customer-profiles_CreateProfile_RequestSyntax) ** The customer’s personal email address. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** [PhoneNumber](#API_connect-customer-profiles_CreateProfile_RequestSyntax) ** The customer’s phone number, which has not been specified as a mobile, home, or business number. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** [ProfileType](#API_connect-customer-profiles_CreateProfile_RequestSyntax) ** The type of the profile. Type: String Valid Values: `ACCOUNT_PROFILE | PROFILE` Required: No ** [ShippingAddress](#API_connect-customer-profiles_CreateProfile_RequestSyntax) ** The customer’s shipping address. Type: [Address](API_connect-customer-profiles_Address.md) object Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "ProfileId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ProfileId](#API_connect-customer-profiles_CreateProfile_ResponseSyntax) ** The unique identifier of a customer profile. Type: String Pattern: `[a-f0-9]{32}` ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## Examples ### Example This example illustrates one usage of CreateProfile. #### Sample Request ``` POST /domains/ExampleDomainName/profiles HTTP/1.1 Content-type: application/json { "AccountNumber": "ACCT12344", "Address": { "Address1": "123 Sample St", "Address2": "Apt 4", "Address3": "null", "Address4": "null", "City": "Seattle", "Country": "USA", "County": "King", "PostalCode": "98011", "Province": "", "State": "WA" }, "Attributes": { "SSN" : "123-44-3433", "LoyaltyPoints" : "3000" }, "BillingAddress": { "Address1": "789 Sample St", "Address2": "Apt 1", "City": "Seattle", "Country": "USA", "County": "King", "PostalCode": "98011", "Province": "", "State": "WA" }, "BirthDate": "07/12/1980", "BusinessEmailAddress": "example@amazon.com", "BusinessName": "My Awesome Company", "BusinessPhoneNumber": "555-334-3389", "EmailAddress": "example@gmail.com", "FirstName": "John", "Gender": "MALE", "HomePhoneNumber": "555-334-3344", "LastName": "Doe", "MailingAddress": { "Address1": "234 Home St", "Address2": "Apt 5", "City": "Seattle", "Country": "USA", "County": "King", "PostalCode": "98011", "Province": "", "State": "WA" }, "AdditionalInformation": "High Profile Customer", "MiddleName": "", "MobilePhoneNumber": "555-334-7777", "PartyType": "INDIVIDUAL", "PersonalEmailAddress": "email1@gmail.com", "PhoneNumber": "", "ShippingAddress": { "Address1": "555 A St", "Address2": "Suite 100", "City": "Seattle", "Country": "USA", "County": "King", "PostalCode": "98011", "Province": "", "State": "WA" } } ``` #### Sample Response ``` Content-type: application/json { "ProfileId" : "3991a7d959d248bb982546b2dEXAMPLE" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/CreateProfile) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/CreateProfile) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/CreateProfile) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/CreateProfile) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/CreateProfile) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/CreateProfile) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/CreateProfile) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/CreateProfile) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/CreateProfile) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/CreateProfile) # CreateRecommender Creates a recommender ## Request Syntax ``` POST /domains/DomainName/recommenders/RecommenderName HTTP/1.1 Content-type: application/json { "Description": "string", "RecommenderConfig": { "EventsConfig": { "EventParametersList": [ { "EventType": "string", "EventValueThreshold": number, "EventWeight": number } ] }, "IncludedColumns": { "string" : [ "string" ] }, "InferenceConfig": { "MinProvisionedTPS": number }, "TrainingFrequency": number }, "RecommenderRecipeName": "string", "RecommenderSchemaName": "string", "Tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_CreateRecommender_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [RecommenderName](#API_connect-customer-profiles_CreateRecommender_RequestSyntax) ** The name of the recommender. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Description](#API_connect-customer-profiles_CreateRecommender_RequestSyntax) ** The description of the domain object type. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Required: No ** [RecommenderConfig](#API_connect-customer-profiles_CreateRecommender_RequestSyntax) ** The recommender configuration. Type: [RecommenderConfig](API_connect-customer-profiles_RecommenderConfig.md) object Required: No ** [RecommenderRecipeName](#API_connect-customer-profiles_CreateRecommender_RequestSyntax) ** The name of the recommeder recipe. Type: String Valid Values: `recommended-for-you | similar-items | frequently-paired-items | popular-items | trending-now | personalized-ranking` Required: Yes ** [RecommenderSchemaName](#API_connect-customer-profiles_CreateRecommender_RequestSyntax) ** The name of the recommender schema to use for this recommender. If not specified, the default schema is used. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: No ** [Tags](#API_connect-customer-profiles_CreateRecommender_RequestSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "RecommenderArn": "string", "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [RecommenderArn](#API_connect-customer-profiles_CreateRecommender_ResponseSyntax) ** The ARN of the recommender Type: String Pattern: `arn:([a-z\d-]+):profile:.*:.*:.+` ** [Tags](#API_connect-customer-profiles_CreateRecommender_ResponseSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/CreateRecommender) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/CreateRecommender) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/CreateRecommender) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/CreateRecommender) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/CreateRecommender) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/CreateRecommender) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/CreateRecommender) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/CreateRecommender) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/CreateRecommender) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/CreateRecommender) # CreateRecommenderFilter Creates a recommender filter. A recommender filter specifies which items to include or exclude from recommendations. ## Request Syntax ``` POST /domains/DomainName/recommender-filters/RecommenderFilterName HTTP/1.1 Content-type: application/json { "Description": "string", "RecommenderFilterExpression": "string", "RecommenderSchemaName": "string", "Tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_CreateRecommenderFilter_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [RecommenderFilterName](#API_connect-customer-profiles_CreateRecommenderFilter_RequestSyntax) ** The name of the recommender filter. The name must be unique within the domain. Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9_-]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Description](#API_connect-customer-profiles_CreateRecommenderFilter_RequestSyntax) ** A description of the recommender filter. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Required: No ** [RecommenderFilterExpression](#API_connect-customer-profiles_CreateRecommenderFilter_RequestSyntax) ** The filter expression that defines which items to include or exclude from recommendations. Type: String Length Constraints: Minimum length of 1. Maximum length of 2500. Required: Yes ** [RecommenderSchemaName](#API_connect-customer-profiles_CreateRecommenderFilter_RequestSyntax) ** The name of the recommender schema to use for this recommender filter. If not specified, the default schema is used. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: No ** [Tags](#API_connect-customer-profiles_CreateRecommenderFilter_RequestSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "RecommenderFilterArn": "string", "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [RecommenderFilterArn](#API_connect-customer-profiles_CreateRecommenderFilter_ResponseSyntax) ** The Amazon Resource Name (ARN) of the recommender filter. Type: String Pattern: `arn:([a-z\d-]+):profile:.*:.*:.+` ** [Tags](#API_connect-customer-profiles_CreateRecommenderFilter_ResponseSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/CreateRecommenderFilter) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/CreateRecommenderFilter) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/CreateRecommenderFilter) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/CreateRecommenderFilter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/CreateRecommenderFilter) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/CreateRecommenderFilter) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/CreateRecommenderFilter) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/CreateRecommenderFilter) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/CreateRecommenderFilter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/CreateRecommenderFilter) # CreateRecommenderSchema Creates a recommender schema. A recommender schema defines the set of data columns available for training recommenders and filters under a domain. ## Request Syntax ``` POST /domains/DomainName/recommender-schemas/RecommenderSchemaName HTTP/1.1 Content-type: application/json { "Fields": { "string" : [ { "ContentType": "string", "FeatureType": "string", "TargetFieldName": "string" } ] }, "Tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_CreateRecommenderSchema_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [RecommenderSchemaName](#API_connect-customer-profiles_CreateRecommenderSchema_RequestSyntax) ** The name of the recommender schema. The name must be unique within the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Fields](#API_connect-customer-profiles_CreateRecommenderSchema_RequestSyntax) ** A map of dataset type to column definitions that specifies which data columns to include in the schema. Currently only the `_webAnalytics` key is supported. Type: String to array of [RecommenderSchemaField](API_connect-customer-profiles_RecommenderSchemaField.md) objects map Map Entries: Maximum number of 1 item. Array Members: Minimum number of 1 item. Maximum number of 9 items. Required: Yes ** [Tags](#API_connect-customer-profiles_CreateRecommenderSchema_RequestSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreatedAt": number, "Fields": { "string" : [ { "ContentType": "string", "FeatureType": "string", "TargetFieldName": "string" } ] }, "RecommenderSchemaArn": "string", "RecommenderSchemaName": "string", "Status": "string", "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedAt](#API_connect-customer-profiles_CreateRecommenderSchema_ResponseSyntax) ** The timestamp of when the recommender schema was created. Type: Timestamp ** [Fields](#API_connect-customer-profiles_CreateRecommenderSchema_ResponseSyntax) ** A map of dataset type to column definitions included in the schema. Type: String to array of [RecommenderSchemaField](API_connect-customer-profiles_RecommenderSchemaField.md) objects map Map Entries: Maximum number of 1 item. Array Members: Minimum number of 1 item. Maximum number of 9 items. ** [RecommenderSchemaArn](#API_connect-customer-profiles_CreateRecommenderSchema_ResponseSyntax) ** The Amazon Resource Name (ARN) of the recommender schema. Type: String Pattern: `arn:([a-z\d-]+):profile:.*:.*:.+` ** [RecommenderSchemaName](#API_connect-customer-profiles_CreateRecommenderSchema_ResponseSyntax) ** The name of the recommender schema. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [Status](#API_connect-customer-profiles_CreateRecommenderSchema_ResponseSyntax) ** The status of the recommender schema. Type: String Valid Values: `ACTIVE | DELETING` ** [Tags](#API_connect-customer-profiles_CreateRecommenderSchema_ResponseSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/CreateRecommenderSchema) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/CreateRecommenderSchema) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/CreateRecommenderSchema) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/CreateRecommenderSchema) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/CreateRecommenderSchema) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/CreateRecommenderSchema) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/CreateRecommenderSchema) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/CreateRecommenderSchema) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/CreateRecommenderSchema) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/CreateRecommenderSchema) # CreateSegmentDefinition Creates a segment definition associated to the given domain. ## Request Syntax ``` POST /domains/DomainName/segment-definitions/SegmentDefinitionName HTTP/1.1 Content-type: application/json { "Description": "string", "DisplayName": "string", "SegmentGroups": { "Groups": [ { "Dimensions": [ { ... } ], "SourceSegments": [ { "SegmentDefinitionName": "string" } ], "SourceType": "string", "Type": "string" } ], "Include": "string" }, "SegmentSort": { "Attributes": [ { "DataType": "string", "Name": "string", "Order": "string", "Type": "string" } ] }, "SegmentSqlQuery": "string", "Tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_CreateSegmentDefinition_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [SegmentDefinitionName](#API_connect-customer-profiles_CreateSegmentDefinition_RequestSyntax) ** The unique name of the segment definition. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Description](#API_connect-customer-profiles_CreateSegmentDefinition_RequestSyntax) ** The description of the segment definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 4000. Required: No ** [DisplayName](#API_connect-customer-profiles_CreateSegmentDefinition_RequestSyntax) ** The display name of the segment definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ** [SegmentGroups](#API_connect-customer-profiles_CreateSegmentDefinition_RequestSyntax) ** Specifies the base segments and dimensions for a segment definition along with their respective relationship. Type: [SegmentGroup](API_connect-customer-profiles_SegmentGroup.md) object Required: No ** [SegmentSort](#API_connect-customer-profiles_CreateSegmentDefinition_RequestSyntax) ** The segment sort. Type: [SegmentSort](API_connect-customer-profiles_SegmentSort.md) object Required: No ** [SegmentSqlQuery](#API_connect-customer-profiles_CreateSegmentDefinition_RequestSyntax) ** The segment SQL query. Type: String Length Constraints: Minimum length of 1. Maximum length of 50000. Required: No ** [Tags](#API_connect-customer-profiles_CreateSegmentDefinition_RequestSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreatedAt": number, "Description": "string", "DisplayName": "string", "SegmentDefinitionArn": "string", "SegmentDefinitionName": "string", "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedAt](#API_connect-customer-profiles_CreateSegmentDefinition_ResponseSyntax) ** The timestamp of when the segment definition was created. Type: Timestamp ** [Description](#API_connect-customer-profiles_CreateSegmentDefinition_ResponseSyntax) ** The description of the segment definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 4000. ** [DisplayName](#API_connect-customer-profiles_CreateSegmentDefinition_ResponseSyntax) ** The display name of the segment definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [SegmentDefinitionArn](#API_connect-customer-profiles_CreateSegmentDefinition_ResponseSyntax) ** The arn of the segment definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [SegmentDefinitionName](#API_connect-customer-profiles_CreateSegmentDefinition_ResponseSyntax) ** The name of the segment definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [Tags](#API_connect-customer-profiles_CreateSegmentDefinition_ResponseSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/CreateSegmentDefinition) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/CreateSegmentDefinition) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/CreateSegmentDefinition) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/CreateSegmentDefinition) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/CreateSegmentDefinition) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/CreateSegmentDefinition) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/CreateSegmentDefinition) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/CreateSegmentDefinition) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/CreateSegmentDefinition) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/CreateSegmentDefinition) # CreateSegmentEstimate Creates a segment estimate query. ## Request Syntax ``` POST /domains/DomainName/segment-estimates HTTP/1.1 Content-type: application/json { "SegmentQuery": { "Groups": [ { "Dimensions": [ { ... } ], "SourceSegments": [ { "SegmentDefinitionName": "string" } ], "SourceType": "string", "Type": "string" } ], "Include": "string" }, "SegmentSqlQuery": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_CreateSegmentEstimate_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [SegmentQuery](#API_connect-customer-profiles_CreateSegmentEstimate_RequestSyntax) ** The segment query for calculating a segment estimate. Type: [SegmentGroupStructure](API_connect-customer-profiles_SegmentGroupStructure.md) object Required: No ** [SegmentSqlQuery](#API_connect-customer-profiles_CreateSegmentEstimate_RequestSyntax) ** The segment SQL query. Type: String Length Constraints: Minimum length of 1. Maximum length of 50000. Required: No ## Response Syntax ``` HTTP/1.1 StatusCode Content-type: application/json { "DomainName": "string", "EstimateId": "string" } ``` ## Response Elements If the action is successful, the service sends back the following HTTP response. ** [StatusCode](#API_connect-customer-profiles_CreateSegmentEstimate_ResponseSyntax) ** The status code for the response. The following data is returned in JSON format by the service. ** [DomainName](#API_connect-customer-profiles_CreateSegmentEstimate_ResponseSyntax) ** The unique name of the domain. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [EstimateId](#API_connect-customer-profiles_CreateSegmentEstimate_ResponseSyntax) ** A unique identifier for the resource. The value can be passed to `GetSegmentEstimate` to retrieve the result of segment estimate status. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/CreateSegmentEstimate) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/CreateSegmentEstimate) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/CreateSegmentEstimate) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/CreateSegmentEstimate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/CreateSegmentEstimate) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/CreateSegmentEstimate) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/CreateSegmentEstimate) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/CreateSegmentEstimate) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/CreateSegmentEstimate) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/CreateSegmentEstimate) # CreateSegmentSnapshot Triggers a job to export a segment to a specified destination. ## Request Syntax ``` POST /domains/DomainName/segments/SegmentDefinitionName/snapshots HTTP/1.1 Content-type: application/json { "DataFormat": "string", "DestinationUri": "string", "EncryptionKey": "string", "RoleArn": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_CreateSegmentSnapshot_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [SegmentDefinitionName](#API_connect-customer-profiles_CreateSegmentSnapshot_RequestSyntax) ** The name of the segment definition used in this snapshot request. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [DataFormat](#API_connect-customer-profiles_CreateSegmentSnapshot_RequestSyntax) ** The format in which the segment will be exported. Type: String Valid Values: `CSV | JSONL | ORC` Required: Yes ** [DestinationUri](#API_connect-customer-profiles_CreateSegmentSnapshot_RequestSyntax) ** The destination to which the segment will be exported. This field must be provided if the request is not submitted from the Amazon Connect Admin Website. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** [EncryptionKey](#API_connect-customer-profiles_CreateSegmentSnapshot_RequestSyntax) ** The Amazon Resource Name (ARN) of the KMS key used to encrypt the exported segment. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Required: No ** [RoleArn](#API_connect-customer-profiles_CreateSegmentSnapshot_RequestSyntax) ** The Amazon Resource Name (ARN) of the IAM role that allows Customer Profiles service principal to assume the role for conducting KMS and S3 operations. Type: String Length Constraints: Maximum length of 512. Pattern: `arn:aws:iam:.*:[0-9]+:.*` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "SnapshotId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [SnapshotId](#API_connect-customer-profiles_CreateSegmentSnapshot_ResponseSyntax) ** The unique identifier of the segment snapshot. Type: String Pattern: `[a-f0-9]{32}` ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/CreateSegmentSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/CreateSegmentSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/CreateSegmentSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/CreateSegmentSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/CreateSegmentSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/CreateSegmentSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/CreateSegmentSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/CreateSegmentSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/CreateSegmentSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/CreateSegmentSnapshot) # CreateUploadJob Creates an Upload job to ingest data for segment imports. The metadata is created for the job with the provided field mapping and unique key. ## Request Syntax ``` POST /domains/DomainName/upload-jobs HTTP/1.1 Content-type: application/json { "DataExpiry": number, "DisplayName": "string", "Fields": { "string" : { "ContentType": "string", "Source": "string", "Target": "string" } }, "UniqueKey": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_CreateUploadJob_RequestSyntax) ** The unique name of the domain. Domain should be exists for the upload job to be created. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [DataExpiry](#API_connect-customer-profiles_CreateUploadJob_RequestSyntax) ** The expiry duration for the profiles ingested with the job. If not provided, the system default of 2 weeks is used. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1098. Required: No ** [DisplayName](#API_connect-customer-profiles_CreateUploadJob_RequestSyntax) ** The unique name of the upload job. Could be a file name to identify the upload job. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ** [Fields](#API_connect-customer-profiles_CreateUploadJob_RequestSyntax) ** The mapping between CSV Columns and Profile Object attributes. A map of the name and ObjectType field. Type: String to [ObjectTypeField](API_connect-customer-profiles_ObjectTypeField.md) object map Key Length Constraints: Minimum length of 1. Maximum length of 64. Key Pattern: `^[a-zA-Z0-9_.-]+$` Required: Yes ** [UniqueKey](#API_connect-customer-profiles_CreateUploadJob_RequestSyntax) ** The unique key columns for de-duping the profiles used to map data to the profile. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "JobId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [JobId](#API_connect-customer-profiles_CreateUploadJob_ResponseSyntax) ** The unique identifier for the created upload job. Type: String Pattern: `[a-f0-9]{32}` ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/CreateUploadJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/CreateUploadJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/CreateUploadJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/CreateUploadJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/CreateUploadJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/CreateUploadJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/CreateUploadJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/CreateUploadJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/CreateUploadJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/CreateUploadJob) # DeleteCalculatedAttributeDefinition 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. ## Request Syntax ``` DELETE /domains/DomainName/calculated-attributes/CalculatedAttributeName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [CalculatedAttributeName](#API_connect-customer-profiles_DeleteCalculatedAttributeDefinition_RequestSyntax) ** The unique name of the calculated attribute. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` Required: Yes ** [DomainName](#API_connect-customer-profiles_DeleteCalculatedAttributeDefinition_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinition) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinition) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinition) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinition) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinition) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinition) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinition) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinition) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinition) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinition) # DeleteDomain Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects. ## Request Syntax ``` DELETE /domains/DomainName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_DeleteDomain_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Message": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Message](#API_connect-customer-profiles_DeleteDomain_ResponseSyntax) ** A message that indicates the delete request is done. Type: String ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## Examples ### Example This example illustrates one usage of DeleteDomain. #### Sample Request ``` DELETE /v1/domains/ExampleDomainName HTTP/1.1 ``` #### Sample Response ``` Content-type: application/json { "Message": "Domain Deleted" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteDomain) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteDomain) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteDomain) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteDomain) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteDomain) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteDomain) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteDomain) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteDomain) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteDomain) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteDomain) # DeleteDomainLayout Deletes the layout used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website. ## Request Syntax ``` DELETE /domains/DomainName/layouts/LayoutDefinitionName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_DeleteDomainLayout_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [LayoutDefinitionName](#API_connect-customer-profiles_DeleteDomainLayout_RequestSyntax) ** The unique name of the layout. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Message": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Message](#API_connect-customer-profiles_DeleteDomainLayout_ResponseSyntax) ** A message that indicates the delete request is done. Type: String ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteDomainLayout) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteDomainLayout) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteDomainLayout) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteDomainLayout) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteDomainLayout) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteDomainLayout) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteDomainLayout) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteDomainLayout) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteDomainLayout) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteDomainLayout) # DeleteDomainObjectType Delete a DomainObjectType for the given Domain and ObjectType name. ## Request Syntax ``` DELETE /domains/DomainName/domain-object-types/ObjectTypeName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_DeleteDomainObjectType_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [ObjectTypeName](#API_connect-customer-profiles_DeleteDomainObjectType_RequestSyntax) ** The unique name of the domain object type. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteDomainObjectType) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteDomainObjectType) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteDomainObjectType) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteDomainObjectType) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteDomainObjectType) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteDomainObjectType) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteDomainObjectType) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteDomainObjectType) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteDomainObjectType) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteDomainObjectType) # DeleteEventStream Disables and deletes the specified event stream. ## Request Syntax ``` DELETE /domains/DomainName/event-streams/EventStreamName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_DeleteEventStream_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [EventStreamName](#API_connect-customer-profiles_DeleteEventStream_RequestSyntax) ** The name of the event stream Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteEventStream) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteEventStream) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteEventStream) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteEventStream) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteEventStream) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteEventStream) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteEventStream) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteEventStream) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteEventStream) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteEventStream) # DeleteEventTrigger Disable and deletes the Event Trigger. **Note** You cannot delete an Event Trigger with an active Integration associated. ## Request Syntax ``` DELETE /domains/DomainName/event-triggers/EventTriggerName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_DeleteEventTrigger_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [EventTriggerName](#API_connect-customer-profiles_DeleteEventTrigger_RequestSyntax) ** The unique name of the event trigger. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Message": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Message](#API_connect-customer-profiles_DeleteEventTrigger_ResponseSyntax) ** A message that indicates the delete request is done. Type: String ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteEventTrigger) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteEventTrigger) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteEventTrigger) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteEventTrigger) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteEventTrigger) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteEventTrigger) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteEventTrigger) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteEventTrigger) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteEventTrigger) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteEventTrigger) # DeleteIntegration Removes an integration from a specific domain. ## Request Syntax ``` POST /domains/DomainName/integrations/delete HTTP/1.1 Content-type: application/json { "Uri": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_DeleteIntegration_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Uri](#API_connect-customer-profiles_DeleteIntegration_RequestSyntax) ** The URI of the S3 bucket or any other type of data source. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Message": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Message](#API_connect-customer-profiles_DeleteIntegration_ResponseSyntax) ** A message that indicates the delete request is done. Type: String ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## Examples ### Example This example illustrates one usage of DeleteIntegration. #### Sample Request ``` POST /domains/{DomainName}/integrations/delete HTTP/1.1 { "Uri": "arn:aws:sqs:us-east-1:123456789012:URIOfIntegration1" } ``` #### Sample Response ``` Content-type: application/json { "Message": "Deleted" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteIntegration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteIntegration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteIntegration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteIntegration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteIntegration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteIntegration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteIntegration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteIntegration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteIntegration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteIntegration) # DeleteProfile Deletes the standard customer profile and all data pertaining to the profile. ## Request Syntax ``` POST /domains/DomainName/profiles/delete HTTP/1.1 Content-type: application/json { "ProfileId": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_DeleteProfile_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [ProfileId](#API_connect-customer-profiles_DeleteProfile_RequestSyntax) ** The unique identifier of a customer profile. Type: String Pattern: `[a-f0-9]{32}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Message": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Message](#API_connect-customer-profiles_DeleteProfile_ResponseSyntax) ** A message that indicates the delete request is done. Type: String ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## Examples ### Example This example illustrates one usage of DeleteProfile. #### Sample Request ``` POST /domains/ExampleDomainName/profiles/delete HTTP/1.1 Content-type: application/json { "ProfileId": "3991a7d959d248bba82546b2dEXAMPLE" } ``` #### Sample Response ``` Content-type: application/json { "Message": "OK" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteProfile) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteProfile) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteProfile) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteProfile) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteProfile) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteProfile) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteProfile) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteProfile) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteProfile) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteProfile) # DeleteProfileKey Removes a searchable key from a customer profile. ## Request Syntax ``` POST /domains/DomainName/profiles/keys/delete HTTP/1.1 Content-type: application/json { "KeyName": "string", "ProfileId": "string", "Values": [ "string" ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_DeleteProfileKey_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [KeyName](#API_connect-customer-profiles_DeleteProfileKey_RequestSyntax) ** A searchable identifier of a customer profile. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [ProfileId](#API_connect-customer-profiles_DeleteProfileKey_RequestSyntax) ** The unique identifier of a customer profile. Type: String Pattern: `[a-f0-9]{32}` Required: Yes ** [Values](#API_connect-customer-profiles_DeleteProfileKey_RequestSyntax) ** A list of key values. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Message": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Message](#API_connect-customer-profiles_DeleteProfileKey_ResponseSyntax) ** A message that indicates the delete request is done. Type: String ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## Examples ### Example This example illustrates one usage of DeleteProfileKey. #### Sample Request ``` POST /domains/ExampleDomainName/profiles/keys/delete HTTP/1.1 Content-type: application/json { "KeyName": "_phone", "ProfileId": "3991a7d959d248bba82546b2dEXAMPLE", "Values": [ "555-445-3344" ] } ``` #### Sample Response ``` Content-type: application/json { "Message": "OK" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteProfileKey) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteProfileKey) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteProfileKey) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteProfileKey) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteProfileKey) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteProfileKey) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteProfileKey) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteProfileKey) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteProfileKey) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteProfileKey) # DeleteProfileObject Removes an object associated with a profile of a given ProfileObjectType. ## Request Syntax ``` POST /domains/DomainName/profiles/objects/delete HTTP/1.1 Content-type: application/json { "ObjectTypeName": "string", "ProfileId": "string", "ProfileObjectUniqueKey": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_DeleteProfileObject_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [ObjectTypeName](#API_connect-customer-profiles_DeleteProfileObject_RequestSyntax) ** The name of the profile object type. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` Required: Yes ** [ProfileId](#API_connect-customer-profiles_DeleteProfileObject_RequestSyntax) ** The unique identifier of a customer profile. Type: String Pattern: `[a-f0-9]{32}` Required: Yes ** [ProfileObjectUniqueKey](#API_connect-customer-profiles_DeleteProfileObject_RequestSyntax) ** The unique identifier of the profile object generated by the service. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Message": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Message](#API_connect-customer-profiles_DeleteProfileObject_ResponseSyntax) ** A message that indicates the delete request is done. Type: String ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## Examples ### Example This example illustrates one usage of DeleteProfileObject. #### Sample Request ``` POST /domains/DomainName/profiles/objects/delete HTTP/1.1 Content-type: application/json { "ObjectTypeName": "MyCustomObjectName", "ProfileId": "3991a7d959d248bba82546b2dEXAMPLE", "ProfileObjectUniqueKey": "UniqueKeyOfTheProfileObject" } ``` #### Sample Response ``` Content-type: application/json { "Message": "OK" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteProfileObject) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteProfileObject) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteProfileObject) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteProfileObject) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteProfileObject) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteProfileObject) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteProfileObject) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteProfileObject) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteProfileObject) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteProfileObject) # DeleteProfileObjectType 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. ## Request Syntax ``` DELETE /domains/DomainName/object-types/ObjectTypeName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_DeleteProfileObjectType_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [ObjectTypeName](#API_connect-customer-profiles_DeleteProfileObjectType_RequestSyntax) ** The name of the profile object type. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Message": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Message](#API_connect-customer-profiles_DeleteProfileObjectType_ResponseSyntax) ** A message that indicates the delete request is done. Type: String ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## Examples ### Example This example illustrates one usage of DeleteProfileObjectType. #### Sample Request ``` DELETE /domains/ExampleDomainName/object-types/MyCustomObjectTypeName HTTP/1.1 ``` #### Sample Response ``` Content-type: application/json { "Message": "Deleted" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteProfileObjectType) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteProfileObjectType) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteProfileObjectType) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteProfileObjectType) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteProfileObjectType) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteProfileObjectType) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteProfileObjectType) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteProfileObjectType) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteProfileObjectType) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteProfileObjectType) # DeleteRecommender Deletes a recommender. ## Request Syntax ``` DELETE /domains/DomainName/recommenders/RecommenderName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_DeleteRecommender_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [RecommenderName](#API_connect-customer-profiles_DeleteRecommender_RequestSyntax) ** The recommender name. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteRecommender) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteRecommender) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteRecommender) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteRecommender) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteRecommender) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteRecommender) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteRecommender) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteRecommender) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteRecommender) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteRecommender) # DeleteRecommenderFilter Deletes a recommender filter from a domain. ## Request Syntax ``` DELETE /domains/DomainName/recommender-filters/RecommenderFilterName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_DeleteRecommenderFilter_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [RecommenderFilterName](#API_connect-customer-profiles_DeleteRecommenderFilter_RequestSyntax) ** The name of the recommender filter to delete. Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9_-]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Message": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Message](#API_connect-customer-profiles_DeleteRecommenderFilter_ResponseSyntax) ** A message that indicates the delete request is done. Type: String ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteRecommenderFilter) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteRecommenderFilter) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteRecommenderFilter) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteRecommenderFilter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteRecommenderFilter) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteRecommenderFilter) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteRecommenderFilter) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteRecommenderFilter) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteRecommenderFilter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteRecommenderFilter) # DeleteRecommenderSchema Deletes a recommender schema from a domain. ## Request Syntax ``` DELETE /domains/DomainName/recommender-schemas/RecommenderSchemaName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_DeleteRecommenderSchema_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [RecommenderSchemaName](#API_connect-customer-profiles_DeleteRecommenderSchema_RequestSyntax) ** The name of the recommender schema to delete. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteRecommenderSchema) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteRecommenderSchema) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteRecommenderSchema) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteRecommenderSchema) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteRecommenderSchema) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteRecommenderSchema) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteRecommenderSchema) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteRecommenderSchema) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteRecommenderSchema) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteRecommenderSchema) # DeleteSegmentDefinition Deletes a segment definition from the domain. ## Request Syntax ``` DELETE /domains/DomainName/segment-definitions/SegmentDefinitionName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_DeleteSegmentDefinition_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [SegmentDefinitionName](#API_connect-customer-profiles_DeleteSegmentDefinition_RequestSyntax) ** The unique name of the segment definition. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Message": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Message](#API_connect-customer-profiles_DeleteSegmentDefinition_ResponseSyntax) ** A message that indicates the delete request is done. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteSegmentDefinition) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteSegmentDefinition) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteSegmentDefinition) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteSegmentDefinition) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteSegmentDefinition) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteSegmentDefinition) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteSegmentDefinition) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteSegmentDefinition) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteSegmentDefinition) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteSegmentDefinition) # DeleteWorkflow Deletes the specified workflow and all its corresponding resources. This is an async process. ## Request Syntax ``` DELETE /domains/DomainName/workflows/WorkflowId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_DeleteWorkflow_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [WorkflowId](#API_connect-customer-profiles_DeleteWorkflow_RequestSyntax) ** Unique identifier for the workflow. Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteWorkflow) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteWorkflow) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteWorkflow) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteWorkflow) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteWorkflow) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteWorkflow) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteWorkflow) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteWorkflow) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteWorkflow) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteWorkflow) # DetectProfileObjectType The process of detecting profile object type mapping by using given objects. ## Request Syntax ``` POST /domains/DomainName/detect/object-types HTTP/1.1 Content-type: application/json { "Objects": [ "string" ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_DetectProfileObjectType_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Objects](#API_connect-customer-profiles_DetectProfileObjectType_RequestSyntax) ** A string that is serialized from a JSON object. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 256000. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DetectedProfileObjectTypes": [ { "Fields": { "string" : { "ContentType": "string", "Source": "string", "Target": "string" } }, "Keys": { "string" : [ { "FieldNames": [ "string" ], "StandardIdentifiers": [ "string" ] } ] }, "SourceLastUpdatedTimestampFormat": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DetectedProfileObjectTypes](#API_connect-customer-profiles_DetectProfileObjectType_ResponseSyntax) ** Detected `ProfileObjectType` mappings from given objects. A maximum of one mapping is supported. Type: Array of [DetectedProfileObjectType](API_connect-customer-profiles_DetectedProfileObjectType.md) objects ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DetectProfileObjectType) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DetectProfileObjectType) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DetectProfileObjectType) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DetectProfileObjectType) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DetectProfileObjectType) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DetectProfileObjectType) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DetectProfileObjectType) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DetectProfileObjectType) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DetectProfileObjectType) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DetectProfileObjectType) # GetAutoMergingPreview 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. **Important** We strongly recommend you use this API to do a dry run of the automerging process before running the Identity Resolution Job. Include **at least** two matching attributes. If your matching list includes too few attributes (such as only `FirstName` or only `LastName`), there may be a large number of matches. This increases the chances of erroneous merges. ## Request Syntax ``` POST /domains/DomainName/identity-resolution-jobs/auto-merging-preview HTTP/1.1 Content-type: application/json { "ConflictResolution": { "ConflictResolvingModel": "string", "SourceName": "string" }, "Consolidation": { "MatchingAttributesList": [ [ "string" ] ] }, "MinAllowedConfidenceScoreForMerging": number } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_GetAutoMergingPreview_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [ConflictResolution](#API_connect-customer-profiles_GetAutoMergingPreview_RequestSyntax) ** How the auto-merging process should resolve conflicts between different profiles. Type: [ConflictResolution](API_connect-customer-profiles_ConflictResolution.md) object Required: Yes ** [Consolidation](#API_connect-customer-profiles_GetAutoMergingPreview_RequestSyntax) ** A list of matching attributes that represent matching criteria. Type: [Consolidation](API_connect-customer-profiles_Consolidation.md) object Required: Yes ** [MinAllowedConfidenceScoreForMerging](#API_connect-customer-profiles_GetAutoMergingPreview_RequestSyntax) ** Minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. Type: Double Valid Range: Minimum value of 0.0. Maximum value of 1.0. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DomainName": "string", "NumberOfMatchesInSample": number, "NumberOfProfilesInSample": number, "NumberOfProfilesWillBeMerged": number } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DomainName](#API_connect-customer-profiles_GetAutoMergingPreview_ResponseSyntax) ** The unique name of the domain. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [NumberOfMatchesInSample](#API_connect-customer-profiles_GetAutoMergingPreview_ResponseSyntax) ** The number of match groups in the domain that have been reviewed in this preview dry run. Type: Long ** [NumberOfProfilesInSample](#API_connect-customer-profiles_GetAutoMergingPreview_ResponseSyntax) ** The number of profiles found in this preview dry run. Type: Long ** [NumberOfProfilesWillBeMerged](#API_connect-customer-profiles_GetAutoMergingPreview_ResponseSyntax) ** The number of profiles that would be merged if this wasn't a preview dry run. Type: Long ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetAutoMergingPreview) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetAutoMergingPreview) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetAutoMergingPreview) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetAutoMergingPreview) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetAutoMergingPreview) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetAutoMergingPreview) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetAutoMergingPreview) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetAutoMergingPreview) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetAutoMergingPreview) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetAutoMergingPreview) # GetCalculatedAttributeDefinition Provides more information on a calculated attribute definition for Customer Profiles. ## Request Syntax ``` GET /domains/DomainName/calculated-attributes/CalculatedAttributeName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [CalculatedAttributeName](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_RequestSyntax) ** The unique name of the calculated attribute. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` Required: Yes ** [DomainName](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "AttributeDetails": { "Attributes": [ { "Name": "string" } ], "Expression": "string" }, "CalculatedAttributeName": "string", "Conditions": { "ObjectCount": number, "Range": { "TimestampFormat": "string", "TimestampSource": "string", "Unit": "string", "Value": number, "ValueRange": { "End": number, "Start": number } }, "Threshold": { "Operator": "string", "Value": "string" } }, "CreatedAt": number, "Description": "string", "DisplayName": "string", "Filter": { "Groups": [ { "Dimensions": [ { "Attributes": { "string" : { "DimensionType": "string", "Values": [ "string" ] } } } ], "Type": "string" } ], "Include": "string" }, "LastUpdatedAt": number, "Readiness": { "Message": "string", "ProgressPercentage": number }, "Statistic": "string", "Status": "string", "Tags": { "string" : "string" }, "UseHistoricalData": boolean } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AttributeDetails](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseSyntax) ** Mathematical expression and a list of attribute items specified in that expression. Type: [AttributeDetails](API_connect-customer-profiles_AttributeDetails.md) object ** [CalculatedAttributeName](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseSyntax) ** The unique name of the calculated attribute. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` ** [Conditions](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseSyntax) ** The conditions including range, object count, and threshold for the calculated attribute. Type: [Conditions](API_connect-customer-profiles_Conditions.md) object ** [CreatedAt](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseSyntax) ** The timestamp of when the calculated attribute definition was created. Type: Timestamp ** [Description](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseSyntax) ** The description of the calculated attribute. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. ** [DisplayName](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseSyntax) ** The display name of the calculated attribute. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-\s]*$` ** [Filter](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseSyntax) ** The filter assigned to this calculated attribute definition. Type: [Filter](API_connect-customer-profiles_Filter.md) object ** [LastUpdatedAt](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseSyntax) ** The timestamp of when the calculated attribute definition was most recently edited. Type: Timestamp ** [Readiness](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseSyntax) ** Information indicating if the Calculated Attribute is ready for use by confirming all historical data has been processed and reflected. Type: [Readiness](API_connect-customer-profiles_Readiness.md) object ** [Statistic](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseSyntax) ** The aggregation operation to perform for the calculated attribute. Type: String Valid Values: `FIRST_OCCURRENCE | LAST_OCCURRENCE | COUNT | SUM | MINIMUM | MAXIMUM | AVERAGE | MAX_OCCURRENCE` ** [Status](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseSyntax) ** Status of the Calculated Attribute creation (whether all historical data has been indexed). Type: String Valid Values: `PREPARING | IN_PROGRESS | COMPLETED | FAILED` ** [Tags](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ** [UseHistoricalData](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseSyntax) ** Whether historical data ingested before the Calculated Attribute was created should be included in calculations. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetCalculatedAttributeDefinition) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetCalculatedAttributeDefinition) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetCalculatedAttributeDefinition) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetCalculatedAttributeDefinition) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetCalculatedAttributeDefinition) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetCalculatedAttributeDefinition) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetCalculatedAttributeDefinition) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetCalculatedAttributeDefinition) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetCalculatedAttributeDefinition) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetCalculatedAttributeDefinition) # GetCalculatedAttributeForProfile Retrieve a calculated attribute for a customer profile. ## Request Syntax ``` GET /domains/DomainName/profile/ProfileId/calculated-attributes/CalculatedAttributeName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [CalculatedAttributeName](#API_connect-customer-profiles_GetCalculatedAttributeForProfile_RequestSyntax) ** The unique name of the calculated attribute. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` Required: Yes ** [DomainName](#API_connect-customer-profiles_GetCalculatedAttributeForProfile_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [ProfileId](#API_connect-customer-profiles_GetCalculatedAttributeForProfile_RequestSyntax) ** The unique identifier of a customer profile. Pattern: `[a-f0-9]{32}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CalculatedAttributeName": "string", "DisplayName": "string", "IsDataPartial": "string", "LastObjectTimestamp": number, "Value": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CalculatedAttributeName](#API_connect-customer-profiles_GetCalculatedAttributeForProfile_ResponseSyntax) ** The unique name of the calculated attribute. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` ** [DisplayName](#API_connect-customer-profiles_GetCalculatedAttributeForProfile_ResponseSyntax) ** The display name of the calculated attribute. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-\s]*$` ** [IsDataPartial](#API_connect-customer-profiles_GetCalculatedAttributeForProfile_ResponseSyntax) ** Indicates whether the calculated attribute’s value is based on partial data. If data is partial, it is set to true. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [LastObjectTimestamp](#API_connect-customer-profiles_GetCalculatedAttributeForProfile_ResponseSyntax) ** The timestamp of the newest object included in the calculated attribute calculation. Type: Timestamp ** [Value](#API_connect-customer-profiles_GetCalculatedAttributeForProfile_ResponseSyntax) ** The value of the calculated attribute. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetCalculatedAttributeForProfile) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetCalculatedAttributeForProfile) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetCalculatedAttributeForProfile) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetCalculatedAttributeForProfile) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetCalculatedAttributeForProfile) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetCalculatedAttributeForProfile) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetCalculatedAttributeForProfile) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetCalculatedAttributeForProfile) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetCalculatedAttributeForProfile) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetCalculatedAttributeForProfile) # GetDomain Returns information about a specific domain. ## Request Syntax ``` GET /domains/DomainName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_GetDomain_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreatedAt": number, "DataStore": { "Enabled": boolean, "Readiness": { "Message": "string", "ProgressPercentage": number } }, "DeadLetterQueueUrl": "string", "DefaultEncryptionKey": "string", "DefaultExpirationDays": number, "DomainName": "string", "LastUpdatedAt": number, "Matching": { "AutoMerging": { "ConflictResolution": { "ConflictResolvingModel": "string", "SourceName": "string" }, "Consolidation": { "MatchingAttributesList": [ [ "string" ] ] }, "Enabled": boolean, "MinAllowedConfidenceScoreForMerging": number }, "Enabled": boolean, "ExportingConfig": { "S3Exporting": { "S3BucketName": "string", "S3KeyName": "string" } }, "JobSchedule": { "DayOfTheWeek": "string", "Time": "string" } }, "RuleBasedMatching": { "AttributeTypesSelector": { "Address": [ "string" ], "AttributeMatchingModel": "string", "EmailAddress": [ "string" ], "PhoneNumber": [ "string" ] }, "ConflictResolution": { "ConflictResolvingModel": "string", "SourceName": "string" }, "Enabled": boolean, "ExportingConfig": { "S3Exporting": { "S3BucketName": "string", "S3KeyName": "string" } }, "MatchingRules": [ { "Rule": [ "string" ] } ], "MaxAllowedRuleLevelForMatching": number, "MaxAllowedRuleLevelForMerging": number, "Status": "string" }, "Stats": { "MeteringProfileCount": number, "ObjectCount": number, "ProfileCount": number, "TotalSize": number }, "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedAt](#API_connect-customer-profiles_GetDomain_ResponseSyntax) ** The timestamp of when the domain was created. Type: Timestamp ** [DataStore](#API_connect-customer-profiles_GetDomain_ResponseSyntax) ** True if data store is enabled for this domain. Type: [DataStoreResponse](API_connect-customer-profiles_DataStoreResponse.md) object ** [DeadLetterQueueUrl](#API_connect-customer-profiles_GetDomain_ResponseSyntax) ** The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. ** [DefaultEncryptionKey](#API_connect-customer-profiles_GetDomain_ResponseSyntax) ** The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. ** [DefaultExpirationDays](#API_connect-customer-profiles_GetDomain_ResponseSyntax) ** The default number of days until the data within the domain expires. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1098. ** [DomainName](#API_connect-customer-profiles_GetDomain_ResponseSyntax) ** The unique name of the domain. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [LastUpdatedAt](#API_connect-customer-profiles_GetDomain_ResponseSyntax) ** The timestamp of when the domain was most recently edited. Type: Timestamp ** [Matching](#API_connect-customer-profiles_GetDomain_ResponseSyntax) ** The process of matching duplicate profiles. If `Matching` = `true`, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the Identity Resolution Job completes, use the [GetMatches](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html) API to return and review the results. Or, if you have configured `ExportingConfig` in the `MatchingRequest`, you can download the results from S3. Type: [MatchingResponse](API_connect-customer-profiles_MatchingResponse.md) object ** [RuleBasedMatching](#API_connect-customer-profiles_GetDomain_ResponseSyntax) ** The process of matching duplicate profiles using the Rule-Based matching. If `RuleBasedMatching` = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the `RuleBasedMatchingRequest`. You can use the `ListRuleBasedMatches` and `GetSimilarProfiles` API to return and review the results. Also, if you have configured `ExportingConfig` in the `RuleBasedMatchingRequest`, you can download the results from S3. Type: [RuleBasedMatchingResponse](API_connect-customer-profiles_RuleBasedMatchingResponse.md) object ** [Stats](#API_connect-customer-profiles_GetDomain_ResponseSyntax) ** Usage-specific statistics about the domain. Type: [DomainStats](API_connect-customer-profiles_DomainStats.md) object ** [Tags](#API_connect-customer-profiles_GetDomain_ResponseSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetDomain) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetDomain) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetDomain) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetDomain) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetDomain) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetDomain) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetDomain) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetDomain) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetDomain) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetDomain) # GetDomainLayout Gets the layout to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website. ## Request Syntax ``` GET /domains/DomainName/layouts/LayoutDefinitionName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_GetDomainLayout_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [LayoutDefinitionName](#API_connect-customer-profiles_GetDomainLayout_RequestSyntax) ** The unique name of the layout. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreatedAt": number, "Description": "string", "DisplayName": "string", "IsDefault": boolean, "LastUpdatedAt": number, "Layout": "string", "LayoutDefinitionName": "string", "LayoutType": "string", "Tags": { "string" : "string" }, "Version": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedAt](#API_connect-customer-profiles_GetDomainLayout_ResponseSyntax) ** The timestamp of when the layout was created. Type: Timestamp ** [Description](#API_connect-customer-profiles_GetDomainLayout_ResponseSyntax) ** The description of the layout Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. ** [DisplayName](#API_connect-customer-profiles_GetDomainLayout_ResponseSyntax) ** The display name of the layout Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-\s]*$` ** [IsDefault](#API_connect-customer-profiles_GetDomainLayout_ResponseSyntax) ** If set to true for a layout, this layout will be used by default to view data. If set to false, then the layout will not be used by default, but it can be used to view data by explicitly selecting it in the console. Type: Boolean ** [LastUpdatedAt](#API_connect-customer-profiles_GetDomainLayout_ResponseSyntax) ** The timestamp of when the layout was most recently updated. Type: Timestamp ** [Layout](#API_connect-customer-profiles_GetDomainLayout_ResponseSyntax) ** A customizable layout that can be used to view data under a Customer Profiles domain. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000000. ** [LayoutDefinitionName](#API_connect-customer-profiles_GetDomainLayout_ResponseSyntax) ** The unique name of the layout. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [LayoutType](#API_connect-customer-profiles_GetDomainLayout_ResponseSyntax) ** The type of layout that can be used to view data under a Customer Profiles domain. Type: String Valid Values: `PROFILE_EXPLORER` ** [Tags](#API_connect-customer-profiles_GetDomainLayout_ResponseSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ** [Version](#API_connect-customer-profiles_GetDomainLayout_ResponseSyntax) ** The version used to create layout. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetDomainLayout) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetDomainLayout) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetDomainLayout) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetDomainLayout) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetDomainLayout) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetDomainLayout) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetDomainLayout) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetDomainLayout) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetDomainLayout) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetDomainLayout) # GetDomainObjectType Return a DomainObjectType for the input Domain and ObjectType names. ## Request Syntax ``` GET /domains/DomainName/domain-object-types/ObjectTypeName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_GetDomainObjectType_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [ObjectTypeName](#API_connect-customer-profiles_GetDomainObjectType_RequestSyntax) ** The unique name of the domain object type. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreatedAt": number, "Description": "string", "EncryptionKey": "string", "Fields": { "string" : { "ContentType": "string", "FeatureType": "string", "Source": "string", "Target": "string" } }, "LastUpdatedAt": number, "ObjectTypeName": "string", "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedAt](#API_connect-customer-profiles_GetDomainObjectType_ResponseSyntax) ** The timestamp of when the domain object type was created. Type: Timestamp ** [Description](#API_connect-customer-profiles_GetDomainObjectType_ResponseSyntax) ** The description of the domain object type. Type: String Length Constraints: Minimum length of 1. Maximum length of 10000. ** [EncryptionKey](#API_connect-customer-profiles_GetDomainObjectType_ResponseSyntax) ** The customer provided KMS key used to encrypt this type of domain object. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. ** [Fields](#API_connect-customer-profiles_GetDomainObjectType_ResponseSyntax) ** A map of field names to their corresponding domain object type field definitions. Type: String to [DomainObjectTypeField](API_connect-customer-profiles_DomainObjectTypeField.md) object map Key Length Constraints: Minimum length of 1. Maximum length of 64. Key Pattern: `^[a-zA-Z0-9_.-]+$` ** [LastUpdatedAt](#API_connect-customer-profiles_GetDomainObjectType_ResponseSyntax) ** The timestamp of when the domain object type was most recently edited. Type: Timestamp ** [ObjectTypeName](#API_connect-customer-profiles_GetDomainObjectType_ResponseSyntax) ** The unique name of the domain object type. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` ** [Tags](#API_connect-customer-profiles_GetDomainObjectType_ResponseSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetDomainObjectType) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetDomainObjectType) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetDomainObjectType) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetDomainObjectType) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetDomainObjectType) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetDomainObjectType) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetDomainObjectType) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetDomainObjectType) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetDomainObjectType) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetDomainObjectType) # GetEventStream Returns information about the specified event stream in a specific domain. ## Request Syntax ``` GET /domains/DomainName/event-streams/EventStreamName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_GetEventStream_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [EventStreamName](#API_connect-customer-profiles_GetEventStream_RequestSyntax) ** The name of the event stream provided during create operations. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreatedAt": number, "DestinationDetails": { "Message": "string", "Status": "string", "UnhealthySince": number, "Uri": "string" }, "DomainName": "string", "EventStreamArn": "string", "State": "string", "StoppedSince": number, "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedAt](#API_connect-customer-profiles_GetEventStream_ResponseSyntax) ** The timestamp of when the export was created. Type: Timestamp ** [DestinationDetails](#API_connect-customer-profiles_GetEventStream_ResponseSyntax) ** Details regarding the Kinesis stream. Type: [EventStreamDestinationDetails](API_connect-customer-profiles_EventStreamDestinationDetails.md) object ** [DomainName](#API_connect-customer-profiles_GetEventStream_ResponseSyntax) ** The unique name of the domain. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [EventStreamArn](#API_connect-customer-profiles_GetEventStream_ResponseSyntax) ** A unique identifier for the event stream. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [State](#API_connect-customer-profiles_GetEventStream_ResponseSyntax) ** The operational state of destination stream for export. Type: String Valid Values: `RUNNING | STOPPED` ** [StoppedSince](#API_connect-customer-profiles_GetEventStream_ResponseSyntax) ** The timestamp when the `State` changed to `STOPPED`. Type: Timestamp ** [Tags](#API_connect-customer-profiles_GetEventStream_ResponseSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetEventStream) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetEventStream) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetEventStream) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetEventStream) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetEventStream) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetEventStream) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetEventStream) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetEventStream) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetEventStream) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetEventStream) # GetEventTrigger Get a specific Event Trigger from the domain. ## Request Syntax ``` GET /domains/DomainName/event-triggers/EventTriggerName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_GetEventTrigger_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [EventTriggerName](#API_connect-customer-profiles_GetEventTrigger_RequestSyntax) ** The unique name of the event trigger. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreatedAt": number, "Description": "string", "EventTriggerConditions": [ { "EventTriggerDimensions": [ { "ObjectAttributes": [ { "ComparisonOperator": "string", "FieldName": "string", "Source": "string", "Values": [ "string" ] } ] } ], "LogicalOperator": "string" } ], "EventTriggerLimits": { "EventExpiration": number, "Periods": [ { "MaxInvocationsPerProfile": number, "Unit": "string", "Unlimited": boolean, "Value": number } ] }, "EventTriggerName": "string", "LastUpdatedAt": number, "ObjectTypeName": "string", "SegmentFilter": "string", "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedAt](#API_connect-customer-profiles_GetEventTrigger_ResponseSyntax) ** The timestamp of when the event trigger was created. Type: Timestamp ** [Description](#API_connect-customer-profiles_GetEventTrigger_ResponseSyntax) ** The description of the event trigger. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. ** [EventTriggerConditions](#API_connect-customer-profiles_GetEventTrigger_ResponseSyntax) ** A list of conditions that determine when an event should trigger the destination. Type: Array of [EventTriggerCondition](API_connect-customer-profiles_EventTriggerCondition.md) objects Array Members: Minimum number of 1 item. Maximum number of 5 items. ** [EventTriggerLimits](#API_connect-customer-profiles_GetEventTrigger_ResponseSyntax) ** Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods. Type: [EventTriggerLimits](API_connect-customer-profiles_EventTriggerLimits.md) object ** [EventTriggerName](#API_connect-customer-profiles_GetEventTrigger_ResponseSyntax) ** The unique name of the event trigger. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [LastUpdatedAt](#API_connect-customer-profiles_GetEventTrigger_ResponseSyntax) ** The timestamp of when the event trigger was most recently updated. Type: Timestamp ** [ObjectTypeName](#API_connect-customer-profiles_GetEventTrigger_ResponseSyntax) ** The unique name of the object type. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` ** [SegmentFilter](#API_connect-customer-profiles_GetEventTrigger_ResponseSyntax) ** The destination is triggered only for profiles that meet the criteria of a segment definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [Tags](#API_connect-customer-profiles_GetEventTrigger_ResponseSyntax) ** An array of key-value pairs to apply to this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetEventTrigger) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetEventTrigger) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetEventTrigger) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetEventTrigger) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetEventTrigger) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetEventTrigger) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetEventTrigger) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetEventTrigger) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetEventTrigger) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetEventTrigger) # GetIdentityResolutionJob 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](https://docs.aws.amazon.com/connect/latest/adminguide/use-identity-resolution.html). ## Request Syntax ``` GET /domains/DomainName/identity-resolution-jobs/JobId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_GetIdentityResolutionJob_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [JobId](#API_connect-customer-profiles_GetIdentityResolutionJob_RequestSyntax) ** The unique identifier of the Identity Resolution Job. Pattern: `[a-f0-9]{32}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "AutoMerging": { "ConflictResolution": { "ConflictResolvingModel": "string", "SourceName": "string" }, "Consolidation": { "MatchingAttributesList": [ [ "string" ] ] }, "Enabled": boolean, "MinAllowedConfidenceScoreForMerging": number }, "DomainName": "string", "ExportingLocation": { "S3Exporting": { "S3BucketName": "string", "S3KeyName": "string" } }, "JobEndTime": number, "JobExpirationTime": number, "JobId": "string", "JobStartTime": number, "JobStats": { "NumberOfMatchesFound": number, "NumberOfMergesDone": number, "NumberOfProfilesReviewed": number }, "LastUpdatedAt": number, "Message": "string", "Status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AutoMerging](#API_connect-customer-profiles_GetIdentityResolutionJob_ResponseSyntax) ** Configuration settings for how to perform the auto-merging of profiles. Type: [AutoMerging](API_connect-customer-profiles_AutoMerging.md) object ** [DomainName](#API_connect-customer-profiles_GetIdentityResolutionJob_ResponseSyntax) ** The unique name of the domain. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [ExportingLocation](#API_connect-customer-profiles_GetIdentityResolutionJob_ResponseSyntax) ** The S3 location where the Identity Resolution Job writes result files. Type: [ExportingLocation](API_connect-customer-profiles_ExportingLocation.md) object ** [JobEndTime](#API_connect-customer-profiles_GetIdentityResolutionJob_ResponseSyntax) ** The timestamp of when the Identity Resolution Job was completed. Type: Timestamp ** [JobExpirationTime](#API_connect-customer-profiles_GetIdentityResolutionJob_ResponseSyntax) ** The timestamp of when the Identity Resolution Job will expire. Type: Timestamp ** [JobId](#API_connect-customer-profiles_GetIdentityResolutionJob_ResponseSyntax) ** The unique identifier of the Identity Resolution Job. Type: String Pattern: `[a-f0-9]{32}` ** [JobStartTime](#API_connect-customer-profiles_GetIdentityResolutionJob_ResponseSyntax) ** The timestamp of when the Identity Resolution Job was started or will be started. Type: Timestamp ** [JobStats](#API_connect-customer-profiles_GetIdentityResolutionJob_ResponseSyntax) ** Statistics about the Identity Resolution Job. Type: [JobStats](API_connect-customer-profiles_JobStats.md) object ** [LastUpdatedAt](#API_connect-customer-profiles_GetIdentityResolutionJob_ResponseSyntax) ** The timestamp of when the Identity Resolution Job was most recently edited. Type: Timestamp ** [Message](#API_connect-customer-profiles_GetIdentityResolutionJob_ResponseSyntax) ** The error messages that are generated when the Identity Resolution Job runs. Type: String Length Constraints: Maximum length of 2048. Pattern: `.*` ** [Status](#API_connect-customer-profiles_GetIdentityResolutionJob_ResponseSyntax) ** The status of the Identity Resolution Job. + `PENDING`: The Identity Resolution Job is scheduled but has not started yet. If you turn off the Identity Resolution feature in your domain, jobs in the `PENDING` state are deleted. + `PREPROCESSING`: The Identity Resolution Job is loading your data. + `FIND_MATCHING`: The Identity Resolution Job is using the machine learning model to identify profiles that belong to the same matching group. + `MERGING`: The Identity Resolution Job is merging duplicate profiles. + `COMPLETED`: The Identity Resolution Job completed successfully. + `PARTIAL_SUCCESS`: There's a system error and not all of the data is merged. The Identity Resolution Job writes a message indicating the source of the problem. + `FAILED`: The Identity Resolution Job did not merge any data. It writes a message indicating the source of the problem. Type: String Valid Values: `PENDING | PREPROCESSING | FIND_MATCHING | MERGING | COMPLETED | PARTIAL_SUCCESS | FAILED` ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetIdentityResolutionJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetIdentityResolutionJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetIdentityResolutionJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetIdentityResolutionJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetIdentityResolutionJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetIdentityResolutionJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetIdentityResolutionJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetIdentityResolutionJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetIdentityResolutionJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetIdentityResolutionJob) # GetIntegration Returns an integration for a domain. ## Request Syntax ``` POST /domains/DomainName/integrations HTTP/1.1 Content-type: application/json { "Uri": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_GetIntegration_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Uri](#API_connect-customer-profiles_GetIntegration_RequestSyntax) ** The URI of the S3 bucket or any other type of data source. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreatedAt": number, "DomainName": "string", "EventTriggerNames": [ "string" ], "IsUnstructured": boolean, "LastUpdatedAt": number, "ObjectTypeName": "string", "ObjectTypeNames": { "string" : "string" }, "RoleArn": "string", "Scope": "string", "Tags": { "string" : "string" }, "Uri": "string", "WorkflowId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedAt](#API_connect-customer-profiles_GetIntegration_ResponseSyntax) ** The timestamp of when the domain was created. Type: Timestamp ** [DomainName](#API_connect-customer-profiles_GetIntegration_ResponseSyntax) ** The unique name of the domain. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [EventTriggerNames](#API_connect-customer-profiles_GetIntegration_ResponseSyntax) ** A list of unique names for active event triggers associated with the integration. This list would be empty if no Event Trigger is associated with the integration. Type: Array of strings Array Members: Fixed number of 1 item. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [IsUnstructured](#API_connect-customer-profiles_GetIntegration_ResponseSyntax) ** Boolean that shows if the Flow that's associated with the Integration is created in Amazon Appflow, or with ObjectTypeName equals \$1unstructured via API/CLI in flowDefinition. Type: Boolean ** [LastUpdatedAt](#API_connect-customer-profiles_GetIntegration_ResponseSyntax) ** The timestamp of when the domain was most recently edited. Type: Timestamp ** [ObjectTypeName](#API_connect-customer-profiles_GetIntegration_ResponseSyntax) ** The name of the profile object type. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` ** [ObjectTypeNames](#API_connect-customer-profiles_GetIntegration_ResponseSyntax) ** A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an `ObjectTypeName` (template) used to ingest the event. It supports the following event types: `SegmentIdentify`, `ShopifyCreateCustomers`, `ShopifyUpdateCustomers`, `ShopifyCreateDraftOrders`, `ShopifyUpdateDraftOrders`, `ShopifyCreateOrders`, and `ShopifyUpdatedOrders`. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 255. Value Length Constraints: Minimum length of 1. Maximum length of 255. Value Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` ** [RoleArn](#API_connect-customer-profiles_GetIntegration_ResponseSyntax) ** The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make Customer Profiles requests on your behalf. Type: String Length Constraints: Maximum length of 512. Pattern: `arn:aws:iam:.*:[0-9]+:.*` ** [Scope](#API_connect-customer-profiles_GetIntegration_ResponseSyntax) ** Specifies whether the integration applies to profile level data (associated with profiles) or domain level data (not associated with any specific profile). The default value is PROFILE. Type: String Valid Values: `PROFILE | DOMAIN` ** [Tags](#API_connect-customer-profiles_GetIntegration_ResponseSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ** [Uri](#API_connect-customer-profiles_GetIntegration_ResponseSyntax) ** The URI of the S3 bucket or any other type of data source. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [WorkflowId](#API_connect-customer-profiles_GetIntegration_ResponseSyntax) ** Unique identifier for the workflow. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## Examples ### Example This example illustrates one usage of GetIntegration. #### Sample Request ``` POST /domains/ExampleDomainName/integrations HTTP/1.1 { "Uri": "arn:aws:flow:us-east-1:123456789012:URIOfIntegration1" } ``` #### Sample Response ``` Content-type: application/json { "CreatedAt": 1479249799770, "DomainName": "ExampleDomainName", "LastUpdatedAt": 1479249799770, "ObjectTypeName": "MyCustomObject", "Uri": "arn:aws:flow:us-east-1:123456789012:URIOfIntegration1" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetIntegration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetIntegration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetIntegration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetIntegration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetIntegration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetIntegration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetIntegration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetIntegration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetIntegration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetIntegration) # GetMatches Before calling this API, use [CreateDomain](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html) or [UpdateDomain](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html) 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. **Important** The process of matching duplicate profiles. If `Matching` = `true`, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the Identity Resolution Job completes, use the [GetMatches](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html) API to return and review the results. Or, if you have configured `ExportingConfig` in the `MatchingRequest`, you can download the results from S3. Amazon Connect uses the following profile attributes to identify matches: + PhoneNumber + HomePhoneNumber + BusinessPhoneNumber + MobilePhoneNumber + EmailAddress + PersonalEmailAddress + BusinessEmailAddress + FullName For example, two or more profiles—with spelling mistakes such as **John Doe** and **Jhn Doe**, or different casing email addresses such as **JOHN\$1DOE@ANYCOMPANY.COM** and **johndoe@anycompany.com**, or different phone number formats such as **555-010-0000** and **\$11-555-010-0000**—can be detected as belonging to the same customer **John Doe** and merged into a unified profile. ## Request Syntax ``` GET /domains/DomainName/matches?max-results=MaxResults&next-token=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_GetMatches_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [MaxResults](#API_connect-customer-profiles_GetMatches_RequestSyntax) ** The maximum number of results to return per page. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_connect-customer-profiles_GetMatches_RequestSyntax) ** The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Length Constraints: Minimum length of 1. Maximum length of 1024. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Matches": [ { "ConfidenceScore": number, "MatchId": "string", "ProfileIds": [ "string" ] } ], "MatchGenerationDate": number, "NextToken": "string", "PotentialMatches": number } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Matches](#API_connect-customer-profiles_GetMatches_ResponseSyntax) ** The list of matched profiles for this instance. Type: Array of [MatchItem](API_connect-customer-profiles_MatchItem.md) objects ** [MatchGenerationDate](#API_connect-customer-profiles_GetMatches_ResponseSyntax) ** The timestamp this version of Match Result generated. Type: Timestamp ** [NextToken](#API_connect-customer-profiles_GetMatches_ResponseSyntax) ** If there are additional results, this is the token for the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ** [PotentialMatches](#API_connect-customer-profiles_GetMatches_ResponseSyntax) ** The number of potential matches found. Type: Integer Valid Range: Minimum value of 0. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetMatches) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetMatches) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetMatches) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetMatches) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetMatches) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetMatches) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetMatches) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetMatches) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetMatches) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetMatches) # GetObjectTypeAttributeStatistics The GetObjectTypeAttributeValues API delivers statistical insights about attributes within a specific object type, but is exclusively available for domains with data store enabled. This API performs daily calculations to provide statistical information about your attribute values, helping you understand patterns and trends in your data. The statistical calculations are performed once per day, providing a consistent snapshot of your attribute data characteristics. **Note** You'll receive null values in two scenarios: During the first period after enabling data vault (unless a calculation cycle occurs, which happens once daily). For attributes that don't contain numeric values. ## Request Syntax ``` POST /domains/DomainName/object-types/ObjectTypeName/attributes/AttributeName/statistics HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [AttributeName](#API_connect-customer-profiles_GetObjectTypeAttributeStatistics_RequestSyntax) ** The attribute name. Length Constraints: Minimum length of 1. Maximum length of 1000. Required: Yes ** [DomainName](#API_connect-customer-profiles_GetObjectTypeAttributeStatistics_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [ObjectTypeName](#API_connect-customer-profiles_GetObjectTypeAttributeStatistics_RequestSyntax) ** The unique name of the domain object type. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CalculatedAt": number, "Statistics": { "Average": number, "Maximum": number, "Minimum": number, "Percentiles": { "P25": number, "P5": number, "P50": number, "P75": number, "P95": number }, "StandardDeviation": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CalculatedAt](#API_connect-customer-profiles_GetObjectTypeAttributeStatistics_ResponseSyntax) ** Time when this statistics was calculated. Type: Timestamp ** [Statistics](#API_connect-customer-profiles_GetObjectTypeAttributeStatistics_ResponseSyntax) ** The statistics. Type: [GetObjectTypeAttributeStatisticsStats](API_connect-customer-profiles_GetObjectTypeAttributeStatisticsStats.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetObjectTypeAttributeStatistics) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetObjectTypeAttributeStatistics) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetObjectTypeAttributeStatistics) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetObjectTypeAttributeStatistics) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetObjectTypeAttributeStatistics) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetObjectTypeAttributeStatistics) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetObjectTypeAttributeStatistics) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetObjectTypeAttributeStatistics) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetObjectTypeAttributeStatistics) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetObjectTypeAttributeStatistics) # GetProfileHistoryRecord Returns a history record for a specific profile, for a specific domain. ## Request Syntax ``` GET /domains/DomainName/profiles/ProfileId/history-records/Id HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_GetProfileHistoryRecord_RequestSyntax) ** The unique name of the domain for which to return a profile history record. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [Id](#API_connect-customer-profiles_GetProfileHistoryRecord_RequestSyntax) ** The unique identifier of the profile history record to return. Pattern: `[a-f0-9]{32}` Required: Yes ** [ProfileId](#API_connect-customer-profiles_GetProfileHistoryRecord_RequestSyntax) ** The unique identifier of the profile for which to return a history record. Pattern: `[a-f0-9]{32}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "ActionType": "string", "Content": "string", "CreatedAt": number, "Id": "string", "LastUpdatedAt": number, "ObjectTypeName": "string", "PerformedBy": "string", "ProfileObjectUniqueKey": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ActionType](#API_connect-customer-profiles_GetProfileHistoryRecord_ResponseSyntax) ** The action type of the profile history record. Type: String Valid Values: `ADDED_PROFILE_KEY | DELETED_PROFILE_KEY | CREATED | UPDATED | INGESTED | DELETED_BY_CUSTOMER | EXPIRED | MERGED | DELETED_BY_MERGE` ** [Content](#API_connect-customer-profiles_GetProfileHistoryRecord_ResponseSyntax) ** A string containing the customer profile, profile object, or profile key content. Type: String Length Constraints: Minimum length of 1. Maximum length of 256000. ** [CreatedAt](#API_connect-customer-profiles_GetProfileHistoryRecord_ResponseSyntax) ** The timestamp of when the profile history record was created. Type: Timestamp ** [Id](#API_connect-customer-profiles_GetProfileHistoryRecord_ResponseSyntax) ** The unique identifier of the profile history record. Type: String Pattern: `[a-f0-9]{32}` ** [LastUpdatedAt](#API_connect-customer-profiles_GetProfileHistoryRecord_ResponseSyntax) ** The timestamp of when the profile history record was last updated. Type: Timestamp ** [ObjectTypeName](#API_connect-customer-profiles_GetProfileHistoryRecord_ResponseSyntax) ** The name of the profile object type. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` ** [PerformedBy](#API_connect-customer-profiles_GetProfileHistoryRecord_ResponseSyntax) ** The Amazon Resource Name (ARN) of the person or service principal who performed the action. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [ProfileObjectUniqueKey](#API_connect-customer-profiles_GetProfileHistoryRecord_ResponseSyntax) ** The unique identifier of the profile object generated by the service. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetProfileHistoryRecord) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetProfileHistoryRecord) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetProfileHistoryRecord) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetProfileHistoryRecord) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetProfileHistoryRecord) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetProfileHistoryRecord) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetProfileHistoryRecord) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetProfileHistoryRecord) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetProfileHistoryRecord) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetProfileHistoryRecord) # GetProfileObjectType Returns the object types for a specific domain. ## Request Syntax ``` GET /domains/DomainName/object-types/ObjectTypeName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_GetProfileObjectType_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [ObjectTypeName](#API_connect-customer-profiles_GetProfileObjectType_RequestSyntax) ** The name of the profile object type. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "AllowProfileCreation": boolean, "CreatedAt": number, "Description": "string", "EncryptionKey": "string", "ExpirationDays": number, "Fields": { "string" : { "ContentType": "string", "Source": "string", "Target": "string" } }, "Keys": { "string" : [ { "FieldNames": [ "string" ], "StandardIdentifiers": [ "string" ] } ] }, "LastUpdatedAt": number, "MaxAvailableProfileObjectCount": number, "MaxProfileObjectCount": number, "ObjectTypeName": "string", "SourceLastUpdatedTimestampFormat": "string", "SourcePriority": number, "Tags": { "string" : "string" }, "TemplateId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AllowProfileCreation](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) ** Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is `FALSE`. If the AllowProfileCreation flag is set to `FALSE`, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to `TRUE`, and if no match is found, then the service creates a new standard profile. Type: Boolean ** [CreatedAt](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) ** The timestamp of when the domain was created. Type: Timestamp ** [Description](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) ** The description of the profile object type. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. ** [EncryptionKey](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) ** The customer-provided key to encrypt the profile object that will be created in this profile object type. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. ** [ExpirationDays](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) ** The number of days until the data in the object expires. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1098. ** [Fields](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) ** A map of the name and ObjectType field. Type: String to [ObjectTypeField](API_connect-customer-profiles_ObjectTypeField.md) object map Key Length Constraints: Minimum length of 1. Maximum length of 64. Key Pattern: `^[a-zA-Z0-9_.-]+$` ** [Keys](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) ** A list of unique keys that can be used to map data to the profile. Type: String to array of [ObjectTypeKey](API_connect-customer-profiles_ObjectTypeKey.md) objects map Key Length Constraints: Minimum length of 1. Maximum length of 64. Key Pattern: `^[a-zA-Z0-9_-]+$` ** [LastUpdatedAt](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) ** The timestamp of when the domain was most recently edited. Type: Timestamp ** [MaxAvailableProfileObjectCount](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) ** The amount of provisioned profile object max count available. Type: Integer Valid Range: Minimum value of 0. ** [MaxProfileObjectCount](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) ** The amount of profile object max count assigned to the object type. Type: Integer Valid Range: Minimum value of 1. ** [ObjectTypeName](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) ** The name of the profile object type. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` ** [SourceLastUpdatedTimestampFormat](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) ** The format of your `sourceLastUpdatedTimestamp` that was previously set up. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [SourcePriority](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) ** An integer that determines the priority of this object type when data from multiple sources is ingested. Lower values take priority. Object types without a specified source priority default to the lowest priority. Type: Integer Valid Range: Minimum value of 1. ** [Tags](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ** [TemplateId](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) ** A unique identifier for the object template. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## Examples ### Example This example illustrates one usage of GetProfileObjectType. #### Sample Request ``` GET /domains/ExampleDomainName/object-types/MyCustomObject HTTP/1.1 ``` #### Sample Response ``` Content-type: application/jsonContent-type: application/json { "CreatedAt": 1479249799770, "Description": "Internal ERP System", "EncryptionKey": "arn:aws:kms:us-east-1:123456789012:key/1988472d-6b77-4bb6-ae39-efce5EXAMPLE", "AllowProfileCreation": "FALSE", "ExpirationDays": 100, "Fields": { "email" : { "ContentType": "EMAIL_ADDRESS", "Source": "_source.email", "Target": "_profile.BusinessEmailAddress" }, "phone" : { "ContentType": "PHONE_NUMBER", "Source": "_source.phone", "Target": "_profile.BusinessPhoneNumber" }, "loyaltyPoints" : { "ContentType": "NUMBER", "Source": "_source.loyaltypoints", "Target": "_profile.Attributes.loyaltypoints" } }, "Keys": { "email" : [ { "FieldNames": [ "email" ], "StandardIdentifiers": [ "PROFILE", "UNIQUE" ] } ], "loyaltypoints" : [ { "FieldNames": [ "loyaltyPoints" ], "StandardIdentifiers": [ "PROFILE"] } ] }, "LastUpdatedAt": 1479249799770, "ObjectTypeName": "CustomProfileObjectTypeName", "SourcePriority": 2, "TemplateId": "MyTemplateId" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetProfileObjectType) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetProfileObjectType) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetProfileObjectType) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetProfileObjectType) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetProfileObjectType) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetProfileObjectType) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetProfileObjectType) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetProfileObjectType) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetProfileObjectType) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetProfileObjectType) # GetProfileObjectTypeTemplate 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. ## Request Syntax ``` GET /templates/TemplateId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [TemplateId](#API_connect-customer-profiles_GetProfileObjectTypeTemplate_RequestSyntax) ** A unique identifier for the object template. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "AllowProfileCreation": boolean, "Fields": { "string" : { "ContentType": "string", "Source": "string", "Target": "string" } }, "Keys": { "string" : [ { "FieldNames": [ "string" ], "StandardIdentifiers": [ "string" ] } ] }, "SourceLastUpdatedTimestampFormat": "string", "SourceName": "string", "SourceObject": "string", "TemplateId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AllowProfileCreation](#API_connect-customer-profiles_GetProfileObjectTypeTemplate_ResponseSyntax) ** Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is `FALSE`. If the AllowProfileCreation flag is set to `FALSE`, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to `TRUE`, and if no match is found, then the service creates a new standard profile. Type: Boolean ** [Fields](#API_connect-customer-profiles_GetProfileObjectTypeTemplate_ResponseSyntax) ** A map of the name and ObjectType field. Type: String to [ObjectTypeField](API_connect-customer-profiles_ObjectTypeField.md) object map Key Length Constraints: Minimum length of 1. Maximum length of 64. Key Pattern: `^[a-zA-Z0-9_.-]+$` ** [Keys](#API_connect-customer-profiles_GetProfileObjectTypeTemplate_ResponseSyntax) ** A list of unique keys that can be used to map data to the profile. Type: String to array of [ObjectTypeKey](API_connect-customer-profiles_ObjectTypeKey.md) objects map Key Length Constraints: Minimum length of 1. Maximum length of 64. Key Pattern: `^[a-zA-Z0-9_-]+$` ** [SourceLastUpdatedTimestampFormat](#API_connect-customer-profiles_GetProfileObjectTypeTemplate_ResponseSyntax) ** The format of your `sourceLastUpdatedTimestamp` that was previously set up. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [SourceName](#API_connect-customer-profiles_GetProfileObjectTypeTemplate_ResponseSyntax) ** The name of the source of the object template. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [SourceObject](#API_connect-customer-profiles_GetProfileObjectTypeTemplate_ResponseSyntax) ** The source of the object template. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [TemplateId](#API_connect-customer-profiles_GetProfileObjectTypeTemplate_ResponseSyntax) ** A unique identifier for the object template. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## Examples ### Example This example illustrates one usage of GetProfileObjectTypeTemplate. #### Sample Request ``` GET /templates/{TemplateId} HTTP/1.1 ``` #### Sample Response ``` Content-type: application/json { "AllowProfileCreätion": "FALSE", "Fields": { "email" : { "ContentType": "EMAIL_ADDRESS", "Source": "_source.email", "Target": "_profile.BusinessEmailAddress" }, "phone" : { "ContentType": "PHONE_NUMBER", "Source": "_source.phone", "Target": "_profile.Businessphonenumber" } }, "Keys": { "_email" : [ { "FieldNames": [ "email" ], "StandardIdentifiers": [ "PROFILE", "UNIQUE" ] } ] }, "SourceName": "Saleforce-Account", "SourceObject": "Account", "TemplateId": "Saleforce-Account" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetProfileObjectTypeTemplate) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetProfileObjectTypeTemplate) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetProfileObjectTypeTemplate) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetProfileObjectTypeTemplate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetProfileObjectTypeTemplate) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetProfileObjectTypeTemplate) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetProfileObjectTypeTemplate) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetProfileObjectTypeTemplate) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetProfileObjectTypeTemplate) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetProfileObjectTypeTemplate) # GetProfileRecommendations Fetches the recommendations for a profile in the input Customer Profiles domain. Fetches all the profile recommendations ## Request Syntax ``` POST /domains/DomainName/profiles/ProfileId/recommendations HTTP/1.1 Content-type: application/json { "CandidateIds": [ "string" ], "Context": { "string" : "string" }, "MaxResults": number, "MetadataConfig": { "MetadataColumns": [ "string" ] }, "RecommenderFilters": [ { "Name": "string", "Values": { "string" : "string" } } ], "RecommenderName": "string", "RecommenderPromotionalFilters": [ { "Name": "string", "PercentPromotedItems": number, "PromotionName": "string", "Values": { "string" : "string" } } ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_GetProfileRecommendations_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [ProfileId](#API_connect-customer-profiles_GetProfileRecommendations_RequestSyntax) ** The unique identifier of the profile for which to retrieve recommendations. Pattern: `[a-f0-9]{32}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [CandidateIds](#API_connect-customer-profiles_GetProfileRecommendations_RequestSyntax) ** A list of item IDs to rank for the user. Use this when you want to re-rank a specific set of items rather than getting recommendations from the full item catalog. Required for personalized-ranking use cases. Type: Array of strings Array Members: Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** [Context](#API_connect-customer-profiles_GetProfileRecommendations_RequestSyntax) ** The contextual metadata used to provide dynamic runtime information to tailor recommendations. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 64. Key Pattern: `^[a-zA-Z0-9_.-]+$` Value Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** [MaxResults](#API_connect-customer-profiles_GetProfileRecommendations_RequestSyntax) ** The maximum number of recommendations to return. The default value is 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 500. Required: No ** [MetadataConfig](#API_connect-customer-profiles_GetProfileRecommendations_RequestSyntax) ** Configuration for including item metadata in the recommendation response. Use this to specify which metadata columns to return alongside recommended items. Type: [MetadataConfig](API_connect-customer-profiles_MetadataConfig.md) object Required: No ** [RecommenderFilters](#API_connect-customer-profiles_GetProfileRecommendations_RequestSyntax) ** A list of filters to apply to the returned recommendations. Filters define criteria for including or excluding items from the recommendation results. Type: Array of [RecommenderFilter](API_connect-customer-profiles_RecommenderFilter.md) objects Array Members: Maximum number of 1 item. Required: No ** [RecommenderName](#API_connect-customer-profiles_GetProfileRecommendations_RequestSyntax) ** The unique name of the recommender. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [RecommenderPromotionalFilters](#API_connect-customer-profiles_GetProfileRecommendations_RequestSyntax) ** A list of promotional filters to apply to the recommendations. Promotional filters allow you to promote specific items within a configurable subset of recommendation results. Type: Array of [RecommenderPromotionalFilter](API_connect-customer-profiles_RecommenderPromotionalFilter.md) objects Array Members: Maximum number of 1 item. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Recommendations": [ { "CatalogItem": { "AdditionalInformation": "string", "Attributes": { "string" : "string" }, "Category": "string", "Code": "string", "CreatedAt": number, "Description": "string", "Id": "string", "ImageLink": "string", "Link": "string", "Name": "string", "Price": "string", "Type": "string", "UpdatedAt": number }, "Score": number } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Recommendations](#API_connect-customer-profiles_GetProfileRecommendations_ResponseSyntax) ** List of recommendations generated by the recommender. Type: Array of [Recommendation](API_connect-customer-profiles_Recommendation.md) objects ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetProfileRecommendations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetProfileRecommendations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetProfileRecommendations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetProfileRecommendations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetProfileRecommendations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetProfileRecommendations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetProfileRecommendations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetProfileRecommendations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetProfileRecommendations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetProfileRecommendations) # GetRecommender Retrieves a recommender. ## Request Syntax ``` GET /domains/DomainName/recommenders/RecommenderName?training-metrics-count=TrainingMetricsCount HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_GetRecommender_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [RecommenderName](#API_connect-customer-profiles_GetRecommender_RequestSyntax) ** The name of the recommender. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [TrainingMetricsCount](#API_connect-customer-profiles_GetRecommender_RequestSyntax) ** The number of training metrics to retrieve for the recommender. Valid Range: Minimum value of 0. Maximum value of 5. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreatedAt": number, "Description": "string", "FailureReason": "string", "LastUpdatedAt": number, "LatestRecommenderUpdate": { "CreatedAt": number, "FailureReason": "string", "LastUpdatedAt": number, "RecommenderConfig": { "EventsConfig": { "EventParametersList": [ { "EventType": "string", "EventValueThreshold": number, "EventWeight": number } ] }, "IncludedColumns": { "string" : [ "string" ] }, "InferenceConfig": { "MinProvisionedTPS": number }, "TrainingFrequency": number }, "Status": "string" }, "RecommenderConfig": { "EventsConfig": { "EventParametersList": [ { "EventType": "string", "EventValueThreshold": number, "EventWeight": number } ] }, "IncludedColumns": { "string" : [ "string" ] }, "InferenceConfig": { "MinProvisionedTPS": number }, "TrainingFrequency": number }, "RecommenderName": "string", "RecommenderRecipeName": "string", "RecommenderSchemaName": "string", "Status": "string", "Tags": { "string" : "string" }, "TrainingMetrics": [ { "Metrics": { "string" : number }, "Time": number } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedAt](#API_connect-customer-profiles_GetRecommender_ResponseSyntax) ** The timestamp of when the recommender was created. Type: Timestamp ** [Description](#API_connect-customer-profiles_GetRecommender_ResponseSyntax) ** A detailed description of the recommender providing information about its purpose and functionality. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. ** [FailureReason](#API_connect-customer-profiles_GetRecommender_ResponseSyntax) ** If the recommender fails, provides the reason for the failure. Type: String ** [LastUpdatedAt](#API_connect-customer-profiles_GetRecommender_ResponseSyntax) ** The timestamp of when the recommender was edited. Type: Timestamp ** [LatestRecommenderUpdate](#API_connect-customer-profiles_GetRecommender_ResponseSyntax) ** Information about the most recent update performed on the recommender, including status and timestamp. Type: [RecommenderUpdate](API_connect-customer-profiles_RecommenderUpdate.md) object ** [RecommenderConfig](#API_connect-customer-profiles_GetRecommender_ResponseSyntax) ** The configuration settings for the recommender, including parameters and settings that define its behavior. Type: [RecommenderConfig](API_connect-customer-profiles_RecommenderConfig.md) object ** [RecommenderName](#API_connect-customer-profiles_GetRecommender_ResponseSyntax) ** The name of the recommender. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [RecommenderRecipeName](#API_connect-customer-profiles_GetRecommender_ResponseSyntax) ** The name of the recipe used by the recommender to generate recommendations. Type: String Valid Values: `recommended-for-you | similar-items | frequently-paired-items | popular-items | trending-now | personalized-ranking` ** [RecommenderSchemaName](#API_connect-customer-profiles_GetRecommender_ResponseSyntax) ** The name of the recommender schema associated with this recommender. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [Status](#API_connect-customer-profiles_GetRecommender_ResponseSyntax) ** The current status of the recommender, indicating whether it is active, creating, updating, or in another state. Type: String Valid Values: `PENDING | IN_PROGRESS | ACTIVE | FAILED | STOPPING | INACTIVE | STARTING | DELETING` ** [Tags](#API_connect-customer-profiles_GetRecommender_ResponseSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ** [TrainingMetrics](#API_connect-customer-profiles_GetRecommender_ResponseSyntax) ** A set of metrics that provide information about the recommender's training performance and accuracy. Type: Array of [TrainingMetrics](API_connect-customer-profiles_TrainingMetrics.md) objects ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetRecommender) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetRecommender) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetRecommender) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetRecommender) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetRecommender) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetRecommender) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetRecommender) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetRecommender) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetRecommender) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetRecommender) # GetRecommenderFilter Retrieves information about a specific recommender filter in a domain. ## Request Syntax ``` GET /domains/DomainName/recommender-filters/RecommenderFilterName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_GetRecommenderFilter_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [RecommenderFilterName](#API_connect-customer-profiles_GetRecommenderFilter_RequestSyntax) ** The name of the recommender filter to retrieve. Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9_-]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreatedAt": number, "Description": "string", "FailureReason": "string", "RecommenderFilterExpression": "string", "RecommenderFilterName": "string", "RecommenderSchemaName": "string", "Status": "string", "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedAt](#API_connect-customer-profiles_GetRecommenderFilter_ResponseSyntax) ** The timestamp of when the recommender filter was created. Type: Timestamp ** [Description](#API_connect-customer-profiles_GetRecommenderFilter_ResponseSyntax) ** The description of the recommender filter. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. ** [FailureReason](#API_connect-customer-profiles_GetRecommenderFilter_ResponseSyntax) ** If the recommender filter failed, provides the reason for the failure. Type: String ** [RecommenderFilterExpression](#API_connect-customer-profiles_GetRecommenderFilter_ResponseSyntax) ** The filter expression that defines which items to include or exclude from recommendations. Type: String Length Constraints: Minimum length of 1. Maximum length of 2500. ** [RecommenderFilterName](#API_connect-customer-profiles_GetRecommenderFilter_ResponseSyntax) ** The name of the recommender filter. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9_-]+` ** [RecommenderSchemaName](#API_connect-customer-profiles_GetRecommenderFilter_ResponseSyntax) ** The name of the recommender schema associated with this recommender filter. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [Status](#API_connect-customer-profiles_GetRecommenderFilter_ResponseSyntax) ** The status of the recommender filter. Type: String Valid Values: `ACTIVE | PENDING | IN_PROGRESS | FAILED | DELETING` ** [Tags](#API_connect-customer-profiles_GetRecommenderFilter_ResponseSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetRecommenderFilter) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetRecommenderFilter) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetRecommenderFilter) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetRecommenderFilter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetRecommenderFilter) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetRecommenderFilter) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetRecommenderFilter) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetRecommenderFilter) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetRecommenderFilter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetRecommenderFilter) # GetRecommenderSchema Retrieves information about a specific recommender schema in a domain. ## Request Syntax ``` GET /domains/DomainName/recommender-schemas/RecommenderSchemaName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_GetRecommenderSchema_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [RecommenderSchemaName](#API_connect-customer-profiles_GetRecommenderSchema_RequestSyntax) ** The name of the recommender schema to retrieve. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreatedAt": number, "Fields": { "string" : [ { "ContentType": "string", "FeatureType": "string", "TargetFieldName": "string" } ] }, "RecommenderSchemaName": "string", "Status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedAt](#API_connect-customer-profiles_GetRecommenderSchema_ResponseSyntax) ** The timestamp of when the recommender schema was created. Type: Timestamp ** [Fields](#API_connect-customer-profiles_GetRecommenderSchema_ResponseSyntax) ** A map of dataset type to column definitions included in the schema. Type: String to array of [RecommenderSchemaField](API_connect-customer-profiles_RecommenderSchemaField.md) objects map Map Entries: Maximum number of 1 item. Array Members: Minimum number of 1 item. Maximum number of 9 items. ** [RecommenderSchemaName](#API_connect-customer-profiles_GetRecommenderSchema_ResponseSyntax) ** The name of the recommender schema. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [Status](#API_connect-customer-profiles_GetRecommenderSchema_ResponseSyntax) ** The status of the recommender schema. Type: String Valid Values: `ACTIVE | DELETING` ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetRecommenderSchema) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetRecommenderSchema) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetRecommenderSchema) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetRecommenderSchema) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetRecommenderSchema) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetRecommenderSchema) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetRecommenderSchema) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetRecommenderSchema) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetRecommenderSchema) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetRecommenderSchema) # GetSegmentDefinition Gets a segment definition from the domain. ## Request Syntax ``` GET /domains/DomainName/segment-definitions/SegmentDefinitionName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_GetSegmentDefinition_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [SegmentDefinitionName](#API_connect-customer-profiles_GetSegmentDefinition_RequestSyntax) ** The unique name of the segment definition. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreatedAt": number, "Description": "string", "DisplayName": "string", "SegmentDefinitionArn": "string", "SegmentDefinitionName": "string", "SegmentGroups": { "Groups": [ { "Dimensions": [ { ... } ], "SourceSegments": [ { "SegmentDefinitionName": "string" } ], "SourceType": "string", "Type": "string" } ], "Include": "string" }, "SegmentSort": { "Attributes": [ { "DataType": "string", "Name": "string", "Order": "string", "Type": "string" } ] }, "SegmentSqlQuery": "string", "SegmentType": "string", "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedAt](#API_connect-customer-profiles_GetSegmentDefinition_ResponseSyntax) ** The timestamp of when the segment definition was created. Type: Timestamp ** [Description](#API_connect-customer-profiles_GetSegmentDefinition_ResponseSyntax) ** The description of the segment definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 4000. ** [DisplayName](#API_connect-customer-profiles_GetSegmentDefinition_ResponseSyntax) ** The display name of the segment definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [SegmentDefinitionArn](#API_connect-customer-profiles_GetSegmentDefinition_ResponseSyntax) ** The arn of the segment definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [SegmentDefinitionName](#API_connect-customer-profiles_GetSegmentDefinition_ResponseSyntax) ** The name of the segment definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [SegmentGroups](#API_connect-customer-profiles_GetSegmentDefinition_ResponseSyntax) ** The segment criteria associated with this definition. Type: [SegmentGroup](API_connect-customer-profiles_SegmentGroup.md) object ** [SegmentSort](#API_connect-customer-profiles_GetSegmentDefinition_ResponseSyntax) ** The segment sort. Type: [SegmentSort](API_connect-customer-profiles_SegmentSort.md) object ** [SegmentSqlQuery](#API_connect-customer-profiles_GetSegmentDefinition_ResponseSyntax) ** The segment SQL query. Type: String Length Constraints: Minimum length of 1. Maximum length of 50000. ** [SegmentType](#API_connect-customer-profiles_GetSegmentDefinition_ResponseSyntax) ** The segment type. Classic : Segments created using traditional SegmentGroup structure Enhanced : Segments created using SQL queries Type: String Valid Values: `CLASSIC | ENHANCED` ** [Tags](#API_connect-customer-profiles_GetSegmentDefinition_ResponseSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetSegmentDefinition) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetSegmentDefinition) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetSegmentDefinition) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetSegmentDefinition) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetSegmentDefinition) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetSegmentDefinition) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetSegmentDefinition) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetSegmentDefinition) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetSegmentDefinition) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetSegmentDefinition) # GetSegmentEstimate Gets the result of a segment estimate query. ## Request Syntax ``` GET /domains/DomainName/segment-estimates/EstimateId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_GetSegmentEstimate_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [EstimateId](#API_connect-customer-profiles_GetSegmentEstimate_RequestSyntax) ** The query Id passed by a previous `CreateSegmentEstimate` operation. Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 StatusCode Content-type: application/json { "DomainName": "string", "Estimate": "string", "EstimateId": "string", "Message": "string", "Status": "string" } ``` ## Response Elements If the action is successful, the service sends back the following HTTP response. ** [StatusCode](#API_connect-customer-profiles_GetSegmentEstimate_ResponseSyntax) ** The status code of the segment estimate. The following data is returned in JSON format by the service. ** [DomainName](#API_connect-customer-profiles_GetSegmentEstimate_ResponseSyntax) ** The unique name of the domain. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [Estimate](#API_connect-customer-profiles_GetSegmentEstimate_ResponseSyntax) ** The estimated number of profiles contained in the segment. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [EstimateId](#API_connect-customer-profiles_GetSegmentEstimate_ResponseSyntax) ** The `QueryId` which is the same as the value passed in `QueryId`. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [Message](#API_connect-customer-profiles_GetSegmentEstimate_ResponseSyntax) ** The error message if there is any error. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [Status](#API_connect-customer-profiles_GetSegmentEstimate_ResponseSyntax) ** The current status of the query. Type: String Valid Values: `RUNNING | SUCCEEDED | FAILED` ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetSegmentEstimate) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetSegmentEstimate) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetSegmentEstimate) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetSegmentEstimate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetSegmentEstimate) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetSegmentEstimate) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetSegmentEstimate) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetSegmentEstimate) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetSegmentEstimate) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetSegmentEstimate) # GetSegmentMembership Determines if the given profiles are within a segment. ## Request Syntax ``` POST /domains/DomainName/segments/SegmentDefinitionName/membership HTTP/1.1 Content-type: application/json { "ProfileIds": [ "string" ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_GetSegmentMembership_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [SegmentDefinitionName](#API_connect-customer-profiles_GetSegmentMembership_RequestSyntax) ** The Id of the wanted segment. Needs to be a valid, and existing segment Id. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [ProfileIds](#API_connect-customer-profiles_GetSegmentMembership_RequestSyntax) ** The list of profile IDs to query for. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 100 items. Pattern: `[a-f0-9]{32}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Failures": [ { "Message": "string", "ProfileId": "string", "Status": number } ], "LastComputedAt": number, "Profiles": [ { "Profile": { "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" : "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", "EngagementPreferences": { "Email": [ { "ContactType": "string", "KeyName": "string", "KeyValue": "string", "ProfileId": "string" } ], "Phone": [ { "ContactType": "string", "KeyName": "string", "KeyValue": "string", "ProfileId": "string" } ] }, "FirstName": "string", "FoundByItems": [ { "KeyName": "string", "Values": [ "string" ] } ], "Gender": "string", "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": "string", "PartyTypeString": "string", "PersonalEmailAddress": "string", "PhoneNumber": "string", "ProfileId": "string", "ProfileType": "string", "ShippingAddress": { "Address1": "string", "Address2": "string", "Address3": "string", "Address4": "string", "City": "string", "Country": "string", "County": "string", "PostalCode": "string", "Province": "string", "State": "string" } }, "ProfileId": "string", "QueryResult": "string" } ], "SegmentDefinitionName": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Failures](#API_connect-customer-profiles_GetSegmentMembership_ResponseSyntax) ** An array of maps where each contains a response per profile failed for the request. Type: Array of [ProfileQueryFailures](API_connect-customer-profiles_ProfileQueryFailures.md) objects ** [LastComputedAt](#API_connect-customer-profiles_GetSegmentMembership_ResponseSyntax) ** The timestamp indicating when the segment membership was last computed or updated. Type: Timestamp ** [Profiles](#API_connect-customer-profiles_GetSegmentMembership_ResponseSyntax) ** An array of maps where each contains a response per profile requested. Type: Array of [ProfileQueryResult](API_connect-customer-profiles_ProfileQueryResult.md) objects ** [SegmentDefinitionName](#API_connect-customer-profiles_GetSegmentMembership_ResponseSyntax) ** The unique name of the segment definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetSegmentMembership) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetSegmentMembership) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetSegmentMembership) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetSegmentMembership) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetSegmentMembership) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetSegmentMembership) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetSegmentMembership) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetSegmentMembership) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetSegmentMembership) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetSegmentMembership) # GetSegmentSnapshot Retrieve the latest status of a segment snapshot. ## Request Syntax ``` GET /domains/DomainName/segments/SegmentDefinitionName/snapshots/SnapshotId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_GetSegmentSnapshot_RequestSyntax) ** The unique identifier of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [SegmentDefinitionName](#API_connect-customer-profiles_GetSegmentSnapshot_RequestSyntax) ** The unique name of the segment definition. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [SnapshotId](#API_connect-customer-profiles_GetSegmentSnapshot_RequestSyntax) ** The unique identifier of the segment snapshot. Pattern: `[a-f0-9]{32}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DataFormat": "string", "DestinationUri": "string", "EncryptionKey": "string", "RoleArn": "string", "SnapshotId": "string", "Status": "string", "StatusMessage": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DataFormat](#API_connect-customer-profiles_GetSegmentSnapshot_ResponseSyntax) ** The format in which the segment will be exported. Type: String Valid Values: `CSV | JSONL | ORC` ** [DestinationUri](#API_connect-customer-profiles_GetSegmentSnapshot_ResponseSyntax) ** The destination to which the segment will be exported. This field must be provided if the request is not submitted from the Amazon Connect Admin Website. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [EncryptionKey](#API_connect-customer-profiles_GetSegmentSnapshot_ResponseSyntax) ** The Amazon Resource Name (ARN) of the KMS key used to encrypt the exported segment. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. ** [RoleArn](#API_connect-customer-profiles_GetSegmentSnapshot_ResponseSyntax) ** The Amazon Resource Name (ARN) of the IAM role that allows Customer Profiles service principal to assume the role for conducting KMS and S3 operations. Type: String Length Constraints: Maximum length of 512. Pattern: `arn:aws:iam:.*:[0-9]+:.*` ** [SnapshotId](#API_connect-customer-profiles_GetSegmentSnapshot_ResponseSyntax) ** The unique identifier of the segment snapshot. Type: String Pattern: `[a-f0-9]{32}` ** [Status](#API_connect-customer-profiles_GetSegmentSnapshot_ResponseSyntax) ** The status of the asynchronous job for exporting the segment snapshot. Type: String Valid Values: `COMPLETED | IN_PROGRESS | FAILED` ** [StatusMessage](#API_connect-customer-profiles_GetSegmentSnapshot_ResponseSyntax) ** The status message of the asynchronous job for exporting the segment snapshot. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetSegmentSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetSegmentSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetSegmentSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetSegmentSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetSegmentSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetSegmentSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetSegmentSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetSegmentSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetSegmentSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetSegmentSnapshot) # GetSimilarProfiles 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`. ## Request Syntax ``` POST /domains/DomainName/matches?max-results=MaxResults&next-token=NextToken HTTP/1.1 Content-type: application/json { "MatchType": "string", "SearchKey": "string", "SearchValue": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_GetSimilarProfiles_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [MaxResults](#API_connect-customer-profiles_GetSimilarProfiles_RequestSyntax) ** The maximum number of objects returned per page. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_connect-customer-profiles_GetSimilarProfiles_RequestSyntax) ** The pagination token from the previous `GetSimilarProfiles` API call. Length Constraints: Minimum length of 1. Maximum length of 1024. ## Request Body The request accepts the following data in JSON format. ** [MatchType](#API_connect-customer-profiles_GetSimilarProfiles_RequestSyntax) ** Specify the type of matching to get similar profiles for. Type: String Valid Values: `RULE_BASED_MATCHING | ML_BASED_MATCHING` Required: Yes ** [SearchKey](#API_connect-customer-profiles_GetSimilarProfiles_RequestSyntax) ** The string indicating the search key to be used. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ** [SearchValue](#API_connect-customer-profiles_GetSimilarProfiles_RequestSyntax) ** The string based on `SearchKey` to be searched for similar profiles. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "ConfidenceScore": number, "MatchId": "string", "MatchType": "string", "NextToken": "string", "ProfileIds": [ "string" ], "RuleLevel": number } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ConfidenceScore](#API_connect-customer-profiles_GetSimilarProfiles_ResponseSyntax) ** It only has value when the `MatchType` is `ML_BASED_MATCHING`.A number between 0 and 1, where a higher score means higher similarity. Examining match confidence scores lets you distinguish between groups of similar records in which the system is highly confident (which you may decide to merge), groups of similar records about which the system is uncertain (which you may decide to have reviewed by a human), and groups of similar records that the system deems to be unlikely (which you may decide to reject). Given confidence scores vary as per the data input, it should not be used as an absolute measure of matching quality. Type: Double ** [MatchId](#API_connect-customer-profiles_GetSimilarProfiles_ResponseSyntax) ** The string `matchId` that the similar profiles belong to. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [MatchType](#API_connect-customer-profiles_GetSimilarProfiles_ResponseSyntax) ** Specify the type of matching to get similar profiles for. Type: String Valid Values: `RULE_BASED_MATCHING | ML_BASED_MATCHING` ** [NextToken](#API_connect-customer-profiles_GetSimilarProfiles_ResponseSyntax) ** The pagination token from the previous `GetSimilarProfiles` API call. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ** [ProfileIds](#API_connect-customer-profiles_GetSimilarProfiles_ResponseSyntax) ** Set of `profileId`s that belong to the same matching group. Type: Array of strings Pattern: `[a-f0-9]{32}` ** [RuleLevel](#API_connect-customer-profiles_GetSimilarProfiles_ResponseSyntax) ** The integer rule level that the profiles matched on. Type: Integer Valid Range: Minimum value of 1. Maximum value of 15. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetSimilarProfiles) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetSimilarProfiles) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetSimilarProfiles) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetSimilarProfiles) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetSimilarProfiles) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetSimilarProfiles) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetSimilarProfiles) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetSimilarProfiles) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetSimilarProfiles) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetSimilarProfiles) # GetUploadJob This API retrieves the details of a specific upload job. ## Request Syntax ``` GET /domains/DomainName/upload-jobs/JobId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_GetUploadJob_RequestSyntax) ** The unique name of the domain containing the upload job. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [JobId](#API_connect-customer-profiles_GetUploadJob_RequestSyntax) ** The unique identifier of the upload job to retrieve. Pattern: `[a-f0-9]{32}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CompletedAt": number, "CreatedAt": number, "DataExpiry": number, "DisplayName": "string", "Fields": { "string" : { "ContentType": "string", "Source": "string", "Target": "string" } }, "JobId": "string", "ResultsSummary": { "CreatedRecords": number, "FailedRecords": number, "UpdatedRecords": number }, "Status": "string", "StatusReason": "string", "UniqueKey": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CompletedAt](#API_connect-customer-profiles_GetUploadJob_ResponseSyntax) ** The timestamp when the upload job was completed. Type: Timestamp ** [CreatedAt](#API_connect-customer-profiles_GetUploadJob_ResponseSyntax) ** The timestamp when the upload job was created. Type: Timestamp ** [DataExpiry](#API_connect-customer-profiles_GetUploadJob_ResponseSyntax) ** The expiry duration for the profiles ingested with the upload job. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1098. ** [DisplayName](#API_connect-customer-profiles_GetUploadJob_ResponseSyntax) ** The unique name of the upload job. Could be a file name to identify the upload job. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [Fields](#API_connect-customer-profiles_GetUploadJob_ResponseSyntax) ** The mapping between CSV Columns and Profile Object attributes for the upload job. Type: String to [ObjectTypeField](API_connect-customer-profiles_ObjectTypeField.md) object map Key Length Constraints: Minimum length of 1. Maximum length of 64. Key Pattern: `^[a-zA-Z0-9_.-]+$` ** [JobId](#API_connect-customer-profiles_GetUploadJob_ResponseSyntax) ** The unique identifier of the upload job. Type: String Pattern: `[a-f0-9]{32}` ** [ResultsSummary](#API_connect-customer-profiles_GetUploadJob_ResponseSyntax) ** The summary of results for the upload job, including the number of updated, created, and failed records. Type: [ResultsSummary](API_connect-customer-profiles_ResultsSummary.md) object ** [Status](#API_connect-customer-profiles_GetUploadJob_ResponseSyntax) ** The status describing the status for the upload job. The following are Valid Values: + **CREATED**: The upload job has been created, but has not started processing yet. + **IN\$1PROGRESS**: The upload job is currently in progress, ingesting and processing the profile data. + **PARTIALLY\$1SUCCEEDED**: The upload job has successfully completed the ingestion and processing of all profile data. + **SUCCEEDED**: The upload job has successfully completed the ingestion and processing of all profile data. + **FAILED**: The upload job has failed to complete. + **STOPPED**: The upload job has been manually stopped or terminated before completion. Type: String Valid Values: `CREATED | IN_PROGRESS | PARTIALLY_SUCCEEDED | SUCCEEDED | FAILED | STOPPED` ** [StatusReason](#API_connect-customer-profiles_GetUploadJob_ResponseSyntax) ** The reason for the current status of the upload job. Possible reasons: + **VALIDATION\$1FAILURE**: The upload job has encountered an error or issue and was unable to complete the profile data ingestion. + **INTERNAL\$1FAILURE**: Failure caused from service side Type: String Valid Values: `VALIDATION_FAILURE | INTERNAL_FAILURE` ** [UniqueKey](#API_connect-customer-profiles_GetUploadJob_ResponseSyntax) ** The unique key columns used for de-duping the keys in the upload job. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetUploadJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetUploadJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetUploadJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetUploadJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetUploadJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetUploadJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetUploadJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetUploadJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetUploadJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetUploadJob) # GetUploadJobPath This API retrieves the pre-signed URL and client token for uploading the file associated with the upload job. ## Request Syntax ``` GET /domains/DomainName/upload-jobs/JobId/path HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_GetUploadJobPath_RequestSyntax) ** The unique name of the domain containing the upload job. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [JobId](#API_connect-customer-profiles_GetUploadJobPath_RequestSyntax) ** The unique identifier of the upload job to retrieve the upload path for. This is generated from the CreateUploadJob API. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "ClientToken": "string", "Url": "string", "ValidUntil": number } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ClientToken](#API_connect-customer-profiles_GetUploadJobPath_ResponseSyntax) ** The plaintext data key used to encrypt the upload file. To persist to the pre-signed url, use the client token and MD5 client token as header. The required headers are as follows: + x-amz-server-side-encryption-customer-key: Client Token + x-amz-server-side-encryption-customer-key-MD5: MD5 Client Token + x-amz-server-side-encryption-customer-algorithm: AES256 Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. ** [Url](#API_connect-customer-profiles_GetUploadJobPath_ResponseSyntax) ** The pre-signed S3 URL for uploading the CSV file associated with the upload job. Type: String Length Constraints: Maximum length of 2048. Pattern: `.*` ** [ValidUntil](#API_connect-customer-profiles_GetUploadJobPath_ResponseSyntax) ** The expiry timestamp for the pre-signed URL, after which the URL will no longer be valid. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetUploadJobPath) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetUploadJobPath) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetUploadJobPath) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetUploadJobPath) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetUploadJobPath) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetUploadJobPath) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetUploadJobPath) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetUploadJobPath) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetUploadJobPath) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetUploadJobPath) # GetWorkflow Get details of specified workflow. ## Request Syntax ``` GET /domains/DomainName/workflows/WorkflowId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_GetWorkflow_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [WorkflowId](#API_connect-customer-profiles_GetWorkflow_RequestSyntax) ** Unique identifier for the workflow. Pattern: `[a-f0-9]{32}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Attributes": { "AppflowIntegration": { "ConnectorProfileName": "string", "RoleArn": "string", "SourceConnectorType": "string" } }, "ErrorDescription": "string", "LastUpdatedAt": number, "Metrics": { "AppflowIntegration": { "RecordsProcessed": number, "StepsCompleted": number, "TotalSteps": number } }, "StartDate": number, "Status": "string", "WorkflowId": "string", "WorkflowType": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Attributes](#API_connect-customer-profiles_GetWorkflow_ResponseSyntax) ** Attributes provided for workflow execution. Type: [WorkflowAttributes](API_connect-customer-profiles_WorkflowAttributes.md) object ** [ErrorDescription](#API_connect-customer-profiles_GetWorkflow_ResponseSyntax) ** Workflow error messages during execution (if any). Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [LastUpdatedAt](#API_connect-customer-profiles_GetWorkflow_ResponseSyntax) ** The timestamp that represents when workflow execution last updated. Type: Timestamp ** [Metrics](#API_connect-customer-profiles_GetWorkflow_ResponseSyntax) ** Workflow specific execution metrics. Type: [WorkflowMetrics](API_connect-customer-profiles_WorkflowMetrics.md) object ** [StartDate](#API_connect-customer-profiles_GetWorkflow_ResponseSyntax) ** The timestamp that represents when workflow execution started. Type: Timestamp ** [Status](#API_connect-customer-profiles_GetWorkflow_ResponseSyntax) ** Status of workflow execution. Type: String Valid Values: `NOT_STARTED | IN_PROGRESS | COMPLETE | FAILED | SPLIT | RETRY | CANCELLED` ** [WorkflowId](#API_connect-customer-profiles_GetWorkflow_ResponseSyntax) ** Unique identifier for the workflow. Type: String Pattern: `[a-f0-9]{32}` ** [WorkflowType](#API_connect-customer-profiles_GetWorkflow_ResponseSyntax) ** The type of workflow. The only supported value is APPFLOW\$1INTEGRATION. Type: String Valid Values: `APPFLOW_INTEGRATION` ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetWorkflow) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetWorkflow) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetWorkflow) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetWorkflow) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetWorkflow) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetWorkflow) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetWorkflow) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetWorkflow) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetWorkflow) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetWorkflow) # GetWorkflowSteps Get granular list of steps in workflow. ## Request Syntax ``` GET /domains/DomainName/workflows/WorkflowId/steps?max-results=MaxResults&next-token=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_GetWorkflowSteps_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [MaxResults](#API_connect-customer-profiles_GetWorkflowSteps_RequestSyntax) ** The maximum number of results to return per page. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_connect-customer-profiles_GetWorkflowSteps_RequestSyntax) ** The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Length Constraints: Minimum length of 1. Maximum length of 1024. ** [WorkflowId](#API_connect-customer-profiles_GetWorkflowSteps_RequestSyntax) ** Unique identifier for the workflow. Pattern: `[a-f0-9]{32}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Items": [ { "AppflowIntegration": { "BatchRecordsEndTime": "string", "BatchRecordsStartTime": "string", "CreatedAt": number, "ExecutionMessage": "string", "FlowName": "string", "LastUpdatedAt": number, "RecordsProcessed": number, "Status": "string" } } ], "NextToken": "string", "WorkflowId": "string", "WorkflowType": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Items](#API_connect-customer-profiles_GetWorkflowSteps_ResponseSyntax) ** List containing workflow step details. Type: Array of [WorkflowStepItem](API_connect-customer-profiles_WorkflowStepItem.md) objects ** [NextToken](#API_connect-customer-profiles_GetWorkflowSteps_ResponseSyntax) ** If there are additional results, this is the token for the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ** [WorkflowId](#API_connect-customer-profiles_GetWorkflowSteps_ResponseSyntax) ** Unique identifier for the workflow. Type: String Pattern: `[a-f0-9]{32}` ** [WorkflowType](#API_connect-customer-profiles_GetWorkflowSteps_ResponseSyntax) ** The type of workflow. The only supported value is APPFLOW\$1INTEGRATION. Type: String Valid Values: `APPFLOW_INTEGRATION` ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetWorkflowSteps) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetWorkflowSteps) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetWorkflowSteps) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetWorkflowSteps) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetWorkflowSteps) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetWorkflowSteps) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetWorkflowSteps) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetWorkflowSteps) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetWorkflowSteps) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetWorkflowSteps) # ListAccountIntegrations Lists all of the integrations associated to a specific URI in the AWS account. ## Request Syntax ``` POST /integrations?include-hidden=IncludeHidden&max-results=MaxResults&next-token=NextToken HTTP/1.1 Content-type: application/json { "Uri": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [IncludeHidden](#API_connect-customer-profiles_ListAccountIntegrations_RequestSyntax) ** Boolean to indicate if hidden integration should be returned. Defaults to `False`. ** [MaxResults](#API_connect-customer-profiles_ListAccountIntegrations_RequestSyntax) ** The maximum number of objects returned per page. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_connect-customer-profiles_ListAccountIntegrations_RequestSyntax) ** The pagination token from the previous ListAccountIntegrations API call. Length Constraints: Minimum length of 1. Maximum length of 1024. ## Request Body The request accepts the following data in JSON format. ** [Uri](#API_connect-customer-profiles_ListAccountIntegrations_RequestSyntax) ** The URI of the S3 bucket or any other type of data source. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Items": [ { "CreatedAt": number, "DomainName": "string", "EventTriggerNames": [ "string" ], "IsUnstructured": boolean, "LastUpdatedAt": number, "ObjectTypeName": "string", "ObjectTypeNames": { "string" : "string" }, "RoleArn": "string", "Scope": "string", "Tags": { "string" : "string" }, "Uri": "string", "WorkflowId": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Items](#API_connect-customer-profiles_ListAccountIntegrations_ResponseSyntax) ** The list of ListAccountIntegration instances. Type: Array of [ListIntegrationItem](API_connect-customer-profiles_ListIntegrationItem.md) objects ** [NextToken](#API_connect-customer-profiles_ListAccountIntegrations_ResponseSyntax) ** The pagination token from the previous ListAccountIntegrations API call. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## Examples ### Example This example illustrates one usage of ListAccountIntegrations. #### Sample Request ``` POST /integrations?max-results=10&next-token={NextToken} HTTP/1.1 { "Uri": "arn:aws:sqs:us-east-1:123456789012:URIOfIntegration1" } ``` #### Sample Response ``` Content-type: application/json { "Items": [ { "CreatedAt": 1479249799770, "DomainName": "ExampleDomainName", "LastUpdatedAt": 1479249799770, "ObjectTypeName": "MyCustomObject", "Uri": "arn:aws:flow:us-east-1:123456789012:URIOfIntegration1" } ], "NextToken": "e17145a2-916b-42a2-b4d3-0267fEXAMPLE" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListAccountIntegrations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListAccountIntegrations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListAccountIntegrations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListAccountIntegrations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListAccountIntegrations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListAccountIntegrations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListAccountIntegrations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListAccountIntegrations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListAccountIntegrations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListAccountIntegrations) # ListCalculatedAttributeDefinitions Lists calculated attribute definitions for Customer Profiles ## Request Syntax ``` GET /domains/DomainName/calculated-attributes?max-results=MaxResults&next-token=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_ListCalculatedAttributeDefinitions_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [MaxResults](#API_connect-customer-profiles_ListCalculatedAttributeDefinitions_RequestSyntax) ** The maximum number of calculated attribute definitions returned per page. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_connect-customer-profiles_ListCalculatedAttributeDefinitions_RequestSyntax) ** The pagination token from the previous call to ListCalculatedAttributeDefinitions. Length Constraints: Minimum length of 1. Maximum length of 1024. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Items": [ { "CalculatedAttributeName": "string", "CreatedAt": number, "Description": "string", "DisplayName": "string", "LastUpdatedAt": number, "Status": "string", "Tags": { "string" : "string" }, "UseHistoricalData": boolean } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Items](#API_connect-customer-profiles_ListCalculatedAttributeDefinitions_ResponseSyntax) ** The list of calculated attribute definitions. Type: Array of [ListCalculatedAttributeDefinitionItem](API_connect-customer-profiles_ListCalculatedAttributeDefinitionItem.md) objects ** [NextToken](#API_connect-customer-profiles_ListCalculatedAttributeDefinitions_ResponseSyntax) ** The pagination token from the previous call to ListCalculatedAttributeDefinitions. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListCalculatedAttributeDefinitions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListCalculatedAttributeDefinitions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListCalculatedAttributeDefinitions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListCalculatedAttributeDefinitions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListCalculatedAttributeDefinitions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListCalculatedAttributeDefinitions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListCalculatedAttributeDefinitions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListCalculatedAttributeDefinitions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListCalculatedAttributeDefinitions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListCalculatedAttributeDefinitions) # ListCalculatedAttributesForProfile Retrieve a list of calculated attributes for a customer profile. ## Request Syntax ``` GET /domains/DomainName/profile/ProfileId/calculated-attributes?max-results=MaxResults&next-token=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_ListCalculatedAttributesForProfile_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [MaxResults](#API_connect-customer-profiles_ListCalculatedAttributesForProfile_RequestSyntax) ** The maximum number of calculated attributes returned per page. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_connect-customer-profiles_ListCalculatedAttributesForProfile_RequestSyntax) ** The pagination token from the previous call to ListCalculatedAttributesForProfile. Length Constraints: Minimum length of 1. Maximum length of 1024. ** [ProfileId](#API_connect-customer-profiles_ListCalculatedAttributesForProfile_RequestSyntax) ** The unique identifier of a customer profile. Pattern: `[a-f0-9]{32}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Items": [ { "CalculatedAttributeName": "string", "DisplayName": "string", "IsDataPartial": "string", "LastObjectTimestamp": number, "Value": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Items](#API_connect-customer-profiles_ListCalculatedAttributesForProfile_ResponseSyntax) ** The list of calculated attributes. Type: Array of [ListCalculatedAttributeForProfileItem](API_connect-customer-profiles_ListCalculatedAttributeForProfileItem.md) objects ** [NextToken](#API_connect-customer-profiles_ListCalculatedAttributesForProfile_ResponseSyntax) ** The pagination token from the previous call to ListCalculatedAttributesForProfile. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListCalculatedAttributesForProfile) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListCalculatedAttributesForProfile) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListCalculatedAttributesForProfile) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListCalculatedAttributesForProfile) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListCalculatedAttributesForProfile) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListCalculatedAttributesForProfile) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListCalculatedAttributesForProfile) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListCalculatedAttributesForProfile) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListCalculatedAttributesForProfile) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListCalculatedAttributesForProfile) # ListDomainLayouts Lists the existing layouts that can be used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website. ## Request Syntax ``` GET /domains/DomainName/layouts?max-results=MaxResults&next-token=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_ListDomainLayouts_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [MaxResults](#API_connect-customer-profiles_ListDomainLayouts_RequestSyntax) ** The maximum number of objects returned per page. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_connect-customer-profiles_ListDomainLayouts_RequestSyntax) ** Identifies the next page of results to return. Length Constraints: Minimum length of 1. Maximum length of 1024. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Items": [ { "CreatedAt": number, "Description": "string", "DisplayName": "string", "IsDefault": boolean, "LastUpdatedAt": number, "LayoutDefinitionName": "string", "LayoutType": "string", "Tags": { "string" : "string" } } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Items](#API_connect-customer-profiles_ListDomainLayouts_ResponseSyntax) ** Contains summary information about an EventStream. Type: Array of [LayoutItem](API_connect-customer-profiles_LayoutItem.md) objects ** [NextToken](#API_connect-customer-profiles_ListDomainLayouts_ResponseSyntax) ** Identifies the next page of results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListDomainLayouts) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListDomainLayouts) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListDomainLayouts) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListDomainLayouts) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListDomainLayouts) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListDomainLayouts) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListDomainLayouts) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListDomainLayouts) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListDomainLayouts) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListDomainLayouts) # ListDomainObjectTypes List all DomainObjectType(s) in a Customer Profiles domain. ## Request Syntax ``` GET /domains/DomainName/domain-object-types?max-results=MaxResults&next-token=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_ListDomainObjectTypes_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [MaxResults](#API_connect-customer-profiles_ListDomainObjectTypes_RequestSyntax) ** The maximum number of domain object types returned per page. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_connect-customer-profiles_ListDomainObjectTypes_RequestSyntax) ** The pagination token from the previous call to ListDomainObjectTypes. Length Constraints: Minimum length of 1. Maximum length of 1024. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Items": [ { "CreatedAt": number, "Description": "string", "LastUpdatedAt": number, "ObjectTypeName": "string", "Tags": { "string" : "string" } } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Items](#API_connect-customer-profiles_ListDomainObjectTypes_ResponseSyntax) ** The list of domain object types. Type: Array of [DomainObjectTypesListItem](API_connect-customer-profiles_DomainObjectTypesListItem.md) objects ** [NextToken](#API_connect-customer-profiles_ListDomainObjectTypes_ResponseSyntax) ** The pagination token from the previous call to ListDomainObjectTypes. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListDomainObjectTypes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListDomainObjectTypes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListDomainObjectTypes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListDomainObjectTypes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListDomainObjectTypes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListDomainObjectTypes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListDomainObjectTypes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListDomainObjectTypes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListDomainObjectTypes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListDomainObjectTypes) # ListDomains Returns a list of all the domains for an AWS account that have been created. ## Request Syntax ``` GET /domains?max-results=MaxResults&next-token=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [MaxResults](#API_connect-customer-profiles_ListDomains_RequestSyntax) ** The maximum number of objects returned per page. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_connect-customer-profiles_ListDomains_RequestSyntax) ** The pagination token from the previous ListDomain API call. Length Constraints: Minimum length of 1. Maximum length of 1024. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Items": [ { "CreatedAt": number, "DomainName": "string", "LastUpdatedAt": number, "Tags": { "string" : "string" } } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Items](#API_connect-customer-profiles_ListDomains_ResponseSyntax) ** The list of ListDomains instances. Type: Array of [ListDomainItem](API_connect-customer-profiles_ListDomainItem.md) objects ** [NextToken](#API_connect-customer-profiles_ListDomains_ResponseSyntax) ** The pagination token from the previous ListDomains API call. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## Examples ### Example This example illustrates one usage of ListDomains. #### Sample Request ``` GET /v1/domains?max-results={MaxResults} //First call ``` #### Sample Request ``` GET /v1/domains?next-token={NextToken};max-results={MaxResults} //Subsequent calls ``` #### Sample Response ``` Content-type: application/json { "NextToken": "fcc66dce-8356-4ddb-9f20-911c0EXAMPLE", "Items": [ { "CreatedAt": 1479249799770, "LastUpdatedAt": 1479249799770, "Name": "ExampleDomain1" }, { "CreatedAt": 1479249799770, "LastUpdatedAt": 1479249799770, "Name": "ExampleDomain2" } ] } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListDomains) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListDomains) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListDomains) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListDomains) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListDomains) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListDomains) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListDomains) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListDomains) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListDomains) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListDomains) # ListEventStreams Returns a list of all the event streams in a specific domain. ## Request Syntax ``` GET /domains/DomainName/event-streams?max-results=MaxResults&next-token=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_ListEventStreams_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [MaxResults](#API_connect-customer-profiles_ListEventStreams_RequestSyntax) ** The maximum number of objects returned per page. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_connect-customer-profiles_ListEventStreams_RequestSyntax) ** Identifies the next page of results to return. Length Constraints: Minimum length of 1. Maximum length of 1024. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Items": [ { "DestinationSummary": { "Status": "string", "UnhealthySince": number, "Uri": "string" }, "DomainName": "string", "EventStreamArn": "string", "EventStreamName": "string", "State": "string", "StoppedSince": number, "Tags": { "string" : "string" } } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Items](#API_connect-customer-profiles_ListEventStreams_ResponseSyntax) ** Contains summary information about an EventStream. Type: Array of [EventStreamSummary](API_connect-customer-profiles_EventStreamSummary.md) objects ** [NextToken](#API_connect-customer-profiles_ListEventStreams_ResponseSyntax) ** Identifies the next page of results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListEventStreams) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListEventStreams) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListEventStreams) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListEventStreams) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListEventStreams) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListEventStreams) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListEventStreams) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListEventStreams) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListEventStreams) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListEventStreams) # ListEventTriggers List all Event Triggers under a domain. ## Request Syntax ``` GET /domains/DomainName/event-triggers?max-results=MaxResults&next-token=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_ListEventTriggers_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [MaxResults](#API_connect-customer-profiles_ListEventTriggers_RequestSyntax) ** The maximum number of results to return per page. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_connect-customer-profiles_ListEventTriggers_RequestSyntax) ** The pagination token to use with ListEventTriggers. Length Constraints: Minimum length of 1. Maximum length of 1024. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Items": [ { "CreatedAt": number, "Description": "string", "EventTriggerName": "string", "LastUpdatedAt": number, "ObjectTypeName": "string", "Tags": { "string" : "string" } } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Items](#API_connect-customer-profiles_ListEventTriggers_ResponseSyntax) ** The list of Event Triggers. Type: Array of [EventTriggerSummaryItem](API_connect-customer-profiles_EventTriggerSummaryItem.md) objects ** [NextToken](#API_connect-customer-profiles_ListEventTriggers_ResponseSyntax) ** The pagination token from the previous call to ListEventTriggers. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListEventTriggers) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListEventTriggers) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListEventTriggers) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListEventTriggers) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListEventTriggers) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListEventTriggers) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListEventTriggers) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListEventTriggers) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListEventTriggers) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListEventTriggers) # ListIdentityResolutionJobs Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by `JobStartTime`. ## Request Syntax ``` GET /domains/DomainName/identity-resolution-jobs?max-results=MaxResults&next-token=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_ListIdentityResolutionJobs_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [MaxResults](#API_connect-customer-profiles_ListIdentityResolutionJobs_RequestSyntax) ** The maximum number of results to return per page. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_connect-customer-profiles_ListIdentityResolutionJobs_RequestSyntax) ** The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Length Constraints: Minimum length of 1. Maximum length of 1024. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "IdentityResolutionJobsList": [ { "DomainName": "string", "ExportingLocation": { "S3Exporting": { "S3BucketName": "string", "S3KeyName": "string" } }, "JobEndTime": number, "JobId": "string", "JobStartTime": number, "JobStats": { "NumberOfMatchesFound": number, "NumberOfMergesDone": number, "NumberOfProfilesReviewed": number }, "Message": "string", "Status": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [IdentityResolutionJobsList](#API_connect-customer-profiles_ListIdentityResolutionJobs_ResponseSyntax) ** A list of Identity Resolution Jobs. Type: Array of [IdentityResolutionJob](API_connect-customer-profiles_IdentityResolutionJob.md) objects ** [NextToken](#API_connect-customer-profiles_ListIdentityResolutionJobs_ResponseSyntax) ** If there are additional results, this is the token for the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListIdentityResolutionJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListIdentityResolutionJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListIdentityResolutionJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListIdentityResolutionJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListIdentityResolutionJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListIdentityResolutionJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListIdentityResolutionJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListIdentityResolutionJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListIdentityResolutionJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListIdentityResolutionJobs) # ListIntegrations Lists all of the integrations in your domain. ## Request Syntax ``` GET /domains/DomainName/integrations?include-hidden=IncludeHidden&max-results=MaxResults&next-token=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_ListIntegrations_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [IncludeHidden](#API_connect-customer-profiles_ListIntegrations_RequestSyntax) ** Boolean to indicate if hidden integration should be returned. Defaults to `False`. ** [MaxResults](#API_connect-customer-profiles_ListIntegrations_RequestSyntax) ** The maximum number of objects returned per page. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_connect-customer-profiles_ListIntegrations_RequestSyntax) ** The pagination token from the previous ListIntegrations API call. Length Constraints: Minimum length of 1. Maximum length of 1024. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Items": [ { "CreatedAt": number, "DomainName": "string", "EventTriggerNames": [ "string" ], "IsUnstructured": boolean, "LastUpdatedAt": number, "ObjectTypeName": "string", "ObjectTypeNames": { "string" : "string" }, "RoleArn": "string", "Scope": "string", "Tags": { "string" : "string" }, "Uri": "string", "WorkflowId": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Items](#API_connect-customer-profiles_ListIntegrations_ResponseSyntax) ** The list of ListIntegrations instances. Type: Array of [ListIntegrationItem](API_connect-customer-profiles_ListIntegrationItem.md) objects ** [NextToken](#API_connect-customer-profiles_ListIntegrations_ResponseSyntax) ** The pagination token from the previous ListIntegrations API call. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## Examples ### Example This example illustrates one usage of ListIntegrations. #### Sample Request ``` GET /domains/{DomainName}/integrations?max-results={MaxResults}&next-token={NextToken} HTTP/1.1 ``` #### Sample Response ``` Content-type: application/json { "Items": [ { "CreatedAt": 1479249799770, "DomainName": "ExampleDomainName", "LastUpdatedAt": 1479249799770, "ObjectTypeName": "SalesForce-Account", "Uri": "arn:aws:flow:us-east-1:123456789012:URIOfIntegration1" }, { "CreatedAt": 1479249799770, "DomainName": "ExampleDomainName2", "LastUpdatedAt": 1479249799770, "ObjectTypeName": "MyCustomObjectName", "Uri": "arn:aws:flow:us-east-1:123456789012:URIOfIntegration2" } ], "NextToken": "e17145a2-916b-42a2-b4d3-0267fEXAMPLE" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListIntegrations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListIntegrations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListIntegrations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListIntegrations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListIntegrations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListIntegrations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListIntegrations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListIntegrations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListIntegrations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListIntegrations) # ListObjectTypeAttributes Fetch the possible attribute values given the attribute name. ## Request Syntax ``` GET /domains/DomainName/object-types/ObjectTypeName/attributes?max-results=MaxResults&next-token=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_ListObjectTypeAttributes_RequestSyntax) ** The unique identifier of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [MaxResults](#API_connect-customer-profiles_ListObjectTypeAttributes_RequestSyntax) ** The maximum number of objects returned per page. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_connect-customer-profiles_ListObjectTypeAttributes_RequestSyntax) ** The pagination token from the previous call. Length Constraints: Minimum length of 1. Maximum length of 1024. ** [ObjectTypeName](#API_connect-customer-profiles_ListObjectTypeAttributes_RequestSyntax) ** The name of the profile object type. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Items": [ { "AttributeName": "string", "LastUpdatedAt": number } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Items](#API_connect-customer-profiles_ListObjectTypeAttributes_ResponseSyntax) ** The items returned as part of the response. Type: Array of [ListObjectTypeAttributeItem](API_connect-customer-profiles_ListObjectTypeAttributeItem.md) objects ** [NextToken](#API_connect-customer-profiles_ListObjectTypeAttributes_ResponseSyntax) ** The pagination token from the previous call. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListObjectTypeAttributes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListObjectTypeAttributes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListObjectTypeAttributes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListObjectTypeAttributes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListObjectTypeAttributes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListObjectTypeAttributes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListObjectTypeAttributes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListObjectTypeAttributes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListObjectTypeAttributes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListObjectTypeAttributes) # ListObjectTypeAttributeValues The ListObjectTypeAttributeValues API provides access to the most recent distinct values for any specified attribute, making it valuable for real-time data validation and consistency checks within your object types. This API works across domain, supporting both custom and standard object types. The API accepts the object type name, attribute name, and domain name as input parameters and returns values up to the storage limit of approximately 350KB. ## Request Syntax ``` GET /domains/DomainName/object-types/ObjectTypeName/attributes/AttributeName/values?max-results=MaxResults&next-token=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [AttributeName](#API_connect-customer-profiles_ListObjectTypeAttributeValues_RequestSyntax) ** The attribute name. Length Constraints: Minimum length of 1. Maximum length of 1000. Required: Yes ** [DomainName](#API_connect-customer-profiles_ListObjectTypeAttributeValues_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [MaxResults](#API_connect-customer-profiles_ListObjectTypeAttributeValues_RequestSyntax) ** The maximum number of objects returned per page. Valid Range: Minimum value of 1. Maximum value of 100. If not provided default as 100. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_connect-customer-profiles_ListObjectTypeAttributeValues_RequestSyntax) ** The pagination token from the previous call. Length Constraints: Minimum length of 1. Maximum length of 1024. ** [ObjectTypeName](#API_connect-customer-profiles_ListObjectTypeAttributeValues_RequestSyntax) ** The unique name of the domain object type. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Items": [ { "LastUpdatedAt": number, "Value": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Items](#API_connect-customer-profiles_ListObjectTypeAttributeValues_ResponseSyntax) ** A list of unique attribute values sorted on the basis of LastUpdatedAt. Type: Array of [ListObjectTypeAttributeValuesItem](API_connect-customer-profiles_ListObjectTypeAttributeValuesItem.md) objects ** [NextToken](#API_connect-customer-profiles_ListObjectTypeAttributeValues_ResponseSyntax) ** The pagination token from the previous call to call ListObjectTypeAttributeValues. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListObjectTypeAttributeValues) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListObjectTypeAttributeValues) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListObjectTypeAttributeValues) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListObjectTypeAttributeValues) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListObjectTypeAttributeValues) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListObjectTypeAttributeValues) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListObjectTypeAttributeValues) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListObjectTypeAttributeValues) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListObjectTypeAttributeValues) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListObjectTypeAttributeValues) # ListProfileAttributeValues Fetch the possible attribute values given the attribute name. ## Request Syntax ``` GET /domains/DomainName/profile-attributes/AttributeName/values HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [AttributeName](#API_connect-customer-profiles_ListProfileAttributeValues_RequestSyntax) ** The attribute name. Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ** [DomainName](#API_connect-customer-profiles_ListProfileAttributeValues_RequestSyntax) ** The unique identifier of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 StatusCode Content-type: application/json { "AttributeName": "string", "DomainName": "string", "Items": [ { "Value": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back the following HTTP response. ** [StatusCode](#API_connect-customer-profiles_ListProfileAttributeValues_ResponseSyntax) ** The status code for the response. The following data is returned in JSON format by the service. ** [AttributeName](#API_connect-customer-profiles_ListProfileAttributeValues_ResponseSyntax) ** The attribute name. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [DomainName](#API_connect-customer-profiles_ListProfileAttributeValues_ResponseSyntax) ** The name of the domain. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [Items](#API_connect-customer-profiles_ListProfileAttributeValues_ResponseSyntax) ** The items returned as part of the response. Type: Array of [AttributeValueItem](API_connect-customer-profiles_AttributeValueItem.md) objects ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListProfileAttributeValues) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListProfileAttributeValues) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListProfileAttributeValues) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListProfileAttributeValues) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListProfileAttributeValues) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListProfileAttributeValues) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListProfileAttributeValues) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListProfileAttributeValues) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListProfileAttributeValues) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListProfileAttributeValues) # ListProfileHistoryRecords Returns a list of history records for a specific profile, for a specific domain. ## Request Syntax ``` POST /domains/DomainName/profiles/history-records?max-results=MaxResults&next-token=NextToken HTTP/1.1 Content-type: application/json { "ActionType": "string", "ObjectTypeName": "string", "PerformedBy": "string", "ProfileId": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_ListProfileHistoryRecords_RequestSyntax) ** The unique name of the domain for which to return profile history records. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [MaxResults](#API_connect-customer-profiles_ListProfileHistoryRecords_RequestSyntax) ** The maximum number of results to return per page. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_connect-customer-profiles_ListProfileHistoryRecords_RequestSyntax) ** The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Length Constraints: Minimum length of 1. Maximum length of 1024. ## Request Body The request accepts the following data in JSON format. ** [ActionType](#API_connect-customer-profiles_ListProfileHistoryRecords_RequestSyntax) ** Applies a filter to include profile history records only with the specified `ActionType` value in the response. Type: String Valid Values: `ADDED_PROFILE_KEY | DELETED_PROFILE_KEY | CREATED | UPDATED | INGESTED | DELETED_BY_CUSTOMER | EXPIRED | MERGED | DELETED_BY_MERGE` Required: No ** [ObjectTypeName](#API_connect-customer-profiles_ListProfileHistoryRecords_RequestSyntax) ** Applies a filter to include profile history records only with the specified `ObjectTypeName` value in the response. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` Required: No ** [PerformedBy](#API_connect-customer-profiles_ListProfileHistoryRecords_RequestSyntax) ** Applies a filter to include profile history records only with the specified `PerformedBy` value in the response. The `PerformedBy` value can be the Amazon Resource Name (ARN) of the person or service principal who performed the action. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** [ProfileId](#API_connect-customer-profiles_ListProfileHistoryRecords_RequestSyntax) ** The identifier of the profile to be taken. Type: String Pattern: `[a-f0-9]{32}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "ProfileHistoryRecords": [ { "ActionType": "string", "CreatedAt": number, "Id": "string", "LastUpdatedAt": number, "ObjectTypeName": "string", "PerformedBy": "string", "ProfileObjectUniqueKey": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_connect-customer-profiles_ListProfileHistoryRecords_ResponseSyntax) ** If there are additional results, this is the token for the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ** [ProfileHistoryRecords](#API_connect-customer-profiles_ListProfileHistoryRecords_ResponseSyntax) ** The list of profile history records. Type: Array of [ProfileHistoryRecord](API_connect-customer-profiles_ProfileHistoryRecord.md) objects ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListProfileHistoryRecords) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListProfileHistoryRecords) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListProfileHistoryRecords) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListProfileHistoryRecords) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListProfileHistoryRecords) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListProfileHistoryRecords) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListProfileHistoryRecords) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListProfileHistoryRecords) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListProfileHistoryRecords) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListProfileHistoryRecords) # ListProfileObjects Returns a list of objects associated with a profile of a given ProfileObjectType. ## Request Syntax ``` POST /domains/DomainName/profiles/objects?max-results=MaxResults&next-token=NextToken HTTP/1.1 Content-type: application/json { "ObjectFilter": { "KeyName": "string", "Values": [ "string" ] }, "ObjectTypeName": "string", "ProfileId": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_ListProfileObjects_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [MaxResults](#API_connect-customer-profiles_ListProfileObjects_RequestSyntax) ** The maximum number of objects returned per page. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_connect-customer-profiles_ListProfileObjects_RequestSyntax) ** The pagination token from the previous call to ListProfileObjects. Length Constraints: Minimum length of 1. Maximum length of 1024. ## Request Body The request accepts the following data in JSON format. ** [ObjectFilter](#API_connect-customer-profiles_ListProfileObjects_RequestSyntax) ** Applies a filter to the response to include profile objects with the specified index values. Type: [ObjectFilter](API_connect-customer-profiles_ObjectFilter.md) object Required: No ** [ObjectTypeName](#API_connect-customer-profiles_ListProfileObjects_RequestSyntax) ** The name of the profile object type. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` Required: Yes ** [ProfileId](#API_connect-customer-profiles_ListProfileObjects_RequestSyntax) ** The unique identifier of a customer profile. Type: String Pattern: `[a-f0-9]{32}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Items": [ { "Object": "string", "ObjectTypeName": "string", "ProfileObjectUniqueKey": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Items](#API_connect-customer-profiles_ListProfileObjects_ResponseSyntax) ** The list of ListProfileObject instances. Type: Array of [ListProfileObjectsItem](API_connect-customer-profiles_ListProfileObjectsItem.md) objects ** [NextToken](#API_connect-customer-profiles_ListProfileObjects_ResponseSyntax) ** The pagination token from the previous call to ListProfileObjects. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## Examples ### Example 1: List raw Contact Record objects This example illustrates one usage of ListProfileObjects. #### Sample Request ``` POST /domains/ExampleDomainName/profiles/objects?max-results=10&next-token=nextToken Content-type: application/json { "ObjectTypeName": "MyCustomObject", "ProfileId": "3991a7d959d248bba82546b2dEXAMPLE" } ``` #### Sample Response ``` Content-type: application/json { "Items": [ { "Object": "{\"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"isAlive\": true,\n \"age\": 27,\n \"address\": {\"streetAddress\": \"21 2nd Street\",\"city\": \"New York\",\"state\": \"NY\",\"postalCode\": \"10021-3100\"},\n \"phoneNumbers\": [{\"type\": \"home\",\"number\": \"212 555-1234\"},\n {\"type\": \"office\",\"number\": \"646 555-4567\"}],\n \"children\": [],\n \"spouse\": null}", "ObjectTypeName": "MyCustomObject", "ProfileObjectUniqueKey": "UniqueKeyOfTheProfileObject" }, { "Object": "{\"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"isAlive\": true,\n \"age\": 27,\n \"address\": {\"streetAddress\": \"21 2nd Street\",\"city\": \"New York\",\"state\": \"NY\",\"postalCode\": \"10021-3100\"},\n \"phoneNumbers\": [{\"type\": \"home\",\"number\": \"212 555-1234\"},\n {\"type\": \"office\",\"number\": \"646 555-4567\"}],\n \"children\": [],\n \"spouse\": null}", "ObjectTypeName": "MyCustomObject", "ProfileObjectUniqueKey": "UniqueKeyOfTheProfileObject" } ], "NextToken": "e17145a2-916b-42a2-b4d3-0267fEXAMPLE" } ``` ### Example 2: Filter Standard Asset Objects This example illustrates one usage of ListProfileObjects. #### Sample Request ``` POST /domains/ExampleDomainName/profiles/objects?max-results=10&next-token=nextToken Content-type: application/json { "ObjectTypeName": "_asset", "ProfileId": "3991a7d959d248bba82546b2dEXAMPLE", "ObjectFilter": { "KeyName": "_assetId", "Values": [ "991a7d959d248bba82546b2dEXAMPLE2" ] } } ``` #### Sample Response ``` Content-type: application/json { "Items": [ { "Object": "{\"AssetId\": \"991a7d959d248bba82546b2dEXAMPLE2\",\n \"AssetName\": \"MyAsset\",\n \"SerialNumber\": \"123\",\n \"ModelNumber\": \"1\",\n \"ModelName\": \"name\",\n \"ProductSKU\": \"21\",\n \"PurchaseDate\": \"07-04-2021\",\n \"UsageEndDate\": \"07-04-2021\",\n \"Status\": \"Delivered\",\n \"Price\": \"10\",\n \"Quantity\": \"5\",\n \"Description\": \"This is an asset\",\n \"Location\": \"Office\",\n \"AdditionalInformation\": \"None\",\n \"DataSource\": \"Salesforce-Asset\",\n \"Attributes\": {} }", "ObjectTypeName": "_asset", "ProfileObjectUniqueKey": "UniqueKeyOfTheProfileObject" } ], "NextToken": "e17145a2-916b-42a2-b4d3-0267fEXAMPLE" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListProfileObjects) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListProfileObjects) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListProfileObjects) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListProfileObjects) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListProfileObjects) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListProfileObjects) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListProfileObjects) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListProfileObjects) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListProfileObjects) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListProfileObjects) # ListProfileObjectTypes Lists all of the templates available within the service. ## Request Syntax ``` GET /domains/DomainName/object-types?max-results=MaxResults&next-token=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_ListProfileObjectTypes_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [MaxResults](#API_connect-customer-profiles_ListProfileObjectTypes_RequestSyntax) ** The maximum number of objects returned per page. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_connect-customer-profiles_ListProfileObjectTypes_RequestSyntax) ** Identifies the next page of results to return. Length Constraints: Minimum length of 1. Maximum length of 1024. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Items": [ { "CreatedAt": number, "Description": "string", "LastUpdatedAt": number, "MaxAvailableProfileObjectCount": number, "MaxProfileObjectCount": number, "ObjectTypeName": "string", "SourcePriority": number, "Tags": { "string" : "string" } } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Items](#API_connect-customer-profiles_ListProfileObjectTypes_ResponseSyntax) ** The list of ListProfileObjectTypes instances. Type: Array of [ListProfileObjectTypeItem](API_connect-customer-profiles_ListProfileObjectTypeItem.md) objects ** [NextToken](#API_connect-customer-profiles_ListProfileObjectTypes_ResponseSyntax) ** Identifies the next page of results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## Examples ### Example This example illustrates one usage of ListProfileObjectTypes. #### Sample Request ``` GET /domains/ExampleDomainName/object-types?max-results=10&next-token=nextToken HTTP/1.1 ``` #### Sample Response ``` Content-type: application/json { "Items": [ { "CreatedAt": 1479249799770, "Description": "Example Description 1", "LastUpdatedAt": 1479249799770, "ObjectTypeName": "MyCustomObjectType", "SourcePriority": 2 }, { "CreatedAt": 147924988889, "Description": "Example Description 2", "LastUpdatedAt": 147924988889, "ObjectTypeName": "AnotherCustomObjectType" } ], "NextToken": "e17145a2-916b-42a2-b4d3-0267fEXAMPLE" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListProfileObjectTypes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListProfileObjectTypes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListProfileObjectTypes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListProfileObjectTypes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListProfileObjectTypes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListProfileObjectTypes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListProfileObjectTypes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListProfileObjectTypes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListProfileObjectTypes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListProfileObjectTypes) # ListProfileObjectTypeTemplates Lists all of the template information for object types. ## Request Syntax ``` GET /templates?max-results=MaxResults&next-token=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [MaxResults](#API_connect-customer-profiles_ListProfileObjectTypeTemplates_RequestSyntax) ** The maximum number of objects returned per page. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_connect-customer-profiles_ListProfileObjectTypeTemplates_RequestSyntax) ** The pagination token from the previous ListObjectTypeTemplates API call. Length Constraints: Minimum length of 1. Maximum length of 1024. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Items": [ { "SourceName": "string", "SourceObject": "string", "TemplateId": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Items](#API_connect-customer-profiles_ListProfileObjectTypeTemplates_ResponseSyntax) ** The list of ListProfileObjectType template instances. Type: Array of [ListProfileObjectTypeTemplateItem](API_connect-customer-profiles_ListProfileObjectTypeTemplateItem.md) objects ** [NextToken](#API_connect-customer-profiles_ListProfileObjectTypeTemplates_ResponseSyntax) ** The pagination token from the previous ListObjectTypeTemplates API call. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## Examples ### Example This example illustrates one usage of ListProfileObjectTypeTemplates. #### Sample Request ``` GET /templates?max-results={MaxResults}&next-token={NextToken} HTTP/1.1 ``` #### Sample Response ``` Content-type: application/json { "Items": [ { "SourceName": "Salesforce-account", "SourceObject": "", "TemplateId": "Salesforce-Account" }, { "SourceName": "Another-source", "SourceObject": "", "TemplateId": "MyCustomTemplateId" } ], "NextToken": "e17145a2-916b-42a2-b4d3-0267fEXAMPLE" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListProfileObjectTypeTemplates) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListProfileObjectTypeTemplates) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListProfileObjectTypeTemplates) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListProfileObjectTypeTemplates) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListProfileObjectTypeTemplates) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListProfileObjectTypeTemplates) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListProfileObjectTypeTemplates) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListProfileObjectTypeTemplates) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListProfileObjectTypeTemplates) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListProfileObjectTypeTemplates) # ListRecommenderFilters Returns a list of recommender filters in the specified domain. ## Request Syntax ``` GET /domains/DomainName/recommender-filters?max-results=MaxResults&next-token=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_ListRecommenderFilters_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [MaxResults](#API_connect-customer-profiles_ListRecommenderFilters_RequestSyntax) ** The maximum number of recommender filters to return in the response. The default value is 100. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_connect-customer-profiles_ListRecommenderFilters_RequestSyntax) ** A token received from a previous ListRecommenderFilters call to retrieve the next page of results. Length Constraints: Minimum length of 1. Maximum length of 1024. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "RecommenderFilters": [ { "CreatedAt": number, "Description": "string", "FailureReason": "string", "RecommenderFilterExpression": "string", "RecommenderFilterName": "string", "RecommenderSchemaName": "string", "Status": "string", "Tags": { "string" : "string" } } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_connect-customer-profiles_ListRecommenderFilters_ResponseSyntax) ** A token to retrieve the next page of results. Null if there are no more results to retrieve. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ** [RecommenderFilters](#API_connect-customer-profiles_ListRecommenderFilters_ResponseSyntax) ** A list of recommender filters and their properties in the specified domain. Type: Array of [RecommenderFilterSummary](API_connect-customer-profiles_RecommenderFilterSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListRecommenderFilters) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListRecommenderFilters) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListRecommenderFilters) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListRecommenderFilters) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListRecommenderFilters) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListRecommenderFilters) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListRecommenderFilters) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListRecommenderFilters) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListRecommenderFilters) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListRecommenderFilters) # ListRecommenderRecipes Returns a list of available recommender recipes that can be used to create recommenders. ## Request Syntax ``` GET /recommender-recipes?max-results=MaxResults&next-token=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [MaxResults](#API_connect-customer-profiles_ListRecommenderRecipes_RequestSyntax) ** The maximum number of recommender recipes to return in the response. The default value is 100. Valid Range: Minimum value of 10. Maximum value of 100. ** [NextToken](#API_connect-customer-profiles_ListRecommenderRecipes_RequestSyntax) ** A token received from a previous ListRecommenderRecipes call to retrieve the next page of results. Length Constraints: Minimum length of 1. Maximum length of 1024. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "RecommenderRecipes": [ { "description": "string", "name": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_connect-customer-profiles_ListRecommenderRecipes_ResponseSyntax) ** A token to retrieve the next page of results. Null if there are no more results to retrieve. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ** [RecommenderRecipes](#API_connect-customer-profiles_ListRecommenderRecipes_ResponseSyntax) ** A list of available recommender recipes and their properties. Type: Array of [RecommenderRecipe](API_connect-customer-profiles_RecommenderRecipe.md) objects ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListRecommenderRecipes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListRecommenderRecipes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListRecommenderRecipes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListRecommenderRecipes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListRecommenderRecipes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListRecommenderRecipes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListRecommenderRecipes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListRecommenderRecipes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListRecommenderRecipes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListRecommenderRecipes) # ListRecommenders Returns a list of recommenders in the specified domain. ## Request Syntax ``` GET /domains/DomainName/recommenders?max-results=MaxResults&next-token=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_ListRecommenders_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [MaxResults](#API_connect-customer-profiles_ListRecommenders_RequestSyntax) ** The maximum number of recommenders to return in the response. The default value is 100. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_connect-customer-profiles_ListRecommenders_RequestSyntax) ** A token received from a previous ListRecommenders call to retrieve the next page of results. Length Constraints: Minimum length of 1. Maximum length of 1024. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "Recommenders": [ { "CreatedAt": number, "Description": "string", "FailureReason": "string", "LastUpdatedAt": number, "LatestRecommenderUpdate": { "CreatedAt": number, "FailureReason": "string", "LastUpdatedAt": number, "RecommenderConfig": { "EventsConfig": { "EventParametersList": [ { "EventType": "string", "EventValueThreshold": number, "EventWeight": number } ] }, "IncludedColumns": { "string" : [ "string" ] }, "InferenceConfig": { "MinProvisionedTPS": number }, "TrainingFrequency": number }, "Status": "string" }, "RecipeName": "string", "RecommenderConfig": { "EventsConfig": { "EventParametersList": [ { "EventType": "string", "EventValueThreshold": number, "EventWeight": number } ] }, "IncludedColumns": { "string" : [ "string" ] }, "InferenceConfig": { "MinProvisionedTPS": number }, "TrainingFrequency": number }, "RecommenderName": "string", "RecommenderSchemaName": "string", "Status": "string", "Tags": { "string" : "string" } } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_connect-customer-profiles_ListRecommenders_ResponseSyntax) ** A token to retrieve the next page of results. Null if there are no more results to retrieve. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ** [Recommenders](#API_connect-customer-profiles_ListRecommenders_ResponseSyntax) ** A list of recommenders and their properties in the specified domain. Type: Array of [RecommenderSummary](API_connect-customer-profiles_RecommenderSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListRecommenders) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListRecommenders) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListRecommenders) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListRecommenders) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListRecommenders) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListRecommenders) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListRecommenders) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListRecommenders) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListRecommenders) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListRecommenders) # ListRecommenderSchemas Returns a list of recommender schemas in the specified domain. ## Request Syntax ``` GET /domains/DomainName/recommender-schemas?max-results=MaxResults&next-token=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_ListRecommenderSchemas_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [MaxResults](#API_connect-customer-profiles_ListRecommenderSchemas_RequestSyntax) ** The maximum number of recommender schemas to return in the response. The default value is 100. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_connect-customer-profiles_ListRecommenderSchemas_RequestSyntax) ** A token received from a previous ListRecommenderSchemas call to retrieve the next page of results. Length Constraints: Minimum length of 1. Maximum length of 1024. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "RecommenderSchemas": [ { "CreatedAt": number, "Fields": { "string" : [ { "ContentType": "string", "FeatureType": "string", "TargetFieldName": "string" } ] }, "RecommenderSchemaName": "string", "Status": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_connect-customer-profiles_ListRecommenderSchemas_ResponseSyntax) ** A token to retrieve the next page of results. Null if there are no more results to retrieve. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ** [RecommenderSchemas](#API_connect-customer-profiles_ListRecommenderSchemas_ResponseSyntax) ** A list of recommender schemas and their properties in the specified domain. Type: Array of [RecommenderSchemaSummary](API_connect-customer-profiles_RecommenderSchemaSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListRecommenderSchemas) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListRecommenderSchemas) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListRecommenderSchemas) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListRecommenderSchemas) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListRecommenderSchemas) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListRecommenderSchemas) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListRecommenderSchemas) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListRecommenderSchemas) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListRecommenderSchemas) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListRecommenderSchemas) # ListRuleBasedMatches Returns a set of `MatchIds` that belong to the given domain. ## Request Syntax ``` GET /domains/DomainName/profiles/ruleBasedMatches?max-results=MaxResults&next-token=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_ListRuleBasedMatches_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [MaxResults](#API_connect-customer-profiles_ListRuleBasedMatches_RequestSyntax) ** The maximum number of `MatchIds` returned per page. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_connect-customer-profiles_ListRuleBasedMatches_RequestSyntax) ** The pagination token from the previous `ListRuleBasedMatches` API call. Length Constraints: Minimum length of 1. Maximum length of 1024. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "MatchIds": [ "string" ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [MatchIds](#API_connect-customer-profiles_ListRuleBasedMatches_ResponseSyntax) ** The list of `MatchIds` for the given domain. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 255. ** [NextToken](#API_connect-customer-profiles_ListRuleBasedMatches_ResponseSyntax) ** The pagination token from the previous `ListRuleBasedMatches` API call. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListRuleBasedMatches) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListRuleBasedMatches) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListRuleBasedMatches) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListRuleBasedMatches) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListRuleBasedMatches) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListRuleBasedMatches) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListRuleBasedMatches) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListRuleBasedMatches) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListRuleBasedMatches) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListRuleBasedMatches) # ListSegmentDefinitions Lists all segment definitions under a domain. ## Request Syntax ``` GET /domains/DomainName/segment-definitions?max-results=MaxResults&next-token=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_ListSegmentDefinitions_RequestSyntax) ** The unique identifier of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [MaxResults](#API_connect-customer-profiles_ListSegmentDefinitions_RequestSyntax) ** The maximum number of objects returned per page. Valid Range: Minimum value of 1. Maximum value of 500. ** [NextToken](#API_connect-customer-profiles_ListSegmentDefinitions_RequestSyntax) ** The pagination token from the previous call. Length Constraints: Minimum length of 1. Maximum length of 1024. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Items": [ { "CreatedAt": number, "Description": "string", "DisplayName": "string", "SegmentDefinitionArn": "string", "SegmentDefinitionName": "string", "SegmentType": "string", "Tags": { "string" : "string" } } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Items](#API_connect-customer-profiles_ListSegmentDefinitions_ResponseSyntax) ** List of segment definitions. Type: Array of [SegmentDefinitionItem](API_connect-customer-profiles_SegmentDefinitionItem.md) objects ** [NextToken](#API_connect-customer-profiles_ListSegmentDefinitions_ResponseSyntax) ** The pagination token from the previous call. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListSegmentDefinitions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListSegmentDefinitions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListSegmentDefinitions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListSegmentDefinitions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListSegmentDefinitions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListSegmentDefinitions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListSegmentDefinitions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListSegmentDefinitions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListSegmentDefinitions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListSegmentDefinitions) # ListTagsForResource Displays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged. ## Request Syntax ``` GET /tags/resourceArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [resourceArn](#API_connect-customer-profiles_ListTagsForResource_RequestSyntax) ** The ARN of the resource for which you want to view tags. Length Constraints: Maximum length of 256. Pattern: `^arn:[a-z0-9]{1,10}:profile` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [tags](#API_connect-customer-profiles_ListTagsForResource_ResponseSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListTagsForResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListTagsForResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListTagsForResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListTagsForResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListTagsForResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListTagsForResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListTagsForResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListTagsForResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListTagsForResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListTagsForResource) # ListUploadJobs This API retrieves a list of upload jobs for the specified domain. ## Request Syntax ``` GET /domains/DomainName/upload-jobs?max-results=MaxResults&next-token=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_ListUploadJobs_RequestSyntax) ** The unique name of the domain to list upload jobs for. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [MaxResults](#API_connect-customer-profiles_ListUploadJobs_RequestSyntax) ** The maximum number of upload jobs to return per page. Valid Range: Minimum value of 1. Maximum value of 500. ** [NextToken](#API_connect-customer-profiles_ListUploadJobs_RequestSyntax) ** The pagination token from the previous call to retrieve the next page of results. Length Constraints: Minimum length of 1. Maximum length of 1024. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Items": [ { "CompletedAt": number, "CreatedAt": number, "DataExpiry": number, "DisplayName": "string", "JobId": "string", "Status": "string", "StatusReason": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Items](#API_connect-customer-profiles_ListUploadJobs_ResponseSyntax) ** The list of upload jobs for the specified domain. Type: Array of [UploadJobItem](API_connect-customer-profiles_UploadJobItem.md) objects ** [NextToken](#API_connect-customer-profiles_ListUploadJobs_ResponseSyntax) ** The pagination token to use to retrieve the next page of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListUploadJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListUploadJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListUploadJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListUploadJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListUploadJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListUploadJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListUploadJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListUploadJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListUploadJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListUploadJobs) # ListWorkflows Query to list all workflows. ## Request Syntax ``` POST /domains/DomainName/workflows?max-results=MaxResults&next-token=NextToken HTTP/1.1 Content-type: application/json { "QueryEndDate": number, "QueryStartDate": number, "Status": "string", "WorkflowType": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_ListWorkflows_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [MaxResults](#API_connect-customer-profiles_ListWorkflows_RequestSyntax) ** The maximum number of results to return per page. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_connect-customer-profiles_ListWorkflows_RequestSyntax) ** The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Length Constraints: Minimum length of 1. Maximum length of 1024. ## Request Body The request accepts the following data in JSON format. ** [QueryEndDate](#API_connect-customer-profiles_ListWorkflows_RequestSyntax) ** Retrieve workflows ended after timestamp. Type: Timestamp Required: No ** [QueryStartDate](#API_connect-customer-profiles_ListWorkflows_RequestSyntax) ** Retrieve workflows started after timestamp. Type: Timestamp Required: No ** [Status](#API_connect-customer-profiles_ListWorkflows_RequestSyntax) ** Status of workflow execution. Type: String Valid Values: `NOT_STARTED | IN_PROGRESS | COMPLETE | FAILED | SPLIT | RETRY | CANCELLED` Required: No ** [WorkflowType](#API_connect-customer-profiles_ListWorkflows_RequestSyntax) ** The type of workflow. The only supported value is APPFLOW\$1INTEGRATION. Type: String Valid Values: `APPFLOW_INTEGRATION` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Items": [ { "CreatedAt": number, "LastUpdatedAt": number, "Status": "string", "StatusDescription": "string", "WorkflowId": "string", "WorkflowType": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Items](#API_connect-customer-profiles_ListWorkflows_ResponseSyntax) ** List containing workflow details. Type: Array of [ListWorkflowsItem](API_connect-customer-profiles_ListWorkflowsItem.md) objects ** [NextToken](#API_connect-customer-profiles_ListWorkflows_ResponseSyntax) ** If there are additional results, this is the token for the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListWorkflows) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListWorkflows) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListWorkflows) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListWorkflows) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListWorkflows) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListWorkflows) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListWorkflows) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListWorkflows) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListWorkflows) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListWorkflows) # MergeProfiles Runs an AWS Lambda job that does the following: 1. All the profileKeys in the `ProfileToBeMerged` will be moved to the main profile. 1. All the objects in the `ProfileToBeMerged` will be moved to the main profile. 1. All the `ProfileToBeMerged` will be deleted at the end. 1. All the profileKeys in the `ProfileIdsToBeMerged` will be moved to the main profile. 1. Standard fields are merged as follows: 1. Fields are always "union"-ed if there are no conflicts in standard fields or attributeKeys. 1. When there are conflicting fields: 1. If no `SourceProfileIds` entry is specified, the main Profile value is always taken. 1. 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](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html), 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). ## Request Syntax ``` POST /domains/DomainName/profiles/objects/merge HTTP/1.1 Content-type: application/json { "FieldSourceProfileIds": { "AccountNumber": "string", "AdditionalInformation": "string", "Address": "string", "Attributes": { "string" : "string" }, "BillingAddress": "string", "BirthDate": "string", "BusinessEmailAddress": "string", "BusinessName": "string", "BusinessPhoneNumber": "string", "EmailAddress": "string", "EngagementPreferences": "string", "FirstName": "string", "Gender": "string", "HomePhoneNumber": "string", "LastName": "string", "MailingAddress": "string", "MiddleName": "string", "MobilePhoneNumber": "string", "PartyType": "string", "PersonalEmailAddress": "string", "PhoneNumber": "string", "ProfileType": "string", "ShippingAddress": "string" }, "MainProfileId": "string", "ProfileIdsToBeMerged": [ "string" ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_MergeProfiles_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [FieldSourceProfileIds](#API_connect-customer-profiles_MergeProfiles_RequestSyntax) ** The identifiers of the fields in the profile that has the information you want to apply to the merge. For example, say you want to merge EmailAddress from Profile1 into MainProfile. This would be the identifier of the EmailAddress field in Profile1. Type: [FieldSourceProfileIds](API_connect-customer-profiles_FieldSourceProfileIds.md) object Required: No ** [MainProfileId](#API_connect-customer-profiles_MergeProfiles_RequestSyntax) ** The identifier of the profile to be taken. Type: String Pattern: `[a-f0-9]{32}` Required: Yes ** [ProfileIdsToBeMerged](#API_connect-customer-profiles_MergeProfiles_RequestSyntax) ** The identifier of the profile to be merged into MainProfileId. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Pattern: `[a-f0-9]{32}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Message": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Message](#API_connect-customer-profiles_MergeProfiles_ResponseSyntax) ** A message that indicates the merge request is complete. Type: String ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## Examples ### Example 1 Fields are always "union"-ed if there are no conflicts in standard fields or attributeKeys. ``` MainProfile: { "FirstName": "Jane" } ProfileToBeMerged1: { "LastName": "Doe" } ProfileToBeMerged2: { "MiddleName": "None" } mergeOf(MainProfile, [ProfileToBeMerged1, ProfileToBeMerged2] // Yields a MainProfile that looks like the following: MainProfile: { "FirstName": "Jane", "LastName": "Doe", "MiddleName": "None" } ``` ### Example 2 When there are conflicting fields, if no SourceProfileIds entry is specified, the main Profile value is always taken. ``` MainProfile: { "FirstName": "Jane" } ProfileToBeMerged1: { "LastName": "Doe" } ProfileToBeMerged2: { "FirstName": "Jorge" // Note that this has conflict with MainProfile } mergeOf(MainProfile, [ProfileToBeMerged1, ProfileToBeMerged2] // Yields a MainProfile that looks like the following: MainProfile: { "FirstName": "Jane", // "Jane" stays as that is what MainProfile is "LastName": "Doe" } ``` ### Example 3 When there are conflicting fields, if a SourceProfileIds entry is specified, the specified profileId is always taken, even if it is a NULL value. ``` MainProfile: { "FirstName": "Jane" } ProfileToBeMerged1: { "LastName": "Doe" } ProfileToBeMerged2: { "FirstName": "Jorge" // Note that this has conflict with MainProfile } SourceProfileIds: { "FirstName": "secondaryProfile2" } mergeOf(MainProfile, [ProfileToBeMerged1, ProfileToBeMerged2] // Yields a MainProfile that looks like the following: MainProfile: { "FirstName": "Jorge", // "Jorge" gets picked because SourceProfileIds is specified "LastName": "Doe" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/MergeProfiles) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/MergeProfiles) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/MergeProfiles) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/MergeProfiles) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/MergeProfiles) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/MergeProfiles) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/MergeProfiles) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/MergeProfiles) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/MergeProfiles) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/MergeProfiles) # PutDomainObjectType Create/Update a DomainObjectType in a Customer Profiles domain. To create a new DomainObjectType, Data Store needs to be enabled on the Domain. ## Request Syntax ``` PUT /domains/DomainName/domain-object-types/ObjectTypeName HTTP/1.1 Content-type: application/json { "Description": "string", "EncryptionKey": "string", "Fields": { "string" : { "ContentType": "string", "FeatureType": "string", "Source": "string", "Target": "string" } }, "Tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_PutDomainObjectType_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [ObjectTypeName](#API_connect-customer-profiles_PutDomainObjectType_RequestSyntax) ** The unique name of the domain object type. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Description](#API_connect-customer-profiles_PutDomainObjectType_RequestSyntax) ** The description of the domain object type. Type: String Length Constraints: Minimum length of 1. Maximum length of 10000. Required: No ** [EncryptionKey](#API_connect-customer-profiles_PutDomainObjectType_RequestSyntax) ** The customer provided KMS key used to encrypt this type of domain object. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Required: No ** [Fields](#API_connect-customer-profiles_PutDomainObjectType_RequestSyntax) ** A map of field names to their corresponding domain object type field definitions. Type: String to [DomainObjectTypeField](API_connect-customer-profiles_DomainObjectTypeField.md) object map Key Length Constraints: Minimum length of 1. Maximum length of 64. Key Pattern: `^[a-zA-Z0-9_.-]+$` Required: Yes ** [Tags](#API_connect-customer-profiles_PutDomainObjectType_RequestSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreatedAt": number, "Description": "string", "EncryptionKey": "string", "Fields": { "string" : { "ContentType": "string", "FeatureType": "string", "Source": "string", "Target": "string" } }, "LastUpdatedAt": number, "ObjectTypeName": "string", "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedAt](#API_connect-customer-profiles_PutDomainObjectType_ResponseSyntax) ** The timestamp of when the domain object type was created. Type: Timestamp ** [Description](#API_connect-customer-profiles_PutDomainObjectType_ResponseSyntax) ** The description of the domain object type. Type: String Length Constraints: Minimum length of 1. Maximum length of 10000. ** [EncryptionKey](#API_connect-customer-profiles_PutDomainObjectType_ResponseSyntax) ** The customer provided KMS key used to encrypt this type of domain object. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. ** [Fields](#API_connect-customer-profiles_PutDomainObjectType_ResponseSyntax) ** A map of field names to their corresponding domain object type field definitions. Type: String to [DomainObjectTypeField](API_connect-customer-profiles_DomainObjectTypeField.md) object map Key Length Constraints: Minimum length of 1. Maximum length of 64. Key Pattern: `^[a-zA-Z0-9_.-]+$` ** [LastUpdatedAt](#API_connect-customer-profiles_PutDomainObjectType_ResponseSyntax) ** The timestamp of when the domain object type was most recently edited. Type: Timestamp ** [ObjectTypeName](#API_connect-customer-profiles_PutDomainObjectType_ResponseSyntax) ** The unique name of the domain object type. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` ** [Tags](#API_connect-customer-profiles_PutDomainObjectType_ResponseSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/PutDomainObjectType) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/PutDomainObjectType) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/PutDomainObjectType) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/PutDomainObjectType) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/PutDomainObjectType) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/PutDomainObjectType) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/PutDomainObjectType) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/PutDomainObjectType) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/PutDomainObjectType) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/PutDomainObjectType) # PutIntegration 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 ](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html)/[ UntagResource](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html). ## Request Syntax ``` PUT /domains/DomainName/integrations HTTP/1.1 Content-type: application/json { "EventTriggerNames": [ "string" ], "FlowDefinition": { "Description": "string", "FlowName": "string", "KmsArn": "string", "SourceFlowConfig": { "ConnectorProfileName": "string", "ConnectorType": "string", "IncrementalPullConfig": { "DatetimeTypeFieldName": "string" }, "SourceConnectorProperties": { "Marketo": { "Object": "string" }, "S3": { "BucketName": "string", "BucketPrefix": "string" }, "Salesforce": { "EnableDynamicFieldUpdate": boolean, "IncludeDeletedRecords": boolean, "Object": "string" }, "ServiceNow": { "Object": "string" }, "Zendesk": { "Object": "string" } } }, "Tasks": [ { "ConnectorOperator": { "Marketo": "string", "S3": "string", "Salesforce": "string", "ServiceNow": "string", "Zendesk": "string" }, "DestinationField": "string", "SourceFields": [ "string" ], "TaskProperties": { "string" : "string" }, "TaskType": "string" } ], "TriggerConfig": { "TriggerProperties": { "Scheduled": { "DataPullMode": "string", "FirstExecutionFrom": number, "ScheduleEndTime": number, "ScheduleExpression": "string", "ScheduleOffset": number, "ScheduleStartTime": number, "Timezone": "string" } }, "TriggerType": "string" } }, "ObjectTypeName": "string", "ObjectTypeNames": { "string" : "string" }, "RoleArn": "string", "Scope": "string", "Tags": { "string" : "string" }, "Uri": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_PutIntegration_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [EventTriggerNames](#API_connect-customer-profiles_PutIntegration_RequestSyntax) ** A list of unique names for active event triggers associated with the integration. Type: Array of strings Array Members: Fixed number of 1 item. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: No ** [FlowDefinition](#API_connect-customer-profiles_PutIntegration_RequestSyntax) ** The configuration that controls how Customer Profiles retrieves data from the source. Type: [FlowDefinition](API_connect-customer-profiles_FlowDefinition.md) object Required: No ** [ObjectTypeName](#API_connect-customer-profiles_PutIntegration_RequestSyntax) ** The name of the profile object type. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` Required: No ** [ObjectTypeNames](#API_connect-customer-profiles_PutIntegration_RequestSyntax) ** A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an `ObjectTypeName` (template) used to ingest the event. It supports the following event types: `SegmentIdentify`, `ShopifyCreateCustomers`, `ShopifyUpdateCustomers`, `ShopifyCreateDraftOrders`, `ShopifyUpdateDraftOrders`, `ShopifyCreateOrders`, and `ShopifyUpdatedOrders`. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 255. Value Length Constraints: Minimum length of 1. Maximum length of 255. Value Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` Required: No ** [RoleArn](#API_connect-customer-profiles_PutIntegration_RequestSyntax) ** The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make Customer Profiles requests on your behalf. Type: String Length Constraints: Maximum length of 512. Pattern: `arn:aws:iam:.*:[0-9]+:.*` Required: No ** [Scope](#API_connect-customer-profiles_PutIntegration_RequestSyntax) ** Specifies whether the integration applies to profile level data (associated with profiles) or domain level data (not associated with any specific profile). The default value is PROFILE. Type: String Valid Values: `PROFILE | DOMAIN` Required: No ** [Tags](#API_connect-customer-profiles_PutIntegration_RequestSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. Required: No ** [Uri](#API_connect-customer-profiles_PutIntegration_RequestSyntax) ** The URI of the S3 bucket or any other type of data source. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreatedAt": number, "DomainName": "string", "EventTriggerNames": [ "string" ], "IsUnstructured": boolean, "LastUpdatedAt": number, "ObjectTypeName": "string", "ObjectTypeNames": { "string" : "string" }, "RoleArn": "string", "Scope": "string", "Tags": { "string" : "string" }, "Uri": "string", "WorkflowId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedAt](#API_connect-customer-profiles_PutIntegration_ResponseSyntax) ** The timestamp of when the domain was created. Type: Timestamp ** [DomainName](#API_connect-customer-profiles_PutIntegration_ResponseSyntax) ** The unique name of the domain. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [EventTriggerNames](#API_connect-customer-profiles_PutIntegration_ResponseSyntax) ** A list of unique names for active event triggers associated with the integration. This list would be empty if no Event Trigger is associated with the integration. Type: Array of strings Array Members: Fixed number of 1 item. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [IsUnstructured](#API_connect-customer-profiles_PutIntegration_ResponseSyntax) ** Boolean that shows if the Flow that's associated with the Integration is created in Amazon Appflow, or with ObjectTypeName equals \$1unstructured via API/CLI in flowDefinition. Type: Boolean ** [LastUpdatedAt](#API_connect-customer-profiles_PutIntegration_ResponseSyntax) ** The timestamp of when the domain was most recently edited. Type: Timestamp ** [ObjectTypeName](#API_connect-customer-profiles_PutIntegration_ResponseSyntax) ** The name of the profile object type. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` ** [ObjectTypeNames](#API_connect-customer-profiles_PutIntegration_ResponseSyntax) ** A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an `ObjectTypeName` (template) used to ingest the event. It supports the following event types: `SegmentIdentify`, `ShopifyCreateCustomers`, `ShopifyUpdateCustomers`, `ShopifyCreateDraftOrders`, `ShopifyUpdateDraftOrders`, `ShopifyCreateOrders`, and `ShopifyUpdatedOrders`. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 255. Value Length Constraints: Minimum length of 1. Maximum length of 255. Value Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` ** [RoleArn](#API_connect-customer-profiles_PutIntegration_ResponseSyntax) ** The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make Customer Profiles requests on your behalf. Type: String Length Constraints: Maximum length of 512. Pattern: `arn:aws:iam:.*:[0-9]+:.*` ** [Scope](#API_connect-customer-profiles_PutIntegration_ResponseSyntax) ** Specifies whether the integration applies to profile level data (associated with profiles) or domain level data (not associated with any specific profile). The default value is PROFILE. Type: String Valid Values: `PROFILE | DOMAIN` ** [Tags](#API_connect-customer-profiles_PutIntegration_ResponseSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ** [Uri](#API_connect-customer-profiles_PutIntegration_ResponseSyntax) ** The URI of the S3 bucket or any other type of data source. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [WorkflowId](#API_connect-customer-profiles_PutIntegration_ResponseSyntax) ** Unique identifier for the workflow. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## Examples ### Example This example illustrates one usage of PutIntegration. #### Sample Request ``` PUT /domains/ExampleDomainName/integrations HTTP/1.1 Content-type: application/json { "ObjectTypeName": "MyCustomObject", "Uri": "arn:aws:flow:us-east-1:123456789012:URIOfIntegration1" } ``` #### Sample Response ``` Content-type: application/json { "CreatedAt": 1479249799770, "DomainName": "ExampleDomainName", "LastUpdatedAt": 1479249799770, "ObjectTypeName": "MyCustomObject", "Uri": "arn:aws:flow:us-east-1:123456789012:URIOfIntegration1" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/PutIntegration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/PutIntegration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/PutIntegration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/PutIntegration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/PutIntegration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/PutIntegration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/PutIntegration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/PutIntegration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/PutIntegration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/PutIntegration) # PutProfileObject 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. ## Request Syntax ``` PUT /domains/DomainName/profiles/objects HTTP/1.1 Content-type: application/json { "Object": "string", "ObjectTypeName": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_PutProfileObject_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Object](#API_connect-customer-profiles_PutProfileObject_RequestSyntax) ** A string that is serialized from a JSON object. Type: String Length Constraints: Minimum length of 1. Maximum length of 256000. Required: Yes ** [ObjectTypeName](#API_connect-customer-profiles_PutProfileObject_RequestSyntax) ** The name of the profile object type. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "ProfileObjectUniqueKey": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ProfileObjectUniqueKey](#API_connect-customer-profiles_PutProfileObject_ResponseSyntax) ** The unique identifier of the profile object generated by the service. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## Examples ### Example 1: For a custom object This example illustrates one usage of PutProfileObject. #### Sample Request ``` PUT /domains/ExampleDomainName/profiles/objects HTTP/1.1 Content-type: application/json { "Object": "{\"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"isAlive\": true,\n \"age\": 27,\n \"address\": {\"streetAddress\": \"21 2nd Street\",\"city\": \"New York\",\"state\": \"NY\",\"postalCode\": \"10021-3100\"},\n \"phoneNumbers\": [{\"type\": \"home\",\"number\": \"212 555-1234\"},\n {\"type\": \"office\",\"number\": \"646 555-4567\"}],\n \"children\": [],\n \"spouse\": null}", "ObjectTypeName": "MyCustomObjectName" } ``` #### Sample Response ``` Content-type: application/json { "ProfileObjectUniqueKey": "HashValueOfUniqueKeyOfTheProfileObject" } ``` ### Example 2: For a pre-defined object, like a Contact Record This example illustrates one usage of PutProfileObject. #### Sample Request ``` PUT /domains/ExampleDomainName/profiles/objects HTTP/1.1 Content-type: application/json { "Object": "{\n \"mediaStreams\": [\n {\n \"type\": \"AUDIO\"\n }\n ],\n \"queue\": null,\n \"preDisconnectState\": null,\n \"references\": null,\n \"contactReferences\": null,\n \"initialContactId\": null,\n \"previousContactData\": null,\n \"recordings\": null,\n \"contactDetails\": null,\n \"initialContactFlowId\": \"e1b44e46-a457-4230-a896-64473a2dbe7d\",\n \"channel\": \"VOICE\",\n \"attributes\": null,\n \"customerEndpoint\": {\n \"address\": null,\n \"type\": \"VOIP\",\n \"arn\": null\n },\n \"transferInfo\": null,\n \"initiationMethod\": \"API\",\n \"nextContactData\": null,\n \"contactId\": \"9a3394ee-a0c4-448a-a329-9a148e53d8cd\",\n \"initiationTimestamp\": 1603319514474,\n \"connectedToSystemTimestamp\": 1603319517218,\n \"disconnectTimestamp\": 1603319517000,\n \"agentConnectionAttempts\": 0,\n \"agent\": null,\n \"systemEndpoint\": {\n \"address\": \"e1b44e46-a457-4230-a896-64473a2dbe7d\",\n \"type\": \"CONTACT_FLOW\",\n \"arn\": null\n },\n \"instanceARN\": \"arn:aws:connect:us-west-2:941081270797:instance/fb129b8c-4a2f-4561-859b-cc190fa047b1\",\n \"lastUpdateTimestamp\": 1603319579763,\n \"disconnectReason\": \"CUSTOMER_DISCONNECT\",\n \"awsaccountId\": \"941081270797\",\n \"awscontactTraceRecordFormatVersion\": \"2019-01-23\"\n}", "ObjectTypeName": "CTR" } ``` #### Sample Response ``` Content-type: application/json { "ProfileObjectUniqueKey": "HashValueOfTheCTRContactId" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/PutProfileObject) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/PutProfileObject) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/PutProfileObject) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/PutProfileObject) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/PutProfileObject) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/PutProfileObject) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/PutProfileObject) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/PutProfileObject) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/PutProfileObject) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/PutProfileObject) # PutProfileObjectType Defines a ProfileObjectType. To add or remove tags on an existing ObjectType, see [ TagResource](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html)/[UntagResource](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html). ## Request Syntax ``` PUT /domains/DomainName/object-types/ObjectTypeName HTTP/1.1 Content-type: application/json { "AllowProfileCreation": boolean, "Description": "string", "EncryptionKey": "string", "ExpirationDays": number, "Fields": { "string" : { "ContentType": "string", "Source": "string", "Target": "string" } }, "Keys": { "string" : [ { "FieldNames": [ "string" ], "StandardIdentifiers": [ "string" ] } ] }, "MaxProfileObjectCount": number, "SourceLastUpdatedTimestampFormat": "string", "SourcePriority": number, "Tags": { "string" : "string" }, "TemplateId": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_PutProfileObjectType_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [ObjectTypeName](#API_connect-customer-profiles_PutProfileObjectType_RequestSyntax) ** The name of the profile object type. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [AllowProfileCreation](#API_connect-customer-profiles_PutProfileObjectType_RequestSyntax) ** Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is `FALSE`. If the AllowProfileCreation flag is set to `FALSE`, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to `TRUE`, and if no match is found, then the service creates a new standard profile. Type: Boolean Required: No ** [Description](#API_connect-customer-profiles_PutProfileObjectType_RequestSyntax) ** Description of the profile object type. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Required: Yes ** [EncryptionKey](#API_connect-customer-profiles_PutProfileObjectType_RequestSyntax) ** The customer-provided key to encrypt the profile object that will be created in this profile object type. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Required: No ** [ExpirationDays](#API_connect-customer-profiles_PutProfileObjectType_RequestSyntax) ** The number of days until the data in the object expires. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1098. Required: No ** [Fields](#API_connect-customer-profiles_PutProfileObjectType_RequestSyntax) ** A map of the name and ObjectType field. Type: String to [ObjectTypeField](API_connect-customer-profiles_ObjectTypeField.md) object map Key Length Constraints: Minimum length of 1. Maximum length of 64. Key Pattern: `^[a-zA-Z0-9_.-]+$` Required: No ** [Keys](#API_connect-customer-profiles_PutProfileObjectType_RequestSyntax) ** A list of unique keys that can be used to map data to the profile. Type: String to array of [ObjectTypeKey](API_connect-customer-profiles_ObjectTypeKey.md) objects map Key Length Constraints: Minimum length of 1. Maximum length of 64. Key Pattern: `^[a-zA-Z0-9_-]+$` Required: No ** [MaxProfileObjectCount](#API_connect-customer-profiles_PutProfileObjectType_RequestSyntax) ** The amount of profile object max count assigned to the object type Type: Integer Valid Range: Minimum value of 1. Required: No ** [SourceLastUpdatedTimestampFormat](#API_connect-customer-profiles_PutProfileObjectType_RequestSyntax) ** The format of your `sourceLastUpdatedTimestamp` that was previously set up. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** [SourcePriority](#API_connect-customer-profiles_PutProfileObjectType_RequestSyntax) ** An integer that determines the priority of this object type when data from multiple sources is ingested. Lower values take priority. Object types without a specified source priority default to the lowest priority. Type: Integer Valid Range: Minimum value of 1. Required: No ** [Tags](#API_connect-customer-profiles_PutProfileObjectType_RequestSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. Required: No ** [TemplateId](#API_connect-customer-profiles_PutProfileObjectType_RequestSyntax) ** A unique identifier for the object template. For some attributes in the request, the service will use the default value from the object template when TemplateId is present. If these attributes are present in the request, the service may return a `BadRequestException`. These attributes include: AllowProfileCreation, SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if AllowProfileCreation is set to true when TemplateId is set, the service may return a `BadRequestException`. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "AllowProfileCreation": boolean, "CreatedAt": number, "Description": "string", "EncryptionKey": "string", "ExpirationDays": number, "Fields": { "string" : { "ContentType": "string", "Source": "string", "Target": "string" } }, "Keys": { "string" : [ { "FieldNames": [ "string" ], "StandardIdentifiers": [ "string" ] } ] }, "LastUpdatedAt": number, "MaxAvailableProfileObjectCount": number, "MaxProfileObjectCount": number, "ObjectTypeName": "string", "SourceLastUpdatedTimestampFormat": "string", "SourcePriority": number, "Tags": { "string" : "string" }, "TemplateId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AllowProfileCreation](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) ** Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is `FALSE`. If the AllowProfileCreation flag is set to `FALSE`, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to `TRUE`, and if no match is found, then the service creates a new standard profile. Type: Boolean ** [CreatedAt](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) ** The timestamp of when the domain was created. Type: Timestamp ** [Description](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) ** Description of the profile object type. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. ** [EncryptionKey](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) ** The customer-provided key to encrypt the profile object that will be created in this profile object type. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. ** [ExpirationDays](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) ** The number of days until the data in the object expires. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1098. ** [Fields](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) ** A map of the name and ObjectType field. Type: String to [ObjectTypeField](API_connect-customer-profiles_ObjectTypeField.md) object map Key Length Constraints: Minimum length of 1. Maximum length of 64. Key Pattern: `^[a-zA-Z0-9_.-]+$` ** [Keys](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) ** A list of unique keys that can be used to map data to the profile. Type: String to array of [ObjectTypeKey](API_connect-customer-profiles_ObjectTypeKey.md) objects map Key Length Constraints: Minimum length of 1. Maximum length of 64. Key Pattern: `^[a-zA-Z0-9_-]+$` ** [LastUpdatedAt](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) ** The timestamp of when the domain was most recently edited. Type: Timestamp ** [MaxAvailableProfileObjectCount](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) ** The amount of provisioned profile object max count available. Type: Integer Valid Range: Minimum value of 0. ** [MaxProfileObjectCount](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) ** The amount of profile object max count assigned to the object type. Type: Integer Valid Range: Minimum value of 1. ** [ObjectTypeName](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) ** The name of the profile object type. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` ** [SourceLastUpdatedTimestampFormat](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) ** The format of your `sourceLastUpdatedTimestamp` that was previously set up in fields that were parsed using [SimpleDateFormat](https://docs.oracle.com/javase/10/docs/api/java/text/SimpleDateFormat.html). If you have `sourceLastUpdatedTimestamp` in your field, you must set up `sourceLastUpdatedTimestampFormat`. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [SourcePriority](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) ** An integer that determines the priority of this object type when data from multiple sources is ingested. Lower values take priority. Object types without a specified source priority default to the lowest priority. Type: Integer Valid Range: Minimum value of 1. ** [Tags](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ** [TemplateId](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) ** A unique identifier for the object template. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## Examples ### Example 1 In the request, replace the `Fields` and `Keys` request parameters with your own. If specifying a `TemplateId`, replace it with your own `TemplateId` value. You must either specify both `Fields` and `Keys`, or you can specify `TemplateId`. You can't include all three. #### Sample Request ``` PUT /domains/ExampleDomainName/object-types/CustomProfileObjectTypeName HTTP/1.1 { "Description": "Internal ERP System", "EncryptionKey": "arn:aws:kms:us-east-1:123456789012:key/1988472d-6b77-4bb6-ae39-efce5EXAMPLE", "AllowProfileCreation": false, "ExpirationDays": 1000, "Fields": { "email" : { "ContentType": "EMAIL_ADDRESS", "Source": "_source.email", "Target": "_profile.BusinessEmail" }, "phone" : { "ContentType": "PHONE_NUMBER", "Source": "_source.phone", "Target": "_profile.BusinessPhoneNumber" }, "loyaltyPoints" : { "ContentType": "NUMBER", "Source": "_source.loyaltypoints", "Target": "_profile.Attributes.loyaltypoints" } }, "Keys": { "_email" : [ { "FieldNames": [ "email" ], "StandardIdentifiers": [ "PROFILE", "UNIQUE" ] } ], "loyaltypoints" : [ { "FieldNames": [ "loyaltyPoints" ], "StandardIdentifiers": [ "PROFILE"] } ] }, "SourcePriority": 2, "TemplateId": "MyTemplateId" } ``` #### Sample Response ``` Content-type: application/json { "CreatedAt": 1479249799770, "Description": "Internal ERP System", "EncryptionKey": "arn:aws:kms:us-east-1:123456789012:key/1988472d-6b77-4bb6-ae39-efce5EXAMPLE", "AllowProfileCreation": "FALSE", "ExpirationDays": 100, "Fields": { "email" : { "ContentType": "EMAIL_ADDRESS", "Source": "_source.email", "Target": "_profile.BusinessEmailAddress" }, "phone" : { "ContentType": "PHONE_NUMBER", "Source": "_source.phone", "Target": "_profile.BusinessPhoneNumber" }, "loyaltyPoints" : { "ContentType": "NUMBER", "Source": "_source.loyaltypoints", "Target": "_profile.Attributes.loyaltypoints" } }, "Keys": { "email" : [ { "FieldNames": [ "email" ], "StandardIdentifiers": [ "PROFILE", "UNIQUE" ] } ], "loyaltypoints" : [ { "FieldNames": [ "loyaltyPoints" ], "StandardIdentifiers": [ "PROFILE"] } ] }, "LastUpdatedAt": 1479249799770, "ObjectTypeName": "CustomProfileObjectTypeName", "SourcePriority": 2, "TemplateId": "MyTemplateId" } ``` ### Example 2 This example illustrates one usage of PutProfileObjectType. #### Sample Request ``` PUT /domains/ExampleDomainName/object-types/CTR HTTP/1.1 Content-type: application/json { "Description": "CTR", "TemplateId": "CTR-NoInferred" } ``` ### Example 2.5 This command associates Contact Records with already existing profiles with the same phone number. In the example below, replace `ExampleDomainName` with your domain name, and replace the description with your desired description. #### Sample Request ``` aws profile put-object-type --domain-name ExampleDomainName --object-type-name CTR --description "CTR" --template-id "CTR-NoInferred" ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/PutProfileObjectType) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/PutProfileObjectType) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/PutProfileObjectType) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/PutProfileObjectType) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/PutProfileObjectType) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/PutProfileObjectType) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/PutProfileObjectType) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/PutProfileObjectType) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/PutProfileObjectType) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/PutProfileObjectType) # SearchProfiles Searches for profiles within a specific domain using one or more predefined search keys (e.g., \$1fullName, \$1phone, \$1email, \$1account, 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. ## Request Syntax ``` POST /domains/DomainName/profiles/search?max-results=MaxResults&next-token=NextToken HTTP/1.1 Content-type: application/json { "AdditionalSearchKeys": [ { "KeyName": "string", "Values": [ "string" ] } ], "KeyName": "string", "LogicalOperator": "string", "Values": [ "string" ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_SearchProfiles_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [MaxResults](#API_connect-customer-profiles_SearchProfiles_RequestSyntax) ** The maximum number of objects returned per page. The default is 20 if this parameter is not included in the request. Valid Range: Minimum value of 1. Maximum value of 100. ** [NextToken](#API_connect-customer-profiles_SearchProfiles_RequestSyntax) ** The pagination token from the previous SearchProfiles API call. Length Constraints: Minimum length of 1. Maximum length of 1024. ## Request Body The request accepts the following data in JSON format. ** [AdditionalSearchKeys](#API_connect-customer-profiles_SearchProfiles_RequestSyntax) ** A list of `AdditionalSearchKey` objects that are each searchable identifiers of a profile. Each `AdditionalSearchKey` object contains a `KeyName` and a list of `Values` associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with the `LogicalOperator` and the required `KeyName` and `Values` parameters to search for profiles that satisfy the search criteria. Type: Array of [AdditionalSearchKey](API_connect-customer-profiles_AdditionalSearchKey.md) objects Array Members: Minimum number of 1 item. Maximum number of 4 items. Required: No ** [KeyName](#API_connect-customer-profiles_SearchProfiles_RequestSyntax) ** A searchable identifier of a customer profile. The predefined keys you can use to search include: \$1account, \$1profileId, \$1assetId, \$1caseId, \$1orderId, \$1fullName, \$1phone, \$1email, \$1ctrContactId, \$1marketoLeadId, \$1salesforceAccountId, \$1salesforceContactId, \$1salesforceAssetId, \$1zendeskUserId, \$1zendeskExternalId, \$1zendeskTicketId, \$1serviceNowSystemId, \$1serviceNowIncidentId, \$1segmentUserId, \$1shopifyCustomerId, \$1shopifyOrderId. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [LogicalOperator](#API_connect-customer-profiles_SearchProfiles_RequestSyntax) ** Relationship between all specified search keys that will be used to search for profiles. This includes the required `KeyName` and `Values` parameters as well as any key-value(s) pairs specified in the `AdditionalSearchKeys` list. This parameter influences which profiles will be returned in the response in the following manner: + `AND` - The response only includes profiles that match all of the search keys. + `OR` - The response includes profiles that match at least one of the search keys. The `OR` relationship is the default behavior if this parameter is not included in the request. Type: String Valid Values: `AND | OR` Required: No ** [Values](#API_connect-customer-profiles_SearchProfiles_RequestSyntax) ** A list of key values. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "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" : "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", "EngagementPreferences": { "Email": [ { "ContactType": "string", "KeyName": "string", "KeyValue": "string", "ProfileId": "string" } ], "Phone": [ { "ContactType": "string", "KeyName": "string", "KeyValue": "string", "ProfileId": "string" } ] }, "FirstName": "string", "FoundByItems": [ { "KeyName": "string", "Values": [ "string" ] } ], "Gender": "string", "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": "string", "PartyTypeString": "string", "PersonalEmailAddress": "string", "PhoneNumber": "string", "ProfileId": "string", "ProfileType": "string", "ShippingAddress": { "Address1": "string", "Address2": "string", "Address3": "string", "Address4": "string", "City": "string", "Country": "string", "County": "string", "PostalCode": "string", "Province": "string", "State": "string" } } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Items](#API_connect-customer-profiles_SearchProfiles_ResponseSyntax) ** The list of Profiles matching the search criteria. Type: Array of [Profile](API_connect-customer-profiles_Profile.md) objects ** [NextToken](#API_connect-customer-profiles_SearchProfiles_ResponseSyntax) ** The pagination token from the previous SearchProfiles API call. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## Examples ### Example 1 This example illustrates one usage of SearchProfiles. #### Sample Request ``` POST /domains/ExampleDomainName/profiles/search?max-results=10&next-token=nextTokenString HTTP/1.1 Content-type: application/json { "KeyName": "_phone", "Values": ["555-333-7777"] } ``` #### Sample Response ``` Content-type: application/json { "NextToken": "5231b533-ba17-4787-98a3-f2df3EXAMPLE", "Items":[ { "ProfileId" : "3991a7d95sd248bba82546b2dEXAMPLE", "AccountNumber": "ACCT12344", "Address": { "Address1": "123 Sample St", "Address2": "Apt 4", "Address3": "", "Address4": "", "City": "Seattle", "Country": "USA", "County": "King", "PostalCode": "98011", "Province": "", "State": "WA" }, "Attributes": { "SSN" : "123-44-3433", "LoyaltyPoints" : "4000" }, "BillingAddress": { "Address1": "789 Sample St", "Address2": "Apt 1", "Address3": "", "Address4": "", "City": "Seattle", "Country": "USA", "County": "King", "PostalCode": "98011", "Province": "", "State": "WA" }, "BirthDate": "07/12/1980", "BusinessEmailAddress": "example@amazon.com", "BusinessName": "My Awesome Company", "BusinessPhoneNumber": "555-334-3389", "EmailAddress": "example@gmail.com", "FirstName": "John", "Gender": "MALE", "HomePhoneNumber": "555-334-3344", "LastName": "Doe", "MailingAddress": { "Address1": "234 Home St", "Address2": "Apt 5", "Address3": "", "Address4": "", "City": "Seattle", "Country": "USA", "County": "King", "PostalCode": "98011", "Province": "", "State": "WA" }, "AdditionalInformation": "High Profile Customer", "MiddleName": "", "MobilePhoneNumber": "555-333-7777", "PartyType": "INDIVIDUAL", "PersonalEmailAddress": "email1@gmail.com", "PhoneNumber": "", "ShippingAddress": { "Address1": "555 A St", "Address2": "Suite 100", "Address3": "", "Address4": "", "City": "Seattle", "Country": "USA", "County": "King", "PostalCode": "98011", "Province": "", "State": "WA" } }, { "ProfileId" : "ef30fad550894e0a95f9d64cbEXAMPLE", "AccountNumber": "ACCT12344", "Address": { "Address1": "123 Sample St", "Address2": "Apt 4", "Address3": "", "Address4": "", "City": "Seattle", "Country": "USA", "County": "King", "PostalCode": "98011", "Province": "", "State": "WA" }, "Attributes": { "SSN" : "123-44-3433", "LoyaltyPoints" : "4000" }, "BillingAddress": { "Address1": "789 Sample St", "Address2": "Apt 1", "Address3": "", "Address4": "", "City": "Seattle", "Country": "USA", "County": "King", "PostalCode": "98011", "Province": "", "State": "WA" }, "BirthDate": "07/12/1980", "BusinessEmailAddress": "example@amazon.com", "BusinessName": "My Awesome Company", "BusinessPhoneNumber": "555-334-3389", "EmailAddress": "example@gmail.com", "FirstName": "John", "Gender": "MALE", "HomePhoneNumber": "555-334-3344", "LastName": "Doe", "MailingAddress": { "Address1": "234 Home St", "Address2": "Apt 5", "Address3": "", "Address4": "", "City": "Seattle", "Country": "USA", "County": "King", "PostalCode": "98011", "Province": "", "State": "WA" }, "AdditionalInformation": "High Profile Customer", "MiddleName": "", "MobilePhoneNumber": "555-333-7777", "PartyType": "INDIVIDUAL", "PersonalEmailAddress": "email1@gmail.com", "PhoneNumber": "", "ShippingAddress": { "Address1": "555 A St", "Address2": "Suite 100", "Address3": "", "Address4": "", "City": "Seattle", "Country": "USA", "County": "King", "PostalCode": "98011", "Province": "", "State": "WA" } } ] } ``` ### Example 2 This example illustrates one usage of SearchProfiles. #### Sample Request ``` POST /domains/ExampleDomainName/profiles/search?max-results=10&next-token=nextTokenString HTTP/1.1 Content-type: application/json { "KeyName": "_email", "Values": ["email1@gmail.com"] } ``` #### Sample Response ``` Content-type: application/json { "NextToken": "5231b533-ba17-4787-98a3-f2df3EXAMPLE", "Items":[ { "ProfileId" : "ef30fad55099ee0a95f9d64cbEXAMPLE", "AccountNumber": "ACCT12344", "Address": { "Address1": "123 Sample St", "Address2": "Apt 4", "Address3": "", "Address4": "", "City": "Seattle", "Country": "USA", "County": "King", "PostalCode": "98011", "Province": "", "State": "WA" }, "Attributes": { "SSN" : "123-44-3433", "LoyaltyPoints" : "4000" }, "BillingAddress": { "Address1": "789 Sample St", "Address2": "Apt 1", "Address3": "", "Address4": "", "City": "Seattle", "Country": "USA", "County": "King", "PostalCode": "98011", "Province": "", "State": "WA" }, "BirthDate": "07/12/1980", "BusinessEmailAddress": "example@amazon.com", "BusinessName": "My Awesome Company", "BusinessPhoneNumber": "555-334-3389", "EmailAddress": "example@gmail.com", "FirstName": "John", "Gender": "MALE", "HomePhoneNumber": "555-334-3344", "LastName": "Doe", "MailingAddress": { "Address1": "234 Home St", "Address2": "Apt 5", "Address3": "", "Address4": "", "City": "Seattle", "Country": "USA", "County": "King", "PostalCode": "98011", "Province": "", "State": "WA" }, "AdditionalInformation": "High Profile Customer", "MiddleName": "", "MobilePhoneNumber": "555-333-7777", "PartyType": "INDIVIDUAL", "PersonalEmailAddress": "email5@gmail.com", "PhoneNumber": "", "ShippingAddress": { "Address1": "555 A St", "Address2": "Suite 100", "Address3": "", "Address4": "", "City": "Seattle", "Country": "USA", "County": "King", "PostalCode": "98011", "Province": "", "State": "WA" } }, { "ProfileId" : "3991a7d959d238bba82546b2dEXAMPLE", "AccountNumber": "ACCT12344", "Address": { "Address1": "123 Sample St", "Address2": "Apt 4", "Address3": "", "Address4": "", "City": "Seattle", "Country": "USA", "County": "King", "PostalCode": "98011", "Province": "", "State": "WA" }, "Attributes": { "SSN" : "123-44-3433", "LoyaltyPoints" : "4000" }, "BillingAddress": { "Address1": "789 Sample St", "Address2": "Apt 1", "Address3": "", "Address4": "", "City": "Seattle", "Country": "USA", "County": "King", "PostalCode": "98011", "Province": "", "State": "WA" }, "BirthDate": "07/12/1980", "BusinessEmailAddress": "example@amazon.com", "BusinessName": "My Awesome Company", "BusinessPhoneNumber": "555-334-3389", "EmailAddress": "example@gmail.com", "FirstName": "John", "Gender": "MALE", "HomePhoneNumber": "555-334-3344", "LastName": "Doe", "MailingAddress": { "Address1": "234 Home St", "Address2": "Apt 5", "Address3": "", "Address4": "", "City": "Seattle", "Country": "USA", "County": "King", "PostalCode": "98011", "Province": "", "State": "WA" }, "AdditionalInformation": "High Profile Customer", "MiddleName": "", "MobilePhoneNumber": "555-333-7777", "PartyType": "INDIVIDUAL", "PersonalEmailAddress": "email1@gmail.com", "PhoneNumber": "", "ShippingAddress": { "Address1": "555 A St", "Address2": "Suite 100", "Address3": "", "Address4": "", "City": "Seattle", "Country": "USA", "County": "King", "PostalCode": "98011", "Province": "", "State": "WA" } } ] } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/SearchProfiles) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/SearchProfiles) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/SearchProfiles) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/SearchProfiles) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/SearchProfiles) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/SearchProfiles) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/SearchProfiles) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/SearchProfiles) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/SearchProfiles) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/SearchProfiles) # StartRecommender Starts a recommender that was previously stopped. Starting a recommender resumes its ability to generate recommendations. ## Request Syntax ``` PUT /domains/DomainName/recommenders/RecommenderName/start HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_StartRecommender_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [RecommenderName](#API_connect-customer-profiles_StartRecommender_RequestSyntax) ** The name of the recommender to start. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/StartRecommender) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/StartRecommender) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/StartRecommender) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/StartRecommender) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/StartRecommender) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/StartRecommender) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/StartRecommender) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/StartRecommender) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/StartRecommender) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/StartRecommender) # StartUploadJob This API starts the processing of an upload job to ingest profile data. ## Request Syntax ``` PUT /domains/DomainName/upload-jobs/JobId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_StartUploadJob_RequestSyntax) ** The unique name of the domain containing the upload job to start. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [JobId](#API_connect-customer-profiles_StartUploadJob_RequestSyntax) ** The unique identifier of the upload job to start. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/StartUploadJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/StartUploadJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/StartUploadJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/StartUploadJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/StartUploadJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/StartUploadJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/StartUploadJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/StartUploadJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/StartUploadJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/StartUploadJob) # StopRecommender Stops a recommender, suspending its ability to generate recommendations. The recommender can be restarted later using StartRecommender. ## Request Syntax ``` PUT /domains/DomainName/recommenders/RecommenderName/stop HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_StopRecommender_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [RecommenderName](#API_connect-customer-profiles_StopRecommender_RequestSyntax) ** The name of the recommender to stop. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/StopRecommender) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/StopRecommender) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/StopRecommender) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/StopRecommender) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/StopRecommender) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/StopRecommender) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/StopRecommender) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/StopRecommender) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/StopRecommender) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/StopRecommender) # StopUploadJob This API stops the processing of an upload job. ## Request Syntax ``` PUT /domains/DomainName/upload-jobs/JobId/stop HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_StopUploadJob_RequestSyntax) ** The unique name of the domain containing the upload job to stop. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [JobId](#API_connect-customer-profiles_StopUploadJob_RequestSyntax) ** The unique identifier of the upload job to stop. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/StopUploadJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/StopUploadJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/StopUploadJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/StopUploadJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/StopUploadJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/StopUploadJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/StopUploadJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/StopUploadJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/StopUploadJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/StopUploadJob) # TagResource 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. ## Request Syntax ``` POST /tags/resourceArn HTTP/1.1 Content-type: application/json { "tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [resourceArn](#API_connect-customer-profiles_TagResource_RequestSyntax) ** The ARN of the resource that you're adding tags to. Length Constraints: Maximum length of 256. Pattern: `^arn:[a-z0-9]{1,10}:profile` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [tags](#API_connect-customer-profiles_TagResource_RequestSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/TagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/TagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/TagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/TagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/TagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/TagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/TagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/TagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/TagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/TagResource) # UntagResource 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. ## Request Syntax ``` DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [resourceArn](#API_connect-customer-profiles_UntagResource_RequestSyntax) ** The ARN of the resource from which you are removing tags. Length Constraints: Maximum length of 256. Pattern: `^arn:[a-z0-9]{1,10}:profile` Required: Yes ** [tagKeys](#API_connect-customer-profiles_UntagResource_RequestSyntax) ** The list of tag keys to remove from the resource. Array Members: Minimum number of 1 item. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/UntagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/UntagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/UntagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/UntagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/UntagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/UntagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/UntagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/UntagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/UntagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/UntagResource) # UpdateCalculatedAttributeDefinition 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. ## Request Syntax ``` PUT /domains/DomainName/calculated-attributes/CalculatedAttributeName HTTP/1.1 Content-type: application/json { "Conditions": { "ObjectCount": number, "Range": { "TimestampFormat": "string", "TimestampSource": "string", "Unit": "string", "Value": number, "ValueRange": { "End": number, "Start": number } }, "Threshold": { "Operator": "string", "Value": "string" } }, "Description": "string", "DisplayName": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [CalculatedAttributeName](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_RequestSyntax) ** The unique name of the calculated attribute. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` Required: Yes ** [DomainName](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Conditions](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_RequestSyntax) ** The conditions including range, object count, and threshold for the calculated attribute. Type: [Conditions](API_connect-customer-profiles_Conditions.md) object Required: No ** [Description](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_RequestSyntax) ** The description of the calculated attribute. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Required: No ** [DisplayName](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_RequestSyntax) ** The display name of the calculated attribute. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-\s]*$` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "AttributeDetails": { "Attributes": [ { "Name": "string" } ], "Expression": "string" }, "CalculatedAttributeName": "string", "Conditions": { "ObjectCount": number, "Range": { "TimestampFormat": "string", "TimestampSource": "string", "Unit": "string", "Value": number, "ValueRange": { "End": number, "Start": number } }, "Threshold": { "Operator": "string", "Value": "string" } }, "CreatedAt": number, "Description": "string", "DisplayName": "string", "LastUpdatedAt": number, "Readiness": { "Message": "string", "ProgressPercentage": number }, "Statistic": "string", "Status": "string", "Tags": { "string" : "string" }, "UseHistoricalData": boolean } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AttributeDetails](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_ResponseSyntax) ** The mathematical expression and a list of attribute items specified in that expression. Type: [AttributeDetails](API_connect-customer-profiles_AttributeDetails.md) object ** [CalculatedAttributeName](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_ResponseSyntax) ** The unique name of the calculated attribute. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` ** [Conditions](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_ResponseSyntax) ** The conditions including range, object count, and threshold for the calculated attribute. Type: [Conditions](API_connect-customer-profiles_Conditions.md) object ** [CreatedAt](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_ResponseSyntax) ** The timestamp of when the calculated attribute definition was created. Type: Timestamp ** [Description](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_ResponseSyntax) ** The description of the calculated attribute. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. ** [DisplayName](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_ResponseSyntax) ** The display name of the calculated attribute. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-\s]*$` ** [LastUpdatedAt](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_ResponseSyntax) ** The timestamp of when the calculated attribute definition was most recently edited. Type: Timestamp ** [Readiness](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_ResponseSyntax) ** Information indicating if the Calculated Attribute is ready for use by confirming all historical data has been processed and reflected. Type: [Readiness](API_connect-customer-profiles_Readiness.md) object ** [Statistic](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_ResponseSyntax) ** The aggregation operation to perform for the calculated attribute. Type: String Valid Values: `FIRST_OCCURRENCE | LAST_OCCURRENCE | COUNT | SUM | MINIMUM | MAXIMUM | AVERAGE | MAX_OCCURRENCE` ** [Status](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_ResponseSyntax) ** Status of the Calculated Attribute creation (whether all historical data has been indexed.) Type: String Valid Values: `PREPARING | IN_PROGRESS | COMPLETED | FAILED` ** [Tags](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_ResponseSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ** [UseHistoricalData](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_ResponseSyntax) ** Whether historical data ingested before the Calculated Attribute was created should be included in calculations. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/UpdateCalculatedAttributeDefinition) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/UpdateCalculatedAttributeDefinition) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/UpdateCalculatedAttributeDefinition) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/UpdateCalculatedAttributeDefinition) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/UpdateCalculatedAttributeDefinition) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/UpdateCalculatedAttributeDefinition) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/UpdateCalculatedAttributeDefinition) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/UpdateCalculatedAttributeDefinition) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/UpdateCalculatedAttributeDefinition) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/UpdateCalculatedAttributeDefinition) # UpdateDomain 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](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html) to enable [identity resolution](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html): set `Matching` to true. To prevent cross-service impersonation when you call this API, see [Cross-service confused deputy prevention](https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html) for sample policies that you should apply. To add or remove tags on an existing Domain, see [TagResource](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html)/[UntagResource](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html). ## Request Syntax ``` PUT /domains/DomainName HTTP/1.1 Content-type: application/json { "DataStore": { "Enabled": boolean }, "DeadLetterQueueUrl": "string", "DefaultEncryptionKey": "string", "DefaultExpirationDays": number, "Matching": { "AutoMerging": { "ConflictResolution": { "ConflictResolvingModel": "string", "SourceName": "string" }, "Consolidation": { "MatchingAttributesList": [ [ "string" ] ] }, "Enabled": boolean, "MinAllowedConfidenceScoreForMerging": number }, "Enabled": boolean, "ExportingConfig": { "S3Exporting": { "S3BucketName": "string", "S3KeyName": "string" } }, "JobSchedule": { "DayOfTheWeek": "string", "Time": "string" } }, "RuleBasedMatching": { "AttributeTypesSelector": { "Address": [ "string" ], "AttributeMatchingModel": "string", "EmailAddress": [ "string" ], "PhoneNumber": [ "string" ] }, "ConflictResolution": { "ConflictResolvingModel": "string", "SourceName": "string" }, "Enabled": boolean, "ExportingConfig": { "S3Exporting": { "S3BucketName": "string", "S3KeyName": "string" } }, "MatchingRules": [ { "Rule": [ "string" ] } ], "MaxAllowedRuleLevelForMatching": number, "MaxAllowedRuleLevelForMerging": number }, "Tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_UpdateDomain_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [DataStore](#API_connect-customer-profiles_UpdateDomain_RequestSyntax) ** Set to true to enabled data store for this domain. Type: [DataStoreRequest](API_connect-customer-profiles_DataStoreRequest.md) object Required: No ** [DeadLetterQueueUrl](#API_connect-customer-profiles_UpdateDomain_RequestSyntax) ** The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Required: No ** [DefaultEncryptionKey](#API_connect-customer-profiles_UpdateDomain_RequestSyntax) ** The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. If specified as an empty string, it will clear any existing value. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Required: No ** [DefaultExpirationDays](#API_connect-customer-profiles_UpdateDomain_RequestSyntax) ** The default number of days until the data within the domain expires. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1098. Required: No ** [Matching](#API_connect-customer-profiles_UpdateDomain_RequestSyntax) ** The process of matching duplicate profiles. If `Matching` = `true`, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the Identity Resolution Job completes, use the [GetMatches](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html) API to return and review the results. Or, if you have configured `ExportingConfig` in the `MatchingRequest`, you can download the results from S3. Type: [MatchingRequest](API_connect-customer-profiles_MatchingRequest.md) object Required: No ** [RuleBasedMatching](#API_connect-customer-profiles_UpdateDomain_RequestSyntax) ** The process of matching duplicate profiles using the rule-Based matching. If `RuleBasedMatching` = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the `RuleBasedMatchingRequest`. You can use the `ListRuleBasedMatches` and `GetSimilarProfiles` API to return and review the results. Also, if you have configured `ExportingConfig` in the `RuleBasedMatchingRequest`, you can download the results from S3. Type: [RuleBasedMatchingRequest](API_connect-customer-profiles_RuleBasedMatchingRequest.md) object Required: No ** [Tags](#API_connect-customer-profiles_UpdateDomain_RequestSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreatedAt": number, "DataStore": { "Enabled": boolean, "Readiness": { "Message": "string", "ProgressPercentage": number } }, "DeadLetterQueueUrl": "string", "DefaultEncryptionKey": "string", "DefaultExpirationDays": number, "DomainName": "string", "LastUpdatedAt": number, "Matching": { "AutoMerging": { "ConflictResolution": { "ConflictResolvingModel": "string", "SourceName": "string" }, "Consolidation": { "MatchingAttributesList": [ [ "string" ] ] }, "Enabled": boolean, "MinAllowedConfidenceScoreForMerging": number }, "Enabled": boolean, "ExportingConfig": { "S3Exporting": { "S3BucketName": "string", "S3KeyName": "string" } }, "JobSchedule": { "DayOfTheWeek": "string", "Time": "string" } }, "RuleBasedMatching": { "AttributeTypesSelector": { "Address": [ "string" ], "AttributeMatchingModel": "string", "EmailAddress": [ "string" ], "PhoneNumber": [ "string" ] }, "ConflictResolution": { "ConflictResolvingModel": "string", "SourceName": "string" }, "Enabled": boolean, "ExportingConfig": { "S3Exporting": { "S3BucketName": "string", "S3KeyName": "string" } }, "MatchingRules": [ { "Rule": [ "string" ] } ], "MaxAllowedRuleLevelForMatching": number, "MaxAllowedRuleLevelForMerging": number, "Status": "string" }, "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedAt](#API_connect-customer-profiles_UpdateDomain_ResponseSyntax) ** The timestamp of when the domain was created. Type: Timestamp ** [DataStore](#API_connect-customer-profiles_UpdateDomain_ResponseSyntax) ** The data store. Type: [DataStoreResponse](API_connect-customer-profiles_DataStoreResponse.md) object ** [DeadLetterQueueUrl](#API_connect-customer-profiles_UpdateDomain_ResponseSyntax) ** The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. ** [DefaultEncryptionKey](#API_connect-customer-profiles_UpdateDomain_ResponseSyntax) ** The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. ** [DefaultExpirationDays](#API_connect-customer-profiles_UpdateDomain_ResponseSyntax) ** The default number of days until the data within the domain expires. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1098. ** [DomainName](#API_connect-customer-profiles_UpdateDomain_ResponseSyntax) ** The unique name of the domain. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [LastUpdatedAt](#API_connect-customer-profiles_UpdateDomain_ResponseSyntax) ** The timestamp of when the domain was most recently edited. Type: Timestamp ** [Matching](#API_connect-customer-profiles_UpdateDomain_ResponseSyntax) ** The process of matching duplicate profiles. If `Matching` = `true`, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the Identity Resolution Job completes, use the [GetMatches](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html) API to return and review the results. Or, if you have configured `ExportingConfig` in the `MatchingRequest`, you can download the results from S3. Type: [MatchingResponse](API_connect-customer-profiles_MatchingResponse.md) object ** [RuleBasedMatching](#API_connect-customer-profiles_UpdateDomain_ResponseSyntax) ** The process of matching duplicate profiles using the rule-Based matching. If `RuleBasedMatching` = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the `RuleBasedMatchingRequest`. You can use the `ListRuleBasedMatches` and `GetSimilarProfiles` API to return and review the results. Also, if you have configured `ExportingConfig` in the `RuleBasedMatchingRequest`, you can download the results from S3. Type: [RuleBasedMatchingResponse](API_connect-customer-profiles_RuleBasedMatchingResponse.md) object ** [Tags](#API_connect-customer-profiles_UpdateDomain_ResponseSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## Examples ### Example This example illustrates one usage of UpdateDomain. #### Sample Request ``` PUT /v1/domains/ExampleDomainName Content-type: application/json { "DeadLetterQueueUrl": "https://sqs.us-east-1.amazonaws.com/123456789012/DLQName", "DefaultEncryptionKey":"arn:aws:kms:us-east-1:123456789012:key/1988472d-6b77-4bb6-ae39-efce5EXAMPLE", "DefaultExpirationDays": 200 } ``` #### Sample Response ``` Content-type: application/json { "DeadLetterQueueUrl": "https://sqs.us-east-1.amazonaws.com/123456789012/DLQName", "CreatedAt": 1579249799770, "DefaultEncryptionKey":"arn:aws:kms:us-east-1:123456789012:key/1988472d-6b77-4bb6-ae39-efce5EXAMPLE", "DefaultExpirationDays": 200, "LastUpdatedAt":1579249799770, "DomainName": "ExampleDomainName" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/UpdateDomain) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/UpdateDomain) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/UpdateDomain) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/UpdateDomain) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/UpdateDomain) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/UpdateDomain) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/UpdateDomain) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/UpdateDomain) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/UpdateDomain) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/UpdateDomain) # UpdateDomainLayout Updates the layout used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website. ## Request Syntax ``` PUT /domains/DomainName/layouts/LayoutDefinitionName HTTP/1.1 Content-type: application/json { "Description": "string", "DisplayName": "string", "IsDefault": boolean, "Layout": "string", "LayoutType": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_UpdateDomainLayout_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [LayoutDefinitionName](#API_connect-customer-profiles_UpdateDomainLayout_RequestSyntax) ** The unique name of the layout. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Description](#API_connect-customer-profiles_UpdateDomainLayout_RequestSyntax) ** The description of the layout Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Required: No ** [DisplayName](#API_connect-customer-profiles_UpdateDomainLayout_RequestSyntax) ** The display name of the layout Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-\s]*$` Required: No ** [IsDefault](#API_connect-customer-profiles_UpdateDomainLayout_RequestSyntax) ** If set to true for a layout, this layout will be used by default to view data. If set to false, then the layout will not be used by default, but it can be used to view data by explicitly selecting it in the console. Type: Boolean Required: No ** [Layout](#API_connect-customer-profiles_UpdateDomainLayout_RequestSyntax) ** A customizable layout that can be used to view data under a Customer Profiles domain. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000000. Required: No ** [LayoutType](#API_connect-customer-profiles_UpdateDomainLayout_RequestSyntax) ** The type of layout that can be used to view data under a Customer Profiles domain. Type: String Valid Values: `PROFILE_EXPLORER` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreatedAt": number, "Description": "string", "DisplayName": "string", "IsDefault": boolean, "LastUpdatedAt": number, "Layout": "string", "LayoutDefinitionName": "string", "LayoutType": "string", "Tags": { "string" : "string" }, "Version": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedAt](#API_connect-customer-profiles_UpdateDomainLayout_ResponseSyntax) ** The timestamp of when the layout was created. Type: Timestamp ** [Description](#API_connect-customer-profiles_UpdateDomainLayout_ResponseSyntax) ** The description of the layout Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. ** [DisplayName](#API_connect-customer-profiles_UpdateDomainLayout_ResponseSyntax) ** The display name of the layout Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-\s]*$` ** [IsDefault](#API_connect-customer-profiles_UpdateDomainLayout_ResponseSyntax) ** If set to true for a layout, this layout will be used by default to view data. If set to false, then the layout will not be used by default, but it can be used to view data by explicitly selecting it in the console. Type: Boolean ** [LastUpdatedAt](#API_connect-customer-profiles_UpdateDomainLayout_ResponseSyntax) ** The timestamp of when the layout was most recently updated. Type: Timestamp ** [Layout](#API_connect-customer-profiles_UpdateDomainLayout_ResponseSyntax) ** A customizable layout that can be used to view data under a Customer Profiles domain. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000000. ** [LayoutDefinitionName](#API_connect-customer-profiles_UpdateDomainLayout_ResponseSyntax) ** The unique name of the layout. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [LayoutType](#API_connect-customer-profiles_UpdateDomainLayout_ResponseSyntax) ** The type of layout that can be used to view data under a Customer Profiles domain. Type: String Valid Values: `PROFILE_EXPLORER` ** [Tags](#API_connect-customer-profiles_UpdateDomainLayout_ResponseSyntax) ** The tags used to organize, track, or control access for this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ** [Version](#API_connect-customer-profiles_UpdateDomainLayout_ResponseSyntax) ** The version used to create layout. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/UpdateDomainLayout) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/UpdateDomainLayout) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/UpdateDomainLayout) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/UpdateDomainLayout) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/UpdateDomainLayout) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/UpdateDomainLayout) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/UpdateDomainLayout) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/UpdateDomainLayout) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/UpdateDomainLayout) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/UpdateDomainLayout) # UpdateEventTrigger Update the properties of an Event Trigger. ## Request Syntax ``` PUT /domains/DomainName/event-triggers/EventTriggerName HTTP/1.1 Content-type: application/json { "Description": "string", "EventTriggerConditions": [ { "EventTriggerDimensions": [ { "ObjectAttributes": [ { "ComparisonOperator": "string", "FieldName": "string", "Source": "string", "Values": [ "string" ] } ] } ], "LogicalOperator": "string" } ], "EventTriggerLimits": { "EventExpiration": number, "Periods": [ { "MaxInvocationsPerProfile": number, "Unit": "string", "Unlimited": boolean, "Value": number } ] }, "ObjectTypeName": "string", "SegmentFilter": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_UpdateEventTrigger_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [EventTriggerName](#API_connect-customer-profiles_UpdateEventTrigger_RequestSyntax) ** The unique name of the event trigger. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Description](#API_connect-customer-profiles_UpdateEventTrigger_RequestSyntax) ** The description of the event trigger. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Required: No ** [EventTriggerConditions](#API_connect-customer-profiles_UpdateEventTrigger_RequestSyntax) ** A list of conditions that determine when an event should trigger the destination. Type: Array of [EventTriggerCondition](API_connect-customer-profiles_EventTriggerCondition.md) objects Array Members: Minimum number of 1 item. Maximum number of 5 items. Required: No ** [EventTriggerLimits](#API_connect-customer-profiles_UpdateEventTrigger_RequestSyntax) ** Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods. Type: [EventTriggerLimits](API_connect-customer-profiles_EventTriggerLimits.md) object Required: No ** [ObjectTypeName](#API_connect-customer-profiles_UpdateEventTrigger_RequestSyntax) ** The unique name of the object type. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` Required: No ** [SegmentFilter](#API_connect-customer-profiles_UpdateEventTrigger_RequestSyntax) ** The destination is triggered only for profiles that meet the criteria of a segment definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreatedAt": number, "Description": "string", "EventTriggerConditions": [ { "EventTriggerDimensions": [ { "ObjectAttributes": [ { "ComparisonOperator": "string", "FieldName": "string", "Source": "string", "Values": [ "string" ] } ] } ], "LogicalOperator": "string" } ], "EventTriggerLimits": { "EventExpiration": number, "Periods": [ { "MaxInvocationsPerProfile": number, "Unit": "string", "Unlimited": boolean, "Value": number } ] }, "EventTriggerName": "string", "LastUpdatedAt": number, "ObjectTypeName": "string", "SegmentFilter": "string", "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedAt](#API_connect-customer-profiles_UpdateEventTrigger_ResponseSyntax) ** The timestamp of when the event trigger was created. Type: Timestamp ** [Description](#API_connect-customer-profiles_UpdateEventTrigger_ResponseSyntax) ** The description of the event trigger. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. ** [EventTriggerConditions](#API_connect-customer-profiles_UpdateEventTrigger_ResponseSyntax) ** A list of conditions that determine when an event should trigger the destination. Type: Array of [EventTriggerCondition](API_connect-customer-profiles_EventTriggerCondition.md) objects Array Members: Minimum number of 1 item. Maximum number of 5 items. ** [EventTriggerLimits](#API_connect-customer-profiles_UpdateEventTrigger_ResponseSyntax) ** Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods. Type: [EventTriggerLimits](API_connect-customer-profiles_EventTriggerLimits.md) object ** [EventTriggerName](#API_connect-customer-profiles_UpdateEventTrigger_ResponseSyntax) ** The unique name of the event trigger. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [LastUpdatedAt](#API_connect-customer-profiles_UpdateEventTrigger_ResponseSyntax) ** The timestamp of when the event trigger was most recently updated. Type: Timestamp ** [ObjectTypeName](#API_connect-customer-profiles_UpdateEventTrigger_ResponseSyntax) ** The unique name of the object type. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` ** [SegmentFilter](#API_connect-customer-profiles_UpdateEventTrigger_ResponseSyntax) ** The destination is triggered only for profiles that meet the criteria of a segment definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ** [Tags](#API_connect-customer-profiles_UpdateEventTrigger_ResponseSyntax) ** An array of key-value pairs to apply to this resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Maximum length of 256. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/UpdateEventTrigger) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/UpdateEventTrigger) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/UpdateEventTrigger) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/UpdateEventTrigger) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/UpdateEventTrigger) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/UpdateEventTrigger) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/UpdateEventTrigger) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/UpdateEventTrigger) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/UpdateEventTrigger) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/UpdateEventTrigger) # UpdateProfile 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. ## Request Syntax ``` PUT /domains/DomainName/profiles HTTP/1.1 Content-type: application/json { "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" : "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", "EngagementPreferences": { "Email": [ { "ContactType": "string", "KeyName": "string", "KeyValue": "string", "ProfileId": "string" } ], "Phone": [ { "ContactType": "string", "KeyName": "string", "KeyValue": "string", "ProfileId": "string" } ] }, "FirstName": "string", "Gender": "string", "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": "string", "PartyTypeString": "string", "PersonalEmailAddress": "string", "PhoneNumber": "string", "ProfileId": "string", "ProfileType": "string", "ShippingAddress": { "Address1": "string", "Address2": "string", "Address3": "string", "Address4": "string", "City": "string", "Country": "string", "County": "string", "PostalCode": "string", "Province": "string", "State": "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [AccountNumber](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) ** An account number that you have assigned to the customer. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Required: No ** [AdditionalInformation](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) ** Any additional information relevant to the customer’s profile. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Required: No ** [Address](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) ** A generic address associated with the customer that is not mailing, shipping, or billing. Type: [UpdateAddress](API_connect-customer-profiles_UpdateAddress.md) object Required: No ** [Attributes](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) ** A key value pair of attributes of a customer profile. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 255. Value Length Constraints: Minimum length of 0. Maximum length of 255. Required: No ** [BillingAddress](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) ** The customer’s billing address. Type: [UpdateAddress](API_connect-customer-profiles_UpdateAddress.md) object Required: No ** [BirthDate](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) ** The customer’s birth date. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Required: No ** [BusinessEmailAddress](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) ** The customer’s business email address. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Required: No ** [BusinessName](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) ** The name of the customer’s business. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Required: No ** [BusinessPhoneNumber](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) ** The customer’s business phone number. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Required: No ** [EmailAddress](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) ** The customer’s email address, which has not been specified as a personal or business address. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Required: No ** [EngagementPreferences](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) ** Object that defines users preferred methods of engagement. Type: [EngagementPreferences](API_connect-customer-profiles_EngagementPreferences.md) object Required: No ** [FirstName](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) ** The customer’s first name. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Required: No ** [Gender](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) ** *This parameter has been deprecated.* The gender with which the customer identifies. Type: String Valid Values: `MALE | FEMALE | UNSPECIFIED` Required: No ** [GenderString](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) ** An alternative to `Gender` which accepts any string as input. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Required: No ** [HomePhoneNumber](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) ** The customer’s home phone number. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Required: No ** [LastName](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) ** The customer’s last name. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Required: No ** [MailingAddress](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) ** The customer’s mailing address. Type: [UpdateAddress](API_connect-customer-profiles_UpdateAddress.md) object Required: No ** [MiddleName](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) ** The customer’s middle name. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Required: No ** [MobilePhoneNumber](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) ** The customer’s mobile phone number. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Required: No ** [PartyType](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) ** *This parameter has been deprecated.* The type of profile used to describe the customer. Type: String Valid Values: `INDIVIDUAL | BUSINESS | OTHER` Required: No ** [PartyTypeString](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) ** An alternative to `PartyType` which accepts any string as input. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Required: No ** [PersonalEmailAddress](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) ** The customer’s personal email address. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Required: No ** [PhoneNumber](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) ** The customer’s phone number, which has not been specified as a mobile, home, or business number. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Required: No ** [ProfileId](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) ** The unique identifier of a customer profile. Type: String Pattern: `[a-f0-9]{32}` Required: Yes ** [ProfileType](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) ** Determines the type of the profile. Type: String Valid Values: `ACCOUNT_PROFILE | PROFILE` Required: No ** [ShippingAddress](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) ** The customer’s shipping address. Type: [UpdateAddress](API_connect-customer-profiles_UpdateAddress.md) object Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "ProfileId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ProfileId](#API_connect-customer-profiles_UpdateProfile_ResponseSyntax) ** The unique identifier of a customer profile. Type: String Pattern: `[a-f0-9]{32}` ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## Examples ### Example This example illustrates one usage of UpdateProfile. #### Sample Request ``` PUT /domains/ExampleDomainName/profiles HTTP/1.1 Content-type: application/json { "ProfileId" : "3991a7d95sd248bba82546b2dEXAMPLE", "AccountNumber": "ACCT12344", "Address": { "Address1": "444 B St", "Address2": "Apt 8", "Address3": "", "Address4": "", "City": "Seattle", "Country": "USA", "County": "King", "PostalCode": "98011", "Province": "", "State": "WA" }, "Attributes": { "SSN" : "123-44-3433", "LoyaltyPoints" : "3000" }, "BillingAddress": { "Address1": "789 Sample St", "Address2": "Apt 1", "Address3": "", "Address4": "", "City": "Seattle", "Country": "USA", "County": "King", "PostalCode": "98011", "Province": "", "State": "WA" }, "BirthDate": "07/12/1980", "BusinessEmailAddress": "example@amazon.com", "BusinessName": "My Awesome Company", "BusinessPhoneNumber": "555-334-3389", "EmailAddress": "example@gmail.com", "FirstName": "John", "Gender": "MALE", "HomePhoneNumber": "555-334-3344", "LastName": "Doe", "MailingAddress": { "Address1": "234 Home St", "Address2": "Apt 5", "Address3": "", "Address4": "", "City": "Seattle", "Country": "USA", "County": "King", "PostalCode": "98011", "Province": "", "State": "WA" }, "AdditionalInformation": "High Profile Customer", "MiddleName": "", "MobilePhoneNumber": "555-334-7777", "PartyType": "INDIVIDUAL", "PersonalEmailAddress": "email1@gmail.com", "PhoneNumber": "", "ShippingAddress": { "Address1": "555 A St", "Address2": "Suite 100", "Address3": "", "Address4": "", "City": "Seattle", "Country": "USA", "County": "King", "PostalCode": "98011", "Province": "", "State": "WA" } } ``` #### Sample Response ``` Content-type: application/json { "ProfileId" : "3991a7d95sd248bba82546b2dEXAMPLE" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/UpdateProfile) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/UpdateProfile) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/UpdateProfile) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/UpdateProfile) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/UpdateProfile) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/UpdateProfile) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/UpdateProfile) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/UpdateProfile) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/UpdateProfile) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/UpdateProfile) # UpdateRecommender Updates the properties of an existing recommender, allowing you to modify its configuration and description. ## Request Syntax ``` PATCH /domains/DomainName/recommenders/RecommenderName HTTP/1.1 Content-type: application/json { "Description": "string", "RecommenderConfig": { "EventsConfig": { "EventParametersList": [ { "EventType": "string", "EventValueThreshold": number, "EventWeight": number } ] }, "IncludedColumns": { "string" : [ "string" ] }, "InferenceConfig": { "MinProvisionedTPS": number }, "TrainingFrequency": number } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_connect-customer-profiles_UpdateRecommender_RequestSyntax) ** The unique name of the domain. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [RecommenderName](#API_connect-customer-profiles_UpdateRecommender_RequestSyntax) ** The name of the recommender to update. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Description](#API_connect-customer-profiles_UpdateRecommender_RequestSyntax) ** The new description to assign to the recommender. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Required: No ** [RecommenderConfig](#API_connect-customer-profiles_UpdateRecommender_RequestSyntax) ** The new configuration settings to apply to the recommender, including updated parameters and settings that define its behavior. Type: [RecommenderConfig](API_connect-customer-profiles_RecommenderConfig.md) object Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "RecommenderName": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [RecommenderName](#API_connect-customer-profiles_UpdateRecommender_ResponseSyntax) ** The name of the recommender that was updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** BadRequestException ** The input you provided is invalid. HTTP Status Code: 400 ** InternalServerException ** An internal service error occurred. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource does not exist, or access was denied. HTTP Status Code: 404 ** ThrottlingException ** You exceeded the maximum number of requests. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/UpdateRecommender) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/UpdateRecommender) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/UpdateRecommender) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/UpdateRecommender) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/UpdateRecommender) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/UpdateRecommender) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/UpdateRecommender) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/UpdateRecommender) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/UpdateRecommender) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/UpdateRecommender)