aws-sdk-go: github.com/aws/aws-sdk-go/service/qldb Index | Files | Directories

package qldb

import "github.com/aws/aws-sdk-go/service/qldb"

Package qldb provides the client and types for making API requests to Amazon QLDB.

The control plane for Amazon QLDB

See https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02 for more information on this service.

See qldb package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/qldb/

Using the Client

To contact Amazon QLDB with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon QLDB client QLDB for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/qldb/#New

Index

Package Files

api.go doc.go errors.go service.go

Constants

const (
    // ExportStatusInProgress is a ExportStatus enum value
    ExportStatusInProgress = "IN_PROGRESS"

    // ExportStatusCompleted is a ExportStatus enum value
    ExportStatusCompleted = "COMPLETED"

    // ExportStatusCancelled is a ExportStatus enum value
    ExportStatusCancelled = "CANCELLED"
)
const (
    // LedgerStateCreating is a LedgerState enum value
    LedgerStateCreating = "CREATING"

    // LedgerStateActive is a LedgerState enum value
    LedgerStateActive = "ACTIVE"

    // LedgerStateDeleting is a LedgerState enum value
    LedgerStateDeleting = "DELETING"

    // LedgerStateDeleted is a LedgerState enum value
    LedgerStateDeleted = "DELETED"
)
const (
    // S3ObjectEncryptionTypeSseKms is a S3ObjectEncryptionType enum value
    S3ObjectEncryptionTypeSseKms = "SSE_KMS"

    // S3ObjectEncryptionTypeSseS3 is a S3ObjectEncryptionType enum value
    S3ObjectEncryptionTypeSseS3 = "SSE_S3"

    // S3ObjectEncryptionTypeNoEncryption is a S3ObjectEncryptionType enum value
    S3ObjectEncryptionTypeNoEncryption = "NO_ENCRYPTION"
)
const (

    // ErrCodeInvalidParameterException for service response error code
    // "InvalidParameterException".
    //
    // One or more parameters in the request aren't valid.
    ErrCodeInvalidParameterException = "InvalidParameterException"

    // ErrCodeLimitExceededException for service response error code
    // "LimitExceededException".
    //
    // You have reached the limit on the maximum number of resources allowed.
    ErrCodeLimitExceededException = "LimitExceededException"

    // ErrCodeResourceAlreadyExistsException for service response error code
    // "ResourceAlreadyExistsException".
    //
    // The specified resource already exists.
    ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExistsException"

    // ErrCodeResourceInUseException for service response error code
    // "ResourceInUseException".
    //
    // The specified resource can't be modified at this time.
    ErrCodeResourceInUseException = "ResourceInUseException"

    // ErrCodeResourceNotFoundException for service response error code
    // "ResourceNotFoundException".
    //
    // The specified resource doesn't exist.
    ErrCodeResourceNotFoundException = "ResourceNotFoundException"

    // ErrCodeResourcePreconditionNotMetException for service response error code
    // "ResourcePreconditionNotMetException".
    //
    // The operation failed because a condition wasn't satisfied in advance.
    ErrCodeResourcePreconditionNotMetException = "ResourcePreconditionNotMetException"
)
const (
    ServiceName = "QLDB" // Name of service.
    EndpointsID = "qldb" // ID to lookup a service endpoint with.
    ServiceID   = "QLDB" // ServiceID is a unique identifer of a specific service.
)

Service information constants

const (
    // PermissionsModeAllowAll is a PermissionsMode enum value
    PermissionsModeAllowAll = "ALLOW_ALL"
)

type CreateLedgerInput Uses

type CreateLedgerInput struct {

    // The flag that prevents a ledger from being deleted by any user. If not provided
    // on ledger creation, this feature is enabled (true) by default.
    //
    // 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.
    DeletionProtection *bool `type:"boolean"`

    // The name of the ledger that you want to create. The name must be unique among
    // all of your ledgers in the current AWS Region.
    //
    // Name is a required field
    Name *string `min:"1" type:"string" required:"true"`

    // The permissions mode to assign to the ledger that you want to create.
    //
    // PermissionsMode is a required field
    PermissionsMode *string `type:"string" required:"true" enum:"PermissionsMode"`

    // The key-value pairs to add as tags to the ledger that you want to create.
    // Tag keys are case sensitive. Tag values are case sensitive and can be null.
    Tags map[string]*string `type:"map"`
    // contains filtered or unexported fields
}

func (CreateLedgerInput) GoString Uses

func (s CreateLedgerInput) GoString() string

GoString returns the string representation

func (*CreateLedgerInput) SetDeletionProtection Uses

func (s *CreateLedgerInput) SetDeletionProtection(v bool) *CreateLedgerInput

SetDeletionProtection sets the DeletionProtection field's value.

func (*CreateLedgerInput) SetName Uses

func (s *CreateLedgerInput) SetName(v string) *CreateLedgerInput

SetName sets the Name field's value.

func (*CreateLedgerInput) SetPermissionsMode Uses

func (s *CreateLedgerInput) SetPermissionsMode(v string) *CreateLedgerInput

SetPermissionsMode sets the PermissionsMode field's value.

func (*CreateLedgerInput) SetTags Uses

func (s *CreateLedgerInput) SetTags(v map[string]*string) *CreateLedgerInput

SetTags sets the Tags field's value.

func (CreateLedgerInput) String Uses

func (s CreateLedgerInput) String() string

String returns the string representation

func (*CreateLedgerInput) Validate Uses

func (s *CreateLedgerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateLedgerOutput Uses

type CreateLedgerOutput struct {

    // The Amazon Resource Name (ARN) for the ledger.
    Arn *string `min:"20" type:"string"`

    // The date and time, in epoch time format, when the ledger was created. (Epoch
    // time format is the number of seconds elapsed since 12:00:00 AM January 1,
    // 1970 UTC.)
    CreationDateTime *time.Time `type:"timestamp"`

    // The flag that prevents a ledger from being deleted by any user. If not provided
    // on ledger creation, this feature is enabled (true) by default.
    //
    // 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.
    DeletionProtection *bool `type:"boolean"`

    // The name of the ledger.
    Name *string `min:"1" type:"string"`

    // The current status of the ledger.
    State *string `type:"string" enum:"LedgerState"`
    // contains filtered or unexported fields
}

func (CreateLedgerOutput) GoString Uses

func (s CreateLedgerOutput) GoString() string

GoString returns the string representation

func (*CreateLedgerOutput) SetArn Uses

func (s *CreateLedgerOutput) SetArn(v string) *CreateLedgerOutput

SetArn sets the Arn field's value.

func (*CreateLedgerOutput) SetCreationDateTime Uses

func (s *CreateLedgerOutput) SetCreationDateTime(v time.Time) *CreateLedgerOutput

SetCreationDateTime sets the CreationDateTime field's value.

func (*CreateLedgerOutput) SetDeletionProtection Uses

func (s *CreateLedgerOutput) SetDeletionProtection(v bool) *CreateLedgerOutput

SetDeletionProtection sets the DeletionProtection field's value.

func (*CreateLedgerOutput) SetName Uses

func (s *CreateLedgerOutput) SetName(v string) *CreateLedgerOutput

SetName sets the Name field's value.

func (*CreateLedgerOutput) SetState Uses

func (s *CreateLedgerOutput) SetState(v string) *CreateLedgerOutput

SetState sets the State field's value.

func (CreateLedgerOutput) String Uses

func (s CreateLedgerOutput) String() string

String returns the string representation

type DeleteLedgerInput Uses

type DeleteLedgerInput struct {

    // The name of the ledger that you want to delete.
    //
    // Name is a required field
    Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteLedgerInput) GoString Uses

func (s DeleteLedgerInput) GoString() string

GoString returns the string representation

func (*DeleteLedgerInput) SetName Uses

func (s *DeleteLedgerInput) SetName(v string) *DeleteLedgerInput

SetName sets the Name field's value.

func (DeleteLedgerInput) String Uses

func (s DeleteLedgerInput) String() string

String returns the string representation

func (*DeleteLedgerInput) Validate Uses

func (s *DeleteLedgerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteLedgerOutput Uses

type DeleteLedgerOutput struct {
    // contains filtered or unexported fields
}

func (DeleteLedgerOutput) GoString Uses

func (s DeleteLedgerOutput) GoString() string

GoString returns the string representation

func (DeleteLedgerOutput) String Uses

func (s DeleteLedgerOutput) String() string

String returns the string representation

type DescribeJournalS3ExportInput Uses

type DescribeJournalS3ExportInput struct {

    // The unique ID of the journal export job that you want to describe.
    //
    // ExportId is a required field
    ExportId *string `location:"uri" locationName:"exportId" min:"22" type:"string" required:"true"`

    // The name of the ledger.
    //
    // Name is a required field
    Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeJournalS3ExportInput) GoString Uses

func (s DescribeJournalS3ExportInput) GoString() string

GoString returns the string representation

func (*DescribeJournalS3ExportInput) SetExportId Uses

func (s *DescribeJournalS3ExportInput) SetExportId(v string) *DescribeJournalS3ExportInput

SetExportId sets the ExportId field's value.

func (*DescribeJournalS3ExportInput) SetName Uses

func (s *DescribeJournalS3ExportInput) SetName(v string) *DescribeJournalS3ExportInput

SetName sets the Name field's value.

func (DescribeJournalS3ExportInput) String Uses

func (s DescribeJournalS3ExportInput) String() string

String returns the string representation

func (*DescribeJournalS3ExportInput) Validate Uses

func (s *DescribeJournalS3ExportInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeJournalS3ExportOutput Uses

type DescribeJournalS3ExportOutput struct {

    // Information about the journal export job returned by a DescribeJournalS3Export
    // request.
    //
    // ExportDescription is a required field
    ExportDescription *JournalS3ExportDescription `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeJournalS3ExportOutput) GoString Uses

func (s DescribeJournalS3ExportOutput) GoString() string

GoString returns the string representation

func (*DescribeJournalS3ExportOutput) SetExportDescription Uses

func (s *DescribeJournalS3ExportOutput) SetExportDescription(v *JournalS3ExportDescription) *DescribeJournalS3ExportOutput

SetExportDescription sets the ExportDescription field's value.

func (DescribeJournalS3ExportOutput) String Uses

func (s DescribeJournalS3ExportOutput) String() string

String returns the string representation

type DescribeLedgerInput Uses

type DescribeLedgerInput struct {

    // The name of the ledger that you want to describe.
    //
    // Name is a required field
    Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeLedgerInput) GoString Uses

func (s DescribeLedgerInput) GoString() string

GoString returns the string representation

func (*DescribeLedgerInput) SetName Uses

func (s *DescribeLedgerInput) SetName(v string) *DescribeLedgerInput

SetName sets the Name field's value.

func (DescribeLedgerInput) String Uses

func (s DescribeLedgerInput) String() string

String returns the string representation

func (*DescribeLedgerInput) Validate Uses

func (s *DescribeLedgerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeLedgerOutput Uses

type DescribeLedgerOutput struct {

    // The Amazon Resource Name (ARN) for the ledger.
    Arn *string `min:"20" type:"string"`

    // The date and time, in epoch time format, when the ledger was created. (Epoch
    // time format is the number of seconds elapsed since 12:00:00 AM January 1,
    // 1970 UTC.)
    CreationDateTime *time.Time `type:"timestamp"`

    // The flag that prevents a ledger from being deleted by any user. If not provided
    // on ledger creation, this feature is enabled (true) by default.
    //
    // 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.
    DeletionProtection *bool `type:"boolean"`

    // The name of the ledger.
    Name *string `min:"1" type:"string"`

    // The current status of the ledger.
    State *string `type:"string" enum:"LedgerState"`
    // contains filtered or unexported fields
}

func (DescribeLedgerOutput) GoString Uses

func (s DescribeLedgerOutput) GoString() string

GoString returns the string representation

func (*DescribeLedgerOutput) SetArn Uses

func (s *DescribeLedgerOutput) SetArn(v string) *DescribeLedgerOutput

SetArn sets the Arn field's value.

func (*DescribeLedgerOutput) SetCreationDateTime Uses

func (s *DescribeLedgerOutput) SetCreationDateTime(v time.Time) *DescribeLedgerOutput

SetCreationDateTime sets the CreationDateTime field's value.

func (*DescribeLedgerOutput) SetDeletionProtection Uses

func (s *DescribeLedgerOutput) SetDeletionProtection(v bool) *DescribeLedgerOutput

SetDeletionProtection sets the DeletionProtection field's value.

func (*DescribeLedgerOutput) SetName Uses

func (s *DescribeLedgerOutput) SetName(v string) *DescribeLedgerOutput

SetName sets the Name field's value.

func (*DescribeLedgerOutput) SetState Uses

func (s *DescribeLedgerOutput) SetState(v string) *DescribeLedgerOutput

SetState sets the State field's value.

func (DescribeLedgerOutput) String Uses

func (s DescribeLedgerOutput) String() string

String returns the string representation

type ExportJournalToS3Input Uses

type ExportJournalToS3Input struct {

    // The exclusive end date and time for the range of journal contents that you
    // want to export.
    //
    // The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal
    // Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z
    //
    // The ExclusiveEndTime must be less than or equal to the current UTC date and
    // time.
    //
    // ExclusiveEndTime is a required field
    ExclusiveEndTime *time.Time `type:"timestamp" required:"true"`

    // The inclusive start date and time for the range of journal contents that
    // you want to export.
    //
    // The InclusiveStartTime must be in ISO 8601 date and time format and in Universal
    // Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z
    //
    // The InclusiveStartTime must be before ExclusiveEndTime.
    //
    // If you provide an InclusiveStartTime that is before the ledger's CreationDateTime,
    // Amazon QLDB defaults it to the ledger's CreationDateTime.
    //
    // InclusiveStartTime is a required field
    InclusiveStartTime *time.Time `type:"timestamp" required:"true"`

    // The name of the ledger.
    //
    // Name is a required field
    Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"`

    // The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions
    // for a journal export job to do the following:
    //
    //    * Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.
    //
    //    * (Optional) Use your customer master key (CMK) in AWS Key Management
    //    Service (AWS KMS) for server-side encryption of your exported data.
    //
    // RoleArn is a required field
    RoleArn *string `min:"20" type:"string" required:"true"`

    // The configuration settings of the Amazon S3 bucket destination for your export
    // request.
    //
    // S3ExportConfiguration is a required field
    S3ExportConfiguration *S3ExportConfiguration `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (ExportJournalToS3Input) GoString Uses

func (s ExportJournalToS3Input) GoString() string

GoString returns the string representation

func (*ExportJournalToS3Input) SetExclusiveEndTime Uses

func (s *ExportJournalToS3Input) SetExclusiveEndTime(v time.Time) *ExportJournalToS3Input

SetExclusiveEndTime sets the ExclusiveEndTime field's value.

func (*ExportJournalToS3Input) SetInclusiveStartTime Uses

func (s *ExportJournalToS3Input) SetInclusiveStartTime(v time.Time) *ExportJournalToS3Input

SetInclusiveStartTime sets the InclusiveStartTime field's value.

func (*ExportJournalToS3Input) SetName Uses

func (s *ExportJournalToS3Input) SetName(v string) *ExportJournalToS3Input

SetName sets the Name field's value.

func (*ExportJournalToS3Input) SetRoleArn Uses

func (s *ExportJournalToS3Input) SetRoleArn(v string) *ExportJournalToS3Input

SetRoleArn sets the RoleArn field's value.

func (*ExportJournalToS3Input) SetS3ExportConfiguration Uses

func (s *ExportJournalToS3Input) SetS3ExportConfiguration(v *S3ExportConfiguration) *ExportJournalToS3Input

SetS3ExportConfiguration sets the S3ExportConfiguration field's value.

func (ExportJournalToS3Input) String Uses

func (s ExportJournalToS3Input) String() string

String returns the string representation

func (*ExportJournalToS3Input) Validate Uses

func (s *ExportJournalToS3Input) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExportJournalToS3Output Uses

type ExportJournalToS3Output struct {

    // The unique ID that QLDB assigns to each journal export job.
    //
    // To describe your export request and check the status of the job, you can
    // use ExportId to call DescribeJournalS3Export.
    //
    // ExportId is a required field
    ExportId *string `min:"22" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ExportJournalToS3Output) GoString Uses

func (s ExportJournalToS3Output) GoString() string

GoString returns the string representation

func (*ExportJournalToS3Output) SetExportId Uses

func (s *ExportJournalToS3Output) SetExportId(v string) *ExportJournalToS3Output

SetExportId sets the ExportId field's value.

func (ExportJournalToS3Output) String Uses

func (s ExportJournalToS3Output) String() string

String returns the string representation

type GetBlockInput Uses

type GetBlockInput struct {

    // The location of the block that you want to request. An address is an Amazon
    // Ion structure that has two fields: strandId and sequenceNo.
    //
    // For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}
    //
    // BlockAddress is a required field
    BlockAddress *ValueHolder `type:"structure" required:"true" sensitive:"true"`

    // The latest block location covered by the digest for which to request a proof.
    // An address is an Amazon Ion structure that has two fields: strandId and sequenceNo.
    //
    // For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}
    DigestTipAddress *ValueHolder `type:"structure" sensitive:"true"`

    // The name of the ledger.
    //
    // Name is a required field
    Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (GetBlockInput) GoString Uses

func (s GetBlockInput) GoString() string

GoString returns the string representation

func (*GetBlockInput) SetBlockAddress Uses

func (s *GetBlockInput) SetBlockAddress(v *ValueHolder) *GetBlockInput

SetBlockAddress sets the BlockAddress field's value.

func (*GetBlockInput) SetDigestTipAddress Uses

func (s *GetBlockInput) SetDigestTipAddress(v *ValueHolder) *GetBlockInput

SetDigestTipAddress sets the DigestTipAddress field's value.

func (*GetBlockInput) SetName Uses

func (s *GetBlockInput) SetName(v string) *GetBlockInput

SetName sets the Name field's value.

func (GetBlockInput) String Uses

func (s GetBlockInput) String() string

String returns the string representation

func (*GetBlockInput) Validate Uses

func (s *GetBlockInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBlockOutput Uses

type GetBlockOutput struct {

    // The block data object in Amazon Ion format.
    //
    // Block is a required field
    Block *ValueHolder `type:"structure" required:"true" sensitive:"true"`

    // The proof object in Amazon Ion format returned by a GetBlock request. A proof
    // contains the list of hash values required to recalculate the specified digest
    // using a Merkle tree, starting with the specified block.
    Proof *ValueHolder `type:"structure" sensitive:"true"`
    // contains filtered or unexported fields
}

func (GetBlockOutput) GoString Uses

func (s GetBlockOutput) GoString() string

GoString returns the string representation

func (*GetBlockOutput) SetBlock Uses

func (s *GetBlockOutput) SetBlock(v *ValueHolder) *GetBlockOutput

SetBlock sets the Block field's value.

func (*GetBlockOutput) SetProof Uses

func (s *GetBlockOutput) SetProof(v *ValueHolder) *GetBlockOutput

SetProof sets the Proof field's value.

func (GetBlockOutput) String Uses

func (s GetBlockOutput) String() string

String returns the string representation

type GetDigestInput Uses

type GetDigestInput struct {

    // The name of the ledger.
    //
    // Name is a required field
    Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (GetDigestInput) GoString Uses

func (s GetDigestInput) GoString() string

GoString returns the string representation

func (*GetDigestInput) SetName Uses

func (s *GetDigestInput) SetName(v string) *GetDigestInput

SetName sets the Name field's value.

func (GetDigestInput) String Uses

func (s GetDigestInput) String() string

String returns the string representation

func (*GetDigestInput) Validate Uses

func (s *GetDigestInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDigestOutput Uses

type GetDigestOutput struct {

    // The 256-bit hash value representing the digest returned by a GetDigest request.
    //
    // Digest is automatically base64 encoded/decoded by the SDK.
    //
    // Digest is a required field
    Digest []byte `min:"32" type:"blob" required:"true"`

    // The latest block location covered by the digest that you requested. An address
    // is an Amazon Ion structure that has two fields: strandId and sequenceNo.
    //
    // DigestTipAddress is a required field
    DigestTipAddress *ValueHolder `type:"structure" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

func (GetDigestOutput) GoString Uses

func (s GetDigestOutput) GoString() string

GoString returns the string representation

func (*GetDigestOutput) SetDigest Uses

func (s *GetDigestOutput) SetDigest(v []byte) *GetDigestOutput

SetDigest sets the Digest field's value.

func (*GetDigestOutput) SetDigestTipAddress Uses

func (s *GetDigestOutput) SetDigestTipAddress(v *ValueHolder) *GetDigestOutput

SetDigestTipAddress sets the DigestTipAddress field's value.

func (GetDigestOutput) String Uses

func (s GetDigestOutput) String() string

String returns the string representation

type GetRevisionInput Uses

type GetRevisionInput struct {

    // The block location of the document revision to be verified. An address is
    // an Amazon Ion structure that has two fields: strandId and sequenceNo.
    //
    // For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}
    //
    // BlockAddress is a required field
    BlockAddress *ValueHolder `type:"structure" required:"true" sensitive:"true"`

    // The latest block location covered by the digest for which to request a proof.
    // An address is an Amazon Ion structure that has two fields: strandId and sequenceNo.
    //
    // For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}
    DigestTipAddress *ValueHolder `type:"structure" sensitive:"true"`

    // The unique ID of the document to be verified.
    //
    // DocumentId is a required field
    DocumentId *string `min:"22" type:"string" required:"true"`

    // The name of the ledger.
    //
    // Name is a required field
    Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (GetRevisionInput) GoString Uses

func (s GetRevisionInput) GoString() string

GoString returns the string representation

func (*GetRevisionInput) SetBlockAddress Uses

func (s *GetRevisionInput) SetBlockAddress(v *ValueHolder) *GetRevisionInput

SetBlockAddress sets the BlockAddress field's value.

func (*GetRevisionInput) SetDigestTipAddress Uses

func (s *GetRevisionInput) SetDigestTipAddress(v *ValueHolder) *GetRevisionInput

SetDigestTipAddress sets the DigestTipAddress field's value.

func (*GetRevisionInput) SetDocumentId Uses

func (s *GetRevisionInput) SetDocumentId(v string) *GetRevisionInput

SetDocumentId sets the DocumentId field's value.

func (*GetRevisionInput) SetName Uses

func (s *GetRevisionInput) SetName(v string) *GetRevisionInput

SetName sets the Name field's value.

func (GetRevisionInput) String Uses

func (s GetRevisionInput) String() string

String returns the string representation

func (*GetRevisionInput) Validate Uses

func (s *GetRevisionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetRevisionOutput Uses

type GetRevisionOutput struct {

    // The proof object in Amazon Ion format returned by a GetRevision request.
    // A proof contains the list of hash values that are required to recalculate
    // the specified digest using a Merkle tree, starting with the specified document
    // revision.
    Proof *ValueHolder `type:"structure" sensitive:"true"`

    // The document revision data object in Amazon Ion format.
    //
    // Revision is a required field
    Revision *ValueHolder `type:"structure" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

func (GetRevisionOutput) GoString Uses

func (s GetRevisionOutput) GoString() string

GoString returns the string representation

func (*GetRevisionOutput) SetProof Uses

func (s *GetRevisionOutput) SetProof(v *ValueHolder) *GetRevisionOutput

SetProof sets the Proof field's value.

func (*GetRevisionOutput) SetRevision Uses

func (s *GetRevisionOutput) SetRevision(v *ValueHolder) *GetRevisionOutput

SetRevision sets the Revision field's value.

func (GetRevisionOutput) String Uses

func (s GetRevisionOutput) String() string

String returns the string representation

type JournalS3ExportDescription Uses

type JournalS3ExportDescription struct {

    // The exclusive end date and time for the range of journal contents that are
    // specified in the original export request.
    //
    // ExclusiveEndTime is a required field
    ExclusiveEndTime *time.Time `type:"timestamp" required:"true"`

    // The date and time, in epoch time format, when the export job was created.
    // (Epoch time format is the number of seconds elapsed since 12:00:00 AM January
    // 1, 1970 UTC.)
    //
    // ExportCreationTime is a required field
    ExportCreationTime *time.Time `type:"timestamp" required:"true"`

    // The unique ID of the journal export job.
    //
    // ExportId is a required field
    ExportId *string `min:"22" type:"string" required:"true"`

    // The inclusive start date and time for the range of journal contents that
    // are specified in the original export request.
    //
    // InclusiveStartTime is a required field
    InclusiveStartTime *time.Time `type:"timestamp" required:"true"`

    // The name of the ledger.
    //
    // LedgerName is a required field
    LedgerName *string `min:"1" type:"string" required:"true"`

    // The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions
    // for a journal export job to do the following:
    //
    //    * Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.
    //
    //    * (Optional) Use your customer master key (CMK) in AWS Key Management
    //    Service (AWS KMS) for server-side encryption of your exported data.
    //
    // RoleArn is a required field
    RoleArn *string `min:"20" type:"string" required:"true"`

    // The Amazon Simple Storage Service (Amazon S3) bucket location in which a
    // journal export job writes the journal contents.
    //
    // S3ExportConfiguration is a required field
    S3ExportConfiguration *S3ExportConfiguration `type:"structure" required:"true"`

    // The current state of the journal export job.
    //
    // Status is a required field
    Status *string `type:"string" required:"true" enum:"ExportStatus"`
    // contains filtered or unexported fields
}

The 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.

func (JournalS3ExportDescription) GoString Uses

func (s JournalS3ExportDescription) GoString() string

GoString returns the string representation

func (*JournalS3ExportDescription) SetExclusiveEndTime Uses

func (s *JournalS3ExportDescription) SetExclusiveEndTime(v time.Time) *JournalS3ExportDescription

SetExclusiveEndTime sets the ExclusiveEndTime field's value.

func (*JournalS3ExportDescription) SetExportCreationTime Uses

func (s *JournalS3ExportDescription) SetExportCreationTime(v time.Time) *JournalS3ExportDescription

SetExportCreationTime sets the ExportCreationTime field's value.

func (*JournalS3ExportDescription) SetExportId Uses

func (s *JournalS3ExportDescription) SetExportId(v string) *JournalS3ExportDescription

SetExportId sets the ExportId field's value.

func (*JournalS3ExportDescription) SetInclusiveStartTime Uses

func (s *JournalS3ExportDescription) SetInclusiveStartTime(v time.Time) *JournalS3ExportDescription

SetInclusiveStartTime sets the InclusiveStartTime field's value.

func (*JournalS3ExportDescription) SetLedgerName Uses

func (s *JournalS3ExportDescription) SetLedgerName(v string) *JournalS3ExportDescription

SetLedgerName sets the LedgerName field's value.

func (*JournalS3ExportDescription) SetRoleArn Uses

func (s *JournalS3ExportDescription) SetRoleArn(v string) *JournalS3ExportDescription

SetRoleArn sets the RoleArn field's value.

func (*JournalS3ExportDescription) SetS3ExportConfiguration Uses

func (s *JournalS3ExportDescription) SetS3ExportConfiguration(v *S3ExportConfiguration) *JournalS3ExportDescription

SetS3ExportConfiguration sets the S3ExportConfiguration field's value.

func (*JournalS3ExportDescription) SetStatus Uses

func (s *JournalS3ExportDescription) SetStatus(v string) *JournalS3ExportDescription

SetStatus sets the Status field's value.

func (JournalS3ExportDescription) String Uses

func (s JournalS3ExportDescription) String() string

String returns the string representation

type LedgerSummary Uses

type LedgerSummary struct {

    // The date and time, in epoch time format, when the ledger was created. (Epoch
    // time format is the number of seconds elapsed since 12:00:00 AM January 1,
    // 1970 UTC.)
    CreationDateTime *time.Time `type:"timestamp"`

    // The name of the ledger.
    Name *string `min:"1" type:"string"`

    // The current status of the ledger.
    State *string `type:"string" enum:"LedgerState"`
    // contains filtered or unexported fields
}

Information about a ledger, including its name, state, and when it was created.

func (LedgerSummary) GoString Uses

func (s LedgerSummary) GoString() string

GoString returns the string representation

func (*LedgerSummary) SetCreationDateTime Uses

func (s *LedgerSummary) SetCreationDateTime(v time.Time) *LedgerSummary

SetCreationDateTime sets the CreationDateTime field's value.

func (*LedgerSummary) SetName Uses

func (s *LedgerSummary) SetName(v string) *LedgerSummary

SetName sets the Name field's value.

func (*LedgerSummary) SetState Uses

func (s *LedgerSummary) SetState(v string) *LedgerSummary

SetState sets the State field's value.

func (LedgerSummary) String Uses

func (s LedgerSummary) String() string

String returns the string representation

type ListJournalS3ExportsForLedgerInput Uses

type ListJournalS3ExportsForLedgerInput struct {

    // The maximum number of results to return in a single ListJournalS3ExportsForLedger
    // request. (The actual number of results returned might be fewer.)
    MaxResults *int64 `location:"querystring" locationName:"max_results" min:"1" type:"integer"`

    // The name of the ledger.
    //
    // Name is a required field
    Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"`

    // A pagination token, indicating that you want to retrieve the next page of
    // results. If you received a value for NextToken in the response from a previous
    // ListJournalS3ExportsForLedger call, then you should use that value as input
    // here.
    NextToken *string `location:"querystring" locationName:"next_token" min:"4" type:"string"`
    // contains filtered or unexported fields
}

func (ListJournalS3ExportsForLedgerInput) GoString Uses

func (s ListJournalS3ExportsForLedgerInput) GoString() string

GoString returns the string representation

func (*ListJournalS3ExportsForLedgerInput) SetMaxResults Uses

func (s *ListJournalS3ExportsForLedgerInput) SetMaxResults(v int64) *ListJournalS3ExportsForLedgerInput

SetMaxResults sets the MaxResults field's value.

func (*ListJournalS3ExportsForLedgerInput) SetName Uses

func (s *ListJournalS3ExportsForLedgerInput) SetName(v string) *ListJournalS3ExportsForLedgerInput

SetName sets the Name field's value.

func (*ListJournalS3ExportsForLedgerInput) SetNextToken Uses

func (s *ListJournalS3ExportsForLedgerInput) SetNextToken(v string) *ListJournalS3ExportsForLedgerInput

SetNextToken sets the NextToken field's value.

func (ListJournalS3ExportsForLedgerInput) String Uses

func (s ListJournalS3ExportsForLedgerInput) String() string

String returns the string representation

func (*ListJournalS3ExportsForLedgerInput) Validate Uses

func (s *ListJournalS3ExportsForLedgerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListJournalS3ExportsForLedgerOutput Uses

type ListJournalS3ExportsForLedgerOutput struct {

    // The array of journal export job descriptions that are associated with the
    // specified ledger.
    JournalS3Exports []*JournalS3ExportDescription `type:"list"`

    //    * If NextToken is empty, then the last page of results has been processed
    //    and there are no more results to be retrieved.
    //
    //    * If NextToken is not empty, then there are more results available. To
    //    retrieve the next page of results, use the value of NextToken in a subsequent
    //    ListJournalS3ExportsForLedger call.
    NextToken *string `min:"4" type:"string"`
    // contains filtered or unexported fields
}

func (ListJournalS3ExportsForLedgerOutput) GoString Uses

func (s ListJournalS3ExportsForLedgerOutput) GoString() string

GoString returns the string representation

func (*ListJournalS3ExportsForLedgerOutput) SetJournalS3Exports Uses

func (s *ListJournalS3ExportsForLedgerOutput) SetJournalS3Exports(v []*JournalS3ExportDescription) *ListJournalS3ExportsForLedgerOutput

SetJournalS3Exports sets the JournalS3Exports field's value.

func (*ListJournalS3ExportsForLedgerOutput) SetNextToken Uses

func (s *ListJournalS3ExportsForLedgerOutput) SetNextToken(v string) *ListJournalS3ExportsForLedgerOutput

SetNextToken sets the NextToken field's value.

func (ListJournalS3ExportsForLedgerOutput) String Uses

func (s ListJournalS3ExportsForLedgerOutput) String() string

String returns the string representation

type ListJournalS3ExportsInput Uses

type ListJournalS3ExportsInput struct {

    // The maximum number of results to return in a single ListJournalS3Exports
    // request. (The actual number of results returned might be fewer.)
    MaxResults *int64 `location:"querystring" locationName:"max_results" min:"1" type:"integer"`

    // A pagination token, indicating that you want to retrieve the next page of
    // results. If you received a value for NextToken in the response from a previous
    // ListJournalS3Exports call, then you should use that value as input here.
    NextToken *string `location:"querystring" locationName:"next_token" min:"4" type:"string"`
    // contains filtered or unexported fields
}

func (ListJournalS3ExportsInput) GoString Uses

func (s ListJournalS3ExportsInput) GoString() string

GoString returns the string representation

func (*ListJournalS3ExportsInput) SetMaxResults Uses

func (s *ListJournalS3ExportsInput) SetMaxResults(v int64) *ListJournalS3ExportsInput

SetMaxResults sets the MaxResults field's value.

func (*ListJournalS3ExportsInput) SetNextToken Uses

func (s *ListJournalS3ExportsInput) SetNextToken(v string) *ListJournalS3ExportsInput

SetNextToken sets the NextToken field's value.

func (ListJournalS3ExportsInput) String Uses

func (s ListJournalS3ExportsInput) String() string

String returns the string representation

func (*ListJournalS3ExportsInput) Validate Uses

func (s *ListJournalS3ExportsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListJournalS3ExportsOutput Uses

type ListJournalS3ExportsOutput struct {

    // The array of journal export job descriptions for all ledgers that are associated
    // with the current AWS account and Region.
    JournalS3Exports []*JournalS3ExportDescription `type:"list"`

    //    * If NextToken is empty, then the last page of results has been processed
    //    and there are no more results to be retrieved.
    //
    //    * If NextToken is not empty, then there are more results available. To
    //    retrieve the next page of results, use the value of NextToken in a subsequent
    //    ListJournalS3Exports call.
    NextToken *string `min:"4" type:"string"`
    // contains filtered or unexported fields
}

func (ListJournalS3ExportsOutput) GoString Uses

func (s ListJournalS3ExportsOutput) GoString() string

GoString returns the string representation

func (*ListJournalS3ExportsOutput) SetJournalS3Exports Uses

func (s *ListJournalS3ExportsOutput) SetJournalS3Exports(v []*JournalS3ExportDescription) *ListJournalS3ExportsOutput

SetJournalS3Exports sets the JournalS3Exports field's value.

func (*ListJournalS3ExportsOutput) SetNextToken Uses

func (s *ListJournalS3ExportsOutput) SetNextToken(v string) *ListJournalS3ExportsOutput

SetNextToken sets the NextToken field's value.

func (ListJournalS3ExportsOutput) String Uses

func (s ListJournalS3ExportsOutput) String() string

String returns the string representation

type ListLedgersInput Uses

type ListLedgersInput struct {

    // The maximum number of results to return in a single ListLedgers request.
    // (The actual number of results returned might be fewer.)
    MaxResults *int64 `location:"querystring" locationName:"max_results" min:"1" type:"integer"`

    // A pagination token, indicating that you want to retrieve the next page of
    // results. If you received a value for NextToken in the response from a previous
    // ListLedgers call, then you should use that value as input here.
    NextToken *string `location:"querystring" locationName:"next_token" min:"4" type:"string"`
    // contains filtered or unexported fields
}

func (ListLedgersInput) GoString Uses

func (s ListLedgersInput) GoString() string

GoString returns the string representation

func (*ListLedgersInput) SetMaxResults Uses

func (s *ListLedgersInput) SetMaxResults(v int64) *ListLedgersInput

SetMaxResults sets the MaxResults field's value.

func (*ListLedgersInput) SetNextToken Uses

func (s *ListLedgersInput) SetNextToken(v string) *ListLedgersInput

SetNextToken sets the NextToken field's value.

func (ListLedgersInput) String Uses

func (s ListLedgersInput) String() string

String returns the string representation

func (*ListLedgersInput) Validate Uses

func (s *ListLedgersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListLedgersOutput Uses

type ListLedgersOutput struct {

    // The array of ledger summaries that are associated with the current AWS account
    // and Region.
    Ledgers []*LedgerSummary `type:"list"`

    // A pagination token, indicating whether there are more results available:
    //
    //    * If NextToken is empty, then the last page of results has been processed
    //    and there are no more results to be retrieved.
    //
    //    * If NextToken is not empty, then there are more results available. To
    //    retrieve the next page of results, use the value of NextToken in a subsequent
    //    ListLedgers call.
    NextToken *string `min:"4" type:"string"`
    // contains filtered or unexported fields
}

func (ListLedgersOutput) GoString Uses

func (s ListLedgersOutput) GoString() string

GoString returns the string representation

func (*ListLedgersOutput) SetLedgers Uses

func (s *ListLedgersOutput) SetLedgers(v []*LedgerSummary) *ListLedgersOutput

SetLedgers sets the Ledgers field's value.

func (*ListLedgersOutput) SetNextToken Uses

func (s *ListLedgersOutput) SetNextToken(v string) *ListLedgersOutput

SetNextToken sets the NextToken field's value.

func (ListLedgersOutput) String Uses

func (s ListLedgersOutput) String() string

String returns the string representation

type ListTagsForResourceInput Uses

type ListTagsForResourceInput struct {

    // The Amazon Resource Name (ARN) for which you want to list the tags. For example:
    //
    // arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger
    //
    // ResourceArn is a required field
    ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString Uses

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetResourceArn Uses

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String Uses

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate Uses

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput Uses

type ListTagsForResourceOutput struct {

    // The tags that are currently associated with the specified Amazon QLDB resource.
    Tags map[string]*string `type:"map"`
    // contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString Uses

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetTags Uses

func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String Uses

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type QLDB Uses

type QLDB struct {
    *client.Client
}

QLDB provides the API operation methods for making requests to Amazon QLDB. See this package's package overview docs for details on the service.

QLDB methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New Uses

func New(p client.ConfigProvider, cfgs ...*aws.Config) *QLDB

New creates a new instance of the QLDB client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a QLDB client from just a session.
svc := qldb.New(mySession)

// Create a QLDB client with additional configuration
svc := qldb.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*QLDB) CreateLedger Uses

func (c *QLDB) CreateLedger(input *CreateLedgerInput) (*CreateLedgerOutput, error)

CreateLedger API operation for Amazon QLDB.

Creates a new ledger in your AWS account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QLDB's API operation CreateLedger for usage and error information.

Returned Error Codes:

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more parameters in the request aren't valid.

* ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException"
The specified resource already exists.

* ErrCodeLimitExceededException "LimitExceededException"
You have reached the limit on the maximum number of resources allowed.

* ErrCodeResourceInUseException "ResourceInUseException"
The specified resource can't be modified at this time.

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/CreateLedger

func (*QLDB) CreateLedgerRequest Uses

func (c *QLDB) CreateLedgerRequest(input *CreateLedgerInput) (req *request.Request, output *CreateLedgerOutput)

CreateLedgerRequest generates a "aws/request.Request" representing the client's request for the CreateLedger operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateLedger for more information on using the CreateLedger API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateLedgerRequest method.
req, resp := client.CreateLedgerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/CreateLedger

func (*QLDB) CreateLedgerWithContext Uses

func (c *QLDB) CreateLedgerWithContext(ctx aws.Context, input *CreateLedgerInput, opts ...request.Option) (*CreateLedgerOutput, error)

CreateLedgerWithContext is the same as CreateLedger with the addition of the ability to pass a context and additional request options.

See CreateLedger for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QLDB) DeleteLedger Uses

func (c *QLDB) DeleteLedger(input *DeleteLedgerInput) (*DeleteLedgerOutput, error)

DeleteLedger API operation for Amazon QLDB.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QLDB's API operation DeleteLedger for usage and error information.

Returned Error Codes:

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more parameters in the request aren't valid.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
The specified resource doesn't exist.

* ErrCodeResourceInUseException "ResourceInUseException"
The specified resource can't be modified at this time.

* ErrCodeResourcePreconditionNotMetException "ResourcePreconditionNotMetException"
The operation failed because a condition wasn't satisfied in advance.

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DeleteLedger

func (*QLDB) DeleteLedgerRequest Uses

func (c *QLDB) DeleteLedgerRequest(input *DeleteLedgerInput) (req *request.Request, output *DeleteLedgerOutput)

DeleteLedgerRequest generates a "aws/request.Request" representing the client's request for the DeleteLedger operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteLedger for more information on using the DeleteLedger API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteLedgerRequest method.
req, resp := client.DeleteLedgerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DeleteLedger

func (*QLDB) DeleteLedgerWithContext Uses

func (c *QLDB) DeleteLedgerWithContext(ctx aws.Context, input *DeleteLedgerInput, opts ...request.Option) (*DeleteLedgerOutput, error)

DeleteLedgerWithContext is the same as DeleteLedger with the addition of the ability to pass a context and additional request options.

See DeleteLedger for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QLDB) DescribeJournalS3Export Uses

func (c *QLDB) DescribeJournalS3Export(input *DescribeJournalS3ExportInput) (*DescribeJournalS3ExportOutput, error)

DescribeJournalS3Export API operation for Amazon QLDB.

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.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QLDB's API operation DescribeJournalS3Export for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
The specified resource doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DescribeJournalS3Export

func (*QLDB) DescribeJournalS3ExportRequest Uses

func (c *QLDB) DescribeJournalS3ExportRequest(input *DescribeJournalS3ExportInput) (req *request.Request, output *DescribeJournalS3ExportOutput)

DescribeJournalS3ExportRequest generates a "aws/request.Request" representing the client's request for the DescribeJournalS3Export operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeJournalS3Export for more information on using the DescribeJournalS3Export API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeJournalS3ExportRequest method.
req, resp := client.DescribeJournalS3ExportRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DescribeJournalS3Export

func (*QLDB) DescribeJournalS3ExportWithContext Uses

func (c *QLDB) DescribeJournalS3ExportWithContext(ctx aws.Context, input *DescribeJournalS3ExportInput, opts ...request.Option) (*DescribeJournalS3ExportOutput, error)

DescribeJournalS3ExportWithContext is the same as DescribeJournalS3Export with the addition of the ability to pass a context and additional request options.

See DescribeJournalS3Export for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QLDB) DescribeLedger Uses

func (c *QLDB) DescribeLedger(input *DescribeLedgerInput) (*DescribeLedgerOutput, error)

DescribeLedger API operation for Amazon QLDB.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QLDB's API operation DescribeLedger for usage and error information.

Returned Error Codes:

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more parameters in the request aren't valid.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
The specified resource doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DescribeLedger

func (*QLDB) DescribeLedgerRequest Uses

func (c *QLDB) DescribeLedgerRequest(input *DescribeLedgerInput) (req *request.Request, output *DescribeLedgerOutput)

DescribeLedgerRequest generates a "aws/request.Request" representing the client's request for the DescribeLedger operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeLedger for more information on using the DescribeLedger API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeLedgerRequest method.
req, resp := client.DescribeLedgerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DescribeLedger

func (*QLDB) DescribeLedgerWithContext Uses

func (c *QLDB) DescribeLedgerWithContext(ctx aws.Context, input *DescribeLedgerInput, opts ...request.Option) (*DescribeLedgerOutput, error)

DescribeLedgerWithContext is the same as DescribeLedger with the addition of the ability to pass a context and additional request options.

See DescribeLedger for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QLDB) ExportJournalToS3 Uses

func (c *QLDB) ExportJournalToS3(input *ExportJournalToS3Input) (*ExportJournalToS3Output, error)

ExportJournalToS3 API operation for Amazon QLDB.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QLDB's API operation ExportJournalToS3 for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
The specified resource doesn't exist.

* ErrCodeResourcePreconditionNotMetException "ResourcePreconditionNotMetException"
The operation failed because a condition wasn't satisfied in advance.

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ExportJournalToS3

func (*QLDB) ExportJournalToS3Request Uses

func (c *QLDB) ExportJournalToS3Request(input *ExportJournalToS3Input) (req *request.Request, output *ExportJournalToS3Output)

ExportJournalToS3Request generates a "aws/request.Request" representing the client's request for the ExportJournalToS3 operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ExportJournalToS3 for more information on using the ExportJournalToS3 API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ExportJournalToS3Request method.
req, resp := client.ExportJournalToS3Request(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ExportJournalToS3

func (*QLDB) ExportJournalToS3WithContext Uses

func (c *QLDB) ExportJournalToS3WithContext(ctx aws.Context, input *ExportJournalToS3Input, opts ...request.Option) (*ExportJournalToS3Output, error)

ExportJournalToS3WithContext is the same as ExportJournalToS3 with the addition of the ability to pass a context and additional request options.

See ExportJournalToS3 for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QLDB) GetBlock Uses

func (c *QLDB) GetBlock(input *GetBlockInput) (*GetBlockOutput, error)

GetBlock API operation for Amazon QLDB.

Returns a journal block object at a specified address in a ledger. Also returns a proof of the specified block for verification if DigestTipAddress is provided.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QLDB's API operation GetBlock for usage and error information.

Returned Error Codes:

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more parameters in the request aren't valid.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
The specified resource doesn't exist.

* ErrCodeResourcePreconditionNotMetException "ResourcePreconditionNotMetException"
The operation failed because a condition wasn't satisfied in advance.

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/GetBlock

func (*QLDB) GetBlockRequest Uses

func (c *QLDB) GetBlockRequest(input *GetBlockInput) (req *request.Request, output *GetBlockOutput)

GetBlockRequest generates a "aws/request.Request" representing the client's request for the GetBlock operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetBlock for more information on using the GetBlock API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetBlockRequest method.
req, resp := client.GetBlockRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/GetBlock

func (*QLDB) GetBlockWithContext Uses

func (c *QLDB) GetBlockWithContext(ctx aws.Context, input *GetBlockInput, opts ...request.Option) (*GetBlockOutput, error)

GetBlockWithContext is the same as GetBlock with the addition of the ability to pass a context and additional request options.

See GetBlock for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QLDB) GetDigest Uses

func (c *QLDB) GetDigest(input *GetDigestInput) (*GetDigestOutput, error)

GetDigest API operation for Amazon QLDB.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QLDB's API operation GetDigest for usage and error information.

Returned Error Codes:

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more parameters in the request aren't valid.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
The specified resource doesn't exist.

* ErrCodeResourcePreconditionNotMetException "ResourcePreconditionNotMetException"
The operation failed because a condition wasn't satisfied in advance.

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/GetDigest

func (*QLDB) GetDigestRequest Uses

func (c *QLDB) GetDigestRequest(input *GetDigestInput) (req *request.Request, output *GetDigestOutput)

GetDigestRequest generates a "aws/request.Request" representing the client's request for the GetDigest operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDigest for more information on using the GetDigest API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDigestRequest method.
req, resp := client.GetDigestRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/GetDigest

func (*QLDB) GetDigestWithContext Uses

func (c *QLDB) GetDigestWithContext(ctx aws.Context, input *GetDigestInput, opts ...request.Option) (*GetDigestOutput, error)

GetDigestWithContext is the same as GetDigest with the addition of the ability to pass a context and additional request options.

See GetDigest for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QLDB) GetRevision Uses

func (c *QLDB) GetRevision(input *GetRevisionInput) (*GetRevisionOutput, error)

GetRevision API operation for Amazon QLDB.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QLDB's API operation GetRevision for usage and error information.

Returned Error Codes:

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more parameters in the request aren't valid.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
The specified resource doesn't exist.

* ErrCodeResourcePreconditionNotMetException "ResourcePreconditionNotMetException"
The operation failed because a condition wasn't satisfied in advance.

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/GetRevision

func (*QLDB) GetRevisionRequest Uses

func (c *QLDB) GetRevisionRequest(input *GetRevisionInput) (req *request.Request, output *GetRevisionOutput)

GetRevisionRequest generates a "aws/request.Request" representing the client's request for the GetRevision operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRevision for more information on using the GetRevision API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRevisionRequest method.
req, resp := client.GetRevisionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/GetRevision

func (*QLDB) GetRevisionWithContext Uses

func (c *QLDB) GetRevisionWithContext(ctx aws.Context, input *GetRevisionInput, opts ...request.Option) (*GetRevisionOutput, error)

GetRevisionWithContext is the same as GetRevision with the addition of the ability to pass a context and additional request options.

See GetRevision for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QLDB) ListJournalS3Exports Uses

func (c *QLDB) ListJournalS3Exports(input *ListJournalS3ExportsInput) (*ListJournalS3ExportsOutput, error)

ListJournalS3Exports API operation for Amazon QLDB.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QLDB's API operation ListJournalS3Exports for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListJournalS3Exports

func (*QLDB) ListJournalS3ExportsForLedger Uses

func (c *QLDB) ListJournalS3ExportsForLedger(input *ListJournalS3ExportsForLedgerInput) (*ListJournalS3ExportsForLedgerOutput, error)

ListJournalS3ExportsForLedger API operation for Amazon QLDB.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QLDB's API operation ListJournalS3ExportsForLedger for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListJournalS3ExportsForLedger

func (*QLDB) ListJournalS3ExportsForLedgerPages Uses

func (c *QLDB) ListJournalS3ExportsForLedgerPages(input *ListJournalS3ExportsForLedgerInput, fn func(*ListJournalS3ExportsForLedgerOutput, bool) bool) error

ListJournalS3ExportsForLedgerPages iterates over the pages of a ListJournalS3ExportsForLedger operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListJournalS3ExportsForLedger method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListJournalS3ExportsForLedger operation.
pageNum := 0
err := client.ListJournalS3ExportsForLedgerPages(params,
    func(page *qldb.ListJournalS3ExportsForLedgerOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*QLDB) ListJournalS3ExportsForLedgerPagesWithContext Uses

func (c *QLDB) ListJournalS3ExportsForLedgerPagesWithContext(ctx aws.Context, input *ListJournalS3ExportsForLedgerInput, fn func(*ListJournalS3ExportsForLedgerOutput, bool) bool, opts ...request.Option) error

ListJournalS3ExportsForLedgerPagesWithContext same as ListJournalS3ExportsForLedgerPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QLDB) ListJournalS3ExportsForLedgerRequest Uses

func (c *QLDB) ListJournalS3ExportsForLedgerRequest(input *ListJournalS3ExportsForLedgerInput) (req *request.Request, output *ListJournalS3ExportsForLedgerOutput)

ListJournalS3ExportsForLedgerRequest generates a "aws/request.Request" representing the client's request for the ListJournalS3ExportsForLedger operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListJournalS3ExportsForLedger for more information on using the ListJournalS3ExportsForLedger API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListJournalS3ExportsForLedgerRequest method.
req, resp := client.ListJournalS3ExportsForLedgerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListJournalS3ExportsForLedger

func (*QLDB) ListJournalS3ExportsForLedgerWithContext Uses

func (c *QLDB) ListJournalS3ExportsForLedgerWithContext(ctx aws.Context, input *ListJournalS3ExportsForLedgerInput, opts ...request.Option) (*ListJournalS3ExportsForLedgerOutput, error)

ListJournalS3ExportsForLedgerWithContext is the same as ListJournalS3ExportsForLedger with the addition of the ability to pass a context and additional request options.

See ListJournalS3ExportsForLedger for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QLDB) ListJournalS3ExportsPages Uses

func (c *QLDB) ListJournalS3ExportsPages(input *ListJournalS3ExportsInput, fn func(*ListJournalS3ExportsOutput, bool) bool) error

ListJournalS3ExportsPages iterates over the pages of a ListJournalS3Exports operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListJournalS3Exports method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListJournalS3Exports operation.
pageNum := 0
err := client.ListJournalS3ExportsPages(params,
    func(page *qldb.ListJournalS3ExportsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*QLDB) ListJournalS3ExportsPagesWithContext Uses

func (c *QLDB) ListJournalS3ExportsPagesWithContext(ctx aws.Context, input *ListJournalS3ExportsInput, fn func(*ListJournalS3ExportsOutput, bool) bool, opts ...request.Option) error

ListJournalS3ExportsPagesWithContext same as ListJournalS3ExportsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QLDB) ListJournalS3ExportsRequest Uses

func (c *QLDB) ListJournalS3ExportsRequest(input *ListJournalS3ExportsInput) (req *request.Request, output *ListJournalS3ExportsOutput)

ListJournalS3ExportsRequest generates a "aws/request.Request" representing the client's request for the ListJournalS3Exports operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListJournalS3Exports for more information on using the ListJournalS3Exports API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListJournalS3ExportsRequest method.
req, resp := client.ListJournalS3ExportsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListJournalS3Exports

func (*QLDB) ListJournalS3ExportsWithContext Uses

func (c *QLDB) ListJournalS3ExportsWithContext(ctx aws.Context, input *ListJournalS3ExportsInput, opts ...request.Option) (*ListJournalS3ExportsOutput, error)

ListJournalS3ExportsWithContext is the same as ListJournalS3Exports with the addition of the ability to pass a context and additional request options.

See ListJournalS3Exports for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QLDB) ListLedgers Uses

func (c *QLDB) ListLedgers(input *ListLedgersInput) (*ListLedgersOutput, error)

ListLedgers API operation for Amazon QLDB.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QLDB's API operation ListLedgers for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListLedgers

func (*QLDB) ListLedgersPages Uses

func (c *QLDB) ListLedgersPages(input *ListLedgersInput, fn func(*ListLedgersOutput, bool) bool) error

ListLedgersPages iterates over the pages of a ListLedgers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListLedgers method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListLedgers operation.
pageNum := 0
err := client.ListLedgersPages(params,
    func(page *qldb.ListLedgersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*QLDB) ListLedgersPagesWithContext Uses

func (c *QLDB) ListLedgersPagesWithContext(ctx aws.Context, input *ListLedgersInput, fn func(*ListLedgersOutput, bool) bool, opts ...request.Option) error

ListLedgersPagesWithContext same as ListLedgersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QLDB) ListLedgersRequest Uses

func (c *QLDB) ListLedgersRequest(input *ListLedgersInput) (req *request.Request, output *ListLedgersOutput)

ListLedgersRequest generates a "aws/request.Request" representing the client's request for the ListLedgers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListLedgers for more information on using the ListLedgers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListLedgersRequest method.
req, resp := client.ListLedgersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListLedgers

func (*QLDB) ListLedgersWithContext Uses

func (c *QLDB) ListLedgersWithContext(ctx aws.Context, input *ListLedgersInput, opts ...request.Option) (*ListLedgersOutput, error)

ListLedgersWithContext is the same as ListLedgers with the addition of the ability to pass a context and additional request options.

See ListLedgers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QLDB) ListTagsForResource Uses

func (c *QLDB) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon QLDB.

Returns all tags for a specified Amazon QLDB resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QLDB's API operation ListTagsForResource for usage and error information.

Returned Error Codes:

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more parameters in the request aren't valid.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
The specified resource doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListTagsForResource

func (*QLDB) ListTagsForResourceRequest Uses

func (c *QLDB) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListTagsForResource

func (*QLDB) ListTagsForResourceWithContext Uses

func (c *QLDB) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QLDB) TagResource Uses

func (c *QLDB) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon QLDB.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QLDB's API operation TagResource for usage and error information.

Returned Error Codes:

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more parameters in the request aren't valid.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
The specified resource doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/TagResource

func (*QLDB) TagResourceRequest Uses

func (c *QLDB) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/TagResource

func (*QLDB) TagResourceWithContext Uses

func (c *QLDB) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QLDB) UntagResource Uses

func (c *QLDB) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon QLDB.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QLDB's API operation UntagResource for usage and error information.

Returned Error Codes:

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more parameters in the request aren't valid.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
The specified resource doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/UntagResource

func (*QLDB) UntagResourceRequest Uses

func (c *QLDB) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/UntagResource

func (*QLDB) UntagResourceWithContext Uses

func (c *QLDB) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QLDB) UpdateLedger Uses

func (c *QLDB) UpdateLedger(input *UpdateLedgerInput) (*UpdateLedgerOutput, error)

UpdateLedger API operation for Amazon QLDB.

Updates properties on a ledger.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QLDB's API operation UpdateLedger for usage and error information.

Returned Error Codes:

* ErrCodeInvalidParameterException "InvalidParameterException"
One or more parameters in the request aren't valid.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
The specified resource doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/UpdateLedger

func (*QLDB) UpdateLedgerRequest Uses

func (c *QLDB) UpdateLedgerRequest(input *UpdateLedgerInput) (req *request.Request, output *UpdateLedgerOutput)

UpdateLedgerRequest generates a "aws/request.Request" representing the client's request for the UpdateLedger operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateLedger for more information on using the UpdateLedger API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateLedgerRequest method.
req, resp := client.UpdateLedgerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/UpdateLedger

func (*QLDB) UpdateLedgerWithContext Uses

func (c *QLDB) UpdateLedgerWithContext(ctx aws.Context, input *UpdateLedgerInput, opts ...request.Option) (*UpdateLedgerOutput, error)

UpdateLedgerWithContext is the same as UpdateLedger with the addition of the ability to pass a context and additional request options.

See UpdateLedger for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type S3EncryptionConfiguration Uses

type S3EncryptionConfiguration struct {

    // The Amazon Resource Name (ARN) for a customer master key (CMK) in AWS Key
    // Management Service (AWS KMS).
    //
    // You must provide a KmsKeyArn if you specify SSE_KMS as the ObjectEncryptionType.
    //
    // KmsKeyArn is not required if you specify SSE_S3 as the ObjectEncryptionType.
    KmsKeyArn *string `min:"20" type:"string"`

    // The Amazon S3 object encryption type.
    //
    // To learn more about server-side encryption options in Amazon S3, see Protecting
    // Data Using Server-Side Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html)
    // in the Amazon S3 Developer Guide.
    //
    // ObjectEncryptionType is a required field
    ObjectEncryptionType *string `type:"string" required:"true" enum:"S3ObjectEncryptionType"`
    // contains filtered or unexported fields
}

The encryption settings that are used by a journal export job to write data in an Amazon Simple Storage Service (Amazon S3) bucket.

func (S3EncryptionConfiguration) GoString Uses

func (s S3EncryptionConfiguration) GoString() string

GoString returns the string representation

func (*S3EncryptionConfiguration) SetKmsKeyArn Uses

func (s *S3EncryptionConfiguration) SetKmsKeyArn(v string) *S3EncryptionConfiguration

SetKmsKeyArn sets the KmsKeyArn field's value.

func (*S3EncryptionConfiguration) SetObjectEncryptionType Uses

func (s *S3EncryptionConfiguration) SetObjectEncryptionType(v string) *S3EncryptionConfiguration

SetObjectEncryptionType sets the ObjectEncryptionType field's value.

func (S3EncryptionConfiguration) String Uses

func (s S3EncryptionConfiguration) String() string

String returns the string representation

func (*S3EncryptionConfiguration) Validate Uses

func (s *S3EncryptionConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type S3ExportConfiguration Uses

type S3ExportConfiguration struct {

    // The Amazon S3 bucket name in which a journal export job writes the journal
    // contents.
    //
    // The bucket name must comply with the Amazon S3 bucket naming conventions.
    // For more information, see Bucket Restrictions and Limitations (https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html)
    // in the Amazon S3 Developer Guide.
    //
    // Bucket is a required field
    Bucket *string `min:"3" type:"string" required:"true"`

    // The encryption settings that are used by a journal export job to write data
    // in an Amazon S3 bucket.
    //
    // EncryptionConfiguration is a required field
    EncryptionConfiguration *S3EncryptionConfiguration `type:"structure" required:"true"`

    // The prefix for the Amazon S3 bucket in which a journal export job writes
    // the journal contents.
    //
    // The prefix must comply with Amazon S3 key naming rules and restrictions.
    // For more information, see Object Key and Metadata (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html)
    // in the Amazon S3 Developer Guide.
    //
    // The following are examples of valid Prefix values:
    //
    //    * JournalExports-ForMyLedger/Testing/
    //
    //    * JournalExports
    //
    //    * My:Tests/
    //
    // Prefix is a required field
    Prefix *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

The Amazon Simple Storage Service (Amazon S3) bucket location in which a journal export job writes the journal contents.

func (S3ExportConfiguration) GoString Uses

func (s S3ExportConfiguration) GoString() string

GoString returns the string representation

func (*S3ExportConfiguration) SetBucket Uses

func (s *S3ExportConfiguration) SetBucket(v string) *S3ExportConfiguration

SetBucket sets the Bucket field's value.

func (*S3ExportConfiguration) SetEncryptionConfiguration Uses

func (s *S3ExportConfiguration) SetEncryptionConfiguration(v *S3EncryptionConfiguration) *S3ExportConfiguration

SetEncryptionConfiguration sets the EncryptionConfiguration field's value.

func (*S3ExportConfiguration) SetPrefix Uses

func (s *S3ExportConfiguration) SetPrefix(v string) *S3ExportConfiguration

SetPrefix sets the Prefix field's value.

func (S3ExportConfiguration) String Uses

func (s S3ExportConfiguration) String() string

String returns the string representation

func (*S3ExportConfiguration) Validate Uses

func (s *S3ExportConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput Uses

type TagResourceInput struct {

    // The Amazon Resource Name (ARN) to which you want to add the tags. For example:
    //
    // arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger
    //
    // ResourceArn is a required field
    ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"`

    // The key-value pairs to add as tags to the specified QLDB resource. Tag keys
    // are case sensitive. If you specify a key that already exists for the resource,
    // your request fails and returns an error. Tag values are case sensitive and
    // can be null.
    //
    // Tags is a required field
    Tags map[string]*string `type:"map" required:"true"`
    // contains filtered or unexported fields
}

func (TagResourceInput) GoString Uses

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetResourceArn Uses

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags Uses

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String Uses

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate Uses

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput Uses

type TagResourceOutput struct {
    // contains filtered or unexported fields
}

func (TagResourceOutput) GoString Uses

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) String Uses

func (s TagResourceOutput) String() string

String returns the string representation

type UntagResourceInput Uses

type UntagResourceInput struct {

    // The Amazon Resource Name (ARN) from which you want to remove the tags. For
    // example:
    //
    // arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger
    //
    // ResourceArn is a required field
    ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"`

    // The list of tag keys that you want to remove.
    //
    // TagKeys is a required field
    TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (UntagResourceInput) GoString Uses

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetResourceArn Uses

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys Uses

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String Uses

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate Uses

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput Uses

type UntagResourceOutput struct {
    // contains filtered or unexported fields
}

func (UntagResourceOutput) GoString Uses

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) String Uses

func (s UntagResourceOutput) String() string

String returns the string representation

type UpdateLedgerInput Uses

type UpdateLedgerInput struct {

    // The flag that prevents a ledger from being deleted by any user. If not provided
    // on ledger creation, this feature is enabled (true) by default.
    //
    // 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.
    DeletionProtection *bool `type:"boolean"`

    // The name of the ledger.
    //
    // Name is a required field
    Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (UpdateLedgerInput) GoString Uses

func (s UpdateLedgerInput) GoString() string

GoString returns the string representation

func (*UpdateLedgerInput) SetDeletionProtection Uses

func (s *UpdateLedgerInput) SetDeletionProtection(v bool) *UpdateLedgerInput

SetDeletionProtection sets the DeletionProtection field's value.

func (*UpdateLedgerInput) SetName Uses

func (s *UpdateLedgerInput) SetName(v string) *UpdateLedgerInput

SetName sets the Name field's value.

func (UpdateLedgerInput) String Uses

func (s UpdateLedgerInput) String() string

String returns the string representation

func (*UpdateLedgerInput) Validate Uses

func (s *UpdateLedgerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateLedgerOutput Uses

type UpdateLedgerOutput struct {

    // The Amazon Resource Name (ARN) for the ledger.
    Arn *string `min:"20" type:"string"`

    // The date and time, in epoch time format, when the ledger was created. (Epoch
    // time format is the number of seconds elapsed since 12:00:00 AM January 1,
    // 1970 UTC.)
    CreationDateTime *time.Time `type:"timestamp"`

    // The flag that prevents a ledger from being deleted by any user. If not provided
    // on ledger creation, this feature is enabled (true) by default.
    //
    // 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.
    DeletionProtection *bool `type:"boolean"`

    // The name of the ledger.
    Name *string `min:"1" type:"string"`

    // The current status of the ledger.
    State *string `type:"string" enum:"LedgerState"`
    // contains filtered or unexported fields
}

func (UpdateLedgerOutput) GoString Uses

func (s UpdateLedgerOutput) GoString() string

GoString returns the string representation

func (*UpdateLedgerOutput) SetArn Uses

func (s *UpdateLedgerOutput) SetArn(v string) *UpdateLedgerOutput

SetArn sets the Arn field's value.

func (*UpdateLedgerOutput) SetCreationDateTime Uses

func (s *UpdateLedgerOutput) SetCreationDateTime(v time.Time) *UpdateLedgerOutput

SetCreationDateTime sets the CreationDateTime field's value.

func (*UpdateLedgerOutput) SetDeletionProtection Uses

func (s *UpdateLedgerOutput) SetDeletionProtection(v bool) *UpdateLedgerOutput

SetDeletionProtection sets the DeletionProtection field's value.

func (*UpdateLedgerOutput) SetName Uses

func (s *UpdateLedgerOutput) SetName(v string) *UpdateLedgerOutput

SetName sets the Name field's value.

func (*UpdateLedgerOutput) SetState Uses

func (s *UpdateLedgerOutput) SetState(v string) *UpdateLedgerOutput

SetState sets the State field's value.

func (UpdateLedgerOutput) String Uses

func (s UpdateLedgerOutput) String() string

String returns the string representation

type ValueHolder Uses

type ValueHolder struct {

    // An Amazon Ion plaintext value contained in a ValueHolder structure.
    IonText *string `min:"1" type:"string" sensitive:"true"`
    // contains filtered or unexported fields
}

A structure that can contain an Amazon Ion value in multiple encoding formats.

func (ValueHolder) GoString Uses

func (s ValueHolder) GoString() string

GoString returns the string representation

func (*ValueHolder) SetIonText Uses

func (s *ValueHolder) SetIonText(v string) *ValueHolder

SetIonText sets the IonText field's value.

func (ValueHolder) String Uses

func (s ValueHolder) String() string

String returns the string representation

func (*ValueHolder) Validate Uses

func (s *ValueHolder) Validate() error

Validate inspects the fields of the type to determine if they are valid.

Directories

PathSynopsis
qldbifacePackage qldbiface provides an interface to enable mocking the Amazon QLDB service client for testing your code.

Package qldb imports 9 packages (graph) and is imported by 9 packages. Updated 2019-10-27. Refresh now. Tools for package owners.