amazonaws.com – connect

OpenAPI apis-guru cloud

Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center and provide reliable customer engagement at any scale.

Amazon Connect provides metrics and real-time reporting that enable you to optimize contact routing. You can also resolve customer issues more efficiently by getting customers in touch with the appropriate agents.

There are limits to the number of Amazon Connect resources that you can create. There are also limits to the number of requests that you can make per second. For more information, see in the Amazon Connect Administrator Guide.

You can connect programmatically to an Amazon Web Services service by using an endpoint. For a list of Amazon Connect endpoints, see .

Homepage: https://api.apis.guru/v2/specs/amazonaws.com:connect/2017-08-08.json
Provider: amazonaws.com:connect / connect
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/amazonaws.com/connect/2017-08-08/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/amazonaws.com/connect/2017-08-08/openapi.yaml

Tools (173)

Extracted live via the executor SDK.

agentStatus.createAgentStatus

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

Creates an agent status for the specified Amazon Connect instance.
agentStatus.describeAgentStatus

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

Describes an agent status.
agentStatus.listAgentStatuses

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

Lists agent statuses.
agentStatus.updateAgentStatus

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

Updates agent status.
contact.createParticipant

Adds a new participant into an on-going chat contact. For more information, see .
contact.getContactAttributes

Retrieves the contact attributes for the specified contact.
contact.listContactReferences

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.
contact.monitorContact

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.
contact.resumeContactRecording

When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call.

Only voice recordings are supported at this time.
contact.startChatContact
Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the 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 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 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 Services Support.

For more information about chat, see in the Amazon Connect Administrator Guide.
contact.startContactRecording
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 block.

Only voice recordings are supported at this time.
contact.startContactStreaming

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

For more information about message streaming, see in the Amazon Connect Administrator Guide.
contact.startOutboundVoiceContact

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.

UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see in the Amazon Connect Administrator Guide.

Campaign calls are not allowed by default. Before you can make a call with TrafficType = CAMPAIGN, you must submit a service quota increase request to the quota .
contact.startTaskContact

Initiates a flow to start a new task.
contact.stopContact
Ends the specified contact. This call does not work for the following initiation methods:
- DISCONNECT
- TRANSFER
- QUEUE_TRANSFER
contact.stopContactRecording

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.
contact.stopContactStreaming

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

When a contact is being recorded, this API suspends recording the call. For example, you might suspend the call recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording.

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

Only voice recordings are supported at this time.
contact.transferContact
Transfers 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 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.
contact.updateContactAttributes

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 in the Amazon Connect Administrator Guide.
contact.updateContactSchedule

Updates the scheduled time of a task contact that is already scheduled.
contact.updateParticipantRoleConfig
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 .
contactFlowModules.createContactFlowModule

Creates a flow module for the specified Amazon Connect instance.
contactFlowModules.deleteContactFlowModule

Deletes the specified flow module.
contactFlowModules.describeContactFlowModule

Describes the specified flow module.
contactFlowModules.updateContactFlowModuleContent

Updates specified flow module for the specified Amazon Connect instance.
contactFlowModules.updateContactFlowModuleMetadata

Updates metadata about specified flow module.
contactFlowModulesSummary.listContactFlowModules

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

Creates a flow for the specified Amazon Connect instance.

You can also create and update flows using the .
contactFlows.deleteContactFlow

Deletes a flow for the specified Amazon Connect instance.
contactFlows.describeContactFlow

Describes the specified flow.

You can also create and update flows using the .
contactFlows.updateContactFlowContent

Updates the specified flow.

You can also create and update flows using the .
contactFlows.updateContactFlowMetadata

Updates metadata about specified flow.
contactFlows.updateContactFlowName

The name of the flow.

You can also create and update flows using the .
contactFlowsSummary.listContactFlows

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

You can also create and update flows using the .

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

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

Describes the specified contact.

Contact information remains available in Amazon Connect for 24 months, and then it is deleted.

Only data from November 12, 2021, and later is returned by this API.
contacts.updateContact

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.

You can add or update user-defined contact information for both ongoing and completed contacts.
defaultVocabulary.associateDefaultVocabulary

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.
defaultVocabularySummary.listDefaultVocabularies

Lists the default vocabularies for the specified Amazon Connect instance.
hoursOfOperations.createHoursOfOperation

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

Creates hours of operation.
hoursOfOperations.deleteHoursOfOperation

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

Deletes an hours of operation.
hoursOfOperations.describeHoursOfOperation

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

Describes the hours of operation.
hoursOfOperations.updateHoursOfOperation

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

Updates the hours of operation.
hoursOfOperationsSummary.listHoursOfOperations

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

For more information about hours of operation, see in the Amazon Connect Administrator Guide.
instance.associateApprovedOrigin

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

Associates an approved origin to an Amazon Connect instance.
instance.associateBot

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.
instance.associateInstanceStorageConfig

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.
instance.associateLambdaFunction

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.
instance.associateLexBot

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.
instance.associateSecurityKey

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

Associates a security key to the instance.
instance.createInstance

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.

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.
instance.createIntegrationAssociation

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

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

Creates a use case for an integration association.
instance.deleteInstance

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

Deletes the Amazon Connect instance.

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.
instance.deleteIntegrationAssociation

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

Deletes the task template.
instance.deleteUseCase

Deletes a use case from an integration association.
instance.describeInstance

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.
instance.describeInstanceAttribute

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

Describes the specified instance attribute.
instance.describeInstanceStorageConfig

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.
instance.disassociateApprovedOrigin

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

Revokes access to integrated applications from Amazon Connect.
instance.disassociateBot

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.
instance.disassociateInstanceStorageConfig

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.
instance.disassociateLambdaFunction

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.
instance.disassociateLexBot

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.
instance.disassociateSecurityKey

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

Deletes the specified security key.
instance.getTaskTemplate

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

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.
instance.listBots

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 returns both Amazon Lex V1 and V2 bots.
instance.listInstanceAttributes

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.
instance.listInstances

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.
instance.listInstanceStorageConfigs

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.
instance.listIntegrationAssociations

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

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.
instance.listLexBots

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 API.
instance.listSecurityKeys

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.
instance.listTaskTemplates

Lists task templates for the specified Amazon Connect instance.
instance.listUseCases

Lists the use cases for the integration association.
instance.replicateInstance

Replicates an Amazon Connect instance in the specified Amazon Web Services Region.

For more information about replicating an Amazon Connect instance, see in the Amazon Connect Administrator Guide.
instance.updateInstanceAttribute

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

Updates the value for the specified attribute type.
instance.updateInstanceStorageConfig

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.
instance.updateTaskTemplate

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.
metrics.getCurrentMetricData

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

For a description of each metric, see in the Amazon Connect Administrator Guide.
metrics.getCurrentUserData

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

Gets historical metric data from the specified Amazon Connect instance.

For a description of each historical metric, see in the Amazon Connect Administrator Guide.
metrics.getMetricDataV2

Gets metric data from the specified Amazon Connect instance.

GetMetricDataV2 offers more features than , 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 14 days, in 24-hour intervals.

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

This API is not available in the Amazon Web Services GovCloud (US) Regions.
phoneNumber.associatePhoneNumberContactFlow

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

If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.
phoneNumber.claimPhoneNumber

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 and in the Amazon Connect Administrator Guide.

You can call the API for available phone numbers that you can claim. Call the API to verify the status of a previous operation.
phoneNumber.describePhoneNumber

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

If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.
phoneNumber.disassociatePhoneNumberContactFlow

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

If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.
phoneNumber.listPhoneNumbersV2

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 in the Amazon Connect Administrator Guide.
phoneNumber.releasePhoneNumber

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.

To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect console.

After releasing a phone number, the phone number enters into a cooldown period of 30 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.
phoneNumber.searchAvailablePhoneNumbers

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.
phoneNumber.updatePhoneNumber

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.

You can call API to verify the status of a previous operation.
phoneNumbersSummary.listPhoneNumbers

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

For more information about phone numbers, see in the Amazon Connect Administrator Guide.

The phone number Arn value that is returned from each of the items in the cannot be used to tag phone number resources. It will fail with a ResourceNotFoundException. Instead, use the API. It returns the new phone number ARN that can be used to tag phone number resources.
promptsSummary.listPrompts

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

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

Associates a set of quick connects with a queue.
queues.createQueue

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

Creates a new queue for the specified Amazon Connect instance.

If the number being used in the input is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the OutboundCallerIdNumberId value of the request body parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.
queues.describeQueue

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

Describes the specified queue.
queues.disassociateQueueQuickConnects

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

Disassociates a set of quick connects from a queue.
queues.listQueueQuickConnects

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

Lists the quick connects associated with a queue.
queues.updateQueueHoursOfOperation

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

Updates the hours of operation for the specified queue.
queues.updateQueueMaxContacts

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.
queues.updateQueueName

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.
queues.updateQueueOutboundCallerConfig

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.

If the number being used in the input is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the OutboundCallerIdNumberId value of the request body parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.
queues.updateQueueStatus

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

Updates the status of the queue.
queuesSummary.listQueues

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 in the Amazon Connect Administrator Guide.
quickConnects.createQuickConnect

Creates a quick connect for the specified Amazon Connect instance.
quickConnects.deleteQuickConnect

Deletes a quick connect.
quickConnects.describeQuickConnect

Describes the quick connect.
quickConnects.listQuickConnects

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

Updates the configuration settings for the specified quick connect.
quickConnects.updateQuickConnectName

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.
routingProfiles.associateRoutingProfileQueues

Associates a set of queues with a routing profile.
routingProfiles.createRoutingProfile

Creates a new routing profile.
routingProfiles.describeRoutingProfile

Describes the specified routing profile.
routingProfiles.disassociateRoutingProfileQueues

Disassociates a set of queues from a routing profile.
routingProfiles.listRoutingProfileQueues

Lists the queues associated with a routing profile.
routingProfiles.updateRoutingProfileConcurrency

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

Updates the default outbound queue of a routing profile.
routingProfiles.updateRoutingProfileName

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.
routingProfiles.updateRoutingProfileQueues

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

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

For more information about routing profiles, see and in the Amazon Connect Administrator Guide.
rules.createRule

Creates a rule for the specified Amazon Connect instance.

Use the to code conditions for the rule.
rules.deleteRule

Deletes a rule for the specified Amazon Connect instance.
rules.describeRule

Describes a rule for the specified Amazon Connect instance.
rules.listRules

List all rules for the specified Amazon Connect instance.
rules.updateRule

Updates a rule for the specified Amazon Connect instance.

Use the to code conditions for the rule.
searchQueues.postOperation

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

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

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

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

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

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

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

AfterContactWorkTimeLimit is returned in milliseconds.
securityProfiles.createSecurityProfile

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

Creates a security profile.
securityProfiles.deleteSecurityProfile

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

Deletes a security profile.
securityProfiles.describeSecurityProfile

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

Gets basic information about the security profle.
securityProfiles.updateSecurityProfile

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

Updates a security profile.
securityProfilesPermissions.listSecurityProfilePermissions

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

Lists the permissions granted to a security profile.
securityProfilesSummary.listSecurityProfiles

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

For more information about security profiles, see in the Amazon Connect Administrator Guide.
tags.listTagsForResource

Lists the tags for the specified resource.

For sample policies that use tags, see in the Amazon Connect Administrator Guide.
tags.tagResource

Adds the specified tags to the specified resource.

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

For sample policies that use tags, see in the Amazon Connect Administrator Guide.
tags.untagResource

Removes the specified tags from the specified resource.
trafficDistribution.getTrafficDistribution

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

Updates the traffic distribution for a given traffic distribution group.

For more information about updating a traffic distribution group, see in the Amazon Connect Administrator Guide.
trafficDistributionGroup.createTrafficDistributionGroup

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

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

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 in the Amazon Connect Administrator Guide.
trafficDistributionGroup.describeTrafficDistributionGroup

Gets details and status of a traffic distribution group.
trafficDistributionGroups.listTrafficDistributionGroups

Lists traffic distribution groups.
user.getFederationToken

Retrieves a token for federation.

This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears:

Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect
userHierarchyGroups.createUserHierarchyGroup

Creates a new user hierarchy group.
userHierarchyGroups.deleteUserHierarchyGroup

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

Describes the specified hierarchy group.
userHierarchyGroups.updateUserHierarchyGroupName

Updates the name of the user hierarchy group.
userHierarchyGroupsSummary.listUserHierarchyGroups

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

For more information about agent hierarchies, see in the Amazon Connect Administrator Guide.
userHierarchyStructure.describeUserHierarchyStructure

Describes the hierarchy structure of the specified Amazon Connect instance.
userHierarchyStructure.updateUserHierarchyStructure

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

Creates a user account for the specified Amazon Connect instance.

For information about how to create user accounts using the Amazon Connect console, see in the Amazon Connect Administrator Guide.
users.deleteUser

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 in the Amazon Connect Administrator Guide.
users.describeUser

Describes the specified user account. You can (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.
users.dismissUserContact

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 .
users.putUserStatus

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 and in the Amazon Connect Administrator Guide.
users.updateUserHierarchy

Assigns the specified hierarchy group to the specified user.
users.updateUserIdentityInfo

Updates the identity information for the specified user.

We strongly recommend limiting who has the ability to invoke UpdateUserIdentityInfo. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see in the Amazon Connect Administrator Guide.
users.updateUserPhoneConfig

Updates the phone configuration settings for the specified user.
users.updateUserRoutingProfile

Assigns the specified routing profile to the specified user.
users.updateUserSecurityProfiles

Assigns the specified security profiles to the specified user.
usersSummary.listUsers

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

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.
vocabulary.describeVocabulary

Describes the specified vocabulary.
vocabularyRemove.deleteVocabulary

Deletes the vocabulary that has the given identifier.
vocabularySummary.searchVocabularies

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

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools