Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListCampaigns

Lists information about created campaigns.

Note

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

Request Syntax


{
   "maxResults": number,
   "nextToken": "string",
   "status": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

maxResults

The maximum number of items to return, between 1 and 100, inclusive.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

Required: No

status

An optional parameter to filter the results by the status of each created campaign in your account. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, or SUSPENDED.

Type: String

Required: No

Response Syntax


{
   "campaignSummaries": [ 
      { 
         "arn": "string",
         "creationTime": number,
         "description": "string",
         "lastModificationTime": number,
         "name": "string",
         "signalCatalogArn": "string",
         "status": "string",
         "targetArn": "string"
      }
   ],
   "nextToken": "string"
}

Response Elements

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

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

campaignSummaries

A summary of information about each campaign.

Type: Array of CampaignSummary objects

nextToken

The token to retrieve the next set of results, or null if there are no more results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

Errors

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

AccessDeniedException

You don't have sufficient permission to perform this action.

HTTP Status Code: 400

InternalServerException

The request couldn't be completed because the server temporarily failed.

HTTP Status Code: 500

ThrottlingException

The request couldn't be completed due to throttling.

HTTP Status Code: 400

ValidationException

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

HTTP Status Code: 400