Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1457355285.1 KB

Lists information about created campaigns.

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

post/#X-Amz-Target=IoTAutobahnControlPlane.ListCampaigns

Headers

X-Amz-Target'IoTAutobahnControlPlane.ListCampaigns' required

Request body

nextTokenstring
<p>A pagination token for the next set of results.</p> <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> 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. </p>
maxResultsinteger

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

statusstring

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

listResponseScope'METADATA_ONLY'

When you set the <code>listResponseScope</code> parameter to <code>METADATA_ONLY</code>, the list response includes: campaign name, Amazon Resource Name (ARN), creation time, and last modification time.

Response

Success

nextTokenstring

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