describe-stream¶
Description¶
Gets information about a stream.
See also: AWS API Documentation
See 'aws help' for descriptions of global parameters.
Synopsis¶
describe-stream
--stream-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
Options¶
--stream-id (string)
The stream ID.
--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See 'aws help' for descriptions of global parameters.
Output¶
streamInfo -> (structure)
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.
(structure)
Represents a file to stream.
fileId -> (integer)
The file ID.s3Location -> (structure)
The location of the file in S3.
bucket -> (string)
The S3 bucket that contains the file to stream.key -> (string)
The name of the file within the S3 bucket to stream.version -> (string)
The file version.createdAt -> (timestamp)
The date when the stream was created.lastUpdatedAt -> (timestamp)
The date when the stream was last updated.roleArn -> (string)
An IAM role AWS IoT assumes to access your S3 files.