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 Amazon Web Services 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.
connect(config = list())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.
Optional configuration of credentials, endpoint, and/or region.
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e., http://s3.amazonaws.com/BUCKET/KEY.
svc <- connect(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical"
)
)
| associate_approved_origin | This API is in preview release for Amazon Connect and is subject to change |
| associate_bot | This API is in preview release for Amazon Connect and is subject to change |
| associate_default_vocabulary | Associates an existing vocabulary as the default |
| 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_phone_number_contact_flow | Associates a contact flow with a phone number claimed to your Amazon Connect instance |
| associate_queue_quick_connects | 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 |
| claim_phone_number | Claims an available phone number to your Amazon Connect instance |
| create_agent_status | 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_contact_flow_module | Creates a contact flow module for the specified Amazon Connect instance |
| create_hours_of_operation | This API is in preview release for Amazon Connect and is subject to change |
| create_instance | This API is in preview release for Amazon Connect and is subject to change |
| create_integration_association | Creates an Amazon Web Services resource association with an Amazon Connect instance |
| create_queue | This API is in preview release for Amazon Connect and is subject to change |
| create_quick_connect | Creates a quick connect for the specified Amazon Connect instance |
| create_routing_profile | Creates a new routing profile |
| create_security_profile | This API is in preview release for Amazon Connect and is subject to change |
| create_task_template | Creates a new task template in the specified Amazon Connect instance |
| create_use_case | Creates a use case for an integration association |
| create_user | Creates a user account for the specified Amazon Connect instance |
| create_user_hierarchy_group | Creates a new user hierarchy group |
| create_vocabulary | Creates a custom vocabulary associated with your Amazon Connect instance |
| delete_contact_flow | Deletes a contact flow for the specified Amazon Connect instance |
| delete_contact_flow_module | Deletes the specified contact flow module |
| delete_hours_of_operation | This API is in preview release for Amazon Connect and is subject to change |
| delete_instance | This API is in preview release for Amazon Connect and is subject to change |
| delete_integration_association | Deletes an Amazon Web Services resource association from an Amazon Connect instance |
| delete_quick_connect | Deletes a quick connect |
| delete_security_profile | This API is in preview release for Amazon Connect and is subject to change |
| delete_task_template | Deletes the task template |
| delete_use_case | Deletes a use case from an integration association |
| delete_user | Deletes a user account from the specified Amazon Connect instance |
| delete_user_hierarchy_group | Deletes an existing user hierarchy group |
| delete_vocabulary | Deletes the vocabulary that has the given identifier |
| describe_agent_status | This API is in preview release for Amazon Connect and is subject to change |
| describe_contact | This API is in preview release for Amazon Connect and is subject to change |
| describe_contact_flow | Describes the specified contact flow |
| describe_contact_flow_module | Describes the specified contact flow module |
| describe_hours_of_operation | This API is in preview release for Amazon Connect and is subject to change |
| 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_phone_number | Gets details and status of a phone number that’s claimed to your Amazon Connect instance |
| describe_queue | This API is in preview release for Amazon Connect and is subject to change |
| describe_quick_connect | Describes the quick connect |
| describe_routing_profile | Describes the specified routing profile |
| describe_security_profile | This API is in preview release for Amazon Connect and is subject to change |
| 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 |
| describe_vocabulary | Describes the specified vocabulary |
| disassociate_approved_origin | This API is in preview release for Amazon Connect and is subject to change |
| disassociate_bot | 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_phone_number_contact_flow | Removes the contact flow association from a phone number claimed to your Amazon Connect instance, if a contact flow association exists |
| disassociate_queue_quick_connects | 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_current_user_data | Gets the real-time active user 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 |
| get_task_template | Gets details about a specific task template in the specified Amazon Connect instance |
| list_agent_statuses | This API is in preview release for Amazon Connect and is subject to change |
| list_approved_origins | This API is in preview release for Amazon Connect and is subject to change |
| list_bots | This API is in preview release for Amazon Connect and is subject to change |
| list_contact_flow_modules | Provides information about the contact flow modules for the specified Amazon Connect instance |
| list_contact_flows | Provides information about the contact flows for the specified Amazon Connect instance |
| list_contact_references | This API is in preview release for Amazon Connect and is subject to change |
| list_default_vocabularies | Lists the default vocabularies 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 | Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance |
| 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_phone_numbers_v2 | Lists phone numbers claimed to your Amazon Connect instance |
| list_prompts | Provides information about the prompts for the specified Amazon Connect instance |
| list_queue_quick_connects | This API is in preview release for Amazon Connect and is subject to change |
| list_queues | Provides information about the queues for the specified Amazon Connect instance |
| list_quick_connects | Provides information about the quick connects for the specified Amazon Connect instance |
| list_routing_profile_queues | Lists 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_profile_permissions | 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_task_templates | Lists task templates for the specified Amazon Connect instance |
| list_use_cases | Lists the use cases for the integration association |
| 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 |
| put_user_status | Changes the current status of a user or agent in Amazon Connect |
| release_phone_number | Releases a phone number previously claimed to an 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 |
| search_available_phone_numbers | Searches for available phone numbers that you can claim to your Amazon Connect instance |
| search_users | Searches users in an Amazon Connect instance, with optional filtering |
| search_vocabularies | Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode |
| start_chat_contact | Initiates a contact flow to start a new chat for the customer |
| start_contact_recording | Starts recording the contact: |
| start_contact_streaming | Initiates real-time message streaming for a new chat contact |
| start_outbound_voice_contact | 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 | Stops recording a call when a contact is being recorded |
| stop_contact_streaming | Ends message streaming on a specified contact |
| 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 |
| transfer_contact | Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created |
| untag_resource | Removes the specified tags from the specified resource |
| update_agent_status | This API is in preview release for Amazon Connect and is subject to change |
| update_contact | This API is in preview release for Amazon Connect and is subject to change |
| update_contact_attributes | Creates or updates user-defined contact attributes associated with the specified contact |
| update_contact_flow_content | Updates the specified contact flow |
| update_contact_flow_metadata | Updates metadata about specified contact flow |
| update_contact_flow_module_content | Updates specified contact flow module for the specified Amazon Connect instance |
| update_contact_flow_module_metadata | Updates metadata about specified contact flow module |
| update_contact_flow_name | The name of the contact flow |
| update_contact_schedule | Updates the scheduled time of a task contact that is already scheduled |
| update_hours_of_operation | This API is in preview release for Amazon Connect and is subject to change |
| 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_phone_number | Updates your claimed phone number from its current Amazon Connect instance to another Amazon Connect instance in the same Region |
| update_queue_hours_of_operation | This API is in preview release for Amazon Connect and is subject to change |
| update_queue_max_contacts | This API is in preview release for Amazon Connect and is subject to change |
| update_queue_name | This API is in preview release for Amazon Connect and is subject to change |
| update_queue_outbound_caller_config | This API is in preview release for Amazon Connect and is subject to change |
| update_queue_status | This API is in preview release for Amazon Connect and is subject to change |
| update_quick_connect_config | Updates the configuration settings for the specified quick connect |
| update_quick_connect_name | Updates the name and description of a quick connect |
| 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_security_profile | This API is in preview release for Amazon Connect and is subject to change |
| update_task_template | Updates details about a specific task template in the specified Amazon Connect instance |
| 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 |
if (FALSE) {
svc <- connect()
svc$associate_approved_origin(
Foo = 123
)
}
Run the code above in your browser using DataLab