func EncryptionStatus_Values() []string
EncryptionStatus_Values returns all elements of the EncryptionStatus enum
func ErrorCause_Values() []string
ErrorCause_Values returns all elements of the ErrorCause enum
func ExportStatus_Values() []string
ExportStatus_Values returns all elements of the ExportStatus enum
func LedgerState_Values() []string
LedgerState_Values returns all elements of the LedgerState enum
func OutputFormat_Values() []string
OutputFormat_Values returns all elements of the OutputFormat enum
func PermissionsMode_Values() []string
PermissionsMode_Values returns all elements of the PermissionsMode enum
func S3ObjectEncryptionType_Values() []string
S3ObjectEncryptionType_Values returns all elements of the S3ObjectEncryptionType enum
func StreamStatus_Values() []string
StreamStatus_Values returns all elements of the StreamStatus enum
type CancelJournalKinesisStreamInput struct {
// The name of the ledger.
//
// LedgerName is a required field
LedgerName *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"`
// The UUID (represented in Base62-encoded text) of the QLDB journal stream
// to be canceled.
//
// StreamId is a required field
StreamId *string `location:"uri" locationName:"streamId" min:"22" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s CancelJournalKinesisStreamInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CancelJournalKinesisStreamInput) SetLedgerName(v string) *CancelJournalKinesisStreamInput
SetLedgerName sets the LedgerName field's value.
func (s *CancelJournalKinesisStreamInput) SetStreamId(v string) *CancelJournalKinesisStreamInput
SetStreamId sets the StreamId field's value.
func (s CancelJournalKinesisStreamInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CancelJournalKinesisStreamInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CancelJournalKinesisStreamOutput struct {
// The UUID (Base62-encoded text) of the canceled QLDB journal stream.
StreamId *string `min:"22" type:"string"`
// contains filtered or unexported fields
}
func (s CancelJournalKinesisStreamOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CancelJournalKinesisStreamOutput) SetStreamId(v string) *CancelJournalKinesisStreamOutput
SetStreamId sets the StreamId field's value.
func (s CancelJournalKinesisStreamOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateLedgerInput struct {
// Specifies whether the ledger is protected from being deleted by any user.
// If not defined during 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. You can disable it by calling the UpdateLedger operation
// to set this parameter to false.
DeletionProtection *bool `type:"boolean"`
// The key in Key Management Service (KMS) to use for encryption of data at
// rest in the ledger. For more information, see Encryption at rest (https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html)
// in the Amazon QLDB Developer Guide.
//
// Use one of the following options to specify this parameter:
//
// * AWS_OWNED_KMS_KEY: Use an KMS key that is owned and managed by Amazon
// Web Services on your behalf.
//
// * Undefined: By default, use an Amazon Web Services owned KMS key.
//
// * A valid symmetric customer managed KMS key: Use the specified symmetric
// encryption KMS key in your account that you create, own, and manage. Amazon
// QLDB does not support asymmetric keys. For more information, see Using
// symmetric and asymmetric keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html)
// in the Key Management Service Developer Guide.
//
// To specify a customer managed KMS key, you can use its key ID, Amazon Resource
// Name (ARN), alias name, or alias ARN. When using an alias name, prefix it
// with "alias/". To specify a key in a different Amazon Web Services account,
// you must use the key ARN or alias ARN.
//
// For example:
//
// * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
//
// * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
//
// * Alias name: alias/ExampleAlias
//
// * Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
//
// For more information, see Key identifiers (KeyId) (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id)
// in the Key Management Service Developer Guide.
KmsKey *string `type:"string"`
// The name of the ledger that you want to create. The name must be unique among
// all of the ledgers in your Amazon Web Services account in the current Region.
//
// Naming constraints for ledger names are defined in Quotas in Amazon QLDB
// (https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming)
// in the Amazon QLDB Developer Guide.
//
// 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. This
// parameter can have one of the following values:
//
// * ALLOW_ALL: A legacy permissions mode that enables access control with
// API-level granularity for ledgers. This mode allows users who have the
// SendCommand API permission for this ledger to run all PartiQL commands
// (hence, ALLOW_ALL) on any tables in the specified ledger. This mode disregards
// any table-level or command-level IAM permissions policies that you create
// for the ledger.
//
// * STANDARD: (Recommended) A permissions mode that enables access control
// with finer granularity for ledgers, tables, and PartiQL commands. By default,
// this mode denies all user requests to run any PartiQL commands on any
// tables in this ledger. To allow PartiQL commands to run, you must create
// IAM permissions policies for specific table resources and PartiQL actions,
// in addition to the SendCommand API permission for the ledger. For information,
// see Getting started with the standard permissions mode (https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html)
// in the Amazon QLDB Developer Guide.
//
// We strongly recommend using the STANDARD permissions mode to maximize the
// security of your ledger data.
//
// 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 (s CreateLedgerInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateLedgerInput) SetDeletionProtection(v bool) *CreateLedgerInput
SetDeletionProtection sets the DeletionProtection field's value.
func (s *CreateLedgerInput) SetKmsKey(v string) *CreateLedgerInput
SetKmsKey sets the KmsKey field's value.
func (s *CreateLedgerInput) SetName(v string) *CreateLedgerInput
SetName sets the Name field's value.
func (s *CreateLedgerInput) SetPermissionsMode(v string) *CreateLedgerInput
SetPermissionsMode sets the PermissionsMode field's value.
func (s *CreateLedgerInput) SetTags(v map[string]*string) *CreateLedgerInput
SetTags sets the Tags field's value.
func (s CreateLedgerInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateLedgerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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"`
// Specifies whether the ledger is protected from being deleted by any user.
// If not defined during 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. You can disable it by calling the UpdateLedger operation
// to set this parameter to false.
DeletionProtection *bool `type:"boolean"`
// The ARN of the customer managed KMS key that the ledger uses for encryption
// at rest. If this parameter is undefined, the ledger uses an Amazon Web Services
// owned KMS key for encryption.
KmsKeyArn *string `min:"20" type:"string"`
// The name of the ledger.
Name *string `min:"1" type:"string"`
// The permissions mode of the ledger that you created.
PermissionsMode *string `type:"string" enum:"PermissionsMode"`
// The current status of the ledger.
State *string `type:"string" enum:"LedgerState"`
// contains filtered or unexported fields
}
func (s CreateLedgerOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateLedgerOutput) SetArn(v string) *CreateLedgerOutput
SetArn sets the Arn field's value.
func (s *CreateLedgerOutput) SetCreationDateTime(v time.Time) *CreateLedgerOutput
SetCreationDateTime sets the CreationDateTime field's value.
func (s *CreateLedgerOutput) SetDeletionProtection(v bool) *CreateLedgerOutput
SetDeletionProtection sets the DeletionProtection field's value.
func (s *CreateLedgerOutput) SetKmsKeyArn(v string) *CreateLedgerOutput
SetKmsKeyArn sets the KmsKeyArn field's value.
func (s *CreateLedgerOutput) SetName(v string) *CreateLedgerOutput
SetName sets the Name field's value.
func (s *CreateLedgerOutput) SetPermissionsMode(v string) *CreateLedgerOutput
SetPermissionsMode sets the PermissionsMode field's value.
func (s *CreateLedgerOutput) SetState(v string) *CreateLedgerOutput
SetState sets the State field's value.
func (s CreateLedgerOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s DeleteLedgerInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteLedgerInput) SetName(v string) *DeleteLedgerInput
SetName sets the Name field's value.
func (s DeleteLedgerInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteLedgerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteLedgerOutput struct {
// contains filtered or unexported fields
}
func (s DeleteLedgerOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DeleteLedgerOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeJournalKinesisStreamInput struct {
// The name of the ledger.
//
// LedgerName is a required field
LedgerName *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"`
// The UUID (represented in Base62-encoded text) of the QLDB journal stream
// to describe.
//
// StreamId is a required field
StreamId *string `location:"uri" locationName:"streamId" min:"22" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DescribeJournalKinesisStreamInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeJournalKinesisStreamInput) SetLedgerName(v string) *DescribeJournalKinesisStreamInput
SetLedgerName sets the LedgerName field's value.
func (s *DescribeJournalKinesisStreamInput) SetStreamId(v string) *DescribeJournalKinesisStreamInput
SetStreamId sets the StreamId field's value.
func (s DescribeJournalKinesisStreamInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeJournalKinesisStreamInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeJournalKinesisStreamOutput struct {
// Information about the QLDB journal stream returned by a DescribeJournalS3Export
// request.
Stream *JournalKinesisStreamDescription `type:"structure"`
// contains filtered or unexported fields
}
func (s DescribeJournalKinesisStreamOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeJournalKinesisStreamOutput) SetStream(v *JournalKinesisStreamDescription) *DescribeJournalKinesisStreamOutput
SetStream sets the Stream field's value.
func (s DescribeJournalKinesisStreamOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeJournalS3ExportInput struct {
// The UUID (represented in Base62-encoded text) of the journal export job 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 (s DescribeJournalS3ExportInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeJournalS3ExportInput) SetExportId(v string) *DescribeJournalS3ExportInput
SetExportId sets the ExportId field's value.
func (s *DescribeJournalS3ExportInput) SetName(v string) *DescribeJournalS3ExportInput
SetName sets the Name field's value.
func (s DescribeJournalS3ExportInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeJournalS3ExportInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s DescribeJournalS3ExportOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeJournalS3ExportOutput) SetExportDescription(v *JournalS3ExportDescription) *DescribeJournalS3ExportOutput
SetExportDescription sets the ExportDescription field's value.
func (s DescribeJournalS3ExportOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s DescribeLedgerInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeLedgerInput) SetName(v string) *DescribeLedgerInput
SetName sets the Name field's value.
func (s DescribeLedgerInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeLedgerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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"`
// Specifies whether the ledger is protected from being deleted by any user.
// If not defined during 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. You can disable it by calling the UpdateLedger operation
// to set this parameter to false.
DeletionProtection *bool `type:"boolean"`
// Information about the encryption of data at rest in the ledger. This includes
// the current status, the KMS key, and when the key became inaccessible (in
// the case of an error). If this parameter is undefined, the ledger uses an
// Amazon Web Services owned KMS key for encryption.
EncryptionDescription *LedgerEncryptionDescription `type:"structure"`
// The name of the ledger.
Name *string `min:"1" type:"string"`
// The permissions mode of the ledger.
PermissionsMode *string `type:"string" enum:"PermissionsMode"`
// The current status of the ledger.
State *string `type:"string" enum:"LedgerState"`
// contains filtered or unexported fields
}
func (s DescribeLedgerOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeLedgerOutput) SetArn(v string) *DescribeLedgerOutput
SetArn sets the Arn field's value.
func (s *DescribeLedgerOutput) SetCreationDateTime(v time.Time) *DescribeLedgerOutput
SetCreationDateTime sets the CreationDateTime field's value.
func (s *DescribeLedgerOutput) SetDeletionProtection(v bool) *DescribeLedgerOutput
SetDeletionProtection sets the DeletionProtection field's value.
func (s *DescribeLedgerOutput) SetEncryptionDescription(v *LedgerEncryptionDescription) *DescribeLedgerOutput
SetEncryptionDescription sets the EncryptionDescription field's value.
func (s *DescribeLedgerOutput) SetName(v string) *DescribeLedgerOutput
SetName sets the Name field's value.
func (s *DescribeLedgerOutput) SetPermissionsMode(v string) *DescribeLedgerOutput
SetPermissionsMode sets the PermissionsMode field's value.
func (s *DescribeLedgerOutput) SetState(v string) *DescribeLedgerOutput
SetState sets the State field's value.
func (s DescribeLedgerOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ExportJournalToS3Input struct {
// The exclusive end date and time for the range of journal contents 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 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 output format of your exported journal data. A journal export job can
// write the data objects in either the text or binary representation of Amazon
// Ion (https://docs.aws.amazon.com/qldb/latest/developerguide/ion.html) format,
// or in JSON Lines (https://jsonlines.org/) text format.
//
// Default: ION_TEXT
//
// In JSON Lines format, each journal block in an exported data object is a
// valid JSON object that is delimited by a newline. You can use this format
// to directly integrate JSON exports with analytics tools such as Amazon Athena
// and Glue because these services can parse newline-delimited JSON automatically.
OutputFormat *string `type:"string" enum:"OutputFormat"`
// 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 S3 bucket.
//
// * (Optional) Use your customer managed key in Key Management Service (KMS)
// for server-side encryption of your exported data.
//
// To pass a role to QLDB when requesting a journal export, you must have permissions
// to perform the iam:PassRole action on the IAM role resource. This is required
// for all journal export requests.
//
// 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 (s ExportJournalToS3Input) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ExportJournalToS3Input) SetExclusiveEndTime(v time.Time) *ExportJournalToS3Input
SetExclusiveEndTime sets the ExclusiveEndTime field's value.
func (s *ExportJournalToS3Input) SetInclusiveStartTime(v time.Time) *ExportJournalToS3Input
SetInclusiveStartTime sets the InclusiveStartTime field's value.
func (s *ExportJournalToS3Input) SetName(v string) *ExportJournalToS3Input
SetName sets the Name field's value.
func (s *ExportJournalToS3Input) SetOutputFormat(v string) *ExportJournalToS3Input
SetOutputFormat sets the OutputFormat field's value.
func (s *ExportJournalToS3Input) SetRoleArn(v string) *ExportJournalToS3Input
SetRoleArn sets the RoleArn field's value.
func (s *ExportJournalToS3Input) SetS3ExportConfiguration(v *S3ExportConfiguration) *ExportJournalToS3Input
SetS3ExportConfiguration sets the S3ExportConfiguration field's value.
func (s ExportJournalToS3Input) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ExportJournalToS3Input) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ExportJournalToS3Output struct {
// The UUID (represented in Base62-encoded text) 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 (s ExportJournalToS3Output) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ExportJournalToS3Output) SetExportId(v string) *ExportJournalToS3Output
SetExportId sets the ExportId field's value.
func (s ExportJournalToS3Output) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 sensitive parameter and its value will be
// replaced with "sensitive" in string returned by GetBlockInput's
// String and GoString methods.
//
// 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 is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by GetBlockInput's
// String and GoString methods.
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 (s GetBlockInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetBlockInput) SetBlockAddress(v *ValueHolder) *GetBlockInput
SetBlockAddress sets the BlockAddress field's value.
func (s *GetBlockInput) SetDigestTipAddress(v *ValueHolder) *GetBlockInput
SetDigestTipAddress sets the DigestTipAddress field's value.
func (s *GetBlockInput) SetName(v string) *GetBlockInput
SetName sets the Name field's value.
func (s GetBlockInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetBlockInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetBlockOutput struct {
// The block data object in Amazon Ion format.
//
// Block is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by GetBlockOutput's
// String and GoString methods.
//
// 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 is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by GetBlockOutput's
// String and GoString methods.
Proof *ValueHolder `type:"structure" sensitive:"true"`
// contains filtered or unexported fields
}
func (s GetBlockOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetBlockOutput) SetBlock(v *ValueHolder) *GetBlockOutput
SetBlock sets the Block field's value.
func (s *GetBlockOutput) SetProof(v *ValueHolder) *GetBlockOutput
SetProof sets the Proof field's value.
func (s GetBlockOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s GetDigestInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetDigestInput) SetName(v string) *GetDigestInput
SetName sets the Name field's value.
func (s GetDigestInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetDigestInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 sensitive parameter and its value will be
// replaced with "sensitive" in string returned by GetDigestOutput's
// String and GoString methods.
//
// DigestTipAddress is a required field
DigestTipAddress *ValueHolder `type:"structure" required:"true" sensitive:"true"`
// contains filtered or unexported fields
}
func (s GetDigestOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetDigestOutput) SetDigest(v []byte) *GetDigestOutput
SetDigest sets the Digest field's value.
func (s *GetDigestOutput) SetDigestTipAddress(v *ValueHolder) *GetDigestOutput
SetDigestTipAddress sets the DigestTipAddress field's value.
func (s GetDigestOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 sensitive parameter and its value will be
// replaced with "sensitive" in string returned by GetRevisionInput's
// String and GoString methods.
//
// 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 is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by GetRevisionInput's
// String and GoString methods.
DigestTipAddress *ValueHolder `type:"structure" sensitive:"true"`
// The UUID (represented in Base62-encoded text) 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 (s GetRevisionInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetRevisionInput) SetBlockAddress(v *ValueHolder) *GetRevisionInput
SetBlockAddress sets the BlockAddress field's value.
func (s *GetRevisionInput) SetDigestTipAddress(v *ValueHolder) *GetRevisionInput
SetDigestTipAddress sets the DigestTipAddress field's value.
func (s *GetRevisionInput) SetDocumentId(v string) *GetRevisionInput
SetDocumentId sets the DocumentId field's value.
func (s *GetRevisionInput) SetName(v string) *GetRevisionInput
SetName sets the Name field's value.
func (s GetRevisionInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetRevisionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by GetRevisionOutput's
// String and GoString methods.
Proof *ValueHolder `type:"structure" sensitive:"true"`
// The document revision data object in Amazon Ion format.
//
// Revision is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by GetRevisionOutput's
// String and GoString methods.
//
// Revision is a required field
Revision *ValueHolder `type:"structure" required:"true" sensitive:"true"`
// contains filtered or unexported fields
}
func (s GetRevisionOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetRevisionOutput) SetProof(v *ValueHolder) *GetRevisionOutput
SetProof sets the Proof field's value.
func (s *GetRevisionOutput) SetRevision(v *ValueHolder) *GetRevisionOutput
SetRevision sets the Revision field's value.
func (s GetRevisionOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InvalidParameterException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// The name of the invalid parameter.
ParameterName *string `type:"string"`
// contains filtered or unexported fields
}
One or more parameters in the request aren't valid.
func (s *InvalidParameterException) Code() string
Code returns the exception type name.
func (s *InvalidParameterException) Error() string
func (s InvalidParameterException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InvalidParameterException) Message() string
Message returns the exception's message.
func (s *InvalidParameterException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidParameterException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidParameterException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InvalidParameterException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type JournalKinesisStreamDescription struct {
// The Amazon Resource Name (ARN) of the QLDB journal stream.
Arn *string `min:"20" type:"string"`
// The date and time, in epoch time format, when the QLDB journal stream was
// created. (Epoch time format is the number of seconds elapsed since 12:00:00
// AM January 1, 1970 UTC.)
CreationTime *time.Time `type:"timestamp"`
// The error message that describes the reason that a stream has a status of
// IMPAIRED or FAILED. This is not applicable to streams that have other status
// values.
ErrorCause *string `type:"string" enum:"ErrorCause"`
// The exclusive date and time that specifies when the stream ends. If this
// parameter is undefined, the stream runs indefinitely until you cancel it.
ExclusiveEndTime *time.Time `type:"timestamp"`
// The inclusive start date and time from which to start streaming journal data.
InclusiveStartTime *time.Time `type:"timestamp"`
// The configuration settings of the Amazon Kinesis Data Streams destination
// for a QLDB journal stream.
//
// KinesisConfiguration is a required field
KinesisConfiguration *KinesisConfiguration `type:"structure" 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 stream to write data records to a Kinesis Data Streams resource.
//
// RoleArn is a required field
RoleArn *string `min:"20" type:"string" required:"true"`
// The current state of the QLDB journal stream.
//
// Status is a required field
Status *string `type:"string" required:"true" enum:"StreamStatus"`
// The UUID (represented in Base62-encoded text) of the QLDB journal stream.
//
// StreamId is a required field
StreamId *string `min:"22" type:"string" required:"true"`
// The user-defined name of the QLDB journal stream.
//
// StreamName is a required field
StreamName *string `min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
Information about an Amazon QLDB journal stream, including the Amazon Resource Name (ARN), stream name, creation time, current status, and the parameters of the original stream creation request.
func (s JournalKinesisStreamDescription) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *JournalKinesisStreamDescription) SetArn(v string) *JournalKinesisStreamDescription
SetArn sets the Arn field's value.
func (s *JournalKinesisStreamDescription) SetCreationTime(v time.Time) *JournalKinesisStreamDescription
SetCreationTime sets the CreationTime field's value.
func (s *JournalKinesisStreamDescription) SetErrorCause(v string) *JournalKinesisStreamDescription
SetErrorCause sets the ErrorCause field's value.
func (s *JournalKinesisStreamDescription) SetExclusiveEndTime(v time.Time) *JournalKinesisStreamDescription
SetExclusiveEndTime sets the ExclusiveEndTime field's value.
func (s *JournalKinesisStreamDescription) SetInclusiveStartTime(v time.Time) *JournalKinesisStreamDescription
SetInclusiveStartTime sets the InclusiveStartTime field's value.
func (s *JournalKinesisStreamDescription) SetKinesisConfiguration(v *KinesisConfiguration) *JournalKinesisStreamDescription
SetKinesisConfiguration sets the KinesisConfiguration field's value.
func (s *JournalKinesisStreamDescription) SetLedgerName(v string) *JournalKinesisStreamDescription
SetLedgerName sets the LedgerName field's value.
func (s *JournalKinesisStreamDescription) SetRoleArn(v string) *JournalKinesisStreamDescription
SetRoleArn sets the RoleArn field's value.
func (s *JournalKinesisStreamDescription) SetStatus(v string) *JournalKinesisStreamDescription
SetStatus sets the Status field's value.
func (s *JournalKinesisStreamDescription) SetStreamId(v string) *JournalKinesisStreamDescription
SetStreamId sets the StreamId field's value.
func (s *JournalKinesisStreamDescription) SetStreamName(v string) *JournalKinesisStreamDescription
SetStreamName sets the StreamName field's value.
func (s JournalKinesisStreamDescription) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type JournalS3ExportDescription struct {
// The exclusive end date and time for the range of journal contents that was
// 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 UUID (represented in Base62-encoded text) 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
// was 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 output format of the exported journal data.
OutputFormat *string `type:"string" enum:"OutputFormat"`
// 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 managed key in Key Management Service (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
}
Information about a journal export job, including the ledger name, export ID, creation time, current status, and the parameters of the original export creation request.
func (s JournalS3ExportDescription) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *JournalS3ExportDescription) SetExclusiveEndTime(v time.Time) *JournalS3ExportDescription
SetExclusiveEndTime sets the ExclusiveEndTime field's value.
func (s *JournalS3ExportDescription) SetExportCreationTime(v time.Time) *JournalS3ExportDescription
SetExportCreationTime sets the ExportCreationTime field's value.
func (s *JournalS3ExportDescription) SetExportId(v string) *JournalS3ExportDescription
SetExportId sets the ExportId field's value.
func (s *JournalS3ExportDescription) SetInclusiveStartTime(v time.Time) *JournalS3ExportDescription
SetInclusiveStartTime sets the InclusiveStartTime field's value.
func (s *JournalS3ExportDescription) SetLedgerName(v string) *JournalS3ExportDescription
SetLedgerName sets the LedgerName field's value.
func (s *JournalS3ExportDescription) SetOutputFormat(v string) *JournalS3ExportDescription
SetOutputFormat sets the OutputFormat field's value.
func (s *JournalS3ExportDescription) SetRoleArn(v string) *JournalS3ExportDescription
SetRoleArn sets the RoleArn field's value.
func (s *JournalS3ExportDescription) SetS3ExportConfiguration(v *S3ExportConfiguration) *JournalS3ExportDescription
SetS3ExportConfiguration sets the S3ExportConfiguration field's value.
func (s *JournalS3ExportDescription) SetStatus(v string) *JournalS3ExportDescription
SetStatus sets the Status field's value.
func (s JournalS3ExportDescription) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type KinesisConfiguration struct {
// Enables QLDB to publish multiple data records in a single Kinesis Data Streams
// record, increasing the number of records sent per API call.
//
// Default: True
//
// Record aggregation has important implications for processing records and
// requires de-aggregation in your stream consumer. To learn more, see KPL Key
// Concepts (https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-concepts.html)
// and Consumer De-aggregation (https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-consumer-deaggregation.html)
// in the Amazon Kinesis Data Streams Developer Guide.
AggregationEnabled *bool `type:"boolean"`
// The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.
//
// StreamArn is a required field
StreamArn *string `min:"20" type:"string" required:"true"`
// contains filtered or unexported fields
}
The configuration settings of the Amazon Kinesis Data Streams destination for an Amazon QLDB journal stream.
func (s KinesisConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KinesisConfiguration) SetAggregationEnabled(v bool) *KinesisConfiguration
SetAggregationEnabled sets the AggregationEnabled field's value.
func (s *KinesisConfiguration) SetStreamArn(v string) *KinesisConfiguration
SetStreamArn sets the StreamArn field's value.
func (s KinesisConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KinesisConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type LedgerEncryptionDescription struct {
// The current state of encryption at rest for the ledger. This can be one of
// the following values:
//
// * ENABLED: Encryption is fully enabled using the specified key.
//
// * UPDATING: The ledger is actively processing the specified key change.
// Key changes in QLDB are asynchronous. The ledger is fully accessible without
// any performance impact while the key change is being processed. The amount
// of time it takes to update a key varies depending on the ledger size.
//
// * KMS_KEY_INACCESSIBLE: The specified customer managed KMS key is not
// accessible, and the ledger is impaired. Either the key was disabled or
// deleted, or the grants on the key were revoked. When a ledger is impaired,
// it is not accessible and does not accept any read or write requests. An
// impaired ledger automatically returns to an active state after you restore
// the grants on the key, or re-enable the key that was disabled. However,
// deleting a customer managed KMS key is irreversible. After a key is deleted,
// you can no longer access the ledgers that are protected with that key,
// and the data becomes unrecoverable permanently.
//
// EncryptionStatus is a required field
EncryptionStatus *string `type:"string" required:"true" enum:"EncryptionStatus"`
// The date and time, in epoch time format, when the KMS key first became inaccessible,
// in the case of an error. (Epoch time format is the number of seconds that
// have elapsed since 12:00:00 AM January 1, 1970 UTC.)
//
// This parameter is undefined if the KMS key is accessible.
InaccessibleKmsKeyDateTime *time.Time `type:"timestamp"`
// The Amazon Resource Name (ARN) of the customer managed KMS key that the ledger
// uses for encryption at rest. If this parameter is undefined, the ledger uses
// an Amazon Web Services owned KMS key for encryption. It will display AWS_OWNED_KMS_KEY
// when updating the ledger's encryption configuration to the Amazon Web Services
// owned KMS key.
//
// KmsKeyArn is a required field
KmsKeyArn *string `min:"20" type:"string" required:"true"`
// contains filtered or unexported fields
}
Information about the encryption of data at rest in an Amazon QLDB ledger. This includes the current status, the key in Key Management Service (KMS), and when the key became inaccessible (in the case of an error).
For more information, see Encryption at rest (https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html) in the Amazon QLDB Developer Guide.
func (s LedgerEncryptionDescription) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *LedgerEncryptionDescription) SetEncryptionStatus(v string) *LedgerEncryptionDescription
SetEncryptionStatus sets the EncryptionStatus field's value.
func (s *LedgerEncryptionDescription) SetInaccessibleKmsKeyDateTime(v time.Time) *LedgerEncryptionDescription
SetInaccessibleKmsKeyDateTime sets the InaccessibleKmsKeyDateTime field's value.
func (s *LedgerEncryptionDescription) SetKmsKeyArn(v string) *LedgerEncryptionDescription
SetKmsKeyArn sets the KmsKeyArn field's value.
func (s LedgerEncryptionDescription) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s LedgerSummary) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *LedgerSummary) SetCreationDateTime(v time.Time) *LedgerSummary
SetCreationDateTime sets the CreationDateTime field's value.
func (s *LedgerSummary) SetName(v string) *LedgerSummary
SetName sets the Name field's value.
func (s *LedgerSummary) SetState(v string) *LedgerSummary
SetState sets the State field's value.
func (s LedgerSummary) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type LimitExceededException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// The type of resource.
ResourceType *string `type:"string"`
// contains filtered or unexported fields
}
You have reached the limit on the maximum number of resources allowed.
func (s *LimitExceededException) Code() string
Code returns the exception type name.
func (s *LimitExceededException) Error() string
func (s LimitExceededException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *LimitExceededException) Message() string
Message returns the exception's message.
func (s *LimitExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *LimitExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *LimitExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s LimitExceededException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListJournalKinesisStreamsForLedgerInput struct {
// The name of the ledger.
//
// LedgerName is a required field
LedgerName *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"`
// The maximum number of results to return in a single ListJournalKinesisStreamsForLedger
// 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
// ListJournalKinesisStreamsForLedger call, 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 (s ListJournalKinesisStreamsForLedgerInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListJournalKinesisStreamsForLedgerInput) SetLedgerName(v string) *ListJournalKinesisStreamsForLedgerInput
SetLedgerName sets the LedgerName field's value.
func (s *ListJournalKinesisStreamsForLedgerInput) SetMaxResults(v int64) *ListJournalKinesisStreamsForLedgerInput
SetMaxResults sets the MaxResults field's value.
func (s *ListJournalKinesisStreamsForLedgerInput) SetNextToken(v string) *ListJournalKinesisStreamsForLedgerInput
SetNextToken sets the NextToken field's value.
func (s ListJournalKinesisStreamsForLedgerInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListJournalKinesisStreamsForLedgerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListJournalKinesisStreamsForLedgerOutput struct {
// * If NextToken is empty, the last page of results has been processed and
// there are no more results to be retrieved.
//
// * If NextToken is not empty, more results are available. To retrieve the
// next page of results, use the value of NextToken in a subsequent ListJournalKinesisStreamsForLedger
// call.
NextToken *string `min:"4" type:"string"`
// The QLDB journal streams that are currently associated with the given ledger.
Streams []*JournalKinesisStreamDescription `type:"list"`
// contains filtered or unexported fields
}
func (s ListJournalKinesisStreamsForLedgerOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListJournalKinesisStreamsForLedgerOutput) SetNextToken(v string) *ListJournalKinesisStreamsForLedgerOutput
SetNextToken sets the NextToken field's value.
func (s *ListJournalKinesisStreamsForLedgerOutput) SetStreams(v []*JournalKinesisStreamDescription) *ListJournalKinesisStreamsForLedgerOutput
SetStreams sets the Streams field's value.
func (s ListJournalKinesisStreamsForLedgerOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s ListJournalS3ExportsForLedgerInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListJournalS3ExportsForLedgerInput) SetMaxResults(v int64) *ListJournalS3ExportsForLedgerInput
SetMaxResults sets the MaxResults field's value.
func (s *ListJournalS3ExportsForLedgerInput) SetName(v string) *ListJournalS3ExportsForLedgerInput
SetName sets the Name field's value.
func (s *ListJournalS3ExportsForLedgerInput) SetNextToken(v string) *ListJournalS3ExportsForLedgerInput
SetNextToken sets the NextToken field's value.
func (s ListJournalS3ExportsForLedgerInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListJournalS3ExportsForLedgerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListJournalS3ExportsForLedgerOutput struct {
// The journal export jobs that are currently 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 (s ListJournalS3ExportsForLedgerOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListJournalS3ExportsForLedgerOutput) SetJournalS3Exports(v []*JournalS3ExportDescription) *ListJournalS3ExportsForLedgerOutput
SetJournalS3Exports sets the JournalS3Exports field's value.
func (s *ListJournalS3ExportsForLedgerOutput) SetNextToken(v string) *ListJournalS3ExportsForLedgerOutput
SetNextToken sets the NextToken field's value.
func (s ListJournalS3ExportsForLedgerOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s ListJournalS3ExportsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListJournalS3ExportsInput) SetMaxResults(v int64) *ListJournalS3ExportsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListJournalS3ExportsInput) SetNextToken(v string) *ListJournalS3ExportsInput
SetNextToken sets the NextToken field's value.
func (s ListJournalS3ExportsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListJournalS3ExportsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListJournalS3ExportsOutput struct {
// The journal export jobs for all ledgers that are associated with the current
// Amazon Web Services 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 (s ListJournalS3ExportsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListJournalS3ExportsOutput) SetJournalS3Exports(v []*JournalS3ExportDescription) *ListJournalS3ExportsOutput
SetJournalS3Exports sets the JournalS3Exports field's value.
func (s *ListJournalS3ExportsOutput) SetNextToken(v string) *ListJournalS3ExportsOutput
SetNextToken sets the NextToken field's value.
func (s ListJournalS3ExportsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s ListLedgersInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListLedgersInput) SetMaxResults(v int64) *ListLedgersInput
SetMaxResults sets the MaxResults field's value.
func (s *ListLedgersInput) SetNextToken(v string) *ListLedgersInput
SetNextToken sets the NextToken field's value.
func (s ListLedgersInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListLedgersInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListLedgersOutput struct {
// The ledgers that are associated with the current Amazon Web Services 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 (s ListLedgersOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListLedgersOutput) SetLedgers(v []*LedgerSummary) *ListLedgersOutput
SetLedgers sets the Ledgers field's value.
func (s *ListLedgersOutput) SetNextToken(v string) *ListLedgersOutput
SetNextToken sets the NextToken field's value.
func (s ListLedgersOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListTagsForResourceInput struct {
// The Amazon Resource Name (ARN) for which 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 (s ListTagsForResourceInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput
SetResourceArn sets the ResourceArn field's value.
func (s ListTagsForResourceInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListTagsForResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s ListTagsForResourceOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput
SetTags sets the Tags field's value.
func (s ListTagsForResourceOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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(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:
mySession := session.Must(session.NewSession())
// 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 (c *QLDB) CancelJournalKinesisStream(input *CancelJournalKinesisStreamInput) (*CancelJournalKinesisStreamOutput, error)
CancelJournalKinesisStream API operation for Amazon QLDB.
Ends a given Amazon QLDB journal stream. Before a stream can be canceled, its current status must be ACTIVE.
You can't restart a stream after you cancel it. Canceled QLDB stream resources are subject to a 7-day retention period, so they are automatically deleted after this limit expires.
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 CancelJournalKinesisStream for usage and error information.
Returned Error Types:
InvalidParameterException One or more parameters in the request aren't valid.
ResourceNotFoundException The specified resource doesn't exist.
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/CancelJournalKinesisStream
func (c *QLDB) CancelJournalKinesisStreamRequest(input *CancelJournalKinesisStreamInput) (req *request.Request, output *CancelJournalKinesisStreamOutput)
CancelJournalKinesisStreamRequest generates a "aws/request.Request" representing the client's request for the CancelJournalKinesisStream 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 CancelJournalKinesisStream for more information on using the CancelJournalKinesisStream 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 CancelJournalKinesisStreamRequest method.
req, resp := client.CancelJournalKinesisStreamRequest(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/CancelJournalKinesisStream
func (c *QLDB) CancelJournalKinesisStreamWithContext(ctx aws.Context, input *CancelJournalKinesisStreamInput, opts ...request.Option) (*CancelJournalKinesisStreamOutput, error)
CancelJournalKinesisStreamWithContext is the same as CancelJournalKinesisStream with the addition of the ability to pass a context and additional request options.
See CancelJournalKinesisStream 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 (c *QLDB) CreateLedger(input *CreateLedgerInput) (*CreateLedgerOutput, error)
CreateLedger API operation for Amazon QLDB.
Creates a new ledger in your Amazon Web Services account in the current Region.
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 Types:
InvalidParameterException One or more parameters in the request aren't valid.
ResourceAlreadyExistsException The specified resource already exists.
LimitExceededException You have reached the limit on the maximum number of resources allowed.
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 (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 (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 (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. You can disable it by calling the UpdateLedger operation to set this parameter to false.
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 Types:
InvalidParameterException One or more parameters in the request aren't valid.
ResourceNotFoundException The specified resource doesn't exist.
ResourceInUseException The specified resource can't be modified at this time.
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 (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 (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 (c *QLDB) DescribeJournalKinesisStream(input *DescribeJournalKinesisStreamInput) (*DescribeJournalKinesisStreamOutput, error)
DescribeJournalKinesisStream API operation for Amazon QLDB.
Returns detailed information about a given Amazon QLDB journal stream. The output includes the Amazon Resource Name (ARN), stream name, current status, creation time, and the parameters of the original stream creation request.
This action does not return any expired journal streams. For more information, see Expiration for terminal streams (https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration) in the Amazon QLDB Developer Guide.
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 DescribeJournalKinesisStream for usage and error information.
Returned Error Types:
InvalidParameterException One or more parameters in the request aren't valid.
ResourceNotFoundException The specified resource doesn't exist.
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/DescribeJournalKinesisStream
func (c *QLDB) DescribeJournalKinesisStreamRequest(input *DescribeJournalKinesisStreamInput) (req *request.Request, output *DescribeJournalKinesisStreamOutput)
DescribeJournalKinesisStreamRequest generates a "aws/request.Request" representing the client's request for the DescribeJournalKinesisStream 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 DescribeJournalKinesisStream for more information on using the DescribeJournalKinesisStream 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 DescribeJournalKinesisStreamRequest method.
req, resp := client.DescribeJournalKinesisStreamRequest(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/DescribeJournalKinesisStream
func (c *QLDB) DescribeJournalKinesisStreamWithContext(ctx aws.Context, input *DescribeJournalKinesisStreamInput, opts ...request.Option) (*DescribeJournalKinesisStreamOutput, error)
DescribeJournalKinesisStreamWithContext is the same as DescribeJournalKinesisStream with the addition of the ability to pass a context and additional request options.
See DescribeJournalKinesisStream 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 (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, creation time, current status, and the parameters of the original export creation request.
This action does not return any expired export jobs. For more information, see Export job expiration (https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration) in the Amazon QLDB Developer Guide.
If the export job with the given ExportId doesn't exist, then throws ResourceNotFoundException.
If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.
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 Types:
See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DescribeJournalS3Export
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 (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 (c *QLDB) DescribeLedger(input *DescribeLedgerInput) (*DescribeLedgerOutput, error)
DescribeLedger API operation for Amazon QLDB.
Returns information about a ledger, including its state, permissions mode, encryption at rest settings, 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 Types:
InvalidParameterException One or more parameters in the request aren't valid.
ResourceNotFoundException The specified resource doesn't exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DescribeLedger
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 (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 (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. A journal export job can write the data objects in either the text or binary representation of Amazon Ion format, or in JSON Lines text 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 Types:
ResourceNotFoundException The specified resource doesn't exist.
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 (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 (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 (c *QLDB) GetBlock(input *GetBlockInput) (*GetBlockOutput, error)
GetBlock API operation for Amazon QLDB.
Returns a block object at a specified address in a journal. Also returns a proof of the specified block for verification if DigestTipAddress is provided.
For information about the data contents in a block, see Journal contents (https://docs.aws.amazon.com/qldb/latest/developerguide/journal-contents.html) in the Amazon QLDB Developer Guide.
If the specified ledger doesn't exist or is in DELETING status, then throws ResourceNotFoundException.
If the specified ledger is in CREATING status, then throws ResourcePreconditionNotMetException.
If no block exists with the specified address, then throws InvalidParameterException.
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 Types:
InvalidParameterException One or more parameters in the request aren't valid.
ResourceNotFoundException The specified resource doesn't exist.
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 (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 (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 (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 Types:
InvalidParameterException One or more parameters in the request aren't valid.
ResourceNotFoundException The specified resource doesn't exist.
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 (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 (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 (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 Types:
InvalidParameterException One or more parameters in the request aren't valid.
ResourceNotFoundException The specified resource doesn't exist.
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 (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 (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 (c *QLDB) ListJournalKinesisStreamsForLedger(input *ListJournalKinesisStreamsForLedgerInput) (*ListJournalKinesisStreamsForLedgerOutput, error)
ListJournalKinesisStreamsForLedger API operation for Amazon QLDB.
Returns all Amazon QLDB journal streams for a given ledger.
This action does not return any expired journal streams. For more information, see Expiration for terminal streams (https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration) in the Amazon QLDB Developer Guide.
This action returns a maximum of MaxResults items. It is paginated so that you can retrieve all the items by calling ListJournalKinesisStreamsForLedger 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 ListJournalKinesisStreamsForLedger for usage and error information.
Returned Error Types:
InvalidParameterException One or more parameters in the request aren't valid.
ResourceNotFoundException The specified resource doesn't exist.
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/ListJournalKinesisStreamsForLedger
func (c *QLDB) ListJournalKinesisStreamsForLedgerPages(input *ListJournalKinesisStreamsForLedgerInput, fn func(*ListJournalKinesisStreamsForLedgerOutput, bool) bool) error
ListJournalKinesisStreamsForLedgerPages iterates over the pages of a ListJournalKinesisStreamsForLedger operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListJournalKinesisStreamsForLedger 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 ListJournalKinesisStreamsForLedger operation.
pageNum := 0
err := client.ListJournalKinesisStreamsForLedgerPages(params,
func(page *qldb.ListJournalKinesisStreamsForLedgerOutput, lastPage bool) bool {
pageNum++
fmt.Println(page)
return pageNum <= 3
})
func (c *QLDB) ListJournalKinesisStreamsForLedgerPagesWithContext(ctx aws.Context, input *ListJournalKinesisStreamsForLedgerInput, fn func(*ListJournalKinesisStreamsForLedgerOutput, bool) bool, opts ...request.Option) error
ListJournalKinesisStreamsForLedgerPagesWithContext same as ListJournalKinesisStreamsForLedgerPages 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 (c *QLDB) ListJournalKinesisStreamsForLedgerRequest(input *ListJournalKinesisStreamsForLedgerInput) (req *request.Request, output *ListJournalKinesisStreamsForLedgerOutput)
ListJournalKinesisStreamsForLedgerRequest generates a "aws/request.Request" representing the client's request for the ListJournalKinesisStreamsForLedger 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 ListJournalKinesisStreamsForLedger for more information on using the ListJournalKinesisStreamsForLedger 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 ListJournalKinesisStreamsForLedgerRequest method.
req, resp := client.ListJournalKinesisStreamsForLedgerRequest(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/ListJournalKinesisStreamsForLedger
func (c *QLDB) ListJournalKinesisStreamsForLedgerWithContext(ctx aws.Context, input *ListJournalKinesisStreamsForLedgerInput, opts ...request.Option) (*ListJournalKinesisStreamsForLedgerOutput, error)
ListJournalKinesisStreamsForLedgerWithContext is the same as ListJournalKinesisStreamsForLedger with the addition of the ability to pass a context and additional request options.
See ListJournalKinesisStreamsForLedger 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 (c *QLDB) ListJournalS3Exports(input *ListJournalS3ExportsInput) (*ListJournalS3ExportsOutput, error)
ListJournalS3Exports API operation for Amazon QLDB.
Returns all journal export jobs for all ledgers that are associated with the current Amazon Web Services account and Region.
This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3Exports multiple times.
This action does not return any expired export jobs. For more information, see Export job expiration (https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration) in the Amazon QLDB Developer Guide.
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 (c *QLDB) ListJournalS3ExportsForLedger(input *ListJournalS3ExportsForLedgerInput) (*ListJournalS3ExportsForLedgerOutput, error)
ListJournalS3ExportsForLedger API operation for Amazon QLDB.
Returns all journal export jobs for a specified ledger.
This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3ExportsForLedger multiple times.
This action does not return any expired export jobs. For more information, see Export job expiration (https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration) in the Amazon QLDB Developer Guide.
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 (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 (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 (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 (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 (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 (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 (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 (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 (c *QLDB) ListLedgers(input *ListLedgersInput) (*ListLedgersOutput, error)
ListLedgers API operation for Amazon QLDB.
Returns all ledgers that are associated with the current Amazon Web Services account and Region.
This action returns a maximum of MaxResults 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 (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 (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 (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 (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 (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 Types:
InvalidParameterException One or more parameters in the request aren't valid.
ResourceNotFoundException The specified resource doesn't exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListTagsForResource
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 (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 (c *QLDB) StreamJournalToKinesis(input *StreamJournalToKinesisInput) (*StreamJournalToKinesisOutput, error)
StreamJournalToKinesis API operation for Amazon QLDB.
Creates a journal stream for a given Amazon QLDB ledger. The stream captures every document revision that is committed to the ledger's journal and delivers the data to a specified Amazon Kinesis Data Streams resource.
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 StreamJournalToKinesis for usage and error information.
Returned Error Types:
InvalidParameterException One or more parameters in the request aren't valid.
ResourceNotFoundException The specified resource doesn't exist.
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/StreamJournalToKinesis
func (c *QLDB) StreamJournalToKinesisRequest(input *StreamJournalToKinesisInput) (req *request.Request, output *StreamJournalToKinesisOutput)
StreamJournalToKinesisRequest generates a "aws/request.Request" representing the client's request for the StreamJournalToKinesis 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 StreamJournalToKinesis for more information on using the StreamJournalToKinesis 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 StreamJournalToKinesisRequest method.
req, resp := client.StreamJournalToKinesisRequest(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/StreamJournalToKinesis
func (c *QLDB) StreamJournalToKinesisWithContext(ctx aws.Context, input *StreamJournalToKinesisInput, opts ...request.Option) (*StreamJournalToKinesisOutput, error)
StreamJournalToKinesisWithContext is the same as StreamJournalToKinesis with the addition of the ability to pass a context and additional request options.
See StreamJournalToKinesis 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 (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 Types:
InvalidParameterException One or more parameters in the request aren't valid.
ResourceNotFoundException The specified resource doesn't exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/TagResource
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 (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 (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 Types:
InvalidParameterException One or more parameters in the request aren't valid.
ResourceNotFoundException The specified resource doesn't exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/UntagResource
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 (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 (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 Types:
InvalidParameterException One or more parameters in the request aren't valid.
ResourceNotFoundException The specified resource doesn't exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/UpdateLedger
func (c *QLDB) UpdateLedgerPermissionsMode(input *UpdateLedgerPermissionsModeInput) (*UpdateLedgerPermissionsModeOutput, error)
UpdateLedgerPermissionsMode API operation for Amazon QLDB.
Updates the permissions mode of a ledger.
Before you switch to the STANDARD permissions mode, you must first create all required IAM policies and table tags to avoid disruption to your users. To learn more, see Migrating to the standard permissions mode (https://docs.aws.amazon.com/qldb/latest/developerguide/ledger-management.basics.html#ledger-mgmt.basics.update-permissions.migrating) in the Amazon QLDB Developer Guide.
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 UpdateLedgerPermissionsMode for usage and error information.
Returned Error Types:
InvalidParameterException One or more parameters in the request aren't valid.
ResourceNotFoundException The specified resource doesn't exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/UpdateLedgerPermissionsMode
func (c *QLDB) UpdateLedgerPermissionsModeRequest(input *UpdateLedgerPermissionsModeInput) (req *request.Request, output *UpdateLedgerPermissionsModeOutput)
UpdateLedgerPermissionsModeRequest generates a "aws/request.Request" representing the client's request for the UpdateLedgerPermissionsMode 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 UpdateLedgerPermissionsMode for more information on using the UpdateLedgerPermissionsMode 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 UpdateLedgerPermissionsModeRequest method.
req, resp := client.UpdateLedgerPermissionsModeRequest(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/UpdateLedgerPermissionsMode
func (c *QLDB) UpdateLedgerPermissionsModeWithContext(ctx aws.Context, input *UpdateLedgerPermissionsModeInput, opts ...request.Option) (*UpdateLedgerPermissionsModeOutput, error)
UpdateLedgerPermissionsModeWithContext is the same as UpdateLedgerPermissionsMode with the addition of the ability to pass a context and additional request options.
See UpdateLedgerPermissionsMode 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 (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 (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 ResourceAlreadyExistsException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// The name of the resource.
ResourceName *string `type:"string"`
// The type of resource.
ResourceType *string `type:"string"`
// contains filtered or unexported fields
}
The specified resource already exists.
func (s *ResourceAlreadyExistsException) Code() string
Code returns the exception type name.
func (s *ResourceAlreadyExistsException) Error() string
func (s ResourceAlreadyExistsException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ResourceAlreadyExistsException) Message() string
Message returns the exception's message.
func (s *ResourceAlreadyExistsException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceAlreadyExistsException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourceAlreadyExistsException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ResourceAlreadyExistsException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ResourceInUseException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// The name of the resource.
ResourceName *string `type:"string"`
// The type of resource.
ResourceType *string `type:"string"`
// contains filtered or unexported fields
}
The specified resource can't be modified at this time.
func (s *ResourceInUseException) Code() string
Code returns the exception type name.
func (s *ResourceInUseException) Error() string
func (s ResourceInUseException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ResourceInUseException) Message() string
Message returns the exception's message.
func (s *ResourceInUseException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceInUseException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourceInUseException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ResourceInUseException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ResourceNotFoundException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// The name of the resource.
ResourceName *string `type:"string"`
// The type of resource.
ResourceType *string `type:"string"`
// contains filtered or unexported fields
}
The specified resource doesn't exist.
func (s *ResourceNotFoundException) Code() string
Code returns the exception type name.
func (s *ResourceNotFoundException) Error() string
func (s ResourceNotFoundException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ResourceNotFoundException) Message() string
Message returns the exception's message.
func (s *ResourceNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourceNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ResourceNotFoundException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ResourcePreconditionNotMetException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// The name of the resource.
ResourceName *string `type:"string"`
// The type of resource.
ResourceType *string `type:"string"`
// contains filtered or unexported fields
}
The operation failed because a condition wasn't satisfied in advance.
func (s *ResourcePreconditionNotMetException) Code() string
Code returns the exception type name.
func (s *ResourcePreconditionNotMetException) Error() string
func (s ResourcePreconditionNotMetException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ResourcePreconditionNotMetException) Message() string
Message returns the exception's message.
func (s *ResourcePreconditionNotMetException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourcePreconditionNotMetException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourcePreconditionNotMetException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ResourcePreconditionNotMetException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type S3EncryptionConfiguration struct {
// The Amazon Resource Name (ARN) of a symmetric encryption key in Key Management
// Service (KMS). Amazon S3 does not support asymmetric KMS keys.
//
// 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 (s S3EncryptionConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *S3EncryptionConfiguration) SetKmsKeyArn(v string) *S3EncryptionConfiguration
SetKmsKeyArn sets the KmsKeyArn field's value.
func (s *S3EncryptionConfiguration) SetObjectEncryptionType(v string) *S3EncryptionConfiguration
SetObjectEncryptionType sets the ObjectEncryptionType field's value.
func (s S3EncryptionConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *S3EncryptionConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s S3ExportConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *S3ExportConfiguration) SetBucket(v string) *S3ExportConfiguration
SetBucket sets the Bucket field's value.
func (s *S3ExportConfiguration) SetEncryptionConfiguration(v *S3EncryptionConfiguration) *S3ExportConfiguration
SetEncryptionConfiguration sets the EncryptionConfiguration field's value.
func (s *S3ExportConfiguration) SetPrefix(v string) *S3ExportConfiguration
SetPrefix sets the Prefix field's value.
func (s S3ExportConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *S3ExportConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StreamJournalToKinesisInput struct {
// The exclusive date and time that specifies when the stream ends. If you don't
// define this parameter, the stream runs indefinitely until you cancel it.
//
// The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal
// Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.
ExclusiveEndTime *time.Time `type:"timestamp"`
// The inclusive start date and time from which to start streaming journal data.
// This parameter must be in ISO 8601 date and time format and in Universal
// Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.
//
// The InclusiveStartTime cannot be in the future and must be before ExclusiveEndTime.
//
// If you provide an InclusiveStartTime that is before the ledger's CreationDateTime,
// QLDB effectively defaults it to the ledger's CreationDateTime.
//
// InclusiveStartTime is a required field
InclusiveStartTime *time.Time `type:"timestamp" required:"true"`
// The configuration settings of the Kinesis Data Streams destination for your
// stream request.
//
// KinesisConfiguration is a required field
KinesisConfiguration *KinesisConfiguration `type:"structure" required:"true"`
// The name of the ledger.
//
// LedgerName is a required field
LedgerName *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 stream to write data records to a Kinesis Data Streams resource.
//
// To pass a role to QLDB when requesting a journal stream, you must have permissions
// to perform the iam:PassRole action on the IAM role resource. This is required
// for all journal stream requests.
//
// RoleArn is a required field
RoleArn *string `min:"20" type:"string" required:"true"`
// The name that you want to assign to the QLDB journal stream. User-defined
// names can help identify and indicate the purpose of a stream.
//
// Your stream name must be unique among other active streams for a given ledger.
// Stream names have the same naming constraints as ledger names, as defined
// in Quotas in Amazon QLDB (https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming)
// in the Amazon QLDB Developer Guide.
//
// StreamName is a required field
StreamName *string `min:"1" type:"string" required:"true"`
// The key-value pairs to add as tags to the stream 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 (s StreamJournalToKinesisInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *StreamJournalToKinesisInput) SetExclusiveEndTime(v time.Time) *StreamJournalToKinesisInput
SetExclusiveEndTime sets the ExclusiveEndTime field's value.
func (s *StreamJournalToKinesisInput) SetInclusiveStartTime(v time.Time) *StreamJournalToKinesisInput
SetInclusiveStartTime sets the InclusiveStartTime field's value.
func (s *StreamJournalToKinesisInput) SetKinesisConfiguration(v *KinesisConfiguration) *StreamJournalToKinesisInput
SetKinesisConfiguration sets the KinesisConfiguration field's value.
func (s *StreamJournalToKinesisInput) SetLedgerName(v string) *StreamJournalToKinesisInput
SetLedgerName sets the LedgerName field's value.
func (s *StreamJournalToKinesisInput) SetRoleArn(v string) *StreamJournalToKinesisInput
SetRoleArn sets the RoleArn field's value.
func (s *StreamJournalToKinesisInput) SetStreamName(v string) *StreamJournalToKinesisInput
SetStreamName sets the StreamName field's value.
func (s *StreamJournalToKinesisInput) SetTags(v map[string]*string) *StreamJournalToKinesisInput
SetTags sets the Tags field's value.
func (s StreamJournalToKinesisInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *StreamJournalToKinesisInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StreamJournalToKinesisOutput struct {
// The UUID (represented in Base62-encoded text) that QLDB assigns to each QLDB
// journal stream.
StreamId *string `min:"22" type:"string"`
// contains filtered or unexported fields
}
func (s StreamJournalToKinesisOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *StreamJournalToKinesisOutput) SetStreamId(v string) *StreamJournalToKinesisOutput
SetStreamId sets the StreamId field's value.
func (s StreamJournalToKinesisOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s TagResourceInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput
SetResourceArn sets the ResourceArn field's value.
func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput
SetTags sets the Tags field's value.
func (s TagResourceInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *TagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceOutput struct {
// contains filtered or unexported fields
}
func (s TagResourceOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s TagResourceOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type UntagResourceInput struct {
// The Amazon Resource Name (ARN) from which 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 to remove.
//
// TagKeys is a required field
TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
// contains filtered or unexported fields
}
func (s UntagResourceInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput
SetResourceArn sets the ResourceArn field's value.
func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput
SetTagKeys sets the TagKeys field's value.
func (s UntagResourceInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UntagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UntagResourceOutput struct {
// contains filtered or unexported fields
}
func (s UntagResourceOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s UntagResourceOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type UpdateLedgerInput struct {
// Specifies whether the ledger is protected from being deleted by any user.
// If not defined during 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. You can disable it by calling the UpdateLedger operation
// to set this parameter to false.
DeletionProtection *bool `type:"boolean"`
// The key in Key Management Service (KMS) to use for encryption of data at
// rest in the ledger. For more information, see Encryption at rest (https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html)
// in the Amazon QLDB Developer Guide.
//
// Use one of the following options to specify this parameter:
//
// * AWS_OWNED_KMS_KEY: Use an KMS key that is owned and managed by Amazon
// Web Services on your behalf.
//
// * Undefined: Make no changes to the KMS key of the ledger.
//
// * A valid symmetric customer managed KMS key: Use the specified symmetric
// encryption KMS key in your account that you create, own, and manage. Amazon
// QLDB does not support asymmetric keys. For more information, see Using
// symmetric and asymmetric keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html)
// in the Key Management Service Developer Guide.
//
// To specify a customer managed KMS key, you can use its key ID, Amazon Resource
// Name (ARN), alias name, or alias ARN. When using an alias name, prefix it
// with "alias/". To specify a key in a different Amazon Web Services account,
// you must use the key ARN or alias ARN.
//
// For example:
//
// * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
//
// * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
//
// * Alias name: alias/ExampleAlias
//
// * Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
//
// For more information, see Key identifiers (KeyId) (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id)
// in the Key Management Service Developer Guide.
KmsKey *string `type:"string"`
// 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 (s UpdateLedgerInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateLedgerInput) SetDeletionProtection(v bool) *UpdateLedgerInput
SetDeletionProtection sets the DeletionProtection field's value.
func (s *UpdateLedgerInput) SetKmsKey(v string) *UpdateLedgerInput
SetKmsKey sets the KmsKey field's value.
func (s *UpdateLedgerInput) SetName(v string) *UpdateLedgerInput
SetName sets the Name field's value.
func (s UpdateLedgerInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateLedgerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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"`
// Specifies whether the ledger is protected from being deleted by any user.
// If not defined during 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. You can disable it by calling the UpdateLedger operation
// to set this parameter to false.
DeletionProtection *bool `type:"boolean"`
// Information about the encryption of data at rest in the ledger. This includes
// the current status, the KMS key, and when the key became inaccessible (in
// the case of an error).
EncryptionDescription *LedgerEncryptionDescription `type:"structure"`
// 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 (s UpdateLedgerOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateLedgerOutput) SetArn(v string) *UpdateLedgerOutput
SetArn sets the Arn field's value.
func (s *UpdateLedgerOutput) SetCreationDateTime(v time.Time) *UpdateLedgerOutput
SetCreationDateTime sets the CreationDateTime field's value.
func (s *UpdateLedgerOutput) SetDeletionProtection(v bool) *UpdateLedgerOutput
SetDeletionProtection sets the DeletionProtection field's value.
func (s *UpdateLedgerOutput) SetEncryptionDescription(v *LedgerEncryptionDescription) *UpdateLedgerOutput
SetEncryptionDescription sets the EncryptionDescription field's value.
func (s *UpdateLedgerOutput) SetName(v string) *UpdateLedgerOutput
SetName sets the Name field's value.
func (s *UpdateLedgerOutput) SetState(v string) *UpdateLedgerOutput
SetState sets the State field's value.
func (s UpdateLedgerOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type UpdateLedgerPermissionsModeInput struct {
// The name of the ledger.
//
// Name is a required field
Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"`
// The permissions mode to assign to the ledger. This parameter can have one
// of the following values:
//
// * ALLOW_ALL: A legacy permissions mode that enables access control with
// API-level granularity for ledgers. This mode allows users who have the
// SendCommand API permission for this ledger to run all PartiQL commands
// (hence, ALLOW_ALL) on any tables in the specified ledger. This mode disregards
// any table-level or command-level IAM permissions policies that you create
// for the ledger.
//
// * STANDARD: (Recommended) A permissions mode that enables access control
// with finer granularity for ledgers, tables, and PartiQL commands. By default,
// this mode denies all user requests to run any PartiQL commands on any
// tables in this ledger. To allow PartiQL commands to run, you must create
// IAM permissions policies for specific table resources and PartiQL actions,
// in addition to the SendCommand API permission for the ledger. For information,
// see Getting started with the standard permissions mode (https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html)
// in the Amazon QLDB Developer Guide.
//
// We strongly recommend using the STANDARD permissions mode to maximize the
// security of your ledger data.
//
// PermissionsMode is a required field
PermissionsMode *string `type:"string" required:"true" enum:"PermissionsMode"`
// contains filtered or unexported fields
}
func (s UpdateLedgerPermissionsModeInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateLedgerPermissionsModeInput) SetName(v string) *UpdateLedgerPermissionsModeInput
SetName sets the Name field's value.
func (s *UpdateLedgerPermissionsModeInput) SetPermissionsMode(v string) *UpdateLedgerPermissionsModeInput
SetPermissionsMode sets the PermissionsMode field's value.
func (s UpdateLedgerPermissionsModeInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateLedgerPermissionsModeInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateLedgerPermissionsModeOutput struct {
// The Amazon Resource Name (ARN) for the ledger.
Arn *string `min:"20" type:"string"`
// The name of the ledger.
Name *string `min:"1" type:"string"`
// The current permissions mode of the ledger.
PermissionsMode *string `type:"string" enum:"PermissionsMode"`
// contains filtered or unexported fields
}
func (s UpdateLedgerPermissionsModeOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateLedgerPermissionsModeOutput) SetArn(v string) *UpdateLedgerPermissionsModeOutput
SetArn sets the Arn field's value.
func (s *UpdateLedgerPermissionsModeOutput) SetName(v string) *UpdateLedgerPermissionsModeOutput
SetName sets the Name field's value.
func (s *UpdateLedgerPermissionsModeOutput) SetPermissionsMode(v string) *UpdateLedgerPermissionsModeOutput
SetPermissionsMode sets the PermissionsMode field's value.
func (s UpdateLedgerPermissionsModeOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ValueHolder struct {
// An Amazon Ion plaintext value contained in a ValueHolder structure.
//
// IonText is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by ValueHolder's
// String and GoString methods.
IonText *string `min:"1" type:"string" sensitive:"true"`
// contains filtered or unexported fields
}
A structure that can contain a value in multiple encoding formats.
func (s ValueHolder) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ValueHolder) SetIonText(v string) *ValueHolder
SetIonText sets the IonText field's value.
func (s ValueHolder) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ValueHolder) Validate() error
Validate inspects the fields of the type to determine if they are valid.