ListCampaigns

class IoTFleetWise.Paginator.ListCampaigns

paginator = client.get_paginator('list_campaigns')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTFleetWise.Client.list_campaigns().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    status='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

• status (string) -- 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 .
• PaginationConfig (dict) --

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'campaignSummaries': [
        {
            'arn': 'string',
            'name': 'string',
            'description': 'string',
            'signalCatalogArn': 'string',
            'targetArn': 'string',
            'status': 'CREATING'|'WAITING_FOR_APPROVAL'|'RUNNING'|'SUSPENDED',
            'creationTime': datetime(2015, 1, 1),
            'lastModificationTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • campaignSummaries (list) --

    A summary of information about each campaign.

    • (dict) --

      Information about a campaign.

      You can use the API operation to return this information about multiple created campaigns.

      • arn (string) --

        The Amazon Resource Name (ARN) of a campaign.

      • name (string) --

        The name of a campaign.

      • description (string) --

        The description of the campaign.

      • signalCatalogArn (string) --

        The ARN of the signal catalog associated with the campaign.

      • targetArn (string) --

        The ARN of a vehicle or fleet to which the campaign is deployed.

      • status (string) --

        The state of a campaign. The status can be one of the following:

        • CREATING - Amazon Web Services IoT FleetWise is processing your request to create the campaign.
        • WAITING_FOR_APPROVAL - After a campaign is created, it enters the WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the API operation to approve the campaign.
        • RUNNING - The campaign is active.
        • SUSPENDED - The campaign is suspended. To resume the campaign, use the API operation.

      • creationTime (datetime) --

        The time the campaign was created.

      • lastModificationTime (datetime) --

        The last time the campaign was modified.

  • NextToken (string) --

    A token to resume pagination.