get-stream-session¶

Description¶

Gets metadata on a specified stream.

Synopsis¶

  get-stream-session
--channel-arn <value>
[--stream-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--channel-arn (string)

ARN of the channel resource

--stream-id (string)

Unique identifier for a live or previously live stream in the specified channel. If no streamId is provided, this returns the most recent stream session for the channel, if it exists.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To get metadata for a specified stream

The following get-stream-session example gets the metadata configuration for the specified channel ARN (Amazon Resource Name) and the specified stream; if streamId is not provided, the most recent stream for the channel is selected.

aws ivs get-stream-session \
    --channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \
    --stream-id "mystream"

Output:

{
    "streamSession": {
        "channel": {
            "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
            "authorized": true,
            "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
            "latencyMode": "LOW",
            "name": "mychannel",
            "playbackUrl": "url-string",
            "recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ",
            "tags": {
                "key1" : "value1",
                "key2" : "value2"
            },
            "type": "STANDARD"
        },
        "startTime": 1641578182,
        "endTime": 1641579982,
        "ingestConfiguration": {
            "audio": {
                "channels": 2,
                "codec": "mp4a.40.2",
                "sampleRate": 8000,
                "targetBitrate": 46875
            },
            "video": {
                "avcLevel": "4.2",
                "avcProfile": "Baseline",
                "codec": "avc1.42C02A",
                "encoder": "Lavf58.45.100",
                "targetBitrate": 8789062,
                "targetFrameRate": 60,
                "videoHeight": 1080,
                "videoWidth": 1920
            }
        },
        "recordingConfiguration": {
            "arn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ",
            "destinationConfiguration": {
                "s3": {
                   "bucketName": "demo-recording-bucket"
                }
            },
            "name": "test-recording-config",
            "recordingReconnectWindowSeconds": 60,
            "state": "ACTIVE",
            "tags": {
                "rkey1" : "rvalue1"
            },
            "thumbnailConfiguration": {
                "recordingMode": "INTERVAL",
                "targetIntervalSeconds": 30
            }
        },

        "streamId": "mystream1",
        "truncatedEvents": [
            {
                "eventTime": 1641579941,
                "name": "Session Ended",
                "type": "IVS Stream State Change"
            }
        ]
    }
}

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

Output¶

streamSession -> (structure)

List of stream details.

channel -> (structure)

The properties of the channel at the time of going live.

arn -> (string)

Channel ARN.

authorized -> (boolean)

Whether the channel is private (enabled for playback authorization). Default: false .

ingestEndpoint -> (string)

Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

latencyMode -> (string)

Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW . (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

name -> (string)

Channel name.

playbackUrl -> (string)

Channel playback URL.

recordingConfigurationArn -> (string)

Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: “” (empty string, recording is disabled).

tags -> (map)

Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value) . See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no service-specific constraints beyond what is documented there.

key -> (string)

value -> (string)

type -> (string)

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD . Valid values:

STANDARD : Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.

BASIC : Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

endTime -> (timestamp)

Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string . For live streams, this is NULL .

ingestConfiguration -> (structure)

The properties of the incoming RTMP stream for the stream.

audio -> (structure)

Encoder settings for audio.

channels -> (long)

Number of audio channels.

codec -> (string)

Codec used for the audio encoding.

sampleRate -> (long)

Number of audio samples recorded per second.

targetBitrate -> (long)

The expected ingest bitrate (bits per second). This is configured in the encoder.

video -> (structure)

Encoder settings for video.

avcLevel -> (string)

Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. For details, see the H.264 specification.

avcProfile -> (string)

Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification.

codec -> (string)

Codec used for the video encoding.

encoder -> (string)

Software or hardware used to encode the video.

targetBitrate -> (long)

The expected ingest bitrate (bits per second). This is configured in the encoder.

targetFramerate -> (long)

The expected ingest framerate. This is configured in the encoder.

videoHeight -> (long)

Video-resolution height in pixels.

videoWidth -> (long)

Video-resolution width in pixels.

recordingConfiguration -> (structure)

The properties of recording the live stream.

arn -> (string)

Recording-configuration ARN.

destinationConfiguration -> (structure)

A complex type that contains information about where recorded video will be stored.

s3 -> (structure)

An S3 destination configuration where recorded videos will be stored.

bucketName -> (string)

Location (S3 bucket name) where recorded videos will be stored.

name -> (string)

Recording-configuration name. The value does not need to be unique.

recordingReconnectWindowSeconds -> (integer)

If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.

state -> (string)

Indicates the current state of the recording configuration. When the state is ACTIVE , the configuration is ready for recording a channel stream.

tags -> (map)

Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value) . See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no service-specific constraints beyond what is documented there.

key -> (string)

value -> (string)

thumbnailConfiguration -> (structure)

A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

recordingMode -> (string)

Thumbnail recording mode. Default: INTERVAL .

targetIntervalSeconds -> (long)

The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL . Default: 60.

Important: Setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.

startTime -> (timestamp)

Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string .

streamId -> (string)

Unique identifier for a live or previously live stream in the specified channel.

truncatedEvents -> (list)

List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS .

(structure)

Object specifying a stream’s events. For a list of events, see Using Amazon EventBridge with Amazon IVS .

eventTime -> (timestamp)

Time when the event occurred. This is an ISO 8601 timestamp; note that this is returned as a string .

name -> (string)

Name that identifies the stream event within a type .

type -> (string)

Logical group for certain events.

Table of Contents

Feedback

User Guide