EBS

public struct EBS

Client object for interacting with AWS EBS service.

You can use the Amazon Elastic Block Store (Amazon EBS) direct APIs to create EBS snapshots, write data directly to your snapshots, read data on your snapshots, and identify the differences or changes between two snapshots. If you’re an independent software vendor (ISV) who offers backup services for Amazon EBS, the EBS direct APIs make it more efficient and cost-effective to track incremental changes on your EBS volumes through snapshots. This can be done without having to create new volumes from snapshots, and then use Amazon Elastic Compute Cloud (Amazon EC2) instances to compare the differences. You can create incremental snapshots directly from data on-premises into EBS volumes and the cloud to use for quick disaster recovery. With the ability to write and read snapshots, you can write your on-premises data to an EBS snapshot during a disaster. Then after recovery, you can restore it back to AWS or on-premises from the snapshot. You no longer need to build and maintain complex mechanisms to copy data to and from Amazon EBS. This API reference provides detailed information about the actions, data types, parameters, and errors of the EBS direct APIs. For more information about the elements that make up the EBS direct APIs, and examples of how to use them effectively, see Accessing the Contents of an EBS Snapshot in the Amazon Elastic Compute Cloud User Guide. For more information about the supported AWS Regions, endpoints, and service quotas for the EBS direct APIs, see Amazon Elastic Block Store Endpoints and Quotas in the AWS General Reference.

Member variables

client
Undocumented
Declaration
Swift

public let client: AWSClient

Initialization


                    
                    
                    init(accessKeyId:secretAccessKey:sessionToken:region:endpoint:middlewares:eventLoopGroupProvider:)

Initialize the EBS client

Declaration

Swift

public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

Parameters

`accessKeyId`	Public access key provided by AWS
`secretAccessKey`	Private access key provided by AWS
`sessionToken`	Token provided by STS.AssumeRole() which allows access to another AWS account
`region`	Region of server you want to communicate with
`endpoint`	Custom endpoint URL to use instead of standard AWS servers
`middlewares`	Array of middlewares to apply to requests and responses
`eventLoopGroupProvider`	EventLoopGroup to use. Use `useAWSClientShared` if the client shall manage its own EventLoopGroup.

API Calls

completeSnapshot(_:)
Seals and completes the snapshot after all of the required blocks of data have been written to it. Completing the snapshot changes the status to completed. You cannot write new blocks to a snapshot after it has been completed.
Declaration
Swift

public func completeSnapshot(_ input: CompleteSnapshotRequest) -> EventLoopFuture<CompleteSnapshotResponse>


                    
                    
                    getSnapshotBlock(_:)

Returns the data in a block in an Amazon Elastic Block Store snapshot.

Declaration

Swift

public func getSnapshotBlock(_ input: GetSnapshotBlockRequest) -> EventLoopFuture<GetSnapshotBlockResponse>

listChangedBlocks(_:)
Returns information about the blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.
Declaration
Swift

public func listChangedBlocks(_ input: ListChangedBlocksRequest) -> EventLoopFuture<ListChangedBlocksResponse>


                    
                    
                    listSnapshotBlocks(_:)

Returns information about the blocks in an Amazon Elastic Block Store snapshot.

Declaration

Swift

public func listSnapshotBlocks(_ input: ListSnapshotBlocksRequest) -> EventLoopFuture<ListSnapshotBlocksResponse>

putSnapshotBlock(_:)
Writes a block of data to a snapshot. If the specified block contains data, the existing data is overwritten. The target snapshot must be in the pending state. Data written to a snapshot must be aligned with 512-byte sectors.
Declaration
Swift

public func putSnapshotBlock(_ input: PutSnapshotBlockRequest) -> EventLoopFuture<PutSnapshotBlockResponse>
startSnapshot(_:)
Creates a new Amazon EBS snapshot. The new snapshot enters the pending state after the request completes. After creating the snapshot, use PutSnapshotBlock to write blocks of data to the snapshot.
Declaration
Swift

public func startSnapshot(_ input: StartSnapshotRequest) -> EventLoopFuture<StartSnapshotResponse>

Paginators

listChangedBlocksPaginator(_:onPage:)
Returns information about the blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.
Declaration
Swift

public func listChangedBlocksPaginator(_ input: ListChangedBlocksRequest, onPage: @escaping (ListChangedBlocksResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listSnapshotBlocksPaginator(_:onPage:)

Returns information about the blocks in an Amazon Elastic Block Store snapshot.

Declaration

Swift

public func listSnapshotBlocksPaginator(_ input: ListSnapshotBlocksRequest, onPage: @escaping (ListSnapshotBlocksResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes


                    
                    
                    ListChangedBlocksRequest

Undocumented

Declaration

Swift

public struct ListChangedBlocksRequest : AWSShape

extension EBS.ListChangedBlocksRequest: AWSPaginateStringToken


                    
                    
                    ListSnapshotBlocksRequest

Undocumented

Declaration

Swift

public struct ListSnapshotBlocksRequest : AWSShape

extension EBS.ListSnapshotBlocksRequest: AWSPaginateStringToken

Block
Undocumented
See more
Declaration
Swift

public struct Block : AWSShape
ChangedBlock
Undocumented
See more
Declaration
Swift

public struct ChangedBlock : AWSShape
CompleteSnapshotRequest
Undocumented
See more
Declaration
Swift

public struct CompleteSnapshotRequest : AWSShape
CompleteSnapshotResponse
Undocumented
See more
Declaration
Swift

public struct CompleteSnapshotResponse : AWSShape
GetSnapshotBlockRequest
Undocumented
See more
Declaration
Swift

public struct GetSnapshotBlockRequest : AWSShape
GetSnapshotBlockResponse
Undocumented
See more
Declaration
Swift

public struct GetSnapshotBlockResponse : AWSShape
ListChangedBlocksResponse
Undocumented
See more
Declaration
Swift

public struct ListChangedBlocksResponse : AWSShape
ListSnapshotBlocksResponse
Undocumented
See more
Declaration
Swift

public struct ListSnapshotBlocksResponse : AWSShape
PutSnapshotBlockRequest
Undocumented
See more
Declaration
Swift

public struct PutSnapshotBlockRequest : AWSShape
PutSnapshotBlockResponse
Undocumented
See more
Declaration
Swift

public struct PutSnapshotBlockResponse : AWSShape
StartSnapshotRequest
Undocumented
See more
Declaration
Swift

public struct StartSnapshotRequest : AWSShape
StartSnapshotResponse
Undocumented
See more
Declaration
Swift

public struct StartSnapshotResponse : AWSShape
Tag
Undocumented
See more
Declaration
Swift

public struct Tag : AWSShape

Enums


                    
                    
                    ChecksumAggregationMethod

Undocumented

Declaration

Swift

public enum ChecksumAggregationMethod : String, CustomStringConvertible, Codable


                    
                    
                    ChecksumAlgorithm

Undocumented

Declaration

Swift

public enum ChecksumAlgorithm : String, CustomStringConvertible, Codable


                    
                    
                    Status

Undocumented

Declaration

Swift

public enum Status : String, CustomStringConvertible, Codable