AWS.Connect (aws-elixir v0.8.0) View Source

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

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

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

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

Working with contact flows? Check out the Amazon Connect Flow language.

Link to this section Summary

Functions

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

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

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

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

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

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

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

Creates a contact flow for the specified Amazon Connect instance.

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

Create an AppIntegration association with an Amazon Connect instance.

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

Creates a quick connect for the specified Amazon Connect instance.

Creates a user account for the specified Amazon Connect instance.

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

Deletes an AppIntegration association from an Amazon Connect instance.

Deletes a user account from the specified Amazon Connect instance.

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

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

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

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

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

Describes the specified user account.

Describes the hierarchy structure of the specified Amazon Connect instance.

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

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

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

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

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

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

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

Retrieves the contact attributes for the specified contact.

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

Gets historical metric data from the specified Amazon Connect instance.

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

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

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.

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

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

Provides summary information about the AppIntegration associations for the specified Amazon Connect instance.

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

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

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

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

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

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

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

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

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

Lists the tags for the specified resource.

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

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.

Starts recording the contact when the agent joins the call.

Places an outbound call to a contact, and then initiates the contact flow.

Initiates a contact flow to start a new task.

Ends the specified contact.

Stops recording a call when a contact is being recorded.

When a contact is being recorded, this API suspends recording the call.

Adds the specified tags to the specified resource.

Removes the specified tags from the specified resource.

Creates or updates user-defined contact attributes associated with the specified contact.

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

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

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

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

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

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

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

Updates the configuration settings for the specified quick connect.

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

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

Assigns the specified hierarchy group to the specified user.

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

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.

Link to this section Functions

Link to this function

associate_approved_origin(client, instance_id, input, options \\ [])

View Source

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

Associates an approved origin to an Amazon Connect instance.

Link to this function

associate_bot(client, instance_id, input, options \\ [])

View Source

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

Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.

Link to this function

associate_instance_storage_config(client, instance_id, input, options \\ [])

View Source

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

Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts.

This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.

Link to this function

associate_lambda_function(client, instance_id, input, options \\ [])

View Source

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

Allows the specified Amazon Connect instance to access the specified Lambda function.

Link to this function

associate_lex_bot(client, instance_id, input, options \\ [])

View Source

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

Allows the specified Amazon Connect instance to access the specified Amazon Lex bot.

Link to this function

associate_queue_quick_connects(client, instance_id, queue_id, input, options \\ [])

View Source

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

Associates a set of quick connects with a queue.

Link to this function

associate_routing_profile_queues(client, instance_id, routing_profile_id, input, options \\ [])

View Source

Associates a set of queues with a routing profile.

Link to this function

associate_security_key(client, instance_id, input, options \\ [])

View Source

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

Associates a security key to the instance.

Link to this function

create_contact_flow(client, instance_id, input, options \\ [])

View Source

Creates a contact flow for the specified Amazon Connect instance.

You can also create and update contact flows using the Amazon Connect Flow language.

Link to this function

create_instance(client, input, options \\ [])

View Source

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

Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.

Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.

Link to this function

create_integration_association(client, instance_id, input, options \\ [])

View Source

Create an AppIntegration association with an Amazon Connect instance.

Link to this function

create_queue(client, instance_id, input, options \\ [])

View Source

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

Creates a new queue for the specified Amazon Connect instance.

Link to this function

create_quick_connect(client, instance_id, input, options \\ [])

View Source

Creates a quick connect for the specified Amazon Connect instance.

Link to this function

create_routing_profile(client, instance_id, input, options \\ [])

View Source

Creates a new routing profile.

Link to this function

create_use_case(client, instance_id, integration_association_id, input, options \\ [])

View Source

Creates a use case for an AppIntegration association.

Link to this function

create_user(client, instance_id, input, options \\ [])

View Source

Creates a user account for the specified Amazon Connect instance.

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

Link to this function

create_user_hierarchy_group(client, instance_id, input, options \\ [])

View Source

Creates a new user hierarchy group.

Link to this function

delete_instance(client, instance_id, input, options \\ [])

View Source

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

Deletes the Amazon Connect instance.

Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.

Link to this function

delete_integration_association(client, instance_id, integration_association_id, input, options \\ [])

View Source

Deletes an AppIntegration association from an Amazon Connect instance.

The association must not have any use cases associated with it.

Link to this function

delete_quick_connect(client, instance_id, quick_connect_id, input, options \\ [])

View Source

Deletes a quick connect.

Link to this function

delete_use_case(client, instance_id, integration_association_id, use_case_id, input, options \\ [])

View Source

Deletes a use case from an AppIntegration association.

Link to this function

delete_user(client, instance_id, user_id, input, options \\ [])

View Source

Deletes a user account from the specified Amazon Connect instance.

For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide.

Link to this function

delete_user_hierarchy_group(client, hierarchy_group_id, instance_id, input, options \\ [])

View Source

Deletes an existing user hierarchy group.

It must not be associated with any agents or have any active child groups.

Link to this function

describe_contact_flow(client, contact_flow_id, instance_id, options \\ [])

View Source

Describes the specified contact flow.

You can also create and update contact flows using the Amazon Connect Flow language.

Link to this function

describe_hours_of_operation(client, hours_of_operation_id, instance_id, options \\ [])

View Source

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

Describes the hours of operation.

Link to this function

describe_instance(client, instance_id, options \\ [])

View Source

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

Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable.

If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.

Link to this function

describe_instance_attribute(client, attribute_type, instance_id, options \\ [])

View Source

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

Describes the specified instance attribute.

Link to this function

describe_instance_storage_config(client, association_id, instance_id, resource_type, options \\ [])

View Source

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

Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.

Link to this function

describe_queue(client, instance_id, queue_id, options \\ [])

View Source

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

Describes the specified queue.

Link to this function

describe_quick_connect(client, instance_id, quick_connect_id, options \\ [])

View Source

Describes the quick connect.

Link to this function

describe_routing_profile(client, instance_id, routing_profile_id, options \\ [])

View Source

Describes the specified routing profile.

Link to this function

describe_user(client, instance_id, user_id, options \\ [])

View Source

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.

Link to this function

describe_user_hierarchy_group(client, hierarchy_group_id, instance_id, options \\ [])

View Source

Describes the specified hierarchy group.

Link to this function

describe_user_hierarchy_structure(client, instance_id, options \\ [])

View Source

Describes the hierarchy structure of the specified Amazon Connect instance.

Link to this function

disassociate_approved_origin(client, instance_id, input, options \\ [])

View Source

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

Revokes access to integrated applications from Amazon Connect.

Link to this function

disassociate_bot(client, instance_id, input, options \\ [])

View Source

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

Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot.

Link to this function

disassociate_instance_storage_config(client, association_id, instance_id, input, options \\ [])

View Source

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

Removes the storage type configurations for the specified resource type and association ID.

Link to this function

disassociate_lambda_function(client, instance_id, input, options \\ [])

View Source

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

Remove the Lambda function from the dropdown options available in the relevant contact flow blocks.

Link to this function

disassociate_lex_bot(client, instance_id, input, options \\ [])

View Source

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

Revokes authorization from the specified instance to access the specified Amazon Lex bot.

Link to this function

disassociate_queue_quick_connects(client, instance_id, queue_id, input, options \\ [])

View Source

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

Disassociates a set of quick connects from a queue.

Link to this function

disassociate_routing_profile_queues(client, instance_id, routing_profile_id, input, options \\ [])

View Source

Disassociates a set of queues from a routing profile.

Link to this function

disassociate_security_key(client, association_id, instance_id, input, options \\ [])

View Source

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

Deletes the specified security key.

Link to this function

get_contact_attributes(client, initial_contact_id, instance_id, options \\ [])

View Source

Retrieves the contact attributes for the specified contact.

Link to this function

get_current_metric_data(client, instance_id, input, options \\ [])

View Source

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

For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.

Link to this function

get_federation_token(client, instance_id, options \\ [])

View Source

Retrieves a token for federation.

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

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

Link to this function

get_metric_data(client, instance_id, input, options \\ [])

View Source

Gets historical metric data from the specified Amazon Connect instance.

For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

Link to this function

list_approved_origins(client, instance_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Returns a paginated list of all approved origins associated with the instance.

Link to this function

list_bots(client, instance_id, lex_version, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance.

Link to this function

list_contact_flows(client, instance_id, contact_flow_types \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

You can also create and update contact flows using the Amazon Connect Flow language.

For more information about contact flows, see Contact Flows in the Amazon Connect Administrator Guide.

Link to this function

list_hours_of_operations(client, instance_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.

Link to this function

list_instance_attributes(client, instance_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Returns a paginated list of all attribute types for the given instance.

Link to this function

list_instance_storage_configs(client, instance_id, max_results \\ nil, next_token \\ nil, resource_type, options \\ [])

View Source

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

Returns a paginated list of storage configs for the identified instance and resource type.

Link to this function

list_instances(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.

Link to this function

list_integration_associations(client, instance_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Provides summary information about the AppIntegration associations for the specified Amazon Connect instance.

Link to this function

list_lambda_functions(client, instance_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant contact flow blocks.

Link to this function

list_lex_bots(client, instance_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Returns a paginated list of all the Amazon Lex bots currently associated with the instance.

Link to this function

list_phone_numbers(client, instance_id, max_results \\ nil, next_token \\ nil, phone_number_country_codes \\ nil, phone_number_types \\ nil, options \\ [])

View Source

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

For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.

Link to this function

list_prompts(client, instance_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_queue_quick_connects(client, instance_id, queue_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Lists the quick connects associated with a queue.

Link to this function

list_queues(client, instance_id, max_results \\ nil, next_token \\ nil, queue_types \\ nil, options \\ [])

View Source

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

If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code.

For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.

Link to this function

list_quick_connects(client, instance_id, max_results \\ nil, next_token \\ nil, quick_connect_types \\ nil, options \\ [])

View Source

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

Link to this function

list_routing_profile_queues(client, instance_id, routing_profile_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the queues associated with a routing profile.

Link to this function

list_routing_profiles(client, instance_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.

Link to this function

list_security_keys(client, instance_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Returns a paginated list of all security keys associated with the instance.

Link to this function

list_security_profiles(client, instance_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists the tags for the specified resource.

For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

Link to this function

list_use_cases(client, instance_id, integration_association_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the use cases.

Link to this function

list_user_hierarchy_groups(client, instance_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.

Link to this function

list_users(client, instance_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

resume_contact_recording(client, input, options \\ [])

View Source

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

Only voice recordings are supported at this time.

Link to this function

start_chat_contact(client, input, options \\ [])

View Source

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.

When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.

A 429 error occurs in two situations:

  • API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception.

  • The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException.

For more information about chat, see Chat in the Amazon Connect Administrator Guide.

Link to this function

start_contact_recording(client, input, options \\ [])

View Source

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.

Only voice recordings are supported at this time.

Link to this function

start_outbound_voice_contact(client, input, options \\ [])

View Source

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 do not initiate the outbound API, which means that they do not dial the contact. If the contact flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.

There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.

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

Link to this function

start_task_contact(client, input, options \\ [])

View Source

Initiates a contact flow to start a new task.

Link to this function

stop_contact(client, input, options \\ [])

View Source

Ends the specified contact.

Link to this function

stop_contact_recording(client, input, options \\ [])

View Source

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.

Link to this function

suspend_contact_recording(client, input, options \\ [])

View Source

When a contact is being recorded, this API suspends recording the call.

For example, you might suspend the call recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording.

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

Only voice recordings are supported at this time.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Adds the specified tags to the specified resource.

The supported resource types are users, routing profiles, queues, quick connects, and contact flows.

For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes the specified tags from the specified resource.

Link to this function

update_contact_attributes(client, input, options \\ [])

View Source

Creates or updates user-defined contact attributes associated with the specified contact.

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

Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about CTR retention and the maximum size of the CTR attributes section, see Feature specifications in the Amazon Connect Administrator Guide.

Important: You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, which was September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance.

Link to this function

update_contact_flow_content(client, contact_flow_id, instance_id, input, options \\ [])

View Source

Updates the specified contact flow.

You can also create and update contact flows using the Amazon Connect Flow language.

Link to this function

update_contact_flow_name(client, contact_flow_id, instance_id, input, options \\ [])

View Source

The name of the contact flow.

You can also create and update contact flows using the Amazon Connect Flow language.

Link to this function

update_instance_attribute(client, attribute_type, instance_id, input, options \\ [])

View Source

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

Updates the value for the specified attribute type.

Link to this function

update_instance_storage_config(client, association_id, instance_id, input, options \\ [])

View Source

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

Updates an existing configuration for a resource type. This API is idempotent.

Link to this function

update_queue_hours_of_operation(client, instance_id, queue_id, input, options \\ [])

View Source

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

Updates the hours of operation for the specified queue.

Link to this function

update_queue_max_contacts(client, instance_id, queue_id, input, options \\ [])

View Source

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

Updates the maximum number of contacts allowed in a queue before it is considered full.

Link to this function

update_queue_name(client, instance_id, queue_id, input, options \\ [])

View Source

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

Updates the name and description of a queue. At least Name or Description must be provided.

Link to this function

update_queue_outbound_caller_config(client, instance_id, queue_id, input, options \\ [])

View Source

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

Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.

Link to this function

update_queue_status(client, instance_id, queue_id, input, options \\ [])

View Source

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

Updates the status of the queue.

Link to this function

update_quick_connect_config(client, instance_id, quick_connect_id, input, options \\ [])

View Source

Updates the configuration settings for the specified quick connect.

Link to this function

update_quick_connect_name(client, instance_id, quick_connect_id, input, options \\ [])

View Source

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.

Link to this function

update_routing_profile_concurrency(client, instance_id, routing_profile_id, input, options \\ [])

View Source

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

Link to this function

update_routing_profile_default_outbound_queue(client, instance_id, routing_profile_id, input, options \\ [])

View Source

Updates the default outbound queue of a routing profile.

Link to this function

update_routing_profile_name(client, instance_id, routing_profile_id, input, options \\ [])

View Source

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.

Link to this function

update_routing_profile_queues(client, instance_id, routing_profile_id, input, options \\ [])

View Source

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

Link to this function

update_user_hierarchy(client, instance_id, user_id, input, options \\ [])

View Source

Assigns the specified hierarchy group to the specified user.

Link to this function

update_user_hierarchy_group_name(client, hierarchy_group_id, instance_id, input, options \\ [])

View Source

Updates the name of the user hierarchy group.

Link to this function

update_user_hierarchy_structure(client, instance_id, input, options \\ [])

View Source

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

Link to this function

update_user_identity_info(client, instance_id, user_id, input, options \\ [])

View Source

Updates the identity information for the specified user.

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

Link to this function

update_user_phone_config(client, instance_id, user_id, input, options \\ [])

View Source

Updates the phone configuration settings for the specified user.

Link to this function

update_user_routing_profile(client, instance_id, user_id, input, options \\ [])

View Source

Assigns the specified routing profile to the specified user.

Link to this function

update_user_security_profiles(client, instance_id, user_id, input, options \\ [])

View Source

Assigns the specified security profiles to the specified user.