[ aws . elementalinference ]

associate-feed

Description

Associates a resource with the feed. The resource provides the input that Elemental Inference needs needs in order to perform an Elemental Inference feature, such as cropping video. You always provide the resource by associating it with a feed. You can associate only one resource with each feed.

See also: AWS API Documentation

Synopsis

  associate-feed
--id <value>
[--associated-resource-name <value>]
--outputs <value>
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--id (string) [required]

The ID of the feed.

Constraints:

• pattern: [a-z0-9]{19}

--associated-resource-name (string)

An identifier for the resource. If the resource is from an AWS service, this identifier must be the full ARN of that resource. Otherwise, the identifier is a name that you assign and that is appropriate for the application that owns the resource. This name must not resemble an ARN.

Constraints:

• min: 1
• max: 2048
• pattern: [\w \-\.',@:;/]*

--outputs (list) [required]

The outputs to add to this feed. You must specify at least one output. You can later use the UpdateFeed action to change the list of outputs.

(structure)

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

name -> (string) [required]

A name for the output.

Constraints:

• pattern: [a-zA-Z0-9]([a-zA-Z0-9-_]{0,126}[a-zA-Z0-9])?

outputConfig -> (tagged union structure) [required]

A typed property for an output in a feed. It is used in the CreateFeed and AssociateFeed actions. 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.

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)

The metadata that is the result of the clip request to Elemental Inference.

Constraints:

• min: 0
• max: 1024
• pattern: [\w \-\.',@:;]*

status -> (string) [required]

The status to assign to the output.

Possible values:

• ENABLED
• DISABLED

description -> (string)

A description for the output.

Constraints:

• min: 0
• max: 1024
• pattern: [\w \-\.',@:;]*

Shorthand Syntax:

name=string,outputConfig={cropping={},clipping={callbackMetadata=string}},status=string,description=string ...

JSON Syntax:

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

      },
      "clipping": {
        "callbackMetadata": "string"
      }
    },
    "status": "ENABLED"|"DISABLED",
    "description": "string"
  }
  ...
]

--dry-run | --no-dry-run (boolean)

Set to true if you want to do a dry run of the associate action.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
• yaml
• yaml-stream
• off

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

• legacy
• json
• yaml
• text
• table
• enhanced

Output

arn -> (string)

The AWS ARN for this association.

id -> (string)

An ID for this response. It is unique in Elemental Inference for this AWS account.

Constraints:

• pattern: [a-z0-9]{19}