AWS SDK for PHP 3.x

Service ID: connect

Version: 2017-08-08

This page describes the parameters and results for the operations of the Amazon Connect Service (2017-08-08), and shows how to use the Aws\Connect\ConnectClient object to call the described operations. This documentation is specific to the 2017-08-08 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AssociateApprovedOrigin ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
AssociateBot ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
AssociateDefaultVocabulary ( array $params = [] )
Associates an existing vocabulary as the default.
AssociateInstanceStorageConfig ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
AssociateLambdaFunction ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
AssociateLexBot ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
AssociatePhoneNumberContactFlow ( array $params = [] )
Associates a flow with a phone number claimed to your Amazon Connect instance.
AssociateQueueQuickConnects ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
AssociateRoutingProfileQueues ( array $params = [] )
Associates a set of queues with a routing profile.
AssociateSecurityKey ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
ClaimPhoneNumber ( array $params = [] )
Claims an available phone number to your Amazon Connect instance or traffic distribution group.
CreateAgentStatus ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
CreateContactFlow ( array $params = [] )
Creates a flow for the specified Amazon Connect instance.
CreateContactFlowModule ( array $params = [] )
Creates a flow module for the specified Amazon Connect instance.
CreateHoursOfOperation ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
CreateInstance ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
CreateIntegrationAssociation ( array $params = [] )
Creates an Amazon Web Services resource association with an Amazon Connect instance.
CreateQueue ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
CreateQuickConnect ( array $params = [] )
Creates a quick connect for the specified Amazon Connect instance.
CreateRoutingProfile ( array $params = [] )
Creates a new routing profile.
CreateRule ( array $params = [] )
Creates a rule for the specified Amazon Connect instance.
CreateSecurityProfile ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
CreateTaskTemplate ( array $params = [] )
Creates a new task template in the specified Amazon Connect instance.
CreateTrafficDistributionGroup ( array $params = [] )
Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
CreateUseCase ( array $params = [] )
Creates a use case for an integration association.
CreateUser ( array $params = [] )
Creates a user account for the specified Amazon Connect instance.
CreateUserHierarchyGroup ( array $params = [] )
Creates a new user hierarchy group.
CreateVocabulary ( array $params = [] )
Creates a custom vocabulary associated with your Amazon Connect instance.
DeleteContactFlow ( array $params = [] )
Deletes a flow for the specified Amazon Connect instance.
DeleteContactFlowModule ( array $params = [] )
Deletes the specified flow module.
DeleteHoursOfOperation ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
DeleteInstance ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
DeleteIntegrationAssociation ( array $params = [] )
Deletes an Amazon Web Services resource association from an Amazon Connect instance.
DeleteQuickConnect ( array $params = [] )
Deletes a quick connect.
DeleteRule ( array $params = [] )
Deletes a rule for the specified Amazon Connect instance.
DeleteSecurityProfile ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
DeleteTaskTemplate ( array $params = [] )
Deletes the task template.
DeleteTrafficDistributionGroup ( array $params = [] )
Deletes a traffic distribution group.
DeleteUseCase ( array $params = [] )
Deletes a use case from an integration association.
DeleteUser ( array $params = [] )
Deletes a user account from the specified Amazon Connect instance.
DeleteUserHierarchyGroup ( array $params = [] )
Deletes an existing user hierarchy group.
DeleteVocabulary ( array $params = [] )
Deletes the vocabulary that has the given identifier.
DescribeAgentStatus ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
DescribeContact ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
DescribeContactFlow ( array $params = [] )
Describes the specified flow.
DescribeContactFlowModule ( array $params = [] )
Describes the specified flow module.
DescribeHoursOfOperation ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
DescribeInstance ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
DescribeInstanceAttribute ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
DescribeInstanceStorageConfig ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
DescribePhoneNumber ( array $params = [] )
Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.
DescribeQueue ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
DescribeQuickConnect ( array $params = [] )
Describes the quick connect.
DescribeRoutingProfile ( array $params = [] )
Describes the specified routing profile.
DescribeRule ( array $params = [] )
Describes a rule for the specified Amazon Connect instance.
DescribeSecurityProfile ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
DescribeTrafficDistributionGroup ( array $params = [] )
Gets details and status of a traffic distribution group.
DescribeUser ( array $params = [] )
Describes the specified user account.
DescribeUserHierarchyGroup ( array $params = [] )
Describes the specified hierarchy group.
DescribeUserHierarchyStructure ( array $params = [] )
Describes the hierarchy structure of the specified Amazon Connect instance.
DescribeVocabulary ( array $params = [] )
Describes the specified vocabulary.
DisassociateApprovedOrigin ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
DisassociateBot ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
DisassociateInstanceStorageConfig ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
DisassociateLambdaFunction ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
DisassociateLexBot ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
DisassociatePhoneNumberContactFlow ( array $params = [] )
Removes the flow association from a phone number claimed to your Amazon Connect instance.
DisassociateQueueQuickConnects ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
DisassociateRoutingProfileQueues ( array $params = [] )
Disassociates a set of queues from a routing profile.
DisassociateSecurityKey ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
DismissUserContact ( array $params = [] )
Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact.
GetContactAttributes ( array $params = [] )
Retrieves the contact attributes for the specified contact.
GetCurrentMetricData ( array $params = [] )
Gets the real-time metric data from the specified Amazon Connect instance.
GetCurrentUserData ( array $params = [] )
Gets the real-time active user data from the specified Amazon Connect instance.
GetFederationToken ( array $params = [] )
Retrieves a token for federation.
GetMetricData ( array $params = [] )
Gets historical metric data from the specified Amazon Connect instance.
GetMetricDataV2 ( array $params = [] )
Gets metric data from the specified Amazon Connect instance.
GetTaskTemplate ( array $params = [] )
Gets details about a specific task template in the specified Amazon Connect instance.
GetTrafficDistribution ( array $params = [] )
Retrieves the current traffic distribution for a given traffic distribution group.
ListAgentStatuses ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
ListApprovedOrigins ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
ListBots ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
ListContactFlowModules ( array $params = [] )
Provides information about the flow modules for the specified Amazon Connect instance.
ListContactFlows ( array $params = [] )
Provides information about the flows for the specified Amazon Connect instance.
ListContactReferences ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
ListDefaultVocabularies ( array $params = [] )
Lists the default vocabularies for the specified Amazon Connect instance.
ListHoursOfOperations ( array $params = [] )
Provides information about the hours of operation for the specified Amazon Connect instance.
ListInstanceAttributes ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
ListInstanceStorageConfigs ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
ListInstances ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
ListIntegrationAssociations ( array $params = [] )
Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
ListLambdaFunctions ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
ListLexBots ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
ListPhoneNumbers ( array $params = [] )
Provides information about the phone numbers for the specified Amazon Connect instance.
ListPhoneNumbersV2 ( array $params = [] )
Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group.
ListPrompts ( array $params = [] )
Provides information about the prompts for the specified Amazon Connect instance.
ListQueueQuickConnects ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
ListQueues ( array $params = [] )
Provides information about the queues for the specified Amazon Connect instance.
ListQuickConnects ( array $params = [] )
Provides information about the quick connects for the specified Amazon Connect instance.
ListRoutingProfileQueues ( array $params = [] )
Lists the queues associated with a routing profile.
ListRoutingProfiles ( array $params = [] )
Provides summary information about the routing profiles for the specified Amazon Connect instance.
ListRules ( array $params = [] )
List all rules for the specified Amazon Connect instance.
ListSecurityKeys ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
ListSecurityProfilePermissions ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
ListSecurityProfiles ( array $params = [] )
Provides summary information about the security profiles for the specified Amazon Connect instance.
ListTagsForResource ( array $params = [] )
Lists the tags for the specified resource.
ListTaskTemplates ( array $params = [] )
Lists task templates for the specified Amazon Connect instance.
ListTrafficDistributionGroups ( array $params = [] )
Lists traffic distribution groups.
ListUseCases ( array $params = [] )
Lists the use cases for the integration association.
ListUserHierarchyGroups ( array $params = [] )
Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
ListUsers ( array $params = [] )
Provides summary information about the users for the specified Amazon Connect instance.
MonitorContact ( array $params = [] )
Initiates silent monitoring of a contact.
PutUserStatus ( array $params = [] )
Changes the current status of a user or agent in Amazon Connect.
ReleasePhoneNumber ( array $params = [] )
Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group.
ReplicateInstance ( array $params = [] )
Replicates an Amazon Connect instance in the specified Amazon Web Services Region.
ResumeContactRecording ( array $params = [] )
When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call.
SearchAvailablePhoneNumbers ( array $params = [] )
Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.
SearchQueues ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
SearchRoutingProfiles ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
SearchSecurityProfiles ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
SearchUsers ( array $params = [] )
Searches users in an Amazon Connect instance, with optional filtering.
SearchVocabularies ( array $params = [] )
Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.
StartChatContact ( array $params = [] )
Initiates a flow to start a new chat for the customer.
StartContactRecording ( array $params = [] )
Starts recording the contact: If the API is called before the agent joins the call, recording starts when the agent joins the call.
StartContactStreaming ( array $params = [] )
Initiates real-time message streaming for a new chat contact.
StartOutboundVoiceContact ( array $params = [] )
Places an outbound call to a contact, and then initiates the flow.
StartTaskContact ( array $params = [] )
Initiates a flow to start a new task.
StopContact ( array $params = [] )
Ends the specified contact.
StopContactRecording ( array $params = [] )
Stops recording a call when a contact is being recorded.
StopContactStreaming ( array $params = [] )
Ends message streaming on a specified contact.
SuspendContactRecording ( array $params = [] )
When a contact is being recorded, this API suspends recording the call.
TagResource ( array $params = [] )
Adds the specified tags to the specified resource.
TransferContact ( array $params = [] )
Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created.
UntagResource ( array $params = [] )
Removes the specified tags from the specified resource.
UpdateAgentStatus ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
UpdateContact ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
UpdateContactAttributes ( array $params = [] )
Creates or updates user-defined contact attributes associated with the specified contact.
UpdateContactFlowContent ( array $params = [] )
Updates the specified flow.
UpdateContactFlowMetadata ( array $params = [] )
Updates metadata about specified flow.
UpdateContactFlowModuleContent ( array $params = [] )
Updates specified flow module for the specified Amazon Connect instance.
UpdateContactFlowModuleMetadata ( array $params = [] )
Updates metadata about specified flow module.
UpdateContactFlowName ( array $params = [] )
The name of the flow.
UpdateContactSchedule ( array $params = [] )
Updates the scheduled time of a task contact that is already scheduled.
UpdateHoursOfOperation ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
UpdateInstanceAttribute ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
UpdateInstanceStorageConfig ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
UpdateParticipantRoleConfig ( array $params = [] )
Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness.
UpdatePhoneNumber ( array $params = [] )
Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.
UpdateQueueHoursOfOperation ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
UpdateQueueMaxContacts ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
UpdateQueueName ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
UpdateQueueOutboundCallerConfig ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
UpdateQueueStatus ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
UpdateQuickConnectConfig ( array $params = [] )
Updates the configuration settings for the specified quick connect.
UpdateQuickConnectName ( array $params = [] )
Updates the name and description of a quick connect.
UpdateRoutingProfileConcurrency ( array $params = [] )
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
UpdateRoutingProfileDefaultOutboundQueue ( array $params = [] )
Updates the default outbound queue of a routing profile.
UpdateRoutingProfileName ( array $params = [] )
Updates the name and description of a routing profile.
UpdateRoutingProfileQueues ( array $params = [] )
Updates the properties associated with a set of queues for a routing profile.
UpdateRule ( array $params = [] )
Updates a rule for the specified Amazon Connect instance.
UpdateSecurityProfile ( array $params = [] )
This API is in preview release for Amazon Connect and is subject to change.
UpdateTaskTemplate ( array $params = [] )
Updates details about a specific task template in the specified Amazon Connect instance.
UpdateTrafficDistribution ( array $params = [] )
Updates the traffic distribution for a given traffic distribution group.
UpdateUserHierarchy ( array $params = [] )
Assigns the specified hierarchy group to the specified user.
UpdateUserHierarchyGroupName ( array $params = [] )
Updates the name of the user hierarchy group.
UpdateUserHierarchyStructure ( array $params = [] )
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
UpdateUserIdentityInfo ( array $params = [] )
Updates the identity information for the specified user.
UpdateUserPhoneConfig ( array $params = [] )
Updates the phone configuration settings for the specified user.
UpdateUserRoutingProfile ( array $params = [] )
Assigns the specified routing profile to the specified user.
UpdateUserSecurityProfiles ( array $params = [] )
Assigns the specified security profiles to the specified user.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

GetCurrentMetricData
GetCurrentUserData
GetMetricData
GetMetricDataV2
ListAgentStatuses
ListApprovedOrigins
ListBots
ListContactFlowModules
ListContactFlows
ListContactReferences
ListDefaultVocabularies
ListHoursOfOperations
ListInstanceAttributes
ListInstanceStorageConfigs
ListInstances
ListIntegrationAssociations
ListLambdaFunctions
ListLexBots
ListPhoneNumbers
ListPhoneNumbersV2
ListPrompts
ListQueueQuickConnects
ListQueues
ListQuickConnects
ListRoutingProfileQueues
ListRoutingProfiles
ListRules
ListSecurityKeys
ListSecurityProfilePermissions
ListSecurityProfiles
ListTaskTemplates
ListTrafficDistributionGroups
ListUseCases
ListUserHierarchyGroups
ListUsers
SearchAvailablePhoneNumbers
SearchQueues
SearchRoutingProfiles
SearchSecurityProfiles
SearchUsers
SearchVocabularies

Operations

AssociateApprovedOrigin

$result = $client->associateApprovedOrigin([/* ... */]);
$promise = $client->associateApprovedOriginAsync([/* ... */]);

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

Associates an approved origin to an Amazon Connect instance.

Parameter Syntax

$result = $client->associateApprovedOrigin([
    'InstanceId' => '<string>', // REQUIRED
    'Origin' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Origin

Required: Yes
Type: string

The domain to add to your allow list.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The specified resource was not found.
ResourceConflictException:
A resource already has that name.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ServiceQuotaExceededException:
The service quota has been exceeded.
ThrottlingException:
The throttling limit has been exceeded.

AssociateBot

$result = $client->associateBot([/* ... */]);
$promise = $client->associateBotAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->associateBot([
    'InstanceId' => '<string>', // REQUIRED
    'LexBot' => [
        'LexRegion' => '<string>', // REQUIRED
        'Name' => '<string>', // REQUIRED
    ],
    'LexV2Bot' => [
        'AliasArn' => '<string>',
    ],
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

LexBot

Type: LexBot structure

Configuration information of an Amazon Lex bot.

LexV2Bot

Type: LexV2Bot structure

The Amazon Lex V2 bot to associate with the instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The specified resource was not found.
ResourceConflictException:
A resource already has that name.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.
LimitExceededException:
The allowed limit for the resource has been exceeded.
ServiceQuotaExceededException:
The service quota has been exceeded.
ThrottlingException:
The throttling limit has been exceeded.

AssociateDefaultVocabulary

$result = $client->associateDefaultVocabulary([/* ... */]);
$promise = $client->associateDefaultVocabularyAsync([/* ... */]);

Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.

Parameter Syntax

$result = $client->associateDefaultVocabulary([
    'InstanceId' => '<string>', // REQUIRED
    'LanguageCode' => 'ar-AE|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fr-CA|fr-FR|hi-IN|it-IT|ja-JP|ko-KR|pt-BR|pt-PT|zh-CN|en-NZ|en-ZA', // REQUIRED
    'VocabularyId' => '<string>',
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

LanguageCode

Required: Yes
Type: string

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

VocabularyId

Type: string

The identifier of the custom vocabulary. If this is empty, the default is set to none.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
ThrottlingException:
The throttling limit has been exceeded.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

AssociateInstanceStorageConfig

$result = $client->associateInstanceStorageConfig([/* ... */]);
$promise = $client->associateInstanceStorageConfigAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->associateInstanceStorageConfig([
    'InstanceId' => '<string>', // REQUIRED
    'ResourceType' => 'CHAT_TRANSCRIPTS|CALL_RECORDINGS|SCHEDULED_REPORTS|MEDIA_STREAMS|CONTACT_TRACE_RECORDS|AGENT_EVENTS|REAL_TIME_CONTACT_ANALYSIS_SEGMENTS|ATTACHMENTS|CONTACT_EVALUATIONS', // REQUIRED
    'StorageConfig' => [ // REQUIRED
        'AssociationId' => '<string>',
        'KinesisFirehoseConfig' => [
            'FirehoseArn' => '<string>', // REQUIRED
        ],
        'KinesisStreamConfig' => [
            'StreamArn' => '<string>', // REQUIRED
        ],
        'KinesisVideoStreamConfig' => [
            'EncryptionConfig' => [ // REQUIRED
                'EncryptionType' => 'KMS', // REQUIRED
                'KeyId' => '<string>', // REQUIRED
            ],
            'Prefix' => '<string>', // REQUIRED
            'RetentionPeriodHours' => <integer>, // REQUIRED
        ],
        'S3Config' => [
            'BucketName' => '<string>', // REQUIRED
            'BucketPrefix' => '<string>', // REQUIRED
            'EncryptionConfig' => [
                'EncryptionType' => 'KMS', // REQUIRED
                'KeyId' => '<string>', // REQUIRED
            ],
        ],
        'StorageType' => 'S3|KINESIS_VIDEO_STREAM|KINESIS_STREAM|KINESIS_FIREHOSE', // REQUIRED
    ],
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

ResourceType

Required: Yes
Type: string

A valid resource type.

StorageConfig

Required: Yes
Type: InstanceStorageConfig structure

A valid storage type.

Result Syntax

[
    'AssociationId' => '<string>',
]

Result Details

Members

AssociationId

Type: string

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

Errors

ResourceNotFoundException:
The specified resource was not found.
ResourceConflictException:
A resource already has that name.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ThrottlingException:
The throttling limit has been exceeded.

AssociateLambdaFunction

$result = $client->associateLambdaFunction([/* ... */]);
$promise = $client->associateLambdaFunctionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->associateLambdaFunction([
    'FunctionArn' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

FunctionArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is 140.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The specified resource was not found.
ResourceConflictException:
A resource already has that name.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ServiceQuotaExceededException:
The service quota has been exceeded.
ThrottlingException:
The throttling limit has been exceeded.

AssociateLexBot

$result = $client->associateLexBot([/* ... */]);
$promise = $client->associateLexBotAsync([/* ... */]);

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 V1 bot. This API only supports the association of Amazon Lex V1 bots.

Parameter Syntax

$result = $client->associateLexBot([
    'InstanceId' => '<string>', // REQUIRED
    'LexBot' => [ // REQUIRED
        'LexRegion' => '<string>', // REQUIRED
        'Name' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

LexBot

Required: Yes
Type: LexBot structure

The Amazon Lex bot to associate with the instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The specified resource was not found.
ResourceConflictException:
A resource already has that name.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ServiceQuotaExceededException:
The service quota has been exceeded.
ThrottlingException:
The throttling limit has been exceeded.

AssociatePhoneNumberContactFlow

$result = $client->associatePhoneNumberContactFlow([/* ... */]);
$promise = $client->associatePhoneNumberContactFlowAsync([/* ... */]);

Associates a flow with a phone number claimed to your Amazon Connect instance.

If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

Parameter Syntax

$result = $client->associatePhoneNumberContactFlow([
    'ContactFlowId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'PhoneNumberId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ContactFlowId

Required: Yes
Type: string

The identifier of the flow.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

PhoneNumberId

Required: Yes
Type: string

A unique identifier for the phone number.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

AssociateQueueQuickConnects

$result = $client->associateQueueQuickConnects([/* ... */]);
$promise = $client->associateQueueQuickConnectsAsync([/* ... */]);

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

Associates a set of quick connects with a queue.

Parameter Syntax

$result = $client->associateQueueQuickConnects([
    'InstanceId' => '<string>', // REQUIRED
    'QueueId' => '<string>', // REQUIRED
    'QuickConnectIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

QueueId

Required: Yes
Type: string

The identifier for the queue.

QuickConnectIds

Required: Yes
Type: Array of strings

The quick connects to associate with this queue.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
LimitExceededException:
The allowed limit for the resource has been exceeded.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

AssociateRoutingProfileQueues

$result = $client->associateRoutingProfileQueues([/* ... */]);
$promise = $client->associateRoutingProfileQueuesAsync([/* ... */]);

Associates a set of queues with a routing profile.

Parameter Syntax

$result = $client->associateRoutingProfileQueues([
    'InstanceId' => '<string>', // REQUIRED
    'QueueConfigs' => [ // REQUIRED
        [
            'Delay' => <integer>, // REQUIRED
            'Priority' => <integer>, // REQUIRED
            'QueueReference' => [ // REQUIRED
                'Channel' => 'VOICE|CHAT|TASK', // REQUIRED
                'QueueId' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'RoutingProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

QueueConfigs

Required: Yes
Type: Array of RoutingProfileQueueConfig structures

The queues to associate with this routing profile.

RoutingProfileId

Required: Yes
Type: string

The identifier of the routing profile.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

AssociateSecurityKey

$result = $client->associateSecurityKey([/* ... */]);
$promise = $client->associateSecurityKeyAsync([/* ... */]);

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

Associates a security key to the instance.

Parameter Syntax

$result = $client->associateSecurityKey([
    'InstanceId' => '<string>', // REQUIRED
    'Key' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Key

Required: Yes
Type: string

A valid security key in PEM format.

Result Syntax

[
    'AssociationId' => '<string>',
]

Result Details

Members

AssociationId

Type: string

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

Errors

ResourceNotFoundException:
The specified resource was not found.
ResourceConflictException:
A resource already has that name.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ServiceQuotaExceededException:
The service quota has been exceeded.
ThrottlingException:
The throttling limit has been exceeded.

ClaimPhoneNumber

$result = $client->claimPhoneNumber([/* ... */]);
$promise = $client->claimPhoneNumberAsync([/* ... */]);

Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.

For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.

You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.

Parameter Syntax

$result = $client->claimPhoneNumber([
    'ClientToken' => '<string>',
    'PhoneNumber' => '<string>', // REQUIRED
    'PhoneNumberDescription' => '<string>',
    'Tags' => ['<string>', ...],
    'TargetArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ClientToken

Type: string

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

PhoneNumber

Required: Yes
Type: string

The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code].

PhoneNumberDescription

Type: string

The description of the phone number.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

TargetArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

Result Syntax

[
    'PhoneNumberArn' => '<string>',
    'PhoneNumberId' => '<string>',
]

Result Details

Members

PhoneNumberArn

Type: string

The Amazon Resource Name (ARN) of the phone number.

PhoneNumberId

Type: string

A unique identifier for the phone number.

Errors

InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.
IdempotencyException:
An entity with the same name already exists.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

CreateAgentStatus

$result = $client->createAgentStatus([/* ... */]);
$promise = $client->createAgentStatusAsync([/* ... */]);

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

Creates an agent status for the specified Amazon Connect instance.

Parameter Syntax

$result = $client->createAgentStatus([
    'Description' => '<string>',
    'DisplayOrder' => <integer>,
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'State' => 'ENABLED|DISABLED', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

Description

Type: string

The description of the status.

DisplayOrder

Type: int

The display order of the status.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Name

Required: Yes
Type: string

The name of the status.

State

Required: Yes
Type: string

The state of the status.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Result Syntax

[
    'AgentStatusARN' => '<string>',
    'AgentStatusId' => '<string>',
]

Result Details

Members

AgentStatusARN

Type: string

The Amazon Resource Name (ARN) of the agent status.

AgentStatusId

Type: string

The identifier of the agent status.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
DuplicateResourceException:
A resource with the specified name already exists.
ResourceNotFoundException:
The specified resource was not found.
LimitExceededException:
The allowed limit for the resource has been exceeded.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

CreateContactFlow

$result = $client->createContactFlow([/* ... */]);
$promise = $client->createContactFlowAsync([/* ... */]);

Creates a flow for the specified Amazon Connect instance.

You can also create and update flows using the Amazon Connect Flow language.

Parameter Syntax

$result = $client->createContactFlow([
    'Content' => '<string>', // REQUIRED
    'Description' => '<string>',
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
    'Type' => 'CONTACT_FLOW|CUSTOMER_QUEUE|CUSTOMER_HOLD|CUSTOMER_WHISPER|AGENT_HOLD|AGENT_WHISPER|OUTBOUND_WHISPER|AGENT_TRANSFER|QUEUE_TRANSFER', // REQUIRED
]);

Parameter Details

Members

Content

Required: Yes
Type: string

The content of the flow.

Description

Type: string

The description of the flow.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance.

Name

Required: Yes
Type: string

The name of the flow.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Type

Required: Yes
Type: string

The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.

Result Syntax

[
    'ContactFlowArn' => '<string>',
    'ContactFlowId' => '<string>',
]

Result Details

Members

ContactFlowArn

Type: string

The Amazon Resource Name (ARN) of the flow.

ContactFlowId

Type: string

The identifier of the flow.

Errors

InvalidRequestException:
The request is not valid.
InvalidContactFlowException:
The flow is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
DuplicateResourceException:
A resource with the specified name already exists.
LimitExceededException:
The allowed limit for the resource has been exceeded.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

CreateContactFlowModule

$result = $client->createContactFlowModule([/* ... */]);
$promise = $client->createContactFlowModuleAsync([/* ... */]);

Creates a flow module for the specified Amazon Connect instance.

Parameter Syntax

$result = $client->createContactFlowModule([
    'ClientToken' => '<string>',
    'Content' => '<string>', // REQUIRED
    'Description' => '<string>',
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

ClientToken

Type: string

Content

Required: Yes
Type: string

The content of the flow module.

Description

Type: string

The description of the flow module.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Name

Required: Yes
Type: string

The name of the flow module.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Result Syntax

[
    'Arn' => '<string>',
    'Id' => '<string>',
]

Result Details

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the flow module.

Id

Type: string

The identifier of the flow module.

Errors

AccessDeniedException:
You do not have sufficient permissions to perform this action.
InvalidRequestException:
The request is not valid.
InvalidContactFlowModuleException:
The problems with the module. Please fix before trying again.
InvalidParameterException:
One or more of the specified parameters are not valid.
DuplicateResourceException:
A resource with the specified name already exists.
LimitExceededException:
The allowed limit for the resource has been exceeded.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
IdempotencyException:
An entity with the same name already exists.
InternalServiceException:
Request processing failed because of an error or failure with the service.

CreateHoursOfOperation

$result = $client->createHoursOfOperation([/* ... */]);
$promise = $client->createHoursOfOperationAsync([/* ... */]);

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

Creates hours of operation.

Parameter Syntax

$result = $client->createHoursOfOperation([
    'Config' => [ // REQUIRED
        [
            'Day' => 'SUNDAY|MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY', // REQUIRED
            'EndTime' => [ // REQUIRED
                'Hours' => <integer>, // REQUIRED
                'Minutes' => <integer>, // REQUIRED
            ],
            'StartTime' => [ // REQUIRED
                'Hours' => <integer>, // REQUIRED
                'Minutes' => <integer>, // REQUIRED
            ],
        ],
        // ...
    ],
    'Description' => '<string>',
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
    'TimeZone' => '<string>', // REQUIRED
]);

Parameter Details

Members

Config

Required: Yes
Type: Array of HoursOfOperationConfig structures

Configuration information for the hours of operation: day, start time, and end time.

Description

Type: string

The description of the hours of operation.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Name

Required: Yes
Type: string

The name of the hours of operation.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

TimeZone

Required: Yes
Type: string

The time zone of the hours of operation.

Result Syntax

[
    'HoursOfOperationArn' => '<string>',
    'HoursOfOperationId' => '<string>',
]

Result Details

Members

HoursOfOperationArn

Type: string

The Amazon Resource Name (ARN) for the hours of operation.

HoursOfOperationId

Type: string

The identifier for the hours of operation.

Errors

DuplicateResourceException:
A resource with the specified name already exists.
InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
LimitExceededException:
The allowed limit for the resource has been exceeded.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

CreateInstance

$result = $client->createInstance([/* ... */]);
$promise = $client->createInstanceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createInstance([
    'ClientToken' => '<string>',
    'DirectoryId' => '<string>',
    'IdentityManagementType' => 'SAML|CONNECT_MANAGED|EXISTING_DIRECTORY', // REQUIRED
    'InboundCallsEnabled' => true || false, // REQUIRED
    'InstanceAlias' => '<string>',
    'OutboundCallsEnabled' => true || false, // REQUIRED
]);

Parameter Details

Members

ClientToken

Type: string

The idempotency token.

DirectoryId

Type: string

The identifier for the directory.

IdentityManagementType

Required: Yes
Type: string

The type of identity management for your Amazon Connect users.

InboundCallsEnabled

Required: Yes
Type: boolean

Your contact center handles incoming contacts.

InstanceAlias

Type: string

The name for your instance.

OutboundCallsEnabled

Required: Yes
Type: boolean

Your contact center allows outbound calls.

Result Syntax

[
    'Arn' => '<string>',
    'Id' => '<string>',
]

Result Details

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the instance.

Id

Type: string

The identifier for the instance.

Errors

InvalidRequestException:
The request is not valid.
ServiceQuotaExceededException:
The service quota has been exceeded.
ThrottlingException:
The throttling limit has been exceeded.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.

CreateIntegrationAssociation

$result = $client->createIntegrationAssociation([/* ... */]);
$promise = $client->createIntegrationAssociationAsync([/* ... */]);

Creates an Amazon Web Services resource association with an Amazon Connect instance.

Parameter Syntax

$result = $client->createIntegrationAssociation([
    'InstanceId' => '<string>', // REQUIRED
    'IntegrationArn' => '<string>', // REQUIRED
    'IntegrationType' => 'EVENT|VOICE_ID|PINPOINT_APP|WISDOM_ASSISTANT|WISDOM_KNOWLEDGE_BASE|CASES_DOMAIN', // REQUIRED
    'SourceApplicationName' => '<string>',
    'SourceApplicationUrl' => '<string>',
    'SourceType' => 'SALESFORCE|ZENDESK',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

IntegrationArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the integration.

When integrating with Amazon Pinpoint, the Amazon Connect and Amazon Pinpoint instances must be in the same account.

IntegrationType

Required: Yes
Type: string

The type of information to be ingested.

SourceApplicationName

Type: string

The name of the external application. This field is only required for the EVENT integration type.

SourceApplicationUrl

Type: string

The URL for the external application. This field is only required for the EVENT integration type.

SourceType

Type: string

The type of the data source. This field is only required for the EVENT integration type.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Result Syntax

[
    'IntegrationAssociationArn' => '<string>',
    'IntegrationAssociationId' => '<string>',
]

Result Details

Members

IntegrationAssociationArn

Type: string

The Amazon Resource Name (ARN) for the association.

IntegrationAssociationId

Type: string

The identifier for the integration association.

Errors

DuplicateResourceException:
A resource with the specified name already exists.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.
ThrottlingException:
The throttling limit has been exceeded.

CreateQueue

$result = $client->createQueue([/* ... */]);
$promise = $client->createQueueAsync([/* ... */]);

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

Creates a new queue for the specified Amazon Connect instance.

If the number being used in the input is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the OutboundCallerIdNumberId value of the OutboundCallerConfig request body parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

Parameter Syntax

$result = $client->createQueue([
    'Description' => '<string>',
    'HoursOfOperationId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'MaxContacts' => <integer>,
    'Name' => '<string>', // REQUIRED
    'OutboundCallerConfig' => [
        'OutboundCallerIdName' => '<string>',
        'OutboundCallerIdNumberId' => '<string>',
        'OutboundFlowId' => '<string>',
    ],
    'QuickConnectIds' => ['<string>', ...],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

Description

Type: string

The description of the queue.

HoursOfOperationId

Required: Yes
Type: string

The identifier for the hours of operation.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxContacts

Type: int

The maximum number of contacts that can be in the queue before it is considered full.

Name

Required: Yes
Type: string

The name of the queue.

OutboundCallerConfig

Type: OutboundCallerConfig structure

The outbound caller ID name, number, and outbound whisper flow.

QuickConnectIds

Type: Array of strings

The quick connects available to agents who are working the queue.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Result Syntax

[
    'QueueArn' => '<string>',
    'QueueId' => '<string>',
]

Result Details

Members

QueueArn

Type: string

The Amazon Resource Name (ARN) of the queue.

QueueId

Type: string

The identifier for the queue.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
DuplicateResourceException:
A resource with the specified name already exists.
ResourceNotFoundException:
The specified resource was not found.
LimitExceededException:
The allowed limit for the resource has been exceeded.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

CreateQuickConnect

$result = $client->createQuickConnect([/* ... */]);
$promise = $client->createQuickConnectAsync([/* ... */]);

Creates a quick connect for the specified Amazon Connect instance.

Parameter Syntax

$result = $client->createQuickConnect([
    'Description' => '<string>',
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'QuickConnectConfig' => [ // REQUIRED
        'PhoneConfig' => [
            'PhoneNumber' => '<string>', // REQUIRED
        ],
        'QueueConfig' => [
            'ContactFlowId' => '<string>', // REQUIRED
            'QueueId' => '<string>', // REQUIRED
        ],
        'QuickConnectType' => 'USER|QUEUE|PHONE_NUMBER', // REQUIRED
        'UserConfig' => [
            'ContactFlowId' => '<string>', // REQUIRED
            'UserId' => '<string>', // REQUIRED
        ],
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

Description

Type: string

The description of the quick connect.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Name

Required: Yes
Type: string

The name of the quick connect.

QuickConnectConfig

Required: Yes
Type: QuickConnectConfig structure

Configuration settings for the quick connect.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Result Syntax

[
    'QuickConnectARN' => '<string>',
    'QuickConnectId' => '<string>',
]

Result Details

Members

QuickConnectARN

Type: string

The Amazon Resource Name (ARN) for the quick connect.

QuickConnectId

Type: string

The identifier for the quick connect.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
DuplicateResourceException:
A resource with the specified name already exists.
ResourceNotFoundException:
The specified resource was not found.
LimitExceededException:
The allowed limit for the resource has been exceeded.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

CreateRoutingProfile

$result = $client->createRoutingProfile([/* ... */]);
$promise = $client->createRoutingProfileAsync([/* ... */]);

Creates a new routing profile.

Parameter Syntax

$result = $client->createRoutingProfile([
    'DefaultOutboundQueueId' => '<string>', // REQUIRED
    'Description' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'MediaConcurrencies' => [ // REQUIRED
        [
            'Channel' => 'VOICE|CHAT|TASK', // REQUIRED
            'Concurrency' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'Name' => '<string>', // REQUIRED
    'QueueConfigs' => [
        [
            'Delay' => <integer>, // REQUIRED
            'Priority' => <integer>, // REQUIRED
            'QueueReference' => [ // REQUIRED
                'Channel' => 'VOICE|CHAT|TASK', // REQUIRED
                'QueueId' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

DefaultOutboundQueueId

Required: Yes
Type: string

The default outbound queue for the routing profile.

Description

Required: Yes
Type: string

Description of the routing profile. Must not be more than 250 characters.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MediaConcurrencies

Required: Yes
Type: Array of MediaConcurrency structures

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

Name

Required: Yes
Type: string

The name of the routing profile. Must not be more than 127 characters.

QueueConfigs

Type: Array of RoutingProfileQueueConfig structures

The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls.

The limit of 10 array members applies to the maximum number of RoutingProfileQueueConfig objects that can be passed during a CreateRoutingProfile API request. It is different from the quota of 50 queues per routing profile per instance that is listed in Amazon Connect service quotas.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Result Syntax

[
    'RoutingProfileArn' => '<string>',
    'RoutingProfileId' => '<string>',
]

Result Details

Members

RoutingProfileArn

Type: string

The Amazon Resource Name (ARN) of the routing profile.

RoutingProfileId

Type: string

The identifier of the routing profile.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
DuplicateResourceException:
A resource with the specified name already exists.
ResourceNotFoundException:
The specified resource was not found.
LimitExceededException:
The allowed limit for the resource has been exceeded.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

CreateRule

$result = $client->createRule([/* ... */]);
$promise = $client->createRuleAsync([/* ... */]);

Creates a rule for the specified Amazon Connect instance.

Use the Rules Function language to code conditions for the rule.

Parameter Syntax

$result = $client->createRule([
    'Actions' => [ // REQUIRED
        [
            'ActionType' => 'CREATE_TASK|ASSIGN_CONTACT_CATEGORY|GENERATE_EVENTBRIDGE_EVENT|SEND_NOTIFICATION', // REQUIRED
            'AssignContactCategoryAction' => [
            ],
            'EventBridgeAction' => [
                'Name' => '<string>', // REQUIRED
            ],
            'SendNotificationAction' => [
                'Content' => '<string>', // REQUIRED
                'ContentType' => 'PLAIN_TEXT', // REQUIRED
                'DeliveryMethod' => 'EMAIL', // REQUIRED
                'Recipient' => [ // REQUIRED
                    'UserIds' => ['<string>', ...],
                    'UserTags' => ['<string>', ...],
                ],
                'Subject' => '<string>',
            ],
            'TaskAction' => [
                'ContactFlowId' => '<string>', // REQUIRED
                'Description' => '<string>',
                'Name' => '<string>', // REQUIRED
                'References' => [
                    '<ReferenceKey>' => [
                        'Type' => 'URL|ATTACHMENT|NUMBER|STRING|DATE|EMAIL', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
        ],
        // ...
    ],
    'ClientToken' => '<string>',
    'Function' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'PublishStatus' => 'DRAFT|PUBLISHED', // REQUIRED
    'TriggerEventSource' => [ // REQUIRED
        'EventSourceName' => 'OnPostCallAnalysisAvailable|OnRealTimeCallAnalysisAvailable|OnPostChatAnalysisAvailable|OnZendeskTicketCreate|OnZendeskTicketStatusUpdate|OnSalesforceCaseCreate', // REQUIRED
        'IntegrationAssociationId' => '<string>',
    ],
]);

Parameter Details

Members

Actions

Required: Yes
Type: Array of RuleAction structures

A list of actions to be run when the rule is triggered.

ClientToken

Type: string

Function

Required: Yes
Type: string

The conditions of the rule.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Name

Required: Yes
Type: string

A unique name for the rule.

PublishStatus

Required: Yes
Type: string

The publish status of the rule.

TriggerEventSource

Required: Yes
Type: RuleTriggerEventSource structure

The event source to trigger the rule.

Result Syntax

[
    'RuleArn' => '<string>',
    'RuleId' => '<string>',
]

Result Details

Members

RuleArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the rule.

RuleId

Required: Yes
Type: string

A unique identifier for the rule.

Errors

InvalidRequestException:
The request is not valid.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
ThrottlingException:
The throttling limit has been exceeded.
AccessDeniedException:
You do not have sufficient permissions to perform this action.
ResourceConflictException:
A resource already has that name.
ServiceQuotaExceededException:
The service quota has been exceeded.

CreateSecurityProfile

$result = $client->createSecurityProfile([/* ... */]);
$promise = $client->createSecurityProfileAsync([/* ... */]);

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

Creates a security profile.

Parameter Syntax

$result = $client->createSecurityProfile([
    'AllowedAccessControlTags' => ['<string>', ...],
    'Description' => '<string>',
    'InstanceId' => '<string>', // REQUIRED
    'Permissions' => ['<string>', ...],
    'SecurityProfileName' => '<string>', // REQUIRED
    'TagRestrictedResources' => ['<string>', ...],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

AllowedAccessControlTags

Type: Associative array of custom strings keys (SecurityProfilePolicyKey) to strings

The list of tags that a security profile uses to restrict access to resources in Amazon Connect.

Description

Type: string

The description of the security profile.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Permissions

Type: Array of strings

Permissions assigned to the security profile. For a list of valid permissions, see List of security profile permissions.

SecurityProfileName

Required: Yes
Type: string

The name of the security profile.

TagRestrictedResources

Type: Array of strings

The list of resources that a security profile applies tag restrictions to in Amazon Connect. Following are acceptable ResourceNames: User | SecurityProfile | Queue | RoutingProfile

Tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Result Syntax

[
    'SecurityProfileArn' => '<string>',
    'SecurityProfileId' => '<string>',
]

Result Details

Members

SecurityProfileArn

Type: string

The Amazon Resource Name (ARN) for the security profile.

SecurityProfileId

Type: string

The identifier for the security profle.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
LimitExceededException:
The allowed limit for the resource has been exceeded.
DuplicateResourceException:
A resource with the specified name already exists.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

CreateTaskTemplate

$result = $client->createTaskTemplate([/* ... */]);
$promise = $client->createTaskTemplateAsync([/* ... */]);

Creates a new task template in the specified Amazon Connect instance.

Parameter Syntax

$result = $client->createTaskTemplate([
    'ClientToken' => '<string>',
    'Constraints' => [
        'InvisibleFields' => [
            [
                'Id' => [
                    'Name' => '<string>',
                ],
            ],
            // ...
        ],
        'ReadOnlyFields' => [
            [
                'Id' => [
                    'Name' => '<string>',
                ],
            ],
            // ...
        ],
        'RequiredFields' => [
            [
                'Id' => [
                    'Name' => '<string>',
                ],
            ],
            // ...
        ],
    ],
    'ContactFlowId' => '<string>',
    'Defaults' => [
        'DefaultFieldValues' => [
            [
                'DefaultValue' => '<string>',
                'Id' => [
                    'Name' => '<string>',
                ],
            ],
            // ...
        ],
    ],
    'Description' => '<string>',
    'Fields' => [ // REQUIRED
        [
            'Description' => '<string>',
            'Id' => [ // REQUIRED
                'Name' => '<string>',
            ],
            'SingleSelectOptions' => ['<string>', ...],
            'Type' => 'NAME|DESCRIPTION|SCHEDULED_TIME|QUICK_CONNECT|URL|NUMBER|TEXT|TEXT_AREA|DATE_TIME|BOOLEAN|SINGLE_SELECT|EMAIL',
        ],
        // ...
    ],
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Status' => 'ACTIVE|INACTIVE',
]);

Parameter Details

Members

ClientToken

Type: string

Constraints

Type: TaskTemplateConstraints structure

Constraints that are applicable to the fields listed.

ContactFlowId

Type: string

The identifier of the flow that runs by default when a task is created by referencing this template.

Defaults

Type: TaskTemplateDefaults structure

The default values for fields when a task is created by referencing this template.

Description

Type: string

The description of the task template.

Fields

Required: Yes
Type: Array of TaskTemplateField structures

Fields that are part of the template.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Name

Required: Yes
Type: string

The name of the task template.

Status

Type: string

Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

Result Syntax

[
    'Arn' => '<string>',
    'Id' => '<string>',
]

Result Details

Members

Arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) for the task template resource.

Id

Required: Yes
Type: string

The identifier of the task template resource.

Errors

PropertyValidationException:
The property is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
ServiceQuotaExceededException:
The service quota has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

CreateTrafficDistributionGroup

$result = $client->createTrafficDistributionGroup([/* ... */]);
$promise = $client->createTrafficDistributionGroupAsync([/* ... */]);

Creates a traffic distribution group given an Amazon Connect instance that has been replicated.

For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->createTrafficDistributionGroup([
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

ClientToken

Type: string

Description

Type: string

A description for the traffic distribution group.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance that has been replicated. You can find the instanceId in the ARN of the instance.

Name

Required: Yes
Type: string

The name for the traffic distribution group.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Result Syntax

[
    'Arn' => '<string>',
    'Id' => '<string>',
]

Result Details

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the traffic distribution group.

Id

Type: string

The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

Errors

InvalidRequestException:
The request is not valid.
AccessDeniedException:
You do not have sufficient permissions to perform this action.
ServiceQuotaExceededException:
The service quota has been exceeded.
ThrottlingException:
The throttling limit has been exceeded.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
ResourceConflictException:
A resource already has that name.
ResourceNotReadyException:
The resource is not ready.

CreateUseCase

$result = $client->createUseCase([/* ... */]);
$promise = $client->createUseCaseAsync([/* ... */]);

Creates a use case for an integration association.

Parameter Syntax

$result = $client->createUseCase([
    'InstanceId' => '<string>', // REQUIRED
    'IntegrationAssociationId' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
    'UseCaseType' => 'RULES_EVALUATION|CONNECT_CAMPAIGNS', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

IntegrationAssociationId

Required: Yes
Type: string

The identifier for the integration association.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

UseCaseType

Required: Yes
Type: string

The type of use case to associate to the integration association. Each integration association can have only one of each use case type.

Result Syntax

[
    'UseCaseArn' => '<string>',
    'UseCaseId' => '<string>',
]

Result Details

Members

UseCaseArn

Type: string

The Amazon Resource Name (ARN) for the use case.

UseCaseId

Type: string

The identifier of the use case.

Errors

DuplicateResourceException:
A resource with the specified name already exists.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.
ThrottlingException:
The throttling limit has been exceeded.

CreateUser

$result = $client->createUser([/* ... */]);
$promise = $client->createUserAsync([/* ... */]);

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 in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->createUser([
    'DirectoryUserId' => '<string>',
    'HierarchyGroupId' => '<string>',
    'IdentityInfo' => [
        'Email' => '<string>',
        'FirstName' => '<string>',
        'LastName' => '<string>',
        'Mobile' => '<string>',
        'SecondaryEmail' => '<string>',
    ],
    'InstanceId' => '<string>', // REQUIRED
    'Password' => '<string>',
    'PhoneConfig' => [ // REQUIRED
        'AfterContactWorkTimeLimit' => <integer>,
        'AutoAccept' => true || false,
        'DeskPhoneNumber' => '<string>',
        'PhoneType' => 'SOFT_PHONE|DESK_PHONE', // REQUIRED
    ],
    'RoutingProfileId' => '<string>', // REQUIRED
    'SecurityProfileIds' => ['<string>', ...], // REQUIRED
    'Tags' => ['<string>', ...],
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

DirectoryUserId

Type: string

The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.

This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.

HierarchyGroupId

Type: string

The identifier of the hierarchy group for the user.

IdentityInfo

Type: UserIdentityInfo structure

The information about the identity of the user.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Password

Type: string

The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.

PhoneConfig

Required: Yes
Type: UserPhoneConfig structure

The phone settings for the user.

RoutingProfileId

Required: Yes
Type: string

The identifier of the routing profile for the user.

SecurityProfileIds

Required: Yes
Type: Array of strings

The identifier of the security profile for the user.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Username

Required: Yes
Type: string

The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.\@]+.

Result Syntax

[
    'UserArn' => '<string>',
    'UserId' => '<string>',
]

Result Details

Members

UserArn

Type: string

The Amazon Resource Name (ARN) of the user account.

UserId

Type: string

The identifier of the user account.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
LimitExceededException:
The allowed limit for the resource has been exceeded.
DuplicateResourceException:
A resource with the specified name already exists.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

CreateUserHierarchyGroup

$result = $client->createUserHierarchyGroup([/* ... */]);
$promise = $client->createUserHierarchyGroupAsync([/* ... */]);

Creates a new user hierarchy group.

Parameter Syntax

$result = $client->createUserHierarchyGroup([
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'ParentGroupId' => '<string>',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Name

Required: Yes
Type: string

The name of the user hierarchy group. Must not be more than 100 characters.

ParentGroupId

Type: string

The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Result Syntax

[
    'HierarchyGroupArn' => '<string>',
    'HierarchyGroupId' => '<string>',
]

Result Details

Members

HierarchyGroupArn

Type: string

The Amazon Resource Name (ARN) of the hierarchy group.

HierarchyGroupId

Type: string

The identifier of the hierarchy group.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
DuplicateResourceException:
A resource with the specified name already exists.
LimitExceededException:
The allowed limit for the resource has been exceeded.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

CreateVocabulary

$result = $client->createVocabulary([/* ... */]);
$promise = $client->createVocabularyAsync([/* ... */]);

Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.

Parameter Syntax

$result = $client->createVocabulary([
    'ClientToken' => '<string>',
    'Content' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'LanguageCode' => 'ar-AE|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fr-CA|fr-FR|hi-IN|it-IT|ja-JP|ko-KR|pt-BR|pt-PT|zh-CN|en-NZ|en-ZA', // REQUIRED
    'Tags' => ['<string>', ...],
    'VocabularyName' => '<string>', // REQUIRED
]);

Parameter Details

Members

ClientToken

Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.

Content

Required: Yes
Type: string

The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. The size limit is 50KB. For more information, see Create a custom vocabulary using a table.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

LanguageCode

Required: Yes
Type: string

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

Tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

VocabularyName

Required: Yes
Type: string

A unique name of the custom vocabulary.

Result Syntax

[
    'State' => 'CREATION_IN_PROGRESS|ACTIVE|CREATION_FAILED|DELETE_IN_PROGRESS',
    'VocabularyArn' => '<string>',
    'VocabularyId' => '<string>',
]

Result Details

Members

State

Required: Yes
Type: string

The current state of the custom vocabulary.

VocabularyArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the custom vocabulary.

VocabularyId

Required: Yes
Type: string

The identifier of the custom vocabulary.

Errors

InvalidRequestException:
The request is not valid.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
ThrottlingException:
The throttling limit has been exceeded.
AccessDeniedException:
You do not have sufficient permissions to perform this action.
ResourceConflictException:
A resource already has that name.
ServiceQuotaExceededException:
The service quota has been exceeded.

DeleteContactFlow

$result = $client->deleteContactFlow([/* ... */]);
$promise = $client->deleteContactFlowAsync([/* ... */]);

Deletes a flow for the specified Amazon Connect instance.

Parameter Syntax

$result = $client->deleteContactFlow([
    'ContactFlowId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ContactFlowId

Required: Yes
Type: string

The identifier of the flow.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
You do not have sufficient permissions to perform this action.
InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
ThrottlingException:
The throttling limit has been exceeded.

DeleteContactFlowModule

$result = $client->deleteContactFlowModule([/* ... */]);
$promise = $client->deleteContactFlowModuleAsync([/* ... */]);

Deletes the specified flow module.

Parameter Syntax

$result = $client->deleteContactFlowModule([
    'ContactFlowModuleId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ContactFlowModuleId

Required: Yes
Type: string

The identifier of the flow module.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
You do not have sufficient permissions to perform this action.
InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

DeleteHoursOfOperation

$result = $client->deleteHoursOfOperation([/* ... */]);
$promise = $client->deleteHoursOfOperationAsync([/* ... */]);

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

Deletes an hours of operation.

Parameter Syntax

$result = $client->deleteHoursOfOperation([
    'HoursOfOperationId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

HoursOfOperationId

Required: Yes
Type: string

The identifier for the hours of operation.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

DeleteInstance

$result = $client->deleteInstance([/* ... */]);
$promise = $client->deleteInstanceAsync([/* ... */]);

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

Deletes the Amazon Connect instance.

Parameter Syntax

$result = $client->deleteInstance([
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.

DeleteIntegrationAssociation

$result = $client->deleteIntegrationAssociation([/* ... */]);
$promise = $client->deleteIntegrationAssociationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteIntegrationAssociation([
    'InstanceId' => '<string>', // REQUIRED
    'IntegrationAssociationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

IntegrationAssociationId

Required: Yes
Type: string

The identifier for the integration association.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.
ThrottlingException:
The throttling limit has been exceeded.

DeleteQuickConnect

$result = $client->deleteQuickConnect([/* ... */]);
$promise = $client->deleteQuickConnectAsync([/* ... */]);

Deletes a quick connect.

Parameter Syntax

$result = $client->deleteQuickConnect([
    'InstanceId' => '<string>', // REQUIRED
    'QuickConnectId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

QuickConnectId

Required: Yes
Type: string

The identifier for the quick connect.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

DeleteRule

$result = $client->deleteRule([/* ... */]);
$promise = $client->deleteRuleAsync([/* ... */]);

Deletes a rule for the specified Amazon Connect instance.

Parameter Syntax

$result = $client->deleteRule([
    'InstanceId' => '<string>', // REQUIRED
    'RuleId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

RuleId

Required: Yes
Type: string

A unique identifier for the rule.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
ThrottlingException:
The throttling limit has been exceeded.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

DeleteSecurityProfile

$result = $client->deleteSecurityProfile([/* ... */]);
$promise = $client->deleteSecurityProfileAsync([/* ... */]);

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

Deletes a security profile.

Parameter Syntax

$result = $client->deleteSecurityProfile([
    'InstanceId' => '<string>', // REQUIRED
    'SecurityProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

SecurityProfileId

Required: Yes
Type: string

The identifier for the security profle.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.
AccessDeniedException:
You do not have sufficient permissions to perform this action.
ResourceInUseException:
That resource is already in use. Please try another.

DeleteTaskTemplate

$result = $client->deleteTaskTemplate([/* ... */]);
$promise = $client->deleteTaskTemplateAsync([/* ... */]);

Deletes the task template.

Parameter Syntax

$result = $client->deleteTaskTemplate([
    'InstanceId' => '<string>', // REQUIRED
    'TaskTemplateId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

TaskTemplateId

Required: Yes
Type: string

A unique identifier for the task template.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

DeleteTrafficDistributionGroup

$result = $client->deleteTrafficDistributionGroup([/* ... */]);
$promise = $client->deleteTrafficDistributionGroupAsync([/* ... */]);

Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.

For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->deleteTrafficDistributionGroup([
    'TrafficDistributionGroupId' => '<string>', // REQUIRED
]);

Parameter Details

Members

TrafficDistributionGroupId

Required: Yes
Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
AccessDeniedException:
You do not have sufficient permissions to perform this action.
ResourceInUseException:
That resource is already in use. Please try another.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

DeleteUseCase

$result = $client->deleteUseCase([/* ... */]);
$promise = $client->deleteUseCaseAsync([/* ... */]);

Deletes a use case from an integration association.

Parameter Syntax

$result = $client->deleteUseCase([
    'InstanceId' => '<string>', // REQUIRED
    'IntegrationAssociationId' => '<string>', // REQUIRED
    'UseCaseId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

IntegrationAssociationId

Required: Yes
Type: string

The identifier for the integration association.

UseCaseId

Required: Yes
Type: string

The identifier for the use case.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.
ThrottlingException:
The throttling limit has been exceeded.

DeleteUser

$result = $client->deleteUser([/* ... */]);
$promise = $client->deleteUserAsync([/* ... */]);

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 in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->deleteUser([
    'InstanceId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

UserId

Required: Yes
Type: string

The identifier of the user.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

DeleteUserHierarchyGroup

$result = $client->deleteUserHierarchyGroup([/* ... */]);
$promise = $client->deleteUserHierarchyGroupAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteUserHierarchyGroup([
    'HierarchyGroupId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

HierarchyGroupId

Required: Yes
Type: string

The identifier of the hierarchy group.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ResourceInUseException:
That resource is already in use. Please try another.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

DeleteVocabulary

$result = $client->deleteVocabulary([/* ... */]);
$promise = $client->deleteVocabularyAsync([/* ... */]);

Deletes the vocabulary that has the given identifier.

Parameter Syntax

$result = $client->deleteVocabulary([
    'InstanceId' => '<string>', // REQUIRED
    'VocabularyId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

VocabularyId

Required: Yes
Type: string

The identifier of the custom vocabulary.

Result Syntax

[
    'State' => 'CREATION_IN_PROGRESS|ACTIVE|CREATION_FAILED|DELETE_IN_PROGRESS',
    'VocabularyArn' => '<string>',
    'VocabularyId' => '<string>',
]

Result Details

Members

State

Required: Yes
Type: string

The current state of the custom vocabulary.

VocabularyArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the custom vocabulary.

VocabularyId

Required: Yes
Type: string

The identifier of the custom vocabulary.

Errors

InvalidRequestException:
The request is not valid.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
ThrottlingException:
The throttling limit has been exceeded.
AccessDeniedException:
You do not have sufficient permissions to perform this action.
ResourceInUseException:
That resource is already in use. Please try another.

DescribeAgentStatus

$result = $client->describeAgentStatus([/* ... */]);
$promise = $client->describeAgentStatusAsync([/* ... */]);

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

Describes an agent status.

Parameter Syntax

$result = $client->describeAgentStatus([
    'AgentStatusId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AgentStatusId

Required: Yes
Type: string

The identifier for the agent status.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Result Syntax

[
    'AgentStatus' => [
        'AgentStatusARN' => '<string>',
        'AgentStatusId' => '<string>',
        'Description' => '<string>',
        'DisplayOrder' => <integer>,
        'Name' => '<string>',
        'State' => 'ENABLED|DISABLED',
        'Tags' => ['<string>', ...],
        'Type' => 'ROUTABLE|CUSTOM|OFFLINE',
    ],
]

Result Details

Members

AgentStatus

Type: AgentStatus structure

The agent status.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

DescribeContact

$result = $client->describeContact([/* ... */]);
$promise = $client->describeContactAsync([/* ... */]);

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

Describes the specified contact.

Contact information remains available in Amazon Connect for 24 months, and then it is deleted.

Only data from November 12, 2021, and later is returned by this API.

Parameter Syntax

$result = $client->describeContact([
    'ContactId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ContactId

Required: Yes
Type: string

The identifier of the contact.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Result Syntax

[
    'Contact' => [
        'AgentInfo' => [
            'ConnectedToAgentTimestamp' => <DateTime>,
            'Id' => '<string>',
        ],
        'Arn' => '<string>',
        'Channel' => 'VOICE|CHAT|TASK',
        'Description' => '<string>',
        'DisconnectTimestamp' => <DateTime>,
        'Id' => '<string>',
        'InitialContactId' => '<string>',
        'InitiationMethod' => 'INBOUND|OUTBOUND|TRANSFER|QUEUE_TRANSFER|CALLBACK|API|DISCONNECT|MONITOR',
        'InitiationTimestamp' => <DateTime>,
        'LastUpdateTimestamp' => <DateTime>,
        'Name' => '<string>',
        'PreviousContactId' => '<string>',
        'QueueInfo' => [
            'EnqueueTimestamp' => <DateTime>,
            'Id' => '<string>',
        ],
        'RelatedContactId' => '<string>',
        'ScheduledTimestamp' => <DateTime>,
        'WisdomInfo' => [
            'SessionArn' => '<string>',
        ],
    ],
]

Result Details

Members

Contact

Type: Contact structure

Information about the contact.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
ThrottlingException:
The throttling limit has been exceeded.

DescribeContactFlow

$result = $client->describeContactFlow([/* ... */]);
$promise = $client->describeContactFlowAsync([/* ... */]);

Describes the specified flow.

You can also create and update flows using the Amazon Connect Flow language.

Parameter Syntax

$result = $client->describeContactFlow([
    'ContactFlowId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ContactFlowId

Required: Yes
Type: string

The identifier of the flow.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance.

Result Syntax

[
    'ContactFlow' => [
        'Arn' => '<string>',
        'Content' => '<string>',
        'Description' => '<string>',
        'Id' => '<string>',
        'Name' => '<string>',
        'State' => 'ACTIVE|ARCHIVED',
        'Tags' => ['<string>', ...],
        'Type' => 'CONTACT_FLOW|CUSTOMER_QUEUE|CUSTOMER_HOLD|CUSTOMER_WHISPER|AGENT_HOLD|AGENT_WHISPER|OUTBOUND_WHISPER|AGENT_TRANSFER|QUEUE_TRANSFER',
    ],
]

Result Details

Members

ContactFlow

Type: ContactFlow structure

Information about the flow.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ContactFlowNotPublishedException:
The flow has not been published.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

DescribeContactFlowModule

$result = $client->describeContactFlowModule([/* ... */]);
$promise = $client->describeContactFlowModuleAsync([/* ... */]);

Describes the specified flow module.

Parameter Syntax

$result = $client->describeContactFlowModule([
    'ContactFlowModuleId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ContactFlowModuleId

Required: Yes
Type: string

The identifier of the flow module.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Result Syntax

[
    'ContactFlowModule' => [
        'Arn' => '<string>',
        'Content' => '<string>',
        'Description' => '<string>',
        'Id' => '<string>',
        'Name' => '<string>',
        'State' => 'ACTIVE|ARCHIVED',
        'Status' => 'PUBLISHED|SAVED',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Members

ContactFlowModule

Type: ContactFlowModule structure

Information about the flow module.

Errors

AccessDeniedException:
You do not have sufficient permissions to perform this action.
InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

DescribeHoursOfOperation

$result = $client->describeHoursOfOperation([/* ... */]);
$promise = $client->describeHoursOfOperationAsync([/* ... */]);

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

Describes the hours of operation.

Parameter Syntax

$result = $client->describeHoursOfOperation([
    'HoursOfOperationId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

HoursOfOperationId

Required: Yes
Type: string

The identifier for the hours of operation.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Result Syntax

[
    'HoursOfOperation' => [
        'Config' => [
            [
                'Day' => 'SUNDAY|MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY',
                'EndTime' => [
                    'Hours' => <integer>,
                    'Minutes' => <integer>,
                ],
                'StartTime' => [
                    'Hours' => <integer>,
                    'Minutes' => <integer>,
                ],
            ],
            // ...
        ],
        'Description' => '<string>',
        'HoursOfOperationArn' => '<string>',
        'HoursOfOperationId' => '<string>',
        'Name' => '<string>',
        'Tags' => ['<string>', ...],
        'TimeZone' => '<string>',
    ],
]

Result Details

Members

HoursOfOperation

Type: HoursOfOperation structure

The hours of operation.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

DescribeInstance

$result = $client->describeInstance([/* ... */]);
$promise = $client->describeInstanceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeInstance([
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Result Syntax

[
    'Instance' => [
        'Arn' => '<string>',
        'CreatedTime' => <DateTime>,
        'Id' => '<string>',
        'IdentityManagementType' => 'SAML|CONNECT_MANAGED|EXISTING_DIRECTORY',
        'InboundCallsEnabled' => true || false,
        'InstanceAlias' => '<string>',
        'InstanceStatus' => 'CREATION_IN_PROGRESS|ACTIVE|CREATION_FAILED',
        'OutboundCallsEnabled' => true || false,
        'ServiceRole' => '<string>',
        'StatusReason' => [
            'Message' => '<string>',
        ],
    ],
]

Result Details

Members

Instance

Type: Instance structure

The name of the instance.

Errors

InvalidRequestException:
The request is not valid.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.

DescribeInstanceAttribute

$result = $client->describeInstanceAttribute([/* ... */]);
$promise = $client->describeInstanceAttributeAsync([/* ... */]);

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

Describes the specified instance attribute.

Parameter Syntax

$result = $client->describeInstanceAttribute([
    'AttributeType' => 'INBOUND_CALLS|OUTBOUND_CALLS|CONTACTFLOW_LOGS|CONTACT_LENS|AUTO_RESOLVE_BEST_VOICES|USE_CUSTOM_TTS_VOICES|EARLY_MEDIA|MULTI_PARTY_CONFERENCE|HIGH_VOLUME_OUTBOUND|ENHANCED_CONTACT_MONITORING', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AttributeType

Required: Yes
Type: string

The type of attribute.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Result Syntax

[
    'Attribute' => [
        'AttributeType' => 'INBOUND_CALLS|OUTBOUND_CALLS|CONTACTFLOW_LOGS|CONTACT_LENS|AUTO_RESOLVE_BEST_VOICES|USE_CUSTOM_TTS_VOICES|EARLY_MEDIA|MULTI_PARTY_CONFERENCE|HIGH_VOLUME_OUTBOUND|ENHANCED_CONTACT_MONITORING',
        'Value' => '<string>',
    ],
]

Result Details

Members

Attribute

Type: Attribute structure

The type of attribute.

Errors

ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ThrottlingException:
The throttling limit has been exceeded.

DescribeInstanceStorageConfig

$result = $client->describeInstanceStorageConfig([/* ... */]);
$promise = $client->describeInstanceStorageConfigAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeInstanceStorageConfig([
    'AssociationId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'ResourceType' => 'CHAT_TRANSCRIPTS|CALL_RECORDINGS|SCHEDULED_REPORTS|MEDIA_STREAMS|CONTACT_TRACE_RECORDS|AGENT_EVENTS|REAL_TIME_CONTACT_ANALYSIS_SEGMENTS|ATTACHMENTS|CONTACT_EVALUATIONS', // REQUIRED
]);

Parameter Details

Members

AssociationId

Required: Yes
Type: string

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

ResourceType

Required: Yes
Type: string

A valid resource type.

Result Syntax

[
    'StorageConfig' => [
        'AssociationId' => '<string>',
        'KinesisFirehoseConfig' => [
            'FirehoseArn' => '<string>',
        ],
        'KinesisStreamConfig' => [
            'StreamArn' => '<string>',
        ],
        'KinesisVideoStreamConfig' => [
            'EncryptionConfig' => [
                'EncryptionType' => 'KMS',
                'KeyId' => '<string>',
            ],
            'Prefix' => '<string>',
            'RetentionPeriodHours' => <integer>,
        ],
        'S3Config' => [
            'BucketName' => '<string>',
            'BucketPrefix' => '<string>',
            'EncryptionConfig' => [
                'EncryptionType' => 'KMS',
                'KeyId' => '<string>',
            ],
        ],
        'StorageType' => 'S3|KINESIS_VIDEO_STREAM|KINESIS_STREAM|KINESIS_FIREHOSE',
    ],
]

Result Details

Members

StorageConfig

Type: InstanceStorageConfig structure

A valid storage type.

Errors

ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ThrottlingException:
The throttling limit has been exceeded.

DescribePhoneNumber

$result = $client->describePhoneNumber([/* ... */]);
$promise = $client->describePhoneNumberAsync([/* ... */]);

Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.

If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

Parameter Syntax

$result = $client->describePhoneNumber([
    'PhoneNumberId' => '<string>', // REQUIRED
]);

Parameter Details

Members

PhoneNumberId

Required: Yes
Type: string

A unique identifier for the phone number.

Result Syntax

[
    'ClaimedPhoneNumberSummary' => [
        'PhoneNumber' => '<string>',
        'PhoneNumberArn' => '<string>',
        'PhoneNumberCountryCode' => 'AF|AL|DZ|AS|AD|AO|AI|AQ|AG|AR|AM|AW|AU|AT|AZ|BS|BH|BD|BB|BY|BE|BZ|BJ|BM|BT|BO|BA|BW|BR|IO|VG|BN|BG|BF|BI|KH|CM|CA|CV|KY|CF|TD|CL|CN|CX|CC|CO|KM|CK|CR|HR|CU|CW|CY|CZ|CD|DK|DJ|DM|DO|TL|EC|EG|SV|GQ|ER|EE|ET|FK|FO|FJ|FI|FR|PF|GA|GM|GE|DE|GH|GI|GR|GL|GD|GU|GT|GG|GN|GW|GY|HT|HN|HK|HU|IS|IN|ID|IR|IQ|IE|IM|IL|IT|CI|JM|JP|JE|JO|KZ|KE|KI|KW|KG|LA|LV|LB|LS|LR|LY|LI|LT|LU|MO|MK|MG|MW|MY|MV|ML|MT|MH|MR|MU|YT|MX|FM|MD|MC|MN|ME|MS|MA|MZ|MM|NA|NR|NP|NL|AN|NC|NZ|NI|NE|NG|NU|KP|MP|NO|OM|PK|PW|PA|PG|PY|PE|PH|PN|PL|PT|PR|QA|CG|RE|RO|RU|RW|BL|SH|KN|LC|MF|PM|VC|WS|SM|ST|SA|SN|RS|SC|SL|SG|SX|SK|SI|SB|SO|ZA|KR|ES|LK|SD|SR|SJ|SZ|SE|CH|SY|TW|TJ|TZ|TH|TG|TK|TO|TT|TN|TR|TM|TC|TV|VI|UG|UA|AE|GB|US|UY|UZ|VU|VA|VE|VN|WF|EH|YE|ZM|ZW',
        'PhoneNumberDescription' => '<string>',
        'PhoneNumberId' => '<string>',
        'PhoneNumberStatus' => [
            'Message' => '<string>',
            'Status' => 'CLAIMED|IN_PROGRESS|FAILED',
        ],
        'PhoneNumberType' => 'TOLL_FREE|DID',
        'Tags' => ['<string>', ...],
        'TargetArn' => '<string>',
    ],
]

Result Details

Members

ClaimedPhoneNumberSummary

Type: ClaimedPhoneNumberSummary structure

Information about a phone number that's been claimed to your Amazon Connect instance or traffic distribution group.

Errors

InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

DescribeQueue

$result = $client->describeQueue([/* ... */]);
$promise = $client->describeQueueAsync([/* ... */]);

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

Describes the specified queue.

Parameter Syntax

$result = $client->describeQueue([
    'InstanceId' => '<string>', // REQUIRED
    'QueueId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

QueueId

Required: Yes
Type: string

The identifier for the queue.

Result Syntax

[
    'Queue' => [
        'Description' => '<string>',
        'HoursOfOperationId' => '<string>',
        'MaxContacts' => <integer>,
        'Name' => '<string>',
        'OutboundCallerConfig' => [
            'OutboundCallerIdName' => '<string>',
            'OutboundCallerIdNumberId' => '<string>',
            'OutboundFlowId' => '<string>',
        ],
        'QueueArn' => '<string>',
        'QueueId' => '<string>',
        'Status' => 'ENABLED|DISABLED',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Members

Queue

Type: Queue structure

The name of the queue.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

DescribeQuickConnect

$result = $client->describeQuickConnect([/* ... */]);
$promise = $client->describeQuickConnectAsync([/* ... */]);

Describes the quick connect.

Parameter Syntax

$result = $client->describeQuickConnect([
    'InstanceId' => '<string>', // REQUIRED
    'QuickConnectId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

QuickConnectId

Required: Yes
Type: string

The identifier for the quick connect.

Result Syntax

[
    'QuickConnect' => [
        'Description' => '<string>',
        'Name' => '<string>',
        'QuickConnectARN' => '<string>',
        'QuickConnectConfig' => [
            'PhoneConfig' => [
                'PhoneNumber' => '<string>',
            ],
            'QueueConfig' => [
                'ContactFlowId' => '<string>',
                'QueueId' => '<string>',
            ],
            'QuickConnectType' => 'USER|QUEUE|PHONE_NUMBER',
            'UserConfig' => [
                'ContactFlowId' => '<string>',
                'UserId' => '<string>',
            ],
        ],
        'QuickConnectId' => '<string>',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Members

QuickConnect

Type: QuickConnect structure

Information about the quick connect.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

DescribeRoutingProfile

$result = $client->describeRoutingProfile([/* ... */]);
$promise = $client->describeRoutingProfileAsync([/* ... */]);

Describes the specified routing profile.

Parameter Syntax

$result = $client->describeRoutingProfile([
    'InstanceId' => '<string>', // REQUIRED
    'RoutingProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

RoutingProfileId

Required: Yes
Type: string

The identifier of the routing profile.

Result Syntax

[
    'RoutingProfile' => [
        'DefaultOutboundQueueId' => '<string>',
        'Description' => '<string>',
        'InstanceId' => '<string>',
        'MediaConcurrencies' => [
            [
                'Channel' => 'VOICE|CHAT|TASK',
                'Concurrency' => <integer>,
            ],
            // ...
        ],
        'Name' => '<string>',
        'NumberOfAssociatedQueues' => <integer>,
        'NumberOfAssociatedUsers' => <integer>,
        'RoutingProfileArn' => '<string>',
        'RoutingProfileId' => '<string>',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Members

RoutingProfile

Type: RoutingProfile structure

The routing profile.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

DescribeRule

$result = $client->describeRule([/* ... */]);
$promise = $client->describeRuleAsync([/* ... */]);

Describes a rule for the specified Amazon Connect instance.

Parameter Syntax

$result = $client->describeRule([
    'InstanceId' => '<string>', // REQUIRED
    'RuleId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

RuleId

Required: Yes
Type: string

A unique identifier for the rule.

Result Syntax

[
    'Rule' => [
        'Actions' => [
            [
                'ActionType' => 'CREATE_TASK|ASSIGN_CONTACT_CATEGORY|GENERATE_EVENTBRIDGE_EVENT|SEND_NOTIFICATION',
                'AssignContactCategoryAction' => [
                ],
                'EventBridgeAction' => [
                    'Name' => '<string>',
                ],
                'SendNotificationAction' => [
                    'Content' => '<string>',
                    'ContentType' => 'PLAIN_TEXT',
                    'DeliveryMethod' => 'EMAIL',
                    'Recipient' => [
                        'UserIds' => ['<string>', ...],
                        'UserTags' => ['<string>', ...],
                    ],
                    'Subject' => '<string>',
                ],
                'TaskAction' => [
                    'ContactFlowId' => '<string>',
                    'Description' => '<string>',
                    'Name' => '<string>',
                    'References' => [
                        '<ReferenceKey>' => [
                            'Type' => 'URL|ATTACHMENT|NUMBER|STRING|DATE|EMAIL',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
            ],
            // ...
        ],
        'CreatedTime' => <DateTime>,
        'Function' => '<string>',
        'LastUpdatedBy' => '<string>',
        'LastUpdatedTime' => <DateTime>,
        'Name' => '<string>',
        'PublishStatus' => 'DRAFT|PUBLISHED',
        'RuleArn' => '<string>',
        'RuleId' => '<string>',
        'Tags' => ['<string>', ...],
        'TriggerEventSource' => [
            'EventSourceName' => 'OnPostCallAnalysisAvailable|OnRealTimeCallAnalysisAvailable|OnPostChatAnalysisAvailable|OnZendeskTicketCreate|OnZendeskTicketStatusUpdate|OnSalesforceCaseCreate',
            'IntegrationAssociationId' => '<string>',
        ],
    ],
]

Result Details

Members

Rule

Required: Yes
Type: Rule structure

Information about the rule.

Errors

InvalidRequestException:
The request is not valid.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
ThrottlingException:
The throttling limit has been exceeded.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

DescribeSecurityProfile

$result = $client->describeSecurityProfile([/* ... */]);
$promise = $client->describeSecurityProfileAsync([/* ... */]);

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

Gets basic information about the security profle.

Parameter Syntax

$result = $client->describeSecurityProfile([
    'InstanceId' => '<string>', // REQUIRED
    'SecurityProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

SecurityProfileId

Required: Yes
Type: string

The identifier for the security profle.

Result Syntax

[
    'SecurityProfile' => [
        'AllowedAccessControlTags' => ['<string>', ...],
        'Arn' => '<string>',
        'Description' => '<string>',
        'Id' => '<string>',
        'OrganizationResourceId' => '<string>',
        'SecurityProfileName' => '<string>',
        'TagRestrictedResources' => ['<string>', ...],
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Members

SecurityProfile

Type: SecurityProfile structure

The security profile.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

DescribeTrafficDistributionGroup

$result = $client->describeTrafficDistributionGroup([/* ... */]);
$promise = $client->describeTrafficDistributionGroupAsync([/* ... */]);

Gets details and status of a traffic distribution group.

Parameter Syntax

$result = $client->describeTrafficDistributionGroup([
    'TrafficDistributionGroupId' => '<string>', // REQUIRED
]);

Parameter Details

Members

TrafficDistributionGroupId

Required: Yes
Type: string

Result Syntax

[
    'TrafficDistributionGroup' => [
        'Arn' => '<string>',
        'Description' => '<string>',
        'Id' => '<string>',
        'InstanceArn' => '<string>',
        'Name' => '<string>',
        'Status' => 'CREATION_IN_PROGRESS|ACTIVE|CREATION_FAILED|PENDING_DELETION|DELETION_FAILED|UPDATE_IN_PROGRESS',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Members

TrafficDistributionGroup

Type: TrafficDistributionGroup structure

Information about the traffic distribution group.

Errors

InvalidRequestException:
The request is not valid.
AccessDeniedException:
You do not have sufficient permissions to perform this action.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
ThrottlingException:
The throttling limit has been exceeded.

DescribeUser

$result = $client->describeUser([/* ... */]);
$promise = $client->describeUserAsync([/* ... */]);

Describes the specified user account. You can find the instance ID in the Amazon Connect 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.

Parameter Syntax

$result = $client->describeUser([
    'InstanceId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

UserId

Required: Yes
Type: string

The identifier of the user account.

Result Syntax

[
    'User' => [
        'Arn' => '<string>',
        'DirectoryUserId' => '<string>',
        'HierarchyGroupId' => '<string>',
        'Id' => '<string>',
        'IdentityInfo' => [
            'Email' => '<string>',
            'FirstName' => '<string>',
            'LastName' => '<string>',
            'Mobile' => '<string>',
            'SecondaryEmail' => '<string>',
        ],
        'PhoneConfig' => [
            'AfterContactWorkTimeLimit' => <integer>,
            'AutoAccept' => true || false,
            'DeskPhoneNumber' => '<string>',
            'PhoneType' => 'SOFT_PHONE|DESK_PHONE',
        ],
        'RoutingProfileId' => '<string>',
        'SecurityProfileIds' => ['<string>', ...],
        'Tags' => ['<string>', ...],
        'Username' => '<string>',
    ],
]

Result Details

Members

User

Type: User structure

Information about the user account and configuration settings.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

DescribeUserHierarchyGroup

$result = $client->describeUserHierarchyGroup([/* ... */]);
$promise = $client->describeUserHierarchyGroupAsync([/* ... */]);

Describes the specified hierarchy group.

Parameter Syntax

$result = $client->describeUserHierarchyGroup([
    'HierarchyGroupId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

HierarchyGroupId

Required: Yes
Type: string

The identifier of the hierarchy group.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Result Syntax

[
    'HierarchyGroup' => [
        'Arn' => '<string>',
        'HierarchyPath' => [
            'LevelFive' => [
                'Arn' => '<string>',
                'Id' => '<string>',
                'Name' => '<string>',
            ],
            'LevelFour' => [
                'Arn' => '<string>',
                'Id' => '<string>',
                'Name' => '<string>',
            ],
            'LevelOne' => [
                'Arn' => '<string>',
                'Id' => '<string>',
                'Name' => '<string>',
            ],
            'LevelThree' => [
                'Arn' => '<string>',
                'Id' => '<string>',
                'Name' => '<string>',
            ],
            'LevelTwo' => [
                'Arn' => '<string>',
                'Id' => '<string>',
                'Name' => '<string>',
            ],
        ],
        'Id' => '<string>',
        'LevelId' => '<string>',
        'Name' => '<string>',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Members

HierarchyGroup

Type: HierarchyGroup structure

Information about the hierarchy group.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

DescribeUserHierarchyStructure

$result = $client->describeUserHierarchyStructure([/* ... */]);
$promise = $client->describeUserHierarchyStructureAsync([/* ... */]);

Describes the hierarchy structure of the specified Amazon Connect instance.

Parameter Syntax

$result = $client->describeUserHierarchyStructure([
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Result Syntax

[
    'HierarchyStructure' => [
        'LevelFive' => [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        'LevelFour' => [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        'LevelOne' => [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        'LevelThree' => [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        'LevelTwo' => [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
    ],
]

Result Details

Members

HierarchyStructure

Type: HierarchyStructure structure

Information about the hierarchy structure.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

DescribeVocabulary

$result = $client->describeVocabulary([/* ... */]);
$promise = $client->describeVocabularyAsync([/* ... */]);

Describes the specified vocabulary.

Parameter Syntax

$result = $client->describeVocabulary([
    'InstanceId' => '<string>', // REQUIRED
    'VocabularyId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

VocabularyId

Required: Yes
Type: string

The identifier of the custom vocabulary.

Result Syntax

[
    'Vocabulary' => [
        'Arn' => '<string>',
        'Content' => '<string>',
        'FailureReason' => '<string>',
        'Id' => '<string>',
        'LanguageCode' => 'ar-AE|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fr-CA|fr-FR|hi-IN|it-IT|ja-JP|ko-KR|pt-BR|pt-PT|zh-CN|en-NZ|en-ZA',
        'LastModifiedTime' => <DateTime>,
        'Name' => '<string>',
        'State' => 'CREATION_IN_PROGRESS|ACTIVE|CREATION_FAILED|DELETE_IN_PROGRESS',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Members

Vocabulary

Required: Yes
Type: Vocabulary structure

A list of specific words that you want Contact Lens for Amazon Connect to recognize in your audio input. They are generally domain-specific words and phrases, words that Contact Lens is not recognizing, or proper nouns.

Errors

InvalidRequestException:
The request is not valid.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
ThrottlingException:
The throttling limit has been exceeded.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

DisassociateApprovedOrigin

$result = $client->disassociateApprovedOrigin([/* ... */]);
$promise = $client->disassociateApprovedOriginAsync([/* ... */]);

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

Revokes access to integrated applications from Amazon Connect.

Parameter Syntax

$result = $client->disassociateApprovedOrigin([
    'InstanceId' => '<string>', // REQUIRED
    'Origin' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Origin

Required: Yes
Type: string

The domain URL of the integrated application.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ThrottlingException:
The throttling limit has been exceeded.

DisassociateBot

$result = $client->disassociateBot([/* ... */]);
$promise = $client->disassociateBotAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->disassociateBot([
    'InstanceId' => '<string>', // REQUIRED
    'LexBot' => [
        'LexRegion' => '<string>', // REQUIRED
        'Name' => '<string>', // REQUIRED
    ],
    'LexV2Bot' => [
        'AliasArn' => '<string>',
    ],
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

LexBot

Type: LexBot structure

Configuration information of an Amazon Lex bot.

LexV2Bot

Type: LexV2Bot structure

The Amazon Lex V2 bot to disassociate from the instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.
ThrottlingException:
The throttling limit has been exceeded.

DisassociateInstanceStorageConfig

$result = $client->disassociateInstanceStorageConfig([/* ... */]);
$promise = $client->disassociateInstanceStorageConfigAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->disassociateInstanceStorageConfig([
    'AssociationId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'ResourceType' => 'CHAT_TRANSCRIPTS|CALL_RECORDINGS|SCHEDULED_REPORTS|MEDIA_STREAMS|CONTACT_TRACE_RECORDS|AGENT_EVENTS|REAL_TIME_CONTACT_ANALYSIS_SEGMENTS|ATTACHMENTS|CONTACT_EVALUATIONS', // REQUIRED
]);

Parameter Details

Members

AssociationId

Required: Yes
Type: string

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

ResourceType

Required: Yes
Type: string

A valid resource type.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ThrottlingException:
The throttling limit has been exceeded.

DisassociateLambdaFunction

$result = $client->disassociateLambdaFunction([/* ... */]);
$promise = $client->disassociateLambdaFunctionAsync([/* ... */]);

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 flow blocks.

Parameter Syntax

$result = $client->disassociateLambdaFunction([
    'FunctionArn' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

FunctionArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Lambda function being disassociated.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance..

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ThrottlingException:
The throttling limit has been exceeded.

DisassociateLexBot

$result = $client->disassociateLexBot([/* ... */]);
$promise = $client->disassociateLexBotAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->disassociateLexBot([
    'BotName' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'LexRegion' => '<string>', // REQUIRED
]);

Parameter Details

Members

BotName

Required: Yes
Type: string

The name of the Amazon Lex bot. Maximum character limit of 50.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

LexRegion

Required: Yes
Type: string

The Amazon Web Services Region in which the Amazon Lex bot has been created.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ThrottlingException:
The throttling limit has been exceeded.

DisassociatePhoneNumberContactFlow

$result = $client->disassociatePhoneNumberContactFlow([/* ... */]);
$promise = $client->disassociatePhoneNumberContactFlowAsync([/* ... */]);

Removes the flow association from a phone number claimed to your Amazon Connect instance.

Parameter Syntax

$result = $client->disassociatePhoneNumberContactFlow([
    'InstanceId' => '<string>', // REQUIRED
    'PhoneNumberId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

PhoneNumberId

Required: Yes
Type: string

A unique identifier for the phone number.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

DisassociateQueueQuickConnects

$result = $client->disassociateQueueQuickConnects([/* ... */]);
$promise = $client->disassociateQueueQuickConnectsAsync([/* ... */]);

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

Disassociates a set of quick connects from a queue.

Parameter Syntax

$result = $client->disassociateQueueQuickConnects([
    'InstanceId' => '<string>', // REQUIRED
    'QueueId' => '<string>', // REQUIRED
    'QuickConnectIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

QueueId

Required: Yes
Type: string

The identifier for the queue.

QuickConnectIds

Required: Yes
Type: Array of strings

The quick connects to disassociate from the queue.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

DisassociateRoutingProfileQueues

$result = $client->disassociateRoutingProfileQueues([/* ... */]);
$promise = $client->disassociateRoutingProfileQueuesAsync([/* ... */]);

Disassociates a set of queues from a routing profile.

Parameter Syntax

$result = $client->disassociateRoutingProfileQueues([
    'InstanceId' => '<string>', // REQUIRED
    'QueueReferences' => [ // REQUIRED
        [
            'Channel' => 'VOICE|CHAT|TASK', // REQUIRED
            'QueueId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'RoutingProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

QueueReferences

Required: Yes
Type: Array of RoutingProfileQueueReference structures

The queues to disassociate from this routing profile.

RoutingProfileId

Required: Yes
Type: string

The identifier of the routing profile.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

DisassociateSecurityKey

$result = $client->disassociateSecurityKey([/* ... */]);
$promise = $client->disassociateSecurityKeyAsync([/* ... */]);

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

Deletes the specified security key.

Parameter Syntax

$result = $client->disassociateSecurityKey([
    'AssociationId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AssociationId

Required: Yes
Type: string

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ThrottlingException:
The throttling limit has been exceeded.

DismissUserContact

$result = $client->dismissUserContact([/* ... */]);
$promise = $client->dismissUserContactAsync([/* ... */]);

Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a MISSED, ERROR, ENDED, or REJECTED state in the Agent Event Stream.

Parameter Syntax

$result = $client->dismissUserContact([
    'ContactId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ContactId

Required: Yes
Type: string

The identifier of the contact.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

UserId

Required: Yes
Type: string

The identifier of the user account.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
AccessDeniedException:
You do not have sufficient permissions to perform this action.
InternalServiceException:
Request processing failed because of an error or failure with the service.

GetContactAttributes

$result = $client->getContactAttributes([/* ... */]);
$promise = $client->getContactAttributesAsync([/* ... */]);

Retrieves the contact attributes for the specified contact.

Parameter Syntax

$result = $client->getContactAttributes([
    'InitialContactId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InitialContactId

Required: Yes
Type: string

The identifier of the initial contact.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance.

Result Syntax

[
    'Attributes' => ['<string>', ...],
]

Result Details

Members

Attributes

Type: Associative array of custom strings keys (AttributeName) to strings

Information about the attributes.

Errors

InvalidRequestException:
The request is not valid.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.

GetCurrentMetricData

$result = $client->getCurrentMetricData([/* ... */]);
$promise = $client->getCurrentMetricDataAsync([/* ... */]);

Gets the real-time metric data from the specified Amazon Connect instance.

For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->getCurrentMetricData([
    'CurrentMetrics' => [ // REQUIRED
        [
            'Name' => 'AGENTS_ONLINE|AGENTS_AVAILABLE|AGENTS_ON_CALL|AGENTS_NON_PRODUCTIVE|AGENTS_AFTER_CONTACT_WORK|AGENTS_ERROR|AGENTS_STAFFED|CONTACTS_IN_QUEUE|OLDEST_CONTACT_AGE|CONTACTS_SCHEDULED|AGENTS_ON_CONTACT|SLOTS_ACTIVE|SLOTS_AVAILABLE',
            'Unit' => 'SECONDS|COUNT|PERCENT',
        ],
        // ...
    ],
    'Filters' => [ // REQUIRED
        'Channels' => ['<string>', ...],
        'Queues' => ['<string>', ...],
        'RoutingProfiles' => ['<string>', ...],
    ],
    'Groupings' => ['<string>', ...],
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SortCriteria' => [
        [
            'SortByMetric' => 'AGENTS_ONLINE|AGENTS_AVAILABLE|AGENTS_ON_CALL|AGENTS_NON_PRODUCTIVE|AGENTS_AFTER_CONTACT_WORK|AGENTS_ERROR|AGENTS_STAFFED|CONTACTS_IN_QUEUE|OLDEST_CONTACT_AGE|CONTACTS_SCHEDULED|AGENTS_ON_CONTACT|SLOTS_ACTIVE|SLOTS_AVAILABLE',
            'SortOrder' => 'ASCENDING|DESCENDING',
        ],
        // ...
    ],
]);

Parameter Details

Members

CurrentMetrics

Required: Yes
Type: Array of CurrentMetric structures

The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.

AGENTS_AFTER_CONTACT_WORK

Unit: COUNT

Name in real-time metrics report: ACW

AGENTS_AVAILABLE

Unit: COUNT

Name in real-time metrics report: Available

AGENTS_ERROR

Unit: COUNT

Name in real-time metrics report: Error

AGENTS_NON_PRODUCTIVE

Unit: COUNT

Name in real-time metrics report: NPT (Non-Productive Time)

AGENTS_ON_CALL

Unit: COUNT

Name in real-time metrics report: On contact

AGENTS_ON_CONTACT

Unit: COUNT

Name in real-time metrics report: On contact

AGENTS_ONLINE

Unit: COUNT

Name in real-time metrics report: Online

AGENTS_STAFFED

Unit: COUNT

Name in real-time metrics report: Staffed

CONTACTS_IN_QUEUE

Unit: COUNT

Name in real-time metrics report: In queue

CONTACTS_SCHEDULED

Unit: COUNT

Name in real-time metrics report: Scheduled

OLDEST_CONTACT_AGE

Unit: SECONDS

When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.

When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:

{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0 }

The actual OLDEST_CONTACT_AGE is 24 seconds.

Name in real-time metrics report: Oldest

SLOTS_ACTIVE

Unit: COUNT

Name in real-time metrics report: Active

SLOTS_AVAILABLE

Unit: COUNT

Name in real-time metrics report: Availability

Filters

Required: Yes
Type: Filters structure

The filters to apply to returned metrics. You can filter up to the following limits:

Queues: 100
Routing profiles: 100
Channels: 3 (VOICE, CHAT, and TASK channels are supported.)

Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource IDs and resource ARNs in the same request.

Currently tagging is only supported on the resources that are passed in the filter.

Groupings

Type: Array of strings

The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues.

If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK channels are supported.
If you group by ROUTING_PROFILE, you must include either a queue or routing profile filter. In addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED, CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE.
If no Grouping is included in the request, a summary of metrics is returned.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.

SortCriteria

Type: Array of CurrentMetricSortCriteria structures

The way to sort the resulting response based on metrics. You can enter one sort criteria. By default resources are sorted based on AGENTS_ONLINE, DESCENDING. The metric collection is sorted based on the input metrics.

Note the following:

Sorting on SLOTS_ACTIVE and SLOTS_AVAILABLE is not supported.

Result Syntax

[
    'ApproximateTotalCount' => <integer>,
    'DataSnapshotTime' => <DateTime>,
    'MetricResults' => [
        [
            'Collections' => [
                [
                    'Metric' => [
                        'Name' => 'AGENTS_ONLINE|AGENTS_AVAILABLE|AGENTS_ON_CALL|AGENTS_NON_PRODUCTIVE|AGENTS_AFTER_CONTACT_WORK|AGENTS_ERROR|AGENTS_STAFFED|CONTACTS_IN_QUEUE|OLDEST_CONTACT_AGE|CONTACTS_SCHEDULED|AGENTS_ON_CONTACT|SLOTS_ACTIVE|SLOTS_AVAILABLE',
                        'Unit' => 'SECONDS|COUNT|PERCENT',
                    ],
                    'Value' => <float>,
                ],
                // ...
            ],
            'Dimensions' => [
                'Channel' => 'VOICE|CHAT|TASK',
                'Queue' => [
                    'Arn' => '<string>',
                    'Id' => '<string>',
                ],
                'RoutingProfile' => [
                    'Arn' => '<string>',
                    'Id' => '<string>',
                ],
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

ApproximateTotalCount

Type: long (int|float)

The total count of the result, regardless of the current page size.

DataSnapshotTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the metrics were retrieved and cached for pagination.

MetricResults

Type: Array of CurrentMetricResult structures

Information about the real-time metrics.

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
InternalServiceException:
Request processing failed because of an error or failure with the service.
ThrottlingException:
The throttling limit has been exceeded.
ResourceNotFoundException:
The specified resource was not found.

GetCurrentUserData

$result = $client->getCurrentUserData([/* ... */]);
$promise = $client->getCurrentUserDataAsync([/* ... */]);

Gets the real-time active user data from the specified Amazon Connect instance.

Parameter Syntax

$result = $client->getCurrentUserData([
    'Filters' => [ // REQUIRED
        'Agents' => ['<string>', ...],
        'ContactFilter' => [
            'ContactStates' => ['<string>', ...],
        ],
        'Queues' => ['<string>', ...],
        'RoutingProfiles' => ['<string>', ...],
        'UserHierarchyGroups' => ['<string>', ...],
    ],
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

Required: Yes
Type: UserDataFilters structure

The filters to apply to returned user data. You can filter up to the following limits:

Queues: 100
Routing profiles: 100
Agents: 100
Contact states: 9
User hierarchy groups: 1

The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups.

Currently tagging is only supported on the resources that are passed in the filter.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'ApproximateTotalCount' => <integer>,
    'NextToken' => '<string>',
    'UserDataList' => [
        [
            'ActiveSlotsByChannel' => [<integer>, ...],
            'AvailableSlotsByChannel' => [<integer>, ...],
            'Contacts' => [
                [
                    'AgentContactState' => 'INCOMING|PENDING|CONNECTING|CONNECTED|CONNECTED_ONHOLD|MISSED|ERROR|ENDED|REJECTED',
                    'Channel' => 'VOICE|CHAT|TASK',
                    'ConnectedToAgentTimestamp' => <DateTime>,
                    'ContactId' => '<string>',
                    'InitiationMethod' => 'INBOUND|OUTBOUND|TRANSFER|QUEUE_TRANSFER|CALLBACK|API|DISCONNECT|MONITOR',
                    'Queue' => [
                        'Arn' => '<string>',
                        'Id' => '<string>',
                    ],
                    'StateStartTimestamp' => <DateTime>,
                ],
                // ...
            ],
            'HierarchyPath' => [
                'LevelFive' => [
                    'Arn' => '<string>',
                    'Id' => '<string>',
                ],
                'LevelFour' => [
                    'Arn' => '<string>',
                    'Id' => '<string>',
                ],
                'LevelOne' => [
                    'Arn' => '<string>',
                    'Id' => '<string>',
                ],
                'LevelThree' => [
                    'Arn' => '<string>',
                    'Id' => '<string>',
                ],
                'LevelTwo' => [
                    'Arn' => '<string>',
                    'Id' => '<string>',
                ],
            ],
            'MaxSlotsByChannel' => [<integer>, ...],
            'NextStatus' => '<string>',
            'RoutingProfile' => [
                'Arn' => '<string>',
                'Id' => '<string>',
            ],
            'Status' => [
                'StatusArn' => '<string>',
                'StatusName' => '<string>',
                'StatusStartTimestamp' => <DateTime>,
            ],
            'User' => [
                'Arn' => '<string>',
                'Id' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members

ApproximateTotalCount

Type: long (int|float)

The total count of the result, regardless of the current page size.

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

UserDataList

Type: Array of UserData structures

A list of the user data that is returned.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
InternalServiceException:
Request processing failed because of an error or failure with the service.
ThrottlingException:
The throttling limit has been exceeded.
ResourceNotFoundException:
The specified resource was not found.

GetFederationToken

$result = $client->getFederationToken([/* ... */]);
$promise = $client->getFederationTokenAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getFederationToken([
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Result Syntax

[
    'Credentials' => [
        'AccessToken' => '<string>',
        'AccessTokenExpiration' => <DateTime>,
        'RefreshToken' => '<string>',
        'RefreshTokenExpiration' => <DateTime>,
    ],
    'SignInUrl' => '<string>',
    'UserArn' => '<string>',
    'UserId' => '<string>',
]

Result Details

Members

Credentials

Type: Credentials structure

The credentials to use for federation.

SignInUrl

Type: string

The URL to sign into the user's instance.

UserArn

Type: string

The Amazon Resource Name (ARN) of the user.

UserId

Type: string

The identifier for the user.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
UserNotFoundException:
No user with the specified credentials was found in the Amazon Connect instance.
InternalServiceException:
Request processing failed because of an error or failure with the service.
DuplicateResourceException:
A resource with the specified name already exists.

GetMetricData

$result = $client->getMetricData([/* ... */]);
$promise = $client->getMetricDataAsync([/* ... */]);

Gets historical metric data from the specified Amazon Connect instance.

For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->getMetricData([
    'EndTime' => <integer || string || DateTime>, // REQUIRED
    'Filters' => [ // REQUIRED
        'Channels' => ['<string>', ...],
        'Queues' => ['<string>', ...],
        'RoutingProfiles' => ['<string>', ...],
    ],
    'Groupings' => ['<string>', ...],
    'HistoricalMetrics' => [ // REQUIRED
        [
            'Name' => 'CONTACTS_QUEUED|CONTACTS_HANDLED|CONTACTS_ABANDONED|CONTACTS_CONSULTED|CONTACTS_AGENT_HUNG_UP_FIRST|CONTACTS_HANDLED_INCOMING|CONTACTS_HANDLED_OUTBOUND|CONTACTS_HOLD_ABANDONS|CONTACTS_TRANSFERRED_IN|CONTACTS_TRANSFERRED_OUT|CONTACTS_TRANSFERRED_IN_FROM_QUEUE|CONTACTS_TRANSFERRED_OUT_FROM_QUEUE|CONTACTS_MISSED|CALLBACK_CONTACTS_HANDLED|API_CONTACTS_HANDLED|OCCUPANCY|HANDLE_TIME|AFTER_CONTACT_WORK_TIME|QUEUED_TIME|ABANDON_TIME|QUEUE_ANSWER_TIME|HOLD_TIME|INTERACTION_TIME|INTERACTION_AND_HOLD_TIME|SERVICE_LEVEL',
            'Statistic' => 'SUM|MAX|AVG',
            'Threshold' => [
                'Comparison' => 'LT',
                'ThresholdValue' => <float>,
            ],
            'Unit' => 'SECONDS|COUNT|PERCENT',
        ],
        // ...
    ],
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StartTime' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Members

EndTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.

The time range between the start and end time must be less than 24 hours.

Filters

Required: Yes
Type: Filters structure

The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.

To filter by Queues, enter the queue ID/ARN, not the name of the queue.

Groupings

Type: Array of strings

The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.

If no grouping is specified, a summary of metrics for all queues is returned.

HistoricalMetrics

Required: Yes
Type: Array of HistoricalMetric structures

The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).

ABANDON_TIME

Unit: SECONDS

Statistic: AVG

AFTER_CONTACT_WORK_TIME

Unit: SECONDS

Statistic: AVG

API_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CALLBACK_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_ABANDONED

Unit: COUNT

Statistic: SUM

CONTACTS_AGENT_HUNG_UP_FIRST

Unit: COUNT

Statistic: SUM

CONTACTS_CONSULTED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_INCOMING

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_OUTBOUND

Unit: COUNT

Statistic: SUM

CONTACTS_HOLD_ABANDONS

Unit: COUNT

Statistic: SUM

CONTACTS_MISSED

Unit: COUNT

Statistic: SUM

CONTACTS_QUEUED

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN_FROM_QUEUE

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

Unit: COUNT

Statistic: SUM

HANDLE_TIME

Unit: SECONDS

Statistic: AVG

HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_AND_HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_TIME

Unit: SECONDS

Statistic: AVG

OCCUPANCY

Unit: PERCENT

Statistic: AVG

QUEUE_ANSWER_TIME

Unit: SECONDS

Statistic: AVG

QUEUED_TIME

Unit: SECONDS

Statistic: MAX

SERVICE_LEVEL

You can include up to 20 SERVICE_LEVEL metrics in a request.

Unit: PERCENT

Statistic: AVG

Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

StartTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.

The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.

Result Syntax

[
    'MetricResults' => [
        [
            'Collections' => [
                [
                    'Metric' => [
                        'Name' => 'CONTACTS_QUEUED|CONTACTS_HANDLED|CONTACTS_ABANDONED|CONTACTS_CONSULTED|CONTACTS_AGENT_HUNG_UP_FIRST|CONTACTS_HANDLED_INCOMING|CONTACTS_HANDLED_OUTBOUND|CONTACTS_HOLD_ABANDONS|CONTACTS_TRANSFERRED_IN|CONTACTS_TRANSFERRED_OUT|CONTACTS_TRANSFERRED_IN_FROM_QUEUE|CONTACTS_TRANSFERRED_OUT_FROM_QUEUE|CONTACTS_MISSED|CALLBACK_CONTACTS_HANDLED|API_CONTACTS_HANDLED|OCCUPANCY|HANDLE_TIME|AFTER_CONTACT_WORK_TIME|QUEUED_TIME|ABANDON_TIME|QUEUE_ANSWER_TIME|HOLD_TIME|INTERACTION_TIME|INTERACTION_AND_HOLD_TIME|SERVICE_LEVEL',
                        'Statistic' => 'SUM|MAX|AVG',
                        'Threshold' => [
                            'Comparison' => 'LT',
                            'ThresholdValue' => <float>,
                        ],
                        'Unit' => 'SECONDS|COUNT|PERCENT',
                    ],
                    'Value' => <float>,
                ],
                // ...
            ],
            'Dimensions' => [
                'Channel' => 'VOICE|CHAT|TASK',
                'Queue' => [
                    'Arn' => '<string>',
                    'Id' => '<string>',
                ],
                'RoutingProfile' => [
                    'Arn' => '<string>',
                    'Id' => '<string>',
                ],
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

MetricResults

Type: Array of HistoricalMetricResult structures

Information about the historical metrics.

If no grouping is specified, a summary of metric data is returned.

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
InternalServiceException:
Request processing failed because of an error or failure with the service.
ThrottlingException:
The throttling limit has been exceeded.
ResourceNotFoundException:
The specified resource was not found.

GetMetricDataV2

$result = $client->getMetricDataV2([/* ... */]);
$promise = $client->getMetricDataV2Async([/* ... */]);

Gets metric data from the specified Amazon Connect instance.

GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for last the 14 days, in 24-hour intervals.

For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect Administrator's Guide.

This API is not available in the Amazon Web Services GovCloud (US) Regions.

Parameter Syntax

$result = $client->getMetricDataV2([
    'EndTime' => <integer || string || DateTime>, // REQUIRED
    'Filters' => [ // REQUIRED
        [
            'FilterKey' => '<string>',
            'FilterValues' => ['<string>', ...],
        ],
        // ...
    ],
    'Groupings' => ['<string>', ...],
    'MaxResults' => <integer>,
    'Metrics' => [ // REQUIRED
        [
            'MetricFilters' => [
                [
                    'MetricFilterKey' => '<string>',
                    'MetricFilterValues' => ['<string>', ...],
                ],
                // ...
            ],
            'Name' => '<string>',
            'Threshold' => [
                [
                    'Comparison' => '<string>',
                    'ThresholdValue' => <float>,
                ],
                // ...
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
    'StartTime' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Members

EndTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be later than the start time timestamp.

The time range between the start and end time must be less than 24 hours.

Filters

Required: Yes
Type: Array of FilterV2 structures

The filters to apply to returned metrics. You can filter on the following resources:

Queues
Routing profiles
Agents
Channels
User hierarchy groups

At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.

To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator's Guide.

Note the following limits:

Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE
Filter values: A maximum of 100 filter values are supported in a single request. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL filter key.

Groupings

Type: Array of strings

The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues.

If no grouping is specified, a summary of all metrics is returned.

MaxResults

Type: int

The maximum number of results to return per page.

Metrics

Required: Yes
Type: Array of MetricV2 structures

The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's Guide.

AGENT_ADHERENT_TIME

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AGENT_NON_RESPONSE

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AGENT_OCCUPANCY

Unit: Percentage

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

AGENT_SCHEDULE_ADHERENCE

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

Unit: Percent

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AGENT_SCHEDULED_TIME

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AVG_ABANDON_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AVG_AFTER_CONTACT_WORK_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AVG_AGENT_CONNECTING_TIME

Unit: Seconds

Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AVG_HANDLE_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AVG_HOLD_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AVG_INTERACTION_AND_HOLD_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AVG_INTERACTION_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile

AVG_QUEUE_ANSWER_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile

CONTACTS_ABANDONED

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

CONTACTS_CREATED

Unit: Count

Valid metric filter key: INITIATION_METHOD

Valid groupings and filters: Queue, Channel, Routing Profile

CONTACTS_HANDLED

Unit: Count

Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

CONTACTS_HOLD_ABANDONS

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

CONTACTS_QUEUED

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

CONTACTS_TRANSFERRED_OUT

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

CONTACTS_TRANSFERRED_OUT_BY_AGENT

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

MAX_QUEUED_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

SERVICE_LEVEL

You can include up to 20 SERVICE_LEVEL metrics in a request.

Unit: Percent

Valid groupings and filters: Queue, Channel, Routing Profile

Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").

SUM_CONTACTS_ANSWERED_IN_X

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile

SUM_CONTACTS_ABANDONED_IN_X

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile

SUM_CONTACTS_DISCONNECTED

Valid metric filter key: DISCONNECT_REASON

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile

SUM_RETRY_CALLBACK_ATTEMPTS

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

ResourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource. This includes the instanceId an Amazon Connect instance.

StartTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be before the end time timestamp. The time range between the start and end time must be less than 24 hours. The start time cannot be earlier than 14 days before the time of the request. Historical metrics are available for 14 days.

Result Syntax

[
    'MetricResults' => [
        [
            'Collections' => [
                [
                    'Metric' => [
                        'MetricFilters' => [
                            [
                                'MetricFilterKey' => '<string>',
                                'MetricFilterValues' => ['<string>', ...],
                            ],
                            // ...
                        ],
                        'Name' => '<string>',
                        'Threshold' => [
                            [
                                'Comparison' => '<string>',
                                'ThresholdValue' => <float>,
                            ],
                            // ...
                        ],
                    ],
                    'Value' => <float>,
                ],
                // ...
            ],
            'Dimensions' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

MetricResults

Type: Array of MetricResultV2 structures

Information about the metrics requested in the API request If no grouping is specified, a summary of metric data is returned.

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
InternalServiceException:
Request processing failed because of an error or failure with the service.
ThrottlingException:
The throttling limit has been exceeded.
ResourceNotFoundException:
The specified resource was not found.

GetTaskTemplate

$result = $client->getTaskTemplate([/* ... */]);
$promise = $client->getTaskTemplateAsync([/* ... */]);

Gets details about a specific task template in the specified Amazon Connect instance.

Parameter Syntax

$result = $client->getTaskTemplate([
    'InstanceId' => '<string>', // REQUIRED
    'SnapshotVersion' => '<string>',
    'TaskTemplateId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

SnapshotVersion

Type: string

The system generated version of a task template that is associated with a task, when the task is created.

TaskTemplateId

Required: Yes
Type: string

A unique identifier for the task template.

Result Syntax

[
    'Arn' => '<string>',
    'Constraints' => [
        'InvisibleFields' => [
            [
                'Id' => [
                    'Name' => '<string>',
                ],
            ],
            // ...
        ],
        'ReadOnlyFields' => [
            [
                'Id' => [
                    'Name' => '<string>',
                ],
            ],
            // ...
        ],
        'RequiredFields' => [
            [
                'Id' => [
                    'Name' => '<string>',
                ],
            ],
            // ...
        ],
    ],
    'ContactFlowId' => '<string>',
    'CreatedTime' => <DateTime>,
    'Defaults' => [
        'DefaultFieldValues' => [
            [
                'DefaultValue' => '<string>',
                'Id' => [
                    'Name' => '<string>',
                ],
            ],
            // ...
        ],
    ],
    'Description' => '<string>',
    'Fields' => [
        [
            'Description' => '<string>',
            'Id' => [
                'Name' => '<string>',
            ],
            'SingleSelectOptions' => ['<string>', ...],
            'Type' => 'NAME|DESCRIPTION|SCHEDULED_TIME|QUICK_CONNECT|URL|NUMBER|TEXT|TEXT_AREA|DATE_TIME|BOOLEAN|SINGLE_SELECT|EMAIL',
        ],
        // ...
    ],
    'Id' => '<string>',
    'InstanceId' => '<string>',
    'LastModifiedTime' => <DateTime>,
    'Name' => '<string>',
    'Status' => 'ACTIVE|INACTIVE',
    'Tags' => ['<string>', ...],
]

Result Details

Members

Arn

Required: Yes
Type: string

The Amazon Resource Name (ARN).

Constraints

Type: TaskTemplateConstraints structure

Constraints that are applicable to the fields listed.

ContactFlowId

Type: string

The identifier of the flow that runs by default when a task is created by referencing this template.

CreatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the task template was created.

Defaults

Type: TaskTemplateDefaults structure

The default values for fields when a task is created by referencing this template.

Description

Type: string

The description of the task template.

Fields

Type: Array of TaskTemplateField structures

Fields that are part of the template.

Id

Required: Yes
Type: string

A unique identifier for the task template.

InstanceId

Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

LastModifiedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the task template was last modified.

Name

Required: Yes
Type: string

The name of the task template.

Status

Type: string

Tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

GetTrafficDistribution

$result = $client->getTrafficDistribution([/* ... */]);
$promise = $client->getTrafficDistributionAsync([/* ... */]);

Retrieves the current traffic distribution for a given traffic distribution group.

Parameter Syntax

$result = $client->getTrafficDistribution([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The identifier of the traffic distribution group.

Result Syntax

[
    'Arn' => '<string>',
    'Id' => '<string>',
    'TelephonyConfig' => [
        'Distributions' => [
            [
                'Percentage' => <integer>,
                'Region' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the traffic distribution group.

Id

Type: string

TelephonyConfig

Type: TelephonyConfig structure

The distribution of traffic between the instance and its replicas.

Errors

InvalidRequestException:
The request is not valid.
AccessDeniedException:
You do not have sufficient permissions to perform this action.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
ThrottlingException:
The throttling limit has been exceeded.

ListAgentStatuses

$result = $client->listAgentStatuses([/* ... */]);
$promise = $client->listAgentStatusesAsync([/* ... */]);

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

Lists agent statuses.

Parameter Syntax

$result = $client->listAgentStatuses([
    'AgentStatusTypes' => ['<string>', ...],
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

AgentStatusTypes

Type: Array of strings

Available agent status types.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'AgentStatusSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
            'Type' => 'ROUTABLE|CUSTOM|OFFLINE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

AgentStatusSummaryList

Type: Array of AgentStatusSummary structures

A summary of agent statuses.

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

ListApprovedOrigins

$result = $client->listApprovedOrigins([/* ... */]);
$promise = $client->listApprovedOriginsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listApprovedOrigins([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'Origins' => ['<string>', ...],
]

Result Details

Members

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

Origins

Type: Array of strings

The approved origins.

Errors

ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ThrottlingException:
The throttling limit has been exceeded.

ListBots

$result = $client->listBots([/* ... */]);
$promise = $client->listBotsAsync([/* ... */]);

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. Use this API to returns both Amazon Lex V1 and V2 bots.

Parameter Syntax

$result = $client->listBots([
    'InstanceId' => '<string>', // REQUIRED
    'LexVersion' => 'V1|V2', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

LexVersion

Required: Yes
Type: string

The version of Amazon Lex or Amazon Lex V2.

MaxResults

Type: int

The maximum number of results to return per page.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'LexBots' => [
        [
            'LexBot' => [
                'LexRegion' => '<string>',
                'Name' => '<string>',
            ],
            'LexV2Bot' => [
                'AliasArn' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

LexBots

Type: Array of LexBotConfig structures

The names and Amazon Web Services Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified instance.

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

Errors

ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.
ThrottlingException:
The throttling limit has been exceeded.

ListContactFlowModules

$result = $client->listContactFlowModules([/* ... */]);
$promise = $client->listContactFlowModulesAsync([/* ... */]);

Provides information about the flow modules for the specified Amazon Connect instance.

Parameter Syntax

$result = $client->listContactFlowModules([
    'ContactFlowModuleState' => 'ACTIVE|ARCHIVED',
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

ContactFlowModuleState

Type: string

The state of the flow module.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'ContactFlowModulesSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
            'State' => 'ACTIVE|ARCHIVED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

ContactFlowModulesSummaryList

Type: Array of ContactFlowModuleSummary structures

Information about the flow module.

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

Errors

AccessDeniedException:
You do not have sufficient permissions to perform this action.
InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

ListContactFlows

$result = $client->listContactFlows([/* ... */]);
$promise = $client->listContactFlowsAsync([/* ... */]);

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

You can also create and update flows using the Amazon Connect Flow language.

For more information about flows, see Flows in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->listContactFlows([
    'ContactFlowTypes' => ['<string>', ...],
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

ContactFlowTypes

Type: Array of strings

The type of flow.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page. The default MaxResult size is 100.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'ContactFlowSummaryList' => [
        [
            'Arn' => '<string>',
            'ContactFlowState' => 'ACTIVE|ARCHIVED',
            'ContactFlowType' => 'CONTACT_FLOW|CUSTOMER_QUEUE|CUSTOMER_HOLD|CUSTOMER_WHISPER|AGENT_HOLD|AGENT_WHISPER|OUTBOUND_WHISPER|AGENT_TRANSFER|QUEUE_TRANSFER',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

ContactFlowSummaryList

Type: Array of ContactFlowSummary structures

Information about the flows.

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

ListContactReferences

$result = $client->listContactReferences([/* ... */]);
$promise = $client->listContactReferencesAsync([/* ... */]);

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

For the specified referenceTypes, returns a list of references associated with the contact.

Parameter Syntax

$result = $client->listContactReferences([
    'ContactId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'ReferenceTypes' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ContactId

Required: Yes
Type: string

The identifier of the initial contact.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

This is not expected to be set, because the value returned in the previous response is always null.

ReferenceTypes

Required: Yes
Type: Array of strings

The type of reference.

Result Syntax

[
    'NextToken' => '<string>',
    'ReferenceSummaryList' => [
        [
            'Attachment' => [
                'Name' => '<string>',
                'Status' => 'APPROVED|REJECTED',
                'Value' => '<string>',
            ],
            'Date' => [
                'Name' => '<string>',
                'Value' => '<string>',
            ],
            'Email' => [
                'Name' => '<string>',
                'Value' => '<string>',
            ],
            'Number' => [
                'Name' => '<string>',
                'Value' => '<string>',
            ],
            'String' => [
                'Name' => '<string>',
                'Value' => '<string>',
            ],
            'Url' => [
                'Name' => '<string>',
                'Value' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

This is always returned as null in the response.

ReferenceSummaryList

Type: Array of ReferenceSummary structures

Information about the flows.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
ThrottlingException:
The throttling limit has been exceeded.

ListDefaultVocabularies

$result = $client->listDefaultVocabularies([/* ... */]);
$promise = $client->listDefaultVocabulariesAsync([/* ... */]);

Lists the default vocabularies for the specified Amazon Connect instance.

Parameter Syntax

$result = $client->listDefaultVocabularies([
    'InstanceId' => '<string>', // REQUIRED
    'LanguageCode' => 'ar-AE|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fr-CA|fr-FR|hi-IN|it-IT|ja-JP|ko-KR|pt-BR|pt-PT|zh-CN|en-NZ|en-ZA',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

LanguageCode

Type: string

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

MaxResults

Type: int

The maximum number of results to return per page.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'DefaultVocabularyList' => [
        [
            'InstanceId' => '<string>',
            'LanguageCode' => 'ar-AE|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fr-CA|fr-FR|hi-IN|it-IT|ja-JP|ko-KR|pt-BR|pt-PT|zh-CN|en-NZ|en-ZA',
            'VocabularyId' => '<string>',
            'VocabularyName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

DefaultVocabularyList

Required: Yes
Type: Array of DefaultVocabulary structures

A list of default vocabularies.

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

Errors

InvalidRequestException:
The request is not valid.
InternalServiceException:
Request processing failed because of an error or failure with the service.
ThrottlingException:
The throttling limit has been exceeded.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

ListHoursOfOperations

$result = $client->listHoursOfOperations([/* ... */]);
$promise = $client->listHoursOfOperationsAsync([/* ... */]);

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 in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->listHoursOfOperations([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page. The default MaxResult size is 100.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'HoursOfOperationSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

HoursOfOperationSummaryList

Type: Array of HoursOfOperationSummary structures

Information about the hours of operation.

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

ListInstanceAttributes

$result = $client->listInstanceAttributes([/* ... */]);
$promise = $client->listInstanceAttributesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listInstanceAttributes([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'Attributes' => [
        [
            'AttributeType' => 'INBOUND_CALLS|OUTBOUND_CALLS|CONTACTFLOW_LOGS|CONTACT_LENS|AUTO_RESOLVE_BEST_VOICES|USE_CUSTOM_TTS_VOICES|EARLY_MEDIA|MULTI_PARTY_CONFERENCE|HIGH_VOLUME_OUTBOUND|ENHANCED_CONTACT_MONITORING',
            'Value' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Attributes

Type: Array of Attribute structures

The attribute types.

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

Errors

ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ThrottlingException:
The throttling limit has been exceeded.

ListInstanceStorageConfigs

$result = $client->listInstanceStorageConfigs([/* ... */]);
$promise = $client->listInstanceStorageConfigsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listInstanceStorageConfigs([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceType' => 'CHAT_TRANSCRIPTS|CALL_RECORDINGS|SCHEDULED_REPORTS|MEDIA_STREAMS|CONTACT_TRACE_RECORDS|AGENT_EVENTS|REAL_TIME_CONTACT_ANALYSIS_SEGMENTS|ATTACHMENTS|CONTACT_EVALUATIONS', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

ResourceType

Required: Yes
Type: string

A valid resource type.

Result Syntax

[
    'NextToken' => '<string>',
    'StorageConfigs' => [
        [
            'AssociationId' => '<string>',
            'KinesisFirehoseConfig' => [
                'FirehoseArn' => '<string>',
            ],
            'KinesisStreamConfig' => [
                'StreamArn' => '<string>',
            ],
            'KinesisVideoStreamConfig' => [
                'EncryptionConfig' => [
                    'EncryptionType' => 'KMS',
                    'KeyId' => '<string>',
                ],
                'Prefix' => '<string>',
                'RetentionPeriodHours' => <integer>,
            ],
            'S3Config' => [
                'BucketName' => '<string>',
                'BucketPrefix' => '<string>',
                'EncryptionConfig' => [
                    'EncryptionType' => 'KMS',
                    'KeyId' => '<string>',
                ],
            ],
            'StorageType' => 'S3|KINESIS_VIDEO_STREAM|KINESIS_STREAM|KINESIS_FIREHOSE',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

StorageConfigs

Type: Array of InstanceStorageConfig structures

A valid storage type.

Errors

ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ThrottlingException:
The throttling limit has been exceeded.

ListInstances

$result = $client->listInstances([/* ... */]);
$promise = $client->listInstancesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listInstances([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of results to return per page.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'InstanceSummaryList' => [
        [
            'Arn' => '<string>',
            'CreatedTime' => <DateTime>,
            'Id' => '<string>',
            'IdentityManagementType' => 'SAML|CONNECT_MANAGED|EXISTING_DIRECTORY',
            'InboundCallsEnabled' => true || false,
            'InstanceAlias' => '<string>',
            'InstanceStatus' => 'CREATION_IN_PROGRESS|ACTIVE|CREATION_FAILED',
            'OutboundCallsEnabled' => true || false,
            'ServiceRole' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

InstanceSummaryList

Type: Array of InstanceSummary structures

Information about the instances.

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

Errors

InvalidRequestException:
The request is not valid.
InternalServiceException:
Request processing failed because of an error or failure with the service.

ListIntegrationAssociations

$result = $client->listIntegrationAssociations([/* ... */]);
$promise = $client->listIntegrationAssociationsAsync([/* ... */]);

Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.

Parameter Syntax

$result = $client->listIntegrationAssociations([
    'InstanceId' => '<string>', // REQUIRED
    'IntegrationType' => 'EVENT|VOICE_ID|PINPOINT_APP|WISDOM_ASSISTANT|WISDOM_KNOWLEDGE_BASE|CASES_DOMAIN',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

IntegrationType

Type: string

The integration type.

MaxResults

Type: int

The maximum number of results to return per page.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'IntegrationAssociationSummaryList' => [
        [
            'InstanceId' => '<string>',
            'IntegrationArn' => '<string>',
            'IntegrationAssociationArn' => '<string>',
            'IntegrationAssociationId' => '<string>',
            'IntegrationType' => 'EVENT|VOICE_ID|PINPOINT_APP|WISDOM_ASSISTANT|WISDOM_KNOWLEDGE_BASE|CASES_DOMAIN',
            'SourceApplicationName' => '<string>',
            'SourceApplicationUrl' => '<string>',
            'SourceType' => 'SALESFORCE|ZENDESK',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

IntegrationAssociationSummaryList

Type: Array of IntegrationAssociationSummary structures

The associations.

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

Errors

ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.
ThrottlingException:
The throttling limit has been exceeded.

ListLambdaFunctions

$result = $client->listLambdaFunctions([/* ... */]);
$promise = $client->listLambdaFunctionsAsync([/* ... */]);

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 flow blocks.

Parameter Syntax

$result = $client->listLambdaFunctions([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'LambdaFunctions' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Members

LambdaFunctions

Type: Array of strings

The Lambdafunction ARNs associated with the specified instance.

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

Errors

ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ThrottlingException:
The throttling limit has been exceeded.

ListLexBots

$result = $client->listLexBots([/* ... */]);
$promise = $client->listLexBotsAsync([/* ... */]);

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

Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API.

Parameter Syntax

$result = $client->listLexBots([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page. If no value is specified, the default is 10.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'LexBots' => [
        [
            'LexRegion' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

LexBots

Type: Array of LexBot structures

The names and Amazon Web Services Regions of the Amazon Lex bots associated with the specified instance.

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

Errors

ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ThrottlingException:
The throttling limit has been exceeded.

ListPhoneNumbers

$result = $client->listPhoneNumbers([/* ... */]);
$promise = $client->listPhoneNumbersAsync([/* ... */]);

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 in the Amazon Connect Administrator Guide.

The phone number Arn value that is returned from each of the items in the PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with a ResourceNotFoundException. Instead, use the ListPhoneNumbersV2 API. It returns the new phone number ARN that can be used to tag phone number resources.

Parameter Syntax

$result = $client->listPhoneNumbers([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PhoneNumberCountryCodes' => ['<string>', ...],
    'PhoneNumberTypes' => ['<string>', ...],
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page. The default MaxResult size is 100.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

PhoneNumberCountryCodes

Type: Array of strings

The ISO country code.

PhoneNumberTypes

Type: Array of strings

The type of phone number.

Result Syntax

[
    'NextToken' => '<string>',
    'PhoneNumberSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'PhoneNumber' => '<string>',
            'PhoneNumberCountryCode' => 'AF|AL|DZ|AS|AD|AO|AI|AQ|AG|AR|AM|AW|AU|AT|AZ|BS|BH|BD|BB|BY|BE|BZ|BJ|BM|BT|BO|BA|BW|BR|IO|VG|BN|BG|BF|BI|KH|CM|CA|CV|KY|CF|TD|CL|CN|CX|CC|CO|KM|CK|CR|HR|CU|CW|CY|CZ|CD|DK|DJ|DM|DO|TL|EC|EG|SV|GQ|ER|EE|ET|FK|FO|FJ|FI|FR|PF|GA|GM|GE|DE|GH|GI|GR|GL|GD|GU|GT|GG|GN|GW|GY|HT|HN|HK|HU|IS|IN|ID|IR|IQ|IE|IM|IL|IT|CI|JM|JP|JE|JO|KZ|KE|KI|KW|KG|LA|LV|LB|LS|LR|LY|LI|LT|LU|MO|MK|MG|MW|MY|MV|ML|MT|MH|MR|MU|YT|MX|FM|MD|MC|MN|ME|MS|MA|MZ|MM|NA|NR|NP|NL|AN|NC|NZ|NI|NE|NG|NU|KP|MP|NO|OM|PK|PW|PA|PG|PY|PE|PH|PN|PL|PT|PR|QA|CG|RE|RO|RU|RW|BL|SH|KN|LC|MF|PM|VC|WS|SM|ST|SA|SN|RS|SC|SL|SG|SX|SK|SI|SB|SO|ZA|KR|ES|LK|SD|SR|SJ|SZ|SE|CH|SY|TW|TJ|TZ|TH|TG|TK|TO|TT|TN|TR|TM|TC|TV|VI|UG|UA|AE|GB|US|UY|UZ|VU|VA|VE|VN|WF|EH|YE|ZM|ZW',
            'PhoneNumberType' => 'TOLL_FREE|DID',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

PhoneNumberSummaryList

Type: Array of PhoneNumberSummary structures

Information about the phone numbers.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

ListPhoneNumbersV2

$result = $client->listPhoneNumbersV2([/* ... */]);
$promise = $client->listPhoneNumbersV2Async([/* ... */]);

Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group.

For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->listPhoneNumbersV2([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PhoneNumberCountryCodes' => ['<string>', ...],
    'PhoneNumberPrefix' => '<string>',
    'PhoneNumberTypes' => ['<string>', ...],
    'TargetArn' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of results to return per page.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

PhoneNumberCountryCodes

Type: Array of strings

The ISO country code.

PhoneNumberPrefix

Type: string

The prefix of the phone number. If provided, it must contain + as part of the country code.

PhoneNumberTypes

Type: Array of strings

The type of phone number.

TargetArn

Type: string

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to. If TargetArn input is not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same Amazon Web Services Region as the request.

Result Syntax

[
    'ListPhoneNumbersSummaryList' => [
        [
            'PhoneNumber' => '<string>',
            'PhoneNumberArn' => '<string>',
            'PhoneNumberCountryCode' => 'AF|AL|DZ|AS|AD|AO|AI|AQ|AG|AR|AM|AW|AU|AT|AZ|BS|BH|BD|BB|BY|BE|BZ|BJ|BM|BT|BO|BA|BW|BR|IO|VG|BN|BG|BF|BI|KH|CM|CA|CV|KY|CF|TD|CL|CN|CX|CC|CO|KM|CK|CR|HR|CU|CW|CY|CZ|CD|DK|DJ|DM|DO|TL|EC|EG|SV|GQ|ER|EE|ET|FK|FO|FJ|FI|FR|PF|GA|GM|GE|DE|GH|GI|GR|GL|GD|GU|GT|GG|GN|GW|GY|HT|HN|HK|HU|IS|IN|ID|IR|IQ|IE|IM|IL|IT|CI|JM|JP|JE|JO|KZ|KE|KI|KW|KG|LA|LV|LB|LS|LR|LY|LI|LT|LU|MO|MK|MG|MW|MY|MV|ML|MT|MH|MR|MU|YT|MX|FM|MD|MC|MN|ME|MS|MA|MZ|MM|NA|NR|NP|NL|AN|NC|NZ|NI|NE|NG|NU|KP|MP|NO|OM|PK|PW|PA|PG|PY|PE|PH|PN|PL|PT|PR|QA|CG|RE|RO|RU|RW|BL|SH|KN|LC|MF|PM|VC|WS|SM|ST|SA|SN|RS|SC|SL|SG|SX|SK|SI|SB|SO|ZA|KR|ES|LK|SD|SR|SJ|SZ|SE|CH|SY|TW|TJ|TZ|TH|TG|TK|TO|TT|TN|TR|TM|TC|TV|VI|UG|UA|AE|GB|US|UY|UZ|VU|VA|VE|VN|WF|EH|YE|ZM|ZW',
            'PhoneNumberId' => '<string>',
            'PhoneNumberType' => 'TOLL_FREE|DID',
            'TargetArn' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

ListPhoneNumbersSummaryList

Type: Array of ListPhoneNumbersSummary structures

Information about phone numbers that have been claimed to your Amazon Connect instances or traffic distribution groups.

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

Errors

InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

ListPrompts

$result = $client->listPrompts([/* ... */]);
$promise = $client->listPromptsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listPrompts([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance.

MaxResults

Type: int

The maximum number of results to return per page. The default MaxResult size is 100.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'PromptSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

PromptSummaryList

Type: Array of PromptSummary structures

Information about the prompts.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

ListQueueQuickConnects

$result = $client->listQueueQuickConnects([/* ... */]);
$promise = $client->listQueueQuickConnectsAsync([/* ... */]);

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

Lists the quick connects associated with a queue.

Parameter Syntax

$result = $client->listQueueQuickConnects([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'QueueId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page. The default MaxResult size is 100.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

QueueId

Required: Yes
Type: string

The identifier for the queue.

Result Syntax

[
    'NextToken' => '<string>',
    'QuickConnectSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
            'QuickConnectType' => 'USER|QUEUE|PHONE_NUMBER',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

QuickConnectSummaryList

Type: Array of QuickConnectSummary structures

Information about the quick connects.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

ListQueues

$result = $client->listQueues([/* ... */]);
$promise = $client->listQueuesAsync([/* ... */]);

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 in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->listQueues([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'QueueTypes' => ['<string>', ...],
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page. The default MaxResult size is 100.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

QueueTypes

Type: Array of strings

The type of queue.

Result Syntax

[
    'NextToken' => '<string>',
    'QueueSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
            'QueueType' => 'STANDARD|AGENT',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

QueueSummaryList

Type: Array of QueueSummary structures

Information about the queues.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

ListQuickConnects

$result = $client->listQuickConnects([/* ... */]);
$promise = $client->listQuickConnectsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listQuickConnects([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'QuickConnectTypes' => ['<string>', ...],
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page. The default MaxResult size is 100.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

QuickConnectTypes

Type: Array of strings

The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

Result Syntax

[
    'NextToken' => '<string>',
    'QuickConnectSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
            'QuickConnectType' => 'USER|QUEUE|PHONE_NUMBER',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

QuickConnectSummaryList

Type: Array of QuickConnectSummary structures

Information about the quick connects.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

ListRoutingProfileQueues

$result = $client->listRoutingProfileQueues([/* ... */]);
$promise = $client->listRoutingProfileQueuesAsync([/* ... */]);

Lists the queues associated with a routing profile.

Parameter Syntax

$result = $client->listRoutingProfileQueues([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RoutingProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page. The default MaxResult size is 100.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

RoutingProfileId

Required: Yes
Type: string

The identifier of the routing profile.

Result Syntax

[
    'NextToken' => '<string>',
    'RoutingProfileQueueConfigSummaryList' => [
        [
            'Channel' => 'VOICE|CHAT|TASK',
            'Delay' => <integer>,
            'Priority' => <integer>,
            'QueueArn' => '<string>',
            'QueueId' => '<string>',
            'QueueName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

RoutingProfileQueueConfigSummaryList

Type: Array of RoutingProfileQueueConfigSummary structures

Information about the routing profiles.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

ListRoutingProfiles

$result = $client->listRoutingProfiles([/* ... */]);
$promise = $client->listRoutingProfilesAsync([/* ... */]);

Provides summary information about the routing profiles for the specified Amazon Connect instance.

For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->listRoutingProfiles([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page. The default MaxResult size is 100.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'RoutingProfileSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

RoutingProfileSummaryList

Type: Array of RoutingProfileSummary structures

Information about the routing profiles.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

ListRules

$result = $client->listRules([/* ... */]);
$promise = $client->listRulesAsync([/* ... */]);

List all rules for the specified Amazon Connect instance.

Parameter Syntax

$result = $client->listRules([
    'EventSourceName' => 'OnPostCallAnalysisAvailable|OnRealTimeCallAnalysisAvailable|OnPostChatAnalysisAvailable|OnZendeskTicketCreate|OnZendeskTicketStatusUpdate|OnSalesforceCaseCreate',
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PublishStatus' => 'DRAFT|PUBLISHED',
]);

Parameter Details

Members

EventSourceName

Type: string

The name of the event source.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

PublishStatus

Type: string

The publish status of the rule.

Result Syntax

[
    'NextToken' => '<string>',
    'RuleSummaryList' => [
        [
            'ActionSummaries' => [
                [
                    'ActionType' => 'CREATE_TASK|ASSIGN_CONTACT_CATEGORY|GENERATE_EVENTBRIDGE_EVENT|SEND_NOTIFICATION',
                ],
                // ...
            ],
            'CreatedTime' => <DateTime>,
            'EventSourceName' => 'OnPostCallAnalysisAvailable|OnRealTimeCallAnalysisAvailable|OnPostChatAnalysisAvailable|OnZendeskTicketCreate|OnZendeskTicketStatusUpdate|OnSalesforceCaseCreate',
            'LastUpdatedTime' => <DateTime>,
            'Name' => '<string>',
            'PublishStatus' => 'DRAFT|PUBLISHED',
            'RuleArn' => '<string>',
            'RuleId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

RuleSummaryList

Required: Yes
Type: Array of RuleSummary structures

Summary information about a rule.

Errors

InvalidRequestException:
The request is not valid.
InternalServiceException:
Request processing failed because of an error or failure with the service.
ThrottlingException:
The throttling limit has been exceeded.
AccessDeniedException:
You do not have sufficient permissions to perform this action.
ResourceNotFoundException:
The specified resource was not found.

ListSecurityKeys

$result = $client->listSecurityKeys([/* ... */]);
$promise = $client->listSecurityKeysAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listSecurityKeys([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'SecurityKeys' => [
        [
            'AssociationId' => '<string>',
            'CreationTime' => <DateTime>,
            'Key' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

SecurityKeys

Type: Array of SecurityKey structures

The security keys.

Errors

ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ThrottlingException:
The throttling limit has been exceeded.

ListSecurityProfilePermissions

$result = $client->listSecurityProfilePermissions([/* ... */]);
$promise = $client->listSecurityProfilePermissionsAsync([/* ... */]);

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

Lists the permissions granted to a security profile.

Parameter Syntax

$result = $client->listSecurityProfilePermissions([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SecurityProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

SecurityProfileId

Required: Yes
Type: string

The identifier for the security profle.

Result Syntax

[
    'NextToken' => '<string>',
    'Permissions' => ['<string>', ...],
]

Result Details

Members

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

Permissions

Type: Array of strings

The permissions granted to the security profile. For a complete list of valid permissions, see List of security profile permissions.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

ListSecurityProfiles

$result = $client->listSecurityProfiles([/* ... */]);
$promise = $client->listSecurityProfilesAsync([/* ... */]);

Provides summary information about the security profiles for the specified Amazon Connect instance.

For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->listSecurityProfiles([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page. The default MaxResult size is 100.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'SecurityProfileSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

SecurityProfileSummaryList

Type: Array of SecurityProfileSummary structures

Information about the security profiles.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags for the specified resource.

For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

resourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource. All Amazon Connect resources (instances, queues, flows, routing profiles, etc) have an ARN. To locate the ARN for an instance, for example, see Find your Amazon Connect instance ID/ARN.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members

tags

Type: Associative array of custom strings keys (TagKey) to strings

Information about the tags.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
InternalServiceException:
Request processing failed because of an error or failure with the service.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.

ListTaskTemplates

$result = $client->listTaskTemplates([/* ... */]);
$promise = $client->listTaskTemplatesAsync([/* ... */]);

Lists task templates for the specified Amazon Connect instance.

Parameter Syntax

$result = $client->listTaskTemplates([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'Name' => '<string>',
    'NextToken' => '<string>',
    'Status' => 'ACTIVE|INACTIVE',
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page.

It is not expected that you set this.

Name

Type: string

The name of the task template.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

It is not expected that you set this because the value returned in the previous response is always null.

Status

Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'TaskTemplates' => [
        [
            'Arn' => '<string>',
            'CreatedTime' => <DateTime>,
            'Description' => '<string>',
            'Id' => '<string>',
            'LastModifiedTime' => <DateTime>,
            'Name' => '<string>',
            'Status' => 'ACTIVE|INACTIVE',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

This is always returned as a null in the response.

TaskTemplates

Type: Array of TaskTemplateMetadata structures

Provides details about a list of task templates belonging to an instance.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

ListTrafficDistributionGroups

$result = $client->listTrafficDistributionGroups([/* ... */]);
$promise = $client->listTrafficDistributionGroupsAsync([/* ... */]);

Lists traffic distribution groups.

Parameter Syntax

$result = $client->listTrafficDistributionGroups([
    'InstanceId' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

InstanceId

Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'TrafficDistributionGroupSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'InstanceArn' => '<string>',
            'Name' => '<string>',
            'Status' => 'CREATION_IN_PROGRESS|ACTIVE|CREATION_FAILED|PENDING_DELETION|DELETION_FAILED|UPDATE_IN_PROGRESS',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

TrafficDistributionGroupSummaryList

Type: Array of TrafficDistributionGroupSummary structures

A list of traffic distribution groups.

Errors

InvalidRequestException:
The request is not valid.
AccessDeniedException:
You do not have sufficient permissions to perform this action.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

ListUseCases

$result = $client->listUseCases([/* ... */]);
$promise = $client->listUseCasesAsync([/* ... */]);

Lists the use cases for the integration association.

Parameter Syntax

$result = $client->listUseCases([
    'InstanceId' => '<string>', // REQUIRED
    'IntegrationAssociationId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

IntegrationAssociationId

Required: Yes
Type: string

The identifier for the integration association.

MaxResults

Type: int

The maximum number of results to return per page.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'UseCaseSummaryList' => [
        [
            'UseCaseArn' => '<string>',
            'UseCaseId' => '<string>',
            'UseCaseType' => 'RULES_EVALUATION|CONNECT_CAMPAIGNS',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

UseCaseSummaryList

Type: Array of UseCase structures

The use cases.

Errors

ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
InvalidRequestException:
The request is not valid.
ThrottlingException:
The throttling limit has been exceeded.

ListUserHierarchyGroups

$result = $client->listUserHierarchyGroups([/* ... */]);
$promise = $client->listUserHierarchyGroupsAsync([/* ... */]);

Provides summary information about the hierarchy groups for the specified Amazon Connect instance.

For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->listUserHierarchyGroups([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page. The default MaxResult size is 100.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'UserHierarchyGroupSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

UserHierarchyGroupSummaryList

Type: Array of HierarchyGroupSummary structures

Information about the hierarchy groups.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

ListUsers

$result = $client->listUsers([/* ... */]);
$promise = $client->listUsersAsync([/* ... */]);

Provides summary information about the users for the specified Amazon Connect instance.

Parameter Syntax

$result = $client->listUsers([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page. The default MaxResult size is 100.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'UserSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Username' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

UserSummaryList

Type: Array of UserSummary structures

Information about the users.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

MonitorContact

$result = $client->monitorContact([/* ... */]);
$promise = $client->monitorContactAsync([/* ... */]);

Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact.

Parameter Syntax

$result = $client->monitorContact([
    'AllowedMonitorCapabilities' => ['<string>', ...],
    'ClientToken' => '<string>',
    'ContactId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AllowedMonitorCapabilities

Type: Array of strings

Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge.

ClientToken

Type: string

ContactId

Required: Yes
Type: string

The identifier of the contact.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

UserId

Required: Yes
Type: string

The identifier of the user account.

Result Syntax

[
    'ContactArn' => '<string>',
    'ContactId' => '<string>',
]

Result Details

Members

ContactArn

Type: string

The ARN of the contact.

ContactId

Type: string

The identifier of the contact.

Errors

InvalidRequestException:
The request is not valid.
IdempotencyException:
An entity with the same name already exists.
AccessDeniedException:
You do not have sufficient permissions to perform this action.
ResourceNotFoundException:
The specified resource was not found.
ServiceQuotaExceededException:
The service quota has been exceeded.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

PutUserStatus

$result = $client->putUserStatus([/* ... */]);
$promise = $client->putUserStatusAsync([/* ... */]);

Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent's next status.

For more information, see Agent status and Set your next status in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->putUserStatus([
    'AgentStatusId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AgentStatusId

Required: Yes
Type: string

The identifier of the agent status.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

UserId

Required: Yes
Type: string

The identifier of the user.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
AccessDeniedException:
You do not have sufficient permissions to perform this action.
InternalServiceException:
Request processing failed because of an error or failure with the service.

ReleasePhoneNumber

$result = $client->releasePhoneNumber([/* ... */]);
$promise = $client->releasePhoneNumberAsync([/* ... */]);

Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.

To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect console.

After releasing a phone number, the phone number enters into a cooldown period of 30 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.

Parameter Syntax

$result = $client->releasePhoneNumber([
    'ClientToken' => '<string>',
    'PhoneNumberId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ClientToken

Type: string

PhoneNumberId

Required: Yes
Type: string

A unique identifier for the phone number.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.
ResourceInUseException:
That resource is already in use. Please try another.
IdempotencyException:
An entity with the same name already exists.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

ReplicateInstance

$result = $client->replicateInstance([/* ... */]);
$promise = $client->replicateInstanceAsync([/* ... */]);

Replicates an Amazon Connect instance in the specified Amazon Web Services Region.

For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->replicateInstance([
    'ClientToken' => '<string>',
    'InstanceId' => '<string>', // REQUIRED
    'ReplicaAlias' => '<string>', // REQUIRED
    'ReplicaRegion' => '<string>', // REQUIRED
]);

Parameter Details

Members

ClientToken

Type: string

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You can provide the InstanceId, or the entire ARN.

ReplicaAlias

Required: Yes
Type: string

The alias for the replicated instance. The ReplicaAlias must be unique.

ReplicaRegion

Required: Yes
Type: string

The Amazon Web Services Region where to replicate the Amazon Connect instance.

Result Syntax

[
    'Arn' => '<string>',
    'Id' => '<string>',
]

Result Details

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the replicated instance.

Id

Type: string

The identifier of the replicated instance. You can find the instanceId in the ARN of the instance. The replicated instance has the same identifier as the instance it was replicated from.

Errors

InvalidRequestException:
The request is not valid.
AccessDeniedException:
You do not have sufficient permissions to perform this action.
ServiceQuotaExceededException:
The service quota has been exceeded.
ThrottlingException:
The throttling limit has been exceeded.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
ResourceNotReadyException:
The resource is not ready.
ResourceConflictException:
A resource already has that name.

ResumeContactRecording

$result = $client->resumeContactRecording([/* ... */]);
$promise = $client->resumeContactRecordingAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->resumeContactRecording([
    'ContactId' => '<string>', // REQUIRED
    'InitialContactId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ContactId

Required: Yes
Type: string

The identifier of the contact.

InitialContactId

Required: Yes
Type: string

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.

SearchAvailablePhoneNumbers

$result = $client->searchAvailablePhoneNumbers([/* ... */]);
$promise = $client->searchAvailablePhoneNumbersAsync([/* ... */]);

Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group.

Parameter Syntax

$result = $client->searchAvailablePhoneNumbers([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PhoneNumberCountryCode' => 'AF|AL|DZ|AS|AD|AO|AI|AQ|AG|AR|AM|AW|AU|AT|AZ|BS|BH|BD|BB|BY|BE|BZ|BJ|BM|BT|BO|BA|BW|BR|IO|VG|BN|BG|BF|BI|KH|CM|CA|CV|KY|CF|TD|CL|CN|CX|CC|CO|KM|CK|CR|HR|CU|CW|CY|CZ|CD|DK|DJ|DM|DO|TL|EC|EG|SV|GQ|ER|EE|ET|FK|FO|FJ|FI|FR|PF|GA|GM|GE|DE|GH|GI|GR|GL|GD|GU|GT|GG|GN|GW|GY|HT|HN|HK|HU|IS|IN|ID|IR|IQ|IE|IM|IL|IT|CI|JM|JP|JE|JO|KZ|KE|KI|KW|KG|LA|LV|LB|LS|LR|LY|LI|LT|LU|MO|MK|MG|MW|MY|MV|ML|MT|MH|MR|MU|YT|MX|FM|MD|MC|MN|ME|MS|MA|MZ|MM|NA|NR|NP|NL|AN|NC|NZ|NI|NE|NG|NU|KP|MP|NO|OM|PK|PW|PA|PG|PY|PE|PH|PN|PL|PT|PR|QA|CG|RE|RO|RU|RW|BL|SH|KN|LC|MF|PM|VC|WS|SM|ST|SA|SN|RS|SC|SL|SG|SX|SK|SI|SB|SO|ZA|KR|ES|LK|SD|SR|SJ|SZ|SE|CH|SY|TW|TJ|TZ|TH|TG|TK|TO|TT|TN|TR|TM|TC|TV|VI|UG|UA|AE|GB|US|UY|UZ|VU|VA|VE|VN|WF|EH|YE|ZM|ZW', // REQUIRED
    'PhoneNumberPrefix' => '<string>',
    'PhoneNumberType' => 'TOLL_FREE|DID', // REQUIRED
    'TargetArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of results to return per page.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

PhoneNumberCountryCode

Required: Yes
Type: string

The ISO country code.

PhoneNumberPrefix

Type: string

The prefix of the phone number. If provided, it must contain + as part of the country code.

PhoneNumberType

Required: Yes
Type: string

The type of phone number.

TargetArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

Result Syntax

[
    'AvailableNumbersList' => [
        [
            'PhoneNumber' => '<string>',
            'PhoneNumberCountryCode' => 'AF|AL|DZ|AS|AD|AO|AI|AQ|AG|AR|AM|AW|AU|AT|AZ|BS|BH|BD|BB|BY|BE|BZ|BJ|BM|BT|BO|BA|BW|BR|IO|VG|BN|BG|BF|BI|KH|CM|CA|CV|KY|CF|TD|CL|CN|CX|CC|CO|KM|CK|CR|HR|CU|CW|CY|CZ|CD|DK|DJ|DM|DO|TL|EC|EG|SV|GQ|ER|EE|ET|FK|FO|FJ|FI|FR|PF|GA|GM|GE|DE|GH|GI|GR|GL|GD|GU|GT|GG|GN|GW|GY|HT|HN|HK|HU|IS|IN|ID|IR|IQ|IE|IM|IL|IT|CI|JM|JP|JE|JO|KZ|KE|KI|KW|KG|LA|LV|LB|LS|LR|LY|LI|LT|LU|MO|MK|MG|MW|MY|MV|ML|MT|MH|MR|MU|YT|MX|FM|MD|MC|MN|ME|MS|MA|MZ|MM|NA|NR|NP|NL|AN|NC|NZ|NI|NE|NG|NU|KP|MP|NO|OM|PK|PW|PA|PG|PY|PE|PH|PN|PL|PT|PR|QA|CG|RE|RO|RU|RW|BL|SH|KN|LC|MF|PM|VC|WS|SM|ST|SA|SN|RS|SC|SL|SG|SX|SK|SI|SB|SO|ZA|KR|ES|LK|SD|SR|SJ|SZ|SE|CH|SY|TW|TJ|TZ|TH|TG|TK|TO|TT|TN|TR|TM|TC|TV|VI|UG|UA|AE|GB|US|UY|UZ|VU|VA|VE|VN|WF|EH|YE|ZM|ZW',
            'PhoneNumberType' => 'TOLL_FREE|DID',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

AvailableNumbersList

Type: Array of AvailableNumberSummary structures

A list of available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

Errors

InvalidParameterException:
One or more of the specified parameters are not valid.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

SearchQueues

$result = $client->searchQueues([/* ... */]);
$promise = $client->searchQueuesAsync([/* ... */]);

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

Searches queues in an Amazon Connect instance, with optional filtering.

Parameter Syntax

$result = $client->searchQueues([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SearchCriteria' => [
        'AndConditions' => [
            [...], // RECURSIVE
            // ...
        ],
        'OrConditions' => [
            [...], // RECURSIVE
            // ...
        ],
        'QueueTypeCondition' => 'STANDARD',
        'StringCondition' => [
            'ComparisonType' => 'STARTS_WITH|CONTAINS|EXACT',
            'FieldName' => '<string>',
            'Value' => '<string>',
        ],
    ],
    'SearchFilter' => [
        'TagFilter' => [
            'AndConditions' => [
                [
                    'TagKey' => '<string>',
                    'TagValue' => '<string>',
                ],
                // ...
            ],
            'OrConditions' => [
                [
                    [
                        'TagKey' => '<string>',
                        'TagValue' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'TagCondition' => [
                'TagKey' => '<string>',
                'TagValue' => '<string>',
            ],
        ],
    ],
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

SearchCriteria

Type: QueueSearchCriteria structure

The search criteria to be used to return queues.

The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

SearchFilter

Type: QueueSearchFilter structure

Filters to be applied to search results.

Result Syntax

[
    'ApproximateTotalCount' => <integer>,
    'NextToken' => '<string>',
    'Queues' => [
        [
            'Description' => '<string>',
            'HoursOfOperationId' => '<string>',
            'MaxContacts' => <integer>,
            'Name' => '<string>',
            'OutboundCallerConfig' => [
                'OutboundCallerIdName' => '<string>',
                'OutboundCallerIdNumberId' => '<string>',
                'OutboundFlowId' => '<string>',
            ],
            'QueueArn' => '<string>',
            'QueueId' => '<string>',
            'Status' => 'ENABLED|DISABLED',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members

ApproximateTotalCount

Type: long (int|float)

The total number of queues which matched your search query.

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

Queues

Type: Array of Queue structures

Information about the queues.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

SearchRoutingProfiles

$result = $client->searchRoutingProfiles([/* ... */]);
$promise = $client->searchRoutingProfilesAsync([/* ... */]);

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

Searches routing profiles in an Amazon Connect instance, with optional filtering.

Parameter Syntax

$result = $client->searchRoutingProfiles([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SearchCriteria' => [
        'AndConditions' => [
            [...], // RECURSIVE
            // ...
        ],
        'OrConditions' => [
            [...], // RECURSIVE
            // ...
        ],
        'StringCondition' => [
            'ComparisonType' => 'STARTS_WITH|CONTAINS|EXACT',
            'FieldName' => '<string>',
            'Value' => '<string>',
        ],
    ],
    'SearchFilter' => [
        'TagFilter' => [
            'AndConditions' => [
                [
                    'TagKey' => '<string>',
                    'TagValue' => '<string>',
                ],
                // ...
            ],
            'OrConditions' => [
                [
                    [
                        'TagKey' => '<string>',
                        'TagValue' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'TagCondition' => [
                'TagKey' => '<string>',
                'TagValue' => '<string>',
            ],
        ],
    ],
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

SearchCriteria

Type: RoutingProfileSearchCriteria structure

The search criteria to be used to return routing profiles.

SearchFilter

Type: RoutingProfileSearchFilter structure

Filters to be applied to search results.

Result Syntax

[
    'ApproximateTotalCount' => <integer>,
    'NextToken' => '<string>',
    'RoutingProfiles' => [
        [
            'DefaultOutboundQueueId' => '<string>',
            'Description' => '<string>',
            'InstanceId' => '<string>',
            'MediaConcurrencies' => [
                [
                    'Channel' => 'VOICE|CHAT|TASK',
                    'Concurrency' => <integer>,
                ],
                // ...
            ],
            'Name' => '<string>',
            'NumberOfAssociatedQueues' => <integer>,
            'NumberOfAssociatedUsers' => <integer>,
            'RoutingProfileArn' => '<string>',
            'RoutingProfileId' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members

ApproximateTotalCount

Type: long (int|float)

The total number of routing profiles which matched your search query.

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

RoutingProfiles

Type: Array of RoutingProfile structures

Information about the routing profiles.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

SearchSecurityProfiles

$result = $client->searchSecurityProfiles([/* ... */]);
$promise = $client->searchSecurityProfilesAsync([/* ... */]);

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

Searches security profiles in an Amazon Connect instance, with optional filtering.

Parameter Syntax

$result = $client->searchSecurityProfiles([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SearchCriteria' => [
        'AndConditions' => [
            [...], // RECURSIVE
            // ...
        ],
        'OrConditions' => [
            [...], // RECURSIVE
            // ...
        ],
        'StringCondition' => [
            'ComparisonType' => 'STARTS_WITH|CONTAINS|EXACT',
            'FieldName' => '<string>',
            'Value' => '<string>',
        ],
    ],
    'SearchFilter' => [
        'TagFilter' => [
            'AndConditions' => [
                [
                    'TagKey' => '<string>',
                    'TagValue' => '<string>',
                ],
                // ...
            ],
            'OrConditions' => [
                [
                    [
                        'TagKey' => '<string>',
                        'TagValue' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'TagCondition' => [
                'TagKey' => '<string>',
                'TagValue' => '<string>',
            ],
        ],
    ],
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

SearchCriteria

Type: SecurityProfileSearchCriteria structure

The search criteria to be used to return security profiles.

The name field support "contains" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

The currently supported value for FieldName: name

SearchFilter

Type: SecurityProfilesSearchFilter structure

Filters to be applied to search results.

Result Syntax

[
    'ApproximateTotalCount' => <integer>,
    'NextToken' => '<string>',
    'SecurityProfiles' => [
        [
            'Arn' => '<string>',
            'Description' => '<string>',
            'Id' => '<string>',
            'OrganizationResourceId' => '<string>',
            'SecurityProfileName' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members

ApproximateTotalCount

Type: long (int|float)

The total number of security profiles which matched your search query.

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

SecurityProfiles

Type: Array of SecurityProfileSearchSummary structures

Information about the security profiles.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

SearchUsers

$result = $client->searchUsers([/* ... */]);
$promise = $client->searchUsersAsync([/* ... */]);

Searches users in an Amazon Connect instance, with optional filtering.

AfterContactWorkTimeLimit is returned in milliseconds.

Parameter Syntax

$result = $client->searchUsers([
    'InstanceId' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SearchCriteria' => [
        'AndConditions' => [
            [...], // RECURSIVE
            // ...
        ],
        'HierarchyGroupCondition' => [
            'HierarchyGroupMatchType' => 'EXACT|WITH_CHILD_GROUPS',
            'Value' => '<string>',
        ],
        'OrConditions' => [
            [...], // RECURSIVE
            // ...
        ],
        'StringCondition' => [
            'ComparisonType' => 'STARTS_WITH|CONTAINS|EXACT',
            'FieldName' => '<string>',
            'Value' => '<string>',
        ],
    ],
    'SearchFilter' => [
        'TagFilter' => [
            'AndConditions' => [
                [
                    'TagKey' => '<string>',
                    'TagValue' => '<string>',
                ],
                // ...
            ],
            'OrConditions' => [
                [
                    [
                        'TagKey' => '<string>',
                        'TagValue' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'TagCondition' => [
                'TagKey' => '<string>',
                'TagValue' => '<string>',
            ],
        ],
    ],
]);

Parameter Details

Members

InstanceId

Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

Type: int

The maximum number of results to return per page.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

SearchCriteria

Type: UserSearchCriteria structure

The search criteria to be used to return users.

SearchFilter

Type: UserSearchFilter structure

Filters to be applied to search results.

Result Syntax

[
    'ApproximateTotalCount' => <integer>,
    'NextToken' => '<string>',
    'Users' => [
        [
            'Arn' => '<string>',
            'DirectoryUserId' => '<string>',
            'HierarchyGroupId' => '<string>',
            'Id' => '<string>',
            'IdentityInfo' => [
                'FirstName' => '<string>',
                'LastName' => '<string>',
            ],
            'PhoneConfig' => [
                'AfterContactWorkTimeLimit' => <integer>,
                'AutoAccept' => true || false,
                'DeskPhoneNumber' => '<string>',
                'PhoneType' => 'SOFT_PHONE|DESK_PHONE',
            ],
            'RoutingProfileId' => '<string>',
            'SecurityProfileIds' => ['<string>', ...],
            'Tags' => ['<string>', ...],
            'Username' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

ApproximateTotalCount

Type: long (int|float)

The total number of users who matched your search query.

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

Users

Type: Array of UserSearchSummary structures

Information about the users.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

SearchVocabularies

$result = $client->searchVocabularies([/* ... */]);
$promise = $client->searchVocabulariesAsync([/* ... */]);

Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.

Parameter Syntax

$result = $client->searchVocabularies([
    'InstanceId' => '<string>', // REQUIRED
    'LanguageCode' => 'ar-AE|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fr-CA|fr-FR|hi-IN|it-IT|ja-JP|ko-KR|pt-BR|pt-PT|zh-CN|en-NZ|en-ZA',
    'MaxResults' => <integer>,
    'NameStartsWith' => '<string>',
    'NextToken' => '<string>',
    'State' => 'CREATION_IN_PROGRESS|ACTIVE|CREATION_FAILED|DELETE_IN_PROGRESS',
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

LanguageCode

Type: string

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

MaxResults

Type: int

The maximum number of results to return per page.

NameStartsWith

Type: string

The starting pattern of the name of the vocabulary.

NextToken

Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

State

Type: string

The current state of the custom vocabulary.

Result Syntax

[
    'NextToken' => '<string>',
    'VocabularySummaryList' => [
        [
            'Arn' => '<string>',
            'FailureReason' => '<string>',
            'Id' => '<string>',
            'LanguageCode' => 'ar-AE|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fr-CA|fr-FR|hi-IN|it-IT|ja-JP|ko-KR|pt-BR|pt-PT|zh-CN|en-NZ|en-ZA',
            'LastModifiedTime' => <DateTime>,
            'Name' => '<string>',
            'State' => 'CREATION_IN_PROGRESS|ACTIVE|CREATION_FAILED|DELETE_IN_PROGRESS',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

If there are additional results, this is the token for the next set of results.

VocabularySummaryList

Type: Array of VocabularySummary structures

The list of the available custom vocabularies.

Errors

InvalidRequestException:
The request is not valid.
InternalServiceException:
Request processing failed because of an error or failure with the service.
ThrottlingException:
The throttling limit has been exceeded.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

StartChatContact

$result = $client->startChatContact([/* ... */]);
$promise = $client->startChatContactAsync([/* ... */]);

Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection 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 with WEBSOCKET and CONNECTION_CREDENTIALS.

A 429 error occurs in the following situations:

API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception.
The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException.

If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.

For more information about chat, see Chat in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->startChatContact([
    'Attributes' => ['<string>', ...],
    'ChatDurationInMinutes' => <integer>,
    'ClientToken' => '<string>',
    'ContactFlowId' => '<string>', // REQUIRED
    'InitialMessage' => [
        'Content' => '<string>', // REQUIRED
        'ContentType' => '<string>', // REQUIRED
    ],
    'InstanceId' => '<string>', // REQUIRED
    'ParticipantDetails' => [ // REQUIRED
        'DisplayName' => '<string>', // REQUIRED
    ],
    'PersistentChat' => [
        'RehydrationType' => 'ENTIRE_PAST_SESSION|FROM_SEGMENT',
        'SourceContactId' => '<string>',
    ],
    'SupportedMessagingContentTypes' => ['<string>', ...],
]);

Parameter Details

Members

Attributes

Type: Associative array of custom strings keys (AttributeName) to strings

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

ChatDurationInMinutes

Type: int

The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minumum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).

ClientToken

Type: string

ContactFlowId

Required: Yes
Type: string

The identifier of the flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

InitialMessage

Type: ChatMessage structure

The initial message to be sent to the newly created chat.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

ParticipantDetails

Required: Yes
Type: ParticipantDetails structure

Information identifying the participant.

PersistentChat

Type: PersistentChat structure

Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat.

SupportedMessagingContentTypes

Type: Array of strings

The supported chat message content types. Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain: [text/plain, text/markdown, application/json], [text/markdown, text/plain], [text/plain, application/json].

Result Syntax

[
    'ContactId' => '<string>',
    'ContinuedFromContactId' => '<string>',
    'ParticipantId' => '<string>',
    'ParticipantToken' => '<string>',
]

Result Details

Members

ContactId

Type: string

The identifier of this contact within the Amazon Connect instance.

ContinuedFromContactId

Type: string

The contactId from which a persistent chat session is started. This field is populated only for persistent chats.

ParticipantId

Type: string

The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.

ParticipantToken

Type: string

The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
LimitExceededException:
The allowed limit for the resource has been exceeded.

StartContactRecording

$result = $client->startContactRecording([/* ... */]);
$promise = $client->startContactRecordingAsync([/* ... */]);

Starts recording the contact:

If the API is called before the agent joins the call, recording starts when the agent joins the call.
If the API is called after the agent joins the call, recording starts at the time of the API 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 block.

Only voice recordings are supported at this time.

Parameter Syntax

$result = $client->startContactRecording([
    'ContactId' => '<string>', // REQUIRED
    'InitialContactId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'VoiceRecordingConfiguration' => [ // REQUIRED
        'VoiceRecordingTrack' => 'FROM_AGENT|TO_AGENT|ALL',
    ],
]);

Parameter Details

Members

ContactId

Required: Yes
Type: string

The identifier of the contact.

InitialContactId

Required: Yes
Type: string

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

VoiceRecordingConfiguration

Required: Yes
Type: VoiceRecordingConfiguration structure

The person being recorded.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.

StartContactStreaming

$result = $client->startContactStreaming([/* ... */]);
$promise = $client->startContactStreamingAsync([/* ... */]);

Initiates real-time message streaming for a new chat contact.

For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->startContactStreaming([
    'ChatStreamingConfiguration' => [ // REQUIRED
        'StreamingEndpointArn' => '<string>', // REQUIRED
    ],
    'ClientToken' => '<string>', // REQUIRED
    'ContactId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ChatStreamingConfiguration

Required: Yes
Type: ChatStreamingConfiguration structure

The streaming configuration, such as the Amazon SNS streaming endpoint.

ClientToken

Required: Yes
Type: string

ContactId

Required: Yes
Type: string

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Result Syntax

[
    'StreamingId' => '<string>',
]

Result Details

Members

StreamingId

Required: Yes
Type: string

The identifier of the streaming configuration enabled.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
LimitExceededException:
The allowed limit for the resource has been exceeded.

StartOutboundVoiceContact

$result = $client->startOutboundVoiceContact([/* ... */]);
$promise = $client->startOutboundVoiceContactAsync([/* ... */]);

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

Agents do not initiate the outbound API, which means that they do not dial the contact. If the 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 in the Amazon Connect Administrator Guide.

Campaign calls are not allowed by default. Before you can make a call with TrafficType = CAMPAIGN, you must submit a service quota increase request to the quota Amazon Connect campaigns.

Parameter Syntax

$result = $client->startOutboundVoiceContact([
    'AnswerMachineDetectionConfig' => [
        'AwaitAnswerMachinePrompt' => true || false,
        'EnableAnswerMachineDetection' => true || false,
    ],
    'Attributes' => ['<string>', ...],
    'CampaignId' => '<string>',
    'ClientToken' => '<string>',
    'ContactFlowId' => '<string>', // REQUIRED
    'DestinationPhoneNumber' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'QueueId' => '<string>',
    'SourcePhoneNumber' => '<string>',
    'TrafficType' => 'GENERAL|CAMPAIGN',
]);

Parameter Details

Members

AnswerMachineDetectionConfig

Type: AnswerMachineDetectionConfig structure

Configuration of the answering machine detection for this outbound call.

Attributes

Type: Associative array of custom strings keys (AttributeName) to strings

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

CampaignId

Type: string

The campaign identifier of the outbound communication.

ClientToken

Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

ContactFlowId

Required: Yes
Type: string

The identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

DestinationPhoneNumber

Required: Yes
Type: string

The phone number of the customer, in E.164 format.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

QueueId

Type: string

The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the flow is used. If you do not specify a queue, you must specify a source phone number.

SourcePhoneNumber

Type: string

The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.

TrafficType

Type: string

Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The default value is GENERAL. Use CAMPAIGN if EnableAnswerMachineDetection is set to true. For all other cases, use GENERAL.

Result Syntax

[
    'ContactId' => '<string>',
]

Result Details

Members

ContactId

Type: string

The identifier of this contact within the Amazon Connect instance.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
LimitExceededException:
The allowed limit for the resource has been exceeded.
DestinationNotAllowedException:
Outbound calls to the destination number are not allowed.
OutboundContactNotPermittedException:
The contact is not permitted.

StartTaskContact

$result = $client->startTaskContact([/* ... */]);
$promise = $client->startTaskContactAsync([/* ... */]);

Initiates a flow to start a new task.

Parameter Syntax

$result = $client->startTaskContact([
    'Attributes' => ['<string>', ...],
    'ClientToken' => '<string>',
    'ContactFlowId' => '<string>',
    'Description' => '<string>',
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'PreviousContactId' => '<string>',
    'QuickConnectId' => '<string>',
    'References' => [
        '<ReferenceKey>' => [
            'Type' => 'URL|ATTACHMENT|NUMBER|STRING|DATE|EMAIL', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'RelatedContactId' => '<string>',
    'ScheduledTime' => <integer || string || DateTime>,
    'TaskTemplateId' => '<string>',
]);

Parameter Details

Members

Attributes

Type: Associative array of custom strings keys (AttributeName) to strings

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

ClientToken

Type: string

ContactFlowId

Type: string

The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

Description

Type: string

A description of the task that is shown to an agent in the Contact Control Panel (CCP).

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Name

Required: Yes
Type: string

The name of a task that is shown to an agent in the Contact Control Panel (CCP).

PreviousContactId

Type: string

The identifier of the previous chat, voice, or task contact.

QuickConnectId

Type: string

The identifier for the quick connect.

References

Type: Associative array of custom strings keys (ReferenceKey) to Reference structures

A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

RelatedContactId

Type: string

The contactId that is related to this contact.

ScheduledTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

TaskTemplateId

Type: string

A unique identifier for the task template.

Result Syntax

[
    'ContactId' => '<string>',
]

Result Details

Members

ContactId

Type: string

The identifier of this contact within the Amazon Connect instance.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
ServiceQuotaExceededException:
The service quota has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

StopContact

$result = $client->stopContact([/* ... */]);
$promise = $client->stopContactAsync([/* ... */]);

Ends the specified contact. This call does not work for the following initiation methods:

DISCONNECT
TRANSFER
QUEUE_TRANSFER

Parameter Syntax

$result = $client->stopContact([
    'ContactId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ContactId

Required: Yes
Type: string

The ID of the contact.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
ContactNotFoundException:
The contact with the specified ID is not active or does not exist. Applies to Voice calls only, not to Chat, Task, or Voice Callback.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.

StopContactRecording

$result = $client->stopContactRecording([/* ... */]);
$promise = $client->stopContactRecordingAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->stopContactRecording([
    'ContactId' => '<string>', // REQUIRED
    'InitialContactId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ContactId

Required: Yes
Type: string

The identifier of the contact.

InitialContactId

Required: Yes
Type: string

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.

StopContactStreaming

$result = $client->stopContactStreaming([/* ... */]);
$promise = $client->stopContactStreamingAsync([/* ... */]);

Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.

Parameter Syntax

$result = $client->stopContactStreaming([
    'ContactId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'StreamingId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ContactId

Required: Yes
Type: string

The identifier of the contact. This is the identifier of the contact that is associated with the first interaction with the contact center.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

StreamingId

Required: Yes
Type: string

The identifier of the streaming configuration enabled.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.

SuspendContactRecording

$result = $client->suspendContactRecording([/* ... */]);
$promise = $client->suspendContactRecordingAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->suspendContactRecording([
    'ContactId' => '<string>', // REQUIRED
    'InitialContactId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ContactId

Required: Yes
Type: string

The identifier of the contact.

InitialContactId

Required: Yes
Type: string

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds the specified tags to the specified resource.

Some of the supported resource types are agents, routing profiles, queues, quick connects, contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect.

For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

tags

Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
InternalServiceException:
Request processing failed because of an error or failure with the service.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.

TransferContact

$result = $client->transferContact([/* ... */]);
$promise = $client->transferContactAsync([/* ... */]);

Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.

Note the following requirements:

Transfer is supported for only TASK contacts.
Do not use both QueueId and UserId in the same call.
The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.
The TransferContact API can be called only on active contacts.
A contact cannot be transferred more than 11 times.

Parameter Syntax

$result = $client->transferContact([
    'ClientToken' => '<string>',
    'ContactFlowId' => '<string>', // REQUIRED
    'ContactId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'QueueId' => '<string>',
    'UserId' => '<string>',
]);

Parameter Details

Members

ClientToken

Type: string

ContactFlowId

Required: Yes
Type: string

The identifier of the flow.

ContactId

Required: Yes
Type: string

The identifier of the contact in this instance of Amazon Connect.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

QueueId

Type: string

The identifier for the queue.

UserId

Type: string

The identifier for the user.

Result Syntax

[
    'ContactArn' => '<string>',
    'ContactId' => '<string>',
]

Result Details

Members

ContactArn

Type: string

The Amazon Resource Name (ARN) of the contact.

ContactId

Type: string

The identifier of the contact in this instance of Amazon Connect.

Errors

InvalidRequestException:
The request is not valid.
IdempotencyException:
An entity with the same name already exists.
AccessDeniedException:
You do not have sufficient permissions to perform this action.
ResourceNotFoundException:
The specified resource was not found.
ServiceQuotaExceededException:
The service quota has been exceeded.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes the specified tags from the specified resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

tagKeys

Required: Yes
Type: Array of strings

The tag keys.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
InternalServiceException:
Request processing failed because of an error or failure with the service.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.

UpdateAgentStatus

$result = $client->updateAgentStatus([/* ... */]);
$promise = $client->updateAgentStatusAsync([/* ... */]);

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

Updates agent status.

Parameter Syntax

$result = $client->updateAgentStatus([
    'AgentStatusId' => '<string>', // REQUIRED
    'Description' => '<string>',
    'DisplayOrder' => <integer>,
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>',
    'ResetOrderNumber' => true || false,
    'State' => 'ENABLED|DISABLED',
]);

Parameter Details

Members

AgentStatusId

Required: Yes
Type: string

The identifier of the agent status.

Description

Type: string

The description of the agent status.

DisplayOrder

Type: int

The display order of the agent status.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Name

Type: string

The name of the agent status.

ResetOrderNumber

Type: boolean

A number indicating the reset order of the agent status.

State

Type: string

The state of the agent status.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
DuplicateResourceException:
A resource with the specified name already exists.
ResourceNotFoundException:
The specified resource was not found.
LimitExceededException:
The allowed limit for the resource has been exceeded.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

UpdateContact

$result = $client->updateContact([/* ... */]);
$promise = $client->updateContactAsync([/* ... */]);

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

Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.

You can add or update user-defined contact information for both ongoing and completed contacts.

Parameter Syntax

$result = $client->updateContact([
    'ContactId' => '<string>', // REQUIRED
    'Description' => '<string>',
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>',
    'References' => [
        '<ReferenceKey>' => [
            'Type' => 'URL|ATTACHMENT|NUMBER|STRING|DATE|EMAIL', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ContactId

Required: Yes
Type: string

The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.

Description

Type: string

The description of the contact.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Name

Type: string

The name of the contact.

References

Type: Associative array of custom strings keys (ReferenceKey) to Reference structures

Well-formed data on contact, shown to agents on Contact Control Panel (CCP).

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.
ThrottlingException:
The throttling limit has been exceeded.

UpdateContactAttributes

$result = $client->updateContactAttributes([/* ... */]);
$promise = $client->updateContactAttributesAsync([/* ... */]);

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 contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->updateContactAttributes([
    'Attributes' => ['<string>', ...], // REQUIRED
    'InitialContactId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Attributes

Required: Yes
Type: Associative array of custom strings keys (AttributeName) to strings

The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes.

You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

InitialContactId

Required: Yes
Type: string

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed because of an error or failure with the service.

UpdateContactFlowContent

$result = $client->updateContactFlowContent([/* ... */]);
$promise = $client->updateContactFlowContentAsync([/* ... */]);

Updates the specified flow.

You can also create and update flows using the Amazon Connect Flow language.

Parameter Syntax

$result = $client->updateContactFlowContent([
    'ContactFlowId' => '<string>', // REQUIRED
    'Content' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ContactFlowId

Required: Yes
Type: string

The identifier of the flow.

Content

Required: Yes
Type: string

The JSON string that represents flow's content. For an example, see Example contact flow in Amazon Connect Flow language.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidContactFlowException:
The flow is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

UpdateContactFlowMetadata

$result = $client->updateContactFlowMetadata([/* ... */]);
$promise = $client->updateContactFlowMetadataAsync([/* ... */]);

Updates metadata about specified flow.

Parameter Syntax

$result = $client->updateContactFlowMetadata([
    'ContactFlowId' => '<string>', // REQUIRED
    'ContactFlowState' => 'ACTIVE|ARCHIVED',
    'Description' => '<string>',
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>',
]);

Parameter Details

Members

ContactFlowId

Required: Yes
Type: string

The identifier of the flow.

ContactFlowState

Type: string

The state of flow.

Description

Type: string

The description of the flow.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Name

Type: string

The name of the flow.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
DuplicateResourceException:
A resource with the specified name already exists.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

UpdateContactFlowModuleContent

$result = $client->updateContactFlowModuleContent([/* ... */]);
$promise = $client->updateContactFlowModuleContentAsync([/* ... */]);

Updates specified flow module for the specified Amazon Connect instance.

Parameter Syntax

$result = $client->updateContactFlowModuleContent([
    'ContactFlowModuleId' => '<string>', // REQUIRED
    'Content' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ContactFlowModuleId

Required: Yes
Type: string

The identifier of the flow module.

Content

Required: Yes
Type: string

The content of the flow module.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
You do not have sufficient permissions to perform this action.
InvalidRequestException:
The request is not valid.
InvalidContactFlowModuleException:
The problems with the module. Please fix before trying again.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

UpdateContactFlowModuleMetadata

$result = $client->updateContactFlowModuleMetadata([/* ... */]);
$promise = $client->updateContactFlowModuleMetadataAsync([/* ... */]);

Updates metadata about specified flow module.

Parameter Syntax

$result = $client->updateContactFlowModuleMetadata([
    'ContactFlowModuleId' => '<string>', // REQUIRED
    'Description' => '<string>',
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>',
    'State' => 'ACTIVE|ARCHIVED',
]);

Parameter Details

Members

ContactFlowModuleId

Required: Yes
Type: string

The identifier of the flow module.

Description

Type: string

The description of the flow module.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Name

Type: string

The name of the flow module.

State

Type: string

The state of flow module.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
You do not have sufficient permissions to perform this action.
InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
DuplicateResourceException:
A resource with the specified name already exists.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

UpdateContactFlowName

$result = $client->updateContactFlowName([/* ... */]);
$promise = $client->updateContactFlowNameAsync([/* ... */]);

The name of the flow.

You can also create and update flows using the Amazon Connect Flow language.

Parameter Syntax

$result = $client->updateContactFlowName([
    'ContactFlowId' => '<string>', // REQUIRED
    'Description' => '<string>',
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>',
]);

Parameter Details

Members

ContactFlowId

Required: Yes
Type: string

The identifier of the flow.

Description

Type: string

The description of the flow.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance.

Name

Type: string

The name of the flow.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
DuplicateResourceException:
A resource with the specified name already exists.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed because of an error or failure with the service.

UpdateContactSchedule

$result = $client->updateContactSchedule([/* ... */]);
$promise = $client->updateContactScheduleAsync([/* ... */]);

Updates the scheduled time of a task contact that is already scheduled.

Parameter Syntax

$result = $client->updateContactSchedule([
    'ContactId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'ScheduledTime' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Members

ContactId

Required: Yes
Type: string

The identifier of the contact.

InstanceId

Required: Yes
Type: string

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

ScheduledTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the specified parameters are not valid.
ResourceNotFoundException:
The specified resource was not found.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon Connect Service 2017-08-08

Operation Summary

Paginators

Operations

AssociateApprovedOrigin

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

AssociateBot

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

AssociateDefaultVocabulary

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

AssociateInstanceStorageConfig

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AssociateLambdaFunction

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

AssociateLexBot

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

AssociatePhoneNumberContactFlow

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

AssociateQueueQuickConnects

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

AssociateRoutingProfileQueues

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

AssociateSecurityKey

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details