AWS API Changes

2021/11/29 - Amazon Recycle Bin - 8 new api methods

Changes This release adds support for Recycle Bin.

ListRules (new)

Lists the Recycle Bin retention rules in the Region.

Request Syntax

client.list_rules(
    MaxResults=123,
    NextToken='string',
    ResourceType='EBS_SNAPSHOT',
    ResourceTags=[
        {
            'ResourceTagKey': 'string',
            'ResourceTagValue': 'string'
        },
    ]
)

type MaxResults

integer

param MaxResults

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

type NextToken

string

param NextToken

The token to use to retrieve 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.

type ResourceTags

list

param ResourceTags

The tags used to identify resources that are to be retained by the retention rule.

(dict) --

Information about a resource tag used to identify resources that are to be retained by a Recycle Bin 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'
            }
        },
    ],
    '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 description for the retention rule.
    - RetentionPeriod (dict) --
      
      Information about the retention period for which the retention rule retains 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.
- 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.

DeleteRule (new)

Link ¶

Deletes a Recycle Bin retention rule. For more information, see Delete Recycle Bin retention rules in the Amazon EC2 User Guide .

See also: AWS API Documentation

Request Syntax

client.delete_rule(
    Identifier='string'
)

type Identifier

string

param Identifier

[REQUIRED]

The unique ID of the retention rule to delete.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

GetRule (new)

Link ¶

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',
    'RetentionPeriod': {
        'RetentionPeriodValue': 123,
        'RetentionPeriodUnit': 'DAYS'
    },
    'ResourceTags': [
        {
            'ResourceTagKey': 'string',
            'ResourceTagValue': 'string'
        },
    ],
    'Status': 'pending'|'available'
}

Response Structure

(dict) --
- Identifier (string) --
  
  The unique ID of the retention rule.
- Description (string) --
  
  The description assigned to the retention rule.
- ResourceType (string) --
  
  The resource type retained by the retention rule. Currently, only Amazon EBS snapshots are supported.
- RetentionPeriod (dict) --
  
  Information about the period for which the retention rule retains 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) --
  
  The resource tags used to identify resources that are to be retained by the retention rule.
  - (dict) --
    
    Information about a resource tag used to identify resources that are to be retained by a Recycle Bin 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 snapshots.

ListTagsForResource (new)

Link ¶

Lists the tags assigned a specific resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    ResourceArn='string'
)

type ResourceArn

string

param ResourceArn

[REQUIRED]

The Amazon Resource Name (ARN) of the resource for which to list the tags.

rtype

dict

returns

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) --
- Tags (list) --
  
  Information about the tags assigned to the resource.
  - (dict) --
    
    Information about the tags assigned to a Recycle Bin retention rule.
    - Key (string) --
      
      The tag key.
    - Value (string) --
      
      The tag value.

CreateRule (new)

Link ¶

Creates a Recycle Bin retention rule. For more information, see Create Recycle Bin retention rules in the Amazon EC2 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',
    ResourceTags=[
        {
            '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

A brief description for the retention rule.

type Tags

list

param Tags

Information about the tags to assign to the retention rule.

(dict) --

Information about the tags assigned to a Recycle Bin 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 are supported.

type ResourceTags

list

param ResourceTags

Information about the resource tags to use to identify resources that are to be retained by the retention rule. The retention rule retains only deleted snapshots that have one or more of the specified tag key and value pairs. If a snapshot 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.

(dict) --

Information about a resource tag used to identify resources that are to be retained by a Recycle Bin 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',
    'ResourceTags': [
        {
            'ResourceTagKey': 'string',
            'ResourceTagValue': 'string'
        },
    ],
    'Status': 'pending'|'available'
}

Response Structure

(dict) --
- Identifier (string) --
  
  The unique identifier of the retention rule.
- RetentionPeriod (dict) --
  
  Information about the retention period for which a 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) --
  
  The tags assigned to the retention rule.
  - (dict) --
    
    Information about the tags assigned to a Recycle Bin retention rule.
    - Key (string) --
      
      The tag key.
    - Value (string) --
      
      The tag value.
- 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.
  - (dict) --
    
    Information about a resource tag used to identify resources that are to be retained by a Recycle Bin 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 snapshots.

UpdateRule (new)

Link ¶

Updates an existing Recycle Bin retention rule. For more information, see Update Recycle Bin retention rules in the Amazon EC2 User Guide .

See also: AWS API Documentation

Request Syntax

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

type Identifier

string

param Identifier

[REQUIRED]

The unique ID of the retention rule to update.

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

The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots are supported.

type ResourceTags

list

param ResourceTags

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

(dict) --

Information about a resource tag used to identify resources that are to be retained by a Recycle Bin 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',
    'ResourceTags': [
        {
            'ResourceTagKey': 'string',
            'ResourceTagValue': 'string'
        },
    ],
    'Status': 'pending'|'available'
}

Response Structure

(dict) --
- Identifier (string) --
  
  The unique ID of the retention rule.
- RetentionPeriod (dict) --
  
  Information about the retention period for which a 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.
  - (dict) --
    
    Information about a resource tag used to identify resources that are to be retained by a Recycle Bin 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 snapshots.

UntagResource (new)

Link ¶

Unassigns a tag from a resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)

type ResourceArn

string

param ResourceArn

[REQUIRED]

The Amazon Resource Name (ARN) of the resource from which to unassign the tags.

type TagKeys

list

param TagKeys

[REQUIRED]

Information about the tags to unassign from the resource.

(string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

TagResource (new)

Link ¶

Assigns tags to the specified resource.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    ResourceArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type ResourceArn

string

param ResourceArn

[REQUIRED]

The Amazon Resource Name (ARN) of the resource to which to assign the tags.

type Tags

list

param Tags

[REQUIRED]

Information about the tags to assign to the resource.

(dict) --

Information about the tags assigned to a Recycle Bin retention rule.
- Key (string) -- [REQUIRED]
  
  The tag key.
- Value (string) -- [REQUIRED]
  
  The tag value.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --