[ aws . elementalinference ]

update-feed

Description

Updates the name and/or outputs in a feed.

See also: AWS API Documentation

Synopsis

  update-feed
--name <value>
--id <value>
--outputs <value>
[--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]

Options

--name (string) [required]

Required. You can specify the existing name (to leave it unchanged) or a new name.

Constraints:

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

--id (string) [required]

The ID of the feed to update.

Constraints:

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

--outputs (list) [required]

Required. You can specify the existing array of outputs (to leave outputs unchanged) or you can specify a new array.

(structure)

Contains configuration information about one output in a feed. It is used in the UpdateFeed action.

name -> (string) [required]

The name start here

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 UpdateFeed action. 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 of the output.

Possible values:

  • ENABLED
  • DISABLED

description -> (string)

A description of the output.

Constraints:

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

fromAssociation -> (boolean)

This property is set by the service when you add the output to the feed, and indicates how you added the output. True means that you used the AssociateFeed operation. False means that you used the CreateFeed or UpdateFeed operation. Use GetFeed to obtain the value. If the value is True, include this field here with a value of True. If the value is False, omit the field here.

Shorthand Syntax:

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

JSON Syntax:

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

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

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

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

Output

arn -> (string)

The ARN of the feed.

name -> (string)

The updated or original name of the feed.

Constraints:

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

id -> (string)

The ID of the feed.

Constraints:

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

dataEndpoints -> (list)

The data endpoints of the feed.

(string)

outputs -> (list)

The array of outputs in the feed. You might have left this array unchanged, or you might have changed it.

(structure)

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

name -> (string) [required]

The ARN of 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 GetFeed action. 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 of the output.

Possible values:

  • ENABLED
  • DISABLED

description -> (string)

The description of the output.

Constraints:

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

fromAssociation -> (boolean)

True means that the output was originally created in the feed by the AssociateFeed operation. False means it was created using CreateFeed or UpdateFeed. You will need this value if you use the UpdateFeed operation to modify the list of outputs in the feed.

status -> (string)

The status of the output.

Possible values:

  • CREATING
  • AVAILABLE
  • ACTIVE
  • UPDATING
  • DELETING
  • DELETED
  • ARCHIVED

association -> (structure)

True means that the output was originally created in the feed by the AssociateFeed operation. False means it was created using CreateFeed or UpdateFeed. You will need this value if you use the UpdateFeed operation to modify the list of outputs in the feed.

associatedResourceName -> (string) [required]

The name of the associated resource.

Constraints:

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

tags -> (map)

The name of the resource currently associated with the feed, if any.

key -> (string)

Constraints:

  • min: 1
  • max: 128

value -> (string)

Constraints:

  • min: 0
  • max: 256