Amazon Recycle Bin

2024/11/20 - Amazon Recycle Bin - 6 updated api methods

Changes  This release adds support for exclusion tags for Recycle Bin, which allows you to identify resources that are to be excluded, or ignored, by a Region-level retention rule.

CreateRule (updated) Link ¶
Changes (both) 
{'ExcludeResourceTags': [{'ResourceTagKey': 'string',
                          'ResourceTagValue': 'string'}]}

Creates a Recycle Bin retention rule. You can create two types of retention rules:

  • Tag-level retention rules - These retention rules use resource tags to identify the resources to protect. For each retention rule, you specify one or more tag key and value pairs. Resources (of the specified type) that have at least one of these tag key and value pairs are automatically retained in the Recycle Bin upon deletion. Use this type of retention rule to protect specific resources in your account based on their tags.

  • Region-level retention rules - These retention rules, by default, apply to all of the resources (of the specified type) in the Region, even if the resources are not tagged. However, you can specify exclusion tags to exclude resources that have specific tags. Use this type of retention rule to protect all resources of a specific type in a Region.

For more information, see Create Recycle Bin retention rules in the Amazon EBS User Guide.

See also: AWS API Documentation

Request Syntax

client.create_rule(
    RetentionPeriod={
        'RetentionPeriodValue': 123,
        'RetentionPeriodUnit': 'DAYS'
    },
    Description='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ResourceType='EBS_SNAPSHOT'|'EC2_IMAGE',
    ResourceTags=[
        {
            'ResourceTagKey': 'string',
            'ResourceTagValue': 'string'
        },
    ],
    LockConfiguration={
        'UnlockDelay': {
            'UnlockDelayValue': 123,
            'UnlockDelayUnit': 'DAYS'
        }
    },
    ExcludeResourceTags=[
        {
            'ResourceTagKey': 'string',
            'ResourceTagValue': 'string'
        },
    ]
)
type RetentionPeriod:

dict

param RetentionPeriod:

[REQUIRED]

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.

type Description:

string

param Description:

The retention rule description.

type Tags:

list

param Tags:

Information about the tags to assign to the retention rule.

  • (dict) --

    Information about the tags to assign to the retention rule.

    • Key (string) -- [REQUIRED]

      The tag key.

    • Value (string) -- [REQUIRED]

      The tag value.

type ResourceType:

string

param ResourceType:

[REQUIRED]

The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To retain snapshots, specify EBS_SNAPSHOT. To retain EBS-backed AMIs, specify EC2_IMAGE.

type ResourceTags:

list

param ResourceTags:

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

type LockConfiguration:

dict

param LockConfiguration:

Information about the retention rule lock configuration.

  • UnlockDelay (dict) -- [REQUIRED]

    Information about the retention rule unlock delay.

    • UnlockDelayValue (integer) -- [REQUIRED]

      The unlock delay period, measured in the unit specified for UnlockDelayUnit.

    • UnlockDelayUnit (string) -- [REQUIRED]

      The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days.

type ExcludeResourceTags:

list

param ExcludeResourceTags:

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

rtype:

dict

returns:

Response Syntax

{
    'Identifier': 'string',
    'RetentionPeriod': {
        'RetentionPeriodValue': 123,
        'RetentionPeriodUnit': 'DAYS'
    },
    'Description': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'ResourceType': 'EBS_SNAPSHOT'|'EC2_IMAGE',
    'ResourceTags': [
        {
            'ResourceTagKey': 'string',
            'ResourceTagValue': 'string'
        },
    ],
    'Status': 'pending'|'available',
    'LockConfiguration': {
        'UnlockDelay': {
            'UnlockDelayValue': 123,
            'UnlockDelayUnit': 'DAYS'
        }
    },
    'LockState': 'locked'|'pending_unlock'|'unlocked',
    '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.

    • Tags (list) --

      Information about the tags assigned to the retention rule.

      • (dict) --

        Information about the tags to assign to the retention rule.

        • Key (string) --

          The tag key.

        • Value (string) --

          The tag value.

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

    • LockConfiguration (dict) --

      Information about the retention rule lock configuration.

      • UnlockDelay (dict) --

        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 the locked and unlocked states only; it can never transition back to null.

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

GetRule (updated) Link ¶
Changes (response) 
{'ExcludeResourceTags': [{'ResourceTagKey': 'string',
                          'ResourceTagValue': 'string'}]}

Gets information about a Recycle Bin retention rule.

See also: AWS API Documentation

Request Syntax

client.get_rule(
    Identifier='string'
)
type Identifier:

string

param Identifier:

[REQUIRED]

The unique ID of the retention rule.

rtype:

dict

returns:

Response Syntax

{
    'Identifier': 'string',
    'Description': 'string',
    'ResourceType': 'EBS_SNAPSHOT'|'EC2_IMAGE',
    'RetentionPeriod': {
        'RetentionPeriodValue': 123,
        'RetentionPeriodUnit': 'DAYS'
    },
    'ResourceTags': [
        {
            'ResourceTagKey': 'string',
            'ResourceTagValue': 'string'
        },
    ],
    'Status': 'pending'|'available',
    'LockConfiguration': {
        'UnlockDelay': {
            'UnlockDelayValue': 123,
            'UnlockDelayUnit': 'DAYS'
        }
    },
    '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.

    • Description (string) --

      The retention rule description.

    • ResourceType (string) --

      The resource type retained by 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.

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

    • LockConfiguration (dict) --

      Information about the retention rule lock configuration.

      • UnlockDelay (dict) --

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

ListRules (updated) Link ¶
Changes (request) 
{'ExcludeResourceTags': [{'ResourceTagKey': 'string',
                          'ResourceTagValue': 'string'}]}

Lists the Recycle Bin retention rules in the Region.

See also: AWS API Documentation

Request Syntax

client.list_rules(
    MaxResults=123,
    NextToken='string',
    ResourceType='EBS_SNAPSHOT'|'EC2_IMAGE',
    ResourceTags=[
        {
            'ResourceTagKey': 'string',
            'ResourceTagValue': 'string'
        },
    ],
    LockState='locked'|'pending_unlock'|'unlocked',
    ExcludeResourceTags=[
        {
            'ResourceTagKey': 'string',
            'ResourceTagValue': 'string'
        },
    ]
)
type MaxResults:

integer

param MaxResults:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned NextToken value.

type NextToken:

string

param NextToken:

The token for the next page of results.

type ResourceType:

string

param ResourceType:

[REQUIRED]

The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To list retention rules that retain snapshots, specify EBS_SNAPSHOT. To list retention rules that retain EBS-backed AMIs, specify EC2_IMAGE.

type ResourceTags:

list

param ResourceTags:

[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) -- [REQUIRED]

      The tag key.

    • ResourceTagValue (string) --

      The tag value.

type LockState:

string

param LockState:

The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.

type ExcludeResourceTags:

list

param ExcludeResourceTags:

[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) -- [REQUIRED]

      The tag key.

    • ResourceTagValue (string) --

      The tag value.

rtype:

dict

returns:

Response Syntax

{
    'Rules': [
        {
            'Identifier': 'string',
            'Description': 'string',
            'RetentionPeriod': {
                'RetentionPeriodValue': 123,
                'RetentionPeriodUnit': 'DAYS'
            },
            'LockState': 'locked'|'pending_unlock'|'unlocked',
            'RuleArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Rules (list) --

      Information about the retention rules.

      • (dict) --

        Information about a Recycle Bin retention rule.

        • Identifier (string) --

          The unique ID of the retention rule.

        • Description (string) --

          The retention rule description.

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

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

        • RuleArn (string) --

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

    • NextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

LockRule (updated) Link ¶
Changes (response) 
{'ExcludeResourceTags': [{'ResourceTagKey': 'string',
                          'ResourceTagValue': 'string'}]}

Locks a Region-level retention rule. A locked retention rule can't be modified or deleted.

See also: AWS API Documentation

Request Syntax

client.lock_rule(
    Identifier='string',
    LockConfiguration={
        'UnlockDelay': {
            'UnlockDelayValue': 123,
            'UnlockDelayUnit': 'DAYS'
        }
    }
)
type Identifier:

string

param Identifier:

[REQUIRED]

The unique ID of the retention rule.

type LockConfiguration:

dict

param LockConfiguration:

[REQUIRED]

Information about the retention rule lock configuration.

  • UnlockDelay (dict) -- [REQUIRED]

    Information about the retention rule unlock delay.

    • UnlockDelayValue (integer) -- [REQUIRED]

      The unlock delay period, measured in the unit specified for UnlockDelayUnit.

    • UnlockDelayUnit (string) -- [REQUIRED]

      The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days.

rtype:

dict

returns:

Response Syntax

{
    'Identifier': 'string',
    'Description': 'string',
    'ResourceType': 'EBS_SNAPSHOT'|'EC2_IMAGE',
    'RetentionPeriod': {
        'RetentionPeriodValue': 123,
        'RetentionPeriodUnit': 'DAYS'
    },
    'ResourceTags': [
        {
            'ResourceTagKey': 'string',
            'ResourceTagValue': 'string'
        },
    ],
    'Status': 'pending'|'available',
    'LockConfiguration': {
        'UnlockDelay': {
            'UnlockDelayValue': 123,
            'UnlockDelayUnit': 'DAYS'
        }
    },
    'LockState': 'locked'|'pending_unlock'|'unlocked',
    'RuleArn': 'string',
    'ExcludeResourceTags': [
        {
            'ResourceTagKey': 'string',
            'ResourceTagValue': 'string'
        },
    ]
}

Response Structure

  • (dict) --

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

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

    • LockConfiguration (dict) --

      Information about the retention rule lock configuration.

      • UnlockDelay (dict) --

        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 the locked and unlocked states only; it can never transition back to null.

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

UnlockRule (updated) Link ¶
Changes (response) 
{'ExcludeResourceTags': [{'ResourceTagKey': 'string',
                          'ResourceTagValue': 'string'}]}

Unlocks a retention rule. After a retention rule is unlocked, it can be modified or deleted only after the unlock delay period expires.

See also: AWS API Documentation

Request Syntax

client.unlock_rule(
    Identifier='string'
)
type Identifier:

string

param Identifier:

[REQUIRED]

The unique ID of the retention rule.

rtype:

dict

returns:

Response Syntax

{
    'Identifier': 'string',
    'Description': 'string',
    'ResourceType': 'EBS_SNAPSHOT'|'EC2_IMAGE',
    'RetentionPeriod': {
        'RetentionPeriodValue': 123,
        'RetentionPeriodUnit': 'DAYS'
    },
    'ResourceTags': [
        {
            'ResourceTagKey': 'string',
            'ResourceTagValue': 'string'
        },
    ],
    'Status': 'pending'|'available',
    'LockConfiguration': {
        'UnlockDelay': {
            'UnlockDelayValue': 123,
            'UnlockDelayUnit': 'DAYS'
        }
    },
    '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.

    • Description (string) --

      The retention rule description.

    • ResourceType (string) --

      The resource type retained by 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.

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

    • LockConfiguration (dict) --

      Information about the retention rule lock configuration.

      • UnlockDelay (dict) --

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

UpdateRule (updated) Link ¶
Changes (both) 
{'ExcludeResourceTags': [{'ResourceTagKey': 'string',
                          'ResourceTagValue': 'string'}]}

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

Request Syntax

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'
        },
    ]
)
type Identifier:

string

param Identifier:

[REQUIRED]

The unique ID of the retention rule.

type RetentionPeriod:

dict

param RetentionPeriod:

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.

type Description:

string

param Description:

The retention rule description.

type ResourceType:

string

param ResourceType:
type ResourceTags:

list

param ResourceTags:

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

type ExcludeResourceTags:

list

param ExcludeResourceTags:

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

rtype:

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.