---
title: Amazon Connect API Integration on Truto
slug: amazonconnect
category: Voice
canonical: "https://truto.one/integrations/detail/amazonconnect/"
---

# Amazon Connect API Integration on Truto



**Category:** Voice  
**Status:** Beta

## MCP-ready AI tools

Truto exposes 405 tools for Amazon Connect that AI agents can call directly.

- **amazon_connect_evaluation_forms_activate** — Activates an evaluation form in the specified Connect Customer instance. After the evaluation form is activated, it is available to start new evaluations based on the form. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_evaluation_form** — Creates an evaluation form in the specified Connect Customer 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. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_evaluation_forms_deactivate** — Deactivates an evaluation form in the specified Connect Customer instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_evaluation_form_by_id** — Deletes an evaluation form in the specified Connect Customer 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. The id is the EvaluationFormId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_evaluation_form_by_id** — Describes an evaluation form in the specified Connect Customer instance. If the version property is not provided, the latest version of the evaluation form is described. The id is the EvaluationFormId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_evaluation_forms** — Lists evaluation forms in the specified Connect Customer instance. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_evaluation_forms_search** — Searches evaluation forms in an Connect Customer instance, with optional filtering. Use cases Following are common uses cases for this API: List all evaluation forms in an instance. Find all evaluation forms that meet specific criteria, such as Title, Description, Status, and more. Find all evaluation forms that are tagged with a specific set of tags. Important things to know A Search operation, unlike a List operation, takes time to index changes to resource (create, update or delete).
- **update_a_amazon_connect_evaluation_form_by_id** — Updates details about a specific evaluation form version in the specified Connect Customer 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. The id is the EvaluationFormId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_approved_origins** — This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of all approved origins associated with the instance. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_approved_origins_attach** — This API is in preview release for Connect Customer and is subject to change. Associates an approved origin to an Connect Customer instance. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_approved_origins_detach** — This API is in preview release for Connect Customer and is subject to change. Revokes access to integrated applications from Connect Customer. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_bots** — This API is in preview release for Connect Customer 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. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_bots_attach** — This API is in preview release for Connect Customer and is subject to change. Allows the specified Connect Customer instance to access the specified Amazon Lex or Amazon Lex V2 bot. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_bots_detach** — This API is in preview release for Connect Customer and is subject to change. Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_contact** — Only the VOICE, EMAIL, and TASK channels are supported. For VOICE: The supported initiation method is TRANSFER . The contacts created with this initiation method have a subtype connect:ExternalAudio . For EMAIL: The supported initiation methods are OUTBOUND , AGENT_REPLY , and FLOW . For TASK: The supported initiation method is API . Contacts created with this API have a sub-type of connect:ExternalTask . Creates a new VOICE, EMAIL, or TASK contact. After a contact is created, you can move it to the desired state by using the InitiateAs parameter.
- **get_single_amazon_connect_contact_by_id** — This API is in preview release for Connect Customer and is subject to change. Describes the specified contact. Use cases Following are common uses cases for this API: Retrieve contact information such as the caller's phone number and the specific number the caller dialed to integrate into custom monitoring or custom agent experience solutions. Detect when a customer chat session disconnects due to a network issue on the agent's end. Use the DisconnectReason field in the ContactTraceRecord to detect this event and then re-queue the chat for followup. The id is the ContactId. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_contacts_pause** — Pauses an ongoing task or email contact.
- **amazon_connect_contacts_resume** — Resumes a task or email contact in a paused state.
- **amazon_connect_contacts_search** — Searches contacts in an Connect Customer instance. Paged automatically (limit / next_cursor).
- **amazon_connect_contacts_stop** — 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.
- **amazon_connect_contacts_tag** — 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 Connect Customer usage .
- **amazon_connect_contacts_untag** — 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 Connect Customer usage . Runs against the Amazon Connect instance set on the connection.
- **update_a_amazon_connect_contact_by_id** — This API is in preview release for Connect Customer 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. The id is the ContactId. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_contacts_assign** — Associates a queued contact with an agent. Use cases Following are common uses cases for this API: Programmatically assign queued contacts to available users. Leverage the IAM context key connect:PreferredUserArn to restrict contact association to specific preferred user. Important things to know Use this API with chat, email, task, and voice contacts. For voice callbacks, this API does not support customer-first mode. This API can be used to offer a contact to an agent even if the agent is currently at maximum concurrency for the channel. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_contacts_reschedule** — Updates the scheduled time of a task contact that is already scheduled.
- **amazon_connect_contacts_bulk_create** — Only the Connect Customer 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 Connect Customer. 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. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_default_vocabularies** — Lists the default vocabularies for the specified Connect Customer instance. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_default_vocabularies_attach** — Associates an existing vocabulary as the default. Contact Lens for Connect Customer uses the vocabulary in post-call and real-time analysis sessions for the given language. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_email_address** — Create new email address in the specified Connect Customer instance. For more information about email addresses, see Create email addresses in the Connect Customer Administrator Guide. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_email_address_by_id** — Deletes email address from the specified Connect Customer instance. The id is the EmailAddressId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_email_address_by_id** — Describe email address form the specified Connect Customer instance. The id is the EmailAddressId. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_email_addresses_search** — Searches email address in an instance, with optional filtering.
- **update_a_amazon_connect_email_address_by_id** — Updates an email address metadata. For more information about email addresses, see Create email addresses in the Connect Customer Administrator Guide. The id is the EmailAddressId. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_hours_of_operation** — Creates hours of operation. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_hours_of_operation_by_id** — Deletes an hours of operation. The id is the HoursOfOperationId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_hours_of_operation_by_id** — Describes the hours of operation. The id is the HoursOfOperationId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_hours_of_operations** — Provides information about the hours of operation for the specified Connect Customer instance. For more information about hours of operation, see Set the Hours of Operation for a Queue in the Connect Customer Administrator Guide . Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_hours_of_operations_search** — Searches the hours of operation in an Connect Customer instance, with optional filtering. Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_hours_of_operation_by_id** — Updates the hours of operation. The id is the HoursOfOperationId. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_hours_of_operations_attach** — Associates a set of hours of operations with another hours of operation. For more information about inheriting overrides from parent hours of operation, see Hours of operation overrides in the Administrator Guide. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_hours_of_operations_detach** — Disassociates a set of hours of operations with another hours of operation. For more information about inheriting overrides from parent hours of operation, see Hours of operation overrides in the Administrator Guide. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_hours_of_operations_lookup_effective** — Get the hours of operations with the effective override applied. hours_of_operation_id is the HoursOfOperationId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_instance_storage_config_by_id** — This API is in preview release for Connect Customer and is subject to change. Retrieves the current storage configurations for the specified resource type, association ID, and instance ID. The id is the AssociationId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_instance_storage_configs** — This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of storage configs for the identified instance and resource type. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_instance_storage_config_by_id** — This API is in preview release for Connect Customer and is subject to change. Updates an existing configuration for a resource type. This API is idempotent. The id is the AssociationId. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_instance_storage_configs_attach** — Associates a storage resource type (for example an S3 bucket or Kinesis stream) with the instance for the first time. One storage configuration per call; the resource must already exist. Preview API, subject to change. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_instance_storage_configs_detach** — This API is in preview release for Connect Customer and is subject to change. Removes the storage type configurations for the specified resource type and association ID. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_lambda_functions** — This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_lambda_functions_attach** — This API is in preview release for Connect Customer and is subject to change. Allows the specified Connect Customer instance to access the specified Lambda function. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_lambda_functions_detach** — This API is in preview release for Connect Customer and is subject to change. Remove the Lambda function from the dropdown options available in the relevant flow blocks. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_lex_bots** — This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_lex_bots_attach** — This API is in preview release for Connect Customer and is subject to change. Allows the specified Connect Customer instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_lex_bots_detach** — This API is in preview release for Connect Customer and is subject to change. Revokes authorization from the specified instance to access the specified Amazon Lex bot. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_phone_number_by_id** — Gets details and status of a phone number that’s claimed to your Connect Customer 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. The id is the PhoneNumberId.
- **list_all_amazon_connect_phone_numbers** — Provides information about the phone numbers for the specified Connect Customer instance. For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Connect Customer 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 . Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_phone_number_by_id** — Updates your claimed phone number from its current Connect Customer instance or traffic distribution group to another Connect Customer 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. The id is the PhoneNumberId.
- **create_a_amazon_connect_phone_number** — Claims an available phone number to your Connect Customer instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Connect Customer 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 Connect Customer Administrator Guide . You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim.
- **delete_a_amazon_connect_phone_number_by_id** — Releases a phone number previously claimed to an Connect Customer 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 Connect Customer 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 Services Support. The id is the PhoneNumberId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_queue_email_addresses** — Lists all email addresses that are currently associated with a specific queue, providing details about which "From" email addresses agents can select when handling email contacts. This helps administrators manage agent email address options and understand the available choices for different brands and business units. Important things to know The response includes metadata about each email address available for agent selection, including whether it's configured as the default outbound email. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_queue_email_addresses_attach** — Associates a set of email addresses with a queue to enable agents to select different "From" (system) email addresses when replying to inbound email contacts or initiating outbound email contacts. This allows agents to handle email contacts across different brands and business units within the same queue. Important things to know You can associate up to 49 additional email addresses with a single queue, plus 1 default outbound email address, for a total of 50. The email addresses must already exist in the Connect Customer instance before they can be associated with a queue. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_queue_email_addresses_detach** — Removes the association between a set of email addresses and a queue. After disassociation, agents will no longer be able to select these email addresses as "From" addresses when replying to inbound email contacts or initiating outbound email contacts in this queue. Important things to know Agents will no longer see these email addresses in their "From" address selection options for this queue. The email addresses themselves are not deleted from the instance, only their availability for agent selection in this queue is removed. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_queue_quick_connects** — Lists the quick connects associated with a queue. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_queue_quick_connects_attach** — Associates a set of quick connects with a queue. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_queue_quick_connects_detach** — Disassociates a set of quick connects from a queue. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_routing_profile_queues** — Lists the queues associated with a routing profile. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_routing_profile_queue_by_id** — Updates the properties associated with a set of queues for a routing profile. The id is the RoutingProfileId. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_routing_profile_queues_attach** — Associates a set of queues with a routing profile. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_routing_profile_queues_detach** — Disassociates a set of queues from a routing profile. Up to 10 queue references can be disassociated in a single API call. More than 10 queue references results in a single call results in an InvalidParameterException. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_security_keys** — This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of all security keys associated with the instance. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_security_keys_attach** — This API is in preview release for Connect Customer and is subject to change. Associates a security key to the instance. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_security_keys_detach** — This API is in preview release for Connect Customer and is subject to change. Deletes the specified security key. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_security_profile** — Creates a security profile. For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide . For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions . Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_security_profile_by_id** — Deletes a security profile. The id is the SecurityProfileId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_security_profile_by_id** — Gets basic information about the security profile. For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide . For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions . The id is the SecurityProfileId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_security_profiles** — Provides summary information about the security profiles for the specified Connect Customer instance. For more information about security profiles, see Security Profiles in the Connect Customer Administrator Guide . For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions . Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_security_profiles_search** — Searches security profiles in an Connect Customer instance, with optional filtering. For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide . For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions . Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_security_profile_by_id** — Updates a security profile. For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide . For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions . The id is the SecurityProfileId. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_security_profiles_attach** — Associate security profiles with an Entity in an Amazon Connect instance. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_security_profiles_detach** — Disassociates a security profile attached to a Q in Connect AI Agent Entity in an Amazon Connect instance. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_traffic_distribution_group_users** — Lists traffic distribution group users. Paged automatically (limit / next_cursor).
- **amazon_connect_traffic_distribution_group_users_attach** — Associates an agent with a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
- **amazon_connect_traffic_distribution_group_users_detach** — Disassociates an agent from a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
- **list_all_amazon_connect_user_proficiencies** — Lists proficiencies associated with a user. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_user_proficiency_by_id** — Updates the properties associated with the proficiencies of a user. The id is the UserId. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_user_proficiencies_attach** — Associates a set of proficiencies with a user. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_user_proficiencies_detach** — Disassociates a set of proficiencies from a user. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_workspace** — Creates a workspace that defines the user experience by mapping views to pages. Workspaces can be assigned to users or routing profiles. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_workspace_by_id** — Deletes a workspace and removes all associated view and resource assignments. The id is the WorkspaceId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_workspace_by_id** — Retrieves details about a workspace, including its configuration and metadata. The id is the WorkspaceId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_workspaces** — Lists the workspaces in an Amazon Connect instance. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_workspaces_search** — Searches workspaces based on name, description, visibility, or tags. Paged automatically (limit / next_cursor).
- **amazon_connect_workspaces_attach** — Associates a workspace with one or more users or routing profiles, allowing them to access the workspace's configured views and pages. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_workspaces_detach** — Removes the association between a workspace and one or more users or routing profiles. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_attached_file** — Creates an attached file for a completed voice contact by copying a recording from an S3 URI (FileSourceUri) into Amazon Connect managed storage. AssociatedResourceArn must be the completed voice contact ARN and FileUseCaseType must be VOICE_RECORDING. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_attached_file_by_id** — Deletes an attached file along with the underlying S3 Object. The attached file is permanently deleted if S3 bucket versioning is not enabled. The id is the FileId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_attached_file_by_id** — 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 . The id is the FileId. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_attached_files_bulk_get** — 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. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_agent_status** — Creates an agent status for the specified Connect Customer instance. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_agent_status_by_id** — Describes an agent status. The id is the AgentStatusId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_agent_statuses** — Lists agent statuses. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_agent_statuses_search** — Searches AgentStatuses in an Connect Customer instance, with optional filtering. Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_agent_status_by_id** — Updates agent status. The id is the AgentStatusId. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_auth_code** — Creates an authorization code for the specified Connect Customer instance. The authorization code can be used to establish a session with scoped permissions defined by the specified scope parameters. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_contact_flow** — Creates a flow for the specified Connect Customer instance. You can also create and update flows using the Connect Customer Flow language . Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_contact_flow_by_id** — Deletes a flow for the specified Connect Customer instance. The id is the ContactFlowId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_contact_flow_by_id** — Describes the specified flow, including its content and status (SAVED or PUBLISHED). Append :$SAVED to the flow ARN or ID to read unpublished saved content, or :<version> for a specific version. The id is the ContactFlowId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_contact_flows** — Provides information about the flows for the specified Connect Customer instance. You can also create and update flows using the Connect Customer Flow language . For more information about flows, see Flows in the Connect Customer Administrator Guide . Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_contact_flows_search** — Searches the flows in an Connect Customer instance, with optional filtering. Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_contact_flow_by_id** — Updates metadata about specified flow. The id is the ContactFlowId. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_contact_flow_alias** — Creates a named alias that points to a specific version of a flow. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_contact_flow_alias_by_id** — Deletes an alias from a flow without deleting the version that the alias points to. The id is the AliasId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_contact_flow_alias_by_id** — Returns information about a specific flow alias, including the version that it points to. The id is the AliasId. Runs against the Amazon Connect instance set on the connection.
- **update_a_amazon_connect_contact_flow_alias_by_id** — Updates the name, description, or flow version associated with an alias. The id is the AliasId. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_contact_flow_module** — Creates a flow module for the specified Connect Customer instance. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_contact_flow_module_by_id** — Deletes the specified flow module. The id is the ContactFlowModuleId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_contact_flow_module_by_id** — 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. The id is the ContactFlowModuleId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_contact_flow_modules** — Provides information about the flow modules for the specified Connect Customer instance. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_contact_flow_modules_search** — Searches the flow modules in an Connect Customer instance, with optional filtering. Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_contact_flow_module_by_id** — Updates metadata about specified flow module. The id is the ContactFlowModuleId. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_contact_flow_module_alias** — Creates a named alias that points to a specific version of a contact flow module. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_contact_flow_module_alias_by_id** — Removes an alias reference, breaking the named connection to the underlying module version without affecting the version itself. The id is the AliasId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_contact_flow_module_alias_by_id** — Retrieves detailed information about a specific alias, including which version it currently points to and its metadata. The id is the AliasId. Runs against the Amazon Connect instance set on the connection.
- **update_a_amazon_connect_contact_flow_module_alias_by_id** — Updates a specific Aliases metadata, including the version it’s tied to, it’s name, and description. The id is the AliasId. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_contact_flow_module_version** — Creates an immutable snapshot of a contact flow module, preserving its content and settings at a specific point in time for version control and rollback capabilities. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_contact_flow_module_version_by_id** — Removes a specific version of a contact flow module. The id is the ContactFlowModuleVersion. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_contact_flow_module_versions** — Retrieves a paginated list of all versions for a specific contact flow module. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **create_a_amazon_connect_contact_flow_version** — 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. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_contact_flow_version_by_id** — Deletes the particular version specified in flow version identifier. The id is the ContactFlowVersion. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_contact_flow_versions** — Returns all the available versions for the specified Connect Customer instance and flow identifier. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **create_a_amazon_connect_data_table** — Creates a new data table with the specified properties. Supports the creation of all table properties except for attributes and values. A table with no attributes and values is a valid state for a table. The number of tables per instance is limited to 100 per instance. Customers can request an increase by using Amazon Web Services Service Quotas. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_data_table_by_id** — Deletes a data table and all associated attributes, versions, audits, and values. Does not update any references to the data table, even from other data tables. This includes dynamic values and conditional validations. System managed data tables are not deletable by customers. API users may delete the table at any time. When deletion is requested from the admin website, a warning is shown alerting the user of the most recent time the table and its values were accessed. The id is the DataTableId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_data_table_by_id** — Returns all properties for a data table except for attributes and values. All properties from CreateDataTable are returned as well as properties for region replication, versioning, and system tables. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations. The id is the DataTableId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_data_tables** — Lists all data tables for the specified Amazon Connect instance. Returns summary information for each table including basic metadata and modification details. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_data_tables_search** — Searches for data tables based on the table's ID, name, and description. In the future, this operation can support searching on attribute names and possibly primary values. Follows other search operations closely and supports both search criteria and filters. Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_data_table_by_id** — Updates the metadata properties of a data table. Accepts all fields similar to CreateDataTable, except for fields and tags. There are no other granular update endpoints. It does not act as a patch operation - all properties must be provided or defaults will be used. Fields follow the same requirements as CreateDataTable. The id is the DataTableId. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_data_table_attribute** — Adds an attribute to an existing data table. Creating a new primary attribute uses the empty value for the specified value type for all existing records. This should not affect uniqueness of published data tables since the existing primary values will already be unique. Creating attributes does not create any values. System managed tables may not allow customers to create new attributes. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_data_table_attribute_by_id** — Deletes an attribute and all its values from a data table. The id is the AttributeName. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_data_table_attribute_by_id** — Returns detailed information for a specific data table attribute including its configuration, validation rules, and metadata. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations. The id is the AttributeName. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_data_table_attributes** — Returns all attributes for a specified data table. A maximum of 100 attributes per data table is allowed. Customers can request an increase by using Amazon Web Services Service Quotas. The response can be filtered by specific attribute IDs for CloudFormation integration. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_data_table_attribute_by_id** — Updates all properties for an attribute using all properties from CreateDataTableAttribute. There are no other granular update endpoints. It does not act as a patch operation - all properties must be provided. System managed attributes are not mutable by customers. Changing an attribute's validation does not invalidate existing values since validation only runs when values are created or updated. The id is the AttributeName. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_extraction_definition** — Creates an extraction definition in the specified Connect Customer instance. An extraction definition specifies how structured data is extracted from customer interactions using generative AI, including the prompt hint that guides extraction and the behavior when a value cannot be found. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_extraction_definition_by_id** — Deletes an extraction definition from the specified Connect Customer instance. The id is the ExtractionDefinitionId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_extraction_definition_by_id** — Describes an extraction definition in the specified Connect Customer instance. The id is the ExtractionDefinitionId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_extraction_definitions** — Lists extraction definitions in the specified Connect Customer instance. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_extraction_definition_by_id** — Updates an extraction definition in the specified Connect Customer instance. The id is the ExtractionDefinitionId. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_hours_of_operation_override** — Creates an hours of operation override in an Connect Customer hours of operation resource. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_hours_of_operation_override_by_id** — Deletes an hours of operation override in an Connect Customer hours of operation resource. The id is the HoursOfOperationOverrideId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_hours_of_operation_override_by_id** — Describes the hours of operation override. The id is the HoursOfOperationOverrideId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_hours_of_operation_overrides** — List the hours of operation overrides. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_hours_of_operation_overrides_search** — Searches the hours of operation overrides. Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_hours_of_operation_override_by_id** — Update the hours of operation override. The id is the HoursOfOperationOverrideId. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_instance** — This API is in preview release for Connect Customer and is subject to change. Initiates an Connect Customer 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 Connect Customer. For more information, see Create an Connect Customer instance in the Connect Customer Administrator Guide . Connect Customer enforces a limit on the total number of instances that you can create or delete in 30 days.
- **list_all_amazon_connect_instances** — This API is in preview release for Connect Customer 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. Paged automatically (limit / next_cursor).
- **get_single_amazon_connect_instance_by_id** — This API is in preview release for Connect Customer 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. The id is the InstanceId (the last part of the instance ARN).
- **delete_a_amazon_connect_instance_by_id** — This API is in preview release for Connect Customer and is subject to change. Deletes the Connect Customer instance. For more information, see Delete your Connect Customer instance in the Connect Customer Administrator Guide . Connect Customer 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. The id is the InstanceId (the last part of the instance ARN).
- **create_a_amazon_connect_integration_association** — Creates an Amazon Web Services resource association with an Connect Customer instance. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_integration_association_by_id** — Deletes an Amazon Web Services resource association from an Connect Customer instance. The association must not have any use cases associated with it. The id is the IntegrationAssociationId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_integration_associations** — Provides summary information about the Amazon Web Services resource associations for the specified Connect Customer instance. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **create_a_amazon_connect_metric** — Creates a new metric definition for the specified Connect Customer instance. You can create custom metrics that use formulas referencing existing Amazon Web Services-managed metrics, optionally with filters applied. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_metric_by_id** — Deletes an existing metric from the specified Connect Customer instance. This operation fails with ResourceConflictException if the metric is currently in use in a dashboard. The id is the MetricId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_metric_by_id** — Retrieves the full definition of an existing metric from the specified Connect Customer instance. The id is the MetricId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_metrics** — Retrieves a paginated list of metric summaries for the specified Connect Customer instance. Use pagination to ensure that the operation returns quickly and successfully. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_metrics_search** — Searches for metrics in the specified Connect Customer instance using search criteria and optional tag-based filters. Use pagination to ensure that the operation returns quickly and successfully. Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_metric_by_id** — Updates the name and/or description of an existing metric in the specified Connect Customer instance. The id is the MetricId. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_notification** — Creates a new notification to be delivered to specified recipients. Notifications can include localized content with links, and an optional expiration time. Recipients can be specified as individual user ARNs or instance ARNs to target all users in an instance. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_notification_by_id** — Deletes a notification. Once deleted, the notification is no longer visible to all users and cannot be managed through the Admin Website or APIs. The id is the NotificationId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_notification_by_id** — Retrieves detailed information about a specific notification, including its content, priority, recipients, and metadata. The id is the NotificationId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_notifications** — Retrieves a paginated list of all notifications in the Amazon Connect instance. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_notifications_search** — Searches for notifications based on specified criteria and filters. Returns a paginated list of notifications matching the search parameters, ordered by descending creation time. Supports filtering by content and tags.
- **update_a_amazon_connect_notification_by_id** — Updates the localized content of an existing notification. This operation applies to all users for whom the notification was sent. The id is the NotificationId. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_participant** — Adds a new participant into an on-going chat contact or webRTC call. For more information, see Customize chat flow experiences by integrating custom participants or Enable multi-user web, in-app, and video calling .
- **create_a_amazon_connect_persistent_contact_association** — Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Connect Customer Administrator Guide . Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_predefined_attribute** — Creates a new predefined attribute for the specified Connect Customer instance. A predefined attribute is made up of a name and a value. For the predefined attributes per instance quota, see Connect Customer quotas . Use cases Following are common uses cases for this API: Create an attribute for routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents . Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_predefined_attribute_by_id** — Deletes a predefined attribute from the specified Connect Customer instance. The id is the Name. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_predefined_attribute_by_id** — Describes a predefined attribute (a name with a set of allowed values), used for routing proficiencies or contact segment attributes. The id is the attribute Name. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_predefined_attributes** — Lists the predefined attributes (names with allowed values) of the instance, used for routing proficiencies or contact segment attributes. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_predefined_attributes_search** — Searches predefined attributes (names with allowed values, used for routing proficiencies or contact segment attributes) that match the given criteria. Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_predefined_attribute_by_id** — Updates a predefined attribute for the specified Connect Customer instance. A predefined attribute is made up of a name and a value. For the predefined attributes per instance quota, see Connect Customer quotas . Use cases Following are common uses cases for this API: Update routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents . The id is the Name. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_prompt** — Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Connect Customer Administrator Guide . Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_prompt_by_id** — Deletes a prompt. The id is the PromptId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_prompt_by_id** — Describes the prompt. The id is the PromptId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_prompts** — Provides information about the prompts for the specified Connect Customer instance. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_prompts_search** — Searches prompts in an Connect Customer instance, with optional filtering. Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_prompt_by_id** — Updates a prompt. The id is the PromptId. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_prompts_lookup_file** — Gets the prompt file. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_push_notification_registration** — 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 Connect Customer for mobile chat in the Connect Customer Administrator Guide . Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_push_notification_registration_by_id** — Deletes registration for a device token and a chat contact. The id is the RegistrationId. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_queue** — Creates a new queue for the specified Connect Customer instance. If the phone number is claimed to a traffic distribution group that was created in the same Region as the Connect Customer 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. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_queue_by_id** — Deletes a queue. The id is the QueueId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_queue_by_id** — Describes the specified queue. The id is the QueueId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_queues** — Provides information about the queues for the specified Connect Customer 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 Connect Customer Administrator Guide . Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_queues_search** — Searches queues in an Connect Customer instance, with optional filtering. Paged automatically (limit / next_cursor).
- **create_a_amazon_connect_quick_connect** — Creates a quick connect for the specified Connect Customer instance. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_quick_connect_by_id** — 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 Connect Customer processes, such as instance replication and syncing if you're using Connect Customer Global Resiliency . The id is the QuickConnectId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_quick_connect_by_id** — Describes the quick connect. The id is the QuickConnectId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_quick_connects** — Provides information about the quick connects for the specified Connect Customer instance. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_quick_connects_search** — Searches quick connects in an Connect Customer instance, with optional filtering. Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_quick_connect_by_id** — Updates the configuration settings for the specified quick connect. The id is the QuickConnectId. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_routing_profile** — Creates a new routing profile. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_routing_profile_by_id** — Deletes a routing profile. The id is the RoutingProfileId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_routing_profile_by_id** — Describes the specified routing profile. DescribeRoutingProfile does not populate AssociatedQueueIds in its response. The example Response Syntax shown on this page is incorrect; we are working to update it. SearchRoutingProfiles does include AssociatedQueueIds. The id is the RoutingProfileId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_routing_profiles** — Provides summary information about the routing profiles for the specified Connect Customer instance. For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Connect Customer Administrator Guide . Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_routing_profiles_search** — Searches routing profiles in an Connect Customer instance, with optional filtering. SearchRoutingProfiles does not populate LastModifiedRegion, LastModifiedTime, MediaConcurrencies.CrossChannelBehavior, and AgentAvailabilityTimer in its response, but DescribeRoutingProfile does. Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_routing_profile_by_id** — 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. The id is the RoutingProfileId. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_rule** — Creates a rule for the specified Connect Customer instance. Use the Rules Function language to code conditions for the rule. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_rule_by_id** — Deletes a rule for the specified Connect Customer instance. The id is the RuleId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_rule_by_id** — Describes a rule for the specified Connect Customer instance. The id is the RuleId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_rules** — List all rules for the specified Connect Customer instance. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_rules_search** — Searches rules in an Connect Customer instance, with optional filtering. Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_rule_by_id** — Updates a rule for the specified Connect Customer instance. Use the Rules Function language to code conditions for the rule. The id is the RuleId. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_task_template** — Creates a new task template in the specified Connect Customer instance. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_task_template_by_id** — Deletes the task template. The id is the TaskTemplateId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_task_template_by_id** — Gets details about a specific task template in the specified Connect Customer instance. The id is the TaskTemplateId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_task_templates** — Lists task templates for the specified Connect Customer instance. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_task_template_by_id** — Updates details about a specific task template in the specified Connect Customer instance. This operation does not support partial updates. Instead it does a full update of template content. The id is the TaskTemplateId. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_test_case** — Creates a test case with its content and metadata for the specified Amazon Connect instance. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_test_case_by_id** — Deletes the test case that has already been created for the specified Amazon Connect instance. The id is the TestCaseId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_test_case_by_id** — Describes the specified test case and allows you to get the content and metadata of the test case for the specified Amazon Connect instance. The id is the TestCaseId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_test_cases** — Lists the test cases present in the specific Amazon Connect instance. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_test_cases_search** — Searches for test cases in the specified Amazon Connect instance, with optional filtering. Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_test_case_by_id** — Updates any of the metadata for a test case, such as the name, description, and status or content of an existing test case. This API doesn't allow customers to update the tags of the test case resource for the specified Amazon Connect instance. The id is the TestCaseId. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_traffic_distribution_group** — Creates a traffic distribution group given an Connect Customer 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 Connect Customer Administrator Guide .
- **delete_a_amazon_connect_traffic_distribution_group_by_id** — 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 Connect Customer Administrator Guide . The id is the TrafficDistributionGroupId.
- **get_single_amazon_connect_traffic_distribution_group_by_id** — Gets details and status of a traffic distribution group. The id is the TrafficDistributionGroupId.
- **list_all_amazon_connect_traffic_distribution_groups** — Lists traffic distribution groups. Paged automatically (limit / next_cursor).
- **create_a_amazon_connect_use_case** — Creates a use case for an integration association. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_use_case_by_id** — Deletes a use case from an integration association. The id is the UseCaseId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_use_cases** — Lists the use cases for the integration association. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **create_a_amazon_connect_user** — Creates a user account for the specified Connect Customer instance. Certain UserIdentityInfo parameters are required in some situations. For example, Email , FirstName and LastName are required if you are using Connect Customer or SAML for identity management. Fields in PhoneConfig cannot be set simultaneously with their corresponding channel-specific configuration parameters. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_user_by_id** — Deletes a user account from the specified Connect Customer instance. For information about what happens to a user's data when their account is deleted, see Delete Users from Your Connect Customer Instance in the Connect Customer 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. The id is the UserId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_user_by_id** — Describes the specified user. You can find the instance ID in the Connect Customer 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. The id is the UserId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_users** — Provides summary information about the users for the specified Connect Customer instance. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_users_search** — Searches users in an Connect Customer instance, with optional filtering. AfterContactWorkTimeLimit is returned in milliseconds. Paged automatically (limit / next_cursor).
- **create_a_amazon_connect_user_hierarchy_group** — Creates a new user hierarchy group. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_user_hierarchy_group_by_id** — Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups. The id is the HierarchyGroupId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_user_hierarchy_group_by_id** — Describes the specified hierarchy group. The id is the HierarchyGroupId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_user_hierarchy_groups** — Provides summary information about the hierarchy groups for the specified Connect Customer instance. For more information about agent hierarchies, see Set Up Agent Hierarchies in the Connect Customer Administrator Guide . Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_user_hierarchy_groups_search** — Searches UserHierarchyGroups in an Connect Customer 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. Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_user_hierarchy_group_by_id** — Updates the name of the user hierarchy group. The id is the HierarchyGroupId. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_view** — 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. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_view_by_id** — Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases). The id is the ViewId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_view_by_id** — Retrieves a view by ViewId or ARN. Add a qualifier such as :$SAVED (unpublished content), :$LATEST (default for customer managed views) or a version number. The id is the ViewId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_views** — Returns views in the given instance. Results are sorted primarily by type, and secondarily by name. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_views_search** — Searches views based on name, description, or tags. Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_view_by_id** — Updates the view content of the given view identifier in the specified Connect Customer 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 . The id is the ViewId. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_view_version** — 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. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_view_version_by_id** — Deletes the particular version specified in ViewVersion identifier. The id is the ViewVersion. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_view_versions** — Returns all the available versions for the specified Connect Customer instance and view identifier. Results will be sorted from highest to lowest. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **create_a_amazon_connect_vocabulary** — Creates a custom vocabulary associated with your Connect Customer instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Connect Customer uses the default vocabulary in post-call and real-time contact analysis sessions for that language. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_vocabulary_by_id** — Deletes the vocabulary that has the given identifier. The id is the VocabularyId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_vocabulary_by_id** — Describes the specified vocabulary. The id is the VocabularyId. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_vocabularies_search** — Searches for vocabularies within a specific Connect Customer instance using State , NameStartsWith , and LanguageCode . Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **create_a_amazon_connect_workspace_page** — Associates a view with a page in a workspace, defining what users see when they navigate to that page. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_workspace_page_by_id** — Removes the association between a view and a page in a workspace. The page will display the default view after deletion. The id is the Page. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_workspace_pages** — Lists the page configurations in a workspace, including the views assigned to each page. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_workspace_page_by_id** — Updates the configuration of a page in a workspace, including the associated view and input data. The id is the Page. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_contact_data_by_id** — Deletes the specified fields containing personally identifiable information (PII) from a contact in the specified Connect Customer instance. We redact PII (such as customer endpoints, additional email recipients, and the email subject) from the contact and its associated contact trace record (CTR). The contact must be in a terminated state. This deletion is permanent and cannot be undone. Performing this operation permanently deletes the specified PII. There is no retention period; you cannot recover the data after deletion. The id is the ContactId. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_contact_evaluation_by_id** — Deletes a contact evaluation in the specified Connect Customer instance. The id is the EvaluationId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_contact_evaluation_by_id** — Describes a contact evaluation in the specified Connect Customer instance. The id is the EvaluationId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_contact_evaluations** — Lists contact evaluations in the specified Connect Customer instance. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_contact_evaluations_search** — Searches contact evaluations in an Connect Customer instance, with optional filtering. Use cases Following are common uses cases for this API: Find contact evaluations by using specific search criteria. Find contact evaluations that are tagged with a specific set of tags. Important things to know A Search operation, unlike a List operation, takes time to index changes to resource (create, update or delete). If you don't see updated information for recently changed contact evaluations, try calling the API again in a few seconds. Endpoints : See Connect Customer endpoints and quotas .
- **amazon_connect_contact_evaluations_start** — Starts an empty evaluation in the specified Connect Customer 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. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_contact_evaluations_submit** — Submits a contact evaluation in the specified Connect Customer 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. Runs against the Amazon Connect instance set on the connection.
- **update_a_amazon_connect_contact_evaluation_by_id** — Updates details about a contact evaluation in the specified Connect Customer 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. The id is the EvaluationId. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_session_by_id** — Deletes a session for the specified Connect Customer instance. The id is the SessionId. Runs against the Amazon Connect instance set on the connection.
- **delete_a_amazon_connect_workspace_media_by_id** — Deletes a media asset (such as a logo) from a workspace. The id is the WorkspaceId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_workspace_medias** — Lists media assets (such as logos) associated with a workspace. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_workspace_media** — Imports a media asset (such as a logo) for use in a workspace. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_attached_files_configuration_by_id** — Describes the attached files configuration for the specified Connect Customer instance and attachment scope. If a custom configuration exists for the specified attachment scope, the custom configuration is returned. If no custom configuration exists, the default configuration values for that attachment scope are returned. The id is the AttachmentScope. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_attached_files_configurations** — Provides summary information about the attached files configurations for the specified Connect Customer instance. This API returns effective configurations (custom overrides or defaults) for each attachment scope. If no custom configuration exists for a scope, the default configuration values are returned. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_attached_files_configuration_by_id** — Updates the attached files configuration for the specified Connect Customer instance and attachment scope. If no instance-specific configuration exists, this operation creates one. Partial updates are supported—only specified fields are updated, while unspecified fields retain their current values. The id is the AttachmentScope. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_authentication_profile_by_id** — This API is in preview release for Connect Customer and is subject to change. To request access to this API, contact Amazon Web Services Support. Describes the target authentication profile. The id is the AuthenticationProfileId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_authentication_profiles** — This API is in preview release for Connect Customer and is subject to change. To request access to this API, contact Amazon Web Services Support. Provides summary information about the authentication profiles in a specified Connect Customer instance. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_authentication_profile_by_id** — This API is in preview release for Connect Customer and is subject to change. To request access to this API, contact Amazon Web Services Support. Updates the selected authentication profile. The id is the AuthenticationProfileId. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_instance_attribute_by_id** — This API is in preview release for Connect Customer and is subject to change. Describes the specified instance attribute. The id is the AttributeType. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_instance_attributes** — This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of all attribute types for the given instance. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_instance_attribute_by_id** — This API is in preview release for Connect Customer and is subject to change. Updates the value for the specified attribute type. The id is the AttributeType. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_user_hierarchy_structures** — Describes the hierarchy structure of the specified Connect Customer instance. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_user_hierarchy_structures_bulk_update** — Updates the user hierarchy structure: add, remove, and rename user hierarchy levels. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_data_table_values** — Lists values stored in a data table with optional filtering by record IDs or primary attribute values. Returns the raw stored values along with metadata such as lock versions and modification timestamps. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_data_table_values_bulk_create** — Creates values for attributes in a data table. The value may be a default or it may be associated with a primary value. The value must pass all customer defined validation as well as the default validation for the value type. The operation must conform to Batch Operation API Standards. Although the standard specifies that successful and failed entities are listed separately in the response, authorization fails if any primary values or attributes are unauthorized. The combination of primary values and the attribute name serve as the identifier for the individual item request. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_data_table_values_bulk_delete** — Deletes multiple values from a data table. API users may delete values at any time. When deletion is requested from the admin website, a warning is shown alerting the user of the most recent time the attribute and its values were accessed. System managed values are not deletable by customers. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_data_table_values_bulk_get** — Retrieves multiple values from a data table without evaluating expressions. Returns the raw stored values along with metadata such as lock versions and modification timestamps. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_data_table_values_bulk_update** — Updates multiple data table values using all properties from BatchCreateDataTableValue. System managed values are not modifiable by customers. The operation requires proper lock versions to prevent concurrent modification conflicts. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_data_table_values_lookup** — Evaluates values at the time of the request and returns them. It considers the request's timezone or the table's timezone, in that order, when accessing time based tables. When a value is accessed, the accessor's identity and the time of access are saved alongside the value to help identify values that are actively in use. The term "Batch" is not included in the operation name since it does not meet all the criteria for a batch operation as specified in Batch Operations: Amazon Web Services API Standards. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **list_all_amazon_connect_cross_region_routing** — Retrieves the current cross-region routing configuration for an Amazon Connect Global Resiliency instance enabled for global routing. This operation returns whether cross-region routing is currently enabled or disabled (isolated) for the instance. This operation is available only for Amazon Connect Global Resiliency instances enabled for global routing. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_cross_region_routing_bulk_update** — Updates the cross-region routing configuration for an Amazon Connect Global Resiliency instance enabled for global routing. When invoked with IsolatedAll set to true , this operation disables cross-region routing, meaning contacts originating in one Region will no longer be routed to agents in another Region. This operation is available only for Amazon Connect Global Resiliency instances enabled for global routing. Reporting and contact search continue to operate globally after you use this operation. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_flow_association_by_id** — Retrieves the flow associated for a given resource. The id is the ResourceType. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_flow_associations** — List the flow association based on the filters. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **amazon_connect_flow_associations_attach** — Associates a connect resource to a flow. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_flow_associations_detach** — Disassociates a connect resource from a flow. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_flow_associations_bulk_get** — Retrieve the flow associations for the given resources. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_test_case_executions** — Lists all test case executions and allows filtering by test case id, test case name, start time, end time or status of the execution for the specified Amazon Connect instance. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_test_case_executions_start** — Starts executing a published test case. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_test_case_executions_stop** — Stops a running test execution. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_test_case_executions_lookup_summary** — Retrieves an overview of a test execution that includes the status of the execution, start and end time, and observation summary. Runs against the Amazon Connect instance set on the connection.
- **get_single_amazon_connect_traffic_distribution_by_id** — Retrieves the current traffic distribution for a given traffic distribution group. The id is the Id.
- **update_a_amazon_connect_traffic_distribution_by_id** — 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). The id is the Id.
- **list_all_amazon_connect_analytics_data_associations** — Lists the association status of requested dataset ID for a given Connect Customer instance. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_analytics_data_lake_data_sets** — Lists the data lake datasets available to associate with for a given Connect Customer instance. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_associated_contacts** — Provides information about contact tree, a list of associated contacts with a unique identifier. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_child_hours_of_operations** — Provides information about the child hours of operations for the specified parent hours of operation. For more information about child hours of operations, see Link overrides from different hours of operation in the Administrator Guide . Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **list_all_amazon_connect_contact_flow_aliases** — Lists the aliases associated with a flow, including the version that each alias points to. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **list_all_amazon_connect_contact_flow_module_aliases** — Lists all aliases associated with a contact flow module, showing their current version mappings and metadata. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **list_all_amazon_connect_contact_references** — This API is in preview release for Connect Customer 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. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **list_all_amazon_connect_data_table_primary_values** — Lists all primary value combinations for a given data table. Returns the unique combinations of primary attribute values that identify records in the table. Up to 100 records are returned per request. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **update_a_amazon_connect_data_table_primary_value_by_id** — Updates the primary values for a record. This operation affects all existing values that are currently associated to the record and its primary values. Users that have restrictions on attributes and/or primary values are not authorized to use this endpoint. The combination of new primary values must be unique within the table. The id is the DataTableId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_entity_security_profiles** — Lists all security profiles attached to a Q in Connect AIAgent Entity in an Amazon Connect instance. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **list_all_amazon_connect_evaluation_form_ai_versions** — Lists the available AI versions for evaluation forms in the specified Connect Customer instance. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **list_all_amazon_connect_evaluation_form_versions** — Lists versions of an evaluation form in the specified Connect Customer instance. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **list_all_amazon_connect_phone_numbers_v_2_s** — Lists phone numbers claimed to your Connect Customer 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 Connect Customer Administrator Guide . When given an instance ARN, ListPhoneNumbersV2 returns only the phone numbers claimed to the instance. Paged automatically (limit / next_cursor).
- **list_all_amazon_connect_realtime_contact_analysis_segments_v_2_s** — 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. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **list_all_amazon_connect_replication_findings** — Lists replication findings for resources of a specified resource type in a specified Connect Customer instance. A replication finding describes a single resource whose replication to one or more Regions is incomplete or has encountered an error. Results are returned in pages. This operation is available only for instances that are set up for Global Resiliency. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **list_all_amazon_connect_routing_profile_manual_assignment_queues** — Lists the manual assignment queues associated with a routing profile. Use cases Following are common uses cases for this API: This API returns list of queues where contacts can be manually assigned or picked by an agent who has access to the Worklist app. The user can additionally filter on queues, if they have access to those queues (otherwise a invalid request exception will be thrown). For information about how manual contact assignment works in the agent workspace, see the Access the Worklist app in the Connect Customer agent workspace in the Connect Customer Administrator Guide . Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **list_all_amazon_connect_security_profile_ai_agents** — Returns a list of the allowed AI agents in a specific security profile. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **list_all_amazon_connect_security_profile_applications** — Returns a list of third-party applications or MCP Servers in a specific security profile. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **list_all_amazon_connect_security_profile_flow_modules** — A list of Flow Modules an AI Agent can invoke as a tool Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **list_all_amazon_connect_security_profile_permissions** — Lists the permissions granted to a security profile. For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide . For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions . Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **list_all_amazon_connect_tags_for_resources** — Lists the tags for the specified resource. For sample policies that use tags, see Connect Customer Identity-Based Policy Examples in the Connect Customer Administrator Guide .
- **list_all_amazon_connect_test_case_execution_records** — Lists detailed steps of test case execution that includes all observations along with actions taken and data associated in the specified Amazon Connect instance. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_user_notifications** — Retrieves a paginated list of notifications for a specific user, including the notification status for that user. Runs against the Amazon Connect instance set on the connection.
- **update_a_amazon_connect_user_notification_by_id** — Updates the status of a notification for a specific user, such as marking it as read or hidden. Users can only update notification status for notifications that have been sent to them. READ status deprioritizes the notification and greys it out, while HIDDEN status removes it from the notification widget. The id is the NotificationId. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_available_phone_numbers_search** — Searches for available phone numbers that you can claim to your Connect Customer 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. Paged automatically (limit / next_cursor).
- **amazon_connect_resource_tags_search** — Searches tags used in an Connect Customer instance using optional search criteria. Paged automatically (limit / next_cursor).
- **amazon_connect_workspace_associations_search** — Searches for workspace associations with users or routing profiles based on various criteria. Paged automatically (limit / next_cursor).
- **amazon_connect_chat_integration_event_send** — Processes chat integration events from Amazon Web Services or external integrations to Connect Customer. 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.
- **amazon_connect_outbound_email_send** — Send outbound email for outbound campaigns. For more information about outbound campaigns, see Set up Connect Customer outbound campaigns . Only the Connect Customer outbound campaigns service principal is allowed to assume a role in your account and call this API. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_outbound_web_notification_send** — Sends an outbound web notification to a customer's web browser for outbound campaigns. For more information about outbound campaigns, see Set up Connect Customer outbound campaigns . Only the Connect Customer outbound campaigns service principal is allowed to assume a role in your account and call this API. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_assistant_contact_start** — Starts a chat contact with an AI agent. Use the returned ParticipantToken with the CreateParticipantConnection operation. For more information about chat, see the following topics in the Connect Customer Administrator Guide : Concepts: Web and mobile messaging capabilities in Connect Customer Connect Customer Chat security best practices
- **amazon_connect_chat_contact_start** — 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 Connect Customer 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. To receive connection information directly in the response, set ConnectionTypes on the request.
- **amazon_connect_email_contact_start** — 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.
- **amazon_connect_outbound_chat_contact_start** — Initiates a new outbound SMS or WhatsApp contact to a customer. Response of this API provides the ContactId of the outbound SMS or WhatsApp 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 contact created. This API can be used to initiate outbound SMS or WhatsApp contacts for an agent, or it can also deflect an ongoing contact to an outbound SMS or WhatsApp contact by using the StartOutboundChatContact Flow Action.
- **amazon_connect_outbound_email_contact_start** — Initiates a flow to send an agent reply or outbound email contact (created from the CreateContact API) to a customer.
- **amazon_connect_outbound_voice_contact_start** — 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. Dialing timeout for this operation can be configured with the “RingTimeoutInSeconds” parameter.
- **amazon_connect_screen_sharing_start** — 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 Connect Customer Administrator Guide .
- **amazon_connect_task_contact_start** — Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Connect Customer in the Connect Customer 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 .
- **amazon_connect_web_rtc_contact_start** — 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 Connect Customer instance (specified as InstanceId).
- **amazon_connect_resource_tag** — 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, task templates, and custom metrics. For a complete list, see Tagging resources in Connect Customer . For sample policies that use tags, see Connect Customer Identity-Based Policy Examples in the Connect Customer Administrator Guide .
- **amazon_connect_resource_untag** — Removes the specified tags from the specified resource.
- **amazon_connect_evaluation_form_validations_start** — Starts an asynchronous validation process for an evaluation form version in the specified Connect Customer instance. The validation first performs structural checks on the form content (such as verifying required fields, valid scoring configuration, and correct conditional logic), then asynchronously analyzes questions configured for generative AI evaluation against a set of best practices. Use GetEvaluationFormValidation to retrieve the status and results once the validation completes. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_evaluation_form_validations_lookup** — Retrieves the status and results of a validation process started by StartEvaluationFormValidation . Returns the current execution status ( IN_PROGRESS , COMPLETED , or FAILED ), the validated form version, and when completed, a list of findings that identify structural issues and quality improvements for the evaluation form, and may include suggested fixes. If the validation failed, a reason is provided indicating the cause of the failure. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_analytics_data_sets_attach** — Associates the specified dataset for a Connect Customer instance with the target account. You can associate only one dataset in a single call. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_analytics_data_sets_detach** — Removes the dataset ID associated with a given Connect Customer instance. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_analytics_data_sets_bulk_attach** — Associates a list of analytics datasets for a given Connect Customer instance to a target account. You can associate multiple datasets in a single call. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_analytics_data_sets_bulk_detach** — Removes a list of analytics datasets associated with a given Connect Customer instance. You can disassociate multiple datasets in a single call. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_email_address_aliases_attach** — Associates an email address alias with an existing email address in an Connect Customer instance. This creates a forwarding relationship where emails sent to the alias email address are automatically forwarded to the primary email address. Use cases Following are common uses cases for this API: Unified customer support : Create multiple entry points (for example, support@example.com, help@example.com, customercare@example.com) that all forward to a single agent queue for streamlined management. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_email_address_aliases_detach** — Removes the alias association between two email addresses in an Connect Customer instance. After disassociation, emails sent to the former alias email address are no longer forwarded to the primary email address. Both email addresses continue to exist independently and can receive emails directly. Use cases Following are common uses cases for this API: Department separation : Remove alias relationships when splitting a consolidated support queue back into separate department-specific queues. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_phone_number_contact_flows_attach** — Associates a flow with a phone number claimed to your Connect Customer 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.
- **amazon_connect_phone_number_contact_flows_detach** — Removes the flow association from a phone number claimed to your Connect Customer 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.
- **get_single_amazon_connect_contact_attribute_by_id** — Retrieves the contact attributes for the specified contact. The id is the InitialContactId. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_contact_attributes_bulk_update** — 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 Connect Customer.
- **list_all_amazon_connect_contact_metrics** — Retrieves contact metric data for a specified contact. Use cases Following are common use cases for position in queue and estimated wait time: Customer-Facing Wait Time Announcements - Display or announce the estimated wait time and position in queue to customers before or during their queue experience. Callback Offerings - Offer customers a callback option when the estimated wait time or position in queue exceeds a defined threshold. Queue Routing Decisions - Route incoming contacts to less congested queues by comparing estimated wait time and position in queue across multiple queues.
- **create_a_amazon_connect_contact_monitor** — 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.
- **amazon_connect_contact_recordings_start** — 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.
- **amazon_connect_contact_recordings_stop** — 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.
- **amazon_connect_contact_recordings_pause** — When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call (IVR or agent), screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen. The period of time that the recording is suspended is filled with silence in the final recording. Voice (IVR, agent) and screen recordings are supported.
- **amazon_connect_contact_recordings_resume** — 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.
- **amazon_connect_contact_streaming_start** — 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 Connect Customer Administrator Guide . For more information about chat, see the following topics in the Connect Customer Administrator Guide : Concepts: Web and mobile messaging capabilities in Connect Customer Connect Customer Chat security best practices
- **amazon_connect_contact_streaming_stop** — Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.
- **amazon_connect_contact_media_processing_start** — Enables in-flight message processing for an ongoing chat session. Message processing will stay active for the rest of the chat, even if an individual contact segment ends.
- **amazon_connect_contact_media_processing_stop** — Stops in-flight message processing for an ongoing chat session.
- **amazon_connect_contact_conversational_analytics_jobs_start** — Starts a Contact Lens post-call analytics job for the specified contact. This API runs Conversational Analytics post-contact analysis on a voice recording that is already attached to the contact, generating transcription, sentiment analysis, redaction, and summarization results based on the provided configuration. A voice recording must already be attached to the contact before calling this API. Use CreateAttachedFile to attach a recording from an S3 source URI. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_contact_transfer** — 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 only supported for TASK and EMAIL contacts. Do not use both QueueId and UserId in the same call.
- **update_a_amazon_connect_contact_routing_datum_by_id** — 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. The id is the ContactId. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_contact_task_templates_bulk_update** — Updates the task template association on an existing task contact. You can update the task template on a contact before assignment to support tasks that are created without a template (for example Rules or disconnect flows ) or change the agent interaction form to represent the latest task data (for example an initial request that was submitted as a refund gets updated to an account cancellation and requires a new template). This operation can only be used with task contacts that are in progress and not connected to an agent. A task template can be updated a maximum of 5 times per contact.
- **amazon_connect_participant_authentication_submit** — Instructs Connect Customer 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.
- **update_a_amazon_connect_participant_role_config_by_id** — 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 . The id is the ContactId. Runs against the Amazon Connect instance set on the connection.
- **create_a_amazon_connect_phone_number_import** — Imports a claimed phone number from an external service, such as Amazon Web Services End User Messaging, into an Connect Customer instance. You can call this API only in the same Amazon Web Services Region where the Connect Customer 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.
- **amazon_connect_phone_number_metadata_bulk_update** — Updates a phone number’s metadata. To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.
- **update_a_amazon_connect_workspace_metadatum_by_id** — Updates the metadata of a workspace, such as its name and description. The id is the WorkspaceId. Runs against the Amazon Connect instance set on the connection.
- **update_a_amazon_connect_workspace_theme_by_id** — Updates the theme configuration for a workspace, including colors and styling. The id is the WorkspaceId. Runs against the Amazon Connect instance set on the connection.
- **update_a_amazon_connect_workspace_visibility_by_id** — Updates the visibility setting of a workspace, controlling whether it is available to all users, assigned users only, or none. The id is the WorkspaceId. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_attached_file_uploads_start** — Provides a pre-signed Amazon S3 URL in response for uploading your content. You may only use this API to upload attachments to a Connect Customer Case , Connect Customer Email , or Connect Customer Task . Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_attached_file_uploads_complete** — Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API. Runs against the Amazon Connect instance set on the connection.
- **update_a_amazon_connect_contact_flow_content_by_id** — Updates the specified flow. You can also create and update flows using the Connect Customer 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. The id is the ContactFlowId. Runs against the Amazon Connect instance set on the connection.
- **update_a_amazon_connect_contact_flow_name_by_id** — The name of the flow. You can also create and update flows using the Connect Customer Flow language . The id is the ContactFlowId. Runs against the Amazon Connect instance set on the connection.
- **update_a_amazon_connect_contact_flow_module_content_by_id** — Updates specified flow module for the specified Connect Customer 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. The id is the ContactFlowModuleId. Runs against the Amazon Connect instance set on the connection.
- **update_a_amazon_connect_view_metadatum_by_id** — Updates the view metadata. Note that either Name or Description must be provided. The id is the ViewId. Runs against the Amazon Connect instance set on the connection.
- **update_a_amazon_connect_metric_content_by_id** — Updates the calculation, unit, and/or trend indicator of an existing metric in the specified Connect Customer instance. The id is the MetricId. Runs against the Amazon Connect instance set on the connection.
- **list_all_amazon_connect_historical_metric_data** — Gets historical metric data from the specified Connect Customer instance. For a description of each historical metric, see Metrics definitions in the Connect Customer 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. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **list_all_amazon_connect_metric_data** — Gets metric data from the specified Connect Customer 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. Paged automatically (limit / next_cursor).
- **list_all_amazon_connect_current_metric_data** — Gets the real-time metric data from the specified Connect Customer instance. For a description of each metric, see Metrics definitions in the Connect Customer Administrator Guide . Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **list_all_amazon_connect_current_user_data** — Gets the real-time active user data from the specified Connect Customer instance. Runs against the Amazon Connect instance set on the connection. Paged automatically (limit / next_cursor).
- **create_a_amazon_connect_instance_replica** — Replicates an Connect Customer instance in the specified Amazon Web Services Region and copies configuration information for Connect Customer resources across Amazon Web Services Regions. For more information about replicating an Connect Customer instance, see Create a replica of your existing Connect Customer instance in the Connect Customer Administrator Guide . Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_entity_sessions_bulk_delete** — Deletes all active sessions for the specified entity in the specified Connect Customer instance. The operation supports only the USER entity type, so you can use it to sign out all of a user's active sessions. Use it when you need to end a user's access right away, for example when they leave your organization or you suspect that their credentials are compromised.
- **list_all_amazon_connect_federation_token** — Supports SAML sign-in for Connect Customer. Retrieves a token for federation. The token is for the Connect Customer user which corresponds to the IAM credentials that were used to invoke this action. For more information about how SAML sign-in works in Connect Customer, see Configure SAML with IAM for Connect Customer in the Connect Customer 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: .... Runs against the Amazon Connect instance set on the connection.
- **update_a_amazon_connect_queue_hours_of_operation_by_id** — Updates the hours of operation for the specified queue. The id is the QueueId. Runs against the Amazon Connect instance set on the connection.
- **update_a_amazon_connect_queue_max_contact_by_id** — Updates the maximum number of contacts allowed in a queue before it is considered full. The id is the QueueId. Runs against the Amazon Connect instance set on the connection.
- **update_a_amazon_connect_queue_name_by_id** — Updates the name and description of a queue. At least Name or Description must be provided. The id is the QueueId. Runs against the Amazon Connect instance set on the connection.
- **update_a_amazon_connect_queue_outbound_caller_config_by_id** — 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 Connect Customer instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId . The id is the QueueId. Runs against the Amazon Connect instance set on the connection.
- **update_a_amazon_connect_queue_outbound_email_config_by_id** — Updates the outbound email address Id for a specified queue. The id is the QueueId. Runs against the Amazon Connect instance set on the connection.
- **update_a_amazon_connect_queue_status_by_id** — Updates the status of the queue. The id is the QueueId. Runs against the Amazon Connect instance set on the connection.
- **update_a_amazon_connect_quick_connect_name_by_id** — 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. The id is the QuickConnectId. Runs against the Amazon Connect instance set on the connection.
- **update_routing_profile_agent_availability_timer_by_id** — Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time . The id is the RoutingProfileId. Runs against the Amazon Connect instance set on the connection.
- **update_a_amazon_connect_routing_profile_concurrency_by_id** — Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile. The id is the RoutingProfileId. Runs against the Amazon Connect instance set on the connection.
- **update_routing_profile_default_outbound_queue_by_id** — Updates the default outbound queue of a routing profile. The id is the RoutingProfileId. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_user_contacts_close** — 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 . Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_user_statuses_bulk_update** — Changes the current status of a user or agent in Connect Customer. 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 Connect Customer Administrator Guide . Runs against the Amazon Connect instance set on the connection.
- **update_a_amazon_connect_user_config_by_id** — Updates the configuration settings for the specified user, including per-channel auto-accept and after contact work (ACW) timeout settings. This operation replaces the UpdateUserPhoneConfig API. While UpdateUserPhoneConfig applies the same ACW timeout to all channels, UpdateUserConfig allows you to set different auto-accept and ACW timeout values for each channel type. The id is the UserId. Runs against the Amazon Connect instance set on the connection.
- **update_a_amazon_connect_user_hierarchy_by_id** — Assigns the specified hierarchy group to the specified user. The id is the UserId. Runs against the Amazon Connect instance set on the connection.
- **update_a_amazon_connect_user_identity_info_by_id** — 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 Connect Customer Administrator Guide . The id is the UserId. Runs against the Amazon Connect instance set on the connection.
- **update_a_amazon_connect_user_phone_config_by_id** — Updates the phone configuration settings for the specified user. We recommend using the UpdateUserConfig API, which supports additional functionality that is not available in the UpdateUserPhoneConfig API, such as voice enhancement settings and per-channel configuration for auto-accept and After Contact Work (ACW) timeouts. In comparison, the UpdateUserPhoneConfig API will always set the same ACW timeouts to all channels the user handles. The id is the UserId. Runs against the Amazon Connect instance set on the connection.
- **update_a_amazon_connect_user_routing_profile_by_id** — Assigns the specified routing profile to the specified user. The id is the UserId. Runs against the Amazon Connect instance set on the connection.
- **update_a_amazon_connect_user_security_profile_by_id** — Assigns the specified security profiles to the specified user. The id is the UserId. Runs against the Amazon Connect instance set on the connection.
- **amazon_connect_outbound_email_contact_messages_bulk_update** — Updates the draft outbound email message for a contact. Use this operation to save changes to an in-progress outbound email reply before you send it. This operation applies only to contacts with an OUTBOUND or AGENT_REPLY initiation method; it isn't supported for flow-initiated emails. contact_id is the ContactId. Runs against the Amazon Connect instance set on the connection.

## How it works

1. **Link your customer's Amazon Connect account.** Use Truto's frontend SDK; we handle every OAuth and API key flow so you don't need to create the OAuth app.
2. **Authentication is automatic.** Truto refreshes tokens, stores credentials securely, and injects them into every API request.
3. **Call Truto's API to reach Amazon Connect.** The Proxy API is a 1-to-1 mapping of the Amazon Connect API.
4. **Get a unified response format.** Every response uses a single shape, with cursor-based pagination and data in the `result` field.

## Use cases

- **Embed a contact center inside your CRM or helpdesk** — Let your customers connect their Amazon Connect instance to power screen-pops, click-to-dial, and automatic call logging without leaving your product. Truto handles AWS auth and API quirks so you can ship the agent workspace faster.
- **Build AI-powered conversation intelligence on top of voice** — Ingest completed voice contacts, pull recordings and transcripts via Contact Lens, and surface coaching insights, sentiment, and competitor mentions inside your revenue intelligence or QA product.
- **Power workforce management and real-time agent adherence** — Sync live agent states, queue metrics, and historical interaction data to drive scheduling, forecasting, and adherence dashboards in your WFM platform — all in near real-time.
- **Trigger outbound voice, SMS, email, and tasks from your workflow engine** — Let marketing automation, sales engagement, or support platforms kick off outbound calls, chats, emails, or routed tasks in Amazon Connect based on product events like high-intent form fills or SLA breaches.
- **Automate contact center administration for your enterprise customers** — Provision users, routing profiles, queues, hours of operation, and security profiles programmatically so your onboarding flow can configure Amazon Connect for new customers without manual AWS console work.

## What you can build

- **Click-to-dial with CRM context injection** — Initiate outbound voice contacts and attach CRM identifiers (ticket ID, customer tier, account ID) as contact attributes so IVR flows and agents get live context.
- **Post-call sync of transcripts, recordings, and metadata** — Fetch Contact Trace Records, attached files (recordings, transcripts), and conversational analytics output to automatically log every interaction to your customer's timeline.
- **Real-time agent presence and queue dashboards** — Stream current user data, current metric data, and historical metric data into your product to show live agent status, queue depth, SLA, and abandonment rates.
- **Omnichannel task injection from product events** — Create voice, email, chat, or task contacts directly in Amazon Connect from your workflow triggers to route urgent product events to the next available agent.
- **PCI-safe recording pause/resume** — Programmatically pause and resume call recording during payment capture or sensitive data collection, then resume automatically — ideal for billing or fintech surfaces.
- **Admin console for Connect configuration** — Expose a UI that lets admins create and manage users, routing profiles, queues, contact flows, hours of operation, and quick connects in Amazon Connect without touching the AWS console.

## FAQs

### How does authentication to Amazon Connect work through Truto?

Amazon Connect uses AWS IAM-based authentication scoped to a specific Connect instance. Truto handles the AWS signing, credential storage, and instance scoping so your end users connect their account once and your product calls a normalized API — no need to manage AWS SigV4 or STS token refresh yourself.

### Can we initiate outbound calls, chats, emails, and tasks?

Yes. Truto exposes the full set of start-contact actions including outbound voice, outbound chat, outbound email, task, email, chat, Web RTC, and screen-sharing contact starts, so you can trigger any channel Amazon Connect supports.

### How do we pull call recordings and transcripts?

Recordings and transcripts are available as attached files on a contact. You can list and fetch them via the attached file endpoints, and trigger Contact Lens conversational analytics jobs to generate transcripts, redaction, and sentiment for voice contacts.

### Can we get real-time agent and queue metrics?

Yes. Truto supports Amazon Connect's current metric data, current user data, historical metric data, and metric data endpoints for live dashboards and historical reporting. Refresh cadence is bound by Amazon Connect's own API rate limits, which Truto helps you manage with built-in retries and backoff.

### Can our end users inject custom context into a live call?

Yes. You can bulk-update contact attributes on an active contact, which dynamically affects routing, IVR branching, and what the agent sees — a common pattern for CRM screen-pop and tiered routing.

### Does Truto support managing Connect configuration like users, queues, and contact flows?

Yes. Truto exposes CRUD operations for users, routing profiles, queues, quick connects, hours of operation, security profiles, contact flows, contact flow modules, prompts, predefined attributes, and more — so you can fully automate tenant provisioning and admin UIs.

### How do we handle pause/resume of recordings for PCI compliance?

Truto provides dedicated actions to start, stop, pause, and resume contact recordings on an active contact, so you can gate sensitive segments (like credit card capture) without building the AWS API plumbing yourself.
