connect: Amazon Connect Service

Description

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.

There are limits to the number of Amazon Connect resources that you can create and 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.

To connect programmatically to an AWS service, you use an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.

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

Usage

connect(config = list())

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Arguments

config: Optional configuration of credentials, endpoint, and/or region.

Service syntax

svc <- connect(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

associate_approved_origin	This API is in preview release for Amazon Connect and is subject to change
associate_instance_storage_config	This API is in preview release for Amazon Connect and is subject to change
associate_lambda_function	This API is in preview release for Amazon Connect and is subject to change
associate_lex_bot	This API is in preview release for Amazon Connect and is subject to change
associate_routing_profile_queues	Associates a set of queues with a routing profile
associate_security_key	This API is in preview release for Amazon Connect and is subject to change
create_contact_flow	Creates a contact flow for the specified Amazon Connect instance
create_instance	This API is in preview release for Amazon Connect and is subject to change
create_integration_association	This API is in preview release for Amazon Connect and is subject to change
create_quick_connect	This API is in preview release for Amazon Connect and is subject to change
create_routing_profile	Creates a new routing profile
create_use_case	This API is in preview release for Amazon Connect and is subject to change
create_user	Creates a user account for the specified Amazon Connect instance
create_user_hierarchy_group	Creates a new user hierarchy group
delete_instance	This API is in preview release for Amazon Connect and is subject to change
delete_integration_association	This API is in preview release for Amazon Connect and is subject to change
delete_quick_connect	This API is in preview release for Amazon Connect and is subject to change
delete_use_case	This API is in preview release for Amazon Connect and is subject to change
delete_user	Deletes a user account from the specified Amazon Connect instance
delete_user_hierarchy_group	Deletes an existing user hierarchy group
describe_contact_flow	Describes the specified contact flow
describe_instance	This API is in preview release for Amazon Connect and is subject to change
describe_instance_attribute	This API is in preview release for Amazon Connect and is subject to change
describe_instance_storage_config	This API is in preview release for Amazon Connect and is subject to change
describe_quick_connect	This API is in preview release for Amazon Connect and is subject to change
describe_routing_profile	Describes the specified routing profile
describe_user	Describes the specified user account
describe_user_hierarchy_group	Describes the specified hierarchy group
describe_user_hierarchy_structure	Describes the hierarchy structure of the specified Amazon Connect instance
disassociate_approved_origin	This API is in preview release for Amazon Connect and is subject to change
disassociate_instance_storage_config	This API is in preview release for Amazon Connect and is subject to change
disassociate_lambda_function	This API is in preview release for Amazon Connect and is subject to change
disassociate_lex_bot	This API is in preview release for Amazon Connect and is subject to change
disassociate_routing_profile_queues	Disassociates a set of queues from a routing profile
disassociate_security_key	This API is in preview release for Amazon Connect and is subject to change
get_contact_attributes	Retrieves the contact attributes for the specified contact
get_current_metric_data	Gets the real-time metric data from the specified Amazon Connect instance
get_federation_token	Retrieves a token for federation
get_metric_data	Gets historical metric data from the specified Amazon Connect instance
list_approved_origins	This API is in preview release for Amazon Connect and is subject to change
list_contact_flows	Provides information about the contact flows for the specified Amazon Connect instance
list_hours_of_operations	Provides information about the hours of operation for the specified Amazon Connect instance
list_instance_attributes	This API is in preview release for Amazon Connect and is subject to change
list_instances	This API is in preview release for Amazon Connect and is subject to change
list_instance_storage_configs	This API is in preview release for Amazon Connect and is subject to change
list_integration_associations	This API is in preview release for Amazon Connect and is subject to change
list_lambda_functions	This API is in preview release for Amazon Connect and is subject to change
list_lex_bots	This API is in preview release for Amazon Connect and is subject to change
list_phone_numbers	Provides information about the phone numbers for the specified Amazon Connect instance
list_prompts	Provides information about the prompts for the specified Amazon Connect instance
list_queues	Provides information about the queues for the specified Amazon Connect instance
list_quick_connects	This API is in preview release for Amazon Connect and is subject to change
list_routing_profile_queues	List the queues associated with a routing profile
list_routing_profiles	Provides summary information about the routing profiles for the specified Amazon Connect instance
list_security_keys	This API is in preview release for Amazon Connect and is subject to change
list_security_profiles	Provides summary information about the security profiles for the specified Amazon Connect instance
list_tags_for_resource	Lists the tags for the specified resource
list_use_cases	This API is in preview release for Amazon Connect and is subject to change
list_user_hierarchy_groups	Provides summary information about the hierarchy groups for the specified Amazon Connect instance
list_users	Provides summary information about the users for the specified Amazon Connect instance
resume_contact_recording	When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call
start_chat_contact	Initiates a contact flow to start a new chat for the customer
start_contact_recording	This API starts recording the contact when the agent joins the call
start_outbound_voice_contact	This API places an outbound call to a contact, and then initiates the contact flow
start_task_contact	Initiates a contact flow to start a new task
stop_contact	Ends the specified contact
stop_contact_recording	When a contact is being recorded, this API stops recording the call
suspend_contact_recording	When a contact is being recorded, this API suspends recording the call
tag_resource	Adds the specified tags to the specified resource
untag_resource	Removes the specified tags from the specified resource
update_contact_attributes	Creates or updates the contact attributes associated with the specified contact
update_contact_flow_content	Updates the specified contact flow
update_contact_flow_name	The name of the contact flow
update_instance_attribute	This API is in preview release for Amazon Connect and is subject to change
update_instance_storage_config	This API is in preview release for Amazon Connect and is subject to change
update_quick_connect_config	This API is in preview release for Amazon Connect and is subject to change
update_quick_connect_name	This API is in preview release for Amazon Connect and is subject to change
update_routing_profile_concurrency	Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile
update_routing_profile_default_outbound_queue	Updates the default outbound queue of a routing profile
update_routing_profile_name	Updates the name and description of a routing profile
update_routing_profile_queues	Updates the properties associated with a set of queues for a routing profile
update_user_hierarchy	Assigns the specified hierarchy group to the specified user
update_user_hierarchy_group_name	Updates the name of the user hierarchy group
update_user_hierarchy_structure	Updates the user hierarchy structure: add, remove, and rename user hierarchy levels
update_user_identity_info	Updates the identity information for the specified user
update_user_phone_config	Updates the phone configuration settings for the specified user
update_user_routing_profile	Assigns the specified routing profile to the specified user
update_user_security_profiles	Assigns the specified security profiles to the specified user

Examples

Run this code

if (FALSE) {
svc <- connect()
svc$associate_approved_origin(
  Foo = 123
)
}

Run the code above in your browser using DataLab