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.
Locks a Region-level retention rule. A locked retention rule can't be modified or deleted.
See also: AWS API Documentation
lock-rule
--identifier <value>
--lock-configuration <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>]
--identifier
(string)
The unique ID of the retention rule.
--lock-configuration
(structure)
Information about the retention rule lock configuration.
UnlockDelay -> (structure)
Information about the retention rule unlock delay.
UnlockDelayValue -> (integer)
The unlock delay period, measured in the unit specified for UnlockDelayUnit .UnlockDelayUnit -> (string)
The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days.
Shorthand Syntax:
UnlockDelay={UnlockDelayValue=integer,UnlockDelayUnit=string}
JSON Syntax:
{
"UnlockDelay": {
"UnlockDelayValue": integer,
"UnlockDelayUnit": "DAYS"
}
}
--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.
--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.
--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.
--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.
Identifier -> (string)
The unique ID of the retention rule.
Description -> (string)
The retention rule description.
ResourceType -> (string)
The resource type retained by 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, onlyDAYS
is supported.
ResourceTags -> (list)
[Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.
(structure)
[Tag-level retention rules only] 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 theavailable
state retain resources.
LockConfiguration -> (structure)
Information about the retention rule lock configuration.
UnlockDelay -> (structure)
Information about the retention rule unlock delay.
UnlockDelayValue -> (integer)
The unlock delay period, measured in the unit specified for UnlockDelayUnit .UnlockDelayUnit -> (string)
The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days.
LockState -> (string)
[Region-level retention rules only] 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 thelocked
andunlocked
states only; it can never transition back tonull
.
RuleArn -> (string)
The Amazon Resource Name (ARN) of the retention rule.
ExcludeResourceTags -> (list)
[Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.
(structure)
[Tag-level retention rules only] 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.