IoT / Paginator / ListStreams


class IoT.Paginator.ListStreams#
paginator = client.get_paginator('list_streams')

Creates an iterator that will paginate through responses from IoT.Client.list_streams().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • ascendingOrder (boolean) – Set to true to return the list of streams in ascending order.

  • 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:



Response Syntax

    'streams': [
            'streamId': 'string',
            'streamArn': 'string',
            'streamVersion': 123,
            'description': 'string'
    'NextToken': 'string'

Response Structure

  • (dict) –

    • streams (list) –

      A list of streams.

      • (dict) –

        A summary of a stream.

        • streamId (string) –

          The stream ID.

        • streamArn (string) –

          The stream ARN.

        • streamVersion (integer) –

          The stream version.

        • description (string) –

          A description of the stream.

    • NextToken (string) –

      A token to resume pagination.