IoT / Client / list_streams

list_streams#

IoT.Client.list_streams(**kwargs)#

Lists all of the streams in your Amazon Web Services account.

Requires permission to access the ListStreams action.

Request Syntax

response = client.list_streams(
    maxResults=123,
    nextToken='string',
    ascendingOrder=True|False
)

Parameters:

maxResults (integer) – The maximum number of results to return at a time.
nextToken (string) – A token used to get the next set of results.
ascendingOrder (boolean) – Set to true to return the list of streams in ascending order.

Return type:

dict

Returns:

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 used to get the next set of results.

Exceptions

IoT.Client.exceptions.InvalidRequestException
IoT.Client.exceptions.ThrottlingException
IoT.Client.exceptions.UnauthorizedException
IoT.Client.exceptions.ServiceUnavailableException
IoT.Client.exceptions.InternalFailureException