AWS SDK for C++AWS SDK for C++ Version 1.11.546 |
#include <ConnectClient.h>
Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center and provide reliable customer engagement at any scale.
Amazon Connect provides metrics and real-time reporting that enable you to optimize contact routing. You can also resolve customer issues more efficiently by getting customers in touch with the appropriate agents.
There are limits to the number of Amazon Connect resources that you can create. There are also limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
You can use an endpoint to connect programmatically to an Amazon Web Services service. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
Definition at line 39 of file ConnectClient.h.
Definition at line 42 of file ConnectClient.h.
Definition at line 46 of file ConnectClient.h.
Definition at line 47 of file ConnectClient.h.
Aws::Connect::ConnectClientConfiguration()
,
nullptr
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Connect::ConnectClientConfiguration()
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Connect::ConnectClientConfiguration()
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form.
nullptr
An Async wrapper for ActivateEvaluationForm that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 119 of file ConnectClient.h.
A Callable wrapper for ActivateEvaluationForm that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 110 of file ConnectClient.h.
Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.
nullptr
An Async wrapper for AssociateAnalyticsDataSet that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 146 of file ConnectClient.h.
A Callable wrapper for AssociateAnalyticsDataSet that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 137 of file ConnectClient.h.
nullptr
An Async wrapper for AssociateApprovedOrigin that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 173 of file ConnectClient.h.
A Callable wrapper for AssociateApprovedOrigin that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 164 of file ConnectClient.h.
nullptr
An Async wrapper for AssociateBot that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 200 of file ConnectClient.h.
A Callable wrapper for AssociateBot that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 191 of file ConnectClient.h.
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.
nullptr
An Async wrapper for AssociateDefaultVocabulary that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 227 of file ConnectClient.h.
A Callable wrapper for AssociateDefaultVocabulary that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 218 of file ConnectClient.h.
nullptr
An Async wrapper for AssociateFlow that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 252 of file ConnectClient.h.
A Callable wrapper for AssociateFlow that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 243 of file ConnectClient.h.
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.
nullptr
An Async wrapper for AssociateInstanceStorageConfig that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 284 of file ConnectClient.h.
A Callable wrapper for AssociateInstanceStorageConfig that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 275 of file ConnectClient.h.
nullptr
An Async wrapper for AssociateLambdaFunction that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 311 of file ConnectClient.h.
A Callable wrapper for AssociateLambdaFunction that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 302 of file ConnectClient.h.
nullptr
An Async wrapper for AssociateLexBot that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 339 of file ConnectClient.h.
A Callable wrapper for AssociateLexBot that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 330 of file ConnectClient.h.
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
.
nullptr
An Async wrapper for AssociatePhoneNumberContactFlow that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 374 of file ConnectClient.h.
A Callable wrapper for AssociatePhoneNumberContactFlow that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 365 of file ConnectClient.h.
This API is in preview release for Amazon Connect and is subject to change.
Associates a set of quick connects with a queue.
nullptr
An Async wrapper for AssociateQueueQuickConnects that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 401 of file ConnectClient.h.
A Callable wrapper for AssociateQueueQuickConnects that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 392 of file ConnectClient.h.
nullptr
An Async wrapper for AssociateRoutingProfileQueues that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 427 of file ConnectClient.h.
A Callable wrapper for AssociateRoutingProfileQueues that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 418 of file ConnectClient.h.
This API is in preview release for Amazon Connect and is subject to change.
Associates a security key to the instance.
nullptr
An Async wrapper for AssociateSecurityKey that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 454 of file ConnectClient.h.
A Callable wrapper for AssociateSecurityKey that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 445 of file ConnectClient.h.
Associates an agent with a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
nullptr
An Async wrapper for AssociateTrafficDistributionGroupUser that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 481 of file ConnectClient.h.
A Callable wrapper for AssociateTrafficDistributionGroupUser that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 472 of file ConnectClient.h.
nullptr
An Async wrapper for AssociateUserProficiencies that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 506 of file ConnectClient.h.
A Callable wrapper for AssociateUserProficiencies that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 497 of file ConnectClient.h.
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.
nullptr
An Async wrapper for BatchAssociateAnalyticsDataSet that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 533 of file ConnectClient.h.
A Callable wrapper for BatchAssociateAnalyticsDataSet that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 524 of file ConnectClient.h.
Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
nullptr
An Async wrapper for BatchDisassociateAnalyticsDataSet that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 560 of file ConnectClient.h.
A Callable wrapper for BatchDisassociateAnalyticsDataSet that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 551 of file ConnectClient.h.
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.
nullptr
An Async wrapper for BatchGetAttachedFileMetadata that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 587 of file ConnectClient.h.
A Callable wrapper for BatchGetAttachedFileMetadata that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 578 of file ConnectClient.h.
nullptr
An Async wrapper for BatchGetFlowAssociation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 613 of file ConnectClient.h.
A Callable wrapper for BatchGetFlowAssociation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 604 of file ConnectClient.h.
Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.
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.
nullptr
An Async wrapper for BatchPutContact that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 646 of file ConnectClient.h.
A Callable wrapper for BatchPutContact that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 637 of file ConnectClient.h.
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.
You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.
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.
nullptr
An Async wrapper for ClaimPhoneNumber that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 697 of file ConnectClient.h.
A Callable wrapper for ClaimPhoneNumber that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 688 of file ConnectClient.h.
Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
nullptr
An Async wrapper for CompleteAttachedFileUpload that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 724 of file ConnectClient.h.
A Callable wrapper for CompleteAttachedFileUpload that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 715 of file ConnectClient.h.
nullptr
An Async wrapper for CreateAgentStatus that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 751 of file ConnectClient.h.
A Callable wrapper for CreateAgentStatus that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 742 of file ConnectClient.h.
Only the EMAIL channel is supported. The supported initiation methods are: OUTBOUND, AGENT_REPLY, and FLOW.
Creates a new EMAIL contact.
nullptr
An Async wrapper for CreateContact that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 778 of file ConnectClient.h.
A Callable wrapper for CreateContact that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 769 of file ConnectClient.h.
Creates a flow for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
nullptr
An Async wrapper for CreateContactFlow that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 806 of file ConnectClient.h.
A Callable wrapper for CreateContactFlow that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 797 of file ConnectClient.h.
nullptr
An Async wrapper for CreateContactFlowModule that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 832 of file ConnectClient.h.
A Callable wrapper for CreateContactFlowModule that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 823 of file ConnectClient.h.
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
.
nullptr
An Async wrapper for CreateContactFlowVersion that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 862 of file ConnectClient.h.
A Callable wrapper for CreateContactFlowVersion that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 853 of file ConnectClient.h.
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.
nullptr
An Async wrapper for CreateEmailAddress that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 891 of file ConnectClient.h.
A Callable wrapper for CreateEmailAddress that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 882 of file ConnectClient.h.
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.
nullptr
An Async wrapper for CreateEvaluationForm that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 919 of file ConnectClient.h.
A Callable wrapper for CreateEvaluationForm that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 910 of file ConnectClient.h.
This API is in preview release for Amazon Connect and is subject to change.
Creates hours of operation.
nullptr
An Async wrapper for CreateHoursOfOperation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 945 of file ConnectClient.h.
A Callable wrapper for CreateHoursOfOperation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 936 of file ConnectClient.h.
Creates an hours of operation override in an Amazon Connect hours of operation resource
nullptr
An Async wrapper for CreateHoursOfOperationOverride that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 971 of file ConnectClient.h.
A Callable wrapper for CreateHoursOfOperationOverride that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 962 of file ConnectClient.h.
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.
nullptr
An Async wrapper for CreateInstance that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1009 of file ConnectClient.h.
A Callable wrapper for CreateInstance that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1000 of file ConnectClient.h.
Creates an Amazon Web Services resource association with an Amazon Connect instance.
nullptr
An Async wrapper for CreateIntegrationAssociation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1035 of file ConnectClient.h.
A Callable wrapper for CreateIntegrationAssociation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1026 of file ConnectClient.h.
Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.
nullptr
An Async wrapper for CreateParticipant that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1064 of file ConnectClient.h.
A Callable wrapper for CreateParticipant that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1055 of file ConnectClient.h.
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.
nullptr
An Async wrapper for CreatePersistentContactAssociation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1093 of file ConnectClient.h.
A Callable wrapper for CreatePersistentContactAssociation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1084 of file ConnectClient.h.
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.
nullptr
An Async wrapper for CreatePredefinedAttribute that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1124 of file ConnectClient.h.
A Callable wrapper for CreatePredefinedAttribute that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1115 of file ConnectClient.h.
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.
nullptr
An Async wrapper for CreatePrompt that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1153 of file ConnectClient.h.
A Callable wrapper for CreatePrompt that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1144 of file ConnectClient.h.
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.
nullptr
An Async wrapper for CreatePushNotificationRegistration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1183 of file ConnectClient.h.
A Callable wrapper for CreatePushNotificationRegistration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1174 of file ConnectClient.h.
Creates a new queue for the specified Amazon Connect instance.
If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId
. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is 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
.
Only use the phone number ARN format that doesn't contain instance
in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid
. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.
If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
nullptr
An Async wrapper for CreateQueue that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1227 of file ConnectClient.h.
A Callable wrapper for CreateQueue that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1218 of file ConnectClient.h.
nullptr
An Async wrapper for CreateQuickConnect that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1253 of file ConnectClient.h.
A Callable wrapper for CreateQuickConnect that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1244 of file ConnectClient.h.
nullptr
An Async wrapper for CreateRoutingProfile that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1278 of file ConnectClient.h.
A Callable wrapper for CreateRoutingProfile that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1269 of file ConnectClient.h.
Creates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
nullptr
An Async wrapper for CreateRule that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1306 of file ConnectClient.h.
A Callable wrapper for CreateRule that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1297 of file ConnectClient.h.
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.
nullptr
An Async wrapper for CreateSecurityProfile that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1337 of file ConnectClient.h.
A Callable wrapper for CreateSecurityProfile that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1328 of file ConnectClient.h.
nullptr
An Async wrapper for CreateTaskTemplate that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1363 of file ConnectClient.h.
A Callable wrapper for CreateTaskTemplate that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1354 of file ConnectClient.h.
Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
The SignInConfig
distribution is available only on a default TrafficDistributionGroup
(see the IsDefault
parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution
with a modified SignInConfig
and a non-default TrafficDistributionGroup
, an InvalidRequestException
is returned.
For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Amazon Connect Administrator Guide.
nullptr
An Async wrapper for CreateTrafficDistributionGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1400 of file ConnectClient.h.
A Callable wrapper for CreateTrafficDistributionGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1391 of file ConnectClient.h.
nullptr
An Async wrapper for CreateUseCase that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1426 of file ConnectClient.h.
A Callable wrapper for CreateUseCase that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1417 of file ConnectClient.h.
Creates a user account for the specified Amazon Connect instance.
Certain UserIdentityInfo parameters are required in some situations. For example, Email
is required if you are using SAML for identity management. FirstName
and LastName
are required if you are using Amazon Connect or SAML for identity management.
For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.
nullptr
An Async wrapper for CreateUser that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1461 of file ConnectClient.h.
A Callable wrapper for CreateUser that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1452 of file ConnectClient.h.
nullptr
An Async wrapper for CreateUserHierarchyGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1486 of file ConnectClient.h.
A Callable wrapper for CreateUserHierarchyGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1477 of file ConnectClient.h.
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.
nullptr
An Async wrapper for CreateView that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1519 of file ConnectClient.h.
A Callable wrapper for CreateView that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1510 of file ConnectClient.h.
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.
nullptr
An Async wrapper for CreateViewVersion that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1548 of file ConnectClient.h.
A Callable wrapper for CreateViewVersion that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1539 of file ConnectClient.h.
nullptr
An Async wrapper for CreateVocabulary that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1577 of file ConnectClient.h.
A Callable wrapper for CreateVocabulary that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1568 of file ConnectClient.h.
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.
nullptr
An Async wrapper for DeactivateEvaluationForm that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1604 of file ConnectClient.h.
A Callable wrapper for DeactivateEvaluationForm that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1595 of file ConnectClient.h.
Deletes an attached file along with the underlying S3 Object.
The attached file is permanently deleted if S3 bucket versioning is not enabled.
nullptr
An Async wrapper for DeleteAttachedFile that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1631 of file ConnectClient.h.
A Callable wrapper for DeleteAttachedFile that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1622 of file ConnectClient.h.
nullptr
An Async wrapper for DeleteContactEvaluation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1657 of file ConnectClient.h.
A Callable wrapper for DeleteContactEvaluation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1648 of file ConnectClient.h.
nullptr
An Async wrapper for DeleteContactFlow that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1683 of file ConnectClient.h.
A Callable wrapper for DeleteContactFlow that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1674 of file ConnectClient.h.
nullptr
An Async wrapper for DeleteContactFlowModule that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1708 of file ConnectClient.h.
A Callable wrapper for DeleteContactFlowModule that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1699 of file ConnectClient.h.
nullptr
An Async wrapper for DeleteContactFlowVersion that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1734 of file ConnectClient.h.
A Callable wrapper for DeleteContactFlowVersion that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1725 of file ConnectClient.h.
nullptr
An Async wrapper for DeleteEmailAddress that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1760 of file ConnectClient.h.
A Callable wrapper for DeleteEmailAddress that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1751 of file ConnectClient.h.
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.
nullptr
An Async wrapper for DeleteEvaluationForm that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1789 of file ConnectClient.h.
A Callable wrapper for DeleteEvaluationForm that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1780 of file ConnectClient.h.
This API is in preview release for Amazon Connect and is subject to change.
Deletes an hours of operation.
nullptr
An Async wrapper for DeleteHoursOfOperation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1815 of file ConnectClient.h.
A Callable wrapper for DeleteHoursOfOperation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1806 of file ConnectClient.h.
Deletes an hours of operation override in an Amazon Connect hours of operation resource
nullptr
An Async wrapper for DeleteHoursOfOperationOverride that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1841 of file ConnectClient.h.
A Callable wrapper for DeleteHoursOfOperationOverride that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1832 of file ConnectClient.h.
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.
nullptr
An Async wrapper for DeleteInstance that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1875 of file ConnectClient.h.
A Callable wrapper for DeleteInstance that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1866 of file ConnectClient.h.
Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.
nullptr
An Async wrapper for DeleteIntegrationAssociation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1902 of file ConnectClient.h.
A Callable wrapper for DeleteIntegrationAssociation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1893 of file ConnectClient.h.
Deletes a predefined attribute from the specified Amazon Connect instance.
nullptr
An Async wrapper for DeletePredefinedAttribute that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1928 of file ConnectClient.h.
A Callable wrapper for DeletePredefinedAttribute that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1919 of file ConnectClient.h.
nullptr
An Async wrapper for DeletePrompt that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1953 of file ConnectClient.h.
A Callable wrapper for DeletePrompt that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1944 of file ConnectClient.h.
nullptr
An Async wrapper for DeletePushNotificationRegistration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1979 of file ConnectClient.h.
A Callable wrapper for DeletePushNotificationRegistration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1970 of file ConnectClient.h.
nullptr
An Async wrapper for DeleteQueue that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2004 of file ConnectClient.h.
A Callable wrapper for DeleteQueue that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1995 of file ConnectClient.h.
Deletes a quick connect.
After calling DeleteUser, it's important to call DeleteQuickConnect
to delete any records related to the deleted users. This will help you:
Avoid dangling resources that impact your service quotas.
Remove deleted users so they don't appear to agents as transfer options.
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.
nullptr
An Async wrapper for DeleteQuickConnect that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2039 of file ConnectClient.h.
A Callable wrapper for DeleteQuickConnect that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2030 of file ConnectClient.h.
nullptr
An Async wrapper for DeleteRoutingProfile that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2064 of file ConnectClient.h.
A Callable wrapper for DeleteRoutingProfile that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2055 of file ConnectClient.h.
nullptr
An Async wrapper for DeleteRule that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2090 of file ConnectClient.h.
A Callable wrapper for DeleteRule that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2081 of file ConnectClient.h.
nullptr
An Async wrapper for DeleteSecurityProfile that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2115 of file ConnectClient.h.
A Callable wrapper for DeleteSecurityProfile that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2106 of file ConnectClient.h.
nullptr
An Async wrapper for DeleteTaskTemplate that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2140 of file ConnectClient.h.
A Callable wrapper for DeleteTaskTemplate that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2131 of file ConnectClient.h.
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.
nullptr
An Async wrapper for DeleteTrafficDistributionGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2170 of file ConnectClient.h.
A Callable wrapper for DeleteTrafficDistributionGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2161 of file ConnectClient.h.
nullptr
An Async wrapper for DeleteUseCase that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2196 of file ConnectClient.h.
A Callable wrapper for DeleteUseCase that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2187 of file ConnectClient.h.
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.
After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you:
Avoid dangling resources that impact your service quotas.
Remove deleted users so they don't appear to agents as transfer options.
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.
nullptr
An Async wrapper for DeleteUser that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2235 of file ConnectClient.h.
A Callable wrapper for DeleteUser that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2226 of file ConnectClient.h.
Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
nullptr
An Async wrapper for DeleteUserHierarchyGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2261 of file ConnectClient.h.
A Callable wrapper for DeleteUserHierarchyGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2252 of file ConnectClient.h.
Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).
nullptr
An Async wrapper for DeleteView that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2287 of file ConnectClient.h.
A Callable wrapper for DeleteView that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2278 of file ConnectClient.h.
nullptr
An Async wrapper for DeleteViewVersion that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2313 of file ConnectClient.h.
A Callable wrapper for DeleteViewVersion that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2304 of file ConnectClient.h.
nullptr
An Async wrapper for DeleteVocabulary that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2339 of file ConnectClient.h.
A Callable wrapper for DeleteVocabulary that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2330 of file ConnectClient.h.
This API is in preview release for Amazon Connect and is subject to change.
Describes an agent status.
nullptr
An Async wrapper for DescribeAgentStatus that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2365 of file ConnectClient.h.
A Callable wrapper for DescribeAgentStatus that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2356 of file ConnectClient.h.
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.
nullptr
An Async wrapper for DescribeAuthenticationProfile that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2392 of file ConnectClient.h.
A Callable wrapper for DescribeAuthenticationProfile that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2383 of file ConnectClient.h.
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
CustomerEndpoint
and SystemEndpoint
are only populated for EMAIL contacts.
Contact information remains available in Amazon Connect for 24 months from the InitiationTimestamp
, and then it is deleted. Only contact information that is available in Amazon Connect is returned by this API.
nullptr
An Async wrapper for DescribeContact that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2423 of file ConnectClient.h.
A Callable wrapper for DescribeContact that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2414 of file ConnectClient.h.
Describes a contact evaluation in the specified Amazon Connect instance.
nullptr
An Async wrapper for DescribeContactEvaluation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2449 of file ConnectClient.h.
A Callable wrapper for DescribeContactEvaluation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2440 of file ConnectClient.h.
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
nullptr
An Async wrapper for DescribeContactFlow that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2487 of file ConnectClient.h.
A Callable wrapper for DescribeContactFlow that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2478 of file ConnectClient.h.
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.
nullptr
An Async wrapper for DescribeContactFlowModule that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2516 of file ConnectClient.h.
A Callable wrapper for DescribeContactFlowModule that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2507 of file ConnectClient.h.
nullptr
An Async wrapper for DescribeEmailAddress that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2542 of file ConnectClient.h.
A Callable wrapper for DescribeEmailAddress that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2533 of file ConnectClient.h.
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.
nullptr
An Async wrapper for DescribeEvaluationForm that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2569 of file ConnectClient.h.
A Callable wrapper for DescribeEvaluationForm that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2560 of file ConnectClient.h.
This API is in preview release for Amazon Connect and is subject to change.
Describes the hours of operation.
nullptr
An Async wrapper for DescribeHoursOfOperation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2595 of file ConnectClient.h.
A Callable wrapper for DescribeHoursOfOperation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2586 of file ConnectClient.h.
nullptr
An Async wrapper for DescribeHoursOfOperationOverride that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2620 of file ConnectClient.h.
A Callable wrapper for DescribeHoursOfOperationOverride that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2611 of file ConnectClient.h.
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.
nullptr
An Async wrapper for DescribeInstance that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2651 of file ConnectClient.h.
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified instance attribute.
nullptr
An Async wrapper for DescribeInstanceAttribute that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2678 of file ConnectClient.h.
A Callable wrapper for DescribeInstanceAttribute that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2669 of file ConnectClient.h.
A Callable wrapper for DescribeInstance that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2642 of file ConnectClient.h.
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.
nullptr
An Async wrapper for DescribeInstanceStorageConfig that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2705 of file ConnectClient.h.
A Callable wrapper for DescribeInstanceStorageConfig that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2696 of file ConnectClient.h.
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 receive a ResourceNotFoundException
.
nullptr
An Async wrapper for DescribePhoneNumber that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2740 of file ConnectClient.h.
A Callable wrapper for DescribePhoneNumber that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2731 of file ConnectClient.h.
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.
nullptr
An Async wrapper for DescribePredefinedAttribute that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2771 of file ConnectClient.h.
A Callable wrapper for DescribePredefinedAttribute that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2762 of file ConnectClient.h.
nullptr
An Async wrapper for DescribePrompt that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2796 of file ConnectClient.h.
A Callable wrapper for DescribePrompt that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2787 of file ConnectClient.h.
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified queue.
nullptr
An Async wrapper for DescribeQueue that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2822 of file ConnectClient.h.
A Callable wrapper for DescribeQueue that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2813 of file ConnectClient.h.
nullptr
An Async wrapper for DescribeQuickConnect that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2847 of file ConnectClient.h.
A Callable wrapper for DescribeQuickConnect that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2838 of file ConnectClient.h.
nullptr
An Async wrapper for DescribeRoutingProfile that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2872 of file ConnectClient.h.
A Callable wrapper for DescribeRoutingProfile that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2863 of file ConnectClient.h.
nullptr
An Async wrapper for DescribeRule that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2898 of file ConnectClient.h.
A Callable wrapper for DescribeRule that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2889 of file ConnectClient.h.
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.
nullptr
An Async wrapper for DescribeSecurityProfile that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2929 of file ConnectClient.h.
A Callable wrapper for DescribeSecurityProfile that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2920 of file ConnectClient.h.
nullptr
An Async wrapper for DescribeTrafficDistributionGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2955 of file ConnectClient.h.
A Callable wrapper for DescribeTrafficDistributionGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2946 of file ConnectClient.h.
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.
nullptr
An Async wrapper for DescribeUser that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2984 of file ConnectClient.h.
A Callable wrapper for DescribeUser that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2975 of file ConnectClient.h.
nullptr
An Async wrapper for DescribeUserHierarchyGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3009 of file ConnectClient.h.
A Callable wrapper for DescribeUserHierarchyGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3000 of file ConnectClient.h.
Describes the hierarchy structure of the specified Amazon Connect instance.
nullptr
An Async wrapper for DescribeUserHierarchyStructure that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3035 of file ConnectClient.h.
A Callable wrapper for DescribeUserHierarchyStructure that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3026 of file ConnectClient.h.
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, <view-id>:$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.
nullptr
An Async wrapper for DescribeView that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3068 of file ConnectClient.h.
A Callable wrapper for DescribeView that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3059 of file ConnectClient.h.
nullptr
An Async wrapper for DescribeVocabulary that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3093 of file ConnectClient.h.
A Callable wrapper for DescribeVocabulary that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3084 of file ConnectClient.h.
nullptr
An Async wrapper for DisassociateAnalyticsDataSet that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3119 of file ConnectClient.h.
A Callable wrapper for DisassociateAnalyticsDataSet that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3110 of file ConnectClient.h.
nullptr
An Async wrapper for DisassociateApprovedOrigin that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3146 of file ConnectClient.h.
A Callable wrapper for DisassociateApprovedOrigin that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3137 of file ConnectClient.h.
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.
nullptr
An Async wrapper for DisassociateBot that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3173 of file ConnectClient.h.
A Callable wrapper for DisassociateBot that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3164 of file ConnectClient.h.
nullptr
An Async wrapper for DisassociateFlow that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3198 of file ConnectClient.h.
A Callable wrapper for DisassociateFlow that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3189 of file ConnectClient.h.
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.
nullptr
An Async wrapper for DisassociateInstanceStorageConfig that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3225 of file ConnectClient.h.
A Callable wrapper for DisassociateInstanceStorageConfig that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3216 of file ConnectClient.h.
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.
nullptr
An Async wrapper for DisassociateLambdaFunction that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3252 of file ConnectClient.h.
A Callable wrapper for DisassociateLambdaFunction that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3243 of file ConnectClient.h.
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.
nullptr
An Async wrapper for DisassociateLexBot that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3279 of file ConnectClient.h.
A Callable wrapper for DisassociateLexBot that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3270 of file ConnectClient.h.
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
.
nullptr
An Async wrapper for DisassociatePhoneNumberContactFlow that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3315 of file ConnectClient.h.
A Callable wrapper for DisassociatePhoneNumberContactFlow that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3306 of file ConnectClient.h.
This API is in preview release for Amazon Connect and is subject to change.
Disassociates a set of quick connects from a queue.
nullptr
An Async wrapper for DisassociateQueueQuickConnects that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3342 of file ConnectClient.h.
A Callable wrapper for DisassociateQueueQuickConnects that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3333 of file ConnectClient.h.
nullptr
An Async wrapper for DisassociateRoutingProfileQueues that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3368 of file ConnectClient.h.
A Callable wrapper for DisassociateRoutingProfileQueues that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3359 of file ConnectClient.h.
This API is in preview release for Amazon Connect and is subject to change.
Deletes the specified security key.
nullptr
An Async wrapper for DisassociateSecurityKey that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3394 of file ConnectClient.h.
A Callable wrapper for DisassociateSecurityKey that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3385 of file ConnectClient.h.
Disassociates an agent from a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
nullptr
An Async wrapper for DisassociateTrafficDistributionGroupUser that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3421 of file ConnectClient.h.
A Callable wrapper for DisassociateTrafficDistributionGroupUser that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3412 of file ConnectClient.h.
nullptr
An Async wrapper for DisassociateUserProficiencies that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3447 of file ConnectClient.h.
A Callable wrapper for DisassociateUserProficiencies that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3438 of file ConnectClient.h.
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.
nullptr
An Async wrapper for DismissUserContact that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3477 of file ConnectClient.h.
A Callable wrapper for DismissUserContact that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3468 of file ConnectClient.h.
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
.
nullptr
An Async wrapper for GetAttachedFile that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3505 of file ConnectClient.h.
A Callable wrapper for GetAttachedFile that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3496 of file ConnectClient.h.
nullptr
An Async wrapper for GetContactAttributes that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3531 of file ConnectClient.h.
A Callable wrapper for GetContactAttributes that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3522 of file ConnectClient.h.
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.
nullptr
An Async wrapper for GetCurrentMetricData that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3560 of file ConnectClient.h.
A Callable wrapper for GetCurrentMetricData that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3551 of file ConnectClient.h.
Gets the real-time active user data from the specified Amazon Connect instance.
nullptr
An Async wrapper for GetCurrentUserData that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3586 of file ConnectClient.h.
A Callable wrapper for GetCurrentUserData that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3577 of file ConnectClient.h.
nullptr
An Async wrapper for GetEffectiveHoursOfOperations that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3612 of file ConnectClient.h.
A Callable wrapper for GetEffectiveHoursOfOperations that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3603 of file ConnectClient.h.
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.
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
nullptr
An Async wrapper for GetFederationToken that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3647 of file ConnectClient.h.
A Callable wrapper for GetFederationToken that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3638 of file ConnectClient.h.
nullptr
An Async wrapper for GetFlowAssociation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3673 of file ConnectClient.h.
A Callable wrapper for GetFlowAssociation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3664 of file ConnectClient.h.
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.
We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData
. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.
nullptr
An Async wrapper for GetMetricData that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3710 of file ConnectClient.h.
A Callable wrapper for GetMetricData that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3701 of file ConnectClient.h.
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.
nullptr
An Async wrapper for GetMetricDataV2 that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3746 of file ConnectClient.h.
A Callable wrapper for GetMetricDataV2 that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3737 of file ConnectClient.h.
nullptr
An Async wrapper for GetPromptFile that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3771 of file ConnectClient.h.
A Callable wrapper for GetPromptFile that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3762 of file ConnectClient.h.
Gets details about a specific task template in the specified Amazon Connect instance.
nullptr
An Async wrapper for GetTaskTemplate that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3797 of file ConnectClient.h.
A Callable wrapper for GetTaskTemplate that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3788 of file ConnectClient.h.
Retrieves the current traffic distribution for a given traffic distribution group.
nullptr
An Async wrapper for GetTrafficDistribution that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3823 of file ConnectClient.h.
A Callable wrapper for GetTrafficDistribution that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3814 of file ConnectClient.h.
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.
Call the DescribePhoneNumber API to verify the status of a previous ImportPhoneNumber
operation.
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.
nullptr
An Async wrapper for ImportPhoneNumber that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3867 of file ConnectClient.h.
A Callable wrapper for ImportPhoneNumber that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3858 of file ConnectClient.h.
This API is in preview release for Amazon Connect and is subject to change.
Lists agent statuses.
nullptr
An Async wrapper for ListAgentStatuses that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3893 of file ConnectClient.h.
A Callable wrapper for ListAgentStatuses that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3884 of file ConnectClient.h.
Lists the association status of requested dataset ID for a given Amazon Connect instance.
nullptr
An Async wrapper for ListAnalyticsDataAssociations that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3919 of file ConnectClient.h.
A Callable wrapper for ListAnalyticsDataAssociations that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3910 of file ConnectClient.h.
Lists the data lake datasets available to associate with for a given Amazon Connect instance.
nullptr
An Async wrapper for ListAnalyticsDataLakeDataSets that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3945 of file ConnectClient.h.
A Callable wrapper for ListAnalyticsDataLakeDataSets that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3936 of file ConnectClient.h.
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.
nullptr
An Async wrapper for ListApprovedOrigins that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3972 of file ConnectClient.h.
A Callable wrapper for ListApprovedOrigins that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3963 of file ConnectClient.h.
Provides information about contact tree, a list of associated contacts with a unique identifier.
nullptr
An Async wrapper for ListAssociatedContacts that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 3998 of file ConnectClient.h.
A Callable wrapper for ListAssociatedContacts that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 3989 of file ConnectClient.h.
nullptr
An Async wrapper for ListAuthenticationProfiles that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4026 of file ConnectClient.h.
A Callable wrapper for ListAuthenticationProfiles that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4017 of file ConnectClient.h.
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.
nullptr
An Async wrapper for ListBots that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4054 of file ConnectClient.h.
A Callable wrapper for ListBots that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4045 of file ConnectClient.h.
nullptr
An Async wrapper for ListContactEvaluations that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4080 of file ConnectClient.h.
A Callable wrapper for ListContactEvaluations that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4071 of file ConnectClient.h.
Provides information about the flow modules for the specified Amazon Connect instance.
nullptr
An Async wrapper for ListContactFlowModules that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4106 of file ConnectClient.h.
A Callable wrapper for ListContactFlowModules that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4097 of file ConnectClient.h.
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.
nullptr
An Async wrapper for ListContactFlows that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4162 of file ConnectClient.h.
A Callable wrapper for ListContactFlows that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4153 of file ConnectClient.h.
Returns all the available versions for the specified Amazon Connect instance and flow identifier.
nullptr
An Async wrapper for ListContactFlowVersions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4132 of file ConnectClient.h.
A Callable wrapper for ListContactFlowVersions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4123 of file ConnectClient.h.
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.
nullptr
An Async wrapper for ListContactReferences that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4191 of file ConnectClient.h.
A Callable wrapper for ListContactReferences that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4182 of file ConnectClient.h.
Lists the default vocabularies for the specified Amazon Connect instance.
nullptr
An Async wrapper for ListDefaultVocabularies that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4217 of file ConnectClient.h.
A Callable wrapper for ListDefaultVocabularies that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4208 of file ConnectClient.h.
nullptr
An Async wrapper for ListEvaluationForms that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4269 of file ConnectClient.h.
A Callable wrapper for ListEvaluationForms that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4260 of file ConnectClient.h.
Lists versions of an evaluation form in the specified Amazon Connect instance.
nullptr
An Async wrapper for ListEvaluationFormVersions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4243 of file ConnectClient.h.
A Callable wrapper for ListEvaluationFormVersions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4234 of file ConnectClient.h.
nullptr
An Async wrapper for ListFlowAssociations that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4294 of file ConnectClient.h.
A Callable wrapper for ListFlowAssociations that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4285 of file ConnectClient.h.
nullptr
An Async wrapper for ListHoursOfOperationOverrides that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4319 of file ConnectClient.h.
A Callable wrapper for ListHoursOfOperationOverrides that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4310 of file ConnectClient.h.
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.
nullptr
An Async wrapper for ListHoursOfOperations that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4348 of file ConnectClient.h.
A Callable wrapper for ListHoursOfOperations that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4339 of file ConnectClient.h.
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.
nullptr
An Async wrapper for ListInstanceAttributes that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4375 of file ConnectClient.h.
A Callable wrapper for ListInstanceAttributes that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4366 of file ConnectClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for ListInstances that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4431 of file ConnectClient.h.
{}
)
const
A Callable wrapper for ListInstances that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4422 of file ConnectClient.h.
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.
nullptr
An Async wrapper for ListInstanceStorageConfigs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4402 of file ConnectClient.h.
A Callable wrapper for ListInstanceStorageConfigs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4393 of file ConnectClient.h.
Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
nullptr
An Async wrapper for ListIntegrationAssociations that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4458 of file ConnectClient.h.
A Callable wrapper for ListIntegrationAssociations that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4449 of file ConnectClient.h.
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.
nullptr
An Async wrapper for ListLambdaFunctions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4485 of file ConnectClient.h.
A Callable wrapper for ListLambdaFunctions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4476 of file ConnectClient.h.
nullptr
An Async wrapper for ListLexBots that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4515 of file ConnectClient.h.
A Callable wrapper for ListLexBots that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4506 of file ConnectClient.h.
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.
We recommend using ListPhoneNumbersV2 to return phone number types. ListPhoneNumbers doesn't support number types UIFN
, SHARED
, THIRD_PARTY_TF
, and THIRD_PARTY_DID
. While it returns numbers of those types, it incorrectly lists them as TOLL_FREE
or DID
.
The phone number Arn
value that is returned from each of the items in the PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with a ResourceNotFoundException
. Instead, use the ListPhoneNumbersV2 API. It returns the new phone number ARN that can be used to tag phone number resources.
nullptr
An Async wrapper for ListPhoneNumbers that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4557 of file ConnectClient.h.
A Callable wrapper for ListPhoneNumbers that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4548 of file ConnectClient.h.
{}
)
const
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.
When given an instance ARN, ListPhoneNumbersV2
returns only the phone numbers claimed to the instance.
When given a traffic distribution group ARN ListPhoneNumbersV2
returns only the phone numbers claimed to the traffic distribution group.
nullptr
,
{}
An Async wrapper for ListPhoneNumbersV2 that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4593 of file ConnectClient.h.
{}
)
const
A Callable wrapper for ListPhoneNumbersV2 that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4584 of file ConnectClient.h.
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.
nullptr
An Async wrapper for ListPredefinedAttributes that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4624 of file ConnectClient.h.
A Callable wrapper for ListPredefinedAttributes that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4615 of file ConnectClient.h.
Provides information about the prompts for the specified Amazon Connect instance.
nullptr
An Async wrapper for ListPrompts that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4650 of file ConnectClient.h.
A Callable wrapper for ListPrompts that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4641 of file ConnectClient.h.
This API is in preview release for Amazon Connect and is subject to change.
Lists the quick connects associated with a queue.
nullptr
An Async wrapper for ListQueueQuickConnects that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4677 of file ConnectClient.h.
A Callable wrapper for ListQueueQuickConnects that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4668 of file ConnectClient.h.
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.
nullptr
An Async wrapper for ListQueues that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4710 of file ConnectClient.h.
A Callable wrapper for ListQueues that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4701 of file ConnectClient.h.
Provides information about the quick connects for the specified Amazon Connect instance.
nullptr
An Async wrapper for ListQuickConnects that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4736 of file ConnectClient.h.
A Callable wrapper for ListQuickConnects that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4727 of file ConnectClient.h.
Provides a list of analysis segments for a real-time chat analysis session. This API supports CHAT channels only.
This API does not support VOICE. If you attempt to use it for VOICE, an InvalidRequestException
occurs.
nullptr
An Async wrapper for ListRealtimeContactAnalysisSegmentsV2 that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4765 of file ConnectClient.h.
A Callable wrapper for ListRealtimeContactAnalysisSegmentsV2 that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4756 of file ConnectClient.h.
nullptr
An Async wrapper for ListRoutingProfileQueues that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4791 of file ConnectClient.h.
A Callable wrapper for ListRoutingProfileQueues that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4782 of file ConnectClient.h.
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.
nullptr
An Async wrapper for ListRoutingProfiles that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4823 of file ConnectClient.h.
A Callable wrapper for ListRoutingProfiles that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4814 of file ConnectClient.h.
nullptr
An Async wrapper for ListRules that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4849 of file ConnectClient.h.
A Callable wrapper for ListRules that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4840 of file ConnectClient.h.
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.
nullptr
An Async wrapper for ListSecurityKeys that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4876 of file ConnectClient.h.
A Callable wrapper for ListSecurityKeys that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4867 of file ConnectClient.h.
Returns a list of third-party applications in a specific security profile.
nullptr
An Async wrapper for ListSecurityProfileApplications that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4902 of file ConnectClient.h.
A Callable wrapper for ListSecurityProfileApplications that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4893 of file ConnectClient.h.
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.
nullptr
An Async wrapper for ListSecurityProfilePermissions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4933 of file ConnectClient.h.
A Callable wrapper for ListSecurityProfilePermissions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4924 of file ConnectClient.h.
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.
nullptr
An Async wrapper for ListSecurityProfiles that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4965 of file ConnectClient.h.
A Callable wrapper for ListSecurityProfiles that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4956 of file ConnectClient.h.
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.
nullptr
An Async wrapper for ListTagsForResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 4994 of file ConnectClient.h.
A Callable wrapper for ListTagsForResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 4985 of file ConnectClient.h.
nullptr
An Async wrapper for ListTaskTemplates that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5020 of file ConnectClient.h.
A Callable wrapper for ListTaskTemplates that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5011 of file ConnectClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for ListTrafficDistributionGroups that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5070 of file ConnectClient.h.
{}
)
const
A Callable wrapper for ListTrafficDistributionGroups that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5061 of file ConnectClient.h.
nullptr
An Async wrapper for ListTrafficDistributionGroupUsers that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5045 of file ConnectClient.h.
A Callable wrapper for ListTrafficDistributionGroupUsers that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5036 of file ConnectClient.h.
nullptr
An Async wrapper for ListUseCases that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5096 of file ConnectClient.h.
A Callable wrapper for ListUseCases that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5087 of file ConnectClient.h.
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.
nullptr
An Async wrapper for ListUserHierarchyGroups that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5126 of file ConnectClient.h.
A Callable wrapper for ListUserHierarchyGroups that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5117 of file ConnectClient.h.
nullptr
An Async wrapper for ListUserProficiencies that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5151 of file ConnectClient.h.
A Callable wrapper for ListUserProficiencies that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5142 of file ConnectClient.h.
Provides summary information about the users for the specified Amazon Connect instance.
nullptr
An Async wrapper for ListUsers that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5177 of file ConnectClient.h.
A Callable wrapper for ListUsers that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5168 of file ConnectClient.h.
Returns views in the given instance.
Results are sorted primarily by type, and secondarily by name.
nullptr
An Async wrapper for ListViews that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5230 of file ConnectClient.h.
A Callable wrapper for ListViews that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5221 of file ConnectClient.h.
Returns all the available versions for the specified Amazon Connect instance and view identifier.
Results will be sorted from highest to lowest.
nullptr
An Async wrapper for ListViewVersions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5204 of file ConnectClient.h.
A Callable wrapper for ListViewVersions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5195 of file ConnectClient.h.
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.
nullptr
An Async wrapper for MonitorContact that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5257 of file ConnectClient.h.
A Callable wrapper for MonitorContact that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5248 of file ConnectClient.h.
nullptr
An Async wrapper for PauseContact that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5282 of file ConnectClient.h.
A Callable wrapper for PauseContact that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5273 of file ConnectClient.h.
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.
nullptr
An Async wrapper for PutUserStatus that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5314 of file ConnectClient.h.
A Callable wrapper for PutUserStatus that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5305 of file ConnectClient.h.
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 admin website.
After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web ServicesSupport.
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.
nullptr
An Async wrapper for ReleasePhoneNumber that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5359 of file ConnectClient.h.
A Callable wrapper for ReleasePhoneNumber that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5350 of file ConnectClient.h.
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.
nullptr
An Async wrapper for ReplicateInstance that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5390 of file ConnectClient.h.
A Callable wrapper for ReplicateInstance that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5381 of file ConnectClient.h.
nullptr
An Async wrapper for ResumeContact that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5416 of file ConnectClient.h.
A Callable wrapper for ResumeContact that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5407 of file ConnectClient.h.
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.
nullptr
An Async wrapper for ResumeContactRecording that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5445 of file ConnectClient.h.
A Callable wrapper for ResumeContactRecording that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5436 of file ConnectClient.h.
Searches AgentStatuses in an Amazon Connect instance, with optional filtering.
nullptr
An Async wrapper for SearchAgentStatuses that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5471 of file ConnectClient.h.
A Callable wrapper for SearchAgentStatuses that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5462 of file ConnectClient.h.
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.
nullptr
An Async wrapper for SearchAvailablePhoneNumbers that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5500 of file ConnectClient.h.
A Callable wrapper for SearchAvailablePhoneNumbers that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5491 of file ConnectClient.h.
Searches the flow modules in an Amazon Connect instance, with optional filtering.
nullptr
An Async wrapper for SearchContactFlowModules that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5526 of file ConnectClient.h.
A Callable wrapper for SearchContactFlowModules that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5517 of file ConnectClient.h.
Searches the flows in an Amazon Connect instance, with optional filtering.
nullptr
An Async wrapper for SearchContactFlows that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5552 of file ConnectClient.h.
A Callable wrapper for SearchContactFlows that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5543 of file ConnectClient.h.
nullptr
An Async wrapper for SearchContacts that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5578 of file ConnectClient.h.
A Callable wrapper for SearchContacts that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5569 of file ConnectClient.h.
nullptr
An Async wrapper for SearchEmailAddresses that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5604 of file ConnectClient.h.
A Callable wrapper for SearchEmailAddresses that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5595 of file ConnectClient.h.
nullptr
An Async wrapper for SearchHoursOfOperationOverrides that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5629 of file ConnectClient.h.
A Callable wrapper for SearchHoursOfOperationOverrides that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5620 of file ConnectClient.h.
Searches the hours of operation in an Amazon Connect instance, with optional filtering.
nullptr
An Async wrapper for SearchHoursOfOperations that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5655 of file ConnectClient.h.
A Callable wrapper for SearchHoursOfOperations that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5646 of file ConnectClient.h.
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.
nullptr
An Async wrapper for SearchPredefinedAttributes that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5686 of file ConnectClient.h.
A Callable wrapper for SearchPredefinedAttributes that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5677 of file ConnectClient.h.
Searches prompts in an Amazon Connect instance, with optional filtering.
nullptr
An Async wrapper for SearchPrompts that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5712 of file ConnectClient.h.
A Callable wrapper for SearchPrompts that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5703 of file ConnectClient.h.
nullptr
An Async wrapper for SearchQueues that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5738 of file ConnectClient.h.
A Callable wrapper for SearchQueues that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5729 of file ConnectClient.h.
Searches quick connects in an Amazon Connect instance, with optional filtering.
nullptr
An Async wrapper for SearchQuickConnects that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5764 of file ConnectClient.h.
A Callable wrapper for SearchQuickConnects that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5755 of file ConnectClient.h.
Searches tags used in an Amazon Connect instance using optional search criteria.
nullptr
An Async wrapper for SearchResourceTags that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5790 of file ConnectClient.h.
A Callable wrapper for SearchResourceTags that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5781 of file ConnectClient.h.
Searches routing profiles in an Amazon Connect instance, with optional filtering.
nullptr
An Async wrapper for SearchRoutingProfiles that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5816 of file ConnectClient.h.
A Callable wrapper for SearchRoutingProfiles that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5807 of file ConnectClient.h.
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.
nullptr
An Async wrapper for SearchSecurityProfiles that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5847 of file ConnectClient.h.
A Callable wrapper for SearchSecurityProfiles that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5838 of file ConnectClient.h.
Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering.
The UserHierarchyGroup with "LevelId": "0"
is the foundation for building levels on top of an instance. It is not user-definable, nor is it visible in the UI.
nullptr
An Async wrapper for SearchUserHierarchyGroups that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5876 of file ConnectClient.h.
A Callable wrapper for SearchUserHierarchyGroups that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5867 of file ConnectClient.h.
Searches users in an Amazon Connect instance, with optional filtering.
AfterContactWorkTimeLimit
is returned in milliseconds.
nullptr
An Async wrapper for SearchUsers that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5903 of file ConnectClient.h.
A Callable wrapper for SearchUsers that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5894 of file ConnectClient.h.
Searches for vocabularies within a specific Amazon Connect instance using State
, NameStartsWith
, and LanguageCode
.
nullptr
An Async wrapper for SearchVocabularies that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5930 of file ConnectClient.h.
A Callable wrapper for SearchVocabularies that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5921 of file ConnectClient.h.
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.
nullptr
An Async wrapper for SendChatIntegrationEvent that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5964 of file ConnectClient.h.
A Callable wrapper for SendChatIntegrationEvent that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5955 of file ConnectClient.h.
Send outbound email for outbound campaigns. For more information about outbound campaigns, see Set up Amazon Connect outbound campaigns.
Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.
nullptr
An Async wrapper for SendOutboundEmail that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 5994 of file ConnectClient.h.
A Callable wrapper for SendOutboundEmail that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 5985 of file ConnectClient.h.
Provides a pre-signed Amazon S3 URL in response for uploading your content.
You may only use this API to upload attachments to an Amazon Connect Case or Amazon Connect Email.
nullptr
An Async wrapper for StartAttachedFileUpload that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6025 of file ConnectClient.h.
A Callable wrapper for StartAttachedFileUpload that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6016 of file ConnectClient.h.
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:
nullptr
An Async wrapper for StartChatContact that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6074 of file ConnectClient.h.
A Callable wrapper for StartChatContact that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6065 of file ConnectClient.h.
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.
Evaluations created through the public API do not contain answer values suggested from automation.
nullptr
An Async wrapper for StartContactEvaluation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6105 of file ConnectClient.h.
A Callable wrapper for StartContactEvaluation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6096 of file ConnectClient.h.
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.
nullptr
An Async wrapper for StartContactRecording that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6143 of file ConnectClient.h.
A Callable wrapper for StartContactRecording that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6134 of file ConnectClient.h.
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:
nullptr
An Async wrapper for StartContactStreaming that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6179 of file ConnectClient.h.
A Callable wrapper for StartContactStreaming that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6170 of file ConnectClient.h.
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.
nullptr
An Async wrapper for StartEmailContact that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6206 of file ConnectClient.h.
A Callable wrapper for StartEmailContact that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6197 of file ConnectClient.h.
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:
nullptr
An Async wrapper for StartOutboundChatContact that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6248 of file ConnectClient.h.
A Callable wrapper for StartOutboundChatContact that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6239 of file ConnectClient.h.
Initiates a flow to send an agent reply or outbound email contact (created from the CreateContact API) to a customer.
nullptr
An Async wrapper for StartOutboundEmailContact that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6274 of file ConnectClient.h.
A Callable wrapper for StartOutboundEmailContact that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6265 of file ConnectClient.h.
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 Amazon Connect Service Quotas 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 Amazon Connect campaigns.
nullptr
An Async wrapper for StartOutboundVoiceContact that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6315 of file ConnectClient.h.
A Callable wrapper for StartOutboundVoiceContact that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6306 of file ConnectClient.h.
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.
nullptr
An Async wrapper for StartScreenSharing that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6344 of file ConnectClient.h.
A Callable wrapper for StartScreenSharing that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6335 of file ConnectClient.h.
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.
nullptr
An Async wrapper for StartTaskContact that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6399 of file ConnectClient.h.
A Callable wrapper for StartTaskContact that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6390 of file ConnectClient.h.
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).
nullptr
An Async wrapper for StartWebRTCContact that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6427 of file ConnectClient.h.
A Callable wrapper for StartWebRTCContact that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6418 of file ConnectClient.h.
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.
nullptr
An Async wrapper for StopContact that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6457 of file ConnectClient.h.
A Callable wrapper for StopContact that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6448 of file ConnectClient.h.
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.
nullptr
An Async wrapper for StopContactRecording that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6488 of file ConnectClient.h.
A Callable wrapper for StopContactRecording that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6479 of file ConnectClient.h.
Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.
nullptr
An Async wrapper for StopContactStreaming that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6516 of file ConnectClient.h.
A Callable wrapper for StopContactStreaming that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6507 of file ConnectClient.h.
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.
nullptr
An Async wrapper for SubmitContactEvaluation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6547 of file ConnectClient.h.
A Callable wrapper for SubmitContactEvaluation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6538 of file ConnectClient.h.
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.
nullptr
An Async wrapper for SuspendContactRecording that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6579 of file ConnectClient.h.
A Callable wrapper for SuspendContactRecording that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6570 of file ConnectClient.h.
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.
nullptr
An Async wrapper for TagContact that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6608 of file ConnectClient.h.
A Callable wrapper for TagContact that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6599 of file ConnectClient.h.
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.
nullptr
An Async wrapper for TagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6642 of file ConnectClient.h.
A Callable wrapper for TagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6633 of file ConnectClient.h.
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.
nullptr
An Async wrapper for TransferContact that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6679 of file ConnectClient.h.
A Callable wrapper for TransferContact that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6670 of file ConnectClient.h.
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.
nullptr
An Async wrapper for UntagContact that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6708 of file ConnectClient.h.
A Callable wrapper for UntagContact that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6699 of file ConnectClient.h.
nullptr
An Async wrapper for UntagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6734 of file ConnectClient.h.
A Callable wrapper for UntagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6725 of file ConnectClient.h.
This API is in preview release for Amazon Connect and is subject to change.
Updates agent status.
nullptr
An Async wrapper for UpdateAgentStatus that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6760 of file ConnectClient.h.
A Callable wrapper for UpdateAgentStatus that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6751 of file ConnectClient.h.
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.
nullptr
An Async wrapper for UpdateAuthenticationProfile that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6787 of file ConnectClient.h.
A Callable wrapper for UpdateAuthenticationProfile that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6778 of file ConnectClient.h.
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.
nullptr
An Async wrapper for UpdateContact that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6817 of file ConnectClient.h.
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.
nullptr
An Async wrapper for UpdateContactAttributes that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6856 of file ConnectClient.h.
A Callable wrapper for UpdateContactAttributes that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6847 of file ConnectClient.h.
A Callable wrapper for UpdateContact that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6808 of file ConnectClient.h.
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.
nullptr
An Async wrapper for UpdateContactEvaluation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6885 of file ConnectClient.h.
A Callable wrapper for UpdateContactEvaluation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6876 of file ConnectClient.h.
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.
nullptr
An Async wrapper for UpdateContactFlowContent that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6917 of file ConnectClient.h.
A Callable wrapper for UpdateContactFlowContent that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6908 of file ConnectClient.h.
nullptr
An Async wrapper for UpdateContactFlowMetadata that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6942 of file ConnectClient.h.
A Callable wrapper for UpdateContactFlowMetadata that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6933 of file ConnectClient.h.
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.
nullptr
An Async wrapper for UpdateContactFlowModuleContent that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6972 of file ConnectClient.h.
A Callable wrapper for UpdateContactFlowModuleContent that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6963 of file ConnectClient.h.
nullptr
An Async wrapper for UpdateContactFlowModuleMetadata that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 6997 of file ConnectClient.h.
A Callable wrapper for UpdateContactFlowModuleMetadata that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 6988 of file ConnectClient.h.
The name of the flow.
You can also create and update flows using the Amazon Connect Flow language.
nullptr
An Async wrapper for UpdateContactFlowName that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7025 of file ConnectClient.h.
A Callable wrapper for UpdateContactFlowName that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7016 of file ConnectClient.h.
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.
Either QueuePriority or QueueTimeAdjustmentInSeconds should be provided within the request body, but not both.
nullptr
An Async wrapper for UpdateContactRoutingData that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7063 of file ConnectClient.h.
A Callable wrapper for UpdateContactRoutingData that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7054 of file ConnectClient.h.
nullptr
An Async wrapper for UpdateContactSchedule that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7089 of file ConnectClient.h.
A Callable wrapper for UpdateContactSchedule that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7080 of file ConnectClient.h.
Updates an email address metadata. For more information about email addresses, see Create email addresses in the Amazon Connect Administrator Guide.
nullptr
An Async wrapper for UpdateEmailAddressMetadata that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7118 of file ConnectClient.h.
A Callable wrapper for UpdateEmailAddressMetadata that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7109 of file ConnectClient.h.
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.
nullptr
An Async wrapper for UpdateEvaluationForm that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7147 of file ConnectClient.h.
A Callable wrapper for UpdateEvaluationForm that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7138 of file ConnectClient.h.
This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation.
nullptr
An Async wrapper for UpdateHoursOfOperation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7173 of file ConnectClient.h.
A Callable wrapper for UpdateHoursOfOperation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7164 of file ConnectClient.h.
nullptr
An Async wrapper for UpdateHoursOfOperationOverride that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7198 of file ConnectClient.h.
A Callable wrapper for UpdateHoursOfOperationOverride that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7189 of file ConnectClient.h.
This API is in preview release for Amazon Connect and is subject to change.
Updates the value for the specified attribute type.
nullptr
An Async wrapper for UpdateInstanceAttribute that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7225 of file ConnectClient.h.
A Callable wrapper for UpdateInstanceAttribute that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7216 of file ConnectClient.h.
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.
nullptr
An Async wrapper for UpdateInstanceStorageConfig that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7252 of file ConnectClient.h.
A Callable wrapper for UpdateInstanceStorageConfig that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7243 of file ConnectClient.h.
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.
The API returns a success response to acknowledge the request. However, the interaction and exchange of identity information occur asynchronously after the response is returned.
nullptr
An Async wrapper for UpdateParticipantAuthentication that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7285 of file ConnectClient.h.
A Callable wrapper for UpdateParticipantAuthentication that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7276 of file ConnectClient.h.
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.
nullptr
An Async wrapper for UpdateParticipantRoleConfig that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7317 of file ConnectClient.h.
A Callable wrapper for UpdateParticipantRoleConfig that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7308 of file ConnectClient.h.
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.
After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flow configuration of the phone number, too.
You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.
nullptr
An Async wrapper for UpdatePhoneNumber that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7353 of file ConnectClient.h.
A Callable wrapper for UpdatePhoneNumber that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7344 of file ConnectClient.h.
Updates a phone number’s metadata.
To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.
nullptr
An Async wrapper for UpdatePhoneNumberMetadata that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7381 of file ConnectClient.h.
A Callable wrapper for UpdatePhoneNumberMetadata that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7372 of file ConnectClient.h.
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.
nullptr
An Async wrapper for UpdatePredefinedAttribute that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7412 of file ConnectClient.h.
A Callable wrapper for UpdatePredefinedAttribute that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7403 of file ConnectClient.h.
nullptr
An Async wrapper for UpdatePrompt that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7437 of file ConnectClient.h.
A Callable wrapper for UpdatePrompt that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7428 of file ConnectClient.h.
This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation for the specified queue.
nullptr
An Async wrapper for UpdateQueueHoursOfOperation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7464 of file ConnectClient.h.
A Callable wrapper for UpdateQueueHoursOfOperation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7455 of file ConnectClient.h.
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.
nullptr
An Async wrapper for UpdateQueueMaxContacts that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7491 of file ConnectClient.h.
A Callable wrapper for UpdateQueueMaxContacts that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7482 of file ConnectClient.h.
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.
nullptr
An Async wrapper for UpdateQueueName that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7519 of file ConnectClient.h.
A Callable wrapper for UpdateQueueName that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7510 of file ConnectClient.h.
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 phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId
. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is 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
.
Only use the phone number ARN format that doesn't contain instance
in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid
. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.
If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
nullptr
An Async wrapper for UpdateQueueOutboundCallerConfig that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7565 of file ConnectClient.h.
A Callable wrapper for UpdateQueueOutboundCallerConfig that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7556 of file ConnectClient.h.
nullptr
An Async wrapper for UpdateQueueOutboundEmailConfig that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7591 of file ConnectClient.h.
A Callable wrapper for UpdateQueueOutboundEmailConfig that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7582 of file ConnectClient.h.
This API is in preview release for Amazon Connect and is subject to change.
Updates the status of the queue.
nullptr
An Async wrapper for UpdateQueueStatus that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7617 of file ConnectClient.h.
A Callable wrapper for UpdateQueueStatus that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7608 of file ConnectClient.h.
nullptr
An Async wrapper for UpdateQuickConnectConfig that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7643 of file ConnectClient.h.
A Callable wrapper for UpdateQuickConnectConfig that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7634 of file ConnectClient.h.
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.
nullptr
An Async wrapper for UpdateQuickConnectName that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7670 of file ConnectClient.h.
A Callable wrapper for UpdateQuickConnectName that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7661 of file ConnectClient.h.
Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
nullptr
An Async wrapper for UpdateRoutingProfileAgentAvailabilityTimer that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7697 of file ConnectClient.h.
A Callable wrapper for UpdateRoutingProfileAgentAvailabilityTimer that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7688 of file ConnectClient.h.
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
nullptr
An Async wrapper for UpdateRoutingProfileConcurrency that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7723 of file ConnectClient.h.
A Callable wrapper for UpdateRoutingProfileConcurrency that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7714 of file ConnectClient.h.
nullptr
An Async wrapper for UpdateRoutingProfileDefaultOutboundQueue that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7749 of file ConnectClient.h.
A Callable wrapper for UpdateRoutingProfileDefaultOutboundQueue that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7740 of file ConnectClient.h.
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.
nullptr
An Async wrapper for UpdateRoutingProfileName that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7776 of file ConnectClient.h.
A Callable wrapper for UpdateRoutingProfileName that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7767 of file ConnectClient.h.
Updates the properties associated with a set of queues for a routing profile.
nullptr
An Async wrapper for UpdateRoutingProfileQueues that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7802 of file ConnectClient.h.
A Callable wrapper for UpdateRoutingProfileQueues that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7793 of file ConnectClient.h.
Updates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
nullptr
An Async wrapper for UpdateRule that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7830 of file ConnectClient.h.
A Callable wrapper for UpdateRule that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7821 of file ConnectClient.h.
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.
nullptr
An Async wrapper for UpdateSecurityProfile that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7861 of file ConnectClient.h.
A Callable wrapper for UpdateSecurityProfile that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7852 of file ConnectClient.h.
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.
nullptr
An Async wrapper for UpdateTaskTemplate that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7888 of file ConnectClient.h.
A Callable wrapper for UpdateTaskTemplate that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7879 of file ConnectClient.h.
Updates the traffic distribution for a given traffic distribution group.
When you shift telephony traffic, also shift agents and/or agent sign-ins to ensure they can handle the calls in the other Region. If you don't shift the agents, voice calls will go to the shifted Region but there won't be any agents available to receive the calls.
The SignInConfig
distribution is available only on a default TrafficDistributionGroup
(see the IsDefault
parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution
with a modified SignInConfig
and a non-default TrafficDistributionGroup
, an InvalidRequestException
is returned.
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.
nullptr
An Async wrapper for UpdateTrafficDistribution that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7929 of file ConnectClient.h.
A Callable wrapper for UpdateTrafficDistribution that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7920 of file ConnectClient.h.
nullptr
An Async wrapper for UpdateUserHierarchy that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7955 of file ConnectClient.h.
A Callable wrapper for UpdateUserHierarchy that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7946 of file ConnectClient.h.
nullptr
An Async wrapper for UpdateUserHierarchyGroupName that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 7980 of file ConnectClient.h.
A Callable wrapper for UpdateUserHierarchyGroupName that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7971 of file ConnectClient.h.
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
nullptr
An Async wrapper for UpdateUserHierarchyStructure that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 8006 of file ConnectClient.h.
A Callable wrapper for UpdateUserHierarchyStructure that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 7997 of file ConnectClient.h.
Updates the identity information for the specified user.
We strongly recommend limiting who has the ability to invoke UpdateUserIdentityInfo
. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.
nullptr
An Async wrapper for UpdateUserIdentityInfo that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 8040 of file ConnectClient.h.
A Callable wrapper for UpdateUserIdentityInfo that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 8031 of file ConnectClient.h.
nullptr
An Async wrapper for UpdateUserPhoneConfig that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 8066 of file ConnectClient.h.
A Callable wrapper for UpdateUserPhoneConfig that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 8057 of file ConnectClient.h.
nullptr
An Async wrapper for UpdateUserProficiencies that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 8092 of file ConnectClient.h.
A Callable wrapper for UpdateUserProficiencies that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 8083 of file ConnectClient.h.
nullptr
An Async wrapper for UpdateUserRoutingProfile that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 8118 of file ConnectClient.h.
A Callable wrapper for UpdateUserRoutingProfile that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 8109 of file ConnectClient.h.
nullptr
An Async wrapper for UpdateUserSecurityProfiles that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 8144 of file ConnectClient.h.
A Callable wrapper for UpdateUserSecurityProfiles that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 8135 of file ConnectClient.h.
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
.
nullptr
An Async wrapper for UpdateViewContent that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 8175 of file ConnectClient.h.
A Callable wrapper for UpdateViewContent that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 8166 of file ConnectClient.h.
Updates the view metadata. Note that either Name
or Description
must be provided.
nullptr
An Async wrapper for UpdateViewMetadata that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 8201 of file ConnectClient.h.
A Callable wrapper for UpdateViewMetadata that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 8192 of file ConnectClient.h.
Definition at line 8208 of file ConnectClient.h.