AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . elementalinference ]

create-feed

Description

Creates a feed. The feed is the target for the live media stream that is being sent by the calling application. An example of a calling application is AWS Elemental MediaLive.

The key contents of the feed is an array of outputs. Each output represents an Elemental Inference feature. After you create the feed, you must associate a resource with the feed. At that point, you will have a useable feed: resource - feed - output or outputs.

See also: AWS API Documentation

Synopsis

  create-feed
--name <value>
--outputs <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>]
[--v2-debug]

Options

--name (string)

A user-friendly name for this feed.

--outputs (list)

An array of outputs for this feed. Each output represents a specific Elemental Inference feature. For example, there is one output type for the smart crop feature. You must specify at least one output, but you can later add outputs using AssociateFeed, or add, modify, and delete outputs using UpdateFeed.

(structure)

Contains configuration information about one output in a feed. It is used in the AssociateFeed and the CreateFeed actions.

name -> (string)

A name for the output.

outputConfig -> (tagged union structure)

A typed property for an output in a feed. It identifies the action for Elemental Inference to perform. It also provides a repository for the results of that action. For example, CroppingConfig output will contain the metadata for the crop feature.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: cropping, clipping, subtitling.

cropping -> (structure)

The output config type that applies to the cropping feature.

clipping -> (structure)

The output config type that applies to the clipping feature.

callbackMetadata -> (string)

A string that you want Elemental Inference to always include in the event clipping metadata for this output. The string might identify the sports event in the source media, for example.

subtitling -> (structure)

The output config type that applies to the smart subtitling feature.

language -> (string)

The language of the audio in the source media. Elemental Inference uses this setting to optimize transcription accuracy. Specify the language using an ISO 639-2/T three-letter code, optionally with a region subtag. Supported values: eng, eng-au, eng-gb, eng-us, fra, ita, deu, spa, por.

aspectRatio -> (structure)

The aspect ratio of the output video, specified as width and height integer values. Elemental Inference uses the aspect ratio to determine subtitle layout and line lengths.

width -> (integer)

The width component of the aspect ratio (for example, 16 in a 16:9 ratio).

height -> (integer)

The height component of the aspect ratio (for example, 9 in a 16:9 ratio).

dictionary -> (string)

The ID of a custom dictionary to improve transcription accuracy for domain-specific terminology. Use the CreateDictionary operation to create a dictionary.

profanityFilter -> (string)

Controls how profanity is handled in the generated subtitles. Valid values: DISABLED (no filtering, default), CENSOR (replace profanity with asterisks), DROP (remove profanity from the transcript).

status -> (string)

The status to assign to the output.

description -> (string)

A description for the output.

JSON Syntax:

[
  {
    "name": "string",
    "outputConfig": {
      "cropping": {

      },
      "clipping": {
        "callbackMetadata": "string"
      },
      "subtitling": {
        "language": "eng"|"eng-au"|"eng-gb"|"eng-us"|"fra"|"ita"|"deu"|"spa"|"por",
        "aspectRatio": {
          "width": integer,
          "height": integer
        },
        "dictionary": "string",
        "profanityFilter": "DISABLED"|"CENSOR"|"DROP"
      }
    },
    "status": "ENABLED"|"DISABLED",
    "description": "string"
  }
  ...
]

--tags (map)

Optional tags. You can also add tags later, using TagResource.

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.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

arn -> (string)

A unique ARN that Elemental Inference assigns to the feed.

name -> (string)

The name that you specified in the request.

id -> (string)

A unique ID that Elemental Inference assigns to the feed.

dataEndpoints -> (list)

An array of endpoints for the feed. Typically, there is only one endpoint. The feed receives source media at this endpoint (when the calling application calls PutMedia) and returns the resulting metadata to this endpoint (when the calling application calls GetMetadata).

(string)

outputs -> (list)

Repeats the outputs that you specified in the request.

(structure)

Contains configuration information about one output in a feed. It is used in the GetFeed response.

name -> (string)

The name of the output.

outputConfig -> (tagged union structure)

A typed property for an output in a feed. It identifies the action for Elemental Inference to perform. It also provides a repository for the results of that action. For example, CroppingConfig output will contain the metadata for the crop feature.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: cropping, clipping, subtitling.

cropping -> (structure)

The output config type that applies to the cropping feature.

clipping -> (structure)

The output config type that applies to the clipping feature.

callbackMetadata -> (string)

A string that you want Elemental Inference to always include in the event clipping metadata for this output. The string might identify the sports event in the source media, for example.

subtitling -> (structure)

The output config type that applies to the smart subtitling feature.

language -> (string)

The language of the audio in the source media. Elemental Inference uses this setting to optimize transcription accuracy. Specify the language using an ISO 639-2/T three-letter code, optionally with a region subtag. Supported values: eng, eng-au, eng-gb, eng-us, fra, ita, deu, spa, por.

aspectRatio -> (structure)

The aspect ratio of the output video, specified as width and height integer values. Elemental Inference uses the aspect ratio to determine subtitle layout and line lengths.

width -> (integer)

The width component of the aspect ratio (for example, 16 in a 16:9 ratio).

height -> (integer)

The height component of the aspect ratio (for example, 9 in a 16:9 ratio).

dictionary -> (string)

The ID of a custom dictionary to improve transcription accuracy for domain-specific terminology. Use the CreateDictionary operation to create a dictionary.

profanityFilter -> (string)

Controls how profanity is handled in the generated subtitles. Valid values: DISABLED (no filtering, default), CENSOR (replace profanity with asterisks), DROP (remove profanity from the transcript).

status -> (string)

The status of the output.

description -> (string)

The description of the output.

fromAssociation -> (boolean)

True means that the output was originally created in the feed using AssociateFeed. False means it was created using CreateFeed or UpdateFeed.

You will need this value if you use UpdateFeed to modify the list of outputs in the feed.

status -> (string)

The current status of the feed. After creation of the feed has succeeded, the status will be AVAILABLE.

association -> (structure)

The association for this feed. When you create the feed, this property is empty. You must associate a resource with the feed using AssociateFeed or UpdateFeed.

associatedResourceName -> (string)

The name of the associated resource.

tags -> (map)

Any tags that you included when you created the feed.

key -> (string)

value -> (string)