Rbin

Service object for interacting with AWS Rbin service.

public struct Rbin: AWSService 

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

     <p>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.</p> 

     <p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-recycle-bin.html">
    Recycle Bin</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>

Inheritance

AWSService

Initializers

init(client:region:partition:endpoint:timeout:byteBufferAllocator:options:)

Initialize the Rbin client

public init(
        client: AWSClient,
        region: SotoCore.Region? = nil,
        partition: AWSPartition = .aws,
        endpoint: String? = nil,
        timeout: TimeAmount? = nil,
        byteBufferAllocator: ByteBufferAllocator = ByteBufferAllocator(),
        options: AWSServiceConfig.Options = []
    ) 

Parameters

• client: AWSClient used to process requests
• region: Region of server you want to communicate with. This will override the partition parameter.
• partition: AWS partition where service resides, standard (.aws), china (.awscn), government (.awsusgov).
• endpoint: Custom endpoint URL to use instead of standard AWS servers
• timeout: Timeout value for HTTP requests

init(from:patch:)

Initializer required by AWSService.with(middlewares:​timeout:​byteBufferAllocator:​options). You are not able to use this initializer directly as there are no public initializers for AWSServiceConfig.Patch. Please use AWSService.with(middlewares:​timeout:​byteBufferAllocator:​options) instead.

public init(from: Rbin, patch: AWSServiceConfig.Patch) 

Properties

client

Client used for communication with AWS

public let client: AWSClient

config

Service configuration

public let config: AWSServiceConfig

Methods

createRule(_:logger:on:)

public func createRule(_ input: CreateRuleRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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(_:logger:on:)

public func deleteRule(_ input: DeleteRuleRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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(_:logger:on:)

public func getRule(_ input: GetRuleRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetRuleResponse> 

Gets information about a Recycle Bin retention rule.

listRules(_:logger:on:)

public func listRules(_ input: ListRulesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListRulesResponse> 

Lists the Recycle Bin retention rules in the Region.

listTagsForResource(_:logger:on:)

public func listTagsForResource(_ input: ListTagsForResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListTagsForResourceResponse> 

Lists the tags assigned to a retention rule.

tagResource(_:logger:on:)

public func tagResource(_ input: TagResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<TagResourceResponse> 

Assigns tags to the specified retention rule.

untagResource(_:logger:on:)

public func untagResource(_ input: UntagResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UntagResourceResponse> 

Unassigns a tag from a retention rule.

updateRule(_:logger:on:)

public func updateRule(_ input: UpdateRuleRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateRuleResponse> 

Updates an existing Recycle Bin retention rule. For more information, see Update Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.

listRulesPaginator(_:logger:on:)

compiler(>=5.5.2) && canImport(_Concurrency)

public func listRulesPaginator(
        _ input: ListRulesRequest,
        logger: Logger = AWSClient.loggingDisabled,
        on eventLoop: EventLoop? = nil
    ) -> AWSClient.PaginatorSequence<ListRulesRequest, ListRulesResponse> 

Lists the Recycle Bin retention rules in the Region.

Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on

listRulesPaginator(_:_:logger:on:onPage:)

Provide paginated results to closure onPage for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:​_:​) -> Result.

public func listRulesPaginator<Result>(
        _ input: ListRulesRequest,
        _ initialValue: Result,
        logger: Logger = AWSClient.loggingDisabled,
        on eventLoop: EventLoop? = nil,
        onPage: @escaping (Result, ListRulesResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
    ) -> EventLoopFuture<Result> 

Lists the Recycle Bin retention rules in the Region.

Parameters:

• input: Input for request

• initialValue: The value to use as the initial accumulating value. initialValue is passed to onPage the first time it is called.

• logger: Logger used flot logging

• eventLoop: EventLoop to run this process on

• onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.

listRulesPaginator(_:logger:on:onPage:)

Provide paginated results to closure onPage.

public func listRulesPaginator(
        _ input: ListRulesRequest,
        logger: Logger = AWSClient.loggingDisabled,
        on eventLoop: EventLoop? = nil,
        onPage: @escaping (ListRulesResponse, EventLoop) -> EventLoopFuture<Bool>
    ) -> EventLoopFuture<Void> 

Parameters

• input: Input for request
• logger: Logger used flot logging
• eventLoop: EventLoop to run this process on
• onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.