IoTFleetHub / Paginator / ListApplications

ListApplications

class IoTFleetHub.Paginator.ListApplications

paginator = client.get_paginator('list_applications')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTFleetHub.Client.list_applications().

See also: AWS API Documentation

Request Syntax

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

Parameters:

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.

• StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'applicationSummaries': [
        {
            'applicationId': 'string',
            'applicationName': 'string',
            'applicationDescription': 'string',
            'applicationUrl': 'string',
            'applicationCreationDate': 123,
            'applicationLastUpdateDate': 123,
            'applicationState': 'CREATING'|'DELETING'|'ACTIVE'|'CREATE_FAILED'|'DELETE_FAILED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • applicationSummaries (list) –

    An array of objects that provide summaries of information about the web applications in the list.

    • (dict) –

      A summary of information about a Fleet Hub for IoT Device Management web application.

      • applicationId (string) –

        The unique Id of the web application.

      • applicationName (string) –

        The name of the web application.

      • applicationDescription (string) –

        An optional description of the web application.

      • applicationUrl (string) –

        The URL of the web application.

      • applicationCreationDate (integer) –

        The date (in Unix epoch time) when the web application was created.

      • applicationLastUpdateDate (integer) –

        The date (in Unix epoch time) when the web application was last updated.

      • applicationState (string) –

        The current state of the web application.

  • NextToken (string) –

    A token to resume pagination.