NAME
Paws::Connect - Perl Interface to AWS Amazon Connect Service
SYNOPSIS
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' } ],
);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 Limits (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the Amazon Connect Administrator Guide.
For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08
METHODS
CreateUser
- InstanceId => Str
- PhoneConfig => Paws::Connect::UserPhoneConfig
- RoutingProfileId => Str
- SecurityProfileIds => ArrayRef[Str|Undef]
- Username => Str
- [DirectoryUserId => Str]
- [HierarchyGroupId => Str]
- [IdentityInfo => Paws::Connect::UserIdentityInfo]
- [Password => Str]
- [Tags => Paws::Connect::TagMap]
Each argument is described in detail in: Paws::Connect::CreateUser
Returns: a Paws::Connect::CreateUserResponse instance
Creates a user account for the specified Amazon Connect instance.
DeleteUser
Each argument is described in detail in: Paws::Connect::DeleteUser
Returns: nothing
Deletes a user account from the specified Amazon Connect instance.
DescribeUser
Each argument is described in detail in: Paws::Connect::DescribeUser
Returns: a Paws::Connect::DescribeUserResponse instance
Describes the specified user account. You can find the instance ID in the console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.
DescribeUserHierarchyGroup
Each argument is described in detail in: Paws::Connect::DescribeUserHierarchyGroup
Returns: a Paws::Connect::DescribeUserHierarchyGroupResponse instance
Describes the specified hierarchy group.
DescribeUserHierarchyStructure
Each argument is described in detail in: Paws::Connect::DescribeUserHierarchyStructure
Returns: a Paws::Connect::DescribeUserHierarchyStructureResponse instance
Describes the hierarchy structure of the specified Amazon Connect instance.
GetContactAttributes
Each argument is described in detail in: Paws::Connect::GetContactAttributes
Returns: a Paws::Connect::GetContactAttributesResponse instance
Retrieves the contact attributes for the specified contact.
GetCurrentMetricData
- CurrentMetrics => ArrayRef[Paws::Connect::CurrentMetric]
- Filters => Paws::Connect::Filters
- InstanceId => Str
- [Groupings => ArrayRef[Str|Undef]]
- [MaxResults => Int]
- [NextToken => Str]
Each argument is described in detail in: Paws::Connect::GetCurrentMetricData
Returns: a Paws::Connect::GetCurrentMetricDataResponse instance
Gets the real-time metric data from the specified Amazon Connect instance.
For more information, see Real-time Metrics Reports (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-reports.html) in the Amazon Connect Administrator Guide.
GetFederationToken
Each argument is described in detail in: Paws::Connect::GetFederationToken
Returns: a Paws::Connect::GetFederationTokenResponse instance
Retrieves a token for federation.
GetMetricData
- EndTime => Str
- Filters => Paws::Connect::Filters
- HistoricalMetrics => ArrayRef[Paws::Connect::HistoricalMetric]
- InstanceId => Str
- StartTime => Str
- [Groupings => ArrayRef[Str|Undef]]
- [MaxResults => Int]
- [NextToken => Str]
Each argument is described in detail in: Paws::Connect::GetMetricData
Returns: a Paws::Connect::GetMetricDataResponse instance
Gets historical metric data from the specified Amazon Connect instance.
For more information, see Historical Metrics Reports (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics.html) in the Amazon Connect Administrator Guide.
ListContactFlows
Each argument is described in detail in: Paws::Connect::ListContactFlows
Returns: a Paws::Connect::ListContactFlowsResponse instance
Provides information about the contact flows for the specified Amazon Connect instance.
ListHoursOfOperations
Each argument is described in detail in: Paws::Connect::ListHoursOfOperations
Returns: a Paws::Connect::ListHoursOfOperationsResponse instance
Provides information about the hours of operation for the specified Amazon Connect instance.
ListPhoneNumbers
- InstanceId => Str
- [MaxResults => Int]
- [NextToken => Str]
- [PhoneNumberCountryCodes => ArrayRef[Str|Undef]]
- [PhoneNumberTypes => ArrayRef[Str|Undef]]
Each argument is described in detail in: Paws::Connect::ListPhoneNumbers
Returns: a Paws::Connect::ListPhoneNumbersResponse instance
Provides information about the phone numbers for the specified Amazon Connect instance.
ListQueues
Each argument is described in detail in: Paws::Connect::ListQueues
Returns: a Paws::Connect::ListQueuesResponse instance
Provides information about the queues for the specified Amazon Connect instance.
ListRoutingProfiles
Each argument is described in detail in: Paws::Connect::ListRoutingProfiles
Returns: a Paws::Connect::ListRoutingProfilesResponse instance
Provides summary information about the routing profiles for the specified Amazon Connect instance.
ListSecurityProfiles
Each argument is described in detail in: Paws::Connect::ListSecurityProfiles
Returns: a Paws::Connect::ListSecurityProfilesResponse instance
Provides summary information about the security profiles for the specified Amazon Connect instance.
ListTagsForResource
Each argument is described in detail in: Paws::Connect::ListTagsForResource
Returns: a Paws::Connect::ListTagsForResourceResponse instance
Lists the tags for the specified resource.
ListUserHierarchyGroups
Each argument is described in detail in: Paws::Connect::ListUserHierarchyGroups
Returns: a Paws::Connect::ListUserHierarchyGroupsResponse instance
Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
ListUsers
Each argument is described in detail in: Paws::Connect::ListUsers
Returns: a Paws::Connect::ListUsersResponse instance
Provides summary information about the users for the specified Amazon Connect instance.
StartChatContact
- ContactFlowId => Str
- InstanceId => Str
- ParticipantDetails => Paws::Connect::ParticipantDetails
- [Attributes => Paws::Connect::Attributes]
- [ClientToken => Str]
- [InitialMessage => Paws::Connect::ChatMessage]
Each argument is described in detail in: Paws::Connect::StartChatContact
Returns: a Paws::Connect::StartChatContactResponse instance
Initiates a contact flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html) API in the Amazon Connect Participant Service.
When a new chat contact is successfully created, clients need to subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html) with WEBSOCKET and CONNECTION_CREDENTIALS.
StartOutboundVoiceContact
- ContactFlowId => Str
- DestinationPhoneNumber => Str
- InstanceId => Str
- [Attributes => Paws::Connect::Attributes]
- [ClientToken => Str]
- [QueueId => Str]
- [SourcePhoneNumber => Str]
Each argument is described in detail in: Paws::Connect::StartOutboundVoiceContact
Returns: a Paws::Connect::StartOutboundVoiceContactResponse instance
Initiates a contact flow to place an outbound call to a customer.
There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.
StopContact
Each argument is described in detail in: Paws::Connect::StopContact
Returns: a Paws::Connect::StopContactResponse instance
Ends the specified contact.
TagResource
- ResourceArn => Str
- Tags => Paws::Connect::TagMap
Each argument is described in detail in: Paws::Connect::TagResource
Returns: nothing
Adds the specified tags to the specified resource.
The supported resource type is users.
UntagResource
Each argument is described in detail in: Paws::Connect::UntagResource
Returns: nothing
Removes the specified tags from the specified resource.
UpdateContactAttributes
- Attributes => Paws::Connect::Attributes
- InitialContactId => Str
- InstanceId => Str
Each argument is described in detail in: Paws::Connect::UpdateContactAttributes
Returns: a Paws::Connect::UpdateContactAttributesResponse instance
Creates or updates the contact attributes associated with the specified contact.
You can 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 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.
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.
UpdateUserHierarchy
Each argument is described in detail in: Paws::Connect::UpdateUserHierarchy
Returns: nothing
Assigns the specified hierarchy group to the specified user.
UpdateUserIdentityInfo
- IdentityInfo => Paws::Connect::UserIdentityInfo
- InstanceId => Str
- UserId => Str
Each argument is described in detail in: Paws::Connect::UpdateUserIdentityInfo
Returns: nothing
Updates the identity information for the specified user.
UpdateUserPhoneConfig
- InstanceId => Str
- PhoneConfig => Paws::Connect::UserPhoneConfig
- UserId => Str
Each argument is described in detail in: Paws::Connect::UpdateUserPhoneConfig
Returns: nothing
Updates the phone configuration settings for the specified user.
UpdateUserRoutingProfile
Each argument is described in detail in: Paws::Connect::UpdateUserRoutingProfile
Returns: nothing
Assigns the specified routing profile to the specified user.
UpdateUserSecurityProfiles
Each argument is described in detail in: Paws::Connect::UpdateUserSecurityProfiles
Returns: nothing
Assigns the specified security profiles to the specified user.
PAGINATORS
Paginator methods are helpers that repetively call methods that return partial results
GetAllMetricData(sub { },EndTime => Str, Filters => Paws::Connect::Filters, HistoricalMetrics => ArrayRef[Paws::Connect::HistoricalMetric], InstanceId => Str, StartTime => Str, [Groupings => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str])
GetAllMetricData(EndTime => Str, Filters => Paws::Connect::Filters, HistoricalMetrics => ArrayRef[Paws::Connect::HistoricalMetric], InstanceId => Str, StartTime => Str, [Groupings => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str])
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.
ListAllContactFlows(sub { },InstanceId => Str, [ContactFlowTypes => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str])
ListAllContactFlows(InstanceId => Str, [ContactFlowTypes => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- ContactFlowSummaryList, passing the object as the first parameter, and the string 'ContactFlowSummaryList' as the second parameter If not, it will return a a Paws::Connect::ListContactFlowsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllHoursOfOperations(sub { },InstanceId => Str, [MaxResults => Int, NextToken => Str])
ListAllHoursOfOperations(InstanceId => Str, [MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- HoursOfOperationSummaryList, passing the object as the first parameter, and the string 'HoursOfOperationSummaryList' as the second parameter If not, it will return a a Paws::Connect::ListHoursOfOperationsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllPhoneNumbers(sub { },InstanceId => Str, [MaxResults => Int, NextToken => Str, PhoneNumberCountryCodes => ArrayRef[Str|Undef], PhoneNumberTypes => ArrayRef[Str|Undef]])
ListAllPhoneNumbers(InstanceId => Str, [MaxResults => Int, NextToken => Str, PhoneNumberCountryCodes => ArrayRef[Str|Undef], PhoneNumberTypes => ArrayRef[Str|Undef]])
If passed a sub as first parameter, it will call the sub for each element found in :
- PhoneNumberSummaryList, passing the object as the first parameter, and the string 'PhoneNumberSummaryList' as the second parameter If not, it will return a a Paws::Connect::ListPhoneNumbersResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllQueues(sub { },InstanceId => Str, [MaxResults => Int, NextToken => Str, QueueTypes => ArrayRef[Str|Undef]])
ListAllQueues(InstanceId => Str, [MaxResults => Int, NextToken => Str, QueueTypes => ArrayRef[Str|Undef]])
If passed a sub as first parameter, it will call the sub for each element found in :
- QueueSummaryList, passing the object as the first parameter, and the string 'QueueSummaryList' as the second parameter If not, it will return a a Paws::Connect::ListQueuesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllRoutingProfiles(sub { },InstanceId => Str, [MaxResults => Int, NextToken => Str])
ListAllRoutingProfiles(InstanceId => Str, [MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- 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.
ListAllSecurityProfiles(sub { },InstanceId => Str, [MaxResults => Int, NextToken => Str])
ListAllSecurityProfiles(InstanceId => Str, [MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- 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.
ListAllUserHierarchyGroups(sub { },InstanceId => Str, [MaxResults => Int, NextToken => Str])
ListAllUserHierarchyGroups(InstanceId => Str, [MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- 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.
ListAllUsers(sub { },InstanceId => Str, [MaxResults => Int, NextToken => Str])
ListAllUsers(InstanceId => Str, [MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- 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.
SEE ALSO
This service class forms part of Paws
BUGS and CONTRIBUTIONS
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