Package-level declarations

Types

Link copied to clipboard

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.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard

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.

Link copied to clipboard

Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Associates a connect resource to a flow.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Associates a flow with a phone number claimed to your Amazon Connect instance.

Link copied to clipboard

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

Link copied to clipboard

Associates a set of queues with a routing profile.

Link copied to clipboard

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

Link copied to clipboard

Associates an agent with a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.

Link copied to clipboard

Associates a set of proficiencies with a user.

Link copied to clipboard

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.

Link copied to clipboard

Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.

Link copied to clipboard

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.

Link copied to clipboard

Retrieve the flow associations for the given resources.

Link copied to clipboard

Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.

Link copied to clipboard

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.

Link copied to clipboard

Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Creates a flow for the specified Amazon Connect instance.

Link copied to clipboard

Creates a flow module for the specified Amazon Connect instance.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Creates an hours of operation override in an Amazon Connect hours of operation resource

Link copied to clipboard

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

Link copied to clipboard

Creates an Amazon Web Services resource association with an Amazon Connect instance.

Link copied to clipboard

Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
inline suspend fun ConnectClient.createQueue(crossinline block: CreateQueueRequest.Builder.() -> Unit): CreateQueueResponse

Creates a new queue for the specified Amazon Connect instance.

Link copied to clipboard

Creates a quick connect for the specified Amazon Connect instance.

Link copied to clipboard

Creates a new routing profile.

Link copied to clipboard
inline suspend fun ConnectClient.createRule(crossinline block: CreateRuleRequest.Builder.() -> Unit): CreateRuleResponse

Creates a rule for the specified Amazon Connect instance.

Link copied to clipboard

Creates a security profile.

Link copied to clipboard

Creates a new task template in the specified Amazon Connect instance.

Link copied to clipboard

Creates a traffic distribution group given an Amazon Connect instance that has been replicated.

Link copied to clipboard

Creates a use case for an integration association.

Link copied to clipboard
inline suspend fun ConnectClient.createUser(crossinline block: CreateUserRequest.Builder.() -> Unit): CreateUserResponse

Creates a user account for the specified Amazon Connect instance.

Link copied to clipboard

Creates a new user hierarchy group.

Link copied to clipboard
inline suspend fun ConnectClient.createView(crossinline block: CreateViewRequest.Builder.() -> Unit): CreateViewResponse

Creates a new view with the possible status of SAVED or PUBLISHED.

Link copied to clipboard

Publishes a new version of the view identifier.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Deletes an attached file along with the underlying S3 Object.

Link copied to clipboard

Deletes a contact evaluation in the specified Amazon Connect instance.

Link copied to clipboard

Deletes a flow for the specified Amazon Connect instance.

Link copied to clipboard

Deletes the specified flow module.

Link copied to clipboard

Deletes the particular version specified in flow version identifier.

Link copied to clipboard

Deletes email address from the specified Amazon Connect instance.

Link copied to clipboard

Deletes an evaluation form in the specified Amazon Connect instance.

Link copied to clipboard

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

Link copied to clipboard

Deletes an hours of operation override in an Amazon Connect hours of operation resource

Link copied to clipboard

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

Link copied to clipboard

Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.

Link copied to clipboard

Deletes a predefined attribute from the specified Amazon Connect instance.

Link copied to clipboard

Deletes a prompt.

Link copied to clipboard

Deletes registration for a device token and a chat contact.

Link copied to clipboard
inline suspend fun ConnectClient.deleteQueue(crossinline block: DeleteQueueRequest.Builder.() -> Unit): DeleteQueueResponse

Deletes a queue.

Link copied to clipboard

Deletes a quick connect.

Link copied to clipboard

Deletes a routing profile.

Link copied to clipboard
inline suspend fun ConnectClient.deleteRule(crossinline block: DeleteRuleRequest.Builder.() -> Unit): DeleteRuleResponse

Deletes a rule for the specified Amazon Connect instance.

Link copied to clipboard

Deletes a security profile.

Link copied to clipboard

Deletes the task template.

Link copied to clipboard

Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.

Link copied to clipboard

Deletes a use case from an integration association.

Link copied to clipboard
inline suspend fun ConnectClient.deleteUser(crossinline block: DeleteUserRequest.Builder.() -> Unit): DeleteUserResponse

Deletes a user account from the specified Amazon Connect instance.

Link copied to clipboard

Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.

Link copied to clipboard
inline suspend fun ConnectClient.deleteView(crossinline block: DeleteViewRequest.Builder.() -> Unit): DeleteViewResponse

Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).

Link copied to clipboard

Deletes the particular version specified in ViewVersion identifier.

Link copied to clipboard

Deletes the vocabulary that has the given identifier.

Link copied to clipboard

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

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.

Link copied to clipboard

Describes a contact evaluation in the specified Amazon Connect instance.

Link copied to clipboard

Describes the specified flow.

Link copied to clipboard

Describes the specified flow module.

Link copied to clipboard

Describe email address form the specified Amazon Connect instance.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Describes the hours of operation override.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.

Link copied to clipboard

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.

Link copied to clipboard

Describes the prompt.

Link copied to clipboard

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

Link copied to clipboard

Describes the quick connect.

Link copied to clipboard

Describes the specified routing profile.

Link copied to clipboard

Describes a rule for the specified Amazon Connect instance.

Link copied to clipboard

Gets basic information about the security profile.

Link copied to clipboard

Gets details and status of a traffic distribution group.

Link copied to clipboard

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.

Link copied to clipboard

Describes the specified hierarchy group.

Link copied to clipboard

Describes the hierarchy structure of the specified Amazon Connect instance.

Link copied to clipboard

Retrieves the view for the specified Amazon Connect instance and view identifier.

Link copied to clipboard

Describes the specified vocabulary.

Link copied to clipboard

Removes the dataset ID associated with a given Amazon Connect instance.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Disassociates a connect resource from a flow.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Removes the flow association from a phone number claimed to your Amazon Connect instance.

Link copied to clipboard

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

Link copied to clipboard

Disassociates a set of queues from a routing profile.

Link copied to clipboard

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

Link copied to clipboard

Disassociates an agent from a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.

Link copied to clipboard

Disassociates a set of proficiencies from a user.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Retrieves the contact attributes for the specified contact.

Link copied to clipboard

Gets the real-time metric data from the specified Amazon Connect instance.

Link copied to clipboard

Gets the real-time active user data from the specified Amazon Connect instance.

Link copied to clipboard

Get the hours of operations with the effective override applied.

Link copied to clipboard

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.

Link copied to clipboard

Retrieves the flow associated for a given resource.

Link copied to clipboard

Gets historical metric data from the specified Amazon Connect instance.

Link copied to clipboard

Gets metric data from the specified Amazon Connect instance.

Link copied to clipboard

Gets the prompt file.

Link copied to clipboard

Gets details about a specific task template in the specified Amazon Connect instance.

Link copied to clipboard

Retrieves the current traffic distribution for a given traffic distribution group.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Lists the association status of requested dataset ID for a given Amazon Connect instance.

Link copied to clipboard

Lists the data lake datasets available to associate with for a given Amazon Connect instance.

Link copied to clipboard

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

Link copied to clipboard

Provides information about contact tree, a list of associated contacts with a unique identifier.

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
inline suspend fun ConnectClient.listBots(crossinline block: ListBotsRequest.Builder.() -> Unit): ListBotsResponse

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

Link copied to clipboard

Lists contact evaluations in the specified Amazon Connect instance.

Link copied to clipboard

Provides information about the flow modules for the specified Amazon Connect instance.

Link copied to clipboard

Provides information about the flows for the specified Amazon Connect instance.

Link copied to clipboard

Returns all the available versions for the specified Amazon Connect instance and flow identifier.

Link copied to clipboard

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

Link copied to clipboard

Lists the default vocabularies for the specified Amazon Connect instance.

Link copied to clipboard

Lists evaluation forms in the specified Amazon Connect instance.

Link copied to clipboard

Lists versions of an evaluation form in the specified Amazon Connect instance.

Link copied to clipboard

List the flow association based on the filters.

Link copied to clipboard

List the hours of operation overrides.

Link copied to clipboard

Provides information about the hours of operation for the specified Amazon Connect instance.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun ConnectClient.listLexBots(crossinline block: ListLexBotsRequest.Builder.() -> Unit): ListLexBotsResponse

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

Link copied to clipboard

Provides information about the phone numbers for the specified Amazon Connect instance.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
inline suspend fun ConnectClient.listPrompts(crossinline block: ListPromptsRequest.Builder.() -> Unit): ListPromptsResponse

Provides information about the prompts for the specified Amazon Connect instance.

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun ConnectClient.listQueues(crossinline block: ListQueuesRequest.Builder.() -> Unit): ListQueuesResponse

Provides information about the queues for the specified Amazon Connect instance.

Link copied to clipboard

Provides information about the quick connects for the specified Amazon Connect instance.

Link copied to clipboard

Provides a list of analysis segments for a real-time chat analysis session. This API supports CHAT channels only.

Link copied to clipboard

Lists the queues associated with a routing profile.

Link copied to clipboard

Provides summary information about the routing profiles for the specified Amazon Connect instance.

Link copied to clipboard
inline suspend fun ConnectClient.listRules(crossinline block: ListRulesRequest.Builder.() -> Unit): ListRulesResponse

List all rules for the specified Amazon Connect instance.

Link copied to clipboard

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

Link copied to clipboard

Returns a list of third-party applications in a specific security profile.

Link copied to clipboard

Lists the permissions granted to a security profile.

Link copied to clipboard

Provides summary information about the security profiles for the specified Amazon Connect instance.

Link copied to clipboard

Lists the tags for the specified resource.

Link copied to clipboard

Lists task templates for the specified Amazon Connect instance.

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

Lists the use cases for the integration association.

Link copied to clipboard

Provides summary information about the hierarchy groups for the specified Amazon Connect instance.

Link copied to clipboard

Lists proficiencies associated with a user.

Link copied to clipboard
inline suspend fun ConnectClient.listUsers(crossinline block: ListUsersRequest.Builder.() -> Unit): ListUsersResponse

Provides summary information about the users for the specified Amazon Connect instance.

Link copied to clipboard
inline suspend fun ConnectClient.listViews(crossinline block: ListViewsRequest.Builder.() -> Unit): ListViewsResponse

Returns views in the given instance.

Link copied to clipboard

Returns all the available versions for the specified Amazon Connect instance and view identifier.

Link copied to clipboard

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.

Link copied to clipboard

Allows pausing an ongoing task contact.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Allows resuming a task contact in a paused state.

Link copied to clipboard

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.

Link copied to clipboard

Searches AgentStatuses in an Amazon Connect instance, with optional filtering.

Link copied to clipboard

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.

Link copied to clipboard

Searches the flow modules in an Amazon Connect instance, with optional filtering.

Link copied to clipboard

Searches the flows in an Amazon Connect instance, with optional filtering.

Link copied to clipboard

Searches contacts in an Amazon Connect instance.

Link copied to clipboard

Searches email address in an instance, with optional filtering.

Link copied to clipboard

Searches the hours of operation overrides.

Link copied to clipboard

Searches the hours of operation in an Amazon Connect instance, with optional filtering.

Link copied to clipboard

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.

Link copied to clipboard

Searches prompts in an Amazon Connect instance, with optional filtering.

Link copied to clipboard

Searches queues in an Amazon Connect instance, with optional filtering.

Link copied to clipboard

Searches quick connects in an Amazon Connect instance, with optional filtering.

Link copied to clipboard

Searches tags used in an Amazon Connect instance using optional search criteria.

Link copied to clipboard

Searches routing profiles in an Amazon Connect instance, with optional filtering.

Link copied to clipboard

Searches security profiles in an Amazon Connect instance, with optional filtering.

Link copied to clipboard

Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering.

Link copied to clipboard
inline suspend fun ConnectClient.searchUsers(crossinline block: SearchUsersRequest.Builder.() -> Unit): SearchUsersResponse

Searches users in an Amazon Connect instance, with optional filtering.

Link copied to clipboard

Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.

Link copied to clipboard

Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes:

Link copied to clipboard

Send outbound email for outbound campaigns. For more information about outbound campaigns, see Set up Amazon Connect outbound campaigns.

Link copied to clipboard

Provides a pre-signed Amazon S3 URL in response for uploading your content.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Starts recording the contact:

Link copied to clipboard

Initiates real-time message streaming for a new chat contact.

Link copied to clipboard

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.

Link copied to clipboard

Initiates a new outbound SMS contact to a customer. Response of this API provides the ContactId of the outbound SMS contact created.

Link copied to clipboard

Initiates a flow to send an agent reply or outbound email contact (created from the CreateContact API) to a customer.

Link copied to clipboard

Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's specified (in ContactFlowId).

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun ConnectClient.stopContact(crossinline block: StopContactRequest.Builder.() -> Unit): StopContactResponse

Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:

Link copied to clipboard

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.

Link copied to clipboard

Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
inline suspend fun ConnectClient.tagContact(crossinline block: TagContactRequest.Builder.() -> Unit): TagContactResponse

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.

Link copied to clipboard
inline suspend fun ConnectClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds the specified tags to the specified resource.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Removes the specified tags from the specified resource.

Link copied to clipboard

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

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.

Link copied to clipboard

Creates or updates user-defined contact attributes associated with the specified contact.

Link copied to clipboard

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.

Link copied to clipboard

Updates the specified flow.

Link copied to clipboard

Updates metadata about specified flow.

Link copied to clipboard

Updates specified flow module for the specified Amazon Connect instance.

Link copied to clipboard

Updates metadata about specified flow module.

Link copied to clipboard

The name of the flow.

Link copied to clipboard

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.

Link copied to clipboard

Updates the scheduled time of a task contact that is already scheduled.

Link copied to clipboard

Updates an email address metadata. For more information about email addresses, see Create email addresses in the Amazon Connect Administrator Guide.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Update the hours of operation override.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Instructs Amazon Connect to resume the authentication process. The subsequent actions depend on the request body contents:

Link copied to clipboard

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:

Link copied to clipboard

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.

Link copied to clipboard

Updates a phone number’s metadata.

Link copied to clipboard

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.

Link copied to clipboard

Updates a prompt.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Updates the outbound email address Id for a specified queue.

Link copied to clipboard

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

Link copied to clipboard

Updates the configuration settings for the specified quick connect.

Link copied to clipboard

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.

Link copied to clipboard

Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

Updates the properties associated with a set of queues for a routing profile.

Link copied to clipboard
inline suspend fun ConnectClient.updateRule(crossinline block: UpdateRuleRequest.Builder.() -> Unit): UpdateRuleResponse

Updates a rule for the specified Amazon Connect instance.

Link copied to clipboard

Updates a security profile.

Link copied to clipboard

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.

Link copied to clipboard

Updates the traffic distribution for a given traffic distribution group.

Link copied to clipboard

Assigns the specified hierarchy group to the specified user.

Link copied to clipboard

Updates the name of the user hierarchy group.

Link copied to clipboard

Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.

Link copied to clipboard

Updates the identity information for the specified user.

Link copied to clipboard

Updates the phone configuration settings for the specified user.

Link copied to clipboard

Updates the properties associated with the proficiencies of a user.

Link copied to clipboard

Assigns the specified routing profile to the specified user.

Link copied to clipboard

Assigns the specified security profiles to the specified user.

Link copied to clipboard

Updates the view content of the given view identifier in the specified Amazon Connect instance.

Link copied to clipboard

Updates the view metadata. Note that either Name or Description must be provided.

Link copied to clipboard

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.