Awso_connect.ValuesSourceinclude module type of struct include Values_0 endval structure_to_value_aux :
('a * 'b option) list ->
f:(('a * 'b) list -> 'c) ->
[> `Structure of 'c ]val structure_to_wrapped_value :
wrapper:'a ->
response:'a ->
('b * 'c option) list ->
[> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]You do not have sufficient permissions to perform this action.
Information about an action.
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.
The throttling limit has been exceeded.
The specified resource was not found.
A resource already has that name.
One or more of the specified parameters are not valid.
Request processing failed because of an error or failure with the service.
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.
Information about the email recipient
List of additional email addresses for an email contact.
Configuration settings for after contact work (ACW) timeout.
Configuration settings for after contact work (ACW) timeout for a specific channel.
Information about a traffic distribution.
The distribution of agents between the instance and its replica(s).
Contains information about a queue resource for which metrics are returned.
Information about the contact associated to the user.
module PostAcceptPreviewTimeoutDurationInSeconds =
Values_0.PostAcceptPreviewTimeoutDurationInSecondsCountdown timer configuration after the agent accepted the contact.
Information about agent-first preview mode outbound strategy configuration.
Information about agent-first outbound strategy configuration.
Information about an agent hierarchy group.
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.
Information about the state transition of a supervisor.
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.
Information about the agent hierarchy. Hierarchies can be configured with up to five levels.
Information regarding the device.
Information about the agent who accepted the contact.
Contains information for score and potential quality issues for Audio
Information about the quality of the Agent's media connection
Contains information about an agent status.
Information about the agent status assigned to the user.
Information about the agent's status.
A leaf node condition which can be used to specify a string condition.
module AgentStatusSearchConditionList = Values_0.AgentStatusSearchConditionListmodule AgentStatusSearchCriteria = Values_0.AgentStatusSearchCriteriaThe search criteria to be used to return agent statuses.
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
A list of conditions which would be applied together with an AND condition.
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.
Filters to be applied to search results.
Summary information for an agent status.
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.
Information of the AI agent involved in the contact.
Configuration information of an email alias.
Information about the capabilities enabled for participants of the contact.
A file extension. The extension must be between 1 and 10 characters and can contain only alphanumeric characters, hyphens, and underscores.
Information about an allowed file extension.
A list of Flow Modules an AI Agent can invoke as a tool
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 datasets that are available to associate with: DataSetId, DataSetName.
Configuration of the answering machine detection.
This API is in preview release for Amazon Connect and is subject to change. A third-party application's metadata.
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.
An empty value.
Object to store union of Field values.
The SLA configuration for Case SlaAssignmentType.
The AssignSla action definition.
Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.
module AttachedFileInvalidRequestExceptionReason =
Values_0.AttachedFileInvalidRequestExceptionReasonReason why the request was invalid.
The request is not valid.
Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.
This API is in preview release for Amazon Connect and is subject to change. Associates an approved origin to an Amazon Connect instance.
Configuration information of an Amazon Lex V2 bot.
Configuration information of an Amazon Lex bot.
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.
Associates a queued contact with an agent. Use cases Following are common uses cases for this API: Programmatically assign queued contacts to available users. Leverage the IAM context key connect:PreferredUserArn to restrict contact association to specific preferred user. Important things to know Use this API with chat, email, and task contacts. It does not support voice contacts. Use it to associate contacts with users regardless of their current state, including custom states. Ensure your application logic accounts for user availability before making associations. It honors the IAM context key connect:PreferredUserArn to prevent unauthorized contact associations. It respects the IAM context key connect:PreferredUserArn to enforce authorization controls and prevent unauthorized contact associations. Verify that your IAM policies are properly configured to support your intended use cases. The service quota Queues per routing profile per instance applies to manually assigned queues, too. For more information about this quota, see Amazon Connect quotas in the Amazon Connect Administrator Guide. Endpoints: See Amazon Connect endpoints and quotas.
Associates a queued contact with an agent. Use cases Following are common uses cases for this API: Programmatically assign queued contacts to available users. Leverage the IAM context key connect:PreferredUserArn to restrict contact association to specific preferred user. Important things to know Use this API with chat, email, and task contacts. It does not support voice contacts. Use it to associate contacts with users regardless of their current state, including custom states. Ensure your application logic accounts for user availability before making associations. It honors the IAM context key connect:PreferredUserArn to prevent unauthorized contact associations. It respects the IAM context key connect:PreferredUserArn to enforce authorization controls and prevent unauthorized contact associations. Verify that your IAM policies are properly configured to support your intended use cases. The service quota Queues per routing profile per instance applies to manually assigned queues, too. For more information about this quota, see Amazon Connect quotas in the Amazon Connect Administrator Guide. Endpoints: See Amazon Connect endpoints and quotas.
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.
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.
Associates an email address alias with an existing email address in an Amazon Connect instance. This creates a forwarding relationship where emails sent to the alias email address are automatically forwarded to the primary email address. Use cases Following are common uses cases for this API: Unified customer support: Create multiple entry points (for example, support@example.com, help@example.com, customercare@example.com) that all forward to a single agent queue for streamlined management. Department consolidation: Forward emails from legacy department addresses (for example, sales@example.com, info@example.com) to a centralized customer service email during organizational restructuring. Brand management: Enable you to use familiar brand-specific email addresses that forward to the appropriate Amazon Connect instance email address. Important things to know Each email address can have a maximum of one alias. You cannot create multiple aliases for the same email address. If the alias email address already receives direct emails, it continues to receive direct emails plus forwarded emails. You cannot chain email aliases together (that is, create an alias of an alias). AssociateEmailAddressAlias does not return the following information: A confirmation of the alias relationship details (you must call DescribeEmailAddress to verify). The timestamp of when the association occurred. The status of the forwarding configuration. Endpoints: See Amazon Connect endpoints and quotas. Related operations DisassociateEmailAddressAlias: Removes the alias association between two email addresses in an Amazon Connect instance. DescribeEmailAddress: View current alias configurations for an email address. SearchEmailAddresses: Find email addresses and their alias relationships across an instance. CreateEmailAddress: Create new email addresses that can participate in alias relationships. DeleteEmailAddress: Remove email addresses (automatically removes any alias relationships). UpdateEmailAddressMetadata: Modify email address properties (does not affect alias relationships).
An entity with the same name already exists.
Associates an email address alias with an existing email address in an Amazon Connect instance. This creates a forwarding relationship where emails sent to the alias email address are automatically forwarded to the primary email address. Use cases Following are common uses cases for this API: Unified customer support: Create multiple entry points (for example, support@example.com, help@example.com, customercare@example.com) that all forward to a single agent queue for streamlined management. Department consolidation: Forward emails from legacy department addresses (for example, sales@example.com, info@example.com) to a centralized customer service email during organizational restructuring. Brand management: Enable you to use familiar brand-specific email addresses that forward to the appropriate Amazon Connect instance email address. Important things to know Each email address can have a maximum of one alias. You cannot create multiple aliases for the same email address. If the alias email address already receives direct emails, it continues to receive direct emails plus forwarded emails. You cannot chain email aliases together (that is, create an alias of an alias). AssociateEmailAddressAlias does not return the following information: A confirmation of the alias relationship details (you must call DescribeEmailAddress to verify). The timestamp of when the association occurred. The status of the forwarding configuration. Endpoints: See Amazon Connect endpoints and quotas. Related operations DisassociateEmailAddressAlias: Removes the alias association between two email addresses in an Amazon Connect instance. DescribeEmailAddress: View current alias configurations for an email address. SearchEmailAddresses: Find email addresses and their alias relationships across an instance. CreateEmailAddress: Create new email addresses that can participate in alias relationships. DeleteEmailAddress: Remove email addresses (automatically removes any alias relationships). UpdateEmailAddressMetadata: Modify email address properties (does not affect alias relationships).
Associates a connect resource to a flow.
Associates a connect resource to a flow.
Contains configuration for the parent hours of operation.
Associates a set of hours of operations with another hours of operation. Refer to Administrator Guide here for more information on inheriting overrides from parent hours of operation(s).
The encryption configuration.
Information about the Amazon Simple Storage Service (Amazon S3) storage type.
Configuration information of a Kinesis video stream.
Configuration information of a Kinesis data stream.
Configuration information of a Kinesis Data Firehose delivery stream.
The storage configuration for the instance.
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.
module AssociateInstanceStorageConfigResponse =
Values_0.AssociateInstanceStorageConfigResponseThis 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.
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.
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.
module AssociatePhoneNumberContactFlowRequest =
Values_0.AssociatePhoneNumberContactFlowRequestAssociates 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.
Configuration object that specifies an email address to be associated with a queue. This configuration contains the identifier of the email address that should be linked to the queue for routing email contacts.
Associates a set of email addresses with a queue to enable agents to select different "From" (system) email addresses when replying to inbound email contacts or initiating outbound email contacts. This allows agents to handle email contacts across different brands and business units within the same queue. Important things to know You can associate up to 49 additional email addresses with a single queue, plus 1 default outbound email address, for a total of 50. The email addresses must already exist in the Amazon Connect instance before they can be associated with a queue. Agents will be able to select from these associated email addresses when handling email contacts in the queue. For inbound email contacts, agents can select from email addresses associated with the queue where the contact was accepted. For outbound email contacts, agents can select from email addresses associated with their default outbound queue configured in their routing profile.
Associates a set of quick connects with a queue.
Contains the channel and queue identifier for a routing profile.
Contains information about the queue and channel for which priority and delay can be set.
module RoutingProfileManualAssignmentQueueConfig =
Values_0.RoutingProfileManualAssignmentQueueConfigContains information about the queue and channel for manual assignment behaviour can be enabled.
module RoutingProfileManualAssignmentQueueConfigList =
Values_0.RoutingProfileManualAssignmentQueueConfigListAssociates a set of queues with a routing profile.
This API is in preview release for Amazon Connect and is subject to change. Associates a security key to the instance.
module AttachedFileServiceQuotaExceededExceptionReason =
Values_0.AttachedFileServiceQuotaExceededExceptionReasonThe reason for the exception.
The service quota has been exceeded.
This API is in preview release for Amazon Connect and is subject to change. Associates a security key to the instance.
Security profile items.
Associate security profiles with an Entity in an Amazon Connect instance.
module AssociateTrafficDistributionGroupUserRequest =
Values_0.AssociateTrafficDistributionGroupUserRequestAssociates an agent with a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
module AssociateTrafficDistributionGroupUserResponse =
Values_0.AssociateTrafficDistributionGroupUserResponseAssociates an agent with a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
Information about proficiency of a user.
Associates a set of proficiencies with a user.
Associates a workspace with one or more users or routing profiles, allowing them to access the workspace's configured views and pages.
Contains information about a resource that was successfully associated with a workspace in a batch operation.
Contains information about a resource that failed to be associated with a workspace in a batch operation.
A resource with the specified name already exists.
Associates a workspace with one or more users or routing profiles, allowing them to access the workspace's configured views and pages.
Contact summary of a contact in contact tree associated with unique identifier.
Information on the identity that created the file.
Information about the attached file.
Error describing a failure to retrieve attached file metadata through BatchGetAttachedFileMetadata action.
The maximum size limit for attached files in bytes. The minimum value is 1 and the maximum value is 104857600 (100 MB).
The configuration for allowed file extensions.
The configuration for attached files for a specific attachment scope.
A summary of the attached files configuration.
Information about a reference when the referenceType is ATTACHMENT. Otherwise, null.
The attendee information, including attendee ID and join token.
A toggle for an individual feature at the instance level.
A leaf node condition which can be used to specify a hierarchy group condition.
A list of conditions which would be applied together with an AND condition.
An Object to define the minimum and maximum proficiency levels.
An object to define AgentsCriteria.
An object to specify the predefined attribute condition.
Defines enumeration validation for attribute values. Allows specifying a list of permitted values and whether custom values beyond the enumerated list are allowed.
Defines validation rules for data table attribute values. Based on JSON Schema Draft 2020-12 with additional Connect-specific validations. Validation rules ensure data integrity and consistency across the data table.
Contains lock version information for different levels of a data table hierarchy. Used for optimistic locking to prevent concurrent modification conflicts. Each component has its own lock version that changes when that component is modified.
Represents an attribute (column) in a data table. Attributes define the schema and validation rules for values that can be stored in the table. They specify the data type, constraints, and whether the attribute is used as a primary key for record identification.
Has audio-specific configurations as the operating parameter for Echo Reduction.
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.
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.
Configuration settings for auto-accept for a specific channel.
Configuration information about automated evaluations.
Details about automated evaluations.
Information about automatic fail configuration for an evaluation form.
Information about available phone numbers.
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.
This API is in preview release for Amazon Connect and is subject to change. List of errors for dataset association failures.
module BatchAssociateAnalyticsDataSetResponse =
Values_0.BatchAssociateAnalyticsDataSetResponseAssociates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.
Represents a primary key value used to identify a specific record in a data table. Primary values are used in combination to create unique record identifiers when a table has multiple primary attributes.
module BatchCreateDataTableValueFailureResult =
Values_0.BatchCreateDataTableValueFailureResultA batch create data table value failure result.
module BatchCreateDataTableValueFailureResultList =
Values_0.BatchCreateDataTableValueFailureResultListA data table value.
Creates values for attributes in a data table. The value may be a default or it may be associated with a primary value. The value must pass all customer defined validation as well as the default validation for the value type. The operation must conform to Batch Operation API Standards. Although the standard specifies that successful and failed entities are listed separately in the response, authorization fails if any primary values or attributes are unauthorized. The combination of primary values and the attribute name serve as the identifier for the individual item request.
Operation cannot be performed at this time as there is a conflict with another operation or contact state.
module BatchCreateDataTableValueSuccessResult =
Values_0.BatchCreateDataTableValueSuccessResultA batch create data table value success result.
module BatchCreateDataTableValueSuccessResultList =
Values_0.BatchCreateDataTableValueSuccessResultListCreates values for attributes in a data table. The value may be a default or it may be associated with a primary value. The value must pass all customer defined validation as well as the default validation for the value type. The operation must conform to Batch Operation API Standards. Although the standard specifies that successful and failed entities are listed separately in the response, authorization fails if any primary values or attributes are unauthorized. The combination of primary values and the attribute name serve as the identifier for the individual item request.
module BatchDeleteDataTableValueFailureResult =
Values_0.BatchDeleteDataTableValueFailureResultA batch delete data table value failure result.
module BatchDeleteDataTableValueFailureResultList =
Values_0.BatchDeleteDataTableValueFailureResultListA data table delete value identifier.
Deletes multiple values from a data table. API users may delete values at any time. When deletion is requested from the admin website, a warning is shown alerting the user of the most recent time the attribute and its values were accessed. System managed values are not deletable by customers.
module BatchDeleteDataTableValueSuccessResult =
Values_0.BatchDeleteDataTableValueSuccessResultA batch delete data table value success result.
module BatchDeleteDataTableValueSuccessResultList =
Values_0.BatchDeleteDataTableValueSuccessResultListDeletes multiple values from a data table. API users may delete values at any time. When deletion is requested from the admin website, a warning is shown alerting the user of the most recent time the attribute and its values were accessed. System managed values are not deletable by customers.
module BatchDescribeDataTableValueFailureResult =
Values_0.BatchDescribeDataTableValueFailureResultA batch describe data table value failure result.
module BatchDescribeDataTableValueFailureResultList =
Values_0.BatchDescribeDataTableValueFailureResultListA data table value identifier.
Retrieves multiple values from a data table without evaluating expressions. Returns the raw stored values along with metadata such as lock versions and modification timestamps. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.
A primary value response.
module BatchDescribeDataTableValueSuccessResult =
Values_0.BatchDescribeDataTableValueSuccessResultA batch describe data table value success result.
module BatchDescribeDataTableValueSuccessResultList =
Values_0.BatchDescribeDataTableValueSuccessResultListRetrieves multiple values from a data table without evaluating expressions. Returns the raw stored values along with metadata such as lock versions and modification timestamps. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.
module BatchDisassociateAnalyticsDataSetRequest =
Values_0.BatchDisassociateAnalyticsDataSetRequestRemoves a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
module BatchDisassociateAnalyticsDataSetResponse =
Values_0.BatchDisassociateAnalyticsDataSetResponseRemoves a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
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.
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.
Retrieve the flow associations for the given resources.
Information about flow associations.
Retrieve the flow associations for the given resources.
The config of the outbound strategy.
Information about the outbound strategy.
Information about the endpoint.
Information associated with a campaign.
Request object with information to create a contact.
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.
Request for which contact was successfully created.
The allowed limit for the resource has been exceeded.
Request for which contact failed to be generated.
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.
module BatchUpdateDataTableValueFailureResult =
Values_0.BatchUpdateDataTableValueFailureResultA batch update data table value failure result.
module BatchUpdateDataTableValueFailureResultList =
Values_0.BatchUpdateDataTableValueFailureResultListUpdates multiple data table values using all properties from BatchCreateDataTableValue. System managed values are not modifiable by customers. The operation requires proper lock versions to prevent concurrent modification conflicts.
module BatchUpdateDataTableValueSuccessResult =
Values_0.BatchUpdateDataTableValueSuccessResultA batch update data table value success result.
module BatchUpdateDataTableValueSuccessResultList =
Values_0.BatchUpdateDataTableValueSuccessResultListUpdates multiple data table values using all properties from BatchCreateDataTableValue. System managed values are not modifiable by customers. The operation requires proper lock versions to prevent concurrent modification conflicts.
A boolean search condition for Search APIs.
Information about the overall participant interactions at the contact level.
Parameters for initiating a chat test.
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
A chat message.
Information about a participant's interactions in a contact.
Information about how agent, bot, and customer interact in a chat contact.
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.
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.
Configuration information for the chat participant role.
The streaming configuration, such as the Amazon SNS streaming endpoint.
Identifier for a hours of operations resource: ARN, ID, Name
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.
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.
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.
Information about a phone number that has been claimed to your Amazon Connect instance or traffic distribution group.
Request to CompleteAttachedFileUpload API
Response from CompleteAttachedFileUpload API
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 ProficiencyName, ProficiencyValue and ProficiencyLimit.
Request processing failed because dependent condition failed.
The configuration settings of the features available to a meeting.
A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.
A meeting created using the Amazon Chime SDK.
Information required to join the call.
Information about Amazon Connect Wisdom.
Information about the task template used to create this contact.
module SegmentAttributeValue = Values_0.SegmentAttributeValueA value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
module SegmentAttributeValueList = Values_0.SegmentAttributeValueListmodule SegmentAttributeValueMap = Values_0.SegmentAttributeValueMapmodule Expression = Values_0.ExpressionA tagged union to specify expression for a routing step.
module Expressions = Values_0.ExpressionsAn object to specify the expiration of a routing step.
Step signifies the criteria to be used for routing to an agent
Latest routing criteria on the contact.
Information about a voice recording, chat transcript, or screen recording.
If this contact was queued, this contains information about the queue.
Information about the quality of the Customer's media connection
Information about the quality of the participant's media connection.
Contact data associated with quick connect operations.
Metadata information for next contact.
Entry representing the next contact in a sequence.
Information about the global resiliency configuration for the contact, including traffic distribution details.
Information about the endpoint.
Information about the call disconnect experience.
Information about customer’s voice activity.
Information about the Customer on the contact.
Information about the contact evaluations where the key is the FormId, which is a unique identifier for the form.
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.
Contains information about a contact.
A structure that defines search criteria base on words or phrases, participants in the Contact Lens conversational analytics transcript.
A structure that defines search criteria and matching logic to search for contacts by matching text with transcripts analyzed by Amazon Connect Contact Lens.
A structure that defines search criteria for contacts using analysis outputs from Amazon Connect Contact Lens.
The contact configuration for push notification registration.
Filters user data based on the contact information that is associated to the users. It contains a list of contact states.
Contains information about a flow.
The contact flow type condition.
A list of conditions which would be applied together with an AND condition.
Filter for contact flow attributes with multiple condition types.
The external invocation configuration for the flow module
Contains information about a flow module.
Contains information about an alias.
Contains information about an alias.
module ContactFlowModuleSearchConditionList =
Values_0.ContactFlowModuleSearchConditionListmodule ContactFlowModuleSearchCriteria =
Values_0.ContactFlowModuleSearchCriteriaThe search criteria to be used to return flow modules.
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.
The search criteria to be used to return flow modules.
Contains summary information about a flow.
Contains information about a version.
The flow has not been published.
module ContactFlowSearchConditionList = Values_0.ContactFlowSearchConditionListmodule ContactFlowSearchCriteria = Values_0.ContactFlowSearchCriteriaThe search criteria to be used to return flows.
Filters to be applied to search results.
Contains summary information about a flow. You can also create and update flows using the Amazon Connect Flow language.
A summary of a flow version's metadata.
Contains the details of a metric to be retrieved for a contact. Use this object to specify which contact level metrics you want to include in your GetContactMetrics request.
Contains the numeric value of a contact metric result.
Contains the result of a requested metric for the contact. This object is returned as part of the GetContactMetrics response and includes both the metric name and its calculated value.
The contact with the specified ID does not exist.
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.
module ContactSearchSummarySegmentAttributeValue =
Values_0.ContactSearchSummarySegmentAttributeValueThe 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.
If this contact was queued, this contains information about the queue.
Information about the agent who accepted the contact.
Information of returned contact.
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.
Creates an agent status for the specified Amazon Connect instance.
Creates an agent status for the specified Amazon Connect instance.
Object for case field values.
The CreateCase action definition.
Creates a named alias that points to a specific version of a contact flow module.
Creates a named alias that points to a specific version of a contact flow module.
Creates a flow module for the specified Amazon Connect instance.
Information about a problem detail.
The problems with the module. Please fix before trying again.
Creates a flow module for the specified Amazon Connect instance.
Creates an immutable snapshot of a contact flow module, preserving its content and settings at a specific point in time for version control and rollback capabilities.
module CreateContactFlowModuleVersionResponse =
Values_0.CreateContactFlowModuleVersionResponseCreates an immutable snapshot of a contact flow module, preserving its content and settings at a specific point in time for version control and rollback capabilities.
Creates a flow for the specified Amazon Connect instance. You can also create and update flows using the Amazon Connect Flow language.
The flow is not valid.
Creates a flow for the specified Amazon Connect instance. You can also create and update flows using the Amazon Connect Flow language.
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.
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.
The user details for the contact.
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.
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.
Adds an attribute to an existing data table. Creating a new primary attribute uses the empty value for the specified value type for all existing records. This should not affect uniqueness of published data tables since the existing primary values will already be unique. Creating attributes does not create any values. System managed tables may not allow customers to create new attributes.
Adds an attribute to an existing data table. Creating a new primary attribute uses the empty value for the specified value type for all existing records. This should not affect uniqueness of published data tables since the existing primary values will already be unique. Creating attributes does not create any values. System managed tables may not allow customers to create new attributes.
Creates a new data table with the specified properties. Supports the creation of all table properties except for attributes and values. A table with no attributes and values is a valid state for a table. The number of tables per instance is limited to 100 per instance. Customers can request an increase by using Amazon Web Services Service Quotas.
Creates a new data table with the specified properties. Supports the creation of all table properties except for attributes and values. A table with no attributes and values is a valid state for a table. The number of tables per instance is limited to 100 per instance. Customers can request an increase by using Amazon Web Services Service Quotas.
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.
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.
module EvaluationReviewNotificationRecipientValue =
Values_0.EvaluationReviewNotificationRecipientValueThe value information for an evaluation review notification recipient.
module EvaluationReviewNotificationRecipientType =
Values_0.EvaluationReviewNotificationRecipientTypeInformation about a recipient who should be notified when an evaluation review is requested.
module EvaluationReviewNotificationRecipientList =
Values_0.EvaluationReviewNotificationRecipientListConfiguration settings for evaluation reviews.
Configuration that specifies the target for an evaluation form.
Information about scoring strategy for an evaluation form.
Language configuration for an evaluation form.
module EvaluationFormQuestionAutomationAnswerSourceType =
Values_0.EvaluationFormQuestionAutomationAnswerSourceTypemodule EvaluationFormQuestionAutomationAnswerSource =
Values_0.EvaluationFormQuestionAutomationAnswerSourceA question automation answer.
Information about the automation configuration in text questions.
Information about properties for a text question in an evaluation form.
module EvaluationFormSingleSelectQuestionOptionText =
Values_0.EvaluationFormSingleSelectQuestionOptionTextmodule EvaluationFormSingleSelectQuestionOption =
Values_0.EvaluationFormSingleSelectQuestionOptionInformation about the automation configuration in single select questions.
module EvaluationFormSingleSelectQuestionOptionList =
Values_0.EvaluationFormSingleSelectQuestionOptionListmodule EvaluationFormSingleSelectQuestionDisplayMode =
Values_0.EvaluationFormSingleSelectQuestionDisplayModemodule SingleSelectQuestionRuleCategoryAutomationLabel =
Values_0.SingleSelectQuestionRuleCategoryAutomationLabelmodule SingleSelectQuestionRuleCategoryAutomationCondition =
Values_0.SingleSelectQuestionRuleCategoryAutomationConditionmodule SingleSelectQuestionRuleCategoryAutomation =
Values_0.SingleSelectQuestionRuleCategoryAutomationInformation about the automation option based on a rule category for a single select question.
module EvaluationFormSingleSelectQuestionAutomationOption =
Values_0.EvaluationFormSingleSelectQuestionAutomationOptionInformation about the automation option of a single select question.
module EvaluationFormSingleSelectQuestionAutomationOptionList =
Values_0.EvaluationFormSingleSelectQuestionAutomationOptionListmodule EvaluationFormSingleSelectQuestionAutomation =
Values_0.EvaluationFormSingleSelectQuestionAutomationInformation 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.
module EvaluationFormSingleSelectQuestionProperties =
Values_0.EvaluationFormSingleSelectQuestionPropertiesInformation about the options in single select questions.
Information about the option range used for scoring in numeric questions.
module EvaluationFormNumericQuestionOptionList =
Values_0.EvaluationFormNumericQuestionOptionListmodule NumericQuestionPropertyAutomationLabel =
Values_0.NumericQuestionPropertyAutomationLabelmodule NumericQuestionPropertyValueAutomation =
Values_0.NumericQuestionPropertyValueAutomationInformation 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.
module EvaluationFormNumericQuestionAutomation =
Values_0.EvaluationFormNumericQuestionAutomationInformation about the automation configuration in numeric questions.
module EvaluationFormNumericQuestionProperties =
Values_0.EvaluationFormNumericQuestionPropertiesInformation about properties for a numeric question in an evaluation form.
module EvaluationFormMultiSelectQuestionOptionText =
Values_0.EvaluationFormMultiSelectQuestionOptionTextmodule EvaluationFormMultiSelectQuestionOption =
Values_0.EvaluationFormMultiSelectQuestionOptionAn option for a multi-select question in an evaluation form.
module EvaluationFormMultiSelectQuestionOptionList =
Values_0.EvaluationFormMultiSelectQuestionOptionListmodule EvaluationFormMultiSelectQuestionDisplayMode =
Values_0.EvaluationFormMultiSelectQuestionDisplayModemodule MultiSelectQuestionRuleCategoryAutomationLabel =
Values_0.MultiSelectQuestionRuleCategoryAutomationLabelmodule MultiSelectQuestionRuleCategoryAutomationCondition =
Values_0.MultiSelectQuestionRuleCategoryAutomationConditionmodule MultiSelectQuestionRuleCategoryAutomation =
Values_0.MultiSelectQuestionRuleCategoryAutomationAutomation rule for multi-select questions based on rule categories.
module EvaluationFormMultiSelectQuestionAutomationOption =
Values_0.EvaluationFormMultiSelectQuestionAutomationOptionAn automation option for a multi-select question.
module EvaluationFormMultiSelectQuestionAutomationOptionList =
Values_0.EvaluationFormMultiSelectQuestionAutomationOptionListmodule EvaluationFormMultiSelectQuestionAutomation =
Values_0.EvaluationFormMultiSelectQuestionAutomationAutomation configuration for multi-select questions.
module EvaluationFormMultiSelectQuestionProperties =
Values_0.EvaluationFormMultiSelectQuestionPropertiesProperties for a multi-select question in an evaluation form.
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.
module EvaluationFormItemSourceValuesComparator =
Values_0.EvaluationFormItemSourceValuesComparatormodule EvaluationFormItemEnablementSourceValueType =
Values_0.EvaluationFormItemEnablementSourceValueTypemodule EvaluationFormItemEnablementSourceValue =
Values_0.EvaluationFormItemEnablementSourceValueAn enablement expression source value.
module EvaluationFormItemEnablementSourceValueList =
Values_0.EvaluationFormItemEnablementSourceValueListmodule EvaluationFormItemEnablementSourceType =
Values_0.EvaluationFormItemEnablementSourceTypeAn enablement expression source item.
module EvaluationFormItemEnablementExpression =
Values_0.EvaluationFormItemEnablementExpressionAn expression that defines a basic building block of conditional enablement.
module EvaluationFormItemEnablementCondition =
Values_0.EvaluationFormItemEnablementConditionA condition for item enablement.
module EvaluationFormItemEnablementConditionOperand =
Values_0.EvaluationFormItemEnablementConditionOperandAn operand of the enablement condition.
module EvaluationFormItemEnablementConditionOperandList =
Values_0.EvaluationFormItemEnablementConditionOperandListmodule EvaluationFormItemEnablementConfiguration =
Values_0.EvaluationFormItemEnablementConfigurationAn item enablement configuration.
Information about a question from an evaluation form.
module EvaluationFormItem = Values_0.EvaluationFormItemInformation about an item from an evaluation form. The item must be either a section or a question.
module EvaluationFormItemsList = Values_0.EvaluationFormItemsListmodule EvaluationFormSection = Values_0.EvaluationFormSectionInformation 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).
module EvaluationFormAutoEvaluationConfiguration =
Values_0.EvaluationFormAutoEvaluationConfigurationThe automatic evaluation configuration of an evaluation form.
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.
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.
Specifies the detailed pattern for event recurrence. Use this to define complex scheduling rules such as "every 2nd Tuesday of the month" or "every 3 months on the 15th".
Defines the recurrence configuration for overrides. This configuration uses a recurrence pattern to specify when and how frequently an event should repeat.
module HoursOfOperationOverrideYearMonthDayDateFormat =
Values_0.HoursOfOperationOverrideYearMonthDayDateFormatThe start time or end time for an hours of operation override.
Information about the hours of operation override config: day, start time, and end time.
Creates an hours of operation override in an Amazon Connect hours of operation resource.
module CreateHoursOfOperationOverrideResponse =
Values_0.CreateHoursOfOperationOverrideResponseCreates an hours of operation override in an Amazon Connect hours of operation resource.
The start time or end time for an hours of operation.
Contains information about the hours of operation.
Creates hours of operation.
Creates hours of operation.
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.
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.
Creates an Amazon Web Services resource association with an Amazon Connect instance.
Creates an Amazon Web Services resource association with an Amazon Connect instance.
The unique identifier for a notification.
A localized string value. Maximum length is 500 characters.
Creates a new notification to be delivered to specified recipients. Notifications can include localized content with links, and an optional expiration time. Recipients can be specified as individual user ARNs or instance ARNs to target all users in an instance.
Creates a new notification to be delivered to specified recipients. Notifications can include localized content with links, and an optional expiration time. Recipients can be specified as individual user ARNs or instance ARNs to target all users in an instance.
The details to add for the participant.
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.
The credentials used by the participant.
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.
module CreatePersistentContactAssociationRequest =
Values_0.CreatePersistentContactAssociationRequestEnables 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.
module CreatePersistentContactAssociationResponse =
Values_0.CreatePersistentContactAssociationResponseEnables 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.
Information about values of a predefined attribute.
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.
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.
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.
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.
module CreatePushNotificationRegistrationRequest =
Values_0.CreatePushNotificationRegistrationRequestCreates 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.
module CreatePushNotificationRegistrationResponse =
Values_0.CreatePushNotificationRegistrationResponseCreates 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.
The outbound email address ID.
The outbound caller ID name, number, and outbound whisper flow.
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 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.
Contains information about the quick connect configuration settings for a user. The contact flow must be of type Transfer to Agent.
Contains information about a queue for a quick connect. The flow must be of type Transfer to Queue.
Contains information about a phone number for a quick connect.
Configuration for quick connect.
Contains configuration settings for a quick connect.
Creates a quick connect for the specified Amazon Connect instance.
Creates a quick connect for the specified Amazon Connect instance.
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.
Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.
Creates a new routing profile.
Creates a new routing profile.
The name of the event source. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate | OnContactEvaluationSubmit | OnMetricDataUpdate.
The UpdateCase action definition.
Information about the task action.
Information about the submit automated evaluation action.
The type of notification recipient.
Information about the send notification action.
The EventBridge action definition.
End associated tasks related to a case.
Information about the action to be performed when a rule is triggered.
Creates a rule for the specified Amazon Connect instance. Use the Rules Function language to code conditions for the rule.
Creates a rule for the specified Amazon Connect instance. Use the Rules Function language to code conditions for the rule.
A primary attribute value.
module PrimaryAttributeAccessControlConfigurationItem =
Values_0.PrimaryAttributeAccessControlConfigurationItemA primary attribute access control configuration item.
A data table access control configuration.
Contains granular access control configuration for security profiles, including data table access permissions.
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.
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.
The identifier of the task template field.
Describes a single task template field.
Describes a default field and its corresponding value.
Describes default values for fields on a template.
Information about a required field.
Indicates a field that is read-only to an agent.
A field that is invisible to an agent.
Describes constraints that apply to the template fields.
Creates a new task template in the specified Amazon Connect instance.
Contains information about why a property is not valid.
module PropertyValidationExceptionPropertyList =
Values_0.PropertyValidationExceptionPropertyListThe property is not valid.
Creates a new task template in the specified Amazon Connect instance.
Parameters for initiating a voice call test.
Defines the starting point for a test case.
Creates a test case with its content and metadata for the specified Amazon Connect instance.
The test is not valid.
Creates a test case with its content and metadata for the specified Amazon Connect instance.
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.
The resource is not ready.
module CreateTrafficDistributionGroupResponse =
Values_0.CreateTrafficDistributionGroupResponseCreates 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.
Creates a use case for an integration association.
Creates a use case for an integration association.
Creates a new user hierarchy group.
Creates a new user hierarchy group.
Configuration settings for voice enhancement.
include module type of struct include Values_1 endContains information about the phone configuration settings for a user.
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.
Configuration settings for phone type and phone number.
Configuration settings for persistent connection for a specific channel.
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. Fields in PhoneConfig cannot be set simultaneously with their corresponding channel-specific configuration parameters. Specifically: PhoneConfig.AutoAccept conflicts with AutoAcceptConfigs PhoneConfig.AfterContactWorkTimeLimit conflicts with AfterContactWorkConfigs PhoneConfig.PhoneType and PhoneConfig.PhoneNumber conflict with PhoneNumberConfigs PhoneConfig.PersistentConnection conflicts with PersistentConnectionConfigs We recommend using channel-specific parameters such as AutoAcceptConfigs, AfterContactWorkConfigs, PhoneNumberConfigs, PersistentConnectionConfigs, and VoiceEnhancementConfigs for per-channel configuration. For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.
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. Fields in PhoneConfig cannot be set simultaneously with their corresponding channel-specific configuration parameters. Specifically: PhoneConfig.AutoAccept conflicts with AutoAcceptConfigs PhoneConfig.AfterContactWorkTimeLimit conflicts with AfterContactWorkConfigs PhoneConfig.PhoneType and PhoneConfig.PhoneNumber conflict with PhoneNumberConfigs PhoneConfig.PersistentConnection conflicts with PersistentConnectionConfigs We recommend using channel-specific parameters such as AutoAcceptConfigs, AfterContactWorkConfigs, PhoneNumberConfigs, PersistentConnectionConfigs, and VoiceEnhancementConfigs for per-channel configuration. For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.
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.
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.
View content containing all content necessary to render a view except for runtime input data.
A view resource object. Contains metadata and content necessary to render the view.
Displayed when rate-related API limits are exceeded.
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.
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.
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.
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.
Associates a view with a page in a workspace, defining what users see when they navigate to that page.
Associates a view with a page in a workspace, defining what users see when they navigate to that page.
Contains font family configuration for workspace themes.
Contains typography configuration for a workspace theme.
Contains primary color configuration for a workspace theme.
Contains color configuration for navigation elements in a workspace theme.
Contains color configuration for header elements in a workspace theme.
Contains color configuration for canvas elements in a workspace theme.
Contains color palette configuration for different areas of a workspace.
Contains logo image configuration for workspace themes.
Contains image configuration for a workspace theme.
Contains detailed theme configuration for a workspace, including colors, images, and typography.
Contains theme configuration for a workspace, supporting both light and dark modes.
Creates a workspace that defines the user experience by mapping views to pages. Workspaces can be assigned to users or routing profiles.
Creates a workspace that defines the user experience by mapping views to pages. Workspaces can be assigned to users or routing profiles.
Contains credentials to use for federation.
Contains information about a real-time metric. For a description of each metric, see Metrics definitions in the Amazon Connect Administrator Guide. Only one of either the Name or MetricId is required.
Contains the data for a real-time metric.
Information about the routing profile assigned to the user.
Contains information about the dimensions for a set of metrics.
Contains information about a set of real-time metrics.
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.
Represents a data table in Amazon Connect. A data table is a JSON-like data structure where attributes and values are dynamically set by customers. Customers can reference table values within call flows, applications, views, and workspaces to pinpoint dynamic configuration that changes their contact center's behavior in a predetermined and safe way.
A data table evaluated value.
module DataTableSearchConditionList = Values_1.DataTableSearchConditionListmodule DataTableSearchCriteria = Values_1.DataTableSearchCriteriaA data table search criteria.
A data table search filter.
A data table summary.
A data table value evaluation set.
A data table value summary.
An object to specify the hours of operation override date condition.
Information about a reference when the referenceType is DATE. Otherwise, null.
A datetime search condition for Search APIs.
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.
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.
A decimal search condition for Search APIs.
Contains information about a default vocabulary.
Request to DeleteAttachedFile API
Response from DeleteAttachedFile API
Deletes a contact evaluation in the specified Amazon Connect instance.
Removes an alias reference, breaking the named connection to the underlying module version without affecting the version itself.
Removes an alias reference, breaking the named connection to the underlying module version without affecting the version itself.
Deletes the specified flow module.
Deletes the specified flow module.
Removes a specific version of a contact flow module.
module DeleteContactFlowModuleVersionResponse =
Values_1.DeleteContactFlowModuleVersionResponseRemoves a specific version of a contact flow module.
Deletes a flow for the specified Amazon Connect instance.
Deletes a flow for the specified Amazon Connect instance.
Deletes the particular version specified in flow version identifier.
Deletes the particular version specified in flow version identifier.
Deletes an attribute and all its values from a data table.
Deletes an attribute and all its values from a data table.
Deletes a data table and all associated attributes, versions, audits, and values. Does not update any references to the data table, even from other data tables. This includes dynamic values and conditional validations. System managed data tables are not deletable by customers. API users may delete the table at any time. When deletion is requested from the admin website, a warning is shown alerting the user of the most recent time the table and its values were accessed.
Deletes a data table and all associated attributes, versions, audits, and values. Does not update any references to the data table, even from other data tables. This includes dynamic values and conditional validations. System managed data tables are not deletable by customers. API users may delete the table at any time. When deletion is requested from the admin website, a warning is shown alerting the user of the most recent time the table and its values were accessed.
Deletes email address from the specified Amazon Connect instance.
Deletes email address from the specified Amazon Connect instance.
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 override in an Amazon Connect hours of operation resource.
Deletes an hours of operation.
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.
Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.
Deletes a notification. Once deleted, the notification is no longer visible to all users and cannot be managed through the Admin Website or APIs.
The response from deleting a notification.
Deletes a predefined attribute from the specified Amazon Connect instance.
Deletes a prompt.
module DeletePushNotificationRegistrationRequest =
Values_1.DeletePushNotificationRegistrationRequestDeletes registration for a device token and a chat contact.
module DeletePushNotificationRegistrationResponse =
Values_1.DeletePushNotificationRegistrationResponseDeletes registration for a device token and a chat contact.
Deletes a queue.
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.
Deletes a rule for the specified Amazon Connect instance.
Deletes a security profile.
Deletes the task template.
Deletes the task template.
Deletes the test case that has already been created for the specified Amazon Connect instance.
Deletes the test case that has already been created for the specified Amazon Connect instance.
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.
module DeleteTrafficDistributionGroupResponse =
Values_1.DeleteTrafficDistributionGroupResponseDeletes 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.
Deletes a use case from an integration association.
Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
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 the view entirely. It deletes the view and all associated qualifiers (versions and aliases).
Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).
Deletes the particular version specified in ViewVersion identifier.
Deletes the particular version specified in ViewVersion identifier.
Deletes the vocabulary that has the given identifier.
Deletes the vocabulary that has the given identifier.
Deletes a media asset (such as a logo) from a workspace.
Deletes a media asset (such as a logo) from a workspace.
Removes the association between a view and a page in a workspace. The page will display the default view after deletion.
Removes the association between a view and a page in a workspace. The page will display the default view after deletion.
Deletes a workspace and removes all associated view and resource assignments.
Deletes a workspace and removes all associated view and resource assignments.
Describes an agent status.
Describes an agent status.
module DescribeAttachedFilesConfigurationRequest =
Values_1.DescribeAttachedFilesConfigurationRequestDescribes the attached files configuration for the specified Amazon Connect instance and attachment scope. If a custom configuration exists for the specified attachment scope, the custom configuration is returned. If no custom configuration exists, the default configuration values for that attachment scope are returned.
module DescribeAttachedFilesConfigurationResponse =
Values_1.DescribeAttachedFilesConfigurationResponseDescribes the attached files configuration for the specified Amazon Connect instance and attachment scope. If a custom configuration exists for the specified attachment scope, the custom configuration is returned. If no custom configuration exists, the default configuration values for that attachment scope are returned.
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.
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.
Describes a contact evaluation in the specified Amazon Connect instance.
Information about an evaluation form used in a contact evaluation.
Information about scores of a contact evaluation item (section or question).
Information about notes for a contact evaluation.
A comment provided when requesting an evaluation review.
Metadata information about an evaluation review.
Information about a contact participant in the evaluation.
Information about the evaluation acknowledgement.
Metadata information about a contact evaluation.
Details of the input data used for automated question processing.
module EvaluationSuggestedAnswerTranscriptSegment =
Values_1.EvaluationSuggestedAnswerTranscriptSegmentmodule EvaluationSuggestedAnswerTranscriptMillisOffset =
Values_1.EvaluationSuggestedAnswerTranscriptMillisOffsetmodule EvaluationSuggestedAnswerTranscriptMillisecondOffsets =
Values_1.EvaluationSuggestedAnswerTranscriptMillisecondOffsetsThe milliseconds offset for transcript reference in suggested answer.
Information about the point of interest in transcript provided to evaluation.
module EvaluationSuggestedAnswerJustification =
Values_1.EvaluationSuggestedAnswerJustificationAn analysis for a generative AI answer to the question.
module QuestionRuleCategoryAutomationCondition =
Values_1.QuestionRuleCategoryAutomationConditionThe Contact Lens category used by evaluation automation.
module EvaluationContactLensAnswerAnalysisDetails =
Values_1.EvaluationContactLensAnswerAnalysisDetailsAnalysis details providing explanation for Contact Lens automation decision.
module EvaluationQuestionAnswerAnalysisDetails =
Values_1.EvaluationQuestionAnswerAnalysisDetailsDetailed analysis results of the automated answer to the evaluation question.
Information about answer data for a contact evaluation. Answer data must be either string, numeric, or not applicable.
The information about the suggested answer for the question.
Information about output answers for a contact evaluation.
Information about a contact evaluation.
Describes a contact evaluation in the specified Amazon Connect instance.
Retrieves detailed information about a specific alias, including which version it currently points to and its metadata.
module DescribeContactFlowModuleAliasResponse =
Values_1.DescribeContactFlowModuleAliasResponseRetrieves detailed information about a specific alias, including which version it currently points to and its metadata.
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.
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.
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. 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
This API is in preview release for Amazon Connect and is subject to change. Describes the specified contact. Use cases Following are common uses cases for this API: Retrieve contact information such as the caller's phone number and the specific number the caller dialed to integrate into custom monitoring or custom agent experience solutions. Detect when a customer chat session disconnects due to a network issue on the agent's end. Use the DisconnectReason field in the ContactTraceRecord to detect this event and then re-queue the chat for followup. Identify after contact work (ACW) duration and call recordings information when a COMPLETED event is received by using the contact event stream. Important things to know 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. Endpoints: See Amazon Connect endpoints and quotas.
This API is in preview release for Amazon Connect and is subject to change. Describes the specified contact. Use cases Following are common uses cases for this API: Retrieve contact information such as the caller's phone number and the specific number the caller dialed to integrate into custom monitoring or custom agent experience solutions. Detect when a customer chat session disconnects due to a network issue on the agent's end. Use the DisconnectReason field in the ContactTraceRecord to detect this event and then re-queue the chat for followup. Identify after contact work (ACW) duration and call recordings information when a COMPLETED event is received by using the contact event stream. Important things to know 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. Endpoints: See Amazon Connect endpoints and quotas.
Returns detailed information for a specific data table attribute including its configuration, validation rules, and metadata. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.
Returns detailed information for a specific data table attribute including its configuration, validation rules, and metadata. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.
Returns all properties for a data table except for attributes and values. All properties from CreateDataTable are returned as well as properties for region replication, versioning, and system tables. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.
Returns all properties for a data table except for attributes and values. All properties from CreateDataTable are returned as well as properties for region replication, versioning, and system tables. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.
Describe email address form the specified Amazon Connect instance.
Describe email address form the specified Amazon Connect instance.
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.
Information about the evaluation form.
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.
module DescribeHoursOfOperationOverrideRequest =
Values_1.DescribeHoursOfOperationOverrideRequestDescribes the hours of operation override.
Information about the hours of operations override.
module DescribeHoursOfOperationOverrideResponse =
Values_1.DescribeHoursOfOperationOverrideResponseDescribes the hours of operation override.
Describes the hours of operation.
Information about of the hours of operation.
Describes the hours of operation.
This API is in preview release for Amazon Connect and is subject to change. Describes the specified instance attribute.
This API is in preview release for Amazon Connect and is subject to change. Describes the specified instance attribute.
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.
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.
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.
Relevant details why the instance was not successfully created.
The Amazon Connect instance.
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.
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.
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.
Retrieves detailed information about a specific notification, including its content, priority, recipients, and metadata.
Contains information about a notification, including its content, priority, recipients, and metadata.
Retrieves detailed information about a specific notification, including its content, priority, recipients, and metadata.
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.
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.
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.
Information about a predefined attribute.
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.
Describes the prompt.
Information about a prompt.
Describes the prompt.
Describes the specified queue.
Contains information about a queue.
Describes the specified queue.
Describes the quick connect.
Contains information about a quick connect.
Describes the quick connect.
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.
Contains information about a routing profile.
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.
Information about a rule.
Describes a rule for the specified Amazon Connect instance.
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.
Contains information about a security profile.
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.
Describes the specified test case and allows you to get the content and metadata of the test case for the specified Amazon Connect instance.
Contains information about a test case.
Describes the specified test case and allows you to get the content and metadata of the test case for the specified Amazon Connect instance.
module DescribeTrafficDistributionGroupRequest =
Values_1.DescribeTrafficDistributionGroupRequestGets details and status of a traffic distribution group.
Information about a traffic distribution group.
module DescribeTrafficDistributionGroupResponse =
Values_1.DescribeTrafficDistributionGroupResponseGets details and status of a traffic distribution group.
Describes the specified hierarchy group.
Contains summary information about a hierarchy group.
Contains information about the levels of a hierarchy group.
Contains information about a hierarchy group.
Describes the specified hierarchy group.
Describes the hierarchy structure of the specified Amazon Connect instance.
Contains information about a hierarchy level.
Contains information about a hierarchy structure.
module DescribeUserHierarchyStructureResponse =
Values_1.DescribeUserHierarchyStructureResponseDescribes the hierarchy structure of the specified Amazon Connect instance.
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.
Contains information about a user account for an Amazon Connect instance.
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.
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.
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.
Contains information about a custom vocabulary.
Describes the specified vocabulary.
Retrieves details about a workspace, including its configuration and metadata.
Contains information about a workspace, which defines the user experience by mapping views to pages.
Retrieves details about a workspace, including its configuration and metadata.
Outbound calls to the destination number are not allowed.
Removes the dataset ID associated with a given Amazon Connect instance.
This API is in preview release for Amazon Connect and is subject to change. Revokes access to integrated applications from Amazon Connect.
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.
Removes the alias association between two email addresses in an Amazon Connect instance. After disassociation, emails sent to the former alias email address are no longer forwarded to the primary email address. Both email addresses continue to exist independently and can receive emails directly. Use cases Following are common uses cases for this API: Department separation: Remove alias relationships when splitting a consolidated support queue back into separate department-specific queues. Email address retirement: Cleanly remove forwarding relationships before decommissioning old email addresses. Organizational restructuring: Reconfigure email routing when business processes change and aliases are no longer needed. Important things to know Concurrent operations: This API uses distributed locking, so concurrent operations on the same email addresses may be temporarily blocked. Emails sent to the former alias address are still delivered directly to that address if it exists. You do not need to delete the email addresses after disassociation. Both addresses remain active independently. After a successful disassociation, you can immediately create a new alias relationship with the same addresses. 200 status means alias was successfully disassociated. DisassociateEmailAddressAlias does not return the following information: Details in the response about the email that was disassociated. The response returns an empty body. The timestamp of when the disassociation occurred. Endpoints: See Amazon Connect endpoints and quotas. Related operations AssociateEmailAddressAlias: Associates an email address alias with an existing email address in an Amazon Connect instance. DescribeEmailAddress: View current alias configurations for an email address. SearchEmailAddresses: Find email addresses and their alias relationships across an instance. CreateEmailAddress: Create new email addresses that can participate in alias relationships. DeleteEmailAddress: Remove email addresses (automatically removes any alias relationships). UpdateEmailAddressMetadata: Modify email address properties (does not affect alias relationships).
Removes the alias association between two email addresses in an Amazon Connect instance. After disassociation, emails sent to the former alias email address are no longer forwarded to the primary email address. Both email addresses continue to exist independently and can receive emails directly. Use cases Following are common uses cases for this API: Department separation: Remove alias relationships when splitting a consolidated support queue back into separate department-specific queues. Email address retirement: Cleanly remove forwarding relationships before decommissioning old email addresses. Organizational restructuring: Reconfigure email routing when business processes change and aliases are no longer needed. Important things to know Concurrent operations: This API uses distributed locking, so concurrent operations on the same email addresses may be temporarily blocked. Emails sent to the former alias address are still delivered directly to that address if it exists. You do not need to delete the email addresses after disassociation. Both addresses remain active independently. After a successful disassociation, you can immediately create a new alias relationship with the same addresses. 200 status means alias was successfully disassociated. DisassociateEmailAddressAlias does not return the following information: Details in the response about the email that was disassociated. The response returns an empty body. The timestamp of when the disassociation occurred. Endpoints: See Amazon Connect endpoints and quotas. Related operations AssociateEmailAddressAlias: Associates an email address alias with an existing email address in an Amazon Connect instance. DescribeEmailAddress: View current alias configurations for an email address. SearchEmailAddresses: Find email addresses and their alias relationships across an instance. CreateEmailAddress: Create new email addresses that can participate in alias relationships. DeleteEmailAddress: Remove email addresses (automatically removes any alias relationships). UpdateEmailAddressMetadata: Modify email address properties (does not affect alias relationships).
Disassociates a connect resource from a flow.
Disassociates a connect resource from a flow.
Disassociates a set of hours of operations with another hours of operation. Refer to Administrator Guide here for more information on inheriting overrides from parent hours of operation(s).
module DisassociateInstanceStorageConfigRequest =
Values_1.DisassociateInstanceStorageConfigRequestThis 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.
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.
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.
module DisassociatePhoneNumberContactFlowRequest =
Values_1.DisassociatePhoneNumberContactFlowRequestRemoves 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.
module DisassociateQueueEmailAddressesRequest =
Values_1.DisassociateQueueEmailAddressesRequestRemoves the association between a set of email addresses and a queue. After disassociation, agents will no longer be able to select these email addresses as "From" addresses when replying to inbound email contacts or initiating outbound email contacts in this queue. Important things to know Agents will no longer see these email addresses in their "From" address selection options for this queue. The email addresses themselves are not deleted from the instance, only their availability for agent selection in this queue is removed. Changes take effect immediately and will affect the agent experience in the Contact Control Panel (CCP).
Disassociates a set of quick connects from a queue.
module DisassociateRoutingProfileQueuesRequest =
Values_1.DisassociateRoutingProfileQueuesRequestDisassociates a set of queues from a routing profile. Up to 10 queue references can be disassociated in a single API call. More than 10 queue references results in a single call results in an InvalidParameterException.
This API is in preview release for Amazon Connect and is subject to change. Deletes the specified security key.
Disassociates a security profile attached to a Q in Connect AI Agent Entity in an Amazon Connect instance.
module DisassociateTrafficDistributionGroupUserRequest =
Values_1.DisassociateTrafficDistributionGroupUserRequestDisassociates an agent from a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
module DisassociateTrafficDistributionGroupUserResponse =
Values_1.DisassociateTrafficDistributionGroupUserResponseDisassociates an agent from a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
Information about proficiency to be disassociated from the user.
Disassociates a set of proficiencies from a user.
Removes the association between a workspace and one or more users or routing profiles.
Removes the association between a workspace and one or more users or routing profiles.
module DisconnectOnCustomerExitParticipantType =
Values_1.DisconnectOnCustomerExitParticipantTypeContains details about why a contact was disconnected. Only Amazon Connect outbound campaigns can provide this field.
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.
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.
Metadata used to download the attached file.
Information about the hours of operations with the effective override applied.
Information about the hours of operations with the effective override applied.
Information about hours of operation override
Information about the hours of operation overrides which contribute to effective hours of operations.
Contains information about a source or destination email address.
Contains information about an email address for a contact center.
Summary information about an email address associated with a queue. Contains the essential details needed to identify and manage the email address routing configuration.
module EmailAddressSearchConditionList =
Values_1.EmailAddressSearchConditionListmodule EmailAddressSearchCriteria = Values_1.EmailAddressSearchCriteriaThe search criteria to be used to return email addresses.
Filters to be applied to search results.
Information about the email attachment files.
Information about the reference when the referenceType is EMAIL_MESSAGE. Otherwise, null.
Information about a reference when the referenceType is EMAIL. Otherwise, null.
Evaluates values at the time of the request and returns them. It considers the request's timezone or the table's timezone, in that order, when accessing time based tables. When a value is accessed, the accessor's identity and the time of access are saved alongside the value to help identify values that are actively in use. The term "Batch" is not included in the operation name since it does not meet all the criteria for a batch operation as specified in Batch Operations: Amazon Web Services API Standards.
Evaluates values at the time of the request and returns them. It considers the request's timezone or the table's timezone, in that order, when accessing time based tables. When a value is accessed, the accessor's identity and the time of access are saved alongside the value to help identify values that are actively in use. The term "Batch" is not included in the operation name since it does not meet all the criteria for a batch operation as specified in Batch Operations: Amazon Web Services API Standards.
Summary information about an evaluation acknowledgement.
Information about input answers for a contact evaluation.
module EvaluationFormSearchConditionList =
Values_1.EvaluationFormSearchConditionListmodule EvaluationFormSearchCriteria = Values_1.EvaluationFormSearchCriteriaThe search criteria to be used to return evaluation forms.
Filters to be applied to search results.
Information about the returned evaluation forms.
Summary information about an evaluation form.
Summary information about an evaluation form.
module EvaluationSearchConditionList = Values_1.EvaluationSearchConditionListmodule EvaluationSearchCriteria = Values_1.EvaluationSearchCriteriaThe search criteria to be used to return evaluations.
Filters to be applied to search results.
Metadata information about an evaluation search.
Summary of evaluation obtained from the search operation.
Summary information about a contact evaluation.
Represents the entity that performed the action on the evaluation.
Contains information about a test case execution record.
module FilterV2StringConditionComparisonOperator =
Values_1.FilterV2StringConditionComparisonOperatorSystem defined filtering condition. For example, the NOT_EXISTS StringCondition returns documents where the field specified by FilterKey does not exist in the document. When the NOT_EXISTS StringCondition is added to a FilterV2 object, FilterValues must be null or empty.
Contains the filter to apply when retrieving metrics with the GetMetricDataV2 API.
Contains the filter to apply when retrieving metrics.
Request to GetAttachedFile API.
Response from GetAttachedFile API.
Retrieves the contact attributes for the specified contact.
Retrieves the contact attributes for the specified contact.
Retrieves contact metric data for a specified contact. Use cases Following are common use cases for position in queue and estimated wait time: Customer-Facing Wait Time Announcements - Display or announce the estimated wait time and position in queue to customers before or during their queue experience. Callback Offerings - Offer customers a callback option when the estimated wait time or position in queue exceeds a defined threshold. Queue Routing Decisions - Route incoming contacts to less congested queues by comparing estimated wait time and position in queue across multiple queues. Self-Service Deflection - Redirect customers to self-service options like chatbots or FAQs when estimated wait time is high or position in queue is unfavorable. Important things to know Metrics are only available while the contact is actively in queue. For more information, see the Position in queue metric in the Amazon Connect Administrator Guide. Endpoints: See Amazon Connect endpoints and quotas.
Retrieves contact metric data for a specified contact. Use cases Following are common use cases for position in queue and estimated wait time: Customer-Facing Wait Time Announcements - Display or announce the estimated wait time and position in queue to customers before or during their queue experience. Callback Offerings - Offer customers a callback option when the estimated wait time or position in queue exceeds a defined threshold. Queue Routing Decisions - Route incoming contacts to less congested queues by comparing estimated wait time and position in queue across multiple queues. Self-Service Deflection - Redirect customers to self-service options like chatbots or FAQs when estimated wait time is high or position in queue is unfavorable. Important things to know Metrics are only available while the contact is actively in queue. For more information, see the Position in queue metric in the Amazon Connect Administrator Guide. Endpoints: See Amazon Connect endpoints and quotas.
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 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
A filter for the user data.
Gets the real-time active user data from the specified Amazon Connect instance.
Information about the user.
Information about the hierarchy group.
Information about the levels in the hierarchy group.
Data for a user.
Gets the real-time active user data from the specified Amazon Connect instance.
Get the hours of operations with the effective override applied.
Get the hours of operations with the effective override applied.
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
No user with the specified credentials was found in the Amazon Connect instance.
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.
Retrieves the flow associated for a given resource.
Contains information about the threshold for service level metrics.
Contains information about a historical metric.
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.
Contains the data for a historical metric.
Contains information about the historical metrics retrieved.
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.
Contains information about the threshold for service level metrics.
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.
Contains information about the metric. Only one of either the Name or MetricId is required.
Information about the interval period to use for returning results.
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
The interval period with the start and end time for the metrics.
Contains the name, thresholds, and metric filters.
Contains information about the metric results.
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.
Gets the prompt file.
Gets details about a specific task template in the specified Amazon Connect instance.
Gets details about a specific task template in the specified Amazon Connect instance.
Retrieves an overview of a test execution that includes the status of the execution, start and end time, and observation summary.
Contains summary statistics about a test case execution.
Retrieves an overview of a test execution that includes the status of the execution, start and end time, and observation summary.
Retrieves the current traffic distribution for a given traffic distribution group.
The distribution of traffic between the instance and its replicas.
The distribution of sign in traffic between the instance and its replica(s).
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).
Retrieves the current traffic distribution for a given traffic distribution group.
Contains information about the hierarchy level to update.
Contains information about the level hierarchy to update.
module HoursOfOperationOverrideSearchConditionList =
Values_1.HoursOfOperationOverrideSearchConditionListmodule HoursOfOperationOverrideSearchCriteria =
Values_1.HoursOfOperationOverrideSearchCriteriaThe search criteria to be used to return hours of operations overrides.
module HoursOfOperationSearchConditionList =
Values_1.HoursOfOperationSearchConditionListmodule HoursOfOperationSearchCriteria = Values_1.HoursOfOperationSearchCriteriaThe search criteria to be used to return hours of operations.
Filters to be applied to search results.
Contains summary information about hours of operation for a contact center.
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.
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.
Imports a media asset (such as a logo) for use in a workspace.
Imports a media asset (such as a logo) for use in a workspace.
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.
Information about the raw email body content.
Information about email body content.
Information about the instance.
Contains summary information about the associated AppIntegrations.
This exception occurs when an API request is made to a non-active region in an Amazon Connect instance configured with Amazon Connect Global Resiliency. For example, if the active region is US West (Oregon) and a request is made to US East (N. Virginia), the exception will be returned.
Configuration information of an Amazon Lex or Amazon Lex V2 bot.
Lists agent statuses.
Lists agent statuses.
Lists the association status of requested dataset ID for a given Amazon Connect instance.
Lists the association status of requested dataset ID for a given Amazon Connect instance.
Lists the data lake datasets available to associate with for a given Amazon Connect instance.
Lists the data lake datasets available to associate with for a given Amazon Connect instance.
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.
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.
module ListAssociatedContactsRequestMaxResults =
Values_1.ListAssociatedContactsRequestMaxResultsProvides information about contact tree, a list of associated contacts with a unique identifier.
Provides information about contact tree, a list of associated contacts with a unique identifier.
module ListAttachedFilesConfigurationsRequest =
Values_1.ListAttachedFilesConfigurationsRequestProvides summary information about the attached files configurations for the specified Amazon Connect instance. This API returns effective configurations (custom overrides or defaults) for each attachment scope. If no custom configuration exists for a scope, the default configuration values are returned.
module ListAttachedFilesConfigurationsResponse =
Values_1.ListAttachedFilesConfigurationsResponseProvides summary information about the attached files configurations for the specified Amazon Connect instance. This API returns effective configurations (custom overrides or defaults) for each attachment scope. If no custom configuration exists for a scope, the default configuration values are returned.
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.
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.
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.
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.
Provides information about the child hours of operations for the specified parent hours of operation. For more information about child hours of operations, see Link overrides from different hours of operation in the Administrator Guide.
Provides information about the child hours of operations for the specified parent hours of operation. For more information about child hours of operations, see Link overrides from different hours of operation in the Administrator Guide.
A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.
Lists contact evaluations in the specified Amazon Connect instance.
Lists contact evaluations in the specified Amazon Connect instance.
Lists all aliases associated with a contact flow module, showing their current version mappings and metadata.
Lists all aliases associated with a contact flow module, showing their current version mappings and metadata.
Retrieves a paginated list of all versions for a specific contact flow module.
Retrieves a paginated list of all versions for a specific contact flow module.
Provides information about the flow modules for the specified Amazon Connect instance.
Provides information about the flow modules for the specified Amazon Connect instance.
Returns all the available versions for the specified Amazon Connect instance and flow identifier.
Returns all the available versions for the specified Amazon Connect instance and flow identifier.
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.
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.
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.
The URL reference.
Information about a reference when the referenceType is STRING. Otherwise, null.
Information about a reference when the referenceType is NUMBER. Otherwise, null.
Contains summary information about a reference. ReferenceSummary contains only one non null field between the URL and attachment based on the reference type.
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.
Returns all attributes for a specified data table. A maximum of 100 attributes per data table is allowed. Customers can request an increase by using Amazon Web Services Service Quotas. The response can be filtered by specific attribute IDs for CloudFormation integration.
Returns all attributes for a specified data table. A maximum of 100 attributes per data table is allowed. Customers can request an increase by using Amazon Web Services Service Quotas. The response can be filtered by specific attribute IDs for CloudFormation integration.
A primary attribute value filter.
Lists all primary value combinations for a given data table. Returns the unique combinations of primary attribute values that identify records in the table. Up to 100 records are returned per request.
A record primary value.
Lists all primary value combinations for a given data table. Returns the unique combinations of primary attribute values that identify records in the table. Up to 100 records are returned per request.
Lists values stored in a data table with optional filtering by record IDs or primary attribute values. Returns the raw stored values along with metadata such as lock versions and modification timestamps.
Lists values stored in a data table with optional filtering by record IDs or primary attribute values. Returns the raw stored values along with metadata such as lock versions and modification timestamps.
Lists all data tables for the specified Amazon Connect instance. Returns summary information for each table including basic metadata and modification details.
Lists all data tables for the specified Amazon Connect instance. Returns summary information for each table including basic metadata and modification details.
Lists the default vocabularies for the specified Amazon Connect instance.
Lists the default vocabularies for the specified Amazon Connect instance.
Lists all security profiles attached to a Q in Connect AIAgent Entity in an Amazon Connect instance.
Lists all security profiles attached to a Q in Connect AIAgent Entity in an Amazon Connect instance.
Lists versions of an evaluation form in the specified Amazon Connect instance.
Lists versions of an evaluation form in the specified Amazon Connect instance.
Lists evaluation forms in the specified Amazon Connect instance.
Lists evaluation forms in the specified Amazon Connect instance.
List the flow association based on the filters.
List the flow association based on the filters.
List the hours of operation overrides.
List the hours of operation overrides.
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.
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.
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.
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.
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.
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.
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.
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.
Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
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.
include module type of struct include Values_2 endThis 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.
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.
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.
Retrieves a paginated list of all notifications in the Amazon Connect instance.
Retrieves a paginated list of all notifications in the Amazon Connect instance.
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.
Contains summary information about a phone number for a contact center.
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.
Information about phone numbers that have been claimed to your Amazon Connect instance or traffic distribution group.
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 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.
Summary of a predefined attribute.
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.
Provides information about the prompts for the specified Amazon Connect instance.
Contains information about the prompt.
Provides information about the prompts for the specified Amazon Connect instance.
Lists all email addresses that are currently associated with a specific queue, providing details about which "From" email addresses agents can select when handling email contacts. This helps administrators manage agent email address options and understand the available choices for different brands and business units. Important things to know The response includes metadata about each email address available for agent selection, including whether it's configured as the default outbound email. Agents can select from these email addresses when replying to inbound contacts or initiating outbound contacts in this queue. The list includes both explicitly associated email addresses and any default outbound email address configured for the queue. Results are paginated to handle queues with many associated email addresses (up to 50 per queue).
Lists all email addresses that are currently associated with a specific queue, providing details about which "From" email addresses agents can select when handling email contacts. This helps administrators manage agent email address options and understand the available choices for different brands and business units. Important things to know The response includes metadata about each email address available for agent selection, including whether it's configured as the default outbound email. Agents can select from these email addresses when replying to inbound contacts or initiating outbound contacts in this queue. The list includes both explicitly associated email addresses and any default outbound email address configured for the queue. Results are paginated to handle queues with many associated email addresses (up to 50 per queue).
Lists the quick connects associated with a queue.
Contains summary information about a quick connect.
Lists the quick connects associated with a queue.
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.
Contains summary information about a queue.
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.
Provides information about the quick connects for the specified Amazon Connect instance.
Provides information about the quick connects for the specified Amazon Connect instance.
module ListRealtimeContactAnalysisSegmentsV2Request =
Values_2.ListRealtimeContactAnalysisSegmentsV2RequestProvides 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.
module RealTimeContactAnalysisCharacterInterval =
Values_2.RealTimeContactAnalysisCharacterIntervalBegin and end offsets for a part of text.
module RealTimeContactAnalysisCharacterIntervals =
Values_2.RealTimeContactAnalysisCharacterIntervalsmodule RealTimeContactAnalysisTranscriptItemRedaction =
Values_2.RealTimeContactAnalysisTranscriptItemRedactionObject describing redaction applied to the segment.
module RealTimeContactAnalysisTranscriptContent =
Values_2.RealTimeContactAnalysisTranscriptContentObject describing time with which the segment is associated. It can have different representations of time. Currently supported: absoluteTime
module RealTimeContactAnalysisSegmentTranscript =
Values_2.RealTimeContactAnalysisSegmentTranscriptThe analyzed transcript segment.
module RealTimeContactAnalysisPostContactSummaryStatus =
Values_2.RealTimeContactAnalysisPostContactSummaryStatusmodule RealTimeContactAnalysisPostContactSummaryFailureCode =
Values_2.RealTimeContactAnalysisPostContactSummaryFailureCodemodule RealTimeContactAnalysisPostContactSummaryContent =
Values_2.RealTimeContactAnalysisPostContactSummaryContentmodule RealTimeContactAnalysisSegmentPostContactSummary =
Values_2.RealTimeContactAnalysisSegmentPostContactSummaryInformation about the post-contact summary for a real-time contact segment.
module RealTimeContactAnalysisTranscriptItemWithContent =
Values_2.RealTimeContactAnalysisTranscriptItemWithContentTranscript 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.
module RealTimeContactAnalysisTranscriptItemsWithContent =
Values_2.RealTimeContactAnalysisTranscriptItemsWithContentPotential issues that are detected based on an artificial intelligence analysis of each turn in the conversation.
Segment type containing a list of detected issues.
Segment type describing a contact event.
module RealTimeContactAnalysisTranscriptItemWithCharacterOffsets =
Values_2.RealTimeContactAnalysisTranscriptItemWithCharacterOffsetsTranscript 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.
module RealTimeContactAnalysisTranscriptItemsWithCharacterOffsets =
Values_2.RealTimeContactAnalysisTranscriptItemsWithCharacterOffsetsmodule RealTimeContactAnalysisPointOfInterest =
Values_2.RealTimeContactAnalysisPointOfInterestThe section of the contact transcript segment that category rule was detected.
module RealTimeContactAnalysisPointsOfInterest =
Values_2.RealTimeContactAnalysisPointsOfInterestmodule RealTimeContactAnalysisCategoryDetails =
Values_2.RealTimeContactAnalysisCategoryDetailsProvides information about the category rule that was matched.
module RealTimeContactAnalysisSegmentCategories =
Values_2.RealTimeContactAnalysisSegmentCategoriesThe matched category rules.
Object that describes attached file.
module RealTimeContactAnalysisSegmentAttachments =
Values_2.RealTimeContactAnalysisSegmentAttachmentsSegment containing list of attachments.
An analyzed segment for a real-time analysis session.
module RealTimeContactAnalysisSupportedChannel =
Values_2.RealTimeContactAnalysisSupportedChannelThrown 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.
module ListRealtimeContactAnalysisSegmentsV2Response =
Values_2.ListRealtimeContactAnalysisSegmentsV2ResponseProvides 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.
module ListRoutingProfileManualAssignmentQueuesRequest =
Values_2.ListRoutingProfileManualAssignmentQueuesRequestLists the manual assignment queues associated with a routing profile. Use cases Following are common uses cases for this API: This API returns list of queues where contacts can be manually assigned or picked by an agent who has access to the Worklist app. The user can additionally filter on queues, if they have access to those queues (otherwise a invalid request exception will be thrown). For information about how manual contact assignment works in the agent workspace, see the Access the Worklist app in the Amazon Connect agent workspace in the Amazon Connect Administrator Guide. Important things to know This API only returns the manual assignment queues associated with a routing profile. Use the ListRoutingProfileQueues API to list the auto assignment queues for the routing profile. Endpoints: See Amazon Connect endpoints and quotas.
module RoutingProfileManualAssignmentQueueConfigSummary =
Values_2.RoutingProfileManualAssignmentQueueConfigSummaryContains summary information about a routing profile manual assignment queue.
module RoutingProfileManualAssignmentQueueConfigSummaryList =
Values_2.RoutingProfileManualAssignmentQueueConfigSummaryListmodule ListRoutingProfileManualAssignmentQueuesResponse =
Values_2.ListRoutingProfileManualAssignmentQueuesResponseLists the manual assignment queues associated with a routing profile. Use cases Following are common uses cases for this API: This API returns list of queues where contacts can be manually assigned or picked by an agent who has access to the Worklist app. The user can additionally filter on queues, if they have access to those queues (otherwise a invalid request exception will be thrown). For information about how manual contact assignment works in the agent workspace, see the Access the Worklist app in the Amazon Connect agent workspace in the Amazon Connect Administrator Guide. Important things to know This API only returns the manual assignment queues associated with a routing profile. Use the ListRoutingProfileQueues API to list the auto assignment queues for the routing profile. Endpoints: See Amazon Connect endpoints and quotas.
Lists the queues associated with a routing profile.
Contains summary information about a routing profile queue.
Lists the queues associated with a routing profile.
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.
Contains summary information about a routing profile.
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.
List all rules for the specified Amazon Connect instance.
A list of ActionTypes associated with a rule.
List all rules for the specified Amazon Connect instance.
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.
Configuration information of the security key.
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.
module ListSecurityProfileApplicationsRequest =
Values_2.ListSecurityProfileApplicationsRequestReturns a list of third-party applications or MCP Servers in a specific security profile.
module ListSecurityProfileApplicationsResponse =
Values_2.ListSecurityProfileApplicationsResponseReturns a list of third-party applications or MCP Servers in a specific security profile.
A list of Flow Modules an AI Agent can invoke as a tool
module ListSecurityProfileFlowModulesResponse =
Values_2.ListSecurityProfileFlowModulesResponseA list of Flow Modules an AI Agent can invoke as a tool
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.
module ListSecurityProfilePermissionsResponse =
Values_2.ListSecurityProfilePermissionsResponseLists 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.
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.
Contains information about a security profile.
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.
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.
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.
Lists task templates for the specified Amazon Connect instance.
Contains summary information about the task template.
Lists task templates for the specified Amazon Connect instance.
Lists detailed steps of test case execution that includes all observations along with actions taken and data associated in the specified Amazon Connect instance.
Lists detailed steps of test case execution that includes all observations along with actions taken and data associated in the specified Amazon Connect instance.
Lists all test case executions and allows filtering by test case id, test case name, start time, end time or status of the execution for the specified Amazon Connect instance.
Contains information about a test case execution.
Lists all test case executions and allows filtering by test case id, test case name, start time, end time or status of the execution for the specified Amazon Connect instance.
Lists the test cases present in the specific Amazon Connect instance.
Contains summary information about a test case.
Lists the test cases present in the specific Amazon Connect instance.
module ListTrafficDistributionGroupUsersRequest =
Values_2.ListTrafficDistributionGroupUsersRequestLists traffic distribution group users.
Summary information about a traffic distribution group user.
module TrafficDistributionGroupUserSummaryList =
Values_2.TrafficDistributionGroupUserSummaryListmodule ListTrafficDistributionGroupUsersResponse =
Values_2.ListTrafficDistributionGroupUsersResponseLists traffic distribution group users.
Lists traffic distribution groups.
Information about traffic distribution groups.
Lists traffic distribution groups.
Provides summary information about the use cases for the specified integration association.
Contains the use case.
Lists the use cases for the integration association.
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.
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.
Retrieves a paginated list of notifications for a specific user, including the notification status for that user.
Summary information about a notification for a specific user, including the user's read status.
Retrieves a paginated list of notifications for a specific user, including the notification status for that user.
Lists proficiencies associated with a user.
Lists proficiencies associated with a user.
Provides summary information about the users for the specified Amazon Connect instance.
Contains summary information about a user.
Provides summary information about the users for the specified Amazon Connect instance.
Returns all the available versions for the specified Amazon Connect instance and view identifier. Results will be sorted from highest to lowest.
A summary of a view version's metadata.
Returns all the available versions for the specified Amazon Connect instance and view identifier. Results will be sorted from highest to lowest.
Returns views in the given instance. Results are sorted primarily by type, and secondarily by name.
A summary of a view's metadata.
Returns views in the given instance. Results are sorted primarily by type, and secondarily by name.
Lists media assets (such as logos) associated with a workspace.
Contains information about a media asset used in a workspace.
Lists media assets (such as logos) associated with a workspace.
Lists the page configurations in a workspace, including the views assigned to each page.
Contains information about a page configuration in a workspace, including the view assigned to the page.
Lists the page configurations in a workspace, including the views assigned to each page.
Lists the workspaces in an Amazon Connect instance.
Contains summary information about a workspace.
Lists the workspaces in an Amazon Connect instance.
Maximum number (1000) of tags have been returned with current request. Consider changing request parameters to get more tags.
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.
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.
The search criteria based on the contact name
The customer's details.
Payload of chat properties to apply when starting a new contact.
module NotificationSearchConditionList =
Values_2.NotificationSearchConditionListmodule NotificationSearchCriteria = Values_2.NotificationSearchCriteriaThe search criteria to be used to return notifications.
Filters to apply when searching for notifications.
Summary information about a notification returned from a search operation.
Information about the additional recipients of outbound email.
The contact is not permitted.
Information about the template attributes.
Information about template message configuration.
Information about the raw email body content.
Information about email body content.
The configuration of the participant.
Allows pausing an ongoing task contact.
Allows pausing an ongoing task contact.
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.
module PredefinedAttributeSearchConditionList =
Values_2.PredefinedAttributeSearchConditionListmodule PredefinedAttributeSearchCriteria =
Values_2.PredefinedAttributeSearchCriteriaThe search criteria to be used to return predefined attributes.
module PromptSearchConditionList = Values_2.PromptSearchConditionListmodule PromptSearchCriteria = Values_2.PromptSearchCriteriaThe search criteria to be used to return prompts.
Filters to be applied to search results.
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.
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.
Information about a queue.
module QueueSearchConditionList = Values_2.QueueSearchConditionListmodule QueueSearchCriteria = Values_2.QueueSearchCriteriaThe 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.
module QuickConnectSearchConditionList =
Values_2.QuickConnectSearchConditionListmodule QuickConnectSearchCriteria = Values_2.QuickConnectSearchCriteriaThe search criteria to be used to return quick connects.
Filters to be applied to search results.
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.
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.
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.
The search criteria to be used to return tags.
The search criteria to be used to search tags.
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.
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.
Allows resuming a task contact in a paused state.
Allows resuming a task contact in a paused state.
Specify whether this routing criteria step should apply for only a limited amount of time, or if it should never expire.
Step defines the list of agents to be routed or route based on the agent requirements such as ProficiencyLevel, Name, or Value.
An object to define the RoutingCriteria.
module RoutingProfileSearchConditionList =
Values_2.RoutingProfileSearchConditionListmodule RoutingProfileSearchCriteria = Values_2.RoutingProfileSearchCriteriaThe 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.
Searches AgentStatuses in an Amazon Connect instance, with optional filtering.
Searches AgentStatuses in an Amazon Connect instance, with optional filtering.
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 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 contact evaluations in an Amazon Connect instance, with optional filtering. Use cases Following are common uses cases for this API: Find contact evaluations by using specific search criteria. Find contact evaluations that are tagged with a specific set of tags. Important things to know A Search operation, unlike a List operation, takes time to index changes to resource (create, update or delete). If you don't see updated information for recently changed contact evaluations, try calling the API again in a few seconds. Endpoints: See Amazon Connect endpoints and quotas.
Searches contact evaluations in an Amazon Connect instance, with optional filtering. Use cases Following are common uses cases for this API: Find contact evaluations by using specific search criteria. Find contact evaluations that are tagged with a specific set of tags. Important things to know A Search operation, unlike a List operation, takes time to index changes to resource (create, update or delete). If you don't see updated information for recently changed contact evaluations, try calling the API again in a few seconds. Endpoints: See Amazon Connect endpoints and quotas.
Searches the flow modules in an Amazon Connect instance, with optional filtering.
Searches the flow modules in an Amazon Connect instance, with optional filtering.
Searches the flows in an Amazon Connect instance, with optional filtering.
Searches the flows in an Amazon Connect instance, with optional filtering.
The timestamp condition indicating which contact timestamp should be used and how it should be filtered. It is not an actual timestamp value.
A structure of time range that you want to search results.
module SearchContactsAdditionalTimeRangeCriteria =
Values_2.SearchContactsAdditionalTimeRangeCriteriaThe criteria of the time range to additionally filter on.
module SearchContactsAdditionalTimeRangeCriteriaList =
Values_2.SearchContactsAdditionalTimeRangeCriteriaListTime range that you additionally want to filter on. This is different from the SearchContactsTimeRange data type.
A structure that defines the field name to sort by and a sort order.
The search criteria based on searchable segment attribute key and values to search on.
module SearchableSegmentAttributesCriteriaList =
Values_2.SearchableSegmentAttributesCriteriaListThe search criteria based on searchable segment attributes of a contact
The agent criteria to search for preferred agents on the routing criteria.
Routing criteria of the contact to match on.
Routing criteria of the contact to match on.
The search criteria based on user-defined contact attribute key and values to search on.
module SearchableContactAttributesCriteriaList =
Values_2.SearchableContactAttributesCriteriaListA structure that defines search criteria based on user-defined contact attributes that are configured for contact search.
A structure of search criteria to be used to return contacts.
Searches contacts in an Amazon Connect instance.
Searches contacts in an Amazon Connect instance.
Searches for data tables based on the table's ID, name, and description. In the future, this operation can support searching on attribute names and possibly primary values. Follows other search operations closely and supports both search criteria and filters.
Searches for data tables based on the table's ID, name, and description. In the future, this operation can support searching on attribute names and possibly primary values. Follows other search operations closely and supports both search criteria and filters.
Searches email address in an instance, with optional filtering.
Searches email address in an instance, with optional filtering.
Searches evaluation forms in an Amazon Connect instance, with optional filtering. Use cases Following are common uses cases for this API: List all evaluation forms in an instance. Find all evaluation forms that meet specific criteria, such as Title, Description, Status, and more. Find all evaluation forms that are tagged with a specific set of tags. Important things to know A Search operation, unlike a List operation, takes time to index changes to resource (create, update or delete). If you don't see updated information for recently changed contact evaluations, try calling the API again in a few seconds. Endpoints: See Amazon Connect endpoints and quotas.
Searches evaluation forms in an Amazon Connect instance, with optional filtering. Use cases Following are common uses cases for this API: List all evaluation forms in an instance. Find all evaluation forms that meet specific criteria, such as Title, Description, Status, and more. Find all evaluation forms that are tagged with a specific set of tags. Important things to know A Search operation, unlike a List operation, takes time to index changes to resource (create, update or delete). If you don't see updated information for recently changed contact evaluations, try calling the API again in a few seconds. Endpoints: See Amazon Connect endpoints and quotas.
module SearchHoursOfOperationOverridesRequest =
Values_2.SearchHoursOfOperationOverridesRequestSearches the hours of operation overrides.
module SearchHoursOfOperationOverridesResponse =
Values_2.SearchHoursOfOperationOverridesResponseSearches the hours of operation overrides.
Searches the hours of operation in an Amazon Connect instance, with optional filtering.
Searches the hours of operation in an Amazon Connect instance, with optional filtering.
Searches for notifications based on specified criteria and filters. Returns a paginated list of notifications matching the search parameters, ordered by descending creation time. Supports filtering by content and tags.
Searches for notifications based on specified criteria and filters. Returns a paginated list of notifications matching the search parameters, ordered by descending creation time. Supports filtering by content and tags.
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.
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.
Searches prompts in an Amazon Connect instance, with optional filtering.
Searches prompts in an Amazon Connect instance, with optional filtering.
Searches queues in an Amazon Connect instance, with optional filtering.
Searches queues in an Amazon Connect instance, with optional filtering.
Searches quick connects in an Amazon Connect instance, with optional filtering.
Searches quick connects in an Amazon Connect instance, with optional filtering.
Searches tags used in an Amazon Connect instance using optional search criteria.
A tag set contains tag key and tag value.
Searches tags used in an Amazon Connect instance using optional search criteria.
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 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.
Filters to be applied to search results.
module SecurityProfileSearchConditionList =
Values_2.SecurityProfileSearchConditionListmodule SecurityProfileSearchCriteria = Values_2.SecurityProfileSearchCriteriaThe 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.
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.
Information about the returned security profiles.
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.
Filters to be applied to search results.
module TestCaseSearchConditionList = Values_2.TestCaseSearchConditionListmodule TestCaseSearchCriteria = Values_2.TestCaseSearchCriteriaThe search criteria to be used to return test cases.
Searches for test cases in the specified Amazon Connect instance, with optional filtering.
Searches for test cases in the specified Amazon Connect instance, with optional filtering.
Filters to be applied to search results.
module UserHierarchyGroupSearchConditionList =
Values_2.UserHierarchyGroupSearchConditionListmodule UserHierarchyGroupSearchCriteria =
Values_2.UserHierarchyGroupSearchCriteriaThe search criteria to be used to return userHierarchyGroup.
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 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.
Filters to be applied to search results.
module UserSearchConditionList = Values_2.UserSearchConditionListmodule UserSearchCriteria = Values_2.UserSearchCriteriaThe 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.
Searches users in an Amazon Connect instance, with optional filtering. AfterContactWorkTimeLimit is returned in milliseconds.
The user's first name and last name.
Information about the returned users.
Searches users in an Amazon Connect instance, with optional filtering. AfterContactWorkTimeLimit is returned in milliseconds.
Defines filters to apply when searching for views, such as tag-based filters.
module ViewSearchConditionList = Values_2.ViewSearchConditionListmodule ViewSearchCriteria = Values_2.ViewSearchCriteriaDefines the search criteria for filtering views.
Searches views based on name, description, or tags.
Searches views based on name, description, or tags.
Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.
Contains summary information about the custom vocabulary.
Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.
Defines filters to apply when searching for workspace associations, such as tag-based filters.
module WorkspaceAssociationSearchConditionList =
Values_2.WorkspaceAssociationSearchConditionListmodule WorkspaceAssociationSearchCriteria =
Values_2.WorkspaceAssociationSearchCriteriaDefines the search criteria for filtering workspace associations.
Searches for workspace associations with users or routing profiles based on various criteria.
Contains summary information about a workspace association with a user or routing profile.
Searches for workspace associations with users or routing profiles based on various criteria.
Defines filters to apply when searching for workspaces, such as tag-based filters.
module WorkspaceSearchConditionList = Values_2.WorkspaceSearchConditionListmodule WorkspaceSearchCriteria = Values_2.WorkspaceSearchCriteriaDefines the search criteria for filtering workspaces.
Searches workspaces based on name, description, visibility, or tags.
Contains summary information about a workspace returned from a search operation.
Searches workspaces based on name, description, visibility, or tags.
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.
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.
Information about the campaign.
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.
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.
Fields required when uploading an attached file.
Response from StartAttachedFileUpload API.
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: Concepts: Web and mobile messaging capabilities in Amazon Connect Amazon Connect Chat security best practices
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: Concepts: Web and mobile messaging capabilities in Amazon Connect Amazon Connect Chat security best practices
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 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.
Enables in-flight message processing for an ongoing chat session. Message processing will stay active for the rest of the chat, even if an individual contact segment ends.
Enables in-flight message processing for an ongoing chat session. Message processing will stay active for the rest of the chat, even if an individual contact segment ends.
Contains information about the recording configuration settings.
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.
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.
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: Concepts: Web and mobile messaging capabilities in Amazon Connect Amazon Connect Chat security best practices
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: Concepts: Web and mobile messaging capabilities in Amazon Connect Amazon Connect Chat security best practices
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.
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.
Initiates a new outbound SMS or WhatsApp contact to a customer. Response of this API provides the ContactId of the outbound SMS or WhatsApp 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 contact created. This API can be used to initiate outbound SMS or WhatsApp contacts for an agent, or it can also deflect an ongoing contact to an outbound SMS or WhatsApp contact by using the StartOutboundChatContact Flow Action. For more information about using SMS or WhatsApp in Amazon Connect, see the following topics in the Amazon Connect Administrator Guide: Set up SMS messaging Request an SMS-enabled phone number through Amazon Web Services End User Messaging SMS Set up WhatsApp Business messaging
Initiates a new outbound SMS or WhatsApp contact to a customer. Response of this API provides the ContactId of the outbound SMS or WhatsApp 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 contact created. This API can be used to initiate outbound SMS or WhatsApp contacts for an agent, or it can also deflect an ongoing contact to an outbound SMS or WhatsApp contact by using the StartOutboundChatContact Flow Action. For more information about using SMS or WhatsApp in Amazon Connect, see the following topics in the Amazon Connect Administrator Guide: Set up SMS messaging Request an SMS-enabled phone number through Amazon Web Services End User Messaging SMS Set up WhatsApp Business messaging
Initiates a flow to send an agent reply or outbound email contact (created from the CreateContact API) to a customer.
Initiates a flow to send an agent reply or outbound email contact (created from the CreateContact API) to a customer.
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. Dialing timeout for this operation can be configured with the “RingTimeoutInSeconds” parameter. If not specified, the default dialing timeout will be 60 seconds which means if the call is not connected within 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. For Preview dialing mode, only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API with OutboundStrategy.
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. Dialing timeout for this operation can be configured with the “RingTimeoutInSeconds” parameter. If not specified, the default dialing timeout will be 60 seconds which means if the call is not connected within 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. For Preview dialing mode, only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API with OutboundStrategy.
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.
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.
Information about the task attachment files.
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.
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.
Starts executing a published test case.
Starts executing a published test case.
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).
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).
Stops in-flight message processing for an ongoing chat session.
Stops in-flight message processing for an ongoing chat session.
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.
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.
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.
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.
Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.
Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.
Stops a running test execution.
Stops a running test execution.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Removes the specified tags from the specified resource.
Updates agent status.
module UpdateAttachedFilesConfigurationRequest =
Values_2.UpdateAttachedFilesConfigurationRequestUpdates the attached files configuration for the specified Amazon Connect instance and attachment scope. If no instance-specific configuration exists, this operation creates one. Partial updates are supported—only specified fields are updated, while unspecified fields retain their current values.
module UpdateAttachedFilesConfigurationResponse =
Values_2.UpdateAttachedFilesConfigurationResponseUpdates the attached files configuration for the specified Amazon Connect instance and attachment scope. If no instance-specific configuration exists, this operation creates one. Partial updates are supported—only specified fields are updated, while unspecified fields retain their current values.
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.
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.
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.
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 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 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.
Updates metadata about specified flow.
Updates a specific Aliases metadata, including the version it’s tied to, it’s name, and description.
Updates a specific Aliases metadata, including the version it’s tied to, it’s name, and description.
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.
module UpdateContactFlowModuleContentResponse =
Values_2.UpdateContactFlowModuleContentResponseUpdates 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.
module UpdateContactFlowModuleMetadataRequest =
Values_2.UpdateContactFlowModuleMetadataRequestUpdates metadata about specified flow module.
module UpdateContactFlowModuleMetadataResponse =
Values_2.UpdateContactFlowModuleMetadataResponseUpdates metadata about specified flow module.
The name of the flow. You can also create and update flows using the Amazon Connect Flow language.
The name of the flow. You can also create and update flows using the Amazon Connect Flow language.
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.
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.
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 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.
Updates the scheduled time of a task contact that is already scheduled.
Updates all properties for an attribute using all properties from CreateDataTableAttribute. There are no other granular update endpoints. It does not act as a patch operation - all properties must be provided. System managed attributes are not mutable by customers. Changing an attribute's validation does not invalidate existing values since validation only runs when values are created or updated.
Updates all properties for an attribute using all properties from CreateDataTableAttribute. There are no other granular update endpoints. It does not act as a patch operation - all properties must be provided. System managed attributes are not mutable by customers. Changing an attribute's validation does not invalidate existing values since validation only runs when values are created or updated.
Updates the metadata properties of a data table. Accepts all fields similar to CreateDataTable, except for fields and tags. There are no other granular update endpoints. It does not act as a patch operation - all properties must be provided or defaults will be used. Fields follow the same requirements as CreateDataTable.
Updates the metadata properties of a data table. Accepts all fields similar to CreateDataTable, except for fields and tags. There are no other granular update endpoints. It does not act as a patch operation - all properties must be provided or defaults will be used. Fields follow the same requirements as CreateDataTable.
Updates the primary values for a record. This operation affects all existing values that are currently associated to the record and its primary values. Users that have restrictions on attributes and/or primary values are not authorized to use this endpoint. The combination of new primary values must be unique within the table.
Updates the primary values for a record. This operation affects all existing values that are currently associated to the record and its primary values. Users that have restrictions on attributes and/or primary values are not authorized to use this endpoint. The combination of new primary values must be unique within the table.
Updates an email address metadata. For more information about email addresses, see Create email addresses in the Amazon Connect Administrator Guide.
Updates an email address metadata. For more information about email addresses, see Create email addresses in the Amazon Connect Administrator Guide.
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.
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.
Update the hours of operation override.
Updates the hours of operation.
This API is in preview release for Amazon Connect and is subject to change. Updates the value for the specified attribute type.
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.
Updates the localized content of an existing notification. This operation applies to all users for whom the notification was sent.
The response from updating notification content.
module UpdateParticipantAuthenticationRequest =
Values_2.UpdateParticipantAuthenticationRequestInstructs 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.
module UpdateParticipantAuthenticationResponse =
Values_2.UpdateParticipantAuthenticationResponseInstructs 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.
module UpdateParticipantRoleConfigChannelInfo =
Values_2.UpdateParticipantRoleConfigChannelInfoConfiguration information for the chat participant role.
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.
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.
Updates a phone number’s metadata. To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.
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 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 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.
Updates a prompt.
Updates a prompt.
Updates the hours of operation for the specified queue.
Updates the maximum number of contacts allowed in a queue before it is considered full.
Updates the name and description of a queue. At least Name or Description must be provided.
module UpdateQueueOutboundCallerConfigRequest =
Values_2.UpdateQueueOutboundCallerConfigRequestUpdates 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.
Updates the status of the queue.
Updates the configuration settings for the specified quick connect.
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.
module UpdateRoutingProfileAgentAvailabilityTimerRequest =
Values_2.UpdateRoutingProfileAgentAvailabilityTimerRequestWhether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
module UpdateRoutingProfileConcurrencyRequest =
Values_2.UpdateRoutingProfileConcurrencyRequestUpdates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
module UpdateRoutingProfileDefaultOutboundQueueRequest =
Values_2.UpdateRoutingProfileDefaultOutboundQueueRequestUpdates the default outbound queue of a routing profile.
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.
Updates a rule for the specified Amazon Connect instance. Use the Rules Function language to code conditions for the rule.
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.
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.
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.
Updates any of the metadata for a test case, such as the name, description, and status or content of an existing test case. This API doesn't allow customers to update the tags of the test case resource for the specified Amazon Connect instance.
Updates any of the metadata for a test case, such as the name, description, and status or content of an existing test case. This API doesn't allow customers to update the tags of the test case resource for the specified Amazon Connect instance.
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. Important things to know Invoke the UpdateTrafficDistribution API in the region that should handle traffic.
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. Important things to know Invoke the UpdateTrafficDistribution API in the region that should handle traffic.
Updates the configuration settings for the specified user, including per-channel auto-accept and after contact work (ACW) timeout settings. This operation replaces the UpdateUserPhoneConfig API. While UpdateUserPhoneConfig applies the same ACW timeout to all channels, UpdateUserConfig allows you to set different auto-accept and ACW timeout values for each channel type.
Updates the name of the user hierarchy group.
Assigns the specified hierarchy group to the specified user.
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
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 status of a notification for a specific user, such as marking it as read or hidden. Users can only update notification status for notifications that have been sent to them. READ status deprioritizes the notification and greys it out, while HIDDEN status removes it from the notification widget.
The response from updating a user's notification status.
Updates the phone configuration settings for the specified user. We recommend using the UpdateUserConfig API, which supports additional functionality that is not available in the UpdateUserPhoneConfig API, such as voice enhancement settings and per-channel configuration for auto-accept and After Contact Work (ACW) timeouts. In comparison, the UpdateUserPhoneConfig API will always set the same ACW timeouts to all channels the user handles.
Updates the properties associated with the proficiencies of a user.
Assigns the specified routing profile to the specified user.
Assigns the specified security profiles to the specified user.
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 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.
Updates the view metadata. Note that either Name or Description must be provided.
Updates the metadata of a workspace, such as its name and description.
Updates the metadata of a workspace, such as its name and description.
Updates the configuration of a page in a workspace, including the associated view and input data.
Updates the configuration of a page in a workspace, including the associated view and input data.
Updates the theme configuration for a workspace, including colors and styling.
Updates the theme configuration for a workspace, including colors and styling.
Updates the visibility setting of a workspace, controlling whether it is available to all users, assigned users only, or none.
Updates the visibility setting of a workspace, controlling whether it is available to all users, assigned users only, or none.