# Rbin

This page documents function available when using the Rbin module, created with @service Rbin.

### Documentation

Main.Rbin.create_ruleMethod
create_rule(resource_type, retention_period)
create_rule(resource_type, retention_period, params::Dict{String,<:Any})

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

Arguments

• resource_type: The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To retain snapshots, specify EBSSNAPSHOT. To retain EBS-backed AMIs, specify EC2IMAGE.
• retention_period: Information about the retention period for which the retention rule is to retain resources.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Description": The retention rule description.
• "LockConfiguration": Information about the retention rule lock configuration.
• "ResourceTags": Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule. You can add the same tag key and value pair to a maximum or five retention rules. To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.
• "Tags": Information about the tags to assign to the retention rule.
source
Main.Rbin.delete_ruleMethod
delete_rule(identifier)
delete_rule(identifier, params::Dict{String,<:Any})

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

Arguments

• identifier: The unique ID of the retention rule.
source
Main.Rbin.get_ruleMethod
get_rule(identifier)
get_rule(identifier, params::Dict{String,<:Any})

Gets information about a Recycle Bin retention rule.

Arguments

• identifier: The unique ID of the retention rule.
source
Main.Rbin.list_rulesMethod
list_rules(resource_type)
list_rules(resource_type, params::Dict{String,<:Any})

Lists the Recycle Bin retention rules in the Region.

Arguments

• resource_type: The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To list retention rules that retain snapshots, specify EBSSNAPSHOT. To list retention rules that retain EBS-backed AMIs, specify EC2IMAGE.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "LockState": The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.
• "MaxResults": The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned NextToken value.
• "NextToken": The token for the next page of results.
• "ResourceTags": Information about the resource tags used to identify resources that are retained by the retention rule.
source
Main.Rbin.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Lists the tags assigned to a retention rule.

Arguments

• resource_arn: The Amazon Resource Name (ARN) of the retention rule.
source
Main.Rbin.lock_ruleMethod
lock_rule(lock_configuration, identifier)
lock_rule(lock_configuration, identifier, params::Dict{String,<:Any})

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

Arguments

• lock_configuration: Information about the retention rule lock configuration.
• identifier: The unique ID of the retention rule.
source
Main.Rbin.tag_resourceMethod
tag_resource(tags, resource_arn)
tag_resource(tags, resource_arn, params::Dict{String,<:Any})

Assigns tags to the specified retention rule.

Arguments

• tags: Information about the tags to assign to the retention rule.
• resource_arn: The Amazon Resource Name (ARN) of the retention rule.
source
Main.Rbin.unlock_ruleMethod
unlock_rule(identifier)
unlock_rule(identifier, params::Dict{String,<:Any})

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

Arguments

• identifier: The unique ID of the retention rule.
source
Main.Rbin.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Unassigns a tag from a retention rule.

Arguments

• resource_arn: The Amazon Resource Name (ARN) of the retention rule.
• tag_keys: The tag keys of the tags to unassign. All tags that have the specified tag key are unassigned.
source
Main.Rbin.update_ruleMethod
update_rule(identifier)
update_rule(identifier, params::Dict{String,<:Any})

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.

Arguments

• identifier: The unique ID of the retention rule.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Description": The retention rule description.
• "ResourceTags": Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule. You can add the same tag key and value pair to a maximum or five retention rules. To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.
• "ResourceType": This parameter is currently not supported. You can't update a retention rule's resource type after creation.
• "RetentionPeriod": Information about the retention period for which the retention rule is to retain resources.
source