View Source AWS.Rbin (aws-elixir v1.0.0)

This is the Recycle Bin API Reference.

This documentation provides descriptions and syntax for each of the actions and data types in Recycle Bin.

Recycle Bin is a resource recovery feature that enables you to restore accidentally deleted snapshots and EBS-backed AMIs. When using Recycle Bin, if your resources are deleted, they are retained in the Recycle Bin for a time period that you specify.

You can restore a resource from the Recycle Bin at any time before its retention period expires. After you restore a resource from the Recycle Bin, the resource is removed from the Recycle Bin, and you can then use it in the same way you use any other resource of that type in your account. If the retention period expires and the resource is not restored, the resource is permanently deleted from the Recycle Bin and is no longer available for recovery. For more information about Recycle Bin, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.

Summary

Functions

Creates a Recycle Bin retention rule.

Deletes a Recycle Bin retention rule.

Gets information about a Recycle Bin retention rule.

Lists the Recycle Bin retention rules in the Region.

Lists the tags assigned to a retention rule.

Assigns tags to the specified retention rule.

Unassigns a tag from a retention rule.

Updates an existing Recycle Bin retention rule.

Functions

Link to this function

create_rule(client, input, options \\ [])

View Source

Creates a Recycle Bin retention rule.

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

Link to this function

delete_rule(client, identifier, input, options \\ [])

View Source

Deletes a Recycle Bin retention rule.

For more information, see Delete Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.

Link to this function

get_rule(client, identifier, options \\ [])

View Source

Gets information about a Recycle Bin retention rule.

Link to this function

list_rules(client, input, options \\ [])

View Source

Lists the Recycle Bin retention rules in the Region.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists the tags assigned to a retention rule.

Link to this function

lock_rule(client, identifier, input, options \\ [])

View Source

Locks a retention rule.

A locked retention rule can't be modified or deleted.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Assigns tags to the specified retention rule.

Link to this function

unlock_rule(client, identifier, input, options \\ [])

View Source

Unlocks a retention rule.

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

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Unassigns a tag from a retention rule.

Link to this function

update_rule(client, identifier, input, options \\ [])

View Source

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.