KinesisVideo / Client / list_streams

list_streams#

KinesisVideo.Client.list_streams(**kwargs)#

Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a StreamNameCondition.

Request Syntax

response = client.list_streams(
    MaxResults=123,
    NextToken='string',
    StreamNameCondition={
        'ComparisonOperator': 'BEGINS_WITH',
        'ComparisonValue': 'string'
    }
)

Parameters:

MaxResults (integer) – The maximum number of streams to return in the response. The default is 10,000.
NextToken (string) – If you specify this parameter, when the result of a ListStreams operation is truncated, the call returns the NextToken in the response. To get another batch of streams, provide this token in your next request.
StreamNameCondition (dict) –
Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.
- ComparisonOperator (string) –
  
  A comparison operator. Currently, you can specify only the BEGINS_WITH operator, which finds streams whose names start with a given prefix.
- ComparisonValue (string) –
  
  A value to compare.

Return type:

dict

Returns:

Response Syntax

{
    'StreamInfoList': [
        {
            'DeviceName': 'string',
            'StreamName': 'string',
            'StreamARN': 'string',
            'MediaType': 'string',
            'KmsKeyId': 'string',
            'Version': 'string',
            'Status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING',
            'CreationTime': datetime(2015, 1, 1),
            'DataRetentionInHours': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- StreamInfoList (list) –
  
  An array of StreamInfo objects.
  - (dict) –
    
    An object describing a Kinesis video stream.
    - DeviceName (string) –
      
      The name of the device that is associated with the stream.
    - StreamName (string) –
      
      The name of the stream.
    - StreamARN (string) –
      
      The Amazon Resource Name (ARN) of the stream.
    - MediaType (string) –
      
      The MediaType of the stream.
    - KmsKeyId (string) –
      
      The ID of the Key Management Service (KMS) key that Kinesis Video Streams uses to encrypt data on the stream.
    - Version (string) –
      
      The version of the stream.
    - Status (string) –
      
      The status of the stream.
    - CreationTime (datetime) –
      
      A time stamp that indicates when the stream was created.
    - DataRetentionInHours (integer) –
      
      How long the stream retains data, in hours.
- NextToken (string) –
  
  If the response is truncated, the call returns this element with a token. To get the next batch of streams, use this token in your next request.

Exceptions

KinesisVideo.Client.exceptions.ClientLimitExceededException
KinesisVideo.Client.exceptions.InvalidArgumentException