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

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 (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

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]

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.

DeleteUser

InstanceId => Str
UserId => Str

Each argument is described in detail in: Paws::Connect::DeleteUser

Returns: nothing

Deletes a user account from Amazon Connect.

DescribeUser

InstanceId => Str
UserId => Str

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.

DescribeUserHierarchyGroup

HierarchyGroupId => Str
InstanceId => Str

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.

DescribeUserHierarchyStructure

InstanceId => Str

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.

GetContactAttributes

InitialContactId => Str
InstanceId => Str

Each argument is described in detail in: Paws::Connect::GetContactAttributes

Returns: a Paws::Connect::GetContactAttributesResponse instance

Retrieves the contact attributes associated with a 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

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.

GetFederationToken

InstanceId => Str

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

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.

ListRoutingProfiles

InstanceId => Str
[MaxResults => Int]
[NextToken => Str]

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.

ListSecurityProfiles

InstanceId => Str
[MaxResults => Int]
[NextToken => Str]

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.

ListUserHierarchyGroups

InstanceId => Str
[MaxResults => Int]
[NextToken => Str]

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.

ListUsers

InstanceId => Str
[MaxResults => Int]
[NextToken => Str]

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.

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

The StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a customer.

If you are using an IAM account, it must have permission to the connect:StartOutboundVoiceContact action.

There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, the call fails.

StopContact

ContactId => Str
InstanceId => Str

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.

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

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.

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

InstanceId => Str
UserId => Str
[HierarchyGroupId => Str]

Each argument is described in detail in: Paws::Connect::UpdateUserHierarchy

Returns: nothing

Assigns the specified hierarchy group to the 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 in a UserIdentityInfo object, including email, first name, and last name.

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 in the UserPhoneConfig object for the specified user.

UpdateUserRoutingProfile

InstanceId => Str
RoutingProfileId => Str
UserId => Str

Each argument is described in detail in: Paws::Connect::UpdateUserRoutingProfile

Returns: nothing

Assigns the specified routing profile to a user.

UpdateUserSecurityProfiles

InstanceId => Str
SecurityProfileIds => ArrayRef[Str|Undef]
UserId => Str

Each argument is described in detail in: Paws::Connect::UpdateUserSecurityProfiles

Returns: nothing

Updates the security profiles assigned to the 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.

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