Paws::Connect - Perl Interface to AWS Amazon Connect Service
use Paws; my $obj = Paws->service('Connect'); my $res = $obj->Method( Arg1 => $val1, Arg2 => [ 'V1', 'V2' ], # if Arg3 is an object, the HashRef will be used as arguments to the constructor # of the arguments type Arg3 => { Att1 => 'Val1' }, # if Arg4 is an array of objects, the HashRefs will be passed as arguments to # the constructor of the arguments type Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], );
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.
GetMetricData
GetCurrentMetricData
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 (https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase). You must be signed in to your AWS account to access the form.
For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08
Each argument is described in detail in: Paws::Connect::CreateUser
Returns: a Paws::Connect::CreateUserResponse instance
Creates a new user account in your Amazon Connect instance.
Each argument is described in detail in: Paws::Connect::DeleteUser
Returns: nothing
Deletes a user account from Amazon Connect.
Each argument is described in detail in: Paws::Connect::DescribeUser
Returns: a Paws::Connect::DescribeUserResponse instance
Returns a User object that contains information about the user account specified by the UserId.
User
UserId
Each argument is described in detail in: Paws::Connect::DescribeUserHierarchyGroup
Returns: a Paws::Connect::DescribeUserHierarchyGroupResponse instance
Returns a HierarchyGroup object that includes information about a hierarchy group in your instance.
HierarchyGroup
Each argument is described in detail in: Paws::Connect::DescribeUserHierarchyStructure
Returns: a Paws::Connect::DescribeUserHierarchyStructureResponse instance
Returns a HiearchyGroupStructure object, which contains data about the levels in the agent hierarchy.
HiearchyGroupStructure
Each argument is described in detail in: Paws::Connect::GetContactAttributes
Returns: a Paws::Connect::GetContactAttributesResponse instance
Retrieves the contact attributes associated with a contact.
Each argument is described in detail in: Paws::Connect::GetCurrentMetricData
Returns: a Paws::Connect::GetCurrentMetricDataResponse instance
The GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance.
If you are using an IAM account, it must have permission to the connect:GetCurrentMetricData action.
connect:GetCurrentMetricData
Each argument is described in detail in: Paws::Connect::GetFederationToken
Returns: a Paws::Connect::GetFederationTokenResponse instance
Retrieves a token for federation.
Each argument is described in detail in: Paws::Connect::GetMetricData
Returns: a Paws::Connect::GetMetricDataResponse instance
The GetMetricData operation retrieves historical metrics data from your Amazon Connect instance.
If you are using an IAM account, it must have permission to the connect:GetMetricData action.
connect:GetMetricData
Each argument is described in detail in: Paws::Connect::ListRoutingProfiles
Returns: a Paws::Connect::ListRoutingProfilesResponse instance
Returns an array of RoutingProfileSummary objects that includes information about the routing profiles in your instance.
RoutingProfileSummary
Each argument is described in detail in: Paws::Connect::ListSecurityProfiles
Returns: a Paws::Connect::ListSecurityProfilesResponse instance
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.
Each argument is described in detail in: Paws::Connect::ListUserHierarchyGroups
Returns: a Paws::Connect::ListUserHierarchyGroupsResponse instance
Returns a UserHierarchyGroupSummaryList, which is an array of HierarchyGroupSummary objects that contain information about the hierarchy groups in your instance.
UserHierarchyGroupSummaryList
HierarchyGroupSummary
Each argument is described in detail in: Paws::Connect::ListUsers
Returns: a Paws::Connect::ListUsersResponse instance
Returns a UserSummaryList, which is an array of UserSummary objects.
UserSummaryList
UserSummary
Each argument is described in detail in: Paws::Connect::StartOutboundVoiceContact
Returns: a Paws::Connect::StartOutboundVoiceContactResponse instance
The StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a customer.
StartOutboundVoiceContact
If you are using an IAM account, it must have permission to the connect:StartOutboundVoiceContact action.
connect:StartOutboundVoiceContact
There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, the call fails.
Each argument is described in detail in: Paws::Connect::StopContact
Returns: a Paws::Connect::StopContactResponse instance
Ends the contact initiated by the StartOutboundVoiceContact operation.
If you are using an IAM account, it must have permission to the connect:StopContact action.
connect:StopContact
Each argument is described in detail in: Paws::Connect::UpdateContactAttributes
Returns: a Paws::Connect::UpdateContactAttributesResponse instance
The UpdateContactAttributes operation lets you programmatically create new, or update existing, contact attributes associated with a contact. You can use the operation to add or update attributes for both ongoing and completed contacts. For example, you can update the customer's name or the reason the customer called while the call is active, or add notes about steps that the agent took during the call that are displayed to the next agent that takes the call. You can also use the UpdateContactAttributes operation to 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 identifying abusive callers.
UpdateContactAttributes
Contact attributes are available in Amazon Connect for 24 months, and are then deleted.
Important:
You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, 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.
Each argument is described in detail in: Paws::Connect::UpdateUserHierarchy
Assigns the specified hierarchy group to the user.
Each argument is described in detail in: Paws::Connect::UpdateUserIdentityInfo
Updates the identity information for the specified user in a UserIdentityInfo object, including email, first name, and last name.
UserIdentityInfo
Each argument is described in detail in: Paws::Connect::UpdateUserPhoneConfig
Updates the phone configuration settings in the UserPhoneConfig object for the specified user.
UserPhoneConfig
Each argument is described in detail in: Paws::Connect::UpdateUserRoutingProfile
Assigns the specified routing profile to a user.
Each argument is described in detail in: Paws::Connect::UpdateUserSecurityProfiles
Updates the security profiles assigned to the user.
Paginator methods are helpers that repetively call methods that return partial results
If passed a sub as first parameter, it will call the sub for each element found in :
- MetricResults, passing the object as the first parameter, and the string 'MetricResults' as the second parameter
If not, it will return a a Paws::Connect::GetMetricDataResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
param
- RoutingProfileSummaryList, passing the object as the first parameter, and the string 'RoutingProfileSummaryList' as the second parameter
If not, it will return a a Paws::Connect::ListRoutingProfilesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
- SecurityProfileSummaryList, passing the object as the first parameter, and the string 'SecurityProfileSummaryList' as the second parameter
If not, it will return a a Paws::Connect::ListSecurityProfilesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
- UserHierarchyGroupSummaryList, passing the object as the first parameter, and the string 'UserHierarchyGroupSummaryList' as the second parameter
If not, it will return a a Paws::Connect::ListUserHierarchyGroupsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
- UserSummaryList, passing the object as the first parameter, and the string 'UserSummaryList' as the second parameter
If not, it will return a a Paws::Connect::ListUsersResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
This service class forms part of Paws
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
To install Paws::SDK::Config, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws::SDK::Config
CPAN shell
perl -MCPAN -e shell install Paws::SDK::Config
For more information on module installation, please visit the detailed CPAN module installation guide.