GetCampaignState

Returns the state of an outbound campaign.

Request Syntax


GET /v2/campaigns/id/state HTTP/1.1

The request uses the following URI parameters.

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [a-zA-Z0-9\-:/]*

Required: Yes

The request does not have a request body.


HTTP/1.1 200
Content-type: application/json

{
   "state": "string"
}

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

The state of a campaign. For detailed descriptions of each state, see Campaign status in the Amazon Connect Administrator Guide.

Type: String

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

This exception occurs when there is an internal failure in the outbound campaigns.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

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

HTTP Status Code: 400