ListCampaignsRequest

ListCampaignsRequest schema

AutomotiveConnected VehiclesIoTTelematicsVehicle Data

Properties

Name Type Description
nextToken object
maxResults object
status object
View JSON Schema on GitHub

JSON Schema

iot-fleetwise-list-campaigns-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-fleetwise/refs/heads/main/json-schema/iot-fleetwise-list-campaigns-request-schema.json",
  "title": "ListCampaignsRequest",
  "description": "ListCampaignsRequest schema",
  "type": "object",
  "properties": {
    "nextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/nextToken"
        },
        {
          "description": "<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>"
        }
      ]
    },
    "maxResults": {
      "allOf": [
        {
          "$ref": "#/components/schemas/maxResults"
        },
        {
          "description": " The maximum number of items to return, between 1 and 100, inclusive. "
        }
      ]
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/status"
        },
        {
          "description": "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>."
        }
      ]
    }
  }
}