Package-level declarations
Types
You do not have sufficient permissions to perform this action.
Information about an action.
List of additional email addresses for an email contact.
The distribution of agents between the instance and its replica(s).
Information about the contact associated to the user.
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 quality of the Agent's media connection
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.
Contains information about an agent status.
Information about the agent's status.
The search criteria to be used to return agent statuses.
Filters to be applied to search results.
Summary information for an agent status.
Information about the capabilities enabled for participants of the contact.
This API is in preview release for Amazon Connect and is subject to change.
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.
This action must be set if TriggerEventSource
is one of the following values: OnPostCallAnalysisAvailable
| OnRealTimeCallAnalysisAvailable
| OnRealTimeChatAnalysisAvailable
| OnPostChatAnalysisAvailable
. Contact is categorized using the rule name.
The AssignSla action definition.
Contact summary of a contact in contact tree associated with unique identifier.
Information about the attached file.
Error describing a failure to retrieve attached file metadata through BatchGetAttachedFileMetadata action.
Information about a reference when the referenceType
is ATTACHMENT
. Otherwise, null.
A list of conditions which would be applied together with an AND
condition.
An object to specify the predefined attribute condition.
Has audio-specific configurations as the operating parameter for Echo Reduction.
Contains information for score and potential quality issues for Audio
This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web ServicesSupport.
This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web ServicesSupport.
Information about available phone numbers.
The SLA configuration for Case SlaAssignmentType.
Information about the overall participant interactions at the contact level.
A chat message.
Information about how agent, bot, and customer interact in a chat contact.
Configuration information for the chat participant role.
The streaming configuration, such as the Amazon SNS streaming endpoint.
Information about a phone number that has been claimed to your Amazon Connect instance or traffic distribution group.
A list of conditions which would be applied together with an AND
condition.
Request to CompleteAttachedFileUpload API
Response from CompleteAttachedFileUpload API
Request processing failed because dependent condition failed.
Operation cannot be performed at this time as there is a conflict with another operation or contact state.
Base class for all service related exceptions thrown by the Connect client
Information required to join the call.
A structure that defines search criteria for contacts using analysis outputs from Amazon Connect Contact Lens.
The contact configuration for push notification registration.
Request object with information to create a contact.
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.
Information about the contact evaluations where the key is the FormId, which is a unique identifier for the form.
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.
Contains information about a flow module.
The search criteria to be used to return flow modules.
The search criteria to be used to return flow modules.
Contains summary information about a flow.
The flow has not been published.
The search criteria to be used to return flows.
Filters to be applied to search results.
Contains summary information about a flow.
A summary of a flow version's metadata.
The contact with the specified ID is not active or does not exist. Applies to Voice calls only, not to Chat or Task contacts.
Information of returned contact.
Information about the agent who accepted the contact.
If this contact was queued, this contains information about the queue.
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.
An object that can be used to specify Tag conditions inside the SearchFilter
. This accepts an OR
or AND
(List of List) input where:
An object that can be used to specify Tag conditions inside the SearchFilter
. This accepts an OR
of AND
(List of List) input where:
An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the SearchFilter
.
The CreateCase
action definition.
Information on the identity that created the file.
Contains credentials to use for federation.
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 a real-time metric. For a description of each metric, see Metrics definitions in the Amazon Connect Administrator Guide.
Contains the data for a real-time metric.
The current metric names.
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.
Information about the quality of the Customer's media connection
Information about customer’s voice activity.
An object to specify the hours of operation override date condition.
Information about a reference when the referenceType
is DATE
. Otherwise, null.
Contains information about a default vocabulary.
Request to DeleteAttachedFile API
Response from DeleteAttachedFile API
Outbound calls to the destination number are not allowed.
Information regarding the device.
Contains information about the dimensions for a set of metrics.
Information about the call disconnect experience.
Contains details about why a contact was disconnected. Only Amazon Connect outbound campaigns can provide this field.
Information about a traffic distribution.
Metadata used to download the attached file.
A resource with the specified name already exists.
Information about the hours of operations with the effective override applied.
Contains information about a source or destination email address.
Contains information about an email address for a contact center.
The 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 the email recipient
Information about a reference when the referenceType
is EMAIL
. Otherwise, null.
An empty value.
The encryption configuration.
End associated tasks related to a case.
Information about the endpoint.
This API is in preview release for Amazon Connect and is subject to change.
Information about a contact evaluation.
Information about answer data for a contact evaluation. Answer data must be either string, numeric, or not applicable.
Information about input answers for a contact evaluation.
Information about output answers for a contact evaluation.
Information about the evaluation form.
Information about an evaluation form used in a contact evaluation.
Information about an item from an evaluation form. The item must be either a section or a question.
Information about the automation configuration in numeric questions.
Information about the option range used for scoring in numeric questions.
Information about properties for a numeric question in an evaluation form.
Information about a question from 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.
Information about scoring strategy for an evaluation form.
Information about a section from an evaluation form. A section can contain sections and/or questions. Evaluation forms can only contain sections and subsections (two level nesting).
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 automation option of a single select question.
Information about the automation configuration in single select questions.
Information about the options in single select questions.
Summary information about an evaluation form.
Summary information about an evaluation form.
Metadata information about a contact evaluation.
Information about notes for a contact evaluation.
Information about scores of a contact evaluation item (section or question).
Summary information about a contact evaluation.
The EventBridge action definition.
A tagged union to specify expression for a routing step.
Request for which contact failed to be generated.
Object for case field values.
Object to store union of Field values.
Contains the filter to apply when retrieving metrics with the GetMetricDataV2 API.
Information about flow associations.
Request to GetAttachedFile API.
Response from GetAttachedFile API.
Contains information about a hierarchy group.
A leaf node condition which can be used to specify a hierarchy group condition.
Information about the agent hierarchy. Hierarchies can be configured with up to five levels.
Contains summary information about a hierarchy group.
Information about the hierarchy group.
Contains information about a hierarchy level.
Contains information about the hierarchy level to update.
Contains information about the levels of a hierarchy group.
Information about the levels in the hierarchy group.
Contains information about a hierarchy structure.
Contains information about the level hierarchy to update.
Contains information about a historical metric. For a description of each metric, see Metrics definitions in the Amazon Connect Administrator Guide.
Contains the data for a historical metric.
The historical metric names.
Contains information about the historical metrics retrieved.
Information about of the hours of operation.
Contains information about the hours of operation.
Information about the hours of operations override.
Information about the hours of operation override config: day, start time, and end time.
The search criteria to be used to return hours of operations overrides.
The 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.
The start time or end time for an hours of operation.
An entity with the same name already exists.
Information about the additional TO and CC recipients of an inbound email contact.
Information about email body content.
Information about the raw email body content.
Relevant details why the instance was not successfully created.
The storage configuration for the instance.
Information about the instance.
Contains summary information about the associated AppIntegrations.
Request processing failed because of an error or failure with the service.
Information about the interval period to use for returning results.
The flow is not valid.
The problems with the module. Please fix before trying again.
One or more of the specified parameters are not valid.
The request is not valid.
Reason why the request was invalid.
A field that is invisible to an agent.
Configuration information of a Kinesis Data Firehose delivery stream.
Configuration information of a Kinesis data stream.
Configuration information of a Kinesis video stream.
Configuration information of an Amazon Lex or Amazon Lex V2 bot.
The allowed limit for the resource has been exceeded.
A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.
Information about phone numbers that have been claimed to your Amazon Connect instance or traffic distribution group.
Provides summary information about the use cases for the specified integration association.
An object to define AgentsCriteria.
Maximum number (1000) of tags have been returned with current request. Consider changing request parameters to get more tags.
Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.
A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.
The configuration settings of the features available to a meeting.
Contains the name, thresholds, and metric filters.
Contains information about the filter used when retrieving metrics. MetricFiltersV2
can be used on the following metrics: AVG_AGENT_CONNECTING_TIME
, CONTACTS_CREATED
, CONTACTS_HANDLED
, SUM_CONTACTS_DISCONNECTED
.
The interval period with the start and end time for the metrics.
Contains information about the metric results.
Payload of chat properties to apply when starting a new contact.
The type of notification recipient.
A leaf node condition which can be used to specify a numeric condition.
Information about a reference when the referenceType
is NUMBER
. Otherwise, null.
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.
Information about the hours of operations with the effective override applied.
Information about the additional recipients of outbound email.
The outbound caller ID name, number, and outbound whisper flow.
The contact is not permitted.
The outbound email address ID.
Information about email body content.
Information about the raw email body content.
Thrown for analyzed content when requested OutputType was not enabled for a given contact. For example, if an OutputType.Raw was requested for a contact that had RedactedOnly
Redaction policy set in the flow.
The start time or end time for an hours of operation override.
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.
The customer's details.
The details to add for the participant.
Information about a participant's interactions in a contact.
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.
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.
The credentials used by the participant.
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.
Contains information about a phone number for a quick connect.
The status of the phone number.
Contains summary information about a phone number for a contact center.
Information about a predefined attribute.
The search criteria to be used to return predefined attributes.
Summary of a predefined attribute.
Information about values of a predefined attribute.
Information about a problem detail.
The search criteria to be used to return prompts.
Filters to be applied to search results.
Contains information about the prompt.
The property is not valid.
Contains information about why a property is not valid.
Information about the quality of the participant's media connection.
Information about a queue.
Contains information about a queue for a quick connect. The flow must be of type Transfer to Queue.
Contains information about a queue resource for which metrics are returned.
The search criteria to be used to return queues.
Filters to be applied to search results.
Contains summary information about a queue.
Contains information about a quick connect.
Contains configuration settings for a quick connect.
The search criteria to be used to return quick connects.
Filters to be applied to search results.
Contains summary information about a quick connect.
Indicates a field that is read-only to an agent.
Object that describes attached file.
Provides information about the category rule that was matched.
Begin and end offsets for a part of text.
Potential issues that are detected based on an artificial intelligence analysis of each turn in the conversation.
The section of the contact transcript segment that category rule was detected.
An analyzed segment for a real-time analysis session.
Segment containing list of attachments.
The matched category rules.
Segment type describing a contact event.
Segment type containing a list of detected issues.
Information about the post-contact summary for a real-time contact segment.
The analyzed transcript segment.
Object describing time with which the segment is associated. It can have different representations of time. Currently supported: absoluteTime
Object describing redaction applied to the segment.
Transcript representation containing Id and list of character intervals that are associated with analysis data. For example, this object within a RealTimeContactAnalysisPointOfInterest
in Category.MatchedDetails
would have character interval describing part of the text that matched category.
Transcript representation containing Id, Content and list of character intervals that are associated with analysis data. For example, this object within an issue detected would describe both content that contains identified issue and intervals where that content is taken from.
Information about a voice recording, chat transcript, or screen recording.
Contains summary information about a reference. ReferenceSummary
contains only one non null field between the URL and attachment based on the reference type.
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.
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.
Information about a required field.
A resource already has that name.
That resource is already in use. Please try another.
The specified resource was not found.
The resource is not ready.
The search criteria to be used to search tags.
Latest routing criteria on the contact.
An object to define the RoutingCriteria.
Step defines the list of agents to be routed or route based on the agent requirements such as ProficiencyLevel, Name, or Value.
Specify whether this routing criteria step should apply for only a limited amount of time, or if it should never expire.
Contains information about a routing profile.
Contains information about the queue and channel for which priority and delay can be set.
Contains summary information about a routing profile queue.
Contains the channel and queue identifier for a routing profile.
Information about the routing profile assigned to the user.
The search criteria to be used to return routing profiles.
Filters to be applied to search results.
Contains summary information about a routing profile.
Information about the action to be performed when a rule is triggered.
A list of ActionTypes
associated with a rule.
The name of the event source. This field is required if TriggerEventSource
is one of the following values: OnZendeskTicketCreate
| OnZendeskTicketStatusUpdate
| OnSalesforceCaseCreate
| OnContactEvaluationSubmit
| OnMetricDataUpdate
.
A structure that defines search criteria based on user-defined contact attributes that are configured for contact search.
The search criteria based on user-defined contact attribute key and values to search on.
The search criteria based on searchable segment attributes of a contact
The search criteria based on searchable segment attribute key and values to search on.
A structure of time range that you want to search results.
A structure of search criteria to be used to return contacts.
Configuration information of the security key.
Contains information about a security profile.
The search criteria to be used to return security profiles.
Information about the returned security profiles.
Filters to be applied to search results.
Contains information about a security profile.
A value for a segment attribute. This is structured as a map where the key is valueString
and the value is a string.
Information about the send notification action.
The service quota has been exceeded.
The reason for the exception.
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).
The distribution of sign in traffic between the instance and its replica(s).
Information about the automation option based on a rule category for a single select question.
Information about the campaign.
Response from StartAttachedFileUpload API.
Information about the state transition of a supervisor.
A leaf node condition which can be used to specify a string condition.
Information about a reference when the referenceType
is STRING
. Otherwise, null.
Information about the submit automated evaluation action.
Request for which contact was successfully created.
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123
.
The search criteria to be used to return tags.
Information about the task action.
Describes constraints that apply to the template fields.
Describes a default field and its corresponding value.
Describes default values for fields on a template.
Describes a single task template field.
The identifier of the task template field.
Contains summary information about the task template.
The distribution of traffic between the instance and its replicas.
Information about the template attributes.
Information about template message configuration.
Contains information about the threshold for service level metrics.
The throttling limit has been exceeded.
Displayed when rate-related API limits are exceeded.
Information about a traffic distribution group.
Information about traffic distribution groups.
Summary information about a traffic distribution group user.
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 base on words or phrases, participants in the Contact Lens conversational analytics transcript.
The UpdateCase
action definition.
Configuration information for the chat participant role.
Fields required when uploading an attached file.
The URL reference.
A filter for the user data.
The search criteria to be used to return userHierarchyGroup.
Filters to be applied to search results.
Contains information about the identity of a user.
The user's first name and last name.
No user with the specified credentials was found in the Amazon Connect instance.
Contains information about the phone configuration settings for a user.
Information about proficiency of a user.
Information about proficiency to be disassociated from the user.
Contains information about the quick connect configuration settings for a user. The contact flow must be of type Transfer to Agent.
Information about the user.
The search criteria to be used to return users.
Filters to be applied to search results.
Information about the returned users.
Contains summary information about a user.
View content containing all content necessary to render a view except for runtime input data.
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.
A summary of a view's metadata.
A summary of a view version's metadata.
Contains information about a custom vocabulary.
Contains summary information about the custom vocabulary.
Contains information about the recording configuration settings.
Information about Amazon Connect Wisdom.