Expand description
Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center and provide reliable customer engagement at any scale.
Amazon Connect provides metrics and real-time reporting that enable you to optimize contact routing. You can also resolve customer issues more efficiently by getting customers in touch with the appropriate agents.
There are limits to the number of Amazon Connect resources that you can create. There are also limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
You can connect programmatically to an AWS service by using an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
Working with contact flows? Check out the Amazon Connect Flow language.
If you’re using the service, you’re probably looking for ConnectClient and Connect.
Structs§
- Associate
Approved Origin Request - Associate
BotRequest - Associate
Instance Storage Config Request - Associate
Instance Storage Config Response - Associate
Lambda Function Request - Associate
LexBot Request - Associate
Queue Quick Connects Request - Associate
Routing Profile Queues Request - Associate
Security KeyRequest - Associate
Security KeyResponse - Attribute
A toggle for an individual feature at the instance level.
- Chat
Message A chat message.
- Connect
Client - A client for the Amazon Connect API.
- Contact
Flow Contains information about a contact flow.
- Contact
Flow Summary Contains summary information about a contact flow.
You can also create and update contact flows using the Amazon Connect Flow language.
- Create
Contact Flow Request - Create
Contact Flow Response - Create
Instance Request - Create
Instance Response - Create
Integration Association Request - Create
Integration Association Response - Create
Queue Request - Create
Queue Response - Create
Quick Connect Request - Create
Quick Connect Response - Create
Routing Profile Request - Create
Routing Profile Response - Create
UseCase Request - Create
UseCase Response - Create
User Hierarchy Group Request - Create
User Hierarchy Group Response - Create
User Request - Create
User Response - Credentials
Contains credentials to use for federation.
- Current
Metric Contains information about a real-time metric. For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
- Current
Metric Data Contains the data for a real-time metric.
- Current
Metric Result Contains information about a set of real-time metrics.
- Delete
Instance Request - Delete
Integration Association Request - Delete
Quick Connect Request - Delete
UseCase Request - Delete
User Hierarchy Group Request - Delete
User Request - Describe
Contact Flow Request - Describe
Contact Flow Response - Describe
Hours OfOperation Request - Describe
Hours OfOperation Response - Describe
Instance Attribute Request - Describe
Instance Attribute Response - Describe
Instance Request - Describe
Instance Response - Describe
Instance Storage Config Request - Describe
Instance Storage Config Response - Describe
Queue Request - Describe
Queue Response - Describe
Quick Connect Request - Describe
Quick Connect Response - Describe
Routing Profile Request - Describe
Routing Profile Response - Describe
User Hierarchy Group Request - Describe
User Hierarchy Group Response - Describe
User Hierarchy Structure Request - Describe
User Hierarchy Structure Response - Describe
User Request - Describe
User Response - Dimensions
Contains information about the dimensions for a set of metrics.
- Disassociate
Approved Origin Request - Disassociate
BotRequest - Disassociate
Instance Storage Config Request - Disassociate
Lambda Function Request - Disassociate
LexBot Request - Disassociate
Queue Quick Connects Request - Disassociate
Routing Profile Queues Request - Disassociate
Security KeyRequest - Encryption
Config The encryption configuration.
- Filters
Contains the filter to apply when retrieving metrics.
- GetContact
Attributes Request - GetContact
Attributes Response - GetCurrent
Metric Data Request - GetCurrent
Metric Data Response - GetFederation
Token Request - GetFederation
Token Response - GetMetric
Data Request - GetMetric
Data Response - Hierarchy
Group Contains information about a hierarchy group.
- Hierarchy
Group Summary Contains summary information about a hierarchy group.
- Hierarchy
Level Contains information about a hierarchy level.
- Hierarchy
Level Update Contains information about the hierarchy level to update.
- Hierarchy
Path Contains information about the levels of a hierarchy group.
- Hierarchy
Structure Contains information about a hierarchy structure.
- Hierarchy
Structure Update Contains information about the level hierarchy to update.
- Historical
Metric Contains information about a historical metric. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
- Historical
Metric Data Contains the data for a historical metric.
- Historical
Metric Result Contains information about the historical metrics retrieved.
- Hours
OfOperation Information about of the hours of operation.
- Hours
OfOperation Config Contains information about the hours of operation.
- Hours
OfOperation Summary Contains summary information about hours of operation for a contact center.
- Hours
OfOperation Time Slice The start time or end time for an hours of operation.
- Instance
The Amazon Connect instance.
- Instance
Status Reason Relevant details why the instance was not successfully created.
- Instance
Storage Config The storage configuration for the instance.
- Instance
Summary Information about the instance.
- Integration
Association Summary Contains summary information about the associated AppIntegrations.
- Kinesis
Firehose Config Configuration information of a Kinesis Data Firehose delivery stream.
- Kinesis
Stream Config Configuration information of a Kinesis data stream.
- Kinesis
Video Stream Config Configuration information of a Kinesis video stream.
- LexBot
Configuration information of an Amazon Lex bot.
- LexBot
Config Configuration information of an Amazon Lex or Amazon Lex V2 bot.
- LexV2
Bot Configuration information of an Amazon Lex V2 bot.
- List
Approved Origins Request - List
Approved Origins Response - List
Bots Request - List
Bots Response - List
Contact Flows Request - List
Contact Flows Response - List
Hours OfOperations Request - List
Hours OfOperations Response - List
Instance Attributes Request - List
Instance Attributes Response - List
Instance Storage Configs Request - List
Instance Storage Configs Response - List
Instances Request - List
Instances Response - List
Integration Associations Request - List
Integration Associations Response - List
Lambda Functions Request - List
Lambda Functions Response - List
LexBots Request - List
LexBots Response - List
Phone Numbers Request - List
Phone Numbers Response - List
Prompts Request - List
Prompts Response - List
Queue Quick Connects Request - List
Queue Quick Connects Response - List
Queues Request - List
Queues Response - List
Quick Connects Request - List
Quick Connects Response - List
Routing Profile Queues Request - List
Routing Profile Queues Response - List
Routing Profiles Request - List
Routing Profiles Response - List
Security Keys Request - List
Security Keys Response - List
Security Profiles Request - List
Security Profiles Response - List
Tags ForResource Request - List
Tags ForResource Response - List
UseCases Request Provides summary information about the use cases for the specified Amazon Connect AppIntegration association.
- List
UseCases Response - List
User Hierarchy Groups Request - List
User Hierarchy Groups Response - List
Users Request - List
Users Response - Media
Concurrency Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.
- Outbound
Caller Config The outbound caller ID name, number, and outbound whisper flow.
- Participant
Details The customer's details.
- Phone
Number Quick Connect Config Contains information about a phone number for a quick connect.
- Phone
Number Summary Contains summary information about a phone number for a contact center.
- Problem
Detail Information about a problem detail.
- Prompt
Summary Contains information about the prompt.
- Queue
Contains information about a queue.
- Queue
Quick Connect Config Contains information about a queue for a quick connect. The contact flow must be of type Transfer to Queue.
- Queue
Reference Contains information about a queue resource for which metrics are returned.
- Queue
Summary Contains summary information about a queue.
- Quick
Connect Contains information about a quick connect.
- Quick
Connect Config Contains configuration settings for a quick connect.
- Quick
Connect Summary Contains summary information about a quick connect.
- Reference
A link that an agent selects to complete a given task. You can have up to 4,096 UTF-8 bytes across all references for a contact.
- Resume
Contact Recording Request - Resume
Contact Recording Response - Routing
Profile Contains information about a routing profile.
- Routing
Profile Queue Config Contains information about the queue and channel for which priority and delay can be set.
- Routing
Profile Queue Config Summary Contains summary information about a routing profile queue.
- Routing
Profile Queue Reference Contains the channel and queue identifier for a routing profile.
- Routing
Profile Summary Contains summary information about a routing profile.
- S3Config
Information about the Amazon Simple Storage Service (Amazon S3) storage type.
- Security
Key Configuration information of the security key.
- Security
Profile Summary Contains information about a security profile.
- Start
Chat Contact Request - Start
Chat Contact Response - Start
Contact Recording Request - Start
Contact Recording Response - Start
Outbound Voice Contact Request - Start
Outbound Voice Contact Response - Start
Task Contact Request - Start
Task Contact Response - Stop
Contact Recording Request - Stop
Contact Recording Response - Stop
Contact Request - Stop
Contact Response - Suspend
Contact Recording Request - Suspend
Contact Recording Response - TagResource
Request - Threshold
Contains information about the threshold for service level metrics.
- Untag
Resource Request - Update
Contact Attributes Request - Update
Contact Attributes Response - Update
Contact Flow Content Request - Update
Contact Flow Name Request - Update
Instance Attribute Request - Update
Instance Storage Config Request - Update
Queue Hours OfOperation Request - Update
Queue MaxContacts Request - Update
Queue Name Request - Update
Queue Outbound Caller Config Request - Update
Queue Status Request - Update
Quick Connect Config Request - Update
Quick Connect Name Request - Update
Routing Profile Concurrency Request - Update
Routing Profile Default Outbound Queue Request - Update
Routing Profile Name Request - Update
Routing Profile Queues Request - Update
User Hierarchy Group Name Request - Update
User Hierarchy Request - Update
User Hierarchy Structure Request - Update
User Identity Info Request - Update
User Phone Config Request - Update
User Routing Profile Request - Update
User Security Profiles Request - UseCase
Contains the use case.
- User
Contains information about a user account for a Amazon Connect instance.
- User
Identity Info Contains information about the identity of a user.
- User
Phone Config Contains information about the phone configuration settings for a user.
- User
Quick Connect Config Contains information about the quick connect configuration settings for a user. The contact flow must be of type Transfer to Agent.
- User
Summary Contains summary information about a user.
- Voice
Recording Configuration Contains information about the recording configuration settings.
Enums§
- Associate
Approved Origin Error - Errors returned by AssociateApprovedOrigin
- Associate
BotError - Errors returned by AssociateBot
- Associate
Instance Storage Config Error - Errors returned by AssociateInstanceStorageConfig
- Associate
Lambda Function Error - Errors returned by AssociateLambdaFunction
- Associate
LexBot Error - Errors returned by AssociateLexBot
- Associate
Queue Quick Connects Error - Errors returned by AssociateQueueQuickConnects
- Associate
Routing Profile Queues Error - Errors returned by AssociateRoutingProfileQueues
- Associate
Security KeyError - Errors returned by AssociateSecurityKey
- Create
Contact Flow Error - Errors returned by CreateContactFlow
- Create
Instance Error - Errors returned by CreateInstance
- Create
Integration Association Error - Errors returned by CreateIntegrationAssociation
- Create
Queue Error - Errors returned by CreateQueue
- Create
Quick Connect Error - Errors returned by CreateQuickConnect
- Create
Routing Profile Error - Errors returned by CreateRoutingProfile
- Create
UseCase Error - Errors returned by CreateUseCase
- Create
User Error - Errors returned by CreateUser
- Create
User Hierarchy Group Error - Errors returned by CreateUserHierarchyGroup
- Delete
Instance Error - Errors returned by DeleteInstance
- Delete
Integration Association Error - Errors returned by DeleteIntegrationAssociation
- Delete
Quick Connect Error - Errors returned by DeleteQuickConnect
- Delete
UseCase Error - Errors returned by DeleteUseCase
- Delete
User Error - Errors returned by DeleteUser
- Delete
User Hierarchy Group Error - Errors returned by DeleteUserHierarchyGroup
- Describe
Contact Flow Error - Errors returned by DescribeContactFlow
- Describe
Hours OfOperation Error - Errors returned by DescribeHoursOfOperation
- Describe
Instance Attribute Error - Errors returned by DescribeInstanceAttribute
- Describe
Instance Error - Errors returned by DescribeInstance
- Describe
Instance Storage Config Error - Errors returned by DescribeInstanceStorageConfig
- Describe
Queue Error - Errors returned by DescribeQueue
- Describe
Quick Connect Error - Errors returned by DescribeQuickConnect
- Describe
Routing Profile Error - Errors returned by DescribeRoutingProfile
- Describe
User Error - Errors returned by DescribeUser
- Describe
User Hierarchy Group Error - Errors returned by DescribeUserHierarchyGroup
- Describe
User Hierarchy Structure Error - Errors returned by DescribeUserHierarchyStructure
- Disassociate
Approved Origin Error - Errors returned by DisassociateApprovedOrigin
- Disassociate
BotError - Errors returned by DisassociateBot
- Disassociate
Instance Storage Config Error - Errors returned by DisassociateInstanceStorageConfig
- Disassociate
Lambda Function Error - Errors returned by DisassociateLambdaFunction
- Disassociate
LexBot Error - Errors returned by DisassociateLexBot
- Disassociate
Queue Quick Connects Error - Errors returned by DisassociateQueueQuickConnects
- Disassociate
Routing Profile Queues Error - Errors returned by DisassociateRoutingProfileQueues
- Disassociate
Security KeyError - Errors returned by DisassociateSecurityKey
- GetContact
Attributes Error - Errors returned by GetContactAttributes
- GetCurrent
Metric Data Error - Errors returned by GetCurrentMetricData
- GetFederation
Token Error - Errors returned by GetFederationToken
- GetMetric
Data Error - Errors returned by GetMetricData
- List
Approved Origins Error - Errors returned by ListApprovedOrigins
- List
Bots Error - Errors returned by ListBots
- List
Contact Flows Error - Errors returned by ListContactFlows
- List
Hours OfOperations Error - Errors returned by ListHoursOfOperations
- List
Instance Attributes Error - Errors returned by ListInstanceAttributes
- List
Instance Storage Configs Error - Errors returned by ListInstanceStorageConfigs
- List
Instances Error - Errors returned by ListInstances
- List
Integration Associations Error - Errors returned by ListIntegrationAssociations
- List
Lambda Functions Error - Errors returned by ListLambdaFunctions
- List
LexBots Error - Errors returned by ListLexBots
- List
Phone Numbers Error - Errors returned by ListPhoneNumbers
- List
Prompts Error - Errors returned by ListPrompts
- List
Queue Quick Connects Error - Errors returned by ListQueueQuickConnects
- List
Queues Error - Errors returned by ListQueues
- List
Quick Connects Error - Errors returned by ListQuickConnects
- List
Routing Profile Queues Error - Errors returned by ListRoutingProfileQueues
- List
Routing Profiles Error - Errors returned by ListRoutingProfiles
- List
Security Keys Error - Errors returned by ListSecurityKeys
- List
Security Profiles Error - Errors returned by ListSecurityProfiles
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- List
UseCases Error - Errors returned by ListUseCases
- List
User Hierarchy Groups Error - Errors returned by ListUserHierarchyGroups
- List
Users Error - Errors returned by ListUsers
- Resume
Contact Recording Error - Errors returned by ResumeContactRecording
- Start
Chat Contact Error - Errors returned by StartChatContact
- Start
Contact Recording Error - Errors returned by StartContactRecording
- Start
Outbound Voice Contact Error - Errors returned by StartOutboundVoiceContact
- Start
Task Contact Error - Errors returned by StartTaskContact
- Stop
Contact Error - Errors returned by StopContact
- Stop
Contact Recording Error - Errors returned by StopContactRecording
- Suspend
Contact Recording Error - Errors returned by SuspendContactRecording
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
Contact Attributes Error - Errors returned by UpdateContactAttributes
- Update
Contact Flow Content Error - Errors returned by UpdateContactFlowContent
- Update
Contact Flow Name Error - Errors returned by UpdateContactFlowName
- Update
Instance Attribute Error - Errors returned by UpdateInstanceAttribute
- Update
Instance Storage Config Error - Errors returned by UpdateInstanceStorageConfig
- Update
Queue Hours OfOperation Error - Errors returned by UpdateQueueHoursOfOperation
- Update
Queue MaxContacts Error - Errors returned by UpdateQueueMaxContacts
- Update
Queue Name Error - Errors returned by UpdateQueueName
- Update
Queue Outbound Caller Config Error - Errors returned by UpdateQueueOutboundCallerConfig
- Update
Queue Status Error - Errors returned by UpdateQueueStatus
- Update
Quick Connect Config Error - Errors returned by UpdateQuickConnectConfig
- Update
Quick Connect Name Error - Errors returned by UpdateQuickConnectName
- Update
Routing Profile Concurrency Error - Errors returned by UpdateRoutingProfileConcurrency
- Update
Routing Profile Default Outbound Queue Error - Errors returned by UpdateRoutingProfileDefaultOutboundQueue
- Update
Routing Profile Name Error - Errors returned by UpdateRoutingProfileName
- Update
Routing Profile Queues Error - Errors returned by UpdateRoutingProfileQueues
- Update
User Hierarchy Error - Errors returned by UpdateUserHierarchy
- Update
User Hierarchy Group Name Error - Errors returned by UpdateUserHierarchyGroupName
- Update
User Hierarchy Structure Error - Errors returned by UpdateUserHierarchyStructure
- Update
User Identity Info Error - Errors returned by UpdateUserIdentityInfo
- Update
User Phone Config Error - Errors returned by UpdateUserPhoneConfig
- Update
User Routing Profile Error - Errors returned by UpdateUserRoutingProfile
- Update
User Security Profiles Error - Errors returned by UpdateUserSecurityProfiles
Traits§
- Connect
- Trait representing the capabilities of the Amazon Connect API. Amazon Connect clients implement this trait.