AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . rbin ]

update-rule

Description

Updates an existing Recycle Bin retention rule. You can update a retention rule's description, resource tags, and retention period at any time after creation. You can't update a retention rule's resource type after creation. For more information, see Update Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide .

See also: AWS API Documentation

Synopsis

  update-rule
--identifier <value>
[--retention-period <value>]
[--description <value>]
[--resource-type <value>]
[--resource-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>]

Options

--identifier (string)

The unique ID of the retention rule.

--retention-period (structure)

Information about the retention period for which the retention rule is to retain resources.

RetentionPeriodValue -> (integer)

The period value for which the retention rule is to retain resources. The period is measured using the unit specified for RetentionPeriodUnit .

RetentionPeriodUnit -> (string)

The unit of time in which the retention period is measured. Currently, only DAYS is supported.

Shorthand Syntax:

RetentionPeriodValue=integer,RetentionPeriodUnit=string

JSON Syntax:

{
  "RetentionPeriodValue": integer,
  "RetentionPeriodUnit": "DAYS"
}

--description (string)

The retention rule description.

--resource-type (string)

Note

This parameter is currently not supported. You can't update a retention rule's resource type after creation.

Possible values:

  • EBS_SNAPSHOT
  • EC2_IMAGE

--resource-tags (list)

Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

You can add the same tag key and value pair to a maximum or five retention rules.

To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.

(structure)

Information about the resource tags used to identify resources that are retained by the retention rule.

ResourceTagKey -> (string)

The tag key.

ResourceTagValue -> (string)

The tag value.

Shorthand Syntax:

ResourceTagKey=string,ResourceTagValue=string ...

JSON Syntax:

[
  {
    "ResourceTagKey": "string",
    "ResourceTagValue": "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.

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

Output

Identifier -> (string)

The unique ID of the retention rule.

RetentionPeriod -> (structure)

Information about the retention period for which the retention rule is to retain resources.

RetentionPeriodValue -> (integer)

The period value for which the retention rule is to retain resources. The period is measured using the unit specified for RetentionPeriodUnit .

RetentionPeriodUnit -> (string)

The unit of time in which the retention period is measured. Currently, only DAYS is supported.

Description -> (string)

The retention rule description.

ResourceType -> (string)

The resource type retained by the retention rule.

ResourceTags -> (list)

Information about the resource tags used to identify resources that are retained by the retention rule.

(structure)

Information about the resource tags used to identify resources that are retained by the retention rule.

ResourceTagKey -> (string)

The tag key.

ResourceTagValue -> (string)

The tag value.

Status -> (string)

The state of the retention rule. Only retention rules that are in the available state retain resources.

LockState -> (string)

The lock state for the retention rule.

  • locked - The retention rule is locked and can't be modified or deleted.
  • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.
  • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.
  • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null .

LockEndTime -> (timestamp)

The date and time at which the unlock delay is set to expire. Only returned for retention rules that have been unlocked and that are still within the unlock delay period.

RuleArn -> (string)

The Amazon Resource Name (ARN) of the retention rule.