ConnectCampaignServiceV2 / Client / get_campaign_state

get_campaign_state#

ConnectCampaignServiceV2.Client.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'|'Completed'
}

Response Structure

(dict) –

The response for GetCampaignState API.
- state (string) –
  
  State of a campaign

Exceptions

ConnectCampaignServiceV2.Client.exceptions.InternalServerException
ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundException
ConnectCampaignServiceV2.Client.exceptions.ValidationException
ConnectCampaignServiceV2.Client.exceptions.AccessDeniedException
ConnectCampaignServiceV2.Client.exceptions.ThrottlingException