aws connect
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
Subcommands
| Name | Description |
|---|---|
associate-approved-origin | This API is in preview release for Amazon Connect and is subject to change. Associates an approved origin to an Amazon Connect instance |
associate-instance-storage-config | This API is in preview release for Amazon Connect and is subject to change. Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts. This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association |
associate-lambda-function | This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon Connect instance to access the specified Lambda function |
associate-lex-bot | This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon Connect instance to access the specified Amazon Lex bot |
associate-queue-quick-connects | This API is in preview release for Amazon Connect and is subject to change. Associates a set of quick connects with a queue |
associate-routing-profile-queues | Associates a set of queues with a routing profile |
associate-security-key | This API is in preview release for Amazon Connect and is subject to change. Associates a security key to the instance |
create-contact-flow | Creates a contact flow for the specified Amazon Connect instance. You can also create and update contact flows using the Amazon Connect Flow language |
create-instance | This API is in preview release for Amazon Connect and is subject to change. Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect |
create-integration-association | This API is in preview release for Amazon Connect and is subject to change. Create an AppIntegration association with an Amazon Connect instance |
create-queue | This API is in preview release for Amazon Connect and is subject to change. Creates a new queue for the specified Amazon Connect instance |
create-quick-connect | This API is in preview release for Amazon Connect and is subject to change. Creates a quick connect for the specified Amazon Connect instance |
create-routing-profile | Creates a new routing profile |
create-use-case | This API is in preview release for Amazon Connect and is subject to change. Creates a use case for an AppIntegration association |
create-user | Creates a user account for the specified Amazon Connect instance. For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide |
create-user-hierarchy-group | Creates a new user hierarchy group |
delete-instance | This API is in preview release for Amazon Connect and is subject to change. Deletes the Amazon Connect instance |
delete-integration-association | This API is in preview release for Amazon Connect and is subject to change. Deletes an AppIntegration association from an Amazon Connect instance. The association must not have any use cases associated with it |
delete-quick-connect | This API is in preview release for Amazon Connect and is subject to change. Deletes a quick connect |
delete-use-case | This API is in preview release for Amazon Connect and is subject to change. Deletes a use case from an AppIntegration association |
delete-user | Deletes a user account from the specified Amazon Connect instance. For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide |
delete-user-hierarchy-group | Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups |
describe-contact-flow | Describes the specified contact flow. You can also create and update contact flows using the Amazon Connect Flow language |
describe-hours-of-operation | This API is in preview release for Amazon Connect and is subject to change. Describes the hours of operation |
describe-instance | This API is in preview release for Amazon Connect and is subject to change. Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable. If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked |
describe-instance-attribute | This API is in preview release for Amazon Connect and is subject to change. Describes the specified instance attribute |
describe-instance-storage-config | This API is in preview release for Amazon Connect and is subject to change. Retrieves the current storage configurations for the specified resource type, association ID, and instance ID |
describe-queue | This API is in preview release for Amazon Connect and is subject to change. Describes the specified queue |
describe-quick-connect | This API is in preview release for Amazon Connect and is subject to change. Describes the quick connect |
describe-routing-profile | Describes the specified routing profile |
describe-user | Describes the specified user account. You can find the instance ID in the console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output |
describe-user-hierarchy-group | Describes the specified hierarchy group |
describe-user-hierarchy-structure | Describes the hierarchy structure of the specified Amazon Connect instance |
disassociate-approved-origin | This API is in preview release for Amazon Connect and is subject to change. Revokes access to integrated applications from Amazon Connect |
disassociate-instance-storage-config | This API is in preview release for Amazon Connect and is subject to change. Removes the storage type configurations for the specified resource type and association ID |
disassociate-lambda-function | This API is in preview release for Amazon Connect and is subject to change. Remove the Lambda function from the dropdown options available in the relevant contact flow blocks |
disassociate-lex-bot | This API is in preview release for Amazon Connect and is subject to change. Revokes authorization from the specified instance to access the specified Amazon Lex bot |
disassociate-queue-quick-connects | This API is in preview release for Amazon Connect and is subject to change. Disassociates a set of quick connects from a queue |
disassociate-routing-profile-queues | Disassociates a set of queues from a routing profile |
disassociate-security-key | This API is in preview release for Amazon Connect and is subject to change. Deletes the specified security key |
get-contact-attributes | Retrieves the contact attributes for the specified contact |
get-current-metric-data | Gets the real-time metric data from the specified Amazon Connect instance. For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide |
get-federation-token | Retrieves a token for federation |
get-metric-data | Gets historical metric data from the specified Amazon Connect instance. For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide |
list-approved-origins | This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all approved origins associated with the instance |
list-contact-flows | Provides information about the contact flows for the specified Amazon Connect instance. You can also create and update contact flows using the Amazon Connect Flow language. For more information about contact flows, see Contact Flows in the Amazon Connect Administrator Guide |
list-hours-of-operations | Provides information about the hours of operation for the specified Amazon Connect instance. For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide |
list-instance-attributes | This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all attribute types for the given instance |
list-instance-storage-configs | This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of storage configs for the identified instance and resource type |
list-instances | This API is in preview release for Amazon Connect and is subject to change. Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked |
list-integration-associations | This API is in preview release for Amazon Connect and is subject to change. Provides summary information about the AppIntegration associations for the specified Amazon Connect instance |
list-lambda-functions | This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant contact flow blocks |
list-lex-bots | This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all the Amazon Lex bots currently associated with the instance |
list-phone-numbers | Provides information about the phone numbers for the specified Amazon Connect instance. For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide |
list-prompts | Provides information about the prompts for the specified Amazon Connect instance |
list-queue-quick-connects | This API is in preview release for Amazon Connect and is subject to change. Lists the quick connects associated with a queue |
list-queues | Provides information about the queues for the specified Amazon Connect instance. For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide |
list-quick-connects | This API is in preview release for Amazon Connect and is subject to change. Provides information about the quick connects for the specified Amazon Connect instance |
list-routing-profile-queues | Lists the queues associated with a routing profile |
list-routing-profiles | Provides summary information about the routing profiles for the specified Amazon Connect instance. For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide |
list-security-keys | This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all security keys associated with the instance |
list-security-profiles | Provides summary information about the security profiles for the specified Amazon Connect instance. For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide |
list-tags-for-resource | Lists the tags for the specified resource. For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide |
list-use-cases | This API is in preview release for Amazon Connect and is subject to change. Lists the use cases |
list-user-hierarchy-groups | Provides summary information about the hierarchy groups for the specified Amazon Connect instance. For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide |
list-users | Provides summary information about the users for the specified Amazon Connect instance |
resume-contact-recording | When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call. Only voice recordings are supported at this time |
start-chat-contact | Initiates a contact flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service. When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS. A 429 error occurs in two situations: API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception from the API Gateway. The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException. For more information about chat, see Chat in the Amazon Connect Administrator Guide |
start-contact-recording | Starts recording the contact when the agent joins the call. StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording. You can use this API to override the recording behavior configured in the Set recording behavior block. Only voice recordings are supported at this time |
start-outbound-voice-contact | Places an outbound call to a contact, and then initiates the contact flow. It performs the actions in the contact flow that's specified (in ContactFlowId). Agents do not initiate the outbound API, which means that they do not dial the contact. If the contact flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case. There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails. UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide |
start-task-contact | Initiates a contact flow to start a new task |
stop-contact | Ends the specified contact |
stop-contact-recording | Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording. Only voice recordings are supported at this time |
suspend-contact-recording | When a contact is being recorded, this API suspends recording the call. For example, you might suspend the call recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording. The period of time that the recording is suspended is filled with silence in the final recording. Only voice recordings are supported at this time |
tag-resource | Adds the specified tags to the specified resource. The supported resource types are users, routing profiles, queues, quick connects, and contact flows. For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide |
untag-resource | Removes the specified tags from the specified resource |
update-contact-attributes | Creates or updates the contact attributes associated with the specified contact. You can add or update attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or to identify abusive callers. Contact attributes are available in Amazon Connect for 24 months, and are then deleted. Important: You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, which was September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance |
update-contact-flow-content | Updates the specified contact flow. You can also create and update contact flows using the Amazon Connect Flow language |
update-contact-flow-name | The name of the contact flow. You can also create and update contact flows using the Amazon Connect Flow language |
update-instance-attribute | This API is in preview release for Amazon Connect and is subject to change. Updates the value for the specified attribute type |
update-instance-storage-config | This API is in preview release for Amazon Connect and is subject to change. Updates an existing configuration for a resource type. This API is idempotent |
update-queue-hours-of-operation | This API is in preview release for Amazon Connect and is subject to change. Updates the hours of operation for the specified queue |
update-queue-max-contacts | This API is in preview release for Amazon Connect and is subject to change. Updates the maximum number of contacts allowed in a queue before it is considered full |
update-queue-name | This API is in preview release for Amazon Connect and is subject to change. Updates the name and description of a queue. At least Name or Description must be provided |
update-queue-outbound-caller-config | This API is in preview release for Amazon Connect and is subject to change. Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue |
update-queue-status | This API is in preview release for Amazon Connect and is subject to change. Updates the status of the queue |
update-quick-connect-config | This API is in preview release for Amazon Connect and is subject to change. Updates the configuration settings for the specified quick connect |
update-quick-connect-name | This API is in preview release for Amazon Connect and is subject to change. Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name or Description must be provided |
update-routing-profile-concurrency | Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile |
update-routing-profile-default-outbound-queue | Updates the default outbound queue of a routing profile |
update-routing-profile-name | Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name or Description must be provided |
update-routing-profile-queues | Updates the properties associated with a set of queues for a routing profile |
update-user-hierarchy | Assigns the specified hierarchy group to the specified user |
update-user-hierarchy-group-name | Updates the name of the user hierarchy group |
update-user-hierarchy-structure | Updates the user hierarchy structure: add, remove, and rename user hierarchy levels |
update-user-identity-info | Updates the identity information for the specified user. We strongly recommend limiting who has the ability to invoke UpdateUserIdentityInfo. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide |
update-user-phone-config | Updates the phone configuration settings for the specified user |
update-user-routing-profile | Assigns the specified routing profile to the specified user |
update-user-security-profiles | Assigns the specified security profiles to the specified user |