[ aws . ivs ]

create-channel

Description

Creates a new channel and an associated stream key to start streaming.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-channel
[--name <value>]
[--latency-mode <value>]
[--type <value>]
[--authorized | --no-authorized]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--name (string)

Channel name.

--latency-mode (string)

Channel latency mode. Default: LOW .

Possible values:

• NORMAL

• LOW

--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. Valid values:

• STANDARD : Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.

• BASIC : Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.

Default: STANDARD .

Possible values:

• BASIC

• STANDARD

--authorized | --no-authorized (boolean)

Whether the channel is authorized. Default: false .

--tags (map)

See Channel$tags .

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

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

See ‘aws help’ for descriptions of global parameters.

Examples

To create channels

The following create-channel example creates a new channel and an associated stream key to start streaming.

aws ivs create-channel

Output:

{
    "channel": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "name": "test-channel",
        "latencyMode": "LOW",
        "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
        "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
        "tags": {}
    },
    "streamKey": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/g1H2I3j4k5L6",
        "value": "sk_us-west-2_abcdABCDefgh_567890abcdef",
        "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "tags": {}
    }
}

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

Output

channel -> (structure)

Object specifying a channel.

arn -> (string)

Channel ARN.

name -> (string)

Channel name.

latencyMode -> (string)

Channel latency mode. Default: LOW .

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. Valid values:

• STANDARD : Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.

• BASIC : Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.

Default: STANDARD .

ingestEndpoint -> (string)

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

playbackUrl -> (string)

Channel playback URL.

authorized -> (boolean)

Whether the channel is authorized.

tags -> (map)

Array of 1-50 maps, each of the form string:string (key:value) .

key -> (string)

value -> (string)

streamKey -> (structure)

Object specifying a stream key.

arn -> (string)

Stream-key ARN.

value -> (string)

Stream-key value.

channelArn -> (string)

Channel ARN for the stream.

tags -> (map)

Array of 1-50 maps, each of the form string:string (key:value) .

key -> (string)

value -> (string)