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 ]

put-metadata

Description

Inserts metadata into an RTMPS stream for the specified channel. A maximum of 5 requests per second per channel is allowed, each with a maximum 1KB payload.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  put-metadata
--channel-arn <value>
--metadata <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--channel-arn (string)

ARN of the channel into which metadata is inserted. This channel must have an active stream.

--metadata (string)

Metadata to insert into the stream. Maximum: 1 KB per request.

--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 insert metadata into the active stream for a specified channel

The following put-metadata example inserts the given metadata into the stream for the specified channel.

aws ivs put-metadata \
    --channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \
    --metadata '{"my": "metadata"}'

This command produces no output.

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

Output

None