update-subscription¶

Description¶

Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.

Note

For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization’s payer account, regardless of whether the payer account itself is subscribed.

Synopsis¶

  update-subscription
[--auto-renew <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--auto-renew (string)

When you initally create a subscription, AutoRenew is set to ENABLED . If ENABLED , the subscription will be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew , the existing value for AutoRenew remains unchanged.

Possible values:

ENABLED

DISABLED

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

See ‘aws help’ for descriptions of global parameters.

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 modify the account’s AWS Shield Advanced subscription

The following update-subscription example enables auto-renewal of the AWS Shield Advanced subscription for the account.

aws shield update-subscription \
    --auto-renew ENABLED

This command produces no output.

For more information, see How AWS Shield Works in the AWS Shield Advanced Developer Guide.

Output¶

None

Table of Contents

Feedback

User Guide