RbinClient

interface RbinClient : SdkClient

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.

Properties

Link copied to clipboard
abstract override val config: RbinClient.Config

RbinClient's configuration

Functions

Link copied to clipboard
abstract suspend fun createRule(input: CreateRuleRequest): CreateRuleResponse

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

Link copied to clipboard
abstract suspend fun deleteRule(input: DeleteRuleRequest): DeleteRuleResponse

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

Link copied to clipboard
abstract suspend fun getRule(input: GetRuleRequest): GetRuleResponse

Gets information about a Recycle Bin retention rule.

Link copied to clipboard
abstract suspend fun listRules(input: ListRulesRequest): ListRulesResponse

Lists the Recycle Bin retention rules in the Region.

Link copied to clipboard

Lists the tags assigned to a retention rule.

Link copied to clipboard
abstract suspend fun lockRule(input: LockRuleRequest): LockRuleResponse

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

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Assigns tags to the specified retention rule.

Link copied to clipboard
abstract suspend fun unlockRule(input: UnlockRuleRequest): UnlockRuleResponse

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

Link copied to clipboard

Unassigns a tag from a retention rule.

Link copied to clipboard
abstract suspend fun updateRule(input: UpdateRuleRequest): UpdateRuleResponse

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.

Inherited functions

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun RbinClient.createRule(crossinline block: CreateRuleRequest.Builder.() -> Unit): CreateRuleResponse

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

Link copied to clipboard
inline suspend fun RbinClient.deleteRule(crossinline block: DeleteRuleRequest.Builder.() -> Unit): DeleteRuleResponse

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

Link copied to clipboard
inline suspend fun RbinClient.getRule(crossinline block: GetRuleRequest.Builder.() -> Unit): GetRuleResponse

Gets information about a Recycle Bin retention rule.

Link copied to clipboard
inline suspend fun RbinClient.listRules(crossinline block: ListRulesRequest.Builder.() -> Unit): ListRulesResponse

Lists the Recycle Bin retention rules in the Region.

Link copied to clipboard

Lists the tags assigned to a retention rule.

Link copied to clipboard
inline suspend fun RbinClient.lockRule(crossinline block: LockRuleRequest.Builder.() -> Unit): LockRuleResponse

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

Link copied to clipboard
inline suspend fun RbinClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Assigns tags to the specified retention rule.

Link copied to clipboard
inline suspend fun RbinClient.unlockRule(crossinline block: UnlockRuleRequest.Builder.() -> Unit): UnlockRuleResponse

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

Link copied to clipboard

Unassigns a tag from a retention rule.

Link copied to clipboard
inline suspend fun RbinClient.updateRule(crossinline block: UpdateRuleRequest.Builder.() -> Unit): UpdateRuleResponse

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.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.