Package-level declarations

Types

Link copied to clipboard

You do not have sufficient permissions to perform this action.

Link copied to clipboard

Information about an action.

Link copied to clipboard
sealed class ActionType
Link copied to clipboard

List of additional email addresses for an email contact.

Link copied to clipboard
Link copied to clipboard

The distribution of agents between the instance and its replica(s).

Link copied to clipboard

Information about the contact associated to the user.

Link copied to clipboard

Information about an agent hierarchy group.

Link copied to clipboard

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.

Link copied to clipboard
class AgentInfo

Information about the agent who accepted the contact.

Link copied to clipboard

Information about the quality of the Agent's media connection

Link copied to clipboard

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.

Link copied to clipboard

Contains information about an agent status.

Link copied to clipboard

Information about the agent's status.

Link copied to clipboard

The search criteria to be used to return agent statuses.

Link copied to clipboard

Filters to be applied to search results.

Link copied to clipboard
sealed class AgentStatusState
Link copied to clipboard

Summary information for an agent status.

Link copied to clipboard
sealed class AgentStatusType
Link copied to clipboard

Information about the capabilities enabled for participants of the contact.

Link copied to clipboard

This API is in preview release for Amazon Connect and is subject to change.

Link copied to clipboard

Information about datasets that are available to associate with: DataSetId, DataSetName.

Link copied to clipboard

Configuration of the answering machine detection.

Link copied to clipboard

This API is in preview release for Amazon Connect and is subject to change.

Link copied to clipboard
sealed class ArtifactStatus
Link copied to clipboard

This action must be set if TriggerEventSource is one of the following values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable. Contact is categorized using the rule name.

Link copied to clipboard

The AssignSla action definition.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Contact summary of a contact in contact tree associated with unique identifier.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Information about the attached file.

Link copied to clipboard

Error describing a failure to retrieve attached file metadata through BatchGetAttachedFileMetadata action.

Link copied to clipboard

Information about a reference when the referenceType is ATTACHMENT. Otherwise, null.

Link copied to clipboard
class Attendee

The attendee information, including attendee ID and join token.

Link copied to clipboard
class Attribute

A toggle for an individual feature at the instance level.

Link copied to clipboard

A list of conditions which would be applied together with an AND condition.

Link copied to clipboard

An object to specify the predefined attribute condition.

Link copied to clipboard

Has audio-specific configurations as the operating parameter for Echo Reduction.

Link copied to clipboard

Contains information for score and potential quality issues for Audio

Link copied to clipboard

This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web ServicesSupport.

Link copied to clipboard

This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web ServicesSupport.

Link copied to clipboard

Information about available phone numbers.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class BehaviorType
Link copied to clipboard
class Campaign

Information associated with a campaign.

Link copied to clipboard

The SLA configuration for Case SlaAssignmentType.

Link copied to clipboard
sealed class Channel
Link copied to clipboard

Information about the overall participant interactions at the contact level.

Link copied to clipboard
class ChatEvent

Chat integration event containing payload to perform different chat actions such as:

Link copied to clipboard
sealed class ChatEventType
Link copied to clipboard

A chat message.

Link copied to clipboard

Information about how agent, bot, and customer interact in a chat contact.

Link copied to clipboard

Configuration information for the chat participant role.

Link copied to clipboard

The streaming configuration, such as the Amazon SNS streaming endpoint.

Link copied to clipboard

Information about a phone number that has been claimed to your Amazon Connect instance or traffic distribution group.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

A list of conditions which would be applied together with an AND condition.

Link copied to clipboard
sealed class Comparison
Link copied to clipboard

Request to CompleteAttachedFileUpload API

Link copied to clipboard

Response from CompleteAttachedFileUpload API

Link copied to clipboard
class Condition

A leaf node condition which can be used to specify a ProficiencyName, ProficiencyValue and ProficiencyLimit.

Link copied to clipboard

Request processing failed because dependent condition failed.

Link copied to clipboard

Operation cannot be performed at this time as there is a conflict with another operation or contact state.

Link copied to clipboard

Base class for all service related exceptions thrown by the Connect client

Link copied to clipboard

Information required to join the call.

Link copied to clipboard
sealed class ConnectUnit
Link copied to clipboard
class Contact

Contains information about a contact.

Link copied to clipboard

A structure that defines search criteria for contacts using analysis outputs from Amazon Connect Contact Lens.

Link copied to clipboard

The contact configuration for push notification registration.

Link copied to clipboard

Request object with information to create a contact.

Link copied to clipboard

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.

Link copied to clipboard

Information about the contact evaluations where the key is the FormId, which is a unique identifier for the form.

Link copied to clipboard

Filters user data based on the contact information that is associated to the users. It contains a list of contact states.

Link copied to clipboard

Contains information about a flow.

Link copied to clipboard

Contains information about a flow module.

Link copied to clipboard

The search criteria to be used to return flow modules.

Link copied to clipboard

The search criteria to be used to return flow modules.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Contains summary information about a flow.

Link copied to clipboard

The flow has not been published.

Link copied to clipboard

The search criteria to be used to return flows.

Link copied to clipboard

Filters to be applied to search results.

Link copied to clipboard
sealed class ContactFlowState
Link copied to clipboard
sealed class ContactFlowStatus
Link copied to clipboard

Contains summary information about a flow.

Link copied to clipboard
sealed class ContactFlowType
Link copied to clipboard

A summary of a flow version's metadata.

Link copied to clipboard
Link copied to clipboard

The contact with the specified ID is not active or does not exist. Applies to Voice calls only, not to Chat or Task contacts.

Link copied to clipboard
Link copied to clipboard

Information of returned contact.

Link copied to clipboard

Information about the agent who accepted the contact.

Link copied to clipboard

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.

Link copied to clipboard
sealed class ContactState
Link copied to clipboard

An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR or AND (List of List) input where:

Link copied to clipboard

An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR of AND (List of List) input where:

Link copied to clipboard

An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the SearchFilter.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The CreateCase action definition.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class CreatedByInfo

Information on the identity that created the file.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Contains credentials to use for federation.

Link copied to clipboard

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.

Link copied to clipboard

Contains information about a real-time metric. For a description of each metric, see Metrics definitions in the Amazon Connect Administrator Guide.

Link copied to clipboard

Contains the data for a real-time metric.

Link copied to clipboard
sealed class CurrentMetricName

The current metric names.

Link copied to clipboard

Contains information about a set of real-time metrics.

Link copied to clipboard

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.

Link copied to clipboard
class Customer

Information about the Customer on the contact.

Link copied to clipboard

Information about the quality of the Customer's media connection

Link copied to clipboard

Information about customer’s voice activity.

Link copied to clipboard
sealed class DateComparisonType
Link copied to clipboard

An object to specify the hours of operation override date condition.

Link copied to clipboard

Information about a reference when the referenceType is DATE. Otherwise, null.

Link copied to clipboard

Contains information about a default vocabulary.

Link copied to clipboard

Request to DeleteAttachedFile API

Link copied to clipboard

Response from DeleteAttachedFile API

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Outbound calls to the destination number are not allowed.

Link copied to clipboard

Information regarding the device.

Link copied to clipboard
sealed class DeviceType
Link copied to clipboard

Contains information about the dimensions for a set of metrics.

Link copied to clipboard
sealed class DirectoryType
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Information about the call disconnect experience.

Link copied to clipboard

Contains details about why a contact was disconnected. Only Amazon Connect outbound campaigns can provide this field.

Link copied to clipboard
Link copied to clipboard

Information about a traffic distribution.

Link copied to clipboard

Metadata used to download the attached file.

Link copied to clipboard

A resource with the specified name already exists.

Link copied to clipboard

Information about the hours of operations with the effective override applied.

Link copied to clipboard

Contains information about a source or destination email address.

Link copied to clipboard

Contains information about an email address for a contact center.

Link copied to clipboard

The search criteria to be used to return email addresses.

Link copied to clipboard

Filters to be applied to search results.

Link copied to clipboard

Information about the email attachment files.

Link copied to clipboard
sealed class EmailHeaderType
Link copied to clipboard

Information about the reference when the referenceType is EMAIL_MESSAGE. Otherwise, null.

Link copied to clipboard

Information about the email recipient

Link copied to clipboard

Information about a reference when the referenceType is EMAIL. Otherwise, null.

Link copied to clipboard

An empty value.

Link copied to clipboard

The encryption configuration.

Link copied to clipboard
sealed class EncryptionType
Link copied to clipboard

End associated tasks related to a case.

Link copied to clipboard
class Endpoint

Information about the endpoint.

Link copied to clipboard

Information about the endpoint.

Link copied to clipboard
sealed class EndpointType
Link copied to clipboard

This API is in preview release for Amazon Connect and is subject to change.

Link copied to clipboard

Information about a contact evaluation.

Link copied to clipboard

Information about answer data for a contact evaluation. Answer data must be either string, numeric, or not applicable.

Link copied to clipboard

Information about input answers for a contact evaluation.

Link copied to clipboard

Information about output answers for a contact evaluation.

Link copied to clipboard

Information about the evaluation form.

Link copied to clipboard

Information about an evaluation form used in a contact evaluation.

Link copied to clipboard
sealed class EvaluationFormItem

Information about an item from an evaluation form. The item must be either a section or a question.

Link copied to clipboard

Information about the automation configuration in numeric questions.

Link copied to clipboard

Information about the option range used for scoring in numeric questions.

Link copied to clipboard

Information about properties for a numeric question in an evaluation form.

Link copied to clipboard

Information about a question from an evaluation form.

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Information about scoring strategy for an evaluation form.

Link copied to clipboard

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.

Link copied to clipboard

Information about the automation configuration in single select questions.

Information about the options in single select questions.

Link copied to clipboard

Summary information about an evaluation form.

Link copied to clipboard
Link copied to clipboard

Summary information about an evaluation form.

Link copied to clipboard

Metadata information about a contact evaluation.

Link copied to clipboard

Information about notes for a contact evaluation.

Link copied to clipboard

Information about scores of a contact evaluation item (section or question).

Link copied to clipboard
sealed class EvaluationStatus
Link copied to clipboard

Summary information about a contact evaluation.

Link copied to clipboard

The EventBridge action definition.

Link copied to clipboard
sealed class EventSourceName
Link copied to clipboard
class Expiry

An object to specify the expiration of a routing step.

Link copied to clipboard

A tagged union to specify expression for a routing step.

Link copied to clipboard

Request for which contact failed to be generated.

Link copied to clipboard
sealed class FailureReasonCode
Link copied to clipboard

Object for case field values.

Link copied to clipboard

Object to store union of Field values.

Link copied to clipboard
sealed class FileStatusType
Link copied to clipboard
sealed class FileUseCaseType
Link copied to clipboard
class Filters

Contains the filter to apply when retrieving metrics.

Link copied to clipboard
class FilterV2

Contains the filter to apply when retrieving metrics with the GetMetricDataV2 API.

Link copied to clipboard
Link copied to clipboard

Information about flow associations.

Link copied to clipboard

Request to GetAttachedFile API.

Link copied to clipboard

Response from GetAttachedFile API.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class Grouping
Link copied to clipboard

Contains information about a hierarchy group.

Link copied to clipboard

A leaf node condition which can be used to specify a hierarchy group condition.

Link copied to clipboard
Link copied to clipboard

Information about the agent hierarchy. Hierarchies can be configured with up to five levels.

Link copied to clipboard

Contains summary information about a hierarchy group.

Link copied to clipboard

Information about the hierarchy group.

Link copied to clipboard

Contains information about a hierarchy level.

Link copied to clipboard

Contains information about the hierarchy level to update.

Link copied to clipboard

Contains information about the levels of a hierarchy group.

Link copied to clipboard

Information about the levels in the hierarchy group.

Link copied to clipboard

Contains information about a hierarchy structure.

Link copied to clipboard

Contains information about the level hierarchy to update.

Link copied to clipboard

Contains information about a historical metric. For a description of each metric, see Metrics definitions in the Amazon Connect Administrator Guide.

Link copied to clipboard

Contains the data for a historical metric.

Link copied to clipboard

The historical metric names.

Link copied to clipboard

Contains information about the historical metrics retrieved.

Link copied to clipboard

Information about of the hours of operation.

Link copied to clipboard

Contains information about the hours of operation.

Link copied to clipboard
Link copied to clipboard

Information about the hours of operations override.

Link copied to clipboard

Information about the hours of operation override config: day, start time, and end time.

Link copied to clipboard

The search criteria to be used to return hours of operations overrides.

Link copied to clipboard

The search criteria to be used to return hours of operations.

Link copied to clipboard

Filters to be applied to search results.

Link copied to clipboard

Contains summary information about hours of operation for a contact center.

Link copied to clipboard

The start time or end time for an hours of operation.

Link copied to clipboard

An entity with the same name already exists.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Information about the additional TO and CC recipients of an inbound email contact.

Link copied to clipboard

Information about email body content.

Link copied to clipboard
Link copied to clipboard

Information about the raw email body content.

Link copied to clipboard
sealed class InitiateAs
Link copied to clipboard
class Instance

The Amazon Connect instance.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class InstanceStatus
Link copied to clipboard

Relevant details why the instance was not successfully created.

Link copied to clipboard

The storage configuration for the instance.

Link copied to clipboard
Link copied to clipboard

Information about the instance.

Link copied to clipboard

Contains summary information about the associated AppIntegrations.

Link copied to clipboard
sealed class IntegrationType
Link copied to clipboard

Request processing failed because of an error or failure with the service.

Link copied to clipboard

Information about the interval period to use for returning results.

Link copied to clipboard
sealed class IntervalPeriod
Link copied to clipboard

The flow is not valid.

Link copied to clipboard

The problems with the module. Please fix before trying again.

Link copied to clipboard

One or more of the specified parameters are not valid.

Link copied to clipboard

The request is not valid.

Link copied to clipboard

Reason why the request was invalid.

Link copied to clipboard

A field that is invisible to an agent.

Link copied to clipboard
sealed class IvrRecordingTrack
Link copied to clipboard

Configuration information of a Kinesis Data Firehose delivery stream.

Link copied to clipboard

Configuration information of a Kinesis data stream.

Link copied to clipboard

Configuration information of a Kinesis video stream.

Link copied to clipboard
class LexBot

Configuration information of an Amazon Lex bot.

Link copied to clipboard

Configuration information of an Amazon Lex or Amazon Lex V2 bot.

Link copied to clipboard
class LexV2Bot

Configuration information of an Amazon Lex V2 bot.

Link copied to clipboard
sealed class LexVersion
Link copied to clipboard

The allowed limit for the resource has been exceeded.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Information about phone numbers that have been claimed to your Amazon Connect instance or traffic distribution group.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Provides summary information about the use cases for the specified integration association.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

An object to define AgentsCriteria.

Link copied to clipboard

Maximum number (1000) of tags have been returned with current request. Consider changing request parameters to get more tags.

Link copied to clipboard

Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.

Link copied to clipboard

A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.

Link copied to clipboard
sealed class MediaStreamType
Link copied to clipboard
class Meeting

A meeting created using the Amazon Chime SDK.

Link copied to clipboard

The configuration settings of the features available to a meeting.

Link copied to clipboard
Link copied to clipboard

Contains the name, thresholds, and metric filters.

Link copied to clipboard

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.

Link copied to clipboard

The interval period with the start and end time for the metrics.

Link copied to clipboard

Contains information about the metric results.

Link copied to clipboard
class MetricV2

Contains information about the metric.

Link copied to clipboard
sealed class MonitorCapability
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Payload of chat properties to apply when starting a new contact.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The type of notification recipient.

Link copied to clipboard
Link copied to clipboard

A leaf node condition which can be used to specify a numeric condition.

Link copied to clipboard

Information about a reference when the referenceType is NUMBER. Otherwise, null.

Link copied to clipboard

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.

Link copied to clipboard

Information about the hours of operations with the effective override applied.

Link copied to clipboard

Information about the additional recipients of outbound email.

Link copied to clipboard

The outbound caller ID name, number, and outbound whisper flow.

Link copied to clipboard

The contact is not permitted.

Link copied to clipboard

The outbound email address ID.

Link copied to clipboard

Information about email body content.

Link copied to clipboard
Link copied to clipboard

Information about the raw email body content.

Link copied to clipboard

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.

Link copied to clipboard
sealed class OverrideDays
Link copied to clipboard

The start time or end time for an hours of operation override.

Link copied to clipboard

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.

Link copied to clipboard

The customer's details.

Link copied to clipboard

The details to add for the participant.

Link copied to clipboard

Information about a participant's interactions in a contact.

Link copied to clipboard
sealed class ParticipantRole
Link copied to clipboard
sealed class ParticipantState
Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

The credentials used by the participant.

Link copied to clipboard
sealed class ParticipantType
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard

Contains information about a phone number for a quick connect.

Link copied to clipboard

The status of the phone number.

Link copied to clipboard

Contains summary information about a phone number for a contact center.

Link copied to clipboard
sealed class PhoneNumberType
Link copied to clipboard
Link copied to clipboard
sealed class PhoneType
Link copied to clipboard

Information about a predefined attribute.

Link copied to clipboard

The search criteria to be used to return predefined attributes.

Link copied to clipboard

Summary of a predefined attribute.

Link copied to clipboard

Information about values of a predefined attribute.

Link copied to clipboard

Information about a problem detail.

Link copied to clipboard
class Prompt

Information about a prompt.

Link copied to clipboard

The search criteria to be used to return prompts.

Link copied to clipboard

Filters to be applied to search results.

Link copied to clipboard

Contains information about the prompt.

Link copied to clipboard

The property is not valid.

Link copied to clipboard

Contains information about why a property is not valid.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Information about the quality of the participant's media connection.

Link copied to clipboard
class Queue

Contains information about a queue.

Link copied to clipboard
class QueueInfo

If this contact was queued, this contains information about the queue.

Link copied to clipboard

Information about a queue.

Link copied to clipboard

Contains information about a queue for a quick connect. The flow must be of type Transfer to Queue.

Link copied to clipboard

Contains information about a queue resource for which metrics are returned.

Link copied to clipboard

The search criteria to be used to return queues.

Link copied to clipboard

Filters to be applied to search results.

Link copied to clipboard
sealed class QueueStatus
Link copied to clipboard

Contains summary information about a queue.

Link copied to clipboard
sealed class QueueType
Link copied to clipboard

Contains information about a quick connect.

Link copied to clipboard

Contains configuration settings for a quick connect.

Link copied to clipboard

The search criteria to be used to return quick connects.

Link copied to clipboard

Filters to be applied to search results.

Link copied to clipboard

Contains summary information about a quick connect.

Link copied to clipboard
sealed class QuickConnectType
Link copied to clipboard
class Range

An Object to define the minimum and maximum proficiency levels.

Link copied to clipboard

Indicates a field that is read-only to an agent.

Link copied to clipboard

Object that describes attached file.

Link copied to clipboard

Provides information about the category rule that was matched.

Link copied to clipboard

Begin and end offsets for a part of text.

Link copied to clipboard

Potential issues that are detected based on an artificial intelligence analysis of each turn in the conversation.

Link copied to clipboard

The section of the contact transcript segment that category rule was detected.

Link copied to clipboard

An analyzed segment for a real-time analysis session.

Segment containing list of attachments.

Link copied to clipboard

The matched category rules.

Link copied to clipboard

Segment type describing a contact event.

Link copied to clipboard

Segment type containing a list of detected issues.

Information about the post-contact summary for a real-time contact segment.

Link copied to clipboard

The analyzed transcript segment.

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

Information about a voice recording, chat transcript, or screen recording.

Link copied to clipboard
sealed class RecordingStatus
Link copied to clipboard
class Reference

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.

Link copied to clipboard
sealed class ReferenceStatus
Link copied to clipboard
sealed class ReferenceSummary

Contains summary information about a reference. ReferenceSummary contains only one non null field between the URL and attachment based on the reference type.

Link copied to clipboard
sealed class ReferenceType
Link copied to clipboard
sealed class RehydrationType
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Information about a required field.

Link copied to clipboard

A resource already has that name.

Link copied to clipboard

That resource is already in use. Please try another.

Link copied to clipboard

The specified resource was not found.

Link copied to clipboard

The resource is not ready.

Link copied to clipboard

The search criteria to be used to search tags.

Link copied to clipboard
sealed class ResourceType
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Latest routing criteria on the contact.

Link copied to clipboard

An object to define the RoutingCriteria.

Link copied to clipboard

Step defines the list of agents to be routed or route based on the agent requirements such as ProficiencyLevel, Name, or Value.

Link copied to clipboard

Specify whether this routing criteria step should apply for only a limited amount of time,
 or if it should never expire.

Link copied to clipboard
Link copied to clipboard

Contains information about a routing profile.

Link copied to clipboard

Contains information about the queue and channel for which priority and delay can be set.

Link copied to clipboard

Contains summary information about a routing profile queue.

Link copied to clipboard

Contains the channel and queue identifier for a routing profile.

Link copied to clipboard

Information about the routing profile assigned to the user.

Link copied to clipboard

The search criteria to be used to return routing profiles.

Link copied to clipboard

Filters to be applied to search results.

Link copied to clipboard

Contains summary information about a routing profile.

Link copied to clipboard
class Rule

Information about a rule.

Link copied to clipboard

Information about the action to be performed when a rule is triggered.

Link copied to clipboard
sealed class RulePublishStatus
Link copied to clipboard

A list of ActionTypes associated with a rule.

Link copied to clipboard

The name of the event source. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate | OnContactEvaluationSubmit | OnMetricDataUpdate.

Link copied to clipboard
class S3Config

Information about the Amazon Simple Storage Service (Amazon S3) storage type.

Link copied to clipboard
Link copied to clipboard

A structure that defines search criteria based on user-defined contact attributes that are configured for contact search.

Link copied to clipboard

The search criteria based on user-defined contact attribute key and values to search on.

Link copied to clipboard
sealed class SearchableQueueType
Link copied to clipboard

The search criteria based on searchable segment attributes of a contact

Link copied to clipboard

The search criteria based on searchable segment attribute key and values to search on.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

A structure of time range that you want to search results.

Link copied to clipboard
Link copied to clipboard

A structure of search criteria to be used to return contacts.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Configuration information of the security key.

Link copied to clipboard

Contains information about a security profile.

Link copied to clipboard

The search criteria to be used to return security profiles.

Link copied to clipboard

Information about the returned security profiles.

Link copied to clipboard

Filters to be applied to search results.

Link copied to clipboard

Contains information about a security profile.

Link copied to clipboard

A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.

Link copied to clipboard

Information about the send notification action.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The service quota has been exceeded.

Link copied to clipboard

The reason for the exception.

Link copied to clipboard

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).

Link copied to clipboard

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.

Link copied to clipboard
sealed class SlaAssignmentType
Link copied to clipboard
sealed class SlaType
Link copied to clipboard
class Sort

A structure that defines the field name to sort by and a sort order.

Link copied to clipboard
sealed class SortableFieldName
Link copied to clipboard
sealed class SortOrder
Link copied to clipboard

Information about the campaign.

Link copied to clipboard
sealed class SourceType
Link copied to clipboard

Response from StartAttachedFileUpload API.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Information about the state transition of a supervisor.

Link copied to clipboard
sealed class Statistic
Link copied to clipboard
sealed class Status
Link copied to clipboard
class Step

Step signifies the criteria to be used for routing to an agent

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class StorageType
Link copied to clipboard
Link copied to clipboard

A leaf node condition which can be used to specify a string condition.

Link copied to clipboard

Information about a reference when the referenceType is STRING. Otherwise, null.

Link copied to clipboard

Information about the submit automated evaluation action.

Link copied to clipboard

Request for which contact was successfully created.

Link copied to clipboard

A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The search criteria to be used to return tags.

Link copied to clipboard
class TagSet

A tag set contains tag key and tag value.

Link copied to clipboard
sealed class TargetListType
Link copied to clipboard

Information about the task action.

Link copied to clipboard

Describes constraints that apply to the template fields.

Link copied to clipboard

Describes a default field and its corresponding value.

Link copied to clipboard

Describes default values for fields on a template.

Link copied to clipboard

Describes a single task template field.

Link copied to clipboard

The identifier of the task template field.

Link copied to clipboard
Link copied to clipboard

Contains summary information about the task template.

Link copied to clipboard
sealed class TaskTemplateStatus
Link copied to clipboard

The distribution of traffic between the instance and its replicas.

Link copied to clipboard

Information about the template attributes.

Link copied to clipboard

Information about template message configuration.

Link copied to clipboard
class Threshold

Contains information about the threshold for service level metrics.

Link copied to clipboard

Contains information about the threshold for service level metrics.

Link copied to clipboard

The throttling limit has been exceeded.

Link copied to clipboard
Link copied to clipboard

Displayed when rate-related API limits are exceeded.

Link copied to clipboard

Information about a traffic distribution group.

Link copied to clipboard
Link copied to clipboard

Information about traffic distribution groups.

Link copied to clipboard

Summary information about a traffic distribution group user.

Link copied to clipboard
sealed class TrafficType
Link copied to clipboard

A structure that defines search criteria and matching logic to search for contacts by matching text with transcripts analyzed by Amazon Connect Contact Lens.

Link copied to clipboard

A structure that defines search criteria base on words or phrases, participants in the Contact Lens conversational analytics transcript.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The UpdateCase action definition.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Configuration information for the chat participant role.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Fields required when uploading an attached file.

Link copied to clipboard

The URL reference.

Link copied to clipboard
class UseCase

Contains the use case.

Link copied to clipboard
sealed class UseCaseType
Link copied to clipboard
class User

Contains information about a user account for an Amazon Connect instance.

Link copied to clipboard
class UserData

Data for a user.

Link copied to clipboard

A filter for the user data.

Link copied to clipboard

The search criteria to be used to return userHierarchyGroup.

Link copied to clipboard

Filters to be applied to search results.

Link copied to clipboard

Contains information about the identity of a user.

Link copied to clipboard

The user's first name and last name.

Link copied to clipboard
class UserInfo

The user details for the contact.

Link copied to clipboard

No user with the specified credentials was found in the Amazon Connect instance.

Link copied to clipboard

Contains information about the phone configuration settings for a user.

Link copied to clipboard

Information about proficiency of a user.

Link copied to clipboard

Information about proficiency to be disassociated from the user.

Link copied to clipboard

Contains information about the quick connect configuration settings for a user. The contact flow must be of type Transfer to Agent.

Link copied to clipboard

Information about the user.

Link copied to clipboard

The search criteria to be used to return users.

Link copied to clipboard

Filters to be applied to search results.

Link copied to clipboard

Information about the returned users.

Link copied to clipboard

Contains summary information about a user.

Link copied to clipboard
sealed class VideoCapability
Link copied to clipboard
class View

A view resource object. Contains metadata and content necessary to render the view.

Link copied to clipboard

View content containing all content necessary to render a view except for runtime input data.

Link copied to clipboard

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.

Link copied to clipboard
sealed class ViewStatus
Link copied to clipboard

A summary of a view's metadata.

Link copied to clipboard
sealed class ViewType
Link copied to clipboard

A summary of a view version's metadata.

Link copied to clipboard

Contains information about a custom vocabulary.

Link copied to clipboard
Link copied to clipboard
sealed class VocabularyState
Link copied to clipboard

Contains summary information about the custom vocabulary.

Link copied to clipboard

Contains information about the recording configuration settings.

Link copied to clipboard
sealed class VoiceRecordingTrack
Link copied to clipboard

Information about Amazon Connect Wisdom.