QLDB

public struct QLDB

Client object for interacting with AWS QLDB service.

The control plane for Amazon QLDB

Member variables

Initialization

  • Initialize the QLDB 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

  • Ends a given Amazon QLDB journal stream. Before a stream can be canceled, its current status must be ACTIVE. You can’t restart a stream after you cancel it. Canceled QLDB stream resources are subject to a 7-day retention period, so they are automatically deleted after this limit expires.

    Declaration

    Swift

    public func cancelJournalKinesisStream(_ input: CancelJournalKinesisStreamRequest) -> EventLoopFuture<CancelJournalKinesisStreamResponse>

  • Creates a new ledger in your AWS account.

    Declaration

    Swift

    public func createLedger(_ input: CreateLedgerRequest) -> EventLoopFuture<CreateLedgerResponse>

  • Deletes a ledger and all of its contents. This action is irreversible. If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.

    Declaration

    Swift

    @discardableResult
public func deleteLedger(_ input: DeleteLedgerRequest) -> EventLoopFuture<Void>

  • Returns detailed information about a given Amazon QLDB journal stream. The output includes the Amazon Resource Name (ARN), stream name, current status, creation time, and the parameters of your original stream creation request.

    Declaration

    Swift

    public func describeJournalKinesisStream(_ input: DescribeJournalKinesisStreamRequest) -> EventLoopFuture<DescribeJournalKinesisStreamResponse>

  • Returns information about a journal export job, including the ledger name, export ID, when it was created, current status, and its start and end time export parameters. This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide. If the export job with the given ExportId doesn’t exist, then throws ResourceNotFoundException. If the ledger with the given Name doesn’t exist, then throws ResourceNotFoundException.

    Declaration

    Swift

    public func describeJournalS3Export(_ input: DescribeJournalS3ExportRequest) -> EventLoopFuture<DescribeJournalS3ExportResponse>

  • Returns information about a ledger, including its state and when it was created.

    Declaration

    Swift

    public func describeLedger(_ input: DescribeLedgerRequest) -> EventLoopFuture<DescribeLedgerResponse>

  • Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. The data is written as files in Amazon Ion format. If the ledger with the given Name doesn’t exist, then throws ResourceNotFoundException. If the ledger with the given Name is in CREATING status, then throws ResourcePreconditionNotMetException. You can initiate up to two concurrent journal export requests for each ledger. Beyond this limit, journal export requests throw LimitExceededException.

    Declaration

    Swift

    public func exportJournalToS3(_ input: ExportJournalToS3Request) -> EventLoopFuture<ExportJournalToS3Response>

  • Returns a block object at a specified address in a journal. Also returns a proof of the specified block for verification if DigestTipAddress is provided. For information about the data contents in a block, see Journal contents in the Amazon QLDB Developer Guide. If the specified ledger doesn’t exist or is in DELETING status, then throws ResourceNotFoundException. If the specified ledger is in CREATING status, then throws ResourcePreconditionNotMetException. If no block exists with the specified address, then throws InvalidParameterException.

    Declaration

    Swift

    public func getBlock(_ input: GetBlockRequest) -> EventLoopFuture<GetBlockResponse>

  • Returns the digest of a ledger at the latest committed block in the journal. The response includes a 256-bit hash value and a block address.

    Declaration

    Swift

    public func getDigest(_ input: GetDigestRequest) -> EventLoopFuture<GetDigestResponse>

  • Returns a revision data object for a specified document ID and block address. Also returns a proof of the specified revision for verification if DigestTipAddress is provided.

    Declaration

    Swift

    public func getRevision(_ input: GetRevisionRequest) -> EventLoopFuture<GetRevisionResponse>

  • Returns an array of all Amazon QLDB journal stream descriptors for a given ledger. The output of each stream descriptor includes the same details that are returned by DescribeJournalKinesisStream. This action returns a maximum of MaxResults items. It is paginated so that you can retrieve all the items by calling ListJournalKinesisStreamsForLedger multiple times.

    Declaration

    Swift

    public func listJournalKinesisStreamsForLedger(_ input: ListJournalKinesisStreamsForLedgerRequest) -> EventLoopFuture<ListJournalKinesisStreamsForLedgerResponse>

  • Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS account and Region. This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3Exports multiple times. This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide.

    Declaration

    Swift

    public func listJournalS3Exports(_ input: ListJournalS3ExportsRequest) -> EventLoopFuture<ListJournalS3ExportsResponse>

  • Returns an array of journal export job descriptions for a specified ledger. This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3ExportsForLedger multiple times. This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide.

    Declaration

    Swift

    public func listJournalS3ExportsForLedger(_ input: ListJournalS3ExportsForLedgerRequest) -> EventLoopFuture<ListJournalS3ExportsForLedgerResponse>

  • Returns an array of ledger summaries that are associated with the current AWS account and Region. This action returns a maximum of 100 items and is paginated so that you can retrieve all the items by calling ListLedgers multiple times.

    Declaration

    Swift

    public func listLedgers(_ input: ListLedgersRequest) -> EventLoopFuture<ListLedgersResponse>

  • Returns all tags for a specified Amazon QLDB resource.

    Declaration

    Swift

    public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse>

  • Creates a journal stream for a given Amazon QLDB ledger. The stream captures every document revision that is committed to the ledger’s journal and delivers the data to a specified Amazon Kinesis Data Streams resource.

    Declaration

    Swift

    public func streamJournalToKinesis(_ input: StreamJournalToKinesisRequest) -> EventLoopFuture<StreamJournalToKinesisResponse>

  • Adds one or more tags to a specified Amazon QLDB resource. A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, your request fails and returns an error.

    Declaration

    Swift

    public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse>

  • Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.

    Declaration

    Swift

    public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse>

  • Updates properties on a ledger.

    Declaration

    Swift

    public func updateLedger(_ input: UpdateLedgerRequest) -> EventLoopFuture<UpdateLedgerResponse>

Paginators

  • Returns an array of all Amazon QLDB journal stream descriptors for a given ledger. The output of each stream descriptor includes the same details that are returned by DescribeJournalKinesisStream. This action returns a maximum of MaxResults items. It is paginated so that you can retrieve all the items by calling ListJournalKinesisStreamsForLedger multiple times.

    Declaration

    Swift

    public func listJournalKinesisStreamsForLedgerPaginator(_ input: ListJournalKinesisStreamsForLedgerRequest, onPage: @escaping (ListJournalKinesisStreamsForLedgerResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS account and Region. This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3Exports multiple times. This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide.

    Declaration

    Swift

    public func listJournalS3ExportsPaginator(_ input: ListJournalS3ExportsRequest, onPage: @escaping (ListJournalS3ExportsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • Returns an array of journal export job descriptions for a specified ledger. This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3ExportsForLedger multiple times. This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide.

    Declaration

    Swift

    public func listJournalS3ExportsForLedgerPaginator(_ input: ListJournalS3ExportsForLedgerRequest, onPage: @escaping (ListJournalS3ExportsForLedgerResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • Returns an array of ledger summaries that are associated with the current AWS account and Region. This action returns a maximum of 100 items and is paginated so that you can retrieve all the items by calling ListLedgers multiple times.

    Declaration

    Swift

    public func listLedgersPaginator(_ input: ListLedgersRequest, onPage: @escaping (ListLedgersResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes

Enums

  • Undocumented

    See more

    Declaration

    Swift

    public enum ErrorCause : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ExportStatus : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum LedgerState : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum PermissionsMode : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum S3ObjectEncryptionType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum StreamStatus : String, CustomStringConvertible, Codable