get_campaign_state

get_campaign_state(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_campaign_state(
    id='string'
)
Parameters
id (string) --

[REQUIRED]

Identifier representing a Campaign

Return type
dict
Returns
Response Syntax
{
    'state': 'Initialized'|'Running'|'Paused'|'Stopped'|'Failed'
}

Response Structure

  • (dict) --

    GetCampaignStateResponse

    • state (string) --

      State of a campaign

Exceptions

  • ConnectCampaignService.Client.exceptions.InternalServerException
  • ConnectCampaignService.Client.exceptions.ResourceNotFoundException
  • ConnectCampaignService.Client.exceptions.ValidationException
  • ConnectCampaignService.Client.exceptions.AccessDeniedException
  • ConnectCampaignService.Client.exceptions.ThrottlingException