[ aws . kinesisvideo ]

create-signaling-channel

Description

Creates a signaling channel.

CreateSignalingChannel is an asynchronous operation.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-signaling-channel
--channel-name <value>
[--channel-type <value>]
[--single-master-configuration <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--channel-name (string)

A name for the signaling channel that you are creating. It must be unique for each Amazon Web Services account and Amazon Web Services Region.

--channel-type (string)

A type of the signaling channel that you are creating. Currently, SINGLE_MASTER is the only supported channel type.

Possible values:

• SINGLE_MASTER

• FULL_MESH

--single-master-configuration (structure)

A structure containing the configuration for the SINGLE_MASTER channel type.

MessageTtlSeconds -> (integer)

The period of time a signaling channel retains undelivered messages before they are discarded.

Shorthand Syntax:

MessageTtlSeconds=integer

JSON Syntax:

{
  "MessageTtlSeconds": integer
}

--tags (list)

A set of tags (key-value pairs) that you want to associate with this channel.

(structure)

A key and value pair that is associated with the specified signaling channel.

Key -> (string)

The key of the tag that is associated with the specified signaling channel.

Value -> (string)

The value of the tag that is associated with the specified signaling channel.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "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.

Output

ChannelARN -> (string)

The Amazon Resource Name (ARN) of the created channel.