ListCampaigns
Lists outbound campaigns.
Request Syntax
POST /v2/campaigns-summary HTTP/1.1
Content-type: application/json
{
"filters": {
"instanceIdFilter": {
"operator": "string",
"value": "string"
}
},
"maxResults": number,
"nextToken": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- filters
-
Filters the list of campaigns.
Type: CampaignFilters object
Required: No
- maxResults
-
The maximum number of results to return per page.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No
- nextToken
-
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"campaignSummaryList": [
{
"arn": "string",
"channelSubtypes": [ "string" ],
"connectCampaignFlowArn": "string",
"connectInstanceId": "string",
"id": "string",
"name": "string",
"schedule": {
"endTime": "string",
"refreshFrequency": "string",
"startTime": "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.
- campaignSummaryList
-
Summary information about the outbound campaigns.
Type: Array of CampaignSummary objects
- nextToken
-
If there are additional results, this is the token for the next set of results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Errors
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
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
