Awso_connect.Values_0Sourceval 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.
Countdown 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.
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 : sig ... endmodule AgentStatusSearchCriteria : sig ... endThe 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.
Reason 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.
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.
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.
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.
Associates a flow with a phone number claimed to your Amazon Connect instance. If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.
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.
Contains information about the queue and channel for manual assignment behaviour can be enabled.
Associates 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.
The 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.
Associates an agent with a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
Associates 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.
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 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.
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.
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.
A batch create data table value failure result.
A 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.
A batch create data table value success result.
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.
A batch delete data table value failure result.
A 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.
A batch delete data table value success result.
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.
A batch describe data table value failure result.
A 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.
A batch describe data table value success result.
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.
Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
Removes 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.
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.
A batch update data table value failure result.
Updates 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 batch update data table value success result.
Updates 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.
Information required to join the call.
Information about Amazon Connect Wisdom.
Information about the task template used to create this contact.
module SegmentAttributeValue : sig ... endA value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
module SegmentAttributeValueList : sig ... endmodule SegmentAttributeValueMap : sig ... endmodule Expression : sig ... endA tagged union to specify expression for a routing step.
module Expressions : sig ... endLatest 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 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.
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 : sig ... endmodule ContactFlowModuleSearchCriteria : sig ... endThe 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 : sig ... endmodule ContactFlowSearchCriteria : sig ... endThe 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.
The value of a segment attribute. This is structured as a map with a single key-value pair. The key 'valueString' indicates that the attribute type is a string, and its corresponding value is the actual string value of the segment attribute.
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.
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.
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.
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.
The value information for an evaluation review notification recipient.
Information about a recipient who should be notified when an evaluation review is requested.
Configuration 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.
A question automation answer.
Information about the automation configuration in text questions.
Information about properties for a text question in an evaluation form.
Information about the automation configuration in single select questions.
Information about the automation option based on a rule category for a single select question.
Information about the automation option of a single select question.
Information about the automation configuration in single select questions. Automation options are evaluated in order, and the first matched option is applied. If no automation option matches, and there is a default option, then the default option is applied.
Information about the options in single select questions.
Information about the option range used for scoring in numeric questions.
Information about the property value used in automation of a numeric questions. Label values are associated with minimum and maximum values for the numeric question. Sentiment scores have a minimum value of -5 and maximum value of 5. Duration labels, such as NON_TALK_TIME, CONTACT_DURATION, AGENT_INTERACTION_DURATION, CUSTOMER_HOLD_TIME have a minimum value of 0 and maximum value of 63072000. Percentages have a minimum value of 0 and maximum value of 100. NUMBER_OF_INTERRUPTIONS has a minimum value of 0 and maximum value of 1000.
Information about the automation configuration in numeric questions.
Information about properties for a numeric question in an evaluation form.
An option for a multi-select question in an evaluation form.
Automation rule for multi-select questions based on rule categories.
An automation option for a multi-select question.
Automation configuration for multi-select questions.
Properties 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.
An enablement expression source value.
An enablement expression source item.
An expression that defines a basic building block of conditional enablement.
module EvaluationFormItemEnablementCondition : sig ... endA condition for item enablement.
module EvaluationFormItemEnablementConditionOperand : sig ... endAn operand of the enablement condition.
module EvaluationFormItemEnablementConditionOperandList : sig ... endAn item enablement configuration.
Information about a question from an evaluation form.
module EvaluationFormItem : sig ... endInformation about an item from an evaluation form. The item must be either a section or a question.
module EvaluationFormItemsList : sig ... endmodule EvaluationFormSection : sig ... endInformation 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).
The 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.
The 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.
Creates 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.
Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide.
Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide.
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.
Creates registration for a device token and a chat contact to receive real-time push notifications. For more information about push notifications, see Set up push notifications in Amazon Connect for mobile chat in the Amazon Connect Administrator Guide.
Creates registration for a device token and a chat contact to receive real-time push notifications. For more information about push notifications, see Set up push notifications in Amazon Connect for mobile chat in the Amazon Connect Administrator Guide.
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.
A 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.
The 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.
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.
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.