Amazon Web Services, Inc.

Amazon Recycle Bin

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…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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
EBS volumes, EBS 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 .

Endpoints 10

  • POSTCreate rule/rulesCreates a Recycle Bin retention rule. You can create two types of retention rules: Tag-level retention rules - These retention rules use resource tags to…
  • GETGet rule/rules/:IdentifierGets information about a Recycle Bin retention rule.
  • DELETEDelete rule/rules/:IdentifierDeletes a Recycle Bin retention rule. For more information, see Delete Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide .
  • PATCHUpdate rule/rules/:IdentifierUpdates an existing Recycle Bin retention rule. You can update a retention rule's description, resource tags, and retention period at any time after creation.…
  • POSTList rules/list-rulesLists the Recycle Bin retention rules in the Region.
  • GETList tags for resource/tags/:ResourceArnLists the tags assigned to a retention rule.
  • POSTTag resource/tags/:ResourceArnAssigns tags to the specified retention rule.
  • DELETEUntag resource/tags/:ResourceArn?tagKeys=Unassigns a tag from a retention rule.
  • PATCHLock rule/rules/:Identifier/lockLocks 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…
  • PATCHUnlock rule/rules/:Identifier/unlockUnlocks a retention rule. After a retention rule is unlocked, it can be modified or deleted only after the unlock delay period expires.

API details

Base URL
https://rbin.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
10 operations on 6 pathsPOST 3PATCH 3GET 2DELETE 2
Description format
AWS Smithy model, API version 2021-06-15

How to test the Amazon Recycle Bin in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Recycle Bin collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create rule” (POST /rules), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Recycle Bin?

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… It is listed under Developer tools and has 10 endpoints.

Who publishes the Amazon Recycle Bin?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Recycle Bin?

Requests go to https://rbin.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Recycle Bin?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Recycle Bin have?

10 operations on 6 paths (3 POST, 3 PATCH, 2 GET, 2 DELETE).

Is forking the Amazon Recycle Bin free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.