1{ 2 "version": "2.0", 3 "service": "<p>Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.</p> <p>Amazon Connect provides rich metrics and real-time reporting that allow you to optimize contact routing. You can also resolve customer issues more efficiently by putting customers in touch with the right agents.</p> <p>There are limits to the number of Amazon Connect resources that you can create and 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>To connect programmatically to an AWS service, you use 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 "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 Amazon S3 bucket, exists when being used for association.</p>", 7 "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>", 8 "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>", 9 "AssociateRoutingProfileQueues": "<p>Associates a set of queues with a routing profile.</p>", 10 "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>", 11 "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>", 12 "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 S3, or Kinesis) or allow for any configurations on features such as Contact Lens for Amazon Connect. </p>", 13 "CreateIntegrationAssociation": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Create an AppIntegration association with an Amazon Connect instance.</p>", 14 "CreateQuickConnect": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Creates a quick connect for the specified Amazon Connect instance.</p>", 15 "CreateRoutingProfile": "<p>Creates a new routing profile.</p>", 16 "CreateUseCase": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Creates a use case for an AppIntegration association.</p>", 17 "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>", 18 "CreateUserHierarchyGroup": "<p>Creates a new user hierarchy group.</p>", 19 "DeleteInstance": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Deletes the Amazon Connect instance.</p>", 20 "DeleteIntegrationAssociation": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Deletes an AppIntegration association from an Amazon Connect instance. The association must not have any use cases associated with it.</p>", 21 "DeleteQuickConnect": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Deletes a quick connect.</p>", 22 "DeleteUseCase": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Deletes a use case from an AppIntegration association.</p>", 23 "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>", 24 "DeleteUserHierarchyGroup": "<p>Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.</p>", 25 "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>", 26 "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>", 27 "DescribeInstanceAttribute": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Describes the specified instance attribute.</p>", 28 "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>", 29 "DescribeQuickConnect": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Describes the quick connect.</p>", 30 "DescribeRoutingProfile": "<p>Describes the specified routing profile.</p>", 31 "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>", 32 "DescribeUserHierarchyGroup": "<p>Describes the specified hierarchy group.</p>", 33 "DescribeUserHierarchyStructure": "<p>Describes the hierarchy structure of the specified Amazon Connect instance.</p>", 34 "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>", 35 "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>", 36 "DisassociateLambdaFunction": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Remove the Lambda function from the drop-down options available in the relevant contact flow blocks.</p>", 37 "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>", 38 "DisassociateRoutingProfileQueues": "<p>Disassociates a set of queues from a routing profile.</p>", 39 "DisassociateSecurityKey": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Deletes the specified security key.</p>", 40 "GetContactAttributes": "<p>Retrieves the contact attributes for the specified contact.</p>", 41 "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>", 42 "GetFederationToken": "<p>Retrieves a token for federation.</p>", 43 "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>", 44 "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>", 45 "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>", 46 "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>", 47 "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>", 48 "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>", 49 "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>", 50 "ListIntegrationAssociations": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Provides summary information about the AppIntegration associations for the specified Amazon Connect instance.</p>", 51 "ListLambdaFunctions": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Returns a paginated list of all the Lambda functions that show up in the drop-down options in the relevant contact flow blocks.</p>", 52 "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>", 53 "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>", 54 "ListPrompts": "<p>Provides information about the prompts for the specified Amazon Connect instance.</p>", 55 "ListQueues": "<p>Provides information about the queues for the specified Amazon Connect instance.</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>", 56 "ListQuickConnects": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Provides information about the quick connects for the specified Amazon Connect instance. </p>", 57 "ListRoutingProfileQueues": "<p>List the queues associated with a routing profile.</p>", 58 "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>", 59 "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>", 60 "ListSecurityProfiles": "<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>", 61 "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>", 62 "ListUseCases": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>List the use cases. </p>", 63 "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>", 64 "ListUsers": "<p>Provides summary information about the users for the specified Amazon Connect instance.</p>", 65 "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>", 66 "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 need to 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 from the API Gateway.</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 how chat works, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/chat.html\">Chat</a> in the <i>Amazon Connect Administrator Guide</i>.</p>", 67 "StartContactRecording": "<p>This API 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>", 68 "StartOutboundVoiceContact": "<p>This API 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 are not involved in initiating the outbound API (that is, dialing the contact). If the contact flow places an outbound call to a contact, and then puts the contact in queue, that's when the call is 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>", 69 "StartTaskContact": "<p>Initiates a contact flow to start a new task.</p>", 70 "StopContact": "<p>Ends the specified contact.</p>", 71 "StopContactRecording": "<p>When a contact is being recorded, this API stops recording the call. 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>", 72 "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>", 73 "TagResource": "<p>Adds the specified tags to the specified resource.</p> <p>The supported resource types are users, routing profiles, quick connects, and contact flows.</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>", 74 "UntagResource": "<p>Removes the specified tags from the specified resource.</p>", 75 "UpdateContactAttributes": "<p>Creates or updates the contact attributes associated with the specified contact.</p> <p>You can add or update attributes for both ongoing and completed contacts. For example, you can update the customer's name or the reason the customer called while the call is active, or add notes about steps that the agent took during the call that are displayed 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 identifying abusive callers.</p> <p>Contact attributes are available in Amazon Connect for 24 months, and are then deleted.</p> <p> <b>Important:</b> You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, 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>", 76 "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>", 77 "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>", 78 "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>", 79 "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>", 80 "UpdateQuickConnectConfig": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates the configuration settings for the specified quick connect.</p>", 81 "UpdateQuickConnectName": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name or Description must be provided.</p>", 82 "UpdateRoutingProfileConcurrency": "<p>Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.</p>", 83 "UpdateRoutingProfileDefaultOutboundQueue": "<p>Updates the default outbound queue of a routing profile.</p>", 84 "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>", 85 "UpdateRoutingProfileQueues": "<p>Updates the properties associated with a set of queues for a routing profile.</p>", 86 "UpdateUserHierarchy": "<p>Assigns the specified hierarchy group to the specified user.</p>", 87 "UpdateUserHierarchyGroupName": "<p>Updates the name of the user hierarchy group. </p>", 88 "UpdateUserHierarchyStructure": "<p>Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.</p>", 89 "UpdateUserIdentityInfo": "<p>Updates the identity information for the specified user.</p> <important> <p>Someone with the ability to invoke <code>UpdateUserIndentityInfo</code> 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. We strongly recommend limiting who has the ability to invoke <code>UpdateUserIndentityInfo</code>. 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>", 90 "UpdateUserPhoneConfig": "<p>Updates the phone configuration settings for the specified user.</p>", 91 "UpdateUserRoutingProfile": "<p>Assigns the specified routing profile to the specified user.</p>", 92 "UpdateUserSecurityProfiles": "<p>Assigns the specified security profiles to the specified user.</p>" 93 }, 94 "shapes": { 95 "ARN": { 96 "base": null, 97 "refs": { 98 "ContactFlow$Arn": "<p>The Amazon Resource Name (ARN) of the contact flow.</p>", 99 "ContactFlowSummary$Arn": "<p>The Amazon Resource Name (ARN) of the contact flow.</p>", 100 "CreateContactFlowResponse$ContactFlowArn": "<p>The Amazon Resource Name (ARN) of the contact flow.</p>", 101 "CreateInstanceResponse$Arn": "<p>The Amazon Resource Name (ARN) of the instance.</p>", 102 "CreateIntegrationAssociationRequest$IntegrationArn": "<p>The Amazon Resource Name (ARN) of the integration.</p>", 103 "CreateIntegrationAssociationResponse$IntegrationAssociationArn": "<p>The Amazon Resource Name (ARN) for the association.</p>", 104 "CreateQuickConnectResponse$QuickConnectARN": "<p>The Amazon Resource Name (ARN) for the quick connect. </p>", 105 "CreateRoutingProfileResponse$RoutingProfileArn": "<p>The Amazon Resource Name (ARN) of the routing profile.</p>", 106 "CreateUseCaseResponse$UseCaseArn": "<p>The Amazon Resource Name (ARN) for the use case.</p>", 107 "CreateUserHierarchyGroupResponse$HierarchyGroupArn": "<p>The Amazon Resource Name (ARN) of the hierarchy group. </p>", 108 "CreateUserResponse$UserArn": "<p>The Amazon Resource Name (ARN) of the user account.</p>", 109 "HierarchyGroup$Arn": "<p>The Amazon Resource Name (ARN) of the hierarchy group.</p>", 110 "HierarchyGroupSummary$Arn": "<p>The Amazon Resource Name (ARN) of the hierarchy group.</p>", 111 "HierarchyLevel$Arn": "<p>The Amazon Resource Name (ARN) of the hierarchy level.</p>", 112 "HoursOfOperationSummary$Arn": "<p>The Amazon Resource Name (ARN) of the hours of operation.</p>", 113 "Instance$Arn": "<p>The Amazon Resource Name (ARN) of the instance.</p>", 114 "Instance$ServiceRole": "<p>The service role of the instance.</p>", 115 "InstanceSummary$Arn": "<p>The Amazon Resource Name (ARN) of the instance.</p>", 116 "InstanceSummary$ServiceRole": "<p>The service role of the instance.</p>", 117 "IntegrationAssociationSummary$IntegrationAssociationArn": "<p>The Amazon Resource Name (ARN) for the AppIntegration association.</p>", 118 "IntegrationAssociationSummary$IntegrationArn": "<p>The Amazon Resource Name (ARN) for the AppIntegration.</p>", 119 "KinesisFirehoseConfig$FirehoseArn": "<p>The Amazon Resource Name (ARN) of the delivery stream.</p>", 120 "KinesisStreamConfig$StreamArn": "<p>The Amazon Resource Name (ARN) of the data stream.</p>", 121 "ListTagsForResourceRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>", 122 "PhoneNumberSummary$Arn": "<p>The Amazon Resource Name (ARN) of the phone number.</p>", 123 "PromptSummary$Arn": "<p>The Amazon Resource Name (ARN) of the prompt.</p>", 124 "QueueReference$Arn": "<p>The Amazon Resource Name (ARN) of the queue.</p>", 125 "QueueSummary$Arn": "<p>The Amazon Resource Name (ARN) of the queue.</p>", 126 "QuickConnect$QuickConnectARN": "<p>The Amazon Resource Name (ARN) of the quick connect.</p>", 127 "QuickConnectSummary$Arn": "<p>The Amazon Resource Name (ARN).</p>", 128 "ResourceInUseException$ResourceId": "<p>The identifier for the resource.</p>", 129 "RoutingProfile$RoutingProfileArn": "<p>The Amazon Resource Name (ARN) of the routing profile.</p>", 130 "RoutingProfileQueueConfigSummary$QueueArn": "<p>The Amazon Resource Name (ARN) of the queue.</p>", 131 "RoutingProfileSummary$Arn": "<p>The Amazon Resource Name (ARN) of the routing profile.</p>", 132 "SecurityProfileSummary$Arn": "<p>The Amazon Resource Name (ARN) of the security profile.</p>", 133 "TagResourceRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>", 134 "UntagResourceRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>", 135 "UseCase$UseCaseArn": "<p>The Amazon Resource Name (ARN) for the use case.</p>", 136 "User$Arn": "<p>The Amazon Resource Name (ARN) of the user account.</p>", 137 "UserSummary$Arn": "<p>The Amazon Resource Name (ARN) of the user account.</p>" 138 } 139 }, 140 "AfterContactWorkTimeLimit": { 141 "base": null, 142 "refs": { 143 "UserPhoneConfig$AfterContactWorkTimeLimit": "<p>The After Call Work (ACW) timeout setting, in seconds.</p>" 144 } 145 }, 146 "AgentFirstName": { 147 "base": null, 148 "refs": { 149 "UserIdentityInfo$FirstName": "<p>The first name. This is required if you are using Amazon Connect or SAML for identity management.</p>" 150 } 151 }, 152 "AgentLastName": { 153 "base": null, 154 "refs": { 155 "UserIdentityInfo$LastName": "<p>The last name. This is required if you are using Amazon Connect or SAML for identity management.</p>" 156 } 157 }, 158 "AgentUsername": { 159 "base": null, 160 "refs": { 161 "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>", 162 "User$Username": "<p>The user name assigned to the user account.</p>", 163 "UserSummary$Username": "<p>The Amazon Connect user name of the user account.</p>" 164 } 165 }, 166 "AssociateApprovedOriginRequest": { 167 "base": null, 168 "refs": { 169 } 170 }, 171 "AssociateInstanceStorageConfigRequest": { 172 "base": null, 173 "refs": { 174 } 175 }, 176 "AssociateInstanceStorageConfigResponse": { 177 "base": null, 178 "refs": { 179 } 180 }, 181 "AssociateLambdaFunctionRequest": { 182 "base": null, 183 "refs": { 184 } 185 }, 186 "AssociateLexBotRequest": { 187 "base": null, 188 "refs": { 189 } 190 }, 191 "AssociateRoutingProfileQueuesRequest": { 192 "base": null, 193 "refs": { 194 } 195 }, 196 "AssociateSecurityKeyRequest": { 197 "base": null, 198 "refs": { 199 } 200 }, 201 "AssociateSecurityKeyResponse": { 202 "base": null, 203 "refs": { 204 } 205 }, 206 "AssociationId": { 207 "base": null, 208 "refs": { 209 "AssociateInstanceStorageConfigResponse$AssociationId": "<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>", 210 "AssociateSecurityKeyResponse$AssociationId": "<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>", 211 "DescribeInstanceStorageConfigRequest$AssociationId": "<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>", 212 "DisassociateInstanceStorageConfigRequest$AssociationId": "<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>", 213 "DisassociateSecurityKeyRequest$AssociationId": "<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>", 214 "InstanceStorageConfig$AssociationId": "<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>", 215 "SecurityKey$AssociationId": "<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>", 216 "UpdateInstanceStorageConfigRequest$AssociationId": "<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>" 217 } 218 }, 219 "Attribute": { 220 "base": "<p>A toggle for an individual feature at the instance level.</p>", 221 "refs": { 222 "AttributesList$member": null, 223 "DescribeInstanceAttributeResponse$Attribute": "<p>The type of attribute.</p>" 224 } 225 }, 226 "AttributeName": { 227 "base": null, 228 "refs": { 229 "Attributes$key": null 230 } 231 }, 232 "AttributeValue": { 233 "base": null, 234 "refs": { 235 "Attributes$value": null 236 } 237 }, 238 "Attributes": { 239 "base": null, 240 "refs": { 241 "GetContactAttributesResponse$Attributes": "<p>Information about the attributes.</p>", 242 "StartChatContactRequest$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>", 243 "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>", 244 "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>", 245 "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>" 246 } 247 }, 248 "AttributesList": { 249 "base": null, 250 "refs": { 251 "ListInstanceAttributesResponse$Attributes": "<p>The attribute types.</p>" 252 } 253 }, 254 "AutoAccept": { 255 "base": null, 256 "refs": { 257 "UserPhoneConfig$AutoAccept": "<p>The Auto accept setting.</p>" 258 } 259 }, 260 "BotName": { 261 "base": null, 262 "refs": { 263 "DisassociateLexBotRequest$BotName": "<p>The name of the Amazon Lex bot. Maximum character limit of 50.</p>", 264 "LexBot$Name": "<p>The name of the Amazon Lex bot.</p>" 265 } 266 }, 267 "BucketName": { 268 "base": null, 269 "refs": { 270 "S3Config$BucketName": "<p>The S3 bucket name.</p>" 271 } 272 }, 273 "Channel": { 274 "base": null, 275 "refs": { 276 "Channels$member": null, 277 "Dimensions$Channel": "<p>The channel used for grouping and filters.</p>", 278 "MediaConcurrency$Channel": "<p>The channels that agents can handle in the Contact Control Panel (CCP).</p>", 279 "RoutingProfileQueueConfigSummary$Channel": "<p>The channels this queue supports.</p>", 280 "RoutingProfileQueueReference$Channel": "<p>The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.</p>" 281 } 282 }, 283 "Channels": { 284 "base": null, 285 "refs": { 286 "Filters$Channels": "<p>The channel to use to filter the metrics.</p>" 287 } 288 }, 289 "ChatContent": { 290 "base": null, 291 "refs": { 292 "ChatMessage$Content": "<p>The content of the chat message.</p>" 293 } 294 }, 295 "ChatContentType": { 296 "base": null, 297 "refs": { 298 "ChatMessage$ContentType": "<p>The type of the content. Supported types are text/plain.</p>" 299 } 300 }, 301 "ChatMessage": { 302 "base": "<p>A chat message.</p>", 303 "refs": { 304 "StartChatContactRequest$InitialMessage": "<p>The initial message to be sent to the newly created chat.</p>" 305 } 306 }, 307 "ClientToken": { 308 "base": null, 309 "refs": { 310 "CreateInstanceRequest$ClientToken": "<p>The idempotency token.</p>", 311 "StartChatContactRequest$ClientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>", 312 "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. If the contact is disconnected, a new contact is started.</p>", 313 "StartTaskContactRequest$ClientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>" 314 } 315 }, 316 "Comparison": { 317 "base": null, 318 "refs": { 319 "Threshold$Comparison": "<p>The type of comparison. Only \"less than\" (LT) comparisons are supported.</p>" 320 } 321 }, 322 "Concurrency": { 323 "base": null, 324 "refs": { 325 "MediaConcurrency$Concurrency": "<p>The number of contacts an agent can have on a channel simultaneously.</p>" 326 } 327 }, 328 "ContactFlow": { 329 "base": "<p>Contains information about a contact flow.</p>", 330 "refs": { 331 "DescribeContactFlowResponse$ContactFlow": "<p>Information about the contact flow.</p>" 332 } 333 }, 334 "ContactFlowContent": { 335 "base": null, 336 "refs": { 337 "ContactFlow$Content": "<p>The content of the contact flow.</p>", 338 "CreateContactFlowRequest$Content": "<p>The content of the contact flow. </p>", 339 "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>" 340 } 341 }, 342 "ContactFlowDescription": { 343 "base": null, 344 "refs": { 345 "ContactFlow$Description": "<p>The description of the contact flow.</p>", 346 "CreateContactFlowRequest$Description": "<p>The description of the contact flow. </p>", 347 "UpdateContactFlowNameRequest$Description": "<p>The description of the contact flow.</p>" 348 } 349 }, 350 "ContactFlowId": { 351 "base": null, 352 "refs": { 353 "ContactFlow$Id": "<p>The identifier of the contact flow.</p>", 354 "ContactFlowSummary$Id": "<p>The identifier of the contact flow.</p>", 355 "CreateContactFlowResponse$ContactFlowId": "<p>The identifier of the contact flow.</p>", 356 "DescribeContactFlowRequest$ContactFlowId": "<p>The identifier of the contact flow.</p>", 357 "QueueQuickConnectConfig$ContactFlowId": "<p>The identifier of the contact flow.</p>", 358 "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>", 359 "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>", 360 "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>", 361 "UpdateContactFlowContentRequest$ContactFlowId": "<p>The identifier of the contact flow.</p>", 362 "UpdateContactFlowNameRequest$ContactFlowId": "<p>The identifier of the contact flow.</p>", 363 "UserQuickConnectConfig$ContactFlowId": "<p>The identifier of the contact flow.</p>" 364 } 365 }, 366 "ContactFlowName": { 367 "base": null, 368 "refs": { 369 "ContactFlow$Name": "<p>The name of the contact flow.</p>", 370 "ContactFlowSummary$Name": "<p>The name of the contact flow.</p>", 371 "CreateContactFlowRequest$Name": "<p>The name of the contact flow.</p>", 372 "UpdateContactFlowNameRequest$Name": "<p>The name of the contact flow.</p>" 373 } 374 }, 375 "ContactFlowNotPublishedException": { 376 "base": "<p>The contact flow has not been published.</p>", 377 "refs": { 378 } 379 }, 380 "ContactFlowSummary": { 381 "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>", 382 "refs": { 383 "ContactFlowSummaryList$member": null 384 } 385 }, 386 "ContactFlowSummaryList": { 387 "base": null, 388 "refs": { 389 "ListContactFlowsResponse$ContactFlowSummaryList": "<p>Information about the contact flows.</p>" 390 } 391 }, 392 "ContactFlowType": { 393 "base": null, 394 "refs": { 395 "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>", 396 "ContactFlowSummary$ContactFlowType": "<p>The type of contact flow.</p>", 397 "ContactFlowTypes$member": null, 398 "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>" 399 } 400 }, 401 "ContactFlowTypes": { 402 "base": null, 403 "refs": { 404 "ListContactFlowsRequest$ContactFlowTypes": "<p>The type of contact flow.</p>" 405 } 406 }, 407 "ContactId": { 408 "base": null, 409 "refs": { 410 "GetContactAttributesRequest$InitialContactId": "<p>The identifier of the initial contact.</p>", 411 "ResumeContactRecordingRequest$ContactId": "<p>The identifier of the contact.</p>", 412 "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>", 413 "StartChatContactResponse$ContactId": "<p>The identifier of this contact within the Amazon Connect instance. </p>", 414 "StartContactRecordingRequest$ContactId": "<p>The identifier of the contact.</p>", 415 "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>", 416 "StartOutboundVoiceContactResponse$ContactId": "<p>The identifier of this contact within the Amazon Connect instance.</p>", 417 "StartTaskContactRequest$PreviousContactId": "<p>The identifier of the previous chat, voice, or task contact. </p>", 418 "StartTaskContactResponse$ContactId": "<p>The identifier of this contact within the Amazon Connect instance.</p>", 419 "StopContactRecordingRequest$ContactId": "<p>The identifier of the contact.</p>", 420 "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>", 421 "StopContactRequest$ContactId": "<p>The ID of the contact.</p>", 422 "SuspendContactRecordingRequest$ContactId": "<p>The identifier of the contact.</p>", 423 "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>", 424 "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>" 425 } 426 }, 427 "ContactNotFoundException": { 428 "base": "<p>The contact with the specified ID is not active or does not exist.</p>", 429 "refs": { 430 } 431 }, 432 "ContactReferences": { 433 "base": null, 434 "refs": { 435 "StartTaskContactRequest$References": "<p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP).</p>" 436 } 437 }, 438 "CreateContactFlowRequest": { 439 "base": null, 440 "refs": { 441 } 442 }, 443 "CreateContactFlowResponse": { 444 "base": null, 445 "refs": { 446 } 447 }, 448 "CreateInstanceRequest": { 449 "base": null, 450 "refs": { 451 } 452 }, 453 "CreateInstanceResponse": { 454 "base": null, 455 "refs": { 456 } 457 }, 458 "CreateIntegrationAssociationRequest": { 459 "base": null, 460 "refs": { 461 } 462 }, 463 "CreateIntegrationAssociationResponse": { 464 "base": null, 465 "refs": { 466 } 467 }, 468 "CreateQuickConnectRequest": { 469 "base": null, 470 "refs": { 471 } 472 }, 473 "CreateQuickConnectResponse": { 474 "base": null, 475 "refs": { 476 } 477 }, 478 "CreateRoutingProfileRequest": { 479 "base": null, 480 "refs": { 481 } 482 }, 483 "CreateRoutingProfileResponse": { 484 "base": null, 485 "refs": { 486 } 487 }, 488 "CreateUseCaseRequest": { 489 "base": null, 490 "refs": { 491 } 492 }, 493 "CreateUseCaseResponse": { 494 "base": null, 495 "refs": { 496 } 497 }, 498 "CreateUserHierarchyGroupRequest": { 499 "base": null, 500 "refs": { 501 } 502 }, 503 "CreateUserHierarchyGroupResponse": { 504 "base": null, 505 "refs": { 506 } 507 }, 508 "CreateUserRequest": { 509 "base": null, 510 "refs": { 511 } 512 }, 513 "CreateUserResponse": { 514 "base": null, 515 "refs": { 516 } 517 }, 518 "Credentials": { 519 "base": "<p>Contains credentials to use for federation.</p>", 520 "refs": { 521 "GetFederationTokenResponse$Credentials": "<p>The credentials to use for federation.</p>" 522 } 523 }, 524 "CurrentMetric": { 525 "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>", 526 "refs": { 527 "CurrentMetricData$Metric": "<p>Information about the metric.</p>", 528 "CurrentMetrics$member": null 529 } 530 }, 531 "CurrentMetricData": { 532 "base": "<p>Contains the data for a real-time metric.</p>", 533 "refs": { 534 "CurrentMetricDataCollections$member": null 535 } 536 }, 537 "CurrentMetricDataCollections": { 538 "base": null, 539 "refs": { 540 "CurrentMetricResult$Collections": "<p>The set of metrics.</p>" 541 } 542 }, 543 "CurrentMetricName": { 544 "base": "<p>The current metric names.</p>", 545 "refs": { 546 "CurrentMetric$Name": "<p>The name of the metric.</p>" 547 } 548 }, 549 "CurrentMetricResult": { 550 "base": "<p>Contains information about a set of real-time metrics.</p>", 551 "refs": { 552 "CurrentMetricResults$member": null 553 } 554 }, 555 "CurrentMetricResults": { 556 "base": null, 557 "refs": { 558 "GetCurrentMetricDataResponse$MetricResults": "<p>Information about the real-time metrics.</p>" 559 } 560 }, 561 "CurrentMetrics": { 562 "base": null, 563 "refs": { 564 "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 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>" 565 } 566 }, 567 "Delay": { 568 "base": null, 569 "refs": { 570 "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>", 571 "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>" 572 } 573 }, 574 "DeleteInstanceRequest": { 575 "base": null, 576 "refs": { 577 } 578 }, 579 "DeleteIntegrationAssociationRequest": { 580 "base": null, 581 "refs": { 582 } 583 }, 584 "DeleteQuickConnectRequest": { 585 "base": null, 586 "refs": { 587 } 588 }, 589 "DeleteUseCaseRequest": { 590 "base": null, 591 "refs": { 592 } 593 }, 594 "DeleteUserHierarchyGroupRequest": { 595 "base": null, 596 "refs": { 597 } 598 }, 599 "DeleteUserRequest": { 600 "base": null, 601 "refs": { 602 } 603 }, 604 "DescribeContactFlowRequest": { 605 "base": null, 606 "refs": { 607 } 608 }, 609 "DescribeContactFlowResponse": { 610 "base": null, 611 "refs": { 612 } 613 }, 614 "DescribeInstanceAttributeRequest": { 615 "base": null, 616 "refs": { 617 } 618 }, 619 "DescribeInstanceAttributeResponse": { 620 "base": null, 621 "refs": { 622 } 623 }, 624 "DescribeInstanceRequest": { 625 "base": null, 626 "refs": { 627 } 628 }, 629 "DescribeInstanceResponse": { 630 "base": null, 631 "refs": { 632 } 633 }, 634 "DescribeInstanceStorageConfigRequest": { 635 "base": null, 636 "refs": { 637 } 638 }, 639 "DescribeInstanceStorageConfigResponse": { 640 "base": null, 641 "refs": { 642 } 643 }, 644 "DescribeQuickConnectRequest": { 645 "base": null, 646 "refs": { 647 } 648 }, 649 "DescribeQuickConnectResponse": { 650 "base": null, 651 "refs": { 652 } 653 }, 654 "DescribeRoutingProfileRequest": { 655 "base": null, 656 "refs": { 657 } 658 }, 659 "DescribeRoutingProfileResponse": { 660 "base": null, 661 "refs": { 662 } 663 }, 664 "DescribeUserHierarchyGroupRequest": { 665 "base": null, 666 "refs": { 667 } 668 }, 669 "DescribeUserHierarchyGroupResponse": { 670 "base": null, 671 "refs": { 672 } 673 }, 674 "DescribeUserHierarchyStructureRequest": { 675 "base": null, 676 "refs": { 677 } 678 }, 679 "DescribeUserHierarchyStructureResponse": { 680 "base": null, 681 "refs": { 682 } 683 }, 684 "DescribeUserRequest": { 685 "base": null, 686 "refs": { 687 } 688 }, 689 "DescribeUserResponse": { 690 "base": null, 691 "refs": { 692 } 693 }, 694 "Description": { 695 "base": null, 696 "refs": { 697 "StartTaskContactRequest$Description": "<p>A description of the task that is shown to an agent in the Contact Control Panel (CCP).</p>" 698 } 699 }, 700 "DestinationNotAllowedException": { 701 "base": "<p>Outbound calls to the destination number are not allowed.</p>", 702 "refs": { 703 } 704 }, 705 "Dimensions": { 706 "base": "<p>Contains information about the dimensions for a set of metrics.</p>", 707 "refs": { 708 "CurrentMetricResult$Dimensions": "<p>The dimensions for the metrics.</p>", 709 "HistoricalMetricResult$Dimensions": "<p>The dimension for the metrics.</p>" 710 } 711 }, 712 "DirectoryAlias": { 713 "base": null, 714 "refs": { 715 "CreateInstanceRequest$InstanceAlias": "<p>The name for your instance.</p>", 716 "Instance$InstanceAlias": "<p>The alias of instance.</p>", 717 "InstanceSummary$InstanceAlias": "<p>The alias of the instance.</p>" 718 } 719 }, 720 "DirectoryId": { 721 "base": null, 722 "refs": { 723 "CreateInstanceRequest$DirectoryId": "<p>The identifier for the directory.</p>" 724 } 725 }, 726 "DirectoryType": { 727 "base": null, 728 "refs": { 729 "CreateInstanceRequest$IdentityManagementType": "<p>The type of identity management for your Amazon Connect users.</p>", 730 "Instance$IdentityManagementType": "<p>The identity management type.</p>", 731 "InstanceSummary$IdentityManagementType": "<p>The identity management type of the instance.</p>" 732 } 733 }, 734 "DirectoryUserId": { 735 "base": null, 736 "refs": { 737 "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>", 738 "User$DirectoryUserId": "<p>The identifier of the user account in the directory used for identity management.</p>" 739 } 740 }, 741 "DisassociateApprovedOriginRequest": { 742 "base": null, 743 "refs": { 744 } 745 }, 746 "DisassociateInstanceStorageConfigRequest": { 747 "base": null, 748 "refs": { 749 } 750 }, 751 "DisassociateLambdaFunctionRequest": { 752 "base": null, 753 "refs": { 754 } 755 }, 756 "DisassociateLexBotRequest": { 757 "base": null, 758 "refs": { 759 } 760 }, 761 "DisassociateRoutingProfileQueuesRequest": { 762 "base": null, 763 "refs": { 764 } 765 }, 766 "DisassociateSecurityKeyRequest": { 767 "base": null, 768 "refs": { 769 } 770 }, 771 "DisplayName": { 772 "base": null, 773 "refs": { 774 "ParticipantDetails$DisplayName": "<p>Display name of the participant.</p>" 775 } 776 }, 777 "DuplicateResourceException": { 778 "base": "<p>A resource with the specified name already exists.</p>", 779 "refs": { 780 } 781 }, 782 "Email": { 783 "base": null, 784 "refs": { 785 "UserIdentityInfo$Email": "<p>The email address. If you are using SAML for identity management and include this parameter, an error is returned.</p>" 786 } 787 }, 788 "EncryptionConfig": { 789 "base": "<p>The encryption configuration.</p>", 790 "refs": { 791 "KinesisVideoStreamConfig$EncryptionConfig": "<p>The encryption configuration.</p>", 792 "S3Config$EncryptionConfig": "<p>The S3 encryption configuration.</p>" 793 } 794 }, 795 "EncryptionType": { 796 "base": null, 797 "refs": { 798 "EncryptionConfig$EncryptionType": "<p>The type of encryption.</p>" 799 } 800 }, 801 "Filters": { 802 "base": "<p>Contains the filter to apply when retrieving metrics.</p>", 803 "refs": { 804 "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>", 805 "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>" 806 } 807 }, 808 "FunctionArn": { 809 "base": null, 810 "refs": { 811 "AssociateLambdaFunctionRequest$FunctionArn": "<p>The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is 140.</p>", 812 "DisassociateLambdaFunctionRequest$FunctionArn": "<p>The Amazon Resource Name (ARN) of the Lambda function being disassociated.</p>", 813 "FunctionArnsList$member": null 814 } 815 }, 816 "FunctionArnsList": { 817 "base": null, 818 "refs": { 819 "ListLambdaFunctionsResponse$LambdaFunctions": "<p>The Lambdafunction ARNs associated with the specified instance.</p>" 820 } 821 }, 822 "GetContactAttributesRequest": { 823 "base": null, 824 "refs": { 825 } 826 }, 827 "GetContactAttributesResponse": { 828 "base": null, 829 "refs": { 830 } 831 }, 832 "GetCurrentMetricDataRequest": { 833 "base": null, 834 "refs": { 835 } 836 }, 837 "GetCurrentMetricDataResponse": { 838 "base": null, 839 "refs": { 840 } 841 }, 842 "GetFederationTokenRequest": { 843 "base": null, 844 "refs": { 845 } 846 }, 847 "GetFederationTokenResponse": { 848 "base": null, 849 "refs": { 850 } 851 }, 852 "GetMetricDataRequest": { 853 "base": null, 854 "refs": { 855 } 856 }, 857 "GetMetricDataResponse": { 858 "base": null, 859 "refs": { 860 } 861 }, 862 "Grouping": { 863 "base": null, 864 "refs": { 865 "Groupings$member": null 866 } 867 }, 868 "Groupings": { 869 "base": null, 870 "refs": { 871 "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>", 872 "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>The only supported grouping is <code>QUEUE</code>.</p> <p>If no grouping is specified, a summary of metrics for all queues is returned.</p>" 873 } 874 }, 875 "HierarchyGroup": { 876 "base": "<p>Contains information about a hierarchy group.</p>", 877 "refs": { 878 "DescribeUserHierarchyGroupResponse$HierarchyGroup": "<p>Information about the hierarchy group.</p>" 879 } 880 }, 881 "HierarchyGroupId": { 882 "base": null, 883 "refs": { 884 "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>", 885 "CreateUserHierarchyGroupResponse$HierarchyGroupId": "<p>The identifier of the hierarchy group.</p>", 886 "CreateUserRequest$HierarchyGroupId": "<p>The identifier of the hierarchy group for the user.</p>", 887 "DeleteUserHierarchyGroupRequest$HierarchyGroupId": "<p>The identifier of the hierarchy group.</p>", 888 "DescribeUserHierarchyGroupRequest$HierarchyGroupId": "<p>The identifier of the hierarchy group.</p>", 889 "HierarchyGroup$Id": "<p>The identifier of the hierarchy group.</p>", 890 "HierarchyGroupSummary$Id": "<p>The identifier of the hierarchy group.</p>", 891 "UpdateUserHierarchyGroupNameRequest$HierarchyGroupId": "<p>The identifier of the hierarchy group.</p>", 892 "UpdateUserHierarchyRequest$HierarchyGroupId": "<p>The identifier of the hierarchy group.</p>", 893 "User$HierarchyGroupId": "<p>The identifier of the hierarchy group for the user.</p>" 894 } 895 }, 896 "HierarchyGroupName": { 897 "base": null, 898 "refs": { 899 "CreateUserHierarchyGroupRequest$Name": "<p>The name of the user hierarchy group. Must not be more than 100 characters.</p>", 900 "HierarchyGroup$Name": "<p>The name of the hierarchy group.</p>", 901 "HierarchyGroupSummary$Name": "<p>The name of the hierarchy group.</p>", 902 "UpdateUserHierarchyGroupNameRequest$Name": "<p>The name of the hierarchy group. Must not be more than 100 characters.</p>" 903 } 904 }, 905 "HierarchyGroupSummary": { 906 "base": "<p>Contains summary information about a hierarchy group.</p>", 907 "refs": { 908 "HierarchyGroupSummaryList$member": null, 909 "HierarchyPath$LevelOne": "<p>Information about level one.</p>", 910 "HierarchyPath$LevelTwo": "<p>Information about level two.</p>", 911 "HierarchyPath$LevelThree": "<p>Information about level three.</p>", 912 "HierarchyPath$LevelFour": "<p>Information about level four.</p>", 913 "HierarchyPath$LevelFive": "<p>Information about level five.</p>" 914 } 915 }, 916 "HierarchyGroupSummaryList": { 917 "base": null, 918 "refs": { 919 "ListUserHierarchyGroupsResponse$UserHierarchyGroupSummaryList": "<p>Information about the hierarchy groups.</p>" 920 } 921 }, 922 "HierarchyLevel": { 923 "base": "<p>Contains information about a hierarchy level.</p>", 924 "refs": { 925 "HierarchyStructure$LevelOne": "<p>Information about level one.</p>", 926 "HierarchyStructure$LevelTwo": "<p>Information about level two.</p>", 927 "HierarchyStructure$LevelThree": "<p>Information about level three.</p>", 928 "HierarchyStructure$LevelFour": "<p>Information about level four.</p>", 929 "HierarchyStructure$LevelFive": "<p>Information about level five.</p>" 930 } 931 }, 932 "HierarchyLevelId": { 933 "base": null, 934 "refs": { 935 "HierarchyGroup$LevelId": "<p>The identifier of the level in the hierarchy group.</p>", 936 "HierarchyLevel$Id": "<p>The identifier of the hierarchy level.</p>" 937 } 938 }, 939 "HierarchyLevelName": { 940 "base": null, 941 "refs": { 942 "HierarchyLevel$Name": "<p>The name of the hierarchy level.</p>", 943 "HierarchyLevelUpdate$Name": "<p>The name of the user hierarchy level. Must not be more than 50 characters.</p>" 944 } 945 }, 946 "HierarchyLevelUpdate": { 947 "base": "<p>Contains information about the hierarchy level to update.</p>", 948 "refs": { 949 "HierarchyStructureUpdate$LevelOne": "<p>The update for level one.</p>", 950 "HierarchyStructureUpdate$LevelTwo": "<p>The update for level two.</p>", 951 "HierarchyStructureUpdate$LevelThree": "<p>The update for level three.</p>", 952 "HierarchyStructureUpdate$LevelFour": "<p>The update for level four.</p>", 953 "HierarchyStructureUpdate$LevelFive": "<p>The update for level five.</p>" 954 } 955 }, 956 "HierarchyPath": { 957 "base": "<p>Contains information about the levels of a hierarchy group.</p>", 958 "refs": { 959 "HierarchyGroup$HierarchyPath": "<p>Information about the levels in the hierarchy group.</p>" 960 } 961 }, 962 "HierarchyStructure": { 963 "base": "<p>Contains information about a hierarchy structure.</p>", 964 "refs": { 965 "DescribeUserHierarchyStructureResponse$HierarchyStructure": "<p>Information about the hierarchy structure.</p>" 966 } 967 }, 968 "HierarchyStructureUpdate": { 969 "base": "<p>Contains information about the level hierarchy to update.</p>", 970 "refs": { 971 "UpdateUserHierarchyStructureRequest$HierarchyStructure": "<p>The hierarchy levels to update.</p>" 972 } 973 }, 974 "HistoricalMetric": { 975 "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>", 976 "refs": { 977 "HistoricalMetricData$Metric": "<p>Information about the metric.</p>", 978 "HistoricalMetrics$member": null 979 } 980 }, 981 "HistoricalMetricData": { 982 "base": "<p>Contains the data for a historical metric.</p>", 983 "refs": { 984 "HistoricalMetricDataCollections$member": null 985 } 986 }, 987 "HistoricalMetricDataCollections": { 988 "base": null, 989 "refs": { 990 "HistoricalMetricResult$Collections": "<p>The set of metrics.</p>" 991 } 992 }, 993 "HistoricalMetricName": { 994 "base": "<p>The historical metric names.</p>", 995 "refs": { 996 "HistoricalMetric$Name": "<p>The name of the metric.</p>" 997 } 998 }, 999 "HistoricalMetricResult": { 1000 "base": "<p>Contains information about the historical metrics retrieved.</p>", 1001 "refs": { 1002 "HistoricalMetricResults$member": null 1003 } 1004 }, 1005 "HistoricalMetricResults": { 1006 "base": null, 1007 "refs": { 1008 "GetMetricDataResponse$MetricResults": "<p>Information about the historical metrics.</p> <p>If no grouping is specified, a summary of metric data is returned.</p>" 1009 } 1010 }, 1011 "HistoricalMetrics": { 1012 "base": null, 1013 "refs": { 1014 "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> <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>Unit: PERCENT</p> <p>Statistic: AVG</p> <p>Threshold: Only \"Less than\" comparisons are supported, with the following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600</p> </dd> </dl>" 1015 } 1016 }, 1017 "Hours": { 1018 "base": null, 1019 "refs": { 1020 "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>" 1021 } 1022 }, 1023 "HoursOfOperationId": { 1024 "base": null, 1025 "refs": { 1026 "HoursOfOperationSummary$Id": "<p>The identifier of the hours of operation.</p>" 1027 } 1028 }, 1029 "HoursOfOperationName": { 1030 "base": null, 1031 "refs": { 1032 "HoursOfOperationSummary$Name": "<p>The name of the hours of operation.</p>" 1033 } 1034 }, 1035 "HoursOfOperationSummary": { 1036 "base": "<p>Contains summary information about hours of operation for a contact center.</p>", 1037 "refs": { 1038 "HoursOfOperationSummaryList$member": null 1039 } 1040 }, 1041 "HoursOfOperationSummaryList": { 1042 "base": null, 1043 "refs": { 1044 "ListHoursOfOperationsResponse$HoursOfOperationSummaryList": "<p>Information about the hours of operation.</p>" 1045 } 1046 }, 1047 "InboundCallsEnabled": { 1048 "base": null, 1049 "refs": { 1050 "CreateInstanceRequest$InboundCallsEnabled": "<p>Whether your contact center handles incoming contacts.</p>", 1051 "Instance$InboundCallsEnabled": "<p>Whether inbound calls are enabled.</p>", 1052 "InstanceSummary$InboundCallsEnabled": "<p>Whether inbound calls are enabled.</p>" 1053 } 1054 }, 1055 "Instance": { 1056 "base": "<p>The Amazon Connect instance.</p>", 1057 "refs": { 1058 "DescribeInstanceResponse$Instance": "<p>The name of the instance.</p>" 1059 } 1060 }, 1061 "InstanceAttributeType": { 1062 "base": null, 1063 "refs": { 1064 "Attribute$AttributeType": "<p>The type of attribute.</p>", 1065 "DescribeInstanceAttributeRequest$AttributeType": "<p>The type of attribute.</p>", 1066 "UpdateInstanceAttributeRequest$AttributeType": "<p>The type of attribute.</p>" 1067 } 1068 }, 1069 "InstanceAttributeValue": { 1070 "base": null, 1071 "refs": { 1072 "Attribute$Value": "<p>The value of the attribute.</p>", 1073 "UpdateInstanceAttributeRequest$Value": "<p>The value for the attribute. Maximum character limit is 100. </p>" 1074 } 1075 }, 1076 "InstanceId": { 1077 "base": null, 1078 "refs": { 1079 "AssociateApprovedOriginRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1080 "AssociateInstanceStorageConfigRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1081 "AssociateLambdaFunctionRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1082 "AssociateLexBotRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1083 "AssociateRoutingProfileQueuesRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1084 "AssociateSecurityKeyRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1085 "CreateContactFlowRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1086 "CreateInstanceResponse$Id": "<p>The identifier for the instance.</p>", 1087 "CreateIntegrationAssociationRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1088 "CreateQuickConnectRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1089 "CreateRoutingProfileRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1090 "CreateUseCaseRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1091 "CreateUserHierarchyGroupRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1092 "CreateUserRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1093 "DeleteInstanceRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1094 "DeleteIntegrationAssociationRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1095 "DeleteQuickConnectRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1096 "DeleteUseCaseRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1097 "DeleteUserHierarchyGroupRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1098 "DeleteUserRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1099 "DescribeContactFlowRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1100 "DescribeInstanceAttributeRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1101 "DescribeInstanceRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1102 "DescribeInstanceStorageConfigRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1103 "DescribeQuickConnectRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1104 "DescribeRoutingProfileRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1105 "DescribeUserHierarchyGroupRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1106 "DescribeUserHierarchyStructureRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1107 "DescribeUserRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1108 "DisassociateApprovedOriginRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1109 "DisassociateInstanceStorageConfigRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1110 "DisassociateLambdaFunctionRequest$InstanceId": "<p>The identifier of the Amazon Connect instance..</p>", 1111 "DisassociateLexBotRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1112 "DisassociateRoutingProfileQueuesRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1113 "DisassociateSecurityKeyRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1114 "GetContactAttributesRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1115 "GetCurrentMetricDataRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1116 "GetFederationTokenRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1117 "GetMetricDataRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1118 "Instance$Id": "<p>The identifier of the Amazon Connect instance.</p>", 1119 "InstanceSummary$Id": "<p>The identifier of the instance.</p>", 1120 "IntegrationAssociationSummary$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1121 "ListApprovedOriginsRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1122 "ListContactFlowsRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1123 "ListHoursOfOperationsRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1124 "ListInstanceAttributesRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1125 "ListInstanceStorageConfigsRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1126 "ListIntegrationAssociationsRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1127 "ListLambdaFunctionsRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1128 "ListLexBotsRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1129 "ListPhoneNumbersRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1130 "ListPromptsRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1131 "ListQueuesRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1132 "ListQuickConnectsRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1133 "ListRoutingProfileQueuesRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1134 "ListRoutingProfilesRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1135 "ListSecurityKeysRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1136 "ListSecurityProfilesRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1137 "ListUseCasesRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1138 "ListUserHierarchyGroupsRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1139 "ListUsersRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1140 "ResumeContactRecordingRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1141 "RoutingProfile$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1142 "StartChatContactRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1143 "StartContactRecordingRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1144 "StartOutboundVoiceContactRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1145 "StartTaskContactRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1146 "StopContactRecordingRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1147 "StopContactRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1148 "SuspendContactRecordingRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1149 "UpdateContactAttributesRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1150 "UpdateContactFlowContentRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1151 "UpdateContactFlowNameRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1152 "UpdateInstanceAttributeRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1153 "UpdateInstanceStorageConfigRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1154 "UpdateQuickConnectConfigRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1155 "UpdateQuickConnectNameRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1156 "UpdateRoutingProfileConcurrencyRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1157 "UpdateRoutingProfileDefaultOutboundQueueRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1158 "UpdateRoutingProfileNameRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1159 "UpdateRoutingProfileQueuesRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1160 "UpdateUserHierarchyGroupNameRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1161 "UpdateUserHierarchyRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1162 "UpdateUserHierarchyStructureRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1163 "UpdateUserIdentityInfoRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1164 "UpdateUserPhoneConfigRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1165 "UpdateUserRoutingProfileRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>", 1166 "UpdateUserSecurityProfilesRequest$InstanceId": "<p>The identifier of the Amazon Connect instance.</p>" 1167 } 1168 }, 1169 "InstanceStatus": { 1170 "base": null, 1171 "refs": { 1172 "Instance$InstanceStatus": "<p>The state of the instance.</p>", 1173 "InstanceSummary$InstanceStatus": "<p>The state of the instance.</p>" 1174 } 1175 }, 1176 "InstanceStatusReason": { 1177 "base": "<p>Relevant details why the instance was not successfully created.</p>", 1178 "refs": { 1179 "Instance$StatusReason": "<p>Relevant details why the instance was not successfully created. </p>" 1180 } 1181 }, 1182 "InstanceStorageConfig": { 1183 "base": "<p>The storage configuration for the instance.</p>", 1184 "refs": { 1185 "AssociateInstanceStorageConfigRequest$StorageConfig": "<p>A valid storage type.</p>", 1186 "DescribeInstanceStorageConfigResponse$StorageConfig": "<p>A valid storage type.</p>", 1187 "InstanceStorageConfigs$member": null, 1188 "UpdateInstanceStorageConfigRequest$StorageConfig": null 1189 } 1190 }, 1191 "InstanceStorageConfigs": { 1192 "base": null, 1193 "refs": { 1194 "ListInstanceStorageConfigsResponse$StorageConfigs": "<p>A valid storage type.</p>" 1195 } 1196 }, 1197 "InstanceStorageResourceType": { 1198 "base": null, 1199 "refs": { 1200 "AssociateInstanceStorageConfigRequest$ResourceType": "<p>A valid resource type.</p>", 1201 "DescribeInstanceStorageConfigRequest$ResourceType": "<p>A valid resource type.</p>", 1202 "DisassociateInstanceStorageConfigRequest$ResourceType": "<p>A valid resource type.</p>", 1203 "ListInstanceStorageConfigsRequest$ResourceType": "<p>A valid resource type.</p>", 1204 "UpdateInstanceStorageConfigRequest$ResourceType": "<p>A valid resource type.</p>" 1205 } 1206 }, 1207 "InstanceSummary": { 1208 "base": "<p>Information about the instance.</p>", 1209 "refs": { 1210 "InstanceSummaryList$member": null 1211 } 1212 }, 1213 "InstanceSummaryList": { 1214 "base": null, 1215 "refs": { 1216 "ListInstancesResponse$InstanceSummaryList": "<p>Information about the instances.</p>" 1217 } 1218 }, 1219 "IntegrationAssociationId": { 1220 "base": null, 1221 "refs": { 1222 "CreateIntegrationAssociationResponse$IntegrationAssociationId": "<p>The identifier for the association.</p>", 1223 "CreateUseCaseRequest$IntegrationAssociationId": "<p>The identifier for the AppIntegration association.</p>", 1224 "DeleteIntegrationAssociationRequest$IntegrationAssociationId": "<p>The identifier for the AppIntegration association.</p>", 1225 "DeleteUseCaseRequest$IntegrationAssociationId": "<p>The identifier for the AppIntegration association.</p>", 1226 "IntegrationAssociationSummary$IntegrationAssociationId": "<p>The identifier for the AppIntegration association.</p>", 1227 "ListUseCasesRequest$IntegrationAssociationId": "<p>The identifier for the integration association.</p>" 1228 } 1229 }, 1230 "IntegrationAssociationSummary": { 1231 "base": "<p>Contains summary information about the associated AppIntegrations.</p>", 1232 "refs": { 1233 "IntegrationAssociationSummaryList$member": null 1234 } 1235 }, 1236 "IntegrationAssociationSummaryList": { 1237 "base": null, 1238 "refs": { 1239 "ListIntegrationAssociationsResponse$IntegrationAssociationSummaryList": "<p>The AppIntegration associations.</p>" 1240 } 1241 }, 1242 "IntegrationType": { 1243 "base": null, 1244 "refs": { 1245 "CreateIntegrationAssociationRequest$IntegrationType": "<p>The type of information to be ingested.</p>", 1246 "IntegrationAssociationSummary$IntegrationType": "<p>The integration type.</p>" 1247 } 1248 }, 1249 "InternalServiceException": { 1250 "base": "<p>Request processing failed due to an error or failure with the service.</p>", 1251 "refs": { 1252 } 1253 }, 1254 "InvalidContactFlowException": { 1255 "base": "<p>The contact flow is not valid.</p>", 1256 "refs": { 1257 } 1258 }, 1259 "InvalidParameterException": { 1260 "base": "<p>One or more of the specified parameters are not valid.</p>", 1261 "refs": { 1262 } 1263 }, 1264 "InvalidRequestException": { 1265 "base": "<p>The request is not valid.</p>", 1266 "refs": { 1267 } 1268 }, 1269 "KeyId": { 1270 "base": null, 1271 "refs": { 1272 "EncryptionConfig$KeyId": "<p>The identifier of the encryption key.</p>" 1273 } 1274 }, 1275 "KinesisFirehoseConfig": { 1276 "base": "<p>Configuration information of a Kinesis Firehose delivery stream.</p>", 1277 "refs": { 1278 "InstanceStorageConfig$KinesisFirehoseConfig": "<p>The configuration of the Kinesis Firehose delivery stream.</p>" 1279 } 1280 }, 1281 "KinesisStreamConfig": { 1282 "base": "<p>Configuration information of a Kinesis data stream.</p>", 1283 "refs": { 1284 "InstanceStorageConfig$KinesisStreamConfig": "<p>The configuration of the Kinesis data stream.</p>" 1285 } 1286 }, 1287 "KinesisVideoStreamConfig": { 1288 "base": "<p>Configuration information of a Kinesis video stream.</p>", 1289 "refs": { 1290 "InstanceStorageConfig$KinesisVideoStreamConfig": "<p>The configuration of the Kinesis video stream.</p>" 1291 } 1292 }, 1293 "LexBot": { 1294 "base": "<p>Configuration information of an Amazon Lex bot.</p>", 1295 "refs": { 1296 "AssociateLexBotRequest$LexBot": "<p>The Amazon Lex box to associate with the instance.</p>", 1297 "LexBotsList$member": null 1298 } 1299 }, 1300 "LexBotsList": { 1301 "base": null, 1302 "refs": { 1303 "ListLexBotsResponse$LexBots": "<p>The the names and regions of the Amazon Lex bots associated with the specified instance.</p>" 1304 } 1305 }, 1306 "LexRegion": { 1307 "base": null, 1308 "refs": { 1309 "DisassociateLexBotRequest$LexRegion": "<p>The Region in which the Amazon Lex bot has been created.</p>", 1310 "LexBot$LexRegion": "<p>The Region the Amazon Lex bot was created in.</p>" 1311 } 1312 }, 1313 "LimitExceededException": { 1314 "base": "<p>The allowed limit for the resource has been exceeded.</p>", 1315 "refs": { 1316 } 1317 }, 1318 "ListApprovedOriginsRequest": { 1319 "base": null, 1320 "refs": { 1321 } 1322 }, 1323 "ListApprovedOriginsResponse": { 1324 "base": null, 1325 "refs": { 1326 } 1327 }, 1328 "ListContactFlowsRequest": { 1329 "base": null, 1330 "refs": { 1331 } 1332 }, 1333 "ListContactFlowsResponse": { 1334 "base": null, 1335 "refs": { 1336 } 1337 }, 1338 "ListHoursOfOperationsRequest": { 1339 "base": null, 1340 "refs": { 1341 } 1342 }, 1343 "ListHoursOfOperationsResponse": { 1344 "base": null, 1345 "refs": { 1346 } 1347 }, 1348 "ListInstanceAttributesRequest": { 1349 "base": null, 1350 "refs": { 1351 } 1352 }, 1353 "ListInstanceAttributesResponse": { 1354 "base": null, 1355 "refs": { 1356 } 1357 }, 1358 "ListInstanceStorageConfigsRequest": { 1359 "base": null, 1360 "refs": { 1361 } 1362 }, 1363 "ListInstanceStorageConfigsResponse": { 1364 "base": null, 1365 "refs": { 1366 } 1367 }, 1368 "ListInstancesRequest": { 1369 "base": null, 1370 "refs": { 1371 } 1372 }, 1373 "ListInstancesResponse": { 1374 "base": null, 1375 "refs": { 1376 } 1377 }, 1378 "ListIntegrationAssociationsRequest": { 1379 "base": null, 1380 "refs": { 1381 } 1382 }, 1383 "ListIntegrationAssociationsResponse": { 1384 "base": null, 1385 "refs": { 1386 } 1387 }, 1388 "ListLambdaFunctionsRequest": { 1389 "base": null, 1390 "refs": { 1391 } 1392 }, 1393 "ListLambdaFunctionsResponse": { 1394 "base": null, 1395 "refs": { 1396 } 1397 }, 1398 "ListLexBotsRequest": { 1399 "base": null, 1400 "refs": { 1401 } 1402 }, 1403 "ListLexBotsResponse": { 1404 "base": null, 1405 "refs": { 1406 } 1407 }, 1408 "ListPhoneNumbersRequest": { 1409 "base": null, 1410 "refs": { 1411 } 1412 }, 1413 "ListPhoneNumbersResponse": { 1414 "base": null, 1415 "refs": { 1416 } 1417 }, 1418 "ListPromptsRequest": { 1419 "base": null, 1420 "refs": { 1421 } 1422 }, 1423 "ListPromptsResponse": { 1424 "base": null, 1425 "refs": { 1426 } 1427 }, 1428 "ListQueuesRequest": { 1429 "base": null, 1430 "refs": { 1431 } 1432 }, 1433 "ListQueuesResponse": { 1434 "base": null, 1435 "refs": { 1436 } 1437 }, 1438 "ListQuickConnectsRequest": { 1439 "base": null, 1440 "refs": { 1441 } 1442 }, 1443 "ListQuickConnectsResponse": { 1444 "base": null, 1445 "refs": { 1446 } 1447 }, 1448 "ListRoutingProfileQueuesRequest": { 1449 "base": null, 1450 "refs": { 1451 } 1452 }, 1453 "ListRoutingProfileQueuesResponse": { 1454 "base": null, 1455 "refs": { 1456 } 1457 }, 1458 "ListRoutingProfilesRequest": { 1459 "base": null, 1460 "refs": { 1461 } 1462 }, 1463 "ListRoutingProfilesResponse": { 1464 "base": null, 1465 "refs": { 1466 } 1467 }, 1468 "ListSecurityKeysRequest": { 1469 "base": null, 1470 "refs": { 1471 } 1472 }, 1473 "ListSecurityKeysResponse": { 1474 "base": null, 1475 "refs": { 1476 } 1477 }, 1478 "ListSecurityProfilesRequest": { 1479 "base": null, 1480 "refs": { 1481 } 1482 }, 1483 "ListSecurityProfilesResponse": { 1484 "base": null, 1485 "refs": { 1486 } 1487 }, 1488 "ListTagsForResourceRequest": { 1489 "base": null, 1490 "refs": { 1491 } 1492 }, 1493 "ListTagsForResourceResponse": { 1494 "base": null, 1495 "refs": { 1496 } 1497 }, 1498 "ListUseCasesRequest": { 1499 "base": "<p>Provides summary information about the use cases for the specified Amazon Connect AppIntegration association.</p>", 1500 "refs": { 1501 } 1502 }, 1503 "ListUseCasesResponse": { 1504 "base": null, 1505 "refs": { 1506 } 1507 }, 1508 "ListUserHierarchyGroupsRequest": { 1509 "base": null, 1510 "refs": { 1511 } 1512 }, 1513 "ListUserHierarchyGroupsResponse": { 1514 "base": null, 1515 "refs": { 1516 } 1517 }, 1518 "ListUsersRequest": { 1519 "base": null, 1520 "refs": { 1521 } 1522 }, 1523 "ListUsersResponse": { 1524 "base": null, 1525 "refs": { 1526 } 1527 }, 1528 "MaxResult10": { 1529 "base": null, 1530 "refs": { 1531 "ListInstanceStorageConfigsRequest$MaxResults": "<p>The maximimum number of results to return per page.</p>", 1532 "ListInstancesRequest$MaxResults": "<p>The maximimum number of results to return per page.</p>" 1533 } 1534 }, 1535 "MaxResult100": { 1536 "base": null, 1537 "refs": { 1538 "GetCurrentMetricDataRequest$MaxResults": "<p>The maximimum number of results to return per page.</p>", 1539 "GetMetricDataRequest$MaxResults": "<p>The maximimum number of results to return per page.</p>", 1540 "ListIntegrationAssociationsRequest$MaxResults": "<p>The maximimum number of results to return per page.</p>", 1541 "ListRoutingProfileQueuesRequest$MaxResults": "<p>The maximimum number of results to return per page.</p>", 1542 "ListUseCasesRequest$MaxResults": "<p>The maximimum number of results to return per page.</p>" 1543 } 1544 }, 1545 "MaxResult1000": { 1546 "base": null, 1547 "refs": { 1548 "ListContactFlowsRequest$MaxResults": "<p>The maximimum number of results to return per page.</p>", 1549 "ListHoursOfOperationsRequest$MaxResults": "<p>The maximimum number of results to return per page.</p>", 1550 "ListPhoneNumbersRequest$MaxResults": "<p>The maximimum number of results to return per page.</p>", 1551 "ListPromptsRequest$MaxResults": "<p>The maximum number of results to return per page.</p>", 1552 "ListQueuesRequest$MaxResults": "<p>The maximimum number of results to return per page.</p>", 1553 "ListQuickConnectsRequest$MaxResults": "<p>The maximimum number of results to return per page.</p>", 1554 "ListRoutingProfilesRequest$MaxResults": "<p>The maximimum number of results to return per page.</p>", 1555 "ListSecurityProfilesRequest$MaxResults": "<p>The maximimum number of results to return per page.</p>", 1556 "ListUserHierarchyGroupsRequest$MaxResults": "<p>The maximimum number of results to return per page.</p>", 1557 "ListUsersRequest$MaxResults": "<p>The maximimum number of results to return per page.</p>" 1558 } 1559 }, 1560 "MaxResult2": { 1561 "base": null, 1562 "refs": { 1563 "ListSecurityKeysRequest$MaxResults": "<p>The maximimum number of results to return per page.</p>" 1564 } 1565 }, 1566 "MaxResult25": { 1567 "base": null, 1568 "refs": { 1569 "ListApprovedOriginsRequest$MaxResults": "<p>The maximimum number of results to return per page.</p>", 1570 "ListLambdaFunctionsRequest$MaxResults": "<p>The maximimum number of results to return per page.</p>", 1571 "ListLexBotsRequest$MaxResults": "<p>The maximimum number of results to return per page.</p>" 1572 } 1573 }, 1574 "MaxResult7": { 1575 "base": null, 1576 "refs": { 1577 "ListInstanceAttributesRequest$MaxResults": "<p>The maximimum number of results to return per page.</p>" 1578 } 1579 }, 1580 "MediaConcurrencies": { 1581 "base": null, 1582 "refs": { 1583 "CreateRoutingProfileRequest$MediaConcurrencies": "<p>The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.</p>", 1584 "RoutingProfile$MediaConcurrencies": "<p>The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.</p>", 1585 "UpdateRoutingProfileConcurrencyRequest$MediaConcurrencies": "<p>The channels agents can handle in the Contact Control Panel (CCP).</p>" 1586 } 1587 }, 1588 "MediaConcurrency": { 1589 "base": "<p>Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.</p>", 1590 "refs": { 1591 "MediaConcurrencies$member": null 1592 } 1593 }, 1594 "Message": { 1595 "base": null, 1596 "refs": { 1597 "ContactFlowNotPublishedException$Message": null, 1598 "ContactNotFoundException$Message": "<p>The message.</p>", 1599 "DestinationNotAllowedException$Message": "<p>The message.</p>", 1600 "DuplicateResourceException$Message": null, 1601 "InternalServiceException$Message": "<p>The message.</p>", 1602 "InvalidParameterException$Message": "<p>The message.</p>", 1603 "InvalidRequestException$Message": "<p>The message.</p>", 1604 "LimitExceededException$Message": "<p>The message.</p>", 1605 "OutboundContactNotPermittedException$Message": "<p>The message.</p>", 1606 "ResourceConflictException$Message": null, 1607 "ResourceInUseException$Message": null, 1608 "ResourceNotFoundException$Message": "<p>The message.</p>", 1609 "ServiceQuotaExceededException$Message": null, 1610 "ThrottlingException$Message": null, 1611 "UserNotFoundException$Message": null 1612 } 1613 }, 1614 "Name": { 1615 "base": null, 1616 "refs": { 1617 "StartTaskContactRequest$Name": "<p>The name of a task that is shown to an agent in the Contact Control Panel (CCP).</p>" 1618 } 1619 }, 1620 "NextToken": { 1621 "base": null, 1622 "refs": { 1623 "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>", 1624 "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>", 1625 "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>", 1626 "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>", 1627 "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>", 1628 "ListApprovedOriginsResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 1629 "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>", 1630 "ListContactFlowsResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 1631 "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>", 1632 "ListHoursOfOperationsResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 1633 "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>", 1634 "ListInstanceAttributesResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 1635 "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>", 1636 "ListInstanceStorageConfigsResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 1637 "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>", 1638 "ListInstancesResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 1639 "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>", 1640 "ListIntegrationAssociationsResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 1641 "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>", 1642 "ListLambdaFunctionsResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 1643 "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>", 1644 "ListLexBotsResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 1645 "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>", 1646 "ListPhoneNumbersResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 1647 "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>", 1648 "ListPromptsResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 1649 "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>", 1650 "ListQueuesResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 1651 "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>", 1652 "ListQuickConnectsResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 1653 "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>", 1654 "ListRoutingProfileQueuesResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 1655 "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>", 1656 "ListRoutingProfilesResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 1657 "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>", 1658 "ListSecurityKeysResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 1659 "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>", 1660 "ListSecurityProfilesResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 1661 "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>", 1662 "ListUseCasesResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 1663 "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>", 1664 "ListUserHierarchyGroupsResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 1665 "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>", 1666 "ListUsersResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>" 1667 } 1668 }, 1669 "Origin": { 1670 "base": null, 1671 "refs": { 1672 "AssociateApprovedOriginRequest$Origin": "<p>The domain to add to your allow list.</p>", 1673 "DisassociateApprovedOriginRequest$Origin": "<p>The domain URL of the integrated application.</p>", 1674 "OriginsList$member": null 1675 } 1676 }, 1677 "OriginsList": { 1678 "base": null, 1679 "refs": { 1680 "ListApprovedOriginsResponse$Origins": "<p>The approved origins.</p>" 1681 } 1682 }, 1683 "OutboundCallsEnabled": { 1684 "base": null, 1685 "refs": { 1686 "CreateInstanceRequest$OutboundCallsEnabled": "<p>Whether your contact center allows outbound calls.</p>", 1687 "Instance$OutboundCallsEnabled": "<p>Whether outbound calls are enabled.</p>", 1688 "InstanceSummary$OutboundCallsEnabled": "<p>Whether outbound calls are enabled.</p>" 1689 } 1690 }, 1691 "OutboundContactNotPermittedException": { 1692 "base": "<p>The contact is not permitted.</p>", 1693 "refs": { 1694 } 1695 }, 1696 "PEM": { 1697 "base": null, 1698 "refs": { 1699 "AssociateSecurityKeyRequest$Key": "<p>A valid security key in PEM format.</p>", 1700 "SecurityKey$Key": "<p>The key of the security key.</p>" 1701 } 1702 }, 1703 "ParticipantDetails": { 1704 "base": "<p>The customer's details.</p>", 1705 "refs": { 1706 "StartChatContactRequest$ParticipantDetails": "<p>Information identifying the participant.</p>" 1707 } 1708 }, 1709 "ParticipantId": { 1710 "base": null, 1711 "refs": { 1712 "StartChatContactResponse$ParticipantId": "<p>The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.</p>" 1713 } 1714 }, 1715 "ParticipantToken": { 1716 "base": null, 1717 "refs": { 1718 "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>" 1719 } 1720 }, 1721 "Password": { 1722 "base": null, 1723 "refs": { 1724 "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>" 1725 } 1726 }, 1727 "PhoneNumber": { 1728 "base": null, 1729 "refs": { 1730 "PhoneNumberQuickConnectConfig$PhoneNumber": "<p>The phone number in E.164 format.</p>", 1731 "PhoneNumberSummary$PhoneNumber": "<p>The phone number.</p>", 1732 "StartOutboundVoiceContactRequest$DestinationPhoneNumber": "<p>The phone number of the customer, in E.164 format.</p>", 1733 "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>", 1734 "UserPhoneConfig$DeskPhoneNumber": "<p>The phone number for the user's desk phone.</p>" 1735 } 1736 }, 1737 "PhoneNumberCountryCode": { 1738 "base": null, 1739 "refs": { 1740 "PhoneNumberCountryCodes$member": null, 1741 "PhoneNumberSummary$PhoneNumberCountryCode": "<p>The ISO country code.</p>" 1742 } 1743 }, 1744 "PhoneNumberCountryCodes": { 1745 "base": null, 1746 "refs": { 1747 "ListPhoneNumbersRequest$PhoneNumberCountryCodes": "<p>The ISO country code.</p>" 1748 } 1749 }, 1750 "PhoneNumberId": { 1751 "base": null, 1752 "refs": { 1753 "PhoneNumberSummary$Id": "<p>The identifier of the phone number.</p>" 1754 } 1755 }, 1756 "PhoneNumberQuickConnectConfig": { 1757 "base": "<p>Contains information about a phone number for a quick connect.</p>", 1758 "refs": { 1759 "QuickConnectConfig$PhoneConfig": "<p>The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.</p>" 1760 } 1761 }, 1762 "PhoneNumberSummary": { 1763 "base": "<p>Contains summary information about a phone number for a contact center.</p>", 1764 "refs": { 1765 "PhoneNumberSummaryList$member": null 1766 } 1767 }, 1768 "PhoneNumberSummaryList": { 1769 "base": null, 1770 "refs": { 1771 "ListPhoneNumbersResponse$PhoneNumberSummaryList": "<p>Information about the phone numbers.</p>" 1772 } 1773 }, 1774 "PhoneNumberType": { 1775 "base": null, 1776 "refs": { 1777 "PhoneNumberSummary$PhoneNumberType": "<p>The type of phone number.</p>", 1778 "PhoneNumberTypes$member": null 1779 } 1780 }, 1781 "PhoneNumberTypes": { 1782 "base": null, 1783 "refs": { 1784 "ListPhoneNumbersRequest$PhoneNumberTypes": "<p>The type of phone number.</p>" 1785 } 1786 }, 1787 "PhoneType": { 1788 "base": null, 1789 "refs": { 1790 "UserPhoneConfig$PhoneType": "<p>The phone type.</p>" 1791 } 1792 }, 1793 "Prefix": { 1794 "base": null, 1795 "refs": { 1796 "KinesisVideoStreamConfig$Prefix": "<p>The prefix of the video stream.</p>", 1797 "S3Config$BucketPrefix": "<p>The S3 bucket prefix.</p>" 1798 } 1799 }, 1800 "Priority": { 1801 "base": null, 1802 "refs": { 1803 "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>", 1804 "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>" 1805 } 1806 }, 1807 "ProblemDetail": { 1808 "base": "<p>Information about a problem detail.</p>", 1809 "refs": { 1810 "Problems$member": null 1811 } 1812 }, 1813 "ProblemMessageString": { 1814 "base": null, 1815 "refs": { 1816 "ProblemDetail$message": "<p>The problem detail's message.</p>" 1817 } 1818 }, 1819 "Problems": { 1820 "base": null, 1821 "refs": { 1822 "InvalidContactFlowException$problems": "<p>The problems with the contact flow. Please fix before trying again.</p>" 1823 } 1824 }, 1825 "PromptId": { 1826 "base": null, 1827 "refs": { 1828 "PromptSummary$Id": "<p>The identifier of the prompt.</p>" 1829 } 1830 }, 1831 "PromptName": { 1832 "base": null, 1833 "refs": { 1834 "PromptSummary$Name": "<p>The name of the prompt.</p>" 1835 } 1836 }, 1837 "PromptSummary": { 1838 "base": "<p>Contains information about the prompt.</p>", 1839 "refs": { 1840 "PromptSummaryList$member": null 1841 } 1842 }, 1843 "PromptSummaryList": { 1844 "base": null, 1845 "refs": { 1846 "ListPromptsResponse$PromptSummaryList": "<p>Information about the prompts.</p>" 1847 } 1848 }, 1849 "QueueId": { 1850 "base": null, 1851 "refs": { 1852 "CreateRoutingProfileRequest$DefaultOutboundQueueId": "<p>The default outbound queue for the routing profile.</p>", 1853 "QueueQuickConnectConfig$QueueId": "<p>The identifier of the queue.</p>", 1854 "QueueReference$Id": "<p>The identifier of the queue.</p>", 1855 "QueueSummary$Id": "<p>The identifier of the queue.</p>", 1856 "Queues$member": null, 1857 "RoutingProfile$DefaultOutboundQueueId": "<p>The identifier of the default outbound queue for this routing profile.</p>", 1858 "RoutingProfileQueueConfigSummary$QueueId": "<p>The identifier of the queue.</p>", 1859 "RoutingProfileQueueReference$QueueId": "<p>The identifier of the queue.</p>", 1860 "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>", 1861 "UpdateRoutingProfileDefaultOutboundQueueRequest$DefaultOutboundQueueId": "<p>The identifier for the default outbound queue.</p>" 1862 } 1863 }, 1864 "QueueName": { 1865 "base": null, 1866 "refs": { 1867 "QueueSummary$Name": "<p>The name of the queue.</p>", 1868 "RoutingProfileQueueConfigSummary$QueueName": "<p>The name of the queue.</p>" 1869 } 1870 }, 1871 "QueueQuickConnectConfig": { 1872 "base": "<p>Contains information about a queue for a quick connect. The contact flow must be of type Transfer to Queue.</p>", 1873 "refs": { 1874 "QuickConnectConfig$QueueConfig": "<p>The queue configuration. This is required only if QuickConnectType is QUEUE.</p>" 1875 } 1876 }, 1877 "QueueReference": { 1878 "base": "<p>Contains information about a queue resource for which metrics are returned.</p>", 1879 "refs": { 1880 "Dimensions$Queue": "<p>Information about the queue for which metrics are returned.</p>" 1881 } 1882 }, 1883 "QueueSummary": { 1884 "base": "<p>Contains summary information about a queue.</p>", 1885 "refs": { 1886 "QueueSummaryList$member": null 1887 } 1888 }, 1889 "QueueSummaryList": { 1890 "base": null, 1891 "refs": { 1892 "ListQueuesResponse$QueueSummaryList": "<p>Information about the queues.</p>" 1893 } 1894 }, 1895 "QueueType": { 1896 "base": null, 1897 "refs": { 1898 "QueueSummary$QueueType": "<p>The type of queue.</p>", 1899 "QueueTypes$member": null 1900 } 1901 }, 1902 "QueueTypes": { 1903 "base": null, 1904 "refs": { 1905 "ListQueuesRequest$QueueTypes": "<p>The type of queue.</p>" 1906 } 1907 }, 1908 "Queues": { 1909 "base": null, 1910 "refs": { 1911 "Filters$Queues": "<p>The queues to use to filter the metrics. You can specify up to 100 queues per request.</p>" 1912 } 1913 }, 1914 "QuickConnect": { 1915 "base": "<p>Contains information about a quick connect.</p>", 1916 "refs": { 1917 "DescribeQuickConnectResponse$QuickConnect": "<p>Information about the quick connect.</p>" 1918 } 1919 }, 1920 "QuickConnectConfig": { 1921 "base": "<p>Contains configuration settings for a quick connect.</p>", 1922 "refs": { 1923 "CreateQuickConnectRequest$QuickConnectConfig": "<p>Configuration settings for the quick connect.</p>", 1924 "QuickConnect$QuickConnectConfig": "<p>Contains information about the quick connect.</p>", 1925 "UpdateQuickConnectConfigRequest$QuickConnectConfig": "<p>Information about the configuration settings for the quick connect.</p>" 1926 } 1927 }, 1928 "QuickConnectDescription": { 1929 "base": null, 1930 "refs": { 1931 "CreateQuickConnectRequest$Description": "<p>The description of the quick connect.</p>", 1932 "QuickConnect$Description": "<p>The description.</p>", 1933 "UpdateQuickConnectNameRequest$Description": "<p>The description of the quick connect.</p>" 1934 } 1935 }, 1936 "QuickConnectId": { 1937 "base": null, 1938 "refs": { 1939 "CreateQuickConnectResponse$QuickConnectId": "<p>The identifier for the quick connect.</p>", 1940 "DeleteQuickConnectRequest$QuickConnectId": "<p>The identifier for the quick connect.</p>", 1941 "DescribeQuickConnectRequest$QuickConnectId": "<p>The identifier for the quick connect.</p>", 1942 "QuickConnect$QuickConnectId": "<p>The identifier for the quick connect.</p>", 1943 "QuickConnectSummary$Id": "<p>The identifier for the quick connect.</p>", 1944 "UpdateQuickConnectConfigRequest$QuickConnectId": "<p>The identifier for the quick connect.</p>", 1945 "UpdateQuickConnectNameRequest$QuickConnectId": "<p>The identifier for the quick connect.</p>" 1946 } 1947 }, 1948 "QuickConnectName": { 1949 "base": null, 1950 "refs": { 1951 "CreateQuickConnectRequest$Name": "<p>The name of the quick connect.</p>", 1952 "QuickConnect$Name": "<p>The name of the quick connect.</p>", 1953 "QuickConnectSummary$Name": "<p>The name.</p>", 1954 "UpdateQuickConnectNameRequest$Name": "<p>The name of the quick connect.</p>" 1955 } 1956 }, 1957 "QuickConnectSummary": { 1958 "base": "<p>Contains summary information about a quick connect.</p>", 1959 "refs": { 1960 "QuickConnectSummaryList$member": null 1961 } 1962 }, 1963 "QuickConnectSummaryList": { 1964 "base": null, 1965 "refs": { 1966 "ListQuickConnectsResponse$QuickConnectSummaryList": "<p>Information about the quick connects.</p>" 1967 } 1968 }, 1969 "QuickConnectType": { 1970 "base": null, 1971 "refs": { 1972 "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>", 1973 "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>", 1974 "QuickConnectTypes$member": null 1975 } 1976 }, 1977 "QuickConnectTypes": { 1978 "base": null, 1979 "refs": { 1980 "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>" 1981 } 1982 }, 1983 "Reference": { 1984 "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>", 1985 "refs": { 1986 "ContactReferences$value": null 1987 } 1988 }, 1989 "ReferenceKey": { 1990 "base": null, 1991 "refs": { 1992 "ContactReferences$key": null 1993 } 1994 }, 1995 "ReferenceType": { 1996 "base": null, 1997 "refs": { 1998 "Reference$Type": "<p>A valid URL.</p>" 1999 } 2000 }, 2001 "ReferenceValue": { 2002 "base": null, 2003 "refs": { 2004 "Reference$Value": "<p>A formatted URL that will be shown to an agent in the Contact Control Panel (CCP)</p>" 2005 } 2006 }, 2007 "ResourceConflictException": { 2008 "base": "<p>A resource already has that name.</p>", 2009 "refs": { 2010 } 2011 }, 2012 "ResourceInUseException": { 2013 "base": "<p>That resource is already in use. Please try another.</p>", 2014 "refs": { 2015 } 2016 }, 2017 "ResourceNotFoundException": { 2018 "base": "<p>The specified resource was not found.</p>", 2019 "refs": { 2020 } 2021 }, 2022 "ResourceType": { 2023 "base": null, 2024 "refs": { 2025 "ResourceInUseException$ResourceType": "<p>The type of resource.</p>" 2026 } 2027 }, 2028 "ResumeContactRecordingRequest": { 2029 "base": null, 2030 "refs": { 2031 } 2032 }, 2033 "ResumeContactRecordingResponse": { 2034 "base": null, 2035 "refs": { 2036 } 2037 }, 2038 "RoutingProfile": { 2039 "base": "<p>Contains information about a routing profile.</p>", 2040 "refs": { 2041 "DescribeRoutingProfileResponse$RoutingProfile": "<p>The routing profile.</p>" 2042 } 2043 }, 2044 "RoutingProfileDescription": { 2045 "base": null, 2046 "refs": { 2047 "CreateRoutingProfileRequest$Description": "<p>Description of the routing profile. Must not be more than 250 characters.</p>", 2048 "RoutingProfile$Description": "<p>The description of the routing profile.</p>", 2049 "UpdateRoutingProfileNameRequest$Description": "<p>The description of the routing profile. Must not be more than 250 characters.</p>" 2050 } 2051 }, 2052 "RoutingProfileId": { 2053 "base": null, 2054 "refs": { 2055 "AssociateRoutingProfileQueuesRequest$RoutingProfileId": "<p>The identifier of the routing profile.</p>", 2056 "CreateRoutingProfileResponse$RoutingProfileId": "<p>The identifier of the routing profile.</p>", 2057 "CreateUserRequest$RoutingProfileId": "<p>The identifier of the routing profile for the user.</p>", 2058 "DescribeRoutingProfileRequest$RoutingProfileId": "<p>The identifier of the routing profile.</p>", 2059 "DisassociateRoutingProfileQueuesRequest$RoutingProfileId": "<p>The identifier of the routing profile.</p>", 2060 "ListRoutingProfileQueuesRequest$RoutingProfileId": "<p>The identifier of the routing profile.</p>", 2061 "RoutingProfile$RoutingProfileId": "<p>The identifier of the routing profile.</p>", 2062 "RoutingProfileSummary$Id": "<p>The identifier of the routing profile.</p>", 2063 "UpdateRoutingProfileConcurrencyRequest$RoutingProfileId": "<p>The identifier of the routing profile.</p>", 2064 "UpdateRoutingProfileDefaultOutboundQueueRequest$RoutingProfileId": "<p>The identifier of the routing profile.</p>", 2065 "UpdateRoutingProfileNameRequest$RoutingProfileId": "<p>The identifier of the routing profile.</p>", 2066 "UpdateRoutingProfileQueuesRequest$RoutingProfileId": "<p>The identifier of the routing profile.</p>", 2067 "UpdateUserRoutingProfileRequest$RoutingProfileId": "<p>The identifier of the routing profile for the user.</p>", 2068 "User$RoutingProfileId": "<p>The identifier of the routing profile for the user.</p>" 2069 } 2070 }, 2071 "RoutingProfileName": { 2072 "base": null, 2073 "refs": { 2074 "CreateRoutingProfileRequest$Name": "<p>The name of the routing profile. Must not be more than 127 characters.</p>", 2075 "RoutingProfile$Name": "<p>The name of the routing profile.</p>", 2076 "RoutingProfileSummary$Name": "<p>The name of the routing profile.</p>", 2077 "UpdateRoutingProfileNameRequest$Name": "<p>The name of the routing profile. Must not be more than 127 characters.</p>" 2078 } 2079 }, 2080 "RoutingProfileQueueConfig": { 2081 "base": "<p>Contains information about the queue and channel for which priority and delay can be set.</p>", 2082 "refs": { 2083 "RoutingProfileQueueConfigList$member": null 2084 } 2085 }, 2086 "RoutingProfileQueueConfigList": { 2087 "base": null, 2088 "refs": { 2089 "AssociateRoutingProfileQueuesRequest$QueueConfigs": "<p>The queues to associate with this routing profile.</p>", 2090 "CreateRoutingProfileRequest$QueueConfigs": "<p>The inbound queues associated with the routing profile. If no queue is added, the agent can only make outbound calls.</p>", 2091 "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>" 2092 } 2093 }, 2094 "RoutingProfileQueueConfigSummary": { 2095 "base": "<p>Contains summary information about a routing profile queue.</p>", 2096 "refs": { 2097 "RoutingProfileQueueConfigSummaryList$member": null 2098 } 2099 }, 2100 "RoutingProfileQueueConfigSummaryList": { 2101 "base": null, 2102 "refs": { 2103 "ListRoutingProfileQueuesResponse$RoutingProfileQueueConfigSummaryList": "<p>Information about the routing profiles.</p>" 2104 } 2105 }, 2106 "RoutingProfileQueueReference": { 2107 "base": "<p>Contains the channel and queue identifier for a routing profile.</p>", 2108 "refs": { 2109 "RoutingProfileQueueConfig$QueueReference": "<p>Contains information about a queue resource.</p>", 2110 "RoutingProfileQueueReferenceList$member": null 2111 } 2112 }, 2113 "RoutingProfileQueueReferenceList": { 2114 "base": null, 2115 "refs": { 2116 "DisassociateRoutingProfileQueuesRequest$QueueReferences": "<p>The queues to disassociate from this routing profile.</p>" 2117 } 2118 }, 2119 "RoutingProfileSummary": { 2120 "base": "<p>Contains summary information about a routing profile.</p>", 2121 "refs": { 2122 "RoutingProfileSummaryList$member": null 2123 } 2124 }, 2125 "RoutingProfileSummaryList": { 2126 "base": null, 2127 "refs": { 2128 "ListRoutingProfilesResponse$RoutingProfileSummaryList": "<p>Information about the routing profiles.</p>" 2129 } 2130 }, 2131 "S3Config": { 2132 "base": "<p>Information about the S3 storage type.</p>", 2133 "refs": { 2134 "InstanceStorageConfig$S3Config": "<p>The S3 configuration.</p>" 2135 } 2136 }, 2137 "SecurityKey": { 2138 "base": "<p>Configuration information of the security key.</p>", 2139 "refs": { 2140 "SecurityKeysList$member": null 2141 } 2142 }, 2143 "SecurityKeysList": { 2144 "base": null, 2145 "refs": { 2146 "ListSecurityKeysResponse$SecurityKeys": "<p>The security keys.</p>" 2147 } 2148 }, 2149 "SecurityProfileId": { 2150 "base": null, 2151 "refs": { 2152 "SecurityProfileIds$member": null, 2153 "SecurityProfileSummary$Id": "<p>The identifier of the security profile.</p>" 2154 } 2155 }, 2156 "SecurityProfileIds": { 2157 "base": null, 2158 "refs": { 2159 "CreateUserRequest$SecurityProfileIds": "<p>The identifier of the security profile for the user.</p>", 2160 "UpdateUserSecurityProfilesRequest$SecurityProfileIds": "<p>The identifiers of the security profiles for the user.</p>", 2161 "User$SecurityProfileIds": "<p>The identifiers of the security profiles for the user.</p>" 2162 } 2163 }, 2164 "SecurityProfileName": { 2165 "base": null, 2166 "refs": { 2167 "SecurityProfileSummary$Name": "<p>The name of the security profile.</p>" 2168 } 2169 }, 2170 "SecurityProfileSummary": { 2171 "base": "<p>Contains information about a security profile.</p>", 2172 "refs": { 2173 "SecurityProfileSummaryList$member": null 2174 } 2175 }, 2176 "SecurityProfileSummaryList": { 2177 "base": null, 2178 "refs": { 2179 "ListSecurityProfilesResponse$SecurityProfileSummaryList": "<p>Information about the security profiles.</p>" 2180 } 2181 }, 2182 "SecurityToken": { 2183 "base": null, 2184 "refs": { 2185 "Credentials$AccessToken": "<p>An access token generated for a federated user to access Amazon Connect.</p>", 2186 "Credentials$RefreshToken": "<p>Renews a token generated for a user to access the Amazon Connect instance.</p>" 2187 } 2188 }, 2189 "ServiceQuotaExceededException": { 2190 "base": "<p>The service quota has been exceeded.</p>", 2191 "refs": { 2192 } 2193 }, 2194 "SourceApplicationName": { 2195 "base": null, 2196 "refs": { 2197 "CreateIntegrationAssociationRequest$SourceApplicationName": "<p>The name of the external application.</p>", 2198 "IntegrationAssociationSummary$SourceApplicationName": "<p>The user-provided, friendly name for the external application.</p>" 2199 } 2200 }, 2201 "SourceType": { 2202 "base": null, 2203 "refs": { 2204 "CreateIntegrationAssociationRequest$SourceType": "<p>The type of the data source.</p>", 2205 "IntegrationAssociationSummary$SourceType": "<p>The name of the source.</p>" 2206 } 2207 }, 2208 "StartChatContactRequest": { 2209 "base": null, 2210 "refs": { 2211 } 2212 }, 2213 "StartChatContactResponse": { 2214 "base": null, 2215 "refs": { 2216 } 2217 }, 2218 "StartContactRecordingRequest": { 2219 "base": null, 2220 "refs": { 2221 } 2222 }, 2223 "StartContactRecordingResponse": { 2224 "base": null, 2225 "refs": { 2226 } 2227 }, 2228 "StartOutboundVoiceContactRequest": { 2229 "base": null, 2230 "refs": { 2231 } 2232 }, 2233 "StartOutboundVoiceContactResponse": { 2234 "base": null, 2235 "refs": { 2236 } 2237 }, 2238 "StartTaskContactRequest": { 2239 "base": null, 2240 "refs": { 2241 } 2242 }, 2243 "StartTaskContactResponse": { 2244 "base": null, 2245 "refs": { 2246 } 2247 }, 2248 "Statistic": { 2249 "base": null, 2250 "refs": { 2251 "HistoricalMetric$Statistic": "<p>The statistic for the metric.</p>" 2252 } 2253 }, 2254 "StopContactRecordingRequest": { 2255 "base": null, 2256 "refs": { 2257 } 2258 }, 2259 "StopContactRecordingResponse": { 2260 "base": null, 2261 "refs": { 2262 } 2263 }, 2264 "StopContactRequest": { 2265 "base": null, 2266 "refs": { 2267 } 2268 }, 2269 "StopContactResponse": { 2270 "base": null, 2271 "refs": { 2272 } 2273 }, 2274 "StorageType": { 2275 "base": null, 2276 "refs": { 2277 "InstanceStorageConfig$StorageType": "<p>A valid storage type.</p>" 2278 } 2279 }, 2280 "String": { 2281 "base": null, 2282 "refs": { 2283 "InstanceStatusReason$Message": "<p>The message.</p>" 2284 } 2285 }, 2286 "SuspendContactRecordingRequest": { 2287 "base": null, 2288 "refs": { 2289 } 2290 }, 2291 "SuspendContactRecordingResponse": { 2292 "base": null, 2293 "refs": { 2294 } 2295 }, 2296 "TagKey": { 2297 "base": null, 2298 "refs": { 2299 "TagKeyList$member": null, 2300 "TagMap$key": null 2301 } 2302 }, 2303 "TagKeyList": { 2304 "base": null, 2305 "refs": { 2306 "UntagResourceRequest$tagKeys": "<p>The tag keys.</p>" 2307 } 2308 }, 2309 "TagMap": { 2310 "base": null, 2311 "refs": { 2312 "ContactFlow$Tags": "<p>One or more tags.</p>", 2313 "CreateContactFlowRequest$Tags": "<p>One or more tags.</p>", 2314 "CreateQuickConnectRequest$Tags": "<p>One or more tags.</p>", 2315 "CreateRoutingProfileRequest$Tags": "<p>One or more tags.</p>", 2316 "CreateUserRequest$Tags": "<p>One or more tags.</p>", 2317 "ListTagsForResourceResponse$tags": "<p>Information about the tags.</p>", 2318 "QuickConnect$Tags": "<p>One or more tags.</p>", 2319 "RoutingProfile$Tags": "<p>One or more tags.</p>", 2320 "TagResourceRequest$tags": "<p>One or more tags. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>", 2321 "User$Tags": "<p>The tags.</p>" 2322 } 2323 }, 2324 "TagResourceRequest": { 2325 "base": null, 2326 "refs": { 2327 } 2328 }, 2329 "TagValue": { 2330 "base": null, 2331 "refs": { 2332 "TagMap$value": null 2333 } 2334 }, 2335 "Threshold": { 2336 "base": "<p>Contains information about the threshold for service level metrics.</p>", 2337 "refs": { 2338 "HistoricalMetric$Threshold": "<p>The threshold for the metric, used with service level metrics.</p>" 2339 } 2340 }, 2341 "ThresholdValue": { 2342 "base": null, 2343 "refs": { 2344 "Threshold$ThresholdValue": "<p>The threshold value to compare.</p>" 2345 } 2346 }, 2347 "ThrottlingException": { 2348 "base": "<p>The throttling limit has been exceeded.</p>", 2349 "refs": { 2350 } 2351 }, 2352 "Timestamp": { 2353 "base": null, 2354 "refs": { 2355 "Instance$CreatedTime": "<p>When the instance was created.</p>", 2356 "InstanceSummary$CreatedTime": "<p>When the instance was created.</p>" 2357 } 2358 }, 2359 "URI": { 2360 "base": null, 2361 "refs": { 2362 "CreateIntegrationAssociationRequest$SourceApplicationUrl": "<p>The URL for the external application.</p>", 2363 "IntegrationAssociationSummary$SourceApplicationUrl": "<p>The URL for the external application.</p>" 2364 } 2365 }, 2366 "Unit": { 2367 "base": null, 2368 "refs": { 2369 "CurrentMetric$Unit": "<p>The unit for the metric.</p>", 2370 "HistoricalMetric$Unit": "<p>The unit for the metric.</p>" 2371 } 2372 }, 2373 "UntagResourceRequest": { 2374 "base": null, 2375 "refs": { 2376 } 2377 }, 2378 "UpdateContactAttributesRequest": { 2379 "base": null, 2380 "refs": { 2381 } 2382 }, 2383 "UpdateContactAttributesResponse": { 2384 "base": null, 2385 "refs": { 2386 } 2387 }, 2388 "UpdateContactFlowContentRequest": { 2389 "base": null, 2390 "refs": { 2391 } 2392 }, 2393 "UpdateContactFlowNameRequest": { 2394 "base": null, 2395 "refs": { 2396 } 2397 }, 2398 "UpdateInstanceAttributeRequest": { 2399 "base": null, 2400 "refs": { 2401 } 2402 }, 2403 "UpdateInstanceStorageConfigRequest": { 2404 "base": null, 2405 "refs": { 2406 } 2407 }, 2408 "UpdateQuickConnectConfigRequest": { 2409 "base": null, 2410 "refs": { 2411 } 2412 }, 2413 "UpdateQuickConnectNameRequest": { 2414 "base": null, 2415 "refs": { 2416 } 2417 }, 2418 "UpdateRoutingProfileConcurrencyRequest": { 2419 "base": null, 2420 "refs": { 2421 } 2422 }, 2423 "UpdateRoutingProfileDefaultOutboundQueueRequest": { 2424 "base": null, 2425 "refs": { 2426 } 2427 }, 2428 "UpdateRoutingProfileNameRequest": { 2429 "base": null, 2430 "refs": { 2431 } 2432 }, 2433 "UpdateRoutingProfileQueuesRequest": { 2434 "base": null, 2435 "refs": { 2436 } 2437 }, 2438 "UpdateUserHierarchyGroupNameRequest": { 2439 "base": null, 2440 "refs": { 2441 } 2442 }, 2443 "UpdateUserHierarchyRequest": { 2444 "base": null, 2445 "refs": { 2446 } 2447 }, 2448 "UpdateUserHierarchyStructureRequest": { 2449 "base": null, 2450 "refs": { 2451 } 2452 }, 2453 "UpdateUserIdentityInfoRequest": { 2454 "base": null, 2455 "refs": { 2456 } 2457 }, 2458 "UpdateUserPhoneConfigRequest": { 2459 "base": null, 2460 "refs": { 2461 } 2462 }, 2463 "UpdateUserRoutingProfileRequest": { 2464 "base": null, 2465 "refs": { 2466 } 2467 }, 2468 "UpdateUserSecurityProfilesRequest": { 2469 "base": null, 2470 "refs": { 2471 } 2472 }, 2473 "UseCase": { 2474 "base": "<p>Contains the use case.</p>", 2475 "refs": { 2476 "UseCaseSummaryList$member": null 2477 } 2478 }, 2479 "UseCaseId": { 2480 "base": null, 2481 "refs": { 2482 "CreateUseCaseResponse$UseCaseId": "<p>The identifier of the use case.</p>", 2483 "DeleteUseCaseRequest$UseCaseId": "<p>The identifier for the use case.</p>", 2484 "UseCase$UseCaseId": "<p>The identifier for the use case.</p>" 2485 } 2486 }, 2487 "UseCaseSummaryList": { 2488 "base": null, 2489 "refs": { 2490 "ListUseCasesResponse$UseCaseSummaryList": "<p>The use cases.</p>" 2491 } 2492 }, 2493 "UseCaseType": { 2494 "base": null, 2495 "refs": { 2496 "CreateUseCaseRequest$UseCaseType": "<p>The type of use case to associate to the AppIntegration association. Each AppIntegration association can have only one of each use case type.</p>", 2497 "UseCase$UseCaseType": "<p>The type of use case to associate to the AppIntegration association. Each AppIntegration association can have only one of each use case type.</p>" 2498 } 2499 }, 2500 "User": { 2501 "base": "<p>Contains information about a user account for a Amazon Connect instance.</p>", 2502 "refs": { 2503 "DescribeUserResponse$User": "<p>Information about the user account and configuration settings.</p>" 2504 } 2505 }, 2506 "UserId": { 2507 "base": null, 2508 "refs": { 2509 "CreateUserResponse$UserId": "<p>The identifier of the user account.</p>", 2510 "DeleteUserRequest$UserId": "<p>The identifier of the user.</p>", 2511 "DescribeUserRequest$UserId": "<p>The identifier of the user account.</p>", 2512 "UpdateUserHierarchyRequest$UserId": "<p>The identifier of the user account.</p>", 2513 "UpdateUserIdentityInfoRequest$UserId": "<p>The identifier of the user account.</p>", 2514 "UpdateUserPhoneConfigRequest$UserId": "<p>The identifier of the user account.</p>", 2515 "UpdateUserRoutingProfileRequest$UserId": "<p>The identifier of the user account.</p>", 2516 "UpdateUserSecurityProfilesRequest$UserId": "<p>The identifier of the user account.</p>", 2517 "User$Id": "<p>The identifier of the user account.</p>", 2518 "UserQuickConnectConfig$UserId": "<p>The identifier of the user.</p>", 2519 "UserSummary$Id": "<p>The identifier of the user account.</p>" 2520 } 2521 }, 2522 "UserIdentityInfo": { 2523 "base": "<p>Contains information about the identity of a user.</p>", 2524 "refs": { 2525 "CreateUserRequest$IdentityInfo": "<p>The information about the identity of the user.</p>", 2526 "UpdateUserIdentityInfoRequest$IdentityInfo": "<p>The identity information for the user.</p>", 2527 "User$IdentityInfo": "<p>Information about the user identity.</p>" 2528 } 2529 }, 2530 "UserNotFoundException": { 2531 "base": "<p>No user with the specified credentials was found in the Amazon Connect instance.</p>", 2532 "refs": { 2533 } 2534 }, 2535 "UserPhoneConfig": { 2536 "base": "<p>Contains information about the phone configuration settings for a user.</p>", 2537 "refs": { 2538 "CreateUserRequest$PhoneConfig": "<p>The phone settings for the user.</p>", 2539 "UpdateUserPhoneConfigRequest$PhoneConfig": "<p>Information about phone configuration settings for the user.</p>", 2540 "User$PhoneConfig": "<p>Information about the phone configuration for the user.</p>" 2541 } 2542 }, 2543 "UserQuickConnectConfig": { 2544 "base": "<p>Contains information about the quick connect configuration settings for a user. The contact flow must be of type Transfer to Agent.</p>", 2545 "refs": { 2546 "QuickConnectConfig$UserConfig": "<p>The user configuration. This is required only if QuickConnectType is USER.</p>" 2547 } 2548 }, 2549 "UserSummary": { 2550 "base": "<p>Contains summary information about a user.</p>", 2551 "refs": { 2552 "UserSummaryList$member": null 2553 } 2554 }, 2555 "UserSummaryList": { 2556 "base": null, 2557 "refs": { 2558 "ListUsersResponse$UserSummaryList": "<p>Information about the users.</p>" 2559 } 2560 }, 2561 "Value": { 2562 "base": null, 2563 "refs": { 2564 "CurrentMetricData$Value": "<p>The value of the metric.</p>", 2565 "HistoricalMetricData$Value": "<p>The value of the metric.</p>" 2566 } 2567 }, 2568 "VoiceRecordingConfiguration": { 2569 "base": "<p>Contains information about the recording configuration settings.</p>", 2570 "refs": { 2571 "StartContactRecordingRequest$VoiceRecordingConfiguration": "<p>Who is being recorded.</p>" 2572 } 2573 }, 2574 "VoiceRecordingTrack": { 2575 "base": null, 2576 "refs": { 2577 "VoiceRecordingConfiguration$VoiceRecordingTrack": "<p>Identifies which track is being recorded.</p>" 2578 } 2579 }, 2580 "timestamp": { 2581 "base": null, 2582 "refs": { 2583 "Credentials$AccessTokenExpiration": "<p>A token generated with an expiration time for the session a user is logged in to Amazon Connect.</p>", 2584 "Credentials$RefreshTokenExpiration": "<p>Renews the expiration timer for a generated token.</p>", 2585 "GetCurrentMetricDataResponse$DataSnapshotTime": "<p>The time at which the metrics were retrieved and cached for pagination.</p>", 2586 "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>", 2587 "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>", 2588 "SecurityKey$CreationTime": "<p>When the security key was created.</p>" 2589 } 2590 } 2591 } 2592} 2593