ב הוא חיבור של הרב יהושע בועז שתוכנו מראי מקומות למקורותشسdggרות הל555ה התafhgfh

{ "version":"2.0", "metadata":{ "apiVersion":"2017-08-08", "endpointPrefix":"connect", "jsonVersion":"1.1", "protocol":"rest-json", "protocols":["rest-json"], "serviceAbbreviation":"Amazon Connect", "serviceFullName":"Amazon Connect Service", "serviceId":"Connect", "signatureVersion":"v4", "signingName":"connect", "uid":"connect-2017-08-08", "auth":["aws.auth#sigv4"] }, "operations":{ "ActivateEvaluationForm":{ "name":"ActivateEvaluationForm", "http":{ "method":"POST", "requestUri":"/evaluation-forms/{InstanceId}/{EvaluationFormId}/activate" }, "input":{"shape":"ActivateEvaluationFormRequest"}, "output":{"shape":"ActivateEvaluationFormResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"ResourceConflictException"} ], "documentation":"<p>Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form. </p>" }, "AssociateAnalyticsDataSet":{ "name":"AssociateAnalyticsDataSet", "http":{ "method":"PUT", "requestUri":"/analytics-data/instance/{InstanceId}/association" }, "input":{"shape":"AssociateAnalyticsDataSetRequest"}, "output":{"shape":"AssociateAnalyticsDataSetResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.</p>" }, "AssociateApprovedOrigin":{ "name":"AssociateApprovedOrigin", "http":{ "method":"PUT", "requestUri":"/instance/{InstanceId}/approved-origin" }, "input":{"shape":"AssociateApprovedOriginRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceConflictException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Associates an approved origin to an Amazon Connect instance.</p>" }, "AssociateBot":{ "name":"AssociateBot", "http":{ "method":"PUT", "requestUri":"/instance/{InstanceId}/bot" }, "input":{"shape":"AssociateBotRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceConflictException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.</p>" }, "AssociateDefaultVocabulary":{ "name":"AssociateDefaultVocabulary", "http":{ "method":"PUT", "requestUri":"/default-vocabulary/{InstanceId}/{LanguageCode}" }, "input":{"shape":"AssociateDefaultVocabularyRequest"}, "output":{"shape":"AssociateDefaultVocabularyResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"<p>Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.</p>" }, "AssociateFlow":{ "name":"AssociateFlow", "http":{ "method":"PUT", "requestUri":"/flow-associations/{InstanceId}" }, "input":{"shape":"AssociateFlowRequest"}, "output":{"shape":"AssociateFlowResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Associates a connect resource to a flow.</p>" }, "AssociateInstanceStorageConfig":{ "name":"AssociateInstanceStorageConfig", "http":{ "method":"PUT", "requestUri":"/instance/{InstanceId}/storage-config" }, "input":{"shape":"AssociateInstanceStorageConfigRequest"}, "output":{"shape":"AssociateInstanceStorageConfigResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceConflictException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts.</p> <p>This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.</p>" }, "AssociateLambdaFunction":{ "name":"AssociateLambdaFunction", "http":{ "method":"PUT", "requestUri":"/instance/{InstanceId}/lambda-function" }, "input":{"shape":"AssociateLambdaFunctionRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceConflictException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Allows the specified Amazon Connect instance to access the specified Lambda function.</p>" }, "AssociateLexBot":{ "name":"AssociateLexBot", "http":{ "method":"PUT", "requestUri":"/instance/{InstanceId}/lex-bot" }, "input":{"shape":"AssociateLexBotRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceConflictException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Allows the specified Amazon Connect instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots.</p>" }, "AssociatePhoneNumberContactFlow":{ "name":"AssociatePhoneNumberContactFlow", "http":{ "method":"PUT", "requestUri":"/phone-number/{PhoneNumberId}/contact-flow" }, "input":{"shape":"AssociatePhoneNumberContactFlowRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"AccessDeniedException"} ], "documentation":"<p>Associates a flow with a phone number claimed to your Amazon Connect instance.</p> <important> <p>If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the <code>PhoneNumberId</code> URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a <code>ResourceNotFoundException</code>.</p> </important>" }, "AssociateQueueQuickConnects":{ "name":"AssociateQueueQuickConnects", "http":{ "method":"POST", "requestUri":"/queues/{InstanceId}/{QueueId}/associate-quick-connects" }, "input":{"shape":"AssociateQueueQuickConnectsRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Associates a set of quick connects with a queue.</p>" }, "AssociateRoutingProfileQueues":{ "name":"AssociateRoutingProfileQueues", "http":{ "method":"POST", "requestUri":"/routing-profiles/{InstanceId}/{RoutingProfileId}/associate-queues" }, "input":{"shape":"AssociateRoutingProfileQueuesRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Associates a set of queues with a routing profile.</p>" }, "AssociateSecurityKey":{ "name":"AssociateSecurityKey", "http":{ "method":"PUT", "requestUri":"/instance/{InstanceId}/security-key" }, "input":{"shape":"AssociateSecurityKeyRequest"}, "output":{"shape":"AssociateSecurityKeyResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceConflictException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Associates a security key to the instance.</p>" }, "AssociateTrafficDistributionGroupUser":{ "name":"AssociateTrafficDistributionGroupUser", "http":{ "method":"PUT", "requestUri":"/traffic-distribution-group/{TrafficDistributionGroupId}/user" }, "input":{"shape":"AssociateTrafficDistributionGroupUserRequest"}, "output":{"shape":"AssociateTrafficDistributionGroupUserResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceConflictException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Associates an agent with a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.</p>", "idempotent":true }, "AssociateUserProficiencies":{ "name":"AssociateUserProficiencies", "http":{ "method":"POST", "requestUri":"/users/{InstanceId}/{UserId}/associate-proficiencies" }, "input":{"shape":"AssociateUserProficienciesRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Associates a set of proficiencies with a user.</p>" }, "BatchAssociateAnalyticsDataSet":{ "name":"BatchAssociateAnalyticsDataSet", "http":{ "method":"PUT", "requestUri":"/analytics-data/instance/{InstanceId}/associations" }, "input":{"shape":"BatchAssociateAnalyticsDataSetRequest"}, "output":{"shape":"BatchAssociateAnalyticsDataSetResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.</p>" }, "BatchDisassociateAnalyticsDataSet":{ "name":"BatchDisassociateAnalyticsDataSet", "http":{ "method":"POST", "requestUri":"/analytics-data/instance/{InstanceId}/associations" }, "input":{"shape":"BatchDisassociateAnalyticsDataSetRequest"}, "output":{"shape":"BatchDisassociateAnalyticsDataSetResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.</p>" }, "BatchGetAttachedFileMetadata":{ "name":"BatchGetAttachedFileMetadata", "http":{ "method":"POST", "requestUri":"/attached-files/{InstanceId}" }, "input":{"shape":"BatchGetAttachedFileMetadataRequest"}, "output":{"shape":"BatchGetAttachedFileMetadataResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"InternalServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.</p>" }, "BatchGetFlowAssociation":{ "name":"BatchGetFlowAssociation", "http":{ "method":"POST", "requestUri":"/flow-associations-batch/{InstanceId}" }, "input":{"shape":"BatchGetFlowAssociationRequest"}, "output":{"shape":"BatchGetFlowAssociationResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Retrieve the flow associations for the given resources.</p>" }, "BatchPutContact":{ "name":"BatchPutContact", "http":{ "method":"PUT", "requestUri":"/contact/batch/{InstanceId}" }, "input":{"shape":"BatchPutContactRequest"}, "output":{"shape":"BatchPutContactResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"IdempotencyException"} ], "documentation":"<note> <p>Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.</p> </note> <p>Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the <a href=\"https://docs.aws.amazon.com/connect-outbound/latest/APIReference/API_PutDialRequestBatch.html\">PutDialRequestBatch</a> API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact. </p>", "idempotent":true }, "ClaimPhoneNumber":{ "name":"ClaimPhoneNumber", "http":{ "method":"POST", "requestUri":"/phone-number/claim" }, "input":{"shape":"ClaimPhoneNumberRequest"}, "output":{"shape":"ClaimPhoneNumberResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"IdempotencyException"}, {"shape":"AccessDeniedException"} ], "documentation":"<p>Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.</p> <p>For more information about how to use this operation, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/claim-phone-number.html\">Claim a phone number in your country</a> and <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/claim-phone-numbers-traffic-distribution-groups.html\">Claim phone numbers to traffic distribution groups</a> in the <i>Amazon Connect Administrator Guide</i>. </p> <important> <p>You can call the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchAvailablePhoneNumbers.html\">SearchAvailablePhoneNumbers</a> API for available phone numbers that you can claim. Call the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html\">DescribePhoneNumber</a> API to verify the status of a previous <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html\">ClaimPhoneNumber</a> operation.</p> </important> <p>If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.</p> <p>By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired. </p> <p>For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.</p>" }, "CompleteAttachedFileUpload":{ "name":"CompleteAttachedFileUpload", "http":{ "method":"POST", "requestUri":"/attached-files/{InstanceId}/{FileId}" }, "input":{"shape":"CompleteAttachedFileUploadRequest"}, "output":{"shape":"CompleteAttachedFileUploadResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"InternalServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.</p>" }, "CreateAgentStatus":{ "name":"CreateAgentStatus", "http":{ "method":"PUT", "requestUri":"/agent-status/{InstanceId}" }, "input":{"shape":"CreateAgentStatusRequest"}, "output":{"shape":"CreateAgentStatusResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"DuplicateResourceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Creates an agent status for the specified Amazon Connect instance.</p>" }, "CreateContact":{ "name":"CreateContact", "http":{ "method":"PUT", "requestUri":"/contact/create-contact" }, "input":{"shape":"CreateContactRequest"}, "output":{"shape":"CreateContactResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"IdempotencyException"}, {"shape":"ConflictException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"<important> <p>Only the VOICE, EMAIL, and TASK channels are supported. </p> <ul> <li> <p>For VOICE: The supported initiation method is <code>TRANSFER</code>. The contacts created with this initiation method have a subtype <code>connect:ExternalAudio</code>. </p> </li> <li> <p>For EMAIL: The supported initiation methods are <code>OUTBOUND</code>, <code>AGENT_REPLY</code>, and <code>FLOW</code>. </p> </li> <li> <p>For TASK: The supported initiation method is <code>API</code>. Contacts created with this API have a sub-type of <code>connect:ExternalTask</code>.</p> </li> </ul> </important> <p>Creates a new VOICE, EMAIL, or TASK contact. </p> <p>After a contact is created, you can move it to the desired state by using the <code>InitiateAs</code> parameter. While you can use API to create task contacts that are in the <code>COMPLETED</code> state, you must contact Amazon Web Services Support before using it for bulk import use cases. Bulk import causes your requests to be throttled or fail if your CreateContact limits aren't high enough. </p>" }, "CreateContactFlow":{ "name":"CreateContactFlow", "http":{ "method":"PUT", "requestUri":"/contact-flows/{InstanceId}" }, "input":{"shape":"CreateContactFlowRequest"}, "output":{"shape":"CreateContactFlowResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidContactFlowException"}, {"shape":"InvalidParameterException"}, {"shape":"DuplicateResourceException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Creates a flow for the specified Amazon Connect instance.</p> <p>You can also create and update flows using the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html\">Amazon Connect Flow language</a>.</p>" }, "CreateContactFlowModule":{ "name":"CreateContactFlowModule", "http":{ "method":"PUT", "requestUri":"/contact-flow-modules/{InstanceId}" }, "input":{"shape":"CreateContactFlowModuleRequest"}, "output":{"shape":"CreateContactFlowModuleResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidContactFlowModuleException"}, {"shape":"InvalidParameterException"}, {"shape":"DuplicateResourceException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"IdempotencyException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Creates a flow module for the specified Amazon Connect instance. </p>" }, "CreateContactFlowVersion":{ "name":"CreateContactFlowVersion", "http":{ "method":"PUT", "requestUri":"/contact-flows/{InstanceId}/{ContactFlowId}/version" }, "input":{"shape":"CreateContactFlowVersionRequest"}, "output":{"shape":"CreateContactFlowVersionResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InternalServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidRequestException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Publishes a new version of the flow provided. Versions are immutable and monotonically increasing. If the <code>FlowContentSha256</code> provided is different from the <code>FlowContentSha256</code> of the <code>$LATEST</code> published flow content, then an error is returned. This API only supports creating versions for flows of type <code>Campaign</code>.</p>" }, "CreateEmailAddress":{ "name":"CreateEmailAddress", "http":{ "method":"PUT", "requestUri":"/email-addresses/{InstanceId}" }, "input":{"shape":"CreateEmailAddressRequest"}, "output":{"shape":"CreateEmailAddressResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InvalidRequestException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServiceException"}, {"shape":"IdempotencyException"}, {"shape":"DuplicateResourceException"}, {"shape":"ResourceConflictException"} ], "documentation":"<p>Create new email address in the specified Amazon Connect instance. For more information about email addresses, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/create-email-address1.html\">Create email addresses</a> in the Amazon Connect Administrator Guide.</p>" }, "CreateEvaluationForm":{ "name":"CreateEvaluationForm", "http":{ "method":"PUT", "requestUri":"/evaluation-forms/{InstanceId}" }, "input":{"shape":"CreateEvaluationFormRequest"}, "output":{"shape":"CreateEvaluationFormResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ResourceConflictException"} ], "documentation":"<p>Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.</p>", "idempotent":true }, "CreateHoursOfOperation":{ "name":"CreateHoursOfOperation", "http":{ "method":"PUT", "requestUri":"/hours-of-operations/{InstanceId}" }, "input":{"shape":"CreateHoursOfOperationRequest"}, "output":{"shape":"CreateHoursOfOperationResponse"}, "errors":[ {"shape":"DuplicateResourceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Creates hours of operation. </p>" }, "CreateHoursOfOperationOverride":{ "name":"CreateHoursOfOperationOverride", "http":{ "method":"PUT", "requestUri":"/hours-of-operations/{InstanceId}/{HoursOfOperationId}/overrides" }, "input":{"shape":"CreateHoursOfOperationOverrideRequest"}, "output":{"shape":"CreateHoursOfOperationOverrideResponse"}, "errors":[ {"shape":"DuplicateResourceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Creates an hours of operation override in an Amazon Connect hours of operation resource</p>" }, "CreateInstance":{ "name":"CreateInstance", "http":{ "method":"PUT", "requestUri":"/instance" }, "input":{"shape":"CreateInstanceRequest"}, "output":{"shape":"CreateInstanceResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-instances.html\">Create an Amazon Connect instance</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <p>Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.</p>" }, "CreateIntegrationAssociation":{ "name":"CreateIntegrationAssociation", "http":{ "method":"PUT", "requestUri":"/instance/{InstanceId}/integration-associations" }, "input":{"shape":"CreateIntegrationAssociationRequest"}, "output":{"shape":"CreateIntegrationAssociationResponse"}, "errors":[ {"shape":"DuplicateResourceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Creates an Amazon Web Services resource association with an Amazon Connect instance.</p>" }, "CreateParticipant":{ "name":"CreateParticipant", "http":{ "method":"POST", "requestUri":"/contact/create-participant" }, "input":{"shape":"CreateParticipantRequest"}, "output":{"shape":"CreateParticipantResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Adds a new participant into an on-going chat contact. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/chat-customize-flow.html\">Customize chat flow experiences by integrating custom participants</a>.</p>" }, "CreatePersistentContactAssociation":{ "name":"CreatePersistentContactAssociation", "http":{ "method":"POST", "requestUri":"/contact/persistent-contact-association/{InstanceId}/{InitialContactId}" }, "input":{"shape":"CreatePersistentContactAssociationRequest"}, "output":{"shape":"CreatePersistentContactAssociationResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html\">Enable persistent chat</a> in the <i>Amazon Connect Administrator Guide</i>. </p>" }, "CreatePredefinedAttribute":{ "name":"CreatePredefinedAttribute", "http":{ "method":"PUT", "requestUri":"/predefined-attributes/{InstanceId}" }, "input":{"shape":"CreatePredefinedAttributeRequest"}, "errors":[ {"shape":"DuplicateResourceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Creates a new predefined attribute for the specified Amazon Connect instance. <i>Predefined attributes</i> are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html\">Create predefined attributes for routing contacts to agents</a>.</p>" }, "CreatePrompt":{ "name":"CreatePrompt", "http":{ "method":"PUT", "requestUri":"/prompts/{InstanceId}" }, "input":{"shape":"CreatePromptRequest"}, "output":{"shape":"CreatePromptResponse"}, "errors":[ {"shape":"DuplicateResourceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"LimitExceededException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Creates a prompt. For more information about prompts, such as supported file types and maximum length, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/prompts.html\">Create prompts</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "CreatePushNotificationRegistration":{ "name":"CreatePushNotificationRegistration", "http":{ "method":"PUT", "requestUri":"/push-notification/{InstanceId}/registrations" }, "input":{"shape":"CreatePushNotificationRegistrationRequest"}, "output":{"shape":"CreatePushNotificationRegistrationResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"<p>Creates registration for a device token and a chat contact to receive real-time push notifications. For more information about push notifications, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/enable-push-notifications-for-mobile-chat.html\">Set up push notifications in Amazon Connect for mobile chat</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "CreateQueue":{ "name":"CreateQueue", "http":{ "method":"PUT", "requestUri":"/queues/{InstanceId}" }, "input":{"shape":"CreateQueueRequest"}, "output":{"shape":"CreateQueueResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"DuplicateResourceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Creates a new queue for the specified Amazon Connect instance.</p> <important> <ul> <li> <p>If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for <code>OutboundCallerIdNumberId</code>. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a <code>ResourceNotFoundException</code>.</p> </li> <li> <p>Only use the phone number ARN format that doesn't contain <code>instance</code> in the path, for example, <code>arn:aws:connect:us-east-1:1234567890:phone-number/uuid</code>. This is the same ARN format that is returned when you call the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html\">ListPhoneNumbersV2</a> API.</p> </li> <li> <p>If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_resource-level-policy-examples.html#allow-deny-queue-actions-replica-region\">Allow or Deny queue API actions for phone numbers in a replica Region</a>.</p> </li> </ul> </important>" }, "CreateQuickConnect":{ "name":"CreateQuickConnect", "http":{ "method":"PUT", "requestUri":"/quick-connects/{InstanceId}" }, "input":{"shape":"CreateQuickConnectRequest"}, "output":{"shape":"CreateQuickConnectResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"DuplicateResourceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Creates a quick connect for the specified Amazon Connect instance.</p>" }, "CreateRoutingProfile":{ "name":"CreateRoutingProfile", "http":{ "method":"PUT", "requestUri":"/routing-profiles/{InstanceId}" }, "input":{"shape":"CreateRoutingProfileRequest"}, "output":{"shape":"CreateRoutingProfileResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"DuplicateResourceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Creates a new routing profile.</p>" }, "CreateRule":{ "name":"CreateRule", "http":{ "method":"POST", "requestUri":"/rules/{InstanceId}" }, "input":{"shape":"CreateRuleRequest"}, "output":{"shape":"CreateRuleResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceConflictException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"<p>Creates a rule for the specified Amazon Connect instance.</p> <p>Use the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-language.html\">Rules Function language</a> to code conditions for the rule. </p>" }, "CreateSecurityProfile":{ "name":"CreateSecurityProfile", "http":{ "method":"PUT", "requestUri":"/security-profiles/{InstanceId}" }, "input":{"shape":"CreateSecurityProfileRequest"}, "output":{"shape":"CreateSecurityProfileResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"LimitExceededException"}, {"shape":"DuplicateResourceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Creates a security profile.</p> <p>For information about security profiles, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html\">Security Profiles</a> in the <i>Amazon Connect Administrator Guide</i>. For a mapping of the API name and user interface name of the security profile permissions, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html\">List of security profile permissions</a>. </p>" }, "CreateTaskTemplate":{ "name":"CreateTaskTemplate", "http":{ "method":"PUT", "requestUri":"/instance/{InstanceId}/task/template" }, "input":{"shape":"CreateTaskTemplateRequest"}, "output":{"shape":"CreateTaskTemplateResponse"}, "errors":[ {"shape":"PropertyValidationException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Creates a new task template in the specified Amazon Connect instance.</p>" }, "CreateTrafficDistributionGroup":{ "name":"CreateTrafficDistributionGroup", "http":{ "method":"PUT", "requestUri":"/traffic-distribution-group" }, "input":{"shape":"CreateTrafficDistributionGroupRequest"}, "output":{"shape":"CreateTrafficDistributionGroupResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"ResourceConflictException"}, {"shape":"ResourceNotReadyException"} ], "documentation":"<p>Creates a traffic distribution group given an Amazon Connect instance that has been replicated.</p> <note> <p>The <code>SignInConfig</code> distribution is available only on a default <code>TrafficDistributionGroup</code> (see the <code>IsDefault</code> parameter in the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html\">TrafficDistributionGroup</a> data type). If you call <code>UpdateTrafficDistribution</code> with a modified <code>SignInConfig</code> and a non-default <code>TrafficDistributionGroup</code>, an <code>InvalidRequestException</code> is returned.</p> </note> <p>For more information about creating traffic distribution groups, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/setup-traffic-distribution-groups.html\">Set up traffic distribution groups</a> in the <i>Amazon Connect Administrator Guide</i>. </p>" }, "CreateUseCase":{ "name":"CreateUseCase", "http":{ "method":"PUT", "requestUri":"/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases" }, "input":{"shape":"CreateUseCaseRequest"}, "output":{"shape":"CreateUseCaseResponse"}, "errors":[ {"shape":"DuplicateResourceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Creates a use case for an integration association.</p>" }, "CreateUser":{ "name":"CreateUser", "http":{ "method":"PUT", "requestUri":"/users/{InstanceId}" }, "input":{"shape":"CreateUserRequest"}, "output":{"shape":"CreateUserResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"LimitExceededException"}, {"shape":"DuplicateResourceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Creates a user account for the specified Amazon Connect instance.</p> <important> <p>Certain <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_UserIdentityInfo.html\">UserIdentityInfo</a> parameters are required in some situations. For example, <code>Email</code> is required if you are using SAML for identity management. <code>FirstName</code> and <code>LastName</code> are required if you are using Amazon Connect or SAML for identity management.</p> </important> <p>For information about how to create users using the Amazon Connect admin website, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html\">Add Users</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "CreateUserHierarchyGroup":{ "name":"CreateUserHierarchyGroup", "http":{ "method":"PUT", "requestUri":"/user-hierarchy-groups/{InstanceId}" }, "input":{"shape":"CreateUserHierarchyGroupRequest"}, "output":{"shape":"CreateUserHierarchyGroupResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"DuplicateResourceException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Creates a new user hierarchy group.</p>" }, "CreateView":{ "name":"CreateView", "http":{ "method":"PUT", "requestUri":"/views/{InstanceId}" }, "input":{"shape":"CreateViewRequest"}, "output":{"shape":"CreateViewResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"DuplicateResourceException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"TooManyRequestsException"}, {"shape":"ResourceInUseException"} ], "documentation":"<p>Creates a new view with the possible status of <code>SAVED</code> or <code>PUBLISHED</code>.</p> <p>The views will have a unique name for each connect instance.</p> <p>It performs basic content validation if the status is <code>SAVED</code> or full content validation if the status is set to <code>PUBLISHED</code>. An error is returned if validation fails. It associates either the <code>$SAVED</code> qualifier or both of the <code>$SAVED</code> and <code>$LATEST</code> qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided.</p>", "idempotent":true }, "CreateViewVersion":{ "name":"CreateViewVersion", "http":{ "method":"PUT", "requestUri":"/views/{InstanceId}/{ViewId}/versions" }, "input":{"shape":"CreateViewVersionRequest"}, "output":{"shape":"CreateViewVersionResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"TooManyRequestsException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ResourceInUseException"} ], "documentation":"<p>Publishes a new version of the view identifier.</p> <p>Versions are immutable and monotonically increasing.</p> <p>It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the <code>$LATEST</code> alias.</p>", "idempotent":true }, "CreateVocabulary":{ "name":"CreateVocabulary", "http":{ "method":"POST", "requestUri":"/vocabulary/{InstanceId}" }, "input":{"shape":"CreateVocabularyRequest"}, "output":{"shape":"CreateVocabularyResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceConflictException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"<p>Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.</p>" }, "DeactivateEvaluationForm":{ "name":"DeactivateEvaluationForm", "http":{ "method":"POST", "requestUri":"/evaluation-forms/{InstanceId}/{EvaluationFormId}/deactivate" }, "input":{"shape":"DeactivateEvaluationFormRequest"}, "output":{"shape":"DeactivateEvaluationFormResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"ResourceConflictException"} ], "documentation":"<p>Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form. </p>" }, "DeleteAttachedFile":{ "name":"DeleteAttachedFile", "http":{ "method":"DELETE", "requestUri":"/attached-files/{InstanceId}/{FileId}" }, "input":{"shape":"DeleteAttachedFileRequest"}, "output":{"shape":"DeleteAttachedFileResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"InternalServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Deletes an attached file along with the underlying S3 Object.</p> <important> <p>The attached file is <b>permanently deleted</b> if S3 bucket versioning is not enabled.</p> </important>" }, "DeleteContactEvaluation":{ "name":"DeleteContactEvaluation", "http":{ "method":"DELETE", "requestUri":"/contact-evaluations/{InstanceId}/{EvaluationId}" }, "input":{"shape":"DeleteContactEvaluationRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"ResourceConflictException"} ], "documentation":"<p>Deletes a contact evaluation in the specified Amazon Connect instance.</p>", "idempotent":true }, "DeleteContactFlow":{ "name":"DeleteContactFlow", "http":{ "method":"DELETE", "requestUri":"/contact-flows/{InstanceId}/{ContactFlowId}" }, "input":{"shape":"DeleteContactFlowRequest"}, "output":{"shape":"DeleteContactFlowResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Deletes a flow for the specified Amazon Connect instance.</p>" }, "DeleteContactFlowModule":{ "name":"DeleteContactFlowModule", "http":{ "method":"DELETE", "requestUri":"/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}" }, "input":{"shape":"DeleteContactFlowModuleRequest"}, "output":{"shape":"DeleteContactFlowModuleResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Deletes the specified flow module.</p>" }, "DeleteContactFlowVersion":{ "name":"DeleteContactFlowVersion", "http":{ "method":"DELETE", "requestUri":"/contact-flows/{InstanceId}/{ContactFlowId}/version/{ContactFlowVersion}" }, "input":{"shape":"DeleteContactFlowVersionRequest"}, "output":{"shape":"DeleteContactFlowVersionResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InternalServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidRequestException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Deletes the particular version specified in flow version identifier.</p>" }, "DeleteEmailAddress":{ "name":"DeleteEmailAddress", "http":{ "method":"DELETE", "requestUri":"/email-addresses/{InstanceId}/{EmailAddressId}" }, "input":{"shape":"DeleteEmailAddressRequest"}, "output":{"shape":"DeleteEmailAddressResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidRequestException"}, {"shape":"InternalServiceException"}, {"shape":"ResourceConflictException"} ], "documentation":"<p>Deletes email address from the specified Amazon Connect instance.</p>" }, "DeleteEvaluationForm":{ "name":"DeleteEvaluationForm", "http":{ "method":"DELETE", "requestUri":"/evaluation-forms/{InstanceId}/{EvaluationFormId}" }, "input":{"shape":"DeleteEvaluationFormRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"ResourceConflictException"} ], "documentation":"<p>Deletes an evaluation form in the specified Amazon Connect instance. </p> <ul> <li> <p>If the version property is provided, only the specified version of the evaluation form is deleted.</p> </li> <li> <p>If no version is provided, then the full form (all versions) is deleted.</p> </li> </ul>", "idempotent":true }, "DeleteHoursOfOperation":{ "name":"DeleteHoursOfOperation", "http":{ "method":"DELETE", "requestUri":"/hours-of-operations/{InstanceId}/{HoursOfOperationId}" }, "input":{"shape":"DeleteHoursOfOperationRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Deletes an hours of operation.</p>" }, "DeleteHoursOfOperationOverride":{ "name":"DeleteHoursOfOperationOverride", "http":{ "method":"DELETE", "requestUri":"/hours-of-operations/{InstanceId}/{HoursOfOperationId}/overrides/{HoursOfOperationOverrideId}" }, "input":{"shape":"DeleteHoursOfOperationOverrideRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Deletes an hours of operation override in an Amazon Connect hours of operation resource</p>" }, "DeleteInstance":{ "name":"DeleteInstance", "http":{ "method":"DELETE", "requestUri":"/instance/{InstanceId}" }, "input":{"shape":"DeleteInstanceRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Deletes the Amazon Connect instance. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/delete-connect-instance.html\">Delete your Amazon Connect instance</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <p>Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.</p>" }, "DeleteIntegrationAssociation":{ "name":"DeleteIntegrationAssociation", "http":{ "method":"DELETE", "requestUri":"/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}" }, "input":{"shape":"DeleteIntegrationAssociationRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.</p>" }, "DeletePredefinedAttribute":{ "name":"DeletePredefinedAttribute", "http":{ "method":"DELETE", "requestUri":"/predefined-attributes/{InstanceId}/{Name}" }, "input":{"shape":"DeletePredefinedAttributeRequest"}, "errors":[ {"shape":"ResourceInUseException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Deletes a predefined attribute from the specified Amazon Connect instance.</p>", "idempotent":true }, "DeletePrompt":{ "name":"DeletePrompt", "http":{ "method":"DELETE", "requestUri":"/prompts/{InstanceId}/{PromptId}" }, "input":{"shape":"DeletePromptRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Deletes a prompt.</p>" }, "DeletePushNotificationRegistration":{ "name":"DeletePushNotificationRegistration", "http":{ "method":"DELETE", "requestUri":"/push-notification/{InstanceId}/registrations/{RegistrationId}" }, "input":{"shape":"DeletePushNotificationRegistrationRequest"}, "output":{"shape":"DeletePushNotificationRegistrationResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"AccessDeniedException"} ], "documentation":"<p>Deletes registration for a device token and a chat contact.</p>" }, "DeleteQueue":{ "name":"DeleteQueue", "http":{ "method":"DELETE", "requestUri":"/queues/{InstanceId}/{QueueId}" }, "input":{"shape":"DeleteQueueRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Deletes a queue.</p>" }, "DeleteQuickConnect":{ "name":"DeleteQuickConnect", "http":{ "method":"DELETE", "requestUri":"/quick-connects/{InstanceId}/{QuickConnectId}" }, "input":{"shape":"DeleteQuickConnectRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Deletes a quick connect. </p> <important> <p>After calling <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteUser.html\">DeleteUser</a>, it's important to call <code>DeleteQuickConnect</code> to delete any records related to the deleted users. This will help you:</p> <ul> <li> <p>Avoid dangling resources that impact your service quotas.</p> </li> <li> <p>Remove deleted users so they don't appear to agents as transfer options.</p> </li> <li> <p>Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/setup-connect-global-resiliency.html\">Amazon Connect Global Resiliency</a>. </p> </li> </ul> </important>" }, "DeleteRoutingProfile":{ "name":"DeleteRoutingProfile", "http":{ "method":"DELETE", "requestUri":"/routing-profiles/{InstanceId}/{RoutingProfileId}" }, "input":{"shape":"DeleteRoutingProfileRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Deletes a routing profile.</p>" }, "DeleteRule":{ "name":"DeleteRule", "http":{ "method":"DELETE", "requestUri":"/rules/{InstanceId}/{RuleId}" }, "input":{"shape":"DeleteRuleRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"<p>Deletes a rule for the specified Amazon Connect instance.</p>" }, "DeleteSecurityProfile":{ "name":"DeleteSecurityProfile", "http":{ "method":"DELETE", "requestUri":"/security-profiles/{InstanceId}/{SecurityProfileId}" }, "input":{"shape":"DeleteSecurityProfileRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceInUseException"} ], "documentation":"<p>Deletes a security profile.</p>" }, "DeleteTaskTemplate":{ "name":"DeleteTaskTemplate", "http":{ "method":"DELETE", "requestUri":"/instance/{InstanceId}/task/template/{TaskTemplateId}" }, "input":{"shape":"DeleteTaskTemplateRequest"}, "output":{"shape":"DeleteTaskTemplateResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Deletes the task template.</p>" }, "DeleteTrafficDistributionGroup":{ "name":"DeleteTrafficDistributionGroup", "http":{ "method":"DELETE", "requestUri":"/traffic-distribution-group/{TrafficDistributionGroupId}" }, "input":{"shape":"DeleteTrafficDistributionGroupRequest"}, "output":{"shape":"DeleteTrafficDistributionGroupResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceInUseException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.</p> <p>For more information about deleting traffic distribution groups, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/delete-traffic-distribution-groups.html\">Delete traffic distribution groups</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "DeleteUseCase":{ "name":"DeleteUseCase", "http":{ "method":"DELETE", "requestUri":"/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases/{UseCaseId}" }, "input":{"shape":"DeleteUseCaseRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Deletes a use case from an integration association.</p>" }, "DeleteUser":{ "name":"DeleteUser", "http":{ "method":"DELETE", "requestUri":"/users/{InstanceId}/{UserId}" }, "input":{"shape":"DeleteUserRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Deletes a user account from the specified Amazon Connect instance.</p> <p>For information about what happens to a user's data when their account is deleted, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/delete-users.html\">Delete Users from Your Amazon Connect Instance</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <important> <p>After calling DeleteUser, call <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteQuickConnect.html\">DeleteQuickConnect</a> to delete any records related to the deleted users. This will help you:</p> <ul> <li> <p>Avoid dangling resources that impact your service quotas.</p> </li> <li> <p>Remove deleted users so they don't appear to agents as transfer options.</p> </li> <li> <p>Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/setup-connect-global-resiliency.html\">Amazon Connect Global Resiliency</a>. </p> </li> </ul> </important>" }, "DeleteUserHierarchyGroup":{ "name":"DeleteUserHierarchyGroup", "http":{ "method":"DELETE", "requestUri":"/user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}" }, "input":{"shape":"DeleteUserHierarchyGroupRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.</p>" }, "DeleteView":{ "name":"DeleteView", "http":{ "method":"DELETE", "requestUri":"/views/{InstanceId}/{ViewId}" }, "input":{"shape":"DeleteViewRequest"}, "output":{"shape":"DeleteViewResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"TooManyRequestsException"}, {"shape":"ResourceInUseException"} ], "documentation":"<p>Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).</p>" }, "DeleteViewVersion":{ "name":"DeleteViewVersion", "http":{ "method":"DELETE", "requestUri":"/views/{InstanceId}/{ViewId}/versions/{ViewVersion}" }, "input":{"shape":"DeleteViewVersionRequest"}, "output":{"shape":"DeleteViewVersionResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"TooManyRequestsException"}, {"shape":"ResourceInUseException"} ], "documentation":"<p>Deletes the particular version specified in <code>ViewVersion</code> identifier.</p>" }, "DeleteVocabulary":{ "name":"DeleteVocabulary", "http":{ "method":"POST", "requestUri":"/vocabulary-remove/{InstanceId}/{VocabularyId}" }, "input":{"shape":"DeleteVocabularyRequest"}, "output":{"shape":"DeleteVocabularyResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceInUseException"} ], "documentation":"<p>Deletes the vocabulary that has the given identifier.</p>" }, "DescribeAgentStatus":{ "name":"DescribeAgentStatus", "http":{ "method":"GET", "requestUri":"/agent-status/{InstanceId}/{AgentStatusId}" }, "input":{"shape":"DescribeAgentStatusRequest"}, "output":{"shape":"DescribeAgentStatusResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Describes an agent status.</p>" }, "DescribeAuthenticationProfile":{ "name":"DescribeAuthenticationProfile", "http":{ "method":"GET", "requestUri":"/authentication-profiles/{InstanceId}/{AuthenticationProfileId}" }, "input":{"shape":"DescribeAuthenticationProfileRequest"}, "output":{"shape":"DescribeAuthenticationProfileResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web ServicesSupport.</p> <p>Describes the target authentication profile.</p>" }, "DescribeContact":{ "name":"DescribeContact", "http":{ "method":"GET", "requestUri":"/contacts/{InstanceId}/{ContactId}" }, "input":{"shape":"DescribeContactRequest"}, "output":{"shape":"DescribeContactResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Describes the specified contact. </p> <important> <ul> <li> <p> <code>SystemEndpoint</code> is not populated for contacts with initiation method of MONITOR, QUEUE_TRANSFER, or CALLBACK</p> </li> <li> <p>Contact information remains available in Amazon Connect for 24 months from the <code>InitiationTimestamp</code>, and then it is deleted. Only contact information that is available in Amazon Connect is returned by this API.</p> </li> </ul> </important>" }, "DescribeContactEvaluation":{ "name":"DescribeContactEvaluation", "http":{ "method":"GET", "requestUri":"/contact-evaluations/{InstanceId}/{EvaluationId}" }, "input":{"shape":"DescribeContactEvaluationRequest"}, "output":{"shape":"DescribeContactEvaluationResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Describes a contact evaluation in the specified Amazon Connect instance.</p>" }, "DescribeContactFlow":{ "name":"DescribeContactFlow", "http":{ "method":"GET", "requestUri":"/contact-flows/{InstanceId}/{ContactFlowId}" }, "input":{"shape":"DescribeContactFlowRequest"}, "output":{"shape":"DescribeContactFlowResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ContactFlowNotPublishedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Describes the specified flow.</p> <p>You can also create and update flows using the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html\">Amazon Connect Flow language</a>.</p> <p>Use the <code>$SAVED</code> alias in the request to describe the <code>SAVED</code> content of a Flow. For example, <code>arn:aws:.../contact-flow/{id}:$SAVED</code>. After a flow is published, <code>$SAVED</code> needs to be supplied to view saved content that has not been published.</p> <p>Use <code>arn:aws:.../contact-flow/{id}:{version}</code> to retrieve the content of a specific flow version.</p> <p>In the response, <b>Status</b> indicates the flow status as either <code>SAVED</code> or <code>PUBLISHED</code>. The <code>PUBLISHED</code> status will initiate validation on the content. <code>SAVED</code> does not initiate validation of the content. <code>SAVED</code> | <code>PUBLISHED</code> </p>" }, "DescribeContactFlowModule":{ "name":"DescribeContactFlowModule", "http":{ "method":"GET", "requestUri":"/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}" }, "input":{"shape":"DescribeContactFlowModuleRequest"}, "output":{"shape":"DescribeContactFlowModuleResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Describes the specified flow module.</p> <p>Use the <code>$SAVED</code> alias in the request to describe the <code>SAVED</code> content of a Flow. For example, <code>arn:aws:.../contact-flow/{id}:$SAVED</code>. After a flow is published, <code>$SAVED</code> needs to be supplied to view saved content that has not been published.</p>" }, "DescribeEmailAddress":{ "name":"DescribeEmailAddress", "http":{ "method":"GET", "requestUri":"/email-addresses/{InstanceId}/{EmailAddressId}" }, "input":{"shape":"DescribeEmailAddressRequest"}, "output":{"shape":"DescribeEmailAddressResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidRequestException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Describe email address form the specified Amazon Connect instance.</p>" }, "DescribeEvaluationForm":{ "name":"DescribeEvaluationForm", "http":{ "method":"GET", "requestUri":"/evaluation-forms/{InstanceId}/{EvaluationFormId}" }, "input":{"shape":"DescribeEvaluationFormRequest"}, "output":{"shape":"DescribeEvaluationFormResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.</p>" }, "DescribeHoursOfOperation":{ "name":"DescribeHoursOfOperation", "http":{ "method":"GET", "requestUri":"/hours-of-operations/{InstanceId}/{HoursOfOperationId}" }, "input":{"shape":"DescribeHoursOfOperationRequest"}, "output":{"shape":"DescribeHoursOfOperationResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Describes the hours of operation.</p>" }, "DescribeHoursOfOperationOverride":{ "name":"DescribeHoursOfOperationOverride", "http":{ "method":"GET", "requestUri":"/hours-of-operations/{InstanceId}/{HoursOfOperationId}/overrides/{HoursOfOperationOverrideId}" }, "input":{"shape":"DescribeHoursOfOperationOverrideRequest"}, "output":{"shape":"DescribeHoursOfOperationOverrideResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Describes the hours of operation override.</p>" }, "DescribeInstance":{ "name":"DescribeInstance", "http":{ "method":"GET", "requestUri":"/instance/{InstanceId}" }, "input":{"shape":"DescribeInstanceRequest"}, "output":{"shape":"DescribeInstanceResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable. </p> <p>If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.</p>" }, "DescribeInstanceAttribute":{ "name":"DescribeInstanceAttribute", "http":{ "method":"GET", "requestUri":"/instance/{InstanceId}/attribute/{AttributeType}" }, "input":{"shape":"DescribeInstanceAttributeRequest"}, "output":{"shape":"DescribeInstanceAttributeResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Describes the specified instance attribute.</p>" }, "DescribeInstanceStorageConfig":{ "name":"DescribeInstanceStorageConfig", "http":{ "method":"GET", "requestUri":"/instance/{InstanceId}/storage-config/{AssociationId}" }, "input":{"shape":"DescribeInstanceStorageConfigRequest"}, "output":{"shape":"DescribeInstanceStorageConfigResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.</p>" }, "DescribePhoneNumber":{ "name":"DescribePhoneNumber", "http":{ "method":"GET", "requestUri":"/phone-number/{PhoneNumberId}" }, "input":{"shape":"DescribePhoneNumberRequest"}, "output":{"shape":"DescribePhoneNumberResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"AccessDeniedException"} ], "documentation":"<p>Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.</p> <important> <p>If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the <code>PhoneNumberId</code> URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you receive a <code>ResourceNotFoundException</code>.</p> </important>" }, "DescribePredefinedAttribute":{ "name":"DescribePredefinedAttribute", "http":{ "method":"GET", "requestUri":"/predefined-attributes/{InstanceId}/{Name}" }, "input":{"shape":"DescribePredefinedAttributeRequest"}, "output":{"shape":"DescribePredefinedAttributeResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Describes a predefined attribute for the specified Amazon Connect instance. <i>Predefined attributes</i> are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html\">Create predefined attributes for routing contacts to agents</a>.</p>" }, "DescribePrompt":{ "name":"DescribePrompt", "http":{ "method":"GET", "requestUri":"/prompts/{InstanceId}/{PromptId}" }, "input":{"shape":"DescribePromptRequest"}, "output":{"shape":"DescribePromptResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Describes the prompt.</p>" }, "DescribeQueue":{ "name":"DescribeQueue", "http":{ "method":"GET", "requestUri":"/queues/{InstanceId}/{QueueId}" }, "input":{"shape":"DescribeQueueRequest"}, "output":{"shape":"DescribeQueueResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Describes the specified queue.</p>" }, "DescribeQuickConnect":{ "name":"DescribeQuickConnect", "http":{ "method":"GET", "requestUri":"/quick-connects/{InstanceId}/{QuickConnectId}" }, "input":{"shape":"DescribeQuickConnectRequest"}, "output":{"shape":"DescribeQuickConnectResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Describes the quick connect.</p>" }, "DescribeRoutingProfile":{ "name":"DescribeRoutingProfile", "http":{ "method":"GET", "requestUri":"/routing-profiles/{InstanceId}/{RoutingProfileId}" }, "input":{"shape":"DescribeRoutingProfileRequest"}, "output":{"shape":"DescribeRoutingProfileResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Describes the specified routing profile.</p> <note> <p> <code>DescribeRoutingProfile</code> does not populate AssociatedQueueIds in its response. The example Response Syntax shown on this page is incorrect; we are working to update it. <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchRoutingProfiles.html\">SearchRoutingProfiles</a> does include AssociatedQueueIds.</p> </note>" }, "DescribeRule":{ "name":"DescribeRule", "http":{ "method":"GET", "requestUri":"/rules/{InstanceId}/{RuleId}" }, "input":{"shape":"DescribeRuleRequest"}, "output":{"shape":"DescribeRuleResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"<p>Describes a rule for the specified Amazon Connect instance.</p>" }, "DescribeSecurityProfile":{ "name":"DescribeSecurityProfile", "http":{ "method":"GET", "requestUri":"/security-profiles/{InstanceId}/{SecurityProfileId}" }, "input":{"shape":"DescribeSecurityProfileRequest"}, "output":{"shape":"DescribeSecurityProfileResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Gets basic information about the security profile.</p> <p>For information about security profiles, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html\">Security Profiles</a> in the <i>Amazon Connect Administrator Guide</i>. For a mapping of the API name and user interface name of the security profile permissions, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html\">List of security profile permissions</a>. </p>" }, "DescribeTrafficDistributionGroup":{ "name":"DescribeTrafficDistributionGroup", "http":{ "method":"GET", "requestUri":"/traffic-distribution-group/{TrafficDistributionGroupId}" }, "input":{"shape":"DescribeTrafficDistributionGroupRequest"}, "output":{"shape":"DescribeTrafficDistributionGroupResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Gets details and status of a traffic distribution group.</p>" }, "DescribeUser":{ "name":"DescribeUser", "http":{ "method":"GET", "requestUri":"/users/{InstanceId}/{UserId}" }, "input":{"shape":"DescribeUserRequest"}, "output":{"shape":"DescribeUserResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Describes the specified user. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID in the Amazon Connect console</a> (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.</p>" }, "DescribeUserHierarchyGroup":{ "name":"DescribeUserHierarchyGroup", "http":{ "method":"GET", "requestUri":"/user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}" }, "input":{"shape":"DescribeUserHierarchyGroupRequest"}, "output":{"shape":"DescribeUserHierarchyGroupResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Describes the specified hierarchy group.</p>" }, "DescribeUserHierarchyStructure":{ "name":"DescribeUserHierarchyStructure", "http":{ "method":"GET", "requestUri":"/user-hierarchy-structure/{InstanceId}" }, "input":{"shape":"DescribeUserHierarchyStructureRequest"}, "output":{"shape":"DescribeUserHierarchyStructureResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Describes the hierarchy structure of the specified Amazon Connect instance.</p>" }, "DescribeView":{ "name":"DescribeView", "http":{ "method":"GET", "requestUri":"/views/{InstanceId}/{ViewId}" }, "input":{"shape":"DescribeViewRequest"}, "output":{"shape":"DescribeViewResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"<p>Retrieves the view for the specified Amazon Connect instance and view identifier.</p> <p>The view identifier can be supplied as a ViewId or ARN.</p> <p> <code>$SAVED</code> needs to be supplied if a view is unpublished.</p> <p>The view identifier can contain an optional qualifier, for example, <code>&lt;view-id&gt;:$SAVED</code>, which is either an actual version number or an Amazon Connect managed qualifier <code>$SAVED | $LATEST</code>. If it is not supplied, then <code>$LATEST</code> is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views.</p>" }, "DescribeVocabulary":{ "name":"DescribeVocabulary", "http":{ "method":"GET", "requestUri":"/vocabulary/{InstanceId}/{VocabularyId}" }, "input":{"shape":"DescribeVocabularyRequest"}, "output":{"shape":"DescribeVocabularyResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"<p>Describes the specified vocabulary.</p>" }, "DisassociateAnalyticsDataSet":{ "name":"DisassociateAnalyticsDataSet", "http":{ "method":"POST", "requestUri":"/analytics-data/instance/{InstanceId}/association" }, "input":{"shape":"DisassociateAnalyticsDataSetRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Removes the dataset ID associated with a given Amazon Connect instance.</p>" }, "DisassociateApprovedOrigin":{ "name":"DisassociateApprovedOrigin", "http":{ "method":"DELETE", "requestUri":"/instance/{InstanceId}/approved-origin" }, "input":{"shape":"DisassociateApprovedOriginRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Revokes access to integrated applications from Amazon Connect.</p>" }, "DisassociateBot":{ "name":"DisassociateBot", "http":{ "method":"POST", "requestUri":"/instance/{InstanceId}/bot" }, "input":{"shape":"DisassociateBotRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot. </p>" }, "DisassociateFlow":{ "name":"DisassociateFlow", "http":{ "method":"DELETE", "requestUri":"/flow-associations/{InstanceId}/{ResourceId}/{ResourceType}" }, "input":{"shape":"DisassociateFlowRequest"}, "output":{"shape":"DisassociateFlowResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Disassociates a connect resource from a flow.</p>" }, "DisassociateInstanceStorageConfig":{ "name":"DisassociateInstanceStorageConfig", "http":{ "method":"DELETE", "requestUri":"/instance/{InstanceId}/storage-config/{AssociationId}" }, "input":{"shape":"DisassociateInstanceStorageConfigRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Removes the storage type configurations for the specified resource type and association ID.</p>" }, "DisassociateLambdaFunction":{ "name":"DisassociateLambdaFunction", "http":{ "method":"DELETE", "requestUri":"/instance/{InstanceId}/lambda-function" }, "input":{"shape":"DisassociateLambdaFunctionRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Remove the Lambda function from the dropdown options available in the relevant flow blocks.</p>" }, "DisassociateLexBot":{ "name":"DisassociateLexBot", "http":{ "method":"DELETE", "requestUri":"/instance/{InstanceId}/lex-bot" }, "input":{"shape":"DisassociateLexBotRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Revokes authorization from the specified instance to access the specified Amazon Lex bot.</p>" }, "DisassociatePhoneNumberContactFlow":{ "name":"DisassociatePhoneNumberContactFlow", "http":{ "method":"DELETE", "requestUri":"/phone-number/{PhoneNumberId}/contact-flow" }, "input":{"shape":"DisassociatePhoneNumberContactFlowRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"AccessDeniedException"} ], "documentation":"<p>Removes the flow association from a phone number claimed to your Amazon Connect instance.</p> <important> <p>If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the <code>PhoneNumberId</code> URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a <code>ResourceNotFoundException</code>.</p> </important>" }, "DisassociateQueueQuickConnects":{ "name":"DisassociateQueueQuickConnects", "http":{ "method":"POST", "requestUri":"/queues/{InstanceId}/{QueueId}/disassociate-quick-connects" }, "input":{"shape":"DisassociateQueueQuickConnectsRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Disassociates a set of quick connects from a queue.</p>" }, "DisassociateRoutingProfileQueues":{ "name":"DisassociateRoutingProfileQueues", "http":{ "method":"POST", "requestUri":"/routing-profiles/{InstanceId}/{RoutingProfileId}/disassociate-queues" }, "input":{"shape":"DisassociateRoutingProfileQueuesRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Disassociates a set of queues from a routing profile.</p>" }, "DisassociateSecurityKey":{ "name":"DisassociateSecurityKey", "http":{ "method":"DELETE", "requestUri":"/instance/{InstanceId}/security-key/{AssociationId}" }, "input":{"shape":"DisassociateSecurityKeyRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Deletes the specified security key.</p>" }, "DisassociateTrafficDistributionGroupUser":{ "name":"DisassociateTrafficDistributionGroupUser", "http":{ "method":"DELETE", "requestUri":"/traffic-distribution-group/{TrafficDistributionGroupId}/user" }, "input":{"shape":"DisassociateTrafficDistributionGroupUserRequest"}, "output":{"shape":"DisassociateTrafficDistributionGroupUserResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceConflictException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Disassociates an agent from a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.</p>", "idempotent":true }, "DisassociateUserProficiencies":{ "name":"DisassociateUserProficiencies", "http":{ "method":"POST", "requestUri":"/users/{InstanceId}/{UserId}/disassociate-proficiencies" }, "input":{"shape":"DisassociateUserProficienciesRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Disassociates a set of proficiencies from a user.</p>" }, "DismissUserContact":{ "name":"DismissUserContact", "http":{ "method":"POST", "requestUri":"/users/{InstanceId}/{UserId}/contact" }, "input":{"shape":"DismissUserContactRequest"}, "output":{"shape":"DismissUserContactResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a <code>MISSED</code>, <code>ERROR</code>, <code>ENDED</code>, or <code>REJECTED</code> state in the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html\">Agent Event Stream</a>.</p>" }, "GetAttachedFile":{ "name":"GetAttachedFile", "http":{ "method":"GET", "requestUri":"/attached-files/{InstanceId}/{FileId}" }, "input":{"shape":"GetAttachedFileRequest"}, "output":{"shape":"GetAttachedFileResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"InternalServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is <code>APPROVED</code>.</p>" }, "GetContactAttributes":{ "name":"GetContactAttributes", "http":{ "method":"GET", "requestUri":"/contact/attributes/{InstanceId}/{InitialContactId}" }, "input":{"shape":"GetContactAttributesRequest"}, "output":{"shape":"GetContactAttributesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Retrieves the contact attributes for the specified contact.</p>" }, "GetCurrentMetricData":{ "name":"GetCurrentMetricData", "http":{ "method":"POST", "requestUri":"/metrics/current/{InstanceId}" }, "input":{"shape":"GetCurrentMetricDataRequest"}, "output":{"shape":"GetCurrentMetricDataResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"<p>Gets the real-time metric data from the specified Amazon Connect instance.</p> <p>For a description of each metric, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html\">Metrics definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "GetCurrentUserData":{ "name":"GetCurrentUserData", "http":{ "method":"POST", "requestUri":"/metrics/userdata/{InstanceId}" }, "input":{"shape":"GetCurrentUserDataRequest"}, "output":{"shape":"GetCurrentUserDataResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"<p>Gets the real-time active user data from the specified Amazon Connect instance. </p>" }, "GetEffectiveHoursOfOperations":{ "name":"GetEffectiveHoursOfOperations", "http":{ "method":"GET", "requestUri":"/effective-hours-of-operations/{InstanceId}/{HoursOfOperationId}" }, "input":{"shape":"GetEffectiveHoursOfOperationsRequest"}, "output":{"shape":"GetEffectiveHoursOfOperationsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Get the hours of operations with the effective override applied.</p>" }, "GetFederationToken":{ "name":"GetFederationToken", "http":{ "method":"GET", "requestUri":"/user/federate/{InstanceId}" }, "input":{"shape":"GetFederationTokenRequest"}, "output":{"shape":"GetFederationTokenResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"UserNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"DuplicateResourceException"} ], "documentation":"<p>Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action. </p> <p>For more information about how SAML sign-in works in Amazon Connect, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/configure-saml.html \">Configure SAML with IAM for Amazon Connect in the <i>Amazon Connect Administrator Guide</i>.</a> </p> <note> <p>This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears: </p> <p> <code>Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect</code> </p> </note>" }, "GetFlowAssociation":{ "name":"GetFlowAssociation", "http":{ "method":"GET", "requestUri":"/flow-associations/{InstanceId}/{ResourceId}/{ResourceType}" }, "input":{"shape":"GetFlowAssociationRequest"}, "output":{"shape":"GetFlowAssociationResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Retrieves the flow associated for a given resource.</p>" }, "GetMetricData":{ "name":"GetMetricData", "http":{ "method":"POST", "requestUri":"/metrics/historical/{InstanceId}" }, "input":{"shape":"GetMetricDataRequest"}, "output":{"shape":"GetMetricDataResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"<p>Gets historical metric data from the specified Amazon Connect instance.</p> <p>For a description of each historical metric, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html\">Metrics definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <note> <p>We recommend using the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html\">GetMetricDataV2</a> API. It provides more flexibility, features, and the ability to query longer time ranges than <code>GetMetricData</code>. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.</p> </note>" }, "GetMetricDataV2":{ "name":"GetMetricDataV2", "http":{ "method":"POST", "requestUri":"/metrics/data" }, "input":{"shape":"GetMetricDataV2Request"}, "output":{"shape":"GetMetricDataV2Response"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"<p>Gets metric data from the specified Amazon Connect instance. </p> <p> <code>GetMetricDataV2</code> offers more features than <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricData.html\">GetMetricData</a>, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. It does not support agent queues.</p> <p>For a description of the historical metrics that are supported by <code>GetMetricDataV2</code> and <code>GetMetricData</code>, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html\">Metrics definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "GetPromptFile":{ "name":"GetPromptFile", "http":{ "method":"GET", "requestUri":"/prompts/{InstanceId}/{PromptId}/file" }, "input":{"shape":"GetPromptFileRequest"}, "output":{"shape":"GetPromptFileResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Gets the prompt file.</p>" }, "GetTaskTemplate":{ "name":"GetTaskTemplate", "http":{ "method":"GET", "requestUri":"/instance/{InstanceId}/task/template/{TaskTemplateId}" }, "input":{"shape":"GetTaskTemplateRequest"}, "output":{"shape":"GetTaskTemplateResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Gets details about a specific task template in the specified Amazon Connect instance.</p>" }, "GetTrafficDistribution":{ "name":"GetTrafficDistribution", "http":{ "method":"GET", "requestUri":"/traffic-distribution/{Id}" }, "input":{"shape":"GetTrafficDistributionRequest"}, "output":{"shape":"GetTrafficDistributionResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Retrieves the current traffic distribution for a given traffic distribution group.</p>" }, "ImportPhoneNumber":{ "name":"ImportPhoneNumber", "http":{ "method":"POST", "requestUri":"/phone-number/import" }, "input":{"shape":"ImportPhoneNumberRequest"}, "output":{"shape":"ImportPhoneNumberResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"IdempotencyException"}, {"shape":"AccessDeniedException"} ], "documentation":"<p>Imports a claimed phone number from an external service, such as Amazon Web Services End User Messaging, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.</p> <important> <p>Call the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html\">DescribePhoneNumber</a> API to verify the status of a previous <code>ImportPhoneNumber</code> operation. </p> </important> <p>If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. </p> <p> By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired. </p> <p>For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web ServicesSupport ticket. </p>" }, "ListAgentStatuses":{ "name":"ListAgentStatuses", "http":{ "method":"GET", "requestUri":"/agent-status/{InstanceId}" }, "input":{"shape":"ListAgentStatusRequest"}, "output":{"shape":"ListAgentStatusResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Lists agent statuses.</p>" }, "ListAnalyticsDataAssociations":{ "name":"ListAnalyticsDataAssociations", "http":{ "method":"GET", "requestUri":"/analytics-data/instance/{InstanceId}/association" }, "input":{"shape":"ListAnalyticsDataAssociationsRequest"}, "output":{"shape":"ListAnalyticsDataAssociationsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Lists the association status of requested dataset ID for a given Amazon Connect instance.</p>" }, "ListAnalyticsDataLakeDataSets":{ "name":"ListAnalyticsDataLakeDataSets", "http":{ "method":"GET", "requestUri":"/analytics-data/instance/{InstanceId}/datasets" }, "input":{"shape":"ListAnalyticsDataLakeDataSetsRequest"}, "output":{"shape":"ListAnalyticsDataLakeDataSetsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Lists the data lake datasets available to associate with for a given Amazon Connect instance.</p>" }, "ListApprovedOrigins":{ "name":"ListApprovedOrigins", "http":{ "method":"GET", "requestUri":"/instance/{InstanceId}/approved-origins" }, "input":{"shape":"ListApprovedOriginsRequest"}, "output":{"shape":"ListApprovedOriginsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Returns a paginated list of all approved origins associated with the instance.</p>" }, "ListAssociatedContacts":{ "name":"ListAssociatedContacts", "http":{ "method":"GET", "requestUri":"/contact/associated/{InstanceId}" }, "input":{"shape":"ListAssociatedContactsRequest"}, "output":{"shape":"ListAssociatedContactsResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Provides information about contact tree, a list of associated contacts with a unique identifier.</p>" }, "ListAuthenticationProfiles":{ "name":"ListAuthenticationProfiles", "http":{ "method":"GET", "requestUri":"/authentication-profiles-summary/{InstanceId}" }, "input":{"shape":"ListAuthenticationProfilesRequest"}, "output":{"shape":"ListAuthenticationProfilesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web ServicesSupport.</p> <p>Provides summary information about the authentication profiles in a specified Amazon Connect instance.</p>" }, "ListBots":{ "name":"ListBots", "http":{ "method":"GET", "requestUri":"/instance/{InstanceId}/bots" }, "input":{"shape":"ListBotsRequest"}, "output":{"shape":"ListBotsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to return both Amazon Lex V1 and V2 bots.</p>" }, "ListContactEvaluations":{ "name":"ListContactEvaluations", "http":{ "method":"GET", "requestUri":"/contact-evaluations/{InstanceId}" }, "input":{"shape":"ListContactEvaluationsRequest"}, "output":{"shape":"ListContactEvaluationsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Lists contact evaluations in the specified Amazon Connect instance.</p>" }, "ListContactFlowModules":{ "name":"ListContactFlowModules", "http":{ "method":"GET", "requestUri":"/contact-flow-modules-summary/{InstanceId}" }, "input":{"shape":"ListContactFlowModulesRequest"}, "output":{"shape":"ListContactFlowModulesResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Provides information about the flow modules for the specified Amazon Connect instance.</p>" }, "ListContactFlowVersions":{ "name":"ListContactFlowVersions", "http":{ "method":"GET", "requestUri":"/contact-flows/{InstanceId}/{ContactFlowId}/versions" }, "input":{"shape":"ListContactFlowVersionsRequest"}, "output":{"shape":"ListContactFlowVersionsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InternalServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidRequestException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Returns all the available versions for the specified Amazon Connect instance and flow identifier.</p>" }, "ListContactFlows":{ "name":"ListContactFlows", "http":{ "method":"GET", "requestUri":"/contact-flows-summary/{InstanceId}" }, "input":{"shape":"ListContactFlowsRequest"}, "output":{"shape":"ListContactFlowsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Provides information about the flows for the specified Amazon Connect instance.</p> <p>You can also create and update flows using the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html\">Amazon Connect Flow language</a>.</p> <p>For more information about flows, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html\">Flows</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "ListContactReferences":{ "name":"ListContactReferences", "http":{ "method":"GET", "requestUri":"/contact/references/{InstanceId}/{ContactId}" }, "input":{"shape":"ListContactReferencesRequest"}, "output":{"shape":"ListContactReferencesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>For the specified <code>referenceTypes</code>, returns a list of references associated with the contact. <i>References</i> are links to documents that are related to a contact, such as emails, attachments, or URLs.</p>" }, "ListDefaultVocabularies":{ "name":"ListDefaultVocabularies", "http":{ "method":"POST", "requestUri":"/default-vocabulary-summary/{InstanceId}" }, "input":{"shape":"ListDefaultVocabulariesRequest"}, "output":{"shape":"ListDefaultVocabulariesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"<p>Lists the default vocabularies for the specified Amazon Connect instance.</p>" }, "ListEvaluationFormVersions":{ "name":"ListEvaluationFormVersions", "http":{ "method":"GET", "requestUri":"/evaluation-forms/{InstanceId}/{EvaluationFormId}/versions" }, "input":{"shape":"ListEvaluationFormVersionsRequest"}, "output":{"shape":"ListEvaluationFormVersionsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Lists versions of an evaluation form in the specified Amazon Connect instance.</p>" }, "ListEvaluationForms":{ "name":"ListEvaluationForms", "http":{ "method":"GET", "requestUri":"/evaluation-forms/{InstanceId}" }, "input":{"shape":"ListEvaluationFormsRequest"}, "output":{"shape":"ListEvaluationFormsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Lists evaluation forms in the specified Amazon Connect instance.</p>" }, "ListFlowAssociations":{ "name":"ListFlowAssociations", "http":{ "method":"GET", "requestUri":"/flow-associations-summary/{InstanceId}" }, "input":{"shape":"ListFlowAssociationsRequest"}, "output":{"shape":"ListFlowAssociationsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>List the flow association based on the filters.</p>" }, "ListHoursOfOperationOverrides":{ "name":"ListHoursOfOperationOverrides", "http":{ "method":"GET", "requestUri":"/hours-of-operations/{InstanceId}/{HoursOfOperationId}/overrides" }, "input":{"shape":"ListHoursOfOperationOverridesRequest"}, "output":{"shape":"ListHoursOfOperationOverridesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>List the hours of operation overrides.</p>" }, "ListHoursOfOperations":{ "name":"ListHoursOfOperations", "http":{ "method":"GET", "requestUri":"/hours-of-operations-summary/{InstanceId}" }, "input":{"shape":"ListHoursOfOperationsRequest"}, "output":{"shape":"ListHoursOfOperationsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Provides information about the hours of operation for the specified Amazon Connect instance.</p> <p>For more information about hours of operation, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/set-hours-operation.html\">Set the Hours of Operation for a Queue</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "ListInstanceAttributes":{ "name":"ListInstanceAttributes", "http":{ "method":"GET", "requestUri":"/instance/{InstanceId}/attributes" }, "input":{"shape":"ListInstanceAttributesRequest"}, "output":{"shape":"ListInstanceAttributesResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Returns a paginated list of all attribute types for the given instance.</p>" }, "ListInstanceStorageConfigs":{ "name":"ListInstanceStorageConfigs", "http":{ "method":"GET", "requestUri":"/instance/{InstanceId}/storage-configs" }, "input":{"shape":"ListInstanceStorageConfigsRequest"}, "output":{"shape":"ListInstanceStorageConfigsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Returns a paginated list of storage configs for the identified instance and resource type.</p>" }, "ListInstances":{ "name":"ListInstances", "http":{ "method":"GET", "requestUri":"/instance" }, "input":{"shape":"ListInstancesRequest"}, "output":{"shape":"ListInstancesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.</p>" }, "ListIntegrationAssociations":{ "name":"ListIntegrationAssociations", "http":{ "method":"GET", "requestUri":"/instance/{InstanceId}/integration-associations" }, "input":{"shape":"ListIntegrationAssociationsRequest"}, "output":{"shape":"ListIntegrationAssociationsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.</p>" }, "ListLambdaFunctions":{ "name":"ListLambdaFunctions", "http":{ "method":"GET", "requestUri":"/instance/{InstanceId}/lambda-functions" }, "input":{"shape":"ListLambdaFunctionsRequest"}, "output":{"shape":"ListLambdaFunctionsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks.</p>" }, "ListLexBots":{ "name":"ListLexBots", "http":{ "method":"GET", "requestUri":"/instance/{InstanceId}/lex-bots" }, "input":{"shape":"ListLexBotsRequest"}, "output":{"shape":"ListLexBotsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_ListBots.html\">ListBots</a> API. </p>" }, "ListPhoneNumbers":{ "name":"ListPhoneNumbers", "http":{ "method":"GET", "requestUri":"/phone-numbers-summary/{InstanceId}" }, "input":{"shape":"ListPhoneNumbersRequest"}, "output":{"shape":"ListPhoneNumbersResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Provides information about the phone numbers for the specified Amazon Connect instance. </p> <p>For more information about phone numbers, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html\">Set Up Phone Numbers for Your Contact Center</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <important> <ul> <li> <p>We recommend using <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html\">ListPhoneNumbersV2</a> to return phone number types. ListPhoneNumbers doesn't support number types <code>UIFN</code>, <code>SHARED</code>, <code>THIRD_PARTY_TF</code>, and <code>THIRD_PARTY_DID</code>. While it returns numbers of those types, it incorrectly lists them as <code>TOLL_FREE</code> or <code>DID</code>. </p> </li> <li> <p>The phone number <code>Arn</code> value that is returned from each of the items in the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbers.html#connect-ListPhoneNumbers-response-PhoneNumberSummaryList\">PhoneNumberSummaryList</a> cannot be used to tag phone number resources. It will fail with a <code>ResourceNotFoundException</code>. Instead, use the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html\">ListPhoneNumbersV2</a> API. It returns the new phone number ARN that can be used to tag phone number resources.</p> </li> </ul> </important>" }, "ListPhoneNumbersV2":{ "name":"ListPhoneNumbersV2", "http":{ "method":"POST", "requestUri":"/phone-number/list" }, "input":{"shape":"ListPhoneNumbersV2Request"}, "output":{"shape":"ListPhoneNumbersV2Response"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"AccessDeniedException"} ], "documentation":"<p>Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided <code>TargetArn</code> is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group.</p> <p>For more information about phone numbers, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html\">Set Up Phone Numbers for Your Contact Center</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <note> <ul> <li> <p>When given an instance ARN, <code>ListPhoneNumbersV2</code> returns only the phone numbers claimed to the instance.</p> </li> <li> <p>When given a traffic distribution group ARN <code>ListPhoneNumbersV2</code> returns only the phone numbers claimed to the traffic distribution group.</p> </li> </ul> </note>" }, "ListPredefinedAttributes":{ "name":"ListPredefinedAttributes", "http":{ "method":"GET", "requestUri":"/predefined-attributes/{InstanceId}" }, "input":{"shape":"ListPredefinedAttributesRequest"}, "output":{"shape":"ListPredefinedAttributesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Lists predefined attributes for the specified Amazon Connect instance. <i>Predefined attributes</i> are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html\">Create predefined attributes for routing contacts to agents</a>.</p>" }, "ListPrompts":{ "name":"ListPrompts", "http":{ "method":"GET", "requestUri":"/prompts-summary/{InstanceId}" }, "input":{"shape":"ListPromptsRequest"}, "output":{"shape":"ListPromptsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Provides information about the prompts for the specified Amazon Connect instance.</p>" }, "ListQueueQuickConnects":{ "name":"ListQueueQuickConnects", "http":{ "method":"GET", "requestUri":"/queues/{InstanceId}/{QueueId}/quick-connects" }, "input":{"shape":"ListQueueQuickConnectsRequest"}, "output":{"shape":"ListQueueQuickConnectsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Lists the quick connects associated with a queue.</p>" }, "ListQueues":{ "name":"ListQueues", "http":{ "method":"GET", "requestUri":"/queues-summary/{InstanceId}" }, "input":{"shape":"ListQueuesRequest"}, "output":{"shape":"ListQueuesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Provides information about the queues for the specified Amazon Connect instance.</p> <p>If you do not specify a <code>QueueTypes</code> parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code.</p> <p>For more information about queues, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/concepts-queues-standard-and-agent.html\">Queues: Standard and Agent</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "ListQuickConnects":{ "name":"ListQuickConnects", "http":{ "method":"GET", "requestUri":"/quick-connects/{InstanceId}" }, "input":{"shape":"ListQuickConnectsRequest"}, "output":{"shape":"ListQuickConnectsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Provides information about the quick connects for the specified Amazon Connect instance. </p>" }, "ListRealtimeContactAnalysisSegmentsV2":{ "name":"ListRealtimeContactAnalysisSegmentsV2", "http":{ "method":"POST", "requestUri":"/contact/list-real-time-analysis-segments-v2/{InstanceId}/{ContactId}" }, "input":{"shape":"ListRealtimeContactAnalysisSegmentsV2Request"}, "output":{"shape":"ListRealtimeContactAnalysisSegmentsV2Response"}, "errors":[ {"shape":"OutputTypeNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidRequestException"}, {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Provides a list of analysis segments for a real-time chat analysis session. This API supports CHAT channels only. </p> <important> <p>This API does not support VOICE. If you attempt to use it for VOICE, an <code>InvalidRequestException</code> occurs.</p> </important>" }, "ListRoutingProfileQueues":{ "name":"ListRoutingProfileQueues", "http":{ "method":"GET", "requestUri":"/routing-profiles/{InstanceId}/{RoutingProfileId}/queues" }, "input":{"shape":"ListRoutingProfileQueuesRequest"}, "output":{"shape":"ListRoutingProfileQueuesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Lists the queues associated with a routing profile.</p>" }, "ListRoutingProfiles":{ "name":"ListRoutingProfiles", "http":{ "method":"GET", "requestUri":"/routing-profiles-summary/{InstanceId}" }, "input":{"shape":"ListRoutingProfilesRequest"}, "output":{"shape":"ListRoutingProfilesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Provides summary information about the routing profiles for the specified Amazon Connect instance.</p> <p>For more information about routing profiles, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing.html\">Routing Profiles</a> and <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/routing-profiles.html\">Create a Routing Profile</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "ListRules":{ "name":"ListRules", "http":{ "method":"GET", "requestUri":"/rules/{InstanceId}" }, "input":{"shape":"ListRulesRequest"}, "output":{"shape":"ListRulesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"<p>List all rules for the specified Amazon Connect instance.</p>" }, "ListSecurityKeys":{ "name":"ListSecurityKeys", "http":{ "method":"GET", "requestUri":"/instance/{InstanceId}/security-keys" }, "input":{"shape":"ListSecurityKeysRequest"}, "output":{"shape":"ListSecurityKeysResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Returns a paginated list of all security keys associated with the instance.</p>" }, "ListSecurityProfileApplications":{ "name":"ListSecurityProfileApplications", "http":{ "method":"GET", "requestUri":"/security-profiles-applications/{InstanceId}/{SecurityProfileId}" }, "input":{"shape":"ListSecurityProfileApplicationsRequest"}, "output":{"shape":"ListSecurityProfileApplicationsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Returns a list of third-party applications in a specific security profile.</p>" }, "ListSecurityProfilePermissions":{ "name":"ListSecurityProfilePermissions", "http":{ "method":"GET", "requestUri":"/security-profiles-permissions/{InstanceId}/{SecurityProfileId}" }, "input":{"shape":"ListSecurityProfilePermissionsRequest"}, "output":{"shape":"ListSecurityProfilePermissionsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Lists the permissions granted to a security profile.</p> <p>For information about security profiles, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html\">Security Profiles</a> in the <i>Amazon Connect Administrator Guide</i>. For a mapping of the API name and user interface name of the security profile permissions, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html\">List of security profile permissions</a>. </p>" }, "ListSecurityProfiles":{ "name":"ListSecurityProfiles", "http":{ "method":"GET", "requestUri":"/security-profiles-summary/{InstanceId}" }, "input":{"shape":"ListSecurityProfilesRequest"}, "output":{"shape":"ListSecurityProfilesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Provides summary information about the security profiles for the specified Amazon Connect instance.</p> <p>For more information about security profiles, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html\">Security Profiles</a> in the <i>Amazon Connect Administrator Guide</i>. For a mapping of the API name and user interface name of the security profile permissions, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html\">List of security profile permissions</a>. </p>" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{resourceArn}" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"InternalServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Lists the tags for the specified resource.</p> <p>For sample policies that use tags, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html\">Amazon Connect Identity-Based Policy Examples</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "ListTaskTemplates":{ "name":"ListTaskTemplates", "http":{ "method":"GET", "requestUri":"/instance/{InstanceId}/task/template" }, "input":{"shape":"ListTaskTemplatesRequest"}, "output":{"shape":"ListTaskTemplatesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Lists task templates for the specified Amazon Connect instance.</p>" }, "ListTrafficDistributionGroupUsers":{ "name":"ListTrafficDistributionGroupUsers", "http":{ "method":"GET", "requestUri":"/traffic-distribution-group/{TrafficDistributionGroupId}/user" }, "input":{"shape":"ListTrafficDistributionGroupUsersRequest"}, "output":{"shape":"ListTrafficDistributionGroupUsersResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidRequestException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Lists traffic distribution group users.</p>" }, "ListTrafficDistributionGroups":{ "name":"ListTrafficDistributionGroups", "http":{ "method":"GET", "requestUri":"/traffic-distribution-groups" }, "input":{"shape":"ListTrafficDistributionGroupsRequest"}, "output":{"shape":"ListTrafficDistributionGroupsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Lists traffic distribution groups.</p>" }, "ListUseCases":{ "name":"ListUseCases", "http":{ "method":"GET", "requestUri":"/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases" }, "input":{"shape":"ListUseCasesRequest"}, "output":{"shape":"ListUseCasesResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Lists the use cases for the integration association. </p>" }, "ListUserHierarchyGroups":{ "name":"ListUserHierarchyGroups", "http":{ "method":"GET", "requestUri":"/user-hierarchy-groups-summary/{InstanceId}" }, "input":{"shape":"ListUserHierarchyGroupsRequest"}, "output":{"shape":"ListUserHierarchyGroupsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Provides summary information about the hierarchy groups for the specified Amazon Connect instance.</p> <p>For more information about agent hierarchies, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html\">Set Up Agent Hierarchies</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "ListUserProficiencies":{ "name":"ListUserProficiencies", "http":{ "method":"GET", "requestUri":"/users/{InstanceId}/{UserId}/proficiencies" }, "input":{"shape":"ListUserProficienciesRequest"}, "output":{"shape":"ListUserProficienciesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Lists proficiencies associated with a user.</p>" }, "ListUsers":{ "name":"ListUsers", "http":{ "method":"GET", "requestUri":"/users-summary/{InstanceId}" }, "input":{"shape":"ListUsersRequest"}, "output":{"shape":"ListUsersResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Provides summary information about the users for the specified Amazon Connect instance.</p>" }, "ListViewVersions":{ "name":"ListViewVersions", "http":{ "method":"GET", "requestUri":"/views/{InstanceId}/{ViewId}/versions" }, "input":{"shape":"ListViewVersionsRequest"}, "output":{"shape":"ListViewVersionsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"<p>Returns all the available versions for the specified Amazon Connect instance and view identifier.</p> <p>Results will be sorted from highest to lowest.</p>" }, "ListViews":{ "name":"ListViews", "http":{ "method":"GET", "requestUri":"/views/{InstanceId}" }, "input":{"shape":"ListViewsRequest"}, "output":{"shape":"ListViewsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"<p>Returns views in the given instance.</p> <p>Results are sorted primarily by type, and secondarily by name.</p>" }, "MonitorContact":{ "name":"MonitorContact", "http":{ "method":"POST", "requestUri":"/contact/monitor" }, "input":{"shape":"MonitorContactRequest"}, "output":{"shape":"MonitorContactResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"IdempotencyException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by <i>userId</i> will be set to silent monitoring mode on the contact.</p>" }, "PauseContact":{ "name":"PauseContact", "http":{ "method":"POST", "requestUri":"/contact/pause" }, "input":{"shape":"PauseContactRequest"}, "output":{"shape":"PauseContactResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"LimitExceededException"}, {"shape":"ConflictException"} ], "documentation":"<p>Allows pausing an ongoing task contact.</p>" }, "PutUserStatus":{ "name":"PutUserStatus", "http":{ "method":"PUT", "requestUri":"/users/{InstanceId}/{UserId}/status" }, "input":{"shape":"PutUserStatusRequest"}, "output":{"shape":"PutUserStatusResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent's next status.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-agent-status.html\">Agent status</a> and <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/set-next-status.html\">Set your next status</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "ReleasePhoneNumber":{ "name":"ReleasePhoneNumber", "http":{ "method":"DELETE", "requestUri":"/phone-number/{PhoneNumberId}" }, "input":{"shape":"ReleasePhoneNumberRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"ResourceInUseException"}, {"shape":"IdempotencyException"}, {"shape":"AccessDeniedException"} ], "documentation":"<p>Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.</p> <important> <p>To release phone numbers from a traffic distribution group, use the <code>ReleasePhoneNumber</code> API, not the Amazon Connect admin website.</p> <p>After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web ServicesSupport.</p> </important> <p>If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.</p> <p>By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired. </p> <p>For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.</p>" }, "ReplicateInstance":{ "name":"ReplicateInstance", "http":{ "method":"POST", "requestUri":"/instance/{InstanceId}/replicate" }, "input":{"shape":"ReplicateInstanceRequest"}, "output":{"shape":"ReplicateInstanceResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"ResourceNotReadyException"}, {"shape":"ResourceConflictException"} ], "documentation":"<p>Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions. </p> <p>For more information about replicating an Amazon Connect instance, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/create-replica-connect-instance.html\">Create a replica of your existing Amazon Connect instance</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "ResumeContact":{ "name":"ResumeContact", "http":{ "method":"POST", "requestUri":"/contact/resume" }, "input":{"shape":"ResumeContactRequest"}, "output":{"shape":"ResumeContactResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictException"} ], "documentation":"<p>Allows resuming a task contact in a paused state.</p>" }, "ResumeContactRecording":{ "name":"ResumeContactRecording", "http":{ "method":"POST", "requestUri":"/contact/resume-recording" }, "input":{"shape":"ResumeContactRecordingRequest"}, "output":{"shape":"ResumeContactRecordingResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume.</p> <p>Voice and screen recordings are supported.</p>" }, "SearchAgentStatuses":{ "name":"SearchAgentStatuses", "http":{ "method":"POST", "requestUri":"/search-agent-statuses" }, "input":{"shape":"SearchAgentStatusesRequest"}, "output":{"shape":"SearchAgentStatusesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Searches AgentStatuses in an Amazon Connect instance, with optional filtering.</p>" }, "SearchAvailablePhoneNumbers":{ "name":"SearchAvailablePhoneNumbers", "http":{ "method":"POST", "requestUri":"/phone-number/search-available" }, "input":{"shape":"SearchAvailablePhoneNumbersRequest"}, "output":{"shape":"SearchAvailablePhoneNumbersResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"AccessDeniedException"} ], "documentation":"<p>Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided <code>TargetArn</code> is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group.</p>" }, "SearchContactFlowModules":{ "name":"SearchContactFlowModules", "http":{ "method":"POST", "requestUri":"/search-contact-flow-modules" }, "input":{"shape":"SearchContactFlowModulesRequest"}, "output":{"shape":"SearchContactFlowModulesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Searches the flow modules in an Amazon Connect instance, with optional filtering.</p>" }, "SearchContactFlows":{ "name":"SearchContactFlows", "http":{ "method":"POST", "requestUri":"/search-contact-flows" }, "input":{"shape":"SearchContactFlowsRequest"}, "output":{"shape":"SearchContactFlowsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Searches the flows in an Amazon Connect instance, with optional filtering.</p>" }, "SearchContacts":{ "name":"SearchContacts", "http":{ "method":"POST", "requestUri":"/search-contacts" }, "input":{"shape":"SearchContactsRequest"}, "output":{"shape":"SearchContactsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Searches contacts in an Amazon Connect instance.</p>" }, "SearchEmailAddresses":{ "name":"SearchEmailAddresses", "http":{ "method":"POST", "requestUri":"/search-email-addresses" }, "input":{"shape":"SearchEmailAddressesRequest"}, "output":{"shape":"SearchEmailAddressesResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidRequestException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Searches email address in an instance, with optional filtering.</p>" }, "SearchHoursOfOperationOverrides":{ "name":"SearchHoursOfOperationOverrides", "http":{ "method":"POST", "requestUri":"/search-hours-of-operation-overrides" }, "input":{"shape":"SearchHoursOfOperationOverridesRequest"}, "output":{"shape":"SearchHoursOfOperationOverridesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Searches the hours of operation overrides.</p>" }, "SearchHoursOfOperations":{ "name":"SearchHoursOfOperations", "http":{ "method":"POST", "requestUri":"/search-hours-of-operations" }, "input":{"shape":"SearchHoursOfOperationsRequest"}, "output":{"shape":"SearchHoursOfOperationsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Searches the hours of operation in an Amazon Connect instance, with optional filtering.</p>" }, "SearchPredefinedAttributes":{ "name":"SearchPredefinedAttributes", "http":{ "method":"POST", "requestUri":"/search-predefined-attributes" }, "input":{"shape":"SearchPredefinedAttributesRequest"}, "output":{"shape":"SearchPredefinedAttributesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Searches predefined attributes that meet certain criteria. <i>Predefined attributes</i> are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html\">Create predefined attributes for routing contacts to agents</a>.</p>" }, "SearchPrompts":{ "name":"SearchPrompts", "http":{ "method":"POST", "requestUri":"/search-prompts" }, "input":{"shape":"SearchPromptsRequest"}, "output":{"shape":"SearchPromptsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Searches prompts in an Amazon Connect instance, with optional filtering.</p>" }, "SearchQueues":{ "name":"SearchQueues", "http":{ "method":"POST", "requestUri":"/search-queues" }, "input":{"shape":"SearchQueuesRequest"}, "output":{"shape":"SearchQueuesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Searches queues in an Amazon Connect instance, with optional filtering.</p>" }, "SearchQuickConnects":{ "name":"SearchQuickConnects", "http":{ "method":"POST", "requestUri":"/search-quick-connects" }, "input":{"shape":"SearchQuickConnectsRequest"}, "output":{"shape":"SearchQuickConnectsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Searches quick connects in an Amazon Connect instance, with optional filtering.</p>" }, "SearchResourceTags":{ "name":"SearchResourceTags", "http":{ "method":"POST", "requestUri":"/search-resource-tags" }, "input":{"shape":"SearchResourceTagsRequest"}, "output":{"shape":"SearchResourceTagsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"MaximumResultReturnedException"} ], "documentation":"<p>Searches tags used in an Amazon Connect instance using optional search criteria.</p>" }, "SearchRoutingProfiles":{ "name":"SearchRoutingProfiles", "http":{ "method":"POST", "requestUri":"/search-routing-profiles" }, "input":{"shape":"SearchRoutingProfilesRequest"}, "output":{"shape":"SearchRoutingProfilesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Searches routing profiles in an Amazon Connect instance, with optional filtering.</p> <note> <p> <code>SearchRoutingProfiles</code> does not populate LastModifiedRegion, LastModifiedTime, MediaConcurrencies.CrossChannelBehavior, and AgentAvailabilityTimer in its response, but <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html\">DescribeRoutingProfile</a> does.</p> </note>" }, "SearchSecurityProfiles":{ "name":"SearchSecurityProfiles", "http":{ "method":"POST", "requestUri":"/search-security-profiles" }, "input":{"shape":"SearchSecurityProfilesRequest"}, "output":{"shape":"SearchSecurityProfilesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Searches security profiles in an Amazon Connect instance, with optional filtering.</p> <p>For information about security profiles, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html\">Security Profiles</a> in the <i>Amazon Connect Administrator Guide</i>. For a mapping of the API name and user interface name of the security profile permissions, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html\">List of security profile permissions</a>. </p>" }, "SearchUserHierarchyGroups":{ "name":"SearchUserHierarchyGroups", "http":{ "method":"POST", "requestUri":"/search-user-hierarchy-groups" }, "input":{"shape":"SearchUserHierarchyGroupsRequest"}, "output":{"shape":"SearchUserHierarchyGroupsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering.</p> <important> <p>The UserHierarchyGroup with <code>\"LevelId\": \"0\"</code> is the foundation for building levels on top of an instance. It is not user-definable, nor is it visible in the UI.</p> </important>" }, "SearchUsers":{ "name":"SearchUsers", "http":{ "method":"POST", "requestUri":"/search-users" }, "input":{"shape":"SearchUsersRequest"}, "output":{"shape":"SearchUsersResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Searches users in an Amazon Connect instance, with optional filtering. </p> <note> <p> <code>AfterContactWorkTimeLimit</code> is returned in milliseconds. </p> </note>" }, "SearchVocabularies":{ "name":"SearchVocabularies", "http":{ "method":"POST", "requestUri":"/vocabulary-summary/{InstanceId}" }, "input":{"shape":"SearchVocabulariesRequest"}, "output":{"shape":"SearchVocabulariesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"<p>Searches for vocabularies within a specific Amazon Connect instance using <code>State</code>, <code>NameStartsWith</code>, and <code>LanguageCode</code>.</p>" }, "SendChatIntegrationEvent":{ "name":"SendChatIntegrationEvent", "http":{ "method":"POST", "requestUri":"/chat-integration-event" }, "input":{"shape":"SendChatIntegrationEventRequest"}, "output":{"shape":"SendChatIntegrationEventResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"<p>Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes:</p> <ul> <li> <p>SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat</p> </li> <li> <p> ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat</p> </li> </ul> <p>When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action. </p> <p>Access to this API is currently restricted to Amazon Web Services End User Messaging for supporting SMS integration. </p>" }, "SendOutboundEmail":{ "name":"SendOutboundEmail", "http":{ "method":"PUT", "requestUri":"/instance/{InstanceId}/outbound-email" }, "input":{"shape":"SendOutboundEmailRequest"}, "output":{"shape":"SendOutboundEmailResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"IdempotencyException"} ], "documentation":"<p>Send outbound email for outbound campaigns. For more information about outbound campaigns, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/enable-outbound-campaigns.html\">Set up Amazon Connect outbound campaigns</a>.</p> <note> <p>Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.</p> </note>" }, "StartAttachedFileUpload":{ "name":"StartAttachedFileUpload", "http":{ "method":"PUT", "requestUri":"/attached-files/{InstanceId}" }, "input":{"shape":"StartAttachedFileUploadRequest"}, "output":{"shape":"StartAttachedFileUploadResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceConflictException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"<p>Provides a pre-signed Amazon S3 URL in response for uploading your content.</p> <important> <p>You may only use this API to upload attachments to an <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html\">Amazon Connect Case</a> or <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html\">Amazon Connect Email</a>. </p> </important>" }, "StartChatContact":{ "name":"StartChatContact", "http":{ "method":"PUT", "requestUri":"/contact/chat" }, "input":{"shape":"StartChatContactRequest"}, "output":{"shape":"StartChatContactResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"LimitExceededException"} ], "documentation":"<p>Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the <a href=\"https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html\">CreateParticipantConnection</a> API in the Amazon Connect Participant Service.</p> <p>When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking <a href=\"https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html\">CreateParticipantConnection</a> with WEBSOCKET and CONNECTION_CREDENTIALS. </p> <p>A 429 error occurs in the following situations:</p> <ul> <li> <p>API rate limit is exceeded. API TPS throttling returns a <code>TooManyRequests</code> exception.</p> </li> <li> <p>The <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html\">quota for concurrent active chats</a> is exceeded. Active chat throttling returns a <code>LimitExceededException</code>.</p> </li> </ul> <p>If you use the <code>ChatDurationInMinutes</code> parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web ServicesSupport. </p> <p>For more information about chat, see the following topics in the <i>Amazon Connect Administrator Guide</i>: </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/web-and-mobile-chat.html\">Concepts: Web and mobile messaging capabilities in Amazon Connect</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat\">Amazon Connect Chat security best practices</a> </p> </li> </ul>" }, "StartContactEvaluation":{ "name":"StartContactEvaluation", "http":{ "method":"PUT", "requestUri":"/contact-evaluations/{InstanceId}" }, "input":{"shape":"StartContactEvaluationRequest"}, "output":{"shape":"StartContactEvaluationResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ResourceConflictException"} ], "documentation":"<p>Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started. </p> <note> <p>Evaluations created through the public API do not contain answer values suggested from automation.</p> </note>", "idempotent":true }, "StartContactRecording":{ "name":"StartContactRecording", "http":{ "method":"POST", "requestUri":"/contact/start-recording" }, "input":{"shape":"StartContactRecordingRequest"}, "output":{"shape":"StartContactRecordingResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Starts recording the contact: </p> <ul> <li> <p>If the API is called <i>before</i> the agent joins the call, recording starts when the agent joins the call.</p> </li> <li> <p>If the API is called <i>after</i> the agent joins the call, recording starts at the time of the API call.</p> </li> </ul> <p>StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.</p> <p>You can use this API to override the recording behavior configured in the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/set-recording-behavior.html\">Set recording behavior</a> block.</p> <p>Only voice recordings are supported at this time.</p>" }, "StartContactStreaming":{ "name":"StartContactStreaming", "http":{ "method":"POST", "requestUri":"/contact/start-streaming" }, "input":{"shape":"StartContactStreamingRequest"}, "output":{"shape":"StartContactStreamingResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"LimitExceededException"} ], "documentation":"<p> Initiates real-time message streaming for a new chat contact.</p> <p> For more information about message streaming, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html\">Enable real-time chat message streaming</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <p>For more information about chat, see the following topics in the <i>Amazon Connect Administrator Guide</i>: </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/web-and-mobile-chat.html\">Concepts: Web and mobile messaging capabilities in Amazon Connect</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat\">Amazon Connect Chat security best practices</a> </p> </li> </ul>" }, "StartEmailContact":{ "name":"StartEmailContact", "http":{ "method":"PUT", "requestUri":"/contact/email" }, "input":{"shape":"StartEmailContactRequest"}, "output":{"shape":"StartEmailContactResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"IdempotencyException"} ], "documentation":"<p>Creates an inbound email contact and initiates a flow to start the email contact for the customer. Response of this API provides the ContactId of the email contact created.</p>" }, "StartOutboundChatContact":{ "name":"StartOutboundChatContact", "http":{ "method":"PUT", "requestUri":"/contact/outbound-chat" }, "input":{"shape":"StartOutboundChatContactRequest"}, "output":{"shape":"StartOutboundChatContactResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ConflictException"}, {"shape":"InternalServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"<p>Initiates a new outbound SMS contact to a customer. Response of this API provides the <code>ContactId</code> of the outbound SMS contact created.</p> <p> <b>SourceEndpoint</b> only supports Endpoints with <code>CONNECT_PHONENUMBER_ARN</code> as Type and <b>DestinationEndpoint</b> only supports Endpoints with <code>TELEPHONE_NUMBER</code> as Type. <b>ContactFlowId</b> initiates the flow to manage the new SMS contact created.</p> <p>This API can be used to initiate outbound SMS contacts for an agent, or it can also deflect an ongoing contact to an outbound SMS contact by using the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_StartOutboundChatContact.html\">StartOutboundChatContact</a> Flow Action.</p> <p>For more information about using SMS in Amazon Connect, see the following topics in the <i>Amazon Connect Administrator Guide</i>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/setup-sms-messaging.html\">Set up SMS messaging</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/sms-number.html\">Request an SMS-enabled phone number through AWS End User Messaging SMS</a> </p> </li> </ul>" }, "StartOutboundEmailContact":{ "name":"StartOutboundEmailContact", "http":{ "method":"PUT", "requestUri":"/contact/outbound-email" }, "input":{"shape":"StartOutboundEmailContactRequest"}, "output":{"shape":"StartOutboundEmailContactResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"IdempotencyException"} ], "documentation":"<p>Initiates a flow to send an agent reply or outbound email contact (created from the CreateContact API) to a customer.</p>" }, "StartOutboundVoiceContact":{ "name":"StartOutboundVoiceContact", "http":{ "method":"PUT", "requestUri":"/contact/outbound-voice" }, "input":{"shape":"StartOutboundVoiceContactRequest"}, "output":{"shape":"StartOutboundVoiceContactResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"LimitExceededException"}, {"shape":"DestinationNotAllowedException"}, {"shape":"OutboundContactNotPermittedException"} ], "documentation":"<p>Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's specified (in <code>ContactFlowId</code>).</p> <p>Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.</p> <p>There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.</p> <note> <p>UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html\">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator Guide</i>. </p> </note> <note> <p>Campaign calls are not allowed by default. Before you can make a call with <code>TrafficType</code> = <code>CAMPAIGN</code>, you must submit a service quota increase request to the quota <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#outbound-communications-quotas\">Amazon Connect campaigns</a>. </p> </note>" }, "StartScreenSharing":{ "name":"StartScreenSharing", "http":{ "method":"PUT", "requestUri":"/contact/screen-sharing" }, "input":{"shape":"StartScreenSharingRequest"}, "output":{"shape":"StartScreenSharingResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"<p>Starts screen sharing for a contact. For more information about screen sharing, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/inapp-calling.html\">Set up in-app, web, video calling, and screen sharing capabilities</a> in the <i>Amazon Connect Administrator Guide</i>. </p>" }, "StartTaskContact":{ "name":"StartTaskContact", "http":{ "method":"PUT", "requestUri":"/contact/task" }, "input":{"shape":"StartTaskContactRequest"}, "output":{"shape":"StartTaskContactResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Initiates a flow to start a new task contact. For more information about task contacts, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html\">Concepts: Tasks in Amazon Connect</a> in the <i>Amazon Connect Administrator Guide</i>. </p> <p>When using <code>PreviousContactId</code> and <code>RelatedContactId</code> input parameters, note the following:</p> <ul> <li> <p> <code>PreviousContactId</code> </p> <ul> <li> <p>Any updates to user-defined task contact attributes on any contact linked through the same <code>PreviousContactId</code> will affect every contact in the chain.</p> </li> <li> <p>There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same <code>PreviousContactId</code>.</p> </li> </ul> </li> <li> <p> <code>RelatedContactId</code> </p> <ul> <li> <p>Copies contact attributes from the related task contact to the new contact.</p> </li> <li> <p>Any update on attributes in a new task contact does not update attributes on previous contact.</p> </li> <li> <p>There’s no limit on the number of task contacts that can be created that use the same <code>RelatedContactId</code>.</p> </li> </ul> </li> </ul> <p>In addition, when calling StartTaskContact include only one of these parameters: <code>ContactFlowID</code>, <code>QuickConnectID</code>, or <code>TaskTemplateID</code>. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the <code>TaskTemplateID</code> is specified but it does not have a flow configured, the request returns an error because Amazon Connect cannot identify the unique flow to run when the task is created.</p> <p>A <code>ServiceQuotaExceededException</code> occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same <code>PreviousContactId</code>. For more information about service quotas for task contacts, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html\">Amazon Connect service quotas</a> in the <i>Amazon Connect Administrator Guide</i>. </p>" }, "StartWebRTCContact":{ "name":"StartWebRTCContact", "http":{ "method":"PUT", "requestUri":"/contact/webrtc" }, "input":{"shape":"StartWebRTCContactRequest"}, "output":{"shape":"StartWebRTCContactResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"<p>Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).</p>" }, "StopContact":{ "name":"StopContact", "http":{ "method":"POST", "requestUri":"/contact/stop" }, "input":{"shape":"StopContactRequest"}, "output":{"shape":"StopContactResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ContactNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:</p> <ul> <li> <p>DISCONNECT</p> </li> <li> <p>TRANSFER</p> </li> <li> <p>QUEUE_TRANSFER</p> </li> <li> <p>EXTERNAL_OUTBOUND</p> </li> <li> <p>MONITOR</p> </li> </ul> <p>Chat and task contacts can be terminated in any state, regardless of initiation method.</p>" }, "StopContactRecording":{ "name":"StopContactRecording", "http":{ "method":"POST", "requestUri":"/contact/stop-recording" }, "input":{"shape":"StopContactRecordingRequest"}, "output":{"shape":"StopContactRecordingResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.</p> <p>Only voice recordings are supported at this time.</p>" }, "StopContactStreaming":{ "name":"StopContactStreaming", "http":{ "method":"POST", "requestUri":"/contact/stop-streaming" }, "input":{"shape":"StopContactStreamingRequest"}, "output":{"shape":"StopContactStreamingResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"} ], "documentation":"<p> Ends message streaming on a specified contact. To restart message streaming on that contact, call the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html\">StartContactStreaming</a> API. </p>" }, "SubmitContactEvaluation":{ "name":"SubmitContactEvaluation", "http":{ "method":"POST", "requestUri":"/contact-evaluations/{InstanceId}/{EvaluationId}/submit" }, "input":{"shape":"SubmitContactEvaluationRequest"}, "output":{"shape":"SubmitContactEvaluationResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"ResourceConflictException"} ], "documentation":"<p>Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted with the existing answers and notes. You can delete an answer or note by passing an empty object (<code>{}</code>) to the question identifier. </p> <p>If a contact evaluation is already in submitted state, this operation will trigger a resubmission.</p>" }, "SuspendContactRecording":{ "name":"SuspendContactRecording", "http":{ "method":"POST", "requestUri":"/contact/suspend-recording" }, "input":{"shape":"SuspendContactRecordingRequest"}, "output":{"shape":"SuspendContactRecordingResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call (IVR or agent), screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_ResumeContactRecording.html\">ResumeContactRecording</a> to restart recording the screen.</p> <p>The period of time that the recording is suspended is filled with silence in the final recording. </p> <p> Voice (IVR, agent) and screen recordings are supported.</p>" }, "TagContact":{ "name":"TagContact", "http":{ "method":"POST", "requestUri":"/contact/tags" }, "input":{"shape":"TagContactRequest"}, "output":{"shape":"TagContactResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Adds the specified tags to the contact resource. For more information about this API is used, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/granular-billing.html\">Set up granular billing for a detailed view of your Amazon Connect usage</a>. </p>", "idempotent":true }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags/{resourceArn}" }, "input":{"shape":"TagResourceRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"InternalServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Adds the specified tags to the specified resource.</p> <p>Some of the supported resource types are agents, routing profiles, queues, quick connects, flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/tagging.html\">Tagging resources in Amazon Connect</a>.</p> <p>For sample policies that use tags, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html\">Amazon Connect Identity-Based Policy Examples</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "TransferContact":{ "name":"TransferContact", "http":{ "method":"POST", "requestUri":"/contact/transfer" }, "input":{"shape":"TransferContactRequest"}, "output":{"shape":"TransferContactResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"IdempotencyException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Transfers <code>TASK</code> or <code>EMAIL</code> contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.</p> <p>Note the following requirements:</p> <ul> <li> <p>Transfer is only supported for <code>TASK</code> and <code>EMAIL</code> contacts.</p> </li> <li> <p>Do not use both <code>QueueId</code> and <code>UserId</code> in the same call.</p> </li> <li> <p>The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.</p> </li> <li> <p>The <code>TransferContact</code> API can be called only on active contacts.</p> </li> <li> <p>A contact cannot be transferred more than 11 times.</p> </li> </ul>" }, "UntagContact":{ "name":"UntagContact", "http":{ "method":"DELETE", "requestUri":"/contact/tags/{InstanceId}/{ContactId}" }, "input":{"shape":"UntagContactRequest"}, "output":{"shape":"UntagContactResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Removes the specified tags from the contact resource. For more information about this API is used, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/granular-billing.html\">Set up granular billing for a detailed view of your Amazon Connect usage</a>.</p>", "idempotent":true }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{resourceArn}" }, "input":{"shape":"UntagResourceRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"InternalServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>Removes the specified tags from the specified resource.</p>" }, "UpdateAgentStatus":{ "name":"UpdateAgentStatus", "http":{ "method":"POST", "requestUri":"/agent-status/{InstanceId}/{AgentStatusId}" }, "input":{"shape":"UpdateAgentStatusRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"DuplicateResourceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates agent status.</p>" }, "UpdateAuthenticationProfile":{ "name":"UpdateAuthenticationProfile", "http":{ "method":"POST", "requestUri":"/authentication-profiles/{InstanceId}/{AuthenticationProfileId}" }, "input":{"shape":"UpdateAuthenticationProfileRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web ServicesSupport.</p> <p>Updates the selected authentication profile.</p>" }, "UpdateContact":{ "name":"UpdateContact", "http":{ "method":"POST", "requestUri":"/contacts/{InstanceId}/{ContactId}" }, "input":{"shape":"UpdateContactRequest"}, "output":{"shape":"UpdateContactResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.</p> <important> <p>You can add or update user-defined contact information for both ongoing and completed contacts.</p> </important>" }, "UpdateContactAttributes":{ "name":"UpdateContactAttributes", "http":{ "method":"POST", "requestUri":"/contact/attributes" }, "input":{"shape":"UpdateContactAttributesRequest"}, "output":{"shape":"UpdateContactAttributesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Creates or updates user-defined contact attributes associated with the specified contact.</p> <p>You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or to identify abusive callers.</p> <p>Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits\">Feature specifications</a> in the <i>Amazon Connect Administrator Guide</i>. </p>" }, "UpdateContactEvaluation":{ "name":"UpdateContactEvaluation", "http":{ "method":"POST", "requestUri":"/contact-evaluations/{InstanceId}/{EvaluationId}" }, "input":{"shape":"UpdateContactEvaluationRequest"}, "output":{"shape":"UpdateContactEvaluationResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"ResourceConflictException"} ], "documentation":"<p>Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object (<code>{}</code>) to the question identifier. </p>" }, "UpdateContactFlowContent":{ "name":"UpdateContactFlowContent", "http":{ "method":"POST", "requestUri":"/contact-flows/{InstanceId}/{ContactFlowId}/content" }, "input":{"shape":"UpdateContactFlowContentRequest"}, "output":{"shape":"UpdateContactFlowContentResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidContactFlowException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Updates the specified flow.</p> <p>You can also create and update flows using the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html\">Amazon Connect Flow language</a>.</p> <p>Use the <code>$SAVED</code> alias in the request to describe the <code>SAVED</code> content of a Flow. For example, <code>arn:aws:.../contact-flow/{id}:$SAVED</code>. After a flow is published, <code>$SAVED</code> needs to be supplied to view saved content that has not been published.</p>" }, "UpdateContactFlowMetadata":{ "name":"UpdateContactFlowMetadata", "http":{ "method":"POST", "requestUri":"/contact-flows/{InstanceId}/{ContactFlowId}/metadata" }, "input":{"shape":"UpdateContactFlowMetadataRequest"}, "output":{"shape":"UpdateContactFlowMetadataResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"DuplicateResourceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Updates metadata about specified flow.</p>" }, "UpdateContactFlowModuleContent":{ "name":"UpdateContactFlowModuleContent", "http":{ "method":"POST", "requestUri":"/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}/content" }, "input":{"shape":"UpdateContactFlowModuleContentRequest"}, "output":{"shape":"UpdateContactFlowModuleContentResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidContactFlowModuleException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Updates specified flow module for the specified Amazon Connect instance. </p> <p>Use the <code>$SAVED</code> alias in the request to describe the <code>SAVED</code> content of a Flow. For example, <code>arn:aws:.../contact-flow/{id}:$SAVED</code>. After a flow is published, <code>$SAVED</code> needs to be supplied to view saved content that has not been published.</p>" }, "UpdateContactFlowModuleMetadata":{ "name":"UpdateContactFlowModuleMetadata", "http":{ "method":"POST", "requestUri":"/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}/metadata" }, "input":{"shape":"UpdateContactFlowModuleMetadataRequest"}, "output":{"shape":"UpdateContactFlowModuleMetadataResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"DuplicateResourceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Updates metadata about specified flow module.</p>" }, "UpdateContactFlowName":{ "name":"UpdateContactFlowName", "http":{ "method":"POST", "requestUri":"/contact-flows/{InstanceId}/{ContactFlowId}/name" }, "input":{"shape":"UpdateContactFlowNameRequest"}, "output":{"shape":"UpdateContactFlowNameResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"DuplicateResourceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>The name of the flow.</p> <p>You can also create and update flows using the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html\">Amazon Connect Flow language</a>.</p>" }, "UpdateContactRoutingData":{ "name":"UpdateContactRoutingData", "http":{ "method":"POST", "requestUri":"/contacts/{InstanceId}/{ContactId}/routing-data" }, "input":{"shape":"UpdateContactRoutingDataRequest"}, "output":{"shape":"UpdateContactRoutingDataResponse"}, "errors":[ {"shape":"ResourceConflictException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"<p>Updates routing priority and age on the contact (<b>QueuePriority</b> and <b>QueueTimeAdjustmentInSeconds</b>). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/change-routing-priority.html\">the Set routing priority / age flow block</a>.</p> <note> <p>Either <b>QueuePriority</b> or <b>QueueTimeAdjustmentInSeconds</b> should be provided within the request body, but not both.</p> </note>" }, "UpdateContactSchedule":{ "name":"UpdateContactSchedule", "http":{ "method":"POST", "requestUri":"/contact/schedule" }, "input":{"shape":"UpdateContactScheduleRequest"}, "output":{"shape":"UpdateContactScheduleResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"LimitExceededException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Updates the scheduled time of a task contact that is already scheduled.</p>" }, "UpdateEmailAddressMetadata":{ "name":"UpdateEmailAddressMetadata", "http":{ "method":"POST", "requestUri":"/email-addresses/{InstanceId}/{EmailAddressId}" }, "input":{"shape":"UpdateEmailAddressMetadataRequest"}, "output":{"shape":"UpdateEmailAddressMetadataResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"InternalServiceException"}, {"shape":"IdempotencyException"} ], "documentation":"<p>Updates an email address metadata. For more information about email addresses, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/create-email-address1.html\">Create email addresses</a> in the Amazon Connect Administrator Guide.</p>" }, "UpdateEvaluationForm":{ "name":"UpdateEvaluationForm", "http":{ "method":"PUT", "requestUri":"/evaluation-forms/{InstanceId}/{EvaluationFormId}" }, "input":{"shape":"UpdateEvaluationFormRequest"}, "output":{"shape":"UpdateEvaluationFormResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ResourceConflictException"} ], "documentation":"<p>Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form.</p> <p>This operation does not support partial updates. Instead it does a full update of evaluation form content.</p>", "idempotent":true }, "UpdateHoursOfOperation":{ "name":"UpdateHoursOfOperation", "http":{ "method":"POST", "requestUri":"/hours-of-operations/{InstanceId}/{HoursOfOperationId}" }, "input":{"shape":"UpdateHoursOfOperationRequest"}, "errors":[ {"shape":"DuplicateResourceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates the hours of operation.</p>" }, "UpdateHoursOfOperationOverride":{ "name":"UpdateHoursOfOperationOverride", "http":{ "method":"POST", "requestUri":"/hours-of-operations/{InstanceId}/{HoursOfOperationId}/overrides/{HoursOfOperationOverrideId}" }, "input":{"shape":"UpdateHoursOfOperationOverrideRequest"}, "errors":[ {"shape":"DuplicateResourceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"ConditionalOperationFailedException"} ], "documentation":"<p>Update the hours of operation override.</p>" }, "UpdateInstanceAttribute":{ "name":"UpdateInstanceAttribute", "http":{ "method":"POST", "requestUri":"/instance/{InstanceId}/attribute/{AttributeType}" }, "input":{"shape":"UpdateInstanceAttributeRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates the value for the specified attribute type.</p>" }, "UpdateInstanceStorageConfig":{ "name":"UpdateInstanceStorageConfig", "http":{ "method":"POST", "requestUri":"/instance/{InstanceId}/storage-config/{AssociationId}" }, "input":{"shape":"UpdateInstanceStorageConfigRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates an existing configuration for a resource type. This API is idempotent.</p>" }, "UpdateParticipantAuthentication":{ "name":"UpdateParticipantAuthentication", "http":{ "method":"POST", "requestUri":"/contact/update-participant-authentication" }, "input":{"shape":"UpdateParticipantAuthenticationRequest"}, "output":{"shape":"UpdateParticipantAuthenticationResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ConflictException"}, {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"<p>Instructs Amazon Connect to resume the authentication process. The subsequent actions depend on the request body contents:</p> <ul> <li> <p> <b>If a code is provided</b>: Connect retrieves the identity information from Amazon Cognito and imports it into Connect Customer Profiles.</p> </li> <li> <p> <b>If an error is provided</b>: The error branch of the Authenticate Customer block is executed.</p> </li> </ul> <note> <p>The API returns a success response to acknowledge the request. However, the interaction and exchange of identity information occur asynchronously after the response is returned.</p> </note>" }, "UpdateParticipantRoleConfig":{ "name":"UpdateParticipantRoleConfig", "http":{ "method":"PUT", "requestUri":"/contact/participant-role-config/{InstanceId}/{ContactId}" }, "input":{"shape":"UpdateParticipantRoleConfigRequest"}, "output":{"shape":"UpdateParticipantRoleConfigResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers:</p> <ul> <li> <p>Customer idle timeout</p> </li> <li> <p>Customer auto-disconnect timeout</p> </li> <li> <p>Agent idle timeout</p> </li> <li> <p>Agent auto-disconnect timeout</p> </li> </ul> <p>For more information about how chat timeouts work, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html\">Set up chat timeouts for human participants</a>. </p>" }, "UpdatePhoneNumber":{ "name":"UpdatePhoneNumber", "http":{ "method":"PUT", "requestUri":"/phone-number/{PhoneNumberId}" }, "input":{"shape":"UpdatePhoneNumberRequest"}, "output":{"shape":"UpdatePhoneNumberResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"ResourceInUseException"}, {"shape":"IdempotencyException"}, {"shape":"AccessDeniedException"} ], "documentation":"<p>Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.</p> <important> <p>After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flow configuration of the phone number, too.</p> <p>You can call <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html\">DescribePhoneNumber</a> API to verify the status of a previous <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html\">UpdatePhoneNumber</a> operation.</p> </important>" }, "UpdatePhoneNumberMetadata":{ "name":"UpdatePhoneNumberMetadata", "http":{ "method":"PUT", "requestUri":"/phone-number/{PhoneNumberId}/metadata" }, "input":{"shape":"UpdatePhoneNumberMetadataRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InvalidRequestException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"IdempotencyException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Updates a phone number’s metadata.</p> <important> <p>To verify the status of a previous UpdatePhoneNumberMetadata operation, call the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html\">DescribePhoneNumber</a> API.</p> </important>" }, "UpdatePredefinedAttribute":{ "name":"UpdatePredefinedAttribute", "http":{ "method":"POST", "requestUri":"/predefined-attributes/{InstanceId}/{Name}" }, "input":{"shape":"UpdatePredefinedAttributeRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Updates a predefined attribute for the specified Amazon Connect instance. <i>Predefined attributes</i> are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html\">Create predefined attributes for routing contacts to agents</a>.</p>" }, "UpdatePrompt":{ "name":"UpdatePrompt", "http":{ "method":"POST", "requestUri":"/prompts/{InstanceId}/{PromptId}" }, "input":{"shape":"UpdatePromptRequest"}, "output":{"shape":"UpdatePromptResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Updates a prompt.</p>" }, "UpdateQueueHoursOfOperation":{ "name":"UpdateQueueHoursOfOperation", "http":{ "method":"POST", "requestUri":"/queues/{InstanceId}/{QueueId}/hours-of-operation" }, "input":{"shape":"UpdateQueueHoursOfOperationRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates the hours of operation for the specified queue.</p>" }, "UpdateQueueMaxContacts":{ "name":"UpdateQueueMaxContacts", "http":{ "method":"POST", "requestUri":"/queues/{InstanceId}/{QueueId}/max-contacts" }, "input":{"shape":"UpdateQueueMaxContactsRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates the maximum number of contacts allowed in a queue before it is considered full.</p>" }, "UpdateQueueName":{ "name":"UpdateQueueName", "http":{ "method":"POST", "requestUri":"/queues/{InstanceId}/{QueueId}/name" }, "input":{"shape":"UpdateQueueNameRequest"}, "errors":[ {"shape":"DuplicateResourceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates the name and description of a queue. At least <code>Name</code> or <code>Description</code> must be provided.</p>" }, "UpdateQueueOutboundCallerConfig":{ "name":"UpdateQueueOutboundCallerConfig", "http":{ "method":"POST", "requestUri":"/queues/{InstanceId}/{QueueId}/outbound-caller-config" }, "input":{"shape":"UpdateQueueOutboundCallerConfigRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.</p> <important> <ul> <li> <p>If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for <code>OutboundCallerIdNumberId</code>. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a <code>ResourceNotFoundException</code>.</p> </li> <li> <p>Only use the phone number ARN format that doesn't contain <code>instance</code> in the path, for example, <code>arn:aws:connect:us-east-1:1234567890:phone-number/uuid</code>. This is the same ARN format that is returned when you call the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html\">ListPhoneNumbersV2</a> API.</p> </li> <li> <p>If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_resource-level-policy-examples.html#allow-deny-queue-actions-replica-region\">Allow or Deny queue API actions for phone numbers in a replica Region</a>.</p> </li> </ul> </important>" }, "UpdateQueueOutboundEmailConfig":{ "name":"UpdateQueueOutboundEmailConfig", "http":{ "method":"POST", "requestUri":"/queues/{InstanceId}/{QueueId}/outbound-email-config" }, "input":{"shape":"UpdateQueueOutboundEmailConfigRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"AccessDeniedException"}, {"shape":"ConditionalOperationFailedException"} ], "documentation":"<p>Updates the outbound email address Id for a specified queue.</p>" }, "UpdateQueueStatus":{ "name":"UpdateQueueStatus", "http":{ "method":"POST", "requestUri":"/queues/{InstanceId}/{QueueId}/status" }, "input":{"shape":"UpdateQueueStatusRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates the status of the queue.</p>" }, "UpdateQuickConnectConfig":{ "name":"UpdateQuickConnectConfig", "http":{ "method":"POST", "requestUri":"/quick-connects/{InstanceId}/{QuickConnectId}/config" }, "input":{"shape":"UpdateQuickConnectConfigRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Updates the configuration settings for the specified quick connect.</p>" }, "UpdateQuickConnectName":{ "name":"UpdateQuickConnectName", "http":{ "method":"POST", "requestUri":"/quick-connects/{InstanceId}/{QuickConnectId}/name" }, "input":{"shape":"UpdateQuickConnectNameRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least <code>Name</code> or <code>Description</code> must be provided.</p>" }, "UpdateRoutingProfileAgentAvailabilityTimer":{ "name":"UpdateRoutingProfileAgentAvailabilityTimer", "http":{ "method":"POST", "requestUri":"/routing-profiles/{InstanceId}/{RoutingProfileId}/agent-availability-timer" }, "input":{"shape":"UpdateRoutingProfileAgentAvailabilityTimerRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Whether agents with this routing profile will have their routing order calculated based on <i>time since their last inbound contact</i> or <i>longest idle time</i>. </p>" }, "UpdateRoutingProfileConcurrency":{ "name":"UpdateRoutingProfileConcurrency", "http":{ "method":"POST", "requestUri":"/routing-profiles/{InstanceId}/{RoutingProfileId}/concurrency" }, "input":{"shape":"UpdateRoutingProfileConcurrencyRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.</p>" }, "UpdateRoutingProfileDefaultOutboundQueue":{ "name":"UpdateRoutingProfileDefaultOutboundQueue", "http":{ "method":"POST", "requestUri":"/routing-profiles/{InstanceId}/{RoutingProfileId}/default-outbound-queue" }, "input":{"shape":"UpdateRoutingProfileDefaultOutboundQueueRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Updates the default outbound queue of a routing profile.</p>" }, "UpdateRoutingProfileName":{ "name":"UpdateRoutingProfileName", "http":{ "method":"POST", "requestUri":"/routing-profiles/{InstanceId}/{RoutingProfileId}/name" }, "input":{"shape":"UpdateRoutingProfileNameRequest"}, "errors":[ {"shape":"DuplicateResourceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least <code>Name</code> or <code>Description</code> must be provided.</p>" }, "UpdateRoutingProfileQueues":{ "name":"UpdateRoutingProfileQueues", "http":{ "method":"POST", "requestUri":"/routing-profiles/{InstanceId}/{RoutingProfileId}/queues" }, "input":{"shape":"UpdateRoutingProfileQueuesRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Updates the properties associated with a set of queues for a routing profile.</p>" }, "UpdateRule":{ "name":"UpdateRule", "http":{ "method":"PUT", "requestUri":"/rules/{InstanceId}/{RuleId}" }, "input":{"shape":"UpdateRuleRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceConflictException"} ], "documentation":"<p>Updates a rule for the specified Amazon Connect instance.</p> <p>Use the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-language.html\">Rules Function language</a> to code conditions for the rule. </p>" }, "UpdateSecurityProfile":{ "name":"UpdateSecurityProfile", "http":{ "method":"POST", "requestUri":"/security-profiles/{InstanceId}/{SecurityProfileId}" }, "input":{"shape":"UpdateSecurityProfileRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Updates a security profile.</p> <p>For information about security profiles, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html\">Security Profiles</a> in the <i>Amazon Connect Administrator Guide</i>. For a mapping of the API name and user interface name of the security profile permissions, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html\">List of security profile permissions</a>. </p>" }, "UpdateTaskTemplate":{ "name":"UpdateTaskTemplate", "http":{ "method":"POST", "requestUri":"/instance/{InstanceId}/task/template/{TaskTemplateId}" }, "input":{"shape":"UpdateTaskTemplateRequest"}, "output":{"shape":"UpdateTaskTemplateResponse"}, "errors":[ {"shape":"PropertyValidationException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content.</p>" }, "UpdateTrafficDistribution":{ "name":"UpdateTrafficDistribution", "http":{ "method":"PUT", "requestUri":"/traffic-distribution/{Id}" }, "input":{"shape":"UpdateTrafficDistributionRequest"}, "output":{"shape":"UpdateTrafficDistributionResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceConflictException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Updates the traffic distribution for a given traffic distribution group. </p> <important> <p>When you shift telephony traffic, also shift agents and/or agent sign-ins to ensure they can handle the calls in the other Region. If you don't shift the agents, voice calls will go to the shifted Region but there won't be any agents available to receive the calls.</p> </important> <note> <p>The <code>SignInConfig</code> distribution is available only on a default <code>TrafficDistributionGroup</code> (see the <code>IsDefault</code> parameter in the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html\">TrafficDistributionGroup</a> data type). If you call <code>UpdateTrafficDistribution</code> with a modified <code>SignInConfig</code> and a non-default <code>TrafficDistributionGroup</code>, an <code>InvalidRequestException</code> is returned.</p> </note> <p>For more information about updating a traffic distribution group, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/update-telephony-traffic-distribution.html\">Update telephony traffic distribution across Amazon Web Services Regions </a> in the <i>Amazon Connect Administrator Guide</i>. </p>" }, "UpdateUserHierarchy":{ "name":"UpdateUserHierarchy", "http":{ "method":"POST", "requestUri":"/users/{InstanceId}/{UserId}/hierarchy" }, "input":{"shape":"UpdateUserHierarchyRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Assigns the specified hierarchy group to the specified user.</p>" }, "UpdateUserHierarchyGroupName":{ "name":"UpdateUserHierarchyGroupName", "http":{ "method":"POST", "requestUri":"/user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}/name" }, "input":{"shape":"UpdateUserHierarchyGroupNameRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"DuplicateResourceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Updates the name of the user hierarchy group. </p>" }, "UpdateUserHierarchyStructure":{ "name":"UpdateUserHierarchyStructure", "http":{ "method":"POST", "requestUri":"/user-hierarchy-structure/{InstanceId}" }, "input":{"shape":"UpdateUserHierarchyStructureRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.</p>" }, "UpdateUserIdentityInfo":{ "name":"UpdateUserIdentityInfo", "http":{ "method":"POST", "requestUri":"/users/{InstanceId}/{UserId}/identity-info" }, "input":{"shape":"UpdateUserIdentityInfoRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Updates the identity information for the specified user.</p> <important> <p>We strongly recommend limiting who has the ability to invoke <code>UpdateUserIdentityInfo</code>. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-best-practices.html\">Best Practices for Security Profiles</a> in the <i>Amazon Connect Administrator Guide</i>.</p> </important>" }, "UpdateUserPhoneConfig":{ "name":"UpdateUserPhoneConfig", "http":{ "method":"POST", "requestUri":"/users/{InstanceId}/{UserId}/phone-config" }, "input":{"shape":"UpdateUserPhoneConfigRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Updates the phone configuration settings for the specified user.</p>" }, "UpdateUserProficiencies":{ "name":"UpdateUserProficiencies", "http":{ "method":"POST", "requestUri":"/users/{InstanceId}/{UserId}/proficiencies" }, "input":{"shape":"UpdateUserProficienciesRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Updates the properties associated with the proficiencies of a user.</p>" }, "UpdateUserRoutingProfile":{ "name":"UpdateUserRoutingProfile", "http":{ "method":"POST", "requestUri":"/users/{InstanceId}/{UserId}/routing-profile" }, "input":{"shape":"UpdateUserRoutingProfileRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Assigns the specified routing profile to the specified user.</p>" }, "UpdateUserSecurityProfiles":{ "name":"UpdateUserSecurityProfiles", "http":{ "method":"POST", "requestUri":"/users/{InstanceId}/{UserId}/security-profiles" }, "input":{"shape":"UpdateUserSecurityProfilesRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], "documentation":"<p>Assigns the specified security profiles to the specified user.</p>" }, "UpdateViewContent":{ "name":"UpdateViewContent", "http":{ "method":"POST", "requestUri":"/views/{InstanceId}/{ViewId}" }, "input":{"shape":"UpdateViewContentRequest"}, "output":{"shape":"UpdateViewContentResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"TooManyRequestsException"}, {"shape":"ResourceInUseException"} ], "documentation":"<p>Updates the view content of the given view identifier in the specified Amazon Connect instance.</p> <p>It performs content validation if <code>Status</code> is set to <code>SAVED</code> and performs full content validation if <code>Status</code> is <code>PUBLISHED</code>. Note that the <code>$SAVED</code> alias' content will always be updated, but the <code>$LATEST</code> alias' content will only be updated if <code>Status</code> is <code>PUBLISHED</code>.</p>" }, "UpdateViewMetadata":{ "name":"UpdateViewMetadata", "http":{ "method":"POST", "requestUri":"/views/{InstanceId}/{ViewId}/metadata" }, "input":{"shape":"UpdateViewMetadataRequest"}, "output":{"shape":"UpdateViewMetadataResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"TooManyRequestsException"}, {"shape":"DuplicateResourceException"}, {"shape":"ResourceInUseException"} ], "documentation":"<p>Updates the view metadata. Note that either <code>Name</code> or <code>Description</code> must be provided.</p>" } }, "shapes":{ "ARN":{"type":"string"}, "AWSAccountId":{"type":"string"}, "AccessDeniedException":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"<p>You do not have sufficient permissions to perform this action.</p>", "error":{"httpStatusCode":403}, "exception":true }, "AccessTokenDuration":{ "type":"integer", "box":true, "max":60, "min":10 }, "ActionSummaries":{ "type":"list", "member":{"shape":"ActionSummary"} }, "ActionSummary":{ "type":"structure", "required":["ActionType"], "members":{ "ActionType":{ "shape":"ActionType", "documentation":"<p>The action type.</p>" } }, "documentation":"<p>Information about an action.</p>" }, "ActionType":{ "type":"string", "enum":[ "CREATE_TASK", "ASSIGN_CONTACT_CATEGORY", "GENERATE_EVENTBRIDGE_EVENT", "SEND_NOTIFICATION", "CREATE_CASE", "UPDATE_CASE", "ASSIGN_SLA", "END_ASSOCIATED_TASKS", "SUBMIT_AUTO_EVALUATION" ] }, "ActivateEvaluationFormRequest":{ "type":"structure", "required":[ "InstanceId", "EvaluationFormId", "EvaluationFormVersion" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "EvaluationFormId":{ "shape":"ResourceId", "documentation":"<p>The unique identifier for the evaluation form.</p>", "location":"uri", "locationName":"EvaluationFormId" }, "EvaluationFormVersion":{ "shape":"VersionNumber", "documentation":"<p>The version of the evaluation form to activate. If the version property is not provided, the latest version of the evaluation form is activated.</p>" } } }, "ActivateEvaluationFormResponse":{ "type":"structure", "required":[ "EvaluationFormId", "EvaluationFormArn", "EvaluationFormVersion" ], "members":{ "EvaluationFormId":{ "shape":"ResourceId", "documentation":"<p>The unique identifier for the evaluation form.</p>" }, "EvaluationFormArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>" }, "EvaluationFormVersion":{ "shape":"VersionNumber", "documentation":"<p>A version of the evaluation form.</p>" } } }, "AdditionalEmailRecipients":{ "type":"structure", "members":{ "ToList":{ "shape":"EmailRecipientsList", "documentation":"<p>List of additional TO email recipients for an email contact.</p>" }, "CcList":{ "shape":"EmailRecipientsList", "documentation":"<p>List of additional CC email recipients for an email contact.</p>" } }, "documentation":"<p>List of additional email addresses for an email contact.</p>" }, "AfterContactWorkTimeLimit":{ "type":"integer", "min":0 }, "AgentAvailabilityTimer":{ "type":"string", "enum":[ "TIME_SINCE_LAST_ACTIVITY", "TIME_SINCE_LAST_INBOUND" ] }, "AgentConfig":{ "type":"structure", "required":["Distributions"], "members":{ "Distributions":{ "shape":"DistributionList", "documentation":"<p>Information about traffic distributions.</p>" } }, "documentation":"<p>The distribution of agents between the instance and its replica(s).</p>" }, "AgentContactReference":{ "type":"structure", "members":{ "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact in this instance of Amazon Connect. </p>" }, "Channel":{ "shape":"Channel", "documentation":"<p>The channel of the contact.</p>" }, "InitiationMethod":{ "shape":"ContactInitiationMethod", "documentation":"<p>How the contact was initiated.</p>" }, "AgentContactState":{ "shape":"ContactState", "documentation":"<p>The <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html\">state of the contact</a>.</p> <note> <p>When <code>AgentContactState</code> is set to <code>CONNECTED_ONHOLD</code>, <code>StateStartTimestamp</code> is not changed. Instead, <code>StateStartTimestamp</code> reflects the time the contact was <code>CONNECTED</code> to the agent.</p> </note>" }, "StateStartTimestamp":{ "shape":"Timestamp", "documentation":"<p>The epoch timestamp when the contact state started.</p>" }, "ConnectedToAgentTimestamp":{ "shape":"Timestamp", "documentation":"<p>The time at which the contact was connected to an agent.</p>" }, "Queue":{"shape":"QueueReference"} }, "documentation":"<p>Information about the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_Contact.html\">contact</a> associated to the user.</p>" }, "AgentContactReferenceList":{ "type":"list", "member":{"shape":"AgentContactReference"} }, "AgentFirstName":{ "type":"string", "max":255, "min":0, "sensitive":true }, "AgentHierarchyGroup":{ "type":"structure", "members":{ "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the group.</p>" } }, "documentation":"<p>Information about an agent hierarchy group.</p>" }, "AgentHierarchyGroups":{ "type":"structure", "members":{ "L1Ids":{ "shape":"HierarchyGroupIdList", "documentation":"<p>The identifiers for level 1 hierarchy groups.</p>" }, "L2Ids":{ "shape":"HierarchyGroupIdList", "documentation":"<p>The identifiers for level 2 hierarchy groups.</p>" }, "L3Ids":{ "shape":"HierarchyGroupIdList", "documentation":"<p>The identifiers for level 3 hierarchy groups.</p>" }, "L4Ids":{ "shape":"HierarchyGroupIdList", "documentation":"<p>The identifiers for level 4 hierarchy groups.</p>" }, "L5Ids":{ "shape":"HierarchyGroupIdList", "documentation":"<p>The identifiers for level 5 hierarchy groups.</p>" } }, "documentation":"<p>A structure that defines search criteria for contacts using agent hierarchy group levels. For more information about agent hierarchies, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html\">Set Up Agent Hierarchies</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "AgentId":{ "type":"string", "max":256 }, "AgentIds":{ "type":"list", "member":{"shape":"AgentId"} }, "AgentInfo":{ "type":"structure", "members":{ "Id":{ "shape":"AgentResourceId", "documentation":"<p>The identifier of the agent who accepted the contact.</p>" }, "ConnectedToAgentTimestamp":{ "shape":"timestamp", "documentation":"<p>The timestamp when the contact was connected to the agent.</p>" }, "AgentPauseDurationInSeconds":{ "shape":"AgentPauseDurationInSeconds", "documentation":"<p>Agent pause duration for a contact in seconds.</p>" }, "HierarchyGroups":{ "shape":"HierarchyGroups", "documentation":"<p>The agent hierarchy groups for the agent.</p>" }, "DeviceInfo":{ "shape":"DeviceInfo", "documentation":"<p>Information regarding Agent’s device.</p>" }, "Capabilities":{"shape":"ParticipantCapabilities"}, "AfterContactWorkDuration":{ "shape":"Duration", "documentation":"<p>The difference in time, in whole seconds, between <code>AfterContactWorkStartTimestamp</code> and <code>AfterContactWorkEndTimestamp</code>.</p>" }, "AfterContactWorkStartTimestamp":{ "shape":"timestamp", "documentation":"<p>The date and time when the agent started doing After Contact Work for the contact, in UTC time.</p>" }, "AfterContactWorkEndTimestamp":{ "shape":"timestamp", "documentation":"<p>The date and time when the agent ended After Contact Work for the contact, in UTC time. In cases when agent finishes doing <code>AfterContactWork</code> for chat contacts and switches their activity status to offline or equivalent without clearing the contact in CCP, discrepancies may be noticed for <code>AfterContactWorkEndTimestamp</code>.</p>" }, "AgentInitiatedHoldDuration":{ "shape":"Duration", "documentation":"<p>The total hold duration in seconds initiated by the agent.</p>" }, "StateTransitions":{ "shape":"StateTransitions", "documentation":"<p>List of <code>StateTransition</code> for a supervisor.</p>" } }, "documentation":"<p>Information about the agent who accepted the contact.</p>" }, "AgentLastName":{ "type":"string", "max":300, "min":0, "sensitive":true }, "AgentPauseDurationInSeconds":{ "type":"integer", "min":0 }, "AgentQualityMetrics":{ "type":"structure", "members":{ "Audio":{ "shape":"AudioQualityMetricsInfo", "documentation":"<p>Information about the audio quality of the Agent</p>" } }, "documentation":"<p>Information about the quality of the Agent's media connection</p>" }, "AgentResourceId":{ "type":"string", "max":256, "min":1 }, "AgentResourceIdList":{ "type":"list", "member":{"shape":"AgentResourceId"}, "max":100, "min":0 }, "AgentStatus":{ "type":"structure", "members":{ "AgentStatusARN":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the agent status.</p>" }, "AgentStatusId":{ "shape":"AgentStatusId", "documentation":"<p>The identifier of the agent status.</p>" }, "Name":{ "shape":"AgentStatusName", "documentation":"<p>The name of the agent status.</p>" }, "Description":{ "shape":"AgentStatusDescription", "documentation":"<p>The description of the agent status.</p>" }, "Type":{ "shape":"AgentStatusType", "documentation":"<p>The type of agent status.</p>" }, "DisplayOrder":{ "shape":"AgentStatusOrderNumber", "documentation":"<p>The display order of the agent status.</p>" }, "State":{ "shape":"AgentStatusState", "documentation":"<p>The state of the agent status.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when this resource was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The Amazon Web Services Region where this resource was last modified.</p>" } }, "documentation":"<p>Contains information about an agent status.</p>" }, "AgentStatusDescription":{ "type":"string", "max":250, "min":1 }, "AgentStatusId":{"type":"string"}, "AgentStatusList":{ "type":"list", "member":{"shape":"AgentStatus"} }, "AgentStatusName":{ "type":"string", "max":127, "min":1 }, "AgentStatusOrderNumber":{ "type":"integer", "max":50, "min":1 }, "AgentStatusReference":{ "type":"structure", "members":{ "StatusStartTimestamp":{ "shape":"Timestamp", "documentation":"<p>The start timestamp of the agent's status.</p>" }, "StatusArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the agent's status.</p>" }, "StatusName":{ "shape":"AgentStatusName", "documentation":"<p>The name of the agent status.</p>" } }, "documentation":"<p>Information about the agent's status.</p>" }, "AgentStatusSearchConditionList":{ "type":"list", "member":{"shape":"AgentStatusSearchCriteria"} }, "AgentStatusSearchCriteria":{ "type":"structure", "members":{ "OrConditions":{ "shape":"AgentStatusSearchConditionList", "documentation":"<p>A list of conditions which would be applied together with an <code>OR</code> condition.</p>" }, "AndConditions":{ "shape":"AgentStatusSearchConditionList", "documentation":"<p>A leaf node condition which can be used to specify a string condition.</p> <note> <p>The currently supported values for <code>FieldName</code> are <code>name</code>,&#x2028;&#x2028; <code>description</code>, <code>state</code>, <code>type</code>, <code>displayOrder</code>,&#x2028; and <code>resourceID</code>.</p> </note>" }, "StringCondition":{ "shape":"StringCondition", "documentation":"<p>A leaf node condition which can be used to specify a string condition.</p> <note> <p>The currently supported values for <code>FieldName</code> are <code>name</code>,&#x2028;&#x2028; <code>description</code>, <code>state</code>, <code>type</code>, <code>displayOrder</code>,&#x2028; and <code>resourceID</code>.</p> </note>" } }, "documentation":"<p>The search criteria to be used to return agent statuses.</p>" }, "AgentStatusSearchFilter":{ "type":"structure", "members":{ "AttributeFilter":{ "shape":"ControlPlaneAttributeFilter", "documentation":"<p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>. This accepts an <code>OR</code> of <code>AND</code> (List of List) input where: </p> <ul> <li> <p>The top level list specifies conditions that need to be applied with <code>OR</code> operator.</p> </li> <li> <p>The inner list specifies conditions that need to be applied with <code>AND</code> operator.</p> </li> </ul>" } }, "documentation":"<p>Filters to be applied to search results.</p>" }, "AgentStatusState":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "AgentStatusSummary":{ "type":"structure", "members":{ "Id":{ "shape":"AgentStatusId", "documentation":"<p>The identifier for an agent status.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the agent status.</p>" }, "Name":{ "shape":"AgentStatusName", "documentation":"<p>The name of the agent status.</p>" }, "Type":{ "shape":"AgentStatusType", "documentation":"<p>The type of the agent status.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when this resource was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The Amazon Web Services Region where this resource was last modified.</p>" } }, "documentation":"<p>Summary information for an agent status.</p>" }, "AgentStatusSummaryList":{ "type":"list", "member":{"shape":"AgentStatusSummary"} }, "AgentStatusType":{ "type":"string", "enum":[ "ROUTABLE", "CUSTOM", "OFFLINE" ] }, "AgentStatusTypes":{ "type":"list", "member":{"shape":"AgentStatusType"}, "max":3 }, "AgentUsername":{ "type":"string", "max":100, "min":1 }, "AgentsCriteria":{ "type":"structure", "members":{ "AgentIds":{ "shape":"AgentIds", "documentation":"<p>An object to specify a list of agents, by user ID.</p>" } }, "documentation":"<p>Can be used to define a list of preferred agents to target the contact to within the queue.&#x2028; Note that agents must have the queue in their routing profile in order to be offered the&#x2028; contact.</p>" }, "AgentsMinOneMaxHundred":{ "type":"list", "member":{"shape":"UserId"}, "max":100, "min":1 }, "AliasArn":{ "type":"string", "max":100, "min":1 }, "AllowedAccessControlTags":{ "type":"map", "key":{"shape":"SecurityProfilePolicyKey"}, "value":{"shape":"SecurityProfilePolicyValue"}, "max":4 }, "AllowedCapabilities":{ "type":"structure", "members":{ "Customer":{ "shape":"ParticipantCapabilities", "documentation":"<p>Information about the customer's video sharing capabilities.</p>" }, "Agent":{ "shape":"ParticipantCapabilities", "documentation":"<p>Information about the agent's video sharing capabilities.</p>" } }, "documentation":"<p>Information about the capabilities enabled for participants of the contact.</p>" }, "AllowedMonitorCapabilities":{ "type":"list", "member":{"shape":"MonitorCapability"}, "max":2 }, "AnalyticsDataAssociationResult":{ "type":"structure", "members":{ "DataSetId":{ "shape":"DataSetId", "documentation":"<p>The identifier of the dataset.</p>" }, "TargetAccountId":{ "shape":"AWSAccountId", "documentation":"<p>The identifier of the target account. </p>" }, "ResourceShareId":{ "shape":"String", "documentation":"<p>The Resource Access Manager share ID.</p>" }, "ResourceShareArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the Resource Access Manager share. </p>" }, "ResourceShareStatus":{ "shape":"String", "documentation":"<p>The Amazon Web Services Resource Access Manager status of association.</p>" } }, "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Information about associations that are successfully created: <code>DataSetId</code>, <code>TargetAccountId</code>, <code>ResourceShareId</code>, <code>ResourceShareArn</code>. </p>" }, "AnalyticsDataAssociationResults":{ "type":"list", "member":{"shape":"AnalyticsDataAssociationResult"} }, "AnalyticsDataSetsResult":{ "type":"structure", "members":{ "DataSetId":{ "shape":"DataSetId", "documentation":"<p>The identifier of the dataset.</p>" }, "DataSetName":{ "shape":"String", "documentation":"<p>The name of the dataset.</p>" } }, "documentation":"<p>Information about datasets that are available to associate with: <code>DataSetId</code>, <code>DataSetName</code>.</p>" }, "AnalyticsDataSetsResults":{ "type":"list", "member":{"shape":"AnalyticsDataSetsResult"} }, "AnswerMachineDetectionConfig":{ "type":"structure", "members":{ "EnableAnswerMachineDetection":{ "shape":"Boolean", "documentation":"<p>The flag to indicate if answer machine detection analysis needs to be performed for a voice call. If set to <code>true</code>, <code>TrafficType</code> must be set as <code>CAMPAIGN</code>. </p>" }, "AwaitAnswerMachinePrompt":{ "shape":"Boolean", "documentation":"<p>Wait for the answering machine prompt.</p>" } }, "documentation":"<p>Configuration of the answering machine detection.</p>" }, "AnsweringMachineDetectionStatus":{ "type":"string", "enum":[ "ANSWERED", "UNDETECTED", "ERROR", "HUMAN_ANSWERED", "SIT_TONE_DETECTED", "SIT_TONE_BUSY", "SIT_TONE_INVALID_NUMBER", "FAX_MACHINE_DETECTED", "VOICEMAIL_BEEP", "VOICEMAIL_NO_BEEP", "AMD_UNRESOLVED", "AMD_UNANSWERED", "AMD_ERROR", "AMD_NOT_APPLICABLE" ] }, "Application":{ "type":"structure", "members":{ "Namespace":{ "shape":"Namespace", "documentation":"<p>Namespace of the application that you want to give access to.</p>" }, "ApplicationPermissions":{ "shape":"ApplicationPermissions", "documentation":"<p>The permissions that the agent is granted on the application. Only the <code>ACCESS</code> permission is supported.</p>" } }, "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>A third-party application's metadata.</p>" }, "ApplicationPermissions":{ "type":"list", "member":{"shape":"Permission"}, "max":10, "min":1 }, "Applications":{ "type":"list", "member":{"shape":"Application"}, "max":10 }, "ApproximateTotalCount":{"type":"long"}, "ArtifactId":{ "type":"string", "max":256, "min":1 }, "ArtifactStatus":{ "type":"string", "enum":[ "APPROVED", "REJECTED", "IN_PROGRESS" ] }, "AssignContactCategoryActionDefinition":{ "type":"structure", "members":{}, "documentation":"<p>This action must be set if <code>TriggerEventSource</code> is one of the following values: <code>OnPostCallAnalysisAvailable</code> | <code>OnRealTimeCallAnalysisAvailable</code> | <code>OnRealTimeChatAnalysisAvailable</code> | <code>OnPostChatAnalysisAvailable</code>. Contact is categorized using the rule name.</p> <p> <code>RuleName</code> is used as <code>ContactCategory</code>.</p>" }, "AssignSlaActionDefinition":{ "type":"structure", "required":["SlaAssignmentType"], "members":{ "SlaAssignmentType":{ "shape":"SlaAssignmentType", "documentation":"<p>Type of SLA assignment.</p>" }, "CaseSlaConfiguration":{ "shape":"CaseSlaConfiguration", "documentation":"<p>The SLA configuration for Case SLA Assignment.</p>" } }, "documentation":"<p>The AssignSla action definition.</p>" }, "AssociateAnalyticsDataSetRequest":{ "type":"structure", "required":[ "InstanceId", "DataSetId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "DataSetId":{ "shape":"DataSetId", "documentation":"<p>The identifier of the dataset to associate with the target account.</p>" }, "TargetAccountId":{ "shape":"AWSAccountId", "documentation":"<p>The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.</p>" } } }, "AssociateAnalyticsDataSetResponse":{ "type":"structure", "members":{ "DataSetId":{ "shape":"DataSetId", "documentation":"<p>The identifier of the dataset that was associated.</p>" }, "TargetAccountId":{ "shape":"AWSAccountId", "documentation":"<p>The identifier of the target account. </p>" }, "ResourceShareId":{ "shape":"String", "documentation":"<p>The Resource Access Manager share ID that is generated.</p>" }, "ResourceShareArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the Resource Access Manager share. </p>" } } }, "AssociateApprovedOriginRequest":{ "type":"structure", "required":[ "InstanceId", "Origin" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Origin":{ "shape":"Origin", "documentation":"<p>The domain to add to your allow list.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true } } }, "AssociateBotRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "LexBot":{"shape":"LexBot"}, "LexV2Bot":{ "shape":"LexV2Bot", "documentation":"<p>The Amazon Lex V2 bot to associate with the instance.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true } } }, "AssociateDefaultVocabularyRequest":{ "type":"structure", "required":[ "InstanceId", "LanguageCode" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "LanguageCode":{ "shape":"VocabularyLanguageCode", "documentation":"<p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html\">What is Amazon Transcribe?</a> </p>", "location":"uri", "locationName":"LanguageCode" }, "VocabularyId":{ "shape":"VocabularyId", "documentation":"<p>The identifier of the custom vocabulary. If this is empty, the default is set to none.</p>" } } }, "AssociateDefaultVocabularyResponse":{ "type":"structure", "members":{} }, "AssociateFlowRequest":{ "type":"structure", "required":[ "InstanceId", "ResourceId", "FlowId", "ResourceType" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ResourceId":{ "shape":"ARN", "documentation":"<p>The identifier of the resource.</p> <ul> <li> <p>Amazon Web Services End User Messaging SMS phone number ARN when using <code>SMS_PHONE_NUMBER</code> </p> </li> <li> <p>Amazon Web Services End User Messaging Social phone number ARN when using <code>WHATSAPP_MESSAGING_PHONE_NUMBER</code> </p> </li> </ul>" }, "FlowId":{ "shape":"ARN", "documentation":"<p>The identifier of the flow.</p>" }, "ResourceType":{ "shape":"FlowAssociationResourceType", "documentation":"<p>A valid resource type.</p>" } } }, "AssociateFlowResponse":{ "type":"structure", "members":{} }, "AssociateInstanceStorageConfigRequest":{ "type":"structure", "required":[ "InstanceId", "ResourceType", "StorageConfig" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ResourceType":{ "shape":"InstanceStorageResourceType", "documentation":"<p>A valid resource type. To <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/enable-contact-analysis-segment-streams.html\">enable streaming for real-time analysis of contacts</a>, use the following types:</p> <ul> <li> <p>For chat contacts, use <code>REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS</code>.</p> </li> <li> <p>For voice contacts, use <code>REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS</code>.</p> </li> </ul> <note> <p> <code>REAL_TIME_CONTACT_ANALYSIS_SEGMENTS</code> is deprecated, but it is still supported and will apply only to VOICE channel contacts. Use <code>REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS</code> for voice contacts moving forward.</p> <p>If you have previously associated a stream with <code>REAL_TIME_CONTACT_ANALYSIS_SEGMENTS</code>, no action is needed to update the stream to <code>REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS</code>.</p> </note>" }, "StorageConfig":{ "shape":"InstanceStorageConfig", "documentation":"<p>A valid storage type.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true } } }, "AssociateInstanceStorageConfigResponse":{ "type":"structure", "members":{ "AssociationId":{ "shape":"AssociationId", "documentation":"<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>" } } }, "AssociateLambdaFunctionRequest":{ "type":"structure", "required":[ "InstanceId", "FunctionArn" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "FunctionArn":{ "shape":"FunctionArn", "documentation":"<p>The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is 140.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true } } }, "AssociateLexBotRequest":{ "type":"structure", "required":[ "InstanceId", "LexBot" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "LexBot":{ "shape":"LexBot", "documentation":"<p>The Amazon Lex bot to associate with the instance.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true } } }, "AssociatePhoneNumberContactFlowRequest":{ "type":"structure", "required":[ "PhoneNumberId", "InstanceId", "ContactFlowId" ], "members":{ "PhoneNumberId":{ "shape":"PhoneNumberId", "documentation":"<p>A unique identifier for the phone number.</p>", "location":"uri", "locationName":"PhoneNumberId" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "ContactFlowId":{ "shape":"ContactFlowId", "documentation":"<p>The identifier of the flow.</p>" } } }, "AssociateQueueQuickConnectsRequest":{ "type":"structure", "required":[ "InstanceId", "QueueId", "QuickConnectIds" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "QueueId":{ "shape":"QueueId", "documentation":"<p>The identifier for the queue.</p>", "location":"uri", "locationName":"QueueId" }, "QuickConnectIds":{ "shape":"QuickConnectsList", "documentation":"<p>The quick connects to associate with this queue.</p>" } } }, "AssociateRoutingProfileQueuesRequest":{ "type":"structure", "required":[ "InstanceId", "RoutingProfileId", "QueueConfigs" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "RoutingProfileId":{ "shape":"RoutingProfileId", "documentation":"<p>The identifier of the routing profile.</p>", "location":"uri", "locationName":"RoutingProfileId" }, "QueueConfigs":{ "shape":"RoutingProfileQueueConfigList", "documentation":"<p>The queues to associate with this routing profile.</p>" } } }, "AssociateSecurityKeyRequest":{ "type":"structure", "required":[ "InstanceId", "Key" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Key":{ "shape":"PEM", "documentation":"<p>A valid security key in PEM format as a String.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true } } }, "AssociateSecurityKeyResponse":{ "type":"structure", "members":{ "AssociationId":{ "shape":"AssociationId", "documentation":"<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>" } } }, "AssociateTrafficDistributionGroupUserRequest":{ "type":"structure", "required":[ "TrafficDistributionGroupId", "UserId", "InstanceId" ], "members":{ "TrafficDistributionGroupId":{ "shape":"TrafficDistributionGroupIdOrArn", "documentation":"<p>The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group.</p>", "location":"uri", "locationName":"TrafficDistributionGroupId" }, "UserId":{ "shape":"UserId", "documentation":"<p>The identifier of the user account. This can be the ID or the ARN of the user. </p>" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" } } }, "AssociateTrafficDistributionGroupUserResponse":{ "type":"structure", "members":{} }, "AssociateUserProficienciesRequest":{ "type":"structure", "required":[ "InstanceId", "UserId", "UserProficiencies" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN of the instance).</p>", "location":"uri", "locationName":"InstanceId" }, "UserId":{ "shape":"UserId", "documentation":"<p>The identifier of the user account.</p>", "location":"uri", "locationName":"UserId" }, "UserProficiencies":{ "shape":"UserProficiencyList", "documentation":"<p>The proficiencies to associate with the user.</p>" } } }, "AssociatedContactSummary":{ "type":"structure", "members":{ "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact in this instance of Amazon Connect. </p>" }, "ContactArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the contact</p>" }, "InitiationTimestamp":{ "shape":"Timestamp", "documentation":"<p>The date and time this contact was initiated, in UTC time.</p>" }, "DisconnectTimestamp":{ "shape":"Timestamp", "documentation":"<p>The date and time that the customer endpoint disconnected from the current contact, in UTC time. In transfer scenarios, the DisconnectTimestamp of the previous contact indicates the date and time when that contact ended.</p>" }, "InitialContactId":{ "shape":"ContactId", "documentation":"<p>If this contact is related to other contacts, this is the ID of the initial contact.</p>" }, "PreviousContactId":{ "shape":"ContactId", "documentation":"<p>If this contact is not the first contact, this is the ID of the previous contact.</p>" }, "RelatedContactId":{ "shape":"ContactId", "documentation":"<p>The contactId that is related to this contact.</p>" }, "InitiationMethod":{ "shape":"ContactInitiationMethod", "documentation":"<p>Indicates how the contact was initiated.</p>" }, "Channel":{ "shape":"Channel", "documentation":"<p>How the contact reached your contact center.</p>" } }, "documentation":"<p>Contact summary of a contact in contact tree associated with unique identifier.</p>" }, "AssociatedContactSummaryList":{ "type":"list", "member":{"shape":"AssociatedContactSummary"} }, "AssociatedQueueIdList":{ "type":"list", "member":{"shape":"QueueId"} }, "AssociationId":{ "type":"string", "max":100, "min":1 }, "AttachedFile":{ "type":"structure", "required":[ "CreationTime", "FileArn", "FileId", "FileName", "FileSizeInBytes", "FileStatus" ], "members":{ "CreationTime":{ "shape":"ISO8601Datetime", "documentation":"<p>The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: <code>yyyy-MM-ddThh:mm:ss.SSSZ</code>. For example, <code>2024-05-03T02:41:28.172Z</code>.</p>" }, "FileArn":{ "shape":"ARN", "documentation":"<p>The unique identifier of the attached file resource (ARN).</p>" }, "FileId":{ "shape":"FileId", "documentation":"<p>The unique identifier of the attached file resource.</p>" }, "FileName":{ "shape":"FileName", "documentation":"<p>A case-sensitive name of the attached file being uploaded.</p>" }, "FileSizeInBytes":{ "shape":"FileSizeInBytes", "documentation":"<p>The size of the attached file in bytes.</p>", "box":true }, "FileStatus":{ "shape":"FileStatusType", "documentation":"<p>The current status of the attached file.</p>" }, "CreatedBy":{ "shape":"CreatedByInfo", "documentation":"<p>Represents the identity that created the file.</p>" }, "FileUseCaseType":{ "shape":"FileUseCaseType", "documentation":"<p>The use case for the file.</p>" }, "AssociatedResourceArn":{ "shape":"ARN", "documentation":"<p>The resource to which the attached file is (being) uploaded to. <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html\">Cases</a> are the only current supported resource.</p> <note> <p>This value must be a valid ARN.</p> </note>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, <code>{ \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }</code>.</p>" } }, "documentation":"<p>Information about the attached file.</p>" }, "AttachedFileError":{ "type":"structure", "members":{ "ErrorCode":{ "shape":"ErrorCode", "documentation":"<p> Status code describing the failure. </p>" }, "ErrorMessage":{ "shape":"ErrorMessage", "documentation":"<p>Why the attached file couldn't be retrieved. </p>" }, "FileId":{ "shape":"FileId", "documentation":"<p>The unique identifier of the attached file resource.</p>" } }, "documentation":"<p>Error describing a failure to retrieve attached file metadata through BatchGetAttachedFileMetadata action.</p>" }, "AttachedFileErrorsList":{ "type":"list", "member":{"shape":"AttachedFileError"} }, "AttachedFileInvalidRequestExceptionReason":{ "type":"string", "enum":[ "INVALID_FILE_SIZE", "INVALID_FILE_TYPE", "INVALID_FILE_NAME" ] }, "AttachedFileServiceQuotaExceededExceptionReason":{ "type":"string", "enum":[ "TOTAL_FILE_SIZE_EXCEEDED", "TOTAL_FILE_COUNT_EXCEEDED" ] }, "AttachedFilesList":{ "type":"list", "member":{"shape":"AttachedFile"} }, "AttachmentName":{ "type":"string", "max":256, "min":1 }, "AttachmentReference":{ "type":"structure", "members":{ "Name":{ "shape":"ReferenceKey", "documentation":"<p>Identifier of the attachment reference.</p>" }, "Value":{ "shape":"ReferenceValue", "documentation":"<p>The location path of the attachment reference.</p>" }, "Status":{ "shape":"ReferenceStatus", "documentation":"<p>Status of the attachment reference type.</p>" }, "Arn":{ "shape":"ReferenceArn", "documentation":"<p>The Amazon Resource Name (ARN) of the attachment reference.</p>" } }, "documentation":"<p>Information about a reference when the <code>referenceType</code> is <code>ATTACHMENT</code>. Otherwise, null.</p>" }, "Attendee":{ "type":"structure", "members":{ "AttendeeId":{ "shape":"AttendeeId", "documentation":"<p>The Amazon Chime SDK attendee ID.</p>" }, "JoinToken":{ "shape":"JoinToken", "documentation":"<p>The join token used by the Amazon Chime SDK attendee.</p>" } }, "documentation":"<p>The attendee information, including attendee ID and join token.</p>" }, "AttendeeId":{"type":"string"}, "Attribute":{ "type":"structure", "members":{ "AttributeType":{ "shape":"InstanceAttributeType", "documentation":"<p>The type of attribute.</p>" }, "Value":{ "shape":"InstanceAttributeValue", "documentation":"<p>The value of the attribute.</p>" } }, "documentation":"<p>A toggle for an individual feature at the instance level.</p>" }, "AttributeAndCondition":{ "type":"structure", "members":{ "TagConditions":{ "shape":"TagAndConditionList", "documentation":"<p>A leaf node condition which can be used to specify a tag condition.</p>" }, "HierarchyGroupCondition":{"shape":"HierarchyGroupCondition"} }, "documentation":"<p>A list of conditions which would be applied together with an <code>AND</code> condition.</p>" }, "AttributeCondition":{ "type":"structure", "members":{ "Name":{ "shape":"PredefinedAttributeName", "documentation":"<p>The name of predefined attribute.</p>" }, "Value":{ "shape":"ProficiencyValue", "documentation":"<p>The value of predefined attribute.</p>" }, "ProficiencyLevel":{ "shape":"NullableProficiencyLevel", "documentation":"<p>The proficiency level of the condition.</p>" }, "Range":{ "shape":"Range", "documentation":"<p>An Object to define the minimum and maximum proficiency levels.</p>" }, "MatchCriteria":{ "shape":"MatchCriteria", "documentation":"<p>An object to define <code>AgentsCriteria</code>.</p>" }, "ComparisonOperator":{ "shape":"ComparisonOperator", "documentation":"<p>The operator of the condition.</p>" } }, "documentation":"<p>An object to specify the predefined attribute condition.</p>" }, "AttributeName":{ "type":"string", "max":32767, "min":1 }, "AttributeOrConditionList":{ "type":"list", "member":{"shape":"AttributeAndCondition"} }, "AttributeValue":{ "type":"string", "max":32767, "min":0 }, "Attributes":{ "type":"map", "key":{"shape":"AttributeName"}, "value":{"shape":"AttributeValue"} }, "AttributesList":{ "type":"list", "member":{"shape":"Attribute"} }, "AudioFeatures":{ "type":"structure", "members":{ "EchoReduction":{ "shape":"MeetingFeatureStatus", "documentation":"<p>Makes echo reduction available to clients who connect to the meeting.</p>" } }, "documentation":"<p>Has audio-specific configurations as the operating parameter for Echo Reduction.</p>" }, "AudioQualityMetricsInfo":{ "type":"structure", "members":{ "QualityScore":{ "shape":"AudioQualityScore", "documentation":"<p>Number measuring the estimated quality of the media connection.</p>" }, "PotentialQualityIssues":{ "shape":"PotentialAudioQualityIssues", "documentation":"<p>List of potential issues causing degradation of quality on a media connection. If the service did not detect any potential quality issues the list is empty.</p> <p>Valid values: <code>HighPacketLoss</code> | <code>HighRoundTripTime</code> | <code>HighJitterBuffer</code> </p>" } }, "documentation":"<p>Contains information for score and potential quality issues for Audio</p>" }, "AudioQualityScore":{"type":"float"}, "AuthenticationError":{ "type":"string", "max":2048, "min":1, "pattern":"^[\\x20-\\x21\\x23-\\x5B\\x5D-\\x7E]*$", "sensitive":true }, "AuthenticationErrorDescription":{ "type":"string", "max":2048, "min":1, "pattern":"^[\\x20-\\x21\\x23-\\x5B\\x5D-\\x7E]*$", "sensitive":true }, "AuthenticationProfile":{ "type":"structure", "members":{ "Id":{ "shape":"AuthenticationProfileId", "documentation":"<p>A unique identifier for the authentication profile. </p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the authentication profile.</p>" }, "Name":{ "shape":"AuthenticationProfileName", "documentation":"<p>The name for the authentication profile.</p>" }, "Description":{ "shape":"AuthenticationProfileDescription", "documentation":"<p>The description for the authentication profile.</p>" }, "AllowedIps":{ "shape":"IpCidrList", "documentation":"<p>A list of IP address range strings that are allowed to access the Amazon Connect instance. For more information about how to configure IP addresses, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-ip-based-ac\">Configure IP address based access control</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "BlockedIps":{ "shape":"IpCidrList", "documentation":"<p>A list of IP address range strings that are blocked from accessing the Amazon Connect instance. For more information about how to configure IP addresses, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-ip-based-ac\">Configure IP address based access control</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "IsDefault":{ "shape":"Boolean", "documentation":"<p>Shows whether the authentication profile is the default authentication profile for the Amazon Connect instance. The default authentication profile applies to all agents in an Amazon Connect instance, unless overridden by another authentication profile.</p>" }, "CreatedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when the authentication profile was created.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when the authentication profile was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The Amazon Web Services Region where the authentication profile was last modified.</p>" }, "PeriodicSessionDuration":{ "shape":"AccessTokenDuration", "documentation":"<p>The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This value determines the maximum possible time before an agent is authenticated. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts\">Configure the session duration</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "MaxSessionDuration":{ "shape":"RefreshTokenDuration", "documentation":"<p>The long lived session duration for users logged in to Amazon Connect, in minutes. After this time period, users must log in again. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts\">Configure the session duration</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" } }, "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web ServicesSupport.</p> <p>Information about an authentication profile. An authentication profile is a resource that stores the authentication settings for users in your contact center. You use authentication profiles to set up IP address range restrictions and session timeouts. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html\">Set IP address restrictions or session timeouts</a>. </p>" }, "AuthenticationProfileDescription":{ "type":"string", "max":250, "min":1 }, "AuthenticationProfileId":{ "type":"string", "max":100, "min":1 }, "AuthenticationProfileName":{ "type":"string", "max":128, "min":1 }, "AuthenticationProfileSummary":{ "type":"structure", "members":{ "Id":{ "shape":"AuthenticationProfileId", "documentation":"<p>The unique identifier of the authentication profile.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the authentication profile summary.</p>" }, "Name":{ "shape":"AuthenticationProfileName", "documentation":"<p>The name of the authentication profile summary.</p>" }, "IsDefault":{ "shape":"Boolean", "documentation":"<p>Shows whether the authentication profile is the default authentication profile for the Amazon Connect instance. The default authentication profile applies to all agents in an Amazon Connect instance, unless overridden by another authentication profile.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when the authentication profile summary was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The Amazon Web Services Region when the authentication profile summary was last modified.</p>" } }, "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web ServicesSupport.</p> <p>A summary of a given authentication profile.</p>" }, "AuthenticationProfileSummaryList":{ "type":"list", "member":{"shape":"AuthenticationProfileSummary"} }, "AuthorizationCode":{ "type":"string", "max":2048, "min":1, "sensitive":true }, "AutoAccept":{"type":"boolean"}, "AvailableNumberSummary":{ "type":"structure", "members":{ "PhoneNumber":{ "shape":"PhoneNumber", "documentation":"<p>The phone number. Phone numbers are formatted <code>[+] [country code] [subscriber number including area code]</code>.</p>" }, "PhoneNumberCountryCode":{ "shape":"PhoneNumberCountryCode", "documentation":"<p>The ISO country code.</p>" }, "PhoneNumberType":{ "shape":"PhoneNumberType", "documentation":"<p>The type of phone number.</p>" } }, "documentation":"<p>Information about available phone numbers.</p>" }, "AvailableNumbersList":{ "type":"list", "member":{"shape":"AvailableNumberSummary"} }, "AwsRegion":{ "type":"string", "max":31, "min":8, "pattern":"[a-z]{2}(-[a-z]+){1,2}(-[0-9])?" }, "BatchAssociateAnalyticsDataSetRequest":{ "type":"structure", "required":[ "InstanceId", "DataSetIds" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "DataSetIds":{ "shape":"DataSetIds", "documentation":"<p>An array of dataset identifiers to associate.</p>" }, "TargetAccountId":{ "shape":"AWSAccountId", "documentation":"<p>The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.</p>" } } }, "BatchAssociateAnalyticsDataSetResponse":{ "type":"structure", "members":{ "Created":{ "shape":"AnalyticsDataAssociationResults", "documentation":"<p>Information about associations that are successfully created: <code>DataSetId</code>, <code>TargetAccountId</code>, <code>ResourceShareId</code>, <code>ResourceShareArn</code>. </p>" }, "Errors":{ "shape":"ErrorResults", "documentation":"<p>A list of errors for datasets that aren't successfully associated with the target account.</p>" } } }, "BatchDisassociateAnalyticsDataSetRequest":{ "type":"structure", "required":[ "InstanceId", "DataSetIds" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "DataSetIds":{ "shape":"DataSetIds", "documentation":"<p>An array of associated dataset identifiers to remove.</p>" }, "TargetAccountId":{ "shape":"AWSAccountId", "documentation":"<p>The identifier of the target account. Use to disassociate a dataset from a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.</p>" } } }, "BatchDisassociateAnalyticsDataSetResponse":{ "type":"structure", "members":{ "Deleted":{ "shape":"DataSetIds", "documentation":"<p>An array of successfully disassociated dataset identifiers.</p>" }, "Errors":{ "shape":"ErrorResults", "documentation":"<p>A list of errors for any datasets not successfully removed.</p>" } } }, "BatchGetAttachedFileMetadataRequest":{ "type":"structure", "required":[ "FileIds", "InstanceId", "AssociatedResourceArn" ], "members":{ "FileIds":{ "shape":"FileIdList", "documentation":"<p>The unique identifiers of the attached file resource.</p>" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The unique identifier of the Connect instance.</p>", "location":"uri", "locationName":"InstanceId" }, "AssociatedResourceArn":{ "shape":"ARN", "documentation":"<p>The resource to which the attached file is (being) uploaded to. The supported resources are <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/cases.html\">Cases</a> and <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html\">Email</a>.</p> <note> <p>This value must be a valid ARN.</p> </note>", "location":"querystring", "locationName":"associatedResourceArn" } } }, "BatchGetAttachedFileMetadataResponse":{ "type":"structure", "members":{ "Files":{ "shape":"AttachedFilesList", "documentation":"<p>List of attached files that were successfully retrieved. </p>" }, "Errors":{ "shape":"AttachedFileErrorsList", "documentation":"<p>List of errors of attached files that could not be retrieved. </p>" } } }, "BatchGetFlowAssociationRequest":{ "type":"structure", "required":[ "InstanceId", "ResourceIds" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ResourceIds":{ "shape":"resourceArnListMaxLimit100", "documentation":"<p>A list of resource identifiers to retrieve flow associations.</p> <ul> <li> <p>Amazon Web Services End User Messaging SMS phone number ARN when using <code>SMS_PHONE_NUMBER</code> </p> </li> <li> <p>Amazon Web Services End User Messaging Social phone number ARN when using <code>WHATSAPP_MESSAGING_PHONE_NUMBER</code> </p> </li> </ul>" }, "ResourceType":{ "shape":"ListFlowAssociationResourceType", "documentation":"<p>The type of resource association.</p>" } } }, "BatchGetFlowAssociationResponse":{ "type":"structure", "members":{ "FlowAssociationSummaryList":{ "shape":"FlowAssociationSummaryList", "documentation":"<p>Information about flow associations.</p>" } } }, "BatchPutContactRequest":{ "type":"structure", "required":[ "InstanceId", "ContactDataRequestList" ], "members":{ "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ContactDataRequestList":{ "shape":"ContactDataRequestList", "documentation":"<p>List of individual contact requests.</p>" } } }, "BatchPutContactResponse":{ "type":"structure", "members":{ "SuccessfulRequestList":{ "shape":"SuccessfulRequestList", "documentation":"<p>List of requests for which contact was successfully created.</p>" }, "FailedRequestList":{ "shape":"FailedRequestList", "documentation":"<p>List of requests for which contact creation failed.</p>" } } }, "BehaviorType":{ "type":"string", "enum":[ "ROUTE_CURRENT_CHANNEL_ONLY", "ROUTE_ANY_CHANNEL" ] }, "Body":{ "type":"string", "max":5242880, "min":1, "sensitive":true }, "Boolean":{"type":"boolean"}, "BotName":{ "type":"string", "max":50 }, "BoxedBoolean":{"type":"boolean"}, "BucketName":{ "type":"string", "max":128, "min":1 }, "Campaign":{ "type":"structure", "members":{ "CampaignId":{ "shape":"CampaignId", "documentation":"<p>A unique identifier for a campaign.</p>" } }, "documentation":"<p>Information associated with a campaign.</p>" }, "CampaignId":{ "type":"string", "max":100, "min":1 }, "CaseSlaConfiguration":{ "type":"structure", "required":[ "Name", "Type", "TargetSlaMinutes" ], "members":{ "Name":{ "shape":"SlaName", "documentation":"<p>Name of an SLA.</p>" }, "Type":{ "shape":"SlaType", "documentation":"<p>Type of SLA for Case SlaAssignmentType.</p>" }, "FieldId":{ "shape":"FieldValueId", "documentation":"<p>Unique identifier of a Case field.</p>" }, "TargetFieldValues":{ "shape":"SlaFieldValueUnionList", "documentation":"<p>Represents a list of target field values for the fieldId specified in CaseSlaConfiguration. The SLA is considered met if any one of these target field values matches the actual field value.</p>" }, "TargetSlaMinutes":{ "shape":"TargetSlaMinutes", "documentation":"<p>Target duration in minutes within which an SLA should be completed.</p>" } }, "documentation":"<p>The SLA configuration for Case SlaAssignmentType.</p>" }, "Channel":{ "type":"string", "enum":[ "VOICE", "CHAT", "TASK", "EMAIL" ] }, "ChannelList":{ "type":"list", "member":{"shape":"Channel"} }, "ChannelToCountMap":{ "type":"map", "key":{"shape":"Channel"}, "value":{"shape":"IntegerCount"} }, "Channels":{ "type":"list", "member":{"shape":"Channel"}, "max":4 }, "ChatContactMetrics":{ "type":"structure", "members":{ "MultiParty":{ "shape":"NullableBoolean", "documentation":"<p>A boolean flag indicating whether multiparty chat or supervisor barge were enabled on this contact.</p>" }, "TotalMessages":{ "shape":"Count", "documentation":"<p>The number of chat messages on the contact.</p>" }, "TotalBotMessages":{ "shape":"Count", "documentation":"<p>The total number of bot and automated messages on a chat contact.</p>" }, "TotalBotMessageLengthInChars":{ "shape":"Count", "documentation":"<p>The total number of characters from bot and automated messages on a chat contact.</p>" }, "ConversationCloseTimeInMillis":{ "shape":"DurationMillis", "documentation":"<p>The time it took for a contact to end after the last customer message.</p>" }, "ConversationTurnCount":{ "shape":"Count", "documentation":"<p>The number of conversation turns in a chat contact, which represents the back-and-forth exchanges between customer and other participants.</p>" }, "AgentFirstResponseTimestamp":{ "shape":"timestamp", "documentation":"<p>The agent first response timestamp for a chat contact.</p>" }, "AgentFirstResponseTimeInMillis":{ "shape":"DurationMillis", "documentation":"<p>The time for an agent to respond after obtaining a chat contact.</p>" } }, "documentation":"<p>Information about the overall participant interactions at the contact level.</p>" }, "ChatContent":{ "type":"string", "max":16384, "min":1 }, "ChatContentType":{ "type":"string", "max":100, "min":1 }, "ChatDurationInMinutes":{ "type":"integer", "max":10080, "min":60 }, "ChatEvent":{ "type":"structure", "required":["Type"], "members":{ "Type":{ "shape":"ChatEventType", "documentation":"<p>Type of chat integration event. </p>" }, "ContentType":{ "shape":"ChatContentType", "documentation":"<p>Type of content. This is required when <code>Type</code> is <code>MESSAGE</code> or <code>EVENT</code>. </p> <ul> <li> <p>For allowed message content types, see the <code>ContentType</code> parameter in the <a href=\"https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendMessage.html\">SendMessage</a> topic in the <i>Amazon Connect Participant Service API Reference</i>.</p> </li> <li> <p>For allowed event content types, see the <code>ContentType</code> parameter in the <a href=\"https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendEvent.html\">SendEvent</a> topic in the <i>Amazon Connect Participant Service API Reference</i>. </p> </li> </ul>" }, "Content":{ "shape":"ChatContent", "documentation":"<p>Content of the message or event. This is required when <code>Type</code> is <code>MESSAGE</code> and for certain <code>ContentTypes</code> when <code>Type</code> is <code>EVENT</code>.</p> <ul> <li> <p>For allowed message content, see the <code>Content</code> parameter in the <a href=\"https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendMessage.html\">SendMessage</a> topic in the <i>Amazon Connect Participant Service API Reference</i>.</p> </li> <li> <p>For allowed event content, see the <code>Content</code> parameter in the <a href=\"https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendEvent.html\">SendEvent</a> topic in the <i>Amazon Connect Participant Service API Reference</i>. </p> </li> </ul>" } }, "documentation":"<p>Chat integration event containing payload to perform different chat actions such as:</p> <ul> <li> <p>Sending a chat message</p> </li> <li> <p>Sending a chat event, such as typing</p> </li> <li> <p>Disconnecting from a chat</p> </li> </ul>" }, "ChatEventType":{ "type":"string", "enum":[ "DISCONNECT", "MESSAGE", "EVENT" ] }, "ChatMessage":{ "type":"structure", "required":[ "ContentType", "Content" ], "members":{ "ContentType":{ "shape":"ChatContentType", "documentation":"<p>The type of the content. Supported types are <code>text/plain</code>, <code>text/markdown</code>, <code>application/json</code>, and <code>application/vnd.amazonaws.connect.message.interactive.response</code>.</p>" }, "Content":{ "shape":"ChatContent", "documentation":"<p>The content of the chat message. </p> <ul> <li> <p>For <code>text/plain</code> and <code>text/markdown</code>, the Length Constraints are Minimum of 1, Maximum of 1024. </p> </li> <li> <p>For <code>application/json</code>, the Length Constraints are Minimum of 1, Maximum of 12000. </p> </li> <li> <p>For <code>application/vnd.amazonaws.connect.message.interactive.response</code>, the Length Constraints are Minimum of 1, Maximum of 12288.</p> </li> </ul>" } }, "documentation":"<p>A chat message.</p>" }, "ChatMetrics":{ "type":"structure", "members":{ "ChatContactMetrics":{ "shape":"ChatContactMetrics", "documentation":"<p>Information about the overall participant interactions at the contact level.</p>" }, "AgentMetrics":{ "shape":"ParticipantMetrics", "documentation":"<p>Information about agent interactions in a contact.</p>" }, "CustomerMetrics":{ "shape":"ParticipantMetrics", "documentation":"<p>Information about customer interactions in a contact.</p>" } }, "documentation":"<p>Information about how agent, bot, and customer interact in a chat contact.</p>" }, "ChatParticipantRoleConfig":{ "type":"structure", "required":["ParticipantTimerConfigList"], "members":{ "ParticipantTimerConfigList":{ "shape":"ParticipantTimerConfigList", "documentation":"<p>A list of participant timers. You can specify any unique combination of role and timer type. Duplicate entries error out the request with a 400.</p>" } }, "documentation":"<p>Configuration information for the chat participant role.</p>" }, "ChatStreamingConfiguration":{ "type":"structure", "required":["StreamingEndpointArn"], "members":{ "StreamingEndpointArn":{ "shape":"ChatStreamingEndpointARN", "documentation":"<p>The Amazon Resource Name (ARN) of the standard Amazon SNS topic. The Amazon Resource Name (ARN) of the streaming endpoint that is used to publish real-time message streaming for chat conversations.</p>" } }, "documentation":"<p>The streaming configuration, such as the Amazon SNS streaming endpoint.</p>" }, "ChatStreamingEndpointARN":{ "type":"string", "max":350, "min":1 }, "ClaimPhoneNumberRequest":{ "type":"structure", "required":["PhoneNumber"], "members":{ "TargetArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance that phone numbers are claimed to. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>" }, "PhoneNumber":{ "shape":"PhoneNumber", "documentation":"<p>The phone number you want to claim. Phone numbers are formatted <code>[+] [country code] [subscriber number including area code]</code>.</p>" }, "PhoneNumberDescription":{ "shape":"PhoneNumberDescription", "documentation":"<p>The description of the phone number.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p> <p>Pattern: <code>^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$</code> </p>", "idempotencyToken":true } } }, "ClaimPhoneNumberResponse":{ "type":"structure", "members":{ "PhoneNumberId":{ "shape":"PhoneNumberId", "documentation":"<p>A unique identifier for the phone number.</p>" }, "PhoneNumberArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the phone number.</p>" } } }, "ClaimedPhoneNumberSummary":{ "type":"structure", "members":{ "PhoneNumberId":{ "shape":"PhoneNumberId", "documentation":"<p>A unique identifier for the phone number.</p>" }, "PhoneNumberArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the phone number.</p>" }, "PhoneNumber":{ "shape":"PhoneNumber", "documentation":"<p>The phone number. Phone numbers are formatted <code>[+] [country code] [subscriber number including area code]</code>.</p>" }, "PhoneNumberCountryCode":{ "shape":"PhoneNumberCountryCode", "documentation":"<p>The ISO country code.</p>" }, "PhoneNumberType":{ "shape":"PhoneNumberType", "documentation":"<p>The type of phone number.</p>" }, "PhoneNumberDescription":{ "shape":"PhoneNumberDescription", "documentation":"<p>The description of the phone number.</p>" }, "TargetArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.</p>" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance that phone numbers are claimed to. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" }, "PhoneNumberStatus":{ "shape":"PhoneNumberStatus", "documentation":"<p>The status of the phone number.</p> <ul> <li> <p> <code>CLAIMED</code> means the previous <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html\">ClaimPhoneNumber</a> or <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html\">UpdatePhoneNumber</a> operation succeeded.</p> </li> <li> <p> <code>IN_PROGRESS</code> means a <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html\">ClaimPhoneNumber</a>, <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html\">UpdatePhoneNumber</a>, or <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumberMetadata.html\">UpdatePhoneNumberMetadata</a> operation is still in progress and has not yet completed. You can call <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html\">DescribePhoneNumber</a> at a later time to verify if the previous operation has completed.</p> </li> <li> <p> <code>FAILED</code> indicates that the previous <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html\">ClaimPhoneNumber</a> or <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html\">UpdatePhoneNumber</a> operation has failed. It will include a message indicating the failure reason. A common reason for a failure may be that the <code>TargetArn</code> value you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received a <code>FAILED</code> status from a <code>ClaimPhoneNumber</code> API call, you have one day to retry claiming the phone number before the number is released back to the inventory for other customers to claim.</p> </li> </ul> <note> <p>You will not be billed for the phone number during the 1-day period if number claiming fails. </p> </note>" }, "SourcePhoneNumberArn":{ "shape":"ARN", "documentation":"<p>The claimed phone number ARN that was previously imported from the external service, such as Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it looks like the ARN of the phone number that was imported from Amazon Web Services End User Messaging.</p>" } }, "documentation":"<p>Information about a phone number that has been claimed to your Amazon Connect instance or traffic distribution group.</p>" }, "ClientToken":{ "type":"string", "max":500 }, "CommonAttributeAndCondition":{ "type":"structure", "members":{ "TagConditions":{ "shape":"TagAndConditionList", "documentation":"<p>A leaf node condition which can be used to specify a tag condition.</p>" } }, "documentation":"<p>A list of conditions which would be applied together with an <code>AND</code> condition.</p>" }, "CommonAttributeOrConditionList":{ "type":"list", "member":{"shape":"CommonAttributeAndCondition"} }, "CommonHumanReadableDescription":{ "type":"string", "pattern":"^[\\P{C}\\r\\n\\t]{1,250}$" }, "CommonHumanReadableName":{ "type":"string", "pattern":"^[\\P{C}\\r\\n\\t]{1,127}$" }, "CommonNameLength127":{ "type":"string", "max":127, "min":1 }, "Comparison":{ "type":"string", "enum":["LT"] }, "ComparisonOperator":{ "type":"string", "max":127, "min":1 }, "CompleteAttachedFileUploadRequest":{ "type":"structure", "required":[ "InstanceId", "FileId", "AssociatedResourceArn" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The unique identifier of the Amazon Connect instance.</p>", "location":"uri", "locationName":"InstanceId" }, "FileId":{ "shape":"FileId", "documentation":"<p>The unique identifier of the attached file resource.</p>", "location":"uri", "locationName":"FileId" }, "AssociatedResourceArn":{ "shape":"ARN", "documentation":"<p>The resource to which the attached file is (being) uploaded to. The supported resources are <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/cases.html\">Cases</a> and <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html\">Email</a>.</p> <note> <p>This value must be a valid ARN.</p> </note>", "location":"querystring", "locationName":"associatedResourceArn" } }, "documentation":"Request to CompleteAttachedFileUpload API" }, "CompleteAttachedFileUploadResponse":{ "type":"structure", "members":{}, "documentation":"Response from CompleteAttachedFileUpload API" }, "Concurrency":{ "type":"integer", "max":10, "min":1 }, "Condition":{ "type":"structure", "members":{ "StringCondition":{ "shape":"StringCondition", "documentation":"<p>A leaf node condition which can be used to specify a string condition.</p> <note> <p>The currently supported values for <code>FieldName</code> are <code>name</code> and&#x2028; <code>value</code>.</p> </note>" }, "NumberCondition":{ "shape":"NumberCondition", "documentation":"<p>A leaf node condition which can be used to specify a numeric condition.</p>" } }, "documentation":"<p>A leaf node condition which can be used to specify a ProficiencyName, ProficiencyValue and ProficiencyLimit.</p>" }, "ConditionalOperationFailedException":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"<p>Request processing failed because dependent condition failed.</p>", "error":{"httpStatusCode":409}, "exception":true }, "Conditions":{ "type":"list", "member":{"shape":"Condition"} }, "ConflictException":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"<p>Operation cannot be performed at this time as there is a conflict with another operation or contact state.</p>", "error":{"httpStatusCode":409}, "exception":true }, "ConnectionData":{ "type":"structure", "members":{ "Attendee":{ "shape":"Attendee", "documentation":"<p>The attendee information, including attendee ID and join token.</p>" }, "Meeting":{ "shape":"Meeting", "documentation":"<p>A meeting created using the Amazon Chime SDK.</p>" } }, "documentation":"<p>Information required to join the call.</p>" }, "Contact":{ "type":"structure", "members":{ "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the contact.</p>" }, "Id":{ "shape":"ContactId", "documentation":"<p>The identifier for the contact.</p>" }, "InitialContactId":{ "shape":"ContactId", "documentation":"<p>If this contact is related to other contacts, this is the ID of the initial contact.</p>" }, "PreviousContactId":{ "shape":"ContactId", "documentation":"<p>If this contact is not the first contact, this is the ID of the previous contact.</p>" }, "ContactAssociationId":{ "shape":"ContactId", "documentation":"<p>This is the root contactId which is used as a unique identifier for all subsequent contacts in a contact tree.</p>" }, "InitiationMethod":{ "shape":"ContactInitiationMethod", "documentation":"<p>Indicates how the contact was initiated.</p>" }, "Name":{ "shape":"Name", "documentation":"<p>The name of the contact.</p>" }, "Description":{ "shape":"Description", "documentation":"<p>The description of the contact.</p>" }, "Channel":{ "shape":"Channel", "documentation":"<p>How the contact reached your contact center.</p>" }, "QueueInfo":{ "shape":"QueueInfo", "documentation":"<p>If this contact was queued, this contains information about the queue. </p>" }, "AgentInfo":{ "shape":"AgentInfo", "documentation":"<p>Information about the agent who accepted the contact.</p>" }, "InitiationTimestamp":{ "shape":"timestamp", "documentation":"<p>The date and time this contact was initiated, in UTC time. For <code>INBOUND</code>, this is when the contact arrived. For <code>OUTBOUND</code>, this is when the agent began dialing. For <code>CALLBACK</code>, this is when the callback contact was created. For <code>TRANSFER</code> and <code>QUEUE_TRANSFER</code>, this is when the transfer was initiated. For <code>API</code>, this is when the request arrived. For <code>EXTERNAL_OUTBOUND</code>, this is when the agent started dialing the external participant. For <code>MONITOR</code>, this is when the supervisor started listening to a contact.</p>" }, "DisconnectTimestamp":{ "shape":"timestamp", "documentation":"<p>The date and time that the customer endpoint disconnected from the current contact, in UTC time. In transfer scenarios, the DisconnectTimestamp of the previous contact indicates the date and time when that contact ended.</p>" }, "LastUpdateTimestamp":{ "shape":"timestamp", "documentation":"<p>The timestamp when contact was last updated.</p>" }, "LastPausedTimestamp":{ "shape":"timestamp", "documentation":"<p>The timestamp when the contact was last paused.</p>" }, "LastResumedTimestamp":{ "shape":"timestamp", "documentation":"<p>The timestamp when the contact was last resumed.</p>" }, "TotalPauseCount":{ "shape":"TotalPauseCount", "documentation":"<p>Total pause count for a contact.</p>" }, "TotalPauseDurationInSeconds":{ "shape":"TotalPauseDurationInSeconds", "documentation":"<p>Total pause duration for a contact in seconds.</p>" }, "ScheduledTimestamp":{ "shape":"timestamp", "documentation":"<p>The timestamp, in Unix epoch time format, at which to start running the inbound flow. </p>" }, "RelatedContactId":{ "shape":"ContactId", "documentation":"<p>The contactId that is <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html#relatedcontactid\">related</a> to this contact.</p>" }, "WisdomInfo":{ "shape":"WisdomInfo", "documentation":"<p>Information about Amazon Connect Wisdom.</p>" }, "CustomerId":{ "shape":"CustomerId", "documentation":"<p>The customer's identification number. For example, the <code>CustomerId</code> may be a customer number from your CRM. You can create a Lambda function to pull the unique customer ID of the caller from your CRM system. If you enable Amazon Connect Voice ID capability, this attribute is populated with the <code>CustomerSpeakerId</code> of the caller.</p>" }, "CustomerEndpoint":{ "shape":"EndpointInfo", "documentation":"<p>The customer or external third party participant endpoint.</p>" }, "SystemEndpoint":{ "shape":"EndpointInfo", "documentation":"<p>The system endpoint. For <code>INBOUND</code>, this is the phone number or email address that the customer dialed. For <code>OUTBOUND</code> and <code>EXTERNAL_OUTBOUND</code>, this is the outbound caller ID number assigned to the outbound queue that is used to dial the customer. For callback, this shows up as Softphone for calls handled by agents with softphone.</p>" }, "QueueTimeAdjustmentSeconds":{ "shape":"QueueTimeAdjustmentSeconds", "documentation":"<p>An integer that represents the queue time adjust to be applied to the contact, in seconds (longer / larger queue time are routed preferentially). Cannot be specified if the QueuePriority is specified. Must be statically defined and a valid integer value.</p>" }, "QueuePriority":{ "shape":"QueuePriority", "documentation":"<p>An integer that represents the queue priority to be applied to the contact (lower priorities are routed preferentially). Cannot be specified if the QueueTimeAdjustmentSeconds is specified. Must be statically defined, must be larger than zero, and a valid integer value. Default Value is 5.</p>" }, "Tags":{ "shape":"ContactTagMap", "documentation":"<p>Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.</p>" }, "ConnectedToSystemTimestamp":{ "shape":"timestamp", "documentation":"<p>The timestamp when customer endpoint connected to Amazon Connect.</p>" }, "RoutingCriteria":{ "shape":"RoutingCriteria", "documentation":"<p>Latest routing criteria on the contact.</p>" }, "Customer":{ "shape":"Customer", "documentation":"<p>Information about the Customer on the contact.</p>" }, "Campaign":{"shape":"Campaign"}, "AnsweringMachineDetectionStatus":{ "shape":"AnsweringMachineDetectionStatus", "documentation":"<p>Indicates how an <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/how-to-create-campaigns.html\">outbound campaign</a> call is actually disposed if the contact is connected to Amazon Connect.</p>" }, "CustomerVoiceActivity":{ "shape":"CustomerVoiceActivity", "documentation":"<p>Information about customer’s voice activity.</p>" }, "QualityMetrics":{ "shape":"QualityMetrics", "documentation":"<p>Information about the quality of the participant's media connection.</p>" }, "ChatMetrics":{ "shape":"ChatMetrics", "documentation":"<p>Information about how agent, bot, and customer interact in a chat contact.</p>" }, "DisconnectDetails":{ "shape":"DisconnectDetails", "documentation":"<p>Information about the call disconnect experience.</p>" }, "AdditionalEmailRecipients":{ "shape":"AdditionalEmailRecipients", "documentation":"<p>List of additional email addresses for an email contact.</p>" }, "SegmentAttributes":{ "shape":"SegmentAttributes", "documentation":"<p>A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes and can be accessed in flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example, <code>connect:Guide</code> or <code>connect:SMS</code>.</p>" }, "Recordings":{ "shape":"Recordings", "documentation":"<p>If recording was enabled, this is information about the recordings.</p>" }, "DisconnectReason":{ "shape":"String", "documentation":"<p>The disconnect reason for the contact.</p>" }, "ContactEvaluations":{ "shape":"ContactEvaluations", "documentation":"<p>Information about the contact evaluations where the key is the FormId, which is a unique identifier for the form.</p>" }, "ContactDetails":{ "shape":"ContactDetails", "documentation":"<p>A map of string key/value pairs that contain user-defined attributes which are lightly typed within the contact. This object is used only for task contacts.</p>" }, "Attributes":{ "shape":"Attributes", "documentation":"<p>The attributes of the contact.</p>" } }, "documentation":"<p>Contains information about a contact.</p>" }, "ContactAnalysis":{ "type":"structure", "members":{ "Transcript":{ "shape":"Transcript", "documentation":"<p>Search criteria based on transcript analyzed by Amazon Connect Contact Lens.</p>" } }, "documentation":"<p>A structure that defines search criteria for contacts using analysis outputs from Amazon Connect Contact Lens.</p>" }, "ContactConfiguration":{ "type":"structure", "required":["ContactId"], "members":{ "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact within the Amazon Connect instance.</p>" }, "ParticipantRole":{ "shape":"ParticipantRole", "documentation":"<p>The role of the participant in the chat conversation.</p> <note> <p>Only <code>CUSTOMER</code> is currently supported. Any other values other than <code>CUSTOMER</code> will result in an exception (4xx error).</p> </note>" }, "IncludeRawMessage":{ "shape":"IncludeRawMessage", "documentation":"<p>Whether to include raw connect message in the push notification payload. Default is <code>False</code>.</p>" } }, "documentation":"<p>The contact configuration for push notification registration.</p>" }, "ContactDataRequest":{ "type":"structure", "members":{ "SystemEndpoint":{ "shape":"Endpoint", "documentation":"<p>Endpoint associated with the Amazon Connect instance from which outbound contact will be initiated for the campaign.</p>" }, "CustomerEndpoint":{ "shape":"Endpoint", "documentation":"<p>Endpoint of the customer for which contact will be initiated.</p>" }, "RequestIdentifier":{ "shape":"RequestIdentifier", "documentation":"<p>Identifier to uniquely identify individual requests in the batch.</p>" }, "QueueId":{ "shape":"QueueId", "documentation":"<p>The identifier of the queue associated with the Amazon Connect instance in which contacts that are created will be queued.</p>" }, "Attributes":{ "shape":"Attributes", "documentation":"<p>List of attributes to be stored in a contact.</p>" }, "Campaign":{ "shape":"Campaign", "documentation":"<p>Structure to store information associated with a campaign.</p>" } }, "documentation":"<p>Request object with information to create a contact.</p>" }, "ContactDataRequestList":{ "type":"list", "member":{"shape":"ContactDataRequest"}, "max":25, "min":1 }, "ContactDetailDescription":{ "type":"string", "max":1024, "min":0 }, "ContactDetailName":{ "type":"string", "max":1024, "min":0 }, "ContactDetails":{ "type":"structure", "members":{ "Name":{ "shape":"ContactDetailName", "documentation":"<p>The name of the contact details.</p>" }, "Description":{ "shape":"ContactDetailDescription", "documentation":"<p>Teh description of the contact details.</p>" } }, "documentation":"<p>A map of string key/value pairs that contain user-defined attributes which are lightly typed within the contact. This object is used only for task contacts. </p>" }, "ContactEvaluation":{ "type":"structure", "members":{ "FormId":{ "shape":"FormId", "documentation":"<p>The <code>FormId</code> of the contact evaluation.</p>" }, "EvaluationArn":{ "shape":"EvaluationArn", "documentation":"<p>The Amazon Resource Name for the evaluation form. It is always present.</p>" }, "Status":{ "shape":"Status", "documentation":"<p>The status of the evaluation.</p>" }, "StartTimestamp":{ "shape":"timestamp", "documentation":"<p>The date and time when the evaluation was started, in UTC time.</p>" }, "EndTimestamp":{ "shape":"timestamp", "documentation":"<p>The date and time when the evaluation was submitted, in UTC time.</p>" }, "DeleteTimestamp":{ "shape":"timestamp", "documentation":"<p>The date and time when the evaluation was deleted, in UTC time.</p>" }, "ExportLocation":{ "shape":"ExportLocation", "documentation":"<p>The path where evaluation was exported.</p>" } }, "documentation":"<p>Information about the contact evaluations where the key is the FormId, which is a unique identifier for the form.</p>" }, "ContactEvaluations":{ "type":"map", "key":{"shape":"EvaluationId"}, "value":{"shape":"ContactEvaluation"} }, "ContactFilter":{ "type":"structure", "members":{ "ContactStates":{ "shape":"ContactStates", "documentation":"<p>A list of up to 9 <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html\">contact states</a>.</p>" } }, "documentation":"<p>Filters user data based on the contact information that is associated to the users. It contains a list of <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html\">contact states</a>.</p>" }, "ContactFlow":{ "type":"structure", "members":{ "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the flow.</p>" }, "Id":{ "shape":"ContactFlowId", "documentation":"<p>The identifier of the flow.</p>" }, "Name":{ "shape":"ContactFlowName", "documentation":"<p>The name of the flow.</p>" }, "Type":{ "shape":"ContactFlowType", "documentation":"<p>The type of the flow. For descriptions of the available types, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types\">Choose a flow type</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "State":{ "shape":"ContactFlowState", "documentation":"<p>The type of flow.</p>" }, "Status":{ "shape":"ContactFlowStatus", "documentation":"<p>The status of the flow.</p>" }, "Description":{ "shape":"ContactFlowDescription", "documentation":"<p>The description of the flow.</p>" }, "Content":{ "shape":"ContactFlowContent", "documentation":"<p>The JSON string that represents the content of the flow. For an example, see <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html\">Example flow in Amazon Connect Flow language</a>. </p> <p>Length Constraints: Minimum length of 1. Maximum length of 256000.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" }, "FlowContentSha256":{ "shape":"FlowContentSha256", "documentation":"<p>Indicates the checksum value of the flow content.</p>" }, "Version":{ "shape":"ResourceVersion", "documentation":"<p>The identifier of the flow version.</p>" }, "VersionDescription":{ "shape":"ContactFlowDescription", "documentation":"<p>The description of the flow version.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The time at which the flow was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The region in which the flow was last modified</p>" } }, "documentation":"<p>Contains information about a flow.</p>" }, "ContactFlowContent":{"type":"string"}, "ContactFlowDescription":{"type":"string"}, "ContactFlowId":{ "type":"string", "max":500 }, "ContactFlowModule":{ "type":"structure", "members":{ "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN).</p>" }, "Id":{ "shape":"ContactFlowModuleId", "documentation":"<p>The identifier of the flow module.</p>" }, "Name":{ "shape":"ContactFlowModuleName", "documentation":"<p>The name of the flow module.</p>" }, "Content":{ "shape":"ContactFlowModuleContent", "documentation":"<p>The JSON string that represents the content of the flow. For an example, see <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html\">Example flow in Amazon Connect Flow language</a>. </p>" }, "Description":{ "shape":"ContactFlowModuleDescription", "documentation":"<p>The description of the flow module.</p>" }, "State":{ "shape":"ContactFlowModuleState", "documentation":"<p>The type of flow module.</p>" }, "Status":{ "shape":"ContactFlowModuleStatus", "documentation":"<p>The status of the flow module.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" } }, "documentation":"<p>Contains information about a flow module.</p>" }, "ContactFlowModuleContent":{ "type":"string", "max":256000, "min":1 }, "ContactFlowModuleDescription":{ "type":"string", "max":500, "min":0, "pattern":".*\\S.*" }, "ContactFlowModuleId":{ "type":"string", "max":256, "min":1 }, "ContactFlowModuleName":{ "type":"string", "max":127, "min":1, "pattern":".*\\S.*" }, "ContactFlowModuleSearchConditionList":{ "type":"list", "member":{"shape":"ContactFlowModuleSearchCriteria"} }, "ContactFlowModuleSearchCriteria":{ "type":"structure", "members":{ "OrConditions":{ "shape":"ContactFlowModuleSearchConditionList", "documentation":"<p>A list of conditions which would be applied together with an <code>OR</code> condition.</p>" }, "AndConditions":{ "shape":"ContactFlowModuleSearchConditionList", "documentation":"<p>A list of conditions which would be applied together with an <code>AND</code> condition.</p>" }, "StringCondition":{"shape":"StringCondition"}, "StateCondition":{ "shape":"ContactFlowModuleState", "documentation":"<p>The state of the flow.</p>" }, "StatusCondition":{ "shape":"ContactFlowModuleStatus", "documentation":"<p>The status of the flow.</p>" } }, "documentation":"<p>The search criteria to be used to return flow modules.</p>" }, "ContactFlowModuleSearchFilter":{ "type":"structure", "members":{ "TagFilter":{"shape":"ControlPlaneTagFilter"} }, "documentation":"<p>The search criteria to be used to return flow modules.</p>" }, "ContactFlowModuleSearchSummaryList":{ "type":"list", "member":{"shape":"ContactFlowModule"} }, "ContactFlowModuleState":{ "type":"string", "enum":[ "ACTIVE", "ARCHIVED" ] }, "ContactFlowModuleStatus":{ "type":"string", "enum":[ "PUBLISHED", "SAVED" ] }, "ContactFlowModuleSummary":{ "type":"structure", "members":{ "Id":{ "shape":"ContactFlowModuleId", "documentation":"<p>The identifier of the flow module.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the flow module.</p>" }, "Name":{ "shape":"ContactFlowModuleName", "documentation":"<p>The name of the flow module.</p>" }, "State":{ "shape":"ContactFlowModuleState", "documentation":"<p>The type of flow module.</p>" } }, "documentation":"<p>Contains summary information about a flow.</p>" }, "ContactFlowModulesSummaryList":{ "type":"list", "member":{"shape":"ContactFlowModuleSummary"} }, "ContactFlowName":{ "type":"string", "min":1 }, "ContactFlowNotPublishedException":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"<p>The flow has not been published.</p>", "error":{"httpStatusCode":404}, "exception":true }, "ContactFlowSearchConditionList":{ "type":"list", "member":{"shape":"ContactFlowSearchCriteria"} }, "ContactFlowSearchCriteria":{ "type":"structure", "members":{ "OrConditions":{ "shape":"ContactFlowSearchConditionList", "documentation":"<p>A list of conditions which would be applied together with an <code>OR</code> condition.</p>" }, "AndConditions":{ "shape":"ContactFlowSearchConditionList", "documentation":"<p>A list of conditions which would be applied together with an <code>AND</code> condition.</p>" }, "StringCondition":{"shape":"StringCondition"}, "TypeCondition":{ "shape":"ContactFlowType", "documentation":"<p>The type of flow.</p>" }, "StateCondition":{ "shape":"ContactFlowState", "documentation":"<p>The state of the flow.</p>" }, "StatusCondition":{ "shape":"ContactFlowStatus", "documentation":"<p>The status of the flow.</p>" } }, "documentation":"<p>The search criteria to be used to return flows.</p>" }, "ContactFlowSearchFilter":{ "type":"structure", "members":{ "TagFilter":{"shape":"ControlPlaneTagFilter"} }, "documentation":"<p>Filters to be applied to search results.</p>" }, "ContactFlowSearchSummaryList":{ "type":"list", "member":{"shape":"ContactFlow"} }, "ContactFlowState":{ "type":"string", "enum":[ "ACTIVE", "ARCHIVED" ] }, "ContactFlowStatus":{ "type":"string", "enum":[ "PUBLISHED", "SAVED" ] }, "ContactFlowSummary":{ "type":"structure", "members":{ "Id":{ "shape":"ContactFlowId", "documentation":"<p>The identifier of the flow.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the flow.</p>" }, "Name":{ "shape":"ContactFlowName", "documentation":"<p>The name of the flow.</p>" }, "ContactFlowType":{ "shape":"ContactFlowType", "documentation":"<p>The type of flow.</p>" }, "ContactFlowState":{ "shape":"ContactFlowState", "documentation":"<p>The type of flow.</p>" }, "ContactFlowStatus":{ "shape":"ContactFlowStatus", "documentation":"<p>The status of the flow.</p>" } }, "documentation":"<p>Contains summary information about a flow.</p> <p>You can also create and update flows using the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html\">Amazon Connect Flow language</a>.</p>" }, "ContactFlowSummaryList":{ "type":"list", "member":{"shape":"ContactFlowSummary"} }, "ContactFlowType":{ "type":"string", "enum":[ "CONTACT_FLOW", "CUSTOMER_QUEUE", "CUSTOMER_HOLD", "CUSTOMER_WHISPER", "AGENT_HOLD", "AGENT_WHISPER", "OUTBOUND_WHISPER", "AGENT_TRANSFER", "QUEUE_TRANSFER", "CAMPAIGN" ] }, "ContactFlowTypes":{ "type":"list", "member":{"shape":"ContactFlowType"}, "max":10 }, "ContactFlowVersionSummary":{ "type":"structure", "members":{ "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the view version.</p>" }, "VersionDescription":{ "shape":"ContactFlowDescription", "documentation":"<p>The description of the flow version.</p>" }, "Version":{ "shape":"ResourceVersion", "documentation":"<p>The identifier of the flow version.</p>" } }, "documentation":"<p>A summary of a flow version's metadata.</p>" }, "ContactFlowVersionSummaryList":{ "type":"list", "member":{"shape":"ContactFlowVersionSummary"} }, "ContactId":{ "type":"string", "max":256, "min":1 }, "ContactInitiationMethod":{ "type":"string", "enum":[ "INBOUND", "OUTBOUND", "TRANSFER", "QUEUE_TRANSFER", "CALLBACK", "API", "DISCONNECT", "MONITOR", "EXTERNAL_OUTBOUND", "WEBRTC_API", "AGENT_REPLY", "FLOW" ] }, "ContactNotFoundException":{ "type":"structure", "members":{ "Message":{ "shape":"Message", "documentation":"<p>The message.</p>" } }, "documentation":"<p>The contact with the specified ID is not active or does not exist. Applies to Voice calls only, not to Chat or Task contacts.</p>", "error":{"httpStatusCode":410}, "exception":true }, "ContactRecordingType":{ "type":"string", "enum":[ "AGENT", "IVR", "SCREEN" ] }, "ContactReferences":{ "type":"map", "key":{"shape":"ReferenceKey"}, "value":{"shape":"Reference"} }, "ContactSearchSummary":{ "type":"structure", "members":{ "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the contact.</p>" }, "Id":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact summary.</p>" }, "InitialContactId":{ "shape":"ContactId", "documentation":"<p>If this contact is related to other contacts, this is the ID of the initial contact.</p>" }, "PreviousContactId":{ "shape":"ContactId", "documentation":"<p>If this contact is not the first contact, this is the ID of the previous contact.</p>" }, "InitiationMethod":{ "shape":"ContactInitiationMethod", "documentation":"<p>Indicates how the contact was initiated.</p>" }, "Channel":{ "shape":"Channel", "documentation":"<p>How the contact reached your contact center.</p>" }, "QueueInfo":{ "shape":"ContactSearchSummaryQueueInfo", "documentation":"<p>If this contact was queued, this contains information about the queue.</p>" }, "AgentInfo":{ "shape":"ContactSearchSummaryAgentInfo", "documentation":"<p>Information about the agent who accepted the contact.</p>" }, "InitiationTimestamp":{ "shape":"timestamp", "documentation":"<p>The date and time this contact was initiated, in UTC time. For <code>INBOUND</code>, this is when the contact arrived. For <code>OUTBOUND</code>, this is when the agent began dialing. For <code>CALLBACK</code>, this is when the callback contact was created. For <code>TRANSFER</code> and <code>QUEUE_TRANSFER</code>, this is when the transfer was initiated. For API, this is when the request arrived. For <code>EXTERNAL_OUTBOUND</code>, this is when the agent started dialing the external participant. For <code>MONITOR</code>, this is when the supervisor started listening to a contact.</p>" }, "DisconnectTimestamp":{ "shape":"timestamp", "documentation":"<p>The timestamp when the customer endpoint disconnected from Amazon Connect.</p>" }, "ScheduledTimestamp":{ "shape":"timestamp", "documentation":"<p>The timestamp, in Unix epoch time format, at which to start running the inbound flow.</p>" }, "SegmentAttributes":{ "shape":"ContactSearchSummarySegmentAttributes", "documentation":"<p>Set of segment attributes for a contact.</p>" } }, "documentation":"<p>Information of returned contact.</p>" }, "ContactSearchSummaryAgentInfo":{ "type":"structure", "members":{ "Id":{ "shape":"AgentResourceId", "documentation":"<p>The identifier of the agent who accepted the contact.</p>" }, "ConnectedToAgentTimestamp":{ "shape":"timestamp", "documentation":"<p>The timestamp when the contact was connected to the agent.</p>" } }, "documentation":"<p>Information about the agent who accepted the contact.</p>" }, "ContactSearchSummaryQueueInfo":{ "type":"structure", "members":{ "Id":{ "shape":"QueueId", "documentation":"<p>The unique identifier for the queue.</p>" }, "EnqueueTimestamp":{ "shape":"timestamp", "documentation":"<p>The timestamp when the contact was added to the queue.</p>" } }, "documentation":"<p>If this contact was queued, this contains information about the queue.</p>" }, "ContactSearchSummarySegmentAttributeValue":{ "type":"structure", "members":{ "ValueString":{ "shape":"SegmentAttributeValueString", "documentation":"<p>The value of a segment attribute represented as a string.</p>" } }, "documentation":"<p>The value of a segment attribute. This is structured as a map with a single key-value pair. The key 'valueString' indicates that the attribute type is a string, and its corresponding value is the actual string value of the segment attribute.</p>" }, "ContactSearchSummarySegmentAttributes":{ "type":"map", "key":{"shape":"SegmentAttributeName"}, "value":{"shape":"ContactSearchSummarySegmentAttributeValue"} }, "ContactState":{ "type":"string", "enum":[ "INCOMING", "PENDING", "CONNECTING", "CONNECTED", "CONNECTED_ONHOLD", "MISSED", "ERROR", "ENDED", "REJECTED" ] }, "ContactStates":{ "type":"list", "member":{"shape":"ContactState"}, "max":9 }, "ContactTagKey":{ "type":"string", "max":128, "min":1, "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" }, "ContactTagKeys":{ "type":"list", "member":{"shape":"ContactTagKey"}, "max":6, "min":1 }, "ContactTagMap":{ "type":"map", "key":{"shape":"ContactTagKey"}, "value":{"shape":"ContactTagValue"}, "max":6, "min":1 }, "ContactTagValue":{ "type":"string", "max":256 }, "Contacts":{ "type":"list", "member":{"shape":"ContactSearchSummary"} }, "Content":{ "type":"string", "max":1024, "min":1 }, "ContentType":{ "type":"string", "max":255, "min":1 }, "ControlPlaneAttributeFilter":{ "type":"structure", "members":{ "OrConditions":{ "shape":"CommonAttributeOrConditionList", "documentation":"<p>A list of conditions which would be applied together with an <code>OR</code> condition.</p>" }, "AndCondition":{ "shape":"CommonAttributeAndCondition", "documentation":"<p>A list of conditions which would be applied together with an <code>AND</code> condition.</p>" }, "TagCondition":{"shape":"TagCondition"} }, "documentation":"<p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>. This accepts an <code>OR</code> or <code>AND</code> (List of List) input where: </p> <ul> <li> <p>The top level list specifies conditions that need to be applied with <code>OR</code> operator.</p> </li> <li> <p>The inner list specifies conditions that need to be applied with <code>AND</code> operator.</p> </li> </ul>" }, "ControlPlaneTagFilter":{ "type":"structure", "members":{ "OrConditions":{ "shape":"TagOrConditionList", "documentation":"<p>A list of conditions which would be applied together with an <code>OR</code> condition. </p>" }, "AndConditions":{ "shape":"TagAndConditionList", "documentation":"<p>A list of conditions which would be applied together with an <code>AND</code> condition.</p>" }, "TagCondition":{ "shape":"TagCondition", "documentation":"<p>A leaf node condition which can be used to specify a tag condition. </p>" } }, "documentation":"<p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>. This accepts an <code>OR</code> of <code>AND</code> (List of List) input where: </p> <ul> <li> <p>Top level list specifies conditions that need to be applied with <code>OR</code> operator</p> </li> <li> <p>Inner list specifies conditions that need to be applied with <code>AND</code> operator.</p> </li> </ul>" }, "ControlPlaneUserAttributeFilter":{ "type":"structure", "members":{ "OrConditions":{ "shape":"AttributeOrConditionList", "documentation":"<p>A list of conditions which would be applied together with an <code>OR</code> condition.</p>" }, "AndCondition":{ "shape":"AttributeAndCondition", "documentation":"<p>A list of conditions which would be applied together with an <code>AND</code> condition.</p>" }, "TagCondition":{"shape":"TagCondition"}, "HierarchyGroupCondition":{"shape":"HierarchyGroupCondition"} }, "documentation":"<p>An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the <code>SearchFilter</code>.</p> <p>This accepts an <code>OR</code> of <code>AND</code> (List of List) input where:</p> <ul> <li> <p>The top level list specifies conditions that need to be applied with <code>OR</code> operator</p> </li> <li> <p>The inner list specifies conditions that need to be applied with <code>AND</code> operator.</p> </li> </ul> <note> <p>Only one field can be populated. Maximum number of allowed Tag conditions is 25. Maximum number of allowed Hierarchy Group conditions is 20. </p> </note>" }, "Count":{"type":"integer"}, "CreateAgentStatusRequest":{ "type":"structure", "required":[ "InstanceId", "Name", "State" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Name":{ "shape":"AgentStatusName", "documentation":"<p>The name of the status.</p>" }, "Description":{ "shape":"AgentStatusDescription", "documentation":"<p>The description of the status.</p>" }, "State":{ "shape":"AgentStatusState", "documentation":"<p>The state of the status.</p>" }, "DisplayOrder":{ "shape":"AgentStatusOrderNumber", "documentation":"<p>The display order of the status.</p>", "box":true }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" } } }, "CreateAgentStatusResponse":{ "type":"structure", "members":{ "AgentStatusARN":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the agent status.</p>" }, "AgentStatusId":{ "shape":"AgentStatusId", "documentation":"<p>The identifier of the agent status.</p>" } } }, "CreateCaseActionDefinition":{ "type":"structure", "required":[ "Fields", "TemplateId" ], "members":{ "Fields":{ "shape":"FieldValues", "documentation":"<p>An array of objects with <code>Field ID</code> and <code>Value</code> data.</p>" }, "TemplateId":{ "shape":"TemplateId", "documentation":"<p>A unique identifier of a template.</p>" } }, "documentation":"<p>The <code>CreateCase</code> action definition.</p>" }, "CreateContactFlowModuleRequest":{ "type":"structure", "required":[ "InstanceId", "Name", "Content" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Name":{ "shape":"ContactFlowModuleName", "documentation":"<p>The name of the flow module.</p>" }, "Description":{ "shape":"ContactFlowModuleDescription", "documentation":"<p>The description of the flow module. </p>" }, "Content":{ "shape":"ContactFlowModuleContent", "documentation":"<p>The JSON string that represents the content of the flow. For an example, see <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html\">Example flow in Amazon Connect Flow language</a>. </p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true } } }, "CreateContactFlowModuleResponse":{ "type":"structure", "members":{ "Id":{ "shape":"ContactFlowModuleId", "documentation":"<p>The identifier of the flow module.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the flow module.</p>" } } }, "CreateContactFlowRequest":{ "type":"structure", "required":[ "InstanceId", "Name", "Type", "Content" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Name":{ "shape":"ContactFlowName", "documentation":"<p>The name of the flow.</p>" }, "Type":{ "shape":"ContactFlowType", "documentation":"<p>The type of the flow. For descriptions of the available types, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types\">Choose a flow type</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "Description":{ "shape":"ContactFlowDescription", "documentation":"<p>The description of the flow. </p>" }, "Content":{ "shape":"ContactFlowContent", "documentation":"<p>The JSON string that represents the content of the flow. For an example, see <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html\">Example flow in Amazon Connect Flow language</a>. </p> <p>Length Constraints: Minimum length of 1. Maximum length of 256000.</p>" }, "Status":{ "shape":"ContactFlowStatus", "documentation":"<p>Indicates the flow status as either <code>SAVED</code> or <code>PUBLISHED</code>. The <code>PUBLISHED</code> status will initiate validation on the content. the <code>SAVED</code> status does not initiate validation of the content. <code>SAVED</code> | <code>PUBLISHED</code>.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" } } }, "CreateContactFlowResponse":{ "type":"structure", "members":{ "ContactFlowId":{ "shape":"ContactFlowId", "documentation":"<p>The identifier of the flow.</p>" }, "ContactFlowArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the flow.</p>" }, "FlowContentSha256":{ "shape":"FlowContentSha256", "documentation":"<p>Indicates the checksum value of the latest published flow content.</p>" } } }, "CreateContactFlowVersionRequest":{ "type":"structure", "required":[ "InstanceId", "ContactFlowId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Description":{ "shape":"ContactFlowDescription", "documentation":"<p>The description of the flow version.</p>" }, "ContactFlowId":{ "shape":"ARN", "documentation":"<p>The identifier of the flow.</p>", "location":"uri", "locationName":"ContactFlowId" }, "FlowContentSha256":{ "shape":"FlowContentSha256", "documentation":"<p>Indicates the checksum value of the flow content.</p>" }, "ContactFlowVersion":{ "shape":"ResourceVersion", "documentation":"<p>The identifier of the flow version.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The Amazon Web Services Region where this resource was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The Amazon Web Services Region where this resource was last modified.</p>" } } }, "CreateContactFlowVersionResponse":{ "type":"structure", "members":{ "ContactFlowArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the flow.</p>" }, "Version":{ "shape":"ResourceVersion", "documentation":"<p>The identifier of the flow version.</p>" } } }, "CreateContactRequest":{ "type":"structure", "required":[ "InstanceId", "Channel", "InitiationMethod" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true }, "RelatedContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact in this instance of Amazon Connect. </p>" }, "Attributes":{ "shape":"Attributes", "documentation":"<p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.</p> <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.</p>" }, "References":{ "shape":"ContactReferences", "documentation":"<p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> | <code>STRING</code> | <code>DATE</code> | <code>EMAIL</code> | <code>ATTACHMENT</code>.</p>" }, "Channel":{ "shape":"Channel", "documentation":"<p>The channel for the contact.</p> <important> <p>The CHAT channel is not supported. The following information is incorrect. We're working to correct it.</p> </important>" }, "InitiationMethod":{ "shape":"ContactInitiationMethod", "documentation":"<p>Indicates how the contact was initiated. </p> <important> <p>CreateContact only supports the following initiation methods. Valid values by channel are: </p> <ul> <li> <p>For VOICE: <code>TRANSFER</code> and the subtype <code>connect:ExternalAudio</code> </p> </li> <li> <p>For EMAIL: <code>OUTBOUND</code> | <code>AGENT_REPLY</code> | <code>FLOW</code> </p> </li> <li> <p>For TASK: <code>API</code> </p> </li> </ul> <p>The other channels listed below are incorrect. We're working to correct this information.</p> </important>" }, "ExpiryDurationInMinutes":{ "shape":"ExpiryDurationInMinutes", "documentation":"<p>Number of minutes the contact will be active for before expiring</p>" }, "UserInfo":{ "shape":"UserInfo", "documentation":"<p>User details for the contact</p> <important> <p>UserInfo is required when creating an EMAIL contact with <code>OUTBOUND</code> and <code>AGENT_REPLY</code> contact initiation methods.</p> </important>" }, "InitiateAs":{ "shape":"InitiateAs", "documentation":"<p>Initial state of the contact when it's created. Only TASK channel contacts can be initiated with <code>COMPLETED</code> state.</p>" }, "Name":{ "shape":"Name", "documentation":"<p>The name of a the contact.</p>" }, "Description":{ "shape":"Description", "documentation":"<p>A description of the contact.</p>" }, "SegmentAttributes":{ "shape":"SegmentAttributes", "documentation":"<p>A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.</p> <p>Attribute keys can include only alphanumeric, -, and _.</p> <p>This field can be used to set Segment Contact Expiry as a duration in minutes.</p> <note> <p>To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will be active for before expiring, with <code>SegmentAttributes</code> like { <code> \"connect:ContactExpiry\": {\"ValueMap\" : { \"ExpiryDuration\": { \"ValueInteger\": 135}}}}</code>. </p> </note>" }, "PreviousContactId":{ "shape":"ContactId", "documentation":"<p>The ID of the previous contact when creating a transfer contact. This value can be provided only for external audio contacts. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html\">Integrate Amazon Connect Contact Lens with external voice systems</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" } } }, "CreateContactResponse":{ "type":"structure", "members":{ "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact in this instance of Amazon Connect. </p>" }, "ContactArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the created contact.</p>" } } }, "CreateEmailAddressRequest":{ "type":"structure", "required":[ "InstanceId", "EmailAddress" ], "members":{ "Description":{ "shape":"Description", "documentation":"<p>The description of the email address.</p>" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "EmailAddress":{ "shape":"EmailAddress", "documentation":"<p>The email address, including the domain.</p>" }, "DisplayName":{ "shape":"EmailAddressDisplayName", "documentation":"<p>The display name of email address</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>" } } }, "CreateEmailAddressResponse":{ "type":"structure", "members":{ "EmailAddressId":{ "shape":"EmailAddressId", "documentation":"<p>The identifier of the email address.</p>" }, "EmailAddressArn":{ "shape":"EmailAddressArn", "documentation":"<p>The Amazon Resource Name (ARN) of the email address.</p>" } } }, "CreateEvaluationFormRequest":{ "type":"structure", "required":[ "InstanceId", "Title", "Items" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Title":{ "shape":"EvaluationFormTitle", "documentation":"<p>A title of the evaluation form.</p>" }, "Description":{ "shape":"EvaluationFormDescription", "documentation":"<p>The description of the evaluation form.</p>" }, "Items":{ "shape":"EvaluationFormItemsList", "documentation":"<p>Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.</p>" }, "ScoringStrategy":{ "shape":"EvaluationFormScoringStrategy", "documentation":"<p>A scoring strategy of the evaluation form.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true } } }, "CreateEvaluationFormResponse":{ "type":"structure", "required":[ "EvaluationFormId", "EvaluationFormArn" ], "members":{ "EvaluationFormId":{ "shape":"ResourceId", "documentation":"<p>The unique identifier for the evaluation form.</p>" }, "EvaluationFormArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>" } } }, "CreateHoursOfOperationOverrideRequest":{ "type":"structure", "required":[ "InstanceId", "HoursOfOperationId", "Name", "Config", "EffectiveFrom", "EffectiveTill" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance.</p>", "location":"uri", "locationName":"InstanceId" }, "HoursOfOperationId":{ "shape":"HoursOfOperationId", "documentation":"<p>The identifier for the hours of operation</p>", "location":"uri", "locationName":"HoursOfOperationId" }, "Name":{ "shape":"CommonHumanReadableName", "documentation":"<p>The name of the hours of operation override.</p>" }, "Description":{ "shape":"CommonHumanReadableDescription", "documentation":"<p>The description of the hours of operation override.</p>" }, "Config":{ "shape":"HoursOfOperationOverrideConfigList", "documentation":"<p>Configuration information for the hours of operation override: day, start time, and end time.</p>" }, "EffectiveFrom":{ "shape":"HoursOfOperationOverrideYearMonthDayDateFormat", "documentation":"<p>The date from when the hours of operation override would be effective.</p>" }, "EffectiveTill":{ "shape":"HoursOfOperationOverrideYearMonthDayDateFormat", "documentation":"<p>The date until when the hours of operation override would be effective.</p>" } } }, "CreateHoursOfOperationOverrideResponse":{ "type":"structure", "members":{ "HoursOfOperationOverrideId":{ "shape":"HoursOfOperationOverrideId", "documentation":"<p>The identifier for the hours of operation override.</p>" } } }, "CreateHoursOfOperationRequest":{ "type":"structure", "required":[ "InstanceId", "Name", "TimeZone", "Config" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Name":{ "shape":"CommonNameLength127", "documentation":"<p>The name of the hours of operation.</p>" }, "Description":{ "shape":"HoursOfOperationDescription", "documentation":"<p>The description of the hours of operation.</p>" }, "TimeZone":{ "shape":"TimeZone", "documentation":"<p>The time zone of the hours of operation.</p>" }, "Config":{ "shape":"HoursOfOperationConfigList", "documentation":"<p>Configuration information for the hours of operation: day, start time, and end time.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" } } }, "CreateHoursOfOperationResponse":{ "type":"structure", "members":{ "HoursOfOperationId":{ "shape":"HoursOfOperationId", "documentation":"<p>The identifier for the hours of operation.</p>" }, "HoursOfOperationArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the hours of operation.</p>" } } }, "CreateInstanceRequest":{ "type":"structure", "required":[ "IdentityManagementType", "InboundCallsEnabled", "OutboundCallsEnabled" ], "members":{ "ClientToken":{ "shape":"ClientToken", "documentation":"<p>The idempotency token.</p>", "idempotencyToken":true }, "IdentityManagementType":{ "shape":"DirectoryType", "documentation":"<p>The type of identity management for your Amazon Connect users.</p>" }, "InstanceAlias":{ "shape":"DirectoryAlias", "documentation":"<p>The name for your instance.</p>" }, "DirectoryId":{ "shape":"DirectoryId", "documentation":"<p>The identifier for the directory.</p>" }, "InboundCallsEnabled":{ "shape":"InboundCallsEnabled", "documentation":"<p>Your contact center handles incoming contacts.</p>" }, "OutboundCallsEnabled":{ "shape":"OutboundCallsEnabled", "documentation":"<p>Your contact center allows outbound calls.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, <code>{ \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }</code>.</p>" } } }, "CreateInstanceResponse":{ "type":"structure", "members":{ "Id":{ "shape":"InstanceId", "documentation":"<p>The identifier for the instance.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the instance.</p>" } } }, "CreateIntegrationAssociationRequest":{ "type":"structure", "required":[ "InstanceId", "IntegrationType", "IntegrationArn" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "IntegrationType":{ "shape":"IntegrationType", "documentation":"<p>The type of information to be ingested.</p>" }, "IntegrationArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the integration.</p> <note> <p>When integrating with Amazon Web Services End User Messaging, the Amazon Connect and Amazon Web Services End User Messaging instances must be in the same account.</p> </note>" }, "SourceApplicationUrl":{ "shape":"URI", "documentation":"<p>The URL for the external application. This field is only required for the EVENT integration type.</p>" }, "SourceApplicationName":{ "shape":"SourceApplicationName", "documentation":"<p>The name of the external application. This field is only required for the EVENT integration type.</p>" }, "SourceType":{ "shape":"SourceType", "documentation":"<p>The type of the data source. This field is only required for the EVENT integration type.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" } } }, "CreateIntegrationAssociationResponse":{ "type":"structure", "members":{ "IntegrationAssociationId":{ "shape":"IntegrationAssociationId", "documentation":"<p>The identifier for the integration association.</p>" }, "IntegrationAssociationArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the association.</p>" } } }, "CreateParticipantRequest":{ "type":"structure", "required":[ "InstanceId", "ContactId", "ParticipantDetails" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance. </p>" }, "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact in this instance of Amazon Connect. Only contacts in the CHAT channel are supported.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true }, "ParticipantDetails":{ "shape":"ParticipantDetailsToAdd", "documentation":"<p>Information identifying the participant.</p> <important> <p>The only Valid value for <code>ParticipantRole</code> is <code>CUSTOM_BOT</code>. </p> <p> <code>DisplayName</code> is <b>Required</b>.</p> </important>" } } }, "CreateParticipantResponse":{ "type":"structure", "members":{ "ParticipantCredentials":{ "shape":"ParticipantTokenCredentials", "documentation":"<p>The token used by the chat participant to call <code>CreateParticipantConnection</code>. The participant token is valid for the lifetime of a chat participant.</p>" }, "ParticipantId":{ "shape":"ParticipantId", "documentation":"<p>The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.</p>" } } }, "CreatePersistentContactAssociationRequest":{ "type":"structure", "required":[ "InstanceId", "InitialContactId", "RehydrationType", "SourceContactId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "InitialContactId":{ "shape":"ContactId", "documentation":"<p>This is the contactId of the current contact that the <code>CreatePersistentContactAssociation</code> API is being called from.</p>", "location":"uri", "locationName":"InitialContactId" }, "RehydrationType":{ "shape":"RehydrationType", "documentation":"<p>The contactId chosen for rehydration depends on the type chosen.</p> <ul> <li> <p> <code>ENTIRE_PAST_SESSION</code>: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the <code>initialContactId</code> of the past ended chat session in the <code>sourceContactId</code> field. In this type, Amazon Connect determines what the most recent chat contact on the past ended chat session and uses it to start a persistent chat. </p> </li> <li> <p> <code>FROM_SEGMENT</code>: Rehydrates a chat from the specified past chat contact provided in the <code>sourceContactId</code> field. </p> </li> </ul> <p>The actual contactId used for rehydration is provided in the response of this API.</p> <p>To illustrate how to use rehydration type, consider the following example: A customer starts a chat session. Agent a1 accepts the chat and a conversation starts between the customer and Agent a1. This first contact creates a contact ID <b>C1</b>. Agent a1 then transfers the chat to Agent a2. This creates another contact ID <b>C2</b>. At this point Agent a2 ends the chat. The customer is forwarded to the disconnect flow for a post chat survey that creates another contact ID <b>C3</b>. After the chat survey, the chat session ends. Later, the customer returns and wants to resume their past chat session. At this point, the customer can have following use cases: </p> <ul> <li> <p> <b>Use Case 1</b>: The customer wants to continue the past chat session but they want to hide the post chat survey. For this they will use the following configuration:</p> <ul> <li> <p> <b>Configuration</b> </p> <ul> <li> <p>SourceContactId = \"C2\"</p> </li> <li> <p>RehydrationType = \"FROM_SEGMENT\"</p> </li> </ul> </li> <li> <p> <b>Expected behavior</b> </p> <ul> <li> <p>This starts a persistent chat session from the specified past ended contact (C2). Transcripts of past chat sessions C2 and C1 are accessible in the current persistent chat session. Note that chat segment C3 is dropped from the persistent chat session.</p> </li> </ul> </li> </ul> </li> <li> <p> <b>Use Case 2</b>: The customer wants to continue the past chat session and see the transcript of the entire past engagement, including the post chat survey. For this they will use the following configuration:</p> <ul> <li> <p> <b>Configuration</b> </p> <ul> <li> <p>SourceContactId = \"C1\"</p> </li> <li> <p>RehydrationType = \"ENTIRE_PAST_SESSION\"</p> </li> </ul> </li> <li> <p> <b>Expected behavior</b> </p> <ul> <li> <p>This starts a persistent chat session from the most recently ended chat contact (C3). Transcripts of past chat sessions C3, C2 and C1 are accessible in the current persistent chat session.</p> </li> </ul> </li> </ul> </li> </ul>" }, "SourceContactId":{ "shape":"ContactId", "documentation":"<p>The contactId from which a persistent chat session must be started.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>" } } }, "CreatePersistentContactAssociationResponse":{ "type":"structure", "members":{ "ContinuedFromContactId":{ "shape":"ContactId", "documentation":"<p>The contactId from which a persistent chat session is started. This field is populated only for persistent chat.</p>" } } }, "CreatePredefinedAttributeRequest":{ "type":"structure", "required":[ "InstanceId", "Name", "Values" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Name":{ "shape":"PredefinedAttributeName", "documentation":"<p> The name of the predefined attribute. </p>" }, "Values":{ "shape":"PredefinedAttributeValues", "documentation":"<p> The values of the predefined attribute. </p>" } } }, "CreatePromptRequest":{ "type":"structure", "required":[ "InstanceId", "Name", "S3Uri" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Name":{ "shape":"CommonNameLength127", "documentation":"<p>The name of the prompt.</p>" }, "Description":{ "shape":"PromptDescription", "documentation":"<p>The description of the prompt.</p>" }, "S3Uri":{ "shape":"S3Uri", "documentation":"<p>The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_GetPromptFile.html\">GetPromptFile</a> API instead of providing S3 URIs.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" } } }, "CreatePromptResponse":{ "type":"structure", "members":{ "PromptARN":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the prompt.</p>" }, "PromptId":{ "shape":"PromptId", "documentation":"<p>A unique identifier for the prompt.</p>" } } }, "CreatePushNotificationRegistrationRequest":{ "type":"structure", "required":[ "InstanceId", "PinpointAppArn", "DeviceToken", "DeviceType", "ContactConfiguration" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true }, "PinpointAppArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the Pinpoint application.</p>" }, "DeviceToken":{ "shape":"DeviceToken", "documentation":"<p>The push notification token issued by the Apple or Google gateways.</p>" }, "DeviceType":{ "shape":"DeviceType", "documentation":"<p>The device type to use when sending the message.</p>" }, "ContactConfiguration":{ "shape":"ContactConfiguration", "documentation":"<p>The contact configuration for push notification registration.</p>" } } }, "CreatePushNotificationRegistrationResponse":{ "type":"structure", "required":["RegistrationId"], "members":{ "RegistrationId":{ "shape":"RegistrationId", "documentation":"<p>The identifier for the registration.</p>" } } }, "CreateQueueRequest":{ "type":"structure", "required":[ "InstanceId", "Name", "HoursOfOperationId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Name":{ "shape":"CommonNameLength127", "documentation":"<p>The name of the queue.</p>" }, "Description":{ "shape":"QueueDescription", "documentation":"<p>The description of the queue.</p>" }, "OutboundCallerConfig":{ "shape":"OutboundCallerConfig", "documentation":"<p>The outbound caller ID name, number, and outbound whisper flow.</p>" }, "OutboundEmailConfig":{ "shape":"OutboundEmailConfig", "documentation":"<p>The outbound email address ID for a specified queue.</p>" }, "HoursOfOperationId":{ "shape":"HoursOfOperationId", "documentation":"<p>The identifier for the hours of operation.</p>" }, "MaxContacts":{ "shape":"QueueMaxContacts", "documentation":"<p>The maximum number of contacts that can be in the queue before it is considered full.</p>", "box":true }, "QuickConnectIds":{ "shape":"QuickConnectsList", "documentation":"<p>The quick connects available to agents who are working the queue.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" } } }, "CreateQueueResponse":{ "type":"structure", "members":{ "QueueArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the queue.</p>" }, "QueueId":{ "shape":"QueueId", "documentation":"<p>The identifier for the queue.</p>" } } }, "CreateQuickConnectRequest":{ "type":"structure", "required":[ "InstanceId", "Name", "QuickConnectConfig" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Name":{ "shape":"QuickConnectName", "documentation":"<p>A unique name of the quick connect.</p>" }, "Description":{ "shape":"QuickConnectDescription", "documentation":"<p>The description of the quick connect.</p>" }, "QuickConnectConfig":{ "shape":"QuickConnectConfig", "documentation":"<p>Configuration settings for the quick connect.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" } } }, "CreateQuickConnectResponse":{ "type":"structure", "members":{ "QuickConnectARN":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the quick connect. </p>" }, "QuickConnectId":{ "shape":"QuickConnectId", "documentation":"<p>The identifier for the quick connect. </p>" } } }, "CreateRoutingProfileRequest":{ "type":"structure", "required":[ "InstanceId", "Name", "Description", "DefaultOutboundQueueId", "MediaConcurrencies" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Name":{ "shape":"RoutingProfileName", "documentation":"<p>The name of the routing profile. Must not be more than 127 characters.</p>" }, "Description":{ "shape":"RoutingProfileDescription", "documentation":"<p>Description of the routing profile. Must not be more than 250 characters.</p>" }, "DefaultOutboundQueueId":{ "shape":"QueueId", "documentation":"<p>The default outbound queue for the routing profile.</p>" }, "QueueConfigs":{ "shape":"RoutingProfileQueueConfigList", "documentation":"<p>The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls.</p> <p>The limit of 10 array members applies to the maximum number of <code>RoutingProfileQueueConfig</code> objects that can be passed during a CreateRoutingProfile API request. It is different from the quota of 50 queues per routing profile per instance that is listed in <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html\">Amazon Connect service quotas</a>. </p>" }, "MediaConcurrencies":{ "shape":"MediaConcurrencies", "documentation":"<p>The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" }, "AgentAvailabilityTimer":{ "shape":"AgentAvailabilityTimer", "documentation":"<p>Whether agents with this routing profile will have their routing order calculated based on <i>longest idle time</i> or <i>time since their last inbound contact</i>. </p>" } } }, "CreateRoutingProfileResponse":{ "type":"structure", "members":{ "RoutingProfileArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the routing profile.</p>" }, "RoutingProfileId":{ "shape":"RoutingProfileId", "documentation":"<p>The identifier of the routing profile.</p>" } } }, "CreateRuleRequest":{ "type":"structure", "required":[ "InstanceId", "Name", "TriggerEventSource", "Function", "Actions", "PublishStatus" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Name":{ "shape":"RuleName", "documentation":"<p>A unique name for the rule.</p>" }, "TriggerEventSource":{ "shape":"RuleTriggerEventSource", "documentation":"<p>The event source to trigger the rule.</p>" }, "Function":{ "shape":"RuleFunction", "documentation":"<p>The conditions of the rule.</p>" }, "Actions":{ "shape":"RuleActions", "documentation":"<p>A list of actions to be run when the rule is triggered.</p>" }, "PublishStatus":{ "shape":"RulePublishStatus", "documentation":"<p>The publish status of the rule.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true } } }, "CreateRuleResponse":{ "type":"structure", "required":[ "RuleArn", "RuleId" ], "members":{ "RuleArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the rule.</p>" }, "RuleId":{ "shape":"RuleId", "documentation":"<p>A unique identifier for the rule.</p>" } } }, "CreateSecurityProfileName":{ "type":"string", "max":127, "min":1, "pattern":"^[ a-zA-Z0-9_@-]+$" }, "CreateSecurityProfileRequest":{ "type":"structure", "required":[ "SecurityProfileName", "InstanceId" ], "members":{ "SecurityProfileName":{ "shape":"CreateSecurityProfileName", "documentation":"<p>The name of the security profile.</p>" }, "Description":{ "shape":"SecurityProfileDescription", "documentation":"<p>The description of the security profile.</p>" }, "Permissions":{ "shape":"PermissionsList", "documentation":"<p>Permissions assigned to the security profile. For a list of valid permissions, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html\">List of security profile permissions</a>. </p>" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" }, "AllowedAccessControlTags":{ "shape":"AllowedAccessControlTags", "documentation":"<p>The list of tags that a security profile uses to restrict access to resources in Amazon Connect.</p>" }, "TagRestrictedResources":{ "shape":"TagRestrictedResourceList", "documentation":"<p>The list of resources that a security profile applies tag restrictions to in Amazon Connect. For a list of Amazon Connect resources that you can tag, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/tagging.html\">Add tags to resources in Amazon Connect</a> in the <i>Amazon Connect Administrator Guide</i>. </p>" }, "Applications":{ "shape":"Applications", "documentation":"<p>A list of third-party applications that the security profile will give access to.</p>" }, "HierarchyRestrictedResources":{ "shape":"HierarchyRestrictedResourceList", "documentation":"<p>The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: <code>User</code>.</p>" }, "AllowedAccessControlHierarchyGroupId":{ "shape":"HierarchyGroupId", "documentation":"<p>The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.</p>" } } }, "CreateSecurityProfileResponse":{ "type":"structure", "members":{ "SecurityProfileId":{ "shape":"SecurityProfileId", "documentation":"<p>The identifier for the security profle.</p>" }, "SecurityProfileArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the security profile.</p>" } } }, "CreateTaskTemplateRequest":{ "type":"structure", "required":[ "InstanceId", "Name", "Fields" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Name":{ "shape":"TaskTemplateName", "documentation":"<p>The name of the task template.</p>" }, "Description":{ "shape":"TaskTemplateDescription", "documentation":"<p>The description of the task template.</p>" }, "ContactFlowId":{ "shape":"ContactFlowId", "documentation":"<p>The identifier of the flow that runs by default when a task is created by referencing this template.</p>" }, "SelfAssignFlowId":{ "shape":"ContactFlowId", "documentation":"<p>The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.</p>" }, "Constraints":{ "shape":"TaskTemplateConstraints", "documentation":"<p>Constraints that are applicable to the fields listed.</p>" }, "Defaults":{ "shape":"TaskTemplateDefaults", "documentation":"<p>The default values for fields when a task is created by referencing this template.</p>" }, "Status":{ "shape":"TaskTemplateStatus", "documentation":"<p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it. Tasks can only be created from <code>ACTIVE</code> templates. If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created. </p>" }, "Fields":{ "shape":"TaskTemplateFields", "documentation":"<p>Fields that are part of the template.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true } } }, "CreateTaskTemplateResponse":{ "type":"structure", "required":[ "Id", "Arn" ], "members":{ "Id":{ "shape":"TaskTemplateId", "documentation":"<p>The identifier of the task template resource.</p>" }, "Arn":{ "shape":"TaskTemplateArn", "documentation":"<p>The Amazon Resource Name (ARN) for the task template resource.</p>" } } }, "CreateTrafficDistributionGroupRequest":{ "type":"structure", "required":[ "Name", "InstanceId" ], "members":{ "Name":{ "shape":"Name128", "documentation":"<p>The name for the traffic distribution group. </p>" }, "Description":{ "shape":"Description250", "documentation":"<p>A description for the traffic distribution group.</p>" }, "InstanceId":{ "shape":"InstanceIdOrArn", "documentation":"<p>The identifier of the Amazon Connect instance that has been replicated. You can find the <code>instanceId</code> in the ARN of the instance.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" } } }, "CreateTrafficDistributionGroupResponse":{ "type":"structure", "members":{ "Id":{ "shape":"TrafficDistributionGroupId", "documentation":"<p>The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group.</p>" }, "Arn":{ "shape":"TrafficDistributionGroupArn", "documentation":"<p>The Amazon Resource Name (ARN) of the traffic distribution group.</p>" } } }, "CreateUseCaseRequest":{ "type":"structure", "required":[ "InstanceId", "IntegrationAssociationId", "UseCaseType" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "IntegrationAssociationId":{ "shape":"IntegrationAssociationId", "documentation":"<p>The identifier for the integration association.</p>", "location":"uri", "locationName":"IntegrationAssociationId" }, "UseCaseType":{ "shape":"UseCaseType", "documentation":"<p>The type of use case to associate to the integration association. Each integration association can have only one of each use case type.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" } } }, "CreateUseCaseResponse":{ "type":"structure", "members":{ "UseCaseId":{ "shape":"UseCaseId", "documentation":"<p>The identifier of the use case.</p>" }, "UseCaseArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the use case.</p>" } } }, "CreateUserHierarchyGroupRequest":{ "type":"structure", "required":[ "Name", "InstanceId" ], "members":{ "Name":{ "shape":"HierarchyGroupName", "documentation":"<p>The name of the user hierarchy group. Must not be more than 100 characters.</p>" }, "ParentGroupId":{ "shape":"HierarchyGroupId", "documentation":"<p>The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.</p>" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" } } }, "CreateUserHierarchyGroupResponse":{ "type":"structure", "members":{ "HierarchyGroupId":{ "shape":"HierarchyGroupId", "documentation":"<p>The identifier of the hierarchy group.</p>" }, "HierarchyGroupArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the hierarchy group. </p>" } } }, "CreateUserRequest":{ "type":"structure", "required":[ "Username", "PhoneConfig", "SecurityProfileIds", "RoutingProfileId", "InstanceId" ], "members":{ "Username":{ "shape":"AgentUsername", "documentation":"<p>The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.\\@]+.</p> <p>Username can include @ only if used in an email format. For example:</p> <ul> <li> <p>Correct: testuser</p> </li> <li> <p>Correct: testuser@example.com</p> </li> <li> <p>Incorrect: testuser@example</p> </li> </ul>" }, "Password":{ "shape":"Password", "documentation":"<p>The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.</p>" }, "IdentityInfo":{ "shape":"UserIdentityInfo", "documentation":"<p>The information about the identity of the user.</p>" }, "PhoneConfig":{ "shape":"UserPhoneConfig", "documentation":"<p>The phone settings for the user.</p>" }, "DirectoryUserId":{ "shape":"DirectoryUserId", "documentation":"<p>The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.</p> <p>This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.</p>" }, "SecurityProfileIds":{ "shape":"SecurityProfileIds", "documentation":"<p>The identifier of the security profile for the user.</p>" }, "RoutingProfileId":{ "shape":"RoutingProfileId", "documentation":"<p>The identifier of the routing profile for the user.</p>" }, "HierarchyGroupId":{ "shape":"HierarchyGroupId", "documentation":"<p>The identifier of the hierarchy group for the user.</p>" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" } } }, "CreateUserResponse":{ "type":"structure", "members":{ "UserId":{ "shape":"UserId", "documentation":"<p>The identifier of the user account.</p>" }, "UserArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the user account.</p>" } } }, "CreateViewRequest":{ "type":"structure", "required":[ "InstanceId", "Status", "Content", "Name" ], "members":{ "InstanceId":{ "shape":"ViewsInstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ClientToken":{ "shape":"ViewsClientToken", "documentation":"<p>A unique Id for each create view request to avoid duplicate view creation. For example, the view is idempotent ClientToken is provided.</p>" }, "Status":{ "shape":"ViewStatus", "documentation":"<p>Indicates the view status as either <code>SAVED</code> or <code>PUBLISHED</code>. The <code>PUBLISHED</code> status will initiate validation on the content.</p>" }, "Content":{ "shape":"ViewInputContent", "documentation":"<p>View content containing all content necessary to render a view except for runtime input data.</p> <p>The total uncompressed content has a maximum file size of 400kB.</p>" }, "Description":{ "shape":"ViewDescription", "documentation":"<p>The description of the view.</p>" }, "Name":{ "shape":"ViewName", "documentation":"<p>The name of the view.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags associated with the view resource (not specific to view version).These tags can be used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" } } }, "CreateViewResponse":{ "type":"structure", "members":{ "View":{ "shape":"View", "documentation":"<p>A view resource object. Contains metadata and content necessary to render the view.</p>" } } }, "CreateViewVersionRequest":{ "type":"structure", "required":[ "InstanceId", "ViewId" ], "members":{ "InstanceId":{ "shape":"ViewsInstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ViewId":{ "shape":"ViewId", "documentation":"<p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be used.</p>", "location":"uri", "locationName":"ViewId" }, "VersionDescription":{ "shape":"ViewDescription", "documentation":"<p>The description for the version being published.</p>" }, "ViewContentSha256":{ "shape":"ViewContentSha256", "documentation":"<p>Indicates the checksum value of the latest published view content.</p>" } } }, "CreateViewVersionResponse":{ "type":"structure", "members":{ "View":{ "shape":"View", "documentation":"<p>All view data is contained within the View object.</p>" } } }, "CreateVocabularyRequest":{ "type":"structure", "required":[ "InstanceId", "VocabularyName", "LanguageCode", "Content" ], "members":{ "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>. If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.</p>", "idempotencyToken":true }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "VocabularyName":{ "shape":"VocabularyName", "documentation":"<p>A unique name of the custom vocabulary.</p>" }, "LanguageCode":{ "shape":"VocabularyLanguageCode", "documentation":"<p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html\">What is Amazon Transcribe?</a> </p>" }, "Content":{ "shape":"VocabularyContent", "documentation":"<p>The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with <code>Phrase</code>, <code>IPA</code>, <code>SoundsLike</code>, and <code>DisplayAs</code> fields. Separate the fields with TAB characters. The size limit is 50KB. For more information, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table\">Create a custom vocabulary using a table</a>.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" } } }, "CreateVocabularyResponse":{ "type":"structure", "required":[ "VocabularyArn", "VocabularyId", "State" ], "members":{ "VocabularyArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the custom vocabulary.</p>" }, "VocabularyId":{ "shape":"VocabularyId", "documentation":"<p>The identifier of the custom vocabulary.</p>" }, "State":{ "shape":"VocabularyState", "documentation":"<p>The current state of the custom vocabulary.</p>" } } }, "CreatedByInfo":{ "type":"structure", "members":{ "ConnectUserArn":{ "shape":"ARN", "documentation":"<p>An agent ARN representing a <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-resources-for-iam-policies\">connect user</a>.</p>" }, "AWSIdentityArn":{ "shape":"ARN", "documentation":"<p>STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if <code>ConnectUserArn</code> is not provided.</p>" } }, "documentation":"<p>Information on the identity that created the file.</p>", "union":true }, "Credentials":{ "type":"structure", "members":{ "AccessToken":{ "shape":"SecurityToken", "documentation":"<p>An access token generated for a federated user to access Amazon Connect.</p>" }, "AccessTokenExpiration":{ "shape":"timestamp", "documentation":"<p>A token generated with an expiration time for the session a user is logged in to Amazon Connect.</p>" }, "RefreshToken":{ "shape":"SecurityToken", "documentation":"<p>Renews a token generated for a user to access the Amazon Connect instance.</p>" }, "RefreshTokenExpiration":{ "shape":"timestamp", "documentation":"<p>Renews the expiration timer for a generated token.</p>" } }, "documentation":"<p>Contains credentials to use for federation.</p>", "sensitive":true }, "CrossChannelBehavior":{ "type":"structure", "required":["BehaviorType"], "members":{ "BehaviorType":{ "shape":"BehaviorType", "documentation":"<p>Specifies the other channels that can be routed to an agent handling their current channel.</p>" } }, "documentation":"<p>Defines the cross-channel routing behavior that allows an agent working on a contact in one channel to be offered a contact from a different channel.</p>" }, "CurrentMetric":{ "type":"structure", "members":{ "Name":{ "shape":"CurrentMetricName", "documentation":"<p>The name of the metric.</p>" }, "Unit":{ "shape":"Unit", "documentation":"<p>The unit for the metric.</p>" } }, "documentation":"<p>Contains information about a real-time metric. For a description of each metric, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html\">Metrics definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "CurrentMetricData":{ "type":"structure", "members":{ "Metric":{ "shape":"CurrentMetric", "documentation":"<p>Information about the metric.</p>" }, "Value":{ "shape":"Value", "documentation":"<p>The value of the metric.</p>", "box":true } }, "documentation":"<p>Contains the data for a real-time metric.</p>" }, "CurrentMetricDataCollections":{ "type":"list", "member":{"shape":"CurrentMetricData"} }, "CurrentMetricName":{ "type":"string", "documentation":"<p>The current metric names.</p>", "enum":[ "AGENTS_ONLINE", "AGENTS_AVAILABLE", "AGENTS_ON_CALL", "AGENTS_NON_PRODUCTIVE", "AGENTS_AFTER_CONTACT_WORK", "AGENTS_ERROR", "AGENTS_STAFFED", "CONTACTS_IN_QUEUE", "OLDEST_CONTACT_AGE", "CONTACTS_SCHEDULED", "AGENTS_ON_CONTACT", "SLOTS_ACTIVE", "SLOTS_AVAILABLE" ] }, "CurrentMetricResult":{ "type":"structure", "members":{ "Dimensions":{ "shape":"Dimensions", "documentation":"<p>The dimensions for the metrics.</p>" }, "Collections":{ "shape":"CurrentMetricDataCollections", "documentation":"<p>The set of metrics.</p>" } }, "documentation":"<p>Contains information about a set of real-time metrics.</p>" }, "CurrentMetricResults":{ "type":"list", "member":{"shape":"CurrentMetricResult"} }, "CurrentMetricSortCriteria":{ "type":"structure", "members":{ "SortByMetric":{"shape":"CurrentMetricName"}, "SortOrder":{ "shape":"SortOrder", "documentation":"<p>The way to sort.</p>" } }, "documentation":"<p>The way to sort the resulting response based on metrics. By default resources are sorted based on <code>AGENTS_ONLINE</code>, <code>DESCENDING</code>. The metric collection is sorted based on the input metrics.</p>" }, "CurrentMetricSortCriteriaMaxOne":{ "type":"list", "member":{"shape":"CurrentMetricSortCriteria"}, "max":1, "min":0 }, "CurrentMetrics":{ "type":"list", "member":{"shape":"CurrentMetric"} }, "Customer":{ "type":"structure", "members":{ "DeviceInfo":{ "shape":"DeviceInfo", "documentation":"<p>Information regarding Customer’s device.</p>" }, "Capabilities":{"shape":"ParticipantCapabilities"} }, "documentation":"<p>Information about the Customer on the contact.</p>" }, "CustomerId":{ "type":"string", "max":128, "min":0 }, "CustomerIdNonEmpty":{ "type":"string", "max":128, "min":1, "sensitive":true }, "CustomerProfileAttributesSerialized":{"type":"string"}, "CustomerQualityMetrics":{ "type":"structure", "members":{ "Audio":{ "shape":"AudioQualityMetricsInfo", "documentation":"<p>Information about the audio quality of the Customer</p>" } }, "documentation":"<p>Information about the quality of the Customer's media connection</p>" }, "CustomerVoiceActivity":{ "type":"structure", "members":{ "GreetingStartTimestamp":{ "shape":"timestamp", "documentation":"<p>Timestamp that measures the beginning of the customer greeting from an outbound voice call.</p>" }, "GreetingEndTimestamp":{ "shape":"timestamp", "documentation":"<p>Timestamp that measures the end of the customer greeting from an outbound voice call.</p>" } }, "documentation":"<p>Information about customer’s voice activity.</p>" }, "DataSetId":{ "type":"string", "max":255, "min":1 }, "DataSetIds":{ "type":"list", "member":{"shape":"DataSetId"} }, "DateComparisonType":{ "type":"string", "enum":[ "GREATER_THAN", "LESS_THAN", "GREATER_THAN_OR_EQUAL_TO", "LESS_THAN_OR_EQUAL_TO", "EQUAL_TO" ] }, "DateCondition":{ "type":"structure", "members":{ "FieldName":{ "shape":"String", "documentation":"<p>An object to specify the hours of operation override date field.</p>" }, "Value":{ "shape":"DateYearMonthDayFormat", "documentation":"<p>An object to specify the hours of operation override date value.</p>" }, "ComparisonType":{ "shape":"DateComparisonType", "documentation":"<p>An object to specify the hours of operation override date condition <code>comparisonType</code>.</p>" } }, "documentation":"<p>An object to specify the hours of operation override date condition.</p>" }, "DateReference":{ "type":"structure", "members":{ "Name":{ "shape":"ReferenceKey", "documentation":"<p>Identifier of the date reference.</p>" }, "Value":{ "shape":"ReferenceValue", "documentation":"<p>A valid date.</p>" } }, "documentation":"<p>Information about a reference when the <code>referenceType</code> is <code>DATE</code>. Otherwise, null.</p>" }, "DateYearMonthDayFormat":{ "type":"string", "pattern":"^\\d{4}-\\d{2}-\\d{2}$" }, "DeactivateEvaluationFormRequest":{ "type":"structure", "required":[ "InstanceId", "EvaluationFormId", "EvaluationFormVersion" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "EvaluationFormId":{ "shape":"ResourceId", "documentation":"<p>The unique identifier for the evaluation form.</p>", "location":"uri", "locationName":"EvaluationFormId" }, "EvaluationFormVersion":{ "shape":"VersionNumber", "documentation":"<p>A version of the evaluation form. If the version property is not provided, the latest version of the evaluation form is deactivated.</p>" } } }, "DeactivateEvaluationFormResponse":{ "type":"structure", "required":[ "EvaluationFormId", "EvaluationFormArn", "EvaluationFormVersion" ], "members":{ "EvaluationFormId":{ "shape":"ResourceId", "documentation":"<p>The unique identifier for the evaluation form.</p>" }, "EvaluationFormArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>" }, "EvaluationFormVersion":{ "shape":"VersionNumber", "documentation":"<p>The version of the deactivated evaluation form resource.</p>" } } }, "DefaultVocabulary":{ "type":"structure", "required":[ "InstanceId", "LanguageCode", "VocabularyId", "VocabularyName" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "LanguageCode":{ "shape":"VocabularyLanguageCode", "documentation":"<p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html\">What is Amazon Transcribe?</a> </p>" }, "VocabularyId":{ "shape":"VocabularyId", "documentation":"<p>The identifier of the custom vocabulary.</p>" }, "VocabularyName":{ "shape":"VocabularyName", "documentation":"<p>A unique name of the custom vocabulary.</p>" } }, "documentation":"<p>Contains information about a default vocabulary.</p>" }, "DefaultVocabularyList":{ "type":"list", "member":{"shape":"DefaultVocabulary"} }, "Delay":{ "type":"integer", "max":9999, "min":0 }, "DeleteAttachedFileRequest":{ "type":"structure", "required":[ "InstanceId", "FileId", "AssociatedResourceArn" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The unique identifier of the Connect instance.</p>", "location":"uri", "locationName":"InstanceId" }, "FileId":{ "shape":"FileId", "documentation":"<p>The unique identifier of the attached file resource.</p>", "location":"uri", "locationName":"FileId" }, "AssociatedResourceArn":{ "shape":"ARN", "documentation":"<p>The resource to which the attached file is (being) uploaded to. <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html\">Cases</a> are the only current supported resource.</p> <note> <p>This value must be a valid ARN.</p> </note>", "location":"querystring", "locationName":"associatedResourceArn" } }, "documentation":"Request to DeleteAttachedFile API" }, "DeleteAttachedFileResponse":{ "type":"structure", "members":{}, "documentation":"Response from DeleteAttachedFile API" }, "DeleteContactEvaluationRequest":{ "type":"structure", "required":[ "InstanceId", "EvaluationId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "EvaluationId":{ "shape":"ResourceId", "documentation":"<p>A unique identifier for the contact evaluation.</p>", "location":"uri", "locationName":"EvaluationId" } } }, "DeleteContactFlowModuleRequest":{ "type":"structure", "required":[ "InstanceId", "ContactFlowModuleId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ContactFlowModuleId":{ "shape":"ContactFlowModuleId", "documentation":"<p>The identifier of the flow module.</p>", "location":"uri", "locationName":"ContactFlowModuleId" } } }, "DeleteContactFlowModuleResponse":{ "type":"structure", "members":{} }, "DeleteContactFlowRequest":{ "type":"structure", "required":[ "InstanceId", "ContactFlowId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ContactFlowId":{ "shape":"ContactFlowId", "documentation":"<p>The identifier of the flow.</p>", "location":"uri", "locationName":"ContactFlowId" } } }, "DeleteContactFlowResponse":{ "type":"structure", "members":{} }, "DeleteContactFlowVersionRequest":{ "type":"structure", "required":[ "InstanceId", "ContactFlowId", "ContactFlowVersion" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ContactFlowId":{ "shape":"ARN", "documentation":"<p>The identifier of the flow.</p>", "location":"uri", "locationName":"ContactFlowId" }, "ContactFlowVersion":{ "shape":"ResourceVersion", "documentation":"<p>The identifier of the flow version.</p>", "location":"uri", "locationName":"ContactFlowVersion" } } }, "DeleteContactFlowVersionResponse":{ "type":"structure", "members":{} }, "DeleteEmailAddressRequest":{ "type":"structure", "required":[ "InstanceId", "EmailAddressId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "EmailAddressId":{ "shape":"EmailAddressId", "documentation":"<p>The identifier of the email address.</p>", "location":"uri", "locationName":"EmailAddressId" } } }, "DeleteEmailAddressResponse":{ "type":"structure", "members":{} }, "DeleteEvaluationFormRequest":{ "type":"structure", "required":[ "InstanceId", "EvaluationFormId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "EvaluationFormId":{ "shape":"ResourceId", "documentation":"<p>The unique identifier for the evaluation form.</p>", "location":"uri", "locationName":"EvaluationFormId" }, "EvaluationFormVersion":{ "shape":"VersionNumber", "documentation":"<p>The unique identifier for the evaluation form.</p>", "box":true, "location":"querystring", "locationName":"version" } } }, "DeleteHoursOfOperationOverrideRequest":{ "type":"structure", "required":[ "InstanceId", "HoursOfOperationId", "HoursOfOperationOverrideId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance.</p>", "location":"uri", "locationName":"InstanceId" }, "HoursOfOperationId":{ "shape":"HoursOfOperationId", "documentation":"<p>The identifier for the hours of operation.</p>", "location":"uri", "locationName":"HoursOfOperationId" }, "HoursOfOperationOverrideId":{ "shape":"HoursOfOperationOverrideId", "documentation":"<p>The identifier for the hours of operation override.</p>", "location":"uri", "locationName":"HoursOfOperationOverrideId" } } }, "DeleteHoursOfOperationRequest":{ "type":"structure", "required":[ "InstanceId", "HoursOfOperationId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "HoursOfOperationId":{ "shape":"HoursOfOperationId", "documentation":"<p>The identifier for the hours of operation.</p>", "location":"uri", "locationName":"HoursOfOperationId" } } }, "DeleteInstanceRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" } } }, "DeleteIntegrationAssociationRequest":{ "type":"structure", "required":[ "InstanceId", "IntegrationAssociationId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "IntegrationAssociationId":{ "shape":"IntegrationAssociationId", "documentation":"<p>The identifier for the integration association.</p>", "location":"uri", "locationName":"IntegrationAssociationId" } } }, "DeletePredefinedAttributeRequest":{ "type":"structure", "required":[ "InstanceId", "Name" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p> The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Name":{ "shape":"PredefinedAttributeName", "documentation":"<p> The name of the predefined attribute.</p>", "location":"uri", "locationName":"Name" } } }, "DeletePromptRequest":{ "type":"structure", "required":[ "InstanceId", "PromptId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "PromptId":{ "shape":"PromptId", "documentation":"<p>A unique identifier for the prompt.</p>", "location":"uri", "locationName":"PromptId" } } }, "DeletePushNotificationRegistrationRequest":{ "type":"structure", "required":[ "InstanceId", "RegistrationId", "ContactId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "RegistrationId":{ "shape":"RegistrationId", "documentation":"<p>The identifier for the registration.</p>", "location":"uri", "locationName":"RegistrationId" }, "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact within the Amazon Connect instance.</p>", "location":"querystring", "locationName":"contactId" } } }, "DeletePushNotificationRegistrationResponse":{ "type":"structure", "members":{} }, "DeleteQueueRequest":{ "type":"structure", "required":[ "InstanceId", "QueueId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "QueueId":{ "shape":"QueueId", "documentation":"<p>The identifier for the queue.</p>", "location":"uri", "locationName":"QueueId" } } }, "DeleteQuickConnectRequest":{ "type":"structure", "required":[ "InstanceId", "QuickConnectId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "QuickConnectId":{ "shape":"QuickConnectId", "documentation":"<p>The identifier for the quick connect.</p>", "location":"uri", "locationName":"QuickConnectId" } } }, "DeleteRoutingProfileRequest":{ "type":"structure", "required":[ "InstanceId", "RoutingProfileId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "RoutingProfileId":{ "shape":"RoutingProfileId", "documentation":"<p>The identifier of the routing profile.</p>", "location":"uri", "locationName":"RoutingProfileId" } } }, "DeleteRuleRequest":{ "type":"structure", "required":[ "InstanceId", "RuleId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "RuleId":{ "shape":"RuleId", "documentation":"<p>A unique identifier for the rule.</p>", "location":"uri", "locationName":"RuleId" } } }, "DeleteSecurityProfileRequest":{ "type":"structure", "required":[ "InstanceId", "SecurityProfileId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "SecurityProfileId":{ "shape":"SecurityProfileId", "documentation":"<p>The identifier for the security profle.</p>", "location":"uri", "locationName":"SecurityProfileId" } } }, "DeleteTaskTemplateRequest":{ "type":"structure", "required":[ "InstanceId", "TaskTemplateId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "TaskTemplateId":{ "shape":"TaskTemplateId", "documentation":"<p>A unique identifier for the task template.</p>", "location":"uri", "locationName":"TaskTemplateId" } } }, "DeleteTaskTemplateResponse":{ "type":"structure", "members":{} }, "DeleteTrafficDistributionGroupRequest":{ "type":"structure", "required":["TrafficDistributionGroupId"], "members":{ "TrafficDistributionGroupId":{ "shape":"TrafficDistributionGroupIdOrArn", "documentation":"<p>The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group.</p>", "location":"uri", "locationName":"TrafficDistributionGroupId" } } }, "DeleteTrafficDistributionGroupResponse":{ "type":"structure", "members":{} }, "DeleteUseCaseRequest":{ "type":"structure", "required":[ "InstanceId", "IntegrationAssociationId", "UseCaseId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "IntegrationAssociationId":{ "shape":"IntegrationAssociationId", "documentation":"<p>The identifier for the integration association.</p>", "location":"uri", "locationName":"IntegrationAssociationId" }, "UseCaseId":{ "shape":"UseCaseId", "documentation":"<p>The identifier for the use case.</p>", "location":"uri", "locationName":"UseCaseId" } } }, "DeleteUserHierarchyGroupRequest":{ "type":"structure", "required":[ "HierarchyGroupId", "InstanceId" ], "members":{ "HierarchyGroupId":{ "shape":"HierarchyGroupId", "documentation":"<p>The identifier of the hierarchy group.</p>", "location":"uri", "locationName":"HierarchyGroupId" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" } } }, "DeleteUserRequest":{ "type":"structure", "required":[ "InstanceId", "UserId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "UserId":{ "shape":"UserId", "documentation":"<p>The identifier of the user.</p>", "location":"uri", "locationName":"UserId" } } }, "DeleteViewRequest":{ "type":"structure", "required":[ "InstanceId", "ViewId" ], "members":{ "InstanceId":{ "shape":"ViewsInstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ViewId":{ "shape":"ViewId", "documentation":"<p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be used.</p>", "location":"uri", "locationName":"ViewId" } } }, "DeleteViewResponse":{ "type":"structure", "members":{} }, "DeleteViewVersionRequest":{ "type":"structure", "required":[ "InstanceId", "ViewId", "ViewVersion" ], "members":{ "InstanceId":{ "shape":"ViewsInstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ViewId":{ "shape":"ViewId", "documentation":"<p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be used.</p>", "location":"uri", "locationName":"ViewId" }, "ViewVersion":{ "shape":"ViewVersion", "documentation":"<p>The version number of the view.</p>", "location":"uri", "locationName":"ViewVersion" } } }, "DeleteViewVersionResponse":{ "type":"structure", "members":{} }, "DeleteVocabularyRequest":{ "type":"structure", "required":[ "InstanceId", "VocabularyId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "VocabularyId":{ "shape":"VocabularyId", "documentation":"<p>The identifier of the custom vocabulary.</p>", "location":"uri", "locationName":"VocabularyId" } } }, "DeleteVocabularyResponse":{ "type":"structure", "required":[ "VocabularyArn", "VocabularyId", "State" ], "members":{ "VocabularyArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the custom vocabulary.</p>" }, "VocabularyId":{ "shape":"VocabularyId", "documentation":"<p>The identifier of the custom vocabulary.</p>" }, "State":{ "shape":"VocabularyState", "documentation":"<p>The current state of the custom vocabulary.</p>" } } }, "DescribeAgentStatusRequest":{ "type":"structure", "required":[ "InstanceId", "AgentStatusId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "AgentStatusId":{ "shape":"AgentStatusId", "documentation":"<p>The identifier for the agent status.</p>", "location":"uri", "locationName":"AgentStatusId" } } }, "DescribeAgentStatusResponse":{ "type":"structure", "members":{ "AgentStatus":{ "shape":"AgentStatus", "documentation":"<p>The agent status.</p>" } } }, "DescribeAuthenticationProfileRequest":{ "type":"structure", "required":[ "AuthenticationProfileId", "InstanceId" ], "members":{ "AuthenticationProfileId":{ "shape":"AuthenticationProfileId", "documentation":"<p>A unique identifier for the authentication profile. </p>", "location":"uri", "locationName":"AuthenticationProfileId" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" } } }, "DescribeAuthenticationProfileResponse":{ "type":"structure", "members":{ "AuthenticationProfile":{ "shape":"AuthenticationProfile", "documentation":"<p>The authentication profile object being described.</p>" } } }, "DescribeContactEvaluationRequest":{ "type":"structure", "required":[ "InstanceId", "EvaluationId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "EvaluationId":{ "shape":"ResourceId", "documentation":"<p>A unique identifier for the contact evaluation.</p>", "location":"uri", "locationName":"EvaluationId" } } }, "DescribeContactEvaluationResponse":{ "type":"structure", "required":[ "Evaluation", "EvaluationForm" ], "members":{ "Evaluation":{ "shape":"Evaluation", "documentation":"<p>Information about the evaluation form completed for a specific contact.</p>" }, "EvaluationForm":{ "shape":"EvaluationFormContent", "documentation":"<p>Information about the evaluation form.</p>" } } }, "DescribeContactFlowModuleRequest":{ "type":"structure", "required":[ "InstanceId", "ContactFlowModuleId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ContactFlowModuleId":{ "shape":"ContactFlowModuleId", "documentation":"<p>The identifier of the flow module.</p>", "location":"uri", "locationName":"ContactFlowModuleId" } } }, "DescribeContactFlowModuleResponse":{ "type":"structure", "members":{ "ContactFlowModule":{ "shape":"ContactFlowModule", "documentation":"<p>Information about the flow module.</p>" } } }, "DescribeContactFlowRequest":{ "type":"structure", "required":[ "InstanceId", "ContactFlowId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ContactFlowId":{ "shape":"ContactFlowId", "documentation":"<p>The identifier of the flow.</p>", "location":"uri", "locationName":"ContactFlowId" } } }, "DescribeContactFlowResponse":{ "type":"structure", "members":{ "ContactFlow":{ "shape":"ContactFlow", "documentation":"<p>Information about the flow.</p>" } } }, "DescribeContactRequest":{ "type":"structure", "required":[ "InstanceId", "ContactId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact.</p>", "location":"uri", "locationName":"ContactId" } } }, "DescribeContactResponse":{ "type":"structure", "members":{ "Contact":{ "shape":"Contact", "documentation":"<p>Information about the contact.</p>" } } }, "DescribeEmailAddressRequest":{ "type":"structure", "required":[ "InstanceId", "EmailAddressId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "EmailAddressId":{ "shape":"EmailAddressId", "documentation":"<p>The identifier of the email address.</p>", "location":"uri", "locationName":"EmailAddressId" } } }, "DescribeEmailAddressResponse":{ "type":"structure", "members":{ "EmailAddressId":{ "shape":"EmailAddressId", "documentation":"<p>The identifier of the email address.</p>" }, "EmailAddressArn":{ "shape":"EmailAddressArn", "documentation":"<p>The Amazon Resource Name (ARN) of the email address.</p>" }, "EmailAddress":{ "shape":"EmailAddress", "documentation":"<p>The email address, including the domain.</p>" }, "DisplayName":{ "shape":"EmailAddressDisplayName", "documentation":"<p>The display name of email address</p>" }, "Description":{ "shape":"Description", "documentation":"<p>The description of the email address.</p>" }, "CreateTimestamp":{ "shape":"ISO8601Datetime", "documentation":"<p>The email address creation timestamp in ISO 8601 Datetime.</p>" }, "ModifiedTimestamp":{ "shape":"ISO8601Datetime", "documentation":"<p>The email address last modification timestamp in ISO 8601 Datetime.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" } } }, "DescribeEvaluationFormRequest":{ "type":"structure", "required":[ "InstanceId", "EvaluationFormId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "EvaluationFormId":{ "shape":"ResourceId", "documentation":"<p>A unique identifier for the contact evaluation.</p>", "location":"uri", "locationName":"EvaluationFormId" }, "EvaluationFormVersion":{ "shape":"VersionNumber", "documentation":"<p>A version of the evaluation form.</p>", "box":true, "location":"querystring", "locationName":"version" } } }, "DescribeEvaluationFormResponse":{ "type":"structure", "required":["EvaluationForm"], "members":{ "EvaluationForm":{ "shape":"EvaluationForm", "documentation":"<p>Information about the evaluation form.</p>" } } }, "DescribeHoursOfOperationOverrideRequest":{ "type":"structure", "required":[ "InstanceId", "HoursOfOperationId", "HoursOfOperationOverrideId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance.</p>", "location":"uri", "locationName":"InstanceId" }, "HoursOfOperationId":{ "shape":"HoursOfOperationId", "documentation":"<p>The identifier for the hours of operation.</p>", "location":"uri", "locationName":"HoursOfOperationId" }, "HoursOfOperationOverrideId":{ "shape":"HoursOfOperationOverrideId", "documentation":"<p>The identifier for the hours of operation override.</p>", "location":"uri", "locationName":"HoursOfOperationOverrideId" } } }, "DescribeHoursOfOperationOverrideResponse":{ "type":"structure", "members":{ "HoursOfOperationOverride":{ "shape":"HoursOfOperationOverride", "documentation":"<p>Information about the hours of operations override. </p>" } } }, "DescribeHoursOfOperationRequest":{ "type":"structure", "required":[ "InstanceId", "HoursOfOperationId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "HoursOfOperationId":{ "shape":"HoursOfOperationId", "documentation":"<p>The identifier for the hours of operation.</p>", "location":"uri", "locationName":"HoursOfOperationId" } } }, "DescribeHoursOfOperationResponse":{ "type":"structure", "members":{ "HoursOfOperation":{ "shape":"HoursOfOperation", "documentation":"<p>The hours of operation.</p>" } } }, "DescribeInstanceAttributeRequest":{ "type":"structure", "required":[ "InstanceId", "AttributeType" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "AttributeType":{ "shape":"InstanceAttributeType", "documentation":"<p>The type of attribute.</p>", "location":"uri", "locationName":"AttributeType" } } }, "DescribeInstanceAttributeResponse":{ "type":"structure", "members":{ "Attribute":{ "shape":"Attribute", "documentation":"<p>The type of attribute.</p>" } } }, "DescribeInstanceRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" } } }, "DescribeInstanceResponse":{ "type":"structure", "members":{ "Instance":{ "shape":"Instance", "documentation":"<p>The name of the instance.</p>" }, "ReplicationConfiguration":{ "shape":"ReplicationConfiguration", "documentation":"<p>Status information about the replication process. This field is included only when you are using the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_ReplicateInstance.html\">ReplicateInstance</a> API to replicate an Amazon Connect instance across Amazon Web Services Regions. For information about replicating Amazon Connect instances, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/create-replica-connect-instance.html\">Create a replica of your existing Amazon Connect instance</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" } } }, "DescribeInstanceStorageConfigRequest":{ "type":"structure", "required":[ "InstanceId", "AssociationId", "ResourceType" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "AssociationId":{ "shape":"AssociationId", "documentation":"<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>", "location":"uri", "locationName":"AssociationId" }, "ResourceType":{ "shape":"InstanceStorageResourceType", "documentation":"<p>A valid resource type.</p>", "location":"querystring", "locationName":"resourceType" } } }, "DescribeInstanceStorageConfigResponse":{ "type":"structure", "members":{ "StorageConfig":{ "shape":"InstanceStorageConfig", "documentation":"<p>A valid storage type.</p>" } } }, "DescribePhoneNumberRequest":{ "type":"structure", "required":["PhoneNumberId"], "members":{ "PhoneNumberId":{ "shape":"PhoneNumberId", "documentation":"<p>A unique identifier for the phone number.</p>", "location":"uri", "locationName":"PhoneNumberId" } } }, "DescribePhoneNumberResponse":{ "type":"structure", "members":{ "ClaimedPhoneNumberSummary":{ "shape":"ClaimedPhoneNumberSummary", "documentation":"<p>Information about a phone number that's been claimed to your Amazon Connect instance or traffic distribution group.</p>" } } }, "DescribePredefinedAttributeRequest":{ "type":"structure", "required":[ "InstanceId", "Name" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Name":{ "shape":"PredefinedAttributeName", "documentation":"<p>The name of the predefined attribute.</p>", "location":"uri", "locationName":"Name" } } }, "DescribePredefinedAttributeResponse":{ "type":"structure", "members":{ "PredefinedAttribute":{ "shape":"PredefinedAttribute", "documentation":"<p>Information about the predefined attribute.</p>" } } }, "DescribePromptRequest":{ "type":"structure", "required":[ "InstanceId", "PromptId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "PromptId":{ "shape":"PromptId", "documentation":"<p>A unique identifier for the prompt.</p>", "location":"uri", "locationName":"PromptId" } } }, "DescribePromptResponse":{ "type":"structure", "members":{ "Prompt":{ "shape":"Prompt", "documentation":"<p>Information about the prompt.</p>" } } }, "DescribeQueueRequest":{ "type":"structure", "required":[ "InstanceId", "QueueId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "QueueId":{ "shape":"QueueId", "documentation":"<p>The identifier for the queue.</p>", "location":"uri", "locationName":"QueueId" } } }, "DescribeQueueResponse":{ "type":"structure", "members":{ "Queue":{ "shape":"Queue", "documentation":"<p>The name of the queue.</p>" } } }, "DescribeQuickConnectRequest":{ "type":"structure", "required":[ "InstanceId", "QuickConnectId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "QuickConnectId":{ "shape":"QuickConnectId", "documentation":"<p>The identifier for the quick connect.</p>", "location":"uri", "locationName":"QuickConnectId" } } }, "DescribeQuickConnectResponse":{ "type":"structure", "members":{ "QuickConnect":{ "shape":"QuickConnect", "documentation":"<p>Information about the quick connect.</p>" } } }, "DescribeRoutingProfileRequest":{ "type":"structure", "required":[ "InstanceId", "RoutingProfileId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "RoutingProfileId":{ "shape":"RoutingProfileId", "documentation":"<p>The identifier of the routing profile.</p>", "location":"uri", "locationName":"RoutingProfileId" } } }, "DescribeRoutingProfileResponse":{ "type":"structure", "members":{ "RoutingProfile":{ "shape":"RoutingProfile", "documentation":"<p>The routing profile.</p>" } } }, "DescribeRuleRequest":{ "type":"structure", "required":[ "InstanceId", "RuleId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "RuleId":{ "shape":"RuleId", "documentation":"<p>A unique identifier for the rule.</p>", "location":"uri", "locationName":"RuleId" } } }, "DescribeRuleResponse":{ "type":"structure", "required":["Rule"], "members":{ "Rule":{ "shape":"Rule", "documentation":"<p>Information about the rule.</p>" } } }, "DescribeSecurityProfileRequest":{ "type":"structure", "required":[ "SecurityProfileId", "InstanceId" ], "members":{ "SecurityProfileId":{ "shape":"SecurityProfileId", "documentation":"<p>The identifier for the security profle.</p>", "location":"uri", "locationName":"SecurityProfileId" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" } } }, "DescribeSecurityProfileResponse":{ "type":"structure", "members":{ "SecurityProfile":{ "shape":"SecurityProfile", "documentation":"<p>The security profile.</p>" } } }, "DescribeTrafficDistributionGroupRequest":{ "type":"structure", "required":["TrafficDistributionGroupId"], "members":{ "TrafficDistributionGroupId":{ "shape":"TrafficDistributionGroupIdOrArn", "documentation":"<p>The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.</p>", "location":"uri", "locationName":"TrafficDistributionGroupId" } } }, "DescribeTrafficDistributionGroupResponse":{ "type":"structure", "members":{ "TrafficDistributionGroup":{ "shape":"TrafficDistributionGroup", "documentation":"<p>Information about the traffic distribution group.</p>" } } }, "DescribeUserHierarchyGroupRequest":{ "type":"structure", "required":[ "HierarchyGroupId", "InstanceId" ], "members":{ "HierarchyGroupId":{ "shape":"HierarchyGroupId", "documentation":"<p>The identifier of the hierarchy group.</p>", "location":"uri", "locationName":"HierarchyGroupId" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" } } }, "DescribeUserHierarchyGroupResponse":{ "type":"structure", "members":{ "HierarchyGroup":{ "shape":"HierarchyGroup", "documentation":"<p>Information about the hierarchy group.</p>" } } }, "DescribeUserHierarchyStructureRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" } } }, "DescribeUserHierarchyStructureResponse":{ "type":"structure", "members":{ "HierarchyStructure":{ "shape":"HierarchyStructure", "documentation":"<p>Information about the hierarchy structure.</p>" } } }, "DescribeUserRequest":{ "type":"structure", "required":[ "UserId", "InstanceId" ], "members":{ "UserId":{ "shape":"UserId", "documentation":"<p>The identifier of the user account.</p>", "location":"uri", "locationName":"UserId" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" } } }, "DescribeUserResponse":{ "type":"structure", "members":{ "User":{ "shape":"User", "documentation":"<p>Information about the user account and configuration settings.</p>" } } }, "DescribeViewRequest":{ "type":"structure", "required":[ "InstanceId", "ViewId" ], "members":{ "InstanceId":{ "shape":"ViewsInstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ViewId":{ "shape":"ViewId", "documentation":"<p>The ViewId of the view. This must be an ARN for Amazon Web Services managed views.</p>", "location":"uri", "locationName":"ViewId" } } }, "DescribeViewResponse":{ "type":"structure", "members":{ "View":{ "shape":"View", "documentation":"<p>All view data is contained within the View object.</p>" } } }, "DescribeVocabularyRequest":{ "type":"structure", "required":[ "InstanceId", "VocabularyId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "VocabularyId":{ "shape":"VocabularyId", "documentation":"<p>The identifier of the custom vocabulary.</p>", "location":"uri", "locationName":"VocabularyId" } } }, "DescribeVocabularyResponse":{ "type":"structure", "required":["Vocabulary"], "members":{ "Vocabulary":{ "shape":"Vocabulary", "documentation":"<p>A list of specific words that you want Contact Lens for Amazon Connect to recognize in your audio input. They are generally domain-specific words and phrases, words that Contact Lens is not recognizing, or proper nouns.</p>" } } }, "Description":{ "type":"string", "max":4096, "min":0, "sensitive":true }, "Description250":{ "type":"string", "max":250, "min":1, "pattern":"(^[\\S].*[\\S]$)|(^[\\S]$)" }, "DestinationId":{ "type":"string", "max":255, "min":1 }, "DestinationNotAllowedException":{ "type":"structure", "members":{ "Message":{ "shape":"Message", "documentation":"<p>The message about the outbound calls.</p>" } }, "documentation":"<p>Outbound calls to the destination number are not allowed.</p>", "error":{"httpStatusCode":403}, "exception":true }, "DeviceInfo":{ "type":"structure", "members":{ "PlatformName":{ "shape":"PlatformName", "documentation":"<p>Name of the platform that the participant used for the call.</p>" }, "PlatformVersion":{ "shape":"PlatformVersion", "documentation":"<p>Version of the platform that the participant used for the call.</p>" }, "OperatingSystem":{ "shape":"OperatingSystem", "documentation":"<p>Operating system that the participant used for the call.</p>" } }, "documentation":"<p>Information regarding the device.</p>" }, "DeviceToken":{ "type":"string", "max":500, "min":1 }, "DeviceType":{ "type":"string", "enum":[ "GCM", "APNS", "APNS_SANDBOX" ] }, "Dimensions":{ "type":"structure", "members":{ "Queue":{ "shape":"QueueReference", "documentation":"<p>Information about the queue for which metrics are returned.</p>" }, "Channel":{ "shape":"Channel", "documentation":"<p>The channel used for grouping and filters.</p>" }, "RoutingProfile":{"shape":"RoutingProfileReference"}, "RoutingStepExpression":{ "shape":"RoutingExpression", "documentation":"<p>The expression of a step in a routing criteria.</p>" } }, "documentation":"<p>Contains information about the dimensions for a set of metrics.</p>" }, "DimensionsV2Key":{"type":"string"}, "DimensionsV2Map":{ "type":"map", "key":{"shape":"DimensionsV2Key"}, "value":{"shape":"DimensionsV2Value"} }, "DimensionsV2Value":{"type":"string"}, "DirectoryAlias":{ "type":"string", "max":45, "min":1, "pattern":"^(?!d-)([\\da-zA-Z]+)([-]*[\\da-zA-Z])*$", "sensitive":true }, "DirectoryId":{ "type":"string", "max":12, "min":12, "pattern":"^d-[0-9a-f]{10}$" }, "DirectoryType":{ "type":"string", "enum":[ "SAML", "CONNECT_MANAGED", "EXISTING_DIRECTORY" ] }, "DirectoryUserId":{"type":"string"}, "DisassociateAnalyticsDataSetRequest":{ "type":"structure", "required":[ "InstanceId", "DataSetId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "DataSetId":{ "shape":"DataSetId", "documentation":"<p>The identifier of the dataset to remove.</p>" }, "TargetAccountId":{ "shape":"AWSAccountId", "documentation":"<p>The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.</p>" } } }, "DisassociateApprovedOriginRequest":{ "type":"structure", "required":[ "InstanceId", "Origin" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Origin":{ "shape":"Origin", "documentation":"<p>The domain URL of the integrated application.</p>", "location":"querystring", "locationName":"origin" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" } } }, "DisassociateBotRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "LexBot":{"shape":"LexBot"}, "LexV2Bot":{ "shape":"LexV2Bot", "documentation":"<p>The Amazon Lex V2 bot to disassociate from the instance.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true } } }, "DisassociateFlowRequest":{ "type":"structure", "required":[ "InstanceId", "ResourceId", "ResourceType" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ResourceId":{ "shape":"ARN", "documentation":"<p>The identifier of the resource.</p> <ul> <li> <p>Amazon Web Services End User Messaging SMS phone number ARN when using <code>SMS_PHONE_NUMBER</code> </p> </li> <li> <p>Amazon Web Services End User Messaging Social phone number ARN when using <code>WHATSAPP_MESSAGING_PHONE_NUMBER</code> </p> </li> </ul>", "location":"uri", "locationName":"ResourceId" }, "ResourceType":{ "shape":"FlowAssociationResourceType", "documentation":"<p>A valid resource type.</p>", "location":"uri", "locationName":"ResourceType" } } }, "DisassociateFlowResponse":{ "type":"structure", "members":{} }, "DisassociateInstanceStorageConfigRequest":{ "type":"structure", "required":[ "InstanceId", "AssociationId", "ResourceType" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "AssociationId":{ "shape":"AssociationId", "documentation":"<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>", "location":"uri", "locationName":"AssociationId" }, "ResourceType":{ "shape":"InstanceStorageResourceType", "documentation":"<p>A valid resource type.</p>", "location":"querystring", "locationName":"resourceType" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" } } }, "DisassociateLambdaFunctionRequest":{ "type":"structure", "required":[ "InstanceId", "FunctionArn" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance..</p>", "location":"uri", "locationName":"InstanceId" }, "FunctionArn":{ "shape":"FunctionArn", "documentation":"<p>The Amazon Resource Name (ARN) of the Lambda function being disassociated.</p>", "location":"querystring", "locationName":"functionArn" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" } } }, "DisassociateLexBotRequest":{ "type":"structure", "required":[ "InstanceId", "BotName", "LexRegion" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "BotName":{ "shape":"BotName", "documentation":"<p>The name of the Amazon Lex bot. Maximum character limit of 50.</p>", "location":"querystring", "locationName":"botName" }, "LexRegion":{ "shape":"LexRegion", "documentation":"<p>The Amazon Web Services Region in which the Amazon Lex bot has been created.</p>", "location":"querystring", "locationName":"lexRegion" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" } } }, "DisassociatePhoneNumberContactFlowRequest":{ "type":"structure", "required":[ "PhoneNumberId", "InstanceId" ], "members":{ "PhoneNumberId":{ "shape":"PhoneNumberId", "documentation":"<p>A unique identifier for the phone number.</p>", "location":"uri", "locationName":"PhoneNumberId" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"querystring", "locationName":"instanceId" } } }, "DisassociateQueueQuickConnectsRequest":{ "type":"structure", "required":[ "InstanceId", "QueueId", "QuickConnectIds" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "QueueId":{ "shape":"QueueId", "documentation":"<p>The identifier for the queue.</p>", "location":"uri", "locationName":"QueueId" }, "QuickConnectIds":{ "shape":"QuickConnectsList", "documentation":"<p>The quick connects to disassociate from the queue.</p>" } } }, "DisassociateRoutingProfileQueuesRequest":{ "type":"structure", "required":[ "InstanceId", "RoutingProfileId", "QueueReferences" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "RoutingProfileId":{ "shape":"RoutingProfileId", "documentation":"<p>The identifier of the routing profile.</p>", "location":"uri", "locationName":"RoutingProfileId" }, "QueueReferences":{ "shape":"RoutingProfileQueueReferenceList", "documentation":"<p>The queues to disassociate from this routing profile.</p>" } } }, "DisassociateSecurityKeyRequest":{ "type":"structure", "required":[ "InstanceId", "AssociationId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "AssociationId":{ "shape":"AssociationId", "documentation":"<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>", "location":"uri", "locationName":"AssociationId" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" } } }, "DisassociateTrafficDistributionGroupUserRequest":{ "type":"structure", "required":[ "TrafficDistributionGroupId", "UserId", "InstanceId" ], "members":{ "TrafficDistributionGroupId":{ "shape":"TrafficDistributionGroupIdOrArn", "documentation":"<p>The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group.</p>", "location":"uri", "locationName":"TrafficDistributionGroupId" }, "UserId":{ "shape":"UserId", "documentation":"<p>The identifier for the user. This can be the ID or the ARN of the user.</p>", "location":"querystring", "locationName":"UserId" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"querystring", "locationName":"InstanceId" } } }, "DisassociateTrafficDistributionGroupUserResponse":{ "type":"structure", "members":{} }, "DisassociateUserProficienciesRequest":{ "type":"structure", "required":[ "InstanceId", "UserId", "UserProficiencies" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "UserId":{ "shape":"UserId", "documentation":"<p>The identifier of the user account.</p>", "location":"uri", "locationName":"UserId" }, "UserProficiencies":{ "shape":"UserProficiencyDisassociateList", "documentation":"<p>The proficiencies to disassociate from the user.</p>" } } }, "DisconnectDetails":{ "type":"structure", "members":{ "PotentialDisconnectIssue":{ "shape":"PotentialDisconnectIssue", "documentation":"<p>Indicates the potential disconnection issues for a call. This field is not populated if the service does not detect potential issues.</p>" } }, "documentation":"<p>Information about the call disconnect experience.</p>" }, "DisconnectReason":{ "type":"structure", "members":{ "Code":{ "shape":"DisconnectReasonCode", "documentation":"<p>A code that indicates how the contact was terminated.</p>" } }, "documentation":"<p>Contains details about why a contact was disconnected. Only Amazon Connect outbound campaigns can provide this field.</p>" }, "DisconnectReasonCode":{"type":"string"}, "DismissUserContactRequest":{ "type":"structure", "required":[ "UserId", "InstanceId", "ContactId" ], "members":{ "UserId":{ "shape":"UserId", "documentation":"<p>The identifier of the user account.</p>", "location":"uri", "locationName":"UserId" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact.</p>" } } }, "DismissUserContactResponse":{ "type":"structure", "members":{} }, "DisplayName":{ "type":"string", "max":256, "min":1 }, "Distribution":{ "type":"structure", "required":[ "Region", "Percentage" ], "members":{ "Region":{ "shape":"AwsRegion", "documentation":"<p>The Amazon Web Services Region where the traffic is distributed.</p>" }, "Percentage":{ "shape":"Percentage", "documentation":"<p>The percentage of the traffic that is distributed, in increments of 10.</p>" } }, "documentation":"<p>Information about a traffic distribution.</p>" }, "DistributionList":{ "type":"list", "member":{"shape":"Distribution"} }, "Double":{"type":"double"}, "DownloadUrlMetadata":{ "type":"structure", "members":{ "Url":{ "shape":"MetadataUrl", "documentation":"<p>A pre-signed URL that should be used to download the attached file. </p>" }, "UrlExpiry":{ "shape":"ISO8601Datetime", "documentation":"<p>The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.</p>" } }, "documentation":"<p>Metadata used to download the attached file.</p>" }, "DuplicateResourceException":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"<p>A resource with the specified name already exists.</p>", "error":{"httpStatusCode":409}, "exception":true }, "Duration":{ "type":"integer", "min":0 }, "DurationInSeconds":{"type":"integer"}, "DurationMillis":{ "type":"long", "min":0 }, "EffectiveHoursOfOperationList":{ "type":"list", "member":{"shape":"EffectiveHoursOfOperations"} }, "EffectiveHoursOfOperations":{ "type":"structure", "members":{ "Date":{ "shape":"HoursOfOperationOverrideYearMonthDayDateFormat", "documentation":"<p>The date that the hours of operation or overrides applies to.</p>" }, "OperationalHours":{ "shape":"OperationalHours", "documentation":"<p>Information about the hours of operations with the effective override applied.</p>" } }, "documentation":"<p>Information about the hours of operations with the effective override applied.</p>" }, "Email":{ "type":"string", "sensitive":true }, "EmailAddress":{ "type":"string", "max":255, "min":1, "pattern":"[^\\s@]+@[^\\s@]+\\.[^\\s@]+", "sensitive":true }, "EmailAddressArn":{ "type":"string", "max":500, "min":1 }, "EmailAddressDisplayName":{ "type":"string", "max":256, "min":0, "sensitive":true }, "EmailAddressId":{ "type":"string", "max":500, "min":1 }, "EmailAddressInfo":{ "type":"structure", "required":["EmailAddress"], "members":{ "EmailAddress":{ "shape":"EmailAddress", "documentation":"<p>The email address, including the domain.</p>" }, "DisplayName":{ "shape":"EmailAddressDisplayName", "documentation":"<p>The display name of email address.</p>" } }, "documentation":"<p>Contains information about a source or destination email address.</p>" }, "EmailAddressList":{ "type":"list", "member":{"shape":"EmailAddressMetadata"} }, "EmailAddressMetadata":{ "type":"structure", "members":{ "EmailAddressId":{ "shape":"EmailAddressId", "documentation":"<p>The identifier of the email address.</p>" }, "EmailAddressArn":{ "shape":"EmailAddressArn", "documentation":"<p>The Amazon Resource Name (ARN) of the email address.</p>" }, "EmailAddress":{ "shape":"EmailAddress", "documentation":"<p>The email address, including the domain.</p>" }, "Description":{ "shape":"Description", "documentation":"<p>The description of the email address.</p>" }, "DisplayName":{ "shape":"EmailAddressDisplayName", "documentation":"<p>The display name of email address.</p>" } }, "documentation":"<p>Contains information about an email address for a contact center.</p>" }, "EmailAddressRecipientList":{ "type":"list", "member":{"shape":"EmailAddressInfo"}, "max":50, "min":1 }, "EmailAddressSearchConditionList":{ "type":"list", "member":{"shape":"EmailAddressSearchCriteria"} }, "EmailAddressSearchCriteria":{ "type":"structure", "members":{ "OrConditions":{ "shape":"EmailAddressSearchConditionList", "documentation":"<p>A list of conditions which would be applied together with an OR condition.</p>" }, "AndConditions":{ "shape":"EmailAddressSearchConditionList", "documentation":"<p>A list of conditions which would be applied together with an AND condition.</p>" }, "StringCondition":{"shape":"StringCondition"} }, "documentation":"<p>The search criteria to be used to return email addresses.</p>" }, "EmailAddressSearchFilter":{ "type":"structure", "members":{ "TagFilter":{"shape":"ControlPlaneTagFilter"} }, "documentation":"<p>Filters to be applied to search results.</p>" }, "EmailAttachment":{ "type":"structure", "required":[ "FileName", "S3Url" ], "members":{ "FileName":{ "shape":"FileName", "documentation":"<p>A case-sensitive name of the attached file being uploaded.</p>" }, "S3Url":{ "shape":"PreSignedAttachmentUrl", "documentation":"<p>The pre-signed URLs for the S3 bucket where the email attachment is stored.</p>" } }, "documentation":"<p>Information about the email attachment files.</p>" }, "EmailAttachments":{ "type":"list", "member":{"shape":"EmailAttachment"}, "max":10, "min":1, "sensitive":true }, "EmailHeaderType":{ "type":"string", "enum":[ "REFERENCES", "MESSAGE_ID", "IN_REPLY_TO", "X_SES_SPAM_VERDICT", "X_SES_VIRUS_VERDICT" ] }, "EmailHeaderValue":{ "type":"string", "max":20000, "min":1 }, "EmailHeaders":{ "type":"map", "key":{"shape":"EmailHeaderType"}, "value":{"shape":"EmailHeaderValue"} }, "EmailMessageContentType":{ "type":"string", "max":100, "min":1 }, "EmailMessageReference":{ "type":"structure", "members":{ "Name":{ "shape":"ReferenceKey", "documentation":"<p>The name of the email message reference</p>" }, "Arn":{ "shape":"ReferenceArn", "documentation":"<p>The Amazon Resource Name (ARN) of the email message reference</p>" } }, "documentation":"<p>Information about the reference when the referenceType is <code>EMAIL_MESSAGE</code>. Otherwise, null.</p>" }, "EmailRecipient":{ "type":"structure", "members":{ "Address":{ "shape":"EndpointAddress", "documentation":"<p>Address of the email recipient.</p> <p>Type: String</p> <p>Length Constraints: Minimum length of 1. Maximum length of 256.</p>" }, "DisplayName":{ "shape":"EndpointDisplayName", "documentation":"<p>Display name of the email recipient.</p> <p>Type: String</p> <p>Length Constraints: Minimum length of 1. Maximum length of 256.</p>" } }, "documentation":"<p>Information about the email recipient</p>" }, "EmailRecipientsList":{ "type":"list", "member":{"shape":"EmailRecipient"} }, "EmailReference":{ "type":"structure", "members":{ "Name":{ "shape":"ReferenceKey", "documentation":"<p>Identifier of the email reference.</p>" }, "Value":{ "shape":"ReferenceValue", "documentation":"<p>A valid email address.</p>" } }, "documentation":"<p>Information about a reference when the <code>referenceType</code> is <code>EMAIL</code>. Otherwise, null.</p>" }, "EmptyFieldValue":{ "type":"structure", "members":{}, "documentation":"<p>An empty value.</p>" }, "EncryptionConfig":{ "type":"structure", "required":[ "EncryptionType", "KeyId" ], "members":{ "EncryptionType":{ "shape":"EncryptionType", "documentation":"<p>The type of encryption.</p>" }, "KeyId":{ "shape":"KeyId", "documentation":"<p>The full ARN of the encryption key. </p> <note> <p>Be sure to provide the full ARN of the encryption key, not just the ID.</p> <p>Amazon Connect supports only KMS keys with the default key spec of <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-symmetric-default\"> <code>SYMMETRIC_DEFAULT</code> </a>. </p> </note>" } }, "documentation":"<p>The encryption configuration.</p>" }, "EncryptionType":{ "type":"string", "enum":["KMS"] }, "EndAssociatedTasksActionDefinition":{ "type":"structure", "members":{}, "documentation":"<p>End associated tasks related to a case.</p>" }, "Endpoint":{ "type":"structure", "members":{ "Type":{ "shape":"EndpointType", "documentation":"<p>Type of the endpoint.</p>" }, "Address":{ "shape":"EndpointAddress", "documentation":"<p>Address of the endpoint.</p>" } }, "documentation":"<p>Information about the endpoint.</p>" }, "EndpointAddress":{ "type":"string", "max":256, "min":0 }, "EndpointDisplayName":{ "type":"string", "max":256, "min":0 }, "EndpointInfo":{ "type":"structure", "members":{ "Type":{ "shape":"EndpointType", "documentation":"<p>Type of endpoint.</p>" }, "Address":{ "shape":"EndpointAddress", "documentation":"<p>Address of the endpoint.</p>" }, "DisplayName":{ "shape":"EndpointDisplayName", "documentation":"<p>Display name of the endpoint.</p>" } }, "documentation":"<p>Information about the endpoint.</p>" }, "EndpointType":{ "type":"string", "enum":[ "TELEPHONE_NUMBER", "VOIP", "CONTACT_FLOW", "CONNECT_PHONENUMBER_ARN", "EMAIL_ADDRESS" ] }, "ErrorCode":{"type":"string"}, "ErrorMessage":{"type":"string"}, "ErrorResult":{ "type":"structure", "members":{ "ErrorCode":{ "shape":"String", "documentation":"<p>The error code.</p>" }, "ErrorMessage":{ "shape":"String", "documentation":"<p>The corresponding error message for the error code.</p>" } }, "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>List of errors for dataset association failures. </p>" }, "ErrorResults":{ "type":"list", "member":{"shape":"ErrorResult"} }, "Evaluation":{ "type":"structure", "required":[ "EvaluationId", "EvaluationArn", "Metadata", "Answers", "Notes", "Status", "CreatedTime", "LastModifiedTime" ], "members":{ "EvaluationId":{ "shape":"ResourceId", "documentation":"<p>A unique identifier for the contact evaluation.</p>" }, "EvaluationArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>" }, "Metadata":{ "shape":"EvaluationMetadata", "documentation":"<p>Metadata about the contact evaluation.</p>" }, "Answers":{ "shape":"EvaluationAnswersOutputMap", "documentation":"<p>A map of question identifiers to answer value.</p>" }, "Notes":{ "shape":"EvaluationNotesMap", "documentation":"<p>A map of question identifiers to note value.</p>" }, "Status":{ "shape":"EvaluationStatus", "documentation":"<p>The status of the contact evaluation.</p>" }, "Scores":{ "shape":"EvaluationScoresMap", "documentation":"<p>A map of item (section or question) identifiers to score value.</p>" }, "CreatedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp for when the evaluation was created.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp for when the evaluation was last updated.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" } }, "documentation":"<p>Information about a contact evaluation.</p>" }, "EvaluationAnswerData":{ "type":"structure", "members":{ "StringValue":{ "shape":"EvaluationAnswerDataStringValue", "documentation":"<p>The string value for an answer in a contact evaluation.</p>" }, "NumericValue":{ "shape":"EvaluationAnswerDataNumericValue", "documentation":"<p>The numeric value for an answer in a contact evaluation.</p>" }, "NotApplicable":{ "shape":"Boolean", "documentation":"<p>The flag to mark the question as not applicable.</p>" } }, "documentation":"<p>Information about answer data for a contact evaluation. Answer data must be either string, numeric, or not applicable.</p>", "union":true }, "EvaluationAnswerDataNumericValue":{"type":"double"}, "EvaluationAnswerDataStringValue":{ "type":"string", "max":128, "min":0 }, "EvaluationAnswerInput":{ "type":"structure", "members":{ "Value":{ "shape":"EvaluationAnswerData", "documentation":"<p>The value for an answer in a contact evaluation.</p>" } }, "documentation":"<p>Information about input answers for a contact evaluation.</p>" }, "EvaluationAnswerOutput":{ "type":"structure", "members":{ "Value":{ "shape":"EvaluationAnswerData", "documentation":"<p>The value for an answer in a contact evaluation.</p>" }, "SystemSuggestedValue":{ "shape":"EvaluationAnswerData", "documentation":"<p>The system suggested value for an answer in a contact evaluation.</p>" } }, "documentation":"<p>Information about output answers for a contact evaluation.</p>" }, "EvaluationAnswersInputMap":{ "type":"map", "key":{"shape":"ResourceId"}, "value":{"shape":"EvaluationAnswerInput"}, "max":100 }, "EvaluationAnswersOutputMap":{ "type":"map", "key":{"shape":"ResourceId"}, "value":{"shape":"EvaluationAnswerOutput"}, "max":100 }, "EvaluationArn":{"type":"string"}, "EvaluationForm":{ "type":"structure", "required":[ "EvaluationFormId", "EvaluationFormVersion", "Locked", "EvaluationFormArn", "Title", "Status", "Items", "CreatedTime", "CreatedBy", "LastModifiedTime", "LastModifiedBy" ], "members":{ "EvaluationFormId":{ "shape":"ResourceId", "documentation":"<p>The unique identifier for the evaluation form.</p>" }, "EvaluationFormVersion":{ "shape":"VersionNumber", "documentation":"<p>A version of the evaluation form.</p>" }, "Locked":{ "shape":"EvaluationFormVersionIsLocked", "documentation":"<p>The flag indicating whether the evaluation form is locked for changes.</p>" }, "EvaluationFormArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>" }, "Title":{ "shape":"EvaluationFormTitle", "documentation":"<p>A title of the evaluation form.</p>" }, "Description":{ "shape":"EvaluationFormDescription", "documentation":"<p>The description of the evaluation form.</p>" }, "Status":{ "shape":"EvaluationFormVersionStatus", "documentation":"<p>The status of the evaluation form.</p>" }, "Items":{ "shape":"EvaluationFormItemsList", "documentation":"<p>Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.</p>" }, "ScoringStrategy":{ "shape":"EvaluationFormScoringStrategy", "documentation":"<p>A scoring strategy of the evaluation form.</p>" }, "CreatedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp for when the evaluation form was created.</p>" }, "CreatedBy":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the user who created the evaluation form.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp for when the evaluation form was last updated.</p>" }, "LastModifiedBy":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the user who last updated the evaluation form.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" } }, "documentation":"<p>Information about the evaluation form.</p>" }, "EvaluationFormContent":{ "type":"structure", "required":[ "EvaluationFormVersion", "EvaluationFormId", "EvaluationFormArn", "Title", "Items" ], "members":{ "EvaluationFormVersion":{ "shape":"VersionNumber", "documentation":"<p>A version of the evaluation form.</p>" }, "EvaluationFormId":{ "shape":"ResourceId", "documentation":"<p>The unique identifier for the evaluation form.</p>" }, "EvaluationFormArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>" }, "Title":{ "shape":"EvaluationFormTitle", "documentation":"<p>A title of the evaluation form.</p>" }, "Description":{ "shape":"EvaluationFormDescription", "documentation":"<p>The description of the evaluation form.</p>" }, "Items":{ "shape":"EvaluationFormItemsList", "documentation":"<p>Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.</p>" }, "ScoringStrategy":{ "shape":"EvaluationFormScoringStrategy", "documentation":"<p>A scoring strategy of the evaluation form.</p>" } }, "documentation":"<p>Information about an evaluation form used in a contact evaluation.</p>" }, "EvaluationFormDescription":{ "type":"string", "max":1024, "min":0 }, "EvaluationFormId":{ "type":"string", "max":256, "min":1 }, "EvaluationFormItem":{ "type":"structure", "members":{ "Section":{ "shape":"EvaluationFormSection", "documentation":"<p>The information of the section.</p>" }, "Question":{ "shape":"EvaluationFormQuestion", "documentation":"<p>The information of the question.</p>" } }, "documentation":"<p>Information about an item from an evaluation form. The item must be either a section or a question.</p>", "union":true }, "EvaluationFormItemWeight":{ "type":"double", "max":100, "min":0 }, "EvaluationFormItemsList":{ "type":"list", "member":{"shape":"EvaluationFormItem"}, "max":100, "min":1 }, "EvaluationFormNumericQuestionAutomation":{ "type":"structure", "members":{ "PropertyValue":{ "shape":"NumericQuestionPropertyValueAutomation", "documentation":"<p>The property value of the automation.</p>" } }, "documentation":"<p>Information about the automation configuration in numeric questions.</p>", "union":true }, "EvaluationFormNumericQuestionOption":{ "type":"structure", "required":[ "MinValue", "MaxValue" ], "members":{ "MinValue":{ "shape":"Integer", "documentation":"<p>The minimum answer value of the range option.</p>" }, "MaxValue":{ "shape":"Integer", "documentation":"<p>The maximum answer value of the range option.</p>" }, "Score":{ "shape":"EvaluationFormQuestionAnswerScore", "documentation":"<p>The score assigned to answer values within the range option.</p>" }, "AutomaticFail":{ "shape":"Boolean", "documentation":"<p>The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.</p>" } }, "documentation":"<p>Information about the option range used for scoring in numeric questions.</p>" }, "EvaluationFormNumericQuestionOptionList":{ "type":"list", "member":{"shape":"EvaluationFormNumericQuestionOption"}, "max":10, "min":1 }, "EvaluationFormNumericQuestionProperties":{ "type":"structure", "required":[ "MinValue", "MaxValue" ], "members":{ "MinValue":{ "shape":"Integer", "documentation":"<p>The minimum answer value.</p>" }, "MaxValue":{ "shape":"Integer", "documentation":"<p>The maximum answer value.</p>" }, "Options":{ "shape":"EvaluationFormNumericQuestionOptionList", "documentation":"<p>The scoring options of the numeric question.</p>" }, "Automation":{ "shape":"EvaluationFormNumericQuestionAutomation", "documentation":"<p>The automation properties of the numeric question.</p>" } }, "documentation":"<p>Information about properties for a numeric question in an evaluation form.</p>" }, "EvaluationFormQuestion":{ "type":"structure", "required":[ "Title", "RefId", "QuestionType" ], "members":{ "Title":{ "shape":"EvaluationFormQuestionTitle", "documentation":"<p>The title of the question.</p>" }, "Instructions":{ "shape":"EvaluationFormQuestionInstructions", "documentation":"<p>The instructions of the section.</p>" }, "RefId":{ "shape":"ReferenceId", "documentation":"<p>The identifier of the question. An identifier must be unique within the evaluation form.</p>" }, "NotApplicableEnabled":{ "shape":"Boolean", "documentation":"<p>The flag to enable not applicable answers to the question.</p>" }, "QuestionType":{ "shape":"EvaluationFormQuestionType", "documentation":"<p>The type of the question.</p>" }, "QuestionTypeProperties":{ "shape":"EvaluationFormQuestionTypeProperties", "documentation":"<p>The properties of the type of question. Text questions do not have to define question type properties.</p>" }, "Weight":{ "shape":"EvaluationFormItemWeight", "documentation":"<p>The scoring weight of the section.</p>" } }, "documentation":"<p>Information about a question from an evaluation form.</p>" }, "EvaluationFormQuestionAnswerScore":{ "type":"integer", "max":10, "min":0 }, "EvaluationFormQuestionInstructions":{ "type":"string", "max":1024, "min":0 }, "EvaluationFormQuestionTitle":{ "type":"string", "max":350, "min":0 }, "EvaluationFormQuestionType":{ "type":"string", "enum":[ "TEXT", "SINGLESELECT", "NUMERIC" ] }, "EvaluationFormQuestionTypeProperties":{ "type":"structure", "members":{ "Numeric":{ "shape":"EvaluationFormNumericQuestionProperties", "documentation":"<p>The properties of the numeric question.</p>" }, "SingleSelect":{ "shape":"EvaluationFormSingleSelectQuestionProperties", "documentation":"<p>The properties of the numeric question.</p>" } }, "documentation":"<p>Information about properties for a question in an evaluation form. The question type properties must be either for a numeric question or a single select question.</p>", "union":true }, "EvaluationFormScoringMode":{ "type":"string", "enum":[ "QUESTION_ONLY", "SECTION_ONLY" ] }, "EvaluationFormScoringStatus":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "EvaluationFormScoringStrategy":{ "type":"structure", "required":[ "Mode", "Status" ], "members":{ "Mode":{ "shape":"EvaluationFormScoringMode", "documentation":"<p>The scoring mode of the evaluation form.</p>" }, "Status":{ "shape":"EvaluationFormScoringStatus", "documentation":"<p>The scoring status of the evaluation form.</p>" } }, "documentation":"<p>Information about scoring strategy for an evaluation form.</p>" }, "EvaluationFormSection":{ "type":"structure", "required":[ "Title", "RefId", "Items" ], "members":{ "Title":{ "shape":"EvaluationFormSectionTitle", "documentation":"<p>The title of the section.</p>" }, "RefId":{ "shape":"ReferenceId", "documentation":"<p>The identifier of the section. An identifier must be unique within the evaluation form.</p>" }, "Instructions":{ "shape":"EvaluationFormQuestionInstructions", "documentation":"<p>The instructions of the section.</p>" }, "Items":{ "shape":"EvaluationFormItemsList", "documentation":"<p>The items of the section.</p>" }, "Weight":{ "shape":"EvaluationFormItemWeight", "documentation":"<p>The scoring weight of the section.</p>" } }, "documentation":"<p>Information about a section from an evaluation form. A section can contain sections and/or questions. Evaluation forms can only contain sections and subsections (two level nesting).</p>" }, "EvaluationFormSectionTitle":{ "type":"string", "max":128, "min":0 }, "EvaluationFormSingleSelectQuestionAutomation":{ "type":"structure", "required":["Options"], "members":{ "Options":{ "shape":"EvaluationFormSingleSelectQuestionAutomationOptionList", "documentation":"<p>The automation options of the single select question.</p>" }, "DefaultOptionRefId":{ "shape":"ReferenceId", "documentation":"<p>The identifier of the default answer option, when none of the automation options match the criteria.</p>" } }, "documentation":"<p>Information about the automation configuration in single select questions. Automation options are evaluated in order, and the first matched option is applied. If no automation option matches, and there is a default option, then the default option is applied.</p>" }, "EvaluationFormSingleSelectQuestionAutomationOption":{ "type":"structure", "members":{ "RuleCategory":{ "shape":"SingleSelectQuestionRuleCategoryAutomation", "documentation":"<p>The automation option based on a rule category for the single select question.</p>" } }, "documentation":"<p>Information about the automation option of a single select question.</p>", "union":true }, "EvaluationFormSingleSelectQuestionAutomationOptionList":{ "type":"list", "member":{"shape":"EvaluationFormSingleSelectQuestionAutomationOption"}, "max":20, "min":1 }, "EvaluationFormSingleSelectQuestionDisplayMode":{ "type":"string", "enum":[ "DROPDOWN", "RADIO" ] }, "EvaluationFormSingleSelectQuestionOption":{ "type":"structure", "required":[ "RefId", "Text" ], "members":{ "RefId":{ "shape":"ReferenceId", "documentation":"<p>The identifier of the answer option. An identifier must be unique within the question.</p>" }, "Text":{ "shape":"EvaluationFormSingleSelectQuestionOptionText", "documentation":"<p>The title of the answer option.</p>" }, "Score":{ "shape":"EvaluationFormQuestionAnswerScore", "documentation":"<p>The score assigned to the answer option.</p>" }, "AutomaticFail":{ "shape":"Boolean", "documentation":"<p>The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.</p>" } }, "documentation":"<p>Information about the automation configuration in single select questions.</p>" }, "EvaluationFormSingleSelectQuestionOptionList":{ "type":"list", "member":{"shape":"EvaluationFormSingleSelectQuestionOption"}, "max":256, "min":1 }, "EvaluationFormSingleSelectQuestionOptionText":{ "type":"string", "max":128, "min":0 }, "EvaluationFormSingleSelectQuestionProperties":{ "type":"structure", "required":["Options"], "members":{ "Options":{ "shape":"EvaluationFormSingleSelectQuestionOptionList", "documentation":"<p>The answer options of the single select question.</p>" }, "DisplayAs":{ "shape":"EvaluationFormSingleSelectQuestionDisplayMode", "documentation":"<p>The display mode of the single select question.</p>" }, "Automation":{ "shape":"EvaluationFormSingleSelectQuestionAutomation", "documentation":"<p>The display mode of the single select question.</p>" } }, "documentation":"<p>Information about the options in single select questions.</p>" }, "EvaluationFormSummary":{ "type":"structure", "required":[ "EvaluationFormId", "EvaluationFormArn", "Title", "CreatedTime", "CreatedBy", "LastModifiedTime", "LastModifiedBy", "LatestVersion" ], "members":{ "EvaluationFormId":{ "shape":"ResourceId", "documentation":"<p>The unique identifier for the evaluation form.</p>" }, "EvaluationFormArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>" }, "Title":{ "shape":"EvaluationFormTitle", "documentation":"<p>A title of the evaluation form.</p>" }, "CreatedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp for when the evaluation form was created.</p>" }, "CreatedBy":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the user who created the evaluation form.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp for when the evaluation form was last updated.</p>" }, "LastModifiedBy":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the user who last updated the evaluation form.</p>" }, "LastActivatedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp for when the evaluation form was last activated.</p>" }, "LastActivatedBy":{ "shape":"ARN", "documentation":"<p> The Amazon Resource Name (ARN) of the user who last activated the evaluation form.</p>" }, "LatestVersion":{ "shape":"VersionNumber", "documentation":"<p>The version number of the latest evaluation form version.</p>" }, "ActiveVersion":{ "shape":"VersionNumber", "documentation":"<p>The version of the active evaluation form version.</p>", "box":true } }, "documentation":"<p>Summary information about an evaluation form.</p>" }, "EvaluationFormSummaryList":{ "type":"list", "member":{"shape":"EvaluationFormSummary"} }, "EvaluationFormTitle":{ "type":"string", "max":128, "min":1 }, "EvaluationFormVersionIsLocked":{"type":"boolean"}, "EvaluationFormVersionStatus":{ "type":"string", "enum":[ "DRAFT", "ACTIVE" ] }, "EvaluationFormVersionSummary":{ "type":"structure", "required":[ "EvaluationFormArn", "EvaluationFormId", "EvaluationFormVersion", "Locked", "Status", "CreatedTime", "CreatedBy", "LastModifiedTime", "LastModifiedBy" ], "members":{ "EvaluationFormArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>" }, "EvaluationFormId":{ "shape":"ResourceId", "documentation":"<p>The unique identifier for the evaluation form.</p>" }, "EvaluationFormVersion":{ "shape":"VersionNumber", "documentation":"<p>A version of the evaluation form.</p>" }, "Locked":{ "shape":"EvaluationFormVersionIsLocked", "documentation":"<p>The flag indicating whether the evaluation form is locked for changes.</p>" }, "Status":{ "shape":"EvaluationFormVersionStatus", "documentation":"<p>The status of the evaluation form.</p>" }, "CreatedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp for when the evaluation form was created.</p>" }, "CreatedBy":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the user who created the evaluation form.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp for when the evaluation form was last updated.</p>" }, "LastModifiedBy":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the user who last updated the evaluation form.</p>" } }, "documentation":"<p>Summary information about an evaluation form.</p>" }, "EvaluationFormVersionSummaryList":{ "type":"list", "member":{"shape":"EvaluationFormVersionSummary"} }, "EvaluationId":{"type":"string"}, "EvaluationMetadata":{ "type":"structure", "required":[ "ContactId", "EvaluatorArn" ], "members":{ "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact in this instance of Amazon Connect. </p>" }, "EvaluatorArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the user who last updated the evaluation.</p>" }, "ContactAgentId":{ "shape":"ResourceId", "documentation":"<p>The identifier of the agent who performed the contact.</p>" }, "Score":{ "shape":"EvaluationScore", "documentation":"<p>The overall score of the contact evaluation.</p>" } }, "documentation":"<p>Metadata information about a contact evaluation.</p>" }, "EvaluationNote":{ "type":"structure", "members":{ "Value":{ "shape":"EvaluationNoteString", "documentation":"<p>The note for an item (section or question) in a contact evaluation.</p> <note> <p>Even though a note in an evaluation can have up to 3072 chars, there is also a limit on the total number of chars for all the notes in the evaluation combined. Assuming there are N questions in the evaluation being submitted, then the max char limit for all notes combined is N x 1024.</p> </note>" } }, "documentation":"<p>Information about notes for a contact evaluation.</p>" }, "EvaluationNoteString":{ "type":"string", "max":3072, "min":0 }, "EvaluationNotesMap":{ "type":"map", "key":{"shape":"ResourceId"}, "value":{"shape":"EvaluationNote"}, "max":100 }, "EvaluationScore":{ "type":"structure", "members":{ "Percentage":{ "shape":"EvaluationScorePercentage", "documentation":"<p>The score percentage for an item in a contact evaluation.</p>" }, "NotApplicable":{ "shape":"Boolean", "documentation":"<p>The flag to mark the item as not applicable for scoring.</p>" }, "AutomaticFail":{ "shape":"Boolean", "documentation":"<p>The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this flag will be true.</p>" } }, "documentation":"<p>Information about scores of a contact evaluation item (section or question).</p>" }, "EvaluationScorePercentage":{ "type":"double", "max":100, "min":0 }, "EvaluationScoresMap":{ "type":"map", "key":{"shape":"ResourceId"}, "value":{"shape":"EvaluationScore"}, "max":100 }, "EvaluationStatus":{ "type":"string", "enum":[ "DRAFT", "SUBMITTED" ] }, "EvaluationSummary":{ "type":"structure", "required":[ "EvaluationId", "EvaluationArn", "EvaluationFormTitle", "EvaluationFormId", "Status", "EvaluatorArn", "CreatedTime", "LastModifiedTime" ], "members":{ "EvaluationId":{ "shape":"ResourceId", "documentation":"<p>A unique identifier for the contact evaluation.</p>" }, "EvaluationArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>" }, "EvaluationFormTitle":{ "shape":"EvaluationFormTitle", "documentation":"<p>A title of the evaluation form.</p>" }, "EvaluationFormId":{ "shape":"ResourceId", "documentation":"<p>The unique identifier for the evaluation form.</p>" }, "Status":{ "shape":"EvaluationStatus", "documentation":"<p>The status of the contact evaluation.</p>" }, "EvaluatorArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the user who last updated the evaluation.</p>" }, "Score":{ "shape":"EvaluationScore", "documentation":"<p>The overall score of the contact evaluation.</p>" }, "CreatedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp for when the evaluation was created.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp for when the evaluation was last updated.</p>" } }, "documentation":"<p>Summary information about a contact evaluation.</p>" }, "EvaluationSummaryList":{ "type":"list", "member":{"shape":"EvaluationSummary"} }, "EventBridgeActionDefinition":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"EventBridgeActionName", "documentation":"<p>The name.</p>" } }, "documentation":"<p>The EventBridge action definition.</p>" }, "EventBridgeActionName":{ "type":"string", "max":100, "min":1 }, "EventSourceName":{ "type":"string", "enum":[ "OnPostCallAnalysisAvailable", "OnRealTimeCallAnalysisAvailable", "OnRealTimeChatAnalysisAvailable", "OnPostChatAnalysisAvailable", "OnZendeskTicketCreate", "OnZendeskTicketStatusUpdate", "OnSalesforceCaseCreate", "OnContactEvaluationSubmit", "OnMetricDataUpdate", "OnCaseCreate", "OnCaseUpdate", "OnSlaBreach" ] }, "Expiry":{ "type":"structure", "members":{ "DurationInSeconds":{ "shape":"DurationInSeconds", "documentation":"<p>The number of seconds to wait before expiring the routing step.</p>" }, "ExpiryTimestamp":{ "shape":"timestamp", "documentation":"<p>The timestamp indicating when the routing step expires.</p>" } }, "documentation":"<p>An object to specify the expiration of a routing step.</p>" }, "ExpiryDurationInMinutes":{"type":"integer"}, "ExportLocation":{"type":"string"}, "Expression":{ "type":"structure", "members":{ "AttributeCondition":{ "shape":"AttributeCondition", "documentation":"<p>An object to specify the predefined attribute condition.</p>" }, "AndExpression":{ "shape":"Expressions", "documentation":"<p>List of routing expressions which will be AND-ed together.</p>" }, "OrExpression":{ "shape":"Expressions", "documentation":"<p>List of routing expressions which will be OR-ed together.</p>" }, "NotAttributeCondition":{"shape":"AttributeCondition"} }, "documentation":"<p>A tagged union to specify expression for a routing step.</p>" }, "Expressions":{ "type":"list", "member":{"shape":"Expression"} }, "FailedRequest":{ "type":"structure", "members":{ "RequestIdentifier":{ "shape":"RequestIdentifier", "documentation":"<p>Request identifier provided in the API call in the ContactDataRequest to create a contact.</p>" }, "FailureReasonCode":{ "shape":"FailureReasonCode", "documentation":"<p>Reason code for the failure.</p>" }, "FailureReasonMessage":{ "shape":"String", "documentation":"<p>Why the request to create a contact failed.</p>" } }, "documentation":"<p>Request for which contact failed to be generated.</p>" }, "FailedRequestList":{ "type":"list", "member":{"shape":"FailedRequest"} }, "FailureReasonCode":{ "type":"string", "enum":[ "INVALID_ATTRIBUTE_KEY", "INVALID_CUSTOMER_ENDPOINT", "INVALID_SYSTEM_ENDPOINT", "INVALID_QUEUE", "MISSING_CAMPAIGN", "MISSING_CUSTOMER_ENDPOINT", "MISSING_QUEUE_ID_AND_SYSTEM_ENDPOINT", "REQUEST_THROTTLED", "IDEMPOTENCY_EXCEPTION", "INTERNAL_ERROR" ] }, "FieldStringValue":{ "type":"string", "max":500, "min":0 }, "FieldValue":{ "type":"structure", "required":[ "Id", "Value" ], "members":{ "Id":{ "shape":"FieldValueId", "documentation":"<p>Unique identifier of a field.</p>" }, "Value":{ "shape":"FieldValueUnion", "documentation":"<p>Union of potential field value types.</p>" } }, "documentation":"<p>Object for case field values.</p>" }, "FieldValueId":{ "type":"string", "max":500, "min":1 }, "FieldValueUnion":{ "type":"structure", "members":{ "BooleanValue":{ "shape":"Boolean", "documentation":"<p>A Boolean number value type.</p>" }, "DoubleValue":{ "shape":"Double", "documentation":"<p>A Double number value type.</p>" }, "EmptyValue":{ "shape":"EmptyFieldValue", "documentation":"<p>An empty value.</p>" }, "StringValue":{ "shape":"FieldStringValue", "documentation":"<p>String value type.</p>" } }, "documentation":"<p>Object to store union of Field values.</p>" }, "FieldValues":{ "type":"list", "member":{"shape":"FieldValue"} }, "FileId":{ "type":"string", "max":256, "min":1 }, "FileIdList":{ "type":"list", "member":{"shape":"FileId"}, "max":100, "min":1 }, "FileName":{ "type":"string", "max":256, "min":1, "pattern":"^\\P{C}*$" }, "FileSizeInBytes":{ "type":"long", "box":true, "min":1 }, "FileStatusType":{ "type":"string", "enum":[ "APPROVED", "REJECTED", "PROCESSING", "FAILED" ] }, "FileUseCaseType":{ "type":"string", "enum":[ "EMAIL_MESSAGE", "ATTACHMENT" ] }, "FilterV2":{ "type":"structure", "members":{ "FilterKey":{ "shape":"ResourceArnOrId", "documentation":"<p>The key to use for filtering data. For example, <code>QUEUE</code>, <code>ROUTING_PROFILE, AGENT</code>, <code>CHANNEL</code>, <code>AGENT_HIERARCHY_LEVEL_ONE</code>, <code>AGENT_HIERARCHY_LEVEL_TWO</code>, <code>AGENT_HIERARCHY_LEVEL_THREE</code>, <code>AGENT_HIERARCHY_LEVEL_FOUR</code>, <code>AGENT_HIERARCHY_LEVEL_FIVE</code>. There must be at least 1 key and a maximum 5 keys. </p>" }, "FilterValues":{ "shape":"FilterValueList", "documentation":"<p>The identifiers to use for filtering data. For example, if you have a filter key of <code>QUEUE</code>, you would add queue IDs or ARNs in <code>FilterValues</code>. </p>" } }, "documentation":"<p>Contains the filter to apply when retrieving metrics with the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html\">GetMetricDataV2</a> API.</p>" }, "FilterValueList":{ "type":"list", "member":{"shape":"ResourceArnOrId"}, "max":100, "min":1 }, "Filters":{ "type":"structure", "members":{ "Queues":{ "shape":"Queues", "documentation":"<p>The queues to use to filter the metrics. You should specify at least one queue, and can specify up to 100 queues per request. The <code>GetCurrentMetricsData</code> API in particular requires a queue when you include a <code>Filter</code> in your request. </p>" }, "Channels":{ "shape":"Channels", "documentation":"<p>The channel to use to filter the metrics.</p>" }, "RoutingProfiles":{ "shape":"RoutingProfiles", "documentation":"<p>A list of up to 100 routing profile IDs or ARNs.</p>" }, "RoutingStepExpressions":{ "shape":"RoutingExpressions", "documentation":"<p>A list of expressions as a filter, in which an expression is an object of a step in a routing criteria.</p>" } }, "documentation":"<p>Contains the filter to apply when retrieving metrics.</p>" }, "FiltersV2List":{ "type":"list", "member":{"shape":"FilterV2"}, "max":5, "min":1 }, "FlowAssociationResourceType":{ "type":"string", "enum":[ "SMS_PHONE_NUMBER", "INBOUND_EMAIL", "OUTBOUND_EMAIL", "ANALYTICS_CONNECTOR", "WHATSAPP_MESSAGING_PHONE_NUMBER" ] }, "FlowAssociationSummary":{ "type":"structure", "members":{ "ResourceId":{ "shape":"ARN", "documentation":"<p>The identifier of the resource.</p>" }, "FlowId":{ "shape":"ARN", "documentation":"<p>The identifier of the flow.</p>" }, "ResourceType":{ "shape":"ListFlowAssociationResourceType", "documentation":"<p>The type of resource association.</p>" } }, "documentation":"<p>Information about flow associations.</p>" }, "FlowAssociationSummaryList":{ "type":"list", "member":{"shape":"FlowAssociationSummary"} }, "FlowContentSha256":{ "type":"string", "max":64, "min":1, "pattern":"^[a-zA-Z0-9]{64}$" }, "FormId":{"type":"string"}, "FragmentNumber":{ "type":"string", "max":128, "min":0 }, "FunctionArn":{ "type":"string", "max":140, "min":1 }, "FunctionArnsList":{ "type":"list", "member":{"shape":"FunctionArn"} }, "GetAttachedFileRequest":{ "type":"structure", "required":[ "InstanceId", "FileId", "AssociatedResourceArn" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The unique identifier of the Amazon Connect instance.</p>", "location":"uri", "locationName":"InstanceId" }, "FileId":{ "shape":"FileId", "documentation":"<p>The unique identifier of the attached file resource.</p>", "location":"uri", "locationName":"FileId" }, "UrlExpiryInSeconds":{ "shape":"URLExpiryInSeconds", "documentation":"<p>Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.</p>", "location":"querystring", "locationName":"urlExpiryInSeconds" }, "AssociatedResourceArn":{ "shape":"ARN", "documentation":"<p>The resource to which the attached file is (being) uploaded to. The supported resources are <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/cases.html\">Cases</a> and <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html\">Email</a>.</p> <note> <p>This value must be a valid ARN.</p> </note>", "location":"querystring", "locationName":"associatedResourceArn" } }, "documentation":"Request to GetAttachedFile API." }, "GetAttachedFileResponse":{ "type":"structure", "required":["FileSizeInBytes"], "members":{ "FileArn":{ "shape":"ARN", "documentation":"<p>The unique identifier of the attached file resource (ARN).</p>" }, "FileId":{ "shape":"FileId", "documentation":"<p>The unique identifier of the attached file resource.</p>" }, "CreationTime":{ "shape":"ISO8601Datetime", "documentation":"<p>The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: <code>yyyy-MM-ddThh:mm:ss.SSSZ</code>. For example, <code>2024-05-03T02:41:28.172Z</code>.</p>" }, "FileStatus":{ "shape":"FileStatusType", "documentation":"<p>The current status of the attached file.</p>" }, "FileName":{ "shape":"FileName", "documentation":"<p>A case-sensitive name of the attached file being uploaded.</p>" }, "FileSizeInBytes":{ "shape":"FileSizeInBytes", "documentation":"<p>The size of the attached file in bytes.</p>", "box":true }, "AssociatedResourceArn":{ "shape":"ARN", "documentation":"<p>The resource to which the attached file is (being) uploaded to. <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html\">Cases</a> are the only current supported resource.</p>" }, "FileUseCaseType":{ "shape":"FileUseCaseType", "documentation":"<p>The use case for the file.</p>" }, "CreatedBy":{ "shape":"CreatedByInfo", "documentation":"<p>Represents the identity that created the file.</p>" }, "DownloadUrlMetadata":{ "shape":"DownloadUrlMetadata", "documentation":"<p>URL and expiry to be used when downloading the attached file. </p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, <code>{ \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }</code>.</p>" } }, "documentation":"Response from GetAttachedFile API." }, "GetContactAttributesRequest":{ "type":"structure", "required":[ "InstanceId", "InitialContactId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance.</p>", "location":"uri", "locationName":"InstanceId" }, "InitialContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the initial contact.</p>", "location":"uri", "locationName":"InitialContactId" } } }, "GetContactAttributesResponse":{ "type":"structure", "members":{ "Attributes":{ "shape":"Attributes", "documentation":"<p>Information about the attributes.</p>" } } }, "GetCurrentMetricDataRequest":{ "type":"structure", "required":[ "InstanceId", "Filters", "CurrentMetrics" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Filters":{ "shape":"Filters", "documentation":"<p>The filters to apply to returned metrics. You can filter up to the following limits:</p> <ul> <li> <p>Queues: 100</p> </li> <li> <p>Routing profiles: 100</p> </li> <li> <p>Channels: 3 (VOICE, CHAT, and TASK channels are supported.)</p> </li> <li> <p>RoutingStepExpressions: 50</p> </li> </ul> <p>Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource IDs and resource ARNs in the same request.</p> <p>When using the <code>RoutingStepExpression</code> filter, you need to pass exactly one <code>QueueId</code>. The filter is also case sensitive so when using the <code>RoutingStepExpression</code> filter, grouping by <code>ROUTING_STEP_EXPRESSION</code> is required.</p> <p>Currently tagging is only supported on the resources that are passed in the filter.</p>" }, "Groupings":{ "shape":"Groupings", "documentation":"<p>The grouping applied to the metrics returned. For example, when grouped by <code>QUEUE</code>, the metrics returned apply to each queue rather than aggregated for all queues. </p> <ul> <li> <p>If you group by <code>CHANNEL</code>, you should include a Channels filter. VOICE, CHAT, and TASK channels are supported.</p> </li> <li> <p>If you group by <code>ROUTING_PROFILE</code>, you must include either a queue or routing profile filter. In addition, a routing profile filter is required for metrics <code>CONTACTS_SCHEDULED</code>, <code>CONTACTS_IN_QUEUE</code>, and <code> OLDEST_CONTACT_AGE</code>.</p> </li> <li> <p>If no <code>Grouping</code> is included in the request, a summary of metrics is returned.</p> </li> <li> <p>When using the <code>RoutingStepExpression</code> filter, group by <code>ROUTING_STEP_EXPRESSION</code> is required.</p> </li> </ul>" }, "CurrentMetrics":{ "shape":"CurrentMetrics", "documentation":"<p>The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html\">Metrics definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <dl> <dt>AGENTS_AFTER_CONTACT_WORK</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#aftercallwork-real-time\">ACW</a> </p> </dd> <dt>AGENTS_AVAILABLE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#available-real-time\">Available</a> </p> </dd> <dt>AGENTS_ERROR</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#error-real-time\">Error</a> </p> </dd> <dt>AGENTS_NON_PRODUCTIVE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#non-productive-time-real-time\">NPT (Non-Productive Time)</a> </p> </dd> <dt>AGENTS_ON_CALL</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#on-call-real-time\">On contact</a> </p> </dd> <dt>AGENTS_ON_CONTACT</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#on-call-real-time\">On contact</a> </p> </dd> <dt>AGENTS_ONLINE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#online-real-time\">Online</a> </p> </dd> <dt>AGENTS_STAFFED</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#staffed-real-time\">Staffed</a> </p> </dd> <dt>CONTACTS_IN_QUEUE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#in-queue-real-time\">In queue</a> </p> </dd> <dt>CONTACTS_SCHEDULED</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#scheduled-real-time\">Scheduled</a> </p> </dd> <dt>OLDEST_CONTACT_AGE</dt> <dd> <p>Unit: SECONDS</p> <p>When you use groupings, Unit says SECONDS and the Value is returned in SECONDS. </p> <p>When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:</p> <p> <code>{ \"Metric\": { \"Name\": \"OLDEST_CONTACT_AGE\", \"Unit\": \"SECONDS\" }, \"Value\": 24113.0 </code>}</p> <p>The actual OLDEST_CONTACT_AGE is 24 seconds.</p> <p>When the filter <code>RoutingStepExpression</code> is used, this metric is still calculated from enqueue time. For example, if a contact that has been queued under <code>&lt;Expression 1&gt;</code> for 10 seconds has expired and <code>&lt;Expression 2&gt;</code> becomes active, then <code>OLDEST_CONTACT_AGE</code> for this queue will be counted starting from 10, not 0.</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#oldest-real-time\">Oldest</a> </p> </dd> <dt>SLOTS_ACTIVE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#active-real-time\">Active</a> </p> </dd> <dt>SLOTS_AVAILABLE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#availability-real-time\">Availability</a> </p> </dd> </dl>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p> <p>The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.</p>" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true }, "SortCriteria":{ "shape":"CurrentMetricSortCriteriaMaxOne", "documentation":"<p>The way to sort the resulting response based on metrics. You can enter one sort criteria. By default resources are sorted based on <code>AGENTS_ONLINE</code>, <code>DESCENDING</code>. The metric collection is sorted based on the input metrics.</p> <p>Note the following:</p> <ul> <li> <p>Sorting on <code>SLOTS_ACTIVE</code> and <code>SLOTS_AVAILABLE</code> is not supported.</p> </li> </ul>" } } }, "GetCurrentMetricDataResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p> <p>The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.</p>" }, "MetricResults":{ "shape":"CurrentMetricResults", "documentation":"<p>Information about the real-time metrics.</p>" }, "DataSnapshotTime":{ "shape":"timestamp", "documentation":"<p>The time at which the metrics were retrieved and cached for pagination.</p>" }, "ApproximateTotalCount":{ "shape":"ApproximateTotalCount", "documentation":"<p>The total count of the result, regardless of the current page size. </p>" } } }, "GetCurrentUserDataRequest":{ "type":"structure", "required":[ "InstanceId", "Filters" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Filters":{ "shape":"UserDataFilters", "documentation":"<p>The filters to apply to returned user data. You can filter up to the following limits:</p> <ul> <li> <p>Queues: 100</p> </li> <li> <p>Routing profiles: 100</p> </li> <li> <p>Agents: 100</p> </li> <li> <p>Contact states: 9</p> </li> <li> <p>User hierarchy groups: 1</p> </li> </ul> <p> The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups. </p> <p>Currently tagging is only supported on the resources that are passed in the filter.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true } } }, "GetCurrentUserDataResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" }, "UserDataList":{ "shape":"UserDataList", "documentation":"<p>A list of the user data that is returned.</p>" }, "ApproximateTotalCount":{ "shape":"ApproximateTotalCount", "documentation":"<p>The total count of the result, regardless of the current page size.</p>" } } }, "GetEffectiveHoursOfOperationsRequest":{ "type":"structure", "required":[ "InstanceId", "HoursOfOperationId", "FromDate", "ToDate" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance.</p>", "location":"uri", "locationName":"InstanceId" }, "HoursOfOperationId":{ "shape":"HoursOfOperationId", "documentation":"<p>The identifier for the hours of operation.</p>", "location":"uri", "locationName":"HoursOfOperationId" }, "FromDate":{ "shape":"HoursOfOperationOverrideYearMonthDayDateFormat", "documentation":"<p>The Date from when the hours of operation are listed.</p>", "location":"querystring", "locationName":"fromDate" }, "ToDate":{ "shape":"HoursOfOperationOverrideYearMonthDayDateFormat", "documentation":"<p>The Date until when the hours of operation are listed.</p>", "location":"querystring", "locationName":"toDate" } } }, "GetEffectiveHoursOfOperationsResponse":{ "type":"structure", "members":{ "EffectiveHoursOfOperationList":{ "shape":"EffectiveHoursOfOperationList", "documentation":"<p>Information about the effective hours of operations</p>" }, "TimeZone":{ "shape":"TimeZone", "documentation":"<p>The time zone for the hours of operation.</p>" } } }, "GetFederationTokenRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" } } }, "GetFederationTokenResponse":{ "type":"structure", "members":{ "Credentials":{ "shape":"Credentials", "documentation":"<p>The credentials to use for federation.</p>" }, "SignInUrl":{ "shape":"Url", "documentation":"<p>The URL to sign into the user's instance. </p>" }, "UserArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the user.</p>" }, "UserId":{ "shape":"AgentResourceId", "documentation":"<p>The identifier for the user. This can be the ID or the ARN of the user.</p>" } } }, "GetFlowAssociationRequest":{ "type":"structure", "required":[ "InstanceId", "ResourceId", "ResourceType" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ResourceId":{ "shape":"ARN", "documentation":"<p>The identifier of the resource.</p> <ul> <li> <p>Amazon Web Services End User Messaging SMS phone number ARN when using <code>SMS_PHONE_NUMBER</code> </p> </li> <li> <p>Amazon Web Services End User Messaging Social phone number ARN when using <code>WHATSAPP_MESSAGING_PHONE_NUMBER</code> </p> </li> </ul>", "location":"uri", "locationName":"ResourceId" }, "ResourceType":{ "shape":"FlowAssociationResourceType", "documentation":"<p>A valid resource type.</p>", "location":"uri", "locationName":"ResourceType" } } }, "GetFlowAssociationResponse":{ "type":"structure", "members":{ "ResourceId":{ "shape":"ARN", "documentation":"<p>The identifier of the resource.</p>" }, "FlowId":{ "shape":"ARN", "documentation":"<p>The identifier of the flow.</p>" }, "ResourceType":{ "shape":"FlowAssociationResourceType", "documentation":"<p>A valid resource type.</p>" } } }, "GetMetricDataRequest":{ "type":"structure", "required":[ "InstanceId", "StartTime", "EndTime", "Filters", "HistoricalMetrics" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "StartTime":{ "shape":"timestamp", "documentation":"<p>The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.</p> <p>The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.</p>" }, "EndTime":{ "shape":"timestamp", "documentation":"<p>The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.</p> <p>The time range between the start and end time must be less than 24 hours.</p>" }, "Filters":{ "shape":"Filters", "documentation":"<p>The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.</p> <p>RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.</p> <note> <p>To filter by <code>Queues</code>, enter the queue ID/ARN, not the name of the queue.</p> </note>" }, "Groupings":{ "shape":"Groupings", "documentation":"<p>The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.</p> <p>If no grouping is specified, a summary of metrics for all queues is returned.</p> <p>RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.</p>" }, "HistoricalMetrics":{ "shape":"HistoricalMetrics", "documentation":"<p>The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html\">Metrics definition</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <note> <p>This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list). </p> </note> <dl> <dt>ABANDON_TIME</dt> <dd> <p>Unit: SECONDS</p> <p>Statistic: AVG</p> </dd> <dt>AFTER_CONTACT_WORK_TIME</dt> <dd> <p>Unit: SECONDS</p> <p>Statistic: AVG</p> </dd> <dt>API_CONTACTS_HANDLED</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CALLBACK_CONTACTS_HANDLED</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_ABANDONED</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_AGENT_HUNG_UP_FIRST</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_CONSULTED</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_HANDLED</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_HANDLED_INCOMING</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_HANDLED_OUTBOUND</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_HOLD_ABANDONS</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_MISSED</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_QUEUED</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_TRANSFERRED_IN</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_TRANSFERRED_IN_FROM_QUEUE</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_TRANSFERRED_OUT</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_TRANSFERRED_OUT_FROM_QUEUE</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>HANDLE_TIME</dt> <dd> <p>Unit: SECONDS</p> <p>Statistic: AVG</p> </dd> <dt>HOLD_TIME</dt> <dd> <p>Unit: SECONDS</p> <p>Statistic: AVG</p> </dd> <dt>INTERACTION_AND_HOLD_TIME</dt> <dd> <p>Unit: SECONDS</p> <p>Statistic: AVG</p> </dd> <dt>INTERACTION_TIME</dt> <dd> <p>Unit: SECONDS</p> <p>Statistic: AVG</p> </dd> <dt>OCCUPANCY</dt> <dd> <p>Unit: PERCENT</p> <p>Statistic: AVG</p> </dd> <dt>QUEUE_ANSWER_TIME</dt> <dd> <p>Unit: SECONDS</p> <p>Statistic: AVG</p> </dd> <dt>QUEUED_TIME</dt> <dd> <p>Unit: SECONDS</p> <p>Statistic: MAX</p> </dd> <dt>SERVICE_LEVEL</dt> <dd> <p>You can include up to 20 SERVICE_LEVEL metrics in a request.</p> <p>Unit: PERCENT</p> <p>Statistic: AVG</p> <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for \"Less than\"). </p> </dd> </dl>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true } } }, "GetMetricDataResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p> <p>The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.</p>" }, "MetricResults":{ "shape":"HistoricalMetricResults", "documentation":"<p>Information about the historical metrics.</p> <p>If no grouping is specified, a summary of metric data is returned.</p>" } } }, "GetMetricDataV2Request":{ "type":"structure", "required":[ "ResourceArn", "StartTime", "EndTime", "Filters", "Metrics" ], "members":{ "ResourceArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the resource. This includes the <code>instanceId</code> an Amazon Connect instance.</p>" }, "StartTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be before the end time timestamp. The start and end time depends on the <code>IntervalPeriod</code> selected. By default the time range between start and end time is 35 days. Historical metrics are available for 3 months.</p>" }, "EndTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be later than the start time timestamp. It cannot be later than the current timestamp.</p>" }, "Interval":{ "shape":"IntervalDetails", "documentation":"<p>The interval period and timezone to apply to returned metrics.</p> <ul> <li> <p> <code>IntervalPeriod</code>: An aggregated grouping applied to request metrics. Valid <code>IntervalPeriod</code> values are: <code>FIFTEEN_MIN</code> | <code>THIRTY_MIN</code> | <code>HOUR</code> | <code>DAY</code> | <code>WEEK</code> | <code>TOTAL</code>. </p> <p>For example, if <code>IntervalPeriod</code> is selected <code>THIRTY_MIN</code>, <code>StartTime</code> and <code>EndTime</code> differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on the <code>TOTAL</code> interval period. </p> <p>The following list describes restrictions on <code>StartTime</code> and <code>EndTime</code> based on which <code>IntervalPeriod</code> is requested. </p> <ul> <li> <p> <code>FIFTEEN_MIN</code>: The difference between <code>StartTime</code> and <code>EndTime</code> must be less than 3 days.</p> </li> <li> <p> <code>THIRTY_MIN</code>: The difference between <code>StartTime</code> and <code>EndTime</code> must be less than 3 days.</p> </li> <li> <p> <code>HOUR</code>: The difference between <code>StartTime</code> and <code>EndTime</code> must be less than 3 days.</p> </li> <li> <p> <code>DAY</code>: The difference between <code>StartTime</code> and <code>EndTime</code> must be less than 35 days.</p> </li> <li> <p> <code>WEEK</code>: The difference between <code>StartTime</code> and <code>EndTime</code> must be less than 35 days.</p> </li> <li> <p> <code>TOTAL</code>: The difference between <code>StartTime</code> and <code>EndTime</code> must be less than 35 days.</p> </li> </ul> </li> <li> <p> <code>TimeZone</code>: The timezone applied to requested metrics.</p> </li> </ul>" }, "Filters":{ "shape":"FiltersV2List", "documentation":"<p>The filters to apply to returned metrics. You can filter on the following resources:</p> <ul> <li> <p>Agents</p> </li> <li> <p>Campaigns</p> </li> <li> <p>Channels</p> </li> <li> <p>Feature</p> </li> <li> <p>Queues</p> </li> <li> <p>Routing profiles</p> </li> <li> <p>Routing step expression</p> </li> <li> <p>User hierarchy groups</p> </li> </ul> <p>At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.</p> <p>For metrics for outbound campaigns analytics, you can also use campaigns to satisfy at least one filter requirement.</p> <p>To filter by phone number, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html\">Create a historical metrics report</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <p>Note the following limits:</p> <ul> <li> <p> <b>Filter keys</b>: A maximum of 5 filter keys are supported in a single request. Valid filter keys: <code>AGENT</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> | <code>AGENT_HIERARCHY_LEVEL_TWO</code> | <code>AGENT_HIERARCHY_LEVEL_THREE</code> | <code>AGENT_HIERARCHY_LEVEL_FOUR</code> | <code>AGENT_HIERARCHY_LEVEL_FIVE</code> | <code>ANSWERING_MACHINE_DETECTION_STATUS</code> | <code> BOT_ID</code> | <code>BOT_ALIAS</code> | <code>BOT_VERSION</code> | <code>BOT_LOCALE</code> | <code>BOT_INTENT_NAME</code> | <code>CAMPAIGN</code> | <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code> | <code>CAMPAIGN_EXCLUDED_EVENT_TYPE </code> | <code>CASE_TEMPLATE_ARN</code> | <code>CASE_STATUS</code> | <code>CHANNEL</code> | <code>contact/segmentAttributes/connect:Subtype</code> | <code>DISCONNECT_REASON</code> | <code>EVALUATION_FORM</code> | <code>EVALUATION_SECTION</code> | <code>EVALUATION_QUESTION</code> | <code>EVALUATION_SOURCE</code> | <code>FEATURE</code> | <code>FLOW_ACTION_ID</code> | <code>FLOW_TYPE</code> | <code>FLOWS_MODULE_RESOURCE_ID</code> | <code>FLOWS_NEXT_RESOURCE_ID</code> | <code>FLOWS_NEXT_RESOURCE_QUEUE_ID</code> | <code>FLOWS_OUTCOME_TYPE</code> | <code>FLOWS_RESOURCE_ID</code> | <code>FORM_VERSION</code> | <code>INITIATION_METHOD</code> | <code>INVOKING_RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>INVOKING_RESOURCE_TYPE</code> | <code>PARENT_FLOWS_RESOURCE_ID</code> | <code>RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>ROUTING_PROFILE</code> | <code>ROUTING_STEP_EXPRESSION</code> | <code>QUEUE</code> | <code>Q_CONNECT_ENABLED</code> | </p> </li> <li> <p> <b>Filter values</b>: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid <code>filterValue</code> for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters. </p> <p> <code>contact_lens_conversational_analytics</code> is a valid filterValue for the <code>FEATURE</code> filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.</p> <p> <code>connect:Chat</code>, <code>connect:SMS</code>, <code>connect:Telephony</code>, and <code>connect:WebRTC</code> are valid <code>filterValue</code> examples (not exhaustive) for the <code>contact/segmentAttributes/connect:Subtype filter</code> key.</p> <p> <code>ROUTING_STEP_EXPRESSION</code> is a valid filter key with a filter value up to 3000 length. This filter is case and order sensitive. JSON string fields must be sorted in ascending order and JSON array order should be kept as is.</p> <p> <code>Q_CONNECT_ENABLED</code>. TRUE and FALSE are the only valid filterValues for the <code>Q_CONNECT_ENABLED</code> filter key. </p> <ul> <li> <p>TRUE includes all contacts that had Amazon Q in Connect enabled as part of the flow.</p> </li> <li> <p>FALSE includes all contacts that did not have Amazon Q in Connect enabled as part of the flow</p> </li> </ul> <p>This filter is available only for contact record-driven metrics. </p> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-outbound-campaigns_Campaign.html\">Campaign</a> ARNs are valid <code>filterValues</code> for the <code>CAMPAIGN</code> filter key.</p> </li> </ul>" }, "Groupings":{ "shape":"GroupingsV2", "documentation":"<p>The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues.</p> <p>If no grouping is specified, a summary of all metrics is returned.</p> <p>Valid grouping keys: <code>AGENT</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> | <code>AGENT_HIERARCHY_LEVEL_TWO</code> | <code>AGENT_HIERARCHY_LEVEL_THREE</code> | <code>AGENT_HIERARCHY_LEVEL_FOUR</code> | <code>AGENT_HIERARCHY_LEVEL_FIVE</code> | <code>ANSWERING_MACHINE_DETECTION_STATUS</code> | <code>BOT_ID</code> | <code>BOT_ALIAS</code> | <code>BOT_VERSION</code> | <code>BOT_LOCALE</code> | <code>BOT_INTENT_NAME</code> | <code>CAMPAIGN</code> | <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code> | <code>CAMPAIGN_EXCLUDED_EVENT_TYPE</code> | <code>CAMPAIGN_EXECUTION_TIMESTAMP</code> | <code>CASE_TEMPLATE_ARN</code> | <code>CASE_STATUS</code> | <code>CHANNEL</code> | <code>contact/segmentAttributes/connect:Subtype</code> | <code>DISCONNECT_REASON</code> | <code>EVALUATION_FORM</code> | <code>EVALUATION_SECTION</code> | <code>EVALUATION_QUESTION</code> | <code>EVALUATION_SOURCE</code> | <code>FLOWS_RESOURCE_ID</code> | <code>FLOWS_MODULE_RESOURCE_ID</code> | <code>FLOW_ACTION_ID</code> | <code>FLOW_TYPE</code> | <code>FLOWS_OUTCOME_TYPE</code> | <code>FORM_VERSION</code> | <code>INITIATION_METHOD</code> | <code>INVOKING_RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>INVOKING_RESOURCE_TYPE</code> | <code>PARENT_FLOWS_RESOURCE_ID</code> | <code>Q_CONNECT_ENABLED</code> | <code>QUEUE</code> | <code>RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>ROUTING_PROFILE</code> | <code>ROUTING_STEP_EXPRESSION</code> </p> <p>Type: Array of strings</p> <p>Array Members: Maximum number of 4 items</p> <p>Required: No</p>" }, "Metrics":{ "shape":"MetricsV2", "documentation":"<p>The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html\">Metrics definition</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <dl> <dt>ABANDONMENT_RATE</dt> <dd> <p>Unit: Percent</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#abandonment-rate\">Abandonment rate</a> </p> </dd> <dt>AGENT_ADHERENT_TIME</dt> <dd> <p>This metric is available only in Amazon Web Services Regions where <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region\">Forecasting, capacity planning, and scheduling</a> is available.</p> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy </p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#adherent-time\">Adherent time</a> </p> </dd> <dt>AGENT_ANSWER_RATE</dt> <dd> <p>Unit: Percent</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-answer-rate\">Agent answer rate</a> </p> </dd> <dt>AGENT_NON_ADHERENT_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#non-adherent-time\">Non-adherent time</a> </p> </dd> <dt>AGENT_NON_RESPONSE</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy </p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-response\">Agent non-response</a> </p> </dd> <dt>AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p> <p>Data for this metric is available starting from October 1, 2023 0:00:00 GMT.</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-response-without-customer-abandons\">Agent non-response without customer abandons</a> </p> </dd> <dt>AGENT_OCCUPANCY</dt> <dd> <p>Unit: Percentage</p> <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy </p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#occupancy\">Occupancy</a> </p> </dd> <dt>AGENT_SCHEDULE_ADHERENCE</dt> <dd> <p>This metric is available only in Amazon Web Services Regions where <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region\">Forecasting, capacity planning, and scheduling</a> is available.</p> <p>Unit: Percent</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#adherence\">Adherence</a> </p> </dd> <dt>AGENT_SCHEDULED_TIME</dt> <dd> <p>This metric is available only in Amazon Web Services Regions where <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region\">Forecasting, capacity planning, and scheduling</a> is available.</p> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#scheduled-time\">Scheduled time</a> </p> </dd> <dt>AVG_ABANDON_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time\">Average queue abandon time</a> </p> </dd> <dt>AVG_ACTIVE_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-active-time\">Average active time</a> </p> </dd> <dt>AVG_AFTER_CONTACT_WORK_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid metric filter key: <code>INITIATION_METHOD</code> </p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#after-contact-work-time\">Average after contact work time</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>AVG_AGENT_CONNECTING_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid metric filter key: <code>INITIATION_METHOD</code>. For now, this metric only supports the following as <code>INITIATION_METHOD</code>: <code>INBOUND</code> | <code>OUTBOUND</code> | <code>CALLBACK</code> | <code>API</code> </p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-api-connecting-time\">Average agent API connecting time</a> </p> <note> <p>The <code>Negate</code> key in metric-level filters is not applicable for this metric.</p> </note> </dd> <dt>AVG_AGENT_PAUSE_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-pause-time\">Average agent pause time</a> </p> </dd> <dt>AVG_BOT_CONVERSATION_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#average-bot-conversation-time\">Average bot conversation time</a> </p> </dd> <dt>AVG_BOT_CONVERSATION_TURNS</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#average-bot-conversation-turns\">Average bot conversation turns</a> </p> </dd> <dt>AVG_CASE_RELATED_CONTACTS</dt> <dd> <p>Unit: Count</p> <p>Required filter key: CASE_TEMPLATE_ARN</p> <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-contacts-per-case\">Average contacts per case</a> </p> </dd> <dt>AVG_CASE_RESOLUTION_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Required filter key: CASE_TEMPLATE_ARN</p> <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-case-resolution-time\">Average case resolution time</a> </p> </dd> <dt>AVG_CONTACT_DURATION</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-contact-duration\">Average contact duration</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>AVG_CONVERSATION_DURATION</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-conversation-duration\">Average conversation duration</a> </p> </dd> <dt>AVG_DIALS_PER_MINUTE</dt> <dd> <p>This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.</p> <p>Unit: Count</p> <p>Valid groupings and filters: Agent, Campaign, Queue, Routing Profile</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-dials-per-minute\">Average dials per minute</a> </p> </dd> <dt>AVG_EVALUATION_SCORE</dt> <dd> <p>Unit: Percent</p> <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-evaluation-score\">Average evaluation score</a> </p> </dd> <dt>AVG_FLOW_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-flow-time\">Average flow time</a> </p> </dd> <dt>AVG_GREETING_TIME_AGENT</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-greeting-time\">Average agent greeting time</a> </p> </dd> <dt>AVG_HANDLE_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-handle-time\">Average handle time</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>AVG_HOLD_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-hold-time\">Average customer hold time</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>AVG_HOLD_TIME_ALL_CONTACTS</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-hold-time-all-contacts\">Average customer hold time all contacts</a> </p> </dd> <dt>AVG_HOLDS</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-holds\">Average holds</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>AVG_INTERACTION_AND_HOLD_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interaction-and-customer-hold-time\">Average agent interaction and customer hold time</a> </p> </dd> <dt>AVG_INTERACTION_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid metric filter key: <code>INITIATION_METHOD</code> </p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interaction-time\">Average agent interaction time</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>AVG_INTERRUPTIONS_AGENT</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interruptions\">Average agent interruptions</a> </p> </dd> <dt>AVG_INTERRUPTION_TIME_AGENT</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interruption-time\">Average agent interruption time</a> </p> </dd> <dt>AVG_NON_TALK_TIME</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-non-talk-time\">Average non-talk time</a> </p> </dd> <dt>AVG_QUEUE_ANSWER_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-answer-time\">Average queue answer time</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>AVG_RESOLUTION_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-resolution-time\">Average resolution time</a> </p> </dd> <dt>AVG_TALK_TIME</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-talk-time\">Average talk time</a> </p> </dd> <dt>AVG_TALK_TIME_AGENT</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-talk-time\">Average agent talk time</a> </p> </dd> <dt>AVG_TALK_TIME_CUSTOMER</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-talk-time\">Average customer talk time</a> </p> </dd> <dt>AVG_WAIT_TIME_AFTER_CUSTOMER_CONNECTION</dt> <dd> <p>This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.</p> <p>Unit: Seconds</p> <p>Valid groupings and filters: Campaign</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-wait-time-after-customer-connection\">Average wait time after customer connection</a> </p> </dd> <dt>AVG_WEIGHTED_EVALUATION_SCORE</dt> <dd> <p>Unit: Percent</p> <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form Id, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-weighted-evaluation-score\">Average weighted evaluation score</a> </p> </dd> <dt>BOT_CONVERSATIONS_COMPLETED</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-conversations-completed\">Bot conversations completed</a> </p> </dd> <dt>BOT_INTENTS_COMPLETED</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-intents-completed\">Bot intents completed</a> </p> </dd> <dt>CAMPAIGN_CONTACTS_ABANDONED_AFTER_X</dt> <dd> <p>This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.</p> <p>Unit: Count</p> <p>Valid groupings and filters: Agent, Campaign</p> <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>GT</code> (for <i>Greater than</i>).</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-contacts-abandoned-after-x\">Campaign contacts abandoned after X</a> </p> </dd> <dt>CAMPAIGN_CONTACTS_ABANDONED_AFTER_X_RATE</dt> <dd> <p>This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.</p> <p>Unit: Percent</p> <p>Valid groupings and filters: Agent, Campaign</p> <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>GT</code> (for <i>Greater than</i>).</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-contacts-abandoned-after-x-rate\">Campaign contacts abandoned after X rate</a> </p> </dd> <dt>CAMPAIGN_INTERACTIONS</dt> <dd> <p>This metric is available only for outbound campaigns using the email delivery mode. </p> <p>Unit: Count</p> <p>Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE</p> <p>Valid groupings and filters: Campaign</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-interactions\">Campaign interactions</a> </p> </dd> <dt>CAMPAIGN_PROGRESS_RATE</dt> <dd> <p>This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.</p> <p>Unit: Percent</p> <p>Valid groupings and filters: Campaign, Campaign Execution Timestamp</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-progress-rate\">Campaign progress rate</a> </p> </dd> <dt>CAMPAIGN_SEND_ATTEMPTS</dt> <dd> <p>This metric is available only for outbound campaigns.</p> <p>Unit: Count</p> <p>Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype </p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-send-attempts\">Campaign send attempts</a> </p> </dd> <dt>CAMPAIGN_SEND_EXCLUSIONS</dt> <dd> <p>This metric is available only for outbound campaigns.</p> <p>Valid metric filter key: CAMPAIGN_EXCLUDED_EVENT_TYPE</p> <p>Unit: Count</p> <p>Valid groupings and filters: Campaign, Campaign Excluded Event Type, Campaign Execution Timestamp</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-send-exclusions\">Campaign send exclusions</a> </p> </dd> <dt>CASES_CREATED</dt> <dd> <p>Unit: Count</p> <p>Required filter key: CASE_TEMPLATE_ARN</p> <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#cases-created\">Cases created</a> </p> </dd> <dt>CONTACTS_CREATED</dt> <dd> <p>Unit: Count</p> <p>Valid metric filter key: <code>INITIATION_METHOD</code> </p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-created\">Contacts created</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>CONTACTS_HANDLED</dt> <dd> <p>Unit: Count</p> <p>Valid metric filter key: <code>INITIATION_METHOD</code>, <code>DISCONNECT_REASON</code> </p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#api-contacts-handled\">API contacts handled</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT</dt> <dd> <p>Unit: Count</p> <p>Valid metric filter key: <code>INITIATION_METHOD</code> </p> <p>Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-by-connected-to-agent-timestamp\">Contacts handled (connected to agent timestamp)</a> </p> </dd> <dt>CONTACTS_HOLD_ABANDONS</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-disconnect\">Contacts hold disconnect</a> </p> </dd> <dt>CONTACTS_ON_HOLD_AGENT_DISCONNECT</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-agent-disconnect\">Contacts hold agent disconnect</a> </p> </dd> <dt>CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-customer-disconnect\">Contacts hold customer disconnect</a> </p> </dd> <dt>CONTACTS_PUT_ON_HOLD</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-put-on-hold\">Contacts put on hold</a> </p> </dd> <dt>CONTACTS_TRANSFERRED_OUT_EXTERNAL</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-external\">Contacts transferred out external</a> </p> </dd> <dt>CONTACTS_TRANSFERRED_OUT_INTERNAL</dt> <dd> <p>Unit: Percent</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-internal\">Contacts transferred out internal</a> </p> </dd> <dt>CONTACTS_QUEUED</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-queued\">Contacts queued</a> </p> </dd> <dt>CONTACTS_QUEUED_BY_ENQUEUE</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-queued-by-enqueue\">Contacts queued (enqueue timestamp)</a> </p> </dd> <dt>CONTACTS_REMOVED_FROM_QUEUE_IN_X</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect</p> <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you can use <code>LT</code> (for \"Less than\") or <code>LTE</code> (for \"Less than equal\").</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-removed-from-queue\">Contacts removed from queue in X seconds</a> </p> </dd> <dt>CONTACTS_RESOLVED_IN_X</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you can use <code>LT</code> (for \"Less than\") or <code>LTE</code> (for \"Less than equal\").</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-resolved\">Contacts resolved in X</a> </p> </dd> <dt>CONTACTS_TRANSFERRED_OUT</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out\">Contacts transferred out</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>CONTACTS_TRANSFERRED_OUT_BY_AGENT</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-by-agent\">Contacts transferred out by agent</a> </p> </dd> <dt>CONTACTS_TRANSFERRED_OUT_FROM_QUEUE</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue\">Contacts transferred out queue</a> </p> </dd> <dt>CURRENT_CASES</dt> <dd> <p>Unit: Count</p> <p>Required filter key: CASE_TEMPLATE_ARN</p> <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#current-cases\">Current cases</a> </p> </dd> <dt>DELIVERY_ATTEMPTS</dt> <dd> <p>This metric is available only for outbound campaigns.</p> <p>Unit: Count</p> <p>Valid metric filter key: <code>ANSWERING_MACHINE_DETECTION_STATUS</code>, <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code>, <code>DISCONNECT_REASON</code> </p> <p>Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Campaign Delivery EventType, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#delivery-attempts\">Delivery attempts</a> </p> <note> <p>Campaign Delivery EventType filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes. </p> </note> </dd> <dt>DELIVERY_ATTEMPT_DISPOSITION_RATE</dt> <dd> <p>This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.</p> <p>Unit: Percent</p> <p>Valid metric filter key: <code>ANSWERING_MACHINE_DETECTION_STATUS</code>, <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code>, <code>DISCONNECT_REASON</code> </p> <p>Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#delivery-attempt-disposition-rate\">Delivery attempt disposition rate</a> </p> <note> <p>Campaign Delivery Event Type filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes. </p> </note> </dd> <dt>EVALUATIONS_PERFORMED</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#evaluations-performed\">Evaluations performed</a> </p> </dd> <dt>FLOWS_OUTCOME</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#flows-outcome\">Flows outcome</a> </p> </dd> <dt>FLOWS_STARTED</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows resource ID, Initiation method, Resource published timestamp</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#flows-started\">Flows started</a> </p> </dd> <dt>HUMAN_ANSWERED_CALLS</dt> <dd> <p>This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled. </p> <p>Unit: Count</p> <p>Valid groupings and filters: Agent, Campaign</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#human-answered\">Human answered</a> </p> </dd> <dt>MAX_FLOW_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#maximum-flow-time\">Maximum flow time</a> </p> </dd> <dt>MAX_QUEUED_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#maximum-queued-time\">Maximum queued time</a> </p> </dd> <dt>MIN_FLOW_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#minimum-flow-time\">Minimum flow time</a> </p> </dd> <dt>PERCENT_AUTOMATIC_FAILS</dt> <dd> <p>Unit: Percent</p> <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#automatic-fails-percent\">Automatic fails percent</a> </p> </dd> <dt>PERCENT_BOT_CONVERSATIONS_OUTCOME</dt> <dd> <p>Unit: Percent</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#percent-bot-conversations-outcome\">Percent bot conversations outcome</a> </p> </dd> <dt>PERCENT_BOT_INTENTS_OUTCOME</dt> <dd> <p>Unit: Percent</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#percent-bot-intents-outcome\">Percent bot intents outcome</a> </p> </dd> <dt>PERCENT_CASES_FIRST_CONTACT_RESOLVED</dt> <dd> <p>Unit: Percent</p> <p>Required filter key: CASE_TEMPLATE_ARN</p> <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#cases-resolved-on-first-contact\">Cases resolved on first contact</a> </p> </dd> <dt>PERCENT_CONTACTS_STEP_EXPIRED</dt> <dd> <p>Unit: Percent</p> <p>Valid groupings and filters: Queue, RoutingStepExpression</p> <p>UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.</p> </dd> <dt>PERCENT_CONTACTS_STEP_JOINED</dt> <dd> <p>Unit: Percent</p> <p>Valid groupings and filters: Queue, RoutingStepExpression</p> <p>UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.</p> </dd> <dt>PERCENT_FLOWS_OUTCOME</dt> <dd> <p>Unit: Percent</p> <p>Valid metric filter key: <code>FLOWS_OUTCOME_TYPE</code> </p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#flows-outcome-percentage\">Flows outcome percentage</a>.</p> <note> <p>The <code>FLOWS_OUTCOME_TYPE</code> is not a valid grouping.</p> </note> </dd> <dt>PERCENT_NON_TALK_TIME</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Percentage</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#non-talk-time-percent\">Non-talk time percent</a> </p> </dd> <dt>PERCENT_TALK_TIME</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Percentage</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#talk-time-percent\">Talk time percent</a> </p> </dd> <dt>PERCENT_TALK_TIME_AGENT</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Percentage</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-talk-time-percent\">Agent talk time percent</a> </p> </dd> <dt>PERCENT_TALK_TIME_CUSTOMER</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Percentage</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#customer-talk-time-percent\">Customer talk time percent</a> </p> </dd> <dt>RECIPIENTS_ATTEMPTED</dt> <dd> <p>This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.</p> <p>Unit: Count</p> <p>Valid groupings and filters: Campaign, Campaign Execution Timestamp</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#recipients-attempted\">Recipients attempted</a> </p> </dd> <dt>RECIPIENTS_INTERACTED</dt> <dd> <p>This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.</p> <p>Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE</p> <p>Unit: Count</p> <p>Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype, Campaign Execution Timestamp</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#recipients-interacted\">Recipients interacted</a> </p> </dd> <dt>RECIPIENTS_TARGETED</dt> <dd> <p>This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.</p> <p>Unit: Count</p> <p>Valid groupings and filters: Campaign, Campaign Execution Timestamp</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#recipients-targeted\">Recipients targeted</a> </p> </dd> <dt>REOPENED_CASE_ACTIONS</dt> <dd> <p>Unit: Count</p> <p>Required filter key: CASE_TEMPLATE_ARN</p> <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#cases-reopened\">Cases reopened</a> </p> </dd> <dt>RESOLVED_CASE_ACTIONS</dt> <dd> <p>Unit: Count</p> <p>Required filter key: CASE_TEMPLATE_ARN</p> <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#cases-resolved\">Cases resolved</a> </p> </dd> <dt>SERVICE_LEVEL</dt> <dd> <p>You can include up to 20 SERVICE_LEVEL metrics in a request.</p> <p>Unit: Percent</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect</p> <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you can use <code>LT</code> (for \"Less than\") or <code>LTE</code> (for \"Less than equal\").</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#service-level\">Service level X</a> </p> </dd> <dt>STEP_CONTACTS_QUEUED</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, RoutingStepExpression</p> <p>UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.</p> </dd> <dt>SUM_AFTER_CONTACT_WORK_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#after-contact-work-time\">After contact work time</a> </p> </dd> <dt>SUM_CONNECTING_TIME_AGENT</dt> <dd> <p>Unit: Seconds</p> <p>Valid metric filter key: <code>INITIATION_METHOD</code>. This metric only supports the following filter keys as <code>INITIATION_METHOD</code>: <code>INBOUND</code> | <code>OUTBOUND</code> | <code>CALLBACK</code> | <code>API</code> </p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-api-connecting-time\">Agent API connecting time</a> </p> <note> <p>The <code>Negate</code> key in metric-level filters is not applicable for this metric.</p> </note> </dd> <dt>CONTACTS_ABANDONED</dt> <dd> <p>Unit: Count</p> <p>Metric filter: </p> <ul> <li> <p>Valid values: <code>API</code>| <code>Incoming</code> | <code>Outbound</code> | <code>Transfer</code> | <code>Callback</code> | <code>Queue_Transfer</code>| <code>Disconnect</code> </p> </li> </ul> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-abandoned\">Contact abandoned</a> </p> </dd> <dt>SUM_CONTACTS_ABANDONED_IN_X</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you can use <code>LT</code> (for \"Less than\") or <code>LTE</code> (for \"Less than equal\").</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-abandoned-in-x-seconds\">Contacts abandoned in X seconds</a> </p> </dd> <dt>SUM_CONTACTS_ANSWERED_IN_X</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you can use <code>LT</code> (for \"Less than\") or <code>LTE</code> (for \"Less than equal\").</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-answered-in-x-seconds\">Contacts answered in X seconds</a> </p> </dd> <dt>SUM_CONTACT_FLOW_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contact-flow-time\">Contact flow time</a> </p> </dd> <dt>SUM_CONTACT_TIME_AGENT</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-on-contact-time\">Agent on contact time</a> </p> </dd> <dt>SUM_CONTACTS_DISCONNECTED </dt> <dd> <p>Valid metric filter key: <code>DISCONNECT_REASON</code> </p> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contact-disconnected\">Contact disconnected</a> </p> </dd> <dt>SUM_ERROR_STATUS_TIME_AGENT</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#error-status-time\">Error status time</a> </p> </dd> <dt>SUM_HANDLE_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contact-handle-time\">Contact handle time</a> </p> </dd> <dt>SUM_HOLD_TIME</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#customer-hold-time\">Customer hold time</a> </p> </dd> <dt>SUM_IDLE_TIME_AGENT</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-idle-time\">Agent idle time</a> </p> </dd> <dt>SUM_INTERACTION_AND_HOLD_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-interaction-and-hold-time\">Agent interaction and hold time</a> </p> </dd> <dt>SUM_INTERACTION_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-interaction-time\">Agent interaction time</a> </p> </dd> <dt>SUM_NON_PRODUCTIVE_TIME_AGENT</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-productive-time\">Agent non-productive time</a> </p> </dd> <dt>SUM_ONLINE_TIME_AGENT</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#online-time\">Online time</a> </p> </dd> <dt>SUM_RETRY_CALLBACK_ATTEMPTS</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#callback-attempts\">Callback attempts</a> </p> </dd> </dl>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>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.</p>" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true } } }, "GetMetricDataV2Response":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken2500", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" }, "MetricResults":{ "shape":"MetricResultsV2", "documentation":"<p>Information about the metrics requested in the API request If no grouping is specified, a summary of metric data is returned. </p>" } } }, "GetPromptFileRequest":{ "type":"structure", "required":[ "InstanceId", "PromptId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "PromptId":{ "shape":"PromptId", "documentation":"<p>A unique identifier for the prompt.</p>", "location":"uri", "locationName":"PromptId" } } }, "GetPromptFileResponse":{ "type":"structure", "members":{ "PromptPresignedUrl":{ "shape":"PromptPresignedUrl", "documentation":"<p>A generated URL to the prompt that can be given to an unauthorized user so they can access the prompt in S3.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when this resource was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The Amazon Web Services Region where this resource was last modified.</p>" } } }, "GetTaskTemplateRequest":{ "type":"structure", "required":[ "InstanceId", "TaskTemplateId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "TaskTemplateId":{ "shape":"TaskTemplateId", "documentation":"<p>A unique identifier for the task template.</p>", "location":"uri", "locationName":"TaskTemplateId" }, "SnapshotVersion":{ "shape":"SnapshotVersion", "documentation":"<p>The system generated version of a task template that is associated with a task, when the task is created.</p>", "location":"querystring", "locationName":"snapshotVersion" } } }, "GetTaskTemplateResponse":{ "type":"structure", "required":[ "Id", "Arn", "Name" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "Id":{ "shape":"TaskTemplateId", "documentation":"<p>A unique identifier for the task template.</p>" }, "Arn":{ "shape":"TaskTemplateArn", "documentation":"<p>The Amazon Resource Name (ARN).</p>" }, "Name":{ "shape":"TaskTemplateName", "documentation":"<p>The name of the task template.</p>" }, "Description":{ "shape":"TaskTemplateDescription", "documentation":"<p>The description of the task template.</p>" }, "ContactFlowId":{ "shape":"ContactFlowId", "documentation":"<p>The identifier of the flow that runs by default when a task is created by referencing this template.</p>" }, "SelfAssignFlowId":{ "shape":"ContactFlowId", "documentation":"<p>ContactFlowId for the flow that will be run if this template is used to create a self-assigned task</p>" }, "Constraints":{ "shape":"TaskTemplateConstraints", "documentation":"<p>Constraints that are applicable to the fields listed.</p>" }, "Defaults":{ "shape":"TaskTemplateDefaults", "documentation":"<p>The default values for fields when a task is created by referencing this template.</p>" }, "Fields":{ "shape":"TaskTemplateFields", "documentation":"<p>Fields that are part of the template.</p>" }, "Status":{ "shape":"TaskTemplateStatus", "documentation":"<p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it. Tasks can only be created from <code>ACTIVE</code> templates. If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.</p>" }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"<p>The timestamp when the task template was last modified.</p>" }, "CreatedTime":{ "shape":"timestamp", "documentation":"<p>The timestamp when the task template was created.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" } } }, "GetTrafficDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"TrafficDistributionGroupIdOrArn", "documentation":"<p>The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.</p>", "location":"uri", "locationName":"Id" } } }, "GetTrafficDistributionResponse":{ "type":"structure", "members":{ "TelephonyConfig":{ "shape":"TelephonyConfig", "documentation":"<p>The distribution of traffic between the instance and its replicas.</p>" }, "Id":{ "shape":"TrafficDistributionGroupId", "documentation":"<p>The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.</p>" }, "Arn":{ "shape":"TrafficDistributionGroupArn", "documentation":"<p>The Amazon Resource Name (ARN) of the traffic distribution group.</p>" }, "SignInConfig":{ "shape":"SignInConfig", "documentation":"<p>The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s).</p>" }, "AgentConfig":{ "shape":"AgentConfig", "documentation":"<p>The distribution of agents between the instance and its replica(s).</p>" } } }, "GlobalSignInEndpoint":{ "type":"string", "max":128, "min":1 }, "Grouping":{ "type":"string", "enum":[ "QUEUE", "CHANNEL", "ROUTING_PROFILE", "ROUTING_STEP_EXPRESSION" ] }, "GroupingV2":{"type":"string"}, "Groupings":{ "type":"list", "member":{"shape":"Grouping"}, "max":2 }, "GroupingsV2":{ "type":"list", "member":{"shape":"GroupingV2"}, "max":4 }, "HierarchyGroup":{ "type":"structure", "members":{ "Id":{ "shape":"HierarchyGroupId", "documentation":"<p>The identifier of the hierarchy group.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the hierarchy group.</p>" }, "Name":{ "shape":"HierarchyGroupName", "documentation":"<p>The name of the hierarchy group.</p>" }, "LevelId":{ "shape":"HierarchyLevelId", "documentation":"<p>The identifier of the level in the hierarchy group.</p>" }, "HierarchyPath":{ "shape":"HierarchyPath", "documentation":"<p>Information about the levels in the hierarchy group.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when this resource was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The Amazon Web Services Region where this resource was last modified.</p>" } }, "documentation":"<p>Contains information about a hierarchy group.</p>" }, "HierarchyGroupCondition":{ "type":"structure", "members":{ "Value":{ "shape":"String", "documentation":"<p>The value in the hierarchy group condition.</p>" }, "HierarchyGroupMatchType":{ "shape":"HierarchyGroupMatchType", "documentation":"<p>The type of hierarchy group match.</p>" } }, "documentation":"<p>A leaf node condition which can be used to specify a hierarchy group condition.</p>" }, "HierarchyGroupId":{"type":"string"}, "HierarchyGroupIdList":{ "type":"list", "member":{"shape":"HierarchyGroupId"}, "max":10, "min":0 }, "HierarchyGroupMatchType":{ "type":"string", "enum":[ "EXACT", "WITH_CHILD_GROUPS" ] }, "HierarchyGroupName":{"type":"string"}, "HierarchyGroupSummary":{ "type":"structure", "members":{ "Id":{ "shape":"HierarchyGroupId", "documentation":"<p>The identifier of the hierarchy group.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the hierarchy group.</p>" }, "Name":{ "shape":"HierarchyGroupName", "documentation":"<p>The name of the hierarchy group.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when this resource was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The Amazon Web Services Region where this resource was last modified.</p>" } }, "documentation":"<p>Contains summary information about a hierarchy group.</p>" }, "HierarchyGroupSummaryList":{ "type":"list", "member":{"shape":"HierarchyGroupSummary"} }, "HierarchyGroupSummaryReference":{ "type":"structure", "members":{ "Id":{ "shape":"HierarchyGroupId", "documentation":"<p>The unique identifier for the hierarchy group.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the hierarchy group. </p>" } }, "documentation":"<p>Information about the hierarchy group.</p>" }, "HierarchyGroups":{ "type":"structure", "members":{ "Level1":{ "shape":"AgentHierarchyGroup", "documentation":"<p>The group at level one of the agent hierarchy.</p>" }, "Level2":{ "shape":"AgentHierarchyGroup", "documentation":"<p>The group at level two of the agent hierarchy.</p>" }, "Level3":{ "shape":"AgentHierarchyGroup", "documentation":"<p>The group at level three of the agent hierarchy.</p>" }, "Level4":{ "shape":"AgentHierarchyGroup", "documentation":"<p>The group at level four of the agent hierarchy.</p>" }, "Level5":{ "shape":"AgentHierarchyGroup", "documentation":"<p>The group at level five of the agent hierarchy.</p>" } }, "documentation":"<p>Information about the agent hierarchy. Hierarchies can be configured with up to five levels.</p>" }, "HierarchyLevel":{ "type":"structure", "members":{ "Id":{ "shape":"HierarchyLevelId", "documentation":"<p>The identifier of the hierarchy level.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the hierarchy level.</p>" }, "Name":{ "shape":"HierarchyLevelName", "documentation":"<p>The name of the hierarchy level.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when this resource was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The Amazon Web Services Region where this resource was last modified.</p>" } }, "documentation":"<p>Contains information about a hierarchy level.</p>" }, "HierarchyLevelId":{"type":"string"}, "HierarchyLevelName":{"type":"string"}, "HierarchyLevelUpdate":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"HierarchyLevelName", "documentation":"<p>The name of the user hierarchy level. Must not be more than 50 characters.</p>" } }, "documentation":"<p>Contains information about the hierarchy level to update.</p>" }, "HierarchyPath":{ "type":"structure", "members":{ "LevelOne":{ "shape":"HierarchyGroupSummary", "documentation":"<p>Information about level one.</p>" }, "LevelTwo":{ "shape":"HierarchyGroupSummary", "documentation":"<p>Information about level two.</p>" }, "LevelThree":{ "shape":"HierarchyGroupSummary", "documentation":"<p>Information about level three.</p>" }, "LevelFour":{ "shape":"HierarchyGroupSummary", "documentation":"<p>Information about level four.</p>" }, "LevelFive":{ "shape":"HierarchyGroupSummary", "documentation":"<p>Information about level five.</p>" } }, "documentation":"<p>Contains information about the levels of a hierarchy group.</p>" }, "HierarchyPathReference":{ "type":"structure", "members":{ "LevelOne":{ "shape":"HierarchyGroupSummaryReference", "documentation":"<p>Information about level one.</p>" }, "LevelTwo":{ "shape":"HierarchyGroupSummaryReference", "documentation":"<p>Information about level two.</p>" }, "LevelThree":{ "shape":"HierarchyGroupSummaryReference", "documentation":"<p>Information about level three.</p>" }, "LevelFour":{ "shape":"HierarchyGroupSummaryReference", "documentation":"<p>Information about level four.</p>" }, "LevelFive":{ "shape":"HierarchyGroupSummaryReference", "documentation":"<p>Information about level five.</p>" } }, "documentation":"<p>Information about the levels in the hierarchy group.</p>" }, "HierarchyRestrictedResourceList":{ "type":"list", "member":{"shape":"HierarchyRestrictedResourceName"} }, "HierarchyRestrictedResourceName":{ "type":"string", "max":128, "min":1 }, "HierarchyStructure":{ "type":"structure", "members":{ "LevelOne":{ "shape":"HierarchyLevel", "documentation":"<p>Information about level one.</p>" }, "LevelTwo":{ "shape":"HierarchyLevel", "documentation":"<p>Information about level two.</p>" }, "LevelThree":{ "shape":"HierarchyLevel", "documentation":"<p>Information about level three.</p>" }, "LevelFour":{ "shape":"HierarchyLevel", "documentation":"<p>Information about level four.</p>" }, "LevelFive":{ "shape":"HierarchyLevel", "documentation":"<p>Information about level five.</p>" } }, "documentation":"<p>Contains information about a hierarchy structure.</p>" }, "HierarchyStructureUpdate":{ "type":"structure", "members":{ "LevelOne":{ "shape":"HierarchyLevelUpdate", "documentation":"<p>The update for level one.</p>" }, "LevelTwo":{ "shape":"HierarchyLevelUpdate", "documentation":"<p>The update for level two.</p>" }, "LevelThree":{ "shape":"HierarchyLevelUpdate", "documentation":"<p>The update for level three.</p>" }, "LevelFour":{ "shape":"HierarchyLevelUpdate", "documentation":"<p>The update for level four.</p>" }, "LevelFive":{ "shape":"HierarchyLevelUpdate", "documentation":"<p>The update for level five.</p>" } }, "documentation":"<p>Contains information about the level hierarchy to update.</p>" }, "HistoricalMetric":{ "type":"structure", "members":{ "Name":{ "shape":"HistoricalMetricName", "documentation":"<p>The name of the metric.</p>" }, "Threshold":{ "shape":"Threshold", "documentation":"<p>The threshold for the metric, used with service level metrics.</p>", "box":true }, "Statistic":{ "shape":"Statistic", "documentation":"<p>The statistic for the metric.</p>" }, "Unit":{ "shape":"Unit", "documentation":"<p>The unit for the metric.</p>" } }, "documentation":"<p>Contains information about a historical metric. For a description of each metric, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html\">Metrics definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "HistoricalMetricData":{ "type":"structure", "members":{ "Metric":{ "shape":"HistoricalMetric", "documentation":"<p>Information about the metric.</p>" }, "Value":{ "shape":"Value", "documentation":"<p>The value of the metric.</p>", "box":true } }, "documentation":"<p>Contains the data for a historical metric.</p>" }, "HistoricalMetricDataCollections":{ "type":"list", "member":{"shape":"HistoricalMetricData"} }, "HistoricalMetricName":{ "type":"string", "documentation":"<p>The historical metric names.</p>", "enum":[ "CONTACTS_QUEUED", "CONTACTS_HANDLED", "CONTACTS_ABANDONED", "CONTACTS_CONSULTED", "CONTACTS_AGENT_HUNG_UP_FIRST", "CONTACTS_HANDLED_INCOMING", "CONTACTS_HANDLED_OUTBOUND", "CONTACTS_HOLD_ABANDONS", "CONTACTS_TRANSFERRED_IN", "CONTACTS_TRANSFERRED_OUT", "CONTACTS_TRANSFERRED_IN_FROM_QUEUE", "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE", "CONTACTS_MISSED", "CALLBACK_CONTACTS_HANDLED", "API_CONTACTS_HANDLED", "OCCUPANCY", "HANDLE_TIME", "AFTER_CONTACT_WORK_TIME", "QUEUED_TIME", "ABANDON_TIME", "QUEUE_ANSWER_TIME", "HOLD_TIME", "INTERACTION_TIME", "INTERACTION_AND_HOLD_TIME", "SERVICE_LEVEL" ] }, "HistoricalMetricResult":{ "type":"structure", "members":{ "Dimensions":{ "shape":"Dimensions", "documentation":"<p>The dimension for the metrics.</p>" }, "Collections":{ "shape":"HistoricalMetricDataCollections", "documentation":"<p>The set of metrics.</p>" } }, "documentation":"<p>Contains information about the historical metrics retrieved.</p>" }, "HistoricalMetricResults":{ "type":"list", "member":{"shape":"HistoricalMetricResult"} }, "HistoricalMetrics":{ "type":"list", "member":{"shape":"HistoricalMetric"} }, "Hours":{ "type":"integer", "max":87600, "min":0 }, "Hours24Format":{ "type":"integer", "max":23, "min":0 }, "HoursOfOperation":{ "type":"structure", "members":{ "HoursOfOperationId":{ "shape":"HoursOfOperationId", "documentation":"<p>The identifier for the hours of operation.</p>" }, "HoursOfOperationArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the hours of operation.</p>" }, "Name":{ "shape":"CommonNameLength127", "documentation":"<p>The name for the hours of operation.</p>" }, "Description":{ "shape":"HoursOfOperationDescription", "documentation":"<p>The description for the hours of operation.</p>" }, "TimeZone":{ "shape":"TimeZone", "documentation":"<p>The time zone for the hours of operation.</p>" }, "Config":{ "shape":"HoursOfOperationConfigList", "documentation":"<p>Configuration information for the hours of operation.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when this resource was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The Amazon Web Services Region where this resource was last modified.</p>" } }, "documentation":"<p>Information about of the hours of operation.</p>" }, "HoursOfOperationConfig":{ "type":"structure", "required":[ "Day", "StartTime", "EndTime" ], "members":{ "Day":{ "shape":"HoursOfOperationDays", "documentation":"<p>The day that the hours of operation applies to.</p>" }, "StartTime":{ "shape":"HoursOfOperationTimeSlice", "documentation":"<p>The start time that your contact center opens.</p>" }, "EndTime":{ "shape":"HoursOfOperationTimeSlice", "documentation":"<p>The end time that your contact center closes.</p>" } }, "documentation":"<p>Contains information about the hours of operation.</p>" }, "HoursOfOperationConfigList":{ "type":"list", "member":{"shape":"HoursOfOperationConfig"}, "max":100, "min":0 }, "HoursOfOperationDays":{ "type":"string", "enum":[ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ] }, "HoursOfOperationDescription":{ "type":"string", "max":250, "min":1 }, "HoursOfOperationId":{"type":"string"}, "HoursOfOperationList":{ "type":"list", "member":{"shape":"HoursOfOperation"} }, "HoursOfOperationName":{"type":"string"}, "HoursOfOperationOverride":{ "type":"structure", "members":{ "HoursOfOperationOverrideId":{ "shape":"HoursOfOperationOverrideId", "documentation":"<p>The identifier for the hours of operation override.</p>" }, "HoursOfOperationId":{ "shape":"HoursOfOperationId", "documentation":"<p>The identifier for the hours of operation.</p>" }, "HoursOfOperationArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the hours of operation.</p>" }, "Name":{ "shape":"CommonHumanReadableName", "documentation":"<p>The name of the hours of operation override.</p>" }, "Description":{ "shape":"CommonHumanReadableDescription", "documentation":"<p>The description of the hours of operation override.</p>" }, "Config":{ "shape":"HoursOfOperationOverrideConfigList", "documentation":"<p>Configuration information for the hours of operation override: day, start time, and end time.</p>" }, "EffectiveFrom":{ "shape":"HoursOfOperationOverrideYearMonthDayDateFormat", "documentation":"<p>The date from which the hours of operation override would be effective.</p>" }, "EffectiveTill":{ "shape":"HoursOfOperationOverrideYearMonthDayDateFormat", "documentation":"<p>The date till which the hours of operation override would be effective.</p>" } }, "documentation":"<p>Information about the hours of operations override.</p>" }, "HoursOfOperationOverrideConfig":{ "type":"structure", "members":{ "Day":{ "shape":"OverrideDays", "documentation":"<p>The day that the hours of operation override applies to.</p>" }, "StartTime":{ "shape":"OverrideTimeSlice", "documentation":"<p>The start time when your contact center opens if overrides are applied.</p>" }, "EndTime":{ "shape":"OverrideTimeSlice", "documentation":"<p>The end time that your contact center closes if overrides are applied.</p>" } }, "documentation":"<p>Information about the hours of operation override config: day, start time, and end time.</p>" }, "HoursOfOperationOverrideConfigList":{ "type":"list", "member":{"shape":"HoursOfOperationOverrideConfig"}, "max":100, "min":0 }, "HoursOfOperationOverrideId":{ "type":"string", "max":36, "min":1 }, "HoursOfOperationOverrideList":{ "type":"list", "member":{"shape":"HoursOfOperationOverride"} }, "HoursOfOperationOverrideSearchConditionList":{ "type":"list", "member":{"shape":"HoursOfOperationOverrideSearchCriteria"} }, "HoursOfOperationOverrideSearchCriteria":{ "type":"structure", "members":{ "OrConditions":{ "shape":"HoursOfOperationOverrideSearchConditionList", "documentation":"<p>A list of conditions which would be applied together with an OR condition.</p>" }, "AndConditions":{ "shape":"HoursOfOperationOverrideSearchConditionList", "documentation":"<p>A list of conditions which would be applied together with an AND condition.</p>" }, "StringCondition":{"shape":"StringCondition"}, "DateCondition":{ "shape":"DateCondition", "documentation":"<p>A leaf node condition which can be used to specify a date condition.</p>" } }, "documentation":"<p>The search criteria to be used to return hours of operations overrides.</p>" }, "HoursOfOperationOverrideYearMonthDayDateFormat":{ "type":"string", "pattern":"^\\d{4}-\\d{2}-\\d{2}$" }, "HoursOfOperationSearchConditionList":{ "type":"list", "member":{"shape":"HoursOfOperationSearchCriteria"} }, "HoursOfOperationSearchCriteria":{ "type":"structure", "members":{ "OrConditions":{ "shape":"HoursOfOperationSearchConditionList", "documentation":"<p>A list of conditions which would be applied together with an OR condition.</p>" }, "AndConditions":{ "shape":"HoursOfOperationSearchConditionList", "documentation":"<p>A list of conditions which would be applied together with an AND condition.</p>" }, "StringCondition":{ "shape":"StringCondition", "documentation":"<p>A leaf node condition which can be used to specify a string condition.</p> <note> <p>The currently supported values for <code>FieldName</code> are <code>name</code>, <code>description</code>, <code>timezone</code>, and <code>resourceID</code>.</p> </note>" } }, "documentation":"<p>The search criteria to be used to return hours of operations.</p>" }, "HoursOfOperationSearchFilter":{ "type":"structure", "members":{ "TagFilter":{"shape":"ControlPlaneTagFilter"} }, "documentation":"<p>Filters to be applied to search results.</p>" }, "HoursOfOperationSummary":{ "type":"structure", "members":{ "Id":{ "shape":"HoursOfOperationId", "documentation":"<p>The identifier of the hours of operation.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the hours of operation.</p>" }, "Name":{ "shape":"HoursOfOperationName", "documentation":"<p>The name of the hours of operation.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when this resource was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The Amazon Web Services Region where this resource was last modified.</p>" } }, "documentation":"<p>Contains summary information about hours of operation for a contact center.</p>" }, "HoursOfOperationSummaryList":{ "type":"list", "member":{"shape":"HoursOfOperationSummary"} }, "HoursOfOperationTimeSlice":{ "type":"structure", "required":[ "Hours", "Minutes" ], "members":{ "Hours":{ "shape":"Hours24Format", "documentation":"<p>The hours.</p>", "box":true }, "Minutes":{ "shape":"MinutesLimit60", "documentation":"<p>The minutes.</p>", "box":true } }, "documentation":"<p>The start time or end time for an hours of operation.</p>" }, "ISO8601Datetime":{"type":"string"}, "IdempotencyException":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"<p>An entity with the same name already exists.</p>", "error":{"httpStatusCode":409}, "exception":true }, "ImportPhoneNumberRequest":{ "type":"structure", "required":[ "InstanceId", "SourcePhoneNumberArn" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "SourcePhoneNumberArn":{ "shape":"ARN", "documentation":"<p>The claimed phone number ARN being imported from the external service, such as Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it looks like the ARN of the phone number to import from Amazon Web Services End User Messaging.</p>" }, "PhoneNumberDescription":{ "shape":"PhoneNumberDescription", "documentation":"<p>The description of the phone number.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true } } }, "ImportPhoneNumberResponse":{ "type":"structure", "members":{ "PhoneNumberId":{ "shape":"PhoneNumberId", "documentation":"<p>A unique identifier for the phone number.</p>" }, "PhoneNumberArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the phone number.</p>" } } }, "InboundAdditionalRecipients":{ "type":"structure", "members":{ "ToAddresses":{ "shape":"EmailAddressRecipientList", "documentation":"<p>The <b>additional</b> recipients information present in to list. You must have 1 required recipient (<code>DestinationEmailAddress</code>). You can then specify up to 49 additional recipients (across <code>ToAddresses</code> and <code>CcAddresses</code>), for a total of 50 recipients.</p>" }, "CcAddresses":{ "shape":"EmailAddressRecipientList", "documentation":"<p>The <b>additional</b> recipients information present in cc list. You must have 1 required recipient (<code>DestinationEmailAddress</code>). You can then specify up to 49 additional recipients (across <code>ToAddresses</code> and <code>CcAddresses</code>), for a total of 50 recipients.</p>" } }, "documentation":"<p>Information about the additional TO and CC recipients of an inbound email contact.</p> <note> <p>You can include up to 50 email addresses in total, distributed across <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_StartEmailContact.html#API_StartEmailContact_RequestBody\">DestinationEmailAddress</a>, <code>ToAddresses</code>, and <code>CcAddresses</code>. This total must include one required <code>DestinationEmailAddress</code>. You can then specify up to 49 addresses allocated across <code>ToAddresses</code> and <code>CcAddresses</code> as needed.</p> </note>" }, "InboundCallsEnabled":{"type":"boolean"}, "InboundEmailContent":{ "type":"structure", "required":["MessageSourceType"], "members":{ "MessageSourceType":{ "shape":"InboundMessageSourceType", "documentation":"<p>The message source type, that is, <code>RAW</code>.</p>" }, "RawMessage":{ "shape":"InboundRawMessage", "documentation":"<p>The raw email body content.</p>" } }, "documentation":"<p>Information about email body content.</p>" }, "InboundMessageSourceType":{ "type":"string", "enum":["RAW"] }, "InboundRawMessage":{ "type":"structure", "required":[ "Subject", "Body", "ContentType" ], "members":{ "Subject":{ "shape":"InboundSubject", "documentation":"<p>The email subject.</p>" }, "Body":{ "shape":"Body", "documentation":"<p>The email message body.</p>" }, "ContentType":{ "shape":"EmailMessageContentType", "documentation":"<p>Type of content, that is, <code>text/plain</code> or <code>text/html</code>.</p>" }, "Headers":{ "shape":"EmailHeaders", "documentation":"<p>Headers present in inbound email.</p>" } }, "documentation":"<p>Information about the raw email body content.</p>" }, "InboundSubject":{ "type":"string", "max":998, "min":0, "sensitive":true }, "IncludeRawMessage":{"type":"boolean"}, "Index":{"type":"integer"}, "InitiateAs":{ "type":"string", "enum":[ "CONNECTED_TO_USER", "COMPLETED" ] }, "InitiationMethodList":{ "type":"list", "member":{"shape":"ContactInitiationMethod"} }, "Instance":{ "type":"structure", "members":{ "Id":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the instance.</p>" }, "IdentityManagementType":{ "shape":"DirectoryType", "documentation":"<p>The identity management type.</p>" }, "InstanceAlias":{ "shape":"DirectoryAlias", "documentation":"<p>The alias of instance.</p>" }, "CreatedTime":{ "shape":"Timestamp", "documentation":"<p>When the instance was created.</p>" }, "ServiceRole":{ "shape":"ARN", "documentation":"<p>The service role of the instance.</p>" }, "InstanceStatus":{ "shape":"InstanceStatus", "documentation":"<p>The state of the instance.</p>" }, "StatusReason":{ "shape":"InstanceStatusReason", "documentation":"<p>Relevant details why the instance was not successfully created. </p>" }, "InboundCallsEnabled":{ "shape":"InboundCallsEnabled", "documentation":"<p>Whether inbound calls are enabled.</p>" }, "OutboundCallsEnabled":{ "shape":"OutboundCallsEnabled", "documentation":"<p>Whether outbound calls are enabled.</p>" }, "InstanceAccessUrl":{ "shape":"Url", "documentation":"<p>This URL allows contact center users to access the Amazon Connect admin website.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags of an instance.</p>" } }, "documentation":"<p>The Amazon Connect instance.</p>" }, "InstanceArn":{ "type":"string", "pattern":"arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9-]{1}:[0-9]{1,20}:instance/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" }, "InstanceAttributeType":{ "type":"string", "enum":[ "INBOUND_CALLS", "OUTBOUND_CALLS", "CONTACTFLOW_LOGS", "CONTACT_LENS", "AUTO_RESOLVE_BEST_VOICES", "USE_CUSTOM_TTS_VOICES", "EARLY_MEDIA", "MULTI_PARTY_CONFERENCE", "HIGH_VOLUME_OUTBOUND", "ENHANCED_CONTACT_MONITORING", "ENHANCED_CHAT_MONITORING", "MULTI_PARTY_CHAT_CONFERENCE" ] }, "InstanceAttributeValue":{ "type":"string", "max":100, "min":1 }, "InstanceId":{ "type":"string", "max":100, "min":1 }, "InstanceIdOrArn":{ "type":"string", "max":250, "min":1, "pattern":"^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" }, "InstanceReplicationStatus":{ "type":"string", "enum":[ "INSTANCE_REPLICATION_COMPLETE", "INSTANCE_REPLICATION_IN_PROGRESS", "INSTANCE_REPLICATION_FAILED", "INSTANCE_REPLICA_DELETING", "INSTANCE_REPLICATION_DELETION_FAILED", "RESOURCE_REPLICATION_NOT_STARTED" ] }, "InstanceStatus":{ "type":"string", "enum":[ "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED" ] }, "InstanceStatusReason":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"<p>The message.</p>" } }, "documentation":"<p>Relevant details why the instance was not successfully created.</p>" }, "InstanceStorageConfig":{ "type":"structure", "required":["StorageType"], "members":{ "AssociationId":{ "shape":"AssociationId", "documentation":"<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>" }, "StorageType":{ "shape":"StorageType", "documentation":"<p>A valid storage type.</p>" }, "S3Config":{ "shape":"S3Config", "documentation":"<p>The S3 bucket configuration.</p>" }, "KinesisVideoStreamConfig":{ "shape":"KinesisVideoStreamConfig", "documentation":"<p>The configuration of the Kinesis video stream.</p>" }, "KinesisStreamConfig":{ "shape":"KinesisStreamConfig", "documentation":"<p>The configuration of the Kinesis data stream.</p>" }, "KinesisFirehoseConfig":{ "shape":"KinesisFirehoseConfig", "documentation":"<p>The configuration of the Kinesis Firehose delivery stream.</p>" } }, "documentation":"<p>The storage configuration for the instance.</p>" }, "InstanceStorageConfigs":{ "type":"list", "member":{"shape":"InstanceStorageConfig"} }, "InstanceStorageResourceType":{ "type":"string", "enum":[ "CHAT_TRANSCRIPTS", "CALL_RECORDINGS", "SCHEDULED_REPORTS", "MEDIA_STREAMS", "CONTACT_TRACE_RECORDS", "AGENT_EVENTS", "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS", "ATTACHMENTS", "CONTACT_EVALUATIONS", "SCREEN_RECORDINGS", "REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS", "REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS", "EMAIL_MESSAGES" ] }, "InstanceSummary":{ "type":"structure", "members":{ "Id":{ "shape":"InstanceId", "documentation":"<p>The identifier of the instance.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the instance.</p>" }, "IdentityManagementType":{ "shape":"DirectoryType", "documentation":"<p>The identity management type of the instance.</p>" }, "InstanceAlias":{ "shape":"DirectoryAlias", "documentation":"<p>The alias of the instance.</p>" }, "CreatedTime":{ "shape":"Timestamp", "documentation":"<p>When the instance was created.</p>" }, "ServiceRole":{ "shape":"ARN", "documentation":"<p>The service role of the instance.</p>" }, "InstanceStatus":{ "shape":"InstanceStatus", "documentation":"<p>The state of the instance.</p>" }, "InboundCallsEnabled":{ "shape":"InboundCallsEnabled", "documentation":"<p>Whether inbound calls are enabled.</p>" }, "OutboundCallsEnabled":{ "shape":"OutboundCallsEnabled", "documentation":"<p>Whether outbound calls are enabled.</p>" }, "InstanceAccessUrl":{ "shape":"Url", "documentation":"<p>This URL allows contact center users to access the Amazon Connect admin website.</p>" } }, "documentation":"<p>Information about the instance.</p>" }, "InstanceSummaryList":{ "type":"list", "member":{"shape":"InstanceSummary"} }, "Integer":{"type":"integer"}, "IntegerCount":{ "type":"integer", "min":0 }, "IntegrationAssociationId":{ "type":"string", "max":200, "min":1 }, "IntegrationAssociationSummary":{ "type":"structure", "members":{ "IntegrationAssociationId":{ "shape":"IntegrationAssociationId", "documentation":"<p>The identifier for the AppIntegration association.</p>" }, "IntegrationAssociationArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the AppIntegration association.</p>" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "IntegrationType":{ "shape":"IntegrationType", "documentation":"<p>The integration type.</p>" }, "IntegrationArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the AppIntegration.</p>" }, "SourceApplicationUrl":{ "shape":"URI", "documentation":"<p>The URL for the external application.</p>" }, "SourceApplicationName":{ "shape":"SourceApplicationName", "documentation":"<p>The user-provided, friendly name for the external application.</p>" }, "SourceType":{ "shape":"SourceType", "documentation":"<p>The name of the source.</p>" } }, "documentation":"<p>Contains summary information about the associated AppIntegrations.</p>" }, "IntegrationAssociationSummaryList":{ "type":"list", "member":{"shape":"IntegrationAssociationSummary"} }, "IntegrationType":{ "type":"string", "enum":[ "EVENT", "VOICE_ID", "PINPOINT_APP", "WISDOM_ASSISTANT", "WISDOM_KNOWLEDGE_BASE", "WISDOM_QUICK_RESPONSES", "Q_MESSAGE_TEMPLATES", "CASES_DOMAIN", "APPLICATION", "FILE_SCANNER", "SES_IDENTITY", "ANALYTICS_CONNECTOR", "CALL_TRANSFER_CONNECTOR", "COGNITO_USER_POOL" ] }, "InternalServiceException":{ "type":"structure", "members":{ "Message":{ "shape":"Message", "documentation":"<p>The message.</p>" } }, "documentation":"<p>Request processing failed because of an error or failure with the service.</p>", "error":{"httpStatusCode":500}, "exception":true }, "IntervalDetails":{ "type":"structure", "members":{ "TimeZone":{ "shape":"String", "documentation":"<p>The timezone applied to requested metrics.</p>" }, "IntervalPeriod":{ "shape":"IntervalPeriod", "documentation":"<p> <code>IntervalPeriod</code>: An aggregated grouping applied to request metrics. Valid <code>IntervalPeriod</code> values are: <code>FIFTEEN_MIN</code> | <code>THIRTY_MIN</code> | <code>HOUR</code> | <code>DAY</code> | <code>WEEK</code> | <code>TOTAL</code>. </p> <p>For example, if <code>IntervalPeriod</code> is selected <code>THIRTY_MIN</code>, <code>StartTime</code> and <code>EndTime</code> differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on the <code>TOTAL</code> interval period. </p> <p>The following list describes restrictions on <code>StartTime</code> and <code>EndTime</code> based on what <code>IntervalPeriod</code> is requested. </p> <ul> <li> <p> <code>FIFTEEN_MIN</code>: The difference between <code>StartTime</code> and <code>EndTime</code> must be less than 3 days.</p> </li> <li> <p> <code>THIRTY_MIN</code>: The difference between <code>StartTime</code> and <code>EndTime</code> must be less than 3 days.</p> </li> <li> <p> <code>HOUR</code>: The difference between <code>StartTime</code> and <code>EndTime</code> must be less than 3 days.</p> </li> <li> <p> <code>DAY</code>: The difference between <code>StartTime</code> and <code>EndTime</code> must be less than 35 days.</p> </li> <li> <p> <code>WEEK</code>: The difference between <code>StartTime</code> and <code>EndTime</code> must be less than 35 days.</p> </li> <li> <p> <code>TOTAL</code>: The difference between <code>StartTime</code> and <code>EndTime</code> must be less than 35 days.</p> </li> </ul>" } }, "documentation":"<p>Information about the interval period to use for returning results.</p>" }, "IntervalPeriod":{ "type":"string", "enum":[ "FIFTEEN_MIN", "THIRTY_MIN", "HOUR", "DAY", "WEEK", "TOTAL" ] }, "InvalidContactFlowException":{ "type":"structure", "members":{ "problems":{ "shape":"Problems", "documentation":"<p>The problems with the flow. Please fix before trying again.</p>" } }, "documentation":"<p>The flow is not valid.</p>", "error":{"httpStatusCode":400}, "exception":true }, "InvalidContactFlowModuleException":{ "type":"structure", "members":{ "Problems":{"shape":"Problems"} }, "documentation":"<p>The problems with the module. Please fix before trying again.</p>", "error":{"httpStatusCode":400}, "exception":true }, "InvalidParameterException":{ "type":"structure", "members":{ "Message":{ "shape":"Message", "documentation":"<p>The message about the parameters.</p>" } }, "documentation":"<p>One or more of the specified parameters are not valid.</p>", "error":{"httpStatusCode":400}, "exception":true }, "InvalidRequestException":{ "type":"structure", "members":{ "Message":{ "shape":"Message", "documentation":"<p>The message about the request.</p>" }, "Reason":{"shape":"InvalidRequestExceptionReason"} }, "documentation":"<p>The request is not valid.</p>", "error":{"httpStatusCode":400}, "exception":true }, "InvalidRequestExceptionReason":{ "type":"structure", "members":{ "AttachedFileInvalidRequestExceptionReason":{ "shape":"AttachedFileInvalidRequestExceptionReason", "documentation":"<p>Reason why the StartAttachedFiledUpload request was invalid.</p>" } }, "documentation":"<p>Reason why the request was invalid.</p>", "union":true }, "InvisibleFieldInfo":{ "type":"structure", "members":{ "Id":{ "shape":"TaskTemplateFieldIdentifier", "documentation":"<p>Identifier of the invisible field.</p>" } }, "documentation":"<p>A field that is invisible to an agent.</p>" }, "InvisibleTaskTemplateFields":{ "type":"list", "member":{"shape":"InvisibleFieldInfo"} }, "IpCidr":{ "type":"string", "max":50, "min":2, "pattern":"^[A-Za-z0-9:/]*$" }, "IpCidrList":{ "type":"list", "member":{"shape":"IpCidr"} }, "IvrRecordingTrack":{ "type":"string", "enum":["ALL"] }, "JoinToken":{ "type":"string", "sensitive":true }, "KeyId":{ "type":"string", "max":128, "min":1 }, "KinesisFirehoseConfig":{ "type":"structure", "required":["FirehoseArn"], "members":{ "FirehoseArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the delivery stream.</p>" } }, "documentation":"<p>Configuration information of a Kinesis Data Firehose delivery stream.</p>" }, "KinesisStreamConfig":{ "type":"structure", "required":["StreamArn"], "members":{ "StreamArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the data stream.</p>" } }, "documentation":"<p>Configuration information of a Kinesis data stream.</p>" }, "KinesisVideoStreamConfig":{ "type":"structure", "required":[ "Prefix", "RetentionPeriodHours", "EncryptionConfig" ], "members":{ "Prefix":{ "shape":"Prefix", "documentation":"<p>The prefix of the video stream.</p>" }, "RetentionPeriodHours":{ "shape":"Hours", "documentation":"<p>The number of hours data is retained in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.</p> <p>The default value is 0, indicating that the stream does not persist data.</p>" }, "EncryptionConfig":{ "shape":"EncryptionConfig", "documentation":"<p>The encryption configuration.</p>" } }, "documentation":"<p>Configuration information of a Kinesis video stream.</p>" }, "LargeNextToken":{ "type":"string", "max":100000, "min":1 }, "LexBot":{ "type":"structure", "required":[ "Name", "LexRegion" ], "members":{ "Name":{ "shape":"BotName", "documentation":"<p>The name of the Amazon Lex bot.</p>" }, "LexRegion":{ "shape":"LexRegion", "documentation":"<p>The Amazon Web Services Region where the Amazon Lex bot was created.</p>" } }, "documentation":"<p>Configuration information of an Amazon Lex bot.</p>" }, "LexBotConfig":{ "type":"structure", "members":{ "LexBot":{"shape":"LexBot"}, "LexV2Bot":{ "shape":"LexV2Bot", "documentation":"<p>Configuration information of an Amazon Lex V2 bot.</p>" } }, "documentation":"<p>Configuration information of an Amazon Lex or Amazon Lex V2 bot.</p>" }, "LexBotConfigList":{ "type":"list", "member":{"shape":"LexBotConfig"} }, "LexBotsList":{ "type":"list", "member":{"shape":"LexBot"} }, "LexRegion":{ "type":"string", "max":60 }, "LexV2Bot":{ "type":"structure", "members":{ "AliasArn":{ "shape":"AliasArn", "documentation":"<p>The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.</p>" } }, "documentation":"<p>Configuration information of an Amazon Lex V2 bot.</p>" }, "LexVersion":{ "type":"string", "enum":[ "V1", "V2" ] }, "LimitExceededException":{ "type":"structure", "members":{ "Message":{ "shape":"Message", "documentation":"<p>The message about the limit.</p>" } }, "documentation":"<p>The allowed limit for the resource has been exceeded.</p>", "error":{"httpStatusCode":429}, "exception":true }, "ListAgentStatusRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult1000", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true, "location":"querystring", "locationName":"maxResults" }, "AgentStatusTypes":{ "shape":"AgentStatusTypes", "documentation":"<p>Available agent status types.</p>", "location":"querystring", "locationName":"AgentStatusTypes" } } }, "ListAgentStatusResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" }, "AgentStatusSummaryList":{ "shape":"AgentStatusSummaryList", "documentation":"<p>A summary of agent statuses.</p>" } } }, "ListAnalyticsDataAssociationsRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "DataSetId":{ "shape":"DataSetId", "documentation":"<p>The identifier of the dataset to get the association status.</p>", "location":"querystring", "locationName":"DataSetId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult1000", "documentation":"<p>The maximum number of results to return per page.</p>", "location":"querystring", "locationName":"maxResults" } } }, "ListAnalyticsDataAssociationsResponse":{ "type":"structure", "members":{ "Results":{ "shape":"AnalyticsDataAssociationResults", "documentation":"<p>An array of successful results: <code>DataSetId</code>, <code>TargetAccountId</code>, <code>ResourceShareId</code>, <code>ResourceShareArn</code>. This is a paginated API, so <code>nextToken</code> is given if there are more results to be returned.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListAnalyticsDataLakeDataSetsRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult1000", "documentation":"<p>The maximum number of results to return per page.</p>", "location":"querystring", "locationName":"maxResults" } } }, "ListAnalyticsDataLakeDataSetsResponse":{ "type":"structure", "members":{ "Results":{ "shape":"AnalyticsDataSetsResults", "documentation":"<p>An array of successful results: <code>DataSetId</code>, <code>DataSetName</code>. This is a paginated API, so <code>nextToken</code> is given if there are more results to be returned.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListApprovedOriginsRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult25", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true, "location":"querystring", "locationName":"maxResults" } } }, "ListApprovedOriginsResponse":{ "type":"structure", "members":{ "Origins":{ "shape":"OriginsList", "documentation":"<p>The approved origins.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListAssociatedContactsRequest":{ "type":"structure", "required":[ "InstanceId", "ContactId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact in this instance of Amazon Connect. </p>", "location":"querystring", "locationName":"contactId" }, "MaxResults":{ "shape":"ListAssociatedContactsRequestMaxResults", "documentation":"<p>The maximum number of results to return per page.</p> <p>The maximum number of results to return per page. The default MaxResult size is 25.</p> <p>Valid Range: Minimum value of 1. Maximum value of 100.</p>", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" } } }, "ListAssociatedContactsRequestMaxResults":{ "type":"integer", "max":100, "min":1 }, "ListAssociatedContactsResponse":{ "type":"structure", "members":{ "ContactSummaryList":{ "shape":"AssociatedContactSummaryList", "documentation":"<p>List of the contact summary for all the contacts in contact tree associated with unique identifier.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListAuthenticationProfilesRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "MaxResults":{ "shape":"MaxResult1000", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true, "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" } } }, "ListAuthenticationProfilesResponse":{ "type":"structure", "members":{ "AuthenticationProfileSummaryList":{ "shape":"AuthenticationProfileSummaryList", "documentation":"<p>A summary of a given authentication profile.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListBotsRequest":{ "type":"structure", "required":[ "InstanceId", "LexVersion" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult25", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true, "location":"querystring", "locationName":"maxResults" }, "LexVersion":{ "shape":"LexVersion", "documentation":"<p>The version of Amazon Lex or Amazon Lex V2.</p>", "location":"querystring", "locationName":"lexVersion" } } }, "ListBotsResponse":{ "type":"structure", "members":{ "LexBots":{ "shape":"LexBotConfigList", "documentation":"<p>The names and Amazon Web Services Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified instance.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListCondition":{ "type":"structure", "members":{ "TargetListType":{ "shape":"TargetListType", "documentation":"<p>The type of target list that will be used to filter the users.</p>" }, "Conditions":{ "shape":"Conditions", "documentation":"<p>A list of Condition objects which would be applied together with an AND condition.</p>" } }, "documentation":"<p>A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.</p>" }, "ListContactEvaluationsRequest":{ "type":"structure", "required":[ "InstanceId", "ContactId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact in this instance of Amazon Connect. </p>", "location":"querystring", "locationName":"contactId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p> <important> <p>This is not expected to be set because the value returned in the previous response is always null.</p> </important>", "location":"querystring", "locationName":"nextToken" } } }, "ListContactEvaluationsResponse":{ "type":"structure", "required":["EvaluationSummaryList"], "members":{ "EvaluationSummaryList":{ "shape":"EvaluationSummaryList", "documentation":"<p>Provides details about a list of contact evaluations belonging to an instance.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p> <important> <p>This is always returned as null in the response.</p> </important>" } } }, "ListContactFlowModulesRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult1000", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true, "location":"querystring", "locationName":"maxResults" }, "ContactFlowModuleState":{ "shape":"ContactFlowModuleState", "documentation":"<p>The state of the flow module.</p>", "location":"querystring", "locationName":"state" } } }, "ListContactFlowModulesResponse":{ "type":"structure", "members":{ "ContactFlowModulesSummaryList":{ "shape":"ContactFlowModulesSummaryList", "documentation":"<p>Information about the flow module.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListContactFlowVersionsRequest":{ "type":"structure", "required":[ "InstanceId", "ContactFlowId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ContactFlowId":{ "shape":"ARN", "documentation":"<p>The identifier of the flow.</p>", "location":"uri", "locationName":"ContactFlowId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult1000", "documentation":"<p>The maximum number of results to return per page. The default MaxResult size is 100.</p>", "box":true, "location":"querystring", "locationName":"maxResults" } } }, "ListContactFlowVersionsResponse":{ "type":"structure", "members":{ "ContactFlowVersionSummaryList":{ "shape":"ContactFlowVersionSummaryList", "documentation":"<p>A list of flow version summaries.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListContactFlowsRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ContactFlowTypes":{ "shape":"ContactFlowTypes", "documentation":"<p>The type of flow.</p>", "location":"querystring", "locationName":"contactFlowTypes" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult1000", "documentation":"<p>The maximum number of results to return per page. The default MaxResult size is 100.</p>", "location":"querystring", "locationName":"maxResults" } } }, "ListContactFlowsResponse":{ "type":"structure", "members":{ "ContactFlowSummaryList":{ "shape":"ContactFlowSummaryList", "documentation":"<p>Information about the flows.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListContactReferencesRequest":{ "type":"structure", "required":[ "InstanceId", "ContactId", "ReferenceTypes" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the initial contact.</p>", "location":"uri", "locationName":"ContactId" }, "ReferenceTypes":{ "shape":"ReferenceTypes", "documentation":"<p>The type of reference.</p>", "location":"querystring", "locationName":"referenceTypes" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p> <important> <p>This is not expected to be set, because the value returned in the previous response is always null.</p> </important>", "location":"querystring", "locationName":"nextToken" } } }, "ListContactReferencesResponse":{ "type":"structure", "members":{ "ReferenceSummaryList":{ "shape":"ReferenceSummaryList", "documentation":"<p>Information about the flows.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p> <important> <p>This is always returned as null in the response.</p> </important>" } } }, "ListDefaultVocabulariesRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "LanguageCode":{ "shape":"VocabularyLanguageCode", "documentation":"<p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html\">What is Amazon Transcribe?</a> </p>" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page.</p>" }, "NextToken":{ "shape":"VocabularyNextToken", "documentation":"<p>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.</p>" } } }, "ListDefaultVocabulariesResponse":{ "type":"structure", "required":["DefaultVocabularyList"], "members":{ "DefaultVocabularyList":{ "shape":"DefaultVocabularyList", "documentation":"<p>A list of default vocabularies.</p>" }, "NextToken":{ "shape":"VocabularyNextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListEvaluationFormVersionsRequest":{ "type":"structure", "required":[ "InstanceId", "EvaluationFormId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "EvaluationFormId":{ "shape":"ResourceId", "documentation":"<p>The unique identifier for the evaluation form.</p>", "location":"uri", "locationName":"EvaluationFormId" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true, "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" } } }, "ListEvaluationFormVersionsResponse":{ "type":"structure", "required":["EvaluationFormVersionSummaryList"], "members":{ "EvaluationFormVersionSummaryList":{ "shape":"EvaluationFormVersionSummaryList", "documentation":"<p>Provides details about a list of evaluation forms belonging to an instance.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListEvaluationFormsRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true, "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" } } }, "ListEvaluationFormsResponse":{ "type":"structure", "required":["EvaluationFormSummaryList"], "members":{ "EvaluationFormSummaryList":{ "shape":"EvaluationFormSummaryList", "documentation":"<p>Provides details about a list of evaluation forms belonging to an instance.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListFlowAssociationResourceType":{ "type":"string", "enum":[ "WHATSAPP_MESSAGING_PHONE_NUMBER", "VOICE_PHONE_NUMBER", "INBOUND_EMAIL", "OUTBOUND_EMAIL", "ANALYTICS_CONNECTOR" ] }, "ListFlowAssociationsRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ResourceType":{ "shape":"ListFlowAssociationResourceType", "documentation":"<p>A valid resource type.</p>", "location":"querystring", "locationName":"ResourceType" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult1000", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true, "location":"querystring", "locationName":"maxResults" } } }, "ListFlowAssociationsResponse":{ "type":"structure", "members":{ "FlowAssociationSummaryList":{ "shape":"FlowAssociationSummaryList", "documentation":"<p>Summary of flow associations.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListHoursOfOperationOverridesRequest":{ "type":"structure", "required":[ "InstanceId", "HoursOfOperationId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance.</p>", "location":"uri", "locationName":"InstanceId" }, "HoursOfOperationId":{ "shape":"HoursOfOperationId", "documentation":"<p>The identifier for the hours of operation</p>", "location":"uri", "locationName":"HoursOfOperationId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page. The default MaxResult size is 100. Valid Range: Minimum value of 1. Maximum value of 1000.</p>", "box":true, "location":"querystring", "locationName":"maxResults" } } }, "ListHoursOfOperationOverridesResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>" }, "HoursOfOperationOverrideList":{ "shape":"HoursOfOperationOverrideList", "documentation":"<p>Information about the hours of operation override.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The AWS Region where this resource was last modified.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when this resource was last modified.</p>" } } }, "ListHoursOfOperationsRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult1000", "documentation":"<p>The maximum number of results to return per page. The default MaxResult size is 100.</p>", "location":"querystring", "locationName":"maxResults" } } }, "ListHoursOfOperationsResponse":{ "type":"structure", "members":{ "HoursOfOperationSummaryList":{ "shape":"HoursOfOperationSummaryList", "documentation":"<p>Information about the hours of operation.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListInstanceAttributesRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult7", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true, "location":"querystring", "locationName":"maxResults" } } }, "ListInstanceAttributesResponse":{ "type":"structure", "members":{ "Attributes":{ "shape":"AttributesList", "documentation":"<p>The attribute types.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListInstanceStorageConfigsRequest":{ "type":"structure", "required":[ "InstanceId", "ResourceType" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ResourceType":{ "shape":"InstanceStorageResourceType", "documentation":"<p>A valid resource type.</p>", "location":"querystring", "locationName":"resourceType" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult10", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true, "location":"querystring", "locationName":"maxResults" } } }, "ListInstanceStorageConfigsResponse":{ "type":"structure", "members":{ "StorageConfigs":{ "shape":"InstanceStorageConfigs", "documentation":"<p>A valid storage type.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListInstancesRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult10", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true, "location":"querystring", "locationName":"maxResults" } } }, "ListInstancesResponse":{ "type":"structure", "members":{ "InstanceSummaryList":{ "shape":"InstanceSummaryList", "documentation":"<p>Information about the instances.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListIntegrationAssociationsRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "IntegrationType":{ "shape":"IntegrationType", "documentation":"<p>The integration type.</p>", "location":"querystring", "locationName":"integrationType" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true, "location":"querystring", "locationName":"maxResults" }, "IntegrationArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the integration.</p>", "location":"querystring", "locationName":"integrationArn" } } }, "ListIntegrationAssociationsResponse":{ "type":"structure", "members":{ "IntegrationAssociationSummaryList":{ "shape":"IntegrationAssociationSummaryList", "documentation":"<p>The associations.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListLambdaFunctionsRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult25", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true, "location":"querystring", "locationName":"maxResults" } } }, "ListLambdaFunctionsResponse":{ "type":"structure", "members":{ "LambdaFunctions":{ "shape":"FunctionArnsList", "documentation":"<p>The Lambdafunction ARNs associated with the specified instance.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListLexBotsRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult25", "documentation":"<p>The maximum number of results to return per page. If no value is specified, the default is 10. </p>", "box":true, "location":"querystring", "locationName":"maxResults" } } }, "ListLexBotsResponse":{ "type":"structure", "members":{ "LexBots":{ "shape":"LexBotsList", "documentation":"<p>The names and Amazon Web Services Regions of the Amazon Lex bots associated with the specified instance.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListPhoneNumbersRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "PhoneNumberTypes":{ "shape":"PhoneNumberTypes", "documentation":"<p>The type of phone number.</p> <note> <p>We recommend using <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html\">ListPhoneNumbersV2</a> to return phone number types. While ListPhoneNumbers returns number types <code>UIFN</code>, <code>SHARED</code>, <code>THIRD_PARTY_TF</code>, and <code>THIRD_PARTY_DID</code>, it incorrectly lists them as <code>TOLL_FREE</code> or <code>DID</code>. </p> </note>", "location":"querystring", "locationName":"phoneNumberTypes" }, "PhoneNumberCountryCodes":{ "shape":"PhoneNumberCountryCodes", "documentation":"<p>The ISO country code.</p>", "location":"querystring", "locationName":"phoneNumberCountryCodes" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult1000", "documentation":"<p>The maximum number of results to return per page. The default MaxResult size is 100.</p>", "location":"querystring", "locationName":"maxResults" } } }, "ListPhoneNumbersResponse":{ "type":"structure", "members":{ "PhoneNumberSummaryList":{ "shape":"PhoneNumberSummaryList", "documentation":"<p>Information about the phone numbers.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListPhoneNumbersSummary":{ "type":"structure", "members":{ "PhoneNumberId":{ "shape":"PhoneNumberId", "documentation":"<p>A unique identifier for the phone number.</p>" }, "PhoneNumberArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the phone number.</p>" }, "PhoneNumber":{ "shape":"PhoneNumber", "documentation":"<p>The phone number. Phone numbers are formatted <code>[+] [country code] [subscriber number including area code]</code>.</p>" }, "PhoneNumberCountryCode":{ "shape":"PhoneNumberCountryCode", "documentation":"<p>The ISO country code.</p>" }, "PhoneNumberType":{ "shape":"PhoneNumberType", "documentation":"<p>The type of phone number.</p>" }, "TargetArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.</p>" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance that phone numbers are claimed to. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "PhoneNumberDescription":{ "shape":"PhoneNumberDescription", "documentation":"<p>The description of the phone number.</p>" }, "SourcePhoneNumberArn":{ "shape":"ARN", "documentation":"<p>The claimed phone number ARN that was previously imported from the external service, such as Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it looks like the ARN of the phone number that was imported from Amazon Web Services End User Messaging.</p>" } }, "documentation":"<p>Information about phone numbers that have been claimed to your Amazon Connect instance or traffic distribution group.</p>" }, "ListPhoneNumbersSummaryList":{ "type":"list", "member":{"shape":"ListPhoneNumbersSummary"} }, "ListPhoneNumbersV2Request":{ "type":"structure", "members":{ "TargetArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. If both <code>TargetArn</code> and <code>InstanceId</code> input are not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same Amazon Web Services Region as the request.</p>" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance that phone numbers are claimed to. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance. If both <code>TargetArn</code> and <code>InstanceId</code> are not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same AWS Region as the request.</p>" }, "MaxResults":{ "shape":"MaxResult1000", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true }, "NextToken":{ "shape":"LargeNextToken", "documentation":"<p>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.</p>" }, "PhoneNumberCountryCodes":{ "shape":"PhoneNumberCountryCodes", "documentation":"<p>The ISO country code.</p>" }, "PhoneNumberTypes":{ "shape":"PhoneNumberTypes", "documentation":"<p>The type of phone number.</p>" }, "PhoneNumberPrefix":{ "shape":"PhoneNumberPrefix", "documentation":"<p>The prefix of the phone number. If provided, it must contain <code>+</code> as part of the country code.</p>" } } }, "ListPhoneNumbersV2Response":{ "type":"structure", "members":{ "NextToken":{ "shape":"LargeNextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" }, "ListPhoneNumbersSummaryList":{ "shape":"ListPhoneNumbersSummaryList", "documentation":"<p>Information about phone numbers that have been claimed to your Amazon Connect instances or traffic distribution groups.</p>" } } }, "ListPredefinedAttributesRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page. </p>", "box":true, "location":"querystring", "locationName":"maxResults" } } }, "ListPredefinedAttributesResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" }, "PredefinedAttributeSummaryList":{ "shape":"PredefinedAttributeSummaryList", "documentation":"<p>Summary of the predefined attributes.</p>" } } }, "ListPromptsRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance.</p>", "location":"uri", "locationName":"InstanceId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult1000", "documentation":"<p>The maximum number of results to return per page. The default MaxResult size is 100.</p>", "box":true, "location":"querystring", "locationName":"maxResults" } } }, "ListPromptsResponse":{ "type":"structure", "members":{ "PromptSummaryList":{ "shape":"PromptSummaryList", "documentation":"<p>Information about the prompts.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListQueueQuickConnectsRequest":{ "type":"structure", "required":[ "InstanceId", "QueueId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "QueueId":{ "shape":"QueueId", "documentation":"<p>The identifier for the queue.</p>", "location":"uri", "locationName":"QueueId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page. The default MaxResult size is 100.</p>", "box":true, "location":"querystring", "locationName":"maxResults" } } }, "ListQueueQuickConnectsResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" }, "QuickConnectSummaryList":{ "shape":"QuickConnectSummaryList", "documentation":"<p>Information about the quick connects.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when this resource was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The Amazon Web Services Region where this resource was last modified.</p>" } } }, "ListQueuesRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "QueueTypes":{ "shape":"QueueTypes", "documentation":"<p>The type of queue.</p>", "location":"querystring", "locationName":"queueTypes" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult1000", "documentation":"<p>The maximum number of results to return per page. The default MaxResult size is 100.</p>", "location":"querystring", "locationName":"maxResults" } } }, "ListQueuesResponse":{ "type":"structure", "members":{ "QueueSummaryList":{ "shape":"QueueSummaryList", "documentation":"<p>Information about the queues.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListQuickConnectsRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult1000", "documentation":"<p>The maximum number of results to return per page. The default MaxResult size is 100.</p>", "box":true, "location":"querystring", "locationName":"maxResults" }, "QuickConnectTypes":{ "shape":"QuickConnectTypes", "documentation":"<p>The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).</p>", "location":"querystring", "locationName":"QuickConnectTypes" } } }, "ListQuickConnectsResponse":{ "type":"structure", "members":{ "QuickConnectSummaryList":{ "shape":"QuickConnectSummaryList", "documentation":"<p>Information about the quick connects.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListRealtimeContactAnalysisSegmentsV2Request":{ "type":"structure", "required":[ "InstanceId", "ContactId", "OutputType", "SegmentTypes" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact in this instance of Amazon Connect. </p>", "location":"uri", "locationName":"ContactId" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page.</p>" }, "NextToken":{ "shape":"LargeNextToken", "documentation":"<p>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.</p>" }, "OutputType":{ "shape":"RealTimeContactAnalysisOutputType", "documentation":"<p>The Contact Lens output type to be returned.</p>" }, "SegmentTypes":{ "shape":"RealTimeContactAnalysisSegmentTypes", "documentation":"<p>Enum with segment types . Each value corresponds to a segment type returned in the segments list of the API. Each segment type has its own structure. Different channels may have different sets of supported segment types.</p>" } } }, "ListRealtimeContactAnalysisSegmentsV2Response":{ "type":"structure", "required":[ "Channel", "Status", "Segments" ], "members":{ "Channel":{ "shape":"RealTimeContactAnalysisSupportedChannel", "documentation":"<p>The channel of the contact. </p> <important> <p>Only <code>CHAT</code> is supported. This API does not support <code>VOICE</code>. If you attempt to use it for the VOICE channel, an <code>InvalidRequestException</code> error occurs.</p> </important>" }, "Status":{ "shape":"RealTimeContactAnalysisStatus", "documentation":"<p>Status of real-time contact analysis.</p>" }, "Segments":{ "shape":"RealtimeContactAnalysisSegments", "documentation":"<p>An analyzed transcript or category.</p>" }, "NextToken":{ "shape":"LargeNextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListRoutingProfileQueuesRequest":{ "type":"structure", "required":[ "InstanceId", "RoutingProfileId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "RoutingProfileId":{ "shape":"RoutingProfileId", "documentation":"<p>The identifier of the routing profile.</p>", "location":"uri", "locationName":"RoutingProfileId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page. The default MaxResult size is 100.</p>", "box":true, "location":"querystring", "locationName":"maxResults" } } }, "ListRoutingProfileQueuesResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" }, "RoutingProfileQueueConfigSummaryList":{ "shape":"RoutingProfileQueueConfigSummaryList", "documentation":"<p>Information about the routing profiles.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when this resource was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The Amazon Web Services Region where this resource was last modified.</p>" } } }, "ListRoutingProfilesRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult1000", "documentation":"<p>The maximum number of results to return per page. The default MaxResult size is 100.</p>", "box":true, "location":"querystring", "locationName":"maxResults" } } }, "ListRoutingProfilesResponse":{ "type":"structure", "members":{ "RoutingProfileSummaryList":{ "shape":"RoutingProfileSummaryList", "documentation":"<p>Information about the routing profiles.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListRulesRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "PublishStatus":{ "shape":"RulePublishStatus", "documentation":"<p>The publish status of the rule.</p>", "location":"querystring", "locationName":"publishStatus" }, "EventSourceName":{ "shape":"EventSourceName", "documentation":"<p>The name of the event source.</p>", "location":"querystring", "locationName":"eventSourceName" }, "MaxResults":{ "shape":"MaxResult200", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true, "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" } } }, "ListRulesResponse":{ "type":"structure", "required":["RuleSummaryList"], "members":{ "RuleSummaryList":{ "shape":"RuleSummaryList", "documentation":"<p>Summary information about a rule.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListSecurityKeysRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult2", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true, "location":"querystring", "locationName":"maxResults" } } }, "ListSecurityKeysResponse":{ "type":"structure", "members":{ "SecurityKeys":{ "shape":"SecurityKeysList", "documentation":"<p>The security keys.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListSecurityProfileApplicationsRequest":{ "type":"structure", "required":[ "SecurityProfileId", "InstanceId" ], "members":{ "SecurityProfileId":{ "shape":"SecurityProfileId", "documentation":"<p>The identifier for the security profle.</p>", "location":"uri", "locationName":"SecurityProfileId" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult1000", "documentation":"<p>The maximum number of results to return per page.</p>", "location":"querystring", "locationName":"maxResults" } } }, "ListSecurityProfileApplicationsResponse":{ "type":"structure", "members":{ "Applications":{ "shape":"Applications", "documentation":"<p>A list of the third-party application's metadata.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when this resource was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The Amazon Web Services Region where this resource was last modified.</p>" } } }, "ListSecurityProfilePermissionsRequest":{ "type":"structure", "required":[ "SecurityProfileId", "InstanceId" ], "members":{ "SecurityProfileId":{ "shape":"SecurityProfileId", "documentation":"<p>The identifier for the security profle.</p>", "location":"uri", "locationName":"SecurityProfileId" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult1000", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true, "location":"querystring", "locationName":"maxResults" } } }, "ListSecurityProfilePermissionsResponse":{ "type":"structure", "members":{ "Permissions":{ "shape":"PermissionsList", "documentation":"<p>The permissions granted to the security profile. For a complete list of valid permissions, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html\">List of security profile permissions</a>.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when this resource was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The Amazon Web Services Region where this resource was last modified.</p>" } } }, "ListSecurityProfilesRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult1000", "documentation":"<p>The maximum number of results to return per page. The default MaxResult size is 100.</p>", "box":true, "location":"querystring", "locationName":"maxResults" } } }, "ListSecurityProfilesResponse":{ "type":"structure", "members":{ "SecurityProfileSummaryList":{ "shape":"SecurityProfileSummaryList", "documentation":"<p>Information about the security profiles.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the resource. All Amazon Connect resources (instances, queues, flows, routing profiles, etc) have an ARN. To locate the ARN for an instance, for example, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">Find your Amazon Connect instance ID/ARN</a>. </p>", "location":"uri", "locationName":"resourceArn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{ "shape":"TagMap", "documentation":"<p>Information about the tags.</p>" } } }, "ListTaskTemplatesRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p> <important> <p>It is not expected that you set this because the value returned in the previous response is always null.</p> </important>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page.</p> <important> <p>It is not expected that you set this.</p> </important>", "box":true, "location":"querystring", "locationName":"maxResults" }, "Status":{ "shape":"TaskTemplateStatus", "documentation":"<p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it. Tasks can only be created from <code>ACTIVE</code> templates. If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.</p>", "location":"querystring", "locationName":"status" }, "Name":{ "shape":"TaskTemplateName", "documentation":"<p>The name of the task template.</p>", "location":"querystring", "locationName":"name" } } }, "ListTaskTemplatesResponse":{ "type":"structure", "members":{ "TaskTemplates":{ "shape":"TaskTemplateList", "documentation":"<p>Provides details about a list of task templates belonging to an instance.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p> <important> <p>This is always returned as a null in the response.</p> </important>" } } }, "ListTrafficDistributionGroupUsersRequest":{ "type":"structure", "required":["TrafficDistributionGroupId"], "members":{ "TrafficDistributionGroupId":{ "shape":"TrafficDistributionGroupIdOrArn", "documentation":"<p>The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.</p>", "location":"uri", "locationName":"TrafficDistributionGroupId" }, "MaxResults":{ "shape":"MaxResult10", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true, "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" } } }, "ListTrafficDistributionGroupUsersResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" }, "TrafficDistributionGroupUserSummaryList":{ "shape":"TrafficDistributionGroupUserSummaryList", "documentation":"<p>A list of traffic distribution group users.</p>" } } }, "ListTrafficDistributionGroupsRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"MaxResult10", "documentation":"<p>The maximum number of results to return per page.</p>", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "InstanceId":{ "shape":"InstanceIdOrArn", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"querystring", "locationName":"instanceId" } } }, "ListTrafficDistributionGroupsResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" }, "TrafficDistributionGroupSummaryList":{ "shape":"TrafficDistributionGroupSummaryList", "documentation":"<p>A list of traffic distribution groups.</p>" } } }, "ListUseCasesRequest":{ "type":"structure", "required":[ "InstanceId", "IntegrationAssociationId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "IntegrationAssociationId":{ "shape":"IntegrationAssociationId", "documentation":"<p>The identifier for the integration association.</p>", "location":"uri", "locationName":"IntegrationAssociationId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true, "location":"querystring", "locationName":"maxResults" } }, "documentation":"<p>Provides summary information about the use cases for the specified integration association.</p>" }, "ListUseCasesResponse":{ "type":"structure", "members":{ "UseCaseSummaryList":{ "shape":"UseCaseSummaryList", "documentation":"<p>The use cases.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListUserHierarchyGroupsRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult1000", "documentation":"<p>The maximum number of results to return per page. The default MaxResult size is 100.</p>", "box":true, "location":"querystring", "locationName":"maxResults" } } }, "ListUserHierarchyGroupsResponse":{ "type":"structure", "members":{ "UserHierarchyGroupSummaryList":{ "shape":"HierarchyGroupSummaryList", "documentation":"<p>Information about the hierarchy groups.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListUserProficienciesRequest":{ "type":"structure", "required":[ "InstanceId", "UserId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "UserId":{ "shape":"UserId", "documentation":"<p>The identifier of the user account.</p>", "location":"uri", "locationName":"UserId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true, "location":"querystring", "locationName":"maxResults" } } }, "ListUserProficienciesResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" }, "UserProficiencyList":{ "shape":"UserProficiencyList", "documentation":"<p>Information about the user proficiencies.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The last time that the user's proficiencies are were modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The region in which a user's proficiencies were last modified.</p>" } } }, "ListUsersRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResult1000", "documentation":"<p>The maximum number of results to return per page. The default MaxResult size is 100.</p>", "box":true, "location":"querystring", "locationName":"maxResults" } } }, "ListUsersResponse":{ "type":"structure", "members":{ "UserSummaryList":{ "shape":"UserSummaryList", "documentation":"<p>Information about the users.</p>" }, "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "ListViewVersionsRequest":{ "type":"structure", "required":[ "InstanceId", "ViewId" ], "members":{ "InstanceId":{ "shape":"ViewsInstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ViewId":{ "shape":"ViewId", "documentation":"<p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be used.</p>", "location":"uri", "locationName":"ViewId" }, "NextToken":{ "shape":"ViewsNextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResults", "documentation":"<p>The maximum number of results to return per page. The default MaxResult size is 100.</p>", "box":true, "location":"querystring", "locationName":"maxResults" } } }, "ListViewVersionsResponse":{ "type":"structure", "members":{ "ViewVersionSummaryList":{ "shape":"ViewVersionSummaryList", "documentation":"<p>A list of view version summaries.</p>" }, "NextToken":{ "shape":"ViewsNextToken", "documentation":"<p>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.</p>" } } }, "ListViewsRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"ViewsInstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Type":{ "shape":"ViewType", "documentation":"<p>The type of the view.</p>", "location":"querystring", "locationName":"type" }, "NextToken":{ "shape":"ViewsNextToken", "documentation":"<p>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.</p>", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResults", "documentation":"<p>The maximum number of results to return per page. The default MaxResult size is 100.</p>", "box":true, "location":"querystring", "locationName":"maxResults" } } }, "ListViewsResponse":{ "type":"structure", "members":{ "ViewsSummaryList":{ "shape":"ViewsSummaryList", "documentation":"<p>A list of view summaries.</p>" }, "NextToken":{ "shape":"ViewsNextToken", "documentation":"<p>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.</p>" } } }, "Long":{"type":"long"}, "MatchCriteria":{ "type":"structure", "members":{ "AgentsCriteria":{ "shape":"AgentsCriteria", "documentation":"<p>An object to define agentIds.</p>" } }, "documentation":"<p>An object to define AgentsCriteria.</p>" }, "MaxResult10":{ "type":"integer", "max":10, "min":1 }, "MaxResult100":{ "type":"integer", "max":100, "min":1 }, "MaxResult1000":{ "type":"integer", "max":1000, "min":1 }, "MaxResult2":{ "type":"integer", "max":2, "min":1 }, "MaxResult200":{ "type":"integer", "max":200, "min":1 }, "MaxResult25":{ "type":"integer", "max":25, "min":1 }, "MaxResult500":{ "type":"integer", "box":true, "max":500, "min":1 }, "MaxResult7":{ "type":"integer", "max":7, "min":1 }, "MaxResults":{ "type":"integer", "max":100, "min":1 }, "MaximumResultReturnedException":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"<p>Maximum number (1000) of tags have been returned with current request. Consider changing request parameters to get more tags.</p>", "error":{"httpStatusCode":400}, "exception":true }, "MediaConcurrencies":{ "type":"list", "member":{"shape":"MediaConcurrency"} }, "MediaConcurrency":{ "type":"structure", "required":[ "Channel", "Concurrency" ], "members":{ "Channel":{ "shape":"Channel", "documentation":"<p>The channels that agents can handle in the Contact Control Panel (CCP).</p>" }, "Concurrency":{ "shape":"Concurrency", "documentation":"<p>The number of contacts an agent can have on a channel simultaneously.</p> <p>Valid Range for <code>VOICE</code>: Minimum value of 1. Maximum value of 1.</p> <p>Valid Range for <code>CHAT</code>: Minimum value of 1. Maximum value of 10.</p> <p>Valid Range for <code>TASK</code>: Minimum value of 1. Maximum value of 10.</p>" }, "CrossChannelBehavior":{ "shape":"CrossChannelBehavior", "documentation":"<p>Defines the cross-channel routing behavior for each channel that is enabled for this Routing Profile. For example, this allows you to offer an agent a different contact from another channel when they are currently working with a contact from a Voice channel.</p>" } }, "documentation":"<p>Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.</p>" }, "MediaPlacement":{ "type":"structure", "members":{ "AudioHostUrl":{ "shape":"URI", "documentation":"<p>The audio host URL.</p>" }, "AudioFallbackUrl":{ "shape":"URI", "documentation":"<p>The audio fallback URL.</p>" }, "SignalingUrl":{ "shape":"URI", "documentation":"<p>The signaling URL.</p>" }, "TurnControlUrl":{ "shape":"URI", "documentation":"<p>The turn control URL.</p>" }, "EventIngestionUrl":{ "shape":"URI", "documentation":"<p>The event ingestion URL to which you send client meeting events.</p>" } }, "documentation":"<p>A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.</p>" }, "MediaRegion":{"type":"string"}, "MediaStreamType":{ "type":"string", "enum":[ "AUDIO", "VIDEO" ] }, "Meeting":{ "type":"structure", "members":{ "MediaRegion":{ "shape":"MediaRegion", "documentation":"<p>The Amazon Web Services Region in which you create the meeting.</p>" }, "MediaPlacement":{ "shape":"MediaPlacement", "documentation":"<p>The media placement for the meeting.</p>" }, "MeetingFeatures":{ "shape":"MeetingFeaturesConfiguration", "documentation":"<p>The configuration settings of the features available to a meeting.</p>" }, "MeetingId":{ "shape":"MeetingId", "documentation":"<p>The Amazon Chime SDK meeting ID.</p>" } }, "documentation":"<p>A meeting created using the Amazon Chime SDK.</p>" }, "MeetingFeatureStatus":{ "type":"string", "enum":[ "AVAILABLE", "UNAVAILABLE" ] }, "MeetingFeaturesConfiguration":{ "type":"structure", "members":{ "Audio":{ "shape":"AudioFeatures", "documentation":"<p>The configuration settings for the audio features available to a meeting.</p>" } }, "documentation":"<p>The configuration settings of the features available to a meeting.</p>" }, "MeetingId":{"type":"string"}, "Message":{"type":"string"}, "MessageTemplateId":{ "type":"string", "max":500, "min":1 }, "MessageTemplateKnowledgeBaseId":{ "type":"string", "max":500, "min":1 }, "MetadataUrl":{ "type":"string", "max":2000, "min":1 }, "MetricDataCollectionsV2":{ "type":"list", "member":{"shape":"MetricDataV2"} }, "MetricDataV2":{ "type":"structure", "members":{ "Metric":{ "shape":"MetricV2", "documentation":"<p>The metric name, thresholds, and metric filters of the returned metric.</p>" }, "Value":{ "shape":"Value", "documentation":"<p>The corresponding value of the metric returned in the response.</p>", "box":true } }, "documentation":"<p>Contains the name, thresholds, and metric filters.</p>" }, "MetricFilterV2":{ "type":"structure", "members":{ "MetricFilterKey":{ "shape":"String", "documentation":"<p>The key to use for filtering data. </p> <p>Valid metric filter keys: </p> <ul> <li> <p>ANSWERING_MACHINE_DETECTION_STATUS</p> </li> <li> <p>CASE_STATUS</p> </li> <li> <p>DISCONNECT_REASON</p> </li> <li> <p>FLOWS_ACTION_IDENTIFIER</p> </li> <li> <p>FLOWS_NEXT_ACTION_IDENTIFIER</p> </li> <li> <p>FLOWS_OUTCOME_TYPE</p> </li> <li> <p>FLOWS_RESOURCE_TYPE</p> </li> <li> <p>INITIATION_METHOD</p> </li> </ul>" }, "MetricFilterValues":{ "shape":"MetricFilterValueList", "documentation":"<p>The values to use for filtering data. Values for metric-level filters can be either a fixed set of values or a customized list, depending on the use case.</p> <p>For valid values of metric-level filters <code>INITIATION_METHOD</code>, <code>DISCONNECT_REASON</code>, and <code>ANSWERING_MACHINE_DETECTION_STATUS</code>, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord\">ContactTraceRecord</a> in the <i>Amazon Connect Administrator Guide</i>. </p> <p>For valid values of the metric-level filter <code>FLOWS_OUTCOME_TYPE</code>, see the description for the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#flows-outcome\">Flow outcome</a> metric in the <i>Amazon Connect Administrator Guide</i>.</p> <p>For valid values of the metric-level filter <code>BOT_CONVERSATION_OUTCOME_TYPE</code>, see the description for the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-conversations-completed-metric\">Bot conversations completed</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <p>For valid values of the metric-level filter <code>BOT_INTENT_OUTCOME_TYPE</code>, see the description for the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-intents-completed-metric\">Bot intents completed</a> metric in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "Negate":{ "shape":"Boolean", "documentation":"<p>If set to <code>true</code>, the API response contains results that filter out the results matched by the metric-level filters condition. By default, <code>Negate</code> is set to <code>false</code>. </p>" } }, "documentation":"<p>Contains information about the filter used when retrieving metrics. <code>MetricFiltersV2</code> can be used on the following metrics: <code>AVG_AGENT_CONNECTING_TIME</code>, <code>CONTACTS_CREATED</code>, <code>CONTACTS_HANDLED</code>, <code>SUM_CONTACTS_DISCONNECTED</code>.</p>" }, "MetricFilterValueList":{ "type":"list", "member":{"shape":"String"}, "max":10, "min":1 }, "MetricFiltersV2List":{ "type":"list", "member":{"shape":"MetricFilterV2"}, "max":2 }, "MetricInterval":{ "type":"structure", "members":{ "Interval":{ "shape":"IntervalPeriod", "documentation":"<p>The interval period provided in the API request. </p>" }, "StartTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp, in UNIX Epoch time format. Start time is based on the interval period selected. </p>" }, "EndTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp, in UNIX Epoch time format. End time is based on the interval period selected. For example, If <code>IntervalPeriod</code> is selected <code>THIRTY_MIN</code>, <code>StartTime</code> and <code>EndTime</code> in the API request differs by 1 day, then 48 results are returned in the response. Each result is aggregated by the 30 minutes period, with each <code>StartTime</code> and <code>EndTime</code> differing by 30 minutes. </p>" } }, "documentation":"<p>The interval period with the start and end time for the metrics.</p>" }, "MetricNameV2":{"type":"string"}, "MetricResultV2":{ "type":"structure", "members":{ "Dimensions":{ "shape":"DimensionsV2Map", "documentation":"<p>The dimension for the metrics.</p>" }, "MetricInterval":{ "shape":"MetricInterval", "documentation":"<p>The interval period with the start and end time for the metrics.</p>" }, "Collections":{ "shape":"MetricDataCollectionsV2", "documentation":"<p>The set of metrics.</p>" } }, "documentation":"<p>Contains information about the metric results.</p>" }, "MetricResultsV2":{ "type":"list", "member":{"shape":"MetricResultV2"} }, "MetricV2":{ "type":"structure", "members":{ "Name":{ "shape":"MetricNameV2", "documentation":"<p>The name of the metric.</p> <important> <p>This parameter is required. The following Required = No is incorrect.</p> </important>" }, "Threshold":{ "shape":"ThresholdCollections", "documentation":"<p>Contains information about the threshold for service level metrics.</p>" }, "MetricFilters":{ "shape":"MetricFiltersV2List", "documentation":"<p>Contains the filters to be used when returning data.</p>" } }, "documentation":"<p>Contains information about the metric.</p>" }, "MetricsV2":{ "type":"list", "member":{"shape":"MetricV2"} }, "MinutesLimit60":{ "type":"integer", "max":59, "min":0 }, "MonitorCapability":{ "type":"string", "enum":[ "SILENT_MONITOR", "BARGE" ] }, "MonitorContactRequest":{ "type":"structure", "required":[ "InstanceId", "ContactId", "UserId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>" }, "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact.</p>" }, "UserId":{ "shape":"AgentResourceId", "documentation":"<p>The identifier of the user account.</p>" }, "AllowedMonitorCapabilities":{ "shape":"AllowedMonitorCapabilities", "documentation":"<p>Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge. AllowedMonitorCapabilities is required if barge is enabled.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true } } }, "MonitorContactResponse":{ "type":"structure", "members":{ "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact.</p>" }, "ContactArn":{ "shape":"ARN", "documentation":"<p>The ARN of the contact.</p>" } } }, "Name":{ "type":"string", "max":1024, "min":0, "sensitive":true }, "Name128":{ "type":"string", "max":128, "min":1, "pattern":"(^[\\S].*[\\S]$)|(^[\\S]$)" }, "Namespace":{ "type":"string", "max":128, "min":1 }, "NewChatCreated":{"type":"boolean"}, "NewSessionDetails":{ "type":"structure", "members":{ "SupportedMessagingContentTypes":{ "shape":"SupportedMessagingContentTypes", "documentation":"<p> The supported chat message content types. Supported types are <code>text/plain</code>, <code>text/markdown</code>, <code>application/json</code>, <code>application/vnd.amazonaws.connect.message.interactive</code>, and <code>application/vnd.amazonaws.connect.message.interactive.response</code>. </p> <p>Content types must always contain <code> text/plain</code>. You can then put any other supported type in the list. For example, all the following lists are valid because they contain <code>text/plain</code>: <code>[text/plain, text/markdown, application/json]</code>, <code> [text/markdown, text/plain]</code>, <code>[text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response]</code>. </p>" }, "ParticipantDetails":{"shape":"ParticipantDetails"}, "Attributes":{ "shape":"Attributes", "documentation":"<p> A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes. </p> <p> There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters. </p>" }, "StreamingConfiguration":{"shape":"ChatStreamingConfiguration"} }, "documentation":"<p>Payload of chat properties to apply when starting a new contact.</p>" }, "NextToken":{"type":"string"}, "NextToken2500":{ "type":"string", "max":2500, "min":1 }, "NotificationContentType":{ "type":"string", "enum":["PLAIN_TEXT"] }, "NotificationDeliveryType":{ "type":"string", "enum":["EMAIL"] }, "NotificationRecipientType":{ "type":"structure", "members":{ "UserTags":{ "shape":"UserTagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }. Amazon Connect users with the specified tags will be notified.</p>" }, "UserIds":{ "shape":"UserIdList", "documentation":"<p>A list of user IDs. Supports variable injection of <code>$.ContactLens.ContactEvaluation.Agent.AgentId</code> for <code>OnContactEvaluationSubmit</code> event source. </p>" } }, "documentation":"<p>The type of notification recipient.</p>" }, "NullableBoolean":{"type":"boolean"}, "NullableProficiencyLevel":{ "type":"float", "max":5.0, "min":1.0 }, "NullableProficiencyLimitValue":{"type":"integer"}, "NumberComparisonType":{ "type":"string", "enum":[ "GREATER_OR_EQUAL", "GREATER", "LESSER_OR_EQUAL", "LESSER", "EQUAL", "NOT_EQUAL", "RANGE" ] }, "NumberCondition":{ "type":"structure", "members":{ "FieldName":{ "shape":"String", "documentation":"<p>The name of the field in the number condition.</p>" }, "MinValue":{ "shape":"NullableProficiencyLimitValue", "documentation":"<p>The minValue to be used while evaluating the number condition.</p>" }, "MaxValue":{ "shape":"NullableProficiencyLimitValue", "documentation":"<p>The maxValue to be used while evaluating the number condition.</p>" }, "ComparisonType":{ "shape":"NumberComparisonType", "documentation":"<p>The type of comparison to be made when evaluating the number condition.</p>" } }, "documentation":"<p>A leaf node condition which can be used to specify a numeric condition.</p> <note> <p>The currently supported value for <code>FieldName</code> is <code>limit</code>.</p> </note>" }, "NumberReference":{ "type":"structure", "members":{ "Name":{ "shape":"ReferenceKey", "documentation":"<p>Identifier of the number reference.</p>" }, "Value":{ "shape":"ReferenceValue", "documentation":"<p>A valid number.</p>" } }, "documentation":"<p>Information about a reference when the <code>referenceType</code> is <code>NUMBER</code>. Otherwise, null.</p>" }, "NumericQuestionPropertyAutomationLabel":{ "type":"string", "enum":[ "OVERALL_CUSTOMER_SENTIMENT_SCORE", "OVERALL_AGENT_SENTIMENT_SCORE", "NON_TALK_TIME", "NON_TALK_TIME_PERCENTAGE", "NUMBER_OF_INTERRUPTIONS", "CONTACT_DURATION", "AGENT_INTERACTION_DURATION", "CUSTOMER_HOLD_TIME" ] }, "NumericQuestionPropertyValueAutomation":{ "type":"structure", "required":["Label"], "members":{ "Label":{ "shape":"NumericQuestionPropertyAutomationLabel", "documentation":"<p>The property label of the automation.</p>" } }, "documentation":"<p>Information about the property value used in automation of a numeric questions. Label values are associated with minimum and maximum values for the numeric question.</p> <ul> <li> <p>Sentiment scores have a minimum value of -5 and maximum value of 5.</p> </li> <li> <p> Duration labels, such as <code>NON_TALK_TIME</code>, <code>CONTACT_DURATION</code>, <code>AGENT_INTERACTION_DURATION</code>, <code>CUSTOMER_HOLD_TIME</code> have a minimum value of 0 and maximum value of 63072000.</p> </li> <li> <p>Percentages have a minimum value of 0 and maximum value of 100. </p> </li> <li> <p> <code>NUMBER_OF_INTERRUPTIONS</code> has a minimum value of 0 and maximum value of 1000.</p> </li> </ul>" }, "OperatingSystem":{ "type":"string", "max":128, "min":0 }, "OperationalHour":{ "type":"structure", "members":{ "Start":{ "shape":"OverrideTimeSlice", "documentation":"<p>The start time that your contact center opens.</p>" }, "End":{ "shape":"OverrideTimeSlice", "documentation":"<p>The end time that your contact center closes.</p>" } }, "documentation":"<p>Information about the hours of operations with the effective override applied.</p>" }, "OperationalHours":{ "type":"list", "member":{"shape":"OperationalHour"} }, "Origin":{ "type":"string", "max":267 }, "OriginsList":{ "type":"list", "member":{"shape":"Origin"} }, "OutboundAdditionalRecipients":{ "type":"structure", "members":{ "CcEmailAddresses":{ "shape":"EmailAddressRecipientList", "documentation":"<p>Information about the <b>additional</b> CC email address recipients. Email recipients are limited to 50 total addresses: 1 required recipient in the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_SendOutboundEmail.html#API_SendOutboundEmail_RequestBody\">DestinationEmailAddress</a> field and up to 49 recipients in the 'CcEmailAddresses' field.</p>" } }, "documentation":"<p>Information about the additional recipients of outbound email.</p>" }, "OutboundCallerConfig":{ "type":"structure", "members":{ "OutboundCallerIdName":{ "shape":"OutboundCallerIdName", "documentation":"<p>The caller ID name.</p>" }, "OutboundCallerIdNumberId":{ "shape":"PhoneNumberId", "documentation":"<p>The caller ID number.</p>" }, "OutboundFlowId":{ "shape":"ContactFlowId", "documentation":"<p>The outbound whisper flow to be used during an outbound call.</p>" } }, "documentation":"<p>The outbound caller ID name, number, and outbound whisper flow.</p>" }, "OutboundCallerIdName":{ "type":"string", "max":255, "min":1 }, "OutboundCallsEnabled":{"type":"boolean"}, "OutboundContactNotPermittedException":{ "type":"structure", "members":{ "Message":{ "shape":"Message", "documentation":"<p>The message about the contact.</p>" } }, "documentation":"<p>The contact is not permitted.</p>", "error":{"httpStatusCode":403}, "exception":true }, "OutboundEmailConfig":{ "type":"structure", "members":{ "OutboundEmailAddressId":{ "shape":"EmailAddressId", "documentation":"<p>The identifier of the email address.</p>" } }, "documentation":"<p>The outbound email address ID.</p>" }, "OutboundEmailContent":{ "type":"structure", "required":["MessageSourceType"], "members":{ "MessageSourceType":{ "shape":"OutboundMessageSourceType", "documentation":"<p>The message source type, that is, <code>RAW</code> or <code>TEMPLATE</code>.</p>" }, "TemplatedMessageConfig":{ "shape":"TemplatedMessageConfig", "documentation":"<p>Information about template message configuration.</p>" }, "RawMessage":{ "shape":"OutboundRawMessage", "documentation":"<p>The raw email body content.</p>" } }, "documentation":"<p>Information about email body content.</p>" }, "OutboundMessageSourceType":{ "type":"string", "enum":[ "TEMPLATE", "RAW" ] }, "OutboundRawMessage":{ "type":"structure", "required":[ "Subject", "Body", "ContentType" ], "members":{ "Subject":{ "shape":"OutboundSubject", "documentation":"<p>The email subject.</p>" }, "Body":{ "shape":"Body", "documentation":"<p>The email message body.</p>" }, "ContentType":{ "shape":"EmailMessageContentType", "documentation":"<p>Type of content, that is, <code>text/plain</code> or <code>text/html</code>.</p>" } }, "documentation":"<p>Information about the raw email body content.</p>" }, "OutboundRequestId":{ "type":"string", "max":36, "min":36 }, "OutboundSubject":{ "type":"string", "max":998, "min":1, "sensitive":true }, "OutputTypeNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"<p>Thrown for analyzed content when requested OutputType was not enabled for a given contact. For example, if an OutputType.Raw was requested for a contact that had `RedactedOnly` Redaction policy set in the flow.</p>", "error":{"httpStatusCode":404}, "exception":true }, "OverrideDays":{ "type":"string", "enum":[ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ] }, "OverrideTimeSlice":{ "type":"structure", "required":[ "Hours", "Minutes" ], "members":{ "Hours":{ "shape":"Hours24Format", "documentation":"<p>The hours.</p>", "box":true }, "Minutes":{ "shape":"MinutesLimit60", "documentation":"<p>The minutes.</p>", "box":true } }, "documentation":"<p>The start time or end time for an hours of operation override.</p>" }, "PEM":{ "type":"string", "max":1024, "min":1 }, "ParticipantCapabilities":{ "type":"structure", "members":{ "Video":{ "shape":"VideoCapability", "documentation":"<p>The configuration having the video and screen sharing capabilities for participants over the call.</p>" }, "ScreenShare":{ "shape":"ScreenShareCapability", "documentation":"<p>The screen sharing capability that is enabled for the participant. <code>SEND</code> indicates the participant can share their screen.</p>" } }, "documentation":"<p>The configuration for the allowed video and screen sharing capabilities for participants present over the call. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/inapp-calling.html\">Set up in-app, web, video calling, and screen sharing capabilities</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "ParticipantDetails":{ "type":"structure", "required":["DisplayName"], "members":{ "DisplayName":{ "shape":"DisplayName", "documentation":"<p>Display name of the participant.</p>" } }, "documentation":"<p>The customer's details.</p>" }, "ParticipantDetailsToAdd":{ "type":"structure", "members":{ "ParticipantRole":{ "shape":"ParticipantRole", "documentation":"<p>The role of the participant being added.</p>" }, "DisplayName":{ "shape":"DisplayName", "documentation":"<p>The display name of the participant.</p>" } }, "documentation":"<p>The details to add for the participant.</p>" }, "ParticipantId":{ "type":"string", "max":256, "min":1 }, "ParticipantMetrics":{ "type":"structure", "members":{ "ParticipantId":{ "shape":"ParticipantId", "documentation":"<p>The Participant's ID.</p>" }, "ParticipantType":{ "shape":"ParticipantType", "documentation":"<p>Information about the conversation participant. Following are the participant types: [Agent, Customer, Supervisor].</p>" }, "ConversationAbandon":{ "shape":"NullableBoolean", "documentation":"<p>A boolean flag indicating whether the chat conversation was abandoned by a Participant.</p>" }, "MessagesSent":{ "shape":"Count", "documentation":"<p>Number of chat messages sent by Participant.</p>" }, "NumResponses":{ "shape":"Count", "documentation":"<p>Number of chat messages sent by Participant.</p>" }, "MessageLengthInChars":{ "shape":"Count", "documentation":"<p>Number of chat characters sent by Participant.</p>" }, "TotalResponseTimeInMillis":{ "shape":"DurationMillis", "documentation":"<p>Total chat response time by Participant.</p>" }, "MaxResponseTimeInMillis":{ "shape":"DurationMillis", "documentation":"<p>Maximum chat response time by Participant.</p>" }, "LastMessageTimestamp":{ "shape":"timestamp", "documentation":"<p>Timestamp of last chat message by Participant.</p>" } }, "documentation":"<p>Information about a participant's interactions in a contact.</p>" }, "ParticipantRole":{ "type":"string", "enum":[ "AGENT", "CUSTOMER", "SYSTEM", "CUSTOM_BOT", "SUPERVISOR" ] }, "ParticipantState":{ "type":"string", "enum":[ "INITIAL", "CONNECTED", "DISCONNECTED", "MISSED" ] }, "ParticipantTimerAction":{ "type":"string", "enum":["Unset"] }, "ParticipantTimerConfigList":{ "type":"list", "member":{"shape":"ParticipantTimerConfiguration"}, "max":6, "min":1 }, "ParticipantTimerConfiguration":{ "type":"structure", "required":[ "ParticipantRole", "TimerType", "TimerValue" ], "members":{ "ParticipantRole":{ "shape":"TimerEligibleParticipantRoles", "documentation":"<p>The role of the participant in the chat conversation.</p>" }, "TimerType":{ "shape":"ParticipantTimerType", "documentation":"<p>The type of timer. <code>IDLE</code> indicates the timer applies for considering a human chat participant as idle. <code>DISCONNECT_NONCUSTOMER</code> indicates the timer applies to automatically disconnecting a chat participant due to idleness.</p>" }, "TimerValue":{ "shape":"ParticipantTimerValue", "documentation":"<p>The value of the timer. Either the timer action (Unset to delete the timer), or the duration of the timer in minutes. Only one value can be set.</p>" } }, "documentation":"<p>Configuration information for the timer. After the timer configuration is set, it persists for the duration of the chat. It persists across new contacts in the chain, for example, transfer contacts.</p> <p>For more information about how chat timeouts work, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html\">Set up chat timeouts for human participants</a>. </p>" }, "ParticipantTimerDurationInMinutes":{ "type":"integer", "max":480, "min":2 }, "ParticipantTimerType":{ "type":"string", "enum":[ "IDLE", "DISCONNECT_NONCUSTOMER" ] }, "ParticipantTimerValue":{ "type":"structure", "members":{ "ParticipantTimerAction":{ "shape":"ParticipantTimerAction", "documentation":"<p>The timer action. Currently only one value is allowed: <code>Unset</code>. It deletes a timer.</p>" }, "ParticipantTimerDurationInMinutes":{ "shape":"ParticipantTimerDurationInMinutes", "documentation":"<p>The duration of a timer, in minutes. </p>" } }, "documentation":"<p>The value of the timer. Either the timer action (<code>Unset</code> to delete the timer), or the duration of the timer in minutes. Only one value can be set.</p> <p>For more information about how chat timeouts work, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html\">Set up chat timeouts for human participants</a>. </p>", "union":true }, "ParticipantToken":{ "type":"string", "max":1000, "min":1 }, "ParticipantTokenCredentials":{ "type":"structure", "members":{ "ParticipantToken":{ "shape":"ParticipantToken", "documentation":"<p>The token used by the chat participant to call <a href=\"https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html\">CreateParticipantConnection</a>. The participant token is valid for the lifetime of a chat participant. </p>" }, "Expiry":{ "shape":"ISO8601Datetime", "documentation":"<p>The expiration of the token. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.</p>" } }, "documentation":"<p>The credentials used by the participant.</p>" }, "ParticipantType":{ "type":"string", "enum":[ "ALL", "MANAGER", "AGENT", "CUSTOMER", "THIRDPARTY" ] }, "Password":{ "type":"string", "pattern":"/^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)[a-zA-Z\\d\\S]{8,64}$/", "sensitive":true }, "PauseContactRequest":{ "type":"structure", "required":[ "ContactId", "InstanceId" ], "members":{ "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact.</p>" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can find the <code>instanceId</code> in the ARN of the instance.</p>" }, "ContactFlowId":{ "shape":"ContactFlowId", "documentation":"<p>The identifier of the flow.</p>" } } }, "PauseContactResponse":{ "type":"structure", "members":{} }, "Percentage":{ "type":"integer", "max":100, "min":0 }, "Permission":{ "type":"string", "max":128, "min":1 }, "PermissionsList":{ "type":"list", "member":{"shape":"SecurityProfilePermission"}, "max":500 }, "PersistentChat":{ "type":"structure", "members":{ "RehydrationType":{ "shape":"RehydrationType", "documentation":"<p>The contactId that is used for rehydration depends on the rehydration type. RehydrationType is required for persistent chat. </p> <ul> <li> <p> <code>ENTIRE_PAST_SESSION</code>: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the <code>initialContactId</code> of the past ended chat session in the <code>sourceContactId</code> field. In this type, Amazon Connect determines the most recent chat contact on the specified chat session that has ended, and uses it to start a persistent chat. </p> </li> <li> <p> <code>FROM_SEGMENT</code>: Rehydrates a chat from the past chat contact that is specified in the <code>sourceContactId</code> field. </p> </li> </ul> <p>The actual contactId used for rehydration is provided in the response of this API. </p>" }, "SourceContactId":{ "shape":"ContactId", "documentation":"<p>The contactId from which a persistent chat session must be started.</p>" } }, "documentation":"<p>Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html\">Enable persistent chat</a>.</p>" }, "PhoneNumber":{ "type":"string", "pattern":"\\\\+[1-9]\\\\d{1,14}$" }, "PhoneNumberCountryCode":{ "type":"string", "enum":[ "AF", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BR", "IO", "VG", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CK", "CR", "HR", "CU", "CW", "CY", "CZ", "CD", "DK", "DJ", "DM", "DO", "TL", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "PF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "CI", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "KP", "MP", "NO", "OM", "PK", "PW", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "CG", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "KR", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "VI", "UG", "UA", "AE", "GB", "US", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "EH", "YE", "ZM", "ZW" ] }, "PhoneNumberCountryCodes":{ "type":"list", "member":{"shape":"PhoneNumberCountryCode"}, "max":10 }, "PhoneNumberDescription":{ "type":"string", "max":500, "min":0, "pattern":"^[\\W\\S_]*" }, "PhoneNumberId":{"type":"string"}, "PhoneNumberPrefix":{ "type":"string", "pattern":"\\\\+?[0-9]{1,11}" }, "PhoneNumberQuickConnectConfig":{ "type":"structure", "required":["PhoneNumber"], "members":{ "PhoneNumber":{ "shape":"PhoneNumber", "documentation":"<p>The phone number in E.164 format.</p>" } }, "documentation":"<p>Contains information about a phone number for a quick connect.</p>" }, "PhoneNumberStatus":{ "type":"structure", "members":{ "Status":{ "shape":"PhoneNumberWorkflowStatus", "documentation":"<p>The status.</p>" }, "Message":{ "shape":"PhoneNumberWorkflowMessage", "documentation":"<p>The status message.</p>" } }, "documentation":"<p>The status of the phone number.</p> <ul> <li> <p> <code>CLAIMED</code> means the previous <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html\">ClaimPhoneNumber</a> or <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html\">UpdatePhoneNumber</a> operation succeeded.</p> </li> <li> <p> <code>IN_PROGRESS</code> means a <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html\">ClaimPhoneNumber</a>, <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html\">UpdatePhoneNumber</a>, or <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumberMetadata.html\">UpdatePhoneNumberMetadata</a> operation is still in progress and has not yet completed. You can call <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html\">DescribePhoneNumber</a> at a later time to verify if the previous operation has completed.</p> </li> <li> <p> <code>FAILED</code> indicates that the previous <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html\">ClaimPhoneNumber</a> or <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html\">UpdatePhoneNumber</a> operation has failed. It will include a message indicating the failure reason. A common reason for a failure may be that the <code>TargetArn</code> value you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received a <code>FAILED</code> status from a <code>ClaimPhoneNumber</code> API call, you have one day to retry claiming the phone number before the number is released back to the inventory for other customers to claim.</p> </li> </ul>" }, "PhoneNumberSummary":{ "type":"structure", "members":{ "Id":{ "shape":"PhoneNumberId", "documentation":"<p>The identifier of the phone number.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the phone number.</p>" }, "PhoneNumber":{ "shape":"PhoneNumber", "documentation":"<p>The phone number.</p>" }, "PhoneNumberType":{ "shape":"PhoneNumberType", "documentation":"<p>The type of phone number.</p>" }, "PhoneNumberCountryCode":{ "shape":"PhoneNumberCountryCode", "documentation":"<p>The ISO country code.</p>" } }, "documentation":"<p>Contains summary information about a phone number for a contact center.</p>" }, "PhoneNumberSummaryList":{ "type":"list", "member":{"shape":"PhoneNumberSummary"} }, "PhoneNumberType":{ "type":"string", "enum":[ "TOLL_FREE", "DID", "UIFN", "SHARED", "THIRD_PARTY_TF", "THIRD_PARTY_DID", "SHORT_CODE" ] }, "PhoneNumberTypes":{ "type":"list", "member":{"shape":"PhoneNumberType"}, "max":6 }, "PhoneNumberWorkflowMessage":{ "type":"string", "max":255, "min":0, "pattern":"^[\\W\\S_]*" }, "PhoneNumberWorkflowStatus":{ "type":"string", "enum":[ "CLAIMED", "IN_PROGRESS", "FAILED" ] }, "PhoneType":{ "type":"string", "enum":[ "SOFT_PHONE", "DESK_PHONE" ] }, "PlatformName":{ "type":"string", "max":128, "min":0 }, "PlatformVersion":{ "type":"string", "max":128, "min":0 }, "PotentialAudioQualityIssue":{ "type":"string", "max":128, "min":0 }, "PotentialAudioQualityIssues":{ "type":"list", "member":{"shape":"PotentialAudioQualityIssue"}, "max":3, "min":0 }, "PotentialDisconnectIssue":{ "type":"string", "max":128, "min":0 }, "PreSignedAttachmentUrl":{ "type":"string", "max":2000, "min":1 }, "PredefinedAttribute":{ "type":"structure", "members":{ "Name":{ "shape":"PredefinedAttributeName", "documentation":"<p>The name of the predefined attribute.</p>" }, "Values":{ "shape":"PredefinedAttributeValues", "documentation":"<p>The values of the predefined attribute.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>Last modified time.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>Last modified region.</p>" } }, "documentation":"<p>Information about a predefined attribute.</p>" }, "PredefinedAttributeName":{ "type":"string", "max":64, "min":1 }, "PredefinedAttributeSearchConditionList":{ "type":"list", "member":{"shape":"PredefinedAttributeSearchCriteria"} }, "PredefinedAttributeSearchCriteria":{ "type":"structure", "members":{ "OrConditions":{ "shape":"PredefinedAttributeSearchConditionList", "documentation":"<p>A list of conditions which would be applied together with an <code>OR</code> condition.</p>" }, "AndConditions":{ "shape":"PredefinedAttributeSearchConditionList", "documentation":"<p>A list of conditions which would be applied together with an <code>AND</code> condition.</p>" }, "StringCondition":{"shape":"StringCondition"} }, "documentation":"<p>The search criteria to be used to return predefined attributes.</p>" }, "PredefinedAttributeSearchSummaryList":{ "type":"list", "member":{"shape":"PredefinedAttribute"} }, "PredefinedAttributeStringValue":{ "type":"string", "max":64, "min":1 }, "PredefinedAttributeStringValuesList":{ "type":"list", "member":{"shape":"PredefinedAttributeStringValue"}, "max":128, "min":1 }, "PredefinedAttributeSummary":{ "type":"structure", "members":{ "Name":{ "shape":"PredefinedAttributeName", "documentation":"<p>The name of the predefined attribute.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>Last modified time.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>Last modified region.</p>" } }, "documentation":"<p>Summary of a predefined attribute.</p>" }, "PredefinedAttributeSummaryList":{ "type":"list", "member":{"shape":"PredefinedAttributeSummary"} }, "PredefinedAttributeValues":{ "type":"structure", "members":{ "StringList":{ "shape":"PredefinedAttributeStringValuesList", "documentation":"<p>Predefined attribute values of type string list.</p>" } }, "documentation":"<p>Information about values of a predefined attribute.</p>", "union":true }, "Prefix":{ "type":"string", "max":128, "min":1 }, "Priority":{ "type":"integer", "max":99, "min":1 }, "ProblemDetail":{ "type":"structure", "members":{ "message":{ "shape":"ProblemMessageString", "documentation":"<p>The problem detail's message.</p>" } }, "documentation":"<p>Information about a problem detail.</p>" }, "ProblemMessageString":{ "type":"string", "max":256, "min":1 }, "Problems":{ "type":"list", "member":{"shape":"ProblemDetail"}, "max":50, "min":1 }, "ProficiencyLevel":{ "type":"float", "box":true, "max":5.0, "min":1.0 }, "ProficiencyValue":{ "type":"string", "max":128, "min":1 }, "Prompt":{ "type":"structure", "members":{ "PromptARN":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the prompt.</p>" }, "PromptId":{ "shape":"PromptId", "documentation":"<p>A unique identifier for the prompt.</p>" }, "Name":{ "shape":"CommonNameLength127", "documentation":"<p>The name of the prompt.</p>" }, "Description":{ "shape":"PromptDescription", "documentation":"<p>The description of the prompt.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when this resource was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The Amazon Web Services Region where this resource was last modified.</p>" } }, "documentation":"<p>Information about a prompt.</p>" }, "PromptDescription":{ "type":"string", "max":250, "min":1 }, "PromptId":{ "type":"string", "max":256, "min":1 }, "PromptList":{ "type":"list", "member":{"shape":"Prompt"} }, "PromptName":{ "type":"string", "max":256, "min":1 }, "PromptPresignedUrl":{ "type":"string", "max":2000, "min":1 }, "PromptSearchConditionList":{ "type":"list", "member":{"shape":"PromptSearchCriteria"} }, "PromptSearchCriteria":{ "type":"structure", "members":{ "OrConditions":{ "shape":"PromptSearchConditionList", "documentation":"<p>A list of conditions which would be applied together with an OR condition.</p>" }, "AndConditions":{ "shape":"PromptSearchConditionList", "documentation":"<p>A list of conditions which would be applied together with an AND condition.</p>" }, "StringCondition":{ "shape":"StringCondition", "documentation":"<p>A leaf node condition which can be used to specify a string condition.</p> <note> <p>The currently supported values for <code>FieldName</code> are <code>name</code>, <code>description</code>, and <code>resourceID</code>.</p> </note>" } }, "documentation":"<p>The search criteria to be used to return prompts.</p>" }, "PromptSearchFilter":{ "type":"structure", "members":{ "TagFilter":{"shape":"ControlPlaneTagFilter"} }, "documentation":"<p>Filters to be applied to search results.</p>" }, "PromptSummary":{ "type":"structure", "members":{ "Id":{ "shape":"PromptId", "documentation":"<p>The identifier of the prompt.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the prompt.</p>" }, "Name":{ "shape":"PromptName", "documentation":"<p>The name of the prompt.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when this resource was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The Amazon Web Services Region where this resource was last modified.</p>" } }, "documentation":"<p>Contains information about the prompt.</p>" }, "PromptSummaryList":{ "type":"list", "member":{"shape":"PromptSummary"} }, "PropertyValidationException":{ "type":"structure", "required":["Message"], "members":{ "Message":{"shape":"Message"}, "PropertyList":{"shape":"PropertyValidationExceptionPropertyList"} }, "documentation":"<p>The property is not valid.</p>", "error":{"httpStatusCode":400}, "exception":true }, "PropertyValidationExceptionProperty":{ "type":"structure", "required":[ "PropertyPath", "Reason", "Message" ], "members":{ "PropertyPath":{ "shape":"String", "documentation":"<p>The full property path.</p>" }, "Reason":{ "shape":"PropertyValidationExceptionReason", "documentation":"<p>Why the property is not valid.</p>" }, "Message":{ "shape":"Message", "documentation":"<p>A message describing why the property is not valid.</p>" } }, "documentation":"<p>Contains information about why a property is not valid.</p>" }, "PropertyValidationExceptionPropertyList":{ "type":"list", "member":{"shape":"PropertyValidationExceptionProperty"} }, "PropertyValidationExceptionReason":{ "type":"string", "enum":[ "INVALID_FORMAT", "UNIQUE_CONSTRAINT_VIOLATED", "REFERENCED_RESOURCE_NOT_FOUND", "RESOURCE_NAME_ALREADY_EXISTS", "REQUIRED_PROPERTY_MISSING", "NOT_SUPPORTED" ] }, "PutUserStatusRequest":{ "type":"structure", "required":[ "UserId", "InstanceId", "AgentStatusId" ], "members":{ "UserId":{ "shape":"UserId", "documentation":"<p>The identifier of the user.</p>", "location":"uri", "locationName":"UserId" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "AgentStatusId":{ "shape":"AgentStatusId", "documentation":"<p>The identifier of the agent status.</p>" } } }, "PutUserStatusResponse":{ "type":"structure", "members":{} }, "QualityMetrics":{ "type":"structure", "members":{ "Agent":{ "shape":"AgentQualityMetrics", "documentation":"<p>Information about the quality of Agent media connection.</p>" }, "Customer":{ "shape":"CustomerQualityMetrics", "documentation":"<p>Information about the quality of Customer media connection.</p>" } }, "documentation":"<p>Information about the quality of the participant's media connection.</p>" }, "Queue":{ "type":"structure", "members":{ "Name":{ "shape":"CommonNameLength127", "documentation":"<p>The name of the queue.</p>" }, "QueueArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the queue.</p>" }, "QueueId":{ "shape":"QueueId", "documentation":"<p>The identifier for the queue.</p>" }, "Description":{ "shape":"QueueDescription", "documentation":"<p>The description of the queue.</p>" }, "OutboundCallerConfig":{ "shape":"OutboundCallerConfig", "documentation":"<p>The outbound caller ID name, number, and outbound whisper flow.</p>" }, "OutboundEmailConfig":{ "shape":"OutboundEmailConfig", "documentation":"<p>The outbound email address ID for a specified queue.</p>" }, "HoursOfOperationId":{ "shape":"HoursOfOperationId", "documentation":"<p>The identifier for the hours of operation.</p>" }, "MaxContacts":{ "shape":"QueueMaxContacts", "documentation":"<p>The maximum number of contacts that can be in the queue before it is considered full.</p>", "box":true }, "Status":{ "shape":"QueueStatus", "documentation":"<p>The status of the queue.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when this resource was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The Amazon Web Services Region where this resource was last modified.</p>" } }, "documentation":"<p>Contains information about a queue.</p>" }, "QueueDescription":{ "type":"string", "max":250, "min":1 }, "QueueId":{"type":"string"}, "QueueIdList":{ "type":"list", "member":{"shape":"QueueId"}, "max":100, "min":0 }, "QueueInfo":{ "type":"structure", "members":{ "Id":{ "shape":"QueueId", "documentation":"<p>The unique identifier for the queue.</p>" }, "EnqueueTimestamp":{ "shape":"timestamp", "documentation":"<p>The timestamp when the contact was added to the queue.</p>" } }, "documentation":"<p>If this contact was queued, this contains information about the queue. </p>" }, "QueueInfoInput":{ "type":"structure", "members":{ "Id":{ "shape":"QueueId", "documentation":"<p>The identifier of the queue.</p>" } }, "documentation":"<p>Information about a queue.</p>" }, "QueueMaxContacts":{ "type":"integer", "min":0 }, "QueueName":{ "type":"string", "max":256, "min":1 }, "QueuePriority":{ "type":"long", "max":9223372036854775807, "min":1 }, "QueueQuickConnectConfig":{ "type":"structure", "required":[ "QueueId", "ContactFlowId" ], "members":{ "QueueId":{ "shape":"QueueId", "documentation":"<p>The identifier for the queue.</p>" }, "ContactFlowId":{ "shape":"ContactFlowId", "documentation":"<p>The identifier of the flow.</p>" } }, "documentation":"<p>Contains information about a queue for a quick connect. The flow must be of type Transfer to Queue.</p>" }, "QueueReference":{ "type":"structure", "members":{ "Id":{ "shape":"QueueId", "documentation":"<p>The identifier of the queue.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the queue.</p>" } }, "documentation":"<p>Contains information about a queue resource for which metrics are returned.</p>" }, "QueueSearchConditionList":{ "type":"list", "member":{"shape":"QueueSearchCriteria"} }, "QueueSearchCriteria":{ "type":"structure", "members":{ "OrConditions":{ "shape":"QueueSearchConditionList", "documentation":"<p>A list of conditions which would be applied together with an OR condition.</p>" }, "AndConditions":{ "shape":"QueueSearchConditionList", "documentation":"<p>A list of conditions which would be applied together with an AND condition.</p>" }, "StringCondition":{ "shape":"StringCondition", "documentation":"<p>A leaf node condition which can be used to specify a string condition.</p> <note> <p>The currently supported values for <code>FieldName</code> are <code>name</code>, <code>description</code>, and <code>resourceID</code>.</p> </note>" }, "QueueTypeCondition":{ "shape":"SearchableQueueType", "documentation":"<p>The type of queue.</p>" } }, "documentation":"<p>The search criteria to be used to return queues.</p> <note> <p>The <code>name</code> and <code>description</code> fields support \"contains\" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. </p> </note>" }, "QueueSearchFilter":{ "type":"structure", "members":{ "TagFilter":{"shape":"ControlPlaneTagFilter"} }, "documentation":"<p>Filters to be applied to search results.</p>" }, "QueueSearchSummaryList":{ "type":"list", "member":{"shape":"Queue"} }, "QueueStatus":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "QueueSummary":{ "type":"structure", "members":{ "Id":{ "shape":"QueueId", "documentation":"<p>The identifier of the queue.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the queue.</p>" }, "Name":{ "shape":"QueueName", "documentation":"<p>The name of the queue.</p>" }, "QueueType":{ "shape":"QueueType", "documentation":"<p>The type of queue.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when this resource was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The Amazon Web Services Region where this resource was last modified.</p>" } }, "documentation":"<p>Contains summary information about a queue.</p>" }, "QueueSummaryList":{ "type":"list", "member":{"shape":"QueueSummary"} }, "QueueTimeAdjustmentSeconds":{"type":"integer"}, "QueueType":{ "type":"string", "enum":[ "STANDARD", "AGENT" ] }, "QueueTypes":{ "type":"list", "member":{"shape":"QueueType"}, "max":2 }, "Queues":{ "type":"list", "member":{"shape":"QueueId"}, "max":100, "min":1 }, "QuickConnect":{ "type":"structure", "members":{ "QuickConnectARN":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the quick connect.</p>" }, "QuickConnectId":{ "shape":"QuickConnectId", "documentation":"<p>The identifier for the quick connect.</p>" }, "Name":{ "shape":"QuickConnectName", "documentation":"<p>The name of the quick connect.</p>" }, "Description":{ "shape":"QuickConnectDescription", "documentation":"<p>The description.</p>" }, "QuickConnectConfig":{ "shape":"QuickConnectConfig", "documentation":"<p>Contains information about the quick connect.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when this resource was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The Amazon Web Services Region where this resource was last modified.</p>" } }, "documentation":"<p>Contains information about a quick connect.</p>" }, "QuickConnectConfig":{ "type":"structure", "required":["QuickConnectType"], "members":{ "QuickConnectType":{ "shape":"QuickConnectType", "documentation":"<p>The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE). </p>" }, "UserConfig":{ "shape":"UserQuickConnectConfig", "documentation":"<p>The user configuration. This is required only if QuickConnectType is USER.</p>" }, "QueueConfig":{ "shape":"QueueQuickConnectConfig", "documentation":"<p>The queue configuration. This is required only if QuickConnectType is QUEUE.</p>" }, "PhoneConfig":{ "shape":"PhoneNumberQuickConnectConfig", "documentation":"<p>The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.</p>" } }, "documentation":"<p>Contains configuration settings for a quick connect.</p>" }, "QuickConnectDescription":{ "type":"string", "max":250, "min":1 }, "QuickConnectId":{"type":"string"}, "QuickConnectName":{ "type":"string", "max":127, "min":1 }, "QuickConnectSearchConditionList":{ "type":"list", "member":{"shape":"QuickConnectSearchCriteria"} }, "QuickConnectSearchCriteria":{ "type":"structure", "members":{ "OrConditions":{ "shape":"QuickConnectSearchConditionList", "documentation":"<p>A list of conditions which would be applied together with an OR condition.</p>" }, "AndConditions":{ "shape":"QuickConnectSearchConditionList", "documentation":"<p>A list of conditions which would be applied together with an AND condition.</p>" }, "StringCondition":{ "shape":"StringCondition", "documentation":"<p>A leaf node condition which can be used to specify a string condition.</p> <note> <p>The currently supported values for <code>FieldName</code> are <code>name</code>, <code>description</code>, and <code>resourceID</code>.</p> </note>" } }, "documentation":"<p>The search criteria to be used to return quick connects.</p>" }, "QuickConnectSearchFilter":{ "type":"structure", "members":{ "TagFilter":{"shape":"ControlPlaneTagFilter"} }, "documentation":"<p>Filters to be applied to search results.</p>" }, "QuickConnectSearchSummaryList":{ "type":"list", "member":{"shape":"QuickConnect"} }, "QuickConnectSummary":{ "type":"structure", "members":{ "Id":{ "shape":"QuickConnectId", "documentation":"<p>The identifier for the quick connect.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the quick connect.</p>" }, "Name":{ "shape":"QuickConnectName", "documentation":"<p>The name of the quick connect.</p>" }, "QuickConnectType":{ "shape":"QuickConnectType", "documentation":"<p>The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when this resource was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The Amazon Web Services Region where this resource was last modified.</p>" } }, "documentation":"<p>Contains summary information about a quick connect.</p>" }, "QuickConnectSummaryList":{ "type":"list", "member":{"shape":"QuickConnectSummary"} }, "QuickConnectType":{ "type":"string", "enum":[ "USER", "QUEUE", "PHONE_NUMBER" ] }, "QuickConnectTypes":{ "type":"list", "member":{"shape":"QuickConnectType"}, "max":3 }, "QuickConnectsList":{ "type":"list", "member":{"shape":"QuickConnectId"}, "max":50, "min":1 }, "Range":{ "type":"structure", "members":{ "MinProficiencyLevel":{ "shape":"NullableProficiencyLevel", "documentation":"<p>The minimum proficiency level of the range.</p>" }, "MaxProficiencyLevel":{ "shape":"NullableProficiencyLevel", "documentation":"<p>The maximum proficiency level of the range.</p>" } }, "documentation":"<p>An Object to define the minimum and maximum proficiency levels.</p>" }, "ReadOnlyFieldInfo":{ "type":"structure", "members":{ "Id":{ "shape":"TaskTemplateFieldIdentifier", "documentation":"<p>Identifier of the read-only field.</p>" } }, "documentation":"<p>Indicates a field that is read-only to an agent.</p>" }, "ReadOnlyTaskTemplateFields":{ "type":"list", "member":{"shape":"ReadOnlyFieldInfo"} }, "RealTimeContactAnalysisAttachment":{ "type":"structure", "required":[ "AttachmentName", "AttachmentId" ], "members":{ "AttachmentName":{ "shape":"AttachmentName", "documentation":"<p>A case-sensitive name of the attachment being uploaded. Can be redacted.</p>" }, "ContentType":{ "shape":"ContentType", "documentation":"<p>Describes the MIME file type of the attachment. For a list of supported file types, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/feature-limits.html\">Feature specifications</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "AttachmentId":{ "shape":"ArtifactId", "documentation":"<p>A unique identifier for the attachment.</p>" }, "Status":{ "shape":"ArtifactStatus", "documentation":"<p>Status of the attachment.</p>" } }, "documentation":"<p>Object that describes attached file. </p>" }, "RealTimeContactAnalysisAttachments":{ "type":"list", "member":{"shape":"RealTimeContactAnalysisAttachment"}, "max":10 }, "RealTimeContactAnalysisCategoryDetails":{ "type":"structure", "required":["PointsOfInterest"], "members":{ "PointsOfInterest":{ "shape":"RealTimeContactAnalysisPointsOfInterest", "documentation":"<p>List of PointOfInterest - objects describing a single match of a rule.</p>" } }, "documentation":"<p>Provides information about the category rule that was matched.</p>" }, "RealTimeContactAnalysisCategoryName":{ "type":"string", "max":256, "min":1 }, "RealTimeContactAnalysisCharacterInterval":{ "type":"structure", "required":[ "BeginOffsetChar", "EndOffsetChar" ], "members":{ "BeginOffsetChar":{ "shape":"RealTimeContactAnalysisOffset", "documentation":"<p>The beginning of the character interval.</p>" }, "EndOffsetChar":{ "shape":"RealTimeContactAnalysisOffset", "documentation":"<p>The end of the character interval.</p>" } }, "documentation":"<p>Begin and end offsets for a part of text.</p>" }, "RealTimeContactAnalysisCharacterIntervals":{ "type":"list", "member":{"shape":"RealTimeContactAnalysisCharacterInterval"} }, "RealTimeContactAnalysisContentType":{ "type":"string", "max":256, "min":1 }, "RealTimeContactAnalysisEventType":{ "type":"string", "max":128, "min":1 }, "RealTimeContactAnalysisId256":{ "type":"string", "max":256, "min":1 }, "RealTimeContactAnalysisIssueDetected":{ "type":"structure", "required":["TranscriptItems"], "members":{ "TranscriptItems":{ "shape":"RealTimeContactAnalysisTranscriptItemsWithContent", "documentation":"<p>List of the transcript items (segments) that are associated with a given issue.</p>" } }, "documentation":"<p>Potential issues that are detected based on an artificial intelligence analysis of each turn in the conversation.</p>" }, "RealTimeContactAnalysisIssuesDetected":{ "type":"list", "member":{"shape":"RealTimeContactAnalysisIssueDetected"} }, "RealTimeContactAnalysisMatchedDetails":{ "type":"map", "key":{"shape":"RealTimeContactAnalysisCategoryName"}, "value":{"shape":"RealTimeContactAnalysisCategoryDetails"}, "max":150, "min":0 }, "RealTimeContactAnalysisOffset":{ "type":"integer", "min":0 }, "RealTimeContactAnalysisOutputType":{ "type":"string", "enum":[ "Raw", "Redacted" ] }, "RealTimeContactAnalysisPointOfInterest":{ "type":"structure", "members":{ "TranscriptItems":{ "shape":"RealTimeContactAnalysisTranscriptItemsWithCharacterOffsets", "documentation":"<p>List of the transcript items (segments) that are associated with a given point of interest. </p>" } }, "documentation":"<p>The section of the contact transcript segment that category rule was detected.</p>" }, "RealTimeContactAnalysisPointsOfInterest":{ "type":"list", "member":{"shape":"RealTimeContactAnalysisPointOfInterest"}, "max":5, "min":0 }, "RealTimeContactAnalysisPostContactSummaryContent":{ "type":"string", "max":1270, "min":1 }, "RealTimeContactAnalysisPostContactSummaryFailureCode":{ "type":"string", "enum":[ "QUOTA_EXCEEDED", "INSUFFICIENT_CONVERSATION_CONTENT", "FAILED_SAFETY_GUIDELINES", "INVALID_ANALYSIS_CONFIGURATION", "INTERNAL_ERROR" ] }, "RealTimeContactAnalysisPostContactSummaryStatus":{ "type":"string", "enum":[ "FAILED", "COMPLETED" ] }, "RealTimeContactAnalysisSegmentAttachments":{ "type":"structure", "required":[ "Id", "ParticipantId", "ParticipantRole", "Attachments", "Time" ], "members":{ "Id":{ "shape":"RealTimeContactAnalysisId256", "documentation":"<p>The identifier of the segment.</p>" }, "ParticipantId":{ "shape":"ParticipantId", "documentation":"<p>The identifier of the participant.</p>" }, "ParticipantRole":{ "shape":"ParticipantRole", "documentation":"<p>The role of the participant. For example, is it a customer, agent, or system.</p>" }, "DisplayName":{ "shape":"DisplayName", "documentation":"<p>The display name of the participant. Can be redacted. </p>" }, "Attachments":{ "shape":"RealTimeContactAnalysisAttachments", "documentation":"<p>List of objects describing an individual attachment.</p>" }, "Time":{ "shape":"RealTimeContactAnalysisTimeData", "documentation":"<p>Field describing the time of the event. It can have different representations of time.</p>" } }, "documentation":"<p>Segment containing list of attachments.</p>" }, "RealTimeContactAnalysisSegmentCategories":{ "type":"structure", "required":["MatchedDetails"], "members":{ "MatchedDetails":{ "shape":"RealTimeContactAnalysisMatchedDetails", "documentation":"<p>Map between the name of the matched rule and RealTimeContactAnalysisCategoryDetails.</p>" } }, "documentation":"<p>The matched category rules.</p>" }, "RealTimeContactAnalysisSegmentEvent":{ "type":"structure", "required":[ "Id", "EventType", "Time" ], "members":{ "Id":{ "shape":"RealTimeContactAnalysisId256", "documentation":"<p>The identifier of the contact event.</p>" }, "ParticipantId":{ "shape":"ParticipantId", "documentation":"<p>The identifier of the participant.</p>" }, "ParticipantRole":{ "shape":"ParticipantRole", "documentation":"<p>The role of the participant. For example, is it a customer, agent, or system.</p>" }, "DisplayName":{ "shape":"DisplayName", "documentation":"<p>The display name of the participant. Can be redacted.</p>" }, "EventType":{ "shape":"RealTimeContactAnalysisEventType", "documentation":"<p>Type of the event. For example, <code>application/vnd.amazonaws.connect.event.participant.left</code>.</p>" }, "Time":{ "shape":"RealTimeContactAnalysisTimeData", "documentation":"<p>Field describing the time of the event. It can have different representations of time.</p>" } }, "documentation":"<p>Segment type describing a contact event.</p>" }, "RealTimeContactAnalysisSegmentIssues":{ "type":"structure", "required":["IssuesDetected"], "members":{ "IssuesDetected":{ "shape":"RealTimeContactAnalysisIssuesDetected", "documentation":"<p>List of the issues detected.</p>" } }, "documentation":"<p>Segment type containing a list of detected issues.</p>" }, "RealTimeContactAnalysisSegmentPostContactSummary":{ "type":"structure", "required":["Status"], "members":{ "Content":{ "shape":"RealTimeContactAnalysisPostContactSummaryContent", "documentation":"<p>The content of the summary.</p>" }, "Status":{ "shape":"RealTimeContactAnalysisPostContactSummaryStatus", "documentation":"<p>Whether the summary was successfully COMPLETED or FAILED to be generated.</p>" }, "FailureCode":{ "shape":"RealTimeContactAnalysisPostContactSummaryFailureCode", "documentation":"<p>If the summary failed to be generated, one of the following failure codes occurs:</p> <ul> <li> <p> <code>QUOTA_EXCEEDED</code>: The number of concurrent analytics jobs reached your service quota.</p> </li> <li> <p> <code>INSUFFICIENT_CONVERSATION_CONTENT</code>: The conversation needs to have at least one turn from both the participants in order to generate the summary.</p> </li> <li> <p> <code>FAILED_SAFETY_GUIDELINES</code>: The generated summary cannot be provided because it failed to meet system safety guidelines.</p> </li> <li> <p> <code>INVALID_ANALYSIS_CONFIGURATION</code>: This code occurs when, for example, you're using a <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/supported-languages.html#supported-languages-contact-lens\">language</a> that isn't supported by generative AI-powered post-contact summaries. </p> </li> <li> <p> <code>INTERNAL_ERROR</code>: Internal system error.</p> </li> </ul>" } }, "documentation":"<p>Information about the post-contact summary for a real-time contact segment.</p>" }, "RealTimeContactAnalysisSegmentTranscript":{ "type":"structure", "required":[ "Id", "ParticipantId", "ParticipantRole", "Content", "Time" ], "members":{ "Id":{ "shape":"RealTimeContactAnalysisId256", "documentation":"<p>The identifier of the transcript.</p>" }, "ParticipantId":{ "shape":"ParticipantId", "documentation":"<p>The identifier of the participant.</p>" }, "ParticipantRole":{ "shape":"ParticipantRole", "documentation":"<p>The role of the participant. For example, is it a customer, agent, or system.</p>" }, "DisplayName":{ "shape":"DisplayName", "documentation":"<p>The display name of the participant.</p>" }, "Content":{ "shape":"RealTimeContactAnalysisTranscriptContent", "documentation":"<p>The content of the transcript. Can be redacted.</p>" }, "ContentType":{ "shape":"RealTimeContactAnalysisContentType", "documentation":"<p>The type of content of the item. For example, <code>text/plain</code>.</p>" }, "Time":{ "shape":"RealTimeContactAnalysisTimeData", "documentation":"<p>Field describing the time of the event. It can have different representations of time.</p>" }, "Redaction":{ "shape":"RealTimeContactAnalysisTranscriptItemRedaction", "documentation":"<p>Object describing redaction that was applied to the transcript. If transcript has the field it means part of the transcript was redacted.</p>" }, "Sentiment":{ "shape":"RealTimeContactAnalysisSentimentLabel", "documentation":"<p>The sentiment detected for this piece of transcript.</p>" } }, "documentation":"<p>The analyzed transcript segment.</p>" }, "RealTimeContactAnalysisSegmentType":{ "type":"string", "enum":[ "Transcript", "Categories", "Issues", "Event", "Attachments", "PostContactSummary" ] }, "RealTimeContactAnalysisSegmentTypes":{ "type":"list", "member":{"shape":"RealTimeContactAnalysisSegmentType"}, "max":6 }, "RealTimeContactAnalysisSentimentLabel":{ "type":"string", "enum":[ "POSITIVE", "NEGATIVE", "NEUTRAL" ] }, "RealTimeContactAnalysisStatus":{ "type":"string", "enum":[ "IN_PROGRESS", "FAILED", "COMPLETED" ] }, "RealTimeContactAnalysisSupportedChannel":{ "type":"string", "enum":[ "VOICE", "CHAT" ] }, "RealTimeContactAnalysisTimeData":{ "type":"structure", "members":{ "AbsoluteTime":{ "shape":"RealTimeContactAnalysisTimeInstant", "documentation":"<p>Time represented in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.</p>" } }, "documentation":"<p>Object describing time with which the segment is associated. It can have different representations of time. Currently supported: absoluteTime</p>", "union":true }, "RealTimeContactAnalysisTimeInstant":{ "type":"timestamp", "timestampFormat":"iso8601" }, "RealTimeContactAnalysisTranscriptContent":{ "type":"string", "max":16384, "min":1 }, "RealTimeContactAnalysisTranscriptItemRedaction":{ "type":"structure", "members":{ "CharacterOffsets":{ "shape":"RealTimeContactAnalysisCharacterIntervals", "documentation":"<p>List of character intervals each describing a part of the text that was redacted. For <code>OutputType.Raw</code>, part of the original text that contains data that can be redacted. For <code> OutputType.Redacted</code>, part of the string with redaction tag.</p>" } }, "documentation":"<p>Object describing redaction applied to the segment.</p>" }, "RealTimeContactAnalysisTranscriptItemWithCharacterOffsets":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"RealTimeContactAnalysisId256", "documentation":"<p>Transcript identifier. Matches the identifier from one of the TranscriptSegments.</p>" }, "CharacterOffsets":{ "shape":"RealTimeContactAnalysisCharacterInterval", "documentation":"<p>List of character intervals within transcript content/text.</p>" } }, "documentation":"<p>Transcript representation containing Id and list of character intervals that are associated with analysis data. For example, this object within a <code>RealTimeContactAnalysisPointOfInterest</code> in <code>Category.MatchedDetails</code> would have character interval describing part of the text that matched category.</p>" }, "RealTimeContactAnalysisTranscriptItemWithContent":{ "type":"structure", "required":["Id"], "members":{ "Content":{ "shape":"RealTimeContactAnalysisTranscriptContent", "documentation":"<p>Part of the transcript content that contains identified issue. Can be redacted</p>" }, "Id":{ "shape":"RealTimeContactAnalysisId256", "documentation":"<p>Transcript identifier. Matches the identifier from one of the TranscriptSegments.</p>" }, "CharacterOffsets":{"shape":"RealTimeContactAnalysisCharacterInterval"} }, "documentation":"<p>Transcript representation containing Id, Content and list of character intervals that are associated with analysis data. For example, this object within an issue detected would describe both content that contains identified issue and intervals where that content is taken from.</p>" }, "RealTimeContactAnalysisTranscriptItemsWithCharacterOffsets":{ "type":"list", "member":{"shape":"RealTimeContactAnalysisTranscriptItemWithCharacterOffsets"}, "max":10, "min":0 }, "RealTimeContactAnalysisTranscriptItemsWithContent":{ "type":"list", "member":{"shape":"RealTimeContactAnalysisTranscriptItemWithContent"} }, "RealtimeContactAnalysisSegment":{ "type":"structure", "members":{ "Transcript":{"shape":"RealTimeContactAnalysisSegmentTranscript"}, "Categories":{"shape":"RealTimeContactAnalysisSegmentCategories"}, "Issues":{"shape":"RealTimeContactAnalysisSegmentIssues"}, "Event":{"shape":"RealTimeContactAnalysisSegmentEvent"}, "Attachments":{ "shape":"RealTimeContactAnalysisSegmentAttachments", "documentation":"<p>The analyzed attachments.</p>" }, "PostContactSummary":{ "shape":"RealTimeContactAnalysisSegmentPostContactSummary", "documentation":"<p>Information about the post-contact summary.</p>" } }, "documentation":"<p>An analyzed segment for a real-time analysis session.</p>", "union":true }, "RealtimeContactAnalysisSegments":{ "type":"list", "member":{"shape":"RealtimeContactAnalysisSegment"} }, "RecordingDeletionReason":{"type":"string"}, "RecordingInfo":{ "type":"structure", "members":{ "StorageType":{ "shape":"StorageType", "documentation":"<p>Where the recording/transcript is stored.</p>" }, "Location":{ "shape":"RecordingLocation", "documentation":"<p>The location, in Amazon S3, for the recording/transcript.</p>" }, "MediaStreamType":{ "shape":"MediaStreamType", "documentation":"<p>Information about the media stream used during the conversation.</p>" }, "ParticipantType":{ "shape":"ParticipantType", "documentation":"<p>Information about the conversation participant, whether they are an agent or contact. The participant types are as follows:</p> <ul> <li> <p>All</p> </li> <li> <p>Manager</p> </li> <li> <p>Agent</p> </li> <li> <p>Customer</p> </li> <li> <p>Thirdparty</p> </li> <li> <p>Supervisor</p> </li> </ul>" }, "FragmentStartNumber":{ "shape":"FragmentNumber", "documentation":"<p>The number that identifies the Kinesis Video Streams fragment where the customer audio stream started.</p>" }, "FragmentStopNumber":{ "shape":"FragmentNumber", "documentation":"<p>The number that identifies the Kinesis Video Streams fragment where the customer audio stream stopped.</p>" }, "StartTimestamp":{ "shape":"timestamp", "documentation":"<p>When the conversation of the last leg of the recording started in UTC time.</p>" }, "StopTimestamp":{ "shape":"timestamp", "documentation":"<p>When the conversation of the last leg of recording stopped in UTC time.</p>" }, "Status":{ "shape":"RecordingStatus", "documentation":"<p>The status of the recording/transcript.</p>" }, "DeletionReason":{ "shape":"RecordingDeletionReason", "documentation":"<p>If the recording/transcript was deleted, this is the reason entered for the deletion.</p>" } }, "documentation":"<p>Information about a voice recording, chat transcript, or screen recording.</p>" }, "RecordingLocation":{ "type":"string", "max":1024, "min":0 }, "RecordingStatus":{ "type":"string", "enum":[ "AVAILABLE", "DELETED" ] }, "Recordings":{ "type":"list", "member":{"shape":"RecordingInfo"} }, "Reference":{ "type":"structure", "required":["Type"], "members":{ "Value":{ "shape":"ReferenceValue", "documentation":"<p>A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).</p>" }, "Type":{ "shape":"ReferenceType", "documentation":"<p>The type of the reference. <code>DATE</code> must be of type Epoch timestamp. </p>" }, "Status":{ "shape":"ReferenceStatus", "documentation":"<p>Status of the attachment reference type.</p>" }, "Arn":{ "shape":"ReferenceArn", "documentation":"<p>The Amazon Resource Name (ARN) of the reference</p>" }, "StatusReason":{ "shape":"ReferenceStatusReason", "documentation":"<p>Relevant details why the reference was not successfully created.</p>" } }, "documentation":"<p>Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.</p>" }, "ReferenceArn":{ "type":"string", "max":256, "min":20, "pattern":"^[-:/A-Za-z0-9]+" }, "ReferenceId":{ "type":"string", "max":40, "min":1 }, "ReferenceKey":{ "type":"string", "max":4096, "min":1 }, "ReferenceStatus":{ "type":"string", "enum":[ "AVAILABLE", "DELETED", "APPROVED", "REJECTED", "PROCESSING", "FAILED" ] }, "ReferenceStatusReason":{ "type":"string", "max":100, "min":0 }, "ReferenceSummary":{ "type":"structure", "members":{ "Url":{ "shape":"UrlReference", "documentation":"<p>Information about the reference when the <code>referenceType</code> is <code>URL</code>. Otherwise, null.</p>" }, "Attachment":{ "shape":"AttachmentReference", "documentation":"<p>Information about the reference when the <code>referenceType</code> is <code>ATTACHMENT</code>. Otherwise, null.</p>" }, "EmailMessage":{ "shape":"EmailMessageReference", "documentation":"<p>Information about the reference when the referenceType is <code>EMAIL_MESSAGE</code>. Otherwise, null.</p>" }, "String":{ "shape":"StringReference", "documentation":"<p>Information about a reference when the <code>referenceType</code> is <code>STRING</code>. Otherwise, null.</p>" }, "Number":{ "shape":"NumberReference", "documentation":"<p>Information about a reference when the <code>referenceType</code> is <code>NUMBER</code>. Otherwise, null.</p>" }, "Date":{ "shape":"DateReference", "documentation":"<p>Information about a reference when the <code>referenceType</code> is <code>DATE</code>. Otherwise, null.</p>" }, "Email":{ "shape":"EmailReference", "documentation":"<p>Information about a reference when the <code>referenceType</code> is <code>EMAIL</code>. Otherwise, null.</p>" } }, "documentation":"<p>Contains summary information about a reference. <code>ReferenceSummary</code> contains only one non null field between the URL and attachment based on the reference type.</p>", "union":true }, "ReferenceSummaryList":{ "type":"list", "member":{"shape":"ReferenceSummary"} }, "ReferenceType":{ "type":"string", "enum":[ "URL", "ATTACHMENT", "CONTACT_ANALYSIS", "NUMBER", "STRING", "DATE", "EMAIL", "EMAIL_MESSAGE" ] }, "ReferenceTypes":{ "type":"list", "member":{"shape":"ReferenceType"}, "max":6 }, "ReferenceValue":{ "type":"string", "max":4096, "min":0 }, "RefreshTokenDuration":{ "type":"integer", "box":true, "max":720, "min":360 }, "RegionName":{ "type":"string", "pattern":"[a-z]{2}(-[a-z]+){1,2}(-[0-9])?" }, "RegistrationId":{ "type":"string", "max":256, "min":1 }, "RehydrationType":{ "type":"string", "enum":[ "ENTIRE_PAST_SESSION", "FROM_SEGMENT" ] }, "ReleasePhoneNumberRequest":{ "type":"structure", "required":["PhoneNumberId"], "members":{ "PhoneNumberId":{ "shape":"PhoneNumberId", "documentation":"<p>A unique identifier for the phone number.</p>", "location":"uri", "locationName":"PhoneNumberId" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" } } }, "ReplicateInstanceRequest":{ "type":"structure", "required":[ "InstanceId", "ReplicaRegion", "ReplicaAlias" ], "members":{ "InstanceId":{ "shape":"InstanceIdOrArn", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance. You can provide the <code>InstanceId</code>, or the entire ARN.</p>", "location":"uri", "locationName":"InstanceId" }, "ReplicaRegion":{ "shape":"AwsRegion", "documentation":"<p>The Amazon Web Services Region where to replicate the Amazon Connect instance.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true }, "ReplicaAlias":{ "shape":"DirectoryAlias", "documentation":"<p>The alias for the replicated instance. The <code>ReplicaAlias</code> must be unique.</p>" } } }, "ReplicateInstanceResponse":{ "type":"structure", "members":{ "Id":{ "shape":"InstanceId", "documentation":"<p>The identifier of the replicated instance. You can find the <code>instanceId</code> in the ARN of the instance. The replicated instance has the same identifier as the instance it was replicated from.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the replicated instance.</p>" } } }, "ReplicationConfiguration":{ "type":"structure", "members":{ "ReplicationStatusSummaryList":{ "shape":"ReplicationStatusSummaryList", "documentation":"<p>A list of replication status summaries. The summaries contain details about the replication of configuration information for Amazon Connect resources, for each Amazon Web Services Region.</p>" }, "SourceRegion":{ "shape":"AwsRegion", "documentation":"<p>The Amazon Web Services Region where the source Amazon Connect instance was created. This is the Region where the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_ReplicateInstance.html\">ReplicateInstance</a> API was called to start the replication process.</p>" }, "GlobalSignInEndpoint":{ "shape":"GlobalSignInEndpoint", "documentation":"<p>The URL that is used to sign-in to your Amazon Connect instance according to your traffic distribution group configuration. For more information about sign-in and traffic distribution groups, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/setup-traffic-distribution-groups.html\">Important things to know</a> in the <i>Create traffic distribution groups</i> topic in the <i>Amazon Connect Administrator Guide</i>. </p>" } }, "documentation":"<p>Details about the status of the replication of a source Amazon Connect instance across Amazon Web Services Regions. Use these details to understand the general status of a given replication. For information about why a replication process may fail, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/create-replica-connect-instance.html#why-replicateinstance-fails\">Why a ReplicateInstance call fails</a> in the <i>Create a replica of your existing Amazon Connect instance</i> topic in the <i>Amazon Connect Administrator Guide</i>. </p>" }, "ReplicationStatusReason":{ "type":"string", "max":1024, "min":0 }, "ReplicationStatusSummary":{ "type":"structure", "members":{ "Region":{ "shape":"AwsRegion", "documentation":"<p>The Amazon Web Services Region. This can be either the source or the replica Region, depending where it appears in the summary list.</p>" }, "ReplicationStatus":{ "shape":"InstanceReplicationStatus", "documentation":"<p>The state of the replication.</p>" }, "ReplicationStatusReason":{ "shape":"ReplicationStatusReason", "documentation":"<p>A description of the replication status. Use this information to resolve any issues that are preventing the successful replication of your Amazon Connect instance to another Region.</p>" } }, "documentation":"<p>Status information about the replication process, where you use the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_ReplicateInstance.html\">ReplicateInstance</a> API to create a replica of your Amazon Connect instance in another Amazon Web Services Region. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/setup-connect-global-resiliency.html\">Set up Amazon Connect Global Resiliency</a> in the <i>Amazon Connect Administrator Guide</i>. </p>" }, "ReplicationStatusSummaryList":{ "type":"list", "member":{"shape":"ReplicationStatusSummary"}, "max":11, "min":0 }, "RequestIdentifier":{ "type":"string", "max":80 }, "RequiredFieldInfo":{ "type":"structure", "members":{ "Id":{ "shape":"TaskTemplateFieldIdentifier", "documentation":"<p>The unique identifier for the field.</p>" } }, "documentation":"<p>Information about a required field.</p>" }, "RequiredTaskTemplateFields":{ "type":"list", "member":{"shape":"RequiredFieldInfo"} }, "ResourceArnOrId":{ "type":"string", "max":250, "min":1 }, "ResourceConflictException":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"<p>A resource already has that name.</p>", "error":{"httpStatusCode":409}, "exception":true }, "ResourceId":{ "type":"string", "max":500, "min":1 }, "ResourceInUseException":{ "type":"structure", "members":{ "Message":{"shape":"Message"}, "ResourceType":{ "shape":"ResourceType", "documentation":"<p>The type of resource.</p>" }, "ResourceId":{ "shape":"ARN", "documentation":"<p>The identifier for the resource.</p>" } }, "documentation":"<p>That resource is already in use. Please try another.</p>", "error":{"httpStatusCode":409}, "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ "Message":{ "shape":"Message", "documentation":"<p>The message about the resource.</p>" } }, "documentation":"<p>The specified resource was not found.</p>", "error":{"httpStatusCode":404}, "exception":true }, "ResourceNotReadyException":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"<p>The resource is not ready.</p>", "error":{"httpStatusCode":409}, "exception":true }, "ResourceTagsSearchCriteria":{ "type":"structure", "members":{ "TagSearchCondition":{ "shape":"TagSearchCondition", "documentation":"<p>The search criteria to be used to return tags.</p>" } }, "documentation":"<p>The search criteria to be used to search tags.</p>" }, "ResourceType":{ "type":"string", "enum":[ "CONTACT", "CONTACT_FLOW", "INSTANCE", "PARTICIPANT", "HIERARCHY_LEVEL", "HIERARCHY_GROUP", "USER", "PHONE_NUMBER" ] }, "ResourceTypeList":{ "type":"list", "member":{"shape":"String"} }, "ResourceVersion":{ "type":"long", "min":1 }, "ResumeContactRecordingRequest":{ "type":"structure", "required":[ "InstanceId", "ContactId", "InitialContactId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact.</p>" }, "InitialContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.</p>" }, "ContactRecordingType":{ "shape":"ContactRecordingType", "documentation":"<p>The type of recording being operated on.</p>" } } }, "ResumeContactRecordingResponse":{ "type":"structure", "members":{} }, "ResumeContactRequest":{ "type":"structure", "required":[ "ContactId", "InstanceId" ], "members":{ "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact.</p>" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can find the <code>instanceId</code> in the ARN of the instance.</p>" }, "ContactFlowId":{ "shape":"ContactFlowId", "documentation":"<p>The identifier of the flow.</p>" } } }, "ResumeContactResponse":{ "type":"structure", "members":{} }, "RoutingCriteria":{ "type":"structure", "members":{ "Steps":{ "shape":"Steps", "documentation":"<p>List of routing steps. When Amazon Connect does not find an available agent meeting the requirements in a step for a given step duration, the routing criteria will move on to the next step sequentially until a join is completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue.</p>" }, "ActivationTimestamp":{ "shape":"timestamp", "documentation":"<p>The timestamp indicating when the routing criteria is set to active. A routing criteria is activated when contact is transferred to a queue. ActivationTimestamp will be set on routing criteria for contacts in agent queue even though Routing criteria is never activated for contacts in agent queue.</p>" }, "Index":{ "shape":"Index", "documentation":"<p>Information about the index of the routing criteria.</p>" } }, "documentation":"<p>Latest routing criteria on the contact.</p>" }, "RoutingCriteriaInput":{ "type":"structure", "members":{ "Steps":{ "shape":"RoutingCriteriaInputSteps", "documentation":"<p>When Amazon Connect does not find an available agent meeting the requirements in a step for&#x2028; a given step duration, the routing criteria will move on to the next step sequentially until a&#x2028; join is completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue.</p>" } }, "documentation":"<p>An object to define the RoutingCriteria.</p>" }, "RoutingCriteriaInputStep":{ "type":"structure", "members":{ "Expiry":{ "shape":"RoutingCriteriaInputStepExpiry", "documentation":"<p>An object to specify the expiration of a routing step.</p>" }, "Expression":{ "shape":"Expression", "documentation":"<p>A tagged union to specify expression for a routing step.</p>" } }, "documentation":"<p>Step defines the list of agents to be routed or route based on the agent requirements such as ProficiencyLevel, Name, or Value.</p>" }, "RoutingCriteriaInputStepExpiry":{ "type":"structure", "members":{ "DurationInSeconds":{ "shape":"DurationInSeconds", "documentation":"<p>The number of seconds that the contact will be routed only to agents matching this routing&#x2028; step, if expiry was configured for this routing step.</p>" } }, "documentation":"<p>Specify whether this routing criteria step should apply for only a limited amount of time,&#x2028; or if it should never expire.</p>" }, "RoutingCriteriaInputSteps":{ "type":"list", "member":{"shape":"RoutingCriteriaInputStep"} }, "RoutingCriteriaStepStatus":{ "type":"string", "enum":[ "ACTIVE", "INACTIVE", "JOINED", "EXPIRED" ] }, "RoutingExpression":{ "type":"string", "max":3000, "min":1 }, "RoutingExpressions":{ "type":"list", "member":{"shape":"RoutingExpression"}, "max":50 }, "RoutingProfile":{ "type":"structure", "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "Name":{ "shape":"RoutingProfileName", "documentation":"<p>The name of the routing profile.</p>" }, "RoutingProfileArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the routing profile.</p>" }, "RoutingProfileId":{ "shape":"RoutingProfileId", "documentation":"<p>The identifier of the routing profile.</p>" }, "Description":{ "shape":"RoutingProfileDescription", "documentation":"<p>The description of the routing profile.</p>" }, "MediaConcurrencies":{ "shape":"MediaConcurrencies", "documentation":"<p>The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.</p>" }, "DefaultOutboundQueueId":{ "shape":"QueueId", "documentation":"<p>The identifier of the default outbound queue for this routing profile.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" }, "NumberOfAssociatedQueues":{ "shape":"Long", "documentation":"<p>The number of associated queues in routing profile.</p>" }, "NumberOfAssociatedUsers":{ "shape":"Long", "documentation":"<p>The number of associated users in routing profile.</p>" }, "AgentAvailabilityTimer":{ "shape":"AgentAvailabilityTimer", "documentation":"<p>Whether agents with this routing profile will have their routing order calculated based on <i>time since their last inbound contact</i> or <i>longest idle time</i>. </p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when this resource was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The Amazon Web Services Region where this resource was last modified.</p>" }, "IsDefault":{ "shape":"Boolean", "documentation":"<p>Whether this a default routing profile.</p>" }, "AssociatedQueueIds":{ "shape":"AssociatedQueueIdList", "documentation":"<p>The IDs of the associated queue.</p>" } }, "documentation":"<p>Contains information about a routing profile.</p>" }, "RoutingProfileDescription":{ "type":"string", "max":250, "min":1 }, "RoutingProfileId":{"type":"string"}, "RoutingProfileList":{ "type":"list", "member":{"shape":"RoutingProfile"} }, "RoutingProfileName":{ "type":"string", "max":127, "min":1 }, "RoutingProfileQueueConfig":{ "type":"structure", "required":[ "QueueReference", "Priority", "Delay" ], "members":{ "QueueReference":{ "shape":"RoutingProfileQueueReference", "documentation":"<p>Contains information about a queue resource.</p>" }, "Priority":{ "shape":"Priority", "documentation":"<p>The order in which contacts are to be handled for the queue. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html\">Queues: priority and delay</a>.</p>", "box":true }, "Delay":{ "shape":"Delay", "documentation":"<p>The delay, in seconds, a contact should be in the queue before they are routed to an available agent. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html\">Queues: priority and delay</a> in the <i>Amazon Connect Administrator Guide</i>.</p>", "box":true } }, "documentation":"<p>Contains information about the queue and channel for which priority and delay can be set.</p>" }, "RoutingProfileQueueConfigList":{ "type":"list", "member":{"shape":"RoutingProfileQueueConfig"}, "max":10, "min":1 }, "RoutingProfileQueueConfigSummary":{ "type":"structure", "required":[ "QueueId", "QueueArn", "QueueName", "Priority", "Delay", "Channel" ], "members":{ "QueueId":{ "shape":"QueueId", "documentation":"<p>The identifier for the queue.</p>" }, "QueueArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the queue.</p>" }, "QueueName":{ "shape":"QueueName", "documentation":"<p>The name of the queue.</p>" }, "Priority":{ "shape":"Priority", "documentation":"<p>The order in which contacts are to be handled for the queue. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html\">Queues: priority and delay</a>.</p>" }, "Delay":{ "shape":"Delay", "documentation":"<p>The delay, in seconds, that a contact should be in the queue before they are routed to an available agent. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html\">Queues: priority and delay</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "Channel":{ "shape":"Channel", "documentation":"<p>The channels this queue supports.</p>" } }, "documentation":"<p>Contains summary information about a routing profile queue.</p>" }, "RoutingProfileQueueConfigSummaryList":{ "type":"list", "member":{"shape":"RoutingProfileQueueConfigSummary"} }, "RoutingProfileQueueReference":{ "type":"structure", "required":[ "QueueId", "Channel" ], "members":{ "QueueId":{ "shape":"QueueId", "documentation":"<p>The identifier for the queue.</p>" }, "Channel":{ "shape":"Channel", "documentation":"<p>The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.</p>" } }, "documentation":"<p>Contains the channel and queue identifier for a routing profile.</p>" }, "RoutingProfileQueueReferenceList":{ "type":"list", "member":{"shape":"RoutingProfileQueueReference"} }, "RoutingProfileReference":{ "type":"structure", "members":{ "Id":{ "shape":"RoutingProfileId", "documentation":"<p>The identifier of the routing profile.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the routing profile.</p>" } }, "documentation":"<p>Information about the routing profile assigned to the user.</p>" }, "RoutingProfileSearchConditionList":{ "type":"list", "member":{"shape":"RoutingProfileSearchCriteria"} }, "RoutingProfileSearchCriteria":{ "type":"structure", "members":{ "OrConditions":{ "shape":"RoutingProfileSearchConditionList", "documentation":"<p>A list of conditions which would be applied together with an OR condition.</p>" }, "AndConditions":{ "shape":"RoutingProfileSearchConditionList", "documentation":"<p>A list of conditions which would be applied together with an AND condition.</p>" }, "StringCondition":{ "shape":"StringCondition", "documentation":"<p>A leaf node condition which can be used to specify a string condition.</p> <note> <p>The currently supported values for <code>FieldName</code> are <code>associatedQueueIds</code>, <code>name</code>, <code>description</code>, and <code>resourceID</code>.</p> </note>" } }, "documentation":"<p>The search criteria to be used to return routing profiles.</p> <note> <p>The <code>name</code> and <code>description</code> fields support \"contains\" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. </p> </note>" }, "RoutingProfileSearchFilter":{ "type":"structure", "members":{ "TagFilter":{"shape":"ControlPlaneTagFilter"} }, "documentation":"<p>Filters to be applied to search results.</p>" }, "RoutingProfileSummary":{ "type":"structure", "members":{ "Id":{ "shape":"RoutingProfileId", "documentation":"<p>The identifier of the routing profile.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the routing profile.</p>" }, "Name":{ "shape":"RoutingProfileName", "documentation":"<p>The name of the routing profile.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when this resource was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The Amazon Web Services Region where this resource was last modified.</p>" } }, "documentation":"<p>Contains summary information about a routing profile.</p>" }, "RoutingProfileSummaryList":{ "type":"list", "member":{"shape":"RoutingProfileSummary"} }, "RoutingProfiles":{ "type":"list", "member":{"shape":"RoutingProfileId"}, "max":100, "min":1 }, "Rule":{ "type":"structure", "required":[ "Name", "RuleId", "RuleArn", "TriggerEventSource", "Function", "Actions", "PublishStatus", "CreatedTime", "LastUpdatedTime", "LastUpdatedBy" ], "members":{ "Name":{ "shape":"RuleName", "documentation":"<p>The name of the rule.</p>" }, "RuleId":{ "shape":"RuleId", "documentation":"<p>A unique identifier for the rule.</p>" }, "RuleArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the rule.</p>" }, "TriggerEventSource":{ "shape":"RuleTriggerEventSource", "documentation":"<p>The event source to trigger the rule.</p>" }, "Function":{ "shape":"RuleFunction", "documentation":"<p>The conditions of the rule.</p>" }, "Actions":{ "shape":"RuleActions", "documentation":"<p>A list of actions to be run when the rule is triggered.</p>" }, "PublishStatus":{ "shape":"RulePublishStatus", "documentation":"<p>The publish status of the rule.</p>" }, "CreatedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp for when the rule was created.</p>" }, "LastUpdatedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp for the when the rule was last updated.</p>" }, "LastUpdatedBy":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the user who last updated the rule.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" } }, "documentation":"<p>Information about a rule.</p>" }, "RuleAction":{ "type":"structure", "required":["ActionType"], "members":{ "ActionType":{ "shape":"ActionType", "documentation":"<p>The type of action that creates a rule.</p>" }, "TaskAction":{ "shape":"TaskActionDefinition", "documentation":"<p>Information about the task action. This field is required if <code>TriggerEventSource</code> is one of the following values: <code>OnZendeskTicketCreate</code> | <code>OnZendeskTicketStatusUpdate</code> | <code>OnSalesforceCaseCreate</code> </p>" }, "EventBridgeAction":{ "shape":"EventBridgeActionDefinition", "documentation":"<p>Information about the EventBridge action.</p> <p>Supported only for <code>TriggerEventSource</code> values: <code>OnPostCallAnalysisAvailable</code> | <code>OnRealTimeCallAnalysisAvailable</code> | <code>OnRealTimeChatAnalysisAvailable</code> | <code>OnPostChatAnalysisAvailable</code> | <code>OnContactEvaluationSubmit</code> | <code>OnMetricDataUpdate</code> </p>" }, "AssignContactCategoryAction":{ "shape":"AssignContactCategoryActionDefinition", "documentation":"<p>Information about the contact category action.</p> <p>Supported only for <code>TriggerEventSource</code> values: <code>OnPostCallAnalysisAvailable</code> | <code>OnRealTimeCallAnalysisAvailable</code> | <code>OnRealTimeChatAnalysisAvailable</code> | <code>OnPostChatAnalysisAvailable</code> | <code>OnZendeskTicketCreate</code> | <code>OnZendeskTicketStatusUpdate</code> | <code>OnSalesforceCaseCreate</code> </p>" }, "SendNotificationAction":{ "shape":"SendNotificationActionDefinition", "documentation":"<p>Information about the send notification action.</p> <p>Supported only for <code>TriggerEventSource</code> values: <code>OnPostCallAnalysisAvailable</code> | <code>OnRealTimeCallAnalysisAvailable</code> | <code>OnRealTimeChatAnalysisAvailable</code> | <code>OnPostChatAnalysisAvailable</code> | <code>OnContactEvaluationSubmit</code> | <code>OnMetricDataUpdate</code> </p>" }, "CreateCaseAction":{ "shape":"CreateCaseActionDefinition", "documentation":"<p>Information about the create case action.</p> <p>Supported only for <code>TriggerEventSource</code> values: <code>OnPostCallAnalysisAvailable</code> | <code>OnPostChatAnalysisAvailable</code>.</p>" }, "UpdateCaseAction":{ "shape":"UpdateCaseActionDefinition", "documentation":"<p>Information about the update case action.</p> <p>Supported only for <code>TriggerEventSource</code> values: <code>OnCaseCreate</code> | <code>OnCaseUpdate</code>.</p>" }, "AssignSlaAction":{ "shape":"AssignSlaActionDefinition", "documentation":"<p>Information about the assign SLA action.</p>" }, "EndAssociatedTasksAction":{ "shape":"EndAssociatedTasksActionDefinition", "documentation":"<p>Information about the end associated tasks action.</p> <p>Supported only for <code>TriggerEventSource</code> values: <code>OnCaseUpdate</code>.</p>" }, "SubmitAutoEvaluationAction":{ "shape":"SubmitAutoEvaluationActionDefinition", "documentation":"<p>Information about the submit automated evaluation action.</p>" } }, "documentation":"<p>Information about the action to be performed when a rule is triggered.</p>" }, "RuleActions":{ "type":"list", "member":{"shape":"RuleAction"} }, "RuleFunction":{"type":"string"}, "RuleId":{ "type":"string", "max":256, "min":1 }, "RuleName":{ "type":"string", "max":200, "min":1, "pattern":"^[0-9a-zA-Z._-]+" }, "RulePublishStatus":{ "type":"string", "enum":[ "DRAFT", "PUBLISHED" ] }, "RuleSummary":{ "type":"structure", "required":[ "Name", "RuleId", "RuleArn", "EventSourceName", "PublishStatus", "ActionSummaries", "CreatedTime", "LastUpdatedTime" ], "members":{ "Name":{ "shape":"RuleName", "documentation":"<p>The name of the rule.</p>" }, "RuleId":{ "shape":"RuleId", "documentation":"<p>A unique identifier for the rule.</p>" }, "RuleArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the rule.</p>" }, "EventSourceName":{ "shape":"EventSourceName", "documentation":"<p>The name of the event source.</p>" }, "PublishStatus":{ "shape":"RulePublishStatus", "documentation":"<p>The publish status of the rule.</p>" }, "ActionSummaries":{ "shape":"ActionSummaries", "documentation":"<p>A list of ActionTypes associated with a rule. </p>" }, "CreatedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp for when the rule was created. </p>" }, "LastUpdatedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp for when the rule was last updated.</p>" } }, "documentation":"<p>A list of <code>ActionTypes</code> associated with a rule. </p>" }, "RuleSummaryList":{ "type":"list", "member":{"shape":"RuleSummary"} }, "RuleTriggerEventSource":{ "type":"structure", "required":["EventSourceName"], "members":{ "EventSourceName":{ "shape":"EventSourceName", "documentation":"<p>The name of the event source.</p>" }, "IntegrationAssociationId":{ "shape":"IntegrationAssociationId", "documentation":"<p>The identifier for the integration association.</p>" } }, "documentation":"<p>The name of the event source. This field is required if <code>TriggerEventSource</code> is one of the following values: <code>OnZendeskTicketCreate</code> | <code>OnZendeskTicketStatusUpdate</code> | <code>OnSalesforceCaseCreate</code> | <code>OnContactEvaluationSubmit</code> | <code>OnMetricDataUpdate</code>.</p>" }, "S3Config":{ "type":"structure", "required":[ "BucketName", "BucketPrefix" ], "members":{ "BucketName":{ "shape":"BucketName", "documentation":"<p>The S3 bucket name.</p>" }, "BucketPrefix":{ "shape":"Prefix", "documentation":"<p>The S3 bucket prefix.</p>" }, "EncryptionConfig":{ "shape":"EncryptionConfig", "documentation":"<p>The Amazon S3 encryption configuration.</p>" } }, "documentation":"<p>Information about the Amazon Simple Storage Service (Amazon S3) storage type.</p>" }, "S3Uri":{ "type":"string", "max":2000, "min":1, "pattern":"s3://\\S+/.+|https://\\\\S+\\\\.s3\\\\.\\\\S+\\\\.amazonaws\\\\.com/\\\\S+" }, "ScreenShareCapability":{ "type":"string", "enum":["SEND"] }, "SearchAgentStatusesRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>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.</p>" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true }, "SearchFilter":{ "shape":"AgentStatusSearchFilter", "documentation":"<p>Filters to be applied to search results.</p>" }, "SearchCriteria":{ "shape":"AgentStatusSearchCriteria", "documentation":"<p>The search criteria to be used to return agent statuses.</p>" } } }, "SearchAgentStatusesResponse":{ "type":"structure", "members":{ "AgentStatuses":{ "shape":"AgentStatusList", "documentation":"<p>The search criteria to be used to return agent statuses.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" }, "ApproximateTotalCount":{ "shape":"ApproximateTotalCount", "documentation":"<p>The total number of agent statuses which matched your search query.</p>" } } }, "SearchAvailablePhoneNumbersRequest":{ "type":"structure", "required":[ "PhoneNumberCountryCode", "PhoneNumberType" ], "members":{ "TargetArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance that phone numbers are claimed to. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>" }, "PhoneNumberCountryCode":{ "shape":"PhoneNumberCountryCode", "documentation":"<p>The ISO country code.</p>" }, "PhoneNumberType":{ "shape":"PhoneNumberType", "documentation":"<p>The type of phone number.</p>" }, "PhoneNumberPrefix":{ "shape":"PhoneNumberPrefix", "documentation":"<p>The prefix of the phone number. If provided, it must contain <code>+</code> as part of the country code.</p>" }, "MaxResults":{ "shape":"MaxResult10", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true }, "NextToken":{ "shape":"LargeNextToken", "documentation":"<p>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.</p>" } } }, "SearchAvailablePhoneNumbersResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"LargeNextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" }, "AvailableNumbersList":{ "shape":"AvailableNumbersList", "documentation":"<p>A list of available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.</p>" } } }, "SearchContactFlowModulesRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>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.</p>" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true }, "SearchFilter":{ "shape":"ContactFlowModuleSearchFilter", "documentation":"<p>Filters to be applied to search results.</p>" }, "SearchCriteria":{ "shape":"ContactFlowModuleSearchCriteria", "documentation":"<p>The search criteria to be used to return flow modules.</p> <note> <p>The <code>name</code> and <code>description</code> fields support \"contains\" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results.</p> </note>" } } }, "SearchContactFlowModulesResponse":{ "type":"structure", "members":{ "ContactFlowModules":{ "shape":"ContactFlowModuleSearchSummaryList", "documentation":"<p>The search criteria to be used to return flow modules.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" }, "ApproximateTotalCount":{ "shape":"ApproximateTotalCount", "documentation":"<p>The total number of flows which matched your search query.</p>" } } }, "SearchContactFlowsRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>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.</p>" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true }, "SearchFilter":{ "shape":"ContactFlowSearchFilter", "documentation":"<p>Filters to be applied to search results.</p>" }, "SearchCriteria":{ "shape":"ContactFlowSearchCriteria", "documentation":"<p>The search criteria to be used to return flows.</p> <note> <p>The <code>name</code> and <code>description</code> fields support \"contains\" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results.</p> </note>" } } }, "SearchContactFlowsResponse":{ "type":"structure", "members":{ "ContactFlows":{ "shape":"ContactFlowSearchSummaryList", "documentation":"<p>Information about the flows.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" }, "ApproximateTotalCount":{ "shape":"ApproximateTotalCount", "documentation":"<p>The total number of flows which matched your search query.</p>" } } }, "SearchContactsMatchType":{ "type":"string", "enum":[ "MATCH_ALL", "MATCH_ANY" ] }, "SearchContactsRequest":{ "type":"structure", "required":[ "InstanceId", "TimeRange" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</p>" }, "TimeRange":{ "shape":"SearchContactsTimeRange", "documentation":"<p>Time range that you want to search results.</p>" }, "SearchCriteria":{ "shape":"SearchCriteria", "documentation":"<p>The search criteria to be used to return contacts.</p>" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true }, "NextToken":{ "shape":"LargeNextToken", "documentation":"<p>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.</p>" }, "Sort":{ "shape":"Sort", "documentation":"<p>Specifies a field to sort by and a sort order.</p>" } } }, "SearchContactsResponse":{ "type":"structure", "required":["Contacts"], "members":{ "Contacts":{ "shape":"Contacts", "documentation":"<p>Information about the contacts.</p>" }, "NextToken":{ "shape":"LargeNextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" }, "TotalCount":{ "shape":"TotalCount", "documentation":"<p>The total number of contacts which matched your search query.</p>" } } }, "SearchContactsTimeRange":{ "type":"structure", "required":[ "Type", "StartTime", "EndTime" ], "members":{ "Type":{ "shape":"SearchContactsTimeRangeType", "documentation":"<p>The type of timestamp to search.</p>" }, "StartTime":{ "shape":"Timestamp", "documentation":"<p>The start time of the time range.</p>" }, "EndTime":{ "shape":"Timestamp", "documentation":"<p>The end time of the time range.</p>" } }, "documentation":"<p>A structure of time range that you want to search results.</p>" }, "SearchContactsTimeRangeType":{ "type":"string", "enum":[ "INITIATION_TIMESTAMP", "SCHEDULED_TIMESTAMP", "CONNECTED_TO_AGENT_TIMESTAMP", "DISCONNECT_TIMESTAMP" ] }, "SearchCriteria":{ "type":"structure", "members":{ "AgentIds":{ "shape":"AgentResourceIdList", "documentation":"<p>The identifiers of agents who handled the contacts.</p>" }, "AgentHierarchyGroups":{ "shape":"AgentHierarchyGroups", "documentation":"<p>The agent hierarchy groups of the agent at the time of handling the contact.</p>" }, "Channels":{ "shape":"ChannelList", "documentation":"<p>The list of channels associated with contacts.</p>" }, "ContactAnalysis":{ "shape":"ContactAnalysis", "documentation":"<p>Search criteria based on analysis outputs from Amazon Connect Contact Lens.</p>" }, "InitiationMethods":{ "shape":"InitiationMethodList", "documentation":"<p>The list of initiation methods associated with contacts.</p>" }, "QueueIds":{ "shape":"QueueIdList", "documentation":"<p>The list of queue IDs associated with contacts.</p>" }, "SearchableContactAttributes":{ "shape":"SearchableContactAttributes", "documentation":"<p>The search criteria based on user-defined contact attributes that have been configured for contact search. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/search-custom-attributes.html\">Search by custom contact attributes</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <important> <p>To use <code>SearchableContactAttributes</code> in a search request, the <code>GetContactAttributes</code> action is required to perform an API request. For more information, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissions\">https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissions</a>Actions defined by Amazon Connect.</p> </important>" }, "SearchableSegmentAttributes":{ "shape":"SearchableSegmentAttributes", "documentation":"<p>The search criteria based on searchable segment attributes of a contact.</p>" } }, "documentation":"<p>A structure of search criteria to be used to return contacts.</p>" }, "SearchEmailAddressesRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>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.</p>" }, "SearchCriteria":{ "shape":"EmailAddressSearchCriteria", "documentation":"<p>The search criteria to be used to return email addresses.</p>" }, "SearchFilter":{ "shape":"EmailAddressSearchFilter", "documentation":"<p>Filters to be applied to search results.</p>" } } }, "SearchEmailAddressesResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" }, "EmailAddresses":{ "shape":"EmailAddressList", "documentation":"<p>List of email addresses matching SearchFilter and SearchCriteria </p>" }, "ApproximateTotalCount":{ "shape":"ApproximateTotalCount", "documentation":"<p>The total number of email addresses which matched your search query.</p>" } } }, "SearchHoursOfOperationOverridesRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>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 2500.</p>" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page. Valid Range: Minimum value of 1. Maximum value of 100.</p>", "box":true }, "SearchFilter":{"shape":"HoursOfOperationSearchFilter"}, "SearchCriteria":{ "shape":"HoursOfOperationOverrideSearchCriteria", "documentation":"<p>The search criteria to be used to return hours of operations overrides.</p>" } } }, "SearchHoursOfOperationOverridesResponse":{ "type":"structure", "members":{ "HoursOfOperationOverrides":{ "shape":"HoursOfOperationOverrideList", "documentation":"<p>Information about the hours of operations overrides.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>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 2500.</p>" }, "ApproximateTotalCount":{ "shape":"ApproximateTotalCount", "documentation":"<p>The total number of hours of operations which matched your search query.</p>" } } }, "SearchHoursOfOperationsRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>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.</p>" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true }, "SearchFilter":{ "shape":"HoursOfOperationSearchFilter", "documentation":"<p>Filters to be applied to search results.</p>" }, "SearchCriteria":{ "shape":"HoursOfOperationSearchCriteria", "documentation":"<p>The search criteria to be used to return hours of operations.</p>" } } }, "SearchHoursOfOperationsResponse":{ "type":"structure", "members":{ "HoursOfOperations":{ "shape":"HoursOfOperationList", "documentation":"<p>Information about the hours of operations.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" }, "ApproximateTotalCount":{ "shape":"ApproximateTotalCount", "documentation":"<p>The total number of hours of operations which matched your search query.</p>" } } }, "SearchPredefinedAttributesRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>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.</p>" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true }, "SearchCriteria":{ "shape":"PredefinedAttributeSearchCriteria", "documentation":"<p>The search criteria to be used to return predefined attributes.</p>" } } }, "SearchPredefinedAttributesResponse":{ "type":"structure", "members":{ "PredefinedAttributes":{ "shape":"PredefinedAttributeSearchSummaryList", "documentation":"<p>Predefined attributes matched by the search criteria.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>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.</p>" }, "ApproximateTotalCount":{ "shape":"ApproximateTotalCount", "documentation":"<p>The approximate number of predefined attributes which matched your search query.</p>" } } }, "SearchPromptsRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>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.</p>" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true }, "SearchFilter":{ "shape":"PromptSearchFilter", "documentation":"<p>Filters to be applied to search results.</p>" }, "SearchCriteria":{ "shape":"PromptSearchCriteria", "documentation":"<p>The search criteria to be used to return prompts.</p>" } } }, "SearchPromptsResponse":{ "type":"structure", "members":{ "Prompts":{ "shape":"PromptList", "documentation":"<p>Information about the prompts.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" }, "ApproximateTotalCount":{ "shape":"ApproximateTotalCount", "documentation":"<p>The total number of quick connects which matched your search query.</p>" } } }, "SearchQueuesRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>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.</p>" }, "MaxResults":{ "shape":"MaxResult500", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true }, "SearchFilter":{ "shape":"QueueSearchFilter", "documentation":"<p>Filters to be applied to search results.</p>" }, "SearchCriteria":{ "shape":"QueueSearchCriteria", "documentation":"<p>The search criteria to be used to return queues.</p> <note> <p>The <code>name</code> and <code>description</code> fields support \"contains\" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. </p> </note>" } } }, "SearchQueuesResponse":{ "type":"structure", "members":{ "Queues":{ "shape":"QueueSearchSummaryList", "documentation":"<p>Information about the queues.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" }, "ApproximateTotalCount":{ "shape":"ApproximateTotalCount", "documentation":"<p>The total number of queues which matched your search query.</p>" } } }, "SearchQuickConnectsRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>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.</p>" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true }, "SearchFilter":{ "shape":"QuickConnectSearchFilter", "documentation":"<p>Filters to be applied to search results.</p>" }, "SearchCriteria":{ "shape":"QuickConnectSearchCriteria", "documentation":"<p>The search criteria to be used to return quick connects.</p>" } } }, "SearchQuickConnectsResponse":{ "type":"structure", "members":{ "QuickConnects":{ "shape":"QuickConnectSearchSummaryList", "documentation":"<p>Information about the quick connects.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" }, "ApproximateTotalCount":{ "shape":"ApproximateTotalCount", "documentation":"<p>The total number of quick connects which matched your search query.</p>" } } }, "SearchResourceTagsRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceIdOrArn", "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instanceId in the Amazon Resource Name (ARN) of the instance.</p>" }, "ResourceTypes":{ "shape":"ResourceTypeList", "documentation":"<p>The list of resource types to be used to search tags from. If not provided or if any empty list is provided, this API will search from all supported resource types. Note that lowercase and - are required.</p> <p class=\"title\"> <b>Supported resource types</b> </p> <ul> <li> <p>agent</p> </li> <li> <p>agent-state</p> </li> <li> <p>routing-profile</p> </li> <li> <p>standard-queue</p> </li> <li> <p>security-profile</p> </li> <li> <p>operating-hours</p> </li> <li> <p>prompt</p> </li> <li> <p>contact-flow</p> </li> <li> <p>flow- module</p> </li> <li> <p>transfer-destination (also known as quick connect)</p> </li> </ul>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>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.</p>" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true }, "SearchCriteria":{ "shape":"ResourceTagsSearchCriteria", "documentation":"<p>The search criteria to be used to return tags.</p>" } } }, "SearchResourceTagsResponse":{ "type":"structure", "members":{ "Tags":{ "shape":"TagsList", "documentation":"<p>A list of tags used in the Amazon Connect instance.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "SearchRoutingProfilesRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>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.</p>" }, "MaxResults":{ "shape":"MaxResult500", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true }, "SearchFilter":{ "shape":"RoutingProfileSearchFilter", "documentation":"<p>Filters to be applied to search results.</p>" }, "SearchCriteria":{ "shape":"RoutingProfileSearchCriteria", "documentation":"<p>The search criteria to be used to return routing profiles.</p> <note> <p>The <code>name</code> and <code>description</code> fields support \"contains\" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. </p> </note>" } } }, "SearchRoutingProfilesResponse":{ "type":"structure", "members":{ "RoutingProfiles":{ "shape":"RoutingProfileList", "documentation":"<p>Information about the routing profiles.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" }, "ApproximateTotalCount":{ "shape":"ApproximateTotalCount", "documentation":"<p>The total number of routing profiles which matched your search query.</p>" } } }, "SearchSecurityProfilesRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>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.</p>" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true }, "SearchCriteria":{ "shape":"SecurityProfileSearchCriteria", "documentation":"<p>The search criteria to be used to return security profiles. </p> <note> <p>The <code>name</code> field support \"contains\" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.</p> </note> <note> <p>The currently supported value for <code>FieldName</code>: <code>name</code> </p> </note>" }, "SearchFilter":{ "shape":"SecurityProfilesSearchFilter", "documentation":"<p>Filters to be applied to search results.</p>" } } }, "SearchSecurityProfilesResponse":{ "type":"structure", "members":{ "SecurityProfiles":{ "shape":"SecurityProfilesSearchSummaryList", "documentation":"<p>Information about the security profiles.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" }, "ApproximateTotalCount":{ "shape":"ApproximateTotalCount", "documentation":"<p>The total number of security profiles which matched your search query.</p>" } } }, "SearchText":{ "type":"string", "max":128, "sensitive":true }, "SearchTextList":{ "type":"list", "member":{"shape":"SearchText"}, "max":100, "min":0 }, "SearchUserHierarchyGroupsRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>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.</p>" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true }, "SearchFilter":{ "shape":"UserHierarchyGroupSearchFilter", "documentation":"<p>Filters to be applied to search results.</p>" }, "SearchCriteria":{ "shape":"UserHierarchyGroupSearchCriteria", "documentation":"<p>The search criteria to be used to return UserHierarchyGroups.</p>" } } }, "SearchUserHierarchyGroupsResponse":{ "type":"structure", "members":{ "UserHierarchyGroups":{ "shape":"UserHierarchyGroupList", "documentation":"<p>Information about the userHierarchyGroups.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" }, "ApproximateTotalCount":{ "shape":"ApproximateTotalCount", "documentation":"<p>The total number of userHierarchyGroups which matched your search query.</p>" } } }, "SearchUsersRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>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.</p>" }, "MaxResults":{ "shape":"MaxResult500", "documentation":"<p>The maximum number of results to return per page.</p>", "box":true }, "SearchFilter":{ "shape":"UserSearchFilter", "documentation":"<p>Filters to be applied to search results.</p>" }, "SearchCriteria":{"shape":"UserSearchCriteria"} } }, "SearchUsersResponse":{ "type":"structure", "members":{ "Users":{ "shape":"UserSearchSummaryList", "documentation":"<p>Information about the users.</p>" }, "NextToken":{ "shape":"NextToken2500", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" }, "ApproximateTotalCount":{ "shape":"ApproximateTotalCount", "documentation":"<p>The total number of users who matched your search query.</p>" } } }, "SearchVocabulariesRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "MaxResults":{ "shape":"MaxResult100", "documentation":"<p>The maximum number of results to return per page.</p>" }, "NextToken":{ "shape":"VocabularyNextToken", "documentation":"<p>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.</p>" }, "State":{ "shape":"VocabularyState", "documentation":"<p>The current state of the custom vocabulary.</p>" }, "NameStartsWith":{ "shape":"VocabularyName", "documentation":"<p>The starting pattern of the name of the vocabulary.</p>" }, "LanguageCode":{ "shape":"VocabularyLanguageCode", "documentation":"<p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html\">What is Amazon Transcribe?</a> </p>" } } }, "SearchVocabulariesResponse":{ "type":"structure", "members":{ "VocabularySummaryList":{ "shape":"VocabularySummaryList", "documentation":"<p>The list of the available custom vocabularies.</p>" }, "NextToken":{ "shape":"VocabularyNextToken", "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" } } }, "SearchableContactAttributeKey":{ "type":"string", "max":100, "min":1, "sensitive":true }, "SearchableContactAttributeValue":{ "type":"string", "max":100, "min":0, "sensitive":true }, "SearchableContactAttributeValueList":{ "type":"list", "member":{"shape":"SearchableContactAttributeValue"}, "max":20, "min":0 }, "SearchableContactAttributes":{ "type":"structure", "required":["Criteria"], "members":{ "Criteria":{ "shape":"SearchableContactAttributesCriteriaList", "documentation":"<p>The list of criteria based on user-defined contact attributes that are configured for contact search.</p>" }, "MatchType":{ "shape":"SearchContactsMatchType", "documentation":"<p>The match type combining search criteria using multiple searchable contact attributes.</p>" } }, "documentation":"<p>A structure that defines search criteria based on user-defined contact attributes that are configured for contact search.</p>" }, "SearchableContactAttributesCriteria":{ "type":"structure", "required":[ "Key", "Values" ], "members":{ "Key":{ "shape":"SearchableContactAttributeKey", "documentation":"<p>The key containing a searchable user-defined contact attribute.</p>" }, "Values":{ "shape":"SearchableContactAttributeValueList", "documentation":"<p>The list of values to search for within a user-defined contact attribute.</p>" } }, "documentation":"<p>The search criteria based on user-defined contact attribute key and values to search on.</p>" }, "SearchableContactAttributesCriteriaList":{ "type":"list", "member":{"shape":"SearchableContactAttributesCriteria"}, "max":15, "min":0 }, "SearchableQueueType":{ "type":"string", "enum":["STANDARD"] }, "SearchableSegmentAttributeKey":{ "type":"string", "max":64, "min":1, "sensitive":true }, "SearchableSegmentAttributeValue":{ "type":"string", "max":128, "min":0, "sensitive":true }, "SearchableSegmentAttributeValueList":{ "type":"list", "member":{"shape":"SearchableSegmentAttributeValue"}, "max":20, "min":1, "sensitive":true }, "SearchableSegmentAttributes":{ "type":"structure", "required":["Criteria"], "members":{ "Criteria":{ "shape":"SearchableSegmentAttributesCriteriaList", "documentation":"<p>The list of criteria based on searchable segment attributes.</p>" }, "MatchType":{ "shape":"SearchContactsMatchType", "documentation":"<p>The match type combining search criteria using multiple searchable segment attributes.</p>" } }, "documentation":"<p>The search criteria based on searchable segment attributes of a contact</p>" }, "SearchableSegmentAttributesCriteria":{ "type":"structure", "required":[ "Key", "Values" ], "members":{ "Key":{ "shape":"SearchableSegmentAttributeKey", "documentation":"<p>The key containing a searchable segment attribute.</p>" }, "Values":{ "shape":"SearchableSegmentAttributeValueList", "documentation":"<p>The list of values to search for within a searchable segment attribute.</p>" } }, "documentation":"<p>The search criteria based on searchable segment attribute key and values to search on.</p>" }, "SearchableSegmentAttributesCriteriaList":{ "type":"list", "member":{"shape":"SearchableSegmentAttributesCriteria"}, "max":15, "min":1 }, "SecurityKey":{ "type":"structure", "members":{ "AssociationId":{ "shape":"AssociationId", "documentation":"<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>" }, "Key":{ "shape":"PEM", "documentation":"<p>The key of the security key.</p>" }, "CreationTime":{ "shape":"timestamp", "documentation":"<p>When the security key was created.</p>" } }, "documentation":"<p>Configuration information of the security key.</p>" }, "SecurityKeysList":{ "type":"list", "member":{"shape":"SecurityKey"} }, "SecurityProfile":{ "type":"structure", "members":{ "Id":{ "shape":"SecurityProfileId", "documentation":"<p>The identifier for the security profile.</p>" }, "OrganizationResourceId":{ "shape":"InstanceId", "documentation":"<p>The organization resource identifier for the security profile.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the security profile.</p>" }, "SecurityProfileName":{ "shape":"SecurityProfileName", "documentation":"<p>The name for the security profile.</p>" }, "Description":{ "shape":"SecurityProfileDescription", "documentation":"<p>The description of the security profile.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" }, "AllowedAccessControlTags":{ "shape":"AllowedAccessControlTags", "documentation":"<p>The list of tags that a security profile uses to restrict access to resources in Amazon Connect.</p>" }, "TagRestrictedResources":{ "shape":"TagRestrictedResourceList", "documentation":"<p>The list of resources that a security profile applies tag restrictions to in Amazon Connect.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when this resource was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The Amazon Web Services Region where this resource was last modified.</p>" }, "HierarchyRestrictedResources":{ "shape":"HierarchyRestrictedResourceList", "documentation":"<p>The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: <code>User</code>.</p>" }, "AllowedAccessControlHierarchyGroupId":{ "shape":"HierarchyGroupId", "documentation":"<p>The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.</p>" } }, "documentation":"<p>Contains information about a security profile.</p>" }, "SecurityProfileDescription":{ "type":"string", "max":250 }, "SecurityProfileId":{"type":"string"}, "SecurityProfileIds":{ "type":"list", "member":{"shape":"SecurityProfileId"}, "max":10, "min":1 }, "SecurityProfileName":{"type":"string"}, "SecurityProfilePermission":{ "type":"string", "max":128, "min":1 }, "SecurityProfilePolicyKey":{ "type":"string", "max":128, "min":1 }, "SecurityProfilePolicyValue":{ "type":"string", "max":256 }, "SecurityProfileSearchConditionList":{ "type":"list", "member":{"shape":"SecurityProfileSearchCriteria"} }, "SecurityProfileSearchCriteria":{ "type":"structure", "members":{ "OrConditions":{ "shape":"SecurityProfileSearchConditionList", "documentation":"<p>A list of conditions which would be applied together with an OR condition.</p>" }, "AndConditions":{ "shape":"SecurityProfileSearchConditionList", "documentation":"<p>A list of conditions which would be applied together with an AND condition.</p>" }, "StringCondition":{"shape":"StringCondition"} }, "documentation":"<p>The search criteria to be used to return security profiles.</p> <note> <p>The <code>name</code> field support \"contains\" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.</p> </note>" }, "SecurityProfileSearchSummary":{ "type":"structure", "members":{ "Id":{ "shape":"SecurityProfileId", "documentation":"<p>The identifier of the security profile.</p>" }, "OrganizationResourceId":{ "shape":"InstanceId", "documentation":"<p>The organization resource identifier.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the security profile.</p>" }, "SecurityProfileName":{ "shape":"SecurityProfileName", "documentation":"<p>The name of the security profile.</p>" }, "Description":{ "shape":"SecurityProfileDescription", "documentation":"<p>The description of the security profile.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" } }, "documentation":"<p>Information about the returned security profiles.</p>" }, "SecurityProfileSummary":{ "type":"structure", "members":{ "Id":{ "shape":"SecurityProfileId", "documentation":"<p>The identifier of the security profile.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the security profile.</p>" }, "Name":{ "shape":"SecurityProfileName", "documentation":"<p>The name of the security profile.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when this resource was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The Amazon Web Services Region where this resource was last modified.</p>" } }, "documentation":"<p>Contains information about a security profile.</p>" }, "SecurityProfileSummaryList":{ "type":"list", "member":{"shape":"SecurityProfileSummary"} }, "SecurityProfilesSearchFilter":{ "type":"structure", "members":{ "TagFilter":{"shape":"ControlPlaneTagFilter"} }, "documentation":"<p>Filters to be applied to search results.</p>" }, "SecurityProfilesSearchSummaryList":{ "type":"list", "member":{"shape":"SecurityProfileSearchSummary"} }, "SecurityToken":{ "type":"string", "sensitive":true }, "SegmentAttributeName":{ "type":"string", "max":128, "min":1 }, "SegmentAttributeValue":{ "type":"structure", "members":{ "ValueString":{ "shape":"SegmentAttributeValueString", "documentation":"<p>The value of a segment attribute.</p>" }, "ValueMap":{ "shape":"SegmentAttributeValueMap", "documentation":"<p>The value of a segment attribute.</p>" }, "ValueInteger":{ "shape":"SegmentAttributeValueInteger", "documentation":"<p>The value of a segment attribute.</p>" } }, "documentation":"<p>A value for a segment attribute. This is structured as a map where the key is <code>valueString</code> and the value is a string.</p>" }, "SegmentAttributeValueInteger":{"type":"integer"}, "SegmentAttributeValueMap":{ "type":"map", "key":{"shape":"SegmentAttributeName"}, "value":{"shape":"SegmentAttributeValue"} }, "SegmentAttributeValueString":{ "type":"string", "max":1024, "min":0 }, "SegmentAttributes":{ "type":"map", "key":{"shape":"SegmentAttributeName"}, "value":{"shape":"SegmentAttributeValue"} }, "SendChatIntegrationEventRequest":{ "type":"structure", "required":[ "SourceId", "DestinationId", "Event" ], "members":{ "SourceId":{ "shape":"SourceId", "documentation":"<p>External identifier of chat customer participant, used in part to uniquely identify a chat. For SMS, this is the E164 phone number of the chat customer participant.</p>" }, "DestinationId":{ "shape":"DestinationId", "documentation":"<p>Chat system identifier, used in part to uniquely identify chat. This is associated with the Amazon Connect instance and flow to be used to start chats. For Server Migration Service, this is the phone number destination of inbound Server Migration Service messages represented by an Amazon Web Services End User Messaging phone number ARN.</p>" }, "Subtype":{ "shape":"Subtype", "documentation":"<p>Classification of a channel. This is used in part to uniquely identify chat. </p> <p>Valid value: <code>[\"connect:sms\", connect:\"WhatsApp\"]</code> </p>" }, "Event":{ "shape":"ChatEvent", "documentation":"<p>Chat integration event payload</p>" }, "NewSessionDetails":{ "shape":"NewSessionDetails", "documentation":"<p>Contact properties to apply when starting a new chat. If the integration event is handled with an existing chat, this is ignored.</p>" } } }, "SendChatIntegrationEventResponse":{ "type":"structure", "members":{ "InitialContactId":{ "shape":"ContactId", "documentation":"<p>Identifier of chat contact used to handle integration event. This may be null if the integration event is not valid without an already existing chat contact.</p>" }, "NewChatCreated":{ "shape":"NewChatCreated", "documentation":"<p>Whether handling the integration event resulted in creating a new chat or acting on existing chat.</p>" } } }, "SendNotificationActionDefinition":{ "type":"structure", "required":[ "DeliveryMethod", "Content", "ContentType", "Recipient" ], "members":{ "DeliveryMethod":{ "shape":"NotificationDeliveryType", "documentation":"<p>Notification delivery method.</p>" }, "Subject":{ "shape":"Subject", "documentation":"<p>The subject of the email if the delivery method is <code>EMAIL</code>. Supports variable injection. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html\">JSONPath reference</a> in the <i>Amazon Connect Administrators Guide</i>.</p>" }, "Content":{ "shape":"Content", "documentation":"<p>Notification content. Supports variable injection. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html\">JSONPath reference</a> in the <i>Amazon Connect Administrators Guide</i>.</p>" }, "ContentType":{ "shape":"NotificationContentType", "documentation":"<p>Content type format.</p>" }, "Recipient":{ "shape":"NotificationRecipientType", "documentation":"<p>Notification recipient.</p>" } }, "documentation":"<p>Information about the send notification action.</p>" }, "SendOutboundEmailRequest":{ "type":"structure", "required":[ "InstanceId", "FromEmailAddress", "DestinationEmailAddress", "EmailMessage", "TrafficType" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "FromEmailAddress":{ "shape":"EmailAddressInfo", "documentation":"<p>The email address to be used for sending email.</p>" }, "DestinationEmailAddress":{ "shape":"EmailAddressInfo", "documentation":"<p>The email address to send the email to.</p>" }, "AdditionalRecipients":{ "shape":"OutboundAdditionalRecipients", "documentation":"<p>The additional recipients address of the email in CC.</p>" }, "EmailMessage":{ "shape":"OutboundEmailContent", "documentation":"<p>The email message body to be sent to the newly created email.</p>" }, "TrafficType":{ "shape":"TrafficType", "documentation":"<p>Denotes the class of traffic.</p> <note> <p>Only the CAMPAIGN traffic type is supported.</p> </note>" }, "SourceCampaign":{ "shape":"SourceCampaign", "documentation":"<p>A Campaign object need for Campaign traffic type.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true } } }, "SendOutboundEmailResponse":{ "type":"structure", "members":{} }, "ServiceQuotaExceededException":{ "type":"structure", "members":{ "Message":{"shape":"Message"}, "Reason":{"shape":"ServiceQuotaExceededExceptionReason"} }, "documentation":"<p>The service quota has been exceeded.</p>", "error":{"httpStatusCode":402}, "exception":true }, "ServiceQuotaExceededExceptionReason":{ "type":"structure", "members":{ "AttachedFileServiceQuotaExceededExceptionReason":{ "shape":"AttachedFileServiceQuotaExceededExceptionReason", "documentation":"<p>Total file size of all files or total number of files exceeds the service quota</p>" } }, "documentation":"<p>The reason for the exception.</p>", "union":true }, "SignInConfig":{ "type":"structure", "required":["Distributions"], "members":{ "Distributions":{ "shape":"SignInDistributionList", "documentation":"<p>Information about traffic distributions.</p>" } }, "documentation":"<p>The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s).</p>" }, "SignInDistribution":{ "type":"structure", "required":[ "Region", "Enabled" ], "members":{ "Region":{ "shape":"AwsRegion", "documentation":"<p>The Amazon Web Services Region of the sign in distribution.</p>" }, "Enabled":{ "shape":"Boolean", "documentation":"<p>Whether sign in distribution is enabled.</p>" } }, "documentation":"<p>The distribution of sign in traffic between the instance and its replica(s).</p>" }, "SignInDistributionList":{ "type":"list", "member":{"shape":"SignInDistribution"} }, "SingleSelectOptions":{ "type":"list", "member":{"shape":"TaskTemplateSingleSelectOption"} }, "SingleSelectQuestionRuleCategoryAutomation":{ "type":"structure", "required":[ "Category", "Condition", "OptionRefId" ], "members":{ "Category":{ "shape":"SingleSelectQuestionRuleCategoryAutomationLabel", "documentation":"<p> The category name, as defined in Rules.</p>" }, "Condition":{ "shape":"SingleSelectQuestionRuleCategoryAutomationCondition", "documentation":"<p>The condition to apply for the automation option. If the condition is <code>PRESENT</code>, then the option is applied when the contact data includes the category. Similarly, if the condition is <code>NOT_PRESENT</code>, then the option is applied when the contact data does not include the category.</p>" }, "OptionRefId":{ "shape":"ReferenceId", "documentation":"<p>The identifier of the answer option.</p>" } }, "documentation":"<p>Information about the automation option based on a rule category for a single select question.</p>" }, "SingleSelectQuestionRuleCategoryAutomationCondition":{ "type":"string", "enum":[ "PRESENT", "NOT_PRESENT" ] }, "SingleSelectQuestionRuleCategoryAutomationLabel":{ "type":"string", "max":50, "min":1 }, "SlaAssignmentType":{ "type":"string", "enum":["CASES"] }, "SlaFieldValueUnionList":{ "type":"list", "member":{"shape":"FieldValueUnion"}, "max":1 }, "SlaName":{ "type":"string", "max":500, "min":1, "pattern":"^.*[\\S]$" }, "SlaType":{ "type":"string", "enum":["CaseField"] }, "SnapshotVersion":{"type":"string"}, "Sort":{ "type":"structure", "required":[ "FieldName", "Order" ], "members":{ "FieldName":{ "shape":"SortableFieldName", "documentation":"<p>The name of the field on which to sort.</p>" }, "Order":{ "shape":"SortOrder", "documentation":"<p>An ascending or descending sort.</p>" } }, "documentation":"<p>A structure that defines the field name to sort by and a sort order.</p>" }, "SortOrder":{ "type":"string", "enum":[ "ASCENDING", "DESCENDING" ] }, "SortableFieldName":{ "type":"string", "enum":[ "INITIATION_TIMESTAMP", "SCHEDULED_TIMESTAMP", "CONNECTED_TO_AGENT_TIMESTAMP", "DISCONNECT_TIMESTAMP", "INITIATION_METHOD", "CHANNEL" ] }, "SourceApplicationName":{ "type":"string", "max":100, "min":1, "pattern":"^[a-zA-Z0-9_ -]+$" }, "SourceCampaign":{ "type":"structure", "members":{ "CampaignId":{ "shape":"CampaignId", "documentation":"<p>A unique identifier for a campaign.</p>" }, "OutboundRequestId":{ "shape":"OutboundRequestId", "documentation":"<p>A unique identifier for a each request part of same campaign.</p>" } }, "documentation":"<p>Information about the campaign.</p>" }, "SourceId":{ "type":"string", "max":255, "min":1 }, "SourceType":{ "type":"string", "enum":[ "SALESFORCE", "ZENDESK", "CASES" ] }, "StartAttachedFileUploadRequest":{ "type":"structure", "required":[ "InstanceId", "FileName", "FileSizeInBytes", "FileUseCaseType", "AssociatedResourceArn" ], "members":{ "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The unique identifier of the Amazon Connect instance.</p>", "location":"uri", "locationName":"InstanceId" }, "FileName":{ "shape":"FileName", "documentation":"<p>A case-sensitive name of the attached file being uploaded.</p>" }, "FileSizeInBytes":{ "shape":"FileSizeInBytes", "documentation":"<p>The size of the attached file in bytes.</p>", "box":true }, "UrlExpiryInSeconds":{ "shape":"URLExpiryInSeconds", "documentation":"<p>Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.</p>" }, "FileUseCaseType":{ "shape":"FileUseCaseType", "documentation":"<p>The use case for the file.</p> <important> <p> Only <code>ATTACHMENTS</code> are supported.</p> </important>" }, "AssociatedResourceArn":{ "shape":"ARN", "documentation":"<p>The resource to which the attached file is (being) uploaded to. The supported resources are <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/cases.html\">Cases</a> and <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html\">Email</a>.</p> <note> <p>This value must be a valid ARN.</p> </note>", "location":"querystring", "locationName":"associatedResourceArn" }, "CreatedBy":{ "shape":"CreatedByInfo", "documentation":"<p>Represents the identity that created the file.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, <code>{ \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }</code>.</p>" } } }, "StartAttachedFileUploadResponse":{ "type":"structure", "members":{ "FileArn":{ "shape":"ARN", "documentation":"<p>The unique identifier of the attached file resource (ARN).</p>" }, "FileId":{ "shape":"FileId", "documentation":"<p>The unique identifier of the attached file resource.</p>" }, "CreationTime":{ "shape":"ISO8601Datetime", "documentation":"<p>The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: <code>yyyy-MM-ddThh:mm:ss.SSSZ</code>. For example, <code>2024-05-03T02:41:28.172Z</code>.</p>" }, "FileStatus":{ "shape":"FileStatusType", "documentation":"<p>The current status of the attached file.</p>" }, "CreatedBy":{ "shape":"CreatedByInfo", "documentation":"<p>Represents the identity that created the file.</p>" }, "UploadUrlMetadata":{ "shape":"UploadUrlMetadata", "documentation":"<p>The headers to be provided while uploading the file to the URL.</p>" } }, "documentation":"Response from StartAttachedFileUpload API." }, "StartChatContactRequest":{ "type":"structure", "required":[ "InstanceId", "ContactFlowId", "ParticipantDetails" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "ContactFlowId":{ "shape":"ContactFlowId", "documentation":"<p>The identifier of the flow for initiating the chat. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose <b>Show additional flow information</b>. The ContactFlowId is the last part of the ARN, shown here in bold: </p> <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b> </p>" }, "Attributes":{ "shape":"Attributes", "documentation":"<p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes. </p> <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.</p>" }, "ParticipantDetails":{ "shape":"ParticipantDetails", "documentation":"<p>Information identifying the participant.</p>" }, "InitialMessage":{ "shape":"ChatMessage", "documentation":"<p>The initial message to be sent to the newly created chat.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true }, "ChatDurationInMinutes":{ "shape":"ChatDurationInMinutes", "documentation":"<p>The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).</p>" }, "SupportedMessagingContentTypes":{ "shape":"SupportedMessagingContentTypes", "documentation":"<p>The supported chat message content types. Supported types are <code>text/plain</code>, <code>text/markdown</code>, <code>application/json</code>, <code>application/vnd.amazonaws.connect.message.interactive</code>, and <code>application/vnd.amazonaws.connect.message.interactive.response</code>. </p> <p>Content types must always contain <code>text/plain</code>. You can then put any other supported type in the list. For example, all the following lists are valid because they contain <code>text/plain</code>: <code>[text/plain, text/markdown, application/json]</code>, <code>[text/markdown, text/plain]</code>, <code>[text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response]</code>. </p> <note> <p>The type <code>application/vnd.amazonaws.connect.message.interactive</code> is required to use the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/show-view-block.html\">Show view</a> flow block.</p> </note>" }, "PersistentChat":{ "shape":"PersistentChat", "documentation":"<p>Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html\">Enable persistent chat</a>.</p>" }, "RelatedContactId":{ "shape":"ContactId", "documentation":"<p>The unique identifier for an Amazon Connect contact. This identifier is related to the chat starting.</p> <note> <p>You cannot provide data for both RelatedContactId and PersistentChat. </p> </note>" }, "SegmentAttributes":{ "shape":"SegmentAttributes", "documentation":"<p>A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.</p> <p>Attribute keys can include only alphanumeric, -, and _.</p> <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p> <note> <p>The types <code>application/vnd.amazonaws.connect.message.interactive</code> and <code>application/vnd.amazonaws.connect.message.interactive.response</code> must be present in the SupportedMessagingContentTypes field of this API in order to set <code>SegmentAttributes</code> as {<code> \"connect:Subtype\": {\"valueString\" : \"connect:Guide\" }}</code>.</p> </note>" }, "CustomerId":{ "shape":"CustomerIdNonEmpty", "documentation":"<p>The customer's identification number. For example, the <code>CustomerId</code> may be a customer number from your CRM.</p>" } } }, "StartChatContactResponse":{ "type":"structure", "members":{ "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of this contact within the Amazon Connect instance. </p>" }, "ParticipantId":{ "shape":"ParticipantId", "documentation":"<p>The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.</p>" }, "ParticipantToken":{ "shape":"ParticipantToken", "documentation":"<p>The token used by the chat participant to call <a href=\"https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html\">CreateParticipantConnection</a>. The participant token is valid for the lifetime of a chat participant.</p>" }, "ContinuedFromContactId":{ "shape":"ContactId", "documentation":"<p>The contactId from which a persistent chat session is started. This field is populated only for persistent chats.</p>" } } }, "StartContactEvaluationRequest":{ "type":"structure", "required":[ "InstanceId", "ContactId", "EvaluationFormId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact in this instance of Amazon Connect. </p>" }, "EvaluationFormId":{ "shape":"ResourceId", "documentation":"<p>The unique identifier for the evaluation form.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true } } }, "StartContactEvaluationResponse":{ "type":"structure", "required":[ "EvaluationId", "EvaluationArn" ], "members":{ "EvaluationId":{ "shape":"ResourceId", "documentation":"<p>A unique identifier for the contact evaluation.</p>" }, "EvaluationArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>" } } }, "StartContactRecordingRequest":{ "type":"structure", "required":[ "InstanceId", "ContactId", "InitialContactId", "VoiceRecordingConfiguration" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact.</p>" }, "InitialContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.</p>" }, "VoiceRecordingConfiguration":{ "shape":"VoiceRecordingConfiguration", "documentation":"<p>The person being recorded.</p>" } } }, "StartContactRecordingResponse":{ "type":"structure", "members":{} }, "StartContactStreamingRequest":{ "type":"structure", "required":[ "InstanceId", "ContactId", "ChatStreamingConfiguration", "ClientToken" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.</p>" }, "ChatStreamingConfiguration":{ "shape":"ChatStreamingConfiguration", "documentation":"<p>The streaming configuration, such as the Amazon SNS streaming endpoint.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true } } }, "StartContactStreamingResponse":{ "type":"structure", "required":["StreamingId"], "members":{ "StreamingId":{ "shape":"StreamingId", "documentation":"<p>The identifier of the streaming configuration enabled. </p>" } } }, "StartEmailContactRequest":{ "type":"structure", "required":[ "InstanceId", "FromEmailAddress", "DestinationEmailAddress", "EmailMessage" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "FromEmailAddress":{ "shape":"EmailAddressInfo", "documentation":"<p>The email address of the customer.</p>" }, "DestinationEmailAddress":{ "shape":"EmailAddress", "documentation":"<p>The email address associated with the Amazon Connect instance.</p>" }, "Description":{ "shape":"Description", "documentation":"<p>A description of the email contact.</p>" }, "References":{ "shape":"ContactReferences", "documentation":"<p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Emails can have the following reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> | <code>STRING</code> | <code>DATE</code>. <code>EMAIL</code> | <code>EMAIL_MESSAGE</code> |<code>ATTACHMENT</code> are not a supported reference type during email creation.</p>" }, "Name":{ "shape":"Name", "documentation":"<p>The name of a email that is shown to an agent in the Contact Control Panel (CCP).</p>" }, "EmailMessage":{ "shape":"InboundEmailContent", "documentation":"<p>The email message body to be sent to the newly created email.</p>" }, "AdditionalRecipients":{ "shape":"InboundAdditionalRecipients", "documentation":"<p>The addtional recipients address of the email.</p>" }, "Attachments":{ "shape":"EmailAttachments", "documentation":"<p>List of S3 presigned URLs of email attachments and their file name. </p>" }, "ContactFlowId":{ "shape":"ContactFlowId", "documentation":"<p>The identifier of the flow for initiating the emails. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose <b>Show additional flow information</b>. The ContactFlowId is the last part of the ARN, shown here in bold: </p> <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b> </p>" }, "RelatedContactId":{ "shape":"ContactId", "documentation":"<p>The contactId that is related to this contact. Linking emails together by using <code>RelatedContactID</code> copies over contact attributes from the related email contact to the new email contact. All updates to user-defined attributes in the new email contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using <code>RelatedContactId</code>. </p>" }, "Attributes":{ "shape":"Attributes", "documentation":"<p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.</p> <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.</p>" }, "SegmentAttributes":{ "shape":"SegmentAttributes", "documentation":"<p>A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.</p> <p>Attribute keys can include only alphanumeric, -, and _.</p> <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p> <note> <p>To set contact expiry, a <code>ValueMap</code> must be specified containing the integer number of minutes the contact will be active for before expiring, with <code>SegmentAttributes</code> like { <code> \"connect:ContactExpiry\": {\"ValueMap\" : { \"ExpiryDuration\": { \"ValueInteger\":135}}}}</code>.</p> </note>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true } } }, "StartEmailContactResponse":{ "type":"structure", "members":{ "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of this contact within the Amazon Connect instance.</p>" } } }, "StartOutboundChatContactRequest":{ "type":"structure", "required":[ "SourceEndpoint", "DestinationEndpoint", "InstanceId", "SegmentAttributes", "ContactFlowId" ], "members":{ "SourceEndpoint":{"shape":"Endpoint"}, "DestinationEndpoint":{"shape":"Endpoint"}, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</p>" }, "SegmentAttributes":{ "shape":"SegmentAttributes", "documentation":"<p>A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.</p> <ul> <li> <p>Attribute keys can include only alphanumeric, <code>-</code>, and <code>_</code>.</p> </li> <li> <p>This field can be used to show channel subtype, such as <code>connect:Guide</code> and <code>connect:SMS</code>.</p> </li> </ul>" }, "Attributes":{ "shape":"Attributes", "documentation":"<p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.</p>" }, "ContactFlowId":{ "shape":"ContactFlowId", "documentation":"<p>The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to <b>Routing, Contact Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose <b>Show additional flow information</b>. The ContactFlowId is the last part of the ARN, shown here in bold:</p> <ul> <li> <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>123ec456-a007-89c0-1234-xxxxxxxxxxxx</b> </p> </li> </ul>" }, "ChatDurationInMinutes":{ "shape":"ChatDurationInMinutes", "documentation":"<p>The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).</p>" }, "ParticipantDetails":{"shape":"ParticipantDetails"}, "InitialSystemMessage":{"shape":"ChatMessage"}, "RelatedContactId":{ "shape":"ContactId", "documentation":"<p>The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.</p>" }, "SupportedMessagingContentTypes":{ "shape":"SupportedMessagingContentTypes", "documentation":"<p>The supported chat message content types. Supported types are:</p> <ul> <li> <p> <code>text/plain</code> </p> </li> <li> <p> <code>text/markdown</code> </p> </li> <li> <p> <code>application/json, application/vnd.amazonaws.connect.message.interactive</code> </p> </li> <li> <p> <code>application/vnd.amazonaws.connect.message.interactive.response</code> </p> </li> </ul> <p>Content types must always contain <code>text/plain</code>. You can then put any other supported type in the list. For example, all the following lists are valid because they contain <code>text/plain</code>:</p> <ul> <li> <p> <code>[text/plain, text/markdown, application/json]</code> </p> </li> <li> <p> <code>[text/markdown, text/plain]</code> </p> </li> <li> <p> <code>[text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response]</code> </p> </li> </ul>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.</p>", "idempotencyToken":true } } }, "StartOutboundChatContactResponse":{ "type":"structure", "members":{ "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of this contact within the Amazon Connect instance.</p>" } } }, "StartOutboundEmailContactRequest":{ "type":"structure", "required":[ "InstanceId", "ContactId", "DestinationEmailAddress", "EmailMessage" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact in this instance of Amazon Connect. </p>" }, "FromEmailAddress":{ "shape":"EmailAddressInfo", "documentation":"<p>The email address associated with the Amazon Connect instance.</p>" }, "DestinationEmailAddress":{ "shape":"EmailAddressInfo", "documentation":"<p>The email address of the customer.</p>" }, "AdditionalRecipients":{ "shape":"OutboundAdditionalRecipients", "documentation":"<p>The additional recipients address of email in CC.</p>" }, "EmailMessage":{ "shape":"OutboundEmailContent", "documentation":"<p>The email message body to be sent to the newly created email.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true } } }, "StartOutboundEmailContactResponse":{ "type":"structure", "members":{ "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact in this instance of Amazon Connect. </p>" } } }, "StartOutboundVoiceContactRequest":{ "type":"structure", "required":[ "DestinationPhoneNumber", "ContactFlowId", "InstanceId" ], "members":{ "Name":{ "shape":"Name", "documentation":"<p>The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).</p>" }, "Description":{ "shape":"Description", "documentation":"<p>A description of the voice contact that appears in the agent's snapshot in the CCP logs. For more information about CCP logs, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/download-ccp-logs.html\">Download and review CCP logs</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "References":{ "shape":"ContactReferences", "documentation":"<p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can have the following reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> | <code>STRING</code> | <code>DATE</code> | <code>EMAIL</code>. <code>ATTACHMENT</code> is not a supported reference type during voice contact creation.</p>" }, "RelatedContactId":{ "shape":"ContactId", "documentation":"<p>The <code>contactId</code> that is related to this contact. Linking voice, task, or chat by using <code>RelatedContactID</code> copies over contact attributes from the related contact to the new contact. All updates to user-defined attributes in the new contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using <code>RelatedContactId</code>. </p>" }, "DestinationPhoneNumber":{ "shape":"PhoneNumber", "documentation":"<p>The phone number of the customer, in E.164 format.</p>" }, "ContactFlowId":{ "shape":"ContactFlowId", "documentation":"<p>The identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to <b>Routing</b>, <b>Contact Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose <b>Show additional flow information</b>. The ContactFlowId is the last part of the ARN, shown here in bold: </p> <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b> </p>" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned. </p>", "idempotencyToken":true }, "SourcePhoneNumber":{ "shape":"PhoneNumber", "documentation":"<p>The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.</p>" }, "QueueId":{ "shape":"QueueId", "documentation":"<p>The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the flow is used. If you do not specify a queue, you must specify a source phone number.</p>" }, "Attributes":{ "shape":"Attributes", "documentation":"<p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.</p> <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.</p>" }, "AnswerMachineDetectionConfig":{ "shape":"AnswerMachineDetectionConfig", "documentation":"<p>Configuration of the answering machine detection for this outbound call. </p>" }, "CampaignId":{ "shape":"CampaignId", "documentation":"<p>The campaign identifier of the outbound communication.</p>" }, "TrafficType":{ "shape":"TrafficType", "documentation":"<p>Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The default value is <code>GENERAL</code>. Use <code>CAMPAIGN</code> if <code>EnableAnswerMachineDetection</code> is set to <code>true</code>. For all other cases, use <code>GENERAL</code>. </p>" } } }, "StartOutboundVoiceContactResponse":{ "type":"structure", "members":{ "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of this contact within the Amazon Connect instance.</p>" } } }, "StartScreenSharingRequest":{ "type":"structure", "required":[ "InstanceId", "ContactId" ], "members":{ "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact in this instance of Amazon Connect. </p>" } } }, "StartScreenSharingResponse":{ "type":"structure", "members":{} }, "StartTaskContactRequest":{ "type":"structure", "required":[ "InstanceId", "Name" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "PreviousContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the previous chat, voice, or task contact. Any updates to user-defined attributes to task contacts linked using the same <code>PreviousContactID</code> will affect every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.</p>" }, "ContactFlowId":{ "shape":"ContactFlowId", "documentation":"<p>The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose <b>Show additional flow information</b>. The ContactFlowId is the last part of the ARN, shown here in bold: </p> <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b> </p>" }, "Attributes":{ "shape":"Attributes", "documentation":"<p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.</p> <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.</p>" }, "Name":{ "shape":"Name", "documentation":"<p>The name of a task that is shown to an agent in the Contact Control Panel (CCP).</p>" }, "References":{ "shape":"ContactReferences", "documentation":"<p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> | <code>STRING</code> | <code>DATE</code> | <code>EMAIL</code>. <code>ATTACHMENT</code> is not a supported reference type during task creation.</p>" }, "Description":{ "shape":"Description", "documentation":"<p>A description of the task that is shown to an agent in the Contact Control Panel (CCP).</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true }, "ScheduledTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future. </p>" }, "TaskTemplateId":{ "shape":"TaskTemplateId", "documentation":"<p>A unique identifier for the task template. For more information about task templates, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/task-templates.html\">Create task templates</a> in the <i>Amazon Connect Administrator Guide</i>. </p>" }, "QuickConnectId":{ "shape":"QuickConnectId", "documentation":"<p>The identifier for the quick connect. Tasks that are created by using <code>QuickConnectId</code> will use the flow that is defined on agent or queue quick connect. For more information about quick connects, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/quick-connects.html\">Create quick connects</a>.</p>" }, "RelatedContactId":{ "shape":"ContactId", "documentation":"<p>The contactId that is <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html#linked-tasks\">related</a> to this contact. Linking tasks together by using <code>RelatedContactID</code> copies over contact attributes from the related task contact to the new task contact. All updates to user-defined attributes in the new task contact are limited to the individual contact ID, unlike what happens when tasks are linked by using <code>PreviousContactID</code>. There are no limits to the number of contacts that can be linked by using <code>RelatedContactId</code>. </p>" }, "SegmentAttributes":{ "shape":"SegmentAttributes", "documentation":"<p>A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.</p> <p>Attribute keys can include only alphanumeric, -, and _.</p> <p>This field can be used to set Contact Expiry as a duration in minutes and set a UserId for the User who created a task.</p> <note> <p>To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will be active for before expiring, with <code>SegmentAttributes</code> like { <code> \"connect:ContactExpiry\": {\"ValueMap\" : { \"ExpiryDuration\": { \"ValueInteger\": 135}}}}</code>. </p> <p>To set the created by user, a valid AgentResourceId must be supplied, with <code>SegmentAttributes</code> like { <code>\"connect:CreatedByUser\" { \"ValueString\": \"arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/agent/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"}}}</code>. </p> </note>" } } }, "StartTaskContactResponse":{ "type":"structure", "members":{ "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of this contact within the Amazon Connect instance.</p>" } } }, "StartWebRTCContactRequest":{ "type":"structure", "required":[ "ContactFlowId", "InstanceId", "ParticipantDetails" ], "members":{ "Attributes":{ "shape":"Attributes", "documentation":"<p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.</p> <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, -, and _ characters.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p> <p>The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.</p>", "idempotencyToken":true }, "ContactFlowId":{ "shape":"ContactFlowId", "documentation":"<p>The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose <b>Show additional flow information</b>. The ContactFlowId is the last part of the ARN, shown here in bold: </p> <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b> </p>" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "AllowedCapabilities":{ "shape":"AllowedCapabilities", "documentation":"<p>Information about the video sharing capabilities of the participants (customer, agent).</p>" }, "ParticipantDetails":{"shape":"ParticipantDetails"}, "RelatedContactId":{ "shape":"ContactId", "documentation":"<p>The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.</p>" }, "References":{ "shape":"ContactReferences", "documentation":"<p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> | <code>STRING</code> | <code>DATE</code> | <code>EMAIL</code>. <code>ATTACHMENT</code> is not a supported reference type during task creation.</p>" }, "Description":{ "shape":"Description", "documentation":"<p>A description of the task that is shown to an agent in the Contact Control Panel (CCP).</p>" } } }, "StartWebRTCContactResponse":{ "type":"structure", "members":{ "ConnectionData":{ "shape":"ConnectionData", "documentation":"<p>Information required for the client application (mobile application or website) to connect to the call.</p>" }, "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact in this instance of Amazon Connect. </p>" }, "ParticipantId":{ "shape":"ParticipantId", "documentation":"<p>The identifier for a contact participant. The <code>ParticipantId</code> for a contact participant is the same throughout the contact lifecycle.</p>" }, "ParticipantToken":{ "shape":"ParticipantToken", "documentation":"<p>The token used by the contact participant to call the <a href=\"https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html\">CreateParticipantConnection</a> API. The participant token is valid for the lifetime of a contact participant.</p>" } } }, "StateTransition":{ "type":"structure", "members":{ "State":{ "shape":"ParticipantState", "documentation":"<p>The state of the transition.</p>" }, "StateStartTimestamp":{ "shape":"timestamp", "documentation":"<p>The date and time when the state started in UTC time.</p>" }, "StateEndTimestamp":{ "shape":"timestamp", "documentation":"<p>The date and time when the state ended in UTC time.</p>" } }, "documentation":"<p>Information about the state transition of a supervisor.</p>" }, "StateTransitions":{ "type":"list", "member":{"shape":"StateTransition"} }, "Statistic":{ "type":"string", "enum":[ "SUM", "MAX", "AVG" ] }, "Status":{ "type":"string", "enum":[ "COMPLETE", "IN_PROGRESS", "DELETED" ] }, "Step":{ "type":"structure", "members":{ "Expiry":{ "shape":"Expiry", "documentation":"<p>An object to specify the expiration of a routing step.</p>" }, "Expression":{ "shape":"Expression", "documentation":"<p>A tagged union to specify expression for a routing step.</p>" }, "Status":{ "shape":"RoutingCriteriaStepStatus", "documentation":"<p>Represents status of the Routing step.</p>" } }, "documentation":"<p>Step signifies the criteria to be used for routing to an agent</p>" }, "Steps":{ "type":"list", "member":{"shape":"Step"} }, "StopContactRecordingRequest":{ "type":"structure", "required":[ "InstanceId", "ContactId", "InitialContactId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact.</p>" }, "InitialContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.</p>" }, "ContactRecordingType":{ "shape":"ContactRecordingType", "documentation":"<p>The type of recording being operated on.</p>" } } }, "StopContactRecordingResponse":{ "type":"structure", "members":{} }, "StopContactRequest":{ "type":"structure", "required":[ "ContactId", "InstanceId" ], "members":{ "ContactId":{ "shape":"ContactId", "documentation":"<p>The ID of the contact.</p>" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "DisconnectReason":{ "shape":"DisconnectReason", "documentation":"<p>The reason a contact can be disconnected. Only Amazon Connect outbound campaigns can provide this field.</p>" } } }, "StopContactResponse":{ "type":"structure", "members":{} }, "StopContactStreamingRequest":{ "type":"structure", "required":[ "InstanceId", "ContactId", "StreamingId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact. This is the identifier of the contact that is associated with the first interaction with the contact center.</p>" }, "StreamingId":{ "shape":"StreamingId", "documentation":"<p>The identifier of the streaming configuration enabled. </p>" } } }, "StopContactStreamingResponse":{ "type":"structure", "members":{} }, "StorageType":{ "type":"string", "enum":[ "S3", "KINESIS_VIDEO_STREAM", "KINESIS_STREAM", "KINESIS_FIREHOSE" ] }, "StreamingId":{ "type":"string", "max":100, "min":1 }, "String":{"type":"string"}, "StringComparisonType":{ "type":"string", "enum":[ "STARTS_WITH", "CONTAINS", "EXACT" ] }, "StringCondition":{ "type":"structure", "members":{ "FieldName":{ "shape":"String", "documentation":"<p>The name of the field in the string condition.</p>" }, "Value":{ "shape":"String", "documentation":"<p>The value of the string.</p>" }, "ComparisonType":{ "shape":"StringComparisonType", "documentation":"<p>The type of comparison to be made when evaluating the string condition.</p>" } }, "documentation":"<p>A leaf node condition which can be used to specify a string condition.</p>" }, "StringReference":{ "type":"structure", "members":{ "Name":{ "shape":"ReferenceKey", "documentation":"<p>Identifier of the string reference.</p>" }, "Value":{ "shape":"ReferenceValue", "documentation":"<p>A valid string.</p>" } }, "documentation":"<p>Information about a reference when the <code>referenceType</code> is <code>STRING</code>. Otherwise, null.</p>" }, "Subject":{ "type":"string", "max":200, "min":1 }, "SubmitAutoEvaluationActionDefinition":{ "type":"structure", "required":["EvaluationFormId"], "members":{ "EvaluationFormId":{ "shape":"EvaluationFormId", "documentation":"<p>The identifier of the auto-evaluation enabled form.</p>" } }, "documentation":"<p>Information about the submit automated evaluation action.</p>" }, "SubmitContactEvaluationRequest":{ "type":"structure", "required":[ "InstanceId", "EvaluationId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "EvaluationId":{ "shape":"ResourceId", "documentation":"<p>A unique identifier for the contact evaluation.</p>", "location":"uri", "locationName":"EvaluationId" }, "Answers":{ "shape":"EvaluationAnswersInputMap", "documentation":"<p>A map of question identifiers to answer value.</p>" }, "Notes":{ "shape":"EvaluationNotesMap", "documentation":"<p>A map of question identifiers to note value.</p>" } } }, "SubmitContactEvaluationResponse":{ "type":"structure", "required":[ "EvaluationId", "EvaluationArn" ], "members":{ "EvaluationId":{ "shape":"ResourceId", "documentation":"<p>A unique identifier for the contact evaluation.</p>" }, "EvaluationArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>" } } }, "Subtype":{ "type":"string", "max":100, "min":1 }, "SuccessfulRequest":{ "type":"structure", "members":{ "RequestIdentifier":{ "shape":"RequestIdentifier", "documentation":"<p>Request identifier provided in the API call in the ContactDataRequest to create a contact.</p>" }, "ContactId":{ "shape":"ContactId", "documentation":"<p>The contactId of the contact that was created successfully.</p>" } }, "documentation":"<p>Request for which contact was successfully created.</p>" }, "SuccessfulRequestList":{ "type":"list", "member":{"shape":"SuccessfulRequest"} }, "SupportedMessagingContentType":{ "type":"string", "max":100, "min":1 }, "SupportedMessagingContentTypes":{ "type":"list", "member":{"shape":"SupportedMessagingContentType"} }, "SuspendContactRecordingRequest":{ "type":"structure", "required":[ "InstanceId", "ContactId", "InitialContactId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact.</p>" }, "InitialContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.</p>" }, "ContactRecordingType":{ "shape":"ContactRecordingType", "documentation":"<p>The type of recording being operated on.</p>" } } }, "SuspendContactRecordingResponse":{ "type":"structure", "members":{} }, "TagAndConditionList":{ "type":"list", "member":{"shape":"TagCondition"} }, "TagCondition":{ "type":"structure", "members":{ "TagKey":{ "shape":"String", "documentation":"<p>The tag key in the tag condition.</p>" }, "TagValue":{ "shape":"String", "documentation":"<p>The tag value in the tag condition.</p>" } }, "documentation":"<p>A leaf node condition which can be used to specify a tag condition, for example, <code>HAVE BPO = 123</code>. </p>" }, "TagContactRequest":{ "type":"structure", "required":[ "ContactId", "InstanceId", "Tags" ], "members":{ "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact in this instance of Amazon Connect. </p>" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "Tags":{ "shape":"ContactTagMap", "documentation":"<p>The tags to be assigned to the contact resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p> <note> <p>Authorization is not supported by this tag.</p> </note>" } } }, "TagContactResponse":{ "type":"structure", "members":{} }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"^(?!aws:)[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*$" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":50, "min":1 }, "TagKeyString":{ "type":"string", "max":128 }, "TagMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "max":50, "min":1 }, "TagOrConditionList":{ "type":"list", "member":{"shape":"TagAndConditionList"} }, "TagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>", "location":"uri", "locationName":"resourceArn" }, "tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" } } }, "TagRestrictedResourceList":{ "type":"list", "member":{"shape":"TagRestrictedResourceName"}, "max":10 }, "TagRestrictedResourceName":{ "type":"string", "max":128, "min":1 }, "TagSearchCondition":{ "type":"structure", "members":{ "tagKey":{ "shape":"TagKeyString", "documentation":"<p>The tag key used in the tag search condition.</p>" }, "tagValue":{ "shape":"TagValueString", "documentation":"<p>The tag value used in the tag search condition.</p>" }, "tagKeyComparisonType":{ "shape":"StringComparisonType", "documentation":"<p>The type of comparison to be made when evaluating the tag key in tag search condition.</p>" }, "tagValueComparisonType":{ "shape":"StringComparisonType", "documentation":"<p>The type of comparison to be made when evaluating the tag value in tag search condition.</p>" } }, "documentation":"<p>The search criteria to be used to return tags.</p>" }, "TagSet":{ "type":"structure", "members":{ "key":{ "shape":"TagKey", "documentation":"<p>The tag key in the TagSet.</p>" }, "value":{ "shape":"TagValue", "documentation":"<p>The tag value in the tagSet.</p>" } }, "documentation":"<p>A tag set contains tag key and tag value.</p>" }, "TagValue":{ "type":"string", "max":256 }, "TagValueString":{ "type":"string", "max":256 }, "TagsList":{ "type":"list", "member":{"shape":"TagSet"} }, "TargetListType":{ "type":"string", "enum":["PROFICIENCIES"] }, "TargetSlaMinutes":{ "type":"long", "max":129600, "min":1 }, "TaskActionDefinition":{ "type":"structure", "required":[ "Name", "ContactFlowId" ], "members":{ "Name":{ "shape":"TaskNameExpression", "documentation":"<p>The name. Supports variable injection. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html\">JSONPath reference</a> in the <i>Amazon Connect Administrators Guide</i>.</p>" }, "Description":{ "shape":"TaskDescriptionExpression", "documentation":"<p>The description. Supports variable injection. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html\">JSONPath reference</a> in the <i>Amazon Connect Administrators Guide</i>.</p>" }, "ContactFlowId":{ "shape":"ContactFlowId", "documentation":"<p>The identifier of the flow.</p>" }, "References":{ "shape":"ContactReferences", "documentation":"<p>Information about the reference when the <code>referenceType</code> is <code>URL</code>. Otherwise, null. (Supports variable injection in the <code>Value</code> field.)</p>" } }, "documentation":"<p>Information about the task action.</p>" }, "TaskDescriptionExpression":{ "type":"string", "max":4096, "min":0 }, "TaskNameExpression":{ "type":"string", "max":512, "min":1 }, "TaskTemplateArn":{ "type":"string", "max":500, "min":1 }, "TaskTemplateConstraints":{ "type":"structure", "members":{ "RequiredFields":{ "shape":"RequiredTaskTemplateFields", "documentation":"<p>Lists the fields that are required to be filled by agents.</p>" }, "ReadOnlyFields":{ "shape":"ReadOnlyTaskTemplateFields", "documentation":"<p>Lists the fields that are read-only to agents, and cannot be edited.</p>" }, "InvisibleFields":{ "shape":"InvisibleTaskTemplateFields", "documentation":"<p>Lists the fields that are invisible to agents.</p>" } }, "documentation":"<p>Describes constraints that apply to the template fields.</p>" }, "TaskTemplateDefaultFieldValue":{ "type":"structure", "members":{ "Id":{ "shape":"TaskTemplateFieldIdentifier", "documentation":"<p>Identifier of a field. </p>" }, "DefaultValue":{ "shape":"TaskTemplateFieldValue", "documentation":"<p>Default value for the field.</p>" } }, "documentation":"<p>Describes a default field and its corresponding value.</p>" }, "TaskTemplateDefaultFieldValueList":{ "type":"list", "member":{"shape":"TaskTemplateDefaultFieldValue"} }, "TaskTemplateDefaults":{ "type":"structure", "members":{ "DefaultFieldValues":{ "shape":"TaskTemplateDefaultFieldValueList", "documentation":"<p>Default value for the field.</p>" } }, "documentation":"<p>Describes default values for fields on a template.</p>" }, "TaskTemplateDescription":{ "type":"string", "max":255, "min":1 }, "TaskTemplateField":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"TaskTemplateFieldIdentifier", "documentation":"<p>The unique identifier for the field.</p>" }, "Description":{ "shape":"TaskTemplateFieldDescription", "documentation":"<p>The description of the field.</p>" }, "Type":{ "shape":"TaskTemplateFieldType", "documentation":"<p>Indicates the type of field.</p>" }, "SingleSelectOptions":{ "shape":"SingleSelectOptions", "documentation":"<p>A list of options for a single select field.</p>" } }, "documentation":"<p>Describes a single task template field.</p>" }, "TaskTemplateFieldDescription":{ "type":"string", "max":255, "min":1 }, "TaskTemplateFieldIdentifier":{ "type":"structure", "members":{ "Name":{ "shape":"TaskTemplateFieldName", "documentation":"<p>The name of the task template field.</p>" } }, "documentation":"<p>The identifier of the task template field.</p>" }, "TaskTemplateFieldName":{ "type":"string", "max":100, "min":1 }, "TaskTemplateFieldType":{ "type":"string", "enum":[ "NAME", "DESCRIPTION", "SCHEDULED_TIME", "QUICK_CONNECT", "URL", "NUMBER", "TEXT", "TEXT_AREA", "DATE_TIME", "BOOLEAN", "SINGLE_SELECT", "EMAIL", "SELF_ASSIGN", "EXPIRY_DURATION" ] }, "TaskTemplateFieldValue":{ "type":"string", "max":4096, "min":0 }, "TaskTemplateFields":{ "type":"list", "member":{"shape":"TaskTemplateField"} }, "TaskTemplateId":{ "type":"string", "max":500, "min":1 }, "TaskTemplateList":{ "type":"list", "member":{"shape":"TaskTemplateMetadata"} }, "TaskTemplateMetadata":{ "type":"structure", "members":{ "Id":{ "shape":"TaskTemplateId", "documentation":"<p>A unique identifier for the task template.</p>" }, "Arn":{ "shape":"TaskTemplateArn", "documentation":"<p>The Amazon Resource Name (ARN) of the task template.</p>" }, "Name":{ "shape":"TaskTemplateName", "documentation":"<p>The name of the task template.</p>" }, "Description":{ "shape":"TaskTemplateDescription", "documentation":"<p>The description of the task template.</p>" }, "Status":{ "shape":"TaskTemplateStatus", "documentation":"<p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it. Tasks can only be created from <code>ACTIVE</code> templates. If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.</p>" }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"<p>The timestamp when the task template was last modified.</p>" }, "CreatedTime":{ "shape":"timestamp", "documentation":"<p>The timestamp when the task template was created.</p>" } }, "documentation":"<p>Contains summary information about the task template.</p>" }, "TaskTemplateName":{ "type":"string", "max":100, "min":1 }, "TaskTemplateSingleSelectOption":{ "type":"string", "max":100, "min":1 }, "TaskTemplateStatus":{ "type":"string", "enum":[ "ACTIVE", "INACTIVE" ] }, "TelephonyConfig":{ "type":"structure", "required":["Distributions"], "members":{ "Distributions":{ "shape":"DistributionList", "documentation":"<p>Information about traffic distributions.</p>" } }, "documentation":"<p>The distribution of traffic between the instance and its replicas.</p>" }, "TemplateAttributes":{ "type":"structure", "members":{ "CustomAttributes":{ "shape":"Attributes", "documentation":"<p>An object that specifies the custom attributes values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. </p>" }, "CustomerProfileAttributes":{ "shape":"CustomerProfileAttributesSerialized", "documentation":"<p>An object that specifies the customer profile attributes values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. </p>" } }, "documentation":"<p>Information about the template attributes.</p>" }, "TemplateId":{ "type":"string", "max":500, "min":1 }, "TemplatedMessageConfig":{ "type":"structure", "required":[ "KnowledgeBaseId", "MessageTemplateId", "TemplateAttributes" ], "members":{ "KnowledgeBaseId":{ "shape":"MessageTemplateKnowledgeBaseId", "documentation":"<p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>" }, "MessageTemplateId":{ "shape":"MessageTemplateId", "documentation":"<p>The identifier of the message template Id.</p>" }, "TemplateAttributes":{ "shape":"TemplateAttributes", "documentation":"<p>Information about template attributes, that is, CustomAttributes or CustomerProfileAttributes.</p>" } }, "documentation":"<p>Information about template message configuration.</p>" }, "Threshold":{ "type":"structure", "members":{ "Comparison":{ "shape":"Comparison", "documentation":"<p>The type of comparison. Only \"less than\" (LT) comparisons are supported.</p>" }, "ThresholdValue":{ "shape":"ThresholdValue", "documentation":"<p>The threshold value to compare.</p>", "box":true } }, "documentation":"<p>Contains information about the threshold for service level metrics.</p>" }, "ThresholdCollections":{ "type":"list", "member":{"shape":"ThresholdV2"}, "max":1 }, "ThresholdV2":{ "type":"structure", "members":{ "Comparison":{ "shape":"ResourceArnOrId", "documentation":"<p>The type of comparison. Currently, \"less than\" (LT), \"less than equal\" (LTE), and \"greater than\" (GT) comparisons are supported.</p>" }, "ThresholdValue":{ "shape":"ThresholdValue", "documentation":"<p>The threshold value to compare.</p>", "box":true } }, "documentation":"<p>Contains information about the threshold for service level metrics.</p>" }, "ThresholdValue":{"type":"double"}, "ThrottlingException":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"<p>The throttling limit has been exceeded.</p>", "error":{"httpStatusCode":429}, "exception":true }, "TimeZone":{"type":"string"}, "TimerEligibleParticipantRoles":{ "type":"string", "enum":[ "CUSTOMER", "AGENT" ] }, "Timestamp":{"type":"timestamp"}, "TooManyRequestsException":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"<p>Displayed when rate-related API limits are exceeded.</p>", "error":{"httpStatusCode":429}, "exception":true }, "TotalCount":{"type":"long"}, "TotalPauseCount":{ "type":"integer", "max":10, "min":0 }, "TotalPauseDurationInSeconds":{ "type":"integer", "min":0 }, "TrafficDistributionGroup":{ "type":"structure", "members":{ "Id":{ "shape":"TrafficDistributionGroupId", "documentation":"<p>The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.</p>" }, "Arn":{ "shape":"TrafficDistributionGroupArn", "documentation":"<p>The Amazon Resource Name (ARN) of the traffic distribution group.</p>" }, "Name":{ "shape":"Name128", "documentation":"<p>The name of the traffic distribution group.</p>" }, "Description":{ "shape":"Description250", "documentation":"<p>The description of the traffic distribution group.</p>" }, "InstanceArn":{ "shape":"InstanceArn", "documentation":"<p>The Amazon Resource Name (ARN).</p>" }, "Status":{ "shape":"TrafficDistributionGroupStatus", "documentation":"<p>The status of the traffic distribution group.</p> <ul> <li> <p> <code>CREATION_IN_PROGRESS</code> means the previous <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html\">CreateTrafficDistributionGroup</a> operation is still in progress and has not yet completed.</p> </li> <li> <p> <code>ACTIVE</code> means the previous <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html\">CreateTrafficDistributionGroup</a> operation has succeeded.</p> </li> <li> <p> <code>CREATION_FAILED</code> indicates that the previous <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html\">CreateTrafficDistributionGroup</a> operation has failed.</p> </li> <li> <p> <code>PENDING_DELETION</code> means the previous <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html\">DeleteTrafficDistributionGroup</a> operation is still in progress and has not yet completed.</p> </li> <li> <p> <code>DELETION_FAILED</code> means the previous <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html\">DeleteTrafficDistributionGroup</a> operation has failed.</p> </li> <li> <p> <code>UPDATE_IN_PROGRESS</code> means the previous <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateTrafficDistribution.html\">UpdateTrafficDistribution</a> operation is still in progress and has not yet completed.</p> </li> </ul>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" }, "IsDefault":{ "shape":"Boolean", "documentation":"<p>Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by the <code>DeleteTrafficDistributionGroup</code> API. The default traffic distribution group is deleted as part of the process for deleting a replica.</p> <note> <p>The <code>SignInConfig</code> distribution is available only on a default <code>TrafficDistributionGroup</code> (see the <code>IsDefault</code> parameter in the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html\">TrafficDistributionGroup</a> data type). If you call <code>UpdateTrafficDistribution</code> with a modified <code>SignInConfig</code> and a non-default <code>TrafficDistributionGroup</code>, an <code>InvalidRequestException</code> is returned.</p> </note>" } }, "documentation":"<p>Information about a traffic distribution group.</p>" }, "TrafficDistributionGroupArn":{ "type":"string", "pattern":"^arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:traffic-distribution-group/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" }, "TrafficDistributionGroupId":{ "type":"string", "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" }, "TrafficDistributionGroupIdOrArn":{ "type":"string", "pattern":"^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z-]+-[0-9]{1}:[0-9]{1,20}:traffic-distribution-group/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" }, "TrafficDistributionGroupStatus":{ "type":"string", "enum":[ "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED", "PENDING_DELETION", "DELETION_FAILED", "UPDATE_IN_PROGRESS" ] }, "TrafficDistributionGroupSummary":{ "type":"structure", "members":{ "Id":{ "shape":"TrafficDistributionGroupId", "documentation":"<p>The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.</p>" }, "Arn":{ "shape":"TrafficDistributionGroupArn", "documentation":"<p>The Amazon Resource Name (ARN) of the traffic distribution group.</p>" }, "Name":{ "shape":"Name128", "documentation":"<p>The name of the traffic distribution group.</p>" }, "InstanceArn":{ "shape":"InstanceArn", "documentation":"<p>The Amazon Resource Name (ARN) of the traffic distribution group.</p>" }, "Status":{ "shape":"TrafficDistributionGroupStatus", "documentation":"<p>The status of the traffic distribution group. </p> <ul> <li> <p> <code>CREATION_IN_PROGRESS</code> means the previous <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html\">CreateTrafficDistributionGroup</a> operation is still in progress and has not yet completed.</p> </li> <li> <p> <code>ACTIVE</code> means the previous <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html\">CreateTrafficDistributionGroup</a> operation has succeeded.</p> </li> <li> <p> <code>CREATION_FAILED</code> indicates that the previous <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html\">CreateTrafficDistributionGroup</a> operation has failed.</p> </li> <li> <p> <code>PENDING_DELETION</code> means the previous <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html\">DeleteTrafficDistributionGroup</a> operation is still in progress and has not yet completed.</p> </li> <li> <p> <code>DELETION_FAILED</code> means the previous <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html\">DeleteTrafficDistributionGroup</a> operation has failed.</p> </li> <li> <p> <code>UPDATE_IN_PROGRESS</code> means the previous <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateTrafficDistributionGroup.html\">UpdateTrafficDistributionGroup</a> operation is still in progress and has not yet completed.</p> </li> </ul>" }, "IsDefault":{ "shape":"Boolean", "documentation":"<p>Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by the <code>DeleteTrafficDistributionGroup</code> API. The default traffic distribution group is deleted as part of the process for deleting a replica.</p>" } }, "documentation":"<p>Information about traffic distribution groups.</p>" }, "TrafficDistributionGroupSummaryList":{ "type":"list", "member":{"shape":"TrafficDistributionGroupSummary"}, "max":10, "min":0 }, "TrafficDistributionGroupUserSummary":{ "type":"structure", "members":{ "UserId":{ "shape":"UserId", "documentation":"<p>The identifier for the user. This can be the ID or the ARN of the user.</p>" } }, "documentation":"<p>Summary information about a traffic distribution group user.</p>" }, "TrafficDistributionGroupUserSummaryList":{ "type":"list", "member":{"shape":"TrafficDistributionGroupUserSummary"}, "max":10, "min":0 }, "TrafficType":{ "type":"string", "enum":[ "GENERAL", "CAMPAIGN" ] }, "Transcript":{ "type":"structure", "required":["Criteria"], "members":{ "Criteria":{ "shape":"TranscriptCriteriaList", "documentation":"<p>The list of search criteria based on Contact Lens conversational analytics transcript.</p>" }, "MatchType":{ "shape":"SearchContactsMatchType", "documentation":"<p>The match type combining search criteria using multiple transcript criteria.</p>" } }, "documentation":"<p>A structure that defines search criteria and matching logic to search for contacts by matching text with transcripts analyzed by Amazon Connect Contact Lens.</p>" }, "TranscriptCriteria":{ "type":"structure", "required":[ "ParticipantRole", "SearchText", "MatchType" ], "members":{ "ParticipantRole":{ "shape":"ParticipantRole", "documentation":"<p>The participant role in a transcript</p>" }, "SearchText":{ "shape":"SearchTextList", "documentation":"<p>The words or phrases used to search within a transcript.</p>" }, "MatchType":{ "shape":"SearchContactsMatchType", "documentation":"<p>The match type combining search criteria using multiple search texts in a transcript criteria.</p>" } }, "documentation":"<p>A structure that defines search criteria base on words or phrases, participants in the Contact Lens conversational analytics transcript.</p>" }, "TranscriptCriteriaList":{ "type":"list", "member":{"shape":"TranscriptCriteria"}, "max":6, "min":0 }, "TransferContactRequest":{ "type":"structure", "required":[ "InstanceId", "ContactId", "ContactFlowId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact in this instance of Amazon Connect. </p>" }, "QueueId":{ "shape":"QueueId", "documentation":"<p>The identifier for the queue.</p>" }, "UserId":{ "shape":"AgentResourceId", "documentation":"<p>The identifier for the user. This can be the ID or the ARN of the user.</p>" }, "ContactFlowId":{ "shape":"ContactFlowId", "documentation":"<p>The identifier of the flow.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true } } }, "TransferContactResponse":{ "type":"structure", "members":{ "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact in this instance of Amazon Connect. </p>" }, "ContactArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the contact.</p>" } } }, "URI":{ "type":"string", "max":2000, "min":1 }, "URLExpiryInSeconds":{ "type":"integer", "max":300, "min":5 }, "Unit":{ "type":"string", "enum":[ "SECONDS", "COUNT", "PERCENT" ] }, "UntagContactRequest":{ "type":"structure", "required":[ "ContactId", "InstanceId", "TagKeys" ], "members":{ "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact in this instance of Amazon Connect. </p>", "location":"uri", "locationName":"ContactId" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "TagKeys":{ "shape":"ContactTagKeys", "documentation":"<p>A list of tag keys. Existing tags on the contact whose keys are members of this list will be removed.</p>", "location":"querystring", "locationName":"TagKeys" } } }, "UntagContactResponse":{ "type":"structure", "members":{} }, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>", "location":"uri", "locationName":"resourceArn" }, "tagKeys":{ "shape":"TagKeyList", "documentation":"<p>The tag keys.</p>", "location":"querystring", "locationName":"tagKeys" } } }, "UpdateAgentStatusDescription":{ "type":"string", "max":250, "min":0 }, "UpdateAgentStatusRequest":{ "type":"structure", "required":[ "InstanceId", "AgentStatusId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "AgentStatusId":{ "shape":"AgentStatusId", "documentation":"<p>The identifier of the agent status.</p>", "location":"uri", "locationName":"AgentStatusId" }, "Name":{ "shape":"AgentStatusName", "documentation":"<p>The name of the agent status.</p>" }, "Description":{ "shape":"UpdateAgentStatusDescription", "documentation":"<p>The description of the agent status.</p>" }, "State":{ "shape":"AgentStatusState", "documentation":"<p>The state of the agent status.</p>" }, "DisplayOrder":{ "shape":"AgentStatusOrderNumber", "documentation":"<p>The display order of the agent status.</p>", "box":true }, "ResetOrderNumber":{ "shape":"Boolean", "documentation":"<p>A number indicating the reset order of the agent status.</p>" } } }, "UpdateAuthenticationProfileRequest":{ "type":"structure", "required":[ "AuthenticationProfileId", "InstanceId" ], "members":{ "AuthenticationProfileId":{ "shape":"AuthenticationProfileId", "documentation":"<p>A unique identifier for the authentication profile. </p>", "location":"uri", "locationName":"AuthenticationProfileId" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Name":{ "shape":"AuthenticationProfileName", "documentation":"<p>The name for the authentication profile.</p>" }, "Description":{ "shape":"AuthenticationProfileDescription", "documentation":"<p>The description for the authentication profile.</p>" }, "AllowedIps":{ "shape":"IpCidrList", "documentation":"<p>A list of IP address range strings that are allowed to access the instance. For more information on how to configure IP addresses, see<a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts\">Configure session timeouts</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "BlockedIps":{ "shape":"IpCidrList", "documentation":"<p>A list of IP address range strings that are blocked from accessing the instance. For more information on how to configure IP addresses, For more information on how to configure IP addresses, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-ip-based-ac\">Configure IP-based access control</a> in the <i>Amazon Connect Administrator Guide</i>. </p>" }, "PeriodicSessionDuration":{ "shape":"AccessTokenDuration", "documentation":"<p>The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This value determines the maximum possible time before an agent is authenticated. For more information, For more information on how to configure IP addresses, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts\">Configure session timeouts</a> in the <i>Amazon Connect Administrator Guide</i>. </p>", "box":true } } }, "UpdateCaseActionDefinition":{ "type":"structure", "required":["Fields"], "members":{ "Fields":{ "shape":"FieldValues", "documentation":"<p>An array of objects with <code>Field ID</code> and Value data.</p>" } }, "documentation":"<p>The <code>UpdateCase</code> action definition.</p>" }, "UpdateContactAttributesRequest":{ "type":"structure", "required":[ "InitialContactId", "InstanceId", "Attributes" ], "members":{ "InitialContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.</p>" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "Attributes":{ "shape":"Attributes", "documentation":"<p>The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes.</p> <p>You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.</p> <p>In the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/set-contact-attributes.html\">Set contact attributes</a> block, when the attributes for a contact exceed 32 KB, the contact is routed down the Error branch of the flow. As a mitigation, consider the following options:</p> <ul> <li> <p>Remove unnecessary attributes by setting their values to empty.</p> </li> <li> <p>If the attributes are only used in one flow and don't need to be referred to outside of that flow (for example, by a Lambda or another flow), then use flow attributes. This way you aren't needlessly persisting the 32 KB of information from one flow to another. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/set-contact-attributes.html\">Flow block: Set contact attributes</a> in the <i>Amazon Connect Administrator Guide</i>. </p> </li> </ul>" } } }, "UpdateContactAttributesResponse":{ "type":"structure", "members":{} }, "UpdateContactEvaluationRequest":{ "type":"structure", "required":[ "InstanceId", "EvaluationId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "EvaluationId":{ "shape":"ResourceId", "documentation":"<p>A unique identifier for the contact evaluation.</p>", "location":"uri", "locationName":"EvaluationId" }, "Answers":{ "shape":"EvaluationAnswersInputMap", "documentation":"<p>A map of question identifiers to answer value.</p>" }, "Notes":{ "shape":"EvaluationNotesMap", "documentation":"<p>A map of question identifiers to note value.</p>" } } }, "UpdateContactEvaluationResponse":{ "type":"structure", "required":[ "EvaluationId", "EvaluationArn" ], "members":{ "EvaluationId":{ "shape":"ResourceId", "documentation":"<p>A unique identifier for the contact evaluation.</p>" }, "EvaluationArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>" } } }, "UpdateContactFlowContentRequest":{ "type":"structure", "required":[ "InstanceId", "ContactFlowId", "Content" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ContactFlowId":{ "shape":"ContactFlowId", "documentation":"<p>The identifier of the flow.</p>", "location":"uri", "locationName":"ContactFlowId" }, "Content":{ "shape":"ContactFlowContent", "documentation":"<p>The JSON string that represents the content of the flow. For an example, see <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html\">Example flow in Amazon Connect Flow language</a>. </p> <p>Length Constraints: Minimum length of 1. Maximum length of 256000.</p>" } } }, "UpdateContactFlowContentResponse":{ "type":"structure", "members":{} }, "UpdateContactFlowMetadataRequest":{ "type":"structure", "required":[ "InstanceId", "ContactFlowId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ContactFlowId":{ "shape":"ContactFlowId", "documentation":"<p>The identifier of the flow.</p>", "location":"uri", "locationName":"ContactFlowId" }, "Name":{ "shape":"ContactFlowName", "documentation":"<p>The name of the flow.</p>" }, "Description":{ "shape":"ContactFlowDescription", "documentation":"<p>The description of the flow.</p>" }, "ContactFlowState":{ "shape":"ContactFlowState", "documentation":"<p>The state of flow.</p>" } } }, "UpdateContactFlowMetadataResponse":{ "type":"structure", "members":{} }, "UpdateContactFlowModuleContentRequest":{ "type":"structure", "required":[ "InstanceId", "ContactFlowModuleId", "Content" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ContactFlowModuleId":{ "shape":"ContactFlowModuleId", "documentation":"<p>The identifier of the flow module.</p>", "location":"uri", "locationName":"ContactFlowModuleId" }, "Content":{ "shape":"ContactFlowModuleContent", "documentation":"<p>The JSON string that represents the content of the flow. For an example, see <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html\">Example flow in Amazon Connect Flow language</a>. </p>" } } }, "UpdateContactFlowModuleContentResponse":{ "type":"structure", "members":{} }, "UpdateContactFlowModuleMetadataRequest":{ "type":"structure", "required":[ "InstanceId", "ContactFlowModuleId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ContactFlowModuleId":{ "shape":"ContactFlowModuleId", "documentation":"<p>The identifier of the flow module.</p>", "location":"uri", "locationName":"ContactFlowModuleId" }, "Name":{ "shape":"ContactFlowModuleName", "documentation":"<p>The name of the flow module.</p>" }, "Description":{ "shape":"ContactFlowModuleDescription", "documentation":"<p>The description of the flow module.</p>" }, "State":{ "shape":"ContactFlowModuleState", "documentation":"<p>The state of flow module.</p>" } } }, "UpdateContactFlowModuleMetadataResponse":{ "type":"structure", "members":{} }, "UpdateContactFlowNameRequest":{ "type":"structure", "required":[ "InstanceId", "ContactFlowId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ContactFlowId":{ "shape":"ContactFlowId", "documentation":"<p>The identifier of the flow.</p>", "location":"uri", "locationName":"ContactFlowId" }, "Name":{ "shape":"ContactFlowName", "documentation":"<p>The name of the flow.</p>" }, "Description":{ "shape":"ContactFlowDescription", "documentation":"<p>The description of the flow.</p>" } } }, "UpdateContactFlowNameResponse":{ "type":"structure", "members":{} }, "UpdateContactRequest":{ "type":"structure", "required":[ "InstanceId", "ContactId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.</p>", "location":"uri", "locationName":"ContactId" }, "Name":{ "shape":"Name", "documentation":"<p>The name of the contact.</p>" }, "Description":{ "shape":"Description", "documentation":"<p>The description of the contact.</p>" }, "References":{ "shape":"ContactReferences", "documentation":"<p>Well-formed data on contact, shown to agents on Contact Control Panel (CCP).</p>" }, "SegmentAttributes":{ "shape":"SegmentAttributes", "documentation":"<p>A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.</p> <p>Attribute keys can include only alphanumeric, -, and _.</p> <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p> <p>Currently Contact Expiry is the only segment attribute which can be updated by using the UpdateContact API.</p>" }, "QueueInfo":{ "shape":"QueueInfoInput", "documentation":"<p> Information about the queue associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html\">Amazon Connect Contact Lens integration</a> in the <i> Amazon Connect Administrator Guide</i>.</p>" }, "UserInfo":{ "shape":"UserInfo", "documentation":"<p>Information about the agent associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html\">Amazon Connect Contact Lens integration</a> in the <i> Amazon Connect Administrator Guide</i>.</p>" }, "CustomerEndpoint":{ "shape":"Endpoint", "documentation":"<p>The endpoint of the customer for which the contact was initiated. For external audio contacts, this is usually the end customer's phone number. This value can only be updated for external audio contacts. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html\">Amazon Connect Contact Lens integration</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, "SystemEndpoint":{ "shape":"Endpoint", "documentation":"<p>External system endpoint for the contact was initiated. For external audio contacts, this is the phone number of the external system such as the contact center. This value can only be updated for external audio contacts. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html\">Amazon Connect Contact Lens integration</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" } } }, "UpdateContactResponse":{ "type":"structure", "members":{} }, "UpdateContactRoutingDataRequest":{ "type":"structure", "required":[ "InstanceId", "ContactId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact in this instance of Amazon Connect. </p>", "location":"uri", "locationName":"ContactId" }, "QueueTimeAdjustmentSeconds":{ "shape":"QueueTimeAdjustmentSeconds", "documentation":"<p>The number of seconds to add or subtract from the contact's routing age. Contacts are routed to agents on a first-come, first-serve basis. This means that changing their amount of time in queue compared to others also changes their position in queue.</p>" }, "QueuePriority":{ "shape":"QueuePriority", "documentation":"<p>Priority of the contact in the queue. The default priority for new contacts is 5. You can raise the priority of a contact compared to other contacts in the queue by assigning them a higher priority, such as 1 or 2.</p>" }, "RoutingCriteria":{ "shape":"RoutingCriteriaInput", "documentation":"<p>Updates the routing criteria on the contact. These properties can be used to change how a&#x2028; contact is routed within the queue.</p>" } } }, "UpdateContactRoutingDataResponse":{ "type":"structure", "members":{} }, "UpdateContactScheduleRequest":{ "type":"structure", "required":[ "InstanceId", "ContactId", "ScheduledTime" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact.</p>" }, "ScheduledTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future. </p>" } } }, "UpdateContactScheduleResponse":{ "type":"structure", "members":{} }, "UpdateEmailAddressMetadataRequest":{ "type":"structure", "required":[ "InstanceId", "EmailAddressId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "EmailAddressId":{ "shape":"EmailAddressId", "documentation":"<p>The identifier of the email address.</p>", "location":"uri", "locationName":"EmailAddressId" }, "Description":{ "shape":"Description", "documentation":"<p>The description of the email address.</p>" }, "DisplayName":{ "shape":"EmailAddressDisplayName", "documentation":"<p>The display name of email address.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>" } } }, "UpdateEmailAddressMetadataResponse":{ "type":"structure", "members":{ "EmailAddressId":{ "shape":"EmailAddressId", "documentation":"<p>The identifier of the email address.</p>" }, "EmailAddressArn":{ "shape":"EmailAddressArn", "documentation":"<p>The Amazon Resource Name (ARN) of the email address.</p>" } } }, "UpdateEvaluationFormRequest":{ "type":"structure", "required":[ "InstanceId", "EvaluationFormId", "EvaluationFormVersion", "Title", "Items" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "EvaluationFormId":{ "shape":"ResourceId", "documentation":"<p>The unique identifier for the evaluation form.</p>", "location":"uri", "locationName":"EvaluationFormId" }, "EvaluationFormVersion":{ "shape":"VersionNumber", "documentation":"<p>A version of the evaluation form to update.</p>" }, "CreateNewVersion":{ "shape":"BoxedBoolean", "documentation":"<p>A flag indicating whether the operation must create a new version.</p>", "box":true }, "Title":{ "shape":"EvaluationFormTitle", "documentation":"<p>A title of the evaluation form.</p>" }, "Description":{ "shape":"EvaluationFormDescription", "documentation":"<p>The description of the evaluation form.</p>" }, "Items":{ "shape":"EvaluationFormItemsList", "documentation":"<p>Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.</p>" }, "ScoringStrategy":{ "shape":"EvaluationFormScoringStrategy", "documentation":"<p>A scoring strategy of the evaluation form.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true } } }, "UpdateEvaluationFormResponse":{ "type":"structure", "required":[ "EvaluationFormId", "EvaluationFormArn", "EvaluationFormVersion" ], "members":{ "EvaluationFormId":{ "shape":"ResourceId", "documentation":"<p>The unique identifier for the evaluation form.</p>" }, "EvaluationFormArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>" }, "EvaluationFormVersion":{ "shape":"VersionNumber", "documentation":"<p>The version of the updated evaluation form resource.</p>" } } }, "UpdateHoursOfOperationDescription":{ "type":"string", "max":250, "min":0 }, "UpdateHoursOfOperationOverrideRequest":{ "type":"structure", "required":[ "InstanceId", "HoursOfOperationId", "HoursOfOperationOverrideId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance.</p>", "location":"uri", "locationName":"InstanceId" }, "HoursOfOperationId":{ "shape":"HoursOfOperationId", "documentation":"<p>The identifier for the hours of operation.</p>", "location":"uri", "locationName":"HoursOfOperationId" }, "HoursOfOperationOverrideId":{ "shape":"HoursOfOperationOverrideId", "documentation":"<p>The identifier for the hours of operation override.</p>", "location":"uri", "locationName":"HoursOfOperationOverrideId" }, "Name":{ "shape":"CommonHumanReadableName", "documentation":"<p>The name of the hours of operation override.</p>" }, "Description":{ "shape":"CommonHumanReadableDescription", "documentation":"<p>The description of the hours of operation override.</p>" }, "Config":{ "shape":"HoursOfOperationOverrideConfigList", "documentation":"<p>Configuration information for the hours of operation override: day, start time, and end time.</p>" }, "EffectiveFrom":{ "shape":"HoursOfOperationOverrideYearMonthDayDateFormat", "documentation":"<p>The date from when the hours of operation override would be effective.</p>" }, "EffectiveTill":{ "shape":"HoursOfOperationOverrideYearMonthDayDateFormat", "documentation":"<p>The date till when the hours of operation override would be effective.</p>" } } }, "UpdateHoursOfOperationRequest":{ "type":"structure", "required":[ "InstanceId", "HoursOfOperationId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "HoursOfOperationId":{ "shape":"HoursOfOperationId", "documentation":"<p>The identifier of the hours of operation.</p>", "location":"uri", "locationName":"HoursOfOperationId" }, "Name":{ "shape":"CommonNameLength127", "documentation":"<p>The name of the hours of operation.</p>" }, "Description":{ "shape":"UpdateHoursOfOperationDescription", "documentation":"<p>The description of the hours of operation.</p>" }, "TimeZone":{ "shape":"TimeZone", "documentation":"<p>The time zone of the hours of operation.</p>" }, "Config":{ "shape":"HoursOfOperationConfigList", "documentation":"<p>Configuration information of the hours of operation.</p>" } } }, "UpdateInstanceAttributeRequest":{ "type":"structure", "required":[ "InstanceId", "AttributeType", "Value" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "AttributeType":{ "shape":"InstanceAttributeType", "documentation":"<p>The type of attribute.</p> <note> <p>Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, contact Amazon Web ServicesSupport for allowlisting.</p> </note>", "location":"uri", "locationName":"AttributeType" }, "Value":{ "shape":"InstanceAttributeValue", "documentation":"<p>The value for the attribute. Maximum character limit is 100. </p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true } } }, "UpdateInstanceStorageConfigRequest":{ "type":"structure", "required":[ "InstanceId", "AssociationId", "ResourceType", "StorageConfig" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "AssociationId":{ "shape":"AssociationId", "documentation":"<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>", "location":"uri", "locationName":"AssociationId" }, "ResourceType":{ "shape":"InstanceStorageResourceType", "documentation":"<p>A valid resource type.</p>", "location":"querystring", "locationName":"resourceType" }, "StorageConfig":{"shape":"InstanceStorageConfig"}, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true } } }, "UpdateParticipantAuthenticationRequest":{ "type":"structure", "required":[ "State", "InstanceId" ], "members":{ "State":{ "shape":"ParticipantToken", "documentation":"<p>The <code>state</code> query parameter that was provided by Cognito in the <code>redirectUri</code>. This will also match the <code>state</code> parameter provided in the <code>AuthenticationUrl</code> from the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_GetAuthenticationUrl.html\">GetAuthenticationUrl</a> response.</p>" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "Code":{ "shape":"AuthorizationCode", "documentation":"<p>The <code>code</code> query parameter provided by Cognito in the <code>redirectUri</code>.</p>" }, "Error":{ "shape":"AuthenticationError", "documentation":"<p>The <code>error</code> query parameter provided by Cognito in the <code>redirectUri</code>.</p>" }, "ErrorDescription":{ "shape":"AuthenticationErrorDescription", "documentation":"<p>The <code>error_description</code> parameter provided by Cognito in the <code>redirectUri</code>.</p>" } } }, "UpdateParticipantAuthenticationResponse":{ "type":"structure", "members":{} }, "UpdateParticipantRoleConfigChannelInfo":{ "type":"structure", "members":{ "Chat":{ "shape":"ChatParticipantRoleConfig", "documentation":"<p>Configuration information for the chat participant role.</p>" } }, "documentation":"<p>Configuration information for the chat participant role.</p>", "union":true }, "UpdateParticipantRoleConfigRequest":{ "type":"structure", "required":[ "InstanceId", "ContactId", "ChannelConfiguration" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ContactId":{ "shape":"ContactId", "documentation":"<p>The identifier of the contact in this instance of Amazon Connect. </p>", "location":"uri", "locationName":"ContactId" }, "ChannelConfiguration":{ "shape":"UpdateParticipantRoleConfigChannelInfo", "documentation":"<p>The Amazon Connect channel you want to configure.</p>" } } }, "UpdateParticipantRoleConfigResponse":{ "type":"structure", "members":{} }, "UpdatePhoneNumberMetadataRequest":{ "type":"structure", "required":["PhoneNumberId"], "members":{ "PhoneNumberId":{ "shape":"PhoneNumberId", "documentation":"<p>The Amazon Resource Name (ARN) or resource ID of the phone number.</p>", "location":"uri", "locationName":"PhoneNumberId" }, "PhoneNumberDescription":{ "shape":"PhoneNumberDescription", "documentation":"<p>The description of the phone number.</p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true } } }, "UpdatePhoneNumberRequest":{ "type":"structure", "required":["PhoneNumberId"], "members":{ "PhoneNumberId":{ "shape":"PhoneNumberId", "documentation":"<p>A unique identifier for the phone number.</p>", "location":"uri", "locationName":"PhoneNumberId" }, "TargetArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance that phone numbers are claimed to. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>" }, "ClientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", "idempotencyToken":true } } }, "UpdatePhoneNumberResponse":{ "type":"structure", "members":{ "PhoneNumberId":{ "shape":"PhoneNumberId", "documentation":"<p>A unique identifier for the phone number.</p>" }, "PhoneNumberArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the phone number.</p>" } } }, "UpdatePredefinedAttributeRequest":{ "type":"structure", "required":[ "InstanceId", "Name" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Name":{ "shape":"PredefinedAttributeName", "documentation":"<p>The name of the predefined attribute.</p>", "location":"uri", "locationName":"Name" }, "Values":{ "shape":"PredefinedAttributeValues", "documentation":"<p>The values of the predefined attribute.</p>" } } }, "UpdatePromptRequest":{ "type":"structure", "required":[ "InstanceId", "PromptId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "PromptId":{ "shape":"PromptId", "documentation":"<p>A unique identifier for the prompt.</p>", "location":"uri", "locationName":"PromptId" }, "Name":{ "shape":"CommonNameLength127", "documentation":"<p>The name of the prompt.</p>" }, "Description":{ "shape":"PromptDescription", "documentation":"<p>A description of the prompt.</p>" }, "S3Uri":{ "shape":"S3Uri", "documentation":"<p>The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_GetPromptFile.html\">GetPromptFile</a> API instead of providing S3 URIs.</p>" } } }, "UpdatePromptResponse":{ "type":"structure", "members":{ "PromptARN":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the prompt.</p>" }, "PromptId":{ "shape":"PromptId", "documentation":"<p>A unique identifier for the prompt.</p>" } } }, "UpdateQueueHoursOfOperationRequest":{ "type":"structure", "required":[ "InstanceId", "QueueId", "HoursOfOperationId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "QueueId":{ "shape":"QueueId", "documentation":"<p>The identifier for the queue.</p>", "location":"uri", "locationName":"QueueId" }, "HoursOfOperationId":{ "shape":"HoursOfOperationId", "documentation":"<p>The identifier for the hours of operation.</p>" } } }, "UpdateQueueMaxContactsRequest":{ "type":"structure", "required":[ "InstanceId", "QueueId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "QueueId":{ "shape":"QueueId", "documentation":"<p>The identifier for the queue.</p>", "location":"uri", "locationName":"QueueId" }, "MaxContacts":{ "shape":"QueueMaxContacts", "documentation":"<p>The maximum number of contacts that can be in the queue before it is considered full.</p>", "box":true } } }, "UpdateQueueNameRequest":{ "type":"structure", "required":[ "InstanceId", "QueueId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "QueueId":{ "shape":"QueueId", "documentation":"<p>The identifier for the queue.</p>", "location":"uri", "locationName":"QueueId" }, "Name":{ "shape":"CommonNameLength127", "documentation":"<p>The name of the queue.</p>" }, "Description":{ "shape":"QueueDescription", "documentation":"<p>The description of the queue.</p>" } } }, "UpdateQueueOutboundCallerConfigRequest":{ "type":"structure", "required":[ "InstanceId", "QueueId", "OutboundCallerConfig" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "QueueId":{ "shape":"QueueId", "documentation":"<p>The identifier for the queue.</p>", "location":"uri", "locationName":"QueueId" }, "OutboundCallerConfig":{ "shape":"OutboundCallerConfig", "documentation":"<p>The outbound caller ID name, number, and outbound whisper flow.</p>" } } }, "UpdateQueueOutboundEmailConfigRequest":{ "type":"structure", "required":[ "InstanceId", "QueueId", "OutboundEmailConfig" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "QueueId":{ "shape":"QueueId", "documentation":"<p>The identifier for the queue.</p>", "location":"uri", "locationName":"QueueId" }, "OutboundEmailConfig":{ "shape":"OutboundEmailConfig", "documentation":"<p>The outbound email address ID for a specified queue.</p>" } } }, "UpdateQueueStatusRequest":{ "type":"structure", "required":[ "InstanceId", "QueueId", "Status" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "QueueId":{ "shape":"QueueId", "documentation":"<p>The identifier for the queue.</p>", "location":"uri", "locationName":"QueueId" }, "Status":{ "shape":"QueueStatus", "documentation":"<p>The status of the queue.</p>" } } }, "UpdateQuickConnectConfigRequest":{ "type":"structure", "required":[ "InstanceId", "QuickConnectId", "QuickConnectConfig" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "QuickConnectId":{ "shape":"QuickConnectId", "documentation":"<p>The identifier for the quick connect.</p>", "location":"uri", "locationName":"QuickConnectId" }, "QuickConnectConfig":{ "shape":"QuickConnectConfig", "documentation":"<p>Information about the configuration settings for the quick connect.</p>" } } }, "UpdateQuickConnectDescription":{ "type":"string", "max":250, "min":0 }, "UpdateQuickConnectNameRequest":{ "type":"structure", "required":[ "InstanceId", "QuickConnectId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "QuickConnectId":{ "shape":"QuickConnectId", "documentation":"<p>The identifier for the quick connect.</p>", "location":"uri", "locationName":"QuickConnectId" }, "Name":{ "shape":"QuickConnectName", "documentation":"<p>The name of the quick connect.</p>" }, "Description":{ "shape":"UpdateQuickConnectDescription", "documentation":"<p>The description of the quick connect.</p>" } } }, "UpdateRoutingProfileAgentAvailabilityTimerRequest":{ "type":"structure", "required":[ "InstanceId", "RoutingProfileId", "AgentAvailabilityTimer" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "RoutingProfileId":{ "shape":"RoutingProfileId", "documentation":"<p>The identifier of the routing profile.</p>", "location":"uri", "locationName":"RoutingProfileId" }, "AgentAvailabilityTimer":{ "shape":"AgentAvailabilityTimer", "documentation":"<p>Whether agents with this routing profile will have their routing order calculated based on <i>time since their last inbound contact</i> or <i>longest idle time</i>. </p>" } } }, "UpdateRoutingProfileConcurrencyRequest":{ "type":"structure", "required":[ "InstanceId", "RoutingProfileId", "MediaConcurrencies" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "RoutingProfileId":{ "shape":"RoutingProfileId", "documentation":"<p>The identifier of the routing profile.</p>", "location":"uri", "locationName":"RoutingProfileId" }, "MediaConcurrencies":{ "shape":"MediaConcurrencies", "documentation":"<p>The channels that agents can handle in the Contact Control Panel (CCP).</p>" } } }, "UpdateRoutingProfileDefaultOutboundQueueRequest":{ "type":"structure", "required":[ "InstanceId", "RoutingProfileId", "DefaultOutboundQueueId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "RoutingProfileId":{ "shape":"RoutingProfileId", "documentation":"<p>The identifier of the routing profile.</p>", "location":"uri", "locationName":"RoutingProfileId" }, "DefaultOutboundQueueId":{ "shape":"QueueId", "documentation":"<p>The identifier for the default outbound queue.</p>" } } }, "UpdateRoutingProfileNameRequest":{ "type":"structure", "required":[ "InstanceId", "RoutingProfileId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "RoutingProfileId":{ "shape":"RoutingProfileId", "documentation":"<p>The identifier of the routing profile.</p>", "location":"uri", "locationName":"RoutingProfileId" }, "Name":{ "shape":"RoutingProfileName", "documentation":"<p>The name of the routing profile. Must not be more than 127 characters.</p>" }, "Description":{ "shape":"RoutingProfileDescription", "documentation":"<p>The description of the routing profile. Must not be more than 250 characters.</p>" } } }, "UpdateRoutingProfileQueuesRequest":{ "type":"structure", "required":[ "InstanceId", "RoutingProfileId", "QueueConfigs" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "RoutingProfileId":{ "shape":"RoutingProfileId", "documentation":"<p>The identifier of the routing profile.</p>", "location":"uri", "locationName":"RoutingProfileId" }, "QueueConfigs":{ "shape":"RoutingProfileQueueConfigList", "documentation":"<p>The queues to be updated for this routing profile. Queues must first be associated to the routing profile. You can do this using AssociateRoutingProfileQueues.</p>" } } }, "UpdateRuleRequest":{ "type":"structure", "required":[ "RuleId", "InstanceId", "Name", "Function", "Actions", "PublishStatus" ], "members":{ "RuleId":{ "shape":"RuleId", "documentation":"<p>A unique identifier for the rule.</p>", "location":"uri", "locationName":"RuleId" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Name":{ "shape":"RuleName", "documentation":"<p>The name of the rule. You can change the name only if <code>TriggerEventSource</code> is one of the following values: <code>OnZendeskTicketCreate</code> | <code>OnZendeskTicketStatusUpdate</code> | <code>OnSalesforceCaseCreate</code> </p>" }, "Function":{ "shape":"RuleFunction", "documentation":"<p>The conditions of the rule.</p>" }, "Actions":{ "shape":"RuleActions", "documentation":"<p>A list of actions to be run when the rule is triggered.</p>" }, "PublishStatus":{ "shape":"RulePublishStatus", "documentation":"<p>The publish status of the rule.</p>" } } }, "UpdateSecurityProfileRequest":{ "type":"structure", "required":[ "SecurityProfileId", "InstanceId" ], "members":{ "Description":{ "shape":"SecurityProfileDescription", "documentation":"<p>The description of the security profile.</p>" }, "Permissions":{ "shape":"PermissionsList", "documentation":"<p>The permissions granted to a security profile. For a list of valid permissions, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html\">List of security profile permissions</a>.</p>" }, "SecurityProfileId":{ "shape":"SecurityProfileId", "documentation":"<p>The identifier for the security profle.</p>", "location":"uri", "locationName":"SecurityProfileId" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "AllowedAccessControlTags":{ "shape":"AllowedAccessControlTags", "documentation":"<p>The list of tags that a security profile uses to restrict access to resources in Amazon Connect.</p>" }, "TagRestrictedResources":{ "shape":"TagRestrictedResourceList", "documentation":"<p>The list of resources that a security profile applies tag restrictions to in Amazon Connect.</p>" }, "Applications":{ "shape":"Applications", "documentation":"<p>A list of the third-party application's metadata.</p>" }, "HierarchyRestrictedResources":{ "shape":"HierarchyRestrictedResourceList", "documentation":"<p>The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: <code>User</code>.</p>" }, "AllowedAccessControlHierarchyGroupId":{ "shape":"HierarchyGroupId", "documentation":"<p>The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.</p>" } } }, "UpdateTaskTemplateRequest":{ "type":"structure", "required":[ "TaskTemplateId", "InstanceId" ], "members":{ "TaskTemplateId":{ "shape":"TaskTemplateId", "documentation":"<p>A unique identifier for the task template.</p>", "location":"uri", "locationName":"TaskTemplateId" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "Name":{ "shape":"TaskTemplateName", "documentation":"<p>The name of the task template.</p>" }, "Description":{ "shape":"TaskTemplateDescription", "documentation":"<p>The description of the task template.</p>" }, "ContactFlowId":{ "shape":"ContactFlowId", "documentation":"<p>The identifier of the flow that runs by default when a task is created by referencing this template.</p>" }, "SelfAssignFlowId":{ "shape":"ContactFlowId", "documentation":"<p>The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.</p>" }, "Constraints":{ "shape":"TaskTemplateConstraints", "documentation":"<p>Constraints that are applicable to the fields listed.</p>" }, "Defaults":{ "shape":"TaskTemplateDefaults", "documentation":"<p>The default values for fields when a task is created by referencing this template.</p>" }, "Status":{ "shape":"TaskTemplateStatus", "documentation":"<p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it. Tasks can only be created from <code>ACTIVE</code> templates. If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.</p>" }, "Fields":{ "shape":"TaskTemplateFields", "documentation":"<p>Fields that are part of the template.</p>" } } }, "UpdateTaskTemplateResponse":{ "type":"structure", "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "Id":{ "shape":"TaskTemplateId", "documentation":"<p>The identifier of the task template resource.</p>" }, "Arn":{ "shape":"TaskTemplateArn", "documentation":"<p>The Amazon Resource Name (ARN) for the task template resource.</p>" }, "Name":{ "shape":"TaskTemplateName", "documentation":"<p>The name of the task template.</p>" }, "Description":{ "shape":"TaskTemplateDescription", "documentation":"<p>The description of the task template.</p>" }, "ContactFlowId":{ "shape":"ContactFlowId", "documentation":"<p>The identifier of the flow that runs by default when a task is created by referencing this template.</p>" }, "SelfAssignFlowId":{ "shape":"ContactFlowId", "documentation":"<p>The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.</p>" }, "Constraints":{ "shape":"TaskTemplateConstraints", "documentation":"<p>Constraints that are applicable to the fields listed.</p>" }, "Defaults":{ "shape":"TaskTemplateDefaults", "documentation":"<p>The default values for fields when a task is created by referencing this template.</p>" }, "Fields":{ "shape":"TaskTemplateFields", "documentation":"<p>Fields that are part of the template.</p>" }, "Status":{ "shape":"TaskTemplateStatus", "documentation":"<p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it. Tasks can only be created from <code>ACTIVE</code> templates. If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.</p>" }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"<p>The timestamp when the task template was last modified.</p>" }, "CreatedTime":{ "shape":"timestamp", "documentation":"<p>The timestamp when the task template was created.</p>" } } }, "UpdateTrafficDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"TrafficDistributionGroupIdOrArn", "documentation":"<p>The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region. </p>", "location":"uri", "locationName":"Id" }, "TelephonyConfig":{ "shape":"TelephonyConfig", "documentation":"<p>The distribution of traffic between the instance and its replica(s).</p>" }, "SignInConfig":{ "shape":"SignInConfig", "documentation":"<p>The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s).</p>" }, "AgentConfig":{ "shape":"AgentConfig", "documentation":"<p>The distribution of agents between the instance and its replica(s).</p>" } } }, "UpdateTrafficDistributionResponse":{ "type":"structure", "members":{} }, "UpdateUserHierarchyGroupNameRequest":{ "type":"structure", "required":[ "Name", "HierarchyGroupId", "InstanceId" ], "members":{ "Name":{ "shape":"HierarchyGroupName", "documentation":"<p>The name of the hierarchy group. Must not be more than 100 characters.</p>" }, "HierarchyGroupId":{ "shape":"HierarchyGroupId", "documentation":"<p>The identifier of the hierarchy group.</p>", "location":"uri", "locationName":"HierarchyGroupId" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" } } }, "UpdateUserHierarchyRequest":{ "type":"structure", "required":[ "UserId", "InstanceId" ], "members":{ "HierarchyGroupId":{ "shape":"HierarchyGroupId", "documentation":"<p>The identifier of the hierarchy group.</p>" }, "UserId":{ "shape":"UserId", "documentation":"<p>The identifier of the user account.</p>", "location":"uri", "locationName":"UserId" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" } } }, "UpdateUserHierarchyStructureRequest":{ "type":"structure", "required":[ "HierarchyStructure", "InstanceId" ], "members":{ "HierarchyStructure":{ "shape":"HierarchyStructureUpdate", "documentation":"<p>The hierarchy levels to update.</p>" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" } } }, "UpdateUserIdentityInfoRequest":{ "type":"structure", "required":[ "IdentityInfo", "UserId", "InstanceId" ], "members":{ "IdentityInfo":{ "shape":"UserIdentityInfo", "documentation":"<p>The identity information for the user.</p>" }, "UserId":{ "shape":"UserId", "documentation":"<p>The identifier of the user account.</p>", "location":"uri", "locationName":"UserId" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" } } }, "UpdateUserPhoneConfigRequest":{ "type":"structure", "required":[ "PhoneConfig", "UserId", "InstanceId" ], "members":{ "PhoneConfig":{ "shape":"UserPhoneConfig", "documentation":"<p>Information about phone configuration settings for the user.</p>" }, "UserId":{ "shape":"UserId", "documentation":"<p>The identifier of the user account.</p>", "location":"uri", "locationName":"UserId" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" } } }, "UpdateUserProficienciesRequest":{ "type":"structure", "required":[ "InstanceId", "UserId", "UserProficiencies" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"<p> The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "UserId":{ "shape":"UserId", "documentation":"<p>The identifier of the user account.</p>", "location":"uri", "locationName":"UserId" }, "UserProficiencies":{ "shape":"UserProficiencyList", "documentation":"<p>The proficiencies to be updated for the user. Proficiencies must first be associated to the user. You can do this using AssociateUserProficiencies API.</p>" } } }, "UpdateUserRoutingProfileRequest":{ "type":"structure", "required":[ "RoutingProfileId", "UserId", "InstanceId" ], "members":{ "RoutingProfileId":{ "shape":"RoutingProfileId", "documentation":"<p>The identifier of the routing profile for the user.</p>" }, "UserId":{ "shape":"UserId", "documentation":"<p>The identifier of the user account.</p>", "location":"uri", "locationName":"UserId" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" } } }, "UpdateUserSecurityProfilesRequest":{ "type":"structure", "required":[ "SecurityProfileIds", "UserId", "InstanceId" ], "members":{ "SecurityProfileIds":{ "shape":"SecurityProfileIds", "documentation":"<p>The identifiers of the security profiles for the user.</p>" }, "UserId":{ "shape":"UserId", "documentation":"<p>The identifier of the user account.</p>", "location":"uri", "locationName":"UserId" }, "InstanceId":{ "shape":"InstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" } } }, "UpdateViewContentRequest":{ "type":"structure", "required":[ "InstanceId", "ViewId", "Status", "Content" ], "members":{ "InstanceId":{ "shape":"ViewsInstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ViewId":{ "shape":"ViewId", "documentation":"<p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be used.</p>", "location":"uri", "locationName":"ViewId" }, "Status":{ "shape":"ViewStatus", "documentation":"<p>Indicates the view status as either <code>SAVED</code> or <code>PUBLISHED</code>. The <code>PUBLISHED</code> status will initiate validation on the content.</p>" }, "Content":{ "shape":"ViewInputContent", "documentation":"<p>View content containing all content necessary to render a view except for runtime input data and the runtime input schema, which is auto-generated by this operation.</p> <p>The total uncompressed content has a maximum file size of 400kB.</p>" } } }, "UpdateViewContentResponse":{ "type":"structure", "members":{ "View":{ "shape":"View", "documentation":"<p>A view resource object. Contains metadata and content necessary to render the view.</p>" } } }, "UpdateViewMetadataRequest":{ "type":"structure", "required":[ "InstanceId", "ViewId" ], "members":{ "InstanceId":{ "shape":"ViewsInstanceId", "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", "location":"uri", "locationName":"InstanceId" }, "ViewId":{ "shape":"ViewId", "documentation":"<p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be used.</p>", "location":"uri", "locationName":"ViewId" }, "Name":{ "shape":"ViewName", "documentation":"<p>The name of the view.</p>" }, "Description":{ "shape":"ViewDescription", "documentation":"<p>The description of the view.</p>" } } }, "UpdateViewMetadataResponse":{ "type":"structure", "members":{} }, "UploadUrlMetadata":{ "type":"structure", "members":{ "Url":{ "shape":"MetadataUrl", "documentation":"<p>A pre-signed S3 URL that should be used for uploading the attached file. </p>" }, "UrlExpiry":{ "shape":"ISO8601Datetime", "documentation":"<p>The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: <code>yyyy-MM-ddThh:mm:ss.SSSZ</code>. For example, <code>2019-11-08T02:41:28.172Z</code>.</p>" }, "HeadersToInclude":{ "shape":"UrlMetadataSignedHeaders", "documentation":"<p>A map of headers that should be provided when uploading the attached file. </p>" } }, "documentation":"<p>Fields required when uploading an attached file. </p>" }, "Url":{"type":"string"}, "UrlMetadataSignedHeaders":{ "type":"map", "key":{"shape":"UrlMetadataSignedHeadersKey"}, "value":{"shape":"UrlMetadataSignedHeadersValue"} }, "UrlMetadataSignedHeadersKey":{ "type":"string", "max":128, "min":1 }, "UrlMetadataSignedHeadersValue":{ "type":"string", "max":256, "min":1 }, "UrlReference":{ "type":"structure", "members":{ "Name":{ "shape":"ReferenceKey", "documentation":"<p>Identifier of the URL reference.</p>" }, "Value":{ "shape":"ReferenceValue", "documentation":"<p>A valid URL.</p>" } }, "documentation":"<p>The URL reference.</p>" }, "UseCase":{ "type":"structure", "members":{ "UseCaseId":{ "shape":"UseCaseId", "documentation":"<p>The identifier for the use case.</p>" }, "UseCaseArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the use case.</p>" }, "UseCaseType":{ "shape":"UseCaseType", "documentation":"<p>The type of use case to associate to the integration association. Each integration association can have only one of each use case type.</p>" } }, "documentation":"<p>Contains the use case.</p>" }, "UseCaseId":{ "type":"string", "max":200, "min":1 }, "UseCaseSummaryList":{ "type":"list", "member":{"shape":"UseCase"} }, "UseCaseType":{ "type":"string", "enum":[ "RULES_EVALUATION", "CONNECT_CAMPAIGNS" ] }, "User":{ "type":"structure", "members":{ "Id":{ "shape":"UserId", "documentation":"<p>The identifier of the user account.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the user account.</p>" }, "Username":{ "shape":"AgentUsername", "documentation":"<p>The user name assigned to the user account.</p>" }, "IdentityInfo":{ "shape":"UserIdentityInfo", "documentation":"<p>Information about the user identity.</p>" }, "PhoneConfig":{ "shape":"UserPhoneConfig", "documentation":"<p>Information about the phone configuration for the user.</p>" }, "DirectoryUserId":{ "shape":"DirectoryUserId", "documentation":"<p>The identifier of the user account in the directory used for identity management.</p>" }, "SecurityProfileIds":{ "shape":"SecurityProfileIds", "documentation":"<p>The identifiers of the security profiles for the user.</p>" }, "RoutingProfileId":{ "shape":"RoutingProfileId", "documentation":"<p>The identifier of the routing profile for the user.</p>" }, "HierarchyGroupId":{ "shape":"HierarchyGroupId", "documentation":"<p>The identifier of the hierarchy group for the user.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when this resource was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The Amazon Web Services Region where this resource was last modified.</p>" } }, "documentation":"<p>Contains information about a user account for an Amazon Connect instance.</p>" }, "UserData":{ "type":"structure", "members":{ "User":{ "shape":"UserReference", "documentation":"<p>Information about the user for the data that is returned. It contains the <code>resourceId</code> and ARN of the user. </p>" }, "RoutingProfile":{ "shape":"RoutingProfileReference", "documentation":"<p>Information about the routing profile that is assigned to the user.</p>" }, "HierarchyPath":{ "shape":"HierarchyPathReference", "documentation":"<p>Contains information about the levels of a hierarchy group assigned to a user.</p>" }, "Status":{ "shape":"AgentStatusReference", "documentation":"<p>The status of the agent that they manually set in their Contact Control Panel (CCP), or that the supervisor manually changes in the real-time metrics report.</p>" }, "AvailableSlotsByChannel":{ "shape":"ChannelToCountMap", "documentation":"<p>A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots. </p>" }, "MaxSlotsByChannel":{ "shape":"ChannelToCountMap", "documentation":"<p>A map of maximum slots by channel. The key is a channel name. The value is an integer: the maximum number of slots. This is calculated from <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_MediaConcurrency.html\">MediaConcurrency</a> of the <code>RoutingProfile</code> assigned to the agent. </p>" }, "ActiveSlotsByChannel":{ "shape":"ChannelToCountMap", "documentation":"<p> A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots. </p>" }, "Contacts":{ "shape":"AgentContactReferenceList", "documentation":"<p>A list of contact reference information.</p>" }, "NextStatus":{ "shape":"AgentStatusName", "documentation":"<p>The Next status of the agent.</p>" } }, "documentation":"<p>Data for a user.</p>" }, "UserDataFilters":{ "type":"structure", "members":{ "Queues":{ "shape":"Queues", "documentation":"<p>A list of up to 100 queues or ARNs.</p>" }, "ContactFilter":{ "shape":"ContactFilter", "documentation":"<p>A filter for the user data based on the contact information that is associated to the user. It contains a list of contact states. </p>" }, "RoutingProfiles":{ "shape":"RoutingProfiles", "documentation":"<p>A list of up to 100 routing profile IDs or ARNs.</p>" }, "Agents":{ "shape":"AgentsMinOneMaxHundred", "documentation":"<p>A list of up to 100 agent IDs or ARNs.</p>" }, "UserHierarchyGroups":{ "shape":"UserDataHierarchyGroups", "documentation":"<p>A UserHierarchyGroup ID or ARN.</p>" } }, "documentation":"<p>A filter for the user data.</p>" }, "UserDataHierarchyGroups":{ "type":"list", "member":{"shape":"HierarchyGroupId"}, "max":1, "min":1 }, "UserDataList":{ "type":"list", "member":{"shape":"UserData"} }, "UserHierarchyGroupList":{ "type":"list", "member":{"shape":"HierarchyGroup"} }, "UserHierarchyGroupSearchConditionList":{ "type":"list", "member":{"shape":"UserHierarchyGroupSearchCriteria"} }, "UserHierarchyGroupSearchCriteria":{ "type":"structure", "members":{ "OrConditions":{ "shape":"UserHierarchyGroupSearchConditionList", "documentation":"<p>A list of conditions which would be applied together with an OR condition.</p>" }, "AndConditions":{ "shape":"UserHierarchyGroupSearchConditionList", "documentation":"<p>A list of conditions which would be applied together with an AND condition.</p>" }, "StringCondition":{ "shape":"StringCondition", "documentation":"<p>A leaf node condition which can be used to specify a string condition.</p> <note> <p>The currently supported values for <code>FieldName</code> are <code>name</code>,&#x2028;&#x2028; <code>parentId</code>, <code>levelId</code>, and <code>resourceID</code>.</p> </note>" } }, "documentation":"<p>The search criteria to be used to return userHierarchyGroup.</p>" }, "UserHierarchyGroupSearchFilter":{ "type":"structure", "members":{ "AttributeFilter":{ "shape":"ControlPlaneAttributeFilter", "documentation":"<p>An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR or AND (List of List) input where:</p> <ul> <li> <p>The top level list specifies conditions that need to be applied with <code>OR</code> operator.</p> </li> <li> <p>The inner list specifies conditions that need to be applied with <code>AND</code> operator.</p> </li> </ul>" } }, "documentation":"<p>Filters to be applied to search results.</p>" }, "UserId":{"type":"string"}, "UserIdList":{ "type":"list", "member":{"shape":"UserId"} }, "UserIdentityInfo":{ "type":"structure", "members":{ "FirstName":{ "shape":"AgentFirstName", "documentation":"<p>The first name. This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted.</p>" }, "LastName":{ "shape":"AgentLastName", "documentation":"<p>The last name. This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted.</p>" }, "Email":{ "shape":"Email", "documentation":"<p>The email address. If you are using SAML for identity management and include this parameter, an error is returned.</p>" }, "SecondaryEmail":{ "shape":"Email", "documentation":"<p>The user's secondary email address. If you provide a secondary email, the user receives email notifications - other than password reset notifications - to this email address instead of to their primary email address.</p> <p>Pattern: <code>(?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,63}</code> </p>" }, "Mobile":{ "shape":"PhoneNumber", "documentation":"<p>The user's mobile number.</p>" } }, "documentation":"<p>Contains information about the identity of a user.</p> <note> <p>For Amazon Connect instances that are created with the <code>EXISTING_DIRECTORY</code> identity management type, <code>FirstName</code>, <code>LastName</code>, and <code>Email</code> cannot be updated from within Amazon Connect because they are managed by the directory.</p> </note> <important> <p>The <code>FirstName</code> and <code>LastName</code> length constraints below apply only to instances using SAML for identity management. If you are using Amazon Connect for identity management, the length constraints are 1-255 for <code>FirstName</code>, and 1-256 for <code>LastName</code>. </p> </important>" }, "UserIdentityInfoLite":{ "type":"structure", "members":{ "FirstName":{ "shape":"AgentFirstName", "documentation":"<p>The user's first name.</p>" }, "LastName":{ "shape":"AgentLastName", "documentation":"<p>The user's last name.</p>" } }, "documentation":"<p>The user's first name and last name.</p>" }, "UserInfo":{ "type":"structure", "members":{ "UserId":{ "shape":"AgentResourceId", "documentation":"<p>The user identifier for the contact.</p>" } }, "documentation":"<p>The user details for the contact.</p>" }, "UserNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"<p>No user with the specified credentials was found in the Amazon Connect instance.</p>", "error":{"httpStatusCode":404}, "exception":true }, "UserPhoneConfig":{ "type":"structure", "required":["PhoneType"], "members":{ "PhoneType":{ "shape":"PhoneType", "documentation":"<p>The phone type.</p>" }, "AutoAccept":{ "shape":"AutoAccept", "documentation":"<p>The Auto accept setting.</p>" }, "AfterContactWorkTimeLimit":{ "shape":"AfterContactWorkTimeLimit", "documentation":"<p>The After Call Work (ACW) timeout setting, in seconds. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW. </p> <note> <p>When returned by a <code>SearchUsers</code> call, <code>AfterContactWorkTimeLimit</code> is returned in milliseconds. </p> </note>" }, "DeskPhoneNumber":{ "shape":"PhoneNumber", "documentation":"<p>The phone number for the user's desk phone.</p>" } }, "documentation":"<p>Contains information about the phone configuration settings for a user.</p>" }, "UserProficiency":{ "type":"structure", "required":[ "AttributeName", "AttributeValue", "Level" ], "members":{ "AttributeName":{ "shape":"PredefinedAttributeName", "documentation":"<p>The name of user's proficiency. You must use name of predefined attribute present in the Amazon Connect instance.</p>" }, "AttributeValue":{ "shape":"PredefinedAttributeStringValue", "documentation":"<p>The value of user's proficiency. You must use value of predefined attribute present in the Amazon Connect instance.</p>" }, "Level":{ "shape":"ProficiencyLevel", "documentation":"<p>The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.</p>" } }, "documentation":"<p>Information about proficiency of a user.</p>" }, "UserProficiencyDisassociate":{ "type":"structure", "required":[ "AttributeName", "AttributeValue" ], "members":{ "AttributeName":{ "shape":"PredefinedAttributeName", "documentation":"<p>The name of user's proficiency.</p>" }, "AttributeValue":{ "shape":"PredefinedAttributeStringValue", "documentation":"<p>The value of user's proficiency.</p>" } }, "documentation":"<p>Information about proficiency to be disassociated from the user.</p>" }, "UserProficiencyDisassociateList":{ "type":"list", "member":{"shape":"UserProficiencyDisassociate"} }, "UserProficiencyList":{ "type":"list", "member":{"shape":"UserProficiency"} }, "UserQuickConnectConfig":{ "type":"structure", "required":[ "UserId", "ContactFlowId" ], "members":{ "UserId":{ "shape":"UserId", "documentation":"<p>The identifier of the user.</p>" }, "ContactFlowId":{ "shape":"ContactFlowId", "documentation":"<p>The identifier of the flow.</p>" } }, "documentation":"<p>Contains information about the quick connect configuration settings for a user. The contact flow must be of type Transfer to Agent.</p>" }, "UserReference":{ "type":"structure", "members":{ "Id":{ "shape":"UserId", "documentation":"<p>The unique identifier for the user.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) for the user.</p>" } }, "documentation":"<p>Information about the user.</p>" }, "UserSearchConditionList":{ "type":"list", "member":{"shape":"UserSearchCriteria"} }, "UserSearchCriteria":{ "type":"structure", "members":{ "OrConditions":{ "shape":"UserSearchConditionList", "documentation":"<p>A list of conditions which would be applied together with an <code>OR</code> condition.</p>" }, "AndConditions":{ "shape":"UserSearchConditionList", "documentation":"<p>A list of conditions which would be applied together with an <code>AND</code> condition. </p>" }, "StringCondition":{ "shape":"StringCondition", "documentation":"<p>A leaf node condition which can be used to specify a string condition.</p> <p>The currently supported values for <code>FieldName</code> are <code>Username</code>, <code>FirstName</code>, <code>LastName</code>, <code>RoutingProfileId</code>, <code>SecurityProfileId</code>, <code>ResourceId</code>.</p>" }, "ListCondition":{ "shape":"ListCondition", "documentation":"<p>A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.</p>" }, "HierarchyGroupCondition":{ "shape":"HierarchyGroupCondition", "documentation":"<p>A leaf node condition which can be used to specify a hierarchy group condition.</p>" } }, "documentation":"<p>The search criteria to be used to return users.</p> <note> <p>The <code>name</code> and <code>description</code> fields support \"contains\" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. </p> </note>" }, "UserSearchFilter":{ "type":"structure", "members":{ "TagFilter":{"shape":"ControlPlaneTagFilter"}, "UserAttributeFilter":{ "shape":"ControlPlaneUserAttributeFilter", "documentation":"<p>An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the SearchFilter.</p> <p>This accepts an <code>OR</code> of <code>AND</code> (List of List) input where:</p> <ul> <li> <p>The top level list specifies conditions that need to be applied with <code>OR</code> operator.</p> </li> <li> <p>The inner list specifies conditions that need to be applied with <code>AND</code> operator.</p> </li> </ul> <note> <p>Only one field can be populated. This object can’t be used along with TagFilter. Request can either contain TagFilter or UserAttributeFilter if SearchFilter is specified, combination of both is not supported and such request will throw AccessDeniedException.</p> </note>" } }, "documentation":"<p>Filters to be applied to search results.</p>" }, "UserSearchSummary":{ "type":"structure", "members":{ "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the user.</p>" }, "DirectoryUserId":{ "shape":"DirectoryUserId", "documentation":"<p>The directory identifier of the user.</p>" }, "HierarchyGroupId":{ "shape":"HierarchyGroupId", "documentation":"<p>The identifier of the user's hierarchy group.</p>" }, "Id":{ "shape":"UserId", "documentation":"<p>The identifier of the user's summary.</p>" }, "IdentityInfo":{ "shape":"UserIdentityInfoLite", "documentation":"<p>The user's first name and last name.</p>" }, "PhoneConfig":{"shape":"UserPhoneConfig"}, "RoutingProfileId":{ "shape":"RoutingProfileId", "documentation":"<p>The identifier of the user's routing profile.</p>" }, "SecurityProfileIds":{ "shape":"SecurityProfileIds", "documentation":"<p>The identifiers of the user's security profiles.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" }, "Username":{ "shape":"AgentUsername", "documentation":"<p>The name of the user.</p>" } }, "documentation":"<p>Information about the returned users.</p>" }, "UserSearchSummaryList":{ "type":"list", "member":{"shape":"UserSearchSummary"} }, "UserSummary":{ "type":"structure", "members":{ "Id":{ "shape":"UserId", "documentation":"<p>The identifier of the user account.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the user account.</p>" }, "Username":{ "shape":"AgentUsername", "documentation":"<p>The Amazon Connect user name of the user account.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp when this resource was last modified.</p>" }, "LastModifiedRegion":{ "shape":"RegionName", "documentation":"<p>The Amazon Web Services Region where this resource was last modified.</p>" } }, "documentation":"<p>Contains summary information about a user.</p>" }, "UserSummaryList":{ "type":"list", "member":{"shape":"UserSummary"} }, "UserTagMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "Value":{"type":"double"}, "VersionNumber":{ "type":"integer", "min":1 }, "VideoCapability":{ "type":"string", "enum":["SEND"] }, "View":{ "type":"structure", "members":{ "Id":{ "shape":"ViewId", "documentation":"<p>The identifier of the view.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the view.</p>" }, "Name":{ "shape":"ViewName", "documentation":"<p>The name of the view.</p>" }, "Status":{ "shape":"ViewStatus", "documentation":"<p>Indicates the view status as either <code>SAVED</code> or <code>PUBLISHED</code>. The <code>PUBLISHED</code> status will initiate validation on the content.</p>" }, "Type":{ "shape":"ViewType", "documentation":"<p>The type of the view - <code>CUSTOMER_MANAGED</code>.</p>" }, "Description":{ "shape":"ViewDescription", "documentation":"<p>The description of the view.</p>" }, "Version":{ "shape":"ViewVersion", "documentation":"<p>Current version of the view.</p>" }, "VersionDescription":{ "shape":"ViewDescription", "documentation":"<p>The description of the version.</p>" }, "Content":{ "shape":"ViewContent", "documentation":"<p>View content containing all content necessary to render a view except for runtime input data.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags associated with the view resource (not specific to view version).</p>" }, "CreatedTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp of when the view was created.</p>" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>Latest timestamp of the <code>UpdateViewContent</code> or <code>CreateViewVersion</code> operations.</p>" }, "ViewContentSha256":{ "shape":"ViewContentSha256", "documentation":"<p>Indicates the checksum value of the latest published view content.</p>" } }, "documentation":"<p>A view resource object. Contains metadata and content necessary to render the view.</p>" }, "ViewAction":{ "type":"string", "max":255, "min":1, "pattern":"^([\\p{L}\\p{N}_.:\\/=+\\-@()']+[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@()']*)$", "sensitive":true }, "ViewActions":{ "type":"list", "member":{"shape":"ViewAction"} }, "ViewContent":{ "type":"structure", "members":{ "InputSchema":{ "shape":"ViewInputSchema", "documentation":"<p>The data schema matching data that the view template must be provided to render.</p>" }, "Template":{ "shape":"ViewTemplate", "documentation":"<p>The view template representing the structure of the view.</p>" }, "Actions":{ "shape":"ViewActions", "documentation":"<p>A list of possible actions from the view.</p>" } }, "documentation":"<p>View content containing all content necessary to render a view except for runtime input data.</p>" }, "ViewContentSha256":{ "type":"string", "max":64, "min":1, "pattern":"^[a-zA-Z0-9]$" }, "ViewDescription":{ "type":"string", "max":4096, "min":1, "pattern":"^([\\p{L}\\p{N}_.:\\/=+\\-@,()']+[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@,()']*)$" }, "ViewId":{ "type":"string", "max":500, "min":1, "pattern":"^[a-zA-Z0-9\\_\\-:\\/$]+$" }, "ViewInputContent":{ "type":"structure", "members":{ "Template":{ "shape":"ViewTemplate", "documentation":"<p>The view template representing the structure of the view.</p>" }, "Actions":{ "shape":"ViewActions", "documentation":"<p>A list of possible actions from the view.</p>" } }, "documentation":"<p>View content containing all content necessary to render a view except for runtime input data and the runtime input schema, which is auto-generated by this operation.</p>" }, "ViewInputSchema":{ "type":"string", "sensitive":true }, "ViewName":{ "type":"string", "max":255, "min":1, "pattern":"^([\\p{L}\\p{N}_.:\\/=+\\-@()']+[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@()']*)$", "sensitive":true }, "ViewStatus":{ "type":"string", "enum":[ "PUBLISHED", "SAVED" ] }, "ViewSummary":{ "type":"structure", "members":{ "Id":{ "shape":"ViewId", "documentation":"<p>The identifier of the view.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the view.</p>" }, "Name":{ "shape":"ViewName", "documentation":"<p>The name of the view.</p>" }, "Type":{ "shape":"ViewType", "documentation":"<p>The type of the view.</p>" }, "Status":{ "shape":"ViewStatus", "documentation":"<p>Indicates the view status as either <code>SAVED</code> or <code>PUBLISHED</code>. The <code>PUBLISHED</code> status will initiate validation on the content.</p>" }, "Description":{ "shape":"ViewDescription", "documentation":"<p>The description of the view.</p>" } }, "documentation":"<p>A summary of a view's metadata.</p>" }, "ViewTemplate":{"type":"string"}, "ViewType":{ "type":"string", "enum":[ "CUSTOMER_MANAGED", "AWS_MANAGED" ] }, "ViewVersion":{"type":"integer"}, "ViewVersionSummary":{ "type":"structure", "members":{ "Id":{ "shape":"ViewId", "documentation":"<p>The identifier of the view version.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the view version.</p>" }, "Description":{ "shape":"ViewDescription", "documentation":"<p>The description of the view version.</p>" }, "Name":{ "shape":"ViewName", "documentation":"<p>The name of the view version.</p>" }, "Type":{ "shape":"ViewType", "documentation":"<p>The type of the view version.</p>" }, "Version":{ "shape":"ViewVersion", "documentation":"<p>The sequentially incremented version of the view version.</p>" }, "VersionDescription":{ "shape":"ViewDescription", "documentation":"<p>The description of the view version.</p>" } }, "documentation":"<p>A summary of a view version's metadata.</p>" }, "ViewVersionSummaryList":{ "type":"list", "member":{"shape":"ViewVersionSummary"} }, "ViewsClientToken":{ "type":"string", "max":500, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)$" }, "ViewsInstanceId":{ "type":"string", "max":100, "min":1, "pattern":"^[a-zA-Z0-9\\_\\-:\\/]+$" }, "ViewsNextToken":{ "type":"string", "max":4096, "min":1, "pattern":"^[a-zA-Z0-9=\\/+_.-]+$" }, "ViewsSummaryList":{ "type":"list", "member":{"shape":"ViewSummary"} }, "Vocabulary":{ "type":"structure", "required":[ "Name", "Id", "Arn", "LanguageCode", "State", "LastModifiedTime" ], "members":{ "Name":{ "shape":"VocabularyName", "documentation":"<p>A unique name of the custom vocabulary.</p>" }, "Id":{ "shape":"VocabularyId", "documentation":"<p>The identifier of the custom vocabulary.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the custom vocabulary.</p>" }, "LanguageCode":{ "shape":"VocabularyLanguageCode", "documentation":"<p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html\">What is Amazon Transcribe?</a> </p>" }, "State":{ "shape":"VocabularyState", "documentation":"<p>The current state of the custom vocabulary.</p>" }, "LastModifiedTime":{ "shape":"VocabularyLastModifiedTime", "documentation":"<p>The timestamp when the custom vocabulary was last modified.</p>" }, "FailureReason":{ "shape":"VocabularyFailureReason", "documentation":"<p>The reason why the custom vocabulary was not created.</p>" }, "Content":{ "shape":"VocabularyContent", "documentation":"<p>The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with <code>Phrase</code>, <code>IPA</code>, <code>SoundsLike</code>, and <code>DisplayAs</code> fields. Separate the fields with TAB characters. For more information, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table\">Create a custom vocabulary using a table</a>.</p>" }, "Tags":{ "shape":"TagMap", "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" } }, "documentation":"<p>Contains information about a custom vocabulary.</p>" }, "VocabularyContent":{ "type":"string", "max":60000, "min":1 }, "VocabularyFailureReason":{"type":"string"}, "VocabularyId":{ "type":"string", "max":500, "min":1 }, "VocabularyLanguageCode":{ "type":"string", "enum":[ "ar-AE", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fr-CA", "fr-FR", "hi-IN", "it-IT", "ja-JP", "ko-KR", "pt-BR", "pt-PT", "zh-CN", "en-NZ", "en-ZA", "ca-ES", "da-DK", "fi-FI", "id-ID", "ms-MY", "nl-NL", "no-NO", "pl-PL", "sv-SE", "tl-PH" ] }, "VocabularyLastModifiedTime":{"type":"timestamp"}, "VocabularyName":{ "type":"string", "max":140, "min":1, "pattern":"^[0-9a-zA-Z._-]+" }, "VocabularyNextToken":{ "type":"string", "max":131070, "min":1, "pattern":".*\\S.*" }, "VocabularyState":{ "type":"string", "enum":[ "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED", "DELETE_IN_PROGRESS" ] }, "VocabularySummary":{ "type":"structure", "required":[ "Name", "Id", "Arn", "LanguageCode", "State", "LastModifiedTime" ], "members":{ "Name":{ "shape":"VocabularyName", "documentation":"<p>A unique name of the custom vocabulary.</p>" }, "Id":{ "shape":"VocabularyId", "documentation":"<p>The identifier of the custom vocabulary.</p>" }, "Arn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the custom vocabulary.</p>" }, "LanguageCode":{ "shape":"VocabularyLanguageCode", "documentation":"<p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html\">What is Amazon Transcribe?</a> </p>" }, "State":{ "shape":"VocabularyState", "documentation":"<p>The current state of the custom vocabulary.</p>" }, "LastModifiedTime":{ "shape":"VocabularyLastModifiedTime", "documentation":"<p>The timestamp when the custom vocabulary was last modified.</p>" }, "FailureReason":{ "shape":"VocabularyFailureReason", "documentation":"<p>The reason why the custom vocabulary was not created.</p>" } }, "documentation":"<p>Contains summary information about the custom vocabulary.</p>" }, "VocabularySummaryList":{ "type":"list", "member":{"shape":"VocabularySummary"} }, "VoiceRecordingConfiguration":{ "type":"structure", "members":{ "VoiceRecordingTrack":{ "shape":"VoiceRecordingTrack", "documentation":"<p>Identifies which track is being recorded.</p>" }, "IvrRecordingTrack":{ "shape":"IvrRecordingTrack", "documentation":"<p>Identifies which IVR track is being recorded.</p> <p>One and only one of the track configurations should be presented in the request.</p>" } }, "documentation":"<p>Contains information about the recording configuration settings.</p>" }, "VoiceRecordingTrack":{ "type":"string", "enum":[ "FROM_AGENT", "TO_AGENT", "ALL" ] }, "WisdomInfo":{ "type":"structure", "members":{ "SessionArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the Wisdom session.</p>" } }, "documentation":"<p>Information about Amazon Connect Wisdom.</p>" }, "resourceArnListMaxLimit100":{ "type":"list", "member":{"shape":"ARN"}, "max":100, "min":1 }, "timestamp":{"type":"timestamp"} }, "documentation":"<ul> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Connect_Service.html\">Amazon Connect actions</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_Types_Amazon_Connect_Service.html\">Amazon Connect data types</a> </p> </li> </ul> <p>Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center and provide reliable customer engagement at any scale.</p> <p>Amazon Connect provides metrics and real-time reporting that enable you to optimize contact routing. You can also resolve customer issues more efficiently by getting customers in touch with the appropriate agents.</p> <p>There are limits to the number of Amazon Connect resources that you can create. There are also limits to the number of requests that you can make per second. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html\">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <p>You can use an endpoint to connect programmatically to an Amazon Web Services service. For a list of Amazon Connect endpoints, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/connect_region.html\">Amazon Connect Endpoints</a>.</p>" }