AWS SDK for PHP 3.x

Client: Aws\ConnectCampaignService\ConnectCampaignServiceClient

Service ID: connectcampaigns

Version: 2021-01-30

This page describes the parameters and results for the operations of the AmazonConnectCampaignService (2021-01-30), and shows how to use the Aws\ConnectCampaignService\ConnectCampaignServiceClient object to call the described operations. This documentation is specific to the 2021-01-30 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 */).

CreateCampaign ( array $params = [] ): Creates a campaign for the specified Amazon Connect account.
DeleteCampaign ( array $params = [] ): Deletes a campaign from the specified Amazon Connect account.
DeleteConnectInstanceConfig ( array $params = [] ): Deletes a connect instance config from the specified AWS account.
DeleteInstanceOnboardingJob ( array $params = [] ): Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.
DescribeCampaign ( array $params = [] ): Describes the specific campaign.
GetCampaignState ( array $params = [] ): Get state of a campaign for the specified Amazon Connect account.
GetCampaignStateBatch ( array $params = [] ): Get state of campaigns for the specified Amazon Connect account.
GetConnectInstanceConfig ( array $params = [] ): Get the specific Connect instance config.
GetInstanceOnboardingJobStatus ( array $params = [] ): Get the specific instance onboarding job status.
ListCampaigns ( array $params = [] ): Provides summary information about the campaigns under the specified Amazon Connect account.
ListTagsForResource ( array $params = [] ): List tags for a resource.
PauseCampaign ( array $params = [] ): Pauses a campaign for the specified Amazon Connect account.
PutDialRequestBatch ( array $params = [] ): Creates dials requests for the specified campaign Amazon Connect account.
ResumeCampaign ( array $params = [] ): Stops a campaign for the specified Amazon Connect account.
StartCampaign ( array $params = [] ): Starts a campaign for the specified Amazon Connect account.
StartInstanceOnboardingJob ( array $params = [] ): Onboard the specific Amazon Connect instance to Connect Campaigns.
StopCampaign ( array $params = [] ): Stops a campaign for the specified Amazon Connect account.
TagResource ( array $params = [] ): Tag a resource.
UntagResource ( array $params = [] ): Untag a resource.
UpdateCampaignDialerConfig ( array $params = [] ): Updates the dialer config of a campaign.
UpdateCampaignName ( array $params = [] ): Updates the name of a campaign.
UpdateCampaignOutboundCallConfig ( array $params = [] ): Updates the outbound call config of a campaign.

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:

ListCampaigns

Operations

CreateCampaign

$result = $client->createCampaign([/* ... */]);
$promise = $client->createCampaignAsync([/* ... */]);

Creates a campaign for the specified Amazon Connect account. This API is idempotent.

Parameter Syntax

$result = $client->createCampaign([
    'connectInstanceId' => '<string>', // REQUIRED
    'dialerConfig' => [ // REQUIRED
        'agentlessDialerConfig' => [
            'dialingCapacity' => <float>,
        ],
        'predictiveDialerConfig' => [
            'bandwidthAllocation' => <float>, // REQUIRED
            'dialingCapacity' => <float>,
        ],
        'progressiveDialerConfig' => [
            'bandwidthAllocation' => <float>, // REQUIRED
            'dialingCapacity' => <float>,
        ],
    ],
    'name' => '<string>', // REQUIRED
    'outboundCallConfig' => [ // REQUIRED
        'answerMachineDetectionConfig' => [
            'awaitAnswerMachinePrompt' => true || false,
            'enableAnswerMachineDetection' => true || false, // REQUIRED
        ],
        'connectContactFlowId' => '<string>', // REQUIRED
        'connectQueueId' => '<string>',
        'connectSourcePhoneNumber' => '<string>',
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

connectInstanceId

: Required: Yes
: Type: string

Amazon Connect Instance Id

dialerConfig

: Required: Yes
: Type: DialerConfig structure

The possible types of dialer config parameters

name

: Required: Yes
: Type: string

The name of an Amazon Connect Campaign name.

outboundCallConfig

: Required: Yes
: Type: OutboundCallConfig structure

The configuration used for outbound calls.

tags

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

Tag map with key and value.

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Members

arn

: Type: string

The resource name of an Amazon Connect campaign.

id

: Type: string

Identifier representing a Campaign

tags

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

Tag map with key and value.

Errors

InternalServerException:: Request processing failed because of an error or failure with the service.
ResourceNotFoundException:: The specified resource was not found.
ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
ConflictException:: The request could not be processed because of conflict in the current state of the resource.
AccessDeniedException:: You do not have sufficient access to perform this action.
ServiceQuotaExceededException:: Request would cause a service quota to be exceeded.
ThrottlingException:: The request was denied due to request throttling.

DeleteCampaign

$result = $client->deleteCampaign([/* ... */]);
$promise = $client->deleteCampaignAsync([/* ... */]);

Deletes a campaign from the specified Amazon Connect account.

Parameter Syntax

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

Parameter Details

Members

id

: Required: Yes
: Type: string

Identifier representing a Campaign

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: Request processing failed because of an error or failure with the service.
ResourceNotFoundException:: The specified resource was not found.
ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: You do not have sufficient access to perform this action.

DeleteConnectInstanceConfig

$result = $client->deleteConnectInstanceConfig([/* ... */]);
$promise = $client->deleteConnectInstanceConfigAsync([/* ... */]);

Deletes a connect instance config from the specified AWS account.

Parameter Syntax

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

Parameter Details

Members

connectInstanceId

: Required: Yes
: Type: string

Amazon Connect Instance Id

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: Request processing failed because of an error or failure with the service.
ResourceNotFoundException:: The specified resource was not found.
ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: You do not have sufficient access to perform this action.
InvalidStateException:: The request could not be processed because of conflict in the current state.
ThrottlingException:: The request was denied due to request throttling.

DeleteInstanceOnboardingJob

$result = $client->deleteInstanceOnboardingJob([/* ... */]);
$promise = $client->deleteInstanceOnboardingJobAsync([/* ... */]);

Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.

Parameter Syntax

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

Parameter Details

Members

connectInstanceId

: Required: Yes
: Type: string

Amazon Connect Instance Id

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: Request processing failed because of an error or failure with the service.
ResourceNotFoundException:: The specified resource was not found.
ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: You do not have sufficient access to perform this action.
InvalidStateException:: The request could not be processed because of conflict in the current state.

DescribeCampaign

$result = $client->describeCampaign([/* ... */]);
$promise = $client->describeCampaignAsync([/* ... */]);

Describes the specific campaign.

Parameter Syntax

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

Parameter Details

Members

id

: Required: Yes
: Type: string

Identifier representing a Campaign

Result Syntax

[
    'campaign' => [
        'arn' => '<string>',
        'connectInstanceId' => '<string>',
        'dialerConfig' => [
            'agentlessDialerConfig' => [
                'dialingCapacity' => <float>,
            ],
            'predictiveDialerConfig' => [
                'bandwidthAllocation' => <float>,
                'dialingCapacity' => <float>,
            ],
            'progressiveDialerConfig' => [
                'bandwidthAllocation' => <float>,
                'dialingCapacity' => <float>,
            ],
        ],
        'id' => '<string>',
        'name' => '<string>',
        'outboundCallConfig' => [
            'answerMachineDetectionConfig' => [
                'awaitAnswerMachinePrompt' => true || false,
                'enableAnswerMachineDetection' => true || false,
            ],
            'connectContactFlowId' => '<string>',
            'connectQueueId' => '<string>',
            'connectSourcePhoneNumber' => '<string>',
        ],
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

campaign

: Type: Campaign structure

An Amazon Connect campaign.

Errors

InternalServerException:: Request processing failed because of an error or failure with the service.
ResourceNotFoundException:: The specified resource was not found.
ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: You do not have sufficient access to perform this action.

GetCampaignState

$result = $client->getCampaignState([/* ... */]);
$promise = $client->getCampaignStateAsync([/* ... */]);

Get state of a campaign for the specified Amazon Connect account.

Parameter Syntax

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

Parameter Details

Members

id

: Required: Yes
: Type: string

Identifier representing a Campaign

Result Syntax

[
    'state' => 'Initialized|Running|Paused|Stopped|Failed',
]

Result Details

Members

state

: Type: string

State of a campaign

Errors

InternalServerException:: Request processing failed because of an error or failure with the service.
ResourceNotFoundException:: The specified resource was not found.
ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: You do not have sufficient access to perform this action.
ThrottlingException:: The request was denied due to request throttling.

GetCampaignStateBatch

$result = $client->getCampaignStateBatch([/* ... */]);
$promise = $client->getCampaignStateBatchAsync([/* ... */]);

Get state of campaigns for the specified Amazon Connect account.

Parameter Syntax

$result = $client->getCampaignStateBatch([
    'campaignIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

campaignIds

: Required: Yes
: Type: Array of strings

List of CampaignId

Result Syntax

[
    'failedRequests' => [
        [
            'campaignId' => '<string>',
            'failureCode' => 'ResourceNotFound|UnknownError',
        ],
        // ...
    ],
    'successfulRequests' => [
        [
            'campaignId' => '<string>',
            'state' => 'Initialized|Running|Paused|Stopped|Failed',
        ],
        // ...
    ],
]

Result Details

Members

failedRequests

: Type: Array of FailedCampaignStateResponse structures

List of failed requests of campaign state

successfulRequests

: Type: Array of SuccessfulCampaignStateResponse structures

List of successful response of campaign state

Errors

InternalServerException:: Request processing failed because of an error or failure with the service.
ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: You do not have sufficient access to perform this action.
ThrottlingException:: The request was denied due to request throttling.

GetConnectInstanceConfig

$result = $client->getConnectInstanceConfig([/* ... */]);
$promise = $client->getConnectInstanceConfigAsync([/* ... */]);

Get the specific Connect instance config.

Parameter Syntax

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

Parameter Details

Members

connectInstanceId

: Required: Yes
: Type: string

Amazon Connect Instance Id

Result Syntax

[
    'connectInstanceConfig' => [
        'connectInstanceId' => '<string>',
        'encryptionConfig' => [
            'enabled' => true || false,
            'encryptionType' => 'KMS',
            'keyArn' => '<string>',
        ],
        'serviceLinkedRoleArn' => '<string>',
    ],
]

Result Details

Members

connectInstanceConfig

: Type: InstanceConfig structure

Instance config object

Errors

InternalServerException:: Request processing failed because of an error or failure with the service.
ResourceNotFoundException:: The specified resource was not found.
ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: You do not have sufficient access to perform this action.

GetInstanceOnboardingJobStatus

$result = $client->getInstanceOnboardingJobStatus([/* ... */]);
$promise = $client->getInstanceOnboardingJobStatusAsync([/* ... */]);

Get the specific instance onboarding job status.

Parameter Syntax

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

Parameter Details

Members

connectInstanceId

: Required: Yes
: Type: string

Amazon Connect Instance Id

Result Syntax

[
    'connectInstanceOnboardingJobStatus' => [
        'connectInstanceId' => '<string>',
        'failureCode' => 'EVENT_BRIDGE_ACCESS_DENIED|EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED|IAM_ACCESS_DENIED|KMS_ACCESS_DENIED|KMS_KEY_NOT_FOUND|INTERNAL_FAILURE',
        'status' => 'IN_PROGRESS|SUCCEEDED|FAILED',
    ],
]

Result Details

Members

connectInstanceOnboardingJobStatus

: Type: InstanceOnboardingJobStatus structure

Instance onboarding job status object

Errors

InternalServerException:: Request processing failed because of an error or failure with the service.
ResourceNotFoundException:: The specified resource was not found.
ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: You do not have sufficient access to perform this action.

ListCampaigns

$result = $client->listCampaigns([/* ... */]);
$promise = $client->listCampaignsAsync([/* ... */]);

Provides summary information about the campaigns under the specified Amazon Connect account.

Parameter Syntax

$result = $client->listCampaigns([
    'filters' => [
        'instanceIdFilter' => [
            'operator' => 'Eq', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

filters

: Type: CampaignFilters structure

Filter model by type

maxResults

: Type: int

The maximum number of results to return per page.

nextToken

: Type: string

The token for the next set of results.

Result Syntax

[
    'campaignSummaryList' => [
        [
            'arn' => '<string>',
            'connectInstanceId' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

campaignSummaryList

: Type: Array of CampaignSummary structures

A list of Amazon Connect campaigns.

nextToken

: Type: string

The token for the next set of results.

Errors

InternalServerException:: Request processing failed because of an error or failure with the service.
ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: You do not have sufficient access to perform this action.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

List tags for a resource.

Parameter Syntax

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

Parameter Details

Members

arn

: Required: Yes
: Type: string

Arn

Result Syntax

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

Result Details

Members

tags

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

Tag map with key and value.

Errors

InternalServerException:: Request processing failed because of an error or failure with the service.
ResourceNotFoundException:: The specified resource was not found.
ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: You do not have sufficient access to perform this action.
ThrottlingException:: The request was denied due to request throttling.

PauseCampaign

$result = $client->pauseCampaign([/* ... */]);
$promise = $client->pauseCampaignAsync([/* ... */]);

Pauses a campaign for the specified Amazon Connect account.

Parameter Syntax

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

Parameter Details

Members

id

: Required: Yes
: Type: string

Identifier representing a Campaign

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: Request processing failed because of an error or failure with the service.
ResourceNotFoundException:: The specified resource was not found.
ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
ConflictException:: The request could not be processed because of conflict in the current state of the resource.
InvalidCampaignStateException:: The request could not be processed because of conflict in the current state of the campaign.
AccessDeniedException:: You do not have sufficient access to perform this action.
ThrottlingException:: The request was denied due to request throttling.

PutDialRequestBatch

$result = $client->putDialRequestBatch([/* ... */]);
$promise = $client->putDialRequestBatchAsync([/* ... */]);

Creates dials requests for the specified campaign Amazon Connect account. This API is idempotent.

Parameter Syntax

$result = $client->putDialRequestBatch([
    'dialRequests' => [ // REQUIRED
        [
            'attributes' => ['<string>', ...], // REQUIRED
            'clientToken' => '<string>', // REQUIRED
            'expirationTime' => <integer || string || DateTime>, // REQUIRED
            'phoneNumber' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members

dialRequests

: Required: Yes
: Type: Array of DialRequest structures

A list of dial requests.

id

: Required: Yes
: Type: string

Identifier representing a Campaign

Result Syntax

[
    'failedRequests' => [
        [
            'clientToken' => '<string>',
            'failureCode' => 'InvalidInput|RequestThrottled|UnknownError',
            'id' => '<string>',
        ],
        // ...
    ],
    'successfulRequests' => [
        [
            'clientToken' => '<string>',
            'id' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

failedRequests

: Type: Array of FailedRequest structures

A list of failed requests.

successfulRequests

: Type: Array of SuccessfulRequest structures

A list of successful requests identified by the unique client token.

Errors

InternalServerException:: Request processing failed because of an error or failure with the service.
ResourceNotFoundException:: The specified resource was not found.
ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
ConflictException:: The request could not be processed because of conflict in the current state of the resource.
InvalidCampaignStateException:: The request could not be processed because of conflict in the current state of the campaign.
AccessDeniedException:: You do not have sufficient access to perform this action.
ThrottlingException:: The request was denied due to request throttling.

ResumeCampaign

$result = $client->resumeCampaign([/* ... */]);
$promise = $client->resumeCampaignAsync([/* ... */]);

Stops a campaign for the specified Amazon Connect account.

Parameter Syntax

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

Parameter Details

Members

id

: Required: Yes
: Type: string

Identifier representing a Campaign

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: Request processing failed because of an error or failure with the service.
ResourceNotFoundException:: The specified resource was not found.
ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
ConflictException:: The request could not be processed because of conflict in the current state of the resource.
InvalidCampaignStateException:: The request could not be processed because of conflict in the current state of the campaign.
AccessDeniedException:: You do not have sufficient access to perform this action.
ThrottlingException:: The request was denied due to request throttling.

StartCampaign

$result = $client->startCampaign([/* ... */]);
$promise = $client->startCampaignAsync([/* ... */]);

Starts a campaign for the specified Amazon Connect account.

Parameter Syntax

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

Parameter Details

Members

id

: Required: Yes
: Type: string

Identifier representing a Campaign

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: Request processing failed because of an error or failure with the service.
ResourceNotFoundException:: The specified resource was not found.
ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
ConflictException:: The request could not be processed because of conflict in the current state of the resource.
InvalidCampaignStateException:: The request could not be processed because of conflict in the current state of the campaign.
AccessDeniedException:: You do not have sufficient access to perform this action.
ThrottlingException:: The request was denied due to request throttling.

StartInstanceOnboardingJob

$result = $client->startInstanceOnboardingJob([/* ... */]);
$promise = $client->startInstanceOnboardingJobAsync([/* ... */]);

Onboard the specific Amazon Connect instance to Connect Campaigns.

Parameter Syntax

$result = $client->startInstanceOnboardingJob([
    'connectInstanceId' => '<string>', // REQUIRED
    'encryptionConfig' => [ // REQUIRED
        'enabled' => true || false, // REQUIRED
        'encryptionType' => 'KMS',
        'keyArn' => '<string>',
    ],
]);

Parameter Details

Members

connectInstanceId

: Required: Yes
: Type: string

Amazon Connect Instance Id

encryptionConfig

: Required: Yes
: Type: EncryptionConfig structure

Encryption config for Connect Instance. Note that sensitive data will always be encrypted. If disabled, service will perform encryption with its own key. If enabled, a KMS key id needs to be provided and KMS charges will apply. KMS is only type supported

Result Syntax

[
    'connectInstanceOnboardingJobStatus' => [
        'connectInstanceId' => '<string>',
        'failureCode' => 'EVENT_BRIDGE_ACCESS_DENIED|EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED|IAM_ACCESS_DENIED|KMS_ACCESS_DENIED|KMS_KEY_NOT_FOUND|INTERNAL_FAILURE',
        'status' => 'IN_PROGRESS|SUCCEEDED|FAILED',
    ],
]

Result Details

Members

connectInstanceOnboardingJobStatus

: Type: InstanceOnboardingJobStatus structure

Instance onboarding job status object

Errors

InternalServerException:: Request processing failed because of an error or failure with the service.
ResourceNotFoundException:: The specified resource was not found.
ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
ConflictException:: The request could not be processed because of conflict in the current state of the resource.
AccessDeniedException:: You do not have sufficient access to perform this action.
ThrottlingException:: The request was denied due to request throttling.

StopCampaign

$result = $client->stopCampaign([/* ... */]);
$promise = $client->stopCampaignAsync([/* ... */]);

Stops a campaign for the specified Amazon Connect account.

Parameter Syntax

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

Parameter Details

Members

id

: Required: Yes
: Type: string

Identifier representing a Campaign

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: Request processing failed because of an error or failure with the service.
ResourceNotFoundException:: The specified resource was not found.
ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
ConflictException:: The request could not be processed because of conflict in the current state of the resource.
InvalidCampaignStateException:: The request could not be processed because of conflict in the current state of the campaign.
AccessDeniedException:: You do not have sufficient access to perform this action.
ThrottlingException:: The request was denied due to request throttling.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Tag a resource.

Parameter Syntax

$result = $client->tagResource([
    'arn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

arn

: Required: Yes
: Type: string

Arn

tags

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

Tag map with key and value.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: Request processing failed because of an error or failure with the service.
ResourceNotFoundException:: The specified resource was not found.
ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: You do not have sufficient access to perform this action.
ThrottlingException:: The request was denied due to request throttling.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Untag a resource.

Parameter Syntax

$result = $client->untagResource([
    'arn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

arn

: Required: Yes
: Type: string

Arn

tagKeys

: Required: Yes
: Type: Array of strings

List of tag keys.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: Request processing failed because of an error or failure with the service.
ResourceNotFoundException:: The specified resource was not found.
ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: You do not have sufficient access to perform this action.
ThrottlingException:: The request was denied due to request throttling.

UpdateCampaignDialerConfig

$result = $client->updateCampaignDialerConfig([/* ... */]);
$promise = $client->updateCampaignDialerConfigAsync([/* ... */]);

Updates the dialer config of a campaign. This API is idempotent.

Parameter Syntax

$result = $client->updateCampaignDialerConfig([
    'dialerConfig' => [ // REQUIRED
        'agentlessDialerConfig' => [
            'dialingCapacity' => <float>,
        ],
        'predictiveDialerConfig' => [
            'bandwidthAllocation' => <float>, // REQUIRED
            'dialingCapacity' => <float>,
        ],
        'progressiveDialerConfig' => [
            'bandwidthAllocation' => <float>, // REQUIRED
            'dialingCapacity' => <float>,
        ],
    ],
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members

dialerConfig

: Required: Yes
: Type: DialerConfig structure

The possible types of dialer config parameters

id

: Required: Yes
: Type: string

Identifier representing a Campaign

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: Request processing failed because of an error or failure with the service.
ResourceNotFoundException:: The specified resource was not found.
ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
ConflictException:: The request could not be processed because of conflict in the current state of the resource.
AccessDeniedException:: You do not have sufficient access to perform this action.

UpdateCampaignName

$result = $client->updateCampaignName([/* ... */]);
$promise = $client->updateCampaignNameAsync([/* ... */]);

Updates the name of a campaign. This API is idempotent.

Parameter Syntax

$result = $client->updateCampaignName([
    'id' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members

id

: Required: Yes
: Type: string

Identifier representing a Campaign

name

: Required: Yes
: Type: string

The name of an Amazon Connect Campaign name.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: Request processing failed because of an error or failure with the service.
ResourceNotFoundException:: The specified resource was not found.
ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
ConflictException:: The request could not be processed because of conflict in the current state of the resource.
AccessDeniedException:: You do not have sufficient access to perform this action.

UpdateCampaignOutboundCallConfig

$result = $client->updateCampaignOutboundCallConfig([/* ... */]);
$promise = $client->updateCampaignOutboundCallConfigAsync([/* ... */]);

Updates the outbound call config of a campaign. This API is idempotent.

Parameter Syntax

$result = $client->updateCampaignOutboundCallConfig([
    'answerMachineDetectionConfig' => [
        'awaitAnswerMachinePrompt' => true || false,
        'enableAnswerMachineDetection' => true || false, // REQUIRED
    ],
    'connectContactFlowId' => '<string>',
    'connectSourcePhoneNumber' => '<string>',
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members

answerMachineDetectionConfig

: Type: AnswerMachineDetectionConfig structure

Answering Machine Detection config

connectContactFlowId

: Type: string

The identifier of the contact flow for the outbound call.

connectSourcePhoneNumber

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

id

: Required: Yes
: Type: string

Identifier representing a Campaign

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: Request processing failed because of an error or failure with the service.
ResourceNotFoundException:: The specified resource was not found.
ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
ConflictException:: The request could not be processed because of conflict in the current state of the resource.
AccessDeniedException:: You do not have sufficient access to perform this action.
ThrottlingException:: The request was denied due to request throttling.

Shapes

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members

message

: Required: Yes
: Type: string

xAmzErrorType

: Type: string

A header that defines the error encountered while processing the request.

AgentlessDialerConfig

Description

Agentless Dialer config

Members

dialingCapacity

: Type: double

Allocates dialing capacity for this campaign between multiple active campaigns

AnswerMachineDetectionConfig

Description

Answering Machine Detection config

Members

awaitAnswerMachinePrompt

: Type: boolean

Enable or disable await answer machine prompt

enableAnswerMachineDetection

: Required: Yes
: Type: boolean

Enable or disable answering machine detection

Campaign

Description

An Amazon Connect campaign.

Members

arn

: Required: Yes
: Type: string

The resource name of an Amazon Connect campaign.

connectInstanceId

: Required: Yes
: Type: string

Amazon Connect Instance Id

dialerConfig

: Required: Yes
: Type: DialerConfig structure

The possible types of dialer config parameters

id

: Required: Yes
: Type: string

Identifier representing a Campaign

name

: Required: Yes
: Type: string

The name of an Amazon Connect Campaign name.

outboundCallConfig

: Required: Yes
: Type: OutboundCallConfig structure

The configuration used for outbound calls.

tags

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

Tag map with key and value.

CampaignFilters

Description

Filter model by type

Members

instanceIdFilter

: Type: InstanceIdFilter structure

Connect instance identifier filter

CampaignSummary

Description

An Amazon Connect campaign summary.

Members

arn

: Required: Yes
: Type: string

The resource name of an Amazon Connect campaign.

connectInstanceId

: Required: Yes
: Type: string

Amazon Connect Instance Id

id

: Required: Yes
: Type: string

Identifier representing a Campaign

name

: Required: Yes
: Type: string

The name of an Amazon Connect Campaign name.

ConflictException

Description

The request could not be processed because of conflict in the current state of the resource.

Members

message

: Required: Yes
: Type: string

xAmzErrorType

: Type: string

A header that defines the error encountered while processing the request.

DialRequest

Description

A dial request for a campaign.

Members

attributes

: Required: Yes
: 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 contact flows just like any other contact attributes.

clientToken

: Required: Yes
: Type: string

Client provided parameter used for idempotency. Its value must be unique for each request.

expirationTime

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

Timestamp with no UTC offset or timezone

phoneNumber

: Required: Yes
: Type: string

The phone number of the customer, in E.164 format.

DialerConfig

Description

The possible types of dialer config parameters

Members

agentlessDialerConfig

: Type: AgentlessDialerConfig structure

Agentless Dialer config

predictiveDialerConfig

: Type: PredictiveDialerConfig structure

Predictive Dialer config

progressiveDialerConfig

: Type: ProgressiveDialerConfig structure

Progressive Dialer config

EncryptionConfig

Description

Members

enabled

: Required: Yes
: Type: boolean

Boolean to indicate if custom encryption has been enabled.

encryptionType

: Type: string

Server-side encryption type.

keyArn

: Type: string

KMS key id/arn for encryption config.

FailedCampaignStateResponse

Description

Failed response of campaign state

Members

campaignId

: Type: string

Identifier representing a Campaign

failureCode

: Type: string

A predefined code indicating the error that caused the failure in getting state of campaigns

FailedRequest

Description

A failed request identified by the unique client token.

Members

clientToken

: Type: string

Client provided parameter used for idempotency. Its value must be unique for each request.

failureCode

: Type: string

A predefined code indicating the error that caused the failure.

id

: Type: string

Identifier representing a Dial request

InstanceConfig

Description

Instance config object

Members

connectInstanceId

: Required: Yes
: Type: string

Amazon Connect Instance Id

encryptionConfig

: Required: Yes
: Type: EncryptionConfig structure

serviceLinkedRoleArn

: Required: Yes
: Type: string

Service linked role arn

InstanceIdFilter

Description

Connect instance identifier filter

Members

operator

: Required: Yes
: Type: string

Operators for Connect instance identifier filter

value

: Required: Yes
: Type: string

Amazon Connect Instance Id

InstanceOnboardingJobStatus

Description

Instance onboarding job status object

Members

connectInstanceId

: Required: Yes
: Type: string

Amazon Connect Instance Id

failureCode

: Type: string

Enumeration of the possible failure codes for instance onboarding job

status

: Required: Yes
: Type: string

Enumeration of the possible states for instance onboarding job

InternalServerException

Description

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

Members

message

: Required: Yes
: Type: string

xAmzErrorType

: Type: string

A header that defines the error encountered while processing the request.

InvalidCampaignStateException

Description

The request could not be processed because of conflict in the current state of the campaign.

Members

message

: Required: Yes
: Type: string

state

: Required: Yes
: Type: string

State of a campaign

xAmzErrorType

: Type: string

A header that defines the error encountered while processing the request.

InvalidStateException

Description

The request could not be processed because of conflict in the current state.

Members

message

: Required: Yes
: Type: string

xAmzErrorType

: Type: string

A header that defines the error encountered while processing the request.

OutboundCallConfig

Description

The configuration used for outbound calls.

Members

answerMachineDetectionConfig

: Type: AnswerMachineDetectionConfig structure

Answering Machine Detection config

connectContactFlowId

: Required: Yes
: Type: string

The identifier of the contact flow for the outbound call.

connectQueueId

: 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 contact flow is used. If you do not specify a queue, you must specify a source phone number.

connectSourcePhoneNumber

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

PredictiveDialerConfig

Description

Predictive Dialer config

Members

bandwidthAllocation

: Required: Yes
: Type: double

The bandwidth allocation of a queue resource.

dialingCapacity

: Type: double

Allocates dialing capacity for this campaign between multiple active campaigns

ProgressiveDialerConfig

Description

Progressive Dialer config

Members

bandwidthAllocation

: Required: Yes
: Type: double

The bandwidth allocation of a queue resource.

dialingCapacity

: Type: double

Allocates dialing capacity for this campaign between multiple active campaigns

ResourceNotFoundException

Description

The specified resource was not found.

Members

message

: Required: Yes
: Type: string

xAmzErrorType

: Type: string

A header that defines the error encountered while processing the request.

ServiceQuotaExceededException

Description

Request would cause a service quota to be exceeded.

Members

message

: Required: Yes
: Type: string

xAmzErrorType

: Type: string

A header that defines the error encountered while processing the request.

SuccessfulCampaignStateResponse

Description

Successful response of campaign state

Members

campaignId

: Type: string

Identifier representing a Campaign

state

: Type: string

State of a campaign

SuccessfulRequest

Description

A successful request identified by the unique client token.

Members

clientToken

: Type: string

Client provided parameter used for idempotency. Its value must be unique for each request.

id

: Type: string

Identifier representing a Dial request

ThrottlingException

Description

The request was denied due to request throttling.

Members

message

: Required: Yes
: Type: string

xAmzErrorType

: Type: string

A header that defines the error encountered while processing the request.

ValidationException

Description

The input fails to satisfy the constraints specified by an AWS service.

Members

message

: Required: Yes
: Type: string

xAmzErrorType

: Type: string

A header that defines the error encountered while processing the request.

AmazonConnectCampaignService 2021-01-30

Operation Summary

Paginators

Operations

CreateCampaign

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteCampaign

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteConnectInstanceConfig

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteInstanceOnboardingJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DescribeCampaign

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetCampaignState

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetCampaignStateBatch

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetConnectInstanceConfig

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetInstanceOnboardingJobStatus

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListCampaigns

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members