Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ivs ]

get-stream

Description

Gets information about the active (live) stream on a specified channel.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-stream
--channel-arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--channel-arn (string)

Channel ARN for stream to be accessed.

--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.

Examples

To get information about a stream

The following get-stream example gets information about the stream for the specified channel.

aws ivs get-stream \
    --channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh

Output:

{
    "stream": {
        "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
        "startTime": "2020-05-05T21:55:38Z",
        "state": "LIVE",
        "health": "HEALTHY",
        "viewerCount": 1
    }
}

For more information, see Create a Channel in the Amazon Interactive Video Service User Guide.

Output

stream -> (structure)

Specifies a live video stream that has been ingested and distributed.

channelArn -> (string)

Channel ARN for the stream.

playbackUrl -> (string)

URL of the video master manifest, required by the video player to play the HLS stream.

startTime -> (timestamp)

ISO-8601 formatted timestamp of the stream’s start.

state -> (string)

The stream’s state.

health -> (string)

The stream’s health.

viewerCount -> (long)

Number of current viewers of the stream.