AWS SDK for PHP 3.x

Client: Aws\ConnectCampaignsV2\ConnectCampaignsV2Client

Service ID: connectcampaignsv2

Version: 2024-04-23

This page describes the parameters and results for the operations of the AmazonConnectCampaignServiceV2 (2024-04-23), and shows how to use the Aws\ConnectCampaignsV2\ConnectCampaignsV2Client object to call the described operations. This documentation is specific to the 2024-04-23 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.
DeleteCampaignChannelSubtypeConfig ( array $params = [] ): Deletes the channel subtype config of a campaign.
DeleteCampaignCommunicationLimits ( array $params = [] ): Deletes the communication limits config for a campaign.
DeleteCampaignCommunicationTime ( array $params = [] ): Deletes the communication time config for a campaign.
DeleteConnectInstanceConfig ( array $params = [] ): Deletes a connect instance config from the specified AWS account.
DeleteConnectInstanceIntegration ( array $params = [] ): Delete the integration for the specified Amazon Connect instance.
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.
ListConnectInstanceIntegrations ( array $params = [] ): Provides summary information about the integration under the specified Connect instance.
ListTagsForResource ( array $params = [] ): List tags for a resource.
PauseCampaign ( array $params = [] ): Pauses a campaign for the specified Amazon Connect account.
PutConnectInstanceIntegration ( array $params = [] ): Put or update the integration for the specified Amazon Connect instance.
PutOutboundRequestBatch ( array $params = [] ): Creates outbound 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.
UpdateCampaignChannelSubtypeConfig ( array $params = [] ): Updates the channel subtype config of a campaign.
UpdateCampaignCommunicationLimits ( array $params = [] ): Updates the communication limits config for a campaign.
UpdateCampaignCommunicationTime ( array $params = [] ): Updates the communication time config for a campaign.
UpdateCampaignFlowAssociation ( array $params = [] ): Updates the campaign flow associated with a campaign.
UpdateCampaignName ( array $params = [] ): Updates the name of a campaign.
UpdateCampaignSchedule ( array $params = [] ): Updates the schedule for a campaign.
UpdateCampaignSource ( array $params = [] ): Updates the campaign source with 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
ListConnectInstanceIntegrations

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([
    'channelSubtypeConfig' => [ // REQUIRED
        'email' => [
            'capacity' => <float>,
            'defaultOutboundConfig' => [ // REQUIRED
                'connectSourceEmailAddress' => '<string>', // REQUIRED
                'sourceEmailAddressDisplayName' => '<string>',
                'wisdomTemplateArn' => '<string>', // REQUIRED
            ],
            'outboundMode' => [ // REQUIRED
                'agentless' => [
                ],
            ],
        ],
        'sms' => [
            'capacity' => <float>,
            'defaultOutboundConfig' => [ // REQUIRED
                'connectSourcePhoneNumberArn' => '<string>', // REQUIRED
                'wisdomTemplateArn' => '<string>', // REQUIRED
            ],
            'outboundMode' => [ // REQUIRED
                'agentless' => [
                ],
            ],
        ],
        'telephony' => [
            'capacity' => <float>,
            'connectQueueId' => '<string>',
            'defaultOutboundConfig' => [ // REQUIRED
                'answerMachineDetectionConfig' => [
                    'awaitAnswerMachinePrompt' => true || false,
                    'enableAnswerMachineDetection' => true || false, // REQUIRED
                ],
                'connectContactFlowId' => '<string>', // REQUIRED
                'connectSourcePhoneNumber' => '<string>',
            ],
            'outboundMode' => [ // REQUIRED
                'agentless' => [
                ],
                'predictive' => [
                    'bandwidthAllocation' => <float>, // REQUIRED
                ],
                'progressive' => [
                    'bandwidthAllocation' => <float>, // REQUIRED
                ],
            ],
        ],
    ],
    'communicationLimitsOverride' => [
        'allChannelSubtypes' => [
            'communicationLimitsList' => [
                [
                    'frequency' => <integer>, // REQUIRED
                    'maxCountPerRecipient' => <integer>, // REQUIRED
                    'unit' => 'DAY', // REQUIRED
                ],
                // ...
            ],
        ],
    ],
    'communicationTimeConfig' => [
        'email' => [
            'openHours' => [ // REQUIRED
                'dailyHours' => [
                    '<DayOfWeek>' => [
                        [
                            'endTime' => '<string>', // REQUIRED
                            'startTime' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    // ...
                ],
            ],
            'restrictedPeriods' => [
                'restrictedPeriodList' => [
                    [
                        'endDate' => '<string>', // REQUIRED
                        'name' => '<string>',
                        'startDate' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
        ],
        'localTimeZoneConfig' => [ // REQUIRED
            'defaultTimeZone' => '<string>',
            'localTimeZoneDetection' => ['<string>', ...],
        ],
        'sms' => [
            'openHours' => [ // REQUIRED
                'dailyHours' => [
                    '<DayOfWeek>' => [
                        [
                            'endTime' => '<string>', // REQUIRED
                            'startTime' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    // ...
                ],
            ],
            'restrictedPeriods' => [
                'restrictedPeriodList' => [
                    [
                        'endDate' => '<string>', // REQUIRED
                        'name' => '<string>',
                        'startDate' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
        ],
        'telephony' => [
            'openHours' => [ // REQUIRED
                'dailyHours' => [
                    '<DayOfWeek>' => [
                        [
                            'endTime' => '<string>', // REQUIRED
                            'startTime' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    // ...
                ],
            ],
            'restrictedPeriods' => [
                'restrictedPeriodList' => [
                    [
                        'endDate' => '<string>', // REQUIRED
                        'name' => '<string>',
                        'startDate' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
        ],
    ],
    'connectCampaignFlowArn' => '<string>',
    'connectInstanceId' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'schedule' => [
        'endTime' => <integer || string || DateTime>, // REQUIRED
        'refreshFrequency' => '<string>',
        'startTime' => <integer || string || DateTime>, // REQUIRED
    ],
    'source' => [
        'customerProfilesSegmentArn' => '<string>',
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

channelSubtypeConfig

: Required: Yes
: Type: ChannelSubtypeConfig structure

Campaign Channel Subtype config

communicationLimitsOverride

: Type: CommunicationLimitsConfig structure

Communication limits config

communicationTimeConfig

: Type: CommunicationTimeConfig structure

Campaign communication time config

connectCampaignFlowArn

: Type: string

Amazon Resource Names(ARN)

connectInstanceId

: Required: Yes
: Type: string

Amazon Connect Instance Id

name

: Required: Yes
: Type: string

The name of an Amazon Connect Campaign name.

schedule

: Type: Schedule structure

Campaign schedule

source

: Type: Source structure

Source of the campaign

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.

DeleteCampaignChannelSubtypeConfig

$result = $client->deleteCampaignChannelSubtypeConfig([/* ... */]);
$promise = $client->deleteCampaignChannelSubtypeConfigAsync([/* ... */]);

Deletes the channel subtype config of a campaign. This API is idempotent.

Parameter Syntax

$result = $client->deleteCampaignChannelSubtypeConfig([
    'channelSubtype' => 'TELEPHONY|SMS|EMAIL', // REQUIRED
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members

channelSubtype

: Required: Yes
: Type: string

The type of campaign channel subtype.

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.

DeleteCampaignCommunicationLimits

$result = $client->deleteCampaignCommunicationLimits([/* ... */]);
$promise = $client->deleteCampaignCommunicationLimitsAsync([/* ... */]);

Deletes the communication limits config for a campaign. This API is idempotent.

Parameter Syntax

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

Parameter Details

Members

config

: Required: Yes
: Type: string

The type of campaign communication limits config.

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.

DeleteCampaignCommunicationTime

$result = $client->deleteCampaignCommunicationTime([/* ... */]);
$promise = $client->deleteCampaignCommunicationTimeAsync([/* ... */]);

Deletes the communication time config for a campaign. This API is idempotent.

Parameter Syntax

$result = $client->deleteCampaignCommunicationTime([
    'config' => 'TELEPHONY|SMS|EMAIL', // REQUIRED
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members

config

: Required: Yes
: Type: string

The type of campaign communication time config

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.

DeleteConnectInstanceConfig

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

Deletes a connect instance config from the specified AWS account.

Parameter Syntax

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

Parameter Details

Members

campaignDeletionPolicy

: Type: string

Enumeration of the policies to enact on existing campaigns during instance config deletion

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.

DeleteConnectInstanceIntegration

$result = $client->deleteConnectInstanceIntegration([/* ... */]);
$promise = $client->deleteConnectInstanceIntegrationAsync([/* ... */]);

Delete the integration for the specified Amazon Connect instance.

Parameter Syntax

$result = $client->deleteConnectInstanceIntegration([
    'connectInstanceId' => '<string>', // REQUIRED
    'integrationIdentifier' => [ // REQUIRED
        'customerProfiles' => [
            'domainArn' => '<string>', // REQUIRED
        ],
        'qConnect' => [
            'knowledgeBaseArn' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Members

connectInstanceId

: Required: Yes
: Type: string

Amazon Connect Instance Id

integrationIdentifier

: Required: Yes
: Type: IntegrationIdentifier structure

Integration identifier for Connect instance

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.

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>',
        'channelSubtypeConfig' => [
            'email' => [
                'capacity' => <float>,
                'defaultOutboundConfig' => [
                    'connectSourceEmailAddress' => '<string>',
                    'sourceEmailAddressDisplayName' => '<string>',
                    'wisdomTemplateArn' => '<string>',
                ],
                'outboundMode' => [
                    'agentless' => [
                    ],
                ],
            ],
            'sms' => [
                'capacity' => <float>,
                'defaultOutboundConfig' => [
                    'connectSourcePhoneNumberArn' => '<string>',
                    'wisdomTemplateArn' => '<string>',
                ],
                'outboundMode' => [
                    'agentless' => [
                    ],
                ],
            ],
            'telephony' => [
                'capacity' => <float>,
                'connectQueueId' => '<string>',
                'defaultOutboundConfig' => [
                    'answerMachineDetectionConfig' => [
                        'awaitAnswerMachinePrompt' => true || false,
                        'enableAnswerMachineDetection' => true || false,
                    ],
                    'connectContactFlowId' => '<string>',
                    'connectSourcePhoneNumber' => '<string>',
                ],
                'outboundMode' => [
                    'agentless' => [
                    ],
                    'predictive' => [
                        'bandwidthAllocation' => <float>,
                    ],
                    'progressive' => [
                        'bandwidthAllocation' => <float>,
                    ],
                ],
            ],
        ],
        'communicationLimitsOverride' => [
            'allChannelSubtypes' => [
                'communicationLimitsList' => [
                    [
                        'frequency' => <integer>,
                        'maxCountPerRecipient' => <integer>,
                        'unit' => 'DAY',
                    ],
                    // ...
                ],
            ],
        ],
        'communicationTimeConfig' => [
            'email' => [
                'openHours' => [
                    'dailyHours' => [
                        '<DayOfWeek>' => [
                            [
                                'endTime' => '<string>',
                                'startTime' => '<string>',
                            ],
                            // ...
                        ],
                        // ...
                    ],
                ],
                'restrictedPeriods' => [
                    'restrictedPeriodList' => [
                        [
                            'endDate' => '<string>',
                            'name' => '<string>',
                            'startDate' => '<string>',
                        ],
                        // ...
                    ],
                ],
            ],
            'localTimeZoneConfig' => [
                'defaultTimeZone' => '<string>',
                'localTimeZoneDetection' => ['<string>', ...],
            ],
            'sms' => [
                'openHours' => [
                    'dailyHours' => [
                        '<DayOfWeek>' => [
                            [
                                'endTime' => '<string>',
                                'startTime' => '<string>',
                            ],
                            // ...
                        ],
                        // ...
                    ],
                ],
                'restrictedPeriods' => [
                    'restrictedPeriodList' => [
                        [
                            'endDate' => '<string>',
                            'name' => '<string>',
                            'startDate' => '<string>',
                        ],
                        // ...
                    ],
                ],
            ],
            'telephony' => [
                'openHours' => [
                    'dailyHours' => [
                        '<DayOfWeek>' => [
                            [
                                'endTime' => '<string>',
                                'startTime' => '<string>',
                            ],
                            // ...
                        ],
                        // ...
                    ],
                ],
                'restrictedPeriods' => [
                    'restrictedPeriodList' => [
                        [
                            'endDate' => '<string>',
                            'name' => '<string>',
                            'startDate' => '<string>',
                        ],
                        // ...
                    ],
                ],
            ],
        ],
        'connectCampaignFlowArn' => '<string>',
        'connectInstanceId' => '<string>',
        'id' => '<string>',
        'name' => '<string>',
        'schedule' => [
            'endTime' => <DateTime>,
            'refreshFrequency' => '<string>',
            'startTime' => <DateTime>,
        ],
        'source' => [
            'customerProfilesSegmentArn' => '<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|Completed',
]

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|Completed',
        ],
        // ...
    ],
]

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>',
            'channelSubtypes' => ['<string>', ...],
            'connectCampaignFlowArn' => '<string>',
            'connectInstanceId' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'schedule' => [
                'endTime' => <DateTime>,
                'refreshFrequency' => '<string>',
                'startTime' => <DateTime>,
            ],
        ],
        // ...
    ],
    '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.

ListConnectInstanceIntegrations

$result = $client->listConnectInstanceIntegrations([/* ... */]);
$promise = $client->listConnectInstanceIntegrationsAsync([/* ... */]);

Provides summary information about the integration under the specified Connect instance.

Parameter Syntax

$result = $client->listConnectInstanceIntegrations([
    'connectInstanceId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

connectInstanceId

: Required: Yes
: Type: string

Amazon Connect Instance Id

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

[
    'integrationSummaryList' => [
        [
            'customerProfiles' => [
                'domainArn' => '<string>',
                'objectTypeNames' => ['<string>', ...],
            ],
            'qConnect' => [
                'knowledgeBaseArn' => '<string>',
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

integrationSummaryList

: Type: Array of IntegrationSummary structures

A list of Amazon Connect Instance Integrations.

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

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

Amazon Resource Names(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.

PutConnectInstanceIntegration

$result = $client->putConnectInstanceIntegration([/* ... */]);
$promise = $client->putConnectInstanceIntegrationAsync([/* ... */]);

Put or update the integration for the specified Amazon Connect instance.

Parameter Syntax

$result = $client->putConnectInstanceIntegration([
    'connectInstanceId' => '<string>', // REQUIRED
    'integrationConfig' => [ // REQUIRED
        'customerProfiles' => [
            'domainArn' => '<string>', // REQUIRED
            'objectTypeNames' => ['<string>', ...], // REQUIRED
        ],
        'qConnect' => [
            'knowledgeBaseArn' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Members

connectInstanceId

: Required: Yes
: Type: string

Amazon Connect Instance Id

integrationConfig

: Required: Yes
: Type: IntegrationConfig structure

Integration config for Connect Instance

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.

PutOutboundRequestBatch

$result = $client->putOutboundRequestBatch([/* ... */]);
$promise = $client->putOutboundRequestBatchAsync([/* ... */]);

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

Parameter Syntax

$result = $client->putOutboundRequestBatch([
    'id' => '<string>', // REQUIRED
    'outboundRequests' => [ // REQUIRED
        [
            'channelSubtypeParameters' => [ // REQUIRED
                'email' => [
                    'connectSourceEmailAddress' => '<string>',
                    'destinationEmailAddress' => '<string>', // REQUIRED
                    'templateArn' => '<string>',
                    'templateParameters' => ['<string>', ...], // REQUIRED
                ],
                'sms' => [
                    'connectSourcePhoneNumberArn' => '<string>',
                    'destinationPhoneNumber' => '<string>', // REQUIRED
                    'templateArn' => '<string>',
                    'templateParameters' => ['<string>', ...], // REQUIRED
                ],
                'telephony' => [
                    'answerMachineDetectionConfig' => [
                        'awaitAnswerMachinePrompt' => true || false,
                        'enableAnswerMachineDetection' => true || false, // REQUIRED
                    ],
                    'attributes' => ['<string>', ...], // REQUIRED
                    'connectSourcePhoneNumber' => '<string>',
                    'destinationPhoneNumber' => '<string>', // REQUIRED
                ],
            ],
            'clientToken' => '<string>', // REQUIRED
            'expirationTime' => <integer || string || DateTime>, // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

id

: Required: Yes
: Type: string

Identifier representing a Campaign

outboundRequests

: Required: Yes
: Type: Array of OutboundRequest structures

A list of outbound requests.

Result Syntax

[
    'failedRequests' => [
        [
            'clientToken' => '<string>',
            'failureCode' => 'InvalidInput|RequestThrottled|UnknownError|BufferLimitExceeded',
            '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

Amazon Resource Names(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

Amazon Resource Names(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.

UpdateCampaignChannelSubtypeConfig

$result = $client->updateCampaignChannelSubtypeConfig([/* ... */]);
$promise = $client->updateCampaignChannelSubtypeConfigAsync([/* ... */]);

Updates the channel subtype config of a campaign. This API is idempotent.

Parameter Syntax

$result = $client->updateCampaignChannelSubtypeConfig([
    'channelSubtypeConfig' => [ // REQUIRED
        'email' => [
            'capacity' => <float>,
            'defaultOutboundConfig' => [ // REQUIRED
                'connectSourceEmailAddress' => '<string>', // REQUIRED
                'sourceEmailAddressDisplayName' => '<string>',
                'wisdomTemplateArn' => '<string>', // REQUIRED
            ],
            'outboundMode' => [ // REQUIRED
                'agentless' => [
                ],
            ],
        ],
        'sms' => [
            'capacity' => <float>,
            'defaultOutboundConfig' => [ // REQUIRED
                'connectSourcePhoneNumberArn' => '<string>', // REQUIRED
                'wisdomTemplateArn' => '<string>', // REQUIRED
            ],
            'outboundMode' => [ // REQUIRED
                'agentless' => [
                ],
            ],
        ],
        'telephony' => [
            'capacity' => <float>,
            'connectQueueId' => '<string>',
            'defaultOutboundConfig' => [ // REQUIRED
                'answerMachineDetectionConfig' => [
                    'awaitAnswerMachinePrompt' => true || false,
                    'enableAnswerMachineDetection' => true || false, // REQUIRED
                ],
                'connectContactFlowId' => '<string>', // REQUIRED
                'connectSourcePhoneNumber' => '<string>',
            ],
            'outboundMode' => [ // REQUIRED
                'agentless' => [
                ],
                'predictive' => [
                    'bandwidthAllocation' => <float>, // REQUIRED
                ],
                'progressive' => [
                    'bandwidthAllocation' => <float>, // REQUIRED
                ],
            ],
        ],
    ],
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members

channelSubtypeConfig

: Required: Yes
: Type: ChannelSubtypeConfig structure

Campaign Channel Subtype config

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.

UpdateCampaignCommunicationLimits

$result = $client->updateCampaignCommunicationLimits([/* ... */]);
$promise = $client->updateCampaignCommunicationLimitsAsync([/* ... */]);

Updates the communication limits config for a campaign. This API is idempotent.

Parameter Syntax

$result = $client->updateCampaignCommunicationLimits([
    'communicationLimitsOverride' => [ // REQUIRED
        'allChannelSubtypes' => [
            'communicationLimitsList' => [
                [
                    'frequency' => <integer>, // REQUIRED
                    'maxCountPerRecipient' => <integer>, // REQUIRED
                    'unit' => 'DAY', // REQUIRED
                ],
                // ...
            ],
        ],
    ],
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members

communicationLimitsOverride

: Required: Yes
: Type: CommunicationLimitsConfig structure

Communication limits config

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.

UpdateCampaignCommunicationTime

$result = $client->updateCampaignCommunicationTime([/* ... */]);
$promise = $client->updateCampaignCommunicationTimeAsync([/* ... */]);

Updates the communication time config for a campaign. This API is idempotent.

Parameter Syntax

$result = $client->updateCampaignCommunicationTime([
    'communicationTimeConfig' => [ // REQUIRED
        'email' => [
            'openHours' => [ // REQUIRED
                'dailyHours' => [
                    '<DayOfWeek>' => [
                        [
                            'endTime' => '<string>', // REQUIRED
                            'startTime' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    // ...
                ],
            ],
            'restrictedPeriods' => [
                'restrictedPeriodList' => [
                    [
                        'endDate' => '<string>', // REQUIRED
                        'name' => '<string>',
                        'startDate' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
        ],
        'localTimeZoneConfig' => [ // REQUIRED
            'defaultTimeZone' => '<string>',
            'localTimeZoneDetection' => ['<string>', ...],
        ],
        'sms' => [
            'openHours' => [ // REQUIRED
                'dailyHours' => [
                    '<DayOfWeek>' => [
                        [
                            'endTime' => '<string>', // REQUIRED
                            'startTime' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    // ...
                ],
            ],
            'restrictedPeriods' => [
                'restrictedPeriodList' => [
                    [
                        'endDate' => '<string>', // REQUIRED
                        'name' => '<string>',
                        'startDate' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
        ],
        'telephony' => [
            'openHours' => [ // REQUIRED
                'dailyHours' => [
                    '<DayOfWeek>' => [
                        [
                            'endTime' => '<string>', // REQUIRED
                            'startTime' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    // ...
                ],
            ],
            'restrictedPeriods' => [
                'restrictedPeriodList' => [
                    [
                        'endDate' => '<string>', // REQUIRED
                        'name' => '<string>',
                        'startDate' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
        ],
    ],
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members

communicationTimeConfig

: Required: Yes
: Type: CommunicationTimeConfig structure

Campaign communication time config

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.

UpdateCampaignFlowAssociation

$result = $client->updateCampaignFlowAssociation([/* ... */]);
$promise = $client->updateCampaignFlowAssociationAsync([/* ... */]);

Updates the campaign flow associated with a campaign. This API is idempotent.

Parameter Syntax

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

Parameter Details

Members

connectCampaignFlowArn

: Required: Yes
: Type: string

Amazon Resource Names(ARN)

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.

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.

UpdateCampaignSchedule

$result = $client->updateCampaignSchedule([/* ... */]);
$promise = $client->updateCampaignScheduleAsync([/* ... */]);

Updates the schedule for a campaign. This API is idempotent.

Parameter Syntax

$result = $client->updateCampaignSchedule([
    'id' => '<string>', // REQUIRED
    'schedule' => [ // REQUIRED
        'endTime' => <integer || string || DateTime>, // REQUIRED
        'refreshFrequency' => '<string>',
        'startTime' => <integer || string || DateTime>, // REQUIRED
    ],
]);

Parameter Details

Members

id

: Required: Yes
: Type: string

Identifier representing a Campaign

schedule

: Required: Yes
: Type: Schedule structure

Campaign schedule

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.

UpdateCampaignSource

$result = $client->updateCampaignSource([/* ... */]);
$promise = $client->updateCampaignSourceAsync([/* ... */]);

Updates the campaign source with a campaign. This API is idempotent.

Parameter Syntax

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

Parameter Details

Members

id

: Required: Yes
: Type: string

Identifier representing a Campaign

source

: Required: Yes
: Type: Source structure

Source of the 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.

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.

AgentlessConfig

Description

Agentless config

Members

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.

channelSubtypeConfig

: Required: Yes
: Type: ChannelSubtypeConfig structure

Campaign Channel Subtype config

communicationLimitsOverride

: Type: CommunicationLimitsConfig structure

Communication limits config

communicationTimeConfig

: Type: CommunicationTimeConfig structure

Campaign communication time config

connectCampaignFlowArn

: Type: string

Amazon Resource Names(ARN)

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.

schedule

: Type: Schedule structure

Campaign schedule

source

: Type: Source structure

Source of the campaign

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.

channelSubtypes

: Required: Yes
: Type: Array of strings

Channel subtype list

connectCampaignFlowArn

: Type: string

Amazon Resource Names(ARN)

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.

schedule

: Type: Schedule structure

Campaign schedule

ChannelSubtypeConfig

Description

Campaign Channel Subtype config

Members

email

: Type: EmailChannelSubtypeConfig structure

Email Channel Subtype config

sms

: Type: SmsChannelSubtypeConfig structure

SMS Channel Subtype config

telephony

: Type: TelephonyChannelSubtypeConfig structure

Telephony Channel Subtype config

ChannelSubtypeParameters

Description

ChannelSubtypeParameters for an outbound request

Members

email

: Type: EmailChannelSubtypeParameters structure

Parameters for the Email Channel Subtype

sms

: Type: SmsChannelSubtypeParameters structure

Parameters for the SMS Channel Subtype

telephony

: Type: TelephonyChannelSubtypeParameters structure

Parameters for the Telephony Channel Subtype

CommunicationLimit

Description

Communication Limit

Members

frequency

: Required: Yes
: Type: int

The number of days to consider with regards to this limit.

maxCountPerRecipient

: Required: Yes
: Type: int

Maximum number of contacts allowed for a given target within the given frequency.

unit

: Required: Yes
: Type: string

The communication limit time unit.

CommunicationLimits

Description

Communication limits

Members

communicationLimitsList

: Type: Array of CommunicationLimit structures

List of communication limit

CommunicationLimitsConfig

Description

Communication limits config

Members

allChannelSubtypes

: Type: CommunicationLimits structure

Communication limits

CommunicationTimeConfig

Description

Campaign communication time config

Members

email

: Type: TimeWindow structure

Time window config

localTimeZoneConfig

: Required: Yes
: Type: LocalTimeZoneConfig structure

Local time zone config

sms

: Type: TimeWindow structure

Time window config

telephony

: Type: TimeWindow structure

Time window config

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.

CustomerProfilesIntegrationConfig

Description

Customer Profiles integration config

Members

domainArn

: Required: Yes
: Type: string

Amazon Resource Names(ARN)

objectTypeNames

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

Object type names map.

CustomerProfilesIntegrationIdentifier

Description

Customer Profiles integration identifier

Members

domainArn

: Required: Yes
: Type: string

Amazon Resource Names(ARN)

CustomerProfilesIntegrationSummary

Description

Customer Profiles integration summary

Members

domainArn

: Required: Yes
: Type: string

Amazon Resource Names(ARN)

objectTypeNames

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

Object type names map.

EmailChannelSubtypeConfig

Description

Email Channel Subtype config

Members

capacity

: Type: double

Allocates outbound capacity for the specific channel subtype of this campaign between multiple active campaigns

defaultOutboundConfig

: Required: Yes
: Type: EmailOutboundConfig structure

Default Email Outbound config

outboundMode

: Required: Yes
: Type: EmailOutboundMode structure

Email Outbound Mode

EmailChannelSubtypeParameters

Description

Parameters for the Email Channel Subtype

Members

connectSourceEmailAddress

: Type: string

Source/Destination Email address used for Email messages

destinationEmailAddress

: Required: Yes
: Type: string

Source/Destination Email address used for Email messages

templateArn

: Type: string

Amazon Resource Names(ARN)

templateParameters

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

EmailOutboundConfig

Description

Default Email Outbound config

Members

connectSourceEmailAddress

: Required: Yes
: Type: string

Source/Destination Email address used for Email messages

sourceEmailAddressDisplayName

: Type: string

Display name for Email Address

wisdomTemplateArn

: Required: Yes
: Type: string

Amazon Resource Names(ARN)

EmailOutboundMode

Description

Email Outbound Mode

Members

agentless

: Type: AgentlessConfig structure

Agentless 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

IntegrationConfig

Description

Integration config for Connect Instance

Members

customerProfiles

: Type: CustomerProfilesIntegrationConfig structure

Customer Profiles integration config

qConnect

: Type: QConnectIntegrationConfig structure

Q Connect integration config

IntegrationIdentifier

Description

Integration identifier for Connect instance

Members

customerProfiles

: Type: CustomerProfilesIntegrationIdentifier structure

Customer Profiles integration identifier

qConnect

: Type: QConnectIntegrationIdentifier structure

Q Connect integration identifier

IntegrationSummary

Description

Integration summary for Connect instance.

Members

customerProfiles

: Type: CustomerProfilesIntegrationSummary structure

Customer Profiles integration summary

qConnect

: Type: QConnectIntegrationSummary structure

Q Connect integration summary

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.

LocalTimeZoneConfig

Description

Local time zone config

Members

defaultTimeZone

: Type: string

Time Zone Id in the IANA format

localTimeZoneDetection

: Type: Array of strings

Local TimeZone Detection method list

OpenHours

Description

Open Hours config

Members

dailyHours

: Type: Associative array of custom strings keys (DayOfWeek) to TimeRange structuress

Daily Hours map

OutboundRequest

Description

An outbound request for a campaign.

Members

channelSubtypeParameters

: Required: Yes
: Type: ChannelSubtypeParameters structure

ChannelSubtypeParameters for an outbound request

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

PredictiveConfig

Description

Predictive config

Members

bandwidthAllocation

: Required: Yes
: Type: double

The bandwidth allocation of a queue resource.

ProgressiveConfig

Description

Progressive config

Members

bandwidthAllocation

: Required: Yes
: Type: double

The bandwidth allocation of a queue resource.

QConnectIntegrationConfig

Description

Q Connect integration config

Members

knowledgeBaseArn

: Required: Yes
: Type: string

Amazon Resource Names(ARN)

QConnectIntegrationIdentifier

Description

Q Connect integration identifier

Members

knowledgeBaseArn

: Required: Yes
: Type: string

Amazon Resource Names(ARN)

QConnectIntegrationSummary

Description

Q Connect integration summary

Members

knowledgeBaseArn

: Required: Yes
: Type: string

Amazon Resource Names(ARN)

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.

RestrictedPeriod

Description

Restricted period

Members

endDate

: Required: Yes
: Type: string

Date in ISO 8601 format, e.g. 2024-01-01

name

: Type: string

The name of a restricted period.

startDate

: Required: Yes
: Type: string

Date in ISO 8601 format, e.g. 2024-01-01

RestrictedPeriods

Description

Restricted period config

Members

restrictedPeriodList

: Type: Array of RestrictedPeriod structures

List of restricted period

Schedule

Description

Campaign schedule

Members

endTime

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

Timestamp with no UTC offset or timezone

refreshFrequency

: Type: string

Time duration in ISO 8601 format

startTime

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

Timestamp with no UTC offset or timezone

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.

SmsChannelSubtypeConfig

Description

SMS Channel Subtype config

Members

capacity

: Type: double

Allocates outbound capacity for the specific channel subtype of this campaign between multiple active campaigns

defaultOutboundConfig

: Required: Yes
: Type: SmsOutboundConfig structure

Default SMS Outbound config

outboundMode

: Required: Yes
: Type: SmsOutboundMode structure

SMS Outbound Mode

SmsChannelSubtypeParameters

Description

Parameters for the SMS Channel Subtype

Members

connectSourcePhoneNumberArn

: Type: string

Amazon Resource Names(ARN)

destinationPhoneNumber

: Required: Yes
: Type: string

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

templateArn

: Type: string

Amazon Resource Names(ARN)

templateParameters

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

SmsOutboundConfig

Description

Default SMS Outbound config

Members

connectSourcePhoneNumberArn

: Required: Yes
: Type: string

Amazon Resource Names(ARN)

wisdomTemplateArn

: Required: Yes
: Type: string

Amazon Resource Names(ARN)

SmsOutboundMode

Description

SMS Outbound Mode

Members

agentless

: Type: AgentlessConfig structure

Agentless config

Source

Description

Source of the campaign

Members

customerProfilesSegmentArn

: Type: string

Amazon Resource Names(ARN)

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

TelephonyChannelSubtypeConfig

Description

Telephony Channel Subtype config

Members

capacity

: Type: double

Allocates outbound capacity for the specific channel subtype of this campaign between multiple active campaigns

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.

defaultOutboundConfig

: Required: Yes
: Type: TelephonyOutboundConfig structure

Default Telephony Outbound config

outboundMode

: Required: Yes
: Type: TelephonyOutboundMode structure

Telephony Outbound Mode

TelephonyChannelSubtypeParameters

Description

Parameters for the Telephony Channel Subtype

Members

answerMachineDetectionConfig

: Type: AnswerMachineDetectionConfig structure

Answering Machine Detection config

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.

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.

destinationPhoneNumber

: Required: Yes
: Type: string

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

TelephonyOutboundConfig

Description

Default Telephony Outbound config

Members

answerMachineDetectionConfig

: Type: AnswerMachineDetectionConfig structure

Answering Machine Detection config

connectContactFlowId

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

TelephonyOutboundMode

Description

Telephony Outbound Mode

Members

agentless

: Type: AgentlessConfig structure

Agentless config

predictive

: Type: PredictiveConfig structure

Predictive config

progressive

: Type: ProgressiveConfig structure

Progressive config

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.

TimeRange

Description

Time range in 24 hour format

Members

endTime

: Required: Yes
: Type: string

Time in ISO 8601 format, e.g. T23:11

startTime

: Required: Yes
: Type: string

Time in ISO 8601 format, e.g. T23:11

TimeWindow

Description

Time window config

Members

openHours

: Required: Yes
: Type: OpenHours structure

Open Hours config

restrictedPeriods

: Type: RestrictedPeriods structure

Restricted period config

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.

AmazonConnectCampaignServiceV2 2024-04-23

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

DeleteCampaignChannelSubtypeConfig

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteCampaignCommunicationLimits

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteCampaignCommunicationTime

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteConnectInstanceConfig

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteConnectInstanceIntegration

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