View Source AWS.Rbin (aws-elixir v1.0.4)
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.
Link to this section 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.
Locks a Region-level retention rule.
Assigns tags to the specified retention rule.
Unlocks a retention rule.
Unassigns a tag from a retention rule.
Updates an existing Recycle Bin retention rule.
Link to this section Functions
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.
Deletes a Recycle Bin retention rule.
For more information, see Delete Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.
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.
Locks a Region-level retention rule.
A locked retention rule can't be modified or deleted.
You can't lock tag-level retention rules, or Region-level retention rules that have exclusion tags.
Assigns tags to the specified retention rule.
Unlocks a retention rule.
After a retention rule is unlocked, it can be modified or deleted only after the unlock delay period expires.
Unassigns a tag from a retention rule.
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.