paws.customer.engagement (version 0.1.3)

connect: Amazon Connect Service

Description

The Amazon Connect API Reference provides descriptions, syntax, and usage examples for each of the Amazon Connect actions, data types, parameters, and errors. 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.

Throttling limits for the Amazon Connect API operations:

For the GetMetricData and GetCurrentMetricData operations, a RateLimit of 5 per second, and a BurstLimit of 8 per second.

For all other operations, a RateLimit of 2 per second, and a BurstLimit of 5 per second.

You can request an increase to the throttling limits by submitting a Amazon Connect service limits increase form. You must be signed in to your AWS account to access the form.

Usage

connect()

Operations

create_user	Creates a new user account in your Amazon Connect instance
delete_user	Deletes a user account from Amazon Connect
describe_user	Returns a User object that contains information about the user account specified by the UserId
describe_user_hierarchy_group	Returns a HierarchyGroup object that includes information about a hierarchy group in your instance
describe_user_hierarchy_structure	Returns a HiearchyGroupStructure object, which contains data about the levels in the agent hierarchy
get_contact_attributes	Retrieves the contact attributes associated with a contact
get_current_metric_data	The GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance
get_federation_token	Retrieves a token for federation
get_metric_data	The GetMetricData operation retrieves historical metrics data from your Amazon Connect instance
list_routing_profiles	Returns an array of RoutingProfileSummary objects that includes information about the routing profiles in your instance
list_security_profiles	Returns an array of SecurityProfileSummary objects that contain information about the security profiles in your instance, including the ARN, Id, and Name of the security profile
list_user_hierarchy_groups	Returns a UserHierarchyGroupSummaryList, which is an array of HierarchyGroupSummary objects that contain information about the hierarchy groups in your instance
list_users	Returns a UserSummaryList, which is an array of UserSummary objects
start_outbound_voice_contact	The StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a customer
stop_contact	Ends the contact initiated by the StartOutboundVoiceContact operation
update_contact_attributes	The UpdateContactAttributes operation lets you programmatically create new, or update existing, contact attributes associated with a contact
update_user_hierarchy	Assigns the specified hierarchy group to the user
update_user_identity_info	Updates the identity information for the specified user in a UserIdentityInfo object, including email, first name, and last name
update_user_phone_config	Updates the phone configuration settings in the UserPhoneConfig object for the specified user
update_user_routing_profile	Assigns the specified routing profile to a user

Examples

# NOT RUN {
svc <- connect()
svc$create_user(
  Foo = 123
)
# }
# NOT RUN {
# }