[ aws . ivs ]

create-stream-key

Description

Creates a stream key, used to initiate a stream, for the specified channel ARN.

Note that CreateChannel creates a stream key. If you subsequently use CreateStreamKey on the same channel, it will fail because a stream key already exists and there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-stream-key
--channel-arn <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--channel-arn (string)

ARN of the channel for which to create the stream key.

--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 a stream key

The following create-stream-key example creates a stream key for a specified ARN (Amazon Resource Name).

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

Output:

{
    "streamKey": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/abcdABCDefgh",
        "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

streamKey -> (structure)

Stream key used to authenticate an RTMPS stream for ingestion.

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)