View Source aws_connect (aws v1.0.4)
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: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html in the Amazon Connect Administrator Guide.
You can connect programmatically to an Amazon Web Services service by using an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints: https://docs.aws.amazon.com/general/latest/gr/connect_region.html.Summary
Functions
Activates an evaluation form in the specified Amazon Connect instance.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
Associates an existing vocabulary as the default.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
Associates a flow with a phone number claimed to your Amazon Connect instance.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.
Claims an available phone number to your Amazon Connect instance or traffic distribution group.
This API is in preview release for Amazon Connect and is subject to change.
Creates a flow for the specified Amazon Connect instance.
Creates an evaluation form in the specified Amazon Connect instance.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
Adds a new participant into an on-going chat contact.
Enables rehydration of chats for the lifespan of a contact.
Creates a prompt.
This API is in preview release for Amazon Connect and is subject to change.
Creates a rule for the specified Amazon Connect instance.
Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
Creates a user account for the specified Amazon Connect instance.
Creates a new view with the possible status of SAVED
or PUBLISHED
.
Publishes a new version of the view identifier.
Creates a custom vocabulary associated with your Amazon Connect instance.
Deactivates an evaluation form in the specified Amazon Connect instance.
Deletes an evaluation form in the specified Amazon Connect instance.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
Deletes an Amazon Web Services resource association from an Amazon Connect instance.
Deletes a traffic distribution group.
Deletes a user account from the specified Amazon Connect instance.
Deletes an existing user hierarchy group.
Deletes the view entirely.
ViewVersion
identifier.This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified flow.
Describes an evaluation form in the specified Amazon Connect instance.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified user.
Retrieves the view for the specified Amazon Connect instance and view identifier.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
Removes the flow association from a phone number claimed to your Amazon Connect instance.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
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.
Gets the real-time metric data from the specified Amazon Connect instance.
Supports SAML sign-in for Amazon Connect.
Gets historical metric data from the specified Amazon Connect instance.
Gets metric data from the specified Amazon Connect instance.
Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
Provides information about the flows for the specified Amazon Connect instance.
This API is in preview release for Amazon Connect and is subject to change.
Provides information about the hours of operation for the specified Amazon Connect instance.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
Provides information about the phone numbers for the specified Amazon Connect instance.
Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group.
This API is in preview release for Amazon Connect and is subject to change.
Provides information about the queues for the specified Amazon Connect instance.
Provides summary information about the routing profiles for the specified Amazon Connect instance.
This API is in preview release for Amazon Connect and is subject to change.
Provides summary information about the security profiles for the specified Amazon Connect instance.
Lists the tags for the specified resource.
Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
Returns all the available versions for the specified Amazon Connect instance and view identifier.
Returns views in the given instance.
Initiates silent monitoring of a contact.
Changes the current status of a user or agent in Amazon Connect.
Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group.
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.
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.
Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.
Searches users in an Amazon Connect instance, with optional filtering.
State
, NameStartsWith
, and LanguageCode
.Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect.
Initiates a flow to start a new chat for the customer.
Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact.
Starts recording the contact
Initiates real-time message streaming for a new chat contact.
Places an outbound call to a contact, and then initiates the flow.
Initiates a flow to start a new task contact.
Places an inbound in-app, web, or video call to a contact, and then initiates the flow.
Ends the specified contact.
Stops recording a call when a contact is being recorded.
Ends message streaming on a specified contact.
Submits a contact evaluation in the specified Amazon Connect instance.
When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both.
Adds the specified tags to the contact resource.
Adds the specified tags to the specified resource.
Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created.
Removes the specified tags from the contact resource.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
Creates or updates user-defined contact attributes associated with the specified contact.
Updates details about a contact evaluation in the specified Amazon Connect instance.
Updates the specified flow.
The name of the flow.
This API is in preview release for Amazon Connect and is subject to change.
Updates details about a specific evaluation form version in the specified Amazon Connect instance.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness.
Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.
Updates a phone number’s metadata.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
This API is in preview release for Amazon Connect and is subject to change.
Updates the name and description of a quick connect.
Updates the name and description of a routing profile.
Updates a rule for the specified Amazon Connect instance.
Updates details about a specific task template in the specified Amazon Connect instance.
Updates the traffic distribution for a given traffic distribution group.
Updates the identity information for the specified user.
Updates the view content of the given view identifier in the specified Amazon Connect instance.
Updates the view metadata.
Functions
activate_evaluation_form(Client, EvaluationFormId, InstanceId, Input)
View SourceActivates 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.activate_evaluation_form(Client, EvaluationFormId, InstanceId, Input0, Options0)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.associate_analytics_data_set(Client, InstanceId, Input0, Options0)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
Associates an approved origin to an Amazon Connect instance.This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.associate_default_vocabulary(Client, InstanceId, LanguageCode, Input)
View SourceAssociates 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.associate_default_vocabulary(Client, InstanceId, LanguageCode, Input0, Options0)
View SourceThis 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.associate_instance_storage_config(Client, InstanceId, Input0, Options0)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Lambda function.This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots.Associates a flow with a phone number claimed to your Amazon Connect instance.
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 thePhoneNumberId
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
.
associate_phone_number_contact_flow(Client, PhoneNumberId, Input0, Options0)
View Sourceassociate_queue_quick_connects(Client, InstanceId, QueueId, Input)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
Associates a set of quick connects with a queue.associate_queue_quick_connects(Client, InstanceId, QueueId, Input0, Options0)
View Sourceassociate_routing_profile_queues(Client, InstanceId, RoutingProfileId, Input)
View Sourceassociate_routing_profile_queues(Client, InstanceId, RoutingProfileId, Input0, Options0)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
Associates a security key to the instance.associate_traffic_distribution_group_user(Client, TrafficDistributionGroupId, Input)
View Sourceassociate_traffic_distribution_group_user(Client, TrafficDistributionGroupId, Input0, Options0)
View Sourceassociate_user_proficiencies(Client, InstanceId, UserId, Input0, Options0)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
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.batch_associate_analytics_data_set(Client, InstanceId, Input0, Options0)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.batch_disassociate_analytics_data_set(Client, InstanceId, Input0, Options0)
View SourceOnly 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: https://docs.aws.amazon.com/connect-outbound/latest/APIReference/API_PutDialRequestBatch.html API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.Claims an available phone number to your Amazon Connect instance or traffic distribution group.
You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.
For more information about how to use this operation, see Claim a phone number in your country: https://docs.aws.amazon.com/connect/latest/adminguide/claim-phone-number.html and Claim phone numbers to traffic distribution groups: https://docs.aws.amazon.com/connect/latest/adminguide/claim-phone-numbers-traffic-distribution-groups.html in the Amazon Connect Administrator Guide.
You can call the SearchAvailablePhoneNumbers: https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchAvailablePhoneNumbers.html API for available phone numbers that you can claim. Call the DescribePhoneNumber: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html API to verify the status of a previous ClaimPhoneNumber: https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html operation.
If you plan to claim and release numbers frequently during a 30 day period, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until 30 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 during any 30 day period. If you claim and release phone numbers using the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 30 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 30 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.This API is in preview release for Amazon Connect and is subject to change.
Creates an agent status for the specified Amazon Connect instance.Creates a flow for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html.Creates an evaluation form in the specified Amazon Connect instance.
The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.This API is in preview release for Amazon Connect and is subject to change.
Creates hours of operation.This API is in preview release for Amazon Connect and is subject to change.
Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.create_integration_association(Client, InstanceId, Input0, Options0)
View SourceAdds a new participant into an on-going chat contact.
For more information, see Customize chat flow experiences by integrating custom participants: https://docs.aws.amazon.com/connect/latest/adminguide/chat-customize-flow.html.create_persistent_contact_association(Client, InitialContactId, InstanceId, Input)
View SourceEnables rehydration of chats for the lifespan of a contact.
For more information about chat rehydration, see Enable persistent chat: https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html in the Amazon Connect Administrator Guide.create_persistent_contact_association(Client, InitialContactId, InstanceId, Input0, Options0)
View SourceCreates a prompt.
For more information about prompts, such as supported file types and maximum length, see Create prompts: https://docs.aws.amazon.com/connect/latest/adminguide/prompts.html in the Amazon Connect Administrator's Guide.This API is in preview release for Amazon Connect and is subject to change.
Creates a new queue for the specified Amazon Connect instance.
If the 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: https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html API.
Creates a rule for the specified Amazon Connect instance.
Use the Rules Function language: https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-language.html to code conditions for the rule.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: https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html data type). If you call UpdateTrafficDistribution
with a modified SignInConfig
and a non-default TrafficDistributionGroup
, an InvalidRequestException
is returned.
create_use_case(Client, InstanceId, IntegrationAssociationId, Input)
View Sourcecreate_use_case(Client, InstanceId, IntegrationAssociationId, Input0, Options0)
View SourceCreates a user account for the specified Amazon Connect instance.
Certain UserIdentityInfo: https://docs.aws.amazon.com/connect/latest/APIReference/API_UserIdentityInfo.html 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.
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 isSAVED
or full content validation if the status is set to PUBLISHED
. An error is returned if validation fails. It associates either the $SAVED
qualifier or both of the $SAVED
and $LATEST
qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided.
Publishes a new version of the view identifier.
Versions are immutable and monotonically increasing.
It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the$LATEST
alias.
Creates a custom vocabulary associated with your Amazon Connect instance.
You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.deactivate_evaluation_form(Client, EvaluationFormId, InstanceId, Input)
View SourceDeactivates 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.deactivate_evaluation_form(Client, EvaluationFormId, InstanceId, Input0, Options0)
View Sourcedelete_contact_evaluation(Client, EvaluationId, InstanceId, Input)
View Sourcedelete_contact_evaluation(Client, EvaluationId, InstanceId, Input0, Options0)
View Sourcedelete_contact_flow(Client, ContactFlowId, InstanceId, Input0, Options0)
View Sourcedelete_contact_flow_module(Client, ContactFlowModuleId, InstanceId, Input)
View Sourcedelete_contact_flow_module(Client, ContactFlowModuleId, InstanceId, Input0, Options0)
View Sourcedelete_evaluation_form(Client, EvaluationFormId, InstanceId, Input)
View SourceDeletes 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.
delete_evaluation_form(Client, EvaluationFormId, InstanceId, Input0, Options0)
View Sourcedelete_hours_of_operation(Client, HoursOfOperationId, InstanceId, Input)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
Deletes an hours of operation.delete_hours_of_operation(Client, HoursOfOperationId, InstanceId, Input0, Options0)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
Deletes the Amazon Connect instance.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.delete_integration_association(Client, InstanceId, IntegrationAssociationId, Input)
View SourceDeletes an Amazon Web Services resource association from an Amazon Connect instance.
The association must not have any use cases associated with it.delete_integration_association(Client, InstanceId, IntegrationAssociationId, Input0, Options0)
View Sourcedelete_predefined_attribute(Client, InstanceId, Name, Input0, Options0)
View Sourcedelete_quick_connect(Client, InstanceId, QuickConnectId, Input0, Options0)
View Sourcedelete_routing_profile(Client, InstanceId, RoutingProfileId, Input)
View Sourcedelete_routing_profile(Client, InstanceId, RoutingProfileId, Input0, Options0)
View Sourcedelete_security_profile(Client, InstanceId, SecurityProfileId, Input)
View Sourcedelete_security_profile(Client, InstanceId, SecurityProfileId, Input0, Options0)
View Sourcedelete_task_template(Client, InstanceId, TaskTemplateId, Input0, Options0)
View Sourcedelete_traffic_distribution_group(Client, TrafficDistributionGroupId, Input)
View SourceDeletes 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: https://docs.aws.amazon.com/connect/latest/adminguide/delete-traffic-distribution-groups.html in the Amazon Connect Administrator Guide.delete_traffic_distribution_group(Client, TrafficDistributionGroupId, Input0, Options0)
View Sourcedelete_use_case(Client, InstanceId, IntegrationAssociationId, UseCaseId, Input)
View Sourcedelete_use_case(Client, InstanceId, IntegrationAssociationId, UseCaseId, Input0, Options0)
View SourceDeletes 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: https://docs.aws.amazon.com/connect/latest/adminguide/delete-users.html in the Amazon Connect Administrator Guide.delete_user_hierarchy_group(Client, HierarchyGroupId, InstanceId, Input)
View SourceDeletes an existing user hierarchy group.
It must not be associated with any agents or have any active child groups.delete_user_hierarchy_group(Client, HierarchyGroupId, InstanceId, Input0, Options0)
View SourceDeletes the view entirely.
It deletes the view and all associated qualifiers (versions and aliases).delete_view_version(Client, InstanceId, ViewId, ViewVersion, Input)
View SourceViewVersion
identifier.
delete_view_version(Client, InstanceId, ViewId, ViewVersion, Input0, Options0)
View Sourcedelete_vocabulary(Client, InstanceId, VocabularyId, Input0, Options0)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
Describes an agent status.describe_agent_status(Client, AgentStatusId, InstanceId, QueryMap, HeadersMap)
View Sourcedescribe_agent_status(Client, AgentStatusId, InstanceId, QueryMap, HeadersMap, Options0)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
Contact information remains available in Amazon Connect for 24 months, and then it is deleted.
Only data from November 12, 2021, and later is returned by this API.describe_contact(Client, ContactId, InstanceId, QueryMap, HeadersMap)
View Sourcedescribe_contact(Client, ContactId, InstanceId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_contact_evaluation(Client, EvaluationId, InstanceId, QueryMap, HeadersMap)
View Sourcedescribe_contact_evaluation(Client, EvaluationId, InstanceId, QueryMap, HeadersMap, Options0)
View SourceDescribes the specified flow.
You can also create and update flows using the Amazon Connect Flow language: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html.describe_contact_flow(Client, ContactFlowId, InstanceId, QueryMap, HeadersMap)
View Sourcedescribe_contact_flow(Client, ContactFlowId, InstanceId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_contact_flow_module(Client, ContactFlowModuleId, InstanceId)
View Sourcedescribe_contact_flow_module(Client, ContactFlowModuleId, InstanceId, QueryMap, HeadersMap)
View Sourcedescribe_contact_flow_module(Client, ContactFlowModuleId, InstanceId, QueryMap, HeadersMap, Options0)
View SourceDescribes 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.describe_evaluation_form(Client, EvaluationFormId, InstanceId, QueryMap, HeadersMap)
View Sourcedescribe_evaluation_form(Client, EvaluationFormId, InstanceId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_hours_of_operation(Client, HoursOfOperationId, InstanceId)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
Describes the hours of operation.describe_hours_of_operation(Client, HoursOfOperationId, InstanceId, QueryMap, HeadersMap)
View Sourcedescribe_hours_of_operation(Client, HoursOfOperationId, InstanceId, QueryMap, HeadersMap, Options0)
View SourceThis 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.describe_instance(Client, InstanceId, QueryMap, HeadersMap, Options0)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
Describes the specified instance attribute.describe_instance_attribute(Client, AttributeType, InstanceId, QueryMap, HeadersMap)
View Sourcedescribe_instance_attribute(Client, AttributeType, InstanceId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_instance_storage_config(Client, AssociationId, InstanceId, ResourceType)
View SourceThis 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.describe_instance_storage_config(Client, AssociationId, InstanceId, ResourceType, QueryMap, HeadersMap)
View Sourcedescribe_instance_storage_config(Client, AssociationId, InstanceId, ResourceType, QueryMap, HeadersMap, Options0)
View SourceGets 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 thePhoneNumberId
URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException
.
describe_phone_number(Client, PhoneNumberId, QueryMap, HeadersMap)
View Sourcedescribe_phone_number(Client, PhoneNumberId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_predefined_attribute(Client, InstanceId, Name, QueryMap, HeadersMap)
View Sourcedescribe_predefined_attribute(Client, InstanceId, Name, QueryMap, HeadersMap, Options0)
View Sourcedescribe_prompt(Client, InstanceId, PromptId, QueryMap, HeadersMap)
View Sourcedescribe_prompt(Client, InstanceId, PromptId, QueryMap, HeadersMap, Options0)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
Describes the specified queue.describe_queue(Client, InstanceId, QueueId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_quick_connect(Client, InstanceId, QuickConnectId, QueryMap, HeadersMap)
View Sourcedescribe_quick_connect(Client, InstanceId, QuickConnectId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_routing_profile(Client, InstanceId, RoutingProfileId, QueryMap, HeadersMap)
View Sourcedescribe_routing_profile(Client, InstanceId, RoutingProfileId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_rule(Client, InstanceId, RuleId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_security_profile(Client, InstanceId, SecurityProfileId, QueryMap, HeadersMap)
View Sourcedescribe_security_profile(Client, InstanceId, SecurityProfileId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_traffic_distribution_group(Client, TrafficDistributionGroupId)
View Sourcedescribe_traffic_distribution_group(Client, TrafficDistributionGroupId, QueryMap, HeadersMap)
View Sourcedescribe_traffic_distribution_group(Client, TrafficDistributionGroupId, QueryMap, HeadersMap, Options0)
View SourceDescribes the specified user.
You can find the instance ID in the Amazon Connect console: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html (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.describe_user(Client, InstanceId, UserId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_user_hierarchy_group(Client, HierarchyGroupId, InstanceId)
View Sourcedescribe_user_hierarchy_group(Client, HierarchyGroupId, InstanceId, QueryMap, HeadersMap)
View Sourcedescribe_user_hierarchy_group(Client, HierarchyGroupId, InstanceId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_user_hierarchy_structure(Client, InstanceId, QueryMap, HeadersMap)
View Sourcedescribe_user_hierarchy_structure(Client, InstanceId, QueryMap, HeadersMap, Options0)
View SourceRetrieves 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.
<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.
describe_view(Client, InstanceId, ViewId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_vocabulary(Client, InstanceId, VocabularyId, QueryMap, HeadersMap)
View Sourcedescribe_vocabulary(Client, InstanceId, VocabularyId, QueryMap, HeadersMap, Options0)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
Removes the dataset ID associated with a given Amazon Connect instance.disassociate_analytics_data_set(Client, InstanceId, Input0, Options0)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
Revokes access to integrated applications from Amazon Connect.disassociate_approved_origin(Client, InstanceId, Input0, Options0)
View SourceThis 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.disassociate_flow(Client, InstanceId, ResourceId, ResourceType, Input)
View Sourcedisassociate_flow(Client, InstanceId, ResourceId, ResourceType, Input0, Options0)
View Sourcedisassociate_instance_storage_config(Client, AssociationId, InstanceId, Input)
View SourceThis 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.disassociate_instance_storage_config(Client, AssociationId, InstanceId, Input0, Options0)
View SourceThis 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.disassociate_lambda_function(Client, InstanceId, Input0, Options0)
View SourceThis 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.disassociate_phone_number_contact_flow(Client, PhoneNumberId, Input)
View SourceRemoves 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 thePhoneNumberId
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
.
disassociate_phone_number_contact_flow(Client, PhoneNumberId, Input0, Options0)
View Sourcedisassociate_queue_quick_connects(Client, InstanceId, QueueId, Input)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
Disassociates a set of quick connects from a queue.disassociate_queue_quick_connects(Client, InstanceId, QueueId, Input0, Options0)
View Sourcedisassociate_routing_profile_queues(Client, InstanceId, RoutingProfileId, Input)
View Sourcedisassociate_routing_profile_queues(Client, InstanceId, RoutingProfileId, Input0, Options0)
View Sourcedisassociate_security_key(Client, AssociationId, InstanceId, Input)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
Deletes the specified security key.disassociate_security_key(Client, AssociationId, InstanceId, Input0, Options0)
View Sourcedisassociate_traffic_distribution_group_user(Client, TrafficDistributionGroupId, Input)
View Sourcedisassociate_traffic_distribution_group_user(Client, TrafficDistributionGroupId, Input0, Options0)
View Sourcedisassociate_user_proficiencies(Client, InstanceId, UserId, Input)
View Sourcedisassociate_user_proficiencies(Client, InstanceId, UserId, Input0, Options0)
View SourceDismisses 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 aMISSED
, ERROR
, ENDED
, or REJECTED
state in the Agent Event Stream: https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html.
dismiss_user_contact(Client, InstanceId, UserId, Input0, Options0)
View Sourceget_contact_attributes(Client, InitialContactId, InstanceId, QueryMap, HeadersMap)
View Sourceget_contact_attributes(Client, InitialContactId, InstanceId, QueryMap, HeadersMap, Options0)
View SourceGets the real-time metric data from the specified Amazon Connect instance.
For a description of each metric, see Real-time Metrics Definitions: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html in the Amazon Connect Administrator Guide.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.: https://docs.aws.amazon.com/connect/latest/adminguide/configure-saml.html
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
get_federation_token(Client, InstanceId, QueryMap, HeadersMap, Options0)
View Sourceget_flow_association(Client, InstanceId, ResourceId, ResourceType)
View Sourceget_flow_association(Client, InstanceId, ResourceId, ResourceType, QueryMap, HeadersMap)
View Sourceget_flow_association(Client, InstanceId, ResourceId, ResourceType, QueryMap, HeadersMap, Options0)
View SourceGets historical metric data from the specified Amazon Connect instance.
For a description of each historical metric, see Historical Metrics Definitions: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html in the Amazon Connect Administrator Guide.
We recommend using the GetMetricDataV2: https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html API. It provides more flexibility, features, and the ability to query longer time ranges thanGetMetricData
. 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.
Gets metric data from the specified Amazon Connect instance.
GetMetricDataV2
offers more features than GetMetricData: https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricData.html, 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.
GetMetricDataV2
and GetMetricData
, see Historical metrics definitions: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html in the Amazon Connect Administrator's Guide.
get_prompt_file(Client, InstanceId, PromptId, QueryMap, HeadersMap)
View Sourceget_prompt_file(Client, InstanceId, PromptId, QueryMap, HeadersMap, Options0)
View Sourceget_task_template(Client, InstanceId, TaskTemplateId, QueryMap, HeadersMap)
View Sourceget_task_template(Client, InstanceId, TaskTemplateId, QueryMap, HeadersMap, Options0)
View Sourceget_traffic_distribution(Client, Id, QueryMap, HeadersMap, Options0)
View SourceImports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance.
You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.This API is in preview release for Amazon Connect and is subject to change.
Lists agent statuses.list_agent_statuses(Client, InstanceId, QueryMap, HeadersMap, Options0)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
Lists the association status of requested dataset ID for a given Amazon Connect instance.list_analytics_data_associations(Client, InstanceId, QueryMap, HeadersMap)
View Sourcelist_analytics_data_associations(Client, InstanceId, QueryMap, HeadersMap, Options0)
View SourceThis 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.list_approved_origins(Client, InstanceId, QueryMap, HeadersMap, Options0)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots.list_bots(Client, InstanceId, LexVersion, QueryMap, HeadersMap, Options0)
View Sourcelist_contact_evaluations(Client, InstanceId, ContactId, QueryMap, HeadersMap)
View Sourcelist_contact_evaluations(Client, InstanceId, ContactId, QueryMap, HeadersMap, Options0)
View Sourcelist_contact_flow_modules(Client, InstanceId, QueryMap, HeadersMap)
View Sourcelist_contact_flow_modules(Client, InstanceId, QueryMap, HeadersMap, Options0)
View SourceProvides information about the flows for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html.
For more information about flows, see Flows: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html in the Amazon Connect Administrator Guide.list_contact_flows(Client, InstanceId, QueryMap, HeadersMap, Options0)
View Sourcelist_contact_references(Client, ContactId, InstanceId, ReferenceTypes)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
For the specifiedreferenceTypes
, returns a list of references associated with the contact.
list_contact_references(Client, ContactId, InstanceId, ReferenceTypes, QueryMap, HeadersMap)
View Sourcelist_contact_references(Client, ContactId, InstanceId, ReferenceTypes, QueryMap, HeadersMap, Options0)
View Sourcelist_evaluation_form_versions(Client, EvaluationFormId, InstanceId)
View Sourcelist_evaluation_form_versions(Client, EvaluationFormId, InstanceId, QueryMap, HeadersMap)
View Sourcelist_evaluation_form_versions(Client, EvaluationFormId, InstanceId, QueryMap, HeadersMap, Options0)
View Sourcelist_evaluation_forms(Client, InstanceId, QueryMap, HeadersMap, Options0)
View Sourcelist_flow_associations(Client, InstanceId, QueryMap, HeadersMap, Options0)
View SourceProvides 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: https://docs.aws.amazon.com/connect/latest/adminguide/set-hours-operation.html in the Amazon Connect Administrator Guide.list_hours_of_operations(Client, InstanceId, QueryMap, HeadersMap)
View Sourcelist_hours_of_operations(Client, InstanceId, QueryMap, HeadersMap, Options0)
View SourceThis 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.list_instance_attributes(Client, InstanceId, QueryMap, HeadersMap)
View Sourcelist_instance_attributes(Client, InstanceId, QueryMap, HeadersMap, Options0)
View SourceThis 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.list_instance_storage_configs(Client, InstanceId, ResourceType, QueryMap, HeadersMap)
View Sourcelist_instance_storage_configs(Client, InstanceId, ResourceType, QueryMap, HeadersMap, Options0)
View SourceThis 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.list_integration_associations(Client, InstanceId, QueryMap, HeadersMap)
View Sourcelist_integration_associations(Client, InstanceId, QueryMap, HeadersMap, Options0)
View SourceThis 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.list_lambda_functions(Client, InstanceId, QueryMap, HeadersMap, Options0)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots: https://docs.aws.amazon.com/connect/latest/APIReference/API_ListBots.html API.Provides information about the phone numbers for the specified Amazon Connect instance.
For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center: https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html in the Amazon Connect Administrator Guide.
We recommend using ListPhoneNumbersV2: https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html 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
.
Arn
value that is returned from each of the items in the PhoneNumberSummaryList: https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbers.html#connect-ListPhoneNumbers-response-PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with a ResourceNotFoundException
. Instead, use the ListPhoneNumbersV2: https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html API. It returns the new phone number ARN that can be used to tag phone number resources.
list_phone_numbers(Client, InstanceId, QueryMap, HeadersMap, Options0)
View SourceLists 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: https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html in the Amazon Connect Administrator Guide.
When given an instance ARN, ListPhoneNumbersV2
returns only the phone numbers claimed to the instance.
ListPhoneNumbersV2
returns only the phone numbers claimed to the traffic distribution group.
list_predefined_attributes(Client, InstanceId, QueryMap, HeadersMap)
View Sourcelist_predefined_attributes(Client, InstanceId, QueryMap, HeadersMap, Options0)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
Lists the quick connects associated with a queue.list_queue_quick_connects(Client, InstanceId, QueueId, QueryMap, HeadersMap)
View Sourcelist_queue_quick_connects(Client, InstanceId, QueueId, QueryMap, HeadersMap, Options0)
View SourceProvides 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.
list_quick_connects(Client, InstanceId, QueryMap, HeadersMap, Options0)
View Sourcelist_realtime_contact_analysis_segments_v2(Client, ContactId, InstanceId, Input)
View Sourcelist_realtime_contact_analysis_segments_v2(Client, ContactId, InstanceId, Input0, Options0)
View Sourcelist_routing_profile_queues(Client, InstanceId, RoutingProfileId, QueryMap, HeadersMap)
View Sourcelist_routing_profile_queues(Client, InstanceId, RoutingProfileId, QueryMap, HeadersMap, Options0)
View SourceProvides summary information about the routing profiles for the specified Amazon Connect instance.
For more information about routing profiles, see Routing Profiles: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing.html and Create a Routing Profile: https://docs.aws.amazon.com/connect/latest/adminguide/routing-profiles.html in the Amazon Connect Administrator Guide.list_routing_profiles(Client, InstanceId, QueryMap, HeadersMap, Options0)
View SourceThis 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.list_security_keys(Client, InstanceId, QueryMap, HeadersMap, Options0)
View Sourcelist_security_profile_applications(Client, InstanceId, SecurityProfileId)
View Sourcelist_security_profile_applications(Client, InstanceId, SecurityProfileId, QueryMap, HeadersMap)
View Sourcelist_security_profile_applications(Client, InstanceId, SecurityProfileId, QueryMap, HeadersMap, Options0)
View Sourcelist_security_profile_permissions(Client, InstanceId, SecurityProfileId)
View Sourcelist_security_profile_permissions(Client, InstanceId, SecurityProfileId, QueryMap, HeadersMap)
View Sourcelist_security_profile_permissions(Client, InstanceId, SecurityProfileId, QueryMap, HeadersMap, Options0)
View SourceProvides summary information about the security profiles for the specified Amazon Connect instance.
For more information about security profiles, see Security Profiles: https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html in the Amazon Connect Administrator Guide.list_security_profiles(Client, InstanceId, QueryMap, HeadersMap, Options0)
View SourceLists the tags for the specified resource.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples: https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html in the Amazon Connect Administrator Guide.list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View Sourcelist_task_templates(Client, InstanceId, QueryMap, HeadersMap, Options0)
View Sourcelist_traffic_distribution_group_users(Client, TrafficDistributionGroupId)
View Sourcelist_traffic_distribution_group_users(Client, TrafficDistributionGroupId, QueryMap, HeadersMap)
View Sourcelist_traffic_distribution_group_users(Client, TrafficDistributionGroupId, QueryMap, HeadersMap, Options0)
View Sourcelist_traffic_distribution_groups(Client, QueryMap, HeadersMap, Options0)
View Sourcelist_use_cases(Client, InstanceId, IntegrationAssociationId, QueryMap, HeadersMap)
View Sourcelist_use_cases(Client, InstanceId, IntegrationAssociationId, QueryMap, HeadersMap, Options0)
View SourceProvides summary information about the hierarchy groups for the specified Amazon Connect instance.
For more information about agent hierarchies, see Set Up Agent Hierarchies: https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html in the Amazon Connect Administrator Guide.list_user_hierarchy_groups(Client, InstanceId, QueryMap, HeadersMap)
View Sourcelist_user_hierarchy_groups(Client, InstanceId, QueryMap, HeadersMap, Options0)
View Sourcelist_user_proficiencies(Client, InstanceId, UserId, QueryMap, HeadersMap)
View Sourcelist_user_proficiencies(Client, InstanceId, UserId, QueryMap, HeadersMap, Options0)
View SourceReturns all the available versions for the specified Amazon Connect instance and view identifier.
Results will be sorted from highest to lowest.list_view_versions(Client, InstanceId, ViewId, QueryMap, HeadersMap)
View Sourcelist_view_versions(Client, InstanceId, ViewId, QueryMap, HeadersMap, Options0)
View SourceReturns views in the given instance.
Results are sorted primarily by type, and secondarily by name.Initiates silent monitoring of a contact.
The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact.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: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-agent-status.html and Set your next status: https://docs.aws.amazon.com/connect/latest/adminguide/set-next-status.html in the Amazon Connect Administrator Guide.Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group.
You can call this API only in the Amazon Web Services Region where the number was claimed.
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 of 30 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.
If you plan to claim and release numbers frequently during a 30 day period, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until 30 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 during any 30 day period. If you claim and release phone numbers using the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 30 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 30 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.
For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance: https://docs.aws.amazon.com/connect/latest/adminguide/create-replica-connect-instance.html in the Amazon Connect Administrator Guide.When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both.
If only call recording or only screen recording is enabled, then it would resume.
Voice and screen recordings are supported.Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.
If the providedTargetArn
is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group.
Searches users in an Amazon Connect instance, with optional filtering.
AfterContactWorkTimeLimit
is returned in milliseconds.
State
, NameStartsWith
, and LanguageCode
.
Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect.
A chat integration event includes:
SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat
ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat
When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action.
Access to this API is currently restricted to Amazon Pinpoint for supporting SMS integration.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: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html 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: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html 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: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html is exceeded. Active chat throttling returns a
LimitExceededException
.
If you use the ChatDurationInMinutes
parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.
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.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: https://docs.aws.amazon.com/connect/latest/adminguide/set-recording-behavior.html block.
Only voice recordings are supported at this time.Initiates real-time message streaming for a new chat contact.
For more information about message streaming, see Enable real-time chat message streaming: https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html in the Amazon Connect Administrator Guide.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: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html in the Amazon Connect Administrator Guide.
Campaign calls are not allowed by default. Before you can make a call withTrafficType
= CAMPAIGN
, you must submit a service quota increase request to the quota Amazon Connect campaigns: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#outbound-communications-quotas.
Initiates a flow to start a new task contact.
For more information about task contacts, see Concepts: Tasks in Amazon Connect: https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html 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.
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: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html in the Amazon Connect Administrator Guide.
Places an inbound in-app, web, or video call to a contact, and then initiates the flow.
It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).Ends the specified contact.
This call does not work for voice contacts that use the following initiation methods:
DISCONNECT
TRANSFER
QUEUE_TRANSFER
Stops recording a call when a contact is being recorded.
StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.
Only voice recordings are supported at this time.Ends message streaming on a specified contact.
To restart message streaming on that contact, call the StartContactStreaming: https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html API.submit_contact_evaluation(Client, EvaluationId, InstanceId, Input)
View SourceSubmits 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.
submit_contact_evaluation(Client, EvaluationId, InstanceId, Input0, Options0)
View SourceWhen a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both.
If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen.
The period of time that the recording is suspended is filled with silence in the final recording.
Voice and screen recordings are supported.Adds the specified tags to the contact resource.
For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage: https://docs.aws.amazon.com/connect/latest/adminguide/granular-billing.html.Adds the specified tags to the specified resource.
Some of the supported resource types are agents, routing profiles, queues, quick connects, contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect: https://docs.aws.amazon.com/connect/latest/adminguide/tagging.html.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples: https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html in the Amazon Connect Administrator Guide.Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created.
You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.
Note the following requirements:
Transfer is supported for only
TASK
contacts.Do not use both
QueueId
andUserId
in the same call.The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.
The
TransferContact
API can be called only on active contacts.A contact cannot be transferred more than 11 times.
Removes the specified tags from the contact resource.
For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage: https://docs.aws.amazon.com/connect/latest/adminguide/granular-billing.html.This API is in preview release for Amazon Connect and is subject to change.
Updates agent status.update_agent_status(Client, AgentStatusId, InstanceId, Input0, Options0)
View SourceThis 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.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: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits in the Amazon Connect Administrator Guide.update_contact_evaluation(Client, EvaluationId, InstanceId, Input)
View SourceUpdates 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.
update_contact_evaluation(Client, EvaluationId, InstanceId, Input0, Options0)
View Sourceupdate_contact_flow_content(Client, ContactFlowId, InstanceId, Input)
View SourceUpdates the specified flow.
You can also create and update flows using the Amazon Connect Flow language: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html.update_contact_flow_content(Client, ContactFlowId, InstanceId, Input0, Options0)
View Sourceupdate_contact_flow_metadata(Client, ContactFlowId, InstanceId, Input)
View Sourceupdate_contact_flow_metadata(Client, ContactFlowId, InstanceId, Input0, Options0)
View Sourceupdate_contact_flow_module_content(Client, ContactFlowModuleId, InstanceId, Input)
View Sourceupdate_contact_flow_module_content(Client, ContactFlowModuleId, InstanceId, Input0, Options0)
View Sourceupdate_contact_flow_module_metadata(Client, ContactFlowModuleId, InstanceId, Input)
View Sourceupdate_contact_flow_module_metadata(Client, ContactFlowModuleId, InstanceId, Input0, Options0)
View Sourceupdate_contact_flow_name(Client, ContactFlowId, InstanceId, Input)
View SourceThe name of the flow.
You can also create and update flows using the Amazon Connect Flow language: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html.update_contact_flow_name(Client, ContactFlowId, InstanceId, Input0, Options0)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
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: https://docs.aws.amazon.com/connect/latest/adminguide/change-routing-priority.html.update_contact_routing_data(Client, ContactId, InstanceId, Input0, Options0)
View Sourceupdate_evaluation_form(Client, EvaluationFormId, InstanceId, Input)
View SourceUpdates 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.update_evaluation_form(Client, EvaluationFormId, InstanceId, Input0, Options0)
View Sourceupdate_hours_of_operation(Client, HoursOfOperationId, InstanceId, Input)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation.update_hours_of_operation(Client, HoursOfOperationId, InstanceId, Input0, Options0)
View Sourceupdate_instance_attribute(Client, AttributeType, InstanceId, Input)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
Updates the value for the specified attribute type.update_instance_attribute(Client, AttributeType, InstanceId, Input0, Options0)
View Sourceupdate_instance_storage_config(Client, AssociationId, InstanceId, Input)
View SourceThis 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.update_instance_storage_config(Client, AssociationId, InstanceId, Input0, Options0)
View Sourceupdate_participant_role_config(Client, ContactId, InstanceId, Input)
View SourceUpdates 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
update_participant_role_config(Client, ContactId, InstanceId, Input0, Options0)
View SourceUpdates 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: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html API to verify the status of a previous UpdatePhoneNumber: https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html operation.Updates a phone number’s metadata.
To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html API.update_phone_number_metadata(Client, PhoneNumberId, Input0, Options0)
View Sourceupdate_predefined_attribute(Client, InstanceId, Name, Input0, Options0)
View Sourceupdate_queue_hours_of_operation(Client, InstanceId, QueueId, Input)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation for the specified queue.update_queue_hours_of_operation(Client, InstanceId, QueueId, Input0, Options0)
View SourceThis 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.update_queue_max_contacts(Client, InstanceId, QueueId, Input0, Options0)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
Updates the name and description of a queue. At leastName
or Description
must be provided.
update_queue_outbound_caller_config(Client, InstanceId, QueueId, Input)
View SourceThis 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: https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html API.
update_queue_outbound_caller_config(Client, InstanceId, QueueId, Input0, Options0)
View SourceThis API is in preview release for Amazon Connect and is subject to change.
Updates the status of the queue.update_queue_status(Client, InstanceId, QueueId, Input0, Options0)
View Sourceupdate_quick_connect_config(Client, InstanceId, QuickConnectId, Input)
View Sourceupdate_quick_connect_config(Client, InstanceId, QuickConnectId, Input0, Options0)
View Sourceupdate_quick_connect_name(Client, InstanceId, QuickConnectId, Input)
View SourceUpdates the name and description of a quick connect.
The request accepts the following data in JSON format. At leastName
or Description
must be provided.
update_quick_connect_name(Client, InstanceId, QuickConnectId, Input0, Options0)
View Sourceupdate_routing_profile_agent_availability_timer(Client, InstanceId, RoutingProfileId, Input)
View Sourceupdate_routing_profile_agent_availability_timer(Client, InstanceId, RoutingProfileId, Input0, Options0)
View Sourceupdate_routing_profile_concurrency(Client, InstanceId, RoutingProfileId, Input)
View Sourceupdate_routing_profile_concurrency(Client, InstanceId, RoutingProfileId, Input0, Options0)
View Sourceupdate_routing_profile_default_outbound_queue(Client, InstanceId, RoutingProfileId, Input)
View Sourceupdate_routing_profile_default_outbound_queue(Client, InstanceId, RoutingProfileId, Input0, Options0)
View Sourceupdate_routing_profile_name(Client, InstanceId, RoutingProfileId, Input)
View SourceUpdates the name and description of a routing profile.
The request accepts the following data in JSON format. At leastName
or Description
must be provided.
update_routing_profile_name(Client, InstanceId, RoutingProfileId, Input0, Options0)
View Sourceupdate_routing_profile_queues(Client, InstanceId, RoutingProfileId, Input)
View Sourceupdate_routing_profile_queues(Client, InstanceId, RoutingProfileId, Input0, Options0)
View SourceUpdates a rule for the specified Amazon Connect instance.
Use the Rules Function language: https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-language.html to code conditions for the rule.update_security_profile(Client, InstanceId, SecurityProfileId, Input)
View Sourceupdate_security_profile(Client, InstanceId, SecurityProfileId, Input0, Options0)
View SourceUpdates 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.update_task_template(Client, InstanceId, TaskTemplateId, Input0, Options0)
View SourceUpdates the traffic distribution for a given traffic distribution group.
The SignInConfig
distribution is available only on a default TrafficDistributionGroup
(see the IsDefault
parameter in the TrafficDistributionGroup: https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html data type). If you call UpdateTrafficDistribution
with a modified SignInConfig
and a non-default TrafficDistributionGroup
, an InvalidRequestException
is returned.
update_user_hierarchy(Client, InstanceId, UserId, Input0, Options0)
View Sourceupdate_user_hierarchy_group_name(Client, HierarchyGroupId, InstanceId, Input)
View Sourceupdate_user_hierarchy_group_name(Client, HierarchyGroupId, InstanceId, Input0, Options0)
View Sourceupdate_user_hierarchy_structure(Client, InstanceId, Input0, Options0)
View SourceUpdates the identity information for the specified user.
We strongly recommend limiting who has the ability to invokeUpdateUserIdentityInfo
. 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: https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-best-practices.html in the Amazon Connect Administrator Guide.
update_user_identity_info(Client, InstanceId, UserId, Input0, Options0)
View Sourceupdate_user_phone_config(Client, InstanceId, UserId, Input0, Options0)
View Sourceupdate_user_proficiencies(Client, InstanceId, UserId, Input0, Options0)
View Sourceupdate_user_routing_profile(Client, InstanceId, UserId, Input0, Options0)
View Sourceupdate_user_security_profiles(Client, InstanceId, UserId, Input0, Options0)
View SourceUpdates the view content of the given view identifier in the specified Amazon Connect instance.
It performs content validation ifStatus
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
.
Updates the view metadata.
Note that eitherName
or Description
must be provided.