rbin/aws.sdk.kotlin.services.rbin

Package-level declarations

Types

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

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

createRule

inline suspend fun RbinClient.createRule(crossinline block: CreateRuleRequest.Builder.() -> Unit): CreateRuleResponse

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

deleteRule

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.

getRule

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

Gets information about a Recycle Bin retention rule.

listRules

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

Lists the Recycle Bin retention rules in the Region.

listTagsForResource

inline suspend fun RbinClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists the tags assigned to a retention rule.

lockRule

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

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

tagResource

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

Assigns tags to the specified retention rule.

unlockRule

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.

untagResource

inline suspend fun RbinClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Unassigns a tag from a retention rule.

updateRule

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.

withConfig

fun RbinClient.withConfig(block: RbinClient.Config.Builder.() -> Unit): RbinClient

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.