ConnectClient

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.

Associates an approved origin to an Amazon Connect instance.

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 or Amazon Lex V2 bot.

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.

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.

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.

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 V1 bot. This API only supports the association of Amazon Lex V1 bots.

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 quick connects with a queue.

Associates a set of queues with a routing profile.

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

Associates a security key to the instance.

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.

Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch  API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.

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.

For more information about how to use this operation, see Claim a phone number in your country  and Claim phone numbers to traffic distribution groups  in the Amazon Connect Administrator Guide.

If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.

By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.

For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.

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.

Creates an agent status for the specified Amazon Connect instance.

Creates a new EMAIL contact.

Creates a flow for the specified Amazon Connect instance.

You can also create and update flows using the Amazon Connect Flow language .

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 hours of operation.

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.

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.

For more information, see Create an Amazon Connect instance  in the Amazon Connect Administrator Guide.

Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.

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.

Use the Rules Function language  to code conditions for the rule.

Creates a security profile.

For information about security profiles, see Security Profiles  in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions .

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.

For more information about creating traffic distribution groups, see Set up traffic distribution groups  in the Amazon Connect Administrator Guide.

Creates a use case for an integration association.

Creates a user account for the specified Amazon Connect instance.

For information about how to create users using the Amazon Connect admin website, see Add Users  in the Amazon Connect Administrator Guide.

Creates a new user hierarchy group.

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

The views will have a unique name for each connect instance.

It performs basic content validation if the status is SAVED or full content validation if the status is set to PUBLISHED. An error is returned if validation fails. It associates either the $SAVED qualifier or both of the $SAVED and $LATEST qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided.

Publishes a new version of the view identifier.

Versions are immutable and monotonically increasing.

It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the $LATEST alias.

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.

• If the version property is provided, only the specified version of the evaluation form is deleted.

• If no version is provided, then the full form (all versions) is deleted.

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

Deletes an hours of operation.

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 the Amazon Connect instance. For more information, see Delete your Amazon Connect instance  in the Amazon Connect Administrator Guide.

Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.

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.

For more information about deleting traffic distribution groups, see Delete traffic distribution groups  in the Amazon Connect Administrator Guide.

Deletes a use case from an integration association.

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.

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.

Describes an agent status.

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

Describes the target authentication profile.

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

Describes the specified contact.

Describes a contact evaluation in the specified Amazon Connect instance.

Describes the specified flow.

You can also create and update flows using the Amazon Connect Flow language .

Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.

Use arn:aws:.../contact-flow/{id}:{version} to retrieve the content of a specific flow version.

In the response, Status indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. SAVED does not initiate validation of the content. SAVED | PUBLISHED

Describes the specified flow module.

Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.

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.

Describes the hours of operation override.

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

Describes the specified instance attribute.

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.

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.

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 specified queue.

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.

For information about security profiles, see Security Profiles  in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions .

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.

The view identifier can be supplied as a ViewId or ARN.

$SAVED needs to be supplied if a view is unpublished.

The view identifier can contain an optional qualifier, for example, :$SAVED, which is either an actual version number or an Amazon Connect managed qualifier $SAVED | $LATEST. If it is not supplied, then $LATEST is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views.

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.

Revokes access to integrated applications from Amazon Connect.

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 or Amazon Lex V2 bot.

Disassociates a connect resource from a flow.

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.

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 flow blocks.

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.

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 quick connects from a queue.

Disassociates a set of queues from a routing profile.

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

Deletes the specified security key.

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.

For a description of each metric, see Real-time Metrics Definitions  in the Amazon Connect Administrator Guide.

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.

For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide. 

Retrieves the flow associated for a given resource.

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.

Gets metric data from the specified Amazon Connect instance.

GetMetricDataV2 offers more features than GetMetricData , the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. It does not support agent queues.

For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Historical metrics definitions  in the Amazon Connect Administrator Guide.

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.

If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.

By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired.

For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web ServicesSupport ticket.

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

Lists agent statuses.

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.

Returns a paginated list of all approved origins associated with the instance.

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.

Provides summary information about the authentication profiles in a specified Amazon Connect instance.

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

For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to return both Amazon Lex V1 and V2 bots.

Lists contact evaluations in the specified Amazon Connect instance.

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

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

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

You can also create and update flows using the Amazon Connect Flow language .

For more information about flows, see Flows  in the Amazon Connect Administrator Guide.

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

For the specified referenceTypes, returns a list of references associated with the contact. References are links to documents that are related to a contact, such as emails, attachments, or URLs.

Lists the default vocabularies for the specified Amazon Connect instance.

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

Lists evaluation forms 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.

For more information about hours of operation, see Set the Hours of Operation for a Queue  in the Amazon Connect Administrator Guide.

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.

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.

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.

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.

Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks.

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

Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots  API.

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.

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.

For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center  in the Amazon Connect Administrator Guide.

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.

Lists the quick connects associated with a queue.

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

If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code.

For more information about queues, see Queues: Standard and Agent  in the Amazon Connect Administrator Guide.

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.

For more information about routing profiles, see Routing Profiles  and Create a Routing Profile  in the Amazon Connect Administrator Guide.

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 paginated list of all security keys associated with the instance.

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

Lists the permissions granted to a security profile.

For information about security profiles, see Security Profiles  in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions .

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. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions .

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.

Lists task templates for the specified Amazon Connect instance.

Lists traffic distribution group users.

Lists traffic distribution groups.

Lists the use cases for the integration association.

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.

Lists proficiencies associated with a user.

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

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

Results will be sorted from highest to lowest.

Returns views in the given instance.

Results are sorted primarily by type, and secondarily by name.

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.

For more information, see Agent status  and Set your next status  in the Amazon Connect Administrator Guide.

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.

If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.

By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.

For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.

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.

For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance  in the Amazon Connect Administrator Guide.

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.

Voice and screen recordings are supported.

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.

For information about security profiles, see Security Profiles  in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions .

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:

• SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat

• ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat

When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action.

Access to this API is currently restricted to Amazon Web Services End User Messaging for supporting SMS integration.

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.

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 the following situations:

• API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception.

• The quota for concurrent active chats  is exceeded. Active chat throttling returns a LimitExceededException.

If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web ServicesSupport.

For more information about chat, see the following topics in the Amazon Connect Administrator Guide:

• Concepts: Web and mobile messaging capabilities in Amazon Connect 

• Amazon Connect Chat security best practices 

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:

• If the API is called before the agent joins the call, recording starts when the agent joins the call.

• If the API is called after the agent joins the call, recording starts at the time of the API 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.

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

For more information about message streaming, see Enable real-time chat message streaming  in the Amazon Connect Administrator Guide.

For more information about chat, see the following topics in the Amazon Connect Administrator Guide:

• Concepts: Web and mobile messaging capabilities in Amazon Connect 

• Amazon Connect Chat security best practices 

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.

SourceEndpoint only supports Endpoints with CONNECT_PHONENUMBER_ARN as Type and DestinationEndpoint only supports Endpoints with TELEPHONE_NUMBER as Type. ContactFlowId initiates the flow to manage the new SMS contact created.

This API can be used to initiate outbound SMS contacts for an agent, or it can also deflect an ongoing contact to an outbound SMS contact by using the StartOutboundChatContact  Flow Action.

For more information about using SMS in Amazon Connect, see the following topics in the Amazon Connect Administrator Guide:

• Set up SMS messaging 

• Request an SMS-enabled phone number through AWS End User Messaging SMS 

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

Agents do not initiate the outbound API, which means that they do not dial the contact. If the 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.

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.

When using PreviousContactId and RelatedContactId input parameters, note the following:

• PreviousContactId

  • Any updates to user-defined task contact attributes on any contact linked through the same PreviousContactId will affect every contact in the chain.

  • There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same PreviousContactId.

• RelatedContactId

  • Copies contact attributes from the related task contact to the new contact.

  • Any update on attributes in a new task contact does not update attributes on previous contact.

  • There’s no limit on the number of task contacts that can be created that use the same RelatedContactId.

In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID, QuickConnectID, or TaskTemplateID. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the TaskTemplateID is specified but it does not have a flow configured, the request returns an error because Amazon Connect cannot identify the unique flow to run when the task is created.

A ServiceQuotaExceededException occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same PreviousContactId. For more information about service quotas for task contacts, see Amazon Connect service quotas  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:

• DISCONNECT

• TRANSFER

• QUEUE_TRANSFER

• EXTERNAL_OUTBOUND

• MONITOR

Chat and task contacts can be terminated in any state, regardless of initiation method.

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.

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.

If a contact evaluation is already in submitted state, this operation will trigger a resubmission.

When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, 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.

The period of time that the recording is suspended is filled with silence in the final recording.

Voice and screen recordings are supported.

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.

Some of the supported resource types are agents, routing profiles, queues, quick connects, flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect .

For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples  in the Amazon Connect Administrator Guide.

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.

Note the following requirements:

• Transfer is supported for only TASK and EMAIL contacts.

• Do not use both QueueId and UserId in the same call.

• The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.

• The TransferContact API can be called only on active contacts.

• A contact cannot be transferred more than 11 times.

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.

Updates agent status.

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

Updates the selected authentication profile.

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

You can create or update user-defined 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. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications  in the Amazon Connect Administrator Guide.

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

Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.

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.

You can also create and update flows using the Amazon Connect Flow language .

Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.

Updates metadata about specified flow.

Updates specified flow module for the specified Amazon Connect instance.

Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.

Updates metadata about specified flow module.

The name of the flow.

You can also create and update flows using the Amazon Connect Flow language .

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 operation does not support partial updates. Instead it does a full update of evaluation form content.

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

Updates the hours of operation.

Update the hours of operation override.

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

Updates the value for the specified attribute type.

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.

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

• If a code is provided: Connect retrieves the identity information from Amazon Cognito and imports it into Connect Customer Profiles.

• If an error is provided: The error branch of the Authenticate Customer block is executed.

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:

• Customer idle timeout

• Customer auto-disconnect timeout

• Agent idle timeout

• Agent auto-disconnect timeout

For more information about how chat timeouts work, see Set up chat timeouts for human participants .

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.

Updates the hours of operation for the specified queue.

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.

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.

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.

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 status of the queue.

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.

Use the Rules Function language  to code conditions for the rule.

Updates a security profile.

For information about security profiles, see Security Profiles  in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions .

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.

For more information about updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions   in the Amazon Connect Administrator Guide.

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.

It performs content validation if Status is set to SAVED and performs full content validation if Status is PUBLISHED. Note that the $SAVED alias' content will always be updated, but the $LATEST alias' content will only be updated if Status is PUBLISHED.