[ aws . greengrass ]

update-subscription-definition

Description

Updates a subscription definition.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-subscription-definition
[--name <value>]
--subscription-definition-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--name (string) The name of the definition.

--subscription-definition-id (string) The ID of the subscription definition.

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To update the name for a subscription definition

The following update-subscription-definition example updates the name for the specified subscription definition. If you want to change details for the subscription, use the create-subscription-definition-version command to create a new version.

aws greengrass update-subscription-definition \
    --subscription-definition-id "fa81bc84-3f59-4377-a84b-5d0134da359b" \
    --name "ObsoleteSubscription"

This command produces no output.

For more information, see title in the guide.

Output

None