IoT1ClickProjects / Paginator / ListPlacements

ListPlacements

class IoT1ClickProjects.Paginator.ListPlacements

paginator = client.get_paginator('list_placements')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• projectName (string) –

  [REQUIRED]

  The project containing the placements to be listed.

• 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

{
    'placements': [
        {
            'projectName': 'string',
            'placementName': 'string',
            'createdDate': datetime(2015, 1, 1),
            'updatedDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • placements (list) –

    An object listing the requested placements.

    • (dict) –

      An object providing summary information for a particular placement.

      • projectName (string) –

        The name of the project containing the placement.

      • placementName (string) –

        The name of the placement being summarized.

      • createdDate (datetime) –

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

      • updatedDate (datetime) –

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

  • NextToken (string) –

    A token to resume pagination.