IoTFleetWise / Client / list_campaigns

list_campaigns#

IoTFleetWise.Client.list_campaigns(**kwargs)#

Lists information about created campaigns.

Note

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

See also: AWS API Documentation

Request Syntax

response = client.list_campaigns(
    nextToken='string',
    maxResults=123,
    status='string'
)
Parameters:

  • nextToken (string) –

    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.

  • maxResults (integer) – The maximum number of items to return, between 1 and 100, inclusive.

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

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) –

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

Exceptions