IoT1ClickProjects / Paginator / ListProjects

ListProjects

class IoT1ClickProjects.Paginator.ListProjects

paginator = client.get_paginator('list_projects')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT1ClickProjects.Client.list_projects().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 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.

• 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

{
    'projects': [
        {
            'arn': 'string',
            'projectName': 'string',
            'createdDate': datetime(2015, 1, 1),
            'updatedDate': datetime(2015, 1, 1),
            'tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • projects (list) –

    An object containing the list of projects.

    • (dict) –

      An object providing summary information for a particular project for an associated AWS account and region.

      • arn (string) –

        The ARN of the project.

      • projectName (string) –

        The name of the project being summarized.

      • createdDate (datetime) –

        The date when the project was originally created, in UNIX epoch time format.

      • updatedDate (datetime) –

        The date when the project was last updated, in UNIX epoch time format. If the project was not updated, then createdDate and updatedDate are the same.

      • tags (dict) –

        The tags (metadata key/value pairs) associated with the project.

        • (string) –

          • (string) –

  • NextToken (string) –

    A token to resume pagination.