aws_connect

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

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

Summary

Functions

• create_user(Client, InstanceId, Input)
  Creates a user account for the specified Amazon Connect instance.
• create_user(Client, InstanceId, Input0, Options)
• delete_user(Client, InstanceId, UserId, Input)
  Deletes a user account from the specified Amazon Connect instance.
• delete_user(Client, InstanceId, UserId, Input0, Options)
• describe_user(Client, InstanceId, UserId)
  Describes the specified user account.
• describe_user(Client, InstanceId, UserId, Options)
• describe_user_hierarchy_group(Client, HierarchyGroupId, InstanceId)
  Describes the specified hierarchy group.
• describe_user_hierarchy_group(Client, HierarchyGroupId, InstanceId, Options)
• describe_user_hierarchy_structure(Client, InstanceId)
  Describes the hierarchy structure of the specified Amazon Connect instance.
• describe_user_hierarchy_structure(Client, InstanceId, Options)
• get_contact_attributes(Client, InitialContactId, InstanceId)
  Retrieves the contact attributes for the specified contact.
• get_contact_attributes(Client, InitialContactId, InstanceId, Options)
• get_current_metric_data(Client, InstanceId, Input)
  Gets the real-time metric data from the specified Amazon Connect instance.
• get_current_metric_data(Client, InstanceId, Input0, Options)
• get_federation_token(Client, InstanceId)
  Retrieves a token for federation.
• get_federation_token(Client, InstanceId, Options)
• get_metric_data(Client, InstanceId, Input)
  Gets historical metric data from the specified Amazon Connect instance.
• get_metric_data(Client, InstanceId, Input0, Options)
• list_contact_flows(Client, InstanceId)
  Provides information about the contact flows for the specified Amazon Connect instance.
• list_contact_flows(Client, InstanceId, Options)
• list_hours_of_operations(Client, InstanceId)
  Provides information about the hours of operation for the specified Amazon Connect instance.
• list_hours_of_operations(Client, InstanceId, Options)
• list_phone_numbers(Client, InstanceId)
  Provides information about the phone numbers for the specified Amazon Connect instance.
• list_phone_numbers(Client, InstanceId, Options)
• list_queues(Client, InstanceId)
  Provides information about the queues for the specified Amazon Connect instance.
• list_queues(Client, InstanceId, Options)
• list_routing_profiles(Client, InstanceId)
  Provides summary information about the routing profiles for the specified Amazon Connect instance.
• list_routing_profiles(Client, InstanceId, Options)
• list_security_profiles(Client, InstanceId)
  Provides summary information about the security profiles for the specified Amazon Connect instance.
• list_security_profiles(Client, InstanceId, Options)
• list_tags_for_resource(Client, ResourceArn)
  Lists the tags for the specified resource.
• list_tags_for_resource(Client, ResourceArn, Options)
• list_user_hierarchy_groups(Client, InstanceId)
  Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
• list_user_hierarchy_groups(Client, InstanceId, Options)
• list_users(Client, InstanceId)
  Provides summary information about the users for the specified Amazon Connect instance.
• list_users(Client, InstanceId, Options)
• resume_contact_recording(Client, Input)
  When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call.
• resume_contact_recording(Client, Input0, Options)
• start_chat_contact(Client, Input)
  Initiates a contact flow to start a new chat for the customer.
• start_chat_contact(Client, Input0, Options)
• start_contact_recording(Client, Input)
  This API starts recording the contact when the agent joins the call.
• start_contact_recording(Client, Input0, Options)
• start_outbound_voice_contact(Client, Input)
  This API places an outbound call to a contact, and then initiates the contact flow.
• start_outbound_voice_contact(Client, Input0, Options)
• stop_contact(Client, Input)
  Ends the specified contact.
• stop_contact(Client, Input0, Options)
• stop_contact_recording(Client, Input)
  When a contact is being recorded, this API stops recording the call.
• stop_contact_recording(Client, Input0, Options)
• suspend_contact_recording(Client, Input)
  When a contact is being recorded, this API suspends recording the call.
• suspend_contact_recording(Client, Input0, Options)
• tag_resource(Client, ResourceArn, Input)
  Adds the specified tags to the specified resource.
• tag_resource(Client, ResourceArn, Input0, Options)
• untag_resource(Client, ResourceArn, Input)
  Removes the specified tags from the specified resource.
• untag_resource(Client, ResourceArn, Input0, Options)
• update_contact_attributes(Client, Input)
  Creates or updates the contact attributes associated with the specified contact.
• update_contact_attributes(Client, Input0, Options)
• update_user_hierarchy(Client, InstanceId, UserId, Input)
  Assigns the specified hierarchy group to the specified user.
• update_user_hierarchy(Client, InstanceId, UserId, Input0, Options)
• update_user_identity_info(Client, InstanceId, UserId, Input)
  Updates the identity information for the specified user.
• update_user_identity_info(Client, InstanceId, UserId, Input0, Options)
• update_user_phone_config(Client, InstanceId, UserId, Input)
  Updates the phone configuration settings for the specified user.
• update_user_phone_config(Client, InstanceId, UserId, Input0, Options)
• update_user_routing_profile(Client, InstanceId, UserId, Input)
  Assigns the specified routing profile to the specified user.
• update_user_routing_profile(Client, InstanceId, UserId, Input0, Options)
• update_user_security_profiles(Client, InstanceId, UserId, Input)
  Assigns the specified security profiles to the specified user.
• update_user_security_profiles(Client, InstanceId, UserId, Input0, Options)

Functions

Creates a user account for the specified Amazon Connect instance.

Deletes a user account from the specified Amazon Connect instance.

Describes the specified user account. You can find the instance ID in the console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.

Describes the specified hierarchy group.

Describes the hierarchy structure of the specified Amazon Connect instance.

Retrieves the contact attributes for the specified contact.

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

Retrieves a token for federation.

Gets historical metric data from the specified Amazon Connect instance.

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

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

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

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

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

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

Lists the tags for the specified resource.

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

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

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

Initiates a contact flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.

This API starts recording the contact when the agent joins the call. StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.

You can use this API to override the recording behavior configured in the Set recording behavior block.

This API places an outbound call to a contact, and then initiates the contact flow. It performs the actions in the contact flow that's specified (in ContactFlowId).

Agents are not involved in initiating the outbound API (that is, dialing the contact). If the contact flow places an outbound call to a contact, and then puts the contact in queue, that's when the call is routed to the agent, like any other inbound case.

Ends the specified contact.

When a contact is being recorded, this API stops recording the call. 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.

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

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

Adds the specified tags to the specified resource.

Removes the specified tags from the specified resource.

Creates or updates the contact attributes associated with the specified contact.

You can add or update attributes for both ongoing and completed contacts. For example, you can update the customer's name or the reason the customer called while the call is active, or add notes about steps that the agent took during the call that are displayed to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or identifying abusive callers.

Contact attributes are available in Amazon Connect for 24 months, and are then deleted.

Assigns the specified hierarchy group to the specified user.

Updates the identity information for the specified user.

Updates the phone configuration settings for the specified user.

Assigns the specified routing profile to the specified user.

Assigns the specified security profiles to the specified user.