ConnectCampaignService / Client / get_campaign_state_batch

get_campaign_state_batch#

ConnectCampaignService.Client.get_campaign_state_batch(**kwargs)#

Get state of campaigns for the specified Amazon Connect account.

See also: AWS API Documentation

Request Syntax

response = client.get_campaign_state_batch(
    campaignIds=[
        'string',
    ]
)
Parameters:

campaignIds (list) –

[REQUIRED]

List of CampaignId

  • (string) –

    Identifier representing a Campaign

Return type:

dict

Returns:

Response Syntax

{
    'successfulRequests': [
        {
            'campaignId': 'string',
            'state': 'Initialized'|'Running'|'Paused'|'Stopped'|'Failed'
        },
    ],
    'failedRequests': [
        {
            'campaignId': 'string',
            'failureCode': 'ResourceNotFound'|'UnknownError'
        },
    ]
}

Response Structure

  • (dict) –

    GetCampaignStateBatchResponse

    • successfulRequests (list) –

      List of successful response of campaign state

      • (dict) –

        Successful response of campaign state

        • campaignId (string) –

          Identifier representing a Campaign

        • state (string) –

          State of a campaign

    • failedRequests (list) –

      List of failed requests of campaign state

      • (dict) –

        Failed response of campaign state

        • campaignId (string) –

          Identifier representing a Campaign

        • failureCode (string) –

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

Exceptions