ActivateEvaluationForm

$result = $client->activateEvaluationForm([/* ... */]);
$promise = $client->activateEvaluationFormAsync([/* ... */]);

Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form.

Parameter Syntax

$result = $client->activateEvaluationForm([
    'EvaluationFormId' => '<string>', // REQUIRED
    'EvaluationFormVersion' => <integer>, // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EvaluationFormArn' => '<string>',
    'EvaluationFormId' => '<string>',
    'EvaluationFormVersion' => <integer>,
]

Result Details

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.

ResourceConflictException:

A resource already has that name.

AssociateAnalyticsDataSet

$result = $client->associateAnalyticsDataSet([/* ... */]);
$promise = $client->associateAnalyticsDataSetAsync([/* ... */]);

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

Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'DataSetId' => '<string>',
    'ResourceShareArn' => '<string>',
    'ResourceShareId' => '<string>',
    'TargetAccountId' => '<string>',
]

Result Details

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.

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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.

AssociateFlow

$result = $client->associateFlow([/* ... */]);
$promise = $client->associateFlowAsync([/* ... */]);

Associates a connect resource to a flow.

Parameter Syntax

$result = $client->associateFlow([
    'FlowId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'ResourceId' => '<string>', // REQUIRED
    'ResourceType' => 'SMS_PHONE_NUMBER', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

InvalidRequestException:

The request is not valid.

InvalidParameterException:

One or more of the specified parameters are not valid.

ThrottlingException:

The throttling limit has been exceeded.

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|SCREEN_RECORDINGS|REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS|REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS', // 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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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.

AssociateTrafficDistributionGroupUser

$result = $client->associateTrafficDistributionGroupUser([/* ... */]);
$promise = $client->associateTrafficDistributionGroupUserAsync([/* ... */]);

Associates an agent with a traffic distribution group.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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.

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.

AssociateUserProficiencies

$result = $client->associateUserProficiencies([/* ... */]);
$promise = $client->associateUserProficienciesAsync([/* ... */]);

>Associates a set of proficiencies with a user.

Parameter Syntax

$result = $client->associateUserProficiencies([
    'InstanceId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
    'UserProficiencies' => [ // REQUIRED
        [
            'AttributeName' => '<string>', // REQUIRED
            'AttributeValue' => '<string>', // REQUIRED
            'Level' => <float>, // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

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.

BatchAssociateAnalyticsDataSet

$result = $client->batchAssociateAnalyticsDataSet([/* ... */]);
$promise = $client->batchAssociateAnalyticsDataSetAsync([/* ... */]);

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

Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.

Parameter Syntax

$result = $client->batchAssociateAnalyticsDataSet([
    'DataSetIds' => ['<string>', ...], // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'TargetAccountId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Created' => [
        [
            'DataSetId' => '<string>',
            'ResourceShareArn' => '<string>',
            'ResourceShareId' => '<string>',
            'TargetAccountId' => '<string>',
        ],
        // ...
    ],
    'Errors' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

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.

BatchDisassociateAnalyticsDataSet

$result = $client->batchDisassociateAnalyticsDataSet([/* ... */]);
$promise = $client->batchDisassociateAnalyticsDataSetAsync([/* ... */]);

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

Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.

Parameter Syntax

$result = $client->batchDisassociateAnalyticsDataSet([
    'DataSetIds' => ['<string>', ...], // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'TargetAccountId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Deleted' => ['<string>', ...],
    'Errors' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

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.

BatchGetAttachedFileMetadata

$result = $client->batchGetAttachedFileMetadata([/* ... */]);
$promise = $client->batchGetAttachedFileMetadataAsync([/* ... */]);

Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.

Parameter Syntax

$result = $client->batchGetAttachedFileMetadata([
    'AssociatedResourceArn' => '<string>', // REQUIRED
    'FileIds' => ['<string>', ...], // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Errors' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'FileId' => '<string>',
        ],
        // ...
    ],
    'Files' => [
        [
            'AssociatedResourceArn' => '<string>',
            'CreatedBy' => [
                'AWSIdentityArn' => '<string>',
                'ConnectUserArn' => '<string>',
            ],
            'CreationTime' => '<string>',
            'FileArn' => '<string>',
            'FileId' => '<string>',
            'FileName' => '<string>',
            'FileSizeInBytes' => <integer>,
            'FileStatus' => 'APPROVED|REJECTED|PROCESSING|FAILED',
            'FileUseCaseType' => 'ATTACHMENT',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InvalidRequestException:

The request is 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.

BatchGetFlowAssociation

$result = $client->batchGetFlowAssociation([/* ... */]);
$promise = $client->batchGetFlowAssociationAsync([/* ... */]);

Retrieve the flow associations for the given resources.

Parameter Syntax

$result = $client->batchGetFlowAssociation([
    'InstanceId' => '<string>', // REQUIRED
    'ResourceIds' => ['<string>', ...], // REQUIRED
    'ResourceType' => 'VOICE_PHONE_NUMBER',
]);

Parameter Details

Result Syntax

[
    'FlowAssociationSummaryList' => [
        [
            'FlowId' => '<string>',
            'ResourceId' => '<string>',
            'ResourceType' => 'VOICE_PHONE_NUMBER',
        ],
        // ...
    ],
]

Result Details

Errors

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.

InvalidRequestException:

The request is not valid.

InvalidParameterException:

One or more of the specified parameters are not valid.

ThrottlingException:

The throttling limit has been exceeded.

BatchPutContact

$result = $client->batchPutContact([/* ... */]);
$promise = $client->batchPutContactAsync([/* ... */]);

Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.

Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.

Parameter Syntax

$result = $client->batchPutContact([
    'ClientToken' => '<string>',
    'ContactDataRequestList' => [ // REQUIRED
        [
            'Attributes' => ['<string>', ...],
            'Campaign' => [
                'CampaignId' => '<string>',
            ],
            'CustomerEndpoint' => [
                'Address' => '<string>',
                'Type' => 'TELEPHONE_NUMBER|VOIP|CONTACT_FLOW',
            ],
            'QueueId' => '<string>',
            'RequestIdentifier' => '<string>',
            'SystemEndpoint' => [
                'Address' => '<string>',
                'Type' => 'TELEPHONE_NUMBER|VOIP|CONTACT_FLOW',
            ],
        ],
        // ...
    ],
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'FailedRequestList' => [
        [
            'FailureReasonCode' => 'INVALID_ATTRIBUTE_KEY|INVALID_CUSTOMER_ENDPOINT|INVALID_SYSTEM_ENDPOINT|INVALID_QUEUE|MISSING_CAMPAIGN|MISSING_CUSTOMER_ENDPOINT|MISSING_QUEUE_ID_AND_SYSTEM_ENDPOINT|REQUEST_THROTTLED|IDEMPOTENCY_EXCEPTION|INTERNAL_ERROR',
            'FailureReasonMessage' => '<string>',
            'RequestIdentifier' => '<string>',
        ],
        // ...
    ],
    'SuccessfulRequestList' => [
        [
            'ContactId' => '<string>',
            'RequestIdentifier' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServiceException:

Request processing failed because of an error or failure with the service.

InvalidRequestException:

The request is not valid.

ResourceNotFoundException:

The specified resource was not found.

LimitExceededException:

The allowed limit for the resource has been exceeded.

IdempotencyException:

An entity with the same name already exists.

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.

If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.

By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.

For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

CompleteAttachedFileUpload

$result = $client->completeAttachedFileUpload([/* ... */]);
$promise = $client->completeAttachedFileUploadAsync([/* ... */]);

Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InvalidRequestException:

The request is 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.

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

Result Syntax

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

Result Details

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
    'Status' => 'PUBLISHED|SAVED',
    'Tags' => ['<string>', ...],
    'Type' => 'CONTACT_FLOW|CUSTOMER_QUEUE|CUSTOMER_HOLD|CUSTOMER_WHISPER|AGENT_HOLD|AGENT_WHISPER|OUTBOUND_WHISPER|AGENT_TRANSFER|QUEUE_TRANSFER', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

CreateEvaluationForm

$result = $client->createEvaluationForm([/* ... */]);
$promise = $client->createEvaluationFormAsync([/* ... */]);

Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.

Parameter Syntax

$result = $client->createEvaluationForm([
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'InstanceId' => '<string>', // REQUIRED
    'Items' => [ // REQUIRED
        [
            'Question' => [
                'Instructions' => '<string>',
                'NotApplicableEnabled' => true || false,
                'QuestionType' => 'TEXT|SINGLESELECT|NUMERIC', // REQUIRED
                'QuestionTypeProperties' => [
                    'Numeric' => [
                        'Automation' => [
                            'PropertyValue' => [
                                'Label' => 'OVERALL_CUSTOMER_SENTIMENT_SCORE|OVERALL_AGENT_SENTIMENT_SCORE|NON_TALK_TIME|NON_TALK_TIME_PERCENTAGE|NUMBER_OF_INTERRUPTIONS|CONTACT_DURATION|AGENT_INTERACTION_DURATION|CUSTOMER_HOLD_TIME', // REQUIRED
                            ],
                        ],
                        'MaxValue' => <integer>, // REQUIRED
                        'MinValue' => <integer>, // REQUIRED
                        'Options' => [
                            [
                                'AutomaticFail' => true || false,
                                'MaxValue' => <integer>, // REQUIRED
                                'MinValue' => <integer>, // REQUIRED
                                'Score' => <integer>,
                            ],
                            // ...
                        ],
                    ],
                    'SingleSelect' => [
                        'Automation' => [
                            'DefaultOptionRefId' => '<string>',
                            'Options' => [ // REQUIRED
                                [
                                    'RuleCategory' => [
                                        'Category' => '<string>', // REQUIRED
                                        'Condition' => 'PRESENT|NOT_PRESENT', // REQUIRED
                                        'OptionRefId' => '<string>', // REQUIRED
                                    ],
                                ],
                                // ...
                            ],
                        ],
                        'DisplayAs' => 'DROPDOWN|RADIO',
                        'Options' => [ // REQUIRED
                            [
                                'AutomaticFail' => true || false,
                                'RefId' => '<string>', // REQUIRED
                                'Score' => <integer>,
                                'Text' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                ],
                'RefId' => '<string>', // REQUIRED
                'Title' => '<string>', // REQUIRED
                'Weight' => <float>,
            ],
            'Section' => [
                'Instructions' => '<string>',
                'Items' => [...], // REQUIRED, RECURSIVE
                'RefId' => '<string>', // REQUIRED
                'Title' => '<string>', // REQUIRED
                'Weight' => <float>,
            ],
        ],
        // ...
    ],
    'ScoringStrategy' => [
        'Mode' => 'QUESTION_ONLY|SECTION_ONLY', // REQUIRED
        'Status' => 'ENABLED|DISABLED', // REQUIRED
    ],
    'Title' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EvaluationFormArn' => '<string>',
    'EvaluationFormId' => '<string>',
]

Result Details

Errors

InternalServiceException:

Request processing failed because of an error or failure with the service.

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.

ResourceConflictException:

A resource already has that name.

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

Result Syntax

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

Result Details

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
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

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|WISDOM_QUICK_RESPONSES|CASES_DOMAIN|APPLICATION|FILE_SCANNER', // REQUIRED
    'SourceApplicationName' => '<string>',
    'SourceApplicationUrl' => '<string>',
    'SourceType' => 'SALESFORCE|ZENDESK|CASES',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

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.

CreateParticipant

$result = $client->createParticipant([/* ... */]);
$promise = $client->createParticipantAsync([/* ... */]);

Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.

Parameter Syntax

$result = $client->createParticipant([
    'ClientToken' => '<string>',
    'ContactId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'ParticipantDetails' => [ // REQUIRED
        'DisplayName' => '<string>',
        'ParticipantRole' => 'AGENT|CUSTOMER|SYSTEM|CUSTOM_BOT|SUPERVISOR',
    ],
]);

Parameter Details

Result Syntax

[
    'ParticipantCredentials' => [
        'Expiry' => '<string>',
        'ParticipantToken' => '<string>',
    ],
    'ParticipantId' => '<string>',
]

Result Details

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.

ServiceQuotaExceededException:

The service quota has been exceeded.

ThrottlingException:

The throttling limit has been exceeded.

CreatePersistentContactAssociation

$result = $client->createPersistentContactAssociation([/* ... */]);
$promise = $client->createPersistentContactAssociationAsync([/* ... */]);

Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->createPersistentContactAssociation([
    'ClientToken' => '<string>',
    'InitialContactId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'RehydrationType' => 'ENTIRE_PAST_SESSION|FROM_SEGMENT', // REQUIRED
    'SourceContactId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

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.

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.

CreatePredefinedAttribute

$result = $client->createPredefinedAttribute([/* ... */]);
$promise = $client->createPredefinedAttributeAsync([/* ... */]);

Creates a new predefined attribute for the specified Amazon Connect instance.

Parameter Syntax

$result = $client->createPredefinedAttribute([
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Values' => [ // REQUIRED
        'StringList' => ['<string>', ...],
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

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.

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.

CreatePrompt

$result = $client->createPrompt([/* ... */]);
$promise = $client->createPromptAsync([/* ... */]);

Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'PromptARN' => '<string>',
    'PromptId' => '<string>',
]

Result Details

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.

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.

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.

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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([
    'AgentAvailabilityTimer' => 'TIME_SINCE_LAST_ACTIVITY|TIME_SINCE_LAST_INBOUND',
    'DefaultOutboundQueueId' => '<string>', // REQUIRED
    'Description' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'MediaConcurrencies' => [ // REQUIRED
        [
            'Channel' => 'VOICE|CHAT|TASK', // REQUIRED
            'Concurrency' => <integer>, // REQUIRED
            'CrossChannelBehavior' => [
                'BehaviorType' => 'ROUTE_CURRENT_CHANNEL_ONLY|ROUTE_ANY_CHANNEL', // 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

Result Syntax

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

Result Details

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|CREATE_CASE|UPDATE_CASE|END_ASSOCIATED_TASKS|SUBMIT_AUTO_EVALUATION', // REQUIRED
            'AssignContactCategoryAction' => [
            ],
            'CreateCaseAction' => [
                'Fields' => [ // REQUIRED
                    [
                        'Id' => '<string>', // REQUIRED
                        'Value' => [ // REQUIRED
                            'BooleanValue' => true || false,
                            'DoubleValue' => <float>,
                            'EmptyValue' => [
                            ],
                            'StringValue' => '<string>',
                        ],
                    ],
                    // ...
                ],
                'TemplateId' => '<string>', // REQUIRED
            ],
            'EndAssociatedTasksAction' => [
            ],
            'EventBridgeAction' => [
                'Name' => '<string>', // REQUIRED
            ],
            'SendNotificationAction' => [
                'Content' => '<string>', // REQUIRED
                'ContentType' => 'PLAIN_TEXT', // REQUIRED
                'DeliveryMethod' => 'EMAIL', // REQUIRED
                'Recipient' => [ // REQUIRED
                    'UserIds' => ['<string>', ...],
                    'UserTags' => ['<string>', ...],
                ],
                'Subject' => '<string>',
            ],
            'SubmitAutoEvaluationAction' => [
                'EvaluationFormId' => '<string>', // REQUIRED
            ],
            'TaskAction' => [
                'ContactFlowId' => '<string>', // REQUIRED
                'Description' => '<string>',
                'Name' => '<string>', // REQUIRED
                'References' => [
                    '<ReferenceKey>' => [
                        'Type' => 'URL|ATTACHMENT|NUMBER|STRING|DATE|EMAIL', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            'UpdateCaseAction' => [
                'Fields' => [ // REQUIRED
                    [
                        'Id' => '<string>', // REQUIRED
                        'Value' => [ // REQUIRED
                            'BooleanValue' => true || false,
                            'DoubleValue' => <float>,
                            'EmptyValue' => [
                            ],
                            'StringValue' => '<string>',
                        ],
                    ],
                    // ...
                ],
            ],
        ],
        // ...
    ],
    'ClientToken' => '<string>',
    'Function' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'PublishStatus' => 'DRAFT|PUBLISHED', // REQUIRED
    'TriggerEventSource' => [ // REQUIRED
        'EventSourceName' => 'OnPostCallAnalysisAvailable|OnRealTimeCallAnalysisAvailable|OnRealTimeChatAnalysisAvailable|OnPostChatAnalysisAvailable|OnZendeskTicketCreate|OnZendeskTicketStatusUpdate|OnSalesforceCaseCreate|OnContactEvaluationSubmit|OnMetricDataUpdate|OnCaseCreate|OnCaseUpdate', // REQUIRED
        'IntegrationAssociationId' => '<string>',
    ],
]);

Parameter Details

Result Syntax

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

Result Details

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([/* ... */]);

Creates a security profile.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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 users using the Amazon Connect admin website, 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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

CreateView

$result = $client->createView([/* ... */]);
$promise = $client->createViewAsync([/* ... */]);

Creates a new view with the possible status of SAVED or PUBLISHED.

The views will have a unique name for each connect instance.

It performs basic content validation if the status is SAVED or full content validation if the status is set to PUBLISHED. An error is returned if validation fails. It associates either the $SAVED qualifier or both of the $SAVED and $LATEST qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided.

Parameter Syntax

$result = $client->createView([
    'ClientToken' => '<string>',
    'Content' => [ // REQUIRED
        'Actions' => ['<string>', ...],
        'Template' => '<string>',
    ],
    'Description' => '<string>',
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Status' => 'PUBLISHED|SAVED', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'View' => [
        'Arn' => '<string>',
        'Content' => [
            'Actions' => ['<string>', ...],
            'InputSchema' => '<string>',
            'Template' => '<string>',
        ],
        'CreatedTime' => <DateTime>,
        'Description' => '<string>',
        'Id' => '<string>',
        'LastModifiedTime' => <DateTime>,
        'Name' => '<string>',
        'Status' => 'PUBLISHED|SAVED',
        'Tags' => ['<string>', ...],
        'Type' => 'CUSTOMER_MANAGED|AWS_MANAGED',
        'Version' => <integer>,
        'VersionDescription' => '<string>',
        'ViewContentSha256' => '<string>',
    ],
]

Result Details

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.

DuplicateResourceException:

A resource with the specified name already exists.

ServiceQuotaExceededException:

The service quota has been exceeded.

TooManyRequestsException:

Displayed when rate-related API limits are exceeded.

ResourceInUseException:

That resource is already in use. Please try another.

CreateViewVersion

$result = $client->createViewVersion([/* ... */]);
$promise = $client->createViewVersionAsync([/* ... */]);

Publishes a new version of the view identifier.

Versions are immutable and monotonically increasing.

It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the $LATEST alias.

Parameter Syntax

$result = $client->createViewVersion([
    'InstanceId' => '<string>', // REQUIRED
    'VersionDescription' => '<string>',
    'ViewContentSha256' => '<string>',
    'ViewId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'View' => [
        'Arn' => '<string>',
        'Content' => [
            'Actions' => ['<string>', ...],
            'InputSchema' => '<string>',
            'Template' => '<string>',
        ],
        'CreatedTime' => <DateTime>,
        'Description' => '<string>',
        'Id' => '<string>',
        'LastModifiedTime' => <DateTime>,
        'Name' => '<string>',
        'Status' => 'PUBLISHED|SAVED',
        'Tags' => ['<string>', ...],
        'Type' => 'CUSTOMER_MANAGED|AWS_MANAGED',
        'Version' => <integer>,
        'VersionDescription' => '<string>',
        'ViewContentSha256' => '<string>',
    ],
]

Result Details

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.

TooManyRequestsException:

Displayed when rate-related API limits are exceeded.

ServiceQuotaExceededException:

The service quota has been exceeded.

ResourceInUseException:

That resource is already in use. Please try another.

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

Result Syntax

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

Result Details

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.

DeactivateEvaluationForm

$result = $client->deactivateEvaluationForm([/* ... */]);
$promise = $client->deactivateEvaluationFormAsync([/* ... */]);

Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.

Parameter Syntax

$result = $client->deactivateEvaluationForm([
    'EvaluationFormId' => '<string>', // REQUIRED
    'EvaluationFormVersion' => <integer>, // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EvaluationFormArn' => '<string>',
    'EvaluationFormId' => '<string>',
    'EvaluationFormVersion' => <integer>,
]

Result Details

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.

ResourceConflictException:

A resource already has that name.

DeleteAttachedFile

$result = $client->deleteAttachedFile([/* ... */]);
$promise = $client->deleteAttachedFileAsync([/* ... */]);

Deletes an attached file along with the underlying S3 Object.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InvalidRequestException:

The request is 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.

DeleteContactEvaluation

$result = $client->deleteContactEvaluation([/* ... */]);
$promise = $client->deleteContactEvaluationAsync([/* ... */]);

Deletes a contact evaluation in the specified Amazon Connect instance.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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.

ResourceConflictException:

A resource already has that name.

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

Result Syntax

[]

Result Details

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.