describe_stream

IoT.Client.describe_stream(**kwargs)

Gets information about a stream.

Requires permission to access the DescribeStream action.

See also: AWS API Documentation

Request Syntax

response = client.describe_stream(
    streamId='string'
)

Parameters

streamId (string) --

[REQUIRED]

The stream ID.

Return type

dict

Returns

Response Syntax

{
    'streamInfo': {
        'streamId': 'string',
        'streamArn': 'string',
        'streamVersion': 123,
        'description': 'string',
        'files': [
            {
                'fileId': 123,
                's3Location': {
                    'bucket': 'string',
                    'key': 'string',
                    'version': 'string'
                }
            },
        ],
        'createdAt': datetime(2015, 1, 1),
        'lastUpdatedAt': datetime(2015, 1, 1),
        'roleArn': 'string'
    }
}

Response Structure

• (dict) --
  • streamInfo (dict) --

    Information about the stream.

    • streamId (string) --

      The stream ID.

    • streamArn (string) --

      The stream ARN.

    • streamVersion (integer) --

      The stream version.

    • description (string) --

      The description of the stream.

    • files (list) --

      The files to stream.

      • (dict) --

        Represents a file to stream.

        • fileId (integer) --

          The file ID.

        • s3Location (dict) --

          The location of the file in S3.

          • bucket (string) --

            The S3 bucket.

          • key (string) --

            The S3 key.

          • version (string) --

            The S3 bucket version.

    • createdAt (datetime) --

      The date when the stream was created.

    • lastUpdatedAt (datetime) --

      The date when the stream was last updated.

    • roleArn (string) --

      An IAM role IoT assumes to access your S3 files.

Exceptions

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