AWS CLI Command Reference

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-realtime ]

create-encoder-configuration

Description

Creates an EncoderConfiguration object.

See also: AWS API Documentation

Synopsis

  create-encoder-configuration
[--name <value>]
[--video <value>]
[--tags <value>]
[--cli-input-json <value>]
[--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>]

Options

--name (string)

Optional name to identify the resource.

--video (structure)

Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps.

width -> (integer)

Video-resolution width. This must be an even number. Note that the maximum value is determined by width times height , such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.

height -> (integer)

Video-resolution height. This must be an even number. Note that the maximum value is determined by width times height , such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.

framerate -> (float)

Video frame rate, in fps. Default: 30.

bitrate -> (integer)

Bitrate for generated output, in bps. Default: 2500000.

Shorthand Syntax:

width=integer,height=integer,framerate=float,bitrate=integer

JSON Syntax:

{
  "width": integer,
  "height": integer,
  "framerate": float,
  "bitrate": integer
}

--tags (map)

Tags attached to the resource. Array of maps, each of the form string:string (key:value) . See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

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

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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

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

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 create a composition encoder configuration

The following create-encoder-configuration example creates a composition encoder configuration with the specified properties.

aws ivs-realtime create-encoder-configuration \
    --name test-ec --video bitrate=3500000,framerate=30.0,height=1080,width=1920

Output:

{
    "encoderConfiguration": {
        "arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef",
        "name": "test-ec",
        "tags": {},
        "video": {
            "bitrate": 3500000,
            "framerate": 30,
            "height": 1080,
            "width": 1920
        }
    }
}

For more information, see Enabling Multiple Hosts on an Amazon IVS Stream in the Amazon Interactive Video Service User Guide.

Output

encoderConfiguration -> (structure)

The EncoderConfiguration that was created.

arn -> (string)

ARN of the EncoderConfiguration resource.

name -> (string)

Optional name to identify the resource.

video -> (structure)

Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps

width -> (integer)

Video-resolution width. This must be an even number. Note that the maximum value is determined by width times height , such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.

height -> (integer)

Video-resolution height. This must be an even number. Note that the maximum value is determined by width times height , such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.

framerate -> (float)

Video frame rate, in fps. Default: 30.

bitrate -> (integer)

Bitrate for generated output, in bps. Default: 2500000.

tags -> (map)

Tags attached to the resource. Array of maps, each of the form string:string (key:value) . See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

key -> (string)

value -> (string)