Package-level declarations
Types
Functions
Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form.
Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.
Associates a connect resource to a flow.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
Associates a flow with a phone number claimed to your Amazon Connect instance.
This API is in preview release for Amazon Connect and is subject to change.
Associates a set of queues with a routing profile.
This API is in preview release for Amazon Connect and is subject to change.
Associates an agent with a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
Associates a set of proficiencies with a user.
Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.
Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.
Retrieve the flow associations for the given resources.
Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.
Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.
Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
This API is in preview release for Amazon Connect and is subject to change.
Only the EMAIL and VOICE channels are supported. The supported initiation methods for EMAIL are: OUTBOUND, AGENT_REPLY, and FLOW. For VOICE the supported initiation methods are TRANSFER and the subtype connect:ExternalAudio.
Creates a flow for the specified Amazon Connect instance.
Creates a flow module for the specified Amazon Connect instance.
Publishes a new version of the flow provided. Versions are immutable and monotonically increasing. If the FlowContentSha256
provided is different from the FlowContentSha256
of the $LATEST
published flow content, then an error is returned. This API only supports creating versions for flows of type Campaign
.
Create new email address in the specified Amazon Connect instance. For more information about email addresses, see Create email addresses in the Amazon Connect Administrator Guide.
Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.
This API is in preview release for Amazon Connect and is subject to change.
Creates an hours of operation override in an Amazon Connect hours of operation resource
This API is in preview release for Amazon Connect and is subject to change.
Creates an Amazon Web Services resource association with an Amazon Connect instance.
Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.
Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide.
Creates a new predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide.
Creates registration for a device token and a chat contact to receive real-time push notifications. For more information about push notifications, see Set up push notifications in Amazon Connect for mobile chat in the Amazon Connect Administrator Guide.
Creates a new queue for the specified Amazon Connect instance.
Creates a quick connect for the specified Amazon Connect instance.
Creates a new routing profile.
Creates a rule for the specified Amazon Connect instance.
Creates a security profile.
Creates a new task template in the specified Amazon Connect instance.
Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
Creates a use case for an integration association.
Creates a user account for the specified Amazon Connect instance.
Creates a new user hierarchy group.
Creates a new view with the possible status of SAVED
or PUBLISHED
.
Publishes a new version of the view identifier.
Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.
Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.
Deletes an attached file along with the underlying S3 Object.
Deletes a contact evaluation in the specified Amazon Connect instance.
Deletes a flow for the specified Amazon Connect instance.
Deletes the specified flow module.
Deletes the particular version specified in flow version identifier.
Deletes email address from the specified Amazon Connect instance.
Deletes an evaluation form in the specified Amazon Connect instance.
This API is in preview release for Amazon Connect and is subject to change.
Deletes an hours of operation override in an Amazon Connect hours of operation resource
This API is in preview release for Amazon Connect and is subject to change.
Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.
Deletes a predefined attribute from the specified Amazon Connect instance.
Deletes a prompt.
Deletes registration for a device token and a chat contact.
Deletes a queue.
Deletes a quick connect.
Deletes a routing profile.
Deletes a rule for the specified Amazon Connect instance.
Deletes a security profile.
Deletes the task template.
Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
Deletes a use case from an integration association.
Deletes a user account from the specified Amazon Connect instance.
Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).
Deletes the particular version specified in ViewVersion
identifier.
Deletes the vocabulary that has the given identifier.
This API is in preview release for Amazon Connect and is subject to change.
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.
Describes a contact evaluation in the specified Amazon Connect instance.
Describes the specified flow.
Describes the specified flow module.
Describe email address form the specified Amazon Connect instance.
Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.
This API is in preview release for Amazon Connect and is subject to change.
Describes the hours of operation override.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.
Describes a predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
Describes the prompt.
This API is in preview release for Amazon Connect and is subject to change.
Describes the quick connect.
Describes the specified routing profile.
Describes a rule for the specified Amazon Connect instance.
Gets basic information about the security profile.
Gets details and status of a traffic distribution group.
Describes the specified user. You can find the instance ID in the Amazon Connect 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.
Describes the specified hierarchy group.
Describes the hierarchy structure of the specified Amazon Connect instance.
Retrieves the view for the specified Amazon Connect instance and view identifier.
Describes the specified vocabulary.
Removes the dataset ID associated with a given Amazon Connect instance.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
Disassociates a connect resource from a flow.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
Removes the flow association from a phone number claimed to your Amazon Connect instance.
This API is in preview release for Amazon Connect and is subject to change.
Disassociates a set of queues from a routing profile.
This API is in preview release for Amazon Connect and is subject to change.
Disassociates an agent from a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
Disassociates a set of proficiencies from a user.
Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a MISSED
, ERROR
, ENDED
, or REJECTED
state in the Agent Event Stream.
Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is APPROVED
.
Retrieves the contact attributes for the specified contact.
Gets the real-time metric data from the specified Amazon Connect instance.
Gets the real-time active user data from the specified Amazon Connect instance.
Get the hours of operations with the effective override applied.
Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action.
Retrieves the flow associated for a given resource.
Gets historical metric data from the specified Amazon Connect instance.
Gets metric data from the specified Amazon Connect instance.
Gets the prompt file.
Gets details about a specific task template in the specified Amazon Connect instance.
Retrieves the current traffic distribution for a given traffic distribution group.
Imports a claimed phone number from an external service, such as Amazon Web Services End User Messaging, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.
This API is in preview release for Amazon Connect and is subject to change.
Lists the association status of requested dataset ID for a given Amazon Connect instance.
Lists the data lake datasets available to associate with for a given Amazon Connect instance.
This API is in preview release for Amazon Connect and is subject to change.
Provides information about contact tree, a list of associated contacts with a unique identifier.
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.
Lists contact evaluations in the specified Amazon Connect instance.
Provides information about the flow modules for the specified Amazon Connect instance.
Provides information about the flows for the specified Amazon Connect instance.
Returns all the available versions for the specified Amazon Connect instance and flow identifier.
This API is in preview release for Amazon Connect and is subject to change.
Lists the default vocabularies for the specified Amazon Connect instance.
Lists evaluation forms in the specified Amazon Connect instance.
Lists versions of an evaluation form in the specified Amazon Connect instance.
List the flow association based on the filters.
List the hours of operation overrides.
Provides information about the hours of operation for the specified Amazon Connect instance.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
Provides information about the phone numbers for the specified Amazon Connect instance.
Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided TargetArn
is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group.
Lists predefined attributes for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
Provides information about the prompts for the specified Amazon Connect instance.
This API is in preview release for Amazon Connect and is subject to change.
Provides information about the queues for the specified Amazon Connect instance.
Provides information about the quick connects for the specified Amazon Connect instance.
Provides a list of analysis segments for a real-time chat analysis session. This API supports CHAT channels only.
Lists the queues associated with a routing profile.
Provides summary information about the routing profiles for the specified Amazon Connect instance.
List all rules for the specified Amazon Connect instance.
This API is in preview release for Amazon Connect and is subject to change.
Returns a list of third-party applications in a specific security profile.
Lists the permissions granted to a security profile.
Provides summary information about the security profiles for the specified Amazon Connect instance.
Lists the tags for the specified resource.
Lists task templates for the specified Amazon Connect instance.
Lists traffic distribution groups.
Lists traffic distribution group users.
Lists the use cases for the integration association.
Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
Lists proficiencies associated with a user.
Provides summary information about the users for the specified Amazon Connect instance.
Returns views in the given instance.
Returns all the available versions for the specified Amazon Connect instance and view identifier.
Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact.
Allows pausing an ongoing task contact.
Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent's next status.
Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.
Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.
Allows resuming a task contact in a paused state.
When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume.
Searches AgentStatuses in an Amazon Connect instance, with optional filtering.
Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided TargetArn
is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group.
Searches the flow modules in an Amazon Connect instance, with optional filtering.
Searches the flows in an Amazon Connect instance, with optional filtering.
Searches contacts in an Amazon Connect instance.
Searches email address in an instance, with optional filtering.
Searches the hours of operation overrides.
Searches the hours of operation in an Amazon Connect instance, with optional filtering.
Searches predefined attributes that meet certain criteria. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
Searches prompts in an Amazon Connect instance, with optional filtering.
Searches queues in an Amazon Connect instance, with optional filtering.
Searches quick connects in an Amazon Connect instance, with optional filtering.
Searches tags used in an Amazon Connect instance using optional search criteria.
Searches routing profiles in an Amazon Connect instance, with optional filtering.
Searches security profiles in an Amazon Connect instance, with optional filtering.
Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering.
Searches users in an Amazon Connect instance, with optional filtering.
Searches for vocabularies within a specific Amazon Connect instance using State
, NameStartsWith
, and LanguageCode
.
Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes:
Send outbound email for outbound campaigns. For more information about outbound campaigns, see Set up Amazon Connect outbound campaigns.
Provides a pre-signed Amazon S3 URL in response for uploading your content.
Initiates a 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.
Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started.
Starts recording the contact:
Initiates real-time message streaming for a new chat contact.
Creates an inbound email contact and initiates a flow to start the email contact for the customer. Response of this API provides the ContactId of the email contact created.
Initiates a new outbound SMS contact to a customer. Response of this API provides the ContactId
of the outbound SMS contact created.
Initiates a flow to send an agent reply or outbound email contact (created from the CreateContact API) to a customer.
Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's specified (in ContactFlowId
).
Starts screen sharing for a contact. For more information about screen sharing, see Set up in-app, web, video calling, and screen sharing capabilities in the Amazon Connect Administrator Guide.
Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the Amazon Connect Administrator Guide.
Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).
Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:
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.
Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.
Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted with the existing answers and notes. You can delete an answer or note by passing an empty object ({}
) to the question identifier.
When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call (IVR or agent), screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen.
Adds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.
Adds the specified tags to the specified resource.
Transfers TASK
or EMAIL
contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.
Removes the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.
Removes the specified tags from the specified resource.
This API is in preview release for Amazon Connect and is subject to change.
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.
Creates or updates user-defined contact attributes associated with the specified contact.
Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object ({}
) to the question identifier.
Updates the specified flow.
Updates metadata about specified flow.
Updates specified flow module for the specified Amazon Connect instance.
Updates metadata about specified flow module.
The name of the flow.
Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block.
Updates the scheduled time of a task contact that is already scheduled.
Updates an email address metadata. For more information about email addresses, see Create email addresses in the Amazon Connect Administrator Guide.
Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form.
This API is in preview release for Amazon Connect and is subject to change.
Update the hours of operation override.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
Instructs Amazon Connect to resume the authentication process. The subsequent actions depend on the request body contents:
Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers:
Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.
Updates a phone number’s metadata.
Updates a predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
Updates a prompt.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
Updates the outbound email address Id for a specified queue.
This API is in preview release for Amazon Connect and is subject to change.
Updates the configuration settings for the specified quick connect.
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.
Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
Updates the default outbound queue of a routing profile.
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.
Updates the properties associated with a set of queues for a routing profile.
Updates a rule for the specified Amazon Connect instance.
Updates a security profile.
Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content.
Updates the traffic distribution for a given traffic distribution group.
Assigns the specified hierarchy group to the specified user.
Updates the name of the user hierarchy group.
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
Updates the identity information for the specified user.
Updates the phone configuration settings for the specified user.
Updates the properties associated with the proficiencies of a user.
Assigns the specified routing profile to the specified user.
Assigns the specified security profiles to the specified user.
Updates the view content of the given view identifier in the specified Amazon Connect instance.
Updates the view metadata. Note that either Name
or Description
must be provided.
Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.