Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center and provide reliable customer engagement at any scale.
Amazon Connect provides metrics and real-time reporting that enable you to optimize contact routing. You can also resolve customer issues more efficiently by getting customers in touch with the appropriate agents.
There are limits to the number of Amazon Connect resources that you can create. There are also limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
You can use an endpoint to connect programmatically to an Amazon Web Services service. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
", "operations": { "ActivateEvaluationForm": "Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form.
", "AssociateAnalyticsDataSet": "Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.
", "AssociateApprovedOrigin": "This API is in preview release for Amazon Connect and is subject to change.
Associates an approved origin to an Amazon Connect instance.
", "AssociateBot": "This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.
", "AssociateDefaultVocabulary": "Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.
", "AssociateFlow": "Associates a connect resource to a flow.
", "AssociateInstanceStorageConfig": "This API is in preview release for Amazon Connect and is subject to change.
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.
This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.
", "AssociateLambdaFunction": "This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Lambda function.
", "AssociateLexBot": "This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots.
", "AssociatePhoneNumberContactFlow": "Associates a flow with a phone number claimed to your Amazon Connect instance.
If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.
Associates a set of quick connects with a queue.
", "AssociateRoutingProfileQueues": "Associates a set of queues with a routing profile.
", "AssociateSecurityKey": "This API is in preview release for Amazon Connect and is subject to change.
Associates a security key to the instance.
", "AssociateTrafficDistributionGroupUser": "Associates an agent with a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
", "AssociateUserProficiencies": "Associates a set of proficiencies with a user.
", "BatchAssociateAnalyticsDataSet": "Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.
", "BatchDisassociateAnalyticsDataSet": "Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
", "BatchGetAttachedFileMetadata": "Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.
", "BatchGetFlowAssociation": "Retrieve the flow associations for the given resources.
", "BatchPutContact": "Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.
Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.
", "ClaimPhoneNumber": "Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.
For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.
You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.
If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
", "CompleteAttachedFileUpload": "Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
", "CreateAgentStatus": "Creates an agent status for the specified Amazon Connect instance.
", "CreateContact": "Only the VOICE, EMAIL, and TASK channels are supported.
For VOICE: The supported initiation method is TRANSFER. The contacts created with this initiation method have a subtype connect:ExternalAudio.
For EMAIL: The supported initiation methods are OUTBOUND, AGENT_REPLY, and FLOW.
For TASK: The supported initiation method is API. Contacts created with this API have a sub-type of connect:ExternalTask.
Creates a new VOICE, EMAIL, or TASK contact.
After a contact is created, you can move it to the desired state by using the InitiateAs parameter. While you can use API to create task contacts that are in the COMPLETED state, you must contact Amazon Web Services Support before using it for bulk import use cases. Bulk import causes your requests to be throttled or fail if your CreateContact limits aren't high enough.
Creates a flow for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
", "CreateContactFlowModule": "Creates a flow module for the specified Amazon Connect instance.
", "CreateContactFlowVersion": "Publishes a new version of the flow provided. Versions are immutable and monotonically increasing. If the FlowContentSha256 provided is different from the FlowContentSha256 of the $LATEST published flow content, then an error is returned. This API only supports creating versions for flows of type Campaign.
Create new email address in the specified Amazon Connect instance. For more information about email addresses, see Create email addresses in the Amazon Connect Administrator Guide.
", "CreateEvaluationForm": "Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.
", "CreateHoursOfOperation": "Creates hours of operation.
", "CreateHoursOfOperationOverride": "Creates an hours of operation override in an Amazon Connect hours of operation resource.
", "CreateInstance": "This API is in preview release for Amazon Connect and is subject to change.
Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.
For more information, see Create an Amazon Connect instance in the Amazon Connect Administrator Guide.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
", "CreateIntegrationAssociation": "Creates an Amazon Web Services resource association with an Amazon Connect instance.
", "CreateParticipant": "Adds a new participant into an on-going chat contact or webRTC call. For more information, see Customize chat flow experiences by integrating custom participants or Enable multi-user web, in-app, and video calling.
", "CreatePersistentContactAssociation": "Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide.
", "CreatePredefinedAttribute": "Creates a new predefined attribute for the specified Amazon Connect instance. A predefined attribute is made up of a name and a value.
For the predefined attributes per instance quota, see Amazon Connect quotas.
Use cases
Following are common uses cases for this API:
Create an attribute for routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents.
Create an attribute for business unit name that has a list of predefined business unit names used in your organization. This is a use case where information for a contact varies between transfers or conferences. For more information, see Use contact segment attributes.
Endpoints: See Amazon Connect endpoints and quotas.
", "CreatePrompt": "Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide.
", "CreatePushNotificationRegistration": "Creates registration for a device token and a chat contact to receive real-time push notifications. For more information about push notifications, see Set up push notifications in Amazon Connect for mobile chat in the Amazon Connect Administrator Guide.
", "CreateQueue": "Creates a new queue for the specified Amazon Connect instance.
If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.
Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.
If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
Creates a quick connect for the specified Amazon Connect instance.
", "CreateRoutingProfile": "Creates a new routing profile.
", "CreateRule": "Creates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
", "CreateSecurityProfile": "Creates a security profile.
For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
", "CreateTaskTemplate": "Creates a new task template in the specified Amazon Connect instance.
", "CreateTrafficDistributionGroup": "Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.
For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Amazon Connect Administrator Guide.
", "CreateUseCase": "Creates a use case for an integration association.
", "CreateUser": "Creates a user account for the specified Amazon Connect instance.
Certain UserIdentityInfo parameters are required in some situations. For example, Email, FirstName and LastName are required if you are using Amazon Connect or SAML for identity management.
For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.
", "CreateUserHierarchyGroup": "Creates a new user hierarchy group.
", "CreateView": "Creates a new view with the possible status of SAVED or PUBLISHED.
The views will have a unique name for each connect instance.
It performs basic content validation if the status is SAVED or full content validation if the status is set to PUBLISHED. An error is returned if validation fails. It associates either the $SAVED qualifier or both of the $SAVED and $LATEST qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided.
Publishes a new version of the view identifier.
Versions are immutable and monotonically increasing.
It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the $LATEST alias.
Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.
", "DeactivateEvaluationForm": "Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.
", "DeleteAttachedFile": "Deletes an attached file along with the underlying S3 Object.
The attached file is permanently deleted if S3 bucket versioning is not enabled.
Deletes a contact evaluation in the specified Amazon Connect instance.
", "DeleteContactFlow": "Deletes a flow for the specified Amazon Connect instance.
", "DeleteContactFlowModule": "Deletes the specified flow module.
", "DeleteContactFlowVersion": "Deletes the particular version specified in flow version identifier.
", "DeleteEmailAddress": "Deletes email address from the specified Amazon Connect instance.
", "DeleteEvaluationForm": "Deletes an evaluation form in the specified Amazon Connect instance.
If the version property is provided, only the specified version of the evaluation form is deleted.
If no version is provided, then the full form (all versions) is deleted.
Deletes an hours of operation.
", "DeleteHoursOfOperationOverride": "Deletes an hours of operation override in an Amazon Connect hours of operation resource.
", "DeleteInstance": "This API is in preview release for Amazon Connect and is subject to change.
Deletes the Amazon Connect instance. For more information, see Delete your Amazon Connect instance in the Amazon Connect Administrator Guide.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
", "DeleteIntegrationAssociation": "Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.
", "DeletePredefinedAttribute": "Deletes a predefined attribute from the specified Amazon Connect instance.
", "DeletePrompt": "Deletes a prompt.
", "DeletePushNotificationRegistration": "Deletes registration for a device token and a chat contact.
", "DeleteQueue": "Deletes a queue.
", "DeleteQuickConnect": "Deletes a quick connect.
After calling DeleteUser, it's important to call DeleteQuickConnect to delete any records related to the deleted users. This will help you:
Avoid dangling resources that impact your service quotas.
Remove deleted users so they don't appear to agents as transfer options.
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.
Deletes a routing profile.
", "DeleteRule": "Deletes a rule for the specified Amazon Connect instance.
", "DeleteSecurityProfile": "Deletes a security profile.
", "DeleteTaskTemplate": "Deletes the task template.
", "DeleteTrafficDistributionGroup": "Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Amazon Connect Administrator Guide.
", "DeleteUseCase": "Deletes a use case from an integration association.
", "DeleteUser": "Deletes a user account from the specified Amazon Connect instance.
For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide.
After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you:
Avoid dangling resources that impact your service quotas.
Remove deleted users so they don't appear to agents as transfer options.
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.
Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
", "DeleteView": "Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).
", "DeleteViewVersion": "Deletes the particular version specified in ViewVersion identifier.
Deletes the vocabulary that has the given identifier.
", "DescribeAgentStatus": "Describes an agent status.
", "DescribeAuthenticationProfile": "This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Describes the target authentication profile.
", "DescribeContact": "This API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
SystemEndpoint is not populated for contacts with initiation method of MONITOR, QUEUE_TRANSFER, or CALLBACK
Contact information remains available in Amazon Connect for 24 months from the InitiationTimestamp, and then it is deleted. Only contact information that is available in Amazon Connect is returned by this API.
Describes a contact evaluation in the specified Amazon Connect instance.
", "DescribeContactFlow": "Describes the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.
Use arn:aws:.../contact-flow/{id}:{version} to retrieve the content of a specific flow version.
In the response, Status indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. SAVED does not initiate validation of the content. SAVED | PUBLISHED
Describes the specified flow module.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.
Describe email address form the specified Amazon Connect instance.
", "DescribeEvaluationForm": "Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.
", "DescribeHoursOfOperation": "Describes the hours of operation.
", "DescribeHoursOfOperationOverride": "Describes the hours of operation override.
", "DescribeInstance": "This API is in preview release for Amazon Connect and is subject to change.
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.
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.
", "DescribeInstanceAttribute": "This API is in preview release for Amazon Connect and is subject to change.
Describes the specified instance attribute.
", "DescribeInstanceStorageConfig": "This API is in preview release for Amazon Connect and is subject to change.
Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.
", "DescribePhoneNumber": "Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.
If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you receive a ResourceNotFoundException.
Describes a predefined attribute for the specified Amazon Connect instance. A predefined attribute is made up of a name and a value. You can use predefined attributes for:
Routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents.
Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see Use contact segment attributes.
For the predefined attributes per instance quota, see Amazon Connect quotas.
Endpoints: See Amazon Connect endpoints and quotas.
", "DescribePrompt": "Describes the prompt.
", "DescribeQueue": "Describes the specified queue.
", "DescribeQuickConnect": "Describes the quick connect.
", "DescribeRoutingProfile": "Describes the specified routing profile.
DescribeRoutingProfile does not populate AssociatedQueueIds in its response. The example Response Syntax shown on this page is incorrect; we are working to update it. SearchRoutingProfiles does include AssociatedQueueIds.
Describes a rule for the specified Amazon Connect instance.
", "DescribeSecurityProfile": "Gets basic information about the security profile.
For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
", "DescribeTrafficDistributionGroup": "Gets details and status of a traffic distribution group.
", "DescribeUser": "Describes the specified user. You can find the instance ID in the Amazon Connect 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.
", "DescribeUserHierarchyGroup": "Describes the specified hierarchy group.
", "DescribeUserHierarchyStructure": "Describes the hierarchy structure of the specified Amazon Connect instance.
", "DescribeView": "Retrieves the view for the specified Amazon Connect instance and view identifier.
The view identifier can be supplied as a ViewId or ARN.
$SAVED needs to be supplied if a view is unpublished.
The view identifier can contain an optional qualifier, for example, <view-id>:$SAVED, which is either an actual version number or an Amazon Connect managed qualifier $SAVED | $LATEST. If it is not supplied, then $LATEST is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views.
Describes the specified vocabulary.
", "DisassociateAnalyticsDataSet": "Removes the dataset ID associated with a given Amazon Connect instance.
", "DisassociateApprovedOrigin": "This API is in preview release for Amazon Connect and is subject to change.
Revokes access to integrated applications from Amazon Connect.
", "DisassociateBot": "This API is in preview release for Amazon Connect and is subject to change.
Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot.
", "DisassociateFlow": "Disassociates a connect resource from a flow.
", "DisassociateInstanceStorageConfig": "This API is in preview release for Amazon Connect and is subject to change.
Removes the storage type configurations for the specified resource type and association ID.
", "DisassociateLambdaFunction": "This API is in preview release for Amazon Connect and is subject to change.
Remove the Lambda function from the dropdown options available in the relevant flow blocks.
", "DisassociateLexBot": "This API is in preview release for Amazon Connect and is subject to change.
Revokes authorization from the specified instance to access the specified Amazon Lex bot.
", "DisassociatePhoneNumberContactFlow": "Removes the flow association from a phone number claimed to your Amazon Connect instance.
If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.
Disassociates a set of quick connects from a queue.
", "DisassociateRoutingProfileQueues": "Disassociates a set of queues from a routing profile.
", "DisassociateSecurityKey": "This API is in preview release for Amazon Connect and is subject to change.
Deletes the specified security key.
", "DisassociateTrafficDistributionGroupUser": "Disassociates an agent from a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
", "DisassociateUserProficiencies": "Disassociates a set of proficiencies from a user.
", "DismissUserContact": "Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a MISSED, ERROR, ENDED, or REJECTED state in the Agent Event Stream.
Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is APPROVED.
Retrieves the contact attributes for the specified contact.
", "GetContactMetrics": "Gets the real-time metrics of the specified contact.
Use cases
Following are common uses cases for this API:
You can use this API to retrieve the position of the contact in the queue.
Endpoints: See Amazon Connect endpoints and quotas.
", "GetCurrentMetricData": "Gets the real-time metric data from the specified Amazon Connect instance.
For a description of each metric, see Metrics definitions in the Amazon Connect Administrator Guide.
When you make a successful API request, you can expect the following metric values in the response:
Metric value is null: The calculation cannot be performed due to divide by zero or insufficient data
Metric value is a number (including 0) of defined type: The number provided is the calculation result
MetricResult list is empty: The request cannot find any data in the system
The following guidelines can help you work with the API:
Each dimension in the metric response must contain a value
Each item in MetricResult must include all requested metrics
If the response is slow due to large result sets, try these approaches:
Add filters to reduce the amount of data returned
Gets the real-time active user data from the specified Amazon Connect instance.
", "GetEffectiveHoursOfOperations": "Get the hours of operations with the effective override applied.
", "GetFederationToken": "Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action.
For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide.
This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears:
Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect
Retrieves the flow associated for a given resource.
", "GetMetricData": "Gets historical metric data from the specified Amazon Connect instance.
For a description of each historical metric, see Metrics definitions in the Amazon Connect Administrator Guide.
We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.
Gets metric data from the specified Amazon Connect instance.
GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. It does not support agent queues.
For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Metrics definitions in the Amazon Connect Administrator Guide.
When you make a successful API request, you can expect the following metric values in the response:
Metric value is null: The calculation cannot be performed due to divide by zero or insufficient data
Metric value is a number (including 0) of defined type: The number provided is the calculation result
MetricResult list is empty: The request cannot find any data in the system
The following guidelines can help you work with the API:
Each dimension in the metric response must contain a value
Each item in MetricResult must include all requested metrics
If the response is slow due to large result sets, try these approaches:
Narrow the time range of your request
Add filters to reduce the amount of data returned
Gets the prompt file.
", "GetTaskTemplate": "Gets details about a specific task template in the specified Amazon Connect instance.
", "GetTrafficDistribution": "Retrieves the current traffic distribution for a given traffic distribution group.
", "ImportPhoneNumber": "Imports a claimed phone number from an external service, such as Amazon Web Services End User Messaging, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.
Call the DescribePhoneNumber API to verify the status of a previous ImportPhoneNumber operation.
If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services Support ticket.
", "ListAgentStatuses": "Lists agent statuses.
", "ListAnalyticsDataAssociations": "Lists the association status of requested dataset ID for a given Amazon Connect instance.
", "ListAnalyticsDataLakeDataSets": "Lists the data lake datasets available to associate with for a given Amazon Connect instance.
", "ListApprovedOrigins": "This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all approved origins associated with the instance.
", "ListAssociatedContacts": "Provides information about contact tree, a list of associated contacts with a unique identifier.
", "ListAuthenticationProfiles": "This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Provides summary information about the authentication profiles in a specified Amazon Connect instance.
", "ListBots": "This API is in preview release for Amazon Connect and is subject to change.
For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to return both Amazon Lex V1 and V2 bots.
", "ListContactEvaluations": "Lists contact evaluations in the specified Amazon Connect instance.
", "ListContactFlowModules": "Provides information about the flow modules for the specified Amazon Connect instance.
", "ListContactFlowVersions": "Returns all the available versions for the specified Amazon Connect instance and flow identifier.
", "ListContactFlows": "Provides information about the flows for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
For more information about flows, see Flows in the Amazon Connect Administrator Guide.
", "ListContactReferences": "This API is in preview release for Amazon Connect and is subject to change.
For the specified referenceTypes, returns a list of references associated with the contact. References are links to documents that are related to a contact, such as emails, attachments, or URLs.
Lists the default vocabularies for the specified Amazon Connect instance.
", "ListEvaluationFormVersions": "Lists versions of an evaluation form in the specified Amazon Connect instance.
", "ListEvaluationForms": "Lists evaluation forms in the specified Amazon Connect instance.
", "ListFlowAssociations": "List the flow association based on the filters.
", "ListHoursOfOperationOverrides": "List the hours of operation overrides.
", "ListHoursOfOperations": "Provides information about the hours of operation for the specified Amazon Connect instance.
For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.
", "ListInstanceAttributes": "This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all attribute types for the given instance.
", "ListInstanceStorageConfigs": "This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of storage configs for the identified instance and resource type.
", "ListInstances": "This API is in preview release for Amazon Connect and is subject to change.
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.
", "ListIntegrationAssociations": "Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
", "ListLambdaFunctions": "This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks.
", "ListLexBots": "This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API.
", "ListPhoneNumbers": "Provides information about the phone numbers for the specified Amazon Connect instance.
For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.
We recommend using ListPhoneNumbersV2 to return phone number types. ListPhoneNumbers doesn't support number types UIFN, SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID. While it returns numbers of those types, it incorrectly lists them as TOLL_FREE or DID.
The phone number Arn value that is returned from each of the items in the PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with a ResourceNotFoundException. Instead, use the ListPhoneNumbersV2 API. It returns the new phone number ARN that can be used to tag phone number resources.
Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group.
For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.
When given an instance ARN, ListPhoneNumbersV2 returns only the phone numbers claimed to the instance.
When given a traffic distribution group ARN ListPhoneNumbersV2 returns only the phone numbers claimed to the traffic distribution group.
Lists predefined attributes for the specified Amazon Connect instance. A predefined attribute is made up of a name and a value. You can use predefined attributes for:
Routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents.
Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see Use contact segment attributes.
For the predefined attributes per instance quota, see Amazon Connect quotas.
Endpoints: See Amazon Connect endpoints and quotas.
", "ListPrompts": "Provides information about the prompts for the specified Amazon Connect instance.
", "ListQueueQuickConnects": "Lists the quick connects associated with a queue.
", "ListQueues": "Provides information about the queues for the specified Amazon Connect instance.
If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code.
For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.
", "ListQuickConnects": "Provides information about the quick connects for the specified Amazon Connect instance.
", "ListRealtimeContactAnalysisSegmentsV2": "Provides a list of analysis segments for a real-time chat analysis session. This API supports CHAT channels only.
This API does not support VOICE. If you attempt to use it for VOICE, an InvalidRequestException occurs.
Lists the queues associated with a routing profile.
", "ListRoutingProfiles": "Provides summary information about the routing profiles for the specified Amazon Connect instance.
For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.
", "ListRules": "List all rules for the specified Amazon Connect instance.
", "ListSecurityKeys": "This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all security keys associated with the instance.
", "ListSecurityProfileApplications": "Returns a list of third-party applications in a specific security profile.
", "ListSecurityProfilePermissions": "Lists the permissions granted to a security profile.
For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
", "ListSecurityProfiles": "Provides summary information about the security profiles for the specified Amazon Connect instance.
For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
", "ListTagsForResource": "Lists the tags for the specified resource.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
", "ListTaskTemplates": "Lists task templates for the specified Amazon Connect instance.
", "ListTrafficDistributionGroupUsers": "Lists traffic distribution group users.
", "ListTrafficDistributionGroups": "Lists traffic distribution groups.
", "ListUseCases": "Lists the use cases for the integration association.
", "ListUserHierarchyGroups": "Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.
", "ListUserProficiencies": "Lists proficiencies associated with a user.
", "ListUsers": "Provides summary information about the users for the specified Amazon Connect instance.
", "ListViewVersions": "Returns all the available versions for the specified Amazon Connect instance and view identifier.
Results will be sorted from highest to lowest.
", "ListViews": "Returns views in the given instance.
Results are sorted primarily by type, and secondarily by name.
", "MonitorContact": "Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact.
", "PauseContact": "Allows pausing an ongoing task contact.
", "PutUserStatus": "Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent's next status.
For more information, see Agent status and Set your next status in the Amazon Connect Administrator Guide.
", "ReleasePhoneNumber": "Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.
To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect admin website.
After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.
If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
", "ReplicateInstance": "Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.
For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide.
", "ResumeContact": "Allows resuming a task contact in a paused state.
", "ResumeContactRecording": "When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume.
Voice and screen recordings are supported.
", "SearchAgentStatuses": "Searches AgentStatuses in an Amazon Connect instance, with optional filtering.
", "SearchAvailablePhoneNumbers": "Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group.
Searches the flow modules in an Amazon Connect instance, with optional filtering.
", "SearchContactFlows": "Searches the flows in an Amazon Connect instance, with optional filtering.
", "SearchContacts": "Searches contacts in an Amazon Connect instance.
", "SearchEmailAddresses": "Searches email address in an instance, with optional filtering.
", "SearchHoursOfOperationOverrides": "Searches the hours of operation overrides.
", "SearchHoursOfOperations": "Searches the hours of operation in an Amazon Connect instance, with optional filtering.
", "SearchPredefinedAttributes": "Searches predefined attributes that meet certain criteria. A predefined attribute is made up of a name and a value. You can use predefined attributes for:
Routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents.
Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see Use contact segment attributes.
For the predefined attributes per instance quota, see Amazon Connect quotas.
Endpoints: See Amazon Connect endpoints and quotas.
", "SearchPrompts": "Searches prompts in an Amazon Connect instance, with optional filtering.
", "SearchQueues": "Searches queues in an Amazon Connect instance, with optional filtering.
", "SearchQuickConnects": "Searches quick connects in an Amazon Connect instance, with optional filtering.
", "SearchResourceTags": "Searches tags used in an Amazon Connect instance using optional search criteria.
", "SearchRoutingProfiles": "Searches routing profiles in an Amazon Connect instance, with optional filtering.
SearchRoutingProfiles does not populate LastModifiedRegion, LastModifiedTime, MediaConcurrencies.CrossChannelBehavior, and AgentAvailabilityTimer in its response, but DescribeRoutingProfile does.
Searches security profiles in an Amazon Connect instance, with optional filtering.
For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
", "SearchUserHierarchyGroups": "Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering.
The UserHierarchyGroup with \"LevelId\": \"0\" is the foundation for building levels on top of an instance. It is not user-definable, nor is it visible in the UI.
Searches users in an Amazon Connect instance, with optional filtering.
AfterContactWorkTimeLimit is returned in milliseconds.
Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.
Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes:
SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat
ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat
When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action.
Access to this API is currently restricted to Amazon Web Services End User Messaging for supporting SMS integration.
", "SendOutboundEmail": "Send outbound email for outbound campaigns. For more information about outbound campaigns, see Set up Amazon Connect outbound campaigns.
Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.
Provides a pre-signed Amazon S3 URL in response for uploading your content.
You may only use this API to upload attachments to an Amazon Connect Case or Amazon Connect Email.
Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.
When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.
A 429 error occurs in the following situations:
API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception.
The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException.
If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
", "StartContactEvaluation": "Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started.
Evaluations created through the public API do not contain answer values suggested from automation.
Starts recording the contact:
If the API is called before the agent joins the call, recording starts when the agent joins the call.
If the API is called after the agent joins the call, recording starts at the time of the API 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.
You can use this API to override the recording behavior configured in the Set recording behavior block.
Only voice recordings are supported at this time.
", "StartContactStreaming": "Initiates real-time message streaming for a new chat contact.
For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
", "StartEmailContact": "Creates an inbound email contact and initiates a flow to start the email contact for the customer. Response of this API provides the ContactId of the email contact created.
", "StartOutboundChatContact": "Initiates a new outbound SMS contact to a customer. Response of this API provides the ContactId of the outbound SMS contact created.
SourceEndpoint only supports Endpoints with CONNECT_PHONENUMBER_ARN as Type and DestinationEndpoint only supports Endpoints with TELEPHONE_NUMBER as Type. ContactFlowId initiates the flow to manage the new SMS contact created.
This API can be used to initiate outbound SMS contacts for an agent, or it can also deflect an ongoing contact to an outbound SMS contact by using the StartOutboundChatContact Flow Action.
For more information about using SMS in Amazon Connect, see the following topics in the Amazon Connect Administrator Guide:
", "StartOutboundEmailContact": "Initiates a flow to send an agent reply or outbound email contact (created from the CreateContact API) to a customer.
", "StartOutboundVoiceContact": "Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's specified (in ContactFlowId).
Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.
There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.
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 Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
Campaign calls are not allowed by default. Before you can make a call with TrafficType = CAMPAIGN, you must submit a service quota increase request to the quota Amazon Connect campaigns.
Starts screen sharing for a contact. For more information about screen sharing, see Set up in-app, web, video calling, and screen sharing capabilities in the Amazon Connect Administrator Guide.
", "StartTaskContact": "Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the Amazon Connect Administrator Guide.
When using PreviousContactId and RelatedContactId input parameters, note the following:
PreviousContactId
Any updates to user-defined task contact attributes on any contact linked through the same PreviousContactId will affect every contact in the chain.
There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same PreviousContactId.
RelatedContactId
Copies contact attributes from the related task contact to the new contact.
Any update on attributes in a new task contact does not update attributes on previous contact.
There’s no limit on the number of task contacts that can be created that use the same RelatedContactId.
In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID, QuickConnectID, or TaskTemplateID. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the TaskTemplateID is specified but it does not have a flow configured, the request returns an error because Amazon Connect cannot identify the unique flow to run when the task is created.
A ServiceQuotaExceededException occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same PreviousContactId. For more information about service quotas for task contacts, see Amazon Connect service quotas in the Amazon Connect Administrator Guide.
Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).
", "StopContact": "Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:
DISCONNECT
TRANSFER
QUEUE_TRANSFER
EXTERNAL_OUTBOUND
MONITOR
Chat and task contacts can be terminated in any state, regardless of initiation method.
", "StopContactRecording": "Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.
Only voice recordings are supported at this time.
", "StopContactStreaming": "Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.
", "SubmitContactEvaluation": "Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted with the existing answers and notes. You can delete an answer or note by passing an empty object ({}) to the question identifier.
If a contact evaluation is already in submitted state, this operation will trigger a resubmission.
", "SuspendContactRecording": "When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call (IVR or agent), screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen.
The period of time that the recording is suspended is filled with silence in the final recording.
Voice (IVR, agent) and screen recordings are supported.
", "TagContact": "Adds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.
", "TagResource": "Adds the specified tags to the specified resource.
Some of the supported resource types are agents, routing profiles, queues, quick connects, flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
", "TransferContact": "Transfers TASK or EMAIL contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.
Note the following requirements:
Transfer is only supported for TASK and EMAIL contacts.
Do not use both QueueId and UserId in the same call.
The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.
The TransferContact API can be called only on active contacts.
A contact cannot be transferred more than 11 times.
Removes the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.
", "UntagResource": "Removes the specified tags from the specified resource.
", "UpdateAgentStatus": "Updates agent status.
", "UpdateAuthenticationProfile": "This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Updates the selected authentication profile.
", "UpdateContact": "This API is in preview release for Amazon Connect and is subject to change.
Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.
You can add or update user-defined contact information for both ongoing and completed contacts.
Creates or updates user-defined contact attributes associated with the specified contact.
You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or to identify abusive callers.
Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Amazon Connect Administrator Guide.
", "UpdateContactEvaluation": "Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object ({}) to the question identifier.
Updates the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.
Updates metadata about specified flow.
", "UpdateContactFlowModuleContent": "Updates specified flow module for the specified Amazon Connect instance.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.
Updates metadata about specified flow module.
", "UpdateContactFlowName": "The name of the flow.
You can also create and update flows using the Amazon Connect Flow language.
", "UpdateContactRoutingData": "Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block.
Either QueuePriority or QueueTimeAdjustmentInSeconds should be provided within the request body, but not both.
Updates the scheduled time of a task contact that is already scheduled.
", "UpdateEmailAddressMetadata": "Updates an email address metadata. For more information about email addresses, see Create email addresses in the Amazon Connect Administrator Guide.
", "UpdateEvaluationForm": "Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form.
This operation does not support partial updates. Instead it does a full update of evaluation form content.
", "UpdateHoursOfOperation": "Updates the hours of operation.
", "UpdateHoursOfOperationOverride": "Update the hours of operation override.
", "UpdateInstanceAttribute": "This API is in preview release for Amazon Connect and is subject to change.
Updates the value for the specified attribute type.
", "UpdateInstanceStorageConfig": "This API is in preview release for Amazon Connect and is subject to change.
Updates an existing configuration for a resource type. This API is idempotent.
", "UpdateParticipantAuthentication": "Instructs Amazon Connect to resume the authentication process. The subsequent actions depend on the request body contents:
If a code is provided: Connect retrieves the identity information from Amazon Cognito and imports it into Connect Customer Profiles.
If an error is provided: The error branch of the Authenticate Customer block is executed.
The API returns a success response to acknowledge the request. However, the interaction and exchange of identity information occur asynchronously after the response is returned.
Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers:
Customer idle timeout
Customer auto-disconnect timeout
Agent idle timeout
Agent auto-disconnect timeout
For more information about how chat timeouts work, see Set up chat timeouts for human participants.
", "UpdatePhoneNumber": "Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.
After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flow configuration of the phone number, too.
You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.
Updates a phone number’s metadata.
To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.
Updates a predefined attribute for the specified Amazon Connect instance. A predefined attribute is made up of a name and a value.
For the predefined attributes per instance quota, see Amazon Connect quotas.
Use cases
Following are common uses cases for this API:
Update routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents.
Update an attribute for business unit name that has a list of predefined business unit names used in your organization. This is a use case where information for a contact varies between transfers or conferences. For more information, see Use contact segment attributes.
Endpoints: See Amazon Connect endpoints and quotas.
", "UpdatePrompt": "Updates a prompt.
", "UpdateQueueHoursOfOperation": "Updates the hours of operation for the specified queue.
", "UpdateQueueMaxContacts": "Updates the maximum number of contacts allowed in a queue before it is considered full.
", "UpdateQueueName": "Updates the name and description of a queue. At least Name or Description must be provided.
Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.
If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.
Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.
If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
Updates the outbound email address Id for a specified queue.
", "UpdateQueueStatus": "Updates the status of the queue.
", "UpdateQuickConnectConfig": "Updates the configuration settings for the specified quick connect.
", "UpdateQuickConnectName": "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.
Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
", "UpdateRoutingProfileConcurrency": "Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
", "UpdateRoutingProfileDefaultOutboundQueue": "Updates the default outbound queue of a routing profile.
", "UpdateRoutingProfileName": "Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name or Description must be provided.
Updates the properties associated with a set of queues for a routing profile.
", "UpdateRule": "Updates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
", "UpdateSecurityProfile": "Updates a security profile.
For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
", "UpdateTaskTemplate": "Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content.
", "UpdateTrafficDistribution": "Updates the traffic distribution for a given traffic distribution group.
When you shift telephony traffic, also shift agents and/or agent sign-ins to ensure they can handle the calls in the other Region. If you don't shift the agents, voice calls will go to the shifted Region but there won't be any agents available to receive the calls.
The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.
For more information about updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions in the Amazon Connect Administrator Guide.
", "UpdateUserHierarchy": "Assigns the specified hierarchy group to the specified user.
", "UpdateUserHierarchyGroupName": "Updates the name of the user hierarchy group.
", "UpdateUserHierarchyStructure": "Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
", "UpdateUserIdentityInfo": "Updates the identity information for the specified user.
We strongly recommend limiting who has the ability to invoke UpdateUserIdentityInfo. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.
Updates the phone configuration settings for the specified user.
", "UpdateUserProficiencies": "Updates the properties associated with the proficiencies of a user.
", "UpdateUserRoutingProfile": "Assigns the specified routing profile to the specified user.
", "UpdateUserSecurityProfiles": "Assigns the specified security profiles to the specified user.
", "UpdateViewContent": "Updates the view content of the given view identifier in the specified Amazon Connect instance.
It performs content validation if Status is set to SAVED and performs full content validation if Status is PUBLISHED. Note that the $SAVED alias' content will always be updated, but the $LATEST alias' content will only be updated if Status is PUBLISHED.
Updates the view metadata. Note that either Name or Description must be provided.
The Amazon Resource Name (ARN) for the evaluation form resource.
", "AgentHierarchyGroup$Arn": "The Amazon Resource Name (ARN) of the group.
", "AgentStatus$AgentStatusARN": "The Amazon Resource Name (ARN) of the agent status.
", "AgentStatusIdentifier$Arn": "The Amazon Resource Name (ARN) of the agent status.
", "AgentStatusReference$StatusArn": "The Amazon Resource Name (ARN) of the agent's status.
", "AgentStatusSummary$Arn": "The Amazon Resource Name (ARN) for the agent status.
", "AnalyticsDataAssociationResult$ResourceShareArn": "The Amazon Resource Name (ARN) of the Resource Access Manager share.
", "AssociateAnalyticsDataSetResponse$ResourceShareArn": "The Amazon Resource Name (ARN) of the Resource Access Manager share.
", "AssociateFlowRequest$ResourceId": "The identifier of the resource.
Amazon Web Services End User Messaging SMS phone number ARN when using SMS_PHONE_NUMBER
Amazon Web Services End User Messaging Social phone number ARN when using WHATSAPP_MESSAGING_PHONE_NUMBER
The identifier of the flow.
", "AssociatedContactSummary$ContactArn": "The Amazon Resource Name (ARN) of the contact
", "AttachedFile$FileArn": "The unique identifier of the attached file resource (ARN).
", "AttachedFile$AssociatedResourceArn": "The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
The Amazon Resource Name (ARN) for the authentication profile.
", "AuthenticationProfileSummary$Arn": "The Amazon Resource Name (ARN) of the authentication profile summary.
", "BatchGetAttachedFileMetadataRequest$AssociatedResourceArn": "The resource to which the attached file is (being) uploaded to. The supported resources are Cases and Email.
This value must be a valid ARN.
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn.
The Amazon Resource Name (ARN) of the phone number.
", "ClaimedPhoneNumberSummary$PhoneNumberArn": "The Amazon Resource Name (ARN) of the phone number.
", "ClaimedPhoneNumberSummary$TargetArn": "The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.
", "ClaimedPhoneNumberSummary$SourcePhoneNumberArn": "The claimed phone number ARN that was previously imported from the external service, such as Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it looks like the ARN of the phone number that was imported from Amazon Web Services End User Messaging.
", "CompleteAttachedFileUploadRequest$AssociatedResourceArn": "The resource to which the attached file is (being) uploaded to. The supported resources are Cases and Email.
This value must be a valid ARN.
The Amazon Resource Name (ARN) for the contact.
", "ContactFlow$Arn": "The Amazon Resource Name (ARN) of the flow.
", "ContactFlowModule$Arn": "The Amazon Resource Name (ARN).
", "ContactFlowModuleSummary$Arn": "The Amazon Resource Name (ARN) of the flow module.
", "ContactFlowSummary$Arn": "The Amazon Resource Name (ARN) of the flow.
", "ContactFlowVersionSummary$Arn": "The Amazon Resource Name (ARN) of the view version.
", "ContactSearchSummary$Arn": "The Amazon Resource Name (ARN) of the contact.
", "CreateAgentStatusResponse$AgentStatusARN": "The Amazon Resource Name (ARN) of the agent status.
", "CreateContactFlowModuleResponse$Arn": "The Amazon Resource Name (ARN) of the flow module.
", "CreateContactFlowResponse$ContactFlowArn": "The Amazon Resource Name (ARN) of the flow.
", "CreateContactFlowVersionRequest$ContactFlowId": "The identifier of the flow.
", "CreateContactFlowVersionResponse$ContactFlowArn": "The Amazon Resource Name (ARN) of the flow.
", "CreateContactResponse$ContactArn": "The Amazon Resource Name (ARN) of the created contact.
", "CreateEvaluationFormResponse$EvaluationFormArn": "The Amazon Resource Name (ARN) for the evaluation form resource.
", "CreateHoursOfOperationResponse$HoursOfOperationArn": "The Amazon Resource Name (ARN) for the hours of operation.
", "CreateInstanceResponse$Arn": "The Amazon Resource Name (ARN) of the instance.
", "CreateIntegrationAssociationRequest$IntegrationArn": "The Amazon Resource Name (ARN) of the integration.
When integrating with Amazon Web Services End User Messaging, the Amazon Connect and Amazon Web Services End User Messaging instances must be in the same account.
The Amazon Resource Name (ARN) for the association.
", "CreatePromptResponse$PromptARN": "The Amazon Resource Name (ARN) of the prompt.
", "CreatePushNotificationRegistrationRequest$PinpointAppArn": "The Amazon Resource Name (ARN) of the Pinpoint application.
", "CreateQueueResponse$QueueArn": "The Amazon Resource Name (ARN) of the queue.
", "CreateQuickConnectResponse$QuickConnectARN": "The Amazon Resource Name (ARN) for the quick connect.
", "CreateRoutingProfileResponse$RoutingProfileArn": "The Amazon Resource Name (ARN) of the routing profile.
", "CreateRuleResponse$RuleArn": "The Amazon Resource Name (ARN) of the rule.
", "CreateSecurityProfileResponse$SecurityProfileArn": "The Amazon Resource Name (ARN) for the security profile.
", "CreateUseCaseResponse$UseCaseArn": "The Amazon Resource Name (ARN) for the use case.
", "CreateUserHierarchyGroupResponse$HierarchyGroupArn": "The Amazon Resource Name (ARN) of the hierarchy group.
", "CreateUserResponse$UserArn": "The Amazon Resource Name (ARN) of the user account.
", "CreateVocabularyResponse$VocabularyArn": "The Amazon Resource Name (ARN) of the custom vocabulary.
", "CreatedByInfo$ConnectUserArn": "An agent ARN representing a connect user.
", "CreatedByInfo$AWSIdentityArn": "STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if ConnectUserArn is not provided.
The Amazon Resource Name (ARN) for the evaluation form resource.
", "DeleteAttachedFileRequest$AssociatedResourceArn": "The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
The identifier of the flow.
", "DeleteVocabularyResponse$VocabularyArn": "The Amazon Resource Name (ARN) of the custom vocabulary.
", "DisassociateFlowRequest$ResourceId": "The identifier of the resource.
Amazon Web Services End User Messaging SMS phone number ARN when using SMS_PHONE_NUMBER
Amazon Web Services End User Messaging Social phone number ARN when using WHATSAPP_MESSAGING_PHONE_NUMBER
The Amazon Resource Name (ARN) for the contact evaluation resource.
", "EvaluationForm$EvaluationFormArn": "The Amazon Resource Name (ARN) for the evaluation form resource.
", "EvaluationForm$CreatedBy": "The Amazon Resource Name (ARN) of the user who created the evaluation form.
", "EvaluationForm$LastModifiedBy": "The Amazon Resource Name (ARN) of the user who last updated the evaluation form.
", "EvaluationFormContent$EvaluationFormArn": "The Amazon Resource Name (ARN) for the evaluation form resource.
", "EvaluationFormSummary$EvaluationFormArn": "The Amazon Resource Name (ARN) for the evaluation form resource.
", "EvaluationFormSummary$CreatedBy": "The Amazon Resource Name (ARN) of the user who created the evaluation form.
", "EvaluationFormSummary$LastModifiedBy": "The Amazon Resource Name (ARN) of the user who last updated the evaluation form.
", "EvaluationFormSummary$LastActivatedBy": "The Amazon Resource Name (ARN) of the user who last activated the evaluation form.
", "EvaluationFormVersionSummary$EvaluationFormArn": "The Amazon Resource Name (ARN) for the evaluation form resource.
", "EvaluationFormVersionSummary$CreatedBy": "The Amazon Resource Name (ARN) of the user who created the evaluation form.
", "EvaluationFormVersionSummary$LastModifiedBy": "The Amazon Resource Name (ARN) of the user who last updated the evaluation form.
", "EvaluationMetadata$EvaluatorArn": "The Amazon Resource Name (ARN) of the user who last updated the evaluation.
", "EvaluationSummary$EvaluationArn": "The Amazon Resource Name (ARN) for the contact evaluation resource.
", "EvaluationSummary$EvaluatorArn": "The Amazon Resource Name (ARN) of the user who last updated the evaluation.
", "FlowAssociationSummary$ResourceId": "The identifier of the resource.
", "FlowAssociationSummary$FlowId": "The identifier of the flow.
", "GetAttachedFileRequest$AssociatedResourceArn": "The resource to which the attached file is (being) uploaded to. The supported resources are Cases and Email.
This value must be a valid ARN.
The unique identifier of the attached file resource (ARN).
", "GetAttachedFileResponse$AssociatedResourceArn": "The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
", "GetContactMetricsResponse$Arn": "The ARN of the contact for which metrics were retrieved.
", "GetFederationTokenResponse$UserArn": "The Amazon Resource Name (ARN) of the user.
", "GetFlowAssociationRequest$ResourceId": "The identifier of the resource.
Amazon Web Services End User Messaging SMS phone number ARN when using SMS_PHONE_NUMBER
Amazon Web Services End User Messaging Social phone number ARN when using WHATSAPP_MESSAGING_PHONE_NUMBER
The identifier of the resource.
", "GetFlowAssociationResponse$FlowId": "The identifier of the flow.
", "GetMetricDataV2Request$ResourceArn": "The Amazon Resource Name (ARN) of the resource. This includes the instanceId an Amazon Connect instance.
The Amazon Resource Name (ARN) of the hierarchy group.
", "HierarchyGroupSummary$Arn": "The Amazon Resource Name (ARN) of the hierarchy group.
", "HierarchyGroupSummaryReference$Arn": "The Amazon Resource Name (ARN) for the hierarchy group.
", "HierarchyLevel$Arn": "The Amazon Resource Name (ARN) of the hierarchy level.
", "HoursOfOperation$HoursOfOperationArn": "The Amazon Resource Name (ARN) for the hours of operation.
", "HoursOfOperationOverride$HoursOfOperationArn": "The Amazon Resource Name (ARN) for the hours of operation.
", "HoursOfOperationSummary$Arn": "The Amazon Resource Name (ARN) of the hours of operation.
", "ImportPhoneNumberRequest$SourcePhoneNumberArn": "The claimed phone number ARN being imported from the external service, such as Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it looks like the ARN of the phone number to import from Amazon Web Services End User Messaging.
", "ImportPhoneNumberResponse$PhoneNumberArn": "The Amazon Resource Name (ARN) of the phone number.
", "Instance$Arn": "The Amazon Resource Name (ARN) of the instance.
", "Instance$ServiceRole": "The service role of the instance.
", "InstanceSummary$Arn": "The Amazon Resource Name (ARN) of the instance.
", "InstanceSummary$ServiceRole": "The service role of the instance.
", "IntegrationAssociationSummary$IntegrationAssociationArn": "The Amazon Resource Name (ARN) for the AppIntegration association.
", "IntegrationAssociationSummary$IntegrationArn": "The Amazon Resource Name (ARN) for the AppIntegration.
", "KinesisFirehoseConfig$FirehoseArn": "The Amazon Resource Name (ARN) of the delivery stream.
", "KinesisStreamConfig$StreamArn": "The Amazon Resource Name (ARN) of the data stream.
", "ListContactFlowVersionsRequest$ContactFlowId": "The identifier of the flow.
", "ListIntegrationAssociationsRequest$IntegrationArn": "The Amazon Resource Name (ARN) of the integration.
", "ListPhoneNumbersSummary$PhoneNumberArn": "The Amazon Resource Name (ARN) of the phone number.
", "ListPhoneNumbersSummary$TargetArn": "The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.
", "ListPhoneNumbersSummary$SourcePhoneNumberArn": "The claimed phone number ARN that was previously imported from the external service, such as Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it looks like the ARN of the phone number that was imported from Amazon Web Services End User Messaging.
", "ListPhoneNumbersV2Request$TargetArn": "The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. If both TargetArn and InstanceId input are not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same Amazon Web Services Region as the request.
The Amazon Resource Name (ARN) of the resource. All Amazon Connect resources (instances, queues, flows, routing profiles, etc) have an ARN. To locate the ARN for an instance, for example, see Find your Amazon Connect instance ID/ARN.
", "MonitorContactResponse$ContactArn": "The ARN of the contact.
", "PhoneNumberSummary$Arn": "The Amazon Resource Name (ARN) of the phone number.
", "Prompt$PromptARN": "The Amazon Resource Name (ARN) of the prompt.
", "PromptSummary$Arn": "The Amazon Resource Name (ARN) of the prompt.
", "Queue$QueueArn": "The Amazon Resource Name (ARN) for the queue.
", "QueueReference$Arn": "The Amazon Resource Name (ARN) of the queue.
", "QueueSummary$Arn": "The Amazon Resource Name (ARN) of the queue.
", "QuickConnect$QuickConnectARN": "The Amazon Resource Name (ARN) of the quick connect.
", "QuickConnectSummary$Arn": "The Amazon Resource Name (ARN) of the quick connect.
", "ReplicateInstanceResponse$Arn": "The Amazon Resource Name (ARN) of the replicated instance.
", "ResourceInUseException$ResourceId": "The identifier for the resource.
", "RoutingProfile$RoutingProfileArn": "The Amazon Resource Name (ARN) of the routing profile.
", "RoutingProfileQueueConfigSummary$QueueArn": "The Amazon Resource Name (ARN) of the queue.
", "RoutingProfileReference$Arn": "The Amazon Resource Name (ARN) of the routing profile.
", "RoutingProfileSummary$Arn": "The Amazon Resource Name (ARN) of the routing profile.
", "Rule$RuleArn": "The Amazon Resource Name (ARN) of the rule.
", "Rule$LastUpdatedBy": "The Amazon Resource Name (ARN) of the user who last updated the rule.
", "RuleSummary$RuleArn": "The Amazon Resource Name (ARN) of the rule.
", "SearchAvailablePhoneNumbersRequest$TargetArn": "The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn.
The Amazon Resource Name (ARN) for the security profile.
", "SecurityProfileSearchSummary$Arn": "The Amazon Resource Name (ARN) of the security profile.
", "SecurityProfileSummary$Arn": "The Amazon Resource Name (ARN) of the security profile.
", "StartAttachedFileUploadRequest$AssociatedResourceArn": "The resource to which the attached file is (being) uploaded to. The supported resources are Cases and Email.
This value must be a valid ARN.
The unique identifier of the attached file resource (ARN).
", "StartContactEvaluationResponse$EvaluationArn": "The Amazon Resource Name (ARN) for the contact evaluation resource.
", "SubmitContactEvaluationResponse$EvaluationArn": "The Amazon Resource Name (ARN) for the contact evaluation resource.
", "TagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", "TransferContactResponse$ContactArn": "The Amazon Resource Name (ARN) of the contact.
", "UntagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", "UpdateContactEvaluationResponse$EvaluationArn": "The Amazon Resource Name (ARN) for the contact evaluation resource.
", "UpdateEvaluationFormResponse$EvaluationFormArn": "The Amazon Resource Name (ARN) for the contact evaluation resource.
", "UpdatePhoneNumberRequest$TargetArn": "The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn.
The Amazon Resource Name (ARN) of the phone number.
", "UpdatePromptResponse$PromptARN": "The Amazon Resource Name (ARN) of the prompt.
", "UseCase$UseCaseArn": "The Amazon Resource Name (ARN) for the use case.
", "User$Arn": "The Amazon Resource Name (ARN) of the user account.
", "UserReference$Arn": "The Amazon Resource Name (ARN) for the user.
", "UserSearchSummary$Arn": "The Amazon Resource Name (ARN) of the user.
", "UserSummary$Arn": "The Amazon Resource Name (ARN) of the user account.
", "View$Arn": "The Amazon Resource Name (ARN) of the view.
", "ViewSummary$Arn": "The Amazon Resource Name (ARN) of the view.
", "ViewVersionSummary$Arn": "The Amazon Resource Name (ARN) of the view version.
", "Vocabulary$Arn": "The Amazon Resource Name (ARN) of the custom vocabulary.
", "VocabularySummary$Arn": "The Amazon Resource Name (ARN) of the custom vocabulary.
", "WisdomInfo$SessionArn": "The Amazon Resource Name (ARN) of the Wisdom session.
", "resourceArnListMaxLimit100$member": null } }, "AWSAccountId": { "base": null, "refs": { "AnalyticsDataAssociationResult$TargetAccountId": "The identifier of the target account.
", "AssociateAnalyticsDataSetRequest$TargetAccountId": "The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.
", "AssociateAnalyticsDataSetResponse$TargetAccountId": "The identifier of the target account.
", "BatchAssociateAnalyticsDataSetRequest$TargetAccountId": "The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.
", "BatchDisassociateAnalyticsDataSetRequest$TargetAccountId": "The identifier of the target account. Use to disassociate a dataset from a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.
", "DisassociateAnalyticsDataSetRequest$TargetAccountId": "The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.
" } }, "AccessDeniedException": { "base": "You do not have sufficient permissions to perform this action.
", "refs": {} }, "AccessTokenDuration": { "base": null, "refs": { "AuthenticationProfile$PeriodicSessionDuration": "The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This value determines the maximum possible time before an agent is authenticated. For more information, see Configure the session duration in the Amazon Connect Administrator Guide.
", "UpdateAuthenticationProfileRequest$PeriodicSessionDuration": "The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This value determines the maximum possible time before an agent is authenticated. For more information, For more information on how to configure IP addresses, see Configure session timeouts in the Amazon Connect Administrator Guide.
" } }, "ActionSummaries": { "base": null, "refs": { "RuleSummary$ActionSummaries": "A list of ActionTypes associated with a rule.
" } }, "ActionSummary": { "base": "Information about an action.
", "refs": { "ActionSummaries$member": null } }, "ActionType": { "base": null, "refs": { "ActionSummary$ActionType": "The action type.
", "RuleAction$ActionType": "The type of action that creates a rule.
" } }, "ActivateEvaluationFormRequest": { "base": null, "refs": {} }, "ActivateEvaluationFormResponse": { "base": null, "refs": {} }, "AdditionalEmailRecipients": { "base": "List of additional email addresses for an email contact.
", "refs": { "Contact$AdditionalEmailRecipients": "List of additional email addresses for an email contact.
" } }, "AfterContactWorkTimeLimit": { "base": null, "refs": { "UserPhoneConfig$AfterContactWorkTimeLimit": "The After Call Work (ACW) timeout setting, in seconds. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW.
When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.
Whether agents with this routing profile will have their routing order calculated based on longest idle time or time since their last inbound contact.
", "RoutingProfile$AgentAvailabilityTimer": "Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
", "UpdateRoutingProfileAgentAvailabilityTimerRequest$AgentAvailabilityTimer": "Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
" } }, "AgentConfig": { "base": "The distribution of agents between the instance and its replica(s).
", "refs": { "GetTrafficDistributionResponse$AgentConfig": "The distribution of agents between the instance and its replica(s).
", "UpdateTrafficDistributionRequest$AgentConfig": "The distribution of agents between the instance and its replica(s).
" } }, "AgentContactReference": { "base": "Information about the contact associated to the user.
", "refs": { "AgentContactReferenceList$member": null } }, "AgentContactReferenceList": { "base": null, "refs": { "UserData$Contacts": "A list of contact reference information.
" } }, "AgentFirstName": { "base": null, "refs": { "UserIdentityInfo$FirstName": "The first name. This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted.
", "UserIdentityInfoLite$FirstName": "The user's first name.
" } }, "AgentHierarchyGroup": { "base": "Information about an agent hierarchy group.
", "refs": { "HierarchyGroups$Level1": "The group at level one of the agent hierarchy.
", "HierarchyGroups$Level2": "The group at level two of the agent hierarchy.
", "HierarchyGroups$Level3": "The group at level three of the agent hierarchy.
", "HierarchyGroups$Level4": "The group at level four of the agent hierarchy.
", "HierarchyGroups$Level5": "The group at level five of the agent hierarchy.
" } }, "AgentHierarchyGroups": { "base": "A structure that defines search criteria for contacts using agent hierarchy group levels. For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.
", "refs": { "SearchCriteria$AgentHierarchyGroups": "The agent hierarchy groups of the agent at the time of handling the contact.
" } }, "AgentId": { "base": null, "refs": { "AgentIds$member": null } }, "AgentIds": { "base": null, "refs": { "AgentsCriteria$AgentIds": "An object to specify a list of agents, by user ID.
" } }, "AgentInfo": { "base": "Information about the agent who accepted the contact.
", "refs": { "Contact$AgentInfo": "Information about the agent who accepted the contact.
" } }, "AgentLastName": { "base": null, "refs": { "UserIdentityInfo$LastName": "The last name. This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted.
", "UserIdentityInfoLite$LastName": "The user's last name.
" } }, "AgentPauseDurationInSeconds": { "base": null, "refs": { "AgentInfo$AgentPauseDurationInSeconds": "Agent pause duration for a contact in seconds.
" } }, "AgentQualityMetrics": { "base": "Information about the quality of the Agent's media connection
", "refs": { "QualityMetrics$Agent": "Information about the quality of Agent media connection.
" } }, "AgentResourceId": { "base": null, "refs": { "AgentInfo$Id": "The identifier of the agent who accepted the contact.
", "AgentResourceIdList$member": null, "ContactSearchSummaryAgentInfo$Id": "The identifier of the agent who accepted the contact.
", "GetFederationTokenResponse$UserId": "The identifier for the user. This can be the ID or the ARN of the user.
", "MonitorContactRequest$UserId": "The identifier of the user account.
", "TransferContactRequest$UserId": "The identifier for the user. This can be the ID or the ARN of the user.
", "UserInfo$UserId": "The user identifier for the contact.
" } }, "AgentResourceIdList": { "base": null, "refs": { "SearchCriteria$AgentIds": "The identifiers of agents who handled the contacts.
" } }, "AgentStatus": { "base": "Contains information about an agent status.
", "refs": { "AgentStatusList$member": null, "DescribeAgentStatusResponse$AgentStatus": "The agent status.
" } }, "AgentStatusDescription": { "base": null, "refs": { "AgentStatus$Description": "The description of the agent status.
", "CreateAgentStatusRequest$Description": "The description of the status.
" } }, "AgentStatusId": { "base": null, "refs": { "AgentStatus$AgentStatusId": "The identifier of the agent status.
", "AgentStatusIdentifier$Id": "The identifier of the agent status.
", "AgentStatusSummary$Id": "The identifier for an agent status.
", "AgentStatuses$member": null, "CreateAgentStatusResponse$AgentStatusId": "The identifier of the agent status.
", "DescribeAgentStatusRequest$AgentStatusId": "The identifier for the agent status.
", "PutUserStatusRequest$AgentStatusId": "The identifier of the agent status.
", "UpdateAgentStatusRequest$AgentStatusId": "The identifier of the agent status.
" } }, "AgentStatusIdentifier": { "base": "Information about the agent status assigned to the user.
", "refs": { "Dimensions$AgentStatus": "Information about the agent status assigned to the user.
" } }, "AgentStatusList": { "base": null, "refs": { "SearchAgentStatusesResponse$AgentStatuses": "The search criteria to be used to return agent statuses.
" } }, "AgentStatusName": { "base": null, "refs": { "AgentStatus$Name": "The name of the agent status.
", "AgentStatusReference$StatusName": "The name of the agent status.
", "AgentStatusSummary$Name": "The name of the agent status.
", "CreateAgentStatusRequest$Name": "The name of the status.
", "UpdateAgentStatusRequest$Name": "The name of the agent status.
", "UserData$NextStatus": "The Next status of the agent.
" } }, "AgentStatusOrderNumber": { "base": null, "refs": { "AgentStatus$DisplayOrder": "The display order of the agent status.
", "CreateAgentStatusRequest$DisplayOrder": "The display order of the status.
", "UpdateAgentStatusRequest$DisplayOrder": "The display order of the agent status.
" } }, "AgentStatusReference": { "base": "Information about the agent's status.
", "refs": { "UserData$Status": "The status of the agent that they manually set in their Contact Control Panel (CCP), or that the supervisor manually changes in the real-time metrics report.
" } }, "AgentStatusSearchConditionList": { "base": null, "refs": { "AgentStatusSearchCriteria$OrConditions": "A list of conditions which would be applied together with an OR condition.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are name,
description, state, type, displayOrder,
and resourceID.
The search criteria to be used to return agent statuses.
", "refs": { "AgentStatusSearchConditionList$member": null, "SearchAgentStatusesRequest$SearchCriteria": "The search criteria to be used to return agent statuses.
" } }, "AgentStatusSearchFilter": { "base": "Filters to be applied to search results.
", "refs": { "SearchAgentStatusesRequest$SearchFilter": "Filters to be applied to search results.
" } }, "AgentStatusState": { "base": null, "refs": { "AgentStatus$State": "The state of the agent status.
", "CreateAgentStatusRequest$State": "The state of the status.
", "UpdateAgentStatusRequest$State": "The state of the agent status.
" } }, "AgentStatusSummary": { "base": "Summary information for an agent status.
", "refs": { "AgentStatusSummaryList$member": null } }, "AgentStatusSummaryList": { "base": null, "refs": { "ListAgentStatusResponse$AgentStatusSummaryList": "A summary of agent statuses.
" } }, "AgentStatusType": { "base": null, "refs": { "AgentStatus$Type": "The type of agent status.
", "AgentStatusSummary$Type": "The type of the agent status.
", "AgentStatusTypes$member": null } }, "AgentStatusTypes": { "base": null, "refs": { "ListAgentStatusRequest$AgentStatusTypes": "Available agent status types.
" } }, "AgentStatuses": { "base": null, "refs": { "Filters$AgentStatuses": "A list of up to 50 agent status IDs or ARNs.
" } }, "AgentUsername": { "base": null, "refs": { "CreateUserRequest$Username": "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_-.\\@]+.
Username can include @ only if used in an email format. For example:
Correct: testuser
Correct: testuser@example.com
Incorrect: testuser@example
The user name assigned to the user account.
", "UserSearchSummary$Username": "The name of the user.
", "UserSummary$Username": "The Amazon Connect user name of the user account.
" } }, "AgentsCriteria": { "base": "Can be used to define a list of preferred agents to target the contact to within the queue. Note that agents must have the queue in their routing profile in order to be offered the contact.
", "refs": { "MatchCriteria$AgentsCriteria": "An object to define agentIds.
" } }, "AgentsMinOneMaxHundred": { "base": null, "refs": { "UserDataFilters$Agents": "A list of up to 100 agent IDs or ARNs.
" } }, "AliasArn": { "base": null, "refs": { "LexV2Bot$AliasArn": "The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.
" } }, "AllowedAccessControlTags": { "base": null, "refs": { "CreateSecurityProfileRequest$AllowedAccessControlTags": "The list of tags that a security profile uses to restrict access to resources in Amazon Connect.
", "SecurityProfile$AllowedAccessControlTags": "The list of tags that a security profile uses to restrict access to resources in Amazon Connect.
", "UpdateSecurityProfileRequest$AllowedAccessControlTags": "The list of tags that a security profile uses to restrict access to resources in Amazon Connect.
" } }, "AllowedCapabilities": { "base": "Information about the capabilities enabled for participants of the contact.
", "refs": { "StartWebRTCContactRequest$AllowedCapabilities": "Information about the video sharing capabilities of the participants (customer, agent).
" } }, "AllowedMonitorCapabilities": { "base": null, "refs": { "MonitorContactRequest$AllowedMonitorCapabilities": "Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge. AllowedMonitorCapabilities is required if barge is enabled.
" } }, "AnalyticsDataAssociationResult": { "base": "This API is in preview release for Amazon Connect and is subject to change.
Information about associations that are successfully created: DataSetId, TargetAccountId, ResourceShareId, ResourceShareArn.
Information about associations that are successfully created: DataSetId, TargetAccountId, ResourceShareId, ResourceShareArn.
An array of successful results: DataSetId, TargetAccountId, ResourceShareId, ResourceShareArn. This is a paginated API, so nextToken is given if there are more results to be returned.
Information about datasets that are available to associate with: DataSetId, DataSetName.
An array of successful results: DataSetId, DataSetName. This is a paginated API, so nextToken is given if there are more results to be returned.
Configuration of the answering machine detection.
", "refs": { "StartOutboundVoiceContactRequest$AnswerMachineDetectionConfig": "Configuration of the answering machine detection for this outbound call.
" } }, "AnsweringMachineDetectionStatus": { "base": null, "refs": { "Contact$AnsweringMachineDetectionStatus": "Indicates how an outbound campaign call is actually disposed if the contact is connected to Amazon Connect.
" } }, "Application": { "base": "This API is in preview release for Amazon Connect and is subject to change.
A third-party application's metadata.
", "refs": { "Applications$member": null } }, "ApplicationPermissions": { "base": null, "refs": { "Application$ApplicationPermissions": "The permissions that the agent is granted on the application. Only the ACCESS permission is supported.
A list of third-party applications that the security profile will give access to.
", "ListSecurityProfileApplicationsResponse$Applications": "A list of the third-party application's metadata.
", "UpdateSecurityProfileRequest$Applications": "A list of the third-party application's metadata.
" } }, "ApproximateTotalCount": { "base": null, "refs": { "GetCurrentMetricDataResponse$ApproximateTotalCount": "The total count of the result, regardless of the current page size.
", "GetCurrentUserDataResponse$ApproximateTotalCount": "The total count of the result, regardless of the current page size.
", "SearchAgentStatusesResponse$ApproximateTotalCount": "The total number of agent statuses which matched your search query.
", "SearchContactFlowModulesResponse$ApproximateTotalCount": "The total number of flows which matched your search query.
", "SearchContactFlowsResponse$ApproximateTotalCount": "The total number of flows which matched your search query.
", "SearchEmailAddressesResponse$ApproximateTotalCount": "The total number of email addresses which matched your search query.
", "SearchHoursOfOperationOverridesResponse$ApproximateTotalCount": "The total number of hours of operations which matched your search query.
", "SearchHoursOfOperationsResponse$ApproximateTotalCount": "The total number of hours of operations which matched your search query.
", "SearchPredefinedAttributesResponse$ApproximateTotalCount": "The approximate number of predefined attributes which matched your search query.
", "SearchPromptsResponse$ApproximateTotalCount": "The total number of quick connects which matched your search query.
", "SearchQueuesResponse$ApproximateTotalCount": "The total number of queues which matched your search query.
", "SearchQuickConnectsResponse$ApproximateTotalCount": "The total number of quick connects which matched your search query.
", "SearchRoutingProfilesResponse$ApproximateTotalCount": "The total number of routing profiles which matched your search query.
", "SearchSecurityProfilesResponse$ApproximateTotalCount": "The total number of security profiles which matched your search query.
", "SearchUserHierarchyGroupsResponse$ApproximateTotalCount": "The total number of userHierarchyGroups which matched your search query.
", "SearchUsersResponse$ApproximateTotalCount": "The total number of users who matched your search query.
" } }, "ArtifactId": { "base": null, "refs": { "RealTimeContactAnalysisAttachment$AttachmentId": "A unique identifier for the attachment.
" } }, "ArtifactStatus": { "base": null, "refs": { "RealTimeContactAnalysisAttachment$Status": "Status of the attachment.
" } }, "AssignContactCategoryActionDefinition": { "base": "This action must be set if TriggerEventSource is one of the following values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable. Contact is categorized using the rule name.
RuleName is used as ContactCategory.
Information about the contact category action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
The AssignSla action definition.
", "refs": { "RuleAction$AssignSlaAction": "Information about the assign SLA action.
" } }, "AssociateAnalyticsDataSetRequest": { "base": null, "refs": {} }, "AssociateAnalyticsDataSetResponse": { "base": null, "refs": {} }, "AssociateApprovedOriginRequest": { "base": null, "refs": {} }, "AssociateBotRequest": { "base": null, "refs": {} }, "AssociateDefaultVocabularyRequest": { "base": null, "refs": {} }, "AssociateDefaultVocabularyResponse": { "base": null, "refs": {} }, "AssociateFlowRequest": { "base": null, "refs": {} }, "AssociateFlowResponse": { "base": null, "refs": {} }, "AssociateInstanceStorageConfigRequest": { "base": null, "refs": {} }, "AssociateInstanceStorageConfigResponse": { "base": null, "refs": {} }, "AssociateLambdaFunctionRequest": { "base": null, "refs": {} }, "AssociateLexBotRequest": { "base": null, "refs": {} }, "AssociatePhoneNumberContactFlowRequest": { "base": null, "refs": {} }, "AssociateQueueQuickConnectsRequest": { "base": null, "refs": {} }, "AssociateRoutingProfileQueuesRequest": { "base": null, "refs": {} }, "AssociateSecurityKeyRequest": { "base": null, "refs": {} }, "AssociateSecurityKeyResponse": { "base": null, "refs": {} }, "AssociateTrafficDistributionGroupUserRequest": { "base": null, "refs": {} }, "AssociateTrafficDistributionGroupUserResponse": { "base": null, "refs": {} }, "AssociateUserProficienciesRequest": { "base": null, "refs": {} }, "AssociatedContactSummary": { "base": "Contact summary of a contact in contact tree associated with unique identifier.
", "refs": { "AssociatedContactSummaryList$member": null } }, "AssociatedContactSummaryList": { "base": null, "refs": { "ListAssociatedContactsResponse$ContactSummaryList": "List of the contact summary for all the contacts in contact tree associated with unique identifier.
" } }, "AssociatedQueueIdList": { "base": null, "refs": { "RoutingProfile$AssociatedQueueIds": "The IDs of the associated queue.
" } }, "AssociationId": { "base": null, "refs": { "AssociateInstanceStorageConfigResponse$AssociationId": "The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
", "AssociateSecurityKeyResponse$AssociationId": "The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
", "DescribeInstanceStorageConfigRequest$AssociationId": "The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
", "DisassociateInstanceStorageConfigRequest$AssociationId": "The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
", "DisassociateSecurityKeyRequest$AssociationId": "The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
", "InstanceStorageConfig$AssociationId": "The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
", "SecurityKey$AssociationId": "The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
", "UpdateInstanceStorageConfigRequest$AssociationId": "The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
" } }, "AttachedFile": { "base": "Information about the attached file.
", "refs": { "AttachedFilesList$member": null } }, "AttachedFileError": { "base": "Error describing a failure to retrieve attached file metadata through BatchGetAttachedFileMetadata action.
", "refs": { "AttachedFileErrorsList$member": null } }, "AttachedFileErrorsList": { "base": null, "refs": { "BatchGetAttachedFileMetadataResponse$Errors": "List of errors of attached files that could not be retrieved.
" } }, "AttachedFileInvalidRequestExceptionReason": { "base": null, "refs": { "InvalidRequestExceptionReason$AttachedFileInvalidRequestExceptionReason": "Reason why the StartAttachedFiledUpload request was invalid.
" } }, "AttachedFileServiceQuotaExceededExceptionReason": { "base": null, "refs": { "ServiceQuotaExceededExceptionReason$AttachedFileServiceQuotaExceededExceptionReason": "Total file size of all files or total number of files exceeds the service quota
" } }, "AttachedFilesList": { "base": null, "refs": { "BatchGetAttachedFileMetadataResponse$Files": "List of attached files that were successfully retrieved.
" } }, "AttachmentName": { "base": null, "refs": { "RealTimeContactAnalysisAttachment$AttachmentName": "A case-sensitive name of the attachment being uploaded. Can be redacted.
" } }, "AttachmentReference": { "base": "Information about a reference when the referenceType is ATTACHMENT. Otherwise, null.
Information about the reference when the referenceType is ATTACHMENT. Otherwise, null.
The attendee information, including attendee ID and join token.
", "refs": { "ConnectionData$Attendee": "The attendee information, including attendee ID and join token.
" } }, "AttendeeId": { "base": null, "refs": { "Attendee$AttendeeId": "The Amazon Chime SDK attendee ID.
" } }, "Attribute": { "base": "A toggle for an individual feature at the instance level.
", "refs": { "AttributesList$member": null, "DescribeInstanceAttributeResponse$Attribute": "The type of attribute.
" } }, "AttributeAndCondition": { "base": "A list of conditions which would be applied together with an AND condition.
A list of conditions which would be applied together with an AND condition.
An object to specify the predefined attribute condition.
", "refs": { "Expression$AttributeCondition": "An object to specify the predefined attribute condition.
", "Expression$NotAttributeCondition": null } }, "AttributeName": { "base": null, "refs": { "Attributes$key": null } }, "AttributeOrConditionList": { "base": null, "refs": { "ControlPlaneUserAttributeFilter$OrConditions": "A list of conditions which would be applied together with an OR condition.
The attributes of the contact.
", "ContactDataRequest$Attributes": "List of attributes to be stored in a contact.
", "CreateContactRequest$Attributes": "A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
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.
", "GetContactAttributesResponse$Attributes": "Information about the attributes.
", "NewSessionDetails$Attributes": "A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes.
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.
", "StartChatContactRequest$Attributes": "A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes.
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.
", "StartEmailContactRequest$Attributes": "A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
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.
", "StartOutboundChatContactRequest$Attributes": "A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
", "StartOutboundVoiceContactRequest$Attributes": "A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
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.
", "StartTaskContactRequest$Attributes": "A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
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.
", "StartWebRTCContactRequest$Attributes": "A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, -, and _ characters.
", "TemplateAttributes$CustomAttributes": "An object that specifies the custom attributes values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template.
", "UpdateContactAttributesRequest$Attributes": "The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes.
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.
In the Set contact attributes block, when the attributes for a contact exceed 32 KB, the contact is routed down the Error branch of the flow. As a mitigation, consider the following options:
Remove unnecessary attributes by setting their values to empty.
If the attributes are only used in one flow and don't need to be referred to outside of that flow (for example, by a Lambda or another flow), then use flow attributes. This way you aren't needlessly persisting the 32 KB of information from one flow to another. For more information, see Flow block: Set contact attributes in the Amazon Connect Administrator Guide.
The attribute types.
" } }, "AudioFeatures": { "base": "Has audio-specific configurations as the operating parameter for Echo Reduction.
", "refs": { "MeetingFeaturesConfiguration$Audio": "The configuration settings for the audio features available to a meeting.
" } }, "AudioQualityMetricsInfo": { "base": "Contains information for score and potential quality issues for Audio
", "refs": { "AgentQualityMetrics$Audio": "Information about the audio quality of the Agent
", "CustomerQualityMetrics$Audio": "Information about the audio quality of the Customer
" } }, "AudioQualityScore": { "base": null, "refs": { "AudioQualityMetricsInfo$QualityScore": "Number measuring the estimated quality of the media connection.
" } }, "AuthenticationError": { "base": null, "refs": { "UpdateParticipantAuthenticationRequest$Error": "The error query parameter provided by Cognito in the redirectUri.
The error_description parameter provided by Cognito in the redirectUri.
This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Information about an authentication profile. An authentication profile is a resource that stores the authentication settings for users in your contact center. You use authentication profiles to set up IP address range restrictions and session timeouts. For more information, see Set IP address restrictions or session timeouts.
", "refs": { "DescribeAuthenticationProfileResponse$AuthenticationProfile": "The authentication profile object being described.
" } }, "AuthenticationProfileDescription": { "base": null, "refs": { "AuthenticationProfile$Description": "The description for the authentication profile.
", "UpdateAuthenticationProfileRequest$Description": "The description for the authentication profile.
" } }, "AuthenticationProfileId": { "base": null, "refs": { "AuthenticationProfile$Id": "A unique identifier for the authentication profile.
", "AuthenticationProfileSummary$Id": "The unique identifier of the authentication profile.
", "DescribeAuthenticationProfileRequest$AuthenticationProfileId": "A unique identifier for the authentication profile.
", "UpdateAuthenticationProfileRequest$AuthenticationProfileId": "A unique identifier for the authentication profile.
" } }, "AuthenticationProfileName": { "base": null, "refs": { "AuthenticationProfile$Name": "The name for the authentication profile.
", "AuthenticationProfileSummary$Name": "The name of the authentication profile summary.
", "UpdateAuthenticationProfileRequest$Name": "The name for the authentication profile.
" } }, "AuthenticationProfileSummary": { "base": "This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
A summary of a given authentication profile.
", "refs": { "AuthenticationProfileSummaryList$member": null } }, "AuthenticationProfileSummaryList": { "base": null, "refs": { "ListAuthenticationProfilesResponse$AuthenticationProfileSummaryList": "A summary of a given authentication profile.
" } }, "AuthorizationCode": { "base": null, "refs": { "UpdateParticipantAuthenticationRequest$Code": "The code query parameter provided by Cognito in the redirectUri.
The Auto accept setting.
" } }, "AvailableNumberSummary": { "base": "Information about available phone numbers.
", "refs": { "AvailableNumbersList$member": null } }, "AvailableNumbersList": { "base": null, "refs": { "SearchAvailablePhoneNumbersResponse$AvailableNumbersList": "A list of available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.
" } }, "AwsRegion": { "base": null, "refs": { "Distribution$Region": "The Amazon Web Services Region where the traffic is distributed.
", "ReplicateInstanceRequest$ReplicaRegion": "The Amazon Web Services Region where to replicate the Amazon Connect instance.
", "ReplicationConfiguration$SourceRegion": "The Amazon Web Services Region where the source Amazon Connect instance was created. This is the Region where the ReplicateInstance API was called to start the replication process.
", "ReplicationStatusSummary$Region": "The Amazon Web Services Region. This can be either the source or the replica Region, depending where it appears in the summary list.
", "SignInDistribution$Region": "The Amazon Web Services Region of the sign in distribution.
" } }, "BatchAssociateAnalyticsDataSetRequest": { "base": null, "refs": {} }, "BatchAssociateAnalyticsDataSetResponse": { "base": null, "refs": {} }, "BatchDisassociateAnalyticsDataSetRequest": { "base": null, "refs": {} }, "BatchDisassociateAnalyticsDataSetResponse": { "base": null, "refs": {} }, "BatchGetAttachedFileMetadataRequest": { "base": null, "refs": {} }, "BatchGetAttachedFileMetadataResponse": { "base": null, "refs": {} }, "BatchGetFlowAssociationRequest": { "base": null, "refs": {} }, "BatchGetFlowAssociationResponse": { "base": null, "refs": {} }, "BatchPutContactRequest": { "base": null, "refs": {} }, "BatchPutContactResponse": { "base": null, "refs": {} }, "BehaviorType": { "base": null, "refs": { "CrossChannelBehavior$BehaviorType": "Specifies the other channels that can be routed to an agent handling their current channel.
" } }, "Body": { "base": null, "refs": { "InboundRawMessage$Body": "The email message body.
", "OutboundRawMessage$Body": "The email message body.
" } }, "Boolean": { "base": null, "refs": { "AnswerMachineDetectionConfig$EnableAnswerMachineDetection": "The flag to indicate if answer machine detection analysis needs to be performed for a voice call. If set to true, TrafficType must be set as CAMPAIGN.
Wait for the answering machine prompt.
", "AuthenticationProfile$IsDefault": "Shows whether the authentication profile is the default authentication profile for the Amazon Connect instance. The default authentication profile applies to all agents in an Amazon Connect instance, unless overridden by another authentication profile.
", "AuthenticationProfileSummary$IsDefault": "Shows whether the authentication profile is the default authentication profile for the Amazon Connect instance. The default authentication profile applies to all agents in an Amazon Connect instance, unless overridden by another authentication profile.
", "EvaluationAnswerData$NotApplicable": "The flag to mark the question as not applicable.
", "EvaluationFormNumericQuestionOption$AutomaticFail": "The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
", "EvaluationFormQuestion$NotApplicableEnabled": "The flag to enable not applicable answers to the question.
", "EvaluationFormSingleSelectQuestionOption$AutomaticFail": "The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
", "EvaluationScore$NotApplicable": "The flag to mark the item as not applicable for scoring.
", "EvaluationScore$AutomaticFail": "The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this flag will be true.
", "FieldValueUnion$BooleanValue": "A Boolean number value type.
", "MetricFilterV2$Negate": "If set to true, the API response contains results that filter out the results matched by the metric-level filters condition. By default, Negate is set to false.
Whether this a default routing profile.
", "SignInDistribution$Enabled": "Whether sign in distribution is enabled.
", "TrafficDistributionGroup$IsDefault": "Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by the DeleteTrafficDistributionGroup API. The default traffic distribution group is deleted as part of the process for deleting a replica.
The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.
Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by the DeleteTrafficDistributionGroup API. The default traffic distribution group is deleted as part of the process for deleting a replica.
A number indicating the reset order of the agent status.
" } }, "BotName": { "base": null, "refs": { "DisassociateLexBotRequest$BotName": "The name of the Amazon Lex bot. Maximum character limit of 50.
", "LexBot$Name": "The name of the Amazon Lex bot.
" } }, "BoxedBoolean": { "base": null, "refs": { "UpdateEvaluationFormRequest$CreateNewVersion": "A flag indicating whether the operation must create a new version.
" } }, "BucketName": { "base": null, "refs": { "S3Config$BucketName": "The S3 bucket name.
" } }, "Campaign": { "base": "Information associated with a campaign.
", "refs": { "Contact$Campaign": null, "ContactDataRequest$Campaign": "Structure to store information associated with a campaign.
" } }, "CampaignId": { "base": null, "refs": { "Campaign$CampaignId": "A unique identifier for a campaign.
", "SourceCampaign$CampaignId": "A unique identifier for a campaign.
", "StartOutboundVoiceContactRequest$CampaignId": "The campaign identifier of the outbound communication.
" } }, "CaseSlaConfiguration": { "base": "The SLA configuration for Case SlaAssignmentType.
", "refs": { "AssignSlaActionDefinition$CaseSlaConfiguration": "The SLA configuration for Case SLA Assignment.
" } }, "Channel": { "base": null, "refs": { "AgentContactReference$Channel": "The channel of the contact.
", "AssociatedContactSummary$Channel": "How the contact reached your contact center.
", "ChannelList$member": null, "ChannelToCountMap$key": null, "Channels$member": null, "Contact$Channel": "How the contact reached your contact center.
", "ContactSearchSummary$Channel": "How the contact reached your contact center.
", "CreateContactRequest$Channel": "The channel for the contact.
The CHAT channel is not supported. The following information is incorrect. We're working to correct it.
The channel used for grouping and filters.
", "MediaConcurrency$Channel": "The channels that agents can handle in the Contact Control Panel (CCP).
", "RoutingProfileQueueConfigSummary$Channel": "The channels this queue supports.
", "RoutingProfileQueueReference$Channel": "The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
" } }, "ChannelList": { "base": null, "refs": { "SearchCriteria$Channels": "The list of channels associated with contacts.
" } }, "ChannelToCountMap": { "base": null, "refs": { "UserData$AvailableSlotsByChannel": "A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots.
", "UserData$MaxSlotsByChannel": "A map of maximum slots by channel. The key is a channel name. The value is an integer: the maximum number of slots. This is calculated from MediaConcurrency of the RoutingProfile assigned to the agent.
A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots.
" } }, "Channels": { "base": null, "refs": { "Filters$Channels": "The channel to use to filter the metrics.
" } }, "ChatContactMetrics": { "base": "Information about the overall participant interactions at the contact level.
", "refs": { "ChatMetrics$ChatContactMetrics": "Information about the overall participant interactions at the contact level.
" } }, "ChatContent": { "base": null, "refs": { "ChatEvent$Content": "Content of the message or event. This is required when Type is MESSAGE and for certain ContentTypes when Type is EVENT.
For allowed message content, see the Content parameter in the SendMessage topic in the Amazon Connect Participant Service API Reference.
For allowed event content, see the Content parameter in the SendEvent topic in the Amazon Connect Participant Service API Reference.
The content of the chat message.
For text/plain and text/markdown, the Length Constraints are Minimum of 1, Maximum of 1024.
For application/json, the Length Constraints are Minimum of 1, Maximum of 12000.
For application/vnd.amazonaws.connect.message.interactive.response, the Length Constraints are Minimum of 1, Maximum of 12288.
Type of content. This is required when Type is MESSAGE or EVENT.
For allowed message content types, see the ContentType parameter in the SendMessage topic in the Amazon Connect Participant Service API Reference.
For allowed event content types, see the ContentType parameter in the SendEvent topic in the Amazon Connect Participant Service API Reference.
The type of the content. Supported types are text/plain, text/markdown, application/json, and application/vnd.amazonaws.connect.message.interactive.response.
The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).
", "StartOutboundChatContactRequest$ChatDurationInMinutes": "The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).
" } }, "ChatEvent": { "base": "Chat integration event containing payload to perform different chat actions such as:
Sending a chat message
Sending a chat event, such as typing
Disconnecting from a chat
Chat integration event payload
" } }, "ChatEventType": { "base": null, "refs": { "ChatEvent$Type": "Type of chat integration event.
" } }, "ChatMessage": { "base": "A chat message.
", "refs": { "StartChatContactRequest$InitialMessage": "The initial message to be sent to the newly created chat.
", "StartOutboundChatContactRequest$InitialSystemMessage": null } }, "ChatMetrics": { "base": "Information about how agent, bot, and customer interact in a chat contact.
", "refs": { "Contact$ChatMetrics": "Information about how agent, bot, and customer interact in a chat contact.
" } }, "ChatParticipantRoleConfig": { "base": "Configuration information for the chat participant role.
", "refs": { "UpdateParticipantRoleConfigChannelInfo$Chat": "Configuration information for the chat participant role.
" } }, "ChatStreamingConfiguration": { "base": "The streaming configuration, such as the Amazon SNS streaming endpoint.
", "refs": { "NewSessionDetails$StreamingConfiguration": null, "StartContactStreamingRequest$ChatStreamingConfiguration": "The streaming configuration, such as the Amazon SNS streaming endpoint.
" } }, "ChatStreamingEndpointARN": { "base": null, "refs": { "ChatStreamingConfiguration$StreamingEndpointArn": "The Amazon Resource Name (ARN) of the standard Amazon SNS topic. The Amazon Resource Name (ARN) of the streaming endpoint that is used to publish real-time message streaming for chat conversations.
" } }, "ClaimPhoneNumberRequest": { "base": null, "refs": {} }, "ClaimPhoneNumberResponse": { "base": null, "refs": {} }, "ClaimedPhoneNumberSummary": { "base": "Information about a phone number that has been claimed to your Amazon Connect instance or traffic distribution group.
", "refs": { "DescribePhoneNumberResponse$ClaimedPhoneNumberSummary": "Information about a phone number that's been claimed to your Amazon Connect instance or traffic distribution group.
" } }, "ClientToken": { "base": null, "refs": { "AssociateApprovedOriginRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "AssociateBotRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "AssociateInstanceStorageConfigRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "AssociateLambdaFunctionRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "AssociateLexBotRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "AssociateSecurityKeyRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "BatchPutContactRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "ClaimPhoneNumberRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "CreateContactRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "CreateEmailAddressRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "CreateEvaluationFormRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "CreateInstanceRequest$ClientToken": "The idempotency token.
", "CreateParticipantRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "CreatePersistentContactAssociationRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "CreatePushNotificationRegistrationRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "CreateRuleRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "CreateTaskTemplateRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "CreateTrafficDistributionGroupRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "CreateVocabularyRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.
", "DeleteInstanceRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "DisassociateApprovedOriginRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "DisassociateBotRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "DisassociateInstanceStorageConfigRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "DisassociateLambdaFunctionRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "DisassociateLexBotRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "DisassociateSecurityKeyRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "ImportPhoneNumberRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "MonitorContactRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "ReleasePhoneNumberRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "ReplicateInstanceRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "SendOutboundEmailRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "StartAttachedFileUploadRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "StartChatContactRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "StartContactEvaluationRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "StartContactStreamingRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "StartEmailContactRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "StartOutboundChatContactRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.
", "StartOutboundEmailContactRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "StartOutboundVoiceContactRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.
", "StartScreenSharingRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "StartTaskContactRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "StartWebRTCContactRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.
", "TransferContactRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "UpdateEmailAddressMetadataRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "UpdateEvaluationFormRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "UpdateInstanceAttributeRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "UpdateInstanceStorageConfigRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "UpdatePhoneNumberMetadataRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "UpdatePhoneNumberRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
" } }, "CommonAttributeAndCondition": { "base": "A list of conditions which would be applied together with an AND condition.
A list of conditions which would be applied together with an AND condition.
A list of conditions which would be applied together with an OR condition.
The description of the hours of operation override.
", "HoursOfOperationOverride$Description": "The description of the hours of operation override.
", "UpdateHoursOfOperationOverrideRequest$Description": "The description of the hours of operation override.
" } }, "CommonHumanReadableName": { "base": null, "refs": { "CreateHoursOfOperationOverrideRequest$Name": "The name of the hours of operation override.
", "HoursOfOperationOverride$Name": "The name of the hours of operation override.
", "UpdateHoursOfOperationOverrideRequest$Name": "The name of the hours of operation override.
" } }, "CommonNameLength127": { "base": null, "refs": { "CreateHoursOfOperationRequest$Name": "The name of the hours of operation.
", "CreatePromptRequest$Name": "The name of the prompt.
", "CreateQueueRequest$Name": "The name of the queue.
", "HoursOfOperation$Name": "The name for the hours of operation.
", "Prompt$Name": "The name of the prompt.
", "Queue$Name": "The name of the queue.
", "UpdateHoursOfOperationRequest$Name": "The name of the hours of operation.
", "UpdatePromptRequest$Name": "The name of the prompt.
", "UpdateQueueNameRequest$Name": "The name of the queue.
" } }, "Comparison": { "base": null, "refs": { "Threshold$Comparison": "The type of comparison. Only \"less than\" (LT) comparisons are supported.
" } }, "ComparisonOperator": { "base": null, "refs": { "AttributeCondition$ComparisonOperator": "The operator of the condition.
" } }, "CompleteAttachedFileUploadRequest": { "base": "Request to CompleteAttachedFileUpload API", "refs": {} }, "CompleteAttachedFileUploadResponse": { "base": "Response from CompleteAttachedFileUpload API", "refs": {} }, "Concurrency": { "base": null, "refs": { "MediaConcurrency$Concurrency": "The number of contacts an agent can have on a channel simultaneously.
Valid Range for VOICE: Minimum value of 1. Maximum value of 1.
Valid Range for CHAT: Minimum value of 1. Maximum value of 10.
Valid Range for TASK: Minimum value of 1. Maximum value of 10.
A leaf node condition which can be used to specify a ProficiencyName, ProficiencyValue and ProficiencyLimit.
", "refs": { "Conditions$member": null } }, "ConditionalOperationFailedException": { "base": "Request processing failed because dependent condition failed.
", "refs": {} }, "Conditions": { "base": null, "refs": { "ListCondition$Conditions": "A list of Condition objects which would be applied together with an AND condition.
" } }, "ConflictException": { "base": "Operation cannot be performed at this time as there is a conflict with another operation or contact state.
", "refs": {} }, "ConnectionData": { "base": "Information required to join the call.
", "refs": { "StartWebRTCContactResponse$ConnectionData": "Information required for the client application (mobile application or website) to connect to the call.
" } }, "Contact": { "base": "Contains information about a contact.
", "refs": { "DescribeContactResponse$Contact": "Information about the contact.
" } }, "ContactAnalysis": { "base": "A structure that defines search criteria for contacts using analysis outputs from Amazon Connect Contact Lens.
", "refs": { "SearchCriteria$ContactAnalysis": "Search criteria based on analysis outputs from Amazon Connect Contact Lens.
" } }, "ContactConfiguration": { "base": "The contact configuration for push notification registration.
", "refs": { "CreatePushNotificationRegistrationRequest$ContactConfiguration": "The contact configuration for push notification registration.
" } }, "ContactDataRequest": { "base": "Request object with information to create a contact.
", "refs": { "ContactDataRequestList$member": null } }, "ContactDataRequestList": { "base": null, "refs": { "BatchPutContactRequest$ContactDataRequestList": "List of individual contact requests.
" } }, "ContactDetailDescription": { "base": null, "refs": { "ContactDetails$Description": "Teh description of the contact details.
" } }, "ContactDetailName": { "base": null, "refs": { "ContactDetails$Name": "The name of the contact details.
" } }, "ContactDetails": { "base": "A map of string key/value pairs that contain user-defined attributes which are lightly typed within the contact. This object is used only for task contacts.
", "refs": { "Contact$ContactDetails": "A map of string key/value pairs that contain user-defined attributes which are lightly typed within the contact. This object is used only for task contacts.
" } }, "ContactEvaluation": { "base": "Information about the contact evaluations where the key is the FormId, which is a unique identifier for the form.
", "refs": { "ContactEvaluations$value": null } }, "ContactEvaluations": { "base": null, "refs": { "Contact$ContactEvaluations": "Information about the contact evaluations where the key is the FormId, which is a unique identifier for the form.
" } }, "ContactFilter": { "base": "Filters user data based on the contact information that is associated to the users. It contains a list of contact states.
", "refs": { "UserDataFilters$ContactFilter": "A filter for the user data based on the contact information that is associated to the user. It contains a list of contact states.
" } }, "ContactFlow": { "base": "Contains information about a flow.
", "refs": { "ContactFlowSearchSummaryList$member": null, "DescribeContactFlowResponse$ContactFlow": "Information about the flow.
" } }, "ContactFlowContent": { "base": null, "refs": { "ContactFlow$Content": "The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
Length Constraints: Minimum length of 1. Maximum length of 256000.
", "CreateContactFlowRequest$Content": "The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
Length Constraints: Minimum length of 1. Maximum length of 256000.
", "UpdateContactFlowContentRequest$Content": "The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
Length Constraints: Minimum length of 1. Maximum length of 256000.
" } }, "ContactFlowDescription": { "base": null, "refs": { "ContactFlow$Description": "The description of the flow.
", "ContactFlow$VersionDescription": "The description of the flow version.
", "ContactFlowVersionSummary$VersionDescription": "The description of the flow version.
", "CreateContactFlowRequest$Description": "The description of the flow.
", "CreateContactFlowVersionRequest$Description": "The description of the flow version.
", "UpdateContactFlowMetadataRequest$Description": "The description of the flow.
", "UpdateContactFlowNameRequest$Description": "The description of the flow.
" } }, "ContactFlowId": { "base": null, "refs": { "AssociatePhoneNumberContactFlowRequest$ContactFlowId": "The identifier of the flow.
", "ContactFlow$Id": "The identifier of the flow.
", "ContactFlowSummary$Id": "The identifier of the flow.
", "CreateContactFlowResponse$ContactFlowId": "The identifier of the flow.
", "CreateTaskTemplateRequest$ContactFlowId": "The identifier of the flow that runs by default when a task is created by referencing this template.
", "CreateTaskTemplateRequest$SelfAssignFlowId": "The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.
", "DeleteContactFlowRequest$ContactFlowId": "The identifier of the flow.
", "DescribeContactFlowRequest$ContactFlowId": "The identifier of the flow.
", "GetTaskTemplateResponse$ContactFlowId": "The identifier of the flow that runs by default when a task is created by referencing this template.
", "GetTaskTemplateResponse$SelfAssignFlowId": "The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.
", "OutboundCallerConfig$OutboundFlowId": "The outbound whisper flow to be used during an outbound call.
", "PauseContactRequest$ContactFlowId": "The identifier of the flow.
", "QueueQuickConnectConfig$ContactFlowId": "The identifier of the flow.
", "ResumeContactRequest$ContactFlowId": "The identifier of the flow.
", "StartChatContactRequest$ContactFlowId": "The identifier of the flow for initiating the chat. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
", "StartEmailContactRequest$ContactFlowId": "The identifier of the flow for initiating the emails. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
", "StartOutboundChatContactRequest$ContactFlowId": "The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/123ec456-a007-89c0-1234-xxxxxxxxxxxx
The identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
", "StartTaskContactRequest$ContactFlowId": "The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
", "StartWebRTCContactRequest$ContactFlowId": "The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
", "TaskActionDefinition$ContactFlowId": "The identifier of the flow.
", "TransferContactRequest$ContactFlowId": "The identifier of the flow.
", "UpdateContactFlowContentRequest$ContactFlowId": "The identifier of the flow.
", "UpdateContactFlowMetadataRequest$ContactFlowId": "The identifier of the flow.
", "UpdateContactFlowNameRequest$ContactFlowId": "The identifier of the flow.
", "UpdateTaskTemplateRequest$ContactFlowId": "The identifier of the flow that runs by default when a task is created by referencing this template.
", "UpdateTaskTemplateRequest$SelfAssignFlowId": "The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.
", "UpdateTaskTemplateResponse$ContactFlowId": "The identifier of the flow that runs by default when a task is created by referencing this template.
", "UpdateTaskTemplateResponse$SelfAssignFlowId": "The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.
", "UserQuickConnectConfig$ContactFlowId": "The identifier of the flow.
" } }, "ContactFlowModule": { "base": "Contains information about a flow module.
", "refs": { "ContactFlowModuleSearchSummaryList$member": null, "DescribeContactFlowModuleResponse$ContactFlowModule": "Information about the flow module.
" } }, "ContactFlowModuleContent": { "base": null, "refs": { "ContactFlowModule$Content": "The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
", "CreateContactFlowModuleRequest$Content": "The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
", "UpdateContactFlowModuleContentRequest$Content": "The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
" } }, "ContactFlowModuleDescription": { "base": null, "refs": { "ContactFlowModule$Description": "The description of the flow module.
", "CreateContactFlowModuleRequest$Description": "The description of the flow module.
", "UpdateContactFlowModuleMetadataRequest$Description": "The description of the flow module.
" } }, "ContactFlowModuleId": { "base": null, "refs": { "ContactFlowModule$Id": "The identifier of the flow module.
", "ContactFlowModuleSummary$Id": "The identifier of the flow module.
", "CreateContactFlowModuleResponse$Id": "The identifier of the flow module.
", "DeleteContactFlowModuleRequest$ContactFlowModuleId": "The identifier of the flow module.
", "DescribeContactFlowModuleRequest$ContactFlowModuleId": "The identifier of the flow module.
", "UpdateContactFlowModuleContentRequest$ContactFlowModuleId": "The identifier of the flow module.
", "UpdateContactFlowModuleMetadataRequest$ContactFlowModuleId": "The identifier of the flow module.
" } }, "ContactFlowModuleName": { "base": null, "refs": { "ContactFlowModule$Name": "The name of the flow module.
", "ContactFlowModuleSummary$Name": "The name of the flow module.
", "CreateContactFlowModuleRequest$Name": "The name of the flow module.
", "UpdateContactFlowModuleMetadataRequest$Name": "The name of the flow module.
" } }, "ContactFlowModuleSearchConditionList": { "base": null, "refs": { "ContactFlowModuleSearchCriteria$OrConditions": "A list of conditions which would be applied together with an OR condition.
A list of conditions which would be applied together with an AND condition.
The search criteria to be used to return flow modules.
", "refs": { "ContactFlowModuleSearchConditionList$member": null, "SearchContactFlowModulesRequest$SearchCriteria": "The search criteria to be used to return flow modules.
The name and description fields support \"contains\" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results.
The search criteria to be used to return flow modules.
", "refs": { "SearchContactFlowModulesRequest$SearchFilter": "Filters to be applied to search results.
" } }, "ContactFlowModuleSearchSummaryList": { "base": null, "refs": { "SearchContactFlowModulesResponse$ContactFlowModules": "The search criteria to be used to return flow modules.
" } }, "ContactFlowModuleState": { "base": null, "refs": { "ContactFlowModule$State": "The type of flow module.
", "ContactFlowModuleSearchCriteria$StateCondition": "The state of the flow.
", "ContactFlowModuleSummary$State": "The type of flow module.
", "ListContactFlowModulesRequest$ContactFlowModuleState": "The state of the flow module.
", "UpdateContactFlowModuleMetadataRequest$State": "The state of flow module.
" } }, "ContactFlowModuleStatus": { "base": null, "refs": { "ContactFlowModule$Status": "The status of the flow module.
", "ContactFlowModuleSearchCriteria$StatusCondition": "The status of the flow.
" } }, "ContactFlowModuleSummary": { "base": "Contains summary information about a flow.
", "refs": { "ContactFlowModulesSummaryList$member": null } }, "ContactFlowModulesSummaryList": { "base": null, "refs": { "ListContactFlowModulesResponse$ContactFlowModulesSummaryList": "Information about the flow module.
" } }, "ContactFlowName": { "base": null, "refs": { "ContactFlow$Name": "The name of the flow.
", "ContactFlowSummary$Name": "The name of the flow.
", "CreateContactFlowRequest$Name": "The name of the flow.
", "UpdateContactFlowMetadataRequest$Name": "The name of the flow.
", "UpdateContactFlowNameRequest$Name": "The name of the flow.
" } }, "ContactFlowNotPublishedException": { "base": "The flow has not been published.
", "refs": {} }, "ContactFlowSearchConditionList": { "base": null, "refs": { "ContactFlowSearchCriteria$OrConditions": "A list of conditions which would be applied together with an OR condition.
A list of conditions which would be applied together with an AND condition.
The search criteria to be used to return flows.
", "refs": { "ContactFlowSearchConditionList$member": null, "SearchContactFlowsRequest$SearchCriteria": "The search criteria to be used to return flows.
The name and description fields support \"contains\" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results.
Filters to be applied to search results.
", "refs": { "SearchContactFlowsRequest$SearchFilter": "Filters to be applied to search results.
" } }, "ContactFlowSearchSummaryList": { "base": null, "refs": { "SearchContactFlowsResponse$ContactFlows": "Information about the flows.
" } }, "ContactFlowState": { "base": null, "refs": { "ContactFlow$State": "The type of flow.
", "ContactFlowSearchCriteria$StateCondition": "The state of the flow.
", "ContactFlowSummary$ContactFlowState": "The type of flow.
", "UpdateContactFlowMetadataRequest$ContactFlowState": "The state of flow.
" } }, "ContactFlowStatus": { "base": null, "refs": { "ContactFlow$Status": "The status of the flow.
", "ContactFlowSearchCriteria$StatusCondition": "The status of the flow.
", "ContactFlowSummary$ContactFlowStatus": "The status of the flow.
", "CreateContactFlowRequest$Status": "Indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. the SAVED status does not initiate validation of the content. SAVED | PUBLISHED.
Contains summary information about a flow.
You can also create and update flows using the Amazon Connect Flow language.
", "refs": { "ContactFlowSummaryList$member": null } }, "ContactFlowSummaryList": { "base": null, "refs": { "ListContactFlowsResponse$ContactFlowSummaryList": "Information about the flows.
" } }, "ContactFlowType": { "base": null, "refs": { "ContactFlow$Type": "The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
", "ContactFlowSearchCriteria$TypeCondition": "The type of flow.
", "ContactFlowSummary$ContactFlowType": "The type of flow.
", "ContactFlowTypes$member": null, "CreateContactFlowRequest$Type": "The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
" } }, "ContactFlowTypes": { "base": null, "refs": { "ListContactFlowsRequest$ContactFlowTypes": "The type of flow.
" } }, "ContactFlowVersionSummary": { "base": "A summary of a flow version's metadata.
", "refs": { "ContactFlowVersionSummaryList$member": null } }, "ContactFlowVersionSummaryList": { "base": null, "refs": { "ListContactFlowVersionsResponse$ContactFlowVersionSummaryList": "A list of flow version summaries.
" } }, "ContactId": { "base": null, "refs": { "AgentContactReference$ContactId": "The identifier of the contact in this instance of Amazon Connect.
", "AssociatedContactSummary$ContactId": "The identifier of the contact in this instance of Amazon Connect.
", "AssociatedContactSummary$InitialContactId": "If this contact is related to other contacts, this is the ID of the initial contact.
", "AssociatedContactSummary$PreviousContactId": "If this contact is not the first contact, this is the ID of the previous contact.
", "AssociatedContactSummary$RelatedContactId": "The contactId that is related to this contact.
", "Contact$Id": "The identifier for the contact.
", "Contact$InitialContactId": "If this contact is related to other contacts, this is the ID of the initial contact.
", "Contact$PreviousContactId": "If this contact is not the first contact, this is the ID of the previous contact.
", "Contact$ContactAssociationId": "This is the root contactId which is used as a unique identifier for all subsequent contacts in a contact tree.
", "Contact$RelatedContactId": "The contactId that is related to this contact.
", "ContactConfiguration$ContactId": "The identifier of the contact within the Amazon Connect instance.
", "ContactSearchSummary$Id": "The identifier of the contact summary.
", "ContactSearchSummary$InitialContactId": "If this contact is related to other contacts, this is the ID of the initial contact.
", "ContactSearchSummary$PreviousContactId": "If this contact is not the first contact, this is the ID of the previous contact.
", "CreateContactRequest$RelatedContactId": "The identifier of the contact in this instance of Amazon Connect.
", "CreateContactRequest$PreviousContactId": "The ID of the previous contact when creating a transfer contact. This value can be provided only for external audio contacts. For more information, see Integrate Amazon Connect Contact Lens with external voice systems in the Amazon Connect Administrator Guide.
", "CreateContactResponse$ContactId": "The identifier of the contact in this instance of Amazon Connect.
", "CreateParticipantRequest$ContactId": "The identifier of the contact in this instance of Amazon Connect. Supports contacts in the CHAT channel and VOICE (WebRTC) channels. For WebRTC calls, this should be the initial contact ID that was generated when the contact was first created (from the StartWebRTCContact API) in the VOICE channel
", "CreatePersistentContactAssociationRequest$InitialContactId": "This is the contactId of the current contact that the CreatePersistentContactAssociation API is being called from.
The contactId from which a persistent chat session must be started.
", "CreatePersistentContactAssociationResponse$ContinuedFromContactId": "The contactId from which a persistent chat session is started. This field is populated only for persistent chat.
", "DeletePushNotificationRegistrationRequest$ContactId": "The identifier of the contact within the Amazon Connect instance.
", "DescribeContactRequest$ContactId": "The identifier of the contact.
", "DismissUserContactRequest$ContactId": "The identifier of the contact.
", "EvaluationMetadata$ContactId": "The identifier of the contact in this instance of Amazon Connect.
", "GetContactAttributesRequest$InitialContactId": "The identifier of the initial contact.
", "GetContactMetricsResponse$Id": "The unique identifier of the contact for which metrics were retrieved.
", "ListAssociatedContactsRequest$ContactId": "The identifier of the contact in this instance of Amazon Connect.
", "ListContactEvaluationsRequest$ContactId": "The identifier of the contact in this instance of Amazon Connect.
", "ListContactReferencesRequest$ContactId": "The identifier of the initial contact.
", "ListRealtimeContactAnalysisSegmentsV2Request$ContactId": "The identifier of the contact in this instance of Amazon Connect.
", "MonitorContactRequest$ContactId": "The identifier of the contact.
", "MonitorContactResponse$ContactId": "The identifier of the contact.
", "PauseContactRequest$ContactId": "The identifier of the contact.
", "PersistentChat$SourceContactId": "The contactId from which a persistent chat session must be started.
", "ResumeContactRecordingRequest$ContactId": "The identifier of the contact.
", "ResumeContactRecordingRequest$InitialContactId": "The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
", "ResumeContactRequest$ContactId": "The identifier of the contact.
", "SendChatIntegrationEventResponse$InitialContactId": "Identifier of chat contact used to handle integration event. This may be null if the integration event is not valid without an already existing chat contact.
", "StartChatContactRequest$RelatedContactId": "The unique identifier for an Amazon Connect contact. This identifier is related to the chat starting.
You cannot provide data for both RelatedContactId and PersistentChat.
The identifier of this contact within the Amazon Connect instance.
", "StartChatContactResponse$ContinuedFromContactId": "The contactId from which a persistent chat session is started. This field is populated only for persistent chats.
", "StartContactEvaluationRequest$ContactId": "The identifier of the contact in this instance of Amazon Connect.
", "StartContactRecordingRequest$ContactId": "The identifier of the contact.
", "StartContactRecordingRequest$InitialContactId": "The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
", "StartContactStreamingRequest$ContactId": "The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
", "StartEmailContactRequest$RelatedContactId": "The contactId that is related to this contact. Linking emails together by using RelatedContactID copies over contact attributes from the related email contact to the new email contact. All updates to user-defined attributes in the new email contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using RelatedContactId.
The identifier of this contact within the Amazon Connect instance.
", "StartOutboundChatContactRequest$RelatedContactId": "The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.
", "StartOutboundChatContactResponse$ContactId": "The identifier of this contact within the Amazon Connect instance.
", "StartOutboundEmailContactRequest$ContactId": "The identifier of the contact in this instance of Amazon Connect.
", "StartOutboundEmailContactResponse$ContactId": "The identifier of the contact in this instance of Amazon Connect.
", "StartOutboundVoiceContactRequest$RelatedContactId": "The contactId that is related to this contact. Linking voice, task, or chat by using RelatedContactID copies over contact attributes from the related contact to the new contact. All updates to user-defined attributes in the new contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using RelatedContactId.
The identifier of this contact within the Amazon Connect instance.
", "StartScreenSharingRequest$ContactId": "The identifier of the contact in this instance of Amazon Connect.
", "StartTaskContactRequest$PreviousContactId": "The identifier of the previous chat, voice, or task contact. Any updates to user-defined attributes to task contacts linked using the same PreviousContactID will affect every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.
The contactId that is related to this contact. Linking tasks together by using RelatedContactID copies over contact attributes from the related task contact to the new task contact. All updates to user-defined attributes in the new task contact are limited to the individual contact ID, unlike what happens when tasks are linked by using PreviousContactID. There are no limits to the number of contacts that can be linked by using RelatedContactId.
The identifier of this contact within the Amazon Connect instance.
", "StartWebRTCContactRequest$RelatedContactId": "The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.
", "StartWebRTCContactResponse$ContactId": "The identifier of the contact in this instance of Amazon Connect.
", "StopContactRecordingRequest$ContactId": "The identifier of the contact.
", "StopContactRecordingRequest$InitialContactId": "The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
", "StopContactRequest$ContactId": "The ID of the contact.
", "StopContactStreamingRequest$ContactId": "The identifier of the contact. This is the identifier of the contact that is associated with the first interaction with the contact center.
", "SuccessfulRequest$ContactId": "The contactId of the contact that was created successfully.
", "SuspendContactRecordingRequest$ContactId": "The identifier of the contact.
", "SuspendContactRecordingRequest$InitialContactId": "The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
", "TagContactRequest$ContactId": "The identifier of the contact in this instance of Amazon Connect.
", "TransferContactRequest$ContactId": "The identifier of the contact in this instance of Amazon Connect.
", "TransferContactResponse$ContactId": "The identifier of the contact in this instance of Amazon Connect.
", "UntagContactRequest$ContactId": "The identifier of the contact in this instance of Amazon Connect.
", "UpdateContactAttributesRequest$InitialContactId": "The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
", "UpdateContactRequest$ContactId": "The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.
", "UpdateContactRoutingDataRequest$ContactId": "The identifier of the contact in this instance of Amazon Connect.
", "UpdateContactScheduleRequest$ContactId": "The identifier of the contact.
", "UpdateParticipantRoleConfigRequest$ContactId": "The identifier of the contact in this instance of Amazon Connect.
" } }, "ContactInitiationMethod": { "base": null, "refs": { "AgentContactReference$InitiationMethod": "How the contact was initiated.
", "AssociatedContactSummary$InitiationMethod": "Indicates how the contact was initiated.
", "Contact$InitiationMethod": "Indicates how the contact was initiated.
", "ContactSearchSummary$InitiationMethod": "Indicates how the contact was initiated.
", "CreateContactRequest$InitiationMethod": "Indicates how the contact was initiated.
CreateContact only supports the following initiation methods. Valid values by channel are:
For VOICE: TRANSFER and the subtype connect:ExternalAudio
For EMAIL: OUTBOUND | AGENT_REPLY | FLOW
For TASK: API
The other channels listed below are incorrect. We're working to correct this information.
The object that contains information about metric being requested.
", "refs": { "ContactMetrics$member": null } }, "ContactMetricName": { "base": null, "refs": { "ContactMetricInfo$Name": "The name of the metric being retrieved in type String.
", "ContactMetricResult$Name": "The name of the metric being retrieved in type String.
" } }, "ContactMetricResult": { "base": "Object containing information about metric requested for the contact.
", "refs": { "ContactMetricResults$member": null } }, "ContactMetricResults": { "base": null, "refs": { "GetContactMetricsResponse$MetricResults": "A list of metric results containing the calculated values for each requested metric. Each result includes the metric name and its corresponding calculated value.
" } }, "ContactMetricValue": { "base": "Object which contains the number.
", "refs": { "ContactMetricResult$Value": "Object result associated with the metric received.
" } }, "ContactMetrics": { "base": null, "refs": { "GetContactMetricsRequest$Metrics": "A list of contact-level metrics to retrieve.
" } }, "ContactNotFoundException": { "base": "The contact with the specified ID is not active or does not exist. Applies to Voice calls only, not to Chat or Task contacts.
", "refs": {} }, "ContactRecordingType": { "base": null, "refs": { "ResumeContactRecordingRequest$ContactRecordingType": "The type of recording being operated on.
", "StopContactRecordingRequest$ContactRecordingType": "The type of recording being operated on.
", "SuspendContactRecordingRequest$ContactRecordingType": "The type of recording being operated on.
" } }, "ContactReferences": { "base": null, "refs": { "CreateContactRequest$References": "A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL | ATTACHMENT.
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Emails can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE. EMAIL | EMAIL_MESSAGE |ATTACHMENT are not a supported reference type during email creation.
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during voice contact creation.
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during task creation.
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during task creation.
Information about the reference when the referenceType is URL. Otherwise, null. (Supports variable injection in the Value field.)
Well-formed data on contact, shown to agents on Contact Control Panel (CCP).
" } }, "ContactSearchSummary": { "base": "Information of returned contact.
", "refs": { "Contacts$member": null } }, "ContactSearchSummaryAgentInfo": { "base": "Information about the agent who accepted the contact.
", "refs": { "ContactSearchSummary$AgentInfo": "Information about the agent who accepted the contact.
" } }, "ContactSearchSummaryQueueInfo": { "base": "If this contact was queued, this contains information about the queue.
", "refs": { "ContactSearchSummary$QueueInfo": "If this contact was queued, this contains information about the queue.
" } }, "ContactSearchSummarySegmentAttributeValue": { "base": "The value of a segment attribute. This is structured as a map with a single key-value pair. The key 'valueString' indicates that the attribute type is a string, and its corresponding value is the actual string value of the segment attribute.
", "refs": { "ContactSearchSummarySegmentAttributes$value": null } }, "ContactSearchSummarySegmentAttributes": { "base": null, "refs": { "ContactSearchSummary$SegmentAttributes": "Set of segment attributes for a contact.
" } }, "ContactState": { "base": null, "refs": { "AgentContactReference$AgentContactState": "The state of the contact.
When AgentContactState is set to CONNECTED_ONHOLD, StateStartTimestamp is not changed. Instead, StateStartTimestamp reflects the time the contact was CONNECTED to the agent.
A list of up to 9 contact states.
" } }, "ContactTagKey": { "base": null, "refs": { "ContactTagKeys$member": null, "ContactTagMap$key": null } }, "ContactTagKeys": { "base": null, "refs": { "UntagContactRequest$TagKeys": "A list of tag keys. Existing tags on the contact whose keys are members of this list will be removed.
" } }, "ContactTagMap": { "base": null, "refs": { "Contact$Tags": "Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.
", "TagContactRequest$Tags": "The tags to be assigned to the contact resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
Authorization is not supported by this tag.
Information about the contacts.
" } }, "Content": { "base": null, "refs": { "SendNotificationActionDefinition$Content": "Notification content. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
" } }, "ContentType": { "base": null, "refs": { "RealTimeContactAnalysisAttachment$ContentType": "Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.
" } }, "ControlPlaneAttributeFilter": { "base": "An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR or AND (List of List) input where:
The top level list specifies conditions that need to be applied with OR operator.
The inner list specifies conditions that need to be applied with AND operator.
An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR of AND (List of List) input where:
The top level list specifies conditions that need to be applied with OR operator.
The inner list specifies conditions that need to be applied with AND operator.
An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR or AND (List of List) input where:
The top level list specifies conditions that need to be applied with OR operator.
The inner list specifies conditions that need to be applied with AND operator.
An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR of AND (List of List) input where:
Top level list specifies conditions that need to be applied with OR operator
Inner list specifies conditions that need to be applied with AND operator.
An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the SearchFilter.
This accepts an OR of AND (List of List) input where:
The top level list specifies conditions that need to be applied with OR operator
The inner list specifies conditions that need to be applied with AND operator.
Only one field can be populated. Maximum number of allowed Tag conditions is 25. Maximum number of allowed Hierarchy Group conditions is 20.
An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the SearchFilter.
This accepts an OR of AND (List of List) input where:
The top level list specifies conditions that need to be applied with OR operator.
The inner list specifies conditions that need to be applied with AND operator.
Only one field can be populated. This object can’t be used along with TagFilter. Request can either contain TagFilter or UserAttributeFilter if SearchFilter is specified, combination of both is not supported and such request will throw AccessDeniedException.
The number of chat messages on the contact.
", "ChatContactMetrics$TotalBotMessages": "The total number of bot and automated messages on a chat contact.
", "ChatContactMetrics$TotalBotMessageLengthInChars": "The total number of characters from bot and automated messages on a chat contact.
", "ChatContactMetrics$ConversationTurnCount": "The number of conversation turns in a chat contact, which represents the back-and-forth exchanges between customer and other participants.
", "ParticipantMetrics$MessagesSent": "Number of chat messages sent by Participant.
", "ParticipantMetrics$NumResponses": "Number of chat messages sent by Participant.
", "ParticipantMetrics$MessageLengthInChars": "Number of chat characters sent by Participant.
" } }, "CreateAgentStatusRequest": { "base": null, "refs": {} }, "CreateAgentStatusResponse": { "base": null, "refs": {} }, "CreateCaseActionDefinition": { "base": "The CreateCase action definition.
Information about the create case action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnPostChatAnalysisAvailable.
The name of the security profile.
" } }, "CreateSecurityProfileRequest": { "base": null, "refs": {} }, "CreateSecurityProfileResponse": { "base": null, "refs": {} }, "CreateTaskTemplateRequest": { "base": null, "refs": {} }, "CreateTaskTemplateResponse": { "base": null, "refs": {} }, "CreateTrafficDistributionGroupRequest": { "base": null, "refs": {} }, "CreateTrafficDistributionGroupResponse": { "base": null, "refs": {} }, "CreateUseCaseRequest": { "base": null, "refs": {} }, "CreateUseCaseResponse": { "base": null, "refs": {} }, "CreateUserHierarchyGroupRequest": { "base": null, "refs": {} }, "CreateUserHierarchyGroupResponse": { "base": null, "refs": {} }, "CreateUserRequest": { "base": null, "refs": {} }, "CreateUserResponse": { "base": null, "refs": {} }, "CreateViewRequest": { "base": null, "refs": {} }, "CreateViewResponse": { "base": null, "refs": {} }, "CreateViewVersionRequest": { "base": null, "refs": {} }, "CreateViewVersionResponse": { "base": null, "refs": {} }, "CreateVocabularyRequest": { "base": null, "refs": {} }, "CreateVocabularyResponse": { "base": null, "refs": {} }, "CreatedByInfo": { "base": "Information on the identity that created the file.
", "refs": { "AttachedFile$CreatedBy": "Represents the identity that created the file.
", "GetAttachedFileResponse$CreatedBy": "Represents the identity that created the file.
", "StartAttachedFileUploadRequest$CreatedBy": "Represents the identity that created the file.
", "StartAttachedFileUploadResponse$CreatedBy": "Represents the identity that created the file.
" } }, "Credentials": { "base": "Contains credentials to use for federation.
", "refs": { "GetFederationTokenResponse$Credentials": "The credentials to use for federation.
" } }, "CrossChannelBehavior": { "base": "Defines the cross-channel routing behavior that allows an agent working on a contact in one channel to be offered a contact from a different channel.
", "refs": { "MediaConcurrency$CrossChannelBehavior": "Defines the cross-channel routing behavior for each channel that is enabled for this Routing Profile. For example, this allows you to offer an agent a different contact from another channel when they are currently working with a contact from a Voice channel.
" } }, "CurrentMetric": { "base": "Contains information about a real-time metric. For a description of each metric, see Metrics definitions in the Amazon Connect Administrator Guide.
", "refs": { "CurrentMetricData$Metric": "Information about the metric.
", "CurrentMetrics$member": null } }, "CurrentMetricData": { "base": "Contains the data for a real-time metric.
", "refs": { "CurrentMetricDataCollections$member": null } }, "CurrentMetricDataCollections": { "base": null, "refs": { "CurrentMetricResult$Collections": "The set of metrics.
" } }, "CurrentMetricName": { "base": "The current metric names.
", "refs": { "CurrentMetric$Name": "The name of the metric.
", "CurrentMetricSortCriteria$SortByMetric": null } }, "CurrentMetricResult": { "base": "Contains information about a set of real-time metrics.
", "refs": { "CurrentMetricResults$member": null } }, "CurrentMetricResults": { "base": null, "refs": { "GetCurrentMetricDataResponse$MetricResults": "Information about the real-time metrics.
" } }, "CurrentMetricSortCriteria": { "base": "The way to sort the resulting response based on metrics. By default resources are sorted based on AGENTS_ONLINE, DESCENDING. The metric collection is sorted based on the input metrics.
The way to sort the resulting response based on metrics. You can enter one sort criteria. By default resources are sorted based on AGENTS_ONLINE, DESCENDING. The metric collection is sorted based on the input metrics.
Note the following:
Sorting on SLOTS_ACTIVE and SLOTS_AVAILABLE is not supported.
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 Metrics definitions in the Amazon Connect Administrator Guide.
Unit: COUNT
Name in real-time metrics report: ACW
Unit: COUNT
Name in real-time metrics report: Available
Unit: COUNT
Name in real-time metrics report: Error
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: Online
Unit: COUNT
Name in real-time metrics report: Staffed
Unit: COUNT
Name in real-time metrics report: In queue
Unit: COUNT
Name in real-time metrics report: Scheduled
Unit: SECONDS
When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ \"Metric\": { \"Name\": \"OLDEST_CONTACT_AGE\", \"Unit\": \"SECONDS\" }, \"Value\": 24113.0 }
The actual OLDEST_CONTACT_AGE is 24 seconds.
When the filter RoutingStepExpression is used, this metric is still calculated from enqueue time. For example, if a contact that has been queued under <Expression 1> for 10 seconds has expired and <Expression 2> becomes active, then OLDEST_CONTACT_AGE for this queue will be counted starting from 10, not 0.
Name in real-time metrics report: Oldest
Unit: COUNT
Name in real-time metrics report: Active
Unit: COUNT
Name in real-time metrics report: Availability
Information about the Customer on the contact.
", "refs": { "Contact$Customer": "Information about the Customer on the contact.
" } }, "CustomerId": { "base": null, "refs": { "Contact$CustomerId": "The customer's identification number. For example, the CustomerId may be a customer number from your CRM. You can create a Lambda function to pull the unique customer ID of the caller from your CRM system. If you enable Amazon Connect Voice ID capability, this attribute is populated with the CustomerSpeakerId of the caller.
The customer's identification number. For example, the CustomerId may be a customer number from your CRM.
An object that specifies the customer profile attributes values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template.
" } }, "CustomerQualityMetrics": { "base": "Information about the quality of the Customer's media connection
", "refs": { "QualityMetrics$Customer": "Information about the quality of Customer media connection.
" } }, "CustomerVoiceActivity": { "base": "Information about customer’s voice activity.
", "refs": { "Contact$CustomerVoiceActivity": "Information about customer’s voice activity.
" } }, "DataSetId": { "base": null, "refs": { "AnalyticsDataAssociationResult$DataSetId": "The identifier of the dataset.
", "AnalyticsDataSetsResult$DataSetId": "The identifier of the dataset.
", "AssociateAnalyticsDataSetRequest$DataSetId": "The identifier of the dataset to associate with the target account.
", "AssociateAnalyticsDataSetResponse$DataSetId": "The identifier of the dataset that was associated.
", "DataSetIds$member": null, "DisassociateAnalyticsDataSetRequest$DataSetId": "The identifier of the dataset to remove.
", "ListAnalyticsDataAssociationsRequest$DataSetId": "The identifier of the dataset to get the association status.
" } }, "DataSetIds": { "base": null, "refs": { "BatchAssociateAnalyticsDataSetRequest$DataSetIds": "An array of dataset identifiers to associate.
", "BatchDisassociateAnalyticsDataSetRequest$DataSetIds": "An array of associated dataset identifiers to remove.
", "BatchDisassociateAnalyticsDataSetResponse$Deleted": "An array of successfully disassociated dataset identifiers.
" } }, "DateComparisonType": { "base": null, "refs": { "DateCondition$ComparisonType": "An object to specify the hours of operation override date condition comparisonType.
An object to specify the hours of operation override date condition.
", "refs": { "HoursOfOperationOverrideSearchCriteria$DateCondition": "A leaf node condition which can be used to specify a date condition.
" } }, "DateReference": { "base": "Information about a reference when the referenceType is DATE. Otherwise, null.
Information about a reference when the referenceType is DATE. Otherwise, null.
An object to specify the hours of operation override date value.
" } }, "DeactivateEvaluationFormRequest": { "base": null, "refs": {} }, "DeactivateEvaluationFormResponse": { "base": null, "refs": {} }, "DefaultVocabulary": { "base": "Contains information about a default vocabulary.
", "refs": { "DefaultVocabularyList$member": null } }, "DefaultVocabularyList": { "base": null, "refs": { "ListDefaultVocabulariesResponse$DefaultVocabularyList": "A list of default vocabularies.
" } }, "Delay": { "base": null, "refs": { "RoutingProfileQueueConfig$Delay": "The delay, in seconds, a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide.
", "RoutingProfileQueueConfigSummary$Delay": "The delay, in seconds, that a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide.
" } }, "DeleteAttachedFileRequest": { "base": "Request to DeleteAttachedFile API", "refs": {} }, "DeleteAttachedFileResponse": { "base": "Response from DeleteAttachedFile API", "refs": {} }, "DeleteContactEvaluationRequest": { "base": null, "refs": {} }, "DeleteContactFlowModuleRequest": { "base": null, "refs": {} }, "DeleteContactFlowModuleResponse": { "base": null, "refs": {} }, "DeleteContactFlowRequest": { "base": null, "refs": {} }, "DeleteContactFlowResponse": { "base": null, "refs": {} }, "DeleteContactFlowVersionRequest": { "base": null, "refs": {} }, "DeleteContactFlowVersionResponse": { "base": null, "refs": {} }, "DeleteEmailAddressRequest": { "base": null, "refs": {} }, "DeleteEmailAddressResponse": { "base": null, "refs": {} }, "DeleteEvaluationFormRequest": { "base": null, "refs": {} }, "DeleteHoursOfOperationOverrideRequest": { "base": null, "refs": {} }, "DeleteHoursOfOperationRequest": { "base": null, "refs": {} }, "DeleteInstanceRequest": { "base": null, "refs": {} }, "DeleteIntegrationAssociationRequest": { "base": null, "refs": {} }, "DeletePredefinedAttributeRequest": { "base": null, "refs": {} }, "DeletePromptRequest": { "base": null, "refs": {} }, "DeletePushNotificationRegistrationRequest": { "base": null, "refs": {} }, "DeletePushNotificationRegistrationResponse": { "base": null, "refs": {} }, "DeleteQueueRequest": { "base": null, "refs": {} }, "DeleteQuickConnectRequest": { "base": null, "refs": {} }, "DeleteRoutingProfileRequest": { "base": null, "refs": {} }, "DeleteRuleRequest": { "base": null, "refs": {} }, "DeleteSecurityProfileRequest": { "base": null, "refs": {} }, "DeleteTaskTemplateRequest": { "base": null, "refs": {} }, "DeleteTaskTemplateResponse": { "base": null, "refs": {} }, "DeleteTrafficDistributionGroupRequest": { "base": null, "refs": {} }, "DeleteTrafficDistributionGroupResponse": { "base": null, "refs": {} }, "DeleteUseCaseRequest": { "base": null, "refs": {} }, "DeleteUserHierarchyGroupRequest": { "base": null, "refs": {} }, "DeleteUserRequest": { "base": null, "refs": {} }, "DeleteViewRequest": { "base": null, "refs": {} }, "DeleteViewResponse": { "base": null, "refs": {} }, "DeleteViewVersionRequest": { "base": null, "refs": {} }, "DeleteViewVersionResponse": { "base": null, "refs": {} }, "DeleteVocabularyRequest": { "base": null, "refs": {} }, "DeleteVocabularyResponse": { "base": null, "refs": {} }, "DescribeAgentStatusRequest": { "base": null, "refs": {} }, "DescribeAgentStatusResponse": { "base": null, "refs": {} }, "DescribeAuthenticationProfileRequest": { "base": null, "refs": {} }, "DescribeAuthenticationProfileResponse": { "base": null, "refs": {} }, "DescribeContactEvaluationRequest": { "base": null, "refs": {} }, "DescribeContactEvaluationResponse": { "base": null, "refs": {} }, "DescribeContactFlowModuleRequest": { "base": null, "refs": {} }, "DescribeContactFlowModuleResponse": { "base": null, "refs": {} }, "DescribeContactFlowRequest": { "base": null, "refs": {} }, "DescribeContactFlowResponse": { "base": null, "refs": {} }, "DescribeContactRequest": { "base": null, "refs": {} }, "DescribeContactResponse": { "base": null, "refs": {} }, "DescribeEmailAddressRequest": { "base": null, "refs": {} }, "DescribeEmailAddressResponse": { "base": null, "refs": {} }, "DescribeEvaluationFormRequest": { "base": null, "refs": {} }, "DescribeEvaluationFormResponse": { "base": null, "refs": {} }, "DescribeHoursOfOperationOverrideRequest": { "base": null, "refs": {} }, "DescribeHoursOfOperationOverrideResponse": { "base": null, "refs": {} }, "DescribeHoursOfOperationRequest": { "base": null, "refs": {} }, "DescribeHoursOfOperationResponse": { "base": null, "refs": {} }, "DescribeInstanceAttributeRequest": { "base": null, "refs": {} }, "DescribeInstanceAttributeResponse": { "base": null, "refs": {} }, "DescribeInstanceRequest": { "base": null, "refs": {} }, "DescribeInstanceResponse": { "base": null, "refs": {} }, "DescribeInstanceStorageConfigRequest": { "base": null, "refs": {} }, "DescribeInstanceStorageConfigResponse": { "base": null, "refs": {} }, "DescribePhoneNumberRequest": { "base": null, "refs": {} }, "DescribePhoneNumberResponse": { "base": null, "refs": {} }, "DescribePredefinedAttributeRequest": { "base": null, "refs": {} }, "DescribePredefinedAttributeResponse": { "base": null, "refs": {} }, "DescribePromptRequest": { "base": null, "refs": {} }, "DescribePromptResponse": { "base": null, "refs": {} }, "DescribeQueueRequest": { "base": null, "refs": {} }, "DescribeQueueResponse": { "base": null, "refs": {} }, "DescribeQuickConnectRequest": { "base": null, "refs": {} }, "DescribeQuickConnectResponse": { "base": null, "refs": {} }, "DescribeRoutingProfileRequest": { "base": null, "refs": {} }, "DescribeRoutingProfileResponse": { "base": null, "refs": {} }, "DescribeRuleRequest": { "base": null, "refs": {} }, "DescribeRuleResponse": { "base": null, "refs": {} }, "DescribeSecurityProfileRequest": { "base": null, "refs": {} }, "DescribeSecurityProfileResponse": { "base": null, "refs": {} }, "DescribeTrafficDistributionGroupRequest": { "base": null, "refs": {} }, "DescribeTrafficDistributionGroupResponse": { "base": null, "refs": {} }, "DescribeUserHierarchyGroupRequest": { "base": null, "refs": {} }, "DescribeUserHierarchyGroupResponse": { "base": null, "refs": {} }, "DescribeUserHierarchyStructureRequest": { "base": null, "refs": {} }, "DescribeUserHierarchyStructureResponse": { "base": null, "refs": {} }, "DescribeUserRequest": { "base": null, "refs": {} }, "DescribeUserResponse": { "base": null, "refs": {} }, "DescribeViewRequest": { "base": null, "refs": {} }, "DescribeViewResponse": { "base": null, "refs": {} }, "DescribeVocabularyRequest": { "base": null, "refs": {} }, "DescribeVocabularyResponse": { "base": null, "refs": {} }, "Description": { "base": null, "refs": { "Contact$Description": "The description of the contact.
", "CreateContactRequest$Description": "A description of the contact.
", "CreateEmailAddressRequest$Description": "The description of the email address.
", "DescribeEmailAddressResponse$Description": "The description of the email address.
", "EmailAddressMetadata$Description": "The description of the email address.
", "StartEmailContactRequest$Description": "A description of the email contact.
", "StartOutboundVoiceContactRequest$Description": "A description of the voice contact that appears in the agent's snapshot in the CCP logs. For more information about CCP logs, see Download and review CCP logs in the Amazon Connect Administrator Guide.
", "StartTaskContactRequest$Description": "A description of the task that is shown to an agent in the Contact Control Panel (CCP).
", "StartWebRTCContactRequest$Description": "A description of the task that is shown to an agent in the Contact Control Panel (CCP).
", "UpdateContactRequest$Description": "The description of the contact.
", "UpdateEmailAddressMetadataRequest$Description": "The description of the email address.
" } }, "Description250": { "base": null, "refs": { "CreateTrafficDistributionGroupRequest$Description": "A description for the traffic distribution group.
", "TrafficDistributionGroup$Description": "The description of the traffic distribution group.
" } }, "DestinationId": { "base": null, "refs": { "SendChatIntegrationEventRequest$DestinationId": "Chat system identifier, used in part to uniquely identify chat. This is associated with the Amazon Connect instance and flow to be used to start chats. For Server Migration Service, this is the phone number destination of inbound Server Migration Service messages represented by an Amazon Web Services End User Messaging phone number ARN.
" } }, "DestinationNotAllowedException": { "base": "Outbound calls to the destination number are not allowed.
", "refs": {} }, "DeviceInfo": { "base": "Information regarding the device.
", "refs": { "AgentInfo$DeviceInfo": "Information regarding Agent’s device.
", "Customer$DeviceInfo": "Information regarding Customer’s device.
" } }, "DeviceToken": { "base": null, "refs": { "CreatePushNotificationRegistrationRequest$DeviceToken": "The push notification token issued by the Apple or Google gateways.
" } }, "DeviceType": { "base": null, "refs": { "CreatePushNotificationRegistrationRequest$DeviceType": "The device type to use when sending the message.
" } }, "Dimensions": { "base": "Contains information about the dimensions for a set of metrics.
", "refs": { "CurrentMetricResult$Dimensions": "The dimensions for the metrics.
", "HistoricalMetricResult$Dimensions": "The dimension for the metrics.
" } }, "DimensionsV2Key": { "base": null, "refs": { "DimensionsV2Map$key": null } }, "DimensionsV2Map": { "base": null, "refs": { "MetricResultV2$Dimensions": "The dimension for the metrics.
" } }, "DimensionsV2Value": { "base": null, "refs": { "DimensionsV2Map$value": null } }, "DirectoryAlias": { "base": null, "refs": { "CreateInstanceRequest$InstanceAlias": "The name for your instance.
", "Instance$InstanceAlias": "The alias of instance.
", "InstanceSummary$InstanceAlias": "The alias of the instance.
", "ReplicateInstanceRequest$ReplicaAlias": "The alias for the replicated instance. The ReplicaAlias must be unique.
The identifier for the directory.
" } }, "DirectoryType": { "base": null, "refs": { "CreateInstanceRequest$IdentityManagementType": "The type of identity management for your Amazon Connect users.
", "Instance$IdentityManagementType": "The identity management type.
", "InstanceSummary$IdentityManagementType": "The identity management type of the instance.
" } }, "DirectoryUserId": { "base": null, "refs": { "CreateUserRequest$DirectoryUserId": "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.
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.
", "User$DirectoryUserId": "The identifier of the user account in the directory used for identity management.
", "UserSearchSummary$DirectoryUserId": "The directory identifier of the user.
" } }, "DisassociateAnalyticsDataSetRequest": { "base": null, "refs": {} }, "DisassociateApprovedOriginRequest": { "base": null, "refs": {} }, "DisassociateBotRequest": { "base": null, "refs": {} }, "DisassociateFlowRequest": { "base": null, "refs": {} }, "DisassociateFlowResponse": { "base": null, "refs": {} }, "DisassociateInstanceStorageConfigRequest": { "base": null, "refs": {} }, "DisassociateLambdaFunctionRequest": { "base": null, "refs": {} }, "DisassociateLexBotRequest": { "base": null, "refs": {} }, "DisassociatePhoneNumberContactFlowRequest": { "base": null, "refs": {} }, "DisassociateQueueQuickConnectsRequest": { "base": null, "refs": {} }, "DisassociateRoutingProfileQueuesRequest": { "base": null, "refs": {} }, "DisassociateSecurityKeyRequest": { "base": null, "refs": {} }, "DisassociateTrafficDistributionGroupUserRequest": { "base": null, "refs": {} }, "DisassociateTrafficDistributionGroupUserResponse": { "base": null, "refs": {} }, "DisassociateUserProficienciesRequest": { "base": null, "refs": {} }, "DisconnectDetails": { "base": "Information about the call disconnect experience.
", "refs": { "Contact$DisconnectDetails": "Information about the call disconnect experience.
" } }, "DisconnectReason": { "base": "Contains details about why a contact was disconnected. Only Amazon Connect outbound campaigns can provide this field.
", "refs": { "StopContactRequest$DisconnectReason": "The reason a contact can be disconnected. Only Amazon Connect outbound campaigns can provide this field.
" } }, "DisconnectReasonCode": { "base": null, "refs": { "DisconnectReason$Code": "A code that indicates how the contact was terminated.
" } }, "DismissUserContactRequest": { "base": null, "refs": {} }, "DismissUserContactResponse": { "base": null, "refs": {} }, "DisplayName": { "base": null, "refs": { "ParticipantDetails$DisplayName": "Display name of the participant.
", "ParticipantDetailsToAdd$DisplayName": "The display name of the participant.
", "RealTimeContactAnalysisSegmentAttachments$DisplayName": "The display name of the participant. Can be redacted.
", "RealTimeContactAnalysisSegmentEvent$DisplayName": "The display name of the participant. Can be redacted.
", "RealTimeContactAnalysisSegmentTranscript$DisplayName": "The display name of the participant.
" } }, "Distribution": { "base": "Information about a traffic distribution.
", "refs": { "DistributionList$member": null } }, "DistributionList": { "base": null, "refs": { "AgentConfig$Distributions": "Information about traffic distributions.
", "TelephonyConfig$Distributions": "Information about traffic distributions.
" } }, "Double": { "base": null, "refs": { "ContactMetricValue$Number": "The number of type Double. This number is the contact's position in queue.
", "FieldValueUnion$DoubleValue": "A Double number value type.
" } }, "DownloadUrlMetadata": { "base": "Metadata used to download the attached file.
", "refs": { "GetAttachedFileResponse$DownloadUrlMetadata": "URL and expiry to be used when downloading the attached file.
" } }, "DuplicateResourceException": { "base": "A resource with the specified name already exists.
", "refs": {} }, "Duration": { "base": null, "refs": { "AgentInfo$AfterContactWorkDuration": "The difference in time, in whole seconds, between AfterContactWorkStartTimestamp and AfterContactWorkEndTimestamp.
The total hold duration in seconds initiated by the agent.
" } }, "DurationInSeconds": { "base": null, "refs": { "Expiry$DurationInSeconds": "The number of seconds to wait before expiring the routing step.
", "RoutingCriteriaInputStepExpiry$DurationInSeconds": "The number of seconds that the contact will be routed only to agents matching this routing step, if expiry was configured for this routing step.
" } }, "DurationMillis": { "base": null, "refs": { "ChatContactMetrics$ConversationCloseTimeInMillis": "The time it took for a contact to end after the last customer message.
", "ChatContactMetrics$AgentFirstResponseTimeInMillis": "The time for an agent to respond after obtaining a chat contact.
", "ParticipantMetrics$TotalResponseTimeInMillis": "Total chat response time by Participant.
", "ParticipantMetrics$MaxResponseTimeInMillis": "Maximum chat response time by Participant.
" } }, "EffectiveHoursOfOperationList": { "base": null, "refs": { "GetEffectiveHoursOfOperationsResponse$EffectiveHoursOfOperationList": "Information about the effective hours of operations.
" } }, "EffectiveHoursOfOperations": { "base": "Information about the hours of operations with the effective override applied.
", "refs": { "EffectiveHoursOfOperationList$member": null } }, "Email": { "base": null, "refs": { "UserIdentityInfo$Email": "The email address. If you are using SAML for identity management and include this parameter, an error is returned.
", "UserIdentityInfo$SecondaryEmail": "The user's secondary email address. If you provide a secondary email, the user receives email notifications - other than password reset notifications - to this email address instead of to their primary email address.
Pattern: (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,63}
The email address, including the domain.
", "DescribeEmailAddressResponse$EmailAddress": "The email address, including the domain.
", "EmailAddressInfo$EmailAddress": "The email address, including the domain.
", "EmailAddressMetadata$EmailAddress": "The email address, including the domain.
", "StartEmailContactRequest$DestinationEmailAddress": "The email address associated with the Amazon Connect instance.
" } }, "EmailAddressArn": { "base": null, "refs": { "CreateEmailAddressResponse$EmailAddressArn": "The Amazon Resource Name (ARN) of the email address.
", "DescribeEmailAddressResponse$EmailAddressArn": "The Amazon Resource Name (ARN) of the email address.
", "EmailAddressMetadata$EmailAddressArn": "The Amazon Resource Name (ARN) of the email address.
", "UpdateEmailAddressMetadataResponse$EmailAddressArn": "The Amazon Resource Name (ARN) of the email address.
" } }, "EmailAddressDisplayName": { "base": null, "refs": { "CreateEmailAddressRequest$DisplayName": "The display name of email address
", "DescribeEmailAddressResponse$DisplayName": "The display name of email address
", "EmailAddressInfo$DisplayName": "The display name of email address.
", "EmailAddressMetadata$DisplayName": "The display name of email address.
", "UpdateEmailAddressMetadataRequest$DisplayName": "The display name of email address.
" } }, "EmailAddressId": { "base": null, "refs": { "CreateEmailAddressResponse$EmailAddressId": "The identifier of the email address.
", "DeleteEmailAddressRequest$EmailAddressId": "The identifier of the email address.
", "DescribeEmailAddressRequest$EmailAddressId": "The identifier of the email address.
", "DescribeEmailAddressResponse$EmailAddressId": "The identifier of the email address.
", "EmailAddressMetadata$EmailAddressId": "The identifier of the email address.
", "OutboundEmailConfig$OutboundEmailAddressId": "The identifier of the email address.
", "UpdateEmailAddressMetadataRequest$EmailAddressId": "The identifier of the email address.
", "UpdateEmailAddressMetadataResponse$EmailAddressId": "The identifier of the email address.
" } }, "EmailAddressInfo": { "base": "Contains information about a source or destination email address.
", "refs": { "EmailAddressRecipientList$member": null, "SendOutboundEmailRequest$FromEmailAddress": "The email address to be used for sending email.
", "SendOutboundEmailRequest$DestinationEmailAddress": "The email address to send the email to.
", "StartEmailContactRequest$FromEmailAddress": "The email address of the customer.
", "StartOutboundEmailContactRequest$FromEmailAddress": "The email address associated with the Amazon Connect instance.
", "StartOutboundEmailContactRequest$DestinationEmailAddress": "The email address of the customer.
" } }, "EmailAddressList": { "base": null, "refs": { "SearchEmailAddressesResponse$EmailAddresses": "List of email addresses matching SearchFilter and SearchCriteria
" } }, "EmailAddressMetadata": { "base": "Contains information about an email address for a contact center.
", "refs": { "EmailAddressList$member": null } }, "EmailAddressRecipientList": { "base": null, "refs": { "InboundAdditionalRecipients$ToAddresses": "The additional recipients information present in to list. You must have 1 required recipient (DestinationEmailAddress). You can then specify up to 49 additional recipients (across ToAddresses and CcAddresses), for a total of 50 recipients.
The additional recipients information present in cc list. You must have 1 required recipient (DestinationEmailAddress). You can then specify up to 49 additional recipients (across ToAddresses and CcAddresses), for a total of 50 recipients.
Information about the additional CC email address recipients. Email recipients are limited to 50 total addresses: 1 required recipient in the DestinationEmailAddress field and up to 49 recipients in the 'CcEmailAddresses' field.
" } }, "EmailAddressSearchConditionList": { "base": null, "refs": { "EmailAddressSearchCriteria$OrConditions": "A list of conditions which would be applied together with an OR condition.
", "EmailAddressSearchCriteria$AndConditions": "A list of conditions which would be applied together with an AND condition.
" } }, "EmailAddressSearchCriteria": { "base": "The search criteria to be used to return email addresses.
", "refs": { "EmailAddressSearchConditionList$member": null, "SearchEmailAddressesRequest$SearchCriteria": "The search criteria to be used to return email addresses.
" } }, "EmailAddressSearchFilter": { "base": "Filters to be applied to search results.
", "refs": { "SearchEmailAddressesRequest$SearchFilter": "Filters to be applied to search results.
" } }, "EmailAttachment": { "base": "Information about the email attachment files.
", "refs": { "EmailAttachments$member": null } }, "EmailAttachments": { "base": null, "refs": { "StartEmailContactRequest$Attachments": "List of S3 presigned URLs of email attachments and their file name.
" } }, "EmailHeaderType": { "base": null, "refs": { "EmailHeaders$key": null } }, "EmailHeaderValue": { "base": null, "refs": { "EmailHeaders$value": null } }, "EmailHeaders": { "base": null, "refs": { "InboundRawMessage$Headers": "Headers present in inbound email.
" } }, "EmailMessageContentType": { "base": null, "refs": { "InboundRawMessage$ContentType": "Type of content, that is, text/plain or text/html.
Type of content, that is, text/plain or text/html.
Information about the reference when the referenceType is EMAIL_MESSAGE. Otherwise, null.
Information about the reference when the referenceType is EMAIL_MESSAGE. Otherwise, null.
Information about the email recipient
", "refs": { "EmailRecipientsList$member": null } }, "EmailRecipientsList": { "base": null, "refs": { "AdditionalEmailRecipients$ToList": "List of additional TO email recipients for an email contact.
", "AdditionalEmailRecipients$CcList": "List of additional CC email recipients for an email contact.
" } }, "EmailReference": { "base": "Information about a reference when the referenceType is EMAIL. Otherwise, null.
Information about a reference when the referenceType is EMAIL. Otherwise, null.
An empty value.
", "refs": { "FieldValueUnion$EmptyValue": "An empty value.
" } }, "EnableValueValidationOnAssociation": { "base": null, "refs": { "InputPredefinedAttributeConfiguration$EnableValueValidationOnAssociation": "When this parameter is set to true, Amazon Connect enforces strict validation on the specific values, if the values are predefined in attributes. The contact will store only valid and predefined values for the predefined attribute key.
", "PredefinedAttributeConfiguration$EnableValueValidationOnAssociation": "When this parameter is set to true, Amazon Connect enforces strict validation on the specific values, if the values are predefined in attributes. The contact will store only valid and predefined values for teh predefined attribute key.
" } }, "EncryptionConfig": { "base": "The encryption configuration.
", "refs": { "KinesisVideoStreamConfig$EncryptionConfig": "The encryption configuration.
", "S3Config$EncryptionConfig": "The Amazon S3 encryption configuration.
" } }, "EncryptionType": { "base": null, "refs": { "EncryptionConfig$EncryptionType": "The type of encryption.
" } }, "EndAssociatedTasksActionDefinition": { "base": "End associated tasks related to a case.
", "refs": { "RuleAction$EndAssociatedTasksAction": "Information about the end associated tasks action.
Supported only for TriggerEventSource values: OnCaseUpdate.
Information about the endpoint.
", "refs": { "ContactDataRequest$SystemEndpoint": "Endpoint associated with the Amazon Connect instance from which outbound contact will be initiated for the campaign.
", "ContactDataRequest$CustomerEndpoint": "Endpoint of the customer for which contact will be initiated.
", "StartOutboundChatContactRequest$SourceEndpoint": null, "StartOutboundChatContactRequest$DestinationEndpoint": null, "UpdateContactRequest$CustomerEndpoint": "The endpoint of the customer for which the contact was initiated. For external audio contacts, this is usually the end customer's phone number. This value can only be updated for external audio contacts. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.
", "UpdateContactRequest$SystemEndpoint": "External system endpoint for the contact was initiated. For external audio contacts, this is the phone number of the external system such as the contact center. This value can only be updated for external audio contacts. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.
" } }, "EndpointAddress": { "base": null, "refs": { "EmailRecipient$Address": "Address of the email recipient.
", "Endpoint$Address": "Address of the endpoint.
", "EndpointInfo$Address": "Address of the endpoint.
" } }, "EndpointDisplayName": { "base": null, "refs": { "EmailRecipient$DisplayName": "Display name of the email recipient.
", "EndpointInfo$DisplayName": "Display name of the endpoint.
" } }, "EndpointInfo": { "base": "Information about the endpoint.
", "refs": { "Contact$CustomerEndpoint": "The customer or external third party participant endpoint.
", "Contact$SystemEndpoint": "The system endpoint. For INBOUND, this is the phone number or email address that the customer dialed. For OUTBOUND and EXTERNAL_OUTBOUND, this is the outbound caller ID number assigned to the outbound queue that is used to dial the customer. For callback, this shows up as Softphone for calls handled by agents with softphone.
Type of the endpoint.
", "EndpointInfo$Type": "Type of endpoint.
" } }, "ErrorCode": { "base": null, "refs": { "AttachedFileError$ErrorCode": "Status code describing the failure.
" } }, "ErrorMessage": { "base": null, "refs": { "AttachedFileError$ErrorMessage": "Why the attached file couldn't be retrieved.
" } }, "ErrorResult": { "base": "This API is in preview release for Amazon Connect and is subject to change.
List of errors for dataset association failures.
", "refs": { "ErrorResults$member": null } }, "ErrorResults": { "base": null, "refs": { "BatchAssociateAnalyticsDataSetResponse$Errors": "A list of errors for datasets that aren't successfully associated with the target account.
", "BatchDisassociateAnalyticsDataSetResponse$Errors": "A list of errors for any datasets not successfully removed.
" } }, "Evaluation": { "base": "Information about a contact evaluation.
", "refs": { "DescribeContactEvaluationResponse$Evaluation": "Information about the evaluation form completed for a specific contact.
" } }, "EvaluationAnswerData": { "base": "Information about answer data for a contact evaluation. Answer data must be either string, numeric, or not applicable.
", "refs": { "EvaluationAnswerInput$Value": "The value for an answer in a contact evaluation.
", "EvaluationAnswerOutput$Value": "The value for an answer in a contact evaluation.
", "EvaluationAnswerOutput$SystemSuggestedValue": "The system suggested value for an answer in a contact evaluation.
" } }, "EvaluationAnswerDataNumericValue": { "base": null, "refs": { "EvaluationAnswerData$NumericValue": "The numeric value for an answer in a contact evaluation.
" } }, "EvaluationAnswerDataStringValue": { "base": null, "refs": { "EvaluationAnswerData$StringValue": "The string value for an answer in a contact evaluation.
" } }, "EvaluationAnswerInput": { "base": "Information about input answers for a contact evaluation.
", "refs": { "EvaluationAnswersInputMap$value": null } }, "EvaluationAnswerOutput": { "base": "Information about output answers for a contact evaluation.
", "refs": { "EvaluationAnswersOutputMap$value": null } }, "EvaluationAnswersInputMap": { "base": null, "refs": { "SubmitContactEvaluationRequest$Answers": "A map of question identifiers to answer value.
", "UpdateContactEvaluationRequest$Answers": "A map of question identifiers to answer value.
" } }, "EvaluationAnswersOutputMap": { "base": null, "refs": { "Evaluation$Answers": "A map of question identifiers to answer value.
" } }, "EvaluationArn": { "base": null, "refs": { "ContactEvaluation$EvaluationArn": "The Amazon Resource Name for the evaluation form. It is always present.
" } }, "EvaluationForm": { "base": "Information about the evaluation form.
", "refs": { "DescribeEvaluationFormResponse$EvaluationForm": "Information about the evaluation form.
" } }, "EvaluationFormContent": { "base": "Information about an evaluation form used in a contact evaluation.
", "refs": { "DescribeContactEvaluationResponse$EvaluationForm": "Information about the evaluation form.
" } }, "EvaluationFormDescription": { "base": null, "refs": { "CreateEvaluationFormRequest$Description": "The description of the evaluation form.
", "EvaluationForm$Description": "The description of the evaluation form.
", "EvaluationFormContent$Description": "The description of the evaluation form.
", "UpdateEvaluationFormRequest$Description": "The description of the evaluation form.
" } }, "EvaluationFormId": { "base": null, "refs": { "SubmitAutoEvaluationActionDefinition$EvaluationFormId": "The identifier of the auto-evaluation enabled form.
" } }, "EvaluationFormItem": { "base": "Information about an item from an evaluation form. The item must be either a section or a question.
", "refs": { "EvaluationFormItemsList$member": null } }, "EvaluationFormItemWeight": { "base": null, "refs": { "EvaluationFormQuestion$Weight": "The scoring weight of the section.
", "EvaluationFormSection$Weight": "The scoring weight of the section.
" } }, "EvaluationFormItemsList": { "base": null, "refs": { "CreateEvaluationFormRequest$Items": "Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
", "EvaluationForm$Items": "Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
", "EvaluationFormContent$Items": "Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
", "EvaluationFormSection$Items": "The items of the section.
", "UpdateEvaluationFormRequest$Items": "Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
" } }, "EvaluationFormNumericQuestionAutomation": { "base": "Information about the automation configuration in numeric questions.
", "refs": { "EvaluationFormNumericQuestionProperties$Automation": "The automation properties of the numeric question.
" } }, "EvaluationFormNumericQuestionOption": { "base": "Information about the option range used for scoring in numeric questions.
", "refs": { "EvaluationFormNumericQuestionOptionList$member": null } }, "EvaluationFormNumericQuestionOptionList": { "base": null, "refs": { "EvaluationFormNumericQuestionProperties$Options": "The scoring options of the numeric question.
" } }, "EvaluationFormNumericQuestionProperties": { "base": "Information about properties for a numeric question in an evaluation form.
", "refs": { "EvaluationFormQuestionTypeProperties$Numeric": "The properties of the numeric question.
" } }, "EvaluationFormQuestion": { "base": "Information about a question from an evaluation form.
", "refs": { "EvaluationFormItem$Question": "The information of the question.
" } }, "EvaluationFormQuestionAnswerScore": { "base": null, "refs": { "EvaluationFormNumericQuestionOption$Score": "The score assigned to answer values within the range option.
", "EvaluationFormSingleSelectQuestionOption$Score": "The score assigned to the answer option.
" } }, "EvaluationFormQuestionInstructions": { "base": null, "refs": { "EvaluationFormQuestion$Instructions": "The instructions of the section.
", "EvaluationFormSection$Instructions": "The instructions of the section.
" } }, "EvaluationFormQuestionTitle": { "base": null, "refs": { "EvaluationFormQuestion$Title": "The title of the question.
" } }, "EvaluationFormQuestionType": { "base": null, "refs": { "EvaluationFormQuestion$QuestionType": "The type of the question.
" } }, "EvaluationFormQuestionTypeProperties": { "base": "Information about properties for a question in an evaluation form. The question type properties must be either for a numeric question or a single select question.
", "refs": { "EvaluationFormQuestion$QuestionTypeProperties": "The properties of the type of question. Text questions do not have to define question type properties.
" } }, "EvaluationFormScoringMode": { "base": null, "refs": { "EvaluationFormScoringStrategy$Mode": "The scoring mode of the evaluation form.
" } }, "EvaluationFormScoringStatus": { "base": null, "refs": { "EvaluationFormScoringStrategy$Status": "The scoring status of the evaluation form.
" } }, "EvaluationFormScoringStrategy": { "base": "Information about scoring strategy for an evaluation form.
", "refs": { "CreateEvaluationFormRequest$ScoringStrategy": "A scoring strategy of the evaluation form.
", "EvaluationForm$ScoringStrategy": "A scoring strategy of the evaluation form.
", "EvaluationFormContent$ScoringStrategy": "A scoring strategy of the evaluation form.
", "UpdateEvaluationFormRequest$ScoringStrategy": "A scoring strategy of the evaluation form.
" } }, "EvaluationFormSection": { "base": "Information about a section from an evaluation form. A section can contain sections and/or questions. Evaluation forms can only contain sections and subsections (two level nesting).
", "refs": { "EvaluationFormItem$Section": "The information of the section.
" } }, "EvaluationFormSectionTitle": { "base": null, "refs": { "EvaluationFormSection$Title": "The title of the section.
" } }, "EvaluationFormSingleSelectQuestionAutomation": { "base": "Information about the automation configuration in single select questions. Automation options are evaluated in order, and the first matched option is applied. If no automation option matches, and there is a default option, then the default option is applied.
", "refs": { "EvaluationFormSingleSelectQuestionProperties$Automation": "The display mode of the single select question.
" } }, "EvaluationFormSingleSelectQuestionAutomationOption": { "base": "Information about the automation option of a single select question.
", "refs": { "EvaluationFormSingleSelectQuestionAutomationOptionList$member": null } }, "EvaluationFormSingleSelectQuestionAutomationOptionList": { "base": null, "refs": { "EvaluationFormSingleSelectQuestionAutomation$Options": "The automation options of the single select question.
" } }, "EvaluationFormSingleSelectQuestionDisplayMode": { "base": null, "refs": { "EvaluationFormSingleSelectQuestionProperties$DisplayAs": "The display mode of the single select question.
" } }, "EvaluationFormSingleSelectQuestionOption": { "base": "Information about the automation configuration in single select questions.
", "refs": { "EvaluationFormSingleSelectQuestionOptionList$member": null } }, "EvaluationFormSingleSelectQuestionOptionList": { "base": null, "refs": { "EvaluationFormSingleSelectQuestionProperties$Options": "The answer options of the single select question.
" } }, "EvaluationFormSingleSelectQuestionOptionText": { "base": null, "refs": { "EvaluationFormSingleSelectQuestionOption$Text": "The title of the answer option.
" } }, "EvaluationFormSingleSelectQuestionProperties": { "base": "Information about the options in single select questions.
", "refs": { "EvaluationFormQuestionTypeProperties$SingleSelect": "The properties of the numeric question.
" } }, "EvaluationFormSummary": { "base": "Summary information about an evaluation form.
", "refs": { "EvaluationFormSummaryList$member": null } }, "EvaluationFormSummaryList": { "base": null, "refs": { "ListEvaluationFormsResponse$EvaluationFormSummaryList": "Provides details about a list of evaluation forms belonging to an instance.
" } }, "EvaluationFormTitle": { "base": null, "refs": { "CreateEvaluationFormRequest$Title": "A title of the evaluation form.
", "EvaluationForm$Title": "A title of the evaluation form.
", "EvaluationFormContent$Title": "A title of the evaluation form.
", "EvaluationFormSummary$Title": "A title of the evaluation form.
", "EvaluationSummary$EvaluationFormTitle": "A title of the evaluation form.
", "UpdateEvaluationFormRequest$Title": "A title of the evaluation form.
" } }, "EvaluationFormVersionIsLocked": { "base": null, "refs": { "EvaluationForm$Locked": "The flag indicating whether the evaluation form is locked for changes.
", "EvaluationFormVersionSummary$Locked": "The flag indicating whether the evaluation form is locked for changes.
" } }, "EvaluationFormVersionStatus": { "base": null, "refs": { "EvaluationForm$Status": "The status of the evaluation form.
", "EvaluationFormVersionSummary$Status": "The status of the evaluation form.
" } }, "EvaluationFormVersionSummary": { "base": "Summary information about an evaluation form.
", "refs": { "EvaluationFormVersionSummaryList$member": null } }, "EvaluationFormVersionSummaryList": { "base": null, "refs": { "ListEvaluationFormVersionsResponse$EvaluationFormVersionSummaryList": "Provides details about a list of evaluation forms belonging to an instance.
" } }, "EvaluationId": { "base": null, "refs": { "ContactEvaluations$key": null } }, "EvaluationMetadata": { "base": "Metadata information about a contact evaluation.
", "refs": { "Evaluation$Metadata": "Metadata about the contact evaluation.
" } }, "EvaluationNote": { "base": "Information about notes for a contact evaluation.
", "refs": { "EvaluationNotesMap$value": null } }, "EvaluationNoteString": { "base": null, "refs": { "EvaluationNote$Value": "The note for an item (section or question) in a contact evaluation.
Even though a note in an evaluation can have up to 3072 chars, there is also a limit on the total number of chars for all the notes in the evaluation combined. Assuming there are N questions in the evaluation being submitted, then the max char limit for all notes combined is N x 1024.
A map of question identifiers to note value.
", "SubmitContactEvaluationRequest$Notes": "A map of question identifiers to note value.
", "UpdateContactEvaluationRequest$Notes": "A map of question identifiers to note value.
" } }, "EvaluationScore": { "base": "Information about scores of a contact evaluation item (section or question).
", "refs": { "EvaluationMetadata$Score": "The overall score of the contact evaluation.
", "EvaluationScoresMap$value": null, "EvaluationSummary$Score": "The overall score of the contact evaluation.
" } }, "EvaluationScorePercentage": { "base": null, "refs": { "EvaluationScore$Percentage": "The score percentage for an item in a contact evaluation.
" } }, "EvaluationScoresMap": { "base": null, "refs": { "Evaluation$Scores": "A map of item (section or question) identifiers to score value.
" } }, "EvaluationStatus": { "base": null, "refs": { "Evaluation$Status": "The status of the contact evaluation.
", "EvaluationSummary$Status": "The status of the contact evaluation.
" } }, "EvaluationSummary": { "base": "Summary information about a contact evaluation.
", "refs": { "EvaluationSummaryList$member": null } }, "EvaluationSummaryList": { "base": null, "refs": { "ListContactEvaluationsResponse$EvaluationSummaryList": "Provides details about a list of contact evaluations belonging to an instance.
" } }, "EventBridgeActionDefinition": { "base": "The EventBridge action definition.
", "refs": { "RuleAction$EventBridgeAction": "Information about the EventBridge action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate
The name.
" } }, "EventSourceName": { "base": null, "refs": { "ListRulesRequest$EventSourceName": "The name of the event source.
", "RuleSummary$EventSourceName": "The name of the event source.
", "RuleTriggerEventSource$EventSourceName": "The name of the event source.
" } }, "Expiry": { "base": "An object to specify the expiration of a routing step.
", "refs": { "Step$Expiry": "An object to specify the expiration of a routing step.
" } }, "ExpiryDurationInMinutes": { "base": null, "refs": { "CreateContactRequest$ExpiryDurationInMinutes": "Number of minutes the contact will be active for before expiring
" } }, "ExportLocation": { "base": null, "refs": { "ContactEvaluation$ExportLocation": "The path where evaluation was exported.
" } }, "Expression": { "base": "A tagged union to specify expression for a routing step.
", "refs": { "Expressions$member": null, "RoutingCriteriaInputStep$Expression": "A tagged union to specify expression for a routing step.
", "Step$Expression": "A tagged union to specify expression for a routing step.
" } }, "Expressions": { "base": null, "refs": { "Expression$AndExpression": "List of routing expressions which will be AND-ed together.
", "Expression$OrExpression": "List of routing expressions which will be OR-ed together.
" } }, "FailedRequest": { "base": "Request for which contact failed to be generated.
", "refs": { "FailedRequestList$member": null } }, "FailedRequestList": { "base": null, "refs": { "BatchPutContactResponse$FailedRequestList": "List of requests for which contact creation failed.
" } }, "FailureReasonCode": { "base": null, "refs": { "FailedRequest$FailureReasonCode": "Reason code for the failure.
" } }, "FieldStringValue": { "base": null, "refs": { "FieldValueUnion$StringValue": "String value type.
" } }, "FieldValue": { "base": "Object for case field values.
", "refs": { "FieldValues$member": null } }, "FieldValueId": { "base": null, "refs": { "CaseSlaConfiguration$FieldId": "Unique identifier of a Case field.
", "FieldValue$Id": "Unique identifier of a field.
" } }, "FieldValueUnion": { "base": "Object to store union of Field values.
", "refs": { "FieldValue$Value": "Union of potential field value types.
", "SlaFieldValueUnionList$member": null } }, "FieldValues": { "base": null, "refs": { "CreateCaseActionDefinition$Fields": "An array of objects with Field ID and Value data.
An array of objects with Field ID and Value data.
The unique identifier of the attached file resource.
", "AttachedFileError$FileId": "The unique identifier of the attached file resource.
", "CompleteAttachedFileUploadRequest$FileId": "The unique identifier of the attached file resource.
", "DeleteAttachedFileRequest$FileId": "The unique identifier of the attached file resource.
", "FileIdList$member": null, "GetAttachedFileRequest$FileId": "The unique identifier of the attached file resource.
", "GetAttachedFileResponse$FileId": "The unique identifier of the attached file resource.
", "StartAttachedFileUploadResponse$FileId": "The unique identifier of the attached file resource.
" } }, "FileIdList": { "base": null, "refs": { "BatchGetAttachedFileMetadataRequest$FileIds": "The unique identifiers of the attached file resource.
" } }, "FileName": { "base": null, "refs": { "AttachedFile$FileName": "A case-sensitive name of the attached file being uploaded.
", "EmailAttachment$FileName": "A case-sensitive name of the attached file being uploaded.
", "GetAttachedFileResponse$FileName": "A case-sensitive name of the attached file being uploaded.
", "StartAttachedFileUploadRequest$FileName": "A case-sensitive name of the attached file being uploaded.
" } }, "FileSizeInBytes": { "base": null, "refs": { "AttachedFile$FileSizeInBytes": "The size of the attached file in bytes.
", "GetAttachedFileResponse$FileSizeInBytes": "The size of the attached file in bytes.
", "StartAttachedFileUploadRequest$FileSizeInBytes": "The size of the attached file in bytes.
" } }, "FileStatusType": { "base": null, "refs": { "AttachedFile$FileStatus": "The current status of the attached file.
", "GetAttachedFileResponse$FileStatus": "The current status of the attached file.
", "StartAttachedFileUploadResponse$FileStatus": "The current status of the attached file.
" } }, "FileUseCaseType": { "base": null, "refs": { "AttachedFile$FileUseCaseType": "The use case for the file.
", "GetAttachedFileResponse$FileUseCaseType": "The use case for the file.
", "StartAttachedFileUploadRequest$FileUseCaseType": "The use case for the file.
Only ATTACHMENTS are supported.
Contains the filter to apply when retrieving metrics with the GetMetricDataV2 API.
", "refs": { "FiltersV2List$member": null } }, "FilterValueList": { "base": null, "refs": { "FilterV2$FilterValues": "The identifiers to use for filtering data. For example, if you have a filter key of QUEUE, you would add queue IDs or ARNs in FilterValues.
Contains the filter to apply when retrieving metrics.
", "refs": { "GetCurrentMetricDataRequest$Filters": "The filters to apply to returned metrics. You can filter up to the following limits:
Queues: 100
Routing profiles: 100
Channels: 3 (VOICE, CHAT, and TASK channels are supported.)
RoutingStepExpressions: 50
AgentStatuses: 50
Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource IDs and resource ARNs in the same request.
When using AgentStatuses as filter make sure Queues is added as primary filter.
When using the RoutingStepExpression filter, you need to pass exactly one QueueId. The filter is also case sensitive so when using the RoutingStepExpression filter, grouping by ROUTING_STEP_EXPRESSION is required.
Currently tagging is only supported on the resources that are passed in the filter.
", "GetMetricDataRequest$Filters": "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.
RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.
To filter by Queues, enter the queue ID/ARN, not the name of the queue.
The filters to apply to returned metrics. You can filter on the following resources:
Agents
Campaigns
Channels
Feature
Queues
Routing profiles
Routing step expression
User hierarchy groups
At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.
For metrics for outbound campaigns analytics, you can also use campaigns to satisfy at least one filter requirement.
To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator Guide.
Note the following limits:
Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: AGENT | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | ANSWERING_MACHINE_DETECTION_STATUS | BOT_ID | BOT_ALIAS | BOT_VERSION | BOT_LOCALE | BOT_INTENT_NAME | CAMPAIGN | CAMPAIGN_DELIVERY_EVENT_TYPE | CAMPAIGN_EXCLUDED_EVENT_TYPE | CASE_TEMPLATE_ARN | CASE_STATUS | CHANNEL | contact/segmentAttributes/connect:Subtype | DISCONNECT_REASON | EVALUATION_FORM | EVALUATION_SECTION | EVALUATION_QUESTION | EVALUATION_SOURCE | FEATURE | FLOW_ACTION_ID | FLOW_TYPE | FLOWS_MODULE_RESOURCE_ID | FLOWS_NEXT_RESOURCE_ID | FLOWS_NEXT_RESOURCE_QUEUE_ID | FLOWS_OUTCOME_TYPE | FLOWS_RESOURCE_ID | FORM_VERSION | INITIATION_METHOD | INVOKING_RESOURCE_PUBLISHED_TIMESTAMP | INVOKING_RESOURCE_TYPE | PARENT_FLOWS_RESOURCE_ID | RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION | QUEUE | Q_CONNECT_ENABLED |
Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters.
contact_lens_conversational_analytics is a valid filterValue for the FEATURE filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.
connect:Chat, connect:SMS, connect:Telephony, and connect:WebRTC are valid filterValue examples (not exhaustive) for the contact/segmentAttributes/connect:Subtype filter key.
ROUTING_STEP_EXPRESSION is a valid filter key with a filter value up to 3000 length. This filter is case and order sensitive. JSON string fields must be sorted in ascending order and JSON array order should be kept as is.
Q_CONNECT_ENABLED. TRUE and FALSE are the only valid filterValues for the Q_CONNECT_ENABLED filter key.
TRUE includes all contacts that had Amazon Q in Connect enabled as part of the flow.
FALSE includes all contacts that did not have Amazon Q in Connect enabled as part of the flow
This filter is available only for contact record-driven metrics.
Campaign ARNs are valid filterValues for the CAMPAIGN filter key.
A valid resource type.
", "DisassociateFlowRequest$ResourceType": "A valid resource type.
", "GetFlowAssociationRequest$ResourceType": "A valid resource type.
", "GetFlowAssociationResponse$ResourceType": "A valid resource type.
" } }, "FlowAssociationSummary": { "base": "Information about flow associations.
", "refs": { "FlowAssociationSummaryList$member": null } }, "FlowAssociationSummaryList": { "base": null, "refs": { "BatchGetFlowAssociationResponse$FlowAssociationSummaryList": "Information about flow associations.
", "ListFlowAssociationsResponse$FlowAssociationSummaryList": "Summary of flow associations.
" } }, "FlowContentSha256": { "base": null, "refs": { "ContactFlow$FlowContentSha256": "Indicates the checksum value of the flow content.
", "CreateContactFlowResponse$FlowContentSha256": "Indicates the checksum value of the latest published flow content.
", "CreateContactFlowVersionRequest$FlowContentSha256": "Indicates the checksum value of the flow content.
" } }, "FormId": { "base": null, "refs": { "ContactEvaluation$FormId": "The FormId of the contact evaluation.
The number that identifies the Kinesis Video Streams fragment where the customer audio stream started.
", "RecordingInfo$FragmentStopNumber": "The number that identifies the Kinesis Video Streams fragment where the customer audio stream stopped.
" } }, "FunctionArn": { "base": null, "refs": { "AssociateLambdaFunctionRequest$FunctionArn": "The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is 140.
", "DisassociateLambdaFunctionRequest$FunctionArn": "The Amazon Resource Name (ARN) of the Lambda function being disassociated.
", "FunctionArnsList$member": null } }, "FunctionArnsList": { "base": null, "refs": { "ListLambdaFunctionsResponse$LambdaFunctions": "The Lambdafunction ARNs associated with the specified instance.
" } }, "GetAttachedFileRequest": { "base": "Request to GetAttachedFile API.", "refs": {} }, "GetAttachedFileResponse": { "base": "Response from GetAttachedFile API.", "refs": {} }, "GetContactAttributesRequest": { "base": null, "refs": {} }, "GetContactAttributesResponse": { "base": null, "refs": {} }, "GetContactMetricsRequest": { "base": null, "refs": {} }, "GetContactMetricsResponse": { "base": null, "refs": {} }, "GetCurrentMetricDataRequest": { "base": null, "refs": {} }, "GetCurrentMetricDataResponse": { "base": null, "refs": {} }, "GetCurrentUserDataRequest": { "base": null, "refs": {} }, "GetCurrentUserDataResponse": { "base": null, "refs": {} }, "GetEffectiveHoursOfOperationsRequest": { "base": null, "refs": {} }, "GetEffectiveHoursOfOperationsResponse": { "base": null, "refs": {} }, "GetFederationTokenRequest": { "base": null, "refs": {} }, "GetFederationTokenResponse": { "base": null, "refs": {} }, "GetFlowAssociationRequest": { "base": null, "refs": {} }, "GetFlowAssociationResponse": { "base": null, "refs": {} }, "GetMetricDataRequest": { "base": null, "refs": {} }, "GetMetricDataResponse": { "base": null, "refs": {} }, "GetMetricDataV2Request": { "base": null, "refs": {} }, "GetMetricDataV2Response": { "base": null, "refs": {} }, "GetPromptFileRequest": { "base": null, "refs": {} }, "GetPromptFileResponse": { "base": null, "refs": {} }, "GetTaskTemplateRequest": { "base": null, "refs": {} }, "GetTaskTemplateResponse": { "base": null, "refs": {} }, "GetTrafficDistributionRequest": { "base": null, "refs": {} }, "GetTrafficDistributionResponse": { "base": null, "refs": {} }, "GlobalSignInEndpoint": { "base": null, "refs": { "ReplicationConfiguration$GlobalSignInEndpoint": "The URL that is used to sign-in to your Amazon Connect instance according to your traffic distribution group configuration. For more information about sign-in and traffic distribution groups, see Important things to know in the Create traffic distribution groups topic in the Amazon Connect Administrator Guide.
" } }, "Grouping": { "base": null, "refs": { "Groupings$member": null } }, "GroupingV2": { "base": null, "refs": { "GroupingsV2$member": null } }, "Groupings": { "base": null, "refs": { "GetCurrentMetricDataRequest$Groupings": "Defines the level of aggregation for metrics data by a dimension(s). Its similar to sorting items into buckets based on a common characteristic, then counting or calculating something for each bucket. For example, when grouped by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues.
The grouping list is an ordered list, with the first item in the list defined as the primary grouping. If no grouping is included in the request, the aggregation happens at the instance-level.
If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK channels are supported.
If you group by AGENT_STATUS, you must include the QUEUE as the primary grouping and use queue filter. When you group by AGENT_STATUS, the only metric available is the AGENTS_ONLINE metric.
If you group by ROUTING_PROFILE, you must include either a queue or routing profile filter. In addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED, CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE.
When using the RoutingStepExpression filter, group by ROUTING_STEP_EXPRESSION is required.
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.
If no grouping is specified, a summary of metrics for all queues is returned.
RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.
" } }, "GroupingsV2": { "base": null, "refs": { "GetMetricDataV2Request$Groupings": "The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues.
If no grouping is specified, a summary of all metrics is returned.
Valid grouping keys: AGENT | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | ANSWERING_MACHINE_DETECTION_STATUS | BOT_ID | BOT_ALIAS | BOT_VERSION | BOT_LOCALE | BOT_INTENT_NAME | CAMPAIGN | CAMPAIGN_DELIVERY_EVENT_TYPE | CAMPAIGN_EXCLUDED_EVENT_TYPE | CAMPAIGN_EXECUTION_TIMESTAMP | CASE_TEMPLATE_ARN | CASE_STATUS | CHANNEL | contact/segmentAttributes/connect:Subtype | DISCONNECT_REASON | EVALUATION_FORM | EVALUATION_SECTION | EVALUATION_QUESTION | EVALUATION_SOURCE | FLOWS_RESOURCE_ID | FLOWS_MODULE_RESOURCE_ID | FLOW_ACTION_ID | FLOW_TYPE | FLOWS_OUTCOME_TYPE | FORM_VERSION | INITIATION_METHOD | INVOKING_RESOURCE_PUBLISHED_TIMESTAMP | INVOKING_RESOURCE_TYPE | PARENT_FLOWS_RESOURCE_ID | Q_CONNECT_ENABLED | QUEUE | RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION
Type: Array of strings
Array Members: Maximum number of 4 items
Required: No
" } }, "HierarchyGroup": { "base": "Contains information about a hierarchy group.
", "refs": { "DescribeUserHierarchyGroupResponse$HierarchyGroup": "Information about the hierarchy group.
", "UserHierarchyGroupList$member": null } }, "HierarchyGroupCondition": { "base": "A leaf node condition which can be used to specify a hierarchy group condition.
", "refs": { "AttributeAndCondition$HierarchyGroupCondition": null, "ControlPlaneUserAttributeFilter$HierarchyGroupCondition": null, "UserSearchCriteria$HierarchyGroupCondition": "A leaf node condition which can be used to specify a hierarchy group condition.
" } }, "HierarchyGroupId": { "base": null, "refs": { "CreateSecurityProfileRequest$AllowedAccessControlHierarchyGroupId": "The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.
", "CreateUserHierarchyGroupRequest$ParentGroupId": "The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.
", "CreateUserHierarchyGroupResponse$HierarchyGroupId": "The identifier of the hierarchy group.
", "CreateUserRequest$HierarchyGroupId": "The identifier of the hierarchy group for the user.
", "DeleteUserHierarchyGroupRequest$HierarchyGroupId": "The identifier of the hierarchy group.
", "DescribeUserHierarchyGroupRequest$HierarchyGroupId": "The identifier of the hierarchy group.
", "HierarchyGroup$Id": "The identifier of the hierarchy group.
", "HierarchyGroupIdList$member": null, "HierarchyGroupSummary$Id": "The identifier of the hierarchy group.
", "HierarchyGroupSummaryReference$Id": "The unique identifier for the hierarchy group.
", "SecurityProfile$AllowedAccessControlHierarchyGroupId": "The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.
", "UpdateSecurityProfileRequest$AllowedAccessControlHierarchyGroupId": "The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.
", "UpdateUserHierarchyGroupNameRequest$HierarchyGroupId": "The identifier of the hierarchy group.
", "UpdateUserHierarchyRequest$HierarchyGroupId": "The identifier of the hierarchy group.
", "User$HierarchyGroupId": "The identifier of the hierarchy group for the user.
", "UserDataHierarchyGroups$member": null, "UserSearchSummary$HierarchyGroupId": "The identifier of the user's hierarchy group.
" } }, "HierarchyGroupIdList": { "base": null, "refs": { "AgentHierarchyGroups$L1Ids": "The identifiers for level 1 hierarchy groups.
", "AgentHierarchyGroups$L2Ids": "The identifiers for level 2 hierarchy groups.
", "AgentHierarchyGroups$L3Ids": "The identifiers for level 3 hierarchy groups.
", "AgentHierarchyGroups$L4Ids": "The identifiers for level 4 hierarchy groups.
", "AgentHierarchyGroups$L5Ids": "The identifiers for level 5 hierarchy groups.
" } }, "HierarchyGroupMatchType": { "base": null, "refs": { "HierarchyGroupCondition$HierarchyGroupMatchType": "The type of hierarchy group match.
" } }, "HierarchyGroupName": { "base": null, "refs": { "CreateUserHierarchyGroupRequest$Name": "The name of the user hierarchy group. Must not be more than 100 characters.
", "HierarchyGroup$Name": "The name of the hierarchy group.
", "HierarchyGroupSummary$Name": "The name of the hierarchy group.
", "UpdateUserHierarchyGroupNameRequest$Name": "The name of the hierarchy group. Must not be more than 100 characters.
" } }, "HierarchyGroupSummary": { "base": "Contains summary information about a hierarchy group.
", "refs": { "HierarchyGroupSummaryList$member": null, "HierarchyPath$LevelOne": "Information about level one.
", "HierarchyPath$LevelTwo": "Information about level two.
", "HierarchyPath$LevelThree": "Information about level three.
", "HierarchyPath$LevelFour": "Information about level four.
", "HierarchyPath$LevelFive": "Information about level five.
" } }, "HierarchyGroupSummaryList": { "base": null, "refs": { "ListUserHierarchyGroupsResponse$UserHierarchyGroupSummaryList": "Information about the hierarchy groups.
" } }, "HierarchyGroupSummaryReference": { "base": "Information about the hierarchy group.
", "refs": { "HierarchyPathReference$LevelOne": "Information about level one.
", "HierarchyPathReference$LevelTwo": "Information about level two.
", "HierarchyPathReference$LevelThree": "Information about level three.
", "HierarchyPathReference$LevelFour": "Information about level four.
", "HierarchyPathReference$LevelFive": "Information about level five.
" } }, "HierarchyGroups": { "base": "Information about the agent hierarchy. Hierarchies can be configured with up to five levels.
", "refs": { "AgentInfo$HierarchyGroups": "The agent hierarchy groups for the agent.
" } }, "HierarchyLevel": { "base": "Contains information about a hierarchy level.
", "refs": { "HierarchyStructure$LevelOne": "Information about level one.
", "HierarchyStructure$LevelTwo": "Information about level two.
", "HierarchyStructure$LevelThree": "Information about level three.
", "HierarchyStructure$LevelFour": "Information about level four.
", "HierarchyStructure$LevelFive": "Information about level five.
" } }, "HierarchyLevelId": { "base": null, "refs": { "HierarchyGroup$LevelId": "The identifier of the level in the hierarchy group.
", "HierarchyLevel$Id": "The identifier of the hierarchy level.
" } }, "HierarchyLevelName": { "base": null, "refs": { "HierarchyLevel$Name": "The name of the hierarchy level.
", "HierarchyLevelUpdate$Name": "The name of the user hierarchy level. Must not be more than 50 characters.
" } }, "HierarchyLevelUpdate": { "base": "Contains information about the hierarchy level to update.
", "refs": { "HierarchyStructureUpdate$LevelOne": "The update for level one.
", "HierarchyStructureUpdate$LevelTwo": "The update for level two.
", "HierarchyStructureUpdate$LevelThree": "The update for level three.
", "HierarchyStructureUpdate$LevelFour": "The update for level four.
", "HierarchyStructureUpdate$LevelFive": "The update for level five.
" } }, "HierarchyPath": { "base": "Contains information about the levels of a hierarchy group.
", "refs": { "HierarchyGroup$HierarchyPath": "Information about the levels in the hierarchy group.
" } }, "HierarchyPathReference": { "base": "Information about the levels in the hierarchy group.
", "refs": { "UserData$HierarchyPath": "Contains information about the levels of a hierarchy group assigned to a user.
" } }, "HierarchyRestrictedResourceList": { "base": null, "refs": { "CreateSecurityProfileRequest$HierarchyRestrictedResources": "The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: User.
The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: User.
The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: User.
Contains information about a hierarchy structure.
", "refs": { "DescribeUserHierarchyStructureResponse$HierarchyStructure": "Information about the hierarchy structure.
" } }, "HierarchyStructureUpdate": { "base": "Contains information about the level hierarchy to update.
", "refs": { "UpdateUserHierarchyStructureRequest$HierarchyStructure": "The hierarchy levels to update.
" } }, "HistoricalMetric": { "base": "Contains information about a historical metric.
", "refs": { "HistoricalMetricData$Metric": "Information about the metric.
", "HistoricalMetrics$member": null } }, "HistoricalMetricData": { "base": "Contains the data for a historical metric.
", "refs": { "HistoricalMetricDataCollections$member": null } }, "HistoricalMetricDataCollections": { "base": null, "refs": { "HistoricalMetricResult$Collections": "The set of metrics.
" } }, "HistoricalMetricName": { "base": "The historical metric names.
", "refs": { "HistoricalMetric$Name": "The name of the metric. Following is a list of each supported metric mapped to the UI name, linked to a detailed description in the Amazon Connect Administrator Guide.
Unit: SECONDS
Statistic: AVG
UI name: Average queue abandon time
Unit: SECONDS
Statistic: AVG
UI name: After contact work time
Unit: COUNT
Statistic: SUM
UI name: API contacts handled
Unit: SECONDS
Statistic: AVG
UI name: Average customer hold time
Unit: COUNT
Statistic: SUM
UI name: Callback contacts handled
Unit: COUNT
Statistic: SUM
UI name: Contacts abandoned
Unit: COUNT
Statistic: SUM
UI name: Contacts agent hung up first
Unit: COUNT
Statistic: SUM
UI name: Contacts consulted
Unit: COUNT
Statistic: SUM
UI name: Contacts handled
Unit: COUNT
Statistic: SUM
UI name: Contacts handled incoming
Unit: COUNT
Statistic: SUM
UI name: Contacts handled outbound
Unit: COUNT
Statistic: SUM
UI name: Contacts hold disconnect
Unit: COUNT
Statistic: SUM
UI name: AGENT_NON_RESPONSE
Unit: COUNT
Statistic: SUM
UI name: Contacts queued
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred in
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out queue
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out queue
Unit: SECONDS
Statistic: AVG
UI name: Average handle time
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
UI name: Average agent interaction time
Unit: PERCENT
Statistic: AVG
UI name: Occupancy
Unit: SECONDS
Statistic: AVG
UI name: Average queue answer time
Unit: SECONDS
Statistic: MAX
UI name: Minimum flow time
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: PERCENT
Statistic: AVG
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").
UI name: Service level X
Contains information about the historical metrics retrieved.
", "refs": { "HistoricalMetricResults$member": null } }, "HistoricalMetricResults": { "base": null, "refs": { "GetMetricDataResponse$MetricResults": "Information about the historical metrics.
If no grouping is specified, a summary of metric data is returned.
" } }, "HistoricalMetrics": { "base": null, "refs": { "GetMetricDataRequest$HistoricalMetrics": "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 Metrics definition in the Amazon Connect Administrator Guide.
This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).
Unit: SECONDS
Statistic: AVG
UI name: Average queue abandon time
Unit: SECONDS
Statistic: AVG
UI name: After contact work time
Unit: COUNT
Statistic: SUM
UI name: API contacts handled
Unit: SECONDS
Statistic: AVG
UI name: Average customer hold time
Unit: COUNT
Statistic: SUM
UI name: Callback contacts handled
Unit: COUNT
Statistic: SUM
UI name: Contacts abandoned
Unit: COUNT
Statistic: SUM
UI name: Contacts agent hung up first
Unit: COUNT
Statistic: SUM
UI name: Contacts consulted
Unit: COUNT
Statistic: SUM
UI name: Contacts handled
Unit: COUNT
Statistic: SUM
UI name: Contacts handled incoming
Unit: COUNT
Statistic: SUM
UI name: Contacts handled outbound
Unit: COUNT
Statistic: SUM
UI name: Contacts hold disconnect
Unit: COUNT
Statistic: SUM
UI name: AGENT_NON_RESPONSE
Unit: COUNT
Statistic: SUM
UI name: Contacts queued
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred in
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out queue
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out queue
Unit: SECONDS
Statistic: AVG
UI name: Average handle time
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
UI name: Average agent interaction time
Unit: PERCENT
Statistic: AVG
UI name: Occupancy
Unit: SECONDS
Statistic: AVG
UI name: Average queue answer time
Unit: SECONDS
Statistic: MAX
UI name: Minimum flow time
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: PERCENT
Statistic: AVG
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").
UI name: Average queue abandon time
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.
The default value is 0, indicating that the stream does not persist data.
" } }, "Hours24Format": { "base": null, "refs": { "HoursOfOperationTimeSlice$Hours": "The hours.
", "OverrideTimeSlice$Hours": "The hours.
" } }, "HoursOfOperation": { "base": "Information about of the hours of operation.
", "refs": { "DescribeHoursOfOperationResponse$HoursOfOperation": "The hours of operation.
", "HoursOfOperationList$member": null } }, "HoursOfOperationConfig": { "base": "Contains information about the hours of operation.
", "refs": { "HoursOfOperationConfigList$member": null } }, "HoursOfOperationConfigList": { "base": null, "refs": { "CreateHoursOfOperationRequest$Config": "Configuration information for the hours of operation: day, start time, and end time.
", "HoursOfOperation$Config": "Configuration information for the hours of operation.
", "UpdateHoursOfOperationRequest$Config": "Configuration information of the hours of operation.
" } }, "HoursOfOperationDays": { "base": null, "refs": { "HoursOfOperationConfig$Day": "The day that the hours of operation applies to.
" } }, "HoursOfOperationDescription": { "base": null, "refs": { "CreateHoursOfOperationRequest$Description": "The description of the hours of operation.
", "HoursOfOperation$Description": "The description for the hours of operation.
" } }, "HoursOfOperationId": { "base": null, "refs": { "CreateHoursOfOperationOverrideRequest$HoursOfOperationId": "The identifier for the hours of operation
", "CreateHoursOfOperationResponse$HoursOfOperationId": "The identifier for the hours of operation.
", "CreateQueueRequest$HoursOfOperationId": "The identifier for the hours of operation.
", "DeleteHoursOfOperationOverrideRequest$HoursOfOperationId": "The identifier for the hours of operation.
", "DeleteHoursOfOperationRequest$HoursOfOperationId": "The identifier for the hours of operation.
", "DescribeHoursOfOperationOverrideRequest$HoursOfOperationId": "The identifier for the hours of operation.
", "DescribeHoursOfOperationRequest$HoursOfOperationId": "The identifier for the hours of operation.
", "GetEffectiveHoursOfOperationsRequest$HoursOfOperationId": "The identifier for the hours of operation.
", "HoursOfOperation$HoursOfOperationId": "The identifier for the hours of operation.
", "HoursOfOperationOverride$HoursOfOperationId": "The identifier for the hours of operation.
", "HoursOfOperationSummary$Id": "The identifier of the hours of operation.
", "ListHoursOfOperationOverridesRequest$HoursOfOperationId": "The identifier for the hours of operation.
", "Queue$HoursOfOperationId": "The identifier for the hours of operation.
", "UpdateHoursOfOperationOverrideRequest$HoursOfOperationId": "The identifier for the hours of operation.
", "UpdateHoursOfOperationRequest$HoursOfOperationId": "The identifier of the hours of operation.
", "UpdateQueueHoursOfOperationRequest$HoursOfOperationId": "The identifier for the hours of operation.
" } }, "HoursOfOperationList": { "base": null, "refs": { "SearchHoursOfOperationsResponse$HoursOfOperations": "Information about the hours of operations.
" } }, "HoursOfOperationName": { "base": null, "refs": { "HoursOfOperationSummary$Name": "The name of the hours of operation.
" } }, "HoursOfOperationOverride": { "base": "Information about the hours of operations override.
", "refs": { "DescribeHoursOfOperationOverrideResponse$HoursOfOperationOverride": "Information about the hours of operations override.
", "HoursOfOperationOverrideList$member": null } }, "HoursOfOperationOverrideConfig": { "base": "Information about the hours of operation override config: day, start time, and end time.
", "refs": { "HoursOfOperationOverrideConfigList$member": null } }, "HoursOfOperationOverrideConfigList": { "base": null, "refs": { "CreateHoursOfOperationOverrideRequest$Config": "Configuration information for the hours of operation override: day, start time, and end time.
", "HoursOfOperationOverride$Config": "Configuration information for the hours of operation override: day, start time, and end time.
", "UpdateHoursOfOperationOverrideRequest$Config": "Configuration information for the hours of operation override: day, start time, and end time.
" } }, "HoursOfOperationOverrideId": { "base": null, "refs": { "CreateHoursOfOperationOverrideResponse$HoursOfOperationOverrideId": "The identifier for the hours of operation override.
", "DeleteHoursOfOperationOverrideRequest$HoursOfOperationOverrideId": "The identifier for the hours of operation override.
", "DescribeHoursOfOperationOverrideRequest$HoursOfOperationOverrideId": "The identifier for the hours of operation override.
", "HoursOfOperationOverride$HoursOfOperationOverrideId": "The identifier for the hours of operation override.
", "UpdateHoursOfOperationOverrideRequest$HoursOfOperationOverrideId": "The identifier for the hours of operation override.
" } }, "HoursOfOperationOverrideList": { "base": null, "refs": { "ListHoursOfOperationOverridesResponse$HoursOfOperationOverrideList": "Information about the hours of operation override.
", "SearchHoursOfOperationOverridesResponse$HoursOfOperationOverrides": "Information about the hours of operations overrides.
" } }, "HoursOfOperationOverrideSearchConditionList": { "base": null, "refs": { "HoursOfOperationOverrideSearchCriteria$OrConditions": "A list of conditions which would be applied together with an OR condition.
", "HoursOfOperationOverrideSearchCriteria$AndConditions": "A list of conditions which would be applied together with an AND condition.
" } }, "HoursOfOperationOverrideSearchCriteria": { "base": "The search criteria to be used to return hours of operations overrides.
", "refs": { "HoursOfOperationOverrideSearchConditionList$member": null, "SearchHoursOfOperationOverridesRequest$SearchCriteria": "The search criteria to be used to return hours of operations overrides.
" } }, "HoursOfOperationOverrideYearMonthDayDateFormat": { "base": null, "refs": { "CreateHoursOfOperationOverrideRequest$EffectiveFrom": "The date from when the hours of operation override is effective.
", "CreateHoursOfOperationOverrideRequest$EffectiveTill": "The date until when the hours of operation override is effective.
", "EffectiveHoursOfOperations$Date": "The date that the hours of operation or overrides applies to.
", "GetEffectiveHoursOfOperationsRequest$FromDate": "The date from when the hours of operation are listed.
", "GetEffectiveHoursOfOperationsRequest$ToDate": "The date until when the hours of operation are listed.
", "HoursOfOperationOverride$EffectiveFrom": "The date from which the hours of operation override would be effective.
", "HoursOfOperationOverride$EffectiveTill": "The date till which the hours of operation override would be effective.
", "UpdateHoursOfOperationOverrideRequest$EffectiveFrom": "The date from when the hours of operation override would be effective.
", "UpdateHoursOfOperationOverrideRequest$EffectiveTill": "The date till when the hours of operation override would be effective.
" } }, "HoursOfOperationSearchConditionList": { "base": null, "refs": { "HoursOfOperationSearchCriteria$OrConditions": "A list of conditions which would be applied together with an OR condition.
", "HoursOfOperationSearchCriteria$AndConditions": "A list of conditions which would be applied together with an AND condition.
" } }, "HoursOfOperationSearchCriteria": { "base": "The search criteria to be used to return hours of operations.
", "refs": { "HoursOfOperationSearchConditionList$member": null, "SearchHoursOfOperationsRequest$SearchCriteria": "The search criteria to be used to return hours of operations.
" } }, "HoursOfOperationSearchFilter": { "base": "Filters to be applied to search results.
", "refs": { "SearchHoursOfOperationOverridesRequest$SearchFilter": null, "SearchHoursOfOperationsRequest$SearchFilter": "Filters to be applied to search results.
" } }, "HoursOfOperationSummary": { "base": "Contains summary information about hours of operation for a contact center.
", "refs": { "HoursOfOperationSummaryList$member": null } }, "HoursOfOperationSummaryList": { "base": null, "refs": { "ListHoursOfOperationsResponse$HoursOfOperationSummaryList": "Information about the hours of operation.
" } }, "HoursOfOperationTimeSlice": { "base": "The start time or end time for an hours of operation.
", "refs": { "HoursOfOperationConfig$StartTime": "The start time that your contact center opens.
", "HoursOfOperationConfig$EndTime": "The end time that your contact center closes.
" } }, "ISO8601Datetime": { "base": null, "refs": { "AttachedFile$CreationTime": "The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.
The email address creation timestamp in ISO 8601 Datetime.
", "DescribeEmailAddressResponse$ModifiedTimestamp": "The email address last modification timestamp in ISO 8601 Datetime.
", "DownloadUrlMetadata$UrlExpiry": "The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
", "GetAttachedFileResponse$CreationTime": "The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.
The expiration of the token. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
", "StartAttachedFileUploadResponse$CreationTime": "The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.
The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
An entity with the same name already exists.
", "refs": {} }, "ImportPhoneNumberRequest": { "base": null, "refs": {} }, "ImportPhoneNumberResponse": { "base": null, "refs": {} }, "InboundAdditionalRecipients": { "base": "Information about the additional TO and CC recipients of an inbound email contact.
You can include up to 50 email addresses in total, distributed across DestinationEmailAddress, ToAddresses, and CcAddresses. This total must include one required DestinationEmailAddress. You can then specify up to 49 addresses allocated across ToAddresses and CcAddresses as needed.
The additional recipients address of the email.
" } }, "InboundCallsEnabled": { "base": null, "refs": { "CreateInstanceRequest$InboundCallsEnabled": "Your contact center handles incoming contacts.
", "Instance$InboundCallsEnabled": "Whether inbound calls are enabled.
", "InstanceSummary$InboundCallsEnabled": "Whether inbound calls are enabled.
" } }, "InboundEmailContent": { "base": "Information about email body content.
", "refs": { "StartEmailContactRequest$EmailMessage": "The email message body to be sent to the newly created email.
" } }, "InboundMessageSourceType": { "base": null, "refs": { "InboundEmailContent$MessageSourceType": "The message source type, that is, RAW.
Information about the raw email body content.
", "refs": { "InboundEmailContent$RawMessage": "The raw email body content.
" } }, "InboundSubject": { "base": null, "refs": { "InboundRawMessage$Subject": "The email subject.
" } }, "IncludeRawMessage": { "base": null, "refs": { "ContactConfiguration$IncludeRawMessage": "Whether to include raw connect message in the push notification payload. Default is False.
Information about the index of the routing criteria.
" } }, "InitiateAs": { "base": null, "refs": { "CreateContactRequest$InitiateAs": "Initial state of the contact when it's created. Only TASK channel contacts can be initiated with COMPLETED state.
The list of initiation methods associated with contacts.
" } }, "InputPredefinedAttributeConfiguration": { "base": "Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.
", "refs": { "CreatePredefinedAttributeRequest$AttributeConfiguration": "Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.
", "UpdatePredefinedAttributeRequest$AttributeConfiguration": "Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.
" } }, "Instance": { "base": "The Amazon Connect instance.
", "refs": { "DescribeInstanceResponse$Instance": "The name of the instance.
" } }, "InstanceArn": { "base": null, "refs": { "TrafficDistributionGroup$InstanceArn": "The Amazon Resource Name (ARN).
", "TrafficDistributionGroupSummary$InstanceArn": "The Amazon Resource Name (ARN) of the traffic distribution group.
" } }, "InstanceAttributeType": { "base": null, "refs": { "Attribute$AttributeType": "The type of attribute.
", "DescribeInstanceAttributeRequest$AttributeType": "The type of attribute.
", "UpdateInstanceAttributeRequest$AttributeType": "The type of attribute.
Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, contact Amazon Web Services Support for allowlisting.
The value of the attribute.
", "UpdateInstanceAttributeRequest$Value": "The value for the attribute. Maximum character limit is 100.
" } }, "InstanceId": { "base": null, "refs": { "ActivateEvaluationFormRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "AssociateAnalyticsDataSetRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "AssociateApprovedOriginRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "AssociateBotRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "AssociateDefaultVocabularyRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "AssociateFlowRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "AssociateInstanceStorageConfigRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "AssociateLambdaFunctionRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "AssociateLexBotRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "AssociatePhoneNumberContactFlowRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "AssociateQueueQuickConnectsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "AssociateRoutingProfileQueuesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "AssociateSecurityKeyRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "AssociateTrafficDistributionGroupUserRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "AssociateUserProficienciesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN of the instance).
", "BatchAssociateAnalyticsDataSetRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "BatchDisassociateAnalyticsDataSetRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "BatchGetAttachedFileMetadataRequest$InstanceId": "The unique identifier of the Connect instance.
", "BatchGetFlowAssociationRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "BatchPutContactRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ClaimPhoneNumberRequest$InstanceId": "The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.
The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "CompleteAttachedFileUploadRequest$InstanceId": "The unique identifier of the Amazon Connect instance.
", "CreateAgentStatusRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "CreateContactFlowModuleRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "CreateContactFlowRequest$InstanceId": "The identifier of the Amazon Connect instance.
", "CreateContactFlowVersionRequest$InstanceId": "The identifier of the Amazon Connect instance.
", "CreateContactRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "CreateEmailAddressRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "CreateEvaluationFormRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "CreateHoursOfOperationOverrideRequest$InstanceId": "The identifier of the Amazon Connect instance.
", "CreateHoursOfOperationRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "CreateInstanceResponse$Id": "The identifier for the instance.
", "CreateIntegrationAssociationRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "CreateParticipantRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "CreatePersistentContactAssociationRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "CreatePredefinedAttributeRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "CreatePromptRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "CreatePushNotificationRegistrationRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "CreateQueueRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "CreateQuickConnectRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "CreateRoutingProfileRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "CreateRuleRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "CreateSecurityProfileRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "CreateTaskTemplateRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "CreateUseCaseRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "CreateUserHierarchyGroupRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "CreateUserRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "CreateVocabularyRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DeactivateEvaluationFormRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DefaultVocabulary$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DeleteAttachedFileRequest$InstanceId": "The unique identifier of the Connect instance.
", "DeleteContactEvaluationRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DeleteContactFlowModuleRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DeleteContactFlowRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DeleteContactFlowVersionRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DeleteEmailAddressRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DeleteEvaluationFormRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DeleteHoursOfOperationOverrideRequest$InstanceId": "The identifier of the Amazon Connect instance.
", "DeleteHoursOfOperationRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DeleteInstanceRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DeleteIntegrationAssociationRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DeletePredefinedAttributeRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DeletePromptRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DeletePushNotificationRegistrationRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DeleteQueueRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DeleteQuickConnectRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DeleteRoutingProfileRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DeleteRuleRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DeleteSecurityProfileRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DeleteTaskTemplateRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DeleteUseCaseRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DeleteUserHierarchyGroupRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DeleteUserRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DeleteVocabularyRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DescribeAgentStatusRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DescribeAuthenticationProfileRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DescribeContactEvaluationRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DescribeContactFlowModuleRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DescribeContactFlowRequest$InstanceId": "The identifier of the Amazon Connect instance.
", "DescribeContactRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DescribeEmailAddressRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DescribeEvaluationFormRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DescribeHoursOfOperationOverrideRequest$InstanceId": "The identifier of the Amazon Connect instance.
", "DescribeHoursOfOperationRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DescribeInstanceAttributeRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DescribeInstanceRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DescribeInstanceStorageConfigRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DescribePredefinedAttributeRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DescribePromptRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DescribeQueueRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DescribeQuickConnectRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DescribeRoutingProfileRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DescribeRuleRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DescribeSecurityProfileRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DescribeUserHierarchyGroupRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DescribeUserHierarchyStructureRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DescribeUserRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DescribeVocabularyRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DisassociateAnalyticsDataSetRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DisassociateApprovedOriginRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DisassociateBotRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DisassociateFlowRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DisassociateInstanceStorageConfigRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DisassociateLambdaFunctionRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance..
", "DisassociateLexBotRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DisassociatePhoneNumberContactFlowRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DisassociateQueueQuickConnectsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DisassociateRoutingProfileQueuesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DisassociateSecurityKeyRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DisassociateTrafficDistributionGroupUserRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DisassociateUserProficienciesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "DismissUserContactRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", "GetAttachedFileRequest$InstanceId": "The unique identifier of the Amazon Connect instance.
", "GetContactAttributesRequest$InstanceId": "The identifier of the Amazon Connect instance.
", "GetCurrentMetricDataRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "GetCurrentUserDataRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "GetEffectiveHoursOfOperationsRequest$InstanceId": "The identifier of the Amazon Connect instance.
", "GetFederationTokenRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "GetFlowAssociationRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "GetMetricDataRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "GetPromptFileRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "GetTaskTemplateRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "GetTaskTemplateResponse$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ImportPhoneNumberRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "Instance$Id": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "InstanceSummary$Id": "The identifier of the instance.
", "IntegrationAssociationSummary$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListAgentStatusRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListAnalyticsDataAssociationsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListAnalyticsDataLakeDataSetsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListApprovedOriginsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListAssociatedContactsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListAuthenticationProfilesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListBotsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListContactEvaluationsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListContactFlowModulesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListContactFlowVersionsRequest$InstanceId": "The identifier of the Amazon Connect instance.
", "ListContactFlowsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListContactReferencesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListDefaultVocabulariesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListEvaluationFormVersionsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListEvaluationFormsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListFlowAssociationsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListHoursOfOperationOverridesRequest$InstanceId": "The identifier of the Amazon Connect instance.
", "ListHoursOfOperationsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListInstanceAttributesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListInstanceStorageConfigsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListIntegrationAssociationsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListLambdaFunctionsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListLexBotsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListPhoneNumbersRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListPhoneNumbersSummary$InstanceId": "The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListPhoneNumbersV2Request$InstanceId": "The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. If both TargetArn and InstanceId are not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same AWS Region as the request.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListPromptsRequest$InstanceId": "The identifier of the Amazon Connect instance.
", "ListQueueQuickConnectsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListQueuesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListQuickConnectsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListRealtimeContactAnalysisSegmentsV2Request$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListRoutingProfileQueuesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListRoutingProfilesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListRulesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListSecurityKeysRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListSecurityProfileApplicationsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListSecurityProfilePermissionsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListSecurityProfilesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListTaskTemplatesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListUseCasesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListUserHierarchyGroupsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListUserProficienciesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ListUsersRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "MonitorContactRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", "PauseContactRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ReplicateInstanceResponse$Id": "The identifier of the replicated instance. You can find the instanceId in the ARN of the instance. The replicated instance has the same identifier as the instance it was replicated from.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ResumeContactRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "SearchAgentStatusesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", "SearchAvailablePhoneNumbersRequest$InstanceId": "The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "SearchContactFlowsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "SearchContactsRequest$InstanceId": "The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "SearchEmailAddressesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "SearchHoursOfOperationOverridesRequest$InstanceId": "The identifier of the Amazon Connect instance.
", "SearchHoursOfOperationsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "SearchPredefinedAttributesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "SearchPromptsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "SearchQueuesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "SearchQuickConnectsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "SearchRoutingProfilesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "SearchSecurityProfilesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "SearchUserHierarchyGroupsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", "SearchUsersRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "SearchVocabulariesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "SecurityProfile$OrganizationResourceId": "The organization resource identifier for the security profile.
", "SecurityProfileSearchSummary$OrganizationResourceId": "The organization resource identifier.
", "SendOutboundEmailRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "StartAttachedFileUploadRequest$InstanceId": "The unique identifier of the Amazon Connect instance.
", "StartChatContactRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "StartContactEvaluationRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "StartContactRecordingRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "StartContactStreamingRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "StartEmailContactRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "StartOutboundChatContactRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "StartOutboundEmailContactRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "StartOutboundVoiceContactRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "StartScreenSharingRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "StartTaskContactRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "StartWebRTCContactRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "StopContactRecordingRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "StopContactRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "StopContactStreamingRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "SubmitContactEvaluationRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "SuspendContactRecordingRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "TagContactRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "TransferContactRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UntagContactRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateAgentStatusRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateAuthenticationProfileRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateContactAttributesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateContactEvaluationRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateContactFlowContentRequest$InstanceId": "The identifier of the Amazon Connect instance.
", "UpdateContactFlowMetadataRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateContactFlowModuleContentRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateContactFlowModuleMetadataRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateContactFlowNameRequest$InstanceId": "The identifier of the Amazon Connect instance.
", "UpdateContactRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateContactRoutingDataRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateContactScheduleRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateEmailAddressMetadataRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateEvaluationFormRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateHoursOfOperationOverrideRequest$InstanceId": "The identifier of the Amazon Connect instance.
", "UpdateHoursOfOperationRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateInstanceAttributeRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateInstanceStorageConfigRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateParticipantAuthenticationRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateParticipantRoleConfigRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdatePhoneNumberRequest$InstanceId": "The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdatePromptRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateQueueHoursOfOperationRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateQueueMaxContactsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateQueueNameRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateQueueOutboundCallerConfigRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateQueueOutboundEmailConfigRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateQueueStatusRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateQuickConnectConfigRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateQuickConnectNameRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateRoutingProfileAgentAvailabilityTimerRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateRoutingProfileConcurrencyRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateRoutingProfileDefaultOutboundQueueRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateRoutingProfileNameRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateRoutingProfileQueuesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateRuleRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateSecurityProfileRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateTaskTemplateRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateTaskTemplateResponse$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateUserHierarchyGroupNameRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateUserHierarchyRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateUserHierarchyStructureRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateUserIdentityInfoRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateUserPhoneConfigRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateUserProficienciesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateUserRoutingProfileRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "UpdateUserSecurityProfilesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
" } }, "InstanceIdOrArn": { "base": null, "refs": { "CreateTrafficDistributionGroupRequest$InstanceId": "The identifier of the Amazon Connect instance that has been replicated. You can find the instanceId in the ARN of the instance.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "GetContactMetricsRequest$ContactId": "The identifier of the contact in this instance of Amazon Connect.
", "ListTrafficDistributionGroupsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ReplicateInstanceRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You can provide the InstanceId, or the entire ARN.
The identifier of the Amazon Connect instance. You can find the instanceId in the Amazon Resource Name (ARN) of the instance.
" } }, "InstanceReplicationStatus": { "base": null, "refs": { "ReplicationStatusSummary$ReplicationStatus": "The state of the replication.
" } }, "InstanceStatus": { "base": null, "refs": { "Instance$InstanceStatus": "The state of the instance.
", "InstanceSummary$InstanceStatus": "The state of the instance.
" } }, "InstanceStatusReason": { "base": "Relevant details why the instance was not successfully created.
", "refs": { "Instance$StatusReason": "Relevant details why the instance was not successfully created.
" } }, "InstanceStorageConfig": { "base": "The storage configuration for the instance.
", "refs": { "AssociateInstanceStorageConfigRequest$StorageConfig": "A valid storage type.
", "DescribeInstanceStorageConfigResponse$StorageConfig": "A valid storage type.
", "InstanceStorageConfigs$member": null, "UpdateInstanceStorageConfigRequest$StorageConfig": null } }, "InstanceStorageConfigs": { "base": null, "refs": { "ListInstanceStorageConfigsResponse$StorageConfigs": "A valid storage type.
" } }, "InstanceStorageResourceType": { "base": null, "refs": { "AssociateInstanceStorageConfigRequest$ResourceType": "A valid resource type. To enable streaming for real-time analysis of contacts, use the following types:
For chat contacts, use REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS.
For voice contacts, use REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS.
REAL_TIME_CONTACT_ANALYSIS_SEGMENTS is deprecated, but it is still supported and will apply only to VOICE channel contacts. Use REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS for voice contacts moving forward.
If you have previously associated a stream with REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, no action is needed to update the stream to REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS.
A valid resource type.
", "DisassociateInstanceStorageConfigRequest$ResourceType": "A valid resource type.
", "ListInstanceStorageConfigsRequest$ResourceType": "A valid resource type.
", "UpdateInstanceStorageConfigRequest$ResourceType": "A valid resource type.
" } }, "InstanceSummary": { "base": "Information about the instance.
", "refs": { "InstanceSummaryList$member": null } }, "InstanceSummaryList": { "base": null, "refs": { "ListInstancesResponse$InstanceSummaryList": "Information about the instances.
" } }, "Integer": { "base": null, "refs": { "EvaluationFormNumericQuestionOption$MinValue": "The minimum answer value of the range option.
", "EvaluationFormNumericQuestionOption$MaxValue": "The maximum answer value of the range option.
", "EvaluationFormNumericQuestionProperties$MinValue": "The minimum answer value.
", "EvaluationFormNumericQuestionProperties$MaxValue": "The maximum answer value.
" } }, "IntegerCount": { "base": null, "refs": { "ChannelToCountMap$value": null } }, "IntegrationAssociationId": { "base": null, "refs": { "CreateIntegrationAssociationResponse$IntegrationAssociationId": "The identifier for the integration association.
", "CreateUseCaseRequest$IntegrationAssociationId": "The identifier for the integration association.
", "DeleteIntegrationAssociationRequest$IntegrationAssociationId": "The identifier for the integration association.
", "DeleteUseCaseRequest$IntegrationAssociationId": "The identifier for the integration association.
", "IntegrationAssociationSummary$IntegrationAssociationId": "The identifier for the AppIntegration association.
", "ListUseCasesRequest$IntegrationAssociationId": "The identifier for the integration association.
", "RuleTriggerEventSource$IntegrationAssociationId": "The identifier for the integration association.
" } }, "IntegrationAssociationSummary": { "base": "Contains summary information about the associated AppIntegrations.
", "refs": { "IntegrationAssociationSummaryList$member": null } }, "IntegrationAssociationSummaryList": { "base": null, "refs": { "ListIntegrationAssociationsResponse$IntegrationAssociationSummaryList": "The associations.
" } }, "IntegrationType": { "base": null, "refs": { "CreateIntegrationAssociationRequest$IntegrationType": "The type of information to be ingested.
", "IntegrationAssociationSummary$IntegrationType": "The integration type.
", "ListIntegrationAssociationsRequest$IntegrationType": "The integration type.
" } }, "InternalServiceException": { "base": "Request processing failed because of an error or failure with the service.
", "refs": {} }, "IntervalDetails": { "base": "Information about the interval period to use for returning results.
", "refs": { "GetMetricDataV2Request$Interval": "The interval period and timezone to apply to returned metrics.
IntervalPeriod: An aggregated grouping applied to request metrics. Valid IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY | WEEK | TOTAL.
For example, if IntervalPeriod is selected THIRTY_MIN, StartTime and EndTime differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on the TOTAL interval period.
The following list describes restrictions on StartTime and EndTime based on which IntervalPeriod is requested.
FIFTEEN_MIN: The difference between StartTime and EndTime must be less than 3 days.
THIRTY_MIN: The difference between StartTime and EndTime must be less than 3 days.
HOUR: The difference between StartTime and EndTime must be less than 3 days.
DAY: The difference between StartTime and EndTime must be less than 35 days.
WEEK: The difference between StartTime and EndTime must be less than 35 days.
TOTAL: The difference between StartTime and EndTime must be less than 35 days.
TimeZone: The timezone applied to requested metrics.
IntervalPeriod: An aggregated grouping applied to request metrics. Valid IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY | WEEK | TOTAL.
For example, if IntervalPeriod is selected THIRTY_MIN, StartTime and EndTime differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on the TOTAL interval period.
The following list describes restrictions on StartTime and EndTime based on what IntervalPeriod is requested.
FIFTEEN_MIN: The difference between StartTime and EndTime must be less than 3 days.
THIRTY_MIN: The difference between StartTime and EndTime must be less than 3 days.
HOUR: The difference between StartTime and EndTime must be less than 3 days.
DAY: The difference between StartTime and EndTime must be less than 35 days.
WEEK: The difference between StartTime and EndTime must be less than 35 days.
TOTAL: The difference between StartTime and EndTime must be less than 35 days.
The interval period provided in the API request.
" } }, "InvalidContactFlowException": { "base": "The flow is not valid.
", "refs": {} }, "InvalidContactFlowModuleException": { "base": "The problems with the module. Please fix before trying again.
", "refs": {} }, "InvalidParameterException": { "base": "One or more of the specified parameters are not valid.
", "refs": {} }, "InvalidRequestException": { "base": "The request is not valid.
", "refs": {} }, "InvalidRequestExceptionReason": { "base": "Reason why the request was invalid.
", "refs": { "InvalidRequestException$Reason": null } }, "InvisibleFieldInfo": { "base": "A field that is invisible to an agent.
", "refs": { "InvisibleTaskTemplateFields$member": null } }, "InvisibleTaskTemplateFields": { "base": null, "refs": { "TaskTemplateConstraints$InvisibleFields": "Lists the fields that are invisible to agents.
" } }, "IpCidr": { "base": null, "refs": { "IpCidrList$member": null } }, "IpCidrList": { "base": null, "refs": { "AuthenticationProfile$AllowedIps": "A list of IP address range strings that are allowed to access the Amazon Connect instance. For more information about how to configure IP addresses, see Configure IP address based access control in the Amazon Connect Administrator Guide.
", "AuthenticationProfile$BlockedIps": "A list of IP address range strings that are blocked from accessing the Amazon Connect instance. For more information about how to configure IP addresses, see Configure IP address based access control in the Amazon Connect Administrator Guide.
", "UpdateAuthenticationProfileRequest$AllowedIps": "A list of IP address range strings that are allowed to access the instance. For more information on how to configure IP addresses, seeConfigure session timeouts in the Amazon Connect Administrator Guide.
", "UpdateAuthenticationProfileRequest$BlockedIps": "A list of IP address range strings that are blocked from accessing the instance. For more information on how to configure IP addresses, For more information on how to configure IP addresses, see Configure IP-based access control in the Amazon Connect Administrator Guide.
" } }, "IsReadOnly": { "base": null, "refs": { "PredefinedAttributeConfiguration$IsReadOnly": "A boolean flag used to indicate whether a predefined attribute should be displayed in the Amazon Connect admin website.
" } }, "IvrRecordingTrack": { "base": null, "refs": { "VoiceRecordingConfiguration$IvrRecordingTrack": "Identifies which IVR track is being recorded.
One and only one of the track configurations should be presented in the request.
" } }, "JoinToken": { "base": null, "refs": { "Attendee$JoinToken": "The join token used by the Amazon Chime SDK attendee.
" } }, "KeyId": { "base": null, "refs": { "EncryptionConfig$KeyId": "The full ARN of the encryption key.
Be sure to provide the full ARN of the encryption key, not just the ID.
Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT .
Configuration information of a Kinesis Data Firehose delivery stream.
", "refs": { "InstanceStorageConfig$KinesisFirehoseConfig": "The configuration of the Kinesis Firehose delivery stream.
" } }, "KinesisStreamConfig": { "base": "Configuration information of a Kinesis data stream.
", "refs": { "InstanceStorageConfig$KinesisStreamConfig": "The configuration of the Kinesis data stream.
" } }, "KinesisVideoStreamConfig": { "base": "Configuration information of a Kinesis video stream.
", "refs": { "InstanceStorageConfig$KinesisVideoStreamConfig": "The configuration of the Kinesis video stream.
" } }, "LargeNextToken": { "base": null, "refs": { "ListPhoneNumbersV2Request$NextToken": "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.
", "ListPhoneNumbersV2Response$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListRealtimeContactAnalysisSegmentsV2Request$NextToken": "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.
", "ListRealtimeContactAnalysisSegmentsV2Response$NextToken": "If there are additional results, this is the token for the next set of results.
", "SearchAvailablePhoneNumbersRequest$NextToken": "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.
", "SearchAvailablePhoneNumbersResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "SearchContactsRequest$NextToken": "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.
", "SearchContactsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
" } }, "LexBot": { "base": "Configuration information of an Amazon Lex bot.
", "refs": { "AssociateBotRequest$LexBot": null, "AssociateLexBotRequest$LexBot": "The Amazon Lex bot to associate with the instance.
", "DisassociateBotRequest$LexBot": null, "LexBotConfig$LexBot": null, "LexBotsList$member": null } }, "LexBotConfig": { "base": "Configuration information of an Amazon Lex or Amazon Lex V2 bot.
", "refs": { "LexBotConfigList$member": null } }, "LexBotConfigList": { "base": null, "refs": { "ListBotsResponse$LexBots": "The names and Amazon Web Services Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified instance.
" } }, "LexBotsList": { "base": null, "refs": { "ListLexBotsResponse$LexBots": "The names and Amazon Web Services Regions of the Amazon Lex bots associated with the specified instance.
" } }, "LexRegion": { "base": null, "refs": { "DisassociateLexBotRequest$LexRegion": "The Amazon Web Services Region in which the Amazon Lex bot has been created.
", "LexBot$LexRegion": "The Amazon Web Services Region where the Amazon Lex bot was created.
" } }, "LexV2Bot": { "base": "Configuration information of an Amazon Lex V2 bot.
", "refs": { "AssociateBotRequest$LexV2Bot": "The Amazon Lex V2 bot to associate with the instance.
", "DisassociateBotRequest$LexV2Bot": "The Amazon Lex V2 bot to disassociate from the instance.
", "LexBotConfig$LexV2Bot": "Configuration information of an Amazon Lex V2 bot.
" } }, "LexVersion": { "base": null, "refs": { "ListBotsRequest$LexVersion": "The version of Amazon Lex or Amazon Lex V2.
" } }, "LimitExceededException": { "base": "The allowed limit for the resource has been exceeded.
", "refs": {} }, "ListAgentStatusRequest": { "base": null, "refs": {} }, "ListAgentStatusResponse": { "base": null, "refs": {} }, "ListAnalyticsDataAssociationsRequest": { "base": null, "refs": {} }, "ListAnalyticsDataAssociationsResponse": { "base": null, "refs": {} }, "ListAnalyticsDataLakeDataSetsRequest": { "base": null, "refs": {} }, "ListAnalyticsDataLakeDataSetsResponse": { "base": null, "refs": {} }, "ListApprovedOriginsRequest": { "base": null, "refs": {} }, "ListApprovedOriginsResponse": { "base": null, "refs": {} }, "ListAssociatedContactsRequest": { "base": null, "refs": {} }, "ListAssociatedContactsRequestMaxResults": { "base": null, "refs": { "ListAssociatedContactsRequest$MaxResults": "The maximum number of results to return per page.
" } }, "ListAssociatedContactsResponse": { "base": null, "refs": {} }, "ListAuthenticationProfilesRequest": { "base": null, "refs": {} }, "ListAuthenticationProfilesResponse": { "base": null, "refs": {} }, "ListBotsRequest": { "base": null, "refs": {} }, "ListBotsResponse": { "base": null, "refs": {} }, "ListCondition": { "base": "A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.
", "refs": { "UserSearchCriteria$ListCondition": "A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.
" } }, "ListContactEvaluationsRequest": { "base": null, "refs": {} }, "ListContactEvaluationsResponse": { "base": null, "refs": {} }, "ListContactFlowModulesRequest": { "base": null, "refs": {} }, "ListContactFlowModulesResponse": { "base": null, "refs": {} }, "ListContactFlowVersionsRequest": { "base": null, "refs": {} }, "ListContactFlowVersionsResponse": { "base": null, "refs": {} }, "ListContactFlowsRequest": { "base": null, "refs": {} }, "ListContactFlowsResponse": { "base": null, "refs": {} }, "ListContactReferencesRequest": { "base": null, "refs": {} }, "ListContactReferencesResponse": { "base": null, "refs": {} }, "ListDefaultVocabulariesRequest": { "base": null, "refs": {} }, "ListDefaultVocabulariesResponse": { "base": null, "refs": {} }, "ListEvaluationFormVersionsRequest": { "base": null, "refs": {} }, "ListEvaluationFormVersionsResponse": { "base": null, "refs": {} }, "ListEvaluationFormsRequest": { "base": null, "refs": {} }, "ListEvaluationFormsResponse": { "base": null, "refs": {} }, "ListFlowAssociationResourceType": { "base": null, "refs": { "BatchGetFlowAssociationRequest$ResourceType": "The type of resource association.
", "FlowAssociationSummary$ResourceType": "The type of resource association.
", "ListFlowAssociationsRequest$ResourceType": "A valid resource type.
" } }, "ListFlowAssociationsRequest": { "base": null, "refs": {} }, "ListFlowAssociationsResponse": { "base": null, "refs": {} }, "ListHoursOfOperationOverridesRequest": { "base": null, "refs": {} }, "ListHoursOfOperationOverridesResponse": { "base": null, "refs": {} }, "ListHoursOfOperationsRequest": { "base": null, "refs": {} }, "ListHoursOfOperationsResponse": { "base": null, "refs": {} }, "ListInstanceAttributesRequest": { "base": null, "refs": {} }, "ListInstanceAttributesResponse": { "base": null, "refs": {} }, "ListInstanceStorageConfigsRequest": { "base": null, "refs": {} }, "ListInstanceStorageConfigsResponse": { "base": null, "refs": {} }, "ListInstancesRequest": { "base": null, "refs": {} }, "ListInstancesResponse": { "base": null, "refs": {} }, "ListIntegrationAssociationsRequest": { "base": null, "refs": {} }, "ListIntegrationAssociationsResponse": { "base": null, "refs": {} }, "ListLambdaFunctionsRequest": { "base": null, "refs": {} }, "ListLambdaFunctionsResponse": { "base": null, "refs": {} }, "ListLexBotsRequest": { "base": null, "refs": {} }, "ListLexBotsResponse": { "base": null, "refs": {} }, "ListPhoneNumbersRequest": { "base": null, "refs": {} }, "ListPhoneNumbersResponse": { "base": null, "refs": {} }, "ListPhoneNumbersSummary": { "base": "Information about phone numbers that have been claimed to your Amazon Connect instance or traffic distribution group.
", "refs": { "ListPhoneNumbersSummaryList$member": null } }, "ListPhoneNumbersSummaryList": { "base": null, "refs": { "ListPhoneNumbersV2Response$ListPhoneNumbersSummaryList": "Information about phone numbers that have been claimed to your Amazon Connect instances or traffic distribution groups.
" } }, "ListPhoneNumbersV2Request": { "base": null, "refs": {} }, "ListPhoneNumbersV2Response": { "base": null, "refs": {} }, "ListPredefinedAttributesRequest": { "base": null, "refs": {} }, "ListPredefinedAttributesResponse": { "base": null, "refs": {} }, "ListPromptsRequest": { "base": null, "refs": {} }, "ListPromptsResponse": { "base": null, "refs": {} }, "ListQueueQuickConnectsRequest": { "base": null, "refs": {} }, "ListQueueQuickConnectsResponse": { "base": null, "refs": {} }, "ListQueuesRequest": { "base": null, "refs": {} }, "ListQueuesResponse": { "base": null, "refs": {} }, "ListQuickConnectsRequest": { "base": null, "refs": {} }, "ListQuickConnectsResponse": { "base": null, "refs": {} }, "ListRealtimeContactAnalysisSegmentsV2Request": { "base": null, "refs": {} }, "ListRealtimeContactAnalysisSegmentsV2Response": { "base": null, "refs": {} }, "ListRoutingProfileQueuesRequest": { "base": null, "refs": {} }, "ListRoutingProfileQueuesResponse": { "base": null, "refs": {} }, "ListRoutingProfilesRequest": { "base": null, "refs": {} }, "ListRoutingProfilesResponse": { "base": null, "refs": {} }, "ListRulesRequest": { "base": null, "refs": {} }, "ListRulesResponse": { "base": null, "refs": {} }, "ListSecurityKeysRequest": { "base": null, "refs": {} }, "ListSecurityKeysResponse": { "base": null, "refs": {} }, "ListSecurityProfileApplicationsRequest": { "base": null, "refs": {} }, "ListSecurityProfileApplicationsResponse": { "base": null, "refs": {} }, "ListSecurityProfilePermissionsRequest": { "base": null, "refs": {} }, "ListSecurityProfilePermissionsResponse": { "base": null, "refs": {} }, "ListSecurityProfilesRequest": { "base": null, "refs": {} }, "ListSecurityProfilesResponse": { "base": null, "refs": {} }, "ListTagsForResourceRequest": { "base": null, "refs": {} }, "ListTagsForResourceResponse": { "base": null, "refs": {} }, "ListTaskTemplatesRequest": { "base": null, "refs": {} }, "ListTaskTemplatesResponse": { "base": null, "refs": {} }, "ListTrafficDistributionGroupUsersRequest": { "base": null, "refs": {} }, "ListTrafficDistributionGroupUsersResponse": { "base": null, "refs": {} }, "ListTrafficDistributionGroupsRequest": { "base": null, "refs": {} }, "ListTrafficDistributionGroupsResponse": { "base": null, "refs": {} }, "ListUseCasesRequest": { "base": "Provides summary information about the use cases for the specified integration association.
", "refs": {} }, "ListUseCasesResponse": { "base": null, "refs": {} }, "ListUserHierarchyGroupsRequest": { "base": null, "refs": {} }, "ListUserHierarchyGroupsResponse": { "base": null, "refs": {} }, "ListUserProficienciesRequest": { "base": null, "refs": {} }, "ListUserProficienciesResponse": { "base": null, "refs": {} }, "ListUsersRequest": { "base": null, "refs": {} }, "ListUsersResponse": { "base": null, "refs": {} }, "ListViewVersionsRequest": { "base": null, "refs": {} }, "ListViewVersionsResponse": { "base": null, "refs": {} }, "ListViewsRequest": { "base": null, "refs": {} }, "ListViewsResponse": { "base": null, "refs": {} }, "Long": { "base": null, "refs": { "RoutingProfile$NumberOfAssociatedQueues": "The number of associated queues in routing profile.
", "RoutingProfile$NumberOfAssociatedUsers": "The number of associated users in routing profile.
" } }, "MatchCriteria": { "base": "An object to define AgentsCriteria.
", "refs": { "AttributeCondition$MatchCriteria": "An object to define AgentsCriteria.
The maximum number of results to return per page.
", "ListInstancesRequest$MaxResults": "The maximum number of results to return per page.
", "ListTrafficDistributionGroupUsersRequest$MaxResults": "The maximum number of results to return per page.
", "ListTrafficDistributionGroupsRequest$MaxResults": "The maximum number of results to return per page.
", "SearchAvailablePhoneNumbersRequest$MaxResults": "The maximum number of results to return per page.
" } }, "MaxResult100": { "base": null, "refs": { "GetCurrentMetricDataRequest$MaxResults": "The maximum number of results to return per page.
", "GetCurrentUserDataRequest$MaxResults": "The maximum number of results to return per page.
", "GetMetricDataRequest$MaxResults": "The maximum number of results to return per page.
", "GetMetricDataV2Request$MaxResults": "The maximum number of results to return per page.
", "ListDefaultVocabulariesRequest$MaxResults": "The maximum number of results to return per page.
", "ListEvaluationFormVersionsRequest$MaxResults": "The maximum number of results to return per page.
", "ListEvaluationFormsRequest$MaxResults": "The maximum number of results to return per page.
", "ListHoursOfOperationOverridesRequest$MaxResults": "The maximum number of results to return per page.
", "ListIntegrationAssociationsRequest$MaxResults": "The maximum number of results to return per page.
", "ListPredefinedAttributesRequest$MaxResults": "The maximum number of results to return per page.
", "ListQueueQuickConnectsRequest$MaxResults": "The maximum number of results to return per page. The default MaxResult size is 100.
", "ListRealtimeContactAnalysisSegmentsV2Request$MaxResults": "The maximum number of results to return per page.
", "ListRoutingProfileQueuesRequest$MaxResults": "The maximum number of results to return per page. The default MaxResult size is 100.
", "ListTaskTemplatesRequest$MaxResults": "The maximum number of results to return per page.
It is not expected that you set this.
The maximum number of results to return per page.
", "ListUserProficienciesRequest$MaxResults": "The maximum number of results to return per page.
", "SearchAgentStatusesRequest$MaxResults": "The maximum number of results to return per page.
", "SearchContactFlowModulesRequest$MaxResults": "The maximum number of results to return per page.
", "SearchContactFlowsRequest$MaxResults": "The maximum number of results to return per page.
", "SearchContactsRequest$MaxResults": "The maximum number of results to return per page.
", "SearchEmailAddressesRequest$MaxResults": "The maximum number of results to return per page.
", "SearchHoursOfOperationOverridesRequest$MaxResults": "The maximum number of results to return per page.
", "SearchHoursOfOperationsRequest$MaxResults": "The maximum number of results to return per page.
", "SearchPredefinedAttributesRequest$MaxResults": "The maximum number of results to return per page.
", "SearchPromptsRequest$MaxResults": "The maximum number of results to return per page.
", "SearchQuickConnectsRequest$MaxResults": "The maximum number of results to return per page.
", "SearchResourceTagsRequest$MaxResults": "The maximum number of results to return per page.
", "SearchSecurityProfilesRequest$MaxResults": "The maximum number of results to return per page.
", "SearchUserHierarchyGroupsRequest$MaxResults": "The maximum number of results to return per page.
", "SearchVocabulariesRequest$MaxResults": "The maximum number of results to return per page.
" } }, "MaxResult1000": { "base": null, "refs": { "ListAgentStatusRequest$MaxResults": "The maximum number of results to return per page.
", "ListAnalyticsDataAssociationsRequest$MaxResults": "The maximum number of results to return per page.
", "ListAnalyticsDataLakeDataSetsRequest$MaxResults": "The maximum number of results to return per page.
", "ListAuthenticationProfilesRequest$MaxResults": "The maximum number of results to return per page.
", "ListContactFlowModulesRequest$MaxResults": "The maximum number of results to return per page.
", "ListContactFlowVersionsRequest$MaxResults": "The maximum number of results to return per page. The default MaxResult size is 100.
", "ListContactFlowsRequest$MaxResults": "The maximum number of results to return per page. The default MaxResult size is 100.
", "ListFlowAssociationsRequest$MaxResults": "The maximum number of results to return per page.
", "ListHoursOfOperationsRequest$MaxResults": "The maximum number of results to return per page. The default MaxResult size is 100.
", "ListPhoneNumbersRequest$MaxResults": "The maximum number of results to return per page. The default MaxResult size is 100.
", "ListPhoneNumbersV2Request$MaxResults": "The maximum number of results to return per page.
", "ListPromptsRequest$MaxResults": "The maximum number of results to return per page. The default MaxResult size is 100.
", "ListQueuesRequest$MaxResults": "The maximum number of results to return per page. The default MaxResult size is 100.
", "ListQuickConnectsRequest$MaxResults": "The maximum number of results to return per page. The default MaxResult size is 100.
", "ListRoutingProfilesRequest$MaxResults": "The maximum number of results to return per page. The default MaxResult size is 100.
", "ListSecurityProfileApplicationsRequest$MaxResults": "The maximum number of results to return per page.
", "ListSecurityProfilePermissionsRequest$MaxResults": "The maximum number of results to return per page.
", "ListSecurityProfilesRequest$MaxResults": "The maximum number of results to return per page. The default MaxResult size is 100.
", "ListUserHierarchyGroupsRequest$MaxResults": "The maximum number of results to return per page. The default MaxResult size is 100.
", "ListUsersRequest$MaxResults": "The maximum number of results to return per page. The default MaxResult size is 100.
" } }, "MaxResult2": { "base": null, "refs": { "ListSecurityKeysRequest$MaxResults": "The maximum number of results to return per page.
" } }, "MaxResult200": { "base": null, "refs": { "ListRulesRequest$MaxResults": "The maximum number of results to return per page.
" } }, "MaxResult25": { "base": null, "refs": { "ListApprovedOriginsRequest$MaxResults": "The maximum number of results to return per page.
", "ListBotsRequest$MaxResults": "The maximum number of results to return per page.
", "ListLambdaFunctionsRequest$MaxResults": "The maximum number of results to return per page.
", "ListLexBotsRequest$MaxResults": "The maximum number of results to return per page. If no value is specified, the default is 10.
" } }, "MaxResult500": { "base": null, "refs": { "SearchQueuesRequest$MaxResults": "The maximum number of results to return per page.
", "SearchRoutingProfilesRequest$MaxResults": "The maximum number of results to return per page.
", "SearchUsersRequest$MaxResults": "The maximum number of results to return per page.
" } }, "MaxResult7": { "base": null, "refs": { "ListInstanceAttributesRequest$MaxResults": "The maximum number of results to return per page.
" } }, "MaxResults": { "base": null, "refs": { "ListViewVersionsRequest$MaxResults": "The maximum number of results to return per page. The default MaxResult size is 100.
", "ListViewsRequest$MaxResults": "The maximum number of results to return per page. The default MaxResult size is 100.
" } }, "MaximumResultReturnedException": { "base": "Maximum number (1000) of tags have been returned with current request. Consider changing request parameters to get more tags.
", "refs": {} }, "MediaConcurrencies": { "base": null, "refs": { "CreateRoutingProfileRequest$MediaConcurrencies": "The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.
", "RoutingProfile$MediaConcurrencies": "The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
", "UpdateRoutingProfileConcurrencyRequest$MediaConcurrencies": "The channels that agents can handle in the Contact Control Panel (CCP).
" } }, "MediaConcurrency": { "base": "Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.
", "refs": { "MediaConcurrencies$member": null } }, "MediaPlacement": { "base": "A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.
", "refs": { "Meeting$MediaPlacement": "The media placement for the meeting.
" } }, "MediaRegion": { "base": null, "refs": { "Meeting$MediaRegion": "The Amazon Web Services Region in which you create the meeting.
" } }, "MediaStreamType": { "base": null, "refs": { "RecordingInfo$MediaStreamType": "Information about the media stream used during the conversation.
" } }, "Meeting": { "base": "A meeting created using the Amazon Chime SDK.
", "refs": { "ConnectionData$Meeting": "A meeting created using the Amazon Chime SDK.
" } }, "MeetingFeatureStatus": { "base": null, "refs": { "AudioFeatures$EchoReduction": "Makes echo reduction available to clients who connect to the meeting.
" } }, "MeetingFeaturesConfiguration": { "base": "The configuration settings of the features available to a meeting.
", "refs": { "Meeting$MeetingFeatures": "The configuration settings of the features available to a meeting.
" } }, "MeetingId": { "base": null, "refs": { "Meeting$MeetingId": "The Amazon Chime SDK meeting ID.
" } }, "Message": { "base": null, "refs": { "AccessDeniedException$Message": null, "ConditionalOperationFailedException$Message": null, "ConflictException$Message": null, "ContactFlowNotPublishedException$Message": null, "ContactNotFoundException$Message": "The message.
", "DestinationNotAllowedException$Message": "The message about the outbound calls.
", "DuplicateResourceException$Message": null, "IdempotencyException$Message": null, "InternalServiceException$Message": "The message.
", "InvalidParameterException$Message": "The message about the parameters.
", "InvalidRequestException$Message": "The message about the request.
", "LimitExceededException$Message": "The message about the limit.
", "MaximumResultReturnedException$Message": null, "OutboundContactNotPermittedException$Message": "The message about the contact.
", "OutputTypeNotFoundException$Message": null, "PropertyValidationException$Message": null, "PropertyValidationExceptionProperty$Message": "A message describing why the property is not valid.
", "ResourceConflictException$Message": null, "ResourceInUseException$Message": null, "ResourceNotFoundException$Message": "The message about the resource.
", "ResourceNotReadyException$Message": null, "ServiceQuotaExceededException$Message": null, "ThrottlingException$Message": null, "TooManyRequestsException$Message": null, "UserNotFoundException$Message": null } }, "MessageTemplateId": { "base": null, "refs": { "TemplatedMessageConfig$MessageTemplateId": "The identifier of the message template Id.
" } }, "MessageTemplateKnowledgeBaseId": { "base": null, "refs": { "TemplatedMessageConfig$KnowledgeBaseId": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
" } }, "MetadataUrl": { "base": null, "refs": { "DownloadUrlMetadata$Url": "A pre-signed URL that should be used to download the attached file.
", "UploadUrlMetadata$Url": "A pre-signed S3 URL that should be used for uploading the attached file.
" } }, "MetricDataCollectionsV2": { "base": null, "refs": { "MetricResultV2$Collections": "The set of metrics.
" } }, "MetricDataV2": { "base": "Contains the name, thresholds, and metric filters.
", "refs": { "MetricDataCollectionsV2$member": null } }, "MetricFilterV2": { "base": "Contains information about the filter used when retrieving metrics. MetricFiltersV2 can be used on the following metrics: AVG_AGENT_CONNECTING_TIME, CONTACTS_CREATED, CONTACTS_HANDLED, SUM_CONTACTS_DISCONNECTED.
The values to use for filtering data. Values for metric-level filters can be either a fixed set of values or a customized list, depending on the use case.
For valid values of metric-level filters INITIATION_METHOD, DISCONNECT_REASON, and ANSWERING_MACHINE_DETECTION_STATUS, see ContactTraceRecord in the Amazon Connect Administrator Guide.
For valid values of the metric-level filter FLOWS_OUTCOME_TYPE, see the description for the Flow outcome metric in the Amazon Connect Administrator Guide.
For valid values of the metric-level filter BOT_CONVERSATION_OUTCOME_TYPE, see the description for the Bot conversations completed in the Amazon Connect Administrator Guide.
For valid values of the metric-level filter BOT_INTENT_OUTCOME_TYPE, see the description for the Bot intents completed metric in the Amazon Connect Administrator Guide.
Contains the filters to be used when returning data.
" } }, "MetricInterval": { "base": "The interval period with the start and end time for the metrics.
", "refs": { "MetricResultV2$MetricInterval": "The interval period with the start and end time for the metrics.
" } }, "MetricNameV2": { "base": null, "refs": { "MetricV2$Name": "The name of the metric.
This parameter is required. The following Required = No is incorrect.
Contains information about the metric results.
", "refs": { "MetricResultsV2$member": null } }, "MetricResultsV2": { "base": null, "refs": { "GetMetricDataV2Response$MetricResults": "Information about the metrics requested in the API request If no grouping is specified, a summary of metric data is returned.
" } }, "MetricV2": { "base": "Contains information about the metric.
", "refs": { "MetricDataV2$Metric": "The metric name, thresholds, and metric filters of the returned metric.
", "MetricsV2$member": null } }, "MetricsV2": { "base": null, "refs": { "GetMetricDataV2Request$Metrics": "The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Metrics definition in the Amazon Connect Administrator Guide.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Abandonment rate
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherent time
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent answer rate
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Non-adherent time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-response
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Occupancy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherence
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Scheduled time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue abandon time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average active time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average after contact work time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average agent API connecting time
The Negate key in metric-level filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average agent pause time
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Average bot conversation time
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Average bot conversation turns
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average contacts per case
Unit: Seconds
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average case resolution time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average contact duration
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
Unit: Seconds
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average conversation close time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average conversation duration
This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.
Unit: Count
Valid groupings and filters: Agent, Campaign, Queue, Routing Profile
UI name: Average dials per minute
Unit: Percent
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Average evaluation score
Unit: Seconds
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average agent first response time
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Average flow time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent greeting time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: Average handle time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer hold time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average holds
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interaction time
Feature is a valid filter but not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruptions
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruption time
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average agent message length
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average customer message length
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average messages
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average agent messages
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average bot messages
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average customer messages
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average non-talk time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue answer time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average agent response time
Unit: Seconds
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average customer response time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average resolution time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer talk time
This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.
Unit: Seconds
Valid groupings and filters: Campaign
Unit: Percent
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form Id, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Average weighted evaluation score
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Bot conversations completed
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Bot intents completed
This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.
Unit: Count
Valid groupings and filters: Agent, Campaign
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than).
UI name: Campaign contacts abandoned after X
This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.
Unit: Percent
Valid groupings and filters: Agent, Campaign
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than).
This metric is available only for outbound campaigns using the email delivery mode.
Unit: Count
Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE
Valid groupings and filters: Campaign
UI name: Campaign interactions
This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.
Unit: Percent
Valid groupings and filters: Campaign, Campaign Execution Timestamp
UI name: Campaign progress rate
This metric is available only for outbound campaigns.
Unit: Count
Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype
UI name: Campaign send attempts
This metric is available only for outbound campaigns.
Valid metric filter key: CAMPAIGN_EXCLUDED_EVENT_TYPE
Unit: Count
Valid groupings and filters: Campaign, Campaign Excluded Event Type, Campaign Execution Timestamp
UI name: Campaign send exclusions
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases created
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts created
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: API contacts handled
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts hold disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold agent disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold customer disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts put on hold
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out external
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out internal
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts queued
Unit: Count
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts queued (enqueue timestamp)
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for \"Less than\") or LTE (for \"Less than equal\").
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for \"Less than\") or LTE (for \"Less than equal\").
UI name: Contacts resolved in X
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out by agent
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out queue
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Current cases
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Conversations abandoned
This metric is available only for outbound campaigns.
Unit: Count
Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON
Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Campaign Delivery EventType, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile
UI name: Delivery attempts
Campaign Delivery EventType filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.
This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.
Unit: Percent
Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON
Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile
UI name: Delivery attempt disposition rate
Campaign Delivery Event Type filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Evaluations performed
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows started
This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.
Unit: Count
Valid groupings and filters: Agent, Campaign
UI name: Human answered
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Maximum flow time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Maximum queued time
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Minimum flow time
Unit: Percent
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Automatic fails percent
Unit: Percent
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Percent bot conversations outcome
Unit: Percent
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Percent bot intents outcome
Unit: Percent
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved on first contact
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Percent
Valid metric filter key: FLOWS_OUTCOME_TYPE
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome percentage.
The FLOWS_OUTCOME_TYPE is not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Non-talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Agent talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Customer talk time percent
This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.
Unit: Count
Valid groupings and filters: Campaign, Campaign Execution Timestamp
UI name: Recipients attempted
This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.
Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE
Unit: Count
Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype, Campaign Execution Timestamp
UI name: Recipients interacted
This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.
Unit: Count
Valid groupings and filters: Campaign, Campaign Execution Timestamp
UI name: Recipients targeted
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases reopened
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for \"Less than\") or LTE (for \"Less than equal\").
UI name: Service level X
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: After contact work time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. This metric only supports the following filter keys as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent API connecting time
The Negate key in metric-level filters is not applicable for this metric.
Unit: Count
Metric filter:
Valid values: API| Incoming | Outbound | Transfer | Callback | Queue_Transfer| Disconnect
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: Contact abandoned
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for \"Less than\") or LTE (for \"Less than equal\").
UI name: Contacts abandoned in X seconds
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for \"Less than\") or LTE (for \"Less than equal\").
UI name: Contacts answered in X seconds
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact flow time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent on contact time
Valid metric filter key: DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contact disconnected
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Error status time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact handle time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Customer hold time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent idle time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Agent interaction and hold time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent interaction time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-productive time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Online time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Callback attempts
The minutes.
", "OverrideTimeSlice$Minutes": "The minutes.
" } }, "MonitorCapability": { "base": null, "refs": { "AllowedMonitorCapabilities$member": null } }, "MonitorContactRequest": { "base": null, "refs": {} }, "MonitorContactResponse": { "base": null, "refs": {} }, "Name": { "base": null, "refs": { "Contact$Name": "The name of the contact.
", "CreateContactRequest$Name": "The name of a the contact.
", "StartEmailContactRequest$Name": "The name of a email that is shown to an agent in the Contact Control Panel (CCP).
", "StartOutboundVoiceContactRequest$Name": "The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).
", "StartTaskContactRequest$Name": "The name of a task that is shown to an agent in the Contact Control Panel (CCP).
", "UpdateContactRequest$Name": "The name of the contact.
" } }, "Name128": { "base": null, "refs": { "CreateTrafficDistributionGroupRequest$Name": "The name for the traffic distribution group.
", "TrafficDistributionGroup$Name": "The name of the traffic distribution group.
", "TrafficDistributionGroupSummary$Name": "The name of the traffic distribution group.
" } }, "Namespace": { "base": null, "refs": { "Application$Namespace": "Namespace of the application that you want to give access to.
" } }, "NewChatCreated": { "base": null, "refs": { "SendChatIntegrationEventResponse$NewChatCreated": "Whether handling the integration event resulted in creating a new chat or acting on existing chat.
" } }, "NewSessionDetails": { "base": "Payload of chat properties to apply when starting a new contact.
", "refs": { "SendChatIntegrationEventRequest$NewSessionDetails": "Contact properties to apply when starting a new chat. If the integration event is handled with an existing chat, this is ignored.
" } }, "NextToken": { "base": null, "refs": { "GetCurrentMetricDataRequest$NextToken": "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.
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.
", "GetCurrentMetricDataResponse$NextToken": "If there are additional results, this is the token for the next set of results.
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.
", "GetCurrentUserDataRequest$NextToken": "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.
", "GetCurrentUserDataResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "GetMetricDataRequest$NextToken": "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.
", "GetMetricDataResponse$NextToken": "If there are additional results, this is the token for the next set of results.
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.
", "ListAgentStatusRequest$NextToken": "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.
", "ListAgentStatusResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListAnalyticsDataAssociationsRequest$NextToken": "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.
", "ListAnalyticsDataAssociationsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListAnalyticsDataLakeDataSetsRequest$NextToken": "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.
", "ListAnalyticsDataLakeDataSetsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListApprovedOriginsRequest$NextToken": "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.
", "ListApprovedOriginsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListAssociatedContactsRequest$NextToken": "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.
", "ListAssociatedContactsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListAuthenticationProfilesRequest$NextToken": "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.
", "ListAuthenticationProfilesResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListBotsRequest$NextToken": "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.
", "ListBotsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListContactEvaluationsRequest$NextToken": "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.
This is not expected to be set because the value returned in the previous response is always null.
If there are additional results, this is the token for the next set of results.
This is always returned as null in the response.
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.
", "ListContactFlowModulesResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListContactFlowVersionsRequest$NextToken": "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.
", "ListContactFlowVersionsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListContactFlowsRequest$NextToken": "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.
", "ListContactFlowsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListContactReferencesRequest$NextToken": "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.
This is not expected to be set, because the value returned in the previous response is always null.
If there are additional results, this is the token for the next set of results.
This is always returned as null in the response.
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.
", "ListEvaluationFormVersionsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListEvaluationFormsRequest$NextToken": "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.
", "ListEvaluationFormsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListFlowAssociationsRequest$NextToken": "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.
", "ListFlowAssociationsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListHoursOfOperationOverridesRequest$NextToken": "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.
", "ListHoursOfOperationOverridesResponse$NextToken": "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.
", "ListHoursOfOperationsRequest$NextToken": "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.
", "ListHoursOfOperationsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListInstanceAttributesRequest$NextToken": "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.
", "ListInstanceAttributesResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListInstanceStorageConfigsRequest$NextToken": "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.
", "ListInstanceStorageConfigsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListInstancesRequest$NextToken": "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.
", "ListInstancesResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListIntegrationAssociationsRequest$NextToken": "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.
", "ListIntegrationAssociationsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListLambdaFunctionsRequest$NextToken": "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.
", "ListLambdaFunctionsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListLexBotsRequest$NextToken": "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.
", "ListLexBotsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListPhoneNumbersRequest$NextToken": "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.
", "ListPhoneNumbersResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListPredefinedAttributesRequest$NextToken": "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.
", "ListPredefinedAttributesResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListPromptsRequest$NextToken": "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.
", "ListPromptsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListQueueQuickConnectsRequest$NextToken": "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.
", "ListQueueQuickConnectsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListQueuesRequest$NextToken": "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.
", "ListQueuesResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListQuickConnectsRequest$NextToken": "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.
", "ListQuickConnectsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListRoutingProfileQueuesRequest$NextToken": "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.
", "ListRoutingProfileQueuesResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListRoutingProfilesRequest$NextToken": "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.
", "ListRoutingProfilesResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListRulesRequest$NextToken": "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.
", "ListRulesResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListSecurityKeysRequest$NextToken": "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.
", "ListSecurityKeysResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListSecurityProfileApplicationsRequest$NextToken": "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.
", "ListSecurityProfileApplicationsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListSecurityProfilePermissionsRequest$NextToken": "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.
", "ListSecurityProfilePermissionsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListSecurityProfilesRequest$NextToken": "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.
", "ListSecurityProfilesResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListTaskTemplatesRequest$NextToken": "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.
It is not expected that you set this because the value returned in the previous response is always null.
If there are additional results, this is the token for the next set of results.
This is always returned as a null in the response.
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.
", "ListTrafficDistributionGroupUsersResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListTrafficDistributionGroupsRequest$NextToken": "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.
", "ListTrafficDistributionGroupsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListUseCasesRequest$NextToken": "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.
", "ListUseCasesResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListUserHierarchyGroupsRequest$NextToken": "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.
", "ListUserHierarchyGroupsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListUserProficienciesRequest$NextToken": "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.
", "ListUserProficienciesResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListUsersRequest$NextToken": "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.
", "ListUsersResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "SearchEmailAddressesResponse$NextToken": "If there are additional results, this is the token for the next set of results.
" } }, "NextToken2500": { "base": null, "refs": { "GetMetricDataV2Request$NextToken": "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.
", "GetMetricDataV2Response$NextToken": "If there are additional results, this is the token for the next set of results.
", "SearchAgentStatusesRequest$NextToken": "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.
", "SearchAgentStatusesResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "SearchContactFlowModulesRequest$NextToken": "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.
", "SearchContactFlowModulesResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "SearchContactFlowsRequest$NextToken": "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.
", "SearchContactFlowsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "SearchEmailAddressesRequest$NextToken": "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.
", "SearchHoursOfOperationOverridesRequest$NextToken": "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.
", "SearchHoursOfOperationOverridesResponse$NextToken": "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.
", "SearchHoursOfOperationsRequest$NextToken": "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.
", "SearchHoursOfOperationsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "SearchPredefinedAttributesRequest$NextToken": "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.
", "SearchPredefinedAttributesResponse$NextToken": "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.
", "SearchPromptsRequest$NextToken": "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.
", "SearchPromptsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "SearchQueuesRequest$NextToken": "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.
", "SearchQueuesResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "SearchQuickConnectsRequest$NextToken": "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.
", "SearchQuickConnectsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "SearchResourceTagsRequest$NextToken": "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.
", "SearchResourceTagsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "SearchRoutingProfilesRequest$NextToken": "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.
", "SearchRoutingProfilesResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "SearchSecurityProfilesRequest$NextToken": "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.
", "SearchSecurityProfilesResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "SearchUserHierarchyGroupsRequest$NextToken": "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.
", "SearchUserHierarchyGroupsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "SearchUsersRequest$NextToken": "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.
", "SearchUsersResponse$NextToken": "If there are additional results, this is the token for the next set of results.
" } }, "NotificationContentType": { "base": null, "refs": { "SendNotificationActionDefinition$ContentType": "Content type format.
" } }, "NotificationDeliveryType": { "base": null, "refs": { "SendNotificationActionDefinition$DeliveryMethod": "Notification delivery method.
" } }, "NotificationRecipientType": { "base": "The type of notification recipient.
", "refs": { "SendNotificationActionDefinition$Recipient": "Notification recipient.
" } }, "NullableBoolean": { "base": null, "refs": { "ChatContactMetrics$MultiParty": "A boolean flag indicating whether multiparty chat or supervisor barge were enabled on this contact.
", "ParticipantMetrics$ConversationAbandon": "A boolean flag indicating whether the chat conversation was abandoned by a Participant.
" } }, "NullableProficiencyLevel": { "base": null, "refs": { "AttributeCondition$ProficiencyLevel": "The proficiency level of the condition.
", "Range$MinProficiencyLevel": "The minimum proficiency level of the range.
", "Range$MaxProficiencyLevel": "The maximum proficiency level of the range.
" } }, "NullableProficiencyLimitValue": { "base": null, "refs": { "NumberCondition$MinValue": "The minValue to be used while evaluating the number condition.
", "NumberCondition$MaxValue": "The maxValue to be used while evaluating the number condition.
" } }, "NumberComparisonType": { "base": null, "refs": { "NumberCondition$ComparisonType": "The type of comparison to be made when evaluating the number condition.
" } }, "NumberCondition": { "base": "A leaf node condition which can be used to specify a numeric condition.
The currently supported value for FieldName is limit.
A leaf node condition which can be used to specify a numeric condition.
" } }, "NumberReference": { "base": "Information about a reference when the referenceType is NUMBER. Otherwise, null.
Information about a reference when the referenceType is NUMBER. Otherwise, null.
The property label of the automation.
" } }, "NumericQuestionPropertyValueAutomation": { "base": "Information about the property value used in automation of a numeric questions. Label values are associated with minimum and maximum values for the numeric question.
Sentiment scores have a minimum value of -5 and maximum value of 5.
Duration labels, such as NON_TALK_TIME, CONTACT_DURATION, AGENT_INTERACTION_DURATION, CUSTOMER_HOLD_TIME have a minimum value of 0 and maximum value of 63072000.
Percentages have a minimum value of 0 and maximum value of 100.
NUMBER_OF_INTERRUPTIONS has a minimum value of 0 and maximum value of 1000.
The property value of the automation.
" } }, "OperatingSystem": { "base": null, "refs": { "DeviceInfo$OperatingSystem": "Operating system that the participant used for the call.
" } }, "OperationalHour": { "base": "Information about the hours of operations with the effective override applied.
", "refs": { "OperationalHours$member": null } }, "OperationalHours": { "base": null, "refs": { "EffectiveHoursOfOperations$OperationalHours": "Information about the hours of operations with the effective override applied.
" } }, "Origin": { "base": null, "refs": { "AssociateApprovedOriginRequest$Origin": "The domain to add to your allow list.
", "DisassociateApprovedOriginRequest$Origin": "The domain URL of the integrated application.
", "OriginsList$member": null } }, "OriginsList": { "base": null, "refs": { "ListApprovedOriginsResponse$Origins": "The approved origins.
" } }, "OutboundAdditionalRecipients": { "base": "Information about the additional recipients of outbound email.
", "refs": { "SendOutboundEmailRequest$AdditionalRecipients": "The additional recipients address of the email in CC.
", "StartOutboundEmailContactRequest$AdditionalRecipients": "The additional recipients address of email in CC.
" } }, "OutboundCallerConfig": { "base": "The outbound caller ID name, number, and outbound whisper flow.
", "refs": { "CreateQueueRequest$OutboundCallerConfig": "The outbound caller ID name, number, and outbound whisper flow.
", "Queue$OutboundCallerConfig": "The outbound caller ID name, number, and outbound whisper flow.
", "UpdateQueueOutboundCallerConfigRequest$OutboundCallerConfig": "The outbound caller ID name, number, and outbound whisper flow.
" } }, "OutboundCallerIdName": { "base": null, "refs": { "OutboundCallerConfig$OutboundCallerIdName": "The caller ID name.
" } }, "OutboundCallsEnabled": { "base": null, "refs": { "CreateInstanceRequest$OutboundCallsEnabled": "Your contact center allows outbound calls.
", "Instance$OutboundCallsEnabled": "Whether outbound calls are enabled.
", "InstanceSummary$OutboundCallsEnabled": "Whether outbound calls are enabled.
" } }, "OutboundContactNotPermittedException": { "base": "The contact is not permitted.
", "refs": {} }, "OutboundEmailConfig": { "base": "The outbound email address ID.
", "refs": { "CreateQueueRequest$OutboundEmailConfig": "The outbound email address ID for a specified queue.
", "Queue$OutboundEmailConfig": "The outbound email address ID for a specified queue.
", "UpdateQueueOutboundEmailConfigRequest$OutboundEmailConfig": "The outbound email address ID for a specified queue.
" } }, "OutboundEmailContent": { "base": "Information about email body content.
", "refs": { "SendOutboundEmailRequest$EmailMessage": "The email message body to be sent to the newly created email.
", "StartOutboundEmailContactRequest$EmailMessage": "The email message body to be sent to the newly created email.
" } }, "OutboundMessageSourceType": { "base": null, "refs": { "OutboundEmailContent$MessageSourceType": "The message source type, that is, RAW or TEMPLATE.
Information about the raw email body content.
", "refs": { "OutboundEmailContent$RawMessage": "The raw email body content.
" } }, "OutboundRequestId": { "base": null, "refs": { "SourceCampaign$OutboundRequestId": "A unique identifier for a each request part of same campaign.
" } }, "OutboundSubject": { "base": null, "refs": { "OutboundRawMessage$Subject": "The email subject.
" } }, "OutputTypeNotFoundException": { "base": "Thrown for analyzed content when requested OutputType was not enabled for a given contact. For example, if an OutputType.Raw was requested for a contact that had `RedactedOnly` Redaction policy set in the flow.
", "refs": {} }, "OverrideDays": { "base": null, "refs": { "HoursOfOperationOverrideConfig$Day": "The day that the hours of operation override applies to.
" } }, "OverrideTimeSlice": { "base": "The start time or end time for an hours of operation override.
", "refs": { "HoursOfOperationOverrideConfig$StartTime": "The start time when your contact center opens if overrides are applied.
", "HoursOfOperationOverrideConfig$EndTime": "The end time that your contact center closes if overrides are applied.
", "OperationalHour$Start": "The start time that your contact center opens.
", "OperationalHour$End": "The end time that your contact center closes.
" } }, "PEM": { "base": null, "refs": { "AssociateSecurityKeyRequest$Key": "A valid security key in PEM format as a String.
", "SecurityKey$Key": "The key of the security key.
" } }, "ParticipantCapabilities": { "base": "The configuration for the allowed video and screen sharing capabilities for participants present over the call. For more information, see Set up in-app, web, video calling, and screen sharing capabilities in the Amazon Connect Administrator Guide.
", "refs": { "AgentInfo$Capabilities": null, "AllowedCapabilities$Customer": "Information about the customer's video sharing capabilities.
", "AllowedCapabilities$Agent": "Information about the agent's video sharing capabilities.
", "Customer$Capabilities": null, "ParticipantDetailsToAdd$ParticipantCapabilities": null } }, "ParticipantDetails": { "base": "The customer's details.
", "refs": { "NewSessionDetails$ParticipantDetails": null, "StartChatContactRequest$ParticipantDetails": "Information identifying the participant.
", "StartOutboundChatContactRequest$ParticipantDetails": null, "StartWebRTCContactRequest$ParticipantDetails": null } }, "ParticipantDetailsToAdd": { "base": "The details to add for the participant.
", "refs": { "CreateParticipantRequest$ParticipantDetails": "Information identifying the participant.
The only valid value for ParticipantRole is CUSTOM_BOT for chat contact and CUSTOMER for voice contact.
The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.
", "ParticipantMetrics$ParticipantId": "The Participant's ID.
", "RealTimeContactAnalysisSegmentAttachments$ParticipantId": "The identifier of the participant.
", "RealTimeContactAnalysisSegmentEvent$ParticipantId": "The identifier of the participant.
", "RealTimeContactAnalysisSegmentTranscript$ParticipantId": "The identifier of the participant.
", "StartChatContactResponse$ParticipantId": "The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.
", "StartWebRTCContactResponse$ParticipantId": "The identifier for a contact participant. The ParticipantId for a contact participant is the same throughout the contact lifecycle.
Information about a participant's interactions in a contact.
", "refs": { "ChatMetrics$AgentMetrics": "Information about agent interactions in a contact.
", "ChatMetrics$CustomerMetrics": "Information about customer interactions in a contact.
" } }, "ParticipantRole": { "base": null, "refs": { "ContactConfiguration$ParticipantRole": "The role of the participant in the chat conversation.
Only CUSTOMER is currently supported. Any other values other than CUSTOMER will result in an exception (4xx error).
The role of the participant being added.
", "RealTimeContactAnalysisSegmentAttachments$ParticipantRole": "The role of the participant. For example, is it a customer, agent, or system.
", "RealTimeContactAnalysisSegmentEvent$ParticipantRole": "The role of the participant. For example, is it a customer, agent, or system.
", "RealTimeContactAnalysisSegmentTranscript$ParticipantRole": "The role of the participant. For example, is it a customer, agent, or system.
", "TranscriptCriteria$ParticipantRole": "The participant role in a transcript
" } }, "ParticipantState": { "base": null, "refs": { "StateTransition$State": "The state of the transition.
" } }, "ParticipantTimerAction": { "base": null, "refs": { "ParticipantTimerValue$ParticipantTimerAction": "The timer action. Currently only one value is allowed: Unset. It deletes a timer.
A list of participant timers. You can specify any unique combination of role and timer type. Duplicate entries error out the request with a 400.
" } }, "ParticipantTimerConfiguration": { "base": "Configuration information for the timer. After the timer configuration is set, it persists for the duration of the chat. It persists across new contacts in the chain, for example, transfer contacts.
For more information about how chat timeouts work, see Set up chat timeouts for human participants.
", "refs": { "ParticipantTimerConfigList$member": null } }, "ParticipantTimerDurationInMinutes": { "base": null, "refs": { "ParticipantTimerValue$ParticipantTimerDurationInMinutes": "The duration of a timer, in minutes.
" } }, "ParticipantTimerType": { "base": null, "refs": { "ParticipantTimerConfiguration$TimerType": "The type of timer. IDLE indicates the timer applies for considering a human chat participant as idle. DISCONNECT_NONCUSTOMER indicates the timer applies to automatically disconnecting a chat participant due to idleness.
The value of the timer. Either the timer action (Unset to delete the timer), or the duration of the timer in minutes. Only one value can be set.
For more information about how chat timeouts work, see Set up chat timeouts for human participants.
", "refs": { "ParticipantTimerConfiguration$TimerValue": "The value of the timer. Either the timer action (Unset to delete the timer), or the duration of the timer in minutes. Only one value can be set.
" } }, "ParticipantToken": { "base": null, "refs": { "ParticipantTokenCredentials$ParticipantToken": "The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant.
", "StartChatContactResponse$ParticipantToken": "The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant.
", "StartWebRTCContactResponse$ParticipantToken": "The token used by the contact participant to call the CreateParticipantConnection API. The participant token is valid for the lifetime of a contact participant.
", "UpdateParticipantAuthenticationRequest$State": "The state query parameter that was provided by Cognito in the redirectUri. This will also match the state parameter provided in the AuthenticationUrl from the GetAuthenticationUrl response.
The credentials used by the participant.
", "refs": { "CreateParticipantResponse$ParticipantCredentials": "The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant.
Information about the conversation participant. Following are the participant types: [Agent, Customer, Supervisor].
", "RecordingInfo$ParticipantType": "Information about the conversation participant, whether they are an agent or contact. The participant types are as follows:
All
Manager
Agent
Customer
Thirdparty
Supervisor
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.
" } }, "PauseContactRequest": { "base": null, "refs": {} }, "PauseContactResponse": { "base": null, "refs": {} }, "Percentage": { "base": null, "refs": { "Distribution$Percentage": "The percentage of the traffic that is distributed, in increments of 10.
" } }, "Permission": { "base": null, "refs": { "ApplicationPermissions$member": null } }, "PermissionsList": { "base": null, "refs": { "CreateSecurityProfileRequest$Permissions": "Permissions assigned to the security profile. For a list of valid permissions, see List of security profile permissions.
", "ListSecurityProfilePermissionsResponse$Permissions": "The permissions granted to the security profile. For a complete list of valid permissions, see List of security profile permissions.
", "UpdateSecurityProfileRequest$Permissions": "The permissions granted to a security profile. For a list of valid permissions, see List of security profile permissions.
" } }, "PersistentChat": { "base": "Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat.
", "refs": { "StartChatContactRequest$PersistentChat": "Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat.
" } }, "PhoneNumber": { "base": null, "refs": { "AvailableNumberSummary$PhoneNumber": "The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code].
The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
The phone number in E.164 format.
", "PhoneNumberSummary$PhoneNumber": "The phone number.
", "StartOutboundVoiceContactRequest$DestinationPhoneNumber": "The phone number of the customer, in E.164 format.
", "StartOutboundVoiceContactRequest$SourcePhoneNumber": "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.
", "UserIdentityInfo$Mobile": "The user's mobile number.
", "UserPhoneConfig$DeskPhoneNumber": "The phone number for the user's desk phone.
" } }, "PhoneNumberCountryCode": { "base": null, "refs": { "AvailableNumberSummary$PhoneNumberCountryCode": "The ISO country code.
", "ClaimedPhoneNumberSummary$PhoneNumberCountryCode": "The ISO country code.
", "ListPhoneNumbersSummary$PhoneNumberCountryCode": "The ISO country code.
", "PhoneNumberCountryCodes$member": null, "PhoneNumberSummary$PhoneNumberCountryCode": "The ISO country code.
", "SearchAvailablePhoneNumbersRequest$PhoneNumberCountryCode": "The ISO country code.
" } }, "PhoneNumberCountryCodes": { "base": null, "refs": { "ListPhoneNumbersRequest$PhoneNumberCountryCodes": "The ISO country code.
", "ListPhoneNumbersV2Request$PhoneNumberCountryCodes": "The ISO country code.
" } }, "PhoneNumberDescription": { "base": null, "refs": { "ClaimPhoneNumberRequest$PhoneNumberDescription": "The description of the phone number.
", "ClaimedPhoneNumberSummary$PhoneNumberDescription": "The description of the phone number.
", "ImportPhoneNumberRequest$PhoneNumberDescription": "The description of the phone number.
", "ListPhoneNumbersSummary$PhoneNumberDescription": "The description of the phone number.
", "UpdatePhoneNumberMetadataRequest$PhoneNumberDescription": "The description of the phone number.
" } }, "PhoneNumberId": { "base": null, "refs": { "AssociatePhoneNumberContactFlowRequest$PhoneNumberId": "A unique identifier for the phone number.
", "ClaimPhoneNumberResponse$PhoneNumberId": "A unique identifier for the phone number.
", "ClaimedPhoneNumberSummary$PhoneNumberId": "A unique identifier for the phone number.
", "DescribePhoneNumberRequest$PhoneNumberId": "A unique identifier for the phone number.
", "DisassociatePhoneNumberContactFlowRequest$PhoneNumberId": "A unique identifier for the phone number.
", "ImportPhoneNumberResponse$PhoneNumberId": "A unique identifier for the phone number.
", "ListPhoneNumbersSummary$PhoneNumberId": "A unique identifier for the phone number.
", "OutboundCallerConfig$OutboundCallerIdNumberId": "The caller ID number.
", "PhoneNumberSummary$Id": "The identifier of the phone number.
", "ReleasePhoneNumberRequest$PhoneNumberId": "A unique identifier for the phone number.
", "UpdatePhoneNumberMetadataRequest$PhoneNumberId": "The Amazon Resource Name (ARN) or resource ID of the phone number.
", "UpdatePhoneNumberRequest$PhoneNumberId": "A unique identifier for the phone number.
", "UpdatePhoneNumberResponse$PhoneNumberId": "A unique identifier for the phone number.
" } }, "PhoneNumberPrefix": { "base": null, "refs": { "ListPhoneNumbersV2Request$PhoneNumberPrefix": "The prefix of the phone number. If provided, it must contain + as part of the country code.
The prefix of the phone number. If provided, it must contain + as part of the country code.
Contains information about a phone number for a quick connect.
", "refs": { "QuickConnectConfig$PhoneConfig": "The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.
" } }, "PhoneNumberStatus": { "base": "The status of the phone number.
CLAIMED means the previous ClaimPhoneNumber or UpdatePhoneNumber operation succeeded.
IN_PROGRESS means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadata operation is still in progress and has not yet completed. You can call DescribePhoneNumber at a later time to verify if the previous operation has completed.
FAILED indicates that the previous ClaimPhoneNumber or UpdatePhoneNumber operation has failed. It will include a message indicating the failure reason. A common reason for a failure may be that the TargetArn value you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received a FAILED status from a ClaimPhoneNumber API call, you have one day to retry claiming the phone number before the number is released back to the inventory for other customers to claim.
The status of the phone number.
CLAIMED means the previous ClaimPhoneNumber or UpdatePhoneNumber operation succeeded.
IN_PROGRESS means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadata operation is still in progress and has not yet completed. You can call DescribePhoneNumber at a later time to verify if the previous operation has completed.
FAILED indicates that the previous ClaimPhoneNumber or UpdatePhoneNumber operation has failed. It will include a message indicating the failure reason. A common reason for a failure may be that the TargetArn value you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received a FAILED status from a ClaimPhoneNumber API call, you have one day to retry claiming the phone number before the number is released back to the inventory for other customers to claim.
You will not be billed for the phone number during the 1-day period if number claiming fails.
Contains summary information about a phone number for a contact center.
", "refs": { "PhoneNumberSummaryList$member": null } }, "PhoneNumberSummaryList": { "base": null, "refs": { "ListPhoneNumbersResponse$PhoneNumberSummaryList": "Information about the phone numbers.
" } }, "PhoneNumberType": { "base": null, "refs": { "AvailableNumberSummary$PhoneNumberType": "The type of phone number.
", "ClaimedPhoneNumberSummary$PhoneNumberType": "The type of phone number.
", "ListPhoneNumbersSummary$PhoneNumberType": "The type of phone number.
", "PhoneNumberSummary$PhoneNumberType": "The type of phone number.
", "PhoneNumberTypes$member": null, "SearchAvailablePhoneNumbersRequest$PhoneNumberType": "The type of phone number.
" } }, "PhoneNumberTypes": { "base": null, "refs": { "ListPhoneNumbersRequest$PhoneNumberTypes": "The type of phone number.
We recommend using ListPhoneNumbersV2 to return phone number types. While ListPhoneNumbers returns number types UIFN, SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID, it incorrectly lists them as TOLL_FREE or DID.
The type of phone number.
" } }, "PhoneNumberWorkflowMessage": { "base": null, "refs": { "PhoneNumberStatus$Message": "The status message.
" } }, "PhoneNumberWorkflowStatus": { "base": null, "refs": { "PhoneNumberStatus$Status": "The status.
" } }, "PhoneType": { "base": null, "refs": { "UserPhoneConfig$PhoneType": "The phone type.
" } }, "PlatformName": { "base": null, "refs": { "DeviceInfo$PlatformName": "Name of the platform that the participant used for the call.
" } }, "PlatformVersion": { "base": null, "refs": { "DeviceInfo$PlatformVersion": "Version of the platform that the participant used for the call.
" } }, "PotentialAudioQualityIssue": { "base": null, "refs": { "PotentialAudioQualityIssues$member": null } }, "PotentialAudioQualityIssues": { "base": null, "refs": { "AudioQualityMetricsInfo$PotentialQualityIssues": "List of potential issues causing degradation of quality on a media connection. If the service did not detect any potential quality issues the list is empty.
Valid values: HighPacketLoss | HighRoundTripTime | HighJitterBuffer
Indicates the potential disconnection issues for a call. This field is not populated if the service does not detect potential issues.
" } }, "PreSignedAttachmentUrl": { "base": null, "refs": { "EmailAttachment$S3Url": "The pre-signed URLs for the S3 bucket where the email attachment is stored.
" } }, "PredefinedAttribute": { "base": "Information about a predefined attribute.
", "refs": { "DescribePredefinedAttributeResponse$PredefinedAttribute": "Information about the predefined attribute.
", "PredefinedAttributeSearchSummaryList$member": null } }, "PredefinedAttributeConfiguration": { "base": "Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.
", "refs": { "PredefinedAttribute$AttributeConfiguration": "Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.
" } }, "PredefinedAttributeName": { "base": null, "refs": { "AttributeCondition$Name": "The name of predefined attribute.
", "CreatePredefinedAttributeRequest$Name": "The name of the predefined attribute.
", "DeletePredefinedAttributeRequest$Name": "The name of the predefined attribute.
", "DescribePredefinedAttributeRequest$Name": "The name of the predefined attribute.
", "PredefinedAttribute$Name": "The name of the predefined attribute.
", "PredefinedAttributeSummary$Name": "The name of the predefined attribute.
", "UpdatePredefinedAttributeRequest$Name": "The name of the predefined attribute.
", "UserProficiency$AttributeName": "The name of user's proficiency. You must use name of predefined attribute present in the Amazon Connect instance.
", "UserProficiencyDisassociate$AttributeName": "The name of user's proficiency.
" } }, "PredefinedAttributePurposeName": { "base": null, "refs": { "PredefinedAttributePurposeNameList$member": null } }, "PredefinedAttributePurposeNameList": { "base": null, "refs": { "CreatePredefinedAttributeRequest$Purposes": "Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.
", "PredefinedAttribute$Purposes": "Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.
", "UpdatePredefinedAttributeRequest$Purposes": "Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.
" } }, "PredefinedAttributeSearchConditionList": { "base": null, "refs": { "PredefinedAttributeSearchCriteria$OrConditions": "A list of conditions which would be applied together with an OR condition.
A list of conditions which would be applied together with an AND condition.
The search criteria to be used to return predefined attributes.
", "refs": { "PredefinedAttributeSearchConditionList$member": null, "SearchPredefinedAttributesRequest$SearchCriteria": "The search criteria to be used to return predefined attributes.
" } }, "PredefinedAttributeSearchSummaryList": { "base": null, "refs": { "SearchPredefinedAttributesResponse$PredefinedAttributes": "Predefined attributes matched by the search criteria.
" } }, "PredefinedAttributeStringValue": { "base": null, "refs": { "PredefinedAttributeStringValuesList$member": null, "UserProficiency$AttributeValue": "The value of user's proficiency. You must use value of predefined attribute present in the Amazon Connect instance.
", "UserProficiencyDisassociate$AttributeValue": "The value of user's proficiency.
" } }, "PredefinedAttributeStringValuesList": { "base": null, "refs": { "PredefinedAttributeValues$StringList": "Predefined attribute values of type string list.
" } }, "PredefinedAttributeSummary": { "base": "Summary of a predefined attribute.
", "refs": { "PredefinedAttributeSummaryList$member": null } }, "PredefinedAttributeSummaryList": { "base": null, "refs": { "ListPredefinedAttributesResponse$PredefinedAttributeSummaryList": "Summary of the predefined attributes.
" } }, "PredefinedAttributeValues": { "base": "Information about values of a predefined attribute.
", "refs": { "CreatePredefinedAttributeRequest$Values": "The values of the predefined attribute.
", "PredefinedAttribute$Values": "The values of the predefined attribute.
", "UpdatePredefinedAttributeRequest$Values": "The values of the predefined attribute.
" } }, "Prefix": { "base": null, "refs": { "KinesisVideoStreamConfig$Prefix": "The prefix of the video stream.
", "S3Config$BucketPrefix": "The S3 bucket prefix.
" } }, "Priority": { "base": null, "refs": { "RoutingProfileQueueConfig$Priority": "The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay.
", "RoutingProfileQueueConfigSummary$Priority": "The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay.
" } }, "ProblemDetail": { "base": "Information about a problem detail.
", "refs": { "Problems$member": null } }, "ProblemMessageString": { "base": null, "refs": { "ProblemDetail$message": "The problem detail's message.
" } }, "Problems": { "base": null, "refs": { "InvalidContactFlowException$problems": "The problems with the flow. Please fix before trying again.
", "InvalidContactFlowModuleException$Problems": null } }, "ProficiencyLevel": { "base": null, "refs": { "UserProficiency$Level": "The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.
" } }, "ProficiencyValue": { "base": null, "refs": { "AttributeCondition$Value": "The value of predefined attribute.
" } }, "Prompt": { "base": "Information about a prompt.
", "refs": { "DescribePromptResponse$Prompt": "Information about the prompt.
", "PromptList$member": null } }, "PromptDescription": { "base": null, "refs": { "CreatePromptRequest$Description": "The description of the prompt.
", "Prompt$Description": "The description of the prompt.
", "UpdatePromptRequest$Description": "A description of the prompt.
" } }, "PromptId": { "base": null, "refs": { "CreatePromptResponse$PromptId": "A unique identifier for the prompt.
", "DeletePromptRequest$PromptId": "A unique identifier for the prompt.
", "DescribePromptRequest$PromptId": "A unique identifier for the prompt.
", "GetPromptFileRequest$PromptId": "A unique identifier for the prompt.
", "Prompt$PromptId": "A unique identifier for the prompt.
", "PromptSummary$Id": "The identifier of the prompt.
", "UpdatePromptRequest$PromptId": "A unique identifier for the prompt.
", "UpdatePromptResponse$PromptId": "A unique identifier for the prompt.
" } }, "PromptList": { "base": null, "refs": { "SearchPromptsResponse$Prompts": "Information about the prompts.
" } }, "PromptName": { "base": null, "refs": { "PromptSummary$Name": "The name of the prompt.
" } }, "PromptPresignedUrl": { "base": null, "refs": { "GetPromptFileResponse$PromptPresignedUrl": "A generated URL to the prompt that can be given to an unauthorized user so they can access the prompt in S3.
" } }, "PromptSearchConditionList": { "base": null, "refs": { "PromptSearchCriteria$OrConditions": "A list of conditions which would be applied together with an OR condition.
", "PromptSearchCriteria$AndConditions": "A list of conditions which would be applied together with an AND condition.
" } }, "PromptSearchCriteria": { "base": "The search criteria to be used to return prompts.
", "refs": { "PromptSearchConditionList$member": null, "SearchPromptsRequest$SearchCriteria": "The search criteria to be used to return prompts.
" } }, "PromptSearchFilter": { "base": "Filters to be applied to search results.
", "refs": { "SearchPromptsRequest$SearchFilter": "Filters to be applied to search results.
" } }, "PromptSummary": { "base": "Contains information about the prompt.
", "refs": { "PromptSummaryList$member": null } }, "PromptSummaryList": { "base": null, "refs": { "ListPromptsResponse$PromptSummaryList": "Information about the prompts.
" } }, "PropertyValidationException": { "base": "The property is not valid.
", "refs": {} }, "PropertyValidationExceptionProperty": { "base": "Contains information about why a property is not valid.
", "refs": { "PropertyValidationExceptionPropertyList$member": null } }, "PropertyValidationExceptionPropertyList": { "base": null, "refs": { "PropertyValidationException$PropertyList": null } }, "PropertyValidationExceptionReason": { "base": null, "refs": { "PropertyValidationExceptionProperty$Reason": "Why the property is not valid.
" } }, "PutUserStatusRequest": { "base": null, "refs": {} }, "PutUserStatusResponse": { "base": null, "refs": {} }, "QualityMetrics": { "base": "Information about the quality of the participant's media connection.
", "refs": { "Contact$QualityMetrics": "Information about the quality of the participant's media connection.
" } }, "Queue": { "base": "Contains information about a queue.
", "refs": { "DescribeQueueResponse$Queue": "The name of the queue.
", "QueueSearchSummaryList$member": null } }, "QueueDescription": { "base": null, "refs": { "CreateQueueRequest$Description": "The description of the queue.
", "Queue$Description": "The description of the queue.
", "UpdateQueueNameRequest$Description": "The description of the queue.
" } }, "QueueId": { "base": null, "refs": { "AssociateQueueQuickConnectsRequest$QueueId": "The identifier for the queue.
", "AssociatedQueueIdList$member": null, "ContactDataRequest$QueueId": "The identifier of the queue associated with the Amazon Connect instance in which contacts that are created will be queued.
", "ContactSearchSummaryQueueInfo$Id": "The unique identifier for the queue.
", "CreateQueueResponse$QueueId": "The identifier for the queue.
", "CreateRoutingProfileRequest$DefaultOutboundQueueId": "The default outbound queue for the routing profile.
", "DeleteQueueRequest$QueueId": "The identifier for the queue.
", "DescribeQueueRequest$QueueId": "The identifier for the queue.
", "DisassociateQueueQuickConnectsRequest$QueueId": "The identifier for the queue.
", "ListQueueQuickConnectsRequest$QueueId": "The identifier for the queue.
", "Queue$QueueId": "The identifier for the queue.
", "QueueIdList$member": null, "QueueInfo$Id": "The unique identifier for the queue.
", "QueueInfoInput$Id": "The identifier of the queue.
", "QueueQuickConnectConfig$QueueId": "The identifier for the queue.
", "QueueReference$Id": "The identifier of the queue.
", "QueueSummary$Id": "The identifier of the queue.
", "Queues$member": null, "RoutingProfile$DefaultOutboundQueueId": "The identifier of the default outbound queue for this routing profile.
", "RoutingProfileQueueConfigSummary$QueueId": "The identifier for the queue.
", "RoutingProfileQueueReference$QueueId": "The identifier for the queue.
", "StartOutboundVoiceContactRequest$QueueId": "The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the flow is used. If you do not specify a queue, you must specify a source phone number.
", "TransferContactRequest$QueueId": "The identifier for the queue.
", "UpdateQueueHoursOfOperationRequest$QueueId": "The identifier for the queue.
", "UpdateQueueMaxContactsRequest$QueueId": "The identifier for the queue.
", "UpdateQueueNameRequest$QueueId": "The identifier for the queue.
", "UpdateQueueOutboundCallerConfigRequest$QueueId": "The identifier for the queue.
", "UpdateQueueOutboundEmailConfigRequest$QueueId": "The identifier for the queue.
", "UpdateQueueStatusRequest$QueueId": "The identifier for the queue.
", "UpdateRoutingProfileDefaultOutboundQueueRequest$DefaultOutboundQueueId": "The identifier for the default outbound queue.
" } }, "QueueIdList": { "base": null, "refs": { "SearchCriteria$QueueIds": "The list of queue IDs associated with contacts.
" } }, "QueueInfo": { "base": "If this contact was queued, this contains information about the queue.
", "refs": { "Contact$QueueInfo": "If this contact was queued, this contains information about the queue.
" } }, "QueueInfoInput": { "base": "Information about a queue.
", "refs": { "UpdateContactRequest$QueueInfo": "Information about the queue associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.
" } }, "QueueMaxContacts": { "base": null, "refs": { "CreateQueueRequest$MaxContacts": "The maximum number of contacts that can be in the queue before it is considered full.
", "Queue$MaxContacts": "The maximum number of contacts that can be in the queue before it is considered full.
", "UpdateQueueMaxContactsRequest$MaxContacts": "The maximum number of contacts that can be in the queue before it is considered full.
" } }, "QueueName": { "base": null, "refs": { "QueueSummary$Name": "The name of the queue.
", "RoutingProfileQueueConfigSummary$QueueName": "The name of the queue.
" } }, "QueuePriority": { "base": null, "refs": { "Contact$QueuePriority": "An integer that represents the queue priority to be applied to the contact (lower priorities are routed preferentially). Cannot be specified if the QueueTimeAdjustmentSeconds is specified. Must be statically defined, must be larger than zero, and a valid integer value. Default Value is 5.
", "UpdateContactRoutingDataRequest$QueuePriority": "Priority of the contact in the queue. The default priority for new contacts is 5. You can raise the priority of a contact compared to other contacts in the queue by assigning them a higher priority, such as 1 or 2.
" } }, "QueueQuickConnectConfig": { "base": "Contains information about a queue for a quick connect. The flow must be of type Transfer to Queue.
", "refs": { "QuickConnectConfig$QueueConfig": "The queue configuration. This is required only if QuickConnectType is QUEUE.
" } }, "QueueReference": { "base": "Contains information about a queue resource for which metrics are returned.
", "refs": { "AgentContactReference$Queue": null, "Dimensions$Queue": "Information about the queue for which metrics are returned.
" } }, "QueueSearchConditionList": { "base": null, "refs": { "QueueSearchCriteria$OrConditions": "A list of conditions which would be applied together with an OR condition.
", "QueueSearchCriteria$AndConditions": "A list of conditions which would be applied together with an AND condition.
" } }, "QueueSearchCriteria": { "base": "The search criteria to be used to return queues.
The name and description fields support \"contains\" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
The search criteria to be used to return queues.
The name and description fields support \"contains\" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
Filters to be applied to search results.
", "refs": { "SearchQueuesRequest$SearchFilter": "Filters to be applied to search results.
" } }, "QueueSearchSummaryList": { "base": null, "refs": { "SearchQueuesResponse$Queues": "Information about the queues.
" } }, "QueueStatus": { "base": null, "refs": { "Queue$Status": "The status of the queue.
", "UpdateQueueStatusRequest$Status": "The status of the queue.
" } }, "QueueSummary": { "base": "Contains summary information about a queue.
", "refs": { "QueueSummaryList$member": null } }, "QueueSummaryList": { "base": null, "refs": { "ListQueuesResponse$QueueSummaryList": "Information about the queues.
" } }, "QueueTimeAdjustmentSeconds": { "base": null, "refs": { "Contact$QueueTimeAdjustmentSeconds": "An integer that represents the queue time adjust to be applied to the contact, in seconds (longer / larger queue time are routed preferentially). Cannot be specified if the QueuePriority is specified. Must be statically defined and a valid integer value.
", "UpdateContactRoutingDataRequest$QueueTimeAdjustmentSeconds": "The number of seconds to add or subtract from the contact's routing age. Contacts are routed to agents on a first-come, first-serve basis. This means that changing their amount of time in queue compared to others also changes their position in queue.
" } }, "QueueType": { "base": null, "refs": { "QueueSummary$QueueType": "The type of queue.
", "QueueTypes$member": null } }, "QueueTypes": { "base": null, "refs": { "ListQueuesRequest$QueueTypes": "The type of queue.
" } }, "Queues": { "base": null, "refs": { "Filters$Queues": "The queues to use to filter the metrics. You should specify at least one queue, and can specify up to 100 queues per request. The GetCurrentMetricsData API in particular requires a queue when you include a Filter in your request.
A list of up to 100 queues or ARNs.
" } }, "QuickConnect": { "base": "Contains information about a quick connect.
", "refs": { "DescribeQuickConnectResponse$QuickConnect": "Information about the quick connect.
", "QuickConnectSearchSummaryList$member": null } }, "QuickConnectConfig": { "base": "Contains configuration settings for a quick connect.
", "refs": { "CreateQuickConnectRequest$QuickConnectConfig": "Configuration settings for the quick connect.
", "QuickConnect$QuickConnectConfig": "Contains information about the quick connect.
", "UpdateQuickConnectConfigRequest$QuickConnectConfig": "Information about the configuration settings for the quick connect.
" } }, "QuickConnectDescription": { "base": null, "refs": { "CreateQuickConnectRequest$Description": "The description of the quick connect.
", "QuickConnect$Description": "The description.
" } }, "QuickConnectId": { "base": null, "refs": { "CreateQuickConnectResponse$QuickConnectId": "The identifier for the quick connect.
", "DeleteQuickConnectRequest$QuickConnectId": "The identifier for the quick connect.
", "DescribeQuickConnectRequest$QuickConnectId": "The identifier for the quick connect.
", "QuickConnect$QuickConnectId": "The identifier for the quick connect.
", "QuickConnectSummary$Id": "The identifier for the quick connect.
", "QuickConnectsList$member": null, "StartTaskContactRequest$QuickConnectId": "The identifier for the quick connect. Tasks that are created by using QuickConnectId will use the flow that is defined on agent or queue quick connect. For more information about quick connects, see Create quick connects.
The identifier for the quick connect.
", "UpdateQuickConnectNameRequest$QuickConnectId": "The identifier for the quick connect.
" } }, "QuickConnectName": { "base": null, "refs": { "CreateQuickConnectRequest$Name": "A unique name of the quick connect.
", "QuickConnect$Name": "The name of the quick connect.
", "QuickConnectSummary$Name": "The name of the quick connect.
", "UpdateQuickConnectNameRequest$Name": "The name of the quick connect.
" } }, "QuickConnectSearchConditionList": { "base": null, "refs": { "QuickConnectSearchCriteria$OrConditions": "A list of conditions which would be applied together with an OR condition.
", "QuickConnectSearchCriteria$AndConditions": "A list of conditions which would be applied together with an AND condition.
" } }, "QuickConnectSearchCriteria": { "base": "The search criteria to be used to return quick connects.
", "refs": { "QuickConnectSearchConditionList$member": null, "SearchQuickConnectsRequest$SearchCriteria": "The search criteria to be used to return quick connects.
" } }, "QuickConnectSearchFilter": { "base": "Filters to be applied to search results.
", "refs": { "SearchQuickConnectsRequest$SearchFilter": "Filters to be applied to search results.
" } }, "QuickConnectSearchSummaryList": { "base": null, "refs": { "SearchQuickConnectsResponse$QuickConnects": "Information about the quick connects.
" } }, "QuickConnectSummary": { "base": "Contains summary information about a quick connect.
", "refs": { "QuickConnectSummaryList$member": null } }, "QuickConnectSummaryList": { "base": null, "refs": { "ListQueueQuickConnectsResponse$QuickConnectSummaryList": "Information about the quick connects.
", "ListQuickConnectsResponse$QuickConnectSummaryList": "Information about the quick connects.
" } }, "QuickConnectType": { "base": null, "refs": { "QuickConnectConfig$QuickConnectType": "The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
", "QuickConnectSummary$QuickConnectType": "The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
", "QuickConnectTypes$member": null } }, "QuickConnectTypes": { "base": null, "refs": { "ListQuickConnectsRequest$QuickConnectTypes": "The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
" } }, "QuickConnectsList": { "base": null, "refs": { "AssociateQueueQuickConnectsRequest$QuickConnectIds": "The quick connects to associate with this queue.
", "CreateQueueRequest$QuickConnectIds": "The quick connects available to agents who are working the queue.
", "DisassociateQueueQuickConnectsRequest$QuickConnectIds": "The quick connects to disassociate from the queue.
" } }, "Range": { "base": "An Object to define the minimum and maximum proficiency levels.
", "refs": { "AttributeCondition$Range": "An Object to define the minimum and maximum proficiency levels.
" } }, "ReadOnlyFieldInfo": { "base": "Indicates a field that is read-only to an agent.
", "refs": { "ReadOnlyTaskTemplateFields$member": null } }, "ReadOnlyTaskTemplateFields": { "base": null, "refs": { "TaskTemplateConstraints$ReadOnlyFields": "Lists the fields that are read-only to agents, and cannot be edited.
" } }, "RealTimeContactAnalysisAttachment": { "base": "Object that describes attached file.
", "refs": { "RealTimeContactAnalysisAttachments$member": null } }, "RealTimeContactAnalysisAttachments": { "base": null, "refs": { "RealTimeContactAnalysisSegmentAttachments$Attachments": "List of objects describing an individual attachment.
" } }, "RealTimeContactAnalysisCategoryDetails": { "base": "Provides information about the category rule that was matched.
", "refs": { "RealTimeContactAnalysisMatchedDetails$value": null } }, "RealTimeContactAnalysisCategoryName": { "base": null, "refs": { "RealTimeContactAnalysisMatchedDetails$key": null } }, "RealTimeContactAnalysisCharacterInterval": { "base": "Begin and end offsets for a part of text.
", "refs": { "RealTimeContactAnalysisCharacterIntervals$member": null, "RealTimeContactAnalysisTranscriptItemWithCharacterOffsets$CharacterOffsets": "List of character intervals within transcript content/text.
", "RealTimeContactAnalysisTranscriptItemWithContent$CharacterOffsets": null } }, "RealTimeContactAnalysisCharacterIntervals": { "base": null, "refs": { "RealTimeContactAnalysisTranscriptItemRedaction$CharacterOffsets": "List of character intervals each describing a part of the text that was redacted. For OutputType.Raw, part of the original text that contains data that can be redacted. For OutputType.Redacted, part of the string with redaction tag.
The type of content of the item. For example, text/plain.
Type of the event. For example, application/vnd.amazonaws.connect.event.participant.left.
The identifier of the segment.
", "RealTimeContactAnalysisSegmentEvent$Id": "The identifier of the contact event.
", "RealTimeContactAnalysisSegmentTranscript$Id": "The identifier of the transcript.
", "RealTimeContactAnalysisTranscriptItemWithCharacterOffsets$Id": "Transcript identifier. Matches the identifier from one of the TranscriptSegments.
", "RealTimeContactAnalysisTranscriptItemWithContent$Id": "Transcript identifier. Matches the identifier from one of the TranscriptSegments.
" } }, "RealTimeContactAnalysisIssueDetected": { "base": "Potential issues that are detected based on an artificial intelligence analysis of each turn in the conversation.
", "refs": { "RealTimeContactAnalysisIssuesDetected$member": null } }, "RealTimeContactAnalysisIssuesDetected": { "base": null, "refs": { "RealTimeContactAnalysisSegmentIssues$IssuesDetected": "List of the issues detected.
" } }, "RealTimeContactAnalysisMatchedDetails": { "base": null, "refs": { "RealTimeContactAnalysisSegmentCategories$MatchedDetails": "Map between the name of the matched rule and RealTimeContactAnalysisCategoryDetails.
" } }, "RealTimeContactAnalysisOffset": { "base": null, "refs": { "RealTimeContactAnalysisCharacterInterval$BeginOffsetChar": "The beginning of the character interval.
", "RealTimeContactAnalysisCharacterInterval$EndOffsetChar": "The end of the character interval.
" } }, "RealTimeContactAnalysisOutputType": { "base": null, "refs": { "ListRealtimeContactAnalysisSegmentsV2Request$OutputType": "The Contact Lens output type to be returned.
" } }, "RealTimeContactAnalysisPointOfInterest": { "base": "The section of the contact transcript segment that category rule was detected.
", "refs": { "RealTimeContactAnalysisPointsOfInterest$member": null } }, "RealTimeContactAnalysisPointsOfInterest": { "base": null, "refs": { "RealTimeContactAnalysisCategoryDetails$PointsOfInterest": "List of PointOfInterest - objects describing a single match of a rule.
" } }, "RealTimeContactAnalysisPostContactSummaryContent": { "base": null, "refs": { "RealTimeContactAnalysisSegmentPostContactSummary$Content": "The content of the summary.
" } }, "RealTimeContactAnalysisPostContactSummaryFailureCode": { "base": null, "refs": { "RealTimeContactAnalysisSegmentPostContactSummary$FailureCode": "If the summary failed to be generated, one of the following failure codes occurs:
QUOTA_EXCEEDED: The number of concurrent analytics jobs reached your service quota.
INSUFFICIENT_CONVERSATION_CONTENT: The conversation needs to have at least one turn from both the participants in order to generate the summary.
FAILED_SAFETY_GUIDELINES: The generated summary cannot be provided because it failed to meet system safety guidelines.
INVALID_ANALYSIS_CONFIGURATION: This code occurs when, for example, you're using a language that isn't supported by generative AI-powered post-contact summaries.
INTERNAL_ERROR: Internal system error.
Whether the summary was successfully COMPLETED or FAILED to be generated.
" } }, "RealTimeContactAnalysisSegmentAttachments": { "base": "Segment containing list of attachments.
", "refs": { "RealtimeContactAnalysisSegment$Attachments": "The analyzed attachments.
" } }, "RealTimeContactAnalysisSegmentCategories": { "base": "The matched category rules.
", "refs": { "RealtimeContactAnalysisSegment$Categories": null } }, "RealTimeContactAnalysisSegmentEvent": { "base": "Segment type describing a contact event.
", "refs": { "RealtimeContactAnalysisSegment$Event": null } }, "RealTimeContactAnalysisSegmentIssues": { "base": "Segment type containing a list of detected issues.
", "refs": { "RealtimeContactAnalysisSegment$Issues": null } }, "RealTimeContactAnalysisSegmentPostContactSummary": { "base": "Information about the post-contact summary for a real-time contact segment.
", "refs": { "RealtimeContactAnalysisSegment$PostContactSummary": "Information about the post-contact summary.
" } }, "RealTimeContactAnalysisSegmentTranscript": { "base": "The analyzed transcript segment.
", "refs": { "RealtimeContactAnalysisSegment$Transcript": null } }, "RealTimeContactAnalysisSegmentType": { "base": null, "refs": { "RealTimeContactAnalysisSegmentTypes$member": null } }, "RealTimeContactAnalysisSegmentTypes": { "base": null, "refs": { "ListRealtimeContactAnalysisSegmentsV2Request$SegmentTypes": "Enum with segment types . Each value corresponds to a segment type returned in the segments list of the API. Each segment type has its own structure. Different channels may have different sets of supported segment types.
" } }, "RealTimeContactAnalysisSentimentLabel": { "base": null, "refs": { "RealTimeContactAnalysisSegmentTranscript$Sentiment": "The sentiment detected for this piece of transcript.
" } }, "RealTimeContactAnalysisStatus": { "base": null, "refs": { "ListRealtimeContactAnalysisSegmentsV2Response$Status": "Status of real-time contact analysis.
" } }, "RealTimeContactAnalysisSupportedChannel": { "base": null, "refs": { "ListRealtimeContactAnalysisSegmentsV2Response$Channel": "The channel of the contact.
Only CHAT is supported. This API does not support VOICE. If you attempt to use it for the VOICE channel, an InvalidRequestException error occurs.
Object describing time with which the segment is associated. It can have different representations of time. Currently supported: absoluteTime
", "refs": { "RealTimeContactAnalysisSegmentAttachments$Time": "Field describing the time of the event. It can have different representations of time.
", "RealTimeContactAnalysisSegmentEvent$Time": "Field describing the time of the event. It can have different representations of time.
", "RealTimeContactAnalysisSegmentTranscript$Time": "Field describing the time of the event. It can have different representations of time.
" } }, "RealTimeContactAnalysisTimeInstant": { "base": null, "refs": { "RealTimeContactAnalysisTimeData$AbsoluteTime": "Time represented in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
" } }, "RealTimeContactAnalysisTranscriptContent": { "base": null, "refs": { "RealTimeContactAnalysisSegmentTranscript$Content": "The content of the transcript. Can be redacted.
", "RealTimeContactAnalysisTranscriptItemWithContent$Content": "Part of the transcript content that contains identified issue. Can be redacted
" } }, "RealTimeContactAnalysisTranscriptItemRedaction": { "base": "Object describing redaction applied to the segment.
", "refs": { "RealTimeContactAnalysisSegmentTranscript$Redaction": "Object describing redaction that was applied to the transcript. If transcript has the field it means part of the transcript was redacted.
" } }, "RealTimeContactAnalysisTranscriptItemWithCharacterOffsets": { "base": "Transcript representation containing Id and list of character intervals that are associated with analysis data. For example, this object within a RealTimeContactAnalysisPointOfInterest in Category.MatchedDetails would have character interval describing part of the text that matched category.
Transcript representation containing Id, Content and list of character intervals that are associated with analysis data. For example, this object within an issue detected would describe both content that contains identified issue and intervals where that content is taken from.
", "refs": { "RealTimeContactAnalysisTranscriptItemsWithContent$member": null } }, "RealTimeContactAnalysisTranscriptItemsWithCharacterOffsets": { "base": null, "refs": { "RealTimeContactAnalysisPointOfInterest$TranscriptItems": "List of the transcript items (segments) that are associated with a given point of interest.
" } }, "RealTimeContactAnalysisTranscriptItemsWithContent": { "base": null, "refs": { "RealTimeContactAnalysisIssueDetected$TranscriptItems": "List of the transcript items (segments) that are associated with a given issue.
" } }, "RealtimeContactAnalysisSegment": { "base": "An analyzed segment for a real-time analysis session.
", "refs": { "RealtimeContactAnalysisSegments$member": null } }, "RealtimeContactAnalysisSegments": { "base": null, "refs": { "ListRealtimeContactAnalysisSegmentsV2Response$Segments": "An analyzed transcript or category.
" } }, "RecordingDeletionReason": { "base": null, "refs": { "RecordingInfo$DeletionReason": "If the recording/transcript was deleted, this is the reason entered for the deletion.
" } }, "RecordingInfo": { "base": "Information about a voice recording, chat transcript, or screen recording.
", "refs": { "Recordings$member": null } }, "RecordingLocation": { "base": null, "refs": { "RecordingInfo$Location": "The location, in Amazon S3, for the recording/transcript.
" } }, "RecordingStatus": { "base": null, "refs": { "RecordingInfo$Status": "The status of the recording/transcript.
" } }, "Recordings": { "base": null, "refs": { "Contact$Recordings": "If recording was enabled, this is information about the recordings.
" } }, "Reference": { "base": "Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.
", "refs": { "ContactReferences$value": null } }, "ReferenceArn": { "base": null, "refs": { "AttachmentReference$Arn": "The Amazon Resource Name (ARN) of the attachment reference.
", "EmailMessageReference$Arn": "The Amazon Resource Name (ARN) of the email message reference
", "Reference$Arn": "The Amazon Resource Name (ARN) of the reference
" } }, "ReferenceId": { "base": null, "refs": { "EvaluationFormQuestion$RefId": "The identifier of the question. An identifier must be unique within the evaluation form.
", "EvaluationFormSection$RefId": "The identifier of the section. An identifier must be unique within the evaluation form.
", "EvaluationFormSingleSelectQuestionAutomation$DefaultOptionRefId": "The identifier of the default answer option, when none of the automation options match the criteria.
", "EvaluationFormSingleSelectQuestionOption$RefId": "The identifier of the answer option. An identifier must be unique within the question.
", "SingleSelectQuestionRuleCategoryAutomation$OptionRefId": "The identifier of the answer option.
" } }, "ReferenceKey": { "base": null, "refs": { "AttachmentReference$Name": "Identifier of the attachment reference.
", "ContactReferences$key": null, "DateReference$Name": "Identifier of the date reference.
", "EmailMessageReference$Name": "The name of the email message reference
", "EmailReference$Name": "Identifier of the email reference.
", "NumberReference$Name": "Identifier of the number reference.
", "StringReference$Name": "Identifier of the string reference.
", "UrlReference$Name": "Identifier of the URL reference.
" } }, "ReferenceStatus": { "base": null, "refs": { "AttachmentReference$Status": "Status of the attachment reference type.
", "Reference$Status": "Status of the attachment reference type.
" } }, "ReferenceStatusReason": { "base": null, "refs": { "Reference$StatusReason": "Relevant details why the reference was not successfully created.
" } }, "ReferenceSummary": { "base": "Contains summary information about a reference. ReferenceSummary contains only one non null field between the URL and attachment based on the reference type.
Information about the flows.
" } }, "ReferenceType": { "base": null, "refs": { "Reference$Type": "The type of the reference. DATE must be of type Epoch timestamp.
The type of reference.
" } }, "ReferenceValue": { "base": null, "refs": { "AttachmentReference$Value": "The location path of the attachment reference.
", "DateReference$Value": "A valid date.
", "EmailReference$Value": "A valid email address.
", "NumberReference$Value": "A valid number.
", "Reference$Value": "A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
", "StringReference$Value": "A valid string.
", "UrlReference$Value": "A valid URL.
" } }, "RefreshTokenDuration": { "base": null, "refs": { "AuthenticationProfile$MaxSessionDuration": "The long lived session duration for users logged in to Amazon Connect, in minutes. After this time period, users must log in again. For more information, see Configure the session duration in the Amazon Connect Administrator Guide.
" } }, "RegionName": { "base": null, "refs": { "AgentStatus$LastModifiedRegion": "The Amazon Web Services Region where this resource was last modified.
", "AgentStatusSummary$LastModifiedRegion": "The Amazon Web Services Region where this resource was last modified.
", "AuthenticationProfile$LastModifiedRegion": "The Amazon Web Services Region where the authentication profile was last modified.
", "AuthenticationProfileSummary$LastModifiedRegion": "The Amazon Web Services Region when the authentication profile summary was last modified.
", "ContactFlow$LastModifiedRegion": "The region in which the flow was last modified
", "CreateContactFlowVersionRequest$LastModifiedRegion": "The Amazon Web Services Region where this resource was last modified.
", "GetPromptFileResponse$LastModifiedRegion": "The Amazon Web Services Region where this resource was last modified.
", "HierarchyGroup$LastModifiedRegion": "The Amazon Web Services Region where this resource was last modified.
", "HierarchyGroupSummary$LastModifiedRegion": "The Amazon Web Services Region where this resource was last modified.
", "HierarchyLevel$LastModifiedRegion": "The Amazon Web Services Region where this resource was last modified.
", "HoursOfOperation$LastModifiedRegion": "The Amazon Web Services Region where this resource was last modified.
", "HoursOfOperationSummary$LastModifiedRegion": "The Amazon Web Services Region where this resource was last modified.
", "ListHoursOfOperationOverridesResponse$LastModifiedRegion": "The Amazon Web Services Region where this resource was last modified.
", "ListQueueQuickConnectsResponse$LastModifiedRegion": "The Amazon Web Services Region where this resource was last modified.
", "ListRoutingProfileQueuesResponse$LastModifiedRegion": "The Amazon Web Services Region where this resource was last modified.
", "ListSecurityProfileApplicationsResponse$LastModifiedRegion": "The Amazon Web Services Region where this resource was last modified.
", "ListSecurityProfilePermissionsResponse$LastModifiedRegion": "The Amazon Web Services Region where this resource was last modified.
", "ListUserProficienciesResponse$LastModifiedRegion": "The region in which a user's proficiencies were last modified.
", "PredefinedAttribute$LastModifiedRegion": "Last modified region.
", "PredefinedAttributeSummary$LastModifiedRegion": "Last modified region.
", "Prompt$LastModifiedRegion": "The Amazon Web Services Region where this resource was last modified.
", "PromptSummary$LastModifiedRegion": "The Amazon Web Services Region where this resource was last modified.
", "Queue$LastModifiedRegion": "The Amazon Web Services Region where this resource was last modified.
", "QueueSummary$LastModifiedRegion": "The Amazon Web Services Region where this resource was last modified.
", "QuickConnect$LastModifiedRegion": "The Amazon Web Services Region where this resource was last modified.
", "QuickConnectSummary$LastModifiedRegion": "The Amazon Web Services Region where this resource was last modified.
", "RoutingProfile$LastModifiedRegion": "The Amazon Web Services Region where this resource was last modified.
", "RoutingProfileSummary$LastModifiedRegion": "The Amazon Web Services Region where this resource was last modified.
", "SecurityProfile$LastModifiedRegion": "The Amazon Web Services Region where this resource was last modified.
", "SecurityProfileSummary$LastModifiedRegion": "The Amazon Web Services Region where this resource was last modified.
", "User$LastModifiedRegion": "The Amazon Web Services Region where this resource was last modified.
", "UserSummary$LastModifiedRegion": "The Amazon Web Services Region where this resource was last modified.
" } }, "RegistrationId": { "base": null, "refs": { "CreatePushNotificationRegistrationResponse$RegistrationId": "The identifier for the registration.
", "DeletePushNotificationRegistrationRequest$RegistrationId": "The identifier for the registration.
" } }, "RehydrationType": { "base": null, "refs": { "CreatePersistentContactAssociationRequest$RehydrationType": "The contactId chosen for rehydration depends on the type chosen.
ENTIRE_PAST_SESSION: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the initialContactId of the past ended chat session in the sourceContactId field. In this type, Amazon Connect determines what the most recent chat contact on the past ended chat session and uses it to start a persistent chat.
FROM_SEGMENT: Rehydrates a chat from the specified past chat contact provided in the sourceContactId field.
The actual contactId used for rehydration is provided in the response of this API.
To illustrate how to use rehydration type, consider the following example: A customer starts a chat session. Agent a1 accepts the chat and a conversation starts between the customer and Agent a1. This first contact creates a contact ID C1. Agent a1 then transfers the chat to Agent a2. This creates another contact ID C2. At this point Agent a2 ends the chat. The customer is forwarded to the disconnect flow for a post chat survey that creates another contact ID C3. After the chat survey, the chat session ends. Later, the customer returns and wants to resume their past chat session. At this point, the customer can have following use cases:
Use Case 1: The customer wants to continue the past chat session but they want to hide the post chat survey. For this they will use the following configuration:
Configuration
SourceContactId = \"C2\"
RehydrationType = \"FROM_SEGMENT\"
Expected behavior
This starts a persistent chat session from the specified past ended contact (C2). Transcripts of past chat sessions C2 and C1 are accessible in the current persistent chat session. Note that chat segment C3 is dropped from the persistent chat session.
Use Case 2: The customer wants to continue the past chat session and see the transcript of the entire past engagement, including the post chat survey. For this they will use the following configuration:
Configuration
SourceContactId = \"C1\"
RehydrationType = \"ENTIRE_PAST_SESSION\"
Expected behavior
This starts a persistent chat session from the most recently ended chat contact (C3). Transcripts of past chat sessions C3, C2 and C1 are accessible in the current persistent chat session.
The contactId that is used for rehydration depends on the rehydration type. RehydrationType is required for persistent chat.
ENTIRE_PAST_SESSION: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the initialContactId of the past ended chat session in the sourceContactId field. In this type, Amazon Connect determines the most recent chat contact on the specified chat session that has ended, and uses it to start a persistent chat.
FROM_SEGMENT: Rehydrates a chat from the past chat contact that is specified in the sourceContactId field.
The actual contactId used for rehydration is provided in the response of this API.
" } }, "ReleasePhoneNumberRequest": { "base": null, "refs": {} }, "ReplicateInstanceRequest": { "base": null, "refs": {} }, "ReplicateInstanceResponse": { "base": null, "refs": {} }, "ReplicationConfiguration": { "base": "Details about the status of the replication of a source Amazon Connect instance across Amazon Web Services Regions. Use these details to understand the general status of a given replication. For information about why a replication process may fail, see Why a ReplicateInstance call fails in the Create a replica of your existing Amazon Connect instance topic in the Amazon Connect Administrator Guide.
", "refs": { "DescribeInstanceResponse$ReplicationConfiguration": "Status information about the replication process. This field is included only when you are using the ReplicateInstance API to replicate an Amazon Connect instance across Amazon Web Services Regions. For information about replicating Amazon Connect instances, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide.
" } }, "ReplicationStatusReason": { "base": null, "refs": { "ReplicationStatusSummary$ReplicationStatusReason": "A description of the replication status. Use this information to resolve any issues that are preventing the successful replication of your Amazon Connect instance to another Region.
" } }, "ReplicationStatusSummary": { "base": "Status information about the replication process, where you use the ReplicateInstance API to create a replica of your Amazon Connect instance in another Amazon Web Services Region. For more information, see Set up Amazon Connect Global Resiliency in the Amazon Connect Administrator Guide.
", "refs": { "ReplicationStatusSummaryList$member": null } }, "ReplicationStatusSummaryList": { "base": null, "refs": { "ReplicationConfiguration$ReplicationStatusSummaryList": "A list of replication status summaries. The summaries contain details about the replication of configuration information for Amazon Connect resources, for each Amazon Web Services Region.
" } }, "RequestIdentifier": { "base": null, "refs": { "ContactDataRequest$RequestIdentifier": "Identifier to uniquely identify individual requests in the batch.
", "FailedRequest$RequestIdentifier": "Request identifier provided in the API call in the ContactDataRequest to create a contact.
", "SuccessfulRequest$RequestIdentifier": "Request identifier provided in the API call in the ContactDataRequest to create a contact.
" } }, "RequiredFieldInfo": { "base": "Information about a required field.
", "refs": { "RequiredTaskTemplateFields$member": null } }, "RequiredTaskTemplateFields": { "base": null, "refs": { "TaskTemplateConstraints$RequiredFields": "Lists the fields that are required to be filled by agents.
" } }, "ResourceArnOrId": { "base": null, "refs": { "FilterV2$FilterKey": "The key to use for filtering data. For example, QUEUE, ROUTING_PROFILE, AGENT, CHANNEL, AGENT_HIERARCHY_LEVEL_ONE, AGENT_HIERARCHY_LEVEL_TWO, AGENT_HIERARCHY_LEVEL_THREE, AGENT_HIERARCHY_LEVEL_FOUR, AGENT_HIERARCHY_LEVEL_FIVE. There must be at least 1 key and a maximum 5 keys.
The type of comparison. Currently, \"less than\" (LT), \"less than equal\" (LTE), and \"greater than\" (GT) comparisons are supported.
" } }, "ResourceConflictException": { "base": "A resource already has that name.
", "refs": {} }, "ResourceId": { "base": null, "refs": { "ActivateEvaluationFormRequest$EvaluationFormId": "The unique identifier for the evaluation form.
", "ActivateEvaluationFormResponse$EvaluationFormId": "The unique identifier for the evaluation form.
", "CreateEvaluationFormResponse$EvaluationFormId": "The unique identifier for the evaluation form.
", "DeactivateEvaluationFormRequest$EvaluationFormId": "The unique identifier for the evaluation form.
", "DeactivateEvaluationFormResponse$EvaluationFormId": "The unique identifier for the evaluation form.
", "DeleteContactEvaluationRequest$EvaluationId": "A unique identifier for the contact evaluation.
", "DeleteEvaluationFormRequest$EvaluationFormId": "The unique identifier for the evaluation form.
", "DescribeContactEvaluationRequest$EvaluationId": "A unique identifier for the contact evaluation.
", "DescribeEvaluationFormRequest$EvaluationFormId": "A unique identifier for the contact evaluation.
", "Evaluation$EvaluationId": "A unique identifier for the contact evaluation.
", "EvaluationAnswersInputMap$key": null, "EvaluationAnswersOutputMap$key": null, "EvaluationForm$EvaluationFormId": "The unique identifier for the evaluation form.
", "EvaluationFormContent$EvaluationFormId": "The unique identifier for the evaluation form.
", "EvaluationFormSummary$EvaluationFormId": "The unique identifier for the evaluation form.
", "EvaluationFormVersionSummary$EvaluationFormId": "The unique identifier for the evaluation form.
", "EvaluationMetadata$ContactAgentId": "The identifier of the agent who performed the contact.
", "EvaluationNotesMap$key": null, "EvaluationScoresMap$key": null, "EvaluationSummary$EvaluationId": "A unique identifier for the contact evaluation.
", "EvaluationSummary$EvaluationFormId": "The unique identifier for the evaluation form.
", "ListEvaluationFormVersionsRequest$EvaluationFormId": "The unique identifier for the evaluation form.
", "StartContactEvaluationRequest$EvaluationFormId": "The unique identifier for the evaluation form.
", "StartContactEvaluationResponse$EvaluationId": "A unique identifier for the contact evaluation.
", "SubmitContactEvaluationRequest$EvaluationId": "A unique identifier for the contact evaluation.
", "SubmitContactEvaluationResponse$EvaluationId": "A unique identifier for the contact evaluation.
", "UpdateContactEvaluationRequest$EvaluationId": "A unique identifier for the contact evaluation.
", "UpdateContactEvaluationResponse$EvaluationId": "A unique identifier for the contact evaluation.
", "UpdateEvaluationFormRequest$EvaluationFormId": "The unique identifier for the evaluation form.
", "UpdateEvaluationFormResponse$EvaluationFormId": "The unique identifier for the evaluation form.
" } }, "ResourceInUseException": { "base": "That resource is already in use (for example, you're trying to add a record with the same name as an existing record). If you are trying to delete a resource (for example, DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources and then try again.
", "refs": {} }, "ResourceNotFoundException": { "base": "The specified resource was not found.
", "refs": {} }, "ResourceNotReadyException": { "base": "The resource is not ready.
", "refs": {} }, "ResourceTagsSearchCriteria": { "base": "The search criteria to be used to search tags.
", "refs": { "SearchResourceTagsRequest$SearchCriteria": "The search criteria to be used to return tags.
" } }, "ResourceType": { "base": null, "refs": { "ResourceInUseException$ResourceType": "The type of resource.
" } }, "ResourceTypeList": { "base": null, "refs": { "SearchResourceTagsRequest$ResourceTypes": "The list of resource types to be used to search tags from. If not provided or if any empty list is provided, this API will search from all supported resource types. Note that lowercase and - are required.
Supported resource types
agent
agent-state
routing-profile
standard-queue
security-profile
operating-hours
prompt
contact-flow
flow- module
transfer-destination (also known as quick connect)
The identifier of the flow version.
", "ContactFlowVersionSummary$Version": "The identifier of the flow version.
", "CreateContactFlowVersionRequest$ContactFlowVersion": "The identifier of the flow version.
", "CreateContactFlowVersionResponse$Version": "The identifier of the flow version.
", "DeleteContactFlowVersionRequest$ContactFlowVersion": "The identifier of the flow version.
" } }, "ResumeContactRecordingRequest": { "base": null, "refs": {} }, "ResumeContactRecordingResponse": { "base": null, "refs": {} }, "ResumeContactRequest": { "base": null, "refs": {} }, "ResumeContactResponse": { "base": null, "refs": {} }, "RoutingCriteria": { "base": "Latest routing criteria on the contact.
", "refs": { "Contact$RoutingCriteria": "Latest routing criteria on the contact.
" } }, "RoutingCriteriaInput": { "base": "An object to define the RoutingCriteria.
", "refs": { "UpdateContactRoutingDataRequest$RoutingCriteria": "Updates the routing criteria on the contact. These properties can be used to change how a contact is routed within the queue.
" } }, "RoutingCriteriaInputStep": { "base": "Step defines the list of agents to be routed or route based on the agent requirements such as ProficiencyLevel, Name, or Value.
", "refs": { "RoutingCriteriaInputSteps$member": null } }, "RoutingCriteriaInputStepExpiry": { "base": "Specify whether this routing criteria step should apply for only a limited amount of time, or if it should never expire.
", "refs": { "RoutingCriteriaInputStep$Expiry": "An object to specify the expiration of a routing step.
" } }, "RoutingCriteriaInputSteps": { "base": null, "refs": { "RoutingCriteriaInput$Steps": "When Amazon Connect does not find an available agent meeting the requirements in a step for a given step duration, the routing criteria will move on to the next step sequentially until a join is completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue.
" } }, "RoutingCriteriaStepStatus": { "base": null, "refs": { "Step$Status": "Represents status of the Routing step.
" } }, "RoutingExpression": { "base": null, "refs": { "Dimensions$RoutingStepExpression": "The expression of a step in a routing criteria.
", "RoutingExpressions$member": null } }, "RoutingExpressions": { "base": null, "refs": { "Filters$RoutingStepExpressions": "A list of expressions as a filter, in which an expression is an object of a step in a routing criteria.
" } }, "RoutingProfile": { "base": "Contains information about a routing profile.
", "refs": { "DescribeRoutingProfileResponse$RoutingProfile": "The routing profile.
", "RoutingProfileList$member": null } }, "RoutingProfileDescription": { "base": null, "refs": { "CreateRoutingProfileRequest$Description": "Description of the routing profile. Must not be more than 250 characters.
", "RoutingProfile$Description": "The description of the routing profile.
", "UpdateRoutingProfileNameRequest$Description": "The description of the routing profile. Must not be more than 250 characters.
" } }, "RoutingProfileId": { "base": null, "refs": { "AssociateRoutingProfileQueuesRequest$RoutingProfileId": "The identifier of the routing profile.
", "CreateRoutingProfileResponse$RoutingProfileId": "The identifier of the routing profile.
", "CreateUserRequest$RoutingProfileId": "The identifier of the routing profile for the user.
", "DeleteRoutingProfileRequest$RoutingProfileId": "The identifier of the routing profile.
", "DescribeRoutingProfileRequest$RoutingProfileId": "The identifier of the routing profile.
", "DisassociateRoutingProfileQueuesRequest$RoutingProfileId": "The identifier of the routing profile.
", "ListRoutingProfileQueuesRequest$RoutingProfileId": "The identifier of the routing profile.
", "RoutingProfile$RoutingProfileId": "The identifier of the routing profile.
", "RoutingProfileReference$Id": "The identifier of the routing profile.
", "RoutingProfileSummary$Id": "The identifier of the routing profile.
", "RoutingProfiles$member": null, "UpdateRoutingProfileAgentAvailabilityTimerRequest$RoutingProfileId": "The identifier of the routing profile.
", "UpdateRoutingProfileConcurrencyRequest$RoutingProfileId": "The identifier of the routing profile.
", "UpdateRoutingProfileDefaultOutboundQueueRequest$RoutingProfileId": "The identifier of the routing profile.
", "UpdateRoutingProfileNameRequest$RoutingProfileId": "The identifier of the routing profile.
", "UpdateRoutingProfileQueuesRequest$RoutingProfileId": "The identifier of the routing profile.
", "UpdateUserRoutingProfileRequest$RoutingProfileId": "The identifier of the routing profile for the user.
", "User$RoutingProfileId": "The identifier of the routing profile for the user.
", "UserSearchSummary$RoutingProfileId": "The identifier of the user's routing profile.
" } }, "RoutingProfileList": { "base": null, "refs": { "SearchRoutingProfilesResponse$RoutingProfiles": "Information about the routing profiles.
" } }, "RoutingProfileName": { "base": null, "refs": { "CreateRoutingProfileRequest$Name": "The name of the routing profile. Must not be more than 127 characters.
", "RoutingProfile$Name": "The name of the routing profile.
", "RoutingProfileSummary$Name": "The name of the routing profile.
", "UpdateRoutingProfileNameRequest$Name": "The name of the routing profile. Must not be more than 127 characters.
" } }, "RoutingProfileQueueConfig": { "base": "Contains information about the queue and channel for which priority and delay can be set.
", "refs": { "RoutingProfileQueueConfigList$member": null } }, "RoutingProfileQueueConfigList": { "base": null, "refs": { "AssociateRoutingProfileQueuesRequest$QueueConfigs": "The queues to associate with this routing profile.
", "CreateRoutingProfileRequest$QueueConfigs": "The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls.
The limit of 10 array members applies to the maximum number of RoutingProfileQueueConfig objects that can be passed during a CreateRoutingProfile API request. It is different from the quota of 50 queues per routing profile per instance that is listed in Amazon Connect service quotas.
The queues to be updated for this routing profile. Queues must first be associated to the routing profile. You can do this using AssociateRoutingProfileQueues.
" } }, "RoutingProfileQueueConfigSummary": { "base": "Contains summary information about a routing profile queue.
", "refs": { "RoutingProfileQueueConfigSummaryList$member": null } }, "RoutingProfileQueueConfigSummaryList": { "base": null, "refs": { "ListRoutingProfileQueuesResponse$RoutingProfileQueueConfigSummaryList": "Information about the routing profiles.
" } }, "RoutingProfileQueueReference": { "base": "Contains the channel and queue identifier for a routing profile.
", "refs": { "RoutingProfileQueueConfig$QueueReference": "Contains information about a queue resource.
", "RoutingProfileQueueReferenceList$member": null } }, "RoutingProfileQueueReferenceList": { "base": null, "refs": { "DisassociateRoutingProfileQueuesRequest$QueueReferences": "The queues to disassociate from this routing profile.
" } }, "RoutingProfileReference": { "base": "Information about the routing profile assigned to the user.
", "refs": { "Dimensions$RoutingProfile": null, "UserData$RoutingProfile": "Information about the routing profile that is assigned to the user.
" } }, "RoutingProfileSearchConditionList": { "base": null, "refs": { "RoutingProfileSearchCriteria$OrConditions": "A list of conditions which would be applied together with an OR condition.
", "RoutingProfileSearchCriteria$AndConditions": "A list of conditions which would be applied together with an AND condition.
" } }, "RoutingProfileSearchCriteria": { "base": "The search criteria to be used to return routing profiles.
The name and description fields support \"contains\" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
The search criteria to be used to return routing profiles.
The name and description fields support \"contains\" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
Filters to be applied to search results.
", "refs": { "SearchRoutingProfilesRequest$SearchFilter": "Filters to be applied to search results.
" } }, "RoutingProfileSummary": { "base": "Contains summary information about a routing profile.
", "refs": { "RoutingProfileSummaryList$member": null } }, "RoutingProfileSummaryList": { "base": null, "refs": { "ListRoutingProfilesResponse$RoutingProfileSummaryList": "Information about the routing profiles.
" } }, "RoutingProfiles": { "base": null, "refs": { "Filters$RoutingProfiles": "A list of up to 100 routing profile IDs or ARNs.
", "UserDataFilters$RoutingProfiles": "A list of up to 100 routing profile IDs or ARNs.
" } }, "Rule": { "base": "Information about a rule.
", "refs": { "DescribeRuleResponse$Rule": "Information about the rule.
" } }, "RuleAction": { "base": "Information about the action to be performed when a rule is triggered.
", "refs": { "RuleActions$member": null } }, "RuleActions": { "base": null, "refs": { "CreateRuleRequest$Actions": "A list of actions to be run when the rule is triggered.
", "Rule$Actions": "A list of actions to be run when the rule is triggered.
", "UpdateRuleRequest$Actions": "A list of actions to be run when the rule is triggered.
" } }, "RuleFunction": { "base": null, "refs": { "CreateRuleRequest$Function": "The conditions of the rule.
", "Rule$Function": "The conditions of the rule.
", "UpdateRuleRequest$Function": "The conditions of the rule.
" } }, "RuleId": { "base": null, "refs": { "CreateRuleResponse$RuleId": "A unique identifier for the rule.
", "DeleteRuleRequest$RuleId": "A unique identifier for the rule.
", "DescribeRuleRequest$RuleId": "A unique identifier for the rule.
", "Rule$RuleId": "A unique identifier for the rule.
", "RuleSummary$RuleId": "A unique identifier for the rule.
", "UpdateRuleRequest$RuleId": "A unique identifier for the rule.
" } }, "RuleName": { "base": null, "refs": { "CreateRuleRequest$Name": "A unique name for the rule.
", "Rule$Name": "The name of the rule.
", "RuleSummary$Name": "The name of the rule.
", "UpdateRuleRequest$Name": "The name of the rule. You can change the name only if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
The publish status of the rule.
", "ListRulesRequest$PublishStatus": "The publish status of the rule.
", "Rule$PublishStatus": "The publish status of the rule.
", "RuleSummary$PublishStatus": "The publish status of the rule.
", "UpdateRuleRequest$PublishStatus": "The publish status of the rule.
" } }, "RuleSummary": { "base": "A list of ActionTypes associated with a rule.
Summary information about a rule.
" } }, "RuleTriggerEventSource": { "base": "The name of the event source. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate | OnContactEvaluationSubmit | OnMetricDataUpdate.
The event source to trigger the rule.
", "Rule$TriggerEventSource": "The event source to trigger the rule.
" } }, "S3Config": { "base": "Information about the Amazon Simple Storage Service (Amazon S3) storage type.
", "refs": { "InstanceStorageConfig$S3Config": "The S3 bucket configuration.
" } }, "S3Uri": { "base": null, "refs": { "CreatePromptRequest$S3Uri": "The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the GetPromptFile API instead of providing S3 URIs.
", "UpdatePromptRequest$S3Uri": "The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the GetPromptFile API instead of providing S3 URIs.
" } }, "ScreenShareCapability": { "base": null, "refs": { "ParticipantCapabilities$ScreenShare": "The screen sharing capability that is enabled for the participant. SEND indicates the participant can share their screen.
The match type combining search criteria using multiple searchable contact attributes.
", "SearchableSegmentAttributes$MatchType": "The match type combining search criteria using multiple searchable segment attributes.
", "Transcript$MatchType": "The match type combining search criteria using multiple transcript criteria.
", "TranscriptCriteria$MatchType": "The match type combining search criteria using multiple search texts in a transcript criteria.
" } }, "SearchContactsRequest": { "base": null, "refs": {} }, "SearchContactsResponse": { "base": null, "refs": {} }, "SearchContactsTimeRange": { "base": "A structure of time range that you want to search results.
", "refs": { "SearchContactsRequest$TimeRange": "Time range that you want to search results.
" } }, "SearchContactsTimeRangeType": { "base": null, "refs": { "SearchContactsTimeRange$Type": "The type of timestamp to search.
" } }, "SearchCriteria": { "base": "A structure of search criteria to be used to return contacts.
", "refs": { "SearchContactsRequest$SearchCriteria": "The search criteria to be used to return contacts.
" } }, "SearchEmailAddressesRequest": { "base": null, "refs": {} }, "SearchEmailAddressesResponse": { "base": null, "refs": {} }, "SearchHoursOfOperationOverridesRequest": { "base": null, "refs": {} }, "SearchHoursOfOperationOverridesResponse": { "base": null, "refs": {} }, "SearchHoursOfOperationsRequest": { "base": null, "refs": {} }, "SearchHoursOfOperationsResponse": { "base": null, "refs": {} }, "SearchPredefinedAttributesRequest": { "base": null, "refs": {} }, "SearchPredefinedAttributesResponse": { "base": null, "refs": {} }, "SearchPromptsRequest": { "base": null, "refs": {} }, "SearchPromptsResponse": { "base": null, "refs": {} }, "SearchQueuesRequest": { "base": null, "refs": {} }, "SearchQueuesResponse": { "base": null, "refs": {} }, "SearchQuickConnectsRequest": { "base": null, "refs": {} }, "SearchQuickConnectsResponse": { "base": null, "refs": {} }, "SearchResourceTagsRequest": { "base": null, "refs": {} }, "SearchResourceTagsResponse": { "base": null, "refs": {} }, "SearchRoutingProfilesRequest": { "base": null, "refs": {} }, "SearchRoutingProfilesResponse": { "base": null, "refs": {} }, "SearchSecurityProfilesRequest": { "base": null, "refs": {} }, "SearchSecurityProfilesResponse": { "base": null, "refs": {} }, "SearchText": { "base": null, "refs": { "SearchTextList$member": null } }, "SearchTextList": { "base": null, "refs": { "TranscriptCriteria$SearchText": "The words or phrases used to search within a transcript.
" } }, "SearchUserHierarchyGroupsRequest": { "base": null, "refs": {} }, "SearchUserHierarchyGroupsResponse": { "base": null, "refs": {} }, "SearchUsersRequest": { "base": null, "refs": {} }, "SearchUsersResponse": { "base": null, "refs": {} }, "SearchVocabulariesRequest": { "base": null, "refs": {} }, "SearchVocabulariesResponse": { "base": null, "refs": {} }, "SearchableContactAttributeKey": { "base": null, "refs": { "SearchableContactAttributesCriteria$Key": "The key containing a searchable user-defined contact attribute.
" } }, "SearchableContactAttributeValue": { "base": null, "refs": { "SearchableContactAttributeValueList$member": null } }, "SearchableContactAttributeValueList": { "base": null, "refs": { "SearchableContactAttributesCriteria$Values": "The list of values to search for within a user-defined contact attribute.
" } }, "SearchableContactAttributes": { "base": "A structure that defines search criteria based on user-defined contact attributes that are configured for contact search.
", "refs": { "SearchCriteria$SearchableContactAttributes": "The search criteria based on user-defined contact attributes that have been configured for contact search. For more information, see Search by custom contact attributes in the Amazon Connect Administrator Guide.
To use SearchableContactAttributes in a search request, the GetContactAttributes action is required to perform an API request. For more information, see https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissionsActions defined by Amazon Connect.
The search criteria based on user-defined contact attribute key and values to search on.
", "refs": { "SearchableContactAttributesCriteriaList$member": null } }, "SearchableContactAttributesCriteriaList": { "base": null, "refs": { "SearchableContactAttributes$Criteria": "The list of criteria based on user-defined contact attributes that are configured for contact search.
" } }, "SearchableQueueType": { "base": null, "refs": { "QueueSearchCriteria$QueueTypeCondition": "The type of queue.
" } }, "SearchableSegmentAttributeKey": { "base": null, "refs": { "SearchableSegmentAttributesCriteria$Key": "The key containing a searchable segment attribute.
" } }, "SearchableSegmentAttributeValue": { "base": null, "refs": { "SearchableSegmentAttributeValueList$member": null } }, "SearchableSegmentAttributeValueList": { "base": null, "refs": { "SearchableSegmentAttributesCriteria$Values": "The list of values to search for within a searchable segment attribute.
" } }, "SearchableSegmentAttributes": { "base": "The search criteria based on searchable segment attributes of a contact
", "refs": { "SearchCriteria$SearchableSegmentAttributes": "The search criteria based on searchable segment attributes of a contact.
" } }, "SearchableSegmentAttributesCriteria": { "base": "The search criteria based on searchable segment attribute key and values to search on.
", "refs": { "SearchableSegmentAttributesCriteriaList$member": null } }, "SearchableSegmentAttributesCriteriaList": { "base": null, "refs": { "SearchableSegmentAttributes$Criteria": "The list of criteria based on searchable segment attributes.
" } }, "SecurityKey": { "base": "Configuration information of the security key.
", "refs": { "SecurityKeysList$member": null } }, "SecurityKeysList": { "base": null, "refs": { "ListSecurityKeysResponse$SecurityKeys": "The security keys.
" } }, "SecurityProfile": { "base": "Contains information about a security profile.
", "refs": { "DescribeSecurityProfileResponse$SecurityProfile": "The security profile.
" } }, "SecurityProfileDescription": { "base": null, "refs": { "CreateSecurityProfileRequest$Description": "The description of the security profile.
", "SecurityProfile$Description": "The description of the security profile.
", "SecurityProfileSearchSummary$Description": "The description of the security profile.
", "UpdateSecurityProfileRequest$Description": "The description of the security profile.
" } }, "SecurityProfileId": { "base": null, "refs": { "CreateSecurityProfileResponse$SecurityProfileId": "The identifier for the security profle.
", "DeleteSecurityProfileRequest$SecurityProfileId": "The identifier for the security profle.
", "DescribeSecurityProfileRequest$SecurityProfileId": "The identifier for the security profle.
", "ListSecurityProfileApplicationsRequest$SecurityProfileId": "The identifier for the security profle.
", "ListSecurityProfilePermissionsRequest$SecurityProfileId": "The identifier for the security profle.
", "SecurityProfile$Id": "The identifier for the security profile.
", "SecurityProfileIds$member": null, "SecurityProfileSearchSummary$Id": "The identifier of the security profile.
", "SecurityProfileSummary$Id": "The identifier of the security profile.
", "UpdateSecurityProfileRequest$SecurityProfileId": "The identifier for the security profle.
" } }, "SecurityProfileIds": { "base": null, "refs": { "CreateUserRequest$SecurityProfileIds": "The identifier of the security profile for the user.
", "UpdateUserSecurityProfilesRequest$SecurityProfileIds": "The identifiers of the security profiles for the user.
", "User$SecurityProfileIds": "The identifiers of the security profiles for the user.
", "UserSearchSummary$SecurityProfileIds": "The identifiers of the user's security profiles.
" } }, "SecurityProfileName": { "base": null, "refs": { "SecurityProfile$SecurityProfileName": "The name for the security profile.
", "SecurityProfileSearchSummary$SecurityProfileName": "The name of the security profile.
", "SecurityProfileSummary$Name": "The name of the security profile.
" } }, "SecurityProfilePermission": { "base": null, "refs": { "PermissionsList$member": null } }, "SecurityProfilePolicyKey": { "base": null, "refs": { "AllowedAccessControlTags$key": null } }, "SecurityProfilePolicyValue": { "base": null, "refs": { "AllowedAccessControlTags$value": null } }, "SecurityProfileSearchConditionList": { "base": null, "refs": { "SecurityProfileSearchCriteria$OrConditions": "A list of conditions which would be applied together with an OR condition.
", "SecurityProfileSearchCriteria$AndConditions": "A list of conditions which would be applied together with an AND condition.
" } }, "SecurityProfileSearchCriteria": { "base": "The search criteria to be used to return security profiles.
The name field support \"contains\" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
The search criteria to be used to return security profiles.
The name field support \"contains\" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
The currently supported value for FieldName: name
Information about the returned security profiles.
", "refs": { "SecurityProfilesSearchSummaryList$member": null } }, "SecurityProfileSummary": { "base": "Contains information about a security profile.
", "refs": { "SecurityProfileSummaryList$member": null } }, "SecurityProfileSummaryList": { "base": null, "refs": { "ListSecurityProfilesResponse$SecurityProfileSummaryList": "Information about the security profiles.
" } }, "SecurityProfilesSearchFilter": { "base": "Filters to be applied to search results.
", "refs": { "SearchSecurityProfilesRequest$SearchFilter": "Filters to be applied to search results.
" } }, "SecurityProfilesSearchSummaryList": { "base": null, "refs": { "SearchSecurityProfilesResponse$SecurityProfiles": "Information about the security profiles.
" } }, "SecurityToken": { "base": null, "refs": { "Credentials$AccessToken": "An access token generated for a federated user to access Amazon Connect.
", "Credentials$RefreshToken": "Renews a token generated for a user to access the Amazon Connect instance.
" } }, "SegmentAttributeName": { "base": null, "refs": { "ContactSearchSummarySegmentAttributes$key": null, "SegmentAttributeValueMap$key": null, "SegmentAttributes$key": null } }, "SegmentAttributeValue": { "base": "A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
The value of a segment attribute.
" } }, "SegmentAttributeValueList": { "base": null, "refs": { "SegmentAttributeValue$ValueList": "The value of a segment attribute. This is only supported for system-defined attributes, not for user-defined attributes.
" } }, "SegmentAttributeValueMap": { "base": null, "refs": { "SegmentAttributeValue$ValueMap": "The value of a segment attribute.
" } }, "SegmentAttributeValueString": { "base": null, "refs": { "ContactSearchSummarySegmentAttributeValue$ValueString": "The value of a segment attribute represented as a string.
", "SegmentAttributeValue$ValueString": "The value of a segment attribute.
", "SegmentAttributeValue$ValueArn": "The value of a segment attribute that has to be a valid ARN. This is only supported for system-defined attributes, not for user-defined attributes.
" } }, "SegmentAttributes": { "base": null, "refs": { "Contact$SegmentAttributes": "A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes and can be accessed in flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example, connect:Guide or connect:SMS.
A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
Attribute keys can include only alphanumeric, -, and _.
This field can be used to set Segment Contact Expiry as a duration in minutes.
To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will be active for before expiring, with SegmentAttributes like { \"connect:ContactExpiry\": {\"ValueMap\" : { \"ExpiryDuration\": { \"ValueInteger\": 135}}}}.
A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
Attribute keys can include only alphanumeric, -, and _.
This field can be used to show channel subtype, such as connect:Guide.
The types application/vnd.amazonaws.connect.message.interactive and application/vnd.amazonaws.connect.message.interactive.response must be present in the SupportedMessagingContentTypes field of this API in order to set SegmentAttributes as { \"connect:Subtype\": {\"valueString\" : \"connect:Guide\" }}.
A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
Attribute keys can include only alphanumeric, -, and _.
This field can be used to show channel subtype, such as connect:Guide.
To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will be active for before expiring, with SegmentAttributes like { \"connect:ContactExpiry\": {\"ValueMap\" : { \"ExpiryDuration\": { \"ValueInteger\":135}}}}.
A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
Attribute keys can include only alphanumeric, -, and _.
This field can be used to show channel subtype, such as connect:Guide and connect:SMS.
A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
Attribute keys can include only alphanumeric, -, and _.
This field can be used to set Contact Expiry as a duration in minutes and set a UserId for the User who created a task.
To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will be active for before expiring, with SegmentAttributes like { \"connect:ContactExpiry\": {\"ValueMap\" : { \"ExpiryDuration\": { \"ValueInteger\": 135}}}}.
To set the created by user, a valid AgentResourceId must be supplied, with SegmentAttributes like { \"connect:CreatedByUser\" { \"ValueString\": \"arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/agent/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"}}}.
A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
Attribute keys can include only alphanumeric, -, and _.
This field can be used to show channel subtype, such as connect:Guide.
Contact Expiry, and user-defined attributes (String - String) that are defined in predefined attributes, can be updated by using the UpdateContact API.
" } }, "SendChatIntegrationEventRequest": { "base": null, "refs": {} }, "SendChatIntegrationEventResponse": { "base": null, "refs": {} }, "SendNotificationActionDefinition": { "base": "Information about the send notification action.
", "refs": { "RuleAction$SendNotificationAction": "Information about the send notification action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate
The service quota has been exceeded.
", "refs": {} }, "ServiceQuotaExceededExceptionReason": { "base": "The reason for the exception.
", "refs": { "ServiceQuotaExceededException$Reason": null } }, "SignInConfig": { "base": "The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s).
", "refs": { "GetTrafficDistributionResponse$SignInConfig": "The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s).
", "UpdateTrafficDistributionRequest$SignInConfig": "The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s).
" } }, "SignInDistribution": { "base": "The distribution of sign in traffic between the instance and its replica(s).
", "refs": { "SignInDistributionList$member": null } }, "SignInDistributionList": { "base": null, "refs": { "SignInConfig$Distributions": "Information about traffic distributions.
" } }, "SingleSelectOptions": { "base": null, "refs": { "TaskTemplateField$SingleSelectOptions": "A list of options for a single select field.
" } }, "SingleSelectQuestionRuleCategoryAutomation": { "base": "Information about the automation option based on a rule category for a single select question.
", "refs": { "EvaluationFormSingleSelectQuestionAutomationOption$RuleCategory": "The automation option based on a rule category for the single select question.
" } }, "SingleSelectQuestionRuleCategoryAutomationCondition": { "base": null, "refs": { "SingleSelectQuestionRuleCategoryAutomation$Condition": "The condition to apply for the automation option. If the condition is PRESENT, then the option is applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT, then the option is applied when the contact data does not include the category.
The category name, as defined in Rules.
" } }, "SlaAssignmentType": { "base": null, "refs": { "AssignSlaActionDefinition$SlaAssignmentType": "Type of SLA assignment.
" } }, "SlaFieldValueUnionList": { "base": null, "refs": { "CaseSlaConfiguration$TargetFieldValues": "Represents a list of target field values for the fieldId specified in CaseSlaConfiguration. The SLA is considered met if any one of these target field values matches the actual field value.
" } }, "SlaName": { "base": null, "refs": { "CaseSlaConfiguration$Name": "Name of an SLA.
" } }, "SlaType": { "base": null, "refs": { "CaseSlaConfiguration$Type": "Type of SLA for Case SlaAssignmentType.
" } }, "SnapshotVersion": { "base": null, "refs": { "GetTaskTemplateRequest$SnapshotVersion": "The system generated version of a task template that is associated with a task, when the task is created.
" } }, "Sort": { "base": "A structure that defines the field name to sort by and a sort order.
", "refs": { "SearchContactsRequest$Sort": "Specifies a field to sort by and a sort order.
" } }, "SortOrder": { "base": null, "refs": { "CurrentMetricSortCriteria$SortOrder": "The way to sort.
", "Sort$Order": "An ascending or descending sort.
" } }, "SortableFieldName": { "base": null, "refs": { "Sort$FieldName": "The name of the field on which to sort.
" } }, "SourceApplicationName": { "base": null, "refs": { "CreateIntegrationAssociationRequest$SourceApplicationName": "The name of the external application. This field is only required for the EVENT integration type.
", "IntegrationAssociationSummary$SourceApplicationName": "The user-provided, friendly name for the external application.
" } }, "SourceCampaign": { "base": "Information about the campaign.
", "refs": { "SendOutboundEmailRequest$SourceCampaign": "A Campaign object need for Campaign traffic type.
" } }, "SourceId": { "base": null, "refs": { "SendChatIntegrationEventRequest$SourceId": "External identifier of chat customer participant, used in part to uniquely identify a chat. For SMS, this is the E164 phone number of the chat customer participant.
" } }, "SourceType": { "base": null, "refs": { "CreateIntegrationAssociationRequest$SourceType": "The type of the data source. This field is only required for the EVENT integration type.
", "IntegrationAssociationSummary$SourceType": "The name of the source.
" } }, "StartAttachedFileUploadRequest": { "base": null, "refs": {} }, "StartAttachedFileUploadResponse": { "base": "Response from StartAttachedFileUpload API.", "refs": {} }, "StartChatContactRequest": { "base": null, "refs": {} }, "StartChatContactResponse": { "base": null, "refs": {} }, "StartContactEvaluationRequest": { "base": null, "refs": {} }, "StartContactEvaluationResponse": { "base": null, "refs": {} }, "StartContactRecordingRequest": { "base": null, "refs": {} }, "StartContactRecordingResponse": { "base": null, "refs": {} }, "StartContactStreamingRequest": { "base": null, "refs": {} }, "StartContactStreamingResponse": { "base": null, "refs": {} }, "StartEmailContactRequest": { "base": null, "refs": {} }, "StartEmailContactResponse": { "base": null, "refs": {} }, "StartOutboundChatContactRequest": { "base": null, "refs": {} }, "StartOutboundChatContactResponse": { "base": null, "refs": {} }, "StartOutboundEmailContactRequest": { "base": null, "refs": {} }, "StartOutboundEmailContactResponse": { "base": null, "refs": {} }, "StartOutboundVoiceContactRequest": { "base": null, "refs": {} }, "StartOutboundVoiceContactResponse": { "base": null, "refs": {} }, "StartScreenSharingRequest": { "base": null, "refs": {} }, "StartScreenSharingResponse": { "base": null, "refs": {} }, "StartTaskContactRequest": { "base": null, "refs": {} }, "StartTaskContactResponse": { "base": null, "refs": {} }, "StartWebRTCContactRequest": { "base": null, "refs": {} }, "StartWebRTCContactResponse": { "base": null, "refs": {} }, "StateTransition": { "base": "Information about the state transition of a supervisor.
", "refs": { "StateTransitions$member": null } }, "StateTransitions": { "base": null, "refs": { "AgentInfo$StateTransitions": "List of StateTransition for a supervisor.
The statistic for the metric.
" } }, "Status": { "base": null, "refs": { "ContactEvaluation$Status": "The status of the evaluation.
" } }, "Step": { "base": "Step signifies the criteria to be used for routing to an agent
", "refs": { "Steps$member": null } }, "Steps": { "base": null, "refs": { "RoutingCriteria$Steps": "List of routing steps. When Amazon Connect does not find an available agent meeting the requirements in a step for a given step duration, the routing criteria will move on to the next step sequentially until a join is completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue.
" } }, "StopContactRecordingRequest": { "base": null, "refs": {} }, "StopContactRecordingResponse": { "base": null, "refs": {} }, "StopContactRequest": { "base": null, "refs": {} }, "StopContactResponse": { "base": null, "refs": {} }, "StopContactStreamingRequest": { "base": null, "refs": {} }, "StopContactStreamingResponse": { "base": null, "refs": {} }, "StorageType": { "base": null, "refs": { "InstanceStorageConfig$StorageType": "A valid storage type.
", "RecordingInfo$StorageType": "Where the recording/transcript is stored.
" } }, "StreamingId": { "base": null, "refs": { "StartContactStreamingResponse$StreamingId": "The identifier of the streaming configuration enabled.
", "StopContactStreamingRequest$StreamingId": "The identifier of the streaming configuration enabled.
" } }, "String": { "base": null, "refs": { "AnalyticsDataAssociationResult$ResourceShareId": "The Resource Access Manager share ID.
", "AnalyticsDataAssociationResult$ResourceShareStatus": "The Amazon Web Services Resource Access Manager status of association.
", "AnalyticsDataSetsResult$DataSetName": "The name of the dataset.
", "AssociateAnalyticsDataSetResponse$ResourceShareId": "The Resource Access Manager share ID that is generated.
", "Contact$DisconnectReason": "The disconnect reason for the contact.
", "DateCondition$FieldName": "An object to specify the hours of operation override date field.
", "ErrorResult$ErrorCode": "The error code.
", "ErrorResult$ErrorMessage": "The corresponding error message for the error code.
", "FailedRequest$FailureReasonMessage": "Why the request to create a contact failed.
", "HierarchyGroupCondition$Value": "The value in the hierarchy group condition.
", "InstanceStatusReason$Message": "The message.
", "IntervalDetails$TimeZone": "The timezone applied to requested metrics.
", "MetricFilterV2$MetricFilterKey": "The key to use for filtering data.
Valid metric filter keys:
ANSWERING_MACHINE_DETECTION_STATUS
CASE_STATUS
DISCONNECT_REASON
FLOWS_ACTION_IDENTIFIER
FLOWS_NEXT_ACTION_IDENTIFIER
FLOWS_OUTCOME_TYPE
FLOWS_RESOURCE_TYPE
INITIATION_METHOD
The name of the field in the number condition.
", "PropertyValidationExceptionProperty$PropertyPath": "The full property path.
", "ResourceTypeList$member": null, "StringCondition$FieldName": "The name of the field in the string condition.
", "StringCondition$Value": "The value of the string.
", "TagCondition$TagKey": "The tag key in the tag condition.
", "TagCondition$TagValue": "The tag value in the tag condition.
", "UserTagMap$key": null, "UserTagMap$value": null } }, "StringComparisonType": { "base": null, "refs": { "StringCondition$ComparisonType": "The type of comparison to be made when evaluating the string condition.
", "TagSearchCondition$tagKeyComparisonType": "The type of comparison to be made when evaluating the tag key in tag search condition.
", "TagSearchCondition$tagValueComparisonType": "The type of comparison to be made when evaluating the tag value in tag search condition.
" } }, "StringCondition": { "base": "A leaf node condition which can be used to specify a string condition.
", "refs": { "AgentStatusSearchCriteria$StringCondition": "A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are name,
description, state, type, displayOrder,
and resourceID.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are name and
value.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are name, description, timezone, and resourceID.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are name, description, and resourceID.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are name, description, and resourceID.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are name, description, and resourceID.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are associatedQueueIds, name, description, and resourceID.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are name,
parentId, levelId, and resourceID.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are Username, FirstName, LastName, RoutingProfileId, SecurityProfileId, ResourceId.
Information about a reference when the referenceType is STRING. Otherwise, null.
Information about a reference when the referenceType is STRING. Otherwise, null.
The subject of the email if the delivery method is EMAIL. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
Information about the submit automated evaluation action.
", "refs": { "RuleAction$SubmitAutoEvaluationAction": "Information about the submit automated evaluation action.
" } }, "SubmitContactEvaluationRequest": { "base": null, "refs": {} }, "SubmitContactEvaluationResponse": { "base": null, "refs": {} }, "Subtype": { "base": null, "refs": { "SendChatIntegrationEventRequest$Subtype": "Classification of a channel. This is used in part to uniquely identify chat.
Valid value: [\"connect:sms\", connect:\"WhatsApp\"]
Request for which contact was successfully created.
", "refs": { "SuccessfulRequestList$member": null } }, "SuccessfulRequestList": { "base": null, "refs": { "BatchPutContactResponse$SuccessfulRequestList": "List of requests for which contact was successfully created.
" } }, "SupportedMessagingContentType": { "base": null, "refs": { "SupportedMessagingContentTypes$member": null } }, "SupportedMessagingContentTypes": { "base": null, "refs": { "NewSessionDetails$SupportedMessagingContentTypes": " The supported chat message content types. Supported types are text/plain, text/markdown, application/json, application/vnd.amazonaws.connect.message.interactive, and application/vnd.amazonaws.connect.message.interactive.response.
Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain: [text/plain, text/markdown, application/json], [text/markdown, text/plain], [text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response].
The supported chat message content types. Supported types are text/plain, text/markdown, application/json, application/vnd.amazonaws.connect.message.interactive, and application/vnd.amazonaws.connect.message.interactive.response.
Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain: [text/plain, text/markdown, application/json], [text/markdown, text/plain], [text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response].
The type application/vnd.amazonaws.connect.message.interactive is required to use the Show view flow block.
The supported chat message content types. Supported types are:
text/plain
text/markdown
application/json, application/vnd.amazonaws.connect.message.interactive
application/vnd.amazonaws.connect.message.interactive.response
Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain:
[text/plain, text/markdown, application/json]
[text/markdown, text/plain]
[text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response]
A leaf node condition which can be used to specify a tag condition.
", "CommonAttributeAndCondition$TagConditions": "A leaf node condition which can be used to specify a tag condition.
", "ControlPlaneTagFilter$AndConditions": "A list of conditions which would be applied together with an AND condition.
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
A leaf node condition which can be used to specify a tag condition.
", "ControlPlaneUserAttributeFilter$TagCondition": null, "TagAndConditionList$member": null } }, "TagContactRequest": { "base": null, "refs": {} }, "TagContactResponse": { "base": null, "refs": {} }, "TagKey": { "base": null, "refs": { "TagKeyList$member": null, "TagMap$key": null, "TagSet$key": "The tag key in the TagSet.
" } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "The tag keys.
" } }, "TagKeyString": { "base": null, "refs": { "TagSearchCondition$tagKey": "The tag key used in the tag search condition.
" } }, "TagMap": { "base": null, "refs": { "AgentStatus$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "AttachedFile$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "ClaimedPhoneNumberSummary$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "ContactFlow$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "ContactFlowModule$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "CreateAgentStatusRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "CreateContactFlowModuleRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "CreateContactFlowRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "CreateEmailAddressRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "CreateHoursOfOperationRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "CreateInstanceRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "CreatePromptRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "CreateQueueRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "CreateQuickConnectRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "CreateRoutingProfileRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "CreateSecurityProfileRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "CreateTrafficDistributionGroupRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "CreateUseCaseRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "CreateUserHierarchyGroupRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "CreateUserRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "CreateViewRequest$Tags": "The tags associated with the view resource (not specific to view version).These tags can be used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "CreateVocabularyRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "DescribeEmailAddressResponse$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "Evaluation$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "EvaluationForm$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "GetAttachedFileResponse$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "HierarchyGroup$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "HoursOfOperation$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "ImportPhoneNumberRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "Instance$Tags": "The tags of an instance.
", "ListTagsForResourceResponse$tags": "Information about the tags.
", "Prompt$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "Queue$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "QuickConnect$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "RoutingProfile$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "Rule$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "SecurityProfile$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "SecurityProfileSearchSummary$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "StartAttachedFileUploadRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "TrafficDistributionGroup$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "User$Tags": "The tags.
", "UserSearchSummary$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "View$Tags": "The tags associated with the view resource (not specific to view version).
", "Vocabulary$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } }, "TagOrConditionList": { "base": null, "refs": { "ControlPlaneTagFilter$OrConditions": "A list of conditions which would be applied together with an OR condition.
The list of resources that a security profile applies tag restrictions to in Amazon Connect. For a list of Amazon Connect resources that you can tag, see Add tags to resources in Amazon Connect in the Amazon Connect Administrator Guide.
", "SecurityProfile$TagRestrictedResources": "The list of resources that a security profile applies tag restrictions to in Amazon Connect.
", "UpdateSecurityProfileRequest$TagRestrictedResources": "The list of resources that a security profile applies tag restrictions to in Amazon Connect.
" } }, "TagRestrictedResourceName": { "base": null, "refs": { "TagRestrictedResourceList$member": null } }, "TagSearchCondition": { "base": "The search criteria to be used to return tags.
", "refs": { "ResourceTagsSearchCriteria$TagSearchCondition": "The search criteria to be used to return tags.
" } }, "TagSet": { "base": "A tag set contains tag key and tag value.
", "refs": { "TagsList$member": null } }, "TagValue": { "base": null, "refs": { "TagMap$value": null, "TagSet$value": "The tag value in the tagSet.
" } }, "TagValueString": { "base": null, "refs": { "TagSearchCondition$tagValue": "The tag value used in the tag search condition.
" } }, "TagsList": { "base": null, "refs": { "SearchResourceTagsResponse$Tags": "A list of tags used in the Amazon Connect instance.
" } }, "TargetListType": { "base": null, "refs": { "ListCondition$TargetListType": "The type of target list that will be used to filter the users.
" } }, "TargetSlaMinutes": { "base": null, "refs": { "CaseSlaConfiguration$TargetSlaMinutes": "Target duration in minutes within which an SLA should be completed.
" } }, "TaskActionDefinition": { "base": "Information about the task action.
", "refs": { "RuleAction$TaskAction": "Information about the task action. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
The description. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
" } }, "TaskNameExpression": { "base": null, "refs": { "TaskActionDefinition$Name": "The name. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
" } }, "TaskTemplateArn": { "base": null, "refs": { "CreateTaskTemplateResponse$Arn": "The Amazon Resource Name (ARN) for the task template resource.
", "GetTaskTemplateResponse$Arn": "The Amazon Resource Name (ARN).
", "TaskTemplateMetadata$Arn": "The Amazon Resource Name (ARN) of the task template.
", "UpdateTaskTemplateResponse$Arn": "The Amazon Resource Name (ARN) for the task template resource.
" } }, "TaskTemplateConstraints": { "base": "Describes constraints that apply to the template fields.
", "refs": { "CreateTaskTemplateRequest$Constraints": "Constraints that are applicable to the fields listed.
", "GetTaskTemplateResponse$Constraints": "Constraints that are applicable to the fields listed.
", "UpdateTaskTemplateRequest$Constraints": "Constraints that are applicable to the fields listed.
", "UpdateTaskTemplateResponse$Constraints": "Constraints that are applicable to the fields listed.
" } }, "TaskTemplateDefaultFieldValue": { "base": "Describes a default field and its corresponding value.
", "refs": { "TaskTemplateDefaultFieldValueList$member": null } }, "TaskTemplateDefaultFieldValueList": { "base": null, "refs": { "TaskTemplateDefaults$DefaultFieldValues": "Default value for the field.
" } }, "TaskTemplateDefaults": { "base": "Describes default values for fields on a template.
", "refs": { "CreateTaskTemplateRequest$Defaults": "The default values for fields when a task is created by referencing this template.
", "GetTaskTemplateResponse$Defaults": "The default values for fields when a task is created by referencing this template.
", "UpdateTaskTemplateRequest$Defaults": "The default values for fields when a task is created by referencing this template.
", "UpdateTaskTemplateResponse$Defaults": "The default values for fields when a task is created by referencing this template.
" } }, "TaskTemplateDescription": { "base": null, "refs": { "CreateTaskTemplateRequest$Description": "The description of the task template.
", "GetTaskTemplateResponse$Description": "The description of the task template.
", "TaskTemplateMetadata$Description": "The description of the task template.
", "UpdateTaskTemplateRequest$Description": "The description of the task template.
", "UpdateTaskTemplateResponse$Description": "The description of the task template.
" } }, "TaskTemplateField": { "base": "Describes a single task template field.
", "refs": { "TaskTemplateFields$member": null } }, "TaskTemplateFieldDescription": { "base": null, "refs": { "TaskTemplateField$Description": "The description of the field.
" } }, "TaskTemplateFieldIdentifier": { "base": "The identifier of the task template field.
", "refs": { "InvisibleFieldInfo$Id": "Identifier of the invisible field.
", "ReadOnlyFieldInfo$Id": "Identifier of the read-only field.
", "RequiredFieldInfo$Id": "The unique identifier for the field.
", "TaskTemplateDefaultFieldValue$Id": "Identifier of a field.
", "TaskTemplateField$Id": "The unique identifier for the field.
" } }, "TaskTemplateFieldName": { "base": null, "refs": { "TaskTemplateFieldIdentifier$Name": "The name of the task template field.
" } }, "TaskTemplateFieldType": { "base": null, "refs": { "TaskTemplateField$Type": "Indicates the type of field.
" } }, "TaskTemplateFieldValue": { "base": null, "refs": { "TaskTemplateDefaultFieldValue$DefaultValue": "Default value for the field.
" } }, "TaskTemplateFields": { "base": null, "refs": { "CreateTaskTemplateRequest$Fields": "Fields that are part of the template.
", "GetTaskTemplateResponse$Fields": "Fields that are part of the template.
", "UpdateTaskTemplateRequest$Fields": "Fields that are part of the template.
", "UpdateTaskTemplateResponse$Fields": "Fields that are part of the template.
" } }, "TaskTemplateId": { "base": null, "refs": { "CreateTaskTemplateResponse$Id": "The identifier of the task template resource.
", "DeleteTaskTemplateRequest$TaskTemplateId": "A unique identifier for the task template.
", "GetTaskTemplateRequest$TaskTemplateId": "A unique identifier for the task template.
", "GetTaskTemplateResponse$Id": "A unique identifier for the task template.
", "StartTaskContactRequest$TaskTemplateId": "A unique identifier for the task template. For more information about task templates, see Create task templates in the Amazon Connect Administrator Guide.
", "TaskTemplateMetadata$Id": "A unique identifier for the task template.
", "UpdateTaskTemplateRequest$TaskTemplateId": "A unique identifier for the task template.
", "UpdateTaskTemplateResponse$Id": "The identifier of the task template resource.
" } }, "TaskTemplateList": { "base": null, "refs": { "ListTaskTemplatesResponse$TaskTemplates": "Provides details about a list of task templates belonging to an instance.
" } }, "TaskTemplateMetadata": { "base": "Contains summary information about the task template.
", "refs": { "TaskTemplateList$member": null } }, "TaskTemplateName": { "base": null, "refs": { "CreateTaskTemplateRequest$Name": "The name of the task template.
", "GetTaskTemplateResponse$Name": "The name of the task template.
", "ListTaskTemplatesRequest$Name": "The name of the task template.
", "TaskTemplateMetadata$Name": "The name of the task template.
", "UpdateTaskTemplateRequest$Name": "The name of the task template.
", "UpdateTaskTemplateResponse$Name": "The name of the task template.
" } }, "TaskTemplateSingleSelectOption": { "base": null, "refs": { "SingleSelectOptions$member": null } }, "TaskTemplateStatus": { "base": null, "refs": { "CreateTaskTemplateRequest$Status": "Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.
Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.
Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.
Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.
Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.
Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.
The distribution of traffic between the instance and its replicas.
", "refs": { "GetTrafficDistributionResponse$TelephonyConfig": "The distribution of traffic between the instance and its replicas.
", "UpdateTrafficDistributionRequest$TelephonyConfig": "The distribution of traffic between the instance and its replica(s).
" } }, "TemplateAttributes": { "base": "Information about the template attributes.
", "refs": { "TemplatedMessageConfig$TemplateAttributes": "Information about template attributes, that is, CustomAttributes or CustomerProfileAttributes.
" } }, "TemplateId": { "base": null, "refs": { "CreateCaseActionDefinition$TemplateId": "A unique identifier of a template.
" } }, "TemplatedMessageConfig": { "base": "Information about template message configuration.
", "refs": { "OutboundEmailContent$TemplatedMessageConfig": "Information about template message configuration.
" } }, "Threshold": { "base": "Contains information about the threshold for service level metrics.
", "refs": { "HistoricalMetric$Threshold": "The threshold for the metric, used with service level metrics.
" } }, "ThresholdCollections": { "base": null, "refs": { "MetricV2$Threshold": "Contains information about the threshold for service level metrics.
" } }, "ThresholdV2": { "base": "Contains information about the threshold for service level metrics.
", "refs": { "ThresholdCollections$member": null } }, "ThresholdValue": { "base": null, "refs": { "Threshold$ThresholdValue": "The threshold value to compare.
", "ThresholdV2$ThresholdValue": "The threshold value to compare.
" } }, "ThrottlingException": { "base": "The throttling limit has been exceeded.
", "refs": {} }, "TimeZone": { "base": null, "refs": { "CreateHoursOfOperationRequest$TimeZone": "The time zone of the hours of operation.
", "GetEffectiveHoursOfOperationsResponse$TimeZone": "The time zone for the hours of operation.
", "HoursOfOperation$TimeZone": "The time zone for the hours of operation.
", "UpdateHoursOfOperationRequest$TimeZone": "The time zone of the hours of operation.
" } }, "TimerEligibleParticipantRoles": { "base": null, "refs": { "ParticipantTimerConfiguration$ParticipantRole": "The role of the participant in the chat conversation.
" } }, "Timestamp": { "base": null, "refs": { "AgentContactReference$StateStartTimestamp": "The epoch timestamp when the contact state started.
", "AgentContactReference$ConnectedToAgentTimestamp": "The time at which the contact was connected to an agent.
", "AgentStatus$LastModifiedTime": "The timestamp when this resource was last modified.
", "AgentStatusReference$StatusStartTimestamp": "The start timestamp of the agent's status.
", "AgentStatusSummary$LastModifiedTime": "The timestamp when this resource was last modified.
", "AssociatedContactSummary$InitiationTimestamp": "The date and time this contact was initiated, in UTC time.
", "AssociatedContactSummary$DisconnectTimestamp": "The date and time that the customer endpoint disconnected from the current contact, in UTC time. In transfer scenarios, the DisconnectTimestamp of the previous contact indicates the date and time when that contact ended.
", "AuthenticationProfile$CreatedTime": "The timestamp when the authentication profile was created.
", "AuthenticationProfile$LastModifiedTime": "The timestamp when the authentication profile was last modified.
", "AuthenticationProfileSummary$LastModifiedTime": "The timestamp when the authentication profile summary was last modified.
", "ContactFlow$LastModifiedTime": "The time at which the flow was last modified.
", "CreateContactFlowVersionRequest$LastModifiedTime": "The Amazon Web Services Region where this resource was last modified.
", "Evaluation$CreatedTime": "The timestamp for when the evaluation was created.
", "Evaluation$LastModifiedTime": "The timestamp for when the evaluation was last updated.
", "EvaluationForm$CreatedTime": "The timestamp for when the evaluation form was created.
", "EvaluationForm$LastModifiedTime": "The timestamp for when the evaluation form was last updated.
", "EvaluationFormSummary$CreatedTime": "The timestamp for when the evaluation form was created.
", "EvaluationFormSummary$LastModifiedTime": "The timestamp for when the evaluation form was last updated.
", "EvaluationFormSummary$LastActivatedTime": "The timestamp for when the evaluation form was last activated.
", "EvaluationFormVersionSummary$CreatedTime": "The timestamp for when the evaluation form was created.
", "EvaluationFormVersionSummary$LastModifiedTime": "The timestamp for when the evaluation form was last updated.
", "EvaluationSummary$CreatedTime": "The timestamp for when the evaluation was created.
", "EvaluationSummary$LastModifiedTime": "The timestamp for when the evaluation was last updated.
", "GetMetricDataV2Request$StartTime": "The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be before the end time timestamp. The start and end time depends on the IntervalPeriod selected. By default the time range between start and end time is 35 days. Historical metrics are available for 3 months.
The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be later than the start time timestamp. It cannot be later than the current timestamp.
", "GetPromptFileResponse$LastModifiedTime": "The timestamp when this resource was last modified.
", "HierarchyGroup$LastModifiedTime": "The timestamp when this resource was last modified.
", "HierarchyGroupSummary$LastModifiedTime": "The timestamp when this resource was last modified.
", "HierarchyLevel$LastModifiedTime": "The timestamp when this resource was last modified.
", "HoursOfOperation$LastModifiedTime": "The timestamp when this resource was last modified.
", "HoursOfOperationSummary$LastModifiedTime": "The timestamp when this resource was last modified.
", "Instance$CreatedTime": "When the instance was created.
", "InstanceSummary$CreatedTime": "When the instance was created.
", "ListHoursOfOperationOverridesResponse$LastModifiedTime": "The timestamp when this resource was last modified.
", "ListQueueQuickConnectsResponse$LastModifiedTime": "The timestamp when this resource was last modified.
", "ListRoutingProfileQueuesResponse$LastModifiedTime": "The timestamp when this resource was last modified.
", "ListSecurityProfileApplicationsResponse$LastModifiedTime": "The timestamp when this resource was last modified.
", "ListSecurityProfilePermissionsResponse$LastModifiedTime": "The timestamp when this resource was last modified.
", "ListUserProficienciesResponse$LastModifiedTime": "The last time that the user's proficiencies are were modified.
", "MetricInterval$StartTime": "The timestamp, in UNIX Epoch time format. Start time is based on the interval period selected.
", "MetricInterval$EndTime": "The timestamp, in UNIX Epoch time format. End time is based on the interval period selected. For example, If IntervalPeriod is selected THIRTY_MIN, StartTime and EndTime in the API request differs by 1 day, then 48 results are returned in the response. Each result is aggregated by the 30 minutes period, with each StartTime and EndTime differing by 30 minutes.
Last modified time.
", "PredefinedAttributeSummary$LastModifiedTime": "Last modified time.
", "Prompt$LastModifiedTime": "The timestamp when this resource was last modified.
", "PromptSummary$LastModifiedTime": "The timestamp when this resource was last modified.
", "Queue$LastModifiedTime": "The timestamp when this resource was last modified.
", "QueueSummary$LastModifiedTime": "The timestamp when this resource was last modified.
", "QuickConnect$LastModifiedTime": "The timestamp when this resource was last modified.
", "QuickConnectSummary$LastModifiedTime": "The timestamp when this resource was last modified.
", "RoutingProfile$LastModifiedTime": "The timestamp when this resource was last modified.
", "RoutingProfileSummary$LastModifiedTime": "The timestamp when this resource was last modified.
", "Rule$CreatedTime": "The timestamp for when the rule was created.
", "Rule$LastUpdatedTime": "The timestamp for the when the rule was last updated.
", "RuleSummary$CreatedTime": "The timestamp for when the rule was created.
", "RuleSummary$LastUpdatedTime": "The timestamp for when the rule was last updated.
", "SearchContactsTimeRange$StartTime": "The start time of the time range.
", "SearchContactsTimeRange$EndTime": "The end time of the time range.
", "SecurityProfile$LastModifiedTime": "The timestamp when this resource was last modified.
", "SecurityProfileSummary$LastModifiedTime": "The timestamp when this resource was last modified.
", "StartTaskContactRequest$ScheduledTime": "The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
", "UpdateContactScheduleRequest$ScheduledTime": "The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
", "User$LastModifiedTime": "The timestamp when this resource was last modified.
", "UserSummary$LastModifiedTime": "The timestamp when this resource was last modified.
", "View$CreatedTime": "The timestamp of when the view was created.
", "View$LastModifiedTime": "Latest timestamp of the UpdateViewContent or CreateViewVersion operations.
Displayed when rate-related API limits are exceeded.
", "refs": {} }, "TotalCount": { "base": null, "refs": { "SearchContactsResponse$TotalCount": "The total number of contacts which matched your search query.
" } }, "TotalPauseCount": { "base": null, "refs": { "Contact$TotalPauseCount": "Total pause count for a contact.
" } }, "TotalPauseDurationInSeconds": { "base": null, "refs": { "Contact$TotalPauseDurationInSeconds": "Total pause duration for a contact in seconds.
" } }, "TrafficDistributionGroup": { "base": "Information about a traffic distribution group.
", "refs": { "DescribeTrafficDistributionGroupResponse$TrafficDistributionGroup": "Information about the traffic distribution group.
" } }, "TrafficDistributionGroupArn": { "base": null, "refs": { "CreateTrafficDistributionGroupResponse$Arn": "The Amazon Resource Name (ARN) of the traffic distribution group.
", "GetTrafficDistributionResponse$Arn": "The Amazon Resource Name (ARN) of the traffic distribution group.
", "TrafficDistributionGroup$Arn": "The Amazon Resource Name (ARN) of the traffic distribution group.
", "TrafficDistributionGroupSummary$Arn": "The Amazon Resource Name (ARN) of the traffic distribution group.
" } }, "TrafficDistributionGroupId": { "base": null, "refs": { "CreateTrafficDistributionGroupResponse$Id": "The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group.
", "GetTrafficDistributionResponse$Id": "The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
", "TrafficDistributionGroup$Id": "The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
", "TrafficDistributionGroupSummary$Id": "The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
" } }, "TrafficDistributionGroupIdOrArn": { "base": null, "refs": { "AssociateTrafficDistributionGroupUserRequest$TrafficDistributionGroupId": "The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group.
", "DeleteTrafficDistributionGroupRequest$TrafficDistributionGroupId": "The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group.
", "DescribeTrafficDistributionGroupRequest$TrafficDistributionGroupId": "The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
", "DisassociateTrafficDistributionGroupUserRequest$TrafficDistributionGroupId": "The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group.
", "GetTrafficDistributionRequest$Id": "The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
", "ListTrafficDistributionGroupUsersRequest$TrafficDistributionGroupId": "The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
", "UpdateTrafficDistributionRequest$Id": "The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
" } }, "TrafficDistributionGroupStatus": { "base": null, "refs": { "TrafficDistributionGroup$Status": "The status of the traffic distribution group.
CREATION_IN_PROGRESS means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed.
ACTIVE means the previous CreateTrafficDistributionGroup operation has succeeded.
CREATION_FAILED indicates that the previous CreateTrafficDistributionGroup operation has failed.
PENDING_DELETION means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed.
DELETION_FAILED means the previous DeleteTrafficDistributionGroup operation has failed.
UPDATE_IN_PROGRESS means the previous UpdateTrafficDistribution operation is still in progress and has not yet completed.
The status of the traffic distribution group.
CREATION_IN_PROGRESS means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed.
ACTIVE means the previous CreateTrafficDistributionGroup operation has succeeded.
CREATION_FAILED indicates that the previous CreateTrafficDistributionGroup operation has failed.
PENDING_DELETION means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed.
DELETION_FAILED means the previous DeleteTrafficDistributionGroup operation has failed.
UPDATE_IN_PROGRESS means the previous UpdateTrafficDistributionGroup operation is still in progress and has not yet completed.
Information about traffic distribution groups.
", "refs": { "TrafficDistributionGroupSummaryList$member": null } }, "TrafficDistributionGroupSummaryList": { "base": null, "refs": { "ListTrafficDistributionGroupsResponse$TrafficDistributionGroupSummaryList": "A list of traffic distribution groups.
" } }, "TrafficDistributionGroupUserSummary": { "base": "Summary information about a traffic distribution group user.
", "refs": { "TrafficDistributionGroupUserSummaryList$member": null } }, "TrafficDistributionGroupUserSummaryList": { "base": null, "refs": { "ListTrafficDistributionGroupUsersResponse$TrafficDistributionGroupUserSummaryList": "A list of traffic distribution group users.
" } }, "TrafficType": { "base": null, "refs": { "SendOutboundEmailRequest$TrafficType": "Denotes the class of traffic.
Only the CAMPAIGN traffic type is supported.
Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The default value is GENERAL. Use CAMPAIGN if EnableAnswerMachineDetection is set to true. For all other cases, use GENERAL.
A structure that defines search criteria and matching logic to search for contacts by matching text with transcripts analyzed by Amazon Connect Contact Lens.
", "refs": { "ContactAnalysis$Transcript": "Search criteria based on transcript analyzed by Amazon Connect Contact Lens.
" } }, "TranscriptCriteria": { "base": "A structure that defines search criteria base on words or phrases, participants in the Contact Lens conversational analytics transcript.
", "refs": { "TranscriptCriteriaList$member": null } }, "TranscriptCriteriaList": { "base": null, "refs": { "Transcript$Criteria": "The list of search criteria based on Contact Lens conversational analytics transcript.
" } }, "TransferContactRequest": { "base": null, "refs": {} }, "TransferContactResponse": { "base": null, "refs": {} }, "URI": { "base": null, "refs": { "CreateIntegrationAssociationRequest$SourceApplicationUrl": "The URL for the external application. This field is only required for the EVENT integration type.
", "IntegrationAssociationSummary$SourceApplicationUrl": "The URL for the external application.
", "MediaPlacement$AudioHostUrl": "The audio host URL.
", "MediaPlacement$AudioFallbackUrl": "The audio fallback URL.
", "MediaPlacement$SignalingUrl": "The signaling URL.
", "MediaPlacement$TurnControlUrl": "The turn control URL.
", "MediaPlacement$EventIngestionUrl": "The event ingestion URL to which you send client meeting events.
" } }, "URLExpiryInSeconds": { "base": null, "refs": { "GetAttachedFileRequest$UrlExpiryInSeconds": "Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.
", "StartAttachedFileUploadRequest$UrlExpiryInSeconds": "Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.
" } }, "Unit": { "base": null, "refs": { "CurrentMetric$Unit": "The unit for the metric.
", "HistoricalMetric$Unit": "The unit for the metric.
" } }, "UntagContactRequest": { "base": null, "refs": {} }, "UntagContactResponse": { "base": null, "refs": {} }, "UntagResourceRequest": { "base": null, "refs": {} }, "UpdateAgentStatusDescription": { "base": null, "refs": { "UpdateAgentStatusRequest$Description": "The description of the agent status.
" } }, "UpdateAgentStatusRequest": { "base": null, "refs": {} }, "UpdateAuthenticationProfileRequest": { "base": null, "refs": {} }, "UpdateCaseActionDefinition": { "base": "The UpdateCase action definition.
Information about the update case action.
Supported only for TriggerEventSource values: OnCaseCreate | OnCaseUpdate.
The description of the hours of operation.
" } }, "UpdateHoursOfOperationOverrideRequest": { "base": null, "refs": {} }, "UpdateHoursOfOperationRequest": { "base": null, "refs": {} }, "UpdateInstanceAttributeRequest": { "base": null, "refs": {} }, "UpdateInstanceStorageConfigRequest": { "base": null, "refs": {} }, "UpdateParticipantAuthenticationRequest": { "base": null, "refs": {} }, "UpdateParticipantAuthenticationResponse": { "base": null, "refs": {} }, "UpdateParticipantRoleConfigChannelInfo": { "base": "Configuration information for the chat participant role.
", "refs": { "UpdateParticipantRoleConfigRequest$ChannelConfiguration": "The Amazon Connect channel you want to configure.
" } }, "UpdateParticipantRoleConfigRequest": { "base": null, "refs": {} }, "UpdateParticipantRoleConfigResponse": { "base": null, "refs": {} }, "UpdatePhoneNumberMetadataRequest": { "base": null, "refs": {} }, "UpdatePhoneNumberRequest": { "base": null, "refs": {} }, "UpdatePhoneNumberResponse": { "base": null, "refs": {} }, "UpdatePredefinedAttributeRequest": { "base": null, "refs": {} }, "UpdatePromptRequest": { "base": null, "refs": {} }, "UpdatePromptResponse": { "base": null, "refs": {} }, "UpdateQueueHoursOfOperationRequest": { "base": null, "refs": {} }, "UpdateQueueMaxContactsRequest": { "base": null, "refs": {} }, "UpdateQueueNameRequest": { "base": null, "refs": {} }, "UpdateQueueOutboundCallerConfigRequest": { "base": null, "refs": {} }, "UpdateQueueOutboundEmailConfigRequest": { "base": null, "refs": {} }, "UpdateQueueStatusRequest": { "base": null, "refs": {} }, "UpdateQuickConnectConfigRequest": { "base": null, "refs": {} }, "UpdateQuickConnectDescription": { "base": null, "refs": { "UpdateQuickConnectNameRequest$Description": "The description of the quick connect.
" } }, "UpdateQuickConnectNameRequest": { "base": null, "refs": {} }, "UpdateRoutingProfileAgentAvailabilityTimerRequest": { "base": null, "refs": {} }, "UpdateRoutingProfileConcurrencyRequest": { "base": null, "refs": {} }, "UpdateRoutingProfileDefaultOutboundQueueRequest": { "base": null, "refs": {} }, "UpdateRoutingProfileNameRequest": { "base": null, "refs": {} }, "UpdateRoutingProfileQueuesRequest": { "base": null, "refs": {} }, "UpdateRuleRequest": { "base": null, "refs": {} }, "UpdateSecurityProfileRequest": { "base": null, "refs": {} }, "UpdateTaskTemplateRequest": { "base": null, "refs": {} }, "UpdateTaskTemplateResponse": { "base": null, "refs": {} }, "UpdateTrafficDistributionRequest": { "base": null, "refs": {} }, "UpdateTrafficDistributionResponse": { "base": null, "refs": {} }, "UpdateUserHierarchyGroupNameRequest": { "base": null, "refs": {} }, "UpdateUserHierarchyRequest": { "base": null, "refs": {} }, "UpdateUserHierarchyStructureRequest": { "base": null, "refs": {} }, "UpdateUserIdentityInfoRequest": { "base": null, "refs": {} }, "UpdateUserPhoneConfigRequest": { "base": null, "refs": {} }, "UpdateUserProficienciesRequest": { "base": null, "refs": {} }, "UpdateUserRoutingProfileRequest": { "base": null, "refs": {} }, "UpdateUserSecurityProfilesRequest": { "base": null, "refs": {} }, "UpdateViewContentRequest": { "base": null, "refs": {} }, "UpdateViewContentResponse": { "base": null, "refs": {} }, "UpdateViewMetadataRequest": { "base": null, "refs": {} }, "UpdateViewMetadataResponse": { "base": null, "refs": {} }, "UploadUrlMetadata": { "base": "Fields required when uploading an attached file.
", "refs": { "StartAttachedFileUploadResponse$UploadUrlMetadata": "The headers to be provided while uploading the file to the URL.
" } }, "Url": { "base": null, "refs": { "GetFederationTokenResponse$SignInUrl": "The URL to sign into the user's instance.
", "Instance$InstanceAccessUrl": "This URL allows contact center users to access the Amazon Connect admin website.
", "InstanceSummary$InstanceAccessUrl": "This URL allows contact center users to access the Amazon Connect admin website.
" } }, "UrlMetadataSignedHeaders": { "base": null, "refs": { "UploadUrlMetadata$HeadersToInclude": "A map of headers that should be provided when uploading the attached file.
" } }, "UrlMetadataSignedHeadersKey": { "base": null, "refs": { "UrlMetadataSignedHeaders$key": null } }, "UrlMetadataSignedHeadersValue": { "base": null, "refs": { "UrlMetadataSignedHeaders$value": null } }, "UrlReference": { "base": "The URL reference.
", "refs": { "ReferenceSummary$Url": "Information about the reference when the referenceType is URL. Otherwise, null.
Contains the use case.
", "refs": { "UseCaseSummaryList$member": null } }, "UseCaseId": { "base": null, "refs": { "CreateUseCaseResponse$UseCaseId": "The identifier of the use case.
", "DeleteUseCaseRequest$UseCaseId": "The identifier for the use case.
", "UseCase$UseCaseId": "The identifier for the use case.
" } }, "UseCaseSummaryList": { "base": null, "refs": { "ListUseCasesResponse$UseCaseSummaryList": "The use cases.
" } }, "UseCaseType": { "base": null, "refs": { "CreateUseCaseRequest$UseCaseType": "The type of use case to associate to the integration association. Each integration association can have only one of each use case type.
", "UseCase$UseCaseType": "The type of use case to associate to the integration association. Each integration association can have only one of each use case type.
" } }, "User": { "base": "Contains information about a user account for an Amazon Connect instance.
", "refs": { "DescribeUserResponse$User": "Information about the user account and configuration settings.
" } }, "UserData": { "base": "Data for a user.
", "refs": { "UserDataList$member": null } }, "UserDataFilters": { "base": "A filter for the user data.
", "refs": { "GetCurrentUserDataRequest$Filters": "The filters to apply to returned user data. You can filter up to the following limits:
Queues: 100
Routing profiles: 100
Agents: 100
Contact states: 9
User hierarchy groups: 1
The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups.
Currently tagging is only supported on the resources that are passed in the filter.
" } }, "UserDataHierarchyGroups": { "base": null, "refs": { "UserDataFilters$UserHierarchyGroups": "A UserHierarchyGroup ID or ARN.
" } }, "UserDataList": { "base": null, "refs": { "GetCurrentUserDataResponse$UserDataList": "A list of the user data that is returned.
" } }, "UserHierarchyGroupList": { "base": null, "refs": { "SearchUserHierarchyGroupsResponse$UserHierarchyGroups": "Information about the userHierarchyGroups.
" } }, "UserHierarchyGroupSearchConditionList": { "base": null, "refs": { "UserHierarchyGroupSearchCriteria$OrConditions": "A list of conditions which would be applied together with an OR condition.
", "UserHierarchyGroupSearchCriteria$AndConditions": "A list of conditions which would be applied together with an AND condition.
" } }, "UserHierarchyGroupSearchCriteria": { "base": "The search criteria to be used to return userHierarchyGroup.
", "refs": { "SearchUserHierarchyGroupsRequest$SearchCriteria": "The search criteria to be used to return UserHierarchyGroups.
", "UserHierarchyGroupSearchConditionList$member": null } }, "UserHierarchyGroupSearchFilter": { "base": "Filters to be applied to search results.
", "refs": { "SearchUserHierarchyGroupsRequest$SearchFilter": "Filters to be applied to search results.
" } }, "UserId": { "base": null, "refs": { "AgentsMinOneMaxHundred$member": null, "AssociateTrafficDistributionGroupUserRequest$UserId": "The identifier of the user account. This can be the ID or the ARN of the user.
", "AssociateUserProficienciesRequest$UserId": "The identifier of the user account.
", "CreateUserResponse$UserId": "The identifier of the user account.
", "DeleteUserRequest$UserId": "The identifier of the user.
", "DescribeUserRequest$UserId": "The identifier of the user account.
", "DisassociateTrafficDistributionGroupUserRequest$UserId": "The identifier for the user. This can be the ID or the ARN of the user.
", "DisassociateUserProficienciesRequest$UserId": "The identifier of the user account.
", "DismissUserContactRequest$UserId": "The identifier of the user account.
", "ListUserProficienciesRequest$UserId": "The identifier of the user account.
", "PutUserStatusRequest$UserId": "The identifier of the user.
", "TrafficDistributionGroupUserSummary$UserId": "The identifier for the user. This can be the ID or the ARN of the user.
", "UpdateUserHierarchyRequest$UserId": "The identifier of the user account.
", "UpdateUserIdentityInfoRequest$UserId": "The identifier of the user account.
", "UpdateUserPhoneConfigRequest$UserId": "The identifier of the user account.
", "UpdateUserProficienciesRequest$UserId": "The identifier of the user account.
", "UpdateUserRoutingProfileRequest$UserId": "The identifier of the user account.
", "UpdateUserSecurityProfilesRequest$UserId": "The identifier of the user account.
", "User$Id": "The identifier of the user account.
", "UserIdList$member": null, "UserQuickConnectConfig$UserId": "The identifier of the user.
", "UserReference$Id": "The unique identifier for the user.
", "UserSearchSummary$Id": "The identifier of the user's summary.
", "UserSummary$Id": "The identifier of the user account.
" } }, "UserIdList": { "base": null, "refs": { "NotificationRecipientType$UserIds": "A list of user IDs. Supports variable injection of $.ContactLens.ContactEvaluation.Agent.AgentId for OnContactEvaluationSubmit event source.
Contains information about the identity of a user.
For Amazon Connect instances that are created with the EXISTING_DIRECTORY identity management type, FirstName, LastName, and Email cannot be updated from within Amazon Connect because they are managed by the directory.
The FirstName and LastName length constraints below apply only to instances using SAML for identity management. If you are using Amazon Connect for identity management, the length constraints are 1-255 for FirstName, and 1-256 for LastName.
The information about the identity of the user.
", "UpdateUserIdentityInfoRequest$IdentityInfo": "The identity information for the user.
", "User$IdentityInfo": "Information about the user identity.
" } }, "UserIdentityInfoLite": { "base": "The user's first name and last name.
", "refs": { "UserSearchSummary$IdentityInfo": "The user's first name and last name.
" } }, "UserInfo": { "base": "The user details for the contact.
", "refs": { "CreateContactRequest$UserInfo": "User details for the contact
UserInfo is required when creating an EMAIL contact with OUTBOUND and AGENT_REPLY contact initiation methods.
Information about the agent associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.
" } }, "UserNotFoundException": { "base": "No user with the specified credentials was found in the Amazon Connect instance.
", "refs": {} }, "UserPhoneConfig": { "base": "Contains information about the phone configuration settings for a user.
", "refs": { "CreateUserRequest$PhoneConfig": "The phone settings for the user.
", "UpdateUserPhoneConfigRequest$PhoneConfig": "Information about phone configuration settings for the user.
", "User$PhoneConfig": "Information about the phone configuration for the user.
", "UserSearchSummary$PhoneConfig": null } }, "UserProficiency": { "base": "Information about proficiency of a user.
", "refs": { "UserProficiencyList$member": null } }, "UserProficiencyDisassociate": { "base": "Information about proficiency to be disassociated from the user.
", "refs": { "UserProficiencyDisassociateList$member": null } }, "UserProficiencyDisassociateList": { "base": null, "refs": { "DisassociateUserProficienciesRequest$UserProficiencies": "The proficiencies to disassociate from the user.
" } }, "UserProficiencyList": { "base": null, "refs": { "AssociateUserProficienciesRequest$UserProficiencies": "The proficiencies to associate with the user.
", "ListUserProficienciesResponse$UserProficiencyList": "Information about the user proficiencies.
", "UpdateUserProficienciesRequest$UserProficiencies": "The proficiencies to be updated for the user. Proficiencies must first be associated to the user. You can do this using AssociateUserProficiencies API.
" } }, "UserQuickConnectConfig": { "base": "Contains information about the quick connect configuration settings for a user. The contact flow must be of type Transfer to Agent.
", "refs": { "QuickConnectConfig$UserConfig": "The user configuration. This is required only if QuickConnectType is USER.
" } }, "UserReference": { "base": "Information about the user.
", "refs": { "UserData$User": "Information about the user for the data that is returned. It contains the resourceId and ARN of the user.
A list of conditions which would be applied together with an OR condition.
A list of conditions which would be applied together with an AND condition.
The search criteria to be used to return users.
The name and description fields support \"contains\" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
Filters to be applied to search results.
", "refs": { "SearchUsersRequest$SearchFilter": "Filters to be applied to search results.
" } }, "UserSearchSummary": { "base": "Information about the returned users.
", "refs": { "UserSearchSummaryList$member": null } }, "UserSearchSummaryList": { "base": null, "refs": { "SearchUsersResponse$Users": "Information about the users.
" } }, "UserSummary": { "base": "Contains summary information about a user.
", "refs": { "UserSummaryList$member": null } }, "UserSummaryList": { "base": null, "refs": { "ListUsersResponse$UserSummaryList": "Information about the users.
" } }, "UserTagMap": { "base": null, "refs": { "NotificationRecipientType$UserTags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }. Amazon Connect users with the specified tags will be notified.
" } }, "Value": { "base": null, "refs": { "CurrentMetricData$Value": "The value of the metric.
", "HistoricalMetricData$Value": "The value of the metric.
", "MetricDataV2$Value": "The corresponding value of the metric returned in the response.
" } }, "VersionNumber": { "base": null, "refs": { "ActivateEvaluationFormRequest$EvaluationFormVersion": "The version of the evaluation form to activate. If the version property is not provided, the latest version of the evaluation form is activated.
", "ActivateEvaluationFormResponse$EvaluationFormVersion": "A version of the evaluation form.
", "DeactivateEvaluationFormRequest$EvaluationFormVersion": "A version of the evaluation form. If the version property is not provided, the latest version of the evaluation form is deactivated.
", "DeactivateEvaluationFormResponse$EvaluationFormVersion": "The version of the deactivated evaluation form resource.
", "DeleteEvaluationFormRequest$EvaluationFormVersion": "The unique identifier for the evaluation form.
", "DescribeEvaluationFormRequest$EvaluationFormVersion": "A version of the evaluation form.
", "EvaluationForm$EvaluationFormVersion": "A version of the evaluation form.
", "EvaluationFormContent$EvaluationFormVersion": "A version of the evaluation form.
", "EvaluationFormSummary$LatestVersion": "The version number of the latest evaluation form version.
", "EvaluationFormSummary$ActiveVersion": "The version of the active evaluation form version.
", "EvaluationFormVersionSummary$EvaluationFormVersion": "A version of the evaluation form.
", "UpdateEvaluationFormRequest$EvaluationFormVersion": "A version of the evaluation form to update.
", "UpdateEvaluationFormResponse$EvaluationFormVersion": "The version of the updated evaluation form resource.
" } }, "VideoCapability": { "base": null, "refs": { "ParticipantCapabilities$Video": "The configuration having the video and screen sharing capabilities for participants over the call.
" } }, "View": { "base": "A view resource object. Contains metadata and content necessary to render the view.
", "refs": { "CreateViewResponse$View": "A view resource object. Contains metadata and content necessary to render the view.
", "CreateViewVersionResponse$View": "All view data is contained within the View object.
", "DescribeViewResponse$View": "All view data is contained within the View object.
", "UpdateViewContentResponse$View": "A view resource object. Contains metadata and content necessary to render the view.
" } }, "ViewAction": { "base": null, "refs": { "ViewActions$member": null } }, "ViewActions": { "base": null, "refs": { "ViewContent$Actions": "A list of possible actions from the view.
", "ViewInputContent$Actions": "A list of possible actions from the view.
" } }, "ViewContent": { "base": "View content containing all content necessary to render a view except for runtime input data.
", "refs": { "View$Content": "View content containing all content necessary to render a view except for runtime input data.
" } }, "ViewContentSha256": { "base": null, "refs": { "CreateViewVersionRequest$ViewContentSha256": "Indicates the checksum value of the latest published view content.
", "View$ViewContentSha256": "Indicates the checksum value of the latest published view content.
" } }, "ViewDescription": { "base": null, "refs": { "CreateViewRequest$Description": "The description of the view.
", "CreateViewVersionRequest$VersionDescription": "The description for the version being published.
", "UpdateViewMetadataRequest$Description": "The description of the view.
", "View$Description": "The description of the view.
", "View$VersionDescription": "The description of the version.
", "ViewSummary$Description": "The description of the view.
", "ViewVersionSummary$Description": "The description of the view version.
", "ViewVersionSummary$VersionDescription": "The description of the view version.
" } }, "ViewId": { "base": null, "refs": { "CreateViewVersionRequest$ViewId": "The identifier of the view. Both ViewArn and ViewId can be used.
The identifier of the view. Both ViewArn and ViewId can be used.
The identifier of the view. Both ViewArn and ViewId can be used.
The ViewId of the view. This must be an ARN for Amazon Web Services managed views.
", "ListViewVersionsRequest$ViewId": "The identifier of the view. Both ViewArn and ViewId can be used.
The identifier of the view. Both ViewArn and ViewId can be used.
The identifier of the view. Both ViewArn and ViewId can be used.
The identifier of the view.
", "ViewSummary$Id": "The identifier of the view.
", "ViewVersionSummary$Id": "The identifier of the view version.
" } }, "ViewInputContent": { "base": "View content containing all content necessary to render a view except for runtime input data and the runtime input schema, which is auto-generated by this operation.
", "refs": { "CreateViewRequest$Content": "View content containing all content necessary to render a view except for runtime input data.
The total uncompressed content has a maximum file size of 400kB.
", "UpdateViewContentRequest$Content": "View content containing all content necessary to render a view except for runtime input data and the runtime input schema, which is auto-generated by this operation.
The total uncompressed content has a maximum file size of 400kB.
" } }, "ViewInputSchema": { "base": null, "refs": { "ViewContent$InputSchema": "The data schema matching data that the view template must be provided to render.
" } }, "ViewName": { "base": null, "refs": { "CreateViewRequest$Name": "The name of the view.
", "UpdateViewMetadataRequest$Name": "The name of the view.
", "View$Name": "The name of the view.
", "ViewSummary$Name": "The name of the view.
", "ViewVersionSummary$Name": "The name of the view version.
" } }, "ViewStatus": { "base": null, "refs": { "CreateViewRequest$Status": "Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content.
Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content.
Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content.
Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content.
A summary of a view's metadata.
", "refs": { "ViewsSummaryList$member": null } }, "ViewTemplate": { "base": null, "refs": { "ViewContent$Template": "The view template representing the structure of the view.
", "ViewInputContent$Template": "The view template representing the structure of the view.
" } }, "ViewType": { "base": null, "refs": { "ListViewsRequest$Type": "The type of the view.
", "View$Type": "The type of the view - CUSTOMER_MANAGED.
The type of the view.
", "ViewVersionSummary$Type": "The type of the view version.
" } }, "ViewVersion": { "base": null, "refs": { "DeleteViewVersionRequest$ViewVersion": "The version number of the view.
", "View$Version": "Current version of the view.
", "ViewVersionSummary$Version": "The sequentially incremented version of the view version.
" } }, "ViewVersionSummary": { "base": "A summary of a view version's metadata.
", "refs": { "ViewVersionSummaryList$member": null } }, "ViewVersionSummaryList": { "base": null, "refs": { "ListViewVersionsResponse$ViewVersionSummaryList": "A list of view version summaries.
" } }, "ViewsClientToken": { "base": null, "refs": { "CreateViewRequest$ClientToken": "A unique Id for each create view request to avoid duplicate view creation. For example, the view is idempotent ClientToken is provided.
" } }, "ViewsInstanceId": { "base": null, "refs": { "CreateViewRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", "CreateViewVersionRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", "DeleteViewRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", "DeleteViewVersionRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", "DescribeViewRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", "ListViewVersionsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", "ListViewsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", "UpdateViewContentRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", "UpdateViewMetadataRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
" } }, "ViewsNextToken": { "base": null, "refs": { "ListViewVersionsRequest$NextToken": "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.
", "ListViewVersionsResponse$NextToken": "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.
", "ListViewsRequest$NextToken": "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.
", "ListViewsResponse$NextToken": "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.
" } }, "ViewsSummaryList": { "base": null, "refs": { "ListViewsResponse$ViewsSummaryList": "A list of view summaries.
" } }, "Vocabulary": { "base": "Contains information about a custom vocabulary.
", "refs": { "DescribeVocabularyResponse$Vocabulary": "A list of specific words that you want Contact Lens for Amazon Connect to recognize in your audio input. They are generally domain-specific words and phrases, words that Contact Lens is not recognizing, or proper nouns.
" } }, "VocabularyContent": { "base": null, "refs": { "CreateVocabularyRequest$Content": "The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. The size limit is 50KB. For more information, see Create a custom vocabulary using a table.
The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. For more information, see Create a custom vocabulary using a table.
The reason why the custom vocabulary was not created.
", "VocabularySummary$FailureReason": "The reason why the custom vocabulary was not created.
" } }, "VocabularyId": { "base": null, "refs": { "AssociateDefaultVocabularyRequest$VocabularyId": "The identifier of the custom vocabulary. If this is empty, the default is set to none.
", "CreateVocabularyResponse$VocabularyId": "The identifier of the custom vocabulary.
", "DefaultVocabulary$VocabularyId": "The identifier of the custom vocabulary.
", "DeleteVocabularyRequest$VocabularyId": "The identifier of the custom vocabulary.
", "DeleteVocabularyResponse$VocabularyId": "The identifier of the custom vocabulary.
", "DescribeVocabularyRequest$VocabularyId": "The identifier of the custom vocabulary.
", "Vocabulary$Id": "The identifier of the custom vocabulary.
", "VocabularySummary$Id": "The identifier of the custom vocabulary.
" } }, "VocabularyLanguageCode": { "base": null, "refs": { "AssociateDefaultVocabularyRequest$LanguageCode": "The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
", "CreateVocabularyRequest$LanguageCode": "The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
", "DefaultVocabulary$LanguageCode": "The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
", "ListDefaultVocabulariesRequest$LanguageCode": "The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
", "SearchVocabulariesRequest$LanguageCode": "The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
", "Vocabulary$LanguageCode": "The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
", "VocabularySummary$LanguageCode": "The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
" } }, "VocabularyLastModifiedTime": { "base": null, "refs": { "Vocabulary$LastModifiedTime": "The timestamp when the custom vocabulary was last modified.
", "VocabularySummary$LastModifiedTime": "The timestamp when the custom vocabulary was last modified.
" } }, "VocabularyName": { "base": null, "refs": { "CreateVocabularyRequest$VocabularyName": "A unique name of the custom vocabulary.
", "DefaultVocabulary$VocabularyName": "A unique name of the custom vocabulary.
", "SearchVocabulariesRequest$NameStartsWith": "The starting pattern of the name of the vocabulary.
", "Vocabulary$Name": "A unique name of the custom vocabulary.
", "VocabularySummary$Name": "A unique name of the custom vocabulary.
" } }, "VocabularyNextToken": { "base": null, "refs": { "ListDefaultVocabulariesRequest$NextToken": "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.
", "ListDefaultVocabulariesResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "SearchVocabulariesRequest$NextToken": "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.
", "SearchVocabulariesResponse$NextToken": "If there are additional results, this is the token for the next set of results.
" } }, "VocabularyState": { "base": null, "refs": { "CreateVocabularyResponse$State": "The current state of the custom vocabulary.
", "DeleteVocabularyResponse$State": "The current state of the custom vocabulary.
", "SearchVocabulariesRequest$State": "The current state of the custom vocabulary.
", "Vocabulary$State": "The current state of the custom vocabulary.
", "VocabularySummary$State": "The current state of the custom vocabulary.
" } }, "VocabularySummary": { "base": "Contains summary information about the custom vocabulary.
", "refs": { "VocabularySummaryList$member": null } }, "VocabularySummaryList": { "base": null, "refs": { "SearchVocabulariesResponse$VocabularySummaryList": "The list of the available custom vocabularies.
" } }, "VoiceRecordingConfiguration": { "base": "Contains information about the recording configuration settings.
", "refs": { "StartContactRecordingRequest$VoiceRecordingConfiguration": "The person being recorded.
" } }, "VoiceRecordingTrack": { "base": null, "refs": { "VoiceRecordingConfiguration$VoiceRecordingTrack": "Identifies which track is being recorded.
" } }, "WisdomInfo": { "base": "Information about Amazon Connect Wisdom.
", "refs": { "Contact$WisdomInfo": "Information about Amazon Connect Wisdom.
" } }, "resourceArnListMaxLimit100": { "base": null, "refs": { "BatchGetFlowAssociationRequest$ResourceIds": "A list of resource identifiers to retrieve flow associations.
Amazon Web Services End User Messaging SMS phone number ARN when using SMS_PHONE_NUMBER
Amazon Web Services End User Messaging Social phone number ARN when using WHATSAPP_MESSAGING_PHONE_NUMBER
The timestamp when the contact was connected to the agent.
", "AgentInfo$AfterContactWorkStartTimestamp": "The date and time when the agent started doing After Contact Work for the contact, in UTC time.
", "AgentInfo$AfterContactWorkEndTimestamp": "The date and time when the agent ended After Contact Work for the contact, in UTC time. In cases when agent finishes doing AfterContactWork for chat contacts and switches their activity status to offline or equivalent without clearing the contact in CCP, discrepancies may be noticed for AfterContactWorkEndTimestamp.
The agent first response timestamp for a chat contact.
", "Contact$InitiationTimestamp": "The date and time this contact was initiated, in UTC time. For INBOUND, this is when the contact arrived. For OUTBOUND, this is when the agent began dialing. For CALLBACK, this is when the callback contact was created. For TRANSFER and QUEUE_TRANSFER, this is when the transfer was initiated. For API, this is when the request arrived. For EXTERNAL_OUTBOUND, this is when the agent started dialing the external participant. For MONITOR, this is when the supervisor started listening to a contact.
The date and time that the customer endpoint disconnected from the current contact, in UTC time. In transfer scenarios, the DisconnectTimestamp of the previous contact indicates the date and time when that contact ended.
", "Contact$LastUpdateTimestamp": "The timestamp when contact was last updated.
", "Contact$LastPausedTimestamp": "The timestamp when the contact was last paused.
", "Contact$LastResumedTimestamp": "The timestamp when the contact was last resumed.
", "Contact$ScheduledTimestamp": "The timestamp, in Unix epoch time format, at which to start running the inbound flow.
", "Contact$ConnectedToSystemTimestamp": "The timestamp when customer endpoint connected to Amazon Connect.
", "ContactEvaluation$StartTimestamp": "The date and time when the evaluation was started, in UTC time.
", "ContactEvaluation$EndTimestamp": "The date and time when the evaluation was submitted, in UTC time.
", "ContactEvaluation$DeleteTimestamp": "The date and time when the evaluation was deleted, in UTC time.
", "ContactSearchSummary$InitiationTimestamp": "The date and time this contact was initiated, in UTC time. For INBOUND, this is when the contact arrived. For OUTBOUND, this is when the agent began dialing. For CALLBACK, this is when the callback contact was created. For TRANSFER and QUEUE_TRANSFER, this is when the transfer was initiated. For API, this is when the request arrived. For EXTERNAL_OUTBOUND, this is when the agent started dialing the external participant. For MONITOR, this is when the supervisor started listening to a contact.
The timestamp when the customer endpoint disconnected from Amazon Connect.
", "ContactSearchSummary$ScheduledTimestamp": "The timestamp, in Unix epoch time format, at which to start running the inbound flow.
", "ContactSearchSummaryAgentInfo$ConnectedToAgentTimestamp": "The timestamp when the contact was connected to the agent.
", "ContactSearchSummaryQueueInfo$EnqueueTimestamp": "The timestamp when the contact was added to the queue.
", "Credentials$AccessTokenExpiration": "A token generated with an expiration time for the session a user is logged in to Amazon Connect.
", "Credentials$RefreshTokenExpiration": "Renews the expiration timer for a generated token.
", "CustomerVoiceActivity$GreetingStartTimestamp": "Timestamp that measures the beginning of the customer greeting from an outbound voice call.
", "CustomerVoiceActivity$GreetingEndTimestamp": "Timestamp that measures the end of the customer greeting from an outbound voice call.
", "Expiry$ExpiryTimestamp": "The timestamp indicating when the routing step expires.
", "GetCurrentMetricDataResponse$DataSnapshotTime": "The time at which the metrics were retrieved and cached for pagination.
", "GetMetricDataRequest$StartTime": "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.
The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.
", "GetMetricDataRequest$EndTime": "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.
The time range between the start and end time must be less than 24 hours.
", "GetTaskTemplateResponse$LastModifiedTime": "The timestamp when the task template was last modified.
", "GetTaskTemplateResponse$CreatedTime": "The timestamp when the task template was created.
", "ParticipantMetrics$LastMessageTimestamp": "Timestamp of last chat message by Participant.
", "QueueInfo$EnqueueTimestamp": "The timestamp when the contact was added to the queue.
", "RecordingInfo$StartTimestamp": "When the conversation of the last leg of the recording started in UTC time.
", "RecordingInfo$StopTimestamp": "When the conversation of the last leg of recording stopped in UTC time.
", "RoutingCriteria$ActivationTimestamp": "The timestamp indicating when the routing criteria is set to active. A routing criteria is activated when contact is transferred to a queue. ActivationTimestamp will be set on routing criteria for contacts in agent queue even though Routing criteria is never activated for contacts in agent queue.
", "SecurityKey$CreationTime": "When the security key was created.
", "StateTransition$StateStartTimestamp": "The date and time when the state started in UTC time.
", "StateTransition$StateEndTimestamp": "The date and time when the state ended in UTC time.
", "TaskTemplateMetadata$LastModifiedTime": "The timestamp when the task template was last modified.
", "TaskTemplateMetadata$CreatedTime": "The timestamp when the task template was created.
", "UpdateTaskTemplateResponse$LastModifiedTime": "The timestamp when the task template was last modified.
", "UpdateTaskTemplateResponse$CreatedTime": "The timestamp when the task template was created.
" } } } }