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.
connect(config = list(), credentials = list(), endpoint = NULL, region = NULL)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.
credentials:
creds:
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.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
Optional credentials shorthand for the config parameter
creds:
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.
Optional shorthand for complete URL to use for the constructed client.
Optional shorthand for AWS Region used in instantiating the client.
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",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
| activate_evaluation_form | Activates an evaluation form in the specified Amazon Connect instance |
| associate_analytics_data_set | This API is in preview release for Amazon Connect and is subject to change |
| 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_flow | Associates a connect resource to a flow |
| 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 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 |
| associate_traffic_distribution_group_user | Associates an agent with a traffic distribution group |
| associate_user_proficiencies | >Associates a set of proficiencies with a user |
| batch_associate_analytics_data_set | This API is in preview release for Amazon Connect and is subject to change |
| batch_disassociate_analytics_data_set | This API is in preview release for Amazon Connect and is subject to change |
| batch_get_flow_association | Retrieve the flow associations for the given resources |
| batch_put_contact | Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API |
| claim_phone_number | Claims an available phone number to your Amazon Connect instance or traffic distribution group |
| create_agent_status | This API is in preview release for Amazon Connect and is subject to change |
| create_contact_flow | Creates a flow for the specified Amazon Connect instance |
| create_contact_flow_module | Creates a flow module for the specified Amazon Connect instance |
| create_evaluation_form | Creates an evaluation form in 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_participant | Adds a new participant into an on-going chat contact |
| create_persistent_contact_association | Enables rehydration of chats for the lifespan of a contact |
| create_predefined_attribute | Creates a new predefined attribute for the specified Amazon Connect instance |
| create_prompt | Creates a prompt |
| 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_rule | Creates a rule for the specified Amazon Connect instance |
| create_security_profile | Creates a security profile |
| create_task_template | Creates a new task template in the specified Amazon Connect instance |
| create_traffic_distribution_group | Creates a traffic distribution group given an Amazon Connect instance that has been replicated |
| 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_view | Creates a new view with the possible status of SAVED or PUBLISHED |
| create_view_version | Publishes a new version of the view identifier |
| create_vocabulary | Creates a custom vocabulary associated with your Amazon Connect instance |
| deactivate_evaluation_form | Deactivates an evaluation form in the specified Amazon Connect instance |
| delete_contact_evaluation | Deletes a contact evaluation in the specified Amazon Connect instance |
| delete_contact_flow | Deletes a flow for the specified Amazon Connect instance |
| delete_contact_flow_module | Deletes the specified flow module |
| delete_evaluation_form | Deletes an evaluation form in the specified Amazon Connect instance |
| 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_predefined_attribute | Deletes a predefined attribute from the specified Amazon Connect instance |
| delete_prompt | Deletes a prompt |
| delete_queue | Deletes a queue |
| delete_quick_connect | Deletes a quick connect |
| delete_routing_profile | Deletes a routing profile |
| delete_rule | Deletes a rule for the specified Amazon Connect instance |
| delete_security_profile | Deletes a security profile |
| delete_task_template | Deletes the task template |
| delete_traffic_distribution_group | Deletes a traffic distribution group |
| 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_view | Deletes the view entirely |
| delete_view_version | Deletes the particular version specified in ViewVersion identifier |
| 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_evaluation | Describes a contact evaluation in the specified Amazon Connect instance |
| describe_contact_flow | Describes the specified flow |
| describe_contact_flow_module | Describes the specified flow module |
| describe_evaluation_form | Describes an evaluation form in the specified Amazon Connect instance |
| 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 or traffic distribution group |
| describe_predefined_attribute | Describes a predefined attribute for the specified Amazon Connect instance |
| describe_prompt | Describes the prompt |
| 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_rule | Describes a rule for the specified Amazon Connect instance |
| describe_security_profile | Gets basic information about the security profle |
| describe_traffic_distribution_group | Gets details and status of a traffic distribution group |
| describe_user | Describes the specified user |
| describe_user_hierarchy_group | Describes the specified hierarchy group |
| describe_user_hierarchy_structure | Describes the hierarchy structure of the specified Amazon Connect instance |
| describe_view | Retrieves the view for the specified Amazon Connect instance and view identifier |
| describe_vocabulary | Describes the specified vocabulary |
| disassociate_analytics_data_set | This API is in preview release for Amazon Connect and is subject to change |
| 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_flow | Disassociates a connect resource from a flow |
| 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 flow association from a phone number claimed to your Amazon Connect instance |
| 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 |
| disassociate_traffic_distribution_group_user | Disassociates an agent from a traffic distribution group |
| disassociate_user_proficiencies | Disassociates a set of proficiencies from a user |
| dismiss_user_contact | 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 |
| 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 | Supports SAML sign-in for Amazon Connect |
| get_flow_association | Retrieves the flow associated for a given resource |
| get_metric_data | Gets historical metric data from the specified Amazon Connect instance |
| get_metric_data_v2 | Gets metric data from the specified Amazon Connect instance |
| get_prompt_file | Gets the prompt file |
| get_task_template | Gets details about a specific task template in the specified Amazon Connect instance |
| get_traffic_distribution | Retrieves the current traffic distribution for a given traffic distribution group |
| import_phone_number | Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance |
| list_agent_statuses | This API is in preview release for Amazon Connect and is subject to change |
| list_analytics_data_associations | 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_evaluations | Lists contact evaluations in the specified Amazon Connect instance |
| list_contact_flow_modules | Provides information about the flow modules for the specified Amazon Connect instance |
| list_contact_flows | Provides information about the 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_evaluation_forms | Lists evaluation forms in the specified Amazon Connect instance |
| list_evaluation_form_versions | Lists versions of an evaluation form in the specified Amazon Connect instance |
| list_flow_associations | List the flow association based on the filters |
| 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 or traffic distribution group |
| list_predefined_attributes | Lists predefined attributes for the specified 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_realtime_contact_analysis_segments_v2 | Provides a list of analysis segments for a real-time analysis session |
| 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_rules | List all rules 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_applications | Returns a list of third-party applications in a specific security profile |
| list_security_profile_permissions | Lists the permissions granted to a security profile |
| 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_traffic_distribution_groups | Lists traffic distribution groups |
| list_traffic_distribution_group_users | Lists traffic distribution group users |
| 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_user_proficiencies | Lists proficiencies associated with a user |
| list_users | Provides summary information about the users for the specified Amazon Connect instance |
| list_views | Returns views in the given instance |
| list_view_versions | Returns all the available versions for the specified Amazon Connect instance and view identifier |
| monitor_contact | Initiates silent monitoring of a contact |
| pause_contact | Allows pausing an ongoing task contact |
| 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 or traffic distribution group |
| replicate_instance | Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions |
| resume_contact | Allows resuming a task contact in a paused state |
| resume_contact_recording | 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 |
| search_available_phone_numbers | Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group |
| search_contacts | Searches contacts in an Amazon Connect instance |
| search_hours_of_operations | Searches the hours of operation in an Amazon Connect instance, with optional filtering |
| search_predefined_attributes | Predefined attributes that meet certain criteria |
| search_prompts | Searches prompts in an Amazon Connect instance, with optional filtering |
| search_queues | Searches queues in an Amazon Connect instance, with optional filtering |
| search_quick_connects | Searches quick connects in an Amazon Connect instance, with optional filtering |
| search_resource_tags | Searches tags used in an Amazon Connect instance using optional search criteria |
| search_routing_profiles | Searches routing profiles in an Amazon Connect instance, with optional filtering |
| search_security_profiles | Searches security profiles in an Amazon Connect instance, with optional filtering |
| 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 |
| send_chat_integration_event | Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect |
| start_chat_contact | Initiates a flow to start a new chat for the customer |
| start_contact_evaluation | Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact |
| 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 flow |
| start_task_contact | Initiates a flow to start a new task contact |
| start_web_rtc_contact | Places an inbound in-app, web, or video call to a contact, and then initiates the flow |
| 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 |
| submit_contact_evaluation | Submits a contact evaluation in the specified Amazon Connect instance |
| suspend_contact_recording | When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both |
| tag_contact | Adds the specified tags to the contact resource |
| 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_contact | Removes the specified tags from the contact resource |
| 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_evaluation | Updates details about a contact evaluation in the specified Amazon Connect instance |
| update_contact_flow_content | Updates the specified flow |
| update_contact_flow_metadata | Updates metadata about specified flow |
| update_contact_flow_module_content | Updates specified flow module for the specified Amazon Connect instance |
| update_contact_flow_module_metadata | Updates metadata about specified flow module |
| update_contact_flow_name | The name of the flow |
| update_contact_routing_data | This API is in preview release for Amazon Connect and is subject to change |
| update_contact_schedule | Updates the scheduled time of a task contact that is already scheduled |
| update_evaluation_form | Updates details about a specific evaluation form version in the specified Amazon Connect instance |
| 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_participant_role_config | Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness |
| update_phone_number | Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region |
| update_phone_number_metadata | Updates a phone number’s metadata |
| update_predefined_attribute | Updates a predefined attribute for the specified Amazon Connect instance |
| update_prompt | Updates a prompt |
| 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_agent_availability_timer | Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time |
| 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_rule | Updates a rule for the specified Amazon Connect instance |
| update_security_profile | Updates a security profile |
| update_task_template | Updates details about a specific task template in the specified Amazon Connect instance |
| update_traffic_distribution | Updates the traffic distribution for a given traffic distribution group |
| 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_proficiencies | Updates the properties associated with the proficiencies of a 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 |
| update_view_content | Updates the view content of the given view identifier in the specified Amazon Connect instance |
| update_view_metadata | Updates the view metadata |
if (FALSE) {
svc <- connect()
svc$activate_evaluation_form(
Foo = 123
)
}
Run the code above in your browser using DataLab