1{ 2 "version": "2.0", 3 "service": "<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 connect programmatically to an Amazon Web Services service by using an endpoint. 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> <note> <p>Working with contact flows? Check out the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html\">Amazon Connect Flow language</a>.</p> </note>", 4 "operations": { 5 "AssociateApprovedOrigin": "<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>", 6 "AssociateBot": "<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>", 7 "AssociateInstanceStorageConfig": "<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>", 8 "AssociateLambdaFunction": "<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>", 9 "AssociateLexBot": "<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 bot.</p>", 10 "AssociateQueueQuickConnects": "<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>", 11 "AssociateRoutingProfileQueues": "<p>Associates a set of queues with a routing profile.</p>", 12 "AssociateSecurityKey": "<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>", 13 "CreateAgentStatus": "<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>", 14 "CreateContactFlow": "<p>Creates a contact flow for the specified Amazon Connect instance.</p> <p>You can also create and update contact flows using the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html\">Amazon Connect Flow language</a>.</p>", 15 "CreateHoursOfOperation": "<p>Creates hours of operation. </p>", 16 "CreateInstance": "<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>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>", 17 "CreateIntegrationAssociation": "<p>Creates an Amazon Web Services resource association with an Amazon Connect instance.</p>", 18 "CreateQueue": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Creates a new queue for the specified Amazon Connect instance.</p>", 19 "CreateQuickConnect": "<p>Creates a quick connect for the specified Amazon Connect instance.</p>", 20 "CreateRoutingProfile": "<p>Creates a new routing profile.</p>", 21 "CreateSecurityProfile": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Creates a security profile.</p>", 22 "CreateUseCase": "<p>Creates a use case for an integration association.</p>", 23 "CreateUser": "<p>Creates a user account for the specified Amazon Connect instance.</p> <p>For information about how to create user accounts using the Amazon Connect console, 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>", 24 "CreateUserHierarchyGroup": "<p>Creates a new user hierarchy group.</p>", 25 "DeleteHoursOfOperation": "<p>Deletes an hours of operation.</p>", 26 "DeleteInstance": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Deletes the Amazon Connect instance.</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>", 27 "DeleteIntegrationAssociation": "<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>", 28 "DeleteQuickConnect": "<p>Deletes a quick connect.</p>", 29 "DeleteSecurityProfile": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Deletes a security profile.</p>", 30 "DeleteUseCase": "<p>Deletes a use case from an integration association.</p>", 31 "DeleteUser": "<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>", 32 "DeleteUserHierarchyGroup": "<p>Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.</p>", 33 "DescribeAgentStatus": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Describes an agent status.</p>", 34 "DescribeContactFlow": "<p>Describes the specified contact flow.</p> <p>You can also create and update contact flows using the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html\">Amazon Connect Flow language</a>.</p>", 35 "DescribeHoursOfOperation": "<p>Describes the hours of operation.</p>", 36 "DescribeInstance": "<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>", 37 "DescribeInstanceAttribute": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Describes the specified instance attribute.</p>", 38 "DescribeInstanceStorageConfig": "<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>", 39 "DescribeQueue": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Describes the specified queue.</p>", 40 "DescribeQuickConnect": "<p>Describes the quick connect.</p>", 41 "DescribeRoutingProfile": "<p>Describes the specified routing profile.</p>", 42 "DescribeSecurityProfile": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Gets basic information about the security profle.</p>", 43 "DescribeUser": "<p>Describes the specified user account. You can find the instance ID in the console (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>", 44 "DescribeUserHierarchyGroup": "<p>Describes the specified hierarchy group.</p>", 45 "DescribeUserHierarchyStructure": "<p>Describes the hierarchy structure of the specified Amazon Connect instance.</p>", 46 "DisassociateApprovedOrigin": "<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>", 47 "DisassociateBot": "<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>", 48 "DisassociateInstanceStorageConfig": "<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>", 49 "DisassociateLambdaFunction": "<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 contact flow blocks.</p>", 50 "DisassociateLexBot": "<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>", 51 "DisassociateQueueQuickConnects": "<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>", 52 "DisassociateRoutingProfileQueues": "<p>Disassociates a set of queues from a routing profile.</p>", 53 "DisassociateSecurityKey": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Deletes the specified security key.</p>", 54 "GetContactAttributes": "<p>Retrieves the contact attributes for the specified contact.</p>", 55 "GetCurrentMetricData": "<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/real-time-metrics-definitions.html\">Real-time Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>", 56 "GetFederationToken": "<p>Retrieves a token for federation.</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>", 57 "GetMetricData": "<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/historical-metrics-definitions.html\">Historical Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>", 58 "ListAgentStatuses": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Lists agent statuses.</p>", 59 "ListApprovedOrigins": "<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>", 60 "ListBots": "<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. </p>", 61 "ListContactFlows": "<p>Provides information about the contact flows for the specified Amazon Connect instance.</p> <p>You can also create and update contact flows using the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html\">Amazon Connect Flow language</a>.</p> <p>For more information about contact flows, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html\">Contact Flows</a> in the <i>Amazon Connect Administrator Guide</i>.</p>", 62 "ListHoursOfOperations": "<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>", 63 "ListInstanceAttributes": "<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>", 64 "ListInstanceStorageConfigs": "<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>", 65 "ListInstances": "<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>", 66 "ListIntegrationAssociations": "<p>Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.</p>", 67 "ListLambdaFunctions": "<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 contact flow blocks.</p>", 68 "ListLexBots": "<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 bots currently associated with the instance.</p>", 69 "ListPhoneNumbers": "<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>", 70 "ListPrompts": "<p>Provides information about the prompts for the specified Amazon Connect instance.</p>", 71 "ListQueueQuickConnects": "<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>", 72 "ListQueues": "<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>", 73 "ListQuickConnects": "<p>Provides information about the quick connects for the specified Amazon Connect instance. </p>", 74 "ListRoutingProfileQueues": "<p>Lists the queues associated with a routing profile.</p>", 75 "ListRoutingProfiles": "<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>", 76 "ListSecurityKeys": "<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>", 77 "ListSecurityProfilePermissions": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Lists the permissions granted to a security profile.</p>", 78 "ListSecurityProfiles": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <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>.</p>", 79 "ListTagsForResource": "<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>", 80 "ListUseCases": "<p>Lists the use cases for the integration association. </p>", 81 "ListUserHierarchyGroups": "<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>", 82 "ListUsers": "<p>Provides summary information about the users for the specified Amazon Connect instance.</p>", 83 "ResumeContactRecording": "<p>When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call.</p> <p>Only voice recordings are supported at this time.</p>", 84 "StartChatContact": "<p>Initiates a contact 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 two 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>For more information about chat, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/chat.html\">Chat</a> in the <i>Amazon Connect Administrator Guide</i>.</p>", 85 "StartContactRecording": "<p>Starts recording the contact when the agent joins the call. 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>", 86 "StartContactStreaming": "<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>", 87 "StartOutboundVoiceContact": "<p>Places an outbound call to a contact, and then initiates the contact flow. It performs the actions in the contact 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 contact 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. 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>", 88 "StartTaskContact": "<p>Initiates a contact flow to start a new task.</p>", 89 "StopContact": "<p>Ends the specified contact.</p>", 90 "StopContactRecording": "<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>", 91 "StopContactStreaming": "<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>", 92 "SuspendContactRecording": "<p>When a contact is being recorded, this API suspends recording the call. For example, you might suspend the call recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording. </p> <p>The period of time that the recording is suspended is filled with silence in the final recording. </p> <p>Only voice recordings are supported at this time.</p>", 93 "TagResource": "<p>Adds the specified tags to the specified resource.</p> <p>The supported resource types are users, routing profiles, queues, quick connects, contact flows, agent status, and hours of operation.</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>", 94 "UntagResource": "<p>Removes the specified tags from the specified resource.</p>", 95 "UpdateAgentStatus": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates agent status.</p>", 96 "UpdateContactAttributes": "<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 CTR retention and the maximum size of the CTR 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> <p> <b>Important:</b> You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, which was September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance.</p>", 97 "UpdateContactFlowContent": "<p>Updates the specified contact flow.</p> <p>You can also create and update contact flows using the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html\">Amazon Connect Flow language</a>.</p>", 98 "UpdateContactFlowName": "<p>The name of the contact flow.</p> <p>You can also create and update contact flows using the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html\">Amazon Connect Flow language</a>.</p>", 99 "UpdateHoursOfOperation": "<p>Updates the hours of operation.</p>", 100 "UpdateInstanceAttribute": "<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>", 101 "UpdateInstanceStorageConfig": "<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>", 102 "UpdateQueueHoursOfOperation": "<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>", 103 "UpdateQueueMaxContacts": "<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>", 104 "UpdateQueueName": "<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>", 105 "UpdateQueueOutboundCallerConfig": "<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>", 106 "UpdateQueueStatus": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates the status of the queue.</p>", 107 "UpdateQuickConnectConfig": "<p>Updates the configuration settings for the specified quick connect.</p>", 108 "UpdateQuickConnectName": "<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>", 109 "UpdateRoutingProfileConcurrency": "<p>Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.</p>", 110 "UpdateRoutingProfileDefaultOutboundQueue": "<p>Updates the default outbound queue of a routing profile.</p>", 111 "UpdateRoutingProfileName": "<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>", 112 "UpdateRoutingProfileQueues": "<p>Updates the properties associated with a set of queues for a routing profile.</p>", 113 "UpdateSecurityProfile": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates a security profile.</p>", 114 "UpdateUserHierarchy": "<p>Assigns the specified hierarchy group to the specified user.</p>", 115 "UpdateUserHierarchyGroupName": "<p>Updates the name of the user hierarchy group. </p>", 116 "UpdateUserHierarchyStructure": "<p>Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.</p>", 117 "UpdateUserIdentityInfo": "<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>", 118 "UpdateUserPhoneConfig": "<p>Updates the phone configuration settings for the specified user.</p>", 119 "UpdateUserRoutingProfile": "<p>Assigns the specified routing profile to the specified user.</p>", 120 "UpdateUserSecurityProfiles": "<p>Assigns the specified security profiles to the specified user.</p>" 121 }, 122 "shapes": { 123 "ARN": { 124 "base": null, 125 "refs": { 126 "AgentStatus$AgentStatusARN": "<p>The Amazon Resource Name (ARN) of the agent status.</p>", 127 "AgentStatusSummary$Arn": "<p>The Amazon Resource Name (ARN) for the agent status.</p>", 128 "ContactFlow$Arn": "<p>The Amazon Resource Name (ARN) of the contact flow.</p>", 129 "ContactFlowSummary$Arn": "<p>The Amazon Resource Name (ARN) of the contact flow.</p>", 130 "CreateAgentStatusResponse$AgentStatusARN": "<p>The Amazon Resource Name (ARN) of the agent status.</p>", 131 "CreateContactFlowResponse$ContactFlowArn": "<p>The Amazon Resource Name (ARN) of the contact flow.</p>", 132 "CreateHoursOfOperationResponse$HoursOfOperationArn": "<p>The Amazon Resource Name (ARN) for the hours of operation.</p>", 133 "CreateInstanceResponse$Arn": "<p>The Amazon Resource Name (ARN) of the instance.</p>", 134 "CreateIntegrationAssociationRequest$IntegrationArn": "<p>The Amazon Resource Name (ARN) of the integration.</p>", 135 "CreateIntegrationAssociationResponse$IntegrationAssociationArn": "<p>The Amazon Resource Name (ARN) for the association.</p>", 136 "CreateQueueResponse$QueueArn": "<p>The Amazon Resource Name (ARN) of the queue.</p>", 137 "CreateQuickConnectResponse$QuickConnectARN": "<p>The Amazon Resource Name (ARN) for the quick connect. </p>", 138 "CreateRoutingProfileResponse$RoutingProfileArn": "<p>The Amazon Resource Name (ARN) of the routing profile.</p>", 139 "CreateSecurityProfileResponse$SecurityProfileArn": "<p>The Amazon Resource Name (ARN) for the security profile.</p>", 140 "CreateUseCaseResponse$UseCaseArn": "<p>The Amazon Resource Name (ARN) for the use case.</p>", 141 "CreateUserHierarchyGroupResponse$HierarchyGroupArn": "<p>The Amazon Resource Name (ARN) of the hierarchy group. </p>", 142 "CreateUserResponse$UserArn": "<p>The Amazon Resource Name (ARN) of the user account.</p>", 143 "HierarchyGroup$Arn": "<p>The Amazon Resource Name (ARN) of the hierarchy group.</p>", 144 "HierarchyGroupSummary$Arn": "<p>The Amazon Resource Name (ARN) of the hierarchy group.</p>", 145 "HierarchyLevel$Arn": "<p>The Amazon Resource Name (ARN) of the hierarchy level.</p>", 146 "HoursOfOperation$HoursOfOperationArn": "<p>The Amazon Resource Name (ARN) for the hours of operation.</p>", 147 "HoursOfOperationSummary$Arn": "<p>The Amazon Resource Name (ARN) of the hours of operation.</p>", 148 "Instance$Arn": "<p>The Amazon Resource Name (ARN) of the instance.</p>", 149 "Instance$ServiceRole": "<p>The service role of the instance.</p>", 150 "InstanceSummary$Arn": "<p>The Amazon Resource Name (ARN) of the instance.</p>", 151 "InstanceSummary$ServiceRole": "<p>The service role of the instance.</p>", 152 "IntegrationAssociationSummary$IntegrationAssociationArn": "<p>The Amazon Resource Name (ARN) for the AppIntegration association.</p>", 153 "IntegrationAssociationSummary$IntegrationArn": "<p>The Amazon Resource Name (ARN) for the AppIntegration.</p>", 154 "KinesisFirehoseConfig$FirehoseArn": "<p>The Amazon Resource Name (ARN) of the delivery stream.</p>", 155 "KinesisStreamConfig$StreamArn": "<p>The Amazon Resource Name (ARN) of the data stream.</p>", 156 "ListTagsForResourceRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>", 157 "PhoneNumberSummary$Arn": "<p>The Amazon Resource Name (ARN) of the phone number.</p>", 158 "PromptSummary$Arn": "<p>The Amazon Resource Name (ARN) of the prompt.</p>", 159 "Queue$QueueArn": "<p>The Amazon Resource Name (ARN) for the queue.</p>", 160 "QueueReference$Arn": "<p>The Amazon Resource Name (ARN) of the queue.</p>", 161 "QueueSummary$Arn": "<p>The Amazon Resource Name (ARN) of the queue.</p>", 162 "QuickConnect$QuickConnectARN": "<p>The Amazon Resource Name (ARN) of the quick connect.</p>", 163 "QuickConnectSummary$Arn": "<p>The Amazon Resource Name (ARN) of the quick connect.</p>", 164 "ResourceInUseException$ResourceId": "<p>The identifier for the resource.</p>", 165 "RoutingProfile$RoutingProfileArn": "<p>The Amazon Resource Name (ARN) of the routing profile.</p>", 166 "RoutingProfileQueueConfigSummary$QueueArn": "<p>The Amazon Resource Name (ARN) of the queue.</p>", 167 "RoutingProfileSummary$Arn": "<p>The Amazon Resource Name (ARN) of the routing profile.</p>", 168 "SecurityProfile$Arn": "<p>The Amazon Resource Name (ARN) for the secruity profile.</p>", 169 "SecurityProfileSummary$Arn": "<p>The Amazon Resource Name (ARN) of the security profile.</p>", 170 "TagResourceRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>", 171 "UntagResourceRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>", 172 "UseCase$UseCaseArn": "<p>The Amazon Resource Name (ARN) for the use case.</p>", 173 "User$Arn": "<p>The Amazon Resource Name (ARN) of the user account.</p>", 174 "UserSummary$Arn": "<p>The Amazon Resource Name (ARN) of the user account.</p>" 175 } 176 }, 177 "AccessDeniedException": { 178 "base": "<p>You do not have sufficient access to perform this action.</p>", 179 "refs": { 180 } 181 }, 182 "AfterContactWorkTimeLimit": { 183 "base": null, 184 "refs": { 185 "UserPhoneConfig$AfterContactWorkTimeLimit": "<p>The After Call Work (ACW) timeout setting, in seconds.</p>" 186 } 187 }, 188 "AgentFirstName": { 189 "base": null, 190 "refs": { 191 "UserIdentityInfo$FirstName": "<p>The first name. This is required if you are using Amazon Connect or SAML for identity management.</p>" 192 } 193 }, 194 "AgentLastName": { 195 "base": null, 196 "refs": { 197 "UserIdentityInfo$LastName": "<p>The last name. This is required if you are using Amazon Connect or SAML for identity management.</p>" 198 } 199 }, 200 "AgentStatus": { 201 "base": "<p>Contains information about an agent status.</p>", 202 "refs": { 203 "DescribeAgentStatusResponse$AgentStatus": "<p>The agent status.</p>" 204 } 205 }, 206 "AgentStatusDescription": { 207 "base": null, 208 "refs": { 209 "AgentStatus$Description": "<p>The description of the agent status.</p>", 210 "CreateAgentStatusRequest$Description": "<p>The description of the status.</p>" 211 } 212 }, 213 "AgentStatusId": { 214 "base": null, 215 "refs": { 216 "AgentStatus$AgentStatusId": "<p>The identifier of the agent status.</p>", 217 "AgentStatusSummary$Id": "<p>The identifier for an agent status.</p>", 218 "CreateAgentStatusResponse$AgentStatusId": "<p>The identifier of the agent status.</p>", 219 "DescribeAgentStatusRequest$AgentStatusId": "<p>The identifier for the agent status.</p>", 220 "UpdateAgentStatusRequest$AgentStatusId": "<p>The identifier of the agent status.</p>" 221 } 222 }, 223 "AgentStatusName": { 224 "base": null, 225 "refs": { 226 "AgentStatus$Name": "<p>The name of the agent status.</p>", 227 "AgentStatusSummary$Name": "<p>The name of the agent status.</p>", 228 "CreateAgentStatusRequest$Name": "<p>The name of the status.</p>", 229 "UpdateAgentStatusRequest$Name": "<p>The name of the agent status.</p>" 230 } 231 }, 232 "AgentStatusOrderNumber": { 233 "base": null, 234 "refs": { 235 "AgentStatus$DisplayOrder": "<p>The display order of the agent status.</p>", 236 "CreateAgentStatusRequest$DisplayOrder": "<p>The display order of the status.</p>", 237 "UpdateAgentStatusRequest$DisplayOrder": "<p>The display order of the agent status.</p>" 238 } 239 }, 240 "AgentStatusState": { 241 "base": null, 242 "refs": { 243 "AgentStatus$State": "<p>The state of the agent status.</p>", 244 "CreateAgentStatusRequest$State": "<p>The state of the status.</p>", 245 "UpdateAgentStatusRequest$State": "<p>The state of the agent status.</p>" 246 } 247 }, 248 "AgentStatusSummary": { 249 "base": "<p>Summary information for an agent status.</p>", 250 "refs": { 251 "AgentStatusSummaryList$member": null 252 } 253 }, 254 "AgentStatusSummaryList": { 255 "base": null, 256 "refs": { 257 "ListAgentStatusResponse$AgentStatusSummaryList": "<p>A summary of agent statuses.</p>" 258 } 259 }, 260 "AgentStatusType": { 261 "base": null, 262 "refs": { 263 "AgentStatus$Type": "<p>The type of agent status.</p>", 264 "AgentStatusSummary$Type": "<p>The type of the agent status.</p>", 265 "AgentStatusTypes$member": null 266 } 267 }, 268 "AgentStatusTypes": { 269 "base": null, 270 "refs": { 271 "ListAgentStatusRequest$AgentStatusTypes": "<p>Available agent status types.</p>" 272 } 273 }, 274 "AgentUsername": { 275 "base": null, 276 "refs": { 277 "CreateUserRequest$Username": "<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>", 278 "User$Username": "<p>The user name assigned to the user account.</p>", 279 "UserSummary$Username": "<p>The Amazon Connect user name of the user account.</p>" 280 } 281 }, 282 "AliasArn": { 283 "base": null, 284 "refs": { 285 "LexV2Bot$AliasArn": "<p>The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.</p>" 286 } 287 }, 288 "AnswerMachineDetectionConfig": { 289 "base": "<p>Configuration of the answering machine detection.</p>", 290 "refs": { 291 "StartOutboundVoiceContactRequest$AnswerMachineDetectionConfig": "<p>Configuration of the answering machine detection for this outbound call. </p>" 292 } 293 }, 294 "AssociateApprovedOriginRequest": { 295 "base": null, 296 "refs": { 297 } 298 }, 299 "AssociateBotRequest": { 300 "base": null, 301 "refs": { 302 } 303 }, 304 "AssociateInstanceStorageConfigRequest": { 305 "base": null, 306 "refs": { 307 } 308 }, 309 "AssociateInstanceStorageConfigResponse": { 310 "base": null, 311 "refs": { 312 } 313 }, 314 "AssociateLambdaFunctionRequest": { 315 "base": null, 316 "refs": { 317 } 318 }, 319 "AssociateLexBotRequest": { 320 "base": null, 321 "refs": { 322 } 323 }, 324 "AssociateQueueQuickConnectsRequest": { 325 "base": null, 326 "refs": { 327 } 328 }, 329 "AssociateRoutingProfileQueuesRequest": { 330 "base": null, 331 "refs": { 332 } 333 }, 334 "AssociateSecurityKeyRequest": { 335 "base": null, 336 "refs": { 337 } 338 }, 339 "AssociateSecurityKeyResponse": { 340 "base": null, 341 "refs": { 342 } 343 }, 344 "AssociationId": { 345 "base": null, 346 "refs": { 347 "AssociateInstanceStorageConfigResponse$AssociationId": "<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>", 348 "AssociateSecurityKeyResponse$AssociationId": "<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>", 349 "DescribeInstanceStorageConfigRequest$AssociationId": "<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>", 350 "DisassociateInstanceStorageConfigRequest$AssociationId": "<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>", 351 "DisassociateSecurityKeyRequest$AssociationId": "<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>", 352 "InstanceStorageConfig$AssociationId": "<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>", 353 "SecurityKey$AssociationId": "<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>", 354 "UpdateInstanceStorageConfigRequest$AssociationId": "<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>" 355 } 356 }, 357 "Attribute": { 358 "base": "<p>A toggle for an individual feature at the instance level.</p>", 359 "refs": { 360 "AttributesList$member": null, 361 "DescribeInstanceAttributeResponse$Attribute": "<p>The type of attribute.</p>" 362 } 363 }, 364 "AttributeName": { 365 "base": null, 366 "refs": { 367 "Attributes$key": null 368 } 369 }, 370 "AttributeValue": { 371 "base": null, 372 "refs": { 373 "Attributes$value": null 374 } 375 }, 376 "Attributes": { 377 "base": null, 378 "refs": { 379 "GetContactAttributesResponse$Attributes": "<p>Information about the attributes.</p>", 380 "StartChatContactRequest$Attributes": "<p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in contact 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>", 381 "StartOutboundVoiceContactRequest$Attributes": "<p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact 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>", 382 "StartTaskContactRequest$Attributes": "<p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact 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>", 383 "UpdateContactAttributesRequest$Attributes": "<p>The Amazon Connect attributes. These attributes can be accessed in contact 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>" 384 } 385 }, 386 "AttributesList": { 387 "base": null, 388 "refs": { 389 "ListInstanceAttributesResponse$Attributes": "<p>The attribute types.</p>" 390 } 391 }, 392 "AutoAccept": { 393 "base": null, 394 "refs": { 395 "UserPhoneConfig$AutoAccept": "<p>The Auto accept setting.</p>" 396 } 397 }, 398 "Boolean": { 399 "base": null, 400 "refs": { 401 "AnswerMachineDetectionConfig$EnableAnswerMachineDetection": "<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>", 402 "AnswerMachineDetectionConfig$AwaitAnswerMachinePrompt": "<p>Wait for the answering machine prompt.</p>", 403 "UpdateAgentStatusRequest$ResetOrderNumber": "<p>A number indicating the reset order of the agent status.</p>" 404 } 405 }, 406 "BotName": { 407 "base": null, 408 "refs": { 409 "DisassociateLexBotRequest$BotName": "<p>The name of the Amazon Lex bot. Maximum character limit of 50.</p>", 410 "LexBot$Name": "<p>The name of the Amazon Lex bot.</p>" 411 } 412 }, 413 "BucketName": { 414 "base": null, 415 "refs": { 416 "S3Config$BucketName": "<p>The S3 bucket name.</p>" 417 } 418 }, 419 "CampaignId": { 420 "base": null, 421 "refs": { 422 "StartOutboundVoiceContactRequest$CampaignId": "<p>The campaign identifier of the outbound communication.</p>" 423 } 424 }, 425 "Channel": { 426 "base": null, 427 "refs": { 428 "Channels$member": null, 429 "Dimensions$Channel": "<p>The channel used for grouping and filters.</p>", 430 "MediaConcurrency$Channel": "<p>The channels that agents can handle in the Contact Control Panel (CCP).</p>", 431 "RoutingProfileQueueConfigSummary$Channel": "<p>The channels this queue supports.</p>", 432 "RoutingProfileQueueReference$Channel": "<p>The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.</p>" 433 } 434 }, 435 "Channels": { 436 "base": null, 437 "refs": { 438 "Filters$Channels": "<p>The channel to use to filter the metrics.</p>" 439 } 440 }, 441 "ChatContent": { 442 "base": null, 443 "refs": { 444 "ChatMessage$Content": "<p>The content of the chat message.</p>" 445 } 446 }, 447 "ChatContentType": { 448 "base": null, 449 "refs": { 450 "ChatMessage$ContentType": "<p>The type of the content. Supported types are text and plain.</p>" 451 } 452 }, 453 "ChatMessage": { 454 "base": "<p>A chat message.</p>", 455 "refs": { 456 "StartChatContactRequest$InitialMessage": "<p>The initial message to be sent to the newly created chat.</p>" 457 } 458 }, 459 "ChatStreamingConfiguration": { 460 "base": "<p>The streaming configuration, such as the Amazon SNS streaming endpoint.</p>", 461 "refs": { 462 "StartContactStreamingRequest$ChatStreamingConfiguration": "<p>The streaming configuration, such as the Amazon SNS streaming endpoint.</p>" 463 } 464 }, 465 "ChatStreamingEndpointARN": { 466 "base": null, 467 "refs": { 468 "ChatStreamingConfiguration$StreamingEndpointArn": "<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>" 469 } 470 }, 471 "ClientToken": { 472 "base": null, 473 "refs": { 474 "CreateInstanceRequest$ClientToken": "<p>The idempotency token.</p>", 475 "StartChatContactRequest$ClientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>", 476 "StartContactStreamingRequest$ClientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>", 477 "StartOutboundVoiceContactRequest$ClientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned. </p>", 478 "StartTaskContactRequest$ClientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>" 479 } 480 }, 481 "CommonNameLength127": { 482 "base": null, 483 "refs": { 484 "CreateHoursOfOperationRequest$Name": "<p>The name of the hours of operation.</p>", 485 "CreateQueueRequest$Name": "<p>The name of the queue.</p>", 486 "HoursOfOperation$Name": "<p>The name for the hours of operation.</p>", 487 "Queue$Name": "<p>The name of the queue.</p>", 488 "UpdateHoursOfOperationRequest$Name": "<p>The name of the hours of operation.</p>", 489 "UpdateQueueNameRequest$Name": "<p>The name of the queue.</p>" 490 } 491 }, 492 "Comparison": { 493 "base": null, 494 "refs": { 495 "Threshold$Comparison": "<p>The type of comparison. Only \"less than\" (LT) comparisons are supported.</p>" 496 } 497 }, 498 "Concurrency": { 499 "base": null, 500 "refs": { 501 "MediaConcurrency$Concurrency": "<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>" 502 } 503 }, 504 "ContactFlow": { 505 "base": "<p>Contains information about a contact flow.</p>", 506 "refs": { 507 "DescribeContactFlowResponse$ContactFlow": "<p>Information about the contact flow.</p>" 508 } 509 }, 510 "ContactFlowContent": { 511 "base": null, 512 "refs": { 513 "ContactFlow$Content": "<p>The content of the contact flow.</p>", 514 "CreateContactFlowRequest$Content": "<p>The content of the contact flow. </p>", 515 "UpdateContactFlowContentRequest$Content": "<p>The JSON string that represents contact flow’s content. For an example, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/flow-language-example.html\">Example contact flow in Amazon Connect Flow language</a> in the <i>Amazon Connect Administrator Guide</i>. </p>" 516 } 517 }, 518 "ContactFlowDescription": { 519 "base": null, 520 "refs": { 521 "ContactFlow$Description": "<p>The description of the contact flow.</p>", 522 "CreateContactFlowRequest$Description": "<p>The description of the contact flow. </p>", 523 "UpdateContactFlowNameRequest$Description": "<p>The description of the contact flow.</p>" 524 } 525 }, 526 "ContactFlowId": { 527 "base": null, 528 "refs": { 529 "ContactFlow$Id": "<p>The identifier of the contact flow.</p>", 530 "ContactFlowSummary$Id": "<p>The identifier of the contact flow.</p>", 531 "CreateContactFlowResponse$ContactFlowId": "<p>The identifier of the contact flow.</p>", 532 "DescribeContactFlowRequest$ContactFlowId": "<p>The identifier of the contact flow.</p>", 533 "OutboundCallerConfig$OutboundFlowId": "<p>The outbound whisper flow to be used during an outbound call.</p>", 534 "QueueQuickConnectConfig$ContactFlowId": "<p>The identifier of the contact flow.</p>", 535 "StartChatContactRequest$ContactFlowId": "<p>The identifier of the contact flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to <b>Routing</b>, <b>Contact Flows</b>. Choose the contact flow. On the contact flow page, under the name of the contact 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>", 536 "StartOutboundVoiceContactRequest$ContactFlowId": "<p>The identifier of the contact flow for the outbound call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to <b>Routing</b>, <b>Contact Flows</b>. Choose the contact flow. On the contact flow page, under the name of the contact 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>", 537 "StartTaskContactRequest$ContactFlowId": "<p>The identifier of the contact flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to <b>Routing</b>, <b>Contact Flows</b>. Choose the contact flow. On the contact flow page, under the name of the contact 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>", 538 "UpdateContactFlowContentRequest$ContactFlowId": "<p>The identifier of the contact flow.</p>", 539 "UpdateContactFlowNameRequest$ContactFlowId": "<p>The identifier of the contact flow.</p>", 540 "UserQuickConnectConfig$ContactFlowId": "<p>The identifier of the contact flow.</p>" 541 } 542 }, 543 "ContactFlowName": { 544 "base": null, 545 "refs": { 546 "ContactFlow$Name": "<p>The name of the contact flow.</p>", 547 "ContactFlowSummary$Name": "<p>The name of the contact flow.</p>", 548 "CreateContactFlowRequest$Name": "<p>The name of the contact flow.</p>", 549 "UpdateContactFlowNameRequest$Name": "<p>The name of the contact flow.</p>" 550 } 551 }, 552 "ContactFlowNotPublishedException": { 553 "base": "<p>The contact flow has not been published.</p>", 554 "refs": { 555 } 556 }, 557 "ContactFlowSummary": { 558 "base": "<p>Contains summary information about a contact flow.</p> <p>You can also create and update contact flows using the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html\">Amazon Connect Flow language</a>.</p>", 559 "refs": { 560 "ContactFlowSummaryList$member": null 561 } 562 }, 563 "ContactFlowSummaryList": { 564 "base": null, 565 "refs": { 566 "ListContactFlowsResponse$ContactFlowSummaryList": "<p>Information about the contact flows.</p>" 567 } 568 }, 569 "ContactFlowType": { 570 "base": null, 571 "refs": { 572 "ContactFlow$Type": "<p>The type of the contact 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 Contact Flow Type</a> in the <i>Amazon Connect Administrator Guide</i>.</p>", 573 "ContactFlowSummary$ContactFlowType": "<p>The type of contact flow.</p>", 574 "ContactFlowTypes$member": null, 575 "CreateContactFlowRequest$Type": "<p>The type of the contact 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 Contact Flow Type</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" 576 } 577 }, 578 "ContactFlowTypes": { 579 "base": null, 580 "refs": { 581 "ListContactFlowsRequest$ContactFlowTypes": "<p>The type of contact flow.</p>" 582 } 583 }, 584 "ContactId": { 585 "base": null, 586 "refs": { 587 "GetContactAttributesRequest$InitialContactId": "<p>The identifier of the initial contact.</p>", 588 "ResumeContactRecordingRequest$ContactId": "<p>The identifier of the contact.</p>", 589 "ResumeContactRecordingRequest$InitialContactId": "<p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.</p>", 590 "StartChatContactResponse$ContactId": "<p>The identifier of this contact within the Amazon Connect instance. </p>", 591 "StartContactRecordingRequest$ContactId": "<p>The identifier of the contact.</p>", 592 "StartContactRecordingRequest$InitialContactId": "<p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.</p>", 593 "StartContactStreamingRequest$ContactId": "<p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.</p>", 594 "StartOutboundVoiceContactResponse$ContactId": "<p>The identifier of this contact within the Amazon Connect instance.</p>", 595 "StartTaskContactRequest$PreviousContactId": "<p>The identifier of the previous chat, voice, or task contact. </p>", 596 "StartTaskContactResponse$ContactId": "<p>The identifier of this contact within the Amazon Connect instance.</p>", 597 "StopContactRecordingRequest$ContactId": "<p>The identifier of the contact.</p>", 598 "StopContactRecordingRequest$InitialContactId": "<p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.</p>", 599 "StopContactRequest$ContactId": "<p>The ID of the contact.</p>", 600 "StopContactStreamingRequest$ContactId": "<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>", 601 "SuspendContactRecordingRequest$ContactId": "<p>The identifier of the contact.</p>", 602 "SuspendContactRecordingRequest$InitialContactId": "<p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.</p>", 603 "UpdateContactAttributesRequest$InitialContactId": "<p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.</p>" 604 } 605 }, 606 "ContactNotFoundException": { 607 "base": "<p>The contact with the specified ID is not active or does not exist.</p>", 608 "refs": { 609 } 610 }, 611 "ContactReferences": { 612 "base": null, 613 "refs": { 614 "StartTaskContactRequest$References": "<p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP).</p>" 615 } 616 }, 617 "CreateAgentStatusRequest": { 618 "base": null, 619 "refs": { 620 } 621 }, 622 "CreateAgentStatusResponse": { 623 "base": null, 624 "refs": { 625 } 626 }, 627 "CreateContactFlowRequest": { 628 "base": null, 629 "refs": { 630 } 631 }, 632 "CreateContactFlowResponse": { 633 "base": null, 634 "refs": { 635 } 636 }, 637 "CreateHoursOfOperationRequest": { 638 "base": null, 639 "refs": { 640 } 641 }, 642 "CreateHoursOfOperationResponse": { 643 "base": null, 644 "refs": { 645 } 646 }, 647 "CreateInstanceRequest": { 648 "base": null, 649 "refs": { 650 } 651 }, 652 "CreateInstanceResponse": { 653 "base": null, 654 "refs": { 655 } 656 }, 657 "CreateIntegrationAssociationRequest": { 658 "base": null, 659 "refs": { 660 } 661 }, 662 "CreateIntegrationAssociationResponse": { 663 "base": null, 664 "refs": { 665 } 666 }, 667 "CreateQueueRequest": { 668 "base": null, 669 "refs": { 670 } 671 }, 672 "CreateQueueResponse": { 673 "base": null, 674 "refs": { 675 } 676 }, 677 "CreateQuickConnectRequest": { 678 "base": null, 679 "refs": { 680 } 681 }, 682 "CreateQuickConnectResponse": { 683 "base": null, 684 "refs": { 685 } 686 }, 687 "CreateRoutingProfileRequest": { 688 "base": null, 689 "refs": { 690 } 691 }, 692 "CreateRoutingProfileResponse": { 693 "base": null, 694 "refs": { 695 } 696 }, 697 "CreateSecurityProfileRequest": { 698 "base": null, 699 "refs": { 700 } 701 }, 702 "CreateSecurityProfileResponse": { 703 "base": null, 704 "refs": { 705 } 706 }, 707 "CreateUseCaseRequest": { 708 "base": null, 709 "refs": { 710 } 711 }, 712 "CreateUseCaseResponse": { 713 "base": null, 714 "refs": { 715 } 716 }, 717 "CreateUserHierarchyGroupRequest": { 718 "base": null, 719 "refs": { 720 } 721 }, 722 "CreateUserHierarchyGroupResponse": { 723 "base": null, 724 "refs": { 725 } 726 }, 727 "CreateUserRequest": { 728 "base": null, 729 "refs": { 730 } 731 }, 732 "CreateUserResponse": { 733 "base": null, 734 "refs": { 735 } 736 }, 737 "Credentials": { 738 "base": "<p>Contains credentials to use for federation.</p>", 739 "refs": { 740 "GetFederationTokenResponse$Credentials": "<p>The credentials to use for federation.</p>" 741 } 742 }, 743 "CurrentMetric": { 744 "base": "<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/real-time-metrics-definitions.html\">Real-time Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>", 745 "refs": { 746 "CurrentMetricData$Metric": "<p>Information about the metric.</p>", 747 "CurrentMetrics$member": null 748 } 749 }, 750 "CurrentMetricData": { 751 "base": "<p>Contains the data for a real-time metric.</p>", 752 "refs": { 753 "CurrentMetricDataCollections$member": null 754 } 755 }, 756 "CurrentMetricDataCollections": { 757 "base": null, 758 "refs": { 759 "CurrentMetricResult$Collections": "<p>The set of metrics.</p>" 760 } 761 }, 762 "CurrentMetricName": { 763 "base": "<p>The current metric names.</p>", 764 "refs": { 765 "CurrentMetric$Name": "<p>The name of the metric.</p>" 766 } 767 }, 768 "CurrentMetricResult": { 769 "base": "<p>Contains information about a set of real-time metrics.</p>", 770 "refs": { 771 "CurrentMetricResults$member": null 772 } 773 }, 774 "CurrentMetricResults": { 775 "base": null, 776 "refs": { 777 "GetCurrentMetricDataResponse$MetricResults": "<p>Information about the real-time metrics.</p>" 778 } 779 }, 780 "CurrentMetrics": { 781 "base": null, 782 "refs": { 783 "GetCurrentMetricDataRequest$CurrentMetrics": "<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/real-time-metrics-definitions.html\">Real-time 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/real-time-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/real-time-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/real-time-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/real-time-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/real-time-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/real-time-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/real-time-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/real-time-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/real-time-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/real-time-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>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-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/real-time-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/real-time-metrics-definitions.html#availability-real-time\">Availability</a> </p> </dd> </dl>" 784 } 785 }, 786 "Delay": { 787 "base": null, 788 "refs": { 789 "RoutingProfileQueueConfig$Delay": "<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>", 790 "RoutingProfileQueueConfigSummary$Delay": "<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>" 791 } 792 }, 793 "DeleteHoursOfOperationRequest": { 794 "base": null, 795 "refs": { 796 } 797 }, 798 "DeleteInstanceRequest": { 799 "base": null, 800 "refs": { 801 } 802 }, 803 "DeleteIntegrationAssociationRequest": { 804 "base": null, 805 "refs": { 806 } 807 }, 808 "DeleteQuickConnectRequest": { 809 "base": null, 810 "refs": { 811 } 812 }, 813 "DeleteSecurityProfileRequest": { 814 "base": null, 815 "refs": { 816 } 817 }, 818 "DeleteUseCaseRequest": { 819 "base": null, 820 "refs": { 821 } 822 }, 823 "DeleteUserHierarchyGroupRequest": { 824 "base": null, 825 "refs": { 826 } 827 }, 828 "DeleteUserRequest": { 829 "base": null, 830 "refs": { 831 } 832 }, 833 "DescribeAgentStatusRequest": { 834 "base": null, 835 "refs": { 836 } 837 }, 838 "DescribeAgentStatusResponse": { 839 "base": null, 840 "refs": { 841 } 842 }, 843 "DescribeContactFlowRequest": { 844 "base": null, 845 "refs": { 846 } 847 }, 848 "DescribeContactFlowResponse": { 849 "base": null, 850 "refs": { 851 } 852 }, 853 "DescribeHoursOfOperationRequest": { 854 "base": null, 855 "refs": { 856 } 857 }, 858 "DescribeHoursOfOperationResponse": { 859 "base": null, 860 "refs": { 861 } 862 }, 863 "DescribeInstanceAttributeRequest": { 864 "base": null, 865 "refs": { 866 } 867 }, 868 "DescribeInstanceAttributeResponse": { 869 "base": null, 870 "refs": { 871 } 872 }, 873 "DescribeInstanceRequest": { 874 "base": null, 875 "refs": { 876 } 877 }, 878 "DescribeInstanceResponse": { 879 "base": null, 880 "refs": { 881 } 882 }, 883 "DescribeInstanceStorageConfigRequest": { 884 "base": null, 885 "refs": { 886 } 887 }, 888 "DescribeInstanceStorageConfigResponse": { 889 "base": null, 890 "refs": { 891 } 892 }, 893 "DescribeQueueRequest": { 894 "base": null, 895 "refs": { 896 } 897 }, 898 "DescribeQueueResponse": { 899 "base": null, 900 "refs": { 901 } 902 }, 903 "DescribeQuickConnectRequest": { 904 "base": null, 905 "refs": { 906 } 907 }, 908 "DescribeQuickConnectResponse": { 909 "base": null, 910 "refs": { 911 } 912 }, 913 "DescribeRoutingProfileRequest": { 914 "base": null, 915 "refs": { 916 } 917 }, 918 "DescribeRoutingProfileResponse": { 919 "base": null, 920 "refs": { 921 } 922 }, 923 "DescribeSecurityProfileRequest": { 924 "base": null, 925 "refs": { 926 } 927 }, 928 "DescribeSecurityProfileResponse": { 929 "base": null, 930 "refs": { 931 } 932 }, 933 "DescribeUserHierarchyGroupRequest": { 934 "base": null, 935 "refs": { 936 } 937 }, 938 "DescribeUserHierarchyGroupResponse": { 939 "base": null, 940 "refs": { 941 } 942 }, 943 "DescribeUserHierarchyStructureRequest": { 944 "base": null, 945 "refs": { 946 } 947 }, 948 "DescribeUserHierarchyStructureResponse": { 949 "base": null, 950 "refs": { 951 } 952 }, 953 "DescribeUserRequest": { 954 "base": null, 955 "refs": { 956 } 957 }, 958 "DescribeUserResponse": { 959 "base": null, 960 "refs": { 961 } 962 }, 963 "Description": { 964 "base": null, 965 "refs": { 966 "StartTaskContactRequest$Description": "<p>A description of the task that is shown to an agent in the Contact Control Panel (CCP).</p>" 967 } 968 }, 969 "DestinationNotAllowedException": { 970 "base": "<p>Outbound calls to the destination number are not allowed.</p>", 971 "refs": { 972 } 973 }, 974 "Dimensions": { 975 "base": "<p>Contains information about the dimensions for a set of metrics.</p>", 976 "refs": { 977 "CurrentMetricResult$Dimensions": "<p>The dimensions for the metrics.</p>", 978 "HistoricalMetricResult$Dimensions": "<p>The dimension for the metrics.</p>" 979 } 980 }, 981 "DirectoryAlias": { 982 "base": null, 983 "refs": { 984 "CreateInstanceRequest$InstanceAlias": "<p>The name for your instance.</p>", 985 "Instance$InstanceAlias": "<p>The alias of instance.</p>", 986 "InstanceSummary$InstanceAlias": "<p>The alias of the instance.</p>" 987 } 988 }, 989 "DirectoryId": { 990 "base": null, 991 "refs": { 992 "CreateInstanceRequest$DirectoryId": "<p>The identifier for the directory.</p>" 993 } 994 }, 995 "DirectoryType": { 996 "base": null, 997 "refs": { 998 "CreateInstanceRequest$IdentityManagementType": "<p>The type of identity management for your Amazon Connect users.</p>", 999 "Instance$IdentityManagementType": "<p>The identity management type.</p>", 1000 "InstanceSummary$IdentityManagementType": "<p>The identity management type of the instance.</p>" 1001 } 1002 }, 1003 "DirectoryUserId": { 1004 "base": null, 1005 "refs": { 1006 "CreateUserRequest$DirectoryUserId": "<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>", 1007 "User$DirectoryUserId": "<p>The identifier of the user account in the directory used for identity management.</p>" 1008 } 1009 }, 1010 "DisassociateApprovedOriginRequest": { 1011 "base": null, 1012 "refs": { 1013 } 1014 }, 1015 "DisassociateBotRequest": { 1016 "base": null, 1017 "refs": { 1018 } 1019 }, 1020 "DisassociateInstanceStorageConfigRequest": { 1021 "base": null, 1022 "refs": { 1023 } 1024 }, 1025 "DisassociateLambdaFunctionRequest": { 1026 "base": null, 1027 "refs": { 1028 } 1029 }, 1030 "DisassociateLexBotRequest": { 1031 "base": null, 1032 "refs": { 1033 } 1034 }, 1035 "DisassociateQueueQuickConnectsRequest": { 1036 "base": null, 1037 "refs": { 1038 } 1039 }, 1040 "DisassociateRoutingProfileQueuesRequest": { 1041 "base": null, 1042 "refs": { 1043 } 1044 }, 1045 "DisassociateSecurityKeyRequest": { 1046 "base": null, 1047 "refs": { 1048 } 1049 }, 1050 "DisplayName": { 1051 "base": null, 1052 "refs": { 1053 "ParticipantDetails$DisplayName": "<p>Display name of the participant.</p>" 1054 } 1055 }, 1056 "DuplicateResourceException": { 1057 "base": "<p>A resource with the specified name already exists.</p>", 1058 "refs": { 1059 } 1060 }, 1061 "Email": { 1062 "base": null, 1063 "refs": { 1064 "UserIdentityInfo$Email": "<p>The email address. If you are using SAML for identity management and include this parameter, an error is returned.</p>" 1065 } 1066 }, 1067 "EncryptionConfig": { 1068 "base": "<p>The encryption configuration.</p>", 1069 "refs": { 1070 "KinesisVideoStreamConfig$EncryptionConfig": "<p>The encryption configuration.</p>", 1071 "S3Config$EncryptionConfig": "<p>The Amazon S3 encryption configuration.</p>" 1072 } 1073 }, 1074 "EncryptionType": { 1075 "base": null, 1076 "refs": { 1077 "EncryptionConfig$EncryptionType": "<p>The type of encryption.</p>" 1078 } 1079 }, 1080 "Filters": { 1081 "base": "<p>Contains the filter to apply when retrieving metrics.</p>", 1082 "refs": { 1083 "GetCurrentMetricDataRequest$Filters": "<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>", 1084 "GetMetricDataRequest$Filters": "<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> <note> <p>To filter by <code>Queues</code>, enter the queue ID/ARN, not the name of the queue.</p> </note>" 1085 } 1086 }, 1087 "FunctionArn": { 1088 "base": null, 1089 "refs": { 1090 "AssociateLambdaFunctionRequest$FunctionArn": "<p>The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is 140.</p>", 1091 "DisassociateLambdaFunctionRequest$FunctionArn": "<p>The Amazon Resource Name (ARN) of the Lambda function being disassociated.</p>", 1092 "FunctionArnsList$member": null 1093 } 1094 }, 1095 "FunctionArnsList": { 1096 "base": null, 1097 "refs": { 1098 "ListLambdaFunctionsResponse$LambdaFunctions": "<p>The Lambda function ARNs associated with the specified instance.</p>" 1099 } 1100 }, 1101 "GetContactAttributesRequest": { 1102 "base": null, 1103 "refs": { 1104 } 1105 }, 1106 "GetContactAttributesResponse": { 1107 "base": null, 1108 "refs": { 1109 } 1110 }, 1111 "GetCurrentMetricDataRequest": { 1112 "base": null, 1113 "refs": { 1114 } 1115 }, 1116 "GetCurrentMetricDataResponse": { 1117 "base": null, 1118 "refs": { 1119 } 1120 }, 1121 "GetFederationTokenRequest": { 1122 "base": null, 1123 "refs": { 1124 } 1125 }, 1126 "GetFederationTokenResponse": { 1127 "base": null, 1128 "refs": { 1129 } 1130 }, 1131 "GetMetricDataRequest": { 1132 "base": null, 1133 "refs": { 1134 } 1135 }, 1136 "GetMetricDataResponse": { 1137 "base": null, 1138 "refs": { 1139 } 1140 }, 1141 "Grouping": { 1142 "base": null, 1143 "refs": { 1144 "Groupings$member": null 1145 } 1146 }, 1147 "Groupings": { 1148 "base": null, 1149 "refs": { 1150 "GetCurrentMetricDataRequest$Groupings": "<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. If you group by <code>CHANNEL</code>, you should include a Channels filter. VOICE, CHAT, and TASK channels are supported.</p> <p>If no <code>Grouping</code> is included in the request, a summary of metrics is returned.</p>", 1151 "GetMetricDataRequest$Groupings": "<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>" 1152 } 1153 }, 1154 "HierarchyGroup": { 1155 "base": "<p>Contains information about a hierarchy group.</p>", 1156 "refs": { 1157 "DescribeUserHierarchyGroupResponse$HierarchyGroup": "<p>Information about the hierarchy group.</p>" 1158 } 1159 }, 1160 "HierarchyGroupId": { 1161 "base": null, 1162 "refs": { 1163 "CreateUserHierarchyGroupRequest$ParentGroupId": "<p>The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.</p>", 1164 "CreateUserHierarchyGroupResponse$HierarchyGroupId": "<p>The identifier of the hierarchy group.</p>", 1165 "CreateUserRequest$HierarchyGroupId": "<p>The identifier of the hierarchy group for the user.</p>", 1166 "DeleteUserHierarchyGroupRequest$HierarchyGroupId": "<p>The identifier of the hierarchy group.</p>", 1167 "DescribeUserHierarchyGroupRequest$HierarchyGroupId": "<p>The identifier of the hierarchy group.</p>", 1168 "HierarchyGroup$Id": "<p>The identifier of the hierarchy group.</p>", 1169 "HierarchyGroupSummary$Id": "<p>The identifier of the hierarchy group.</p>", 1170 "UpdateUserHierarchyGroupNameRequest$HierarchyGroupId": "<p>The identifier of the hierarchy group.</p>", 1171 "UpdateUserHierarchyRequest$HierarchyGroupId": "<p>The identifier of the hierarchy group.</p>", 1172 "User$HierarchyGroupId": "<p>The identifier of the hierarchy group for the user.</p>" 1173 } 1174 }, 1175 "HierarchyGroupName": { 1176 "base": null, 1177 "refs": { 1178 "CreateUserHierarchyGroupRequest$Name": "<p>The name of the user hierarchy group. Must not be more than 100 characters.</p>", 1179 "HierarchyGroup$Name": "<p>The name of the hierarchy group.</p>", 1180 "HierarchyGroupSummary$Name": "<p>The name of the hierarchy group.</p>", 1181 "UpdateUserHierarchyGroupNameRequest$Name": "<p>The name of the hierarchy group. Must not be more than 100 characters.</p>" 1182 } 1183 }, 1184 "HierarchyGroupSummary": { 1185 "base": "<p>Contains summary information about a hierarchy group.</p>", 1186 "refs": { 1187 "HierarchyGroupSummaryList$member": null, 1188 "HierarchyPath$LevelOne": "<p>Information about level one.</p>", 1189 "HierarchyPath$LevelTwo": "<p>Information about level two.</p>", 1190 "HierarchyPath$LevelThree": "<p>Information about level three.</p>", 1191 "HierarchyPath$LevelFour": "<p>Information about level four.</p>", 1192 "HierarchyPath$LevelFive": "<p>Information about level five.</p>" 1193 } 1194 }, 1195 "HierarchyGroupSummaryList": { 1196 "base": null, 1197 "refs": { 1198 "ListUserHierarchyGroupsResponse$UserHierarchyGroupSummaryList": "<p>Information about the hierarchy groups.</p>" 1199 } 1200 }, 1201 "HierarchyLevel": { 1202 "base": "<p>Contains information about a hierarchy level.</p>", 1203 "refs": { 1204 "HierarchyStructure$LevelOne": "<p>Information about level one.</p>", 1205 "HierarchyStructure$LevelTwo": "<p>Information about level two.</p>", 1206 "HierarchyStructure$LevelThree": "<p>Information about level three.</p>", 1207 "HierarchyStructure$LevelFour": "<p>Information about level four.</p>", 1208 "HierarchyStructure$LevelFive": "<p>Information about level five.</p>" 1209 } 1210 }, 1211 "HierarchyLevelId": { 1212 "base": null, 1213 "refs": { 1214 "HierarchyGroup$LevelId": "<p>The identifier of the level in the hierarchy group.</p>", 1215 "HierarchyLevel$Id": "<p>The identifier of the hierarchy level.</p>" 1216 } 1217 }, 1218 "HierarchyLevelName": { 1219 "base": null, 1220 "refs": { 1221 "HierarchyLevel$Name": "<p>The name of the hierarchy level.</p>", 1222 "HierarchyLevelUpdate$Name": "<p>The name of the user hierarchy level. Must not be more than 50 characters.</p>" 1223 } 1224 }, 1225 "HierarchyLevelUpdate": { 1226 "base": "<p>Contains information about the hierarchy level to update.</p>", 1227 "refs": { 1228 "HierarchyStructureUpdate$LevelOne": "<p>The update for level one.</p>", 1229 "HierarchyStructureUpdate$LevelTwo": "<p>The update for level two.</p>", 1230 "HierarchyStructureUpdate$LevelThree": "<p>The update for level three.</p>", 1231 "HierarchyStructureUpdate$LevelFour": "<p>The update for level four.</p>", 1232 "HierarchyStructureUpdate$LevelFive": "<p>The update for level five.</p>" 1233 } 1234 }, 1235 "HierarchyPath": { 1236 "base": "<p>Contains information about the levels of a hierarchy group.</p>", 1237 "refs": { 1238 "HierarchyGroup$HierarchyPath": "<p>Information about the levels in the hierarchy group.</p>" 1239 } 1240 }, 1241 "HierarchyStructure": { 1242 "base": "<p>Contains information about a hierarchy structure.</p>", 1243 "refs": { 1244 "DescribeUserHierarchyStructureResponse$HierarchyStructure": "<p>Information about the hierarchy structure.</p>" 1245 } 1246 }, 1247 "HierarchyStructureUpdate": { 1248 "base": "<p>Contains information about the level hierarchy to update.</p>", 1249 "refs": { 1250 "UpdateUserHierarchyStructureRequest$HierarchyStructure": "<p>The hierarchy levels to update.</p>" 1251 } 1252 }, 1253 "HistoricalMetric": { 1254 "base": "<p>Contains information about a historical metric. For a description of each metric, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html\">Historical Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>", 1255 "refs": { 1256 "HistoricalMetricData$Metric": "<p>Information about the metric.</p>", 1257 "HistoricalMetrics$member": null 1258 } 1259 }, 1260 "HistoricalMetricData": { 1261 "base": "<p>Contains the data for a historical metric.</p>", 1262 "refs": { 1263 "HistoricalMetricDataCollections$member": null 1264 } 1265 }, 1266 "HistoricalMetricDataCollections": { 1267 "base": null, 1268 "refs": { 1269 "HistoricalMetricResult$Collections": "<p>The set of metrics.</p>" 1270 } 1271 }, 1272 "HistoricalMetricName": { 1273 "base": "<p>The historical metric names.</p>", 1274 "refs": { 1275 "HistoricalMetric$Name": "<p>The name of the metric.</p>" 1276 } 1277 }, 1278 "HistoricalMetricResult": { 1279 "base": "<p>Contains information about the historical metrics retrieved.</p>", 1280 "refs": { 1281 "HistoricalMetricResults$member": null 1282 } 1283 }, 1284 "HistoricalMetricResults": { 1285 "base": null, 1286 "refs": { 1287 "GetMetricDataResponse$MetricResults": "<p>Information about the historical metrics.</p> <p>If no grouping is specified, a summary of metric data is returned.</p>" 1288 } 1289 }, 1290 "HistoricalMetrics": { 1291 "base": null, 1292 "refs": { 1293 "GetMetricDataRequest$HistoricalMetrics": "<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/historical-metrics-definitions.html\">Historical Metrics Definitions</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>" 1294 } 1295 }, 1296 "Hours": { 1297 "base": null, 1298 "refs": { 1299 "KinesisVideoStreamConfig$RetentionPeriodHours": "<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>" 1300 } 1301 }, 1302 "Hours24Format": { 1303 "base": null, 1304 "refs": { 1305 "HoursOfOperationTimeSlice$Hours": "<p>The hours.</p>" 1306 } 1307 }, 1308 "HoursOfOperation": { 1309 "base": "<p>Information about of the hours of operation.</p>", 1310 "refs": { 1311 "DescribeHoursOfOperationResponse$HoursOfOperation": "<p>The hours of operation.</p>" 1312 } 1313 }, 1314 "HoursOfOperationConfig": { 1315 "base": "<p>Contains information about the hours of operation.</p>", 1316 "refs": { 1317 "HoursOfOperationConfigList$member": null 1318 } 1319 }, 1320 "HoursOfOperationConfigList": { 1321 "base": null, 1322 "refs": { 1323 "CreateHoursOfOperationRequest$Config": "<p>Configuration information for the hours of operation: day, start time, and end time.</p>", 1324 "HoursOfOperation$Config": "<p>Configuration information for the hours of operation.</p>", 1325 "UpdateHoursOfOperationRequest$Config": "<p>Configuration information of the hours of operation.</p>" 1326 } 1327 }, 1328 "HoursOfOperationDays": { 1329 "base": null, 1330 "refs": { 1331 "HoursOfOperationConfig$Day": "<p>The day that the hours of operation applies to.</p>" 1332 } 1333 }, 1334 "HoursOfOperationDescription": { 1335 "base": null, 1336 "refs": { 1337 "CreateHoursOfOperationRequest$Description": "<p>The description of the hours of operation.</p>", 1338 "HoursOfOperation$Description": "<p>The description for the hours of operation.</p>" 1339 } 1340 }, 1341 "HoursOfOperationId": { 1342 "base": null, 1343 "refs": { 1344 "CreateHoursOfOperationResponse$HoursOfOperationId": "<p>The identifier for the hours of operation.</p>", 1345 "CreateQueueRequest$HoursOfOperationId": "<p>The identifier for the hours of operation.</p>", 1346 "DeleteHoursOfOperationRequest$HoursOfOperationId": "<p>The identifier for the hours of operation.</p>", 1347 "DescribeHoursOfOperationRequest$HoursOfOperationId": "<p>The identifier for the hours of operation.</p>", 1348 "HoursOfOperation$HoursOfOperationId": "<p>The identifier for the hours of operation.</p>", 1349 "HoursOfOperationSummary$Id": "<p>The identifier of the hours of operation.</p>", 1350 "Queue$HoursOfOperationId": "<p>The identifier for the hours of operation.</p>", 1351 "UpdateHoursOfOperationRequest$HoursOfOperationId": "<p>The identifier of the hours of operation.</p>", 1352 "UpdateQueueHoursOfOperationRequest$HoursOfOperationId": "<p>The identifier for the hours of operation.</p>" 1353 } 1354 }, 1355 "HoursOfOperationName": { 1356 "base": null, 1357 "refs": { 1358 "HoursOfOperationSummary$Name": "<p>The name of the hours of operation.</p>" 1359 } 1360 }, 1361 "HoursOfOperationSummary": { 1362 "base": "<p>Contains summary information about hours of operation for a contact center.</p>", 1363 "refs": { 1364 "HoursOfOperationSummaryList$member": null 1365 } 1366 }, 1367 "HoursOfOperationSummaryList": { 1368 "base": null, 1369 "refs": { 1370 "ListHoursOfOperationsResponse$HoursOfOperationSummaryList": "<p>Information about the hours of operation.</p>" 1371 } 1372 }, 1373 "HoursOfOperationTimeSlice": { 1374 "base": "<p>The start time or end time for an hours of operation.</p>", 1375 "refs": { 1376 "HoursOfOperationConfig$StartTime": "<p>The start time that your contact center opens.</p>", 1377 "HoursOfOperationConfig$EndTime": "<p>The end time that your contact center closes.</p>" 1378 } 1379 }, 1380 "InboundCallsEnabled": { 1381 "base": null, 1382 "refs": { 1383 "CreateInstanceRequest$InboundCallsEnabled": "<p>Your contact center handles incoming contacts.</p>", 1384 "Instance$InboundCallsEnabled": "<p>Whether inbound calls are enabled.</p>", 1385 "InstanceSummary$InboundCallsEnabled": "<p>Whether inbound calls are enabled.</p>" 1386 } 1387 }, 1388 "Instance": { 1389 "base": "<p>The Amazon Connect instance.</p>", 1390 "refs": { 1391 "DescribeInstanceResponse$Instance": "<p>The name of the instance.</p>" 1392 } 1393 }, 1394 "InstanceAttributeType": { 1395 "base": null, 1396 "refs": { 1397 "Attribute$AttributeType": "<p>The type of attribute.</p>", 1398 "DescribeInstanceAttributeRequest$AttributeType": "<p>The type of attribute.</p>", 1399 "UpdateInstanceAttributeRequest$AttributeType": "<p>The type of attribute.</p> <note> <p>Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, contact Amazon Web Services Support for allowlisting.</p> </note>" 1400 } 1401 }, 1402 "InstanceAttributeValue": { 1403 "base": null, 1404 "refs": { 1405 "Attribute$Value": "<p>The value of the attribute.</p>", 1406 "UpdateInstanceAttributeRequest$Value": "<p>The value for the attribute. Maximum character limit is 100. </p>" 1407 } 1408 }, 1409 "InstanceId": { 1410 "base": null, 1411 "refs": { 1412 "AssociateApprovedOriginRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1413 "AssociateBotRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1414 "AssociateInstanceStorageConfigRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1415 "AssociateLambdaFunctionRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1416 "AssociateLexBotRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1417 "AssociateQueueQuickConnectsRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1418 "AssociateRoutingProfileQueuesRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1419 "AssociateSecurityKeyRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1420 "CreateAgentStatusRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1421 "CreateContactFlowRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1422 "CreateHoursOfOperationRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1423 "CreateInstanceResponse$Id": "<p>The identifier for the instance.</p>", 1424 "CreateIntegrationAssociationRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1425 "CreateQueueRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1426 "CreateQuickConnectRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1427 "CreateRoutingProfileRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1428 "CreateSecurityProfileRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1429 "CreateUseCaseRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1430 "CreateUserHierarchyGroupRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1431 "CreateUserRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1432 "DeleteHoursOfOperationRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1433 "DeleteInstanceRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1434 "DeleteIntegrationAssociationRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1435 "DeleteQuickConnectRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1436 "DeleteSecurityProfileRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1437 "DeleteUseCaseRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1438 "DeleteUserHierarchyGroupRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1439 "DeleteUserRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1440 "DescribeAgentStatusRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1441 "DescribeContactFlowRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1442 "DescribeHoursOfOperationRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1443 "DescribeInstanceAttributeRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1444 "DescribeInstanceRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1445 "DescribeInstanceStorageConfigRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1446 "DescribeQueueRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1447 "DescribeQuickConnectRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1448 "DescribeRoutingProfileRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1449 "DescribeSecurityProfileRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1450 "DescribeUserHierarchyGroupRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1451 "DescribeUserHierarchyStructureRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1452 "DescribeUserRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1453 "DisassociateApprovedOriginRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1454 "DisassociateBotRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1455 "DisassociateInstanceStorageConfigRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1456 "DisassociateLambdaFunctionRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance..</p>", 1457 "DisassociateLexBotRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1458 "DisassociateQueueQuickConnectsRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1459 "DisassociateRoutingProfileQueuesRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1460 "DisassociateSecurityKeyRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1461 "GetContactAttributesRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1462 "GetCurrentMetricDataRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1463 "GetFederationTokenRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1464 "GetMetricDataRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1465 "Instance$Id": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1466 "InstanceSummary$Id": "<p>The identifier of the instance.</p>", 1467 "IntegrationAssociationSummary$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1468 "ListAgentStatusRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1469 "ListApprovedOriginsRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1470 "ListBotsRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1471 "ListContactFlowsRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1472 "ListHoursOfOperationsRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1473 "ListInstanceAttributesRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1474 "ListInstanceStorageConfigsRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1475 "ListIntegrationAssociationsRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1476 "ListLambdaFunctionsRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1477 "ListLexBotsRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1478 "ListPhoneNumbersRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1479 "ListPromptsRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1480 "ListQueueQuickConnectsRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1481 "ListQueuesRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1482 "ListQuickConnectsRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1483 "ListRoutingProfileQueuesRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1484 "ListRoutingProfilesRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1485 "ListSecurityKeysRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1486 "ListSecurityProfilePermissionsRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1487 "ListSecurityProfilesRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1488 "ListUseCasesRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1489 "ListUserHierarchyGroupsRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1490 "ListUsersRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1491 "ResumeContactRecordingRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1492 "RoutingProfile$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1493 "SecurityProfile$OrganizationResourceId": "<p>The organization resource identifier for the security profile.</p>", 1494 "StartChatContactRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1495 "StartContactRecordingRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1496 "StartContactStreamingRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1497 "StartOutboundVoiceContactRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1498 "StartTaskContactRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1499 "StopContactRecordingRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1500 "StopContactRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1501 "StopContactStreamingRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1502 "SuspendContactRecordingRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1503 "UpdateAgentStatusRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1504 "UpdateContactAttributesRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1505 "UpdateContactFlowContentRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1506 "UpdateContactFlowNameRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1507 "UpdateHoursOfOperationRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1508 "UpdateInstanceAttributeRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1509 "UpdateInstanceStorageConfigRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1510 "UpdateQueueHoursOfOperationRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1511 "UpdateQueueMaxContactsRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1512 "UpdateQueueNameRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1513 "UpdateQueueOutboundCallerConfigRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1514 "UpdateQueueStatusRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1515 "UpdateQuickConnectConfigRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1516 "UpdateQuickConnectNameRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1517 "UpdateRoutingProfileConcurrencyRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1518 "UpdateRoutingProfileDefaultOutboundQueueRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1519 "UpdateRoutingProfileNameRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1520 "UpdateRoutingProfileQueuesRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1521 "UpdateSecurityProfileRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1522 "UpdateUserHierarchyGroupNameRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1523 "UpdateUserHierarchyRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1524 "UpdateUserHierarchyStructureRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1525 "UpdateUserIdentityInfoRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1526 "UpdateUserPhoneConfigRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1527 "UpdateUserRoutingProfileRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", 1528 "UpdateUserSecurityProfilesRequest$InstanceId": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>" 1529 } 1530 }, 1531 "InstanceStatus": { 1532 "base": null, 1533 "refs": { 1534 "Instance$InstanceStatus": "<p>The state of the instance.</p>", 1535 "InstanceSummary$InstanceStatus": "<p>The state of the instance.</p>" 1536 } 1537 }, 1538 "InstanceStatusReason": { 1539 "base": "<p>Relevant details why the instance was not successfully created.</p>", 1540 "refs": { 1541 "Instance$StatusReason": "<p>Relevant details why the instance was not successfully created. </p>" 1542 } 1543 }, 1544 "InstanceStorageConfig": { 1545 "base": "<p>The storage configuration for the instance.</p>", 1546 "refs": { 1547 "AssociateInstanceStorageConfigRequest$StorageConfig": "<p>A valid storage type.</p>", 1548 "DescribeInstanceStorageConfigResponse$StorageConfig": "<p>A valid storage type.</p>", 1549 "InstanceStorageConfigs$member": null, 1550 "UpdateInstanceStorageConfigRequest$StorageConfig": null 1551 } 1552 }, 1553 "InstanceStorageConfigs": { 1554 "base": null, 1555 "refs": { 1556 "ListInstanceStorageConfigsResponse$StorageConfigs": "<p>A valid storage type.</p>" 1557 } 1558 }, 1559 "InstanceStorageResourceType": { 1560 "base": null, 1561 "refs": { 1562 "AssociateInstanceStorageConfigRequest$ResourceType": "<p>A valid resource type.</p>", 1563 "DescribeInstanceStorageConfigRequest$ResourceType": "<p>A valid resource type.</p>", 1564 "DisassociateInstanceStorageConfigRequest$ResourceType": "<p>A valid resource type.</p>", 1565 "ListInstanceStorageConfigsRequest$ResourceType": "<p>A valid resource type.</p>", 1566 "UpdateInstanceStorageConfigRequest$ResourceType": "<p>A valid resource type.</p>" 1567 } 1568 }, 1569 "InstanceSummary": { 1570 "base": "<p>Information about the instance.</p>", 1571 "refs": { 1572 "InstanceSummaryList$member": null 1573 } 1574 }, 1575 "InstanceSummaryList": { 1576 "base": null, 1577 "refs": { 1578 "ListInstancesResponse$InstanceSummaryList": "<p>Information about the instances.</p>" 1579 } 1580 }, 1581 "IntegrationAssociationId": { 1582 "base": null, 1583 "refs": { 1584 "CreateIntegrationAssociationResponse$IntegrationAssociationId": "<p>The identifier for the integration association.</p>", 1585 "CreateUseCaseRequest$IntegrationAssociationId": "<p>The identifier for the integration association.</p>", 1586 "DeleteIntegrationAssociationRequest$IntegrationAssociationId": "<p>The identifier for the integration association.</p>", 1587 "DeleteUseCaseRequest$IntegrationAssociationId": "<p>The identifier for the integration association.</p>", 1588 "IntegrationAssociationSummary$IntegrationAssociationId": "<p>The identifier for the AppIntegration association.</p>", 1589 "ListUseCasesRequest$IntegrationAssociationId": "<p>The identifier for the integration association.</p>" 1590 } 1591 }, 1592 "IntegrationAssociationSummary": { 1593 "base": "<p>Contains summary information about the associated AppIntegrations.</p>", 1594 "refs": { 1595 "IntegrationAssociationSummaryList$member": null 1596 } 1597 }, 1598 "IntegrationAssociationSummaryList": { 1599 "base": null, 1600 "refs": { 1601 "ListIntegrationAssociationsResponse$IntegrationAssociationSummaryList": "<p>The associations.</p>" 1602 } 1603 }, 1604 "IntegrationType": { 1605 "base": null, 1606 "refs": { 1607 "CreateIntegrationAssociationRequest$IntegrationType": "<p>The type of information to be ingested.</p>", 1608 "IntegrationAssociationSummary$IntegrationType": "<p>The integration type.</p>", 1609 "ListIntegrationAssociationsRequest$IntegrationType": "<p>The type of integration.</p>" 1610 } 1611 }, 1612 "InternalServiceException": { 1613 "base": "<p>Request processing failed because of an error or failure with the service.</p>", 1614 "refs": { 1615 } 1616 }, 1617 "InvalidContactFlowException": { 1618 "base": "<p>The contact flow is not valid.</p>", 1619 "refs": { 1620 } 1621 }, 1622 "InvalidParameterException": { 1623 "base": "<p>One or more of the specified parameters are not valid.</p>", 1624 "refs": { 1625 } 1626 }, 1627 "InvalidRequestException": { 1628 "base": "<p>The request is not valid.</p>", 1629 "refs": { 1630 } 1631 }, 1632 "KeyId": { 1633 "base": null, 1634 "refs": { 1635 "EncryptionConfig$KeyId": "<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> </note>" 1636 } 1637 }, 1638 "KinesisFirehoseConfig": { 1639 "base": "<p>Configuration information of a Kinesis Data Firehose delivery stream.</p>", 1640 "refs": { 1641 "InstanceStorageConfig$KinesisFirehoseConfig": "<p>The configuration of the Kinesis Firehose delivery stream.</p>" 1642 } 1643 }, 1644 "KinesisStreamConfig": { 1645 "base": "<p>Configuration information of a Kinesis data stream.</p>", 1646 "refs": { 1647 "InstanceStorageConfig$KinesisStreamConfig": "<p>The configuration of the Kinesis data stream.</p>" 1648 } 1649 }, 1650 "KinesisVideoStreamConfig": { 1651 "base": "<p>Configuration information of a Kinesis video stream.</p>", 1652 "refs": { 1653 "InstanceStorageConfig$KinesisVideoStreamConfig": "<p>The configuration of the Kinesis video stream.</p>" 1654 } 1655 }, 1656 "LexBot": { 1657 "base": "<p>Configuration information of an Amazon Lex bot.</p>", 1658 "refs": { 1659 "AssociateBotRequest$LexBot": null, 1660 "AssociateLexBotRequest$LexBot": "<p>The Amazon Lex bot to associate with the instance.</p>", 1661 "DisassociateBotRequest$LexBot": null, 1662 "LexBotConfig$LexBot": null, 1663 "LexBotsList$member": null 1664 } 1665 }, 1666 "LexBotConfig": { 1667 "base": "<p>Configuration information of an Amazon Lex or Amazon Lex V2 bot.</p>", 1668 "refs": { 1669 "LexBotConfigList$member": null 1670 } 1671 }, 1672 "LexBotConfigList": { 1673 "base": null, 1674 "refs": { 1675 "ListBotsResponse$LexBots": "<p>The names and Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified instance.</p>" 1676 } 1677 }, 1678 "LexBotsList": { 1679 "base": null, 1680 "refs": { 1681 "ListLexBotsResponse$LexBots": "<p>The names and Regions of the Amazon Lex bots associated with the specified instance.</p>" 1682 } 1683 }, 1684 "LexRegion": { 1685 "base": null, 1686 "refs": { 1687 "DisassociateLexBotRequest$LexRegion": "<p>The Region in which the Amazon Lex bot has been created.</p>", 1688 "LexBot$LexRegion": "<p>The Region that the Amazon Lex bot was created in.</p>" 1689 } 1690 }, 1691 "LexV2Bot": { 1692 "base": "<p>Configuration information of an Amazon Lex V2 bot.</p>", 1693 "refs": { 1694 "AssociateBotRequest$LexV2Bot": "<p>The Amazon Lex V2 bot to associate with the instance.</p>", 1695 "DisassociateBotRequest$LexV2Bot": "<p>The Amazon Lex V2 bot to disassociate from the instance.</p>", 1696 "LexBotConfig$LexV2Bot": "<p>Configuration information of an Amazon Lex V2 bot.</p>" 1697 } 1698 }, 1699 "LexVersion": { 1700 "base": null, 1701 "refs": { 1702 "ListBotsRequest$LexVersion": "<p>The version of Amazon Lex or Amazon Lex V2.</p>" 1703 } 1704 }, 1705 "LimitExceededException": { 1706 "base": "<p>The allowed limit for the resource has been exceeded.</p>", 1707 "refs": { 1708 } 1709 }, 1710 "ListAgentStatusRequest": { 1711 "base": null, 1712 "refs": { 1713 } 1714 }, 1715 "ListAgentStatusResponse": { 1716 "base": null, 1717 "refs": { 1718 } 1719 }, 1720 "ListApprovedOriginsRequest": { 1721 "base": null, 1722 "refs": { 1723 } 1724 }, 1725 "ListApprovedOriginsResponse": { 1726 "base": null, 1727 "refs": { 1728 } 1729 }, 1730 "ListBotsRequest": { 1731 "base": null, 1732 "refs": { 1733 } 1734 }, 1735 "ListBotsResponse": { 1736 "base": null, 1737 "refs": { 1738 } 1739 }, 1740 "ListContactFlowsRequest": { 1741 "base": null, 1742 "refs": { 1743 } 1744 }, 1745 "ListContactFlowsResponse": { 1746 "base": null, 1747 "refs": { 1748 } 1749 }, 1750 "ListHoursOfOperationsRequest": { 1751 "base": null, 1752 "refs": { 1753 } 1754 }, 1755 "ListHoursOfOperationsResponse": { 1756 "base": null, 1757 "refs": { 1758 } 1759 }, 1760 "ListInstanceAttributesRequest": { 1761 "base": null, 1762 "refs": { 1763 } 1764 }, 1765 "ListInstanceAttributesResponse": { 1766 "base": null, 1767 "refs": { 1768 } 1769 }, 1770 "ListInstanceStorageConfigsRequest": { 1771 "base": null, 1772 "refs": { 1773 } 1774 }, 1775 "ListInstanceStorageConfigsResponse": { 1776 "base": null, 1777 "refs": { 1778 } 1779 }, 1780 "ListInstancesRequest": { 1781 "base": null, 1782 "refs": { 1783 } 1784 }, 1785 "ListInstancesResponse": { 1786 "base": null, 1787 "refs": { 1788 } 1789 }, 1790 "ListIntegrationAssociationsRequest": { 1791 "base": null, 1792 "refs": { 1793 } 1794 }, 1795 "ListIntegrationAssociationsResponse": { 1796 "base": null, 1797 "refs": { 1798 } 1799 }, 1800 "ListLambdaFunctionsRequest": { 1801 "base": null, 1802 "refs": { 1803 } 1804 }, 1805 "ListLambdaFunctionsResponse": { 1806 "base": null, 1807 "refs": { 1808 } 1809 }, 1810 "ListLexBotsRequest": { 1811 "base": null, 1812 "refs": { 1813 } 1814 }, 1815 "ListLexBotsResponse": { 1816 "base": null, 1817 "refs": { 1818 } 1819 }, 1820 "ListPhoneNumbersRequest": { 1821 "base": null, 1822 "refs": { 1823 } 1824 }, 1825 "ListPhoneNumbersResponse": { 1826 "base": null, 1827 "refs": { 1828 } 1829 }, 1830 "ListPromptsRequest": { 1831 "base": null, 1832 "refs": { 1833 } 1834 }, 1835 "ListPromptsResponse": { 1836 "base": null, 1837 "refs": { 1838 } 1839 }, 1840 "ListQueueQuickConnectsRequest": { 1841 "base": null, 1842 "refs": { 1843 } 1844 }, 1845 "ListQueueQuickConnectsResponse": { 1846 "base": null, 1847 "refs": { 1848 } 1849 }, 1850 "ListQueuesRequest": { 1851 "base": null, 1852 "refs": { 1853 } 1854 }, 1855 "ListQueuesResponse": { 1856 "base": null, 1857 "refs": { 1858 } 1859 }, 1860 "ListQuickConnectsRequest": { 1861 "base": null, 1862 "refs": { 1863 } 1864 }, 1865 "ListQuickConnectsResponse": { 1866 "base": null, 1867 "refs": { 1868 } 1869 }, 1870 "ListRoutingProfileQueuesRequest": { 1871 "base": null, 1872 "refs": { 1873 } 1874 }, 1875 "ListRoutingProfileQueuesResponse": { 1876 "base": null, 1877 "refs": { 1878 } 1879 }, 1880 "ListRoutingProfilesRequest": { 1881 "base": null, 1882 "refs": { 1883 } 1884 }, 1885 "ListRoutingProfilesResponse": { 1886 "base": null, 1887 "refs": { 1888 } 1889 }, 1890 "ListSecurityKeysRequest": { 1891 "base": null, 1892 "refs": { 1893 } 1894 }, 1895 "ListSecurityKeysResponse": { 1896 "base": null, 1897 "refs": { 1898 } 1899 }, 1900 "ListSecurityProfilePermissionsRequest": { 1901 "base": null, 1902 "refs": { 1903 } 1904 }, 1905 "ListSecurityProfilePermissionsResponse": { 1906 "base": null, 1907 "refs": { 1908 } 1909 }, 1910 "ListSecurityProfilesRequest": { 1911 "base": null, 1912 "refs": { 1913 } 1914 }, 1915 "ListSecurityProfilesResponse": { 1916 "base": null, 1917 "refs": { 1918 } 1919 }, 1920 "ListTagsForResourceRequest": { 1921 "base": null, 1922 "refs": { 1923 } 1924 }, 1925 "ListTagsForResourceResponse": { 1926 "base": null, 1927 "refs": { 1928 } 1929 }, 1930 "ListUseCasesRequest": { 1931 "base": "<p>Provides summary information about the use cases for the specified integration association.</p>", 1932 "refs": { 1933 } 1934 }, 1935 "ListUseCasesResponse": { 1936 "base": null, 1937 "refs": { 1938 } 1939 }, 1940 "ListUserHierarchyGroupsRequest": { 1941 "base": null, 1942 "refs": { 1943 } 1944 }, 1945 "ListUserHierarchyGroupsResponse": { 1946 "base": null, 1947 "refs": { 1948 } 1949 }, 1950 "ListUsersRequest": { 1951 "base": null, 1952 "refs": { 1953 } 1954 }, 1955 "ListUsersResponse": { 1956 "base": null, 1957 "refs": { 1958 } 1959 }, 1960 "MaxResult10": { 1961 "base": null, 1962 "refs": { 1963 "ListInstanceStorageConfigsRequest$MaxResults": "<p>The maximum number of results to return per page.</p>", 1964 "ListInstancesRequest$MaxResults": "<p>The maximum number of results to return per page.</p>" 1965 } 1966 }, 1967 "MaxResult100": { 1968 "base": null, 1969 "refs": { 1970 "GetCurrentMetricDataRequest$MaxResults": "<p>The maximum number of results to return per page.</p>", 1971 "GetMetricDataRequest$MaxResults": "<p>The maximum number of results to return per page.</p>", 1972 "ListIntegrationAssociationsRequest$MaxResults": "<p>The maximum number of results to return per page.</p>", 1973 "ListQueueQuickConnectsRequest$MaxResults": "<p>The maximum number of results to return per page.</p>", 1974 "ListRoutingProfileQueuesRequest$MaxResults": "<p>The maximum number of results to return per page.</p>", 1975 "ListUseCasesRequest$MaxResults": "<p>The maximum number of results to return per page.</p>" 1976 } 1977 }, 1978 "MaxResult1000": { 1979 "base": null, 1980 "refs": { 1981 "ListAgentStatusRequest$MaxResults": "<p>The maximum number of results to return per page.</p>", 1982 "ListContactFlowsRequest$MaxResults": "<p>The maximum number of results to return per page.</p>", 1983 "ListHoursOfOperationsRequest$MaxResults": "<p>The maximum number of results to return per page.</p>", 1984 "ListPhoneNumbersRequest$MaxResults": "<p>The maximum number of results to return per page.</p>", 1985 "ListPromptsRequest$MaxResults": "<p>The maximum number of results to return per page.</p>", 1986 "ListQueuesRequest$MaxResults": "<p>The maximum number of results to return per page.</p>", 1987 "ListQuickConnectsRequest$MaxResults": "<p>The maximum number of results to return per page.</p>", 1988 "ListRoutingProfilesRequest$MaxResults": "<p>The maximum number of results to return per page.</p>", 1989 "ListSecurityProfilePermissionsRequest$MaxResults": "<p>The maximum number of results to return per page.</p>", 1990 "ListSecurityProfilesRequest$MaxResults": "<p>The maximum number of results to return per page.</p>", 1991 "ListUserHierarchyGroupsRequest$MaxResults": "<p>The maximum number of results to return per page.</p>", 1992 "ListUsersRequest$MaxResults": "<p>The maximum number of results to return per page.</p>" 1993 } 1994 }, 1995 "MaxResult2": { 1996 "base": null, 1997 "refs": { 1998 "ListSecurityKeysRequest$MaxResults": "<p>The maximum number of results to return per page.</p>" 1999 } 2000 }, 2001 "MaxResult25": { 2002 "base": null, 2003 "refs": { 2004 "ListApprovedOriginsRequest$MaxResults": "<p>The maximum number of results to return per page.</p>", 2005 "ListBotsRequest$MaxResults": "<p>The maximum number of results to return per page.</p>", 2006 "ListLambdaFunctionsRequest$MaxResults": "<p>The maximum number of results to return per page.</p>", 2007 "ListLexBotsRequest$MaxResults": "<p>The maximum number of results to return per page. If no value is specified, the default is 10. </p>" 2008 } 2009 }, 2010 "MaxResult7": { 2011 "base": null, 2012 "refs": { 2013 "ListInstanceAttributesRequest$MaxResults": "<p>The maximum number of results to return per page.</p>" 2014 } 2015 }, 2016 "MediaConcurrencies": { 2017 "base": null, 2018 "refs": { 2019 "CreateRoutingProfileRequest$MediaConcurrencies": "<p>The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.</p>", 2020 "RoutingProfile$MediaConcurrencies": "<p>The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.</p>", 2021 "UpdateRoutingProfileConcurrencyRequest$MediaConcurrencies": "<p>The channels that agents can handle in the Contact Control Panel (CCP).</p>" 2022 } 2023 }, 2024 "MediaConcurrency": { 2025 "base": "<p>Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.</p>", 2026 "refs": { 2027 "MediaConcurrencies$member": null 2028 } 2029 }, 2030 "Message": { 2031 "base": null, 2032 "refs": { 2033 "AccessDeniedException$Message": null, 2034 "ContactFlowNotPublishedException$Message": null, 2035 "ContactNotFoundException$Message": "<p>The message.</p>", 2036 "DestinationNotAllowedException$Message": "<p>The message about the outbound calls.</p>", 2037 "DuplicateResourceException$Message": null, 2038 "InternalServiceException$Message": "<p>The message.</p>", 2039 "InvalidParameterException$Message": "<p>The message about the parameters.</p>", 2040 "InvalidRequestException$Message": "<p>The message about the request.</p>", 2041 "LimitExceededException$Message": "<p>The message about the limit.</p>", 2042 "OutboundContactNotPermittedException$Message": "<p>The message about the contact.</p>", 2043 "ResourceConflictException$Message": null, 2044 "ResourceInUseException$Message": null, 2045 "ResourceNotFoundException$Message": "<p>The message about the resource.</p>", 2046 "ServiceQuotaExceededException$Message": null, 2047 "ThrottlingException$Message": null, 2048 "UserNotFoundException$Message": null 2049 } 2050 }, 2051 "MinutesLimit60": { 2052 "base": null, 2053 "refs": { 2054 "HoursOfOperationTimeSlice$Minutes": "<p>The minutes.</p>" 2055 } 2056 }, 2057 "Name": { 2058 "base": null, 2059 "refs": { 2060 "StartTaskContactRequest$Name": "<p>The name of a task that is shown to an agent in the Contact Control Panel (CCP).</p>" 2061 } 2062 }, 2063 "NextToken": { 2064 "base": null, 2065 "refs": { 2066 "GetCurrentMetricDataRequest$NextToken": "<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>", 2067 "GetCurrentMetricDataResponse$NextToken": "<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>", 2068 "GetMetricDataRequest$NextToken": "<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>", 2069 "GetMetricDataResponse$NextToken": "<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>", 2070 "ListAgentStatusRequest$NextToken": "<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>", 2071 "ListAgentStatusResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 2072 "ListApprovedOriginsRequest$NextToken": "<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>", 2073 "ListApprovedOriginsResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 2074 "ListBotsRequest$NextToken": "<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>", 2075 "ListBotsResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 2076 "ListContactFlowsRequest$NextToken": "<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>", 2077 "ListContactFlowsResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 2078 "ListHoursOfOperationsRequest$NextToken": "<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>", 2079 "ListHoursOfOperationsResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 2080 "ListInstanceAttributesRequest$NextToken": "<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>", 2081 "ListInstanceAttributesResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 2082 "ListInstanceStorageConfigsRequest$NextToken": "<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>", 2083 "ListInstanceStorageConfigsResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 2084 "ListInstancesRequest$NextToken": "<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>", 2085 "ListInstancesResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 2086 "ListIntegrationAssociationsRequest$NextToken": "<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>", 2087 "ListIntegrationAssociationsResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 2088 "ListLambdaFunctionsRequest$NextToken": "<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>", 2089 "ListLambdaFunctionsResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 2090 "ListLexBotsRequest$NextToken": "<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>", 2091 "ListLexBotsResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 2092 "ListPhoneNumbersRequest$NextToken": "<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>", 2093 "ListPhoneNumbersResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 2094 "ListPromptsRequest$NextToken": "<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>", 2095 "ListPromptsResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 2096 "ListQueueQuickConnectsRequest$NextToken": "<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>", 2097 "ListQueueQuickConnectsResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 2098 "ListQueuesRequest$NextToken": "<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>", 2099 "ListQueuesResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 2100 "ListQuickConnectsRequest$NextToken": "<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>", 2101 "ListQuickConnectsResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 2102 "ListRoutingProfileQueuesRequest$NextToken": "<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>", 2103 "ListRoutingProfileQueuesResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 2104 "ListRoutingProfilesRequest$NextToken": "<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>", 2105 "ListRoutingProfilesResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 2106 "ListSecurityKeysRequest$NextToken": "<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>", 2107 "ListSecurityKeysResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 2108 "ListSecurityProfilePermissionsRequest$NextToken": "<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>", 2109 "ListSecurityProfilePermissionsResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 2110 "ListSecurityProfilesRequest$NextToken": "<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>", 2111 "ListSecurityProfilesResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 2112 "ListUseCasesRequest$NextToken": "<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>", 2113 "ListUseCasesResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 2114 "ListUserHierarchyGroupsRequest$NextToken": "<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>", 2115 "ListUserHierarchyGroupsResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 2116 "ListUsersRequest$NextToken": "<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>", 2117 "ListUsersResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>" 2118 } 2119 }, 2120 "Origin": { 2121 "base": null, 2122 "refs": { 2123 "AssociateApprovedOriginRequest$Origin": "<p>The domain to add to your allow list.</p>", 2124 "DisassociateApprovedOriginRequest$Origin": "<p>The domain URL of the integrated application.</p>", 2125 "OriginsList$member": null 2126 } 2127 }, 2128 "OriginsList": { 2129 "base": null, 2130 "refs": { 2131 "ListApprovedOriginsResponse$Origins": "<p>The approved origins.</p>" 2132 } 2133 }, 2134 "OutboundCallerConfig": { 2135 "base": "<p>The outbound caller ID name, number, and outbound whisper flow.</p>", 2136 "refs": { 2137 "CreateQueueRequest$OutboundCallerConfig": "<p>The outbound caller ID name, number, and outbound whisper flow.</p>", 2138 "Queue$OutboundCallerConfig": "<p>The outbound caller ID name, number, and outbound whisper flow.</p>", 2139 "UpdateQueueOutboundCallerConfigRequest$OutboundCallerConfig": "<p>The outbound caller ID name, number, and outbound whisper flow.</p>" 2140 } 2141 }, 2142 "OutboundCallerIdName": { 2143 "base": null, 2144 "refs": { 2145 "OutboundCallerConfig$OutboundCallerIdName": "<p>The caller ID name.</p>" 2146 } 2147 }, 2148 "OutboundCallsEnabled": { 2149 "base": null, 2150 "refs": { 2151 "CreateInstanceRequest$OutboundCallsEnabled": "<p>Your contact center allows outbound calls.</p>", 2152 "Instance$OutboundCallsEnabled": "<p>Whether outbound calls are enabled.</p>", 2153 "InstanceSummary$OutboundCallsEnabled": "<p>Whether outbound calls are enabled.</p>" 2154 } 2155 }, 2156 "OutboundContactNotPermittedException": { 2157 "base": "<p>The contact is not permitted.</p>", 2158 "refs": { 2159 } 2160 }, 2161 "PEM": { 2162 "base": null, 2163 "refs": { 2164 "AssociateSecurityKeyRequest$Key": "<p>A valid security key in PEM format.</p>", 2165 "SecurityKey$Key": "<p>The key of the security key.</p>" 2166 } 2167 }, 2168 "ParticipantDetails": { 2169 "base": "<p>The customer's details.</p>", 2170 "refs": { 2171 "StartChatContactRequest$ParticipantDetails": "<p>Information identifying the participant.</p>" 2172 } 2173 }, 2174 "ParticipantId": { 2175 "base": null, 2176 "refs": { 2177 "StartChatContactResponse$ParticipantId": "<p>The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.</p>" 2178 } 2179 }, 2180 "ParticipantToken": { 2181 "base": null, 2182 "refs": { 2183 "StartChatContactResponse$ParticipantToken": "<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>" 2184 } 2185 }, 2186 "Password": { 2187 "base": null, 2188 "refs": { 2189 "CreateUserRequest$Password": "<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>" 2190 } 2191 }, 2192 "PermissionsList": { 2193 "base": null, 2194 "refs": { 2195 "CreateSecurityProfileRequest$Permissions": "<p>Permissions assigned to the security profile.</p>", 2196 "ListSecurityProfilePermissionsResponse$Permissions": "<p>The permissions granted to the security profile.</p>", 2197 "UpdateSecurityProfileRequest$Permissions": "<p>The permissions granted to a security profile.</p>" 2198 } 2199 }, 2200 "PhoneNumber": { 2201 "base": null, 2202 "refs": { 2203 "PhoneNumberQuickConnectConfig$PhoneNumber": "<p>The phone number in E.164 format.</p>", 2204 "PhoneNumberSummary$PhoneNumber": "<p>The phone number.</p>", 2205 "StartOutboundVoiceContactRequest$DestinationPhoneNumber": "<p>The phone number of the customer, in E.164 format.</p>", 2206 "StartOutboundVoiceContactRequest$SourcePhoneNumber": "<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>", 2207 "UserPhoneConfig$DeskPhoneNumber": "<p>The phone number for the user's desk phone.</p>" 2208 } 2209 }, 2210 "PhoneNumberCountryCode": { 2211 "base": null, 2212 "refs": { 2213 "PhoneNumberCountryCodes$member": null, 2214 "PhoneNumberSummary$PhoneNumberCountryCode": "<p>The ISO country code.</p>" 2215 } 2216 }, 2217 "PhoneNumberCountryCodes": { 2218 "base": null, 2219 "refs": { 2220 "ListPhoneNumbersRequest$PhoneNumberCountryCodes": "<p>The ISO country code.</p>" 2221 } 2222 }, 2223 "PhoneNumberId": { 2224 "base": null, 2225 "refs": { 2226 "OutboundCallerConfig$OutboundCallerIdNumberId": "<p>The caller ID number.</p>", 2227 "PhoneNumberSummary$Id": "<p>The identifier of the phone number.</p>" 2228 } 2229 }, 2230 "PhoneNumberQuickConnectConfig": { 2231 "base": "<p>Contains information about a phone number for a quick connect.</p>", 2232 "refs": { 2233 "QuickConnectConfig$PhoneConfig": "<p>The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.</p>" 2234 } 2235 }, 2236 "PhoneNumberSummary": { 2237 "base": "<p>Contains summary information about a phone number for a contact center.</p>", 2238 "refs": { 2239 "PhoneNumberSummaryList$member": null 2240 } 2241 }, 2242 "PhoneNumberSummaryList": { 2243 "base": null, 2244 "refs": { 2245 "ListPhoneNumbersResponse$PhoneNumberSummaryList": "<p>Information about the phone numbers.</p>" 2246 } 2247 }, 2248 "PhoneNumberType": { 2249 "base": null, 2250 "refs": { 2251 "PhoneNumberSummary$PhoneNumberType": "<p>The type of phone number.</p>", 2252 "PhoneNumberTypes$member": null 2253 } 2254 }, 2255 "PhoneNumberTypes": { 2256 "base": null, 2257 "refs": { 2258 "ListPhoneNumbersRequest$PhoneNumberTypes": "<p>The type of phone number.</p>" 2259 } 2260 }, 2261 "PhoneType": { 2262 "base": null, 2263 "refs": { 2264 "UserPhoneConfig$PhoneType": "<p>The phone type.</p>" 2265 } 2266 }, 2267 "Prefix": { 2268 "base": null, 2269 "refs": { 2270 "KinesisVideoStreamConfig$Prefix": "<p>The prefix of the video stream.</p>", 2271 "S3Config$BucketPrefix": "<p>The S3 bucket prefix.</p>" 2272 } 2273 }, 2274 "Priority": { 2275 "base": null, 2276 "refs": { 2277 "RoutingProfileQueueConfig$Priority": "<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>", 2278 "RoutingProfileQueueConfigSummary$Priority": "<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>" 2279 } 2280 }, 2281 "ProblemDetail": { 2282 "base": "<p>Information about a problem detail.</p>", 2283 "refs": { 2284 "Problems$member": null 2285 } 2286 }, 2287 "ProblemMessageString": { 2288 "base": null, 2289 "refs": { 2290 "ProblemDetail$message": "<p>The problem detail's message.</p>" 2291 } 2292 }, 2293 "Problems": { 2294 "base": null, 2295 "refs": { 2296 "InvalidContactFlowException$problems": "<p>The problems with the contact flow. Please fix before trying again.</p>" 2297 } 2298 }, 2299 "PromptId": { 2300 "base": null, 2301 "refs": { 2302 "PromptSummary$Id": "<p>The identifier of the prompt.</p>" 2303 } 2304 }, 2305 "PromptName": { 2306 "base": null, 2307 "refs": { 2308 "PromptSummary$Name": "<p>The name of the prompt.</p>" 2309 } 2310 }, 2311 "PromptSummary": { 2312 "base": "<p>Contains information about the prompt.</p>", 2313 "refs": { 2314 "PromptSummaryList$member": null 2315 } 2316 }, 2317 "PromptSummaryList": { 2318 "base": null, 2319 "refs": { 2320 "ListPromptsResponse$PromptSummaryList": "<p>Information about the prompts.</p>" 2321 } 2322 }, 2323 "Queue": { 2324 "base": "<p>Contains information about a queue.</p>", 2325 "refs": { 2326 "DescribeQueueResponse$Queue": "<p>The name of the queue.</p>" 2327 } 2328 }, 2329 "QueueDescription": { 2330 "base": null, 2331 "refs": { 2332 "CreateQueueRequest$Description": "<p>The description of the queue.</p>", 2333 "Queue$Description": "<p>The description of the queue.</p>", 2334 "UpdateQueueNameRequest$Description": "<p>The description of the queue.</p>" 2335 } 2336 }, 2337 "QueueId": { 2338 "base": null, 2339 "refs": { 2340 "AssociateQueueQuickConnectsRequest$QueueId": "<p>The identifier for the queue.</p>", 2341 "CreateQueueResponse$QueueId": "<p>The identifier for the queue.</p>", 2342 "CreateRoutingProfileRequest$DefaultOutboundQueueId": "<p>The default outbound queue for the routing profile.</p>", 2343 "DescribeQueueRequest$QueueId": "<p>The identifier for the queue.</p>", 2344 "DisassociateQueueQuickConnectsRequest$QueueId": "<p>The identifier for the queue.</p>", 2345 "ListQueueQuickConnectsRequest$QueueId": "<p>The identifier for the queue.</p>", 2346 "Queue$QueueId": "<p>The identifier for the queue.</p>", 2347 "QueueQuickConnectConfig$QueueId": "<p>The identifier for the queue.</p>", 2348 "QueueReference$Id": "<p>The identifier of the queue.</p>", 2349 "QueueSummary$Id": "<p>The identifier of the queue.</p>", 2350 "Queues$member": null, 2351 "RoutingProfile$DefaultOutboundQueueId": "<p>The identifier of the default outbound queue for this routing profile.</p>", 2352 "RoutingProfileQueueConfigSummary$QueueId": "<p>The identifier for the queue.</p>", 2353 "RoutingProfileQueueReference$QueueId": "<p>The identifier for the queue.</p>", 2354 "StartOutboundVoiceContactRequest$QueueId": "<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 contact flow is used. If you do not specify a queue, you must specify a source phone number.</p>", 2355 "UpdateQueueHoursOfOperationRequest$QueueId": "<p>The identifier for the queue.</p>", 2356 "UpdateQueueMaxContactsRequest$QueueId": "<p>The identifier for the queue.</p>", 2357 "UpdateQueueNameRequest$QueueId": "<p>The identifier for the queue.</p>", 2358 "UpdateQueueOutboundCallerConfigRequest$QueueId": "<p>The identifier for the queue.</p>", 2359 "UpdateQueueStatusRequest$QueueId": "<p>The identifier for the queue.</p>", 2360 "UpdateRoutingProfileDefaultOutboundQueueRequest$DefaultOutboundQueueId": "<p>The identifier for the default outbound queue.</p>" 2361 } 2362 }, 2363 "QueueMaxContacts": { 2364 "base": null, 2365 "refs": { 2366 "CreateQueueRequest$MaxContacts": "<p>The maximum number of contacts that can be in the queue before it is considered full.</p>", 2367 "Queue$MaxContacts": "<p>The maximum number of contacts that can be in the queue before it is considered full.</p>", 2368 "UpdateQueueMaxContactsRequest$MaxContacts": "<p>The maximum number of contacts that can be in the queue before it is considered full.</p>" 2369 } 2370 }, 2371 "QueueName": { 2372 "base": null, 2373 "refs": { 2374 "QueueSummary$Name": "<p>The name of the queue.</p>", 2375 "RoutingProfileQueueConfigSummary$QueueName": "<p>The name of the queue.</p>" 2376 } 2377 }, 2378 "QueueQuickConnectConfig": { 2379 "base": "<p>Contains information about a queue for a quick connect. The contact flow must be of type Transfer to Queue.</p>", 2380 "refs": { 2381 "QuickConnectConfig$QueueConfig": "<p>The queue configuration. This is required only if QuickConnectType is QUEUE.</p>" 2382 } 2383 }, 2384 "QueueReference": { 2385 "base": "<p>Contains information about a queue resource for which metrics are returned.</p>", 2386 "refs": { 2387 "Dimensions$Queue": "<p>Information about the queue for which metrics are returned.</p>" 2388 } 2389 }, 2390 "QueueStatus": { 2391 "base": null, 2392 "refs": { 2393 "Queue$Status": "<p>The status of the queue.</p>", 2394 "UpdateQueueStatusRequest$Status": "<p>The status of the queue.</p>" 2395 } 2396 }, 2397 "QueueSummary": { 2398 "base": "<p>Contains summary information about a queue.</p>", 2399 "refs": { 2400 "QueueSummaryList$member": null 2401 } 2402 }, 2403 "QueueSummaryList": { 2404 "base": null, 2405 "refs": { 2406 "ListQueuesResponse$QueueSummaryList": "<p>Information about the queues.</p>" 2407 } 2408 }, 2409 "QueueType": { 2410 "base": null, 2411 "refs": { 2412 "QueueSummary$QueueType": "<p>The type of queue.</p>", 2413 "QueueTypes$member": null 2414 } 2415 }, 2416 "QueueTypes": { 2417 "base": null, 2418 "refs": { 2419 "ListQueuesRequest$QueueTypes": "<p>The type of queue.</p>" 2420 } 2421 }, 2422 "Queues": { 2423 "base": null, 2424 "refs": { 2425 "Filters$Queues": "<p>The queues to use to filter the metrics. You can specify up to 100 queues per request.</p>" 2426 } 2427 }, 2428 "QuickConnect": { 2429 "base": "<p>Contains information about a quick connect.</p>", 2430 "refs": { 2431 "DescribeQuickConnectResponse$QuickConnect": "<p>Information about the quick connect.</p>" 2432 } 2433 }, 2434 "QuickConnectConfig": { 2435 "base": "<p>Contains configuration settings for a quick connect.</p>", 2436 "refs": { 2437 "CreateQuickConnectRequest$QuickConnectConfig": "<p>Configuration settings for the quick connect.</p>", 2438 "QuickConnect$QuickConnectConfig": "<p>Contains information about the quick connect.</p>", 2439 "UpdateQuickConnectConfigRequest$QuickConnectConfig": "<p>Information about the configuration settings for the quick connect.</p>" 2440 } 2441 }, 2442 "QuickConnectDescription": { 2443 "base": null, 2444 "refs": { 2445 "CreateQuickConnectRequest$Description": "<p>The description of the quick connect.</p>", 2446 "QuickConnect$Description": "<p>The description.</p>" 2447 } 2448 }, 2449 "QuickConnectId": { 2450 "base": null, 2451 "refs": { 2452 "CreateQuickConnectResponse$QuickConnectId": "<p>The identifier for the quick connect. </p>", 2453 "DeleteQuickConnectRequest$QuickConnectId": "<p>The identifier for the quick connect.</p>", 2454 "DescribeQuickConnectRequest$QuickConnectId": "<p>The identifier for the quick connect.</p>", 2455 "QuickConnect$QuickConnectId": "<p>The identifier for the quick connect.</p>", 2456 "QuickConnectSummary$Id": "<p>The identifier for the quick connect.</p>", 2457 "QuickConnectsList$member": null, 2458 "UpdateQuickConnectConfigRequest$QuickConnectId": "<p>The identifier for the quick connect.</p>", 2459 "UpdateQuickConnectNameRequest$QuickConnectId": "<p>The identifier for the quick connect.</p>" 2460 } 2461 }, 2462 "QuickConnectName": { 2463 "base": null, 2464 "refs": { 2465 "CreateQuickConnectRequest$Name": "<p>The name of the quick connect.</p>", 2466 "QuickConnect$Name": "<p>The name of the quick connect.</p>", 2467 "QuickConnectSummary$Name": "<p>The name of the quick connect.</p>", 2468 "UpdateQuickConnectNameRequest$Name": "<p>The name of the quick connect.</p>" 2469 } 2470 }, 2471 "QuickConnectSummary": { 2472 "base": "<p>Contains summary information about a quick connect.</p>", 2473 "refs": { 2474 "QuickConnectSummaryList$member": null 2475 } 2476 }, 2477 "QuickConnectSummaryList": { 2478 "base": null, 2479 "refs": { 2480 "ListQueueQuickConnectsResponse$QuickConnectSummaryList": "<p>Information about the quick connects.</p>", 2481 "ListQuickConnectsResponse$QuickConnectSummaryList": "<p>Information about the quick connects.</p>" 2482 } 2483 }, 2484 "QuickConnectType": { 2485 "base": null, 2486 "refs": { 2487 "QuickConnectConfig$QuickConnectType": "<p>The type of quick connect. In the Amazon Connect console, 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>", 2488 "QuickConnectSummary$QuickConnectType": "<p>The type of quick connect. In the Amazon Connect console, 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>", 2489 "QuickConnectTypes$member": null 2490 } 2491 }, 2492 "QuickConnectTypes": { 2493 "base": null, 2494 "refs": { 2495 "ListQuickConnectsRequest$QuickConnectTypes": "<p>The type of quick connect. In the Amazon Connect console, 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>" 2496 } 2497 }, 2498 "QuickConnectsList": { 2499 "base": null, 2500 "refs": { 2501 "AssociateQueueQuickConnectsRequest$QuickConnectIds": "<p>The quick connects to associate with this queue.</p>", 2502 "CreateQueueRequest$QuickConnectIds": "<p>The quick connects available to agents who are working the queue.</p>", 2503 "DisassociateQueueQuickConnectsRequest$QuickConnectIds": "<p>The quick connects to disassociate from the queue.</p>" 2504 } 2505 }, 2506 "Reference": { 2507 "base": "<p>A link that an agent selects to complete a given task. You can have up to 4,096 UTF-8 bytes across all references for a contact.</p>", 2508 "refs": { 2509 "ContactReferences$value": null 2510 } 2511 }, 2512 "ReferenceKey": { 2513 "base": null, 2514 "refs": { 2515 "ContactReferences$key": null 2516 } 2517 }, 2518 "ReferenceType": { 2519 "base": null, 2520 "refs": { 2521 "Reference$Type": "<p>A valid URL.</p>" 2522 } 2523 }, 2524 "ReferenceValue": { 2525 "base": null, 2526 "refs": { 2527 "Reference$Value": "<p>A formatted URL that displays to an agent in the Contact Control Panel (CCP)</p>" 2528 } 2529 }, 2530 "ResourceConflictException": { 2531 "base": "<p>A resource already has that name.</p>", 2532 "refs": { 2533 } 2534 }, 2535 "ResourceInUseException": { 2536 "base": "<p>That resource is already in use. Please try another.</p>", 2537 "refs": { 2538 } 2539 }, 2540 "ResourceNotFoundException": { 2541 "base": "<p>The specified resource was not found.</p>", 2542 "refs": { 2543 } 2544 }, 2545 "ResourceType": { 2546 "base": null, 2547 "refs": { 2548 "ResourceInUseException$ResourceType": "<p>The type of resource.</p>" 2549 } 2550 }, 2551 "ResumeContactRecordingRequest": { 2552 "base": null, 2553 "refs": { 2554 } 2555 }, 2556 "ResumeContactRecordingResponse": { 2557 "base": null, 2558 "refs": { 2559 } 2560 }, 2561 "RoutingProfile": { 2562 "base": "<p>Contains information about a routing profile.</p>", 2563 "refs": { 2564 "DescribeRoutingProfileResponse$RoutingProfile": "<p>The routing profile.</p>" 2565 } 2566 }, 2567 "RoutingProfileDescription": { 2568 "base": null, 2569 "refs": { 2570 "CreateRoutingProfileRequest$Description": "<p>Description of the routing profile. Must not be more than 250 characters.</p>", 2571 "RoutingProfile$Description": "<p>The description of the routing profile.</p>", 2572 "UpdateRoutingProfileNameRequest$Description": "<p>The description of the routing profile. Must not be more than 250 characters.</p>" 2573 } 2574 }, 2575 "RoutingProfileId": { 2576 "base": null, 2577 "refs": { 2578 "AssociateRoutingProfileQueuesRequest$RoutingProfileId": "<p>The identifier of the routing profile.</p>", 2579 "CreateRoutingProfileResponse$RoutingProfileId": "<p>The identifier of the routing profile.</p>", 2580 "CreateUserRequest$RoutingProfileId": "<p>The identifier of the routing profile for the user.</p>", 2581 "DescribeRoutingProfileRequest$RoutingProfileId": "<p>The identifier of the routing profile.</p>", 2582 "DisassociateRoutingProfileQueuesRequest$RoutingProfileId": "<p>The identifier of the routing profile.</p>", 2583 "ListRoutingProfileQueuesRequest$RoutingProfileId": "<p>The identifier of the routing profile.</p>", 2584 "RoutingProfile$RoutingProfileId": "<p>The identifier of the routing profile.</p>", 2585 "RoutingProfileSummary$Id": "<p>The identifier of the routing profile.</p>", 2586 "UpdateRoutingProfileConcurrencyRequest$RoutingProfileId": "<p>The identifier of the routing profile.</p>", 2587 "UpdateRoutingProfileDefaultOutboundQueueRequest$RoutingProfileId": "<p>The identifier of the routing profile.</p>", 2588 "UpdateRoutingProfileNameRequest$RoutingProfileId": "<p>The identifier of the routing profile.</p>", 2589 "UpdateRoutingProfileQueuesRequest$RoutingProfileId": "<p>The identifier of the routing profile.</p>", 2590 "UpdateUserRoutingProfileRequest$RoutingProfileId": "<p>The identifier of the routing profile for the user.</p>", 2591 "User$RoutingProfileId": "<p>The identifier of the routing profile for the user.</p>" 2592 } 2593 }, 2594 "RoutingProfileName": { 2595 "base": null, 2596 "refs": { 2597 "CreateRoutingProfileRequest$Name": "<p>The name of the routing profile. Must not be more than 127 characters.</p>", 2598 "RoutingProfile$Name": "<p>The name of the routing profile.</p>", 2599 "RoutingProfileSummary$Name": "<p>The name of the routing profile.</p>", 2600 "UpdateRoutingProfileNameRequest$Name": "<p>The name of the routing profile. Must not be more than 127 characters.</p>" 2601 } 2602 }, 2603 "RoutingProfileQueueConfig": { 2604 "base": "<p>Contains information about the queue and channel for which priority and delay can be set.</p>", 2605 "refs": { 2606 "RoutingProfileQueueConfigList$member": null 2607 } 2608 }, 2609 "RoutingProfileQueueConfigList": { 2610 "base": null, 2611 "refs": { 2612 "AssociateRoutingProfileQueuesRequest$QueueConfigs": "<p>The queues to associate with this routing profile.</p>", 2613 "CreateRoutingProfileRequest$QueueConfigs": "<p>The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls.</p>", 2614 "UpdateRoutingProfileQueuesRequest$QueueConfigs": "<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>" 2615 } 2616 }, 2617 "RoutingProfileQueueConfigSummary": { 2618 "base": "<p>Contains summary information about a routing profile queue.</p>", 2619 "refs": { 2620 "RoutingProfileQueueConfigSummaryList$member": null 2621 } 2622 }, 2623 "RoutingProfileQueueConfigSummaryList": { 2624 "base": null, 2625 "refs": { 2626 "ListRoutingProfileQueuesResponse$RoutingProfileQueueConfigSummaryList": "<p>Information about the routing profiles.</p>" 2627 } 2628 }, 2629 "RoutingProfileQueueReference": { 2630 "base": "<p>Contains the channel and queue identifier for a routing profile.</p>", 2631 "refs": { 2632 "RoutingProfileQueueConfig$QueueReference": "<p>Contains information about a queue resource.</p>", 2633 "RoutingProfileQueueReferenceList$member": null 2634 } 2635 }, 2636 "RoutingProfileQueueReferenceList": { 2637 "base": null, 2638 "refs": { 2639 "DisassociateRoutingProfileQueuesRequest$QueueReferences": "<p>The queues to disassociate from this routing profile.</p>" 2640 } 2641 }, 2642 "RoutingProfileSummary": { 2643 "base": "<p>Contains summary information about a routing profile.</p>", 2644 "refs": { 2645 "RoutingProfileSummaryList$member": null 2646 } 2647 }, 2648 "RoutingProfileSummaryList": { 2649 "base": null, 2650 "refs": { 2651 "ListRoutingProfilesResponse$RoutingProfileSummaryList": "<p>Information about the routing profiles.</p>" 2652 } 2653 }, 2654 "S3Config": { 2655 "base": "<p>Information about the Amazon Simple Storage Service (Amazon S3) storage type.</p>", 2656 "refs": { 2657 "InstanceStorageConfig$S3Config": "<p>The S3 bucket configuration.</p>" 2658 } 2659 }, 2660 "SecurityKey": { 2661 "base": "<p>Configuration information of the security key.</p>", 2662 "refs": { 2663 "SecurityKeysList$member": null 2664 } 2665 }, 2666 "SecurityKeysList": { 2667 "base": null, 2668 "refs": { 2669 "ListSecurityKeysResponse$SecurityKeys": "<p>The security keys.</p>" 2670 } 2671 }, 2672 "SecurityProfile": { 2673 "base": "<p>Contains information about a security profile.</p>", 2674 "refs": { 2675 "DescribeSecurityProfileResponse$SecurityProfile": "<p>The security profile.</p>" 2676 } 2677 }, 2678 "SecurityProfileDescription": { 2679 "base": null, 2680 "refs": { 2681 "CreateSecurityProfileRequest$Description": "<p>The description of the security profile.</p>", 2682 "SecurityProfile$Description": "<p>The description of the security profile.</p>", 2683 "UpdateSecurityProfileRequest$Description": "<p>The description of the security profile.</p>" 2684 } 2685 }, 2686 "SecurityProfileId": { 2687 "base": null, 2688 "refs": { 2689 "CreateSecurityProfileResponse$SecurityProfileId": "<p>The identifier for the security profle.</p>", 2690 "DeleteSecurityProfileRequest$SecurityProfileId": "<p>The identifier for the security profle.</p>", 2691 "DescribeSecurityProfileRequest$SecurityProfileId": "<p>The identifier for the security profle.</p>", 2692 "ListSecurityProfilePermissionsRequest$SecurityProfileId": "<p>The identifier for the security profle.</p>", 2693 "SecurityProfile$Id": "<p>The identifier for the security profile.</p>", 2694 "SecurityProfileIds$member": null, 2695 "SecurityProfileSummary$Id": "<p>The identifier of the security profile.</p>", 2696 "UpdateSecurityProfileRequest$SecurityProfileId": "<p>The identifier for the security profle.</p>" 2697 } 2698 }, 2699 "SecurityProfileIds": { 2700 "base": null, 2701 "refs": { 2702 "CreateUserRequest$SecurityProfileIds": "<p>The identifier of the security profile for the user.</p>", 2703 "UpdateUserSecurityProfilesRequest$SecurityProfileIds": "<p>The identifiers of the security profiles for the user.</p>", 2704 "User$SecurityProfileIds": "<p>The identifiers of the security profiles for the user.</p>" 2705 } 2706 }, 2707 "SecurityProfileName": { 2708 "base": null, 2709 "refs": { 2710 "CreateSecurityProfileRequest$SecurityProfileName": "<p>The name of the security profile.</p>", 2711 "SecurityProfile$SecurityProfileName": "<p>The name for the security profile.</p>", 2712 "SecurityProfileSummary$Name": "<p>The name of the security profile.</p>" 2713 } 2714 }, 2715 "SecurityProfilePermission": { 2716 "base": null, 2717 "refs": { 2718 "PermissionsList$member": null 2719 } 2720 }, 2721 "SecurityProfileSummary": { 2722 "base": "<p>Contains information about a security profile.</p>", 2723 "refs": { 2724 "SecurityProfileSummaryList$member": null 2725 } 2726 }, 2727 "SecurityProfileSummaryList": { 2728 "base": null, 2729 "refs": { 2730 "ListSecurityProfilesResponse$SecurityProfileSummaryList": "<p>Information about the security profiles.</p>" 2731 } 2732 }, 2733 "SecurityToken": { 2734 "base": null, 2735 "refs": { 2736 "Credentials$AccessToken": "<p>An access token generated for a federated user to access Amazon Connect.</p>", 2737 "Credentials$RefreshToken": "<p>Renews a token generated for a user to access the Amazon Connect instance.</p>" 2738 } 2739 }, 2740 "ServiceQuotaExceededException": { 2741 "base": "<p>The service quota has been exceeded.</p>", 2742 "refs": { 2743 } 2744 }, 2745 "SourceApplicationName": { 2746 "base": null, 2747 "refs": { 2748 "CreateIntegrationAssociationRequest$SourceApplicationName": "<p>The name of the external application. This field is only required for the EVENT integration type.</p>", 2749 "IntegrationAssociationSummary$SourceApplicationName": "<p>The user-provided, friendly name for the external application.</p>" 2750 } 2751 }, 2752 "SourceType": { 2753 "base": null, 2754 "refs": { 2755 "CreateIntegrationAssociationRequest$SourceType": "<p>The type of the data source. This field is only required for the EVENT integration type.</p>", 2756 "IntegrationAssociationSummary$SourceType": "<p>The name of the source.</p>" 2757 } 2758 }, 2759 "StartChatContactRequest": { 2760 "base": null, 2761 "refs": { 2762 } 2763 }, 2764 "StartChatContactResponse": { 2765 "base": null, 2766 "refs": { 2767 } 2768 }, 2769 "StartContactRecordingRequest": { 2770 "base": null, 2771 "refs": { 2772 } 2773 }, 2774 "StartContactRecordingResponse": { 2775 "base": null, 2776 "refs": { 2777 } 2778 }, 2779 "StartContactStreamingRequest": { 2780 "base": null, 2781 "refs": { 2782 } 2783 }, 2784 "StartContactStreamingResponse": { 2785 "base": null, 2786 "refs": { 2787 } 2788 }, 2789 "StartOutboundVoiceContactRequest": { 2790 "base": null, 2791 "refs": { 2792 } 2793 }, 2794 "StartOutboundVoiceContactResponse": { 2795 "base": null, 2796 "refs": { 2797 } 2798 }, 2799 "StartTaskContactRequest": { 2800 "base": null, 2801 "refs": { 2802 } 2803 }, 2804 "StartTaskContactResponse": { 2805 "base": null, 2806 "refs": { 2807 } 2808 }, 2809 "Statistic": { 2810 "base": null, 2811 "refs": { 2812 "HistoricalMetric$Statistic": "<p>The statistic for the metric.</p>" 2813 } 2814 }, 2815 "StopContactRecordingRequest": { 2816 "base": null, 2817 "refs": { 2818 } 2819 }, 2820 "StopContactRecordingResponse": { 2821 "base": null, 2822 "refs": { 2823 } 2824 }, 2825 "StopContactRequest": { 2826 "base": null, 2827 "refs": { 2828 } 2829 }, 2830 "StopContactResponse": { 2831 "base": null, 2832 "refs": { 2833 } 2834 }, 2835 "StopContactStreamingRequest": { 2836 "base": null, 2837 "refs": { 2838 } 2839 }, 2840 "StopContactStreamingResponse": { 2841 "base": null, 2842 "refs": { 2843 } 2844 }, 2845 "StorageType": { 2846 "base": null, 2847 "refs": { 2848 "InstanceStorageConfig$StorageType": "<p>A valid storage type.</p>" 2849 } 2850 }, 2851 "StreamingId": { 2852 "base": null, 2853 "refs": { 2854 "StartContactStreamingResponse$StreamingId": "<p>The identifier of the streaming configuration enabled. </p>", 2855 "StopContactStreamingRequest$StreamingId": "<p>The identifier of the streaming configuration enabled. </p>" 2856 } 2857 }, 2858 "String": { 2859 "base": null, 2860 "refs": { 2861 "InstanceStatusReason$Message": "<p>The message.</p>" 2862 } 2863 }, 2864 "SuspendContactRecordingRequest": { 2865 "base": null, 2866 "refs": { 2867 } 2868 }, 2869 "SuspendContactRecordingResponse": { 2870 "base": null, 2871 "refs": { 2872 } 2873 }, 2874 "TagKey": { 2875 "base": null, 2876 "refs": { 2877 "TagKeyList$member": null, 2878 "TagMap$key": null 2879 } 2880 }, 2881 "TagKeyList": { 2882 "base": null, 2883 "refs": { 2884 "UntagResourceRequest$tagKeys": "<p>The tag keys.</p>" 2885 } 2886 }, 2887 "TagMap": { 2888 "base": null, 2889 "refs": { 2890 "AgentStatus$Tags": "<p>The tags used to organize, track, or control access for this resource.</p>", 2891 "ContactFlow$Tags": "<p>One or more tags.</p>", 2892 "CreateAgentStatusRequest$Tags": "<p>The tags used to organize, track, or control access for this resource.</p>", 2893 "CreateContactFlowRequest$Tags": "<p>One or more tags.</p>", 2894 "CreateHoursOfOperationRequest$Tags": "<p>The tags used to organize, track, or control access for this resource.</p>", 2895 "CreateIntegrationAssociationRequest$Tags": "<p>The tags used to organize, track, or control access for this resource.</p>", 2896 "CreateQueueRequest$Tags": "<p>The tags used to organize, track, or control access for this resource.</p>", 2897 "CreateQuickConnectRequest$Tags": "<p>The tags used to organize, track, or control access for this resource.</p>", 2898 "CreateRoutingProfileRequest$Tags": "<p>One or more tags.</p>", 2899 "CreateSecurityProfileRequest$Tags": "<p>The tags used to organize, track, or control access for this resource.</p>", 2900 "CreateUseCaseRequest$Tags": "<p>The tags used to organize, track, or control access for this resource.</p>", 2901 "CreateUserRequest$Tags": "<p>One or more tags.</p>", 2902 "HoursOfOperation$Tags": "<p>The tags used to organize, track, or control access for this resource.</p>", 2903 "ListTagsForResourceResponse$tags": "<p>Information about the tags.</p>", 2904 "Queue$Tags": "<p>The tags used to organize, track, or control access for this resource.</p>", 2905 "QuickConnect$Tags": "<p>The tags used to organize, track, or control access for this resource.</p>", 2906 "RoutingProfile$Tags": "<p>One or more tags.</p>", 2907 "SecurityProfile$Tags": "<p>The tags used to organize, track, or control access for this resource.</p>", 2908 "TagResourceRequest$tags": "<p>One or more tags. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>", 2909 "User$Tags": "<p>The tags.</p>" 2910 } 2911 }, 2912 "TagResourceRequest": { 2913 "base": null, 2914 "refs": { 2915 } 2916 }, 2917 "TagValue": { 2918 "base": null, 2919 "refs": { 2920 "TagMap$value": null 2921 } 2922 }, 2923 "Threshold": { 2924 "base": "<p>Contains information about the threshold for service level metrics.</p>", 2925 "refs": { 2926 "HistoricalMetric$Threshold": "<p>The threshold for the metric, used with service level metrics.</p>" 2927 } 2928 }, 2929 "ThresholdValue": { 2930 "base": null, 2931 "refs": { 2932 "Threshold$ThresholdValue": "<p>The threshold value to compare.</p>" 2933 } 2934 }, 2935 "ThrottlingException": { 2936 "base": "<p>The throttling limit has been exceeded.</p>", 2937 "refs": { 2938 } 2939 }, 2940 "TimeZone": { 2941 "base": null, 2942 "refs": { 2943 "CreateHoursOfOperationRequest$TimeZone": "<p>The time zone of the hours of operation.</p>", 2944 "HoursOfOperation$TimeZone": "<p>The time zone for the hours of operation.</p>", 2945 "UpdateHoursOfOperationRequest$TimeZone": "<p>The time zone of the hours of operation.</p>" 2946 } 2947 }, 2948 "Timestamp": { 2949 "base": null, 2950 "refs": { 2951 "Instance$CreatedTime": "<p>When the instance was created.</p>", 2952 "InstanceSummary$CreatedTime": "<p>When the instance was created.</p>" 2953 } 2954 }, 2955 "TrafficType": { 2956 "base": null, 2957 "refs": { 2958 "StartOutboundVoiceContactRequest$TrafficType": "<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>" 2959 } 2960 }, 2961 "URI": { 2962 "base": null, 2963 "refs": { 2964 "CreateIntegrationAssociationRequest$SourceApplicationUrl": "<p>The URL for the external application. This field is only required for the EVENT integration type.</p>", 2965 "IntegrationAssociationSummary$SourceApplicationUrl": "<p>The URL for the external application.</p>" 2966 } 2967 }, 2968 "Unit": { 2969 "base": null, 2970 "refs": { 2971 "CurrentMetric$Unit": "<p>The unit for the metric.</p>", 2972 "HistoricalMetric$Unit": "<p>The unit for the metric.</p>" 2973 } 2974 }, 2975 "UntagResourceRequest": { 2976 "base": null, 2977 "refs": { 2978 } 2979 }, 2980 "UpdateAgentStatusDescription": { 2981 "base": null, 2982 "refs": { 2983 "UpdateAgentStatusRequest$Description": "<p>The description of the agent status.</p>" 2984 } 2985 }, 2986 "UpdateAgentStatusRequest": { 2987 "base": null, 2988 "refs": { 2989 } 2990 }, 2991 "UpdateContactAttributesRequest": { 2992 "base": null, 2993 "refs": { 2994 } 2995 }, 2996 "UpdateContactAttributesResponse": { 2997 "base": null, 2998 "refs": { 2999 } 3000 }, 3001 "UpdateContactFlowContentRequest": { 3002 "base": null, 3003 "refs": { 3004 } 3005 }, 3006 "UpdateContactFlowNameRequest": { 3007 "base": null, 3008 "refs": { 3009 } 3010 }, 3011 "UpdateHoursOfOperationDescription": { 3012 "base": null, 3013 "refs": { 3014 "UpdateHoursOfOperationRequest$Description": "<p>The description of the hours of operation.</p>" 3015 } 3016 }, 3017 "UpdateHoursOfOperationRequest": { 3018 "base": null, 3019 "refs": { 3020 } 3021 }, 3022 "UpdateInstanceAttributeRequest": { 3023 "base": null, 3024 "refs": { 3025 } 3026 }, 3027 "UpdateInstanceStorageConfigRequest": { 3028 "base": null, 3029 "refs": { 3030 } 3031 }, 3032 "UpdateQueueHoursOfOperationRequest": { 3033 "base": null, 3034 "refs": { 3035 } 3036 }, 3037 "UpdateQueueMaxContactsRequest": { 3038 "base": null, 3039 "refs": { 3040 } 3041 }, 3042 "UpdateQueueNameRequest": { 3043 "base": null, 3044 "refs": { 3045 } 3046 }, 3047 "UpdateQueueOutboundCallerConfigRequest": { 3048 "base": null, 3049 "refs": { 3050 } 3051 }, 3052 "UpdateQueueStatusRequest": { 3053 "base": null, 3054 "refs": { 3055 } 3056 }, 3057 "UpdateQuickConnectConfigRequest": { 3058 "base": null, 3059 "refs": { 3060 } 3061 }, 3062 "UpdateQuickConnectDescription": { 3063 "base": null, 3064 "refs": { 3065 "UpdateQuickConnectNameRequest$Description": "<p>The description of the quick connect.</p>" 3066 } 3067 }, 3068 "UpdateQuickConnectNameRequest": { 3069 "base": null, 3070 "refs": { 3071 } 3072 }, 3073 "UpdateRoutingProfileConcurrencyRequest": { 3074 "base": null, 3075 "refs": { 3076 } 3077 }, 3078 "UpdateRoutingProfileDefaultOutboundQueueRequest": { 3079 "base": null, 3080 "refs": { 3081 } 3082 }, 3083 "UpdateRoutingProfileNameRequest": { 3084 "base": null, 3085 "refs": { 3086 } 3087 }, 3088 "UpdateRoutingProfileQueuesRequest": { 3089 "base": null, 3090 "refs": { 3091 } 3092 }, 3093 "UpdateSecurityProfileRequest": { 3094 "base": null, 3095 "refs": { 3096 } 3097 }, 3098 "UpdateUserHierarchyGroupNameRequest": { 3099 "base": null, 3100 "refs": { 3101 } 3102 }, 3103 "UpdateUserHierarchyRequest": { 3104 "base": null, 3105 "refs": { 3106 } 3107 }, 3108 "UpdateUserHierarchyStructureRequest": { 3109 "base": null, 3110 "refs": { 3111 } 3112 }, 3113 "UpdateUserIdentityInfoRequest": { 3114 "base": null, 3115 "refs": { 3116 } 3117 }, 3118 "UpdateUserPhoneConfigRequest": { 3119 "base": null, 3120 "refs": { 3121 } 3122 }, 3123 "UpdateUserRoutingProfileRequest": { 3124 "base": null, 3125 "refs": { 3126 } 3127 }, 3128 "UpdateUserSecurityProfilesRequest": { 3129 "base": null, 3130 "refs": { 3131 } 3132 }, 3133 "UseCase": { 3134 "base": "<p>Contains the use case.</p>", 3135 "refs": { 3136 "UseCaseSummaryList$member": null 3137 } 3138 }, 3139 "UseCaseId": { 3140 "base": null, 3141 "refs": { 3142 "CreateUseCaseResponse$UseCaseId": "<p>The identifier of the use case.</p>", 3143 "DeleteUseCaseRequest$UseCaseId": "<p>The identifier for the use case.</p>", 3144 "UseCase$UseCaseId": "<p>The identifier for the use case.</p>" 3145 } 3146 }, 3147 "UseCaseSummaryList": { 3148 "base": null, 3149 "refs": { 3150 "ListUseCasesResponse$UseCaseSummaryList": "<p>The use cases.</p>" 3151 } 3152 }, 3153 "UseCaseType": { 3154 "base": null, 3155 "refs": { 3156 "CreateUseCaseRequest$UseCaseType": "<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>", 3157 "UseCase$UseCaseType": "<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>" 3158 } 3159 }, 3160 "User": { 3161 "base": "<p>Contains information about a user account for a Amazon Connect instance.</p>", 3162 "refs": { 3163 "DescribeUserResponse$User": "<p>Information about the user account and configuration settings.</p>" 3164 } 3165 }, 3166 "UserId": { 3167 "base": null, 3168 "refs": { 3169 "CreateUserResponse$UserId": "<p>The identifier of the user account.</p>", 3170 "DeleteUserRequest$UserId": "<p>The identifier of the user.</p>", 3171 "DescribeUserRequest$UserId": "<p>The identifier of the user account.</p>", 3172 "UpdateUserHierarchyRequest$UserId": "<p>The identifier of the user account.</p>", 3173 "UpdateUserIdentityInfoRequest$UserId": "<p>The identifier of the user account.</p>", 3174 "UpdateUserPhoneConfigRequest$UserId": "<p>The identifier of the user account.</p>", 3175 "UpdateUserRoutingProfileRequest$UserId": "<p>The identifier of the user account.</p>", 3176 "UpdateUserSecurityProfilesRequest$UserId": "<p>The identifier of the user account.</p>", 3177 "User$Id": "<p>The identifier of the user account.</p>", 3178 "UserQuickConnectConfig$UserId": "<p>The identifier of the user.</p>", 3179 "UserSummary$Id": "<p>The identifier of the user account.</p>" 3180 } 3181 }, 3182 "UserIdentityInfo": { 3183 "base": "<p>Contains information about the identity of a user.</p>", 3184 "refs": { 3185 "CreateUserRequest$IdentityInfo": "<p>The information about the identity of the user.</p>", 3186 "UpdateUserIdentityInfoRequest$IdentityInfo": "<p>The identity information for the user.</p>", 3187 "User$IdentityInfo": "<p>Information about the user identity.</p>" 3188 } 3189 }, 3190 "UserNotFoundException": { 3191 "base": "<p>No user with the specified credentials was found in the Amazon Connect instance.</p>", 3192 "refs": { 3193 } 3194 }, 3195 "UserPhoneConfig": { 3196 "base": "<p>Contains information about the phone configuration settings for a user.</p>", 3197 "refs": { 3198 "CreateUserRequest$PhoneConfig": "<p>The phone settings for the user.</p>", 3199 "UpdateUserPhoneConfigRequest$PhoneConfig": "<p>Information about phone configuration settings for the user.</p>", 3200 "User$PhoneConfig": "<p>Information about the phone configuration for the user.</p>" 3201 } 3202 }, 3203 "UserQuickConnectConfig": { 3204 "base": "<p>Contains information about the quick connect configuration settings for a user. The contact flow must be of type Transfer to Agent.</p>", 3205 "refs": { 3206 "QuickConnectConfig$UserConfig": "<p>The user configuration. This is required only if QuickConnectType is USER.</p>" 3207 } 3208 }, 3209 "UserSummary": { 3210 "base": "<p>Contains summary information about a user.</p>", 3211 "refs": { 3212 "UserSummaryList$member": null 3213 } 3214 }, 3215 "UserSummaryList": { 3216 "base": null, 3217 "refs": { 3218 "ListUsersResponse$UserSummaryList": "<p>Information about the users.</p>" 3219 } 3220 }, 3221 "Value": { 3222 "base": null, 3223 "refs": { 3224 "CurrentMetricData$Value": "<p>The value of the metric.</p>", 3225 "HistoricalMetricData$Value": "<p>The value of the metric.</p>" 3226 } 3227 }, 3228 "VoiceRecordingConfiguration": { 3229 "base": "<p>Contains information about the recording configuration settings.</p>", 3230 "refs": { 3231 "StartContactRecordingRequest$VoiceRecordingConfiguration": "<p>The person being recorded.</p>" 3232 } 3233 }, 3234 "VoiceRecordingTrack": { 3235 "base": null, 3236 "refs": { 3237 "VoiceRecordingConfiguration$VoiceRecordingTrack": "<p>Identifies which track is being recorded.</p>" 3238 } 3239 }, 3240 "timestamp": { 3241 "base": null, 3242 "refs": { 3243 "Credentials$AccessTokenExpiration": "<p>A token generated with an expiration time for the session a user is logged in to Amazon Connect.</p>", 3244 "Credentials$RefreshTokenExpiration": "<p>Renews the expiration timer for a generated token.</p>", 3245 "GetCurrentMetricDataResponse$DataSnapshotTime": "<p>The time at which the metrics were retrieved and cached for pagination.</p>", 3246 "GetMetricDataRequest$StartTime": "<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>", 3247 "GetMetricDataRequest$EndTime": "<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>", 3248 "SecurityKey$CreationTime": "<p>When the security key was created.</p>" 3249 } 3250 } 3251 } 3252} 3253