openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 292 kB

JSON

{"openapi":"3.0.0","info":{"version":"2020-08-15","x-release":"v4","title":"Amazon Connect Customer Profiles","description":"<fullname>Amazon Connect Customer Profiles</fullname> Amazon Connect Customer Profiles is a unified customer profile for your contact center that has pre-built connectors powered by AppFlow that make it easy to combine customer information from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center. If you're new to Amazon Connect, you might find it helpful to review the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/\">Amazon Connect Administrator Guide</a>.","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"customer-profiles","x-aws-signingName":"profile","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/customer-profiles-2020-08-15.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/profile/"},"servers":[{"url":"http://profile.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Customer Profiles multi-region endpoint"},{"url":"https://profile.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Customer Profiles multi-region endpoint"},{"url":"http://profile.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Customer Profiles endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://profile.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Customer Profiles endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/domains/{DomainName}/profiles/keys":{"post":{"operationId":"AddProfileKey","description":"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.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddProfileKeyResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"DomainName","in":"path","required":true,"description":"The unique name of the domain.","schema":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","minLength":1,"maxLength":64}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProfileId","KeyName","Values"],"properties":{"ProfileId":{"description":"The unique identifier of a customer profile.","type":"string","pattern":"[a-f0-9]{32}"},"KeyName":{"description":"A searchable identifier of a customer profile. The predefined keys you can use include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.","type":"string","pattern":"^[a-zA-Z0-9_-]+$","minLength":1,"maxLength":64},"Values":{"description":"A list of key values.","type":"array","items":{"$ref":"#/components/schemas/string1To255"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/domains/{DomainName}/calculated-attributes/{CalculatedAttributeName}":{"post":{"operationId":"CreateCalculatedAttributeDefinition","description":"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 <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetCalculatedAttributeForProfile.html\">GetCalculatedAttributeForProfile</a> API. Defining a calculated attribute makes it available for all profiles within a domain. Each calculated attribute can only reference one <code>ObjectType</code> and at most, two fields from that <code>ObjectType</code>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCalculatedAttributeDefinitionResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"DomainName","in":"path","required":true,"description":"The unique name of the domain.","schema":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","minLength":1,"maxLength":64}},{"name":"CalculatedAttributeName","in":"path","required":true,"description":"The unique name of the calculated attribute.","schema":{"type":"string","pattern":"^[a-zA-Z_][a-zA-Z_0-9-]*$","minLength":1,"maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AttributeDetails","Statistic"],"properties":{"DisplayName":{"description":"The display name of the calculated attribute.","type":"string","pattern":"^[a-zA-Z_][a-zA-Z_0-9-\\s]*$","minLength":1,"maxLength":255},"Description":{"description":"The description of the calculated attribute.","type":"string","minLength":1,"maxLength":1000},"AttributeDetails":{"description":"Mathematical expression and a list of attribute items specified in that expression.","type":"object","properties":{"Attributes":{"allOf":[{"$ref":"#/components/schemas/AttributeList"},{"description":"A list of attribute items specified in the mathematical expression."}]},"Expression":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"Mathematical expression that is performed on attribute items provided in the attribute list. Each element in the expression should follow the structure of \\\"{ObjectTypeName.AttributeName}\\\"."}]}}},"Conditions":{"description":"The conditions including range, object count, and threshold for the calculated attribute.","type":"object","properties":{"Range":{"allOf":[{"$ref":"#/components/schemas/Range"},{"description":"The relative time period over which data is included in the aggregation."}]},"ObjectCount":{"allOf":[{"$ref":"#/components/schemas/ObjectCount"},{"description":"The number of profile objects used for the calculated attribute."}]},"Threshold":{"allOf":[{"$ref":"#/components/schemas/Threshold"},{"description":"The threshold for the calculated attribute."}]}}},"Statistic":{"description":"The aggregation operation to perform for the calculated attribute.","type":"string","enum":["FIRST_OCCURRENCE","LAST_OCCURRENCE","COUNT","SUM","MINIMUM","MAXIMUM","AVERAGE","MAX_OCCURRENCE"]},"Tags":{"description":"The tags used to organize, track, or control access for this resource.","type":"object","minProperties":1,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"delete":{"operationId":"DeleteCalculatedAttributeDefinition","description":"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.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCalculatedAttributeDefinitionResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"DomainName","in":"path","required":true,"description":"The unique name of the domain.","schema":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","minLength":1,"maxLength":64}},{"name":"CalculatedAttributeName","in":"path","required":true,"description":"The unique name of the calculated attribute.","schema":{"type":"string","pattern":"^[a-zA-Z_][a-zA-Z_0-9-]*$","minLength":1,"maxLength":255}}]},"get":{"operationId":"GetCalculatedAttributeDefinition","description":"Provides more information on a calculated attribute definition for Customer Profiles.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCalculatedAttributeDefinitionResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"DomainName","in":"path","required":true,"description":"The unique name of the domain.","schema":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","minLength":1,"maxLength":64}},{"name":"CalculatedAttributeName","in":"path","required":true,"description":"The unique name of the calculated attribute.","schema":{"type":"string","pattern":"^[a-zA-Z_][a-zA-Z_0-9-]*$","minLength":1,"maxLength":255}}]},"put":{"operationId":"UpdateCalculatedAttributeDefinition","description":"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.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCalculatedAttributeDefinitionResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"DomainName","in":"path","required":true,"description":"The unique name of the domain.","schema":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","minLength":1,"maxLength":64}},{"name":"CalculatedAttributeName","in":"path","required":true,"description":"The unique name of the calculated attribute.","schema":{"type":"string","pattern":"^[a-zA-Z_][a-zA-Z_0-9-]*$","minLength":1,"maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"DisplayName":{"description":"The display name of the calculated attribute.","type":"string","pattern":"^[a-zA-Z_][a-zA-Z_0-9-\\s]*$","minLength":1,"maxLength":255},"Description":{"description":"The description of the calculated attribute.","type":"string","minLength":1,"maxLength":1000},"Conditions":{"description":"The conditions including range, object count, and threshold for the calculated attribute.","type":"object","properties":{"Range":{"allOf":[{"$ref":"#/components/schemas/Range"},{"description":"The relative time period over which data is included in the aggregation."}]},"ObjectCount":{"allOf":[{"$ref":"#/components/schemas/ObjectCount"},{"description":"The number of profile objects used for the calculated attribute."}]},"Threshold":{"allOf":[{"$ref":"#/components/schemas/Threshold"},{"description":"The threshold for the calculated attribute."}]}}}}}}}}}},"/domains/{DomainName}":{"post":{"operationId":"CreateDomain","description":"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 <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html\">UpdateDomain</a> to enable <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">identity resolution</a>: set <code>Matching</code> to true. To prevent cross-service impersonation when you call this API, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html\">Cross-service confused deputy prevention</a> for sample policies that you should apply. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDomainResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"DomainName","in":"path","required":true,"description":"The unique name of the domain.","schema":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","minLength":1,"maxLength":64}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DefaultExpirationDays"],"properties":{"DefaultExpirationDays":{"description":"The default number of days until the data within the domain expires.","type":"integer","minimum":1,"maximum":1098},"DefaultEncryptionKey":{"description":"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","minLength":0,"maxLength":255},"DeadLetterQueueUrl":{"description":"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","minLength":0,"maxLength":255},"Matching":{"description":"The flag that enables the matching process of duplicate profiles.","type":"object","properties":{"Enabled":{"allOf":[{"$ref":"#/components/schemas/optionalBoolean"},{"description":"The flag that enables the matching process of duplicate profiles."}]},"JobSchedule":{"allOf":[{"$ref":"#/components/schemas/JobSchedule"},{"description":"The day and time when do you want to start the Identity Resolution Job every week."}]},"AutoMerging":{"allOf":[{"$ref":"#/components/schemas/AutoMerging"},{"description":"Configuration information about the auto-merging process."}]},"ExportingConfig":{"allOf":[{"$ref":"#/components/schemas/ExportingConfig"},{"description":"Configuration information for exporting Identity Resolution results, for example, to an S3 bucket."}]}}},"RuleBasedMatching":{"description":"The request to enable the rule-based matching.","type":"object","properties":{"Enabled":{"allOf":[{"$ref":"#/components/schemas/optionalBoolean"},{"description":"The flag that enables the rule-based matching process of duplicate profiles."}]},"MatchingRules":{"allOf":[{"$ref":"#/components/schemas/MatchingRules"},{"description":"Configures how the rule-based matching process should match profiles. You can have up to 15 <code>MatchingRule</code> in the <code>MatchingRules</code>."}]},"MaxAllowedRuleLevelForMerging":{"allOf":[{"$ref":"#/components/schemas/MaxAllowedRuleLevelForMerging"},{"description":" <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_MatchingRule.html\">MatchingRule</a> "}]},"MaxAllowedRuleLevelForMatching":{"allOf":[{"$ref":"#/components/schemas/MaxAllowedRuleLevelForMatching"},{"description":"Indicates the maximum allowed rule level."}]},"AttributeTypesSelector":{"allOf":[{"$ref":"#/components/schemas/AttributeTypesSelector"},{"description":"Configures information about the <code>AttributeTypesSelector</code> where the rule-based identity resolution uses to match profiles."}]},"ConflictResolution":{"$ref":"#/components/schemas/ConflictResolution"},"ExportingConfig":{"$ref":"#/components/schemas/ExportingConfig"}}},"Tags":{"description":"The tags used to organize, track, or control access for this resource.","type":"object","minProperties":1,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"delete":{"operationId":"DeleteDomain","description":"Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteDomainResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"DomainName","in":"path","required":true,"description":"The unique name of the domain.","schema":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","minLength":1,"maxLength":64}}]},"get":{"operationId":"GetDomain","description":"Returns information about a specific domain.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDomainResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"DomainName","in":"path","required":true,"description":"The unique name of the domain.","schema":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","minLength":1,"maxLength":64}}]},"put":{"operationId":"UpdateDomain","description":"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 <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html\">CreateDomain</a> to enable <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">identity resolution</a>: set <code>Matching</code> to true. To prevent cross-service impersonation when you call this API, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html\">Cross-service confused deputy prevention</a> for sample policies that you should apply. To add or remove tags on an existing Domain, see <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html\">TagResource</a>/<a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html\">UntagResource</a>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDomainResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"DomainName","in":"path","required":true,"description":"The unique name of the domain.","schema":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","minLength":1,"maxLength":64}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"DefaultExpirationDays":{"description":"The default number of days until the data within the domain expires.","type":"integer","minimum":1,"maximum":1098},"DefaultEncryptionKey":{"description":"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","minLength":0,"maxLength":255},"DeadLetterQueueUrl":{"description":"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","minLength":0,"maxLength":255},"Matching":{"description":"The flag that enables the matching process of duplicate profiles.","type":"object","properties":{"Enabled":{"allOf":[{"$ref":"#/components/schemas/optionalBoolean"},{"description":"The flag that enables the matching process of duplicate profiles."}]},"JobSchedule":{"allOf":[{"$ref":"#/components/schemas/JobSchedule"},{"description":"The day and time when do you want to start the Identity Resolution Job every week."}]},"AutoMerging":{"allOf":[{"$ref":"#/components/schemas/AutoMerging"},{"description":"Configuration information about the auto-merging process."}]},"ExportingConfig":{"allOf":[{"$ref":"#/components/schemas/ExportingConfig"},{"description":"Configuration information for exporting Identity Resolution results, for example, to an S3 bucket."}]}}},"RuleBasedMatching":{"description":"The request to enable the rule-based matching.","type":"object","properties":{"Enabled":{"allOf":[{"$ref":"#/components/schemas/optionalBoolean"},{"description":"The flag that enables the rule-based matching process of duplicate profiles."}]},"MatchingRules":{"allOf":[{"$ref":"#/components/schemas/MatchingRules"},{"description":"Configures how the rule-based matching process should match profiles. You can have up to 15 <code>MatchingRule</code> in the <code>MatchingRules</code>."}]},"MaxAllowedRuleLevelForMerging":{"allOf":[{"$ref":"#/components/schemas/MaxAllowedRuleLevelForMerging"},{"description":" <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_MatchingRule.html\">MatchingRule</a> "}]},"MaxAllowedRuleLevelForMatching":{"allOf":[{"$ref":"#/components/schemas/MaxAllowedRuleLevelForMatching"},{"description":"Indicates the maximum allowed rule level."}]},"AttributeTypesSelector":{"allOf":[{"$ref":"#/components/schemas/AttributeTypesSelector"},{"description":"Configures information about the <code>AttributeTypesSelector</code> where the rule-based identity resolution uses to match profiles."}]},"ConflictResolution":{"$ref":"#/components/schemas/ConflictResolution"},"ExportingConfig":{"$ref":"#/components/schemas/ExportingConfig"}}},"Tags":{"description":"The tags used to organize, track, or control access for this resource.","type":"object","minProperties":1,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}}},"/domains/{DomainName}/event-streams/{EventStreamName}":{"post":{"operationId":"CreateEventStream","description":"Creates an event stream, which is a subscription to real-time events, such as when profiles are created and updated through Amazon Connect Customer Profiles. Each event stream can be associated with only one Kinesis Data Stream destination in the same region and Amazon Web Services account as the customer profiles domain","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEventStreamResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"DomainName","in":"path","required":true,"description":"The unique name of the domain.","schema":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","minLength":1,"maxLength":64}},{"name":"EventStreamName","in":"path","required":true,"description":"The name of the event stream.","schema":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","minLength":1,"maxLength":64}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Uri"],"properties":{"Uri":{"description":"The StreamARN of the destination to deliver profile events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name","type":"string","minLength":1,"maxLength":255},"Tags":{"description":"The tags used to organize, track, or control access for this resource.","type":"object","minProperties":1,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"delete":{"operationId":"DeleteEventStream","description":"Disables and deletes the specified event stream.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteEventStreamResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"DomainName","in":"path","required":true,"description":"The unique name of the domain.","schema":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","minLength":1,"maxLength":64}},{"name":"EventStreamName","in":"path","required":true,"description":"The name of the event stream","schema":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","minLength":1,"maxLength":64}}]},"get":{"operationId":"GetEventStream","description":"Returns information about the specified event stream in a specific domain.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEventStreamResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"DomainName","in":"path","required":true,"description":"The unique name of the domain.","schema":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","minLength":1,"maxLength":64}},{"name":"EventStreamName","in":"path","required":true,"description":"The name of the event stream provided during create operations.","schema":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","minLength":1,"maxLength":64}}]}},"/domains/{DomainName}/workflows/integrations":{"post":{"operationId":"CreateIntegrationWorkflow","description":" 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. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIntegrationWorkflowResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"DomainName","in":"path","required":true,"description":"The unique name of the domain.","schema":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","minLength":1,"maxLength":64}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["WorkflowType","IntegrationConfig","ObjectTypeName","RoleArn"],"properties":{"WorkflowType":{"description":"The type of workflow. The only supported value is APPFLOW_INTEGRATION.","type":"string","enum":["APPFLOW_INTEGRATION"]},"IntegrationConfig":{"description":"Configuration data for integration workflow.","type":"object","properties":{"AppflowIntegration":{"allOf":[{"$ref":"#/components/schemas/AppflowIntegration"},{"description":"Configuration data for <code>APPFLOW_INTEGRATION</code> workflow type."}]}}},"ObjectTypeName":{"description":"The name of the profile object type.","type":"string","pattern":"^[a-zA-Z_][a-zA-Z_0-9-]*$","minLength":1,"maxLength":255},"RoleArn":{"description":"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","pattern":"arn:aws:iam:.*:[0-9]+:.*","maxLength":512},"Tags":{"description":"The tags used to organize, track, or control access for this resource.","type":"object","minProperties":1,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/domains/{DomainName}/profiles":{"post":{"operationId":"CreateProfile","description":"Creates a standard profile. A standard profile represents the following attributes for a customer profile in a domain.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProfileResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"DomainName","in":"path","required":true,"description":"The unique name of the domain.","schema":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","minLength":1,"maxLength":64}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"AccountNumber":{"description":"A unique account number that you have given to the customer.","type":"string","minLength":1,"maxLength":255},"AdditionalInformation":{"description":"Any additional information relevant to the customer’s profile.","type":"string","minLength":1,"maxLength":1000},"PartyType":{"description":"The type of profile used to describe the customer.","type":"string","deprecated":true,"enum":["INDIVIDUAL","BUSINESS","OTHER"]},"BusinessName":{"description":"The name of the customer’s business.","type":"string","minLength":1,"maxLength":255},"FirstName":{"description":"The customer’s first name.","type":"string","minLength":1,"maxLength":255},"MiddleName":{"description":"The customer’s middle name.","type":"string","minLength":1,"maxLength":255},"LastName":{"description":"The customer’s last name.","type":"string","minLength":1,"maxLength":255},"BirthDate":{"description":"The customer’s birth date. ","type":"string","minLength":1,"maxLength":255},"Gender":{"description":"The gender with which the customer identifies. ","type":"string","deprecated":true,"enum":["MALE","FEMALE","UNSPECIFIED"]},"PhoneNumber":{"description":"The customer’s phone number, which has not been specified as a mobile, home, or business number. ","type":"string","minLength":1,"maxLength":255},"MobilePhoneNumber":{"description":"The customer’s mobile phone number.","type":"string","minLength":1,"maxLength":255},"HomePhoneNumber":{"description":"The customer’s home phone number.","type":"string","minLength":1,"maxLength":255},"BusinessPhoneNumber":{"description":"The customer’s business phone number.","type":"string","minLength":1,"maxLength":255},"EmailAddress":{"description":"The customer’s email address, which has not been specified as a personal or business address. ","type":"string","minLength":1,"maxLength":255},"PersonalEmailAddress":{"description":"The customer’s personal email address.","type":"string","minLength":1,"maxLength":255},"BusinessEmailAddress":{"description":"The customer’s business email address.","type":"string","minLength":1,"maxLength":255},"Address":{"description":"A generic address associated with the customer that is not mailing, shipping, or billing.","type":"object","properties":{"Address1":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The first line of a customer address."}]},"Address2":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The second line of a customer address."}]},"Address3":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The third line of a customer address."}]},"Address4":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The fourth line of a customer address."}]},"City":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The city in which a customer lives."}]},"County":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The county in which a customer lives."}]},"State":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The state in which a customer lives."}]},"Province":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The province in which a customer lives."}]},"Country":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The country in which a customer lives."}]},"PostalCode":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The postal code of a customer address."}]}}},"ShippingAddress":{"description":"A generic address associated with the customer that is not mailing, shipping, or billing.","type":"object","properties":{"Address1":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The first line of a customer address."}]},"Address2":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The second line of a customer address."}]},"Address3":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The third line of a customer address."}]},"Address4":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The fourth line of a customer address."}]},"City":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The city in which a customer lives."}]},"County":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The county in which a customer lives."}]},"State":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The state in which a customer lives."}]},"Province":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The province in which a customer lives."}]},"Country":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The country in which a customer lives."}]},"PostalCode":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The postal code of a customer address."}]}}},"MailingAddress":{"description":"A generic address associated with the customer that is not mailing, shipping, or billing.","type":"object","properties":{"Address1":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The first line of a customer address."}]},"Address2":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The second line of a customer address."}]},"Address3":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The third line of a customer address."}]},"Address4":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The fourth line of a customer address."}]},"City":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The city in which a customer lives."}]},"County":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The county in which a customer lives."}]},"State":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The state in which a customer lives."}]},"Province":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The province in which a customer lives."}]},"Country":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The country in which a customer lives."}]},"PostalCode":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The postal code of a customer address."}]}}},"BillingAddress":{"description":"A generic address associated with the customer that is not mailing, shipping, or billing.","type":"object","properties":{"Address1":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The first line of a customer address."}]},"Address2":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The second line of a customer address."}]},"Address3":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The third line of a customer address."}]},"Address4":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The fourth line of a customer address."}]},"City":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The city in which a customer lives."}]},"County":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The county in which a customer lives."}]},"State":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The state in which a customer lives."}]},"Province":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The province in which a customer lives."}]},"Country":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The country in which a customer lives."}]},"PostalCode":{"allOf":[{"$ref":"#/components/schemas/string1To255"},{"description":"The postal code of a customer address."}]}}},"Attributes":{"description":"A key value pair of attributes of a customer profile.","type":"object","additionalProperties":{"$ref":"#/components/schemas/string1To255"}},"PartyTypeString":{"description":"An alternative to <code>PartyType</code> which accepts any string as input.","type":"string","minLength":1,"maxLength":255},"GenderString":{"description":"An alternative to <code>Gender</code> which accepts any string as input.","type":"string","minLength":1,"maxLength":255}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"put":{"operationId":"UpdateProfile","description":"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.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProfileResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"DomainName","in":"path","required":true,"description":"The unique name of the domain.","schema":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","minLength":1,"maxLength":64}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProfileId"],"properties":{"ProfileId":{"description":"The unique identifier of a customer profile.","type":"string","pattern":"[a-f0-9]{32}"},"AdditionalInformation":{"description":"Any additional information relevant to the customer’s profile.","type":"string","minLength":0,"maxLength":1000},"AccountNumb