RecycleBin / Client / update_rule

update_rule#

RecycleBin.Client.update_rule(**kwargs)#

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.

Request Syntax

response = client.update_rule(
    Identifier='string',
    RetentionPeriod={
        'RetentionPeriodValue': 123,
        'RetentionPeriodUnit': 'DAYS'
    },
    Description='string',
    ResourceType='EBS_SNAPSHOT'|'EC2_IMAGE',
    ResourceTags=[
        {
            'ResourceTagKey': 'string',
            'ResourceTagValue': 'string'
        },
    ],
    ExcludeResourceTags=[
        {
            'ResourceTagKey': 'string',
            'ResourceTagValue': 'string'
        },
    ]
)

Parameters:

Identifier (string) –
[REQUIRED]

The unique ID of the retention rule.
RetentionPeriod (dict) –
Information about the retention period for which the retention rule is to retain resources.
- RetentionPeriodValue (integer) – [REQUIRED]
  
  The period value for which the retention rule is to retain resources. The period is measured using the unit specified for RetentionPeriodUnit.
- RetentionPeriodUnit (string) – [REQUIRED]
  
  The unit of time in which the retention period is measured. Currently, only DAYS is supported.
Description (string) – The retention rule description.
ResourceType (string) –

Note
This parameter is currently not supported. You can’t update a retention rule’s resource type after creation.
ResourceTags (list) –
[Tag-level retention rules only] 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.
- (dict) –
  
  [Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.
  - ResourceTagKey (string) – [REQUIRED]
    
    The tag key.
  - ResourceTagValue (string) –
    
    The tag value.
ExcludeResourceTags (list) –
[Region-level retention rules only] Specifies the exclusion tags to use to identify resources that are to be excluded, or ignored, by a Region-level retention rule. Resources that have any of these tags are not retained by the retention rule upon deletion.

You can’t specify exclusion tags for tag-level retention rules.
- (dict) –
  
  [Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.
  - ResourceTagKey (string) – [REQUIRED]
    
    The tag key.
  - ResourceTagValue (string) –
    
    The tag value.

Return type:

dict

Returns:

Response Syntax

{
    'Identifier': 'string',
    'RetentionPeriod': {
        'RetentionPeriodValue': 123,
        'RetentionPeriodUnit': 'DAYS'
    },
    'Description': 'string',
    'ResourceType': 'EBS_SNAPSHOT'|'EC2_IMAGE',
    'ResourceTags': [
        {
            'ResourceTagKey': 'string',
            'ResourceTagValue': 'string'
        },
    ],
    'Status': 'pending'|'available',
    'LockState': 'locked'|'pending_unlock'|'unlocked',
    'LockEndTime': datetime(2015, 1, 1),
    'RuleArn': 'string',
    'ExcludeResourceTags': [
        {
            'ResourceTagKey': 'string',
            'ResourceTagValue': 'string'
        },
    ]
}

Response Structure

(dict) –
- Identifier (string) –
  
  The unique ID of the retention rule.
- RetentionPeriod (dict) –
  
  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) –
  
  [Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.
  - (dict) –
    
    [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 the available state retain resources.
- 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 the locked and unlocked states only; it can never transition back to null.
- LockEndTime (datetime) –
  
  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.
- 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.
  - (dict) –
    
    [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.

Exceptions

RecycleBin.Client.exceptions.ValidationException
RecycleBin.Client.exceptions.InternalServerException
RecycleBin.Client.exceptions.ResourceNotFoundException
RecycleBin.Client.exceptions.ConflictException
RecycleBin.Client.exceptions.ServiceQuotaExceededException