GSP
Quick Navigator
Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::Connect(3) User Contributed Perl Documentation Paws::Connect(3)

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' } ],
  );

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 (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the Amazon Connect Administrator Guide.

You can connect programmatically to an AWS service by using an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints (https://docs.aws.amazon.com/general/latest/gr/connect_region.html).

Working with contact flows? Check out the Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html).

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::AssociateApprovedOrigin

Returns: nothing

This API is in preview release for Amazon Connect and is subject to change.

Associates an approved origin to an Amazon Connect instance.

[LexBot => Paws::Connect::LexBot]
[LexV2Bot => Paws::Connect::LexV2Bot]

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

Returns: nothing

This API is in preview release for Amazon Connect and is subject to change.

Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.

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

Returns: a Paws::Connect::AssociateInstanceStorageConfigResponse instance

This API is in preview release for Amazon Connect and is subject to change.

Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts.

This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.

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

Returns: nothing

This API is in preview release for Amazon Connect and is subject to change.

Allows the specified Amazon Connect instance to access the specified Lambda function.

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

Returns: nothing

This API is in preview release for Amazon Connect and is subject to change.

Allows the specified Amazon Connect instance to access the specified Amazon Lex bot.

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

Returns: nothing

This API is in preview release for Amazon Connect and is subject to change.

Associates a set of quick connects with a queue.

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

Returns: nothing

Associates a set of queues with a routing profile.

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

Returns: a Paws::Connect::AssociateSecurityKeyResponse instance

This API is in preview release for Amazon Connect and is subject to change.

Associates a security key to the instance.

[Description => Str]
[Tags => Paws::Connect::TagMap]

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

Returns: a Paws::Connect::CreateContactFlowResponse instance

Creates a contact flow for the specified Amazon Connect instance.

You can also create and update contact flows using the Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html).

[ClientToken => Str]
[DirectoryId => Str]
[InstanceAlias => Str]

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

Returns: a Paws::Connect::CreateInstanceResponse instance

This API is in preview release for Amazon Connect and is subject to change.

Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.

Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.

[Tags => Paws::Connect::TagMap]

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

Returns: a Paws::Connect::CreateIntegrationAssociationResponse instance

Create an AppIntegration association with an Amazon Connect instance.

[Description => Str]
[MaxContacts => Int]
[OutboundCallerConfig => Paws::Connect::OutboundCallerConfig]
[QuickConnectIds => ArrayRef[Str|Undef]]
[Tags => Paws::Connect::TagMap]

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

Returns: a Paws::Connect::CreateQueueResponse instance

This API is in preview release for Amazon Connect and is subject to change.

Creates a new queue for the specified Amazon Connect instance.

[Description => Str]
[Tags => Paws::Connect::TagMap]

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

Returns: a Paws::Connect::CreateQuickConnectResponse instance

Creates a quick connect for the specified Amazon Connect instance.

[QueueConfigs => ArrayRef[Paws::Connect::RoutingProfileQueueConfig]]
[Tags => Paws::Connect::TagMap]

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

Returns: a Paws::Connect::CreateRoutingProfileResponse instance

Creates a new routing profile.

[Tags => Paws::Connect::TagMap]

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

Returns: a Paws::Connect::CreateUseCaseResponse instance

Creates a use case for an AppIntegration association.

[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.

For information about how to create user accounts using the Amazon Connect console, see Add Users (https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html) in the Amazon Connect Administrator Guide.

[ParentGroupId => Str]

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

Returns: a Paws::Connect::CreateUserHierarchyGroupResponse instance

Creates a new user hierarchy group.

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

Returns: nothing

This API is in preview release for Amazon Connect and is subject to change.

Deletes the Amazon Connect instance.

Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.

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

Returns: nothing

Deletes an AppIntegration association from an Amazon Connect instance. The association must not have any use cases associated with it.

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

Returns: nothing

Deletes a quick connect.

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

Returns: nothing

Deletes a use case from an AppIntegration association.

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

Returns: nothing

Deletes a user account from the specified Amazon Connect instance.

For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance (https://docs.aws.amazon.com/connect/latest/adminguide/delete-users.html) in the Amazon Connect Administrator Guide.

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

Returns: nothing

Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.

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

Returns: a Paws::Connect::DescribeContactFlowResponse instance

Describes the specified contact flow.

You can also create and update contact flows using the Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html).

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

Returns: a Paws::Connect::DescribeHoursOfOperationResponse instance

This API is in preview release for Amazon Connect and is subject to change.

Describes the hours of operation.

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

Returns: a Paws::Connect::DescribeInstanceResponse instance

This API is in preview release for Amazon Connect and is subject to change.

Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable.

If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.

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

Returns: a Paws::Connect::DescribeInstanceAttributeResponse instance

This API is in preview release for Amazon Connect and is subject to change.

Describes the specified instance attribute.

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

Returns: a Paws::Connect::DescribeInstanceStorageConfigResponse instance

This API is in preview release for Amazon Connect and is subject to change.

Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.

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

Returns: a Paws::Connect::DescribeQueueResponse instance

This API is in preview release for Amazon Connect and is subject to change.

Describes the specified queue.

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

Returns: a Paws::Connect::DescribeQuickConnectResponse instance

Describes the quick connect.

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

Returns: a Paws::Connect::DescribeRoutingProfileResponse instance

Describes the specified routing profile.

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.

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

Returns: a Paws::Connect::DescribeUserHierarchyGroupResponse instance

Describes the specified hierarchy group.

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.

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

Returns: nothing

This API is in preview release for Amazon Connect and is subject to change.

Revokes access to integrated applications from Amazon Connect.

[LexBot => Paws::Connect::LexBot]
[LexV2Bot => Paws::Connect::LexV2Bot]

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

Returns: nothing

This API is in preview release for Amazon Connect and is subject to change.

Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot.

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

Returns: nothing

This API is in preview release for Amazon Connect and is subject to change.

Removes the storage type configurations for the specified resource type and association ID.

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

Returns: nothing

This API is in preview release for Amazon Connect and is subject to change.

Remove the Lambda function from the dropdown options available in the relevant contact flow blocks.

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

Returns: nothing

This API is in preview release for Amazon Connect and is subject to change.

Revokes authorization from the specified instance to access the specified Amazon Lex bot.

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

Returns: nothing

This API is in preview release for Amazon Connect and is subject to change.

Disassociates a set of quick connects from a queue.

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

Returns: nothing

Disassociates a set of queues from a routing profile.

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

Returns: nothing

This API is in preview release for Amazon Connect and is subject to change.

Deletes the specified security key.

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

Returns: a Paws::Connect::GetContactAttributesResponse instance

Retrieves the contact attributes for the specified contact.

[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 a description of each metric, see Real-time Metrics Definitions (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html) in the Amazon Connect Administrator Guide.

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

Returns: a Paws::Connect::GetFederationTokenResponse instance

Retrieves a token for federation.

This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears:

"Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect"

[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 a description of each historical metric, see Historical Metrics Definitions (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html) in the Amazon Connect Administrator Guide.

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

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

Returns: a Paws::Connect::ListApprovedOriginsResponse instance

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all approved origins associated with the instance.

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

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

Returns: a Paws::Connect::ListBotsResponse instance

This API is in preview release for Amazon Connect and is subject to change.

For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance.

[ContactFlowTypes => ArrayRef[Str|Undef]]
[MaxResults => Int]
[NextToken => Str]

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.

You can also create and update contact flows using the Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html).

For more information about contact flows, see Contact Flows (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html) in the Amazon Connect Administrator Guide.

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

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.

For more information about hours of operation, see Set the Hours of Operation for a Queue (https://docs.aws.amazon.com/connect/latest/adminguide/set-hours-operation.html) in the Amazon Connect Administrator Guide.

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

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

Returns: a Paws::Connect::ListInstanceAttributesResponse instance

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all attribute types for the given instance.

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

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

Returns: a Paws::Connect::ListInstancesResponse instance

This API is in preview release for Amazon Connect and is subject to change.

Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.

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

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

Returns: a Paws::Connect::ListInstanceStorageConfigsResponse instance

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of storage configs for the identified instance and resource type.

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

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

Returns: a Paws::Connect::ListIntegrationAssociationsResponse instance

Provides summary information about the AppIntegration associations for the specified Amazon Connect instance.

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

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

Returns: a Paws::Connect::ListLambdaFunctionsResponse instance

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant contact flow blocks.

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

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

Returns: a Paws::Connect::ListLexBotsResponse instance

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all the Amazon Lex bots currently associated with the instance.

[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.

For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center (https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html) in the Amazon Connect Administrator Guide.

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

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

Returns: a Paws::Connect::ListPromptsResponse instance

Provides information about the prompts for the specified Amazon Connect instance.

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

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

Returns: a Paws::Connect::ListQueueQuickConnectsResponse instance

This API is in preview release for Amazon Connect and is subject to change.

Lists the quick connects associated with a queue.

[MaxResults => Int]
[NextToken => Str]
[QueueTypes => ArrayRef[Str|Undef]]

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.

If you do not specify a "QueueTypes" parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code.

For more information about queues, see Queues: Standard and Agent (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-queues-standard-and-agent.html) in the Amazon Connect Administrator Guide.

[MaxResults => Int]
[NextToken => Str]
[QuickConnectTypes => ArrayRef[Str|Undef]]

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

Returns: a Paws::Connect::ListQuickConnectsResponse instance

Provides information about the quick connects for the specified Amazon Connect instance.

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

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

Returns: a Paws::Connect::ListRoutingProfileQueuesResponse instance

Lists the queues associated with a routing profile.

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

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.

For more information about routing profiles, see Routing Profiles (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing.html) and Create a Routing Profile (https://docs.aws.amazon.com/connect/latest/adminguide/routing-profiles.html) in the Amazon Connect Administrator Guide.

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

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

Returns: a Paws::Connect::ListSecurityKeysResponse instance

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all security keys associated with the instance.

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

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.

For more information about security profiles, see Security Profiles (https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html) in the Amazon Connect Administrator Guide.

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

Returns: a Paws::Connect::ListTagsForResourceResponse instance

Lists the tags for the specified resource.

For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples (https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html) in the Amazon Connect Administrator Guide.

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

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

Returns: a Paws::Connect::ListUseCasesResponse instance

Lists the use cases.

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

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.

For more information about agent hierarchies, see Set Up Agent Hierarchies (https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html) in the Amazon Connect Administrator Guide.

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

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.

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

Returns: a Paws::Connect::ResumeContactRecordingResponse instance

When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call.

Only voice recordings are supported at this time.

[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 must 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.

A 429 error occurs in two situations:

  • API rate limit is exceeded. API TPS throttling returns a "TooManyRequests" exception.
  • The quota for concurrent active chats (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) is exceeded. Active chat throttling returns a "LimitExceededException".

For more information about chat, see Chat (https://docs.aws.amazon.com/connect/latest/adminguide/chat.html) in the Amazon Connect Administrator Guide.

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

Returns: a Paws::Connect::StartContactRecordingResponse instance

Starts recording the contact when the agent joins the call. StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.

You can use this API to override the recording behavior configured in the Set recording behavior (https://docs.aws.amazon.com/connect/latest/adminguide/set-recording-behavior.html) block.

Only voice recordings are supported at this time.

[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

Places an outbound call to a contact, and then initiates the contact flow. It performs the actions in the contact flow that's specified (in "ContactFlowId").

Agents do not initiate the outbound API, which means that they do not dial the contact. If the contact flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.

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

UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the Amazon Connect Administrator Guide.

[Attributes => Paws::Connect::Attributes]
[ClientToken => Str]
[Description => Str]
[PreviousContactId => Str]
[References => Paws::Connect::ContactReferences]

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

Returns: a Paws::Connect::StartTaskContactResponse instance

Initiates a contact flow to start a new task.

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

Returns: a Paws::Connect::StopContactResponse instance

Ends the specified contact.

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

Returns: a Paws::Connect::StopContactRecordingResponse instance

Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.

Only voice recordings are supported at this time.

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

Returns: a Paws::Connect::SuspendContactRecordingResponse instance

When a contact is being recorded, this API suspends recording the call. For example, you might suspend the call recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording.

The period of time that the recording is suspended is filled with silence in the final recording.

Only voice recordings are supported at this time.

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

Returns: nothing

Adds the specified tags to the specified resource.

The supported resource types are users, routing profiles, queues, quick connects, and contact flows.

For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples (https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html) in the Amazon Connect Administrator Guide.

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

Returns: nothing

Removes the specified tags from the specified resource.

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

Returns: a Paws::Connect::UpdateContactAttributesResponse instance

Creates or updates user-defined contact attributes associated with the specified contact.

You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display 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 to identify abusive callers.

Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about CTR retention and the maximum size of the CTR attributes section, see Feature specifications (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits) in the Amazon Connect Administrator Guide.

Important: You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, which was 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::UpdateContactFlowContent

Returns: nothing

Updates the specified contact flow.

You can also create and update contact flows using the Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html).

[Description => Str]
[Name => Str]

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

Returns: nothing

The name of the contact flow.

You can also create and update contact flows using the Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html).

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

Returns: nothing

This API is in preview release for Amazon Connect and is subject to change.

Updates the value for the specified attribute type.

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

Returns: nothing

This API is in preview release for Amazon Connect and is subject to change.

Updates an existing configuration for a resource type. This API is idempotent.

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

Returns: nothing

This API is in preview release for Amazon Connect and is subject to change.

Updates the hours of operation for the specified queue.

[MaxContacts => Int]

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

Returns: nothing

This API is in preview release for Amazon Connect and is subject to change.

Updates the maximum number of contacts allowed in a queue before it is considered full.

[Description => Str]
[Name => Str]

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

Returns: nothing

This API is in preview release for Amazon Connect and is subject to change.

Updates the name and description of a queue. At least "Name" or "Description" must be provided.

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

Returns: nothing

This API is in preview release for Amazon Connect and is subject to change.

Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.

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

Returns: nothing

This API is in preview release for Amazon Connect and is subject to change.

Updates the status of the queue.

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

Returns: nothing

Updates the configuration settings for the specified quick connect.

[Description => Str]
[Name => Str]

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

Returns: nothing

Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least "Name" or "Description" must be provided.

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

Returns: nothing

Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.

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

Returns: nothing

Updates the default outbound queue of a routing profile.

[Description => Str]
[Name => Str]

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

Returns: nothing

Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least "Name" or "Description" must be provided.

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

Returns: nothing

Updates the properties associated with a set of queues for a routing profile.

[HierarchyGroupId => Str]

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

Returns: nothing

Assigns the specified hierarchy group to the specified user.

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

Returns: nothing

Updates the name of the user hierarchy group.

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

Returns: nothing

Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.

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

Returns: nothing

Updates the identity information for the specified user.

We strongly recommend limiting who has the ability to invoke "UpdateUserIdentityInfo". Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see Best Practices for Security Profiles (https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-best-practices.html) in the Amazon Connect Administrator Guide.

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

Returns: nothing

Updates the phone configuration settings for the specified user.

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

Returns: nothing

Assigns the specified routing profile to the specified user.

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

Returns: nothing

Assigns the specified security profiles to the specified 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 "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - Origins, passing the object as the first parameter, and the string 'Origins' as the second parameter

If not, it will return a a Paws::Connect::ListApprovedOriginsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - LexBots, passing the object as the first parameter, and the string 'LexBots' as the second parameter

If not, it will return a a Paws::Connect::ListBotsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

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 "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

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 "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - Attributes, passing the object as the first parameter, and the string 'Attributes' as the second parameter

If not, it will return a a Paws::Connect::ListInstanceAttributesResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - InstanceSummaryList, passing the object as the first parameter, and the string 'InstanceSummaryList' as the second parameter

If not, it will return a a Paws::Connect::ListInstancesResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - StorageConfigs, passing the object as the first parameter, and the string 'StorageConfigs' as the second parameter

If not, it will return a a Paws::Connect::ListInstanceStorageConfigsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - IntegrationAssociationSummaryList, passing the object as the first parameter, and the string 'IntegrationAssociationSummaryList' as the second parameter

If not, it will return a a Paws::Connect::ListIntegrationAssociationsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - LambdaFunctions, passing the object as the first parameter, and the string 'LambdaFunctions' as the second parameter

If not, it will return a a Paws::Connect::ListLambdaFunctionsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - LexBots, passing the object as the first parameter, and the string 'LexBots' as the second parameter

If not, it will return a a Paws::Connect::ListLexBotsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

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 "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - PromptSummaryList, passing the object as the first parameter, and the string 'PromptSummaryList' as the second parameter

If not, it will return a a Paws::Connect::ListPromptsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - QuickConnectSummaryList, passing the object as the first parameter, and the string 'QuickConnectSummaryList' as the second parameter

If not, it will return a a Paws::Connect::ListQueueQuickConnectsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

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 "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - QuickConnectSummaryList, passing the object as the first parameter, and the string 'QuickConnectSummaryList' as the second parameter

If not, it will return a a Paws::Connect::ListQuickConnectsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - RoutingProfileQueueConfigSummaryList, passing the object as the first parameter, and the string 'RoutingProfileQueueConfigSummaryList' as the second parameter

If not, it will return a a Paws::Connect::ListRoutingProfileQueuesResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

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 "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - SecurityKeys, passing the object as the first parameter, and the string 'SecurityKeys' as the second parameter

If not, it will return a a Paws::Connect::ListSecurityKeysResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

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 "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - UseCaseSummaryList, passing the object as the first parameter, and the string 'UseCaseSummaryList' as the second parameter

If not, it will return a a Paws::Connect::ListUseCasesResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

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 "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

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 "param"s; 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>

2022-06-01 perl v5.40.2
Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.