Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ErrorCause

type ErrorCause string
const (
	ErrorCauseKinesisStreamNotFound ErrorCause = "KINESIS_STREAM_NOT_FOUND"
	ErrorCauseIamPermissionRevoked  ErrorCause = "IAM_PERMISSION_REVOKED"
)

    Enum values for ErrorCause

    func (ErrorCause) Values

    func (ErrorCause) Values() []ErrorCause

      Values returns all known values for ErrorCause. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

      type ExportStatus

      type ExportStatus string
      const (
      	ExportStatusInProgress ExportStatus = "IN_PROGRESS"
      	ExportStatusCompleted  ExportStatus = "COMPLETED"
      	ExportStatusCancelled  ExportStatus = "CANCELLED"
      )

        Enum values for ExportStatus

        func (ExportStatus) Values

        func (ExportStatus) Values() []ExportStatus

          Values returns all known values for ExportStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

          type InvalidParameterException

          type InvalidParameterException struct {
          	Message *string
          
          	ParameterName *string
          }

            One or more parameters in the request aren't valid.

            func (*InvalidParameterException) Error

            func (e *InvalidParameterException) Error() string

            func (*InvalidParameterException) ErrorCode

            func (e *InvalidParameterException) ErrorCode() string

            func (*InvalidParameterException) ErrorFault

            func (*InvalidParameterException) ErrorMessage

            func (e *InvalidParameterException) ErrorMessage() string

            type JournalKinesisStreamDescription

            type JournalKinesisStreamDescription struct {
            
            	// The configuration settings of the Amazon Kinesis Data Streams destination for
            	// your QLDB journal stream.
            	//
            	// This member is required.
            	KinesisConfiguration *KinesisConfiguration
            
            	// The name of the ledger.
            	//
            	// This member is required.
            	LedgerName *string
            
            	// 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.
            	//
            	// This member is required.
            	RoleArn *string
            
            	// The current state of the QLDB journal stream.
            	//
            	// This member is required.
            	Status StreamStatus
            
            	// The unique ID that QLDB assigns to each QLDB journal stream.
            	//
            	// This member is required.
            	StreamId *string
            
            	// The user-defined name of the QLDB journal stream.
            	//
            	// This member is required.
            	StreamName *string
            
            	// The Amazon Resource Name (ARN) of the QLDB journal stream.
            	Arn *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
            
            	// 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 ErrorCause
            
            	// The exclusive date and time that specifies when the stream ends. If this
            	// parameter is blank, the stream runs indefinitely until you cancel it.
            	ExclusiveEndTime *time.Time
            
            	// The inclusive start date and time from which to start streaming journal data.
            	InclusiveStartTime *time.Time
            }

              The information about an Amazon QLDB journal stream, including the Amazon Resource Name (ARN), stream name, creation time, current status, and the parameters of your original stream creation request.

              type JournalS3ExportDescription

              type JournalS3ExportDescription struct {
              
              	// The exclusive end date and time for the range of journal contents that are
              	// specified in the original export request.
              	//
              	// This member is required.
              	ExclusiveEndTime *time.Time
              
              	// 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.)
              	//
              	// This member is required.
              	ExportCreationTime *time.Time
              
              	// The unique ID of the journal export job.
              	//
              	// This member is required.
              	ExportId *string
              
              	// The inclusive start date and time for the range of journal contents that are
              	// specified in the original export request.
              	//
              	// This member is required.
              	InclusiveStartTime *time.Time
              
              	// The name of the ledger.
              	//
              	// This member is required.
              	LedgerName *string
              
              	// The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for
              	// a journal export job to do the following:
              	//
              	// * Write objects into your Amazon
              	// Simple Storage Service (Amazon S3) bucket.
              	//
              	// * (Optional) Use your customer
              	// master key (CMK) in AWS Key Management Service (AWS KMS) for server-side
              	// encryption of your exported data.
              	//
              	// This member is required.
              	RoleArn *string
              
              	// The Amazon Simple Storage Service (Amazon S3) bucket location in which a journal
              	// export job writes the journal contents.
              	//
              	// This member is required.
              	S3ExportConfiguration *S3ExportConfiguration
              
              	// The current state of the journal export job.
              	//
              	// This member is required.
              	Status ExportStatus
              }

                The information about a journal export job, including the ledger name, export ID, when it was created, current status, and its start and end time export parameters.

                type KinesisConfiguration

                type KinesisConfiguration struct {
                
                	// The Amazon Resource Name (ARN) of the Kinesis data stream resource.
                	//
                	// This member is required.
                	StreamArn *string
                
                	// Enables QLDB to publish multiple data records in a single Kinesis Data Streams
                	// record. To learn more, see KPL Key Concepts
                	// (https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-concepts.html) in
                	// the Amazon Kinesis Data Streams Developer Guide.
                	AggregationEnabled *bool
                }

                  The configuration settings of the Amazon Kinesis Data Streams destination for your Amazon QLDB journal stream.

                  type LedgerState

                  type LedgerState string
                  const (
                  	LedgerStateCreating LedgerState = "CREATING"
                  	LedgerStateActive   LedgerState = "ACTIVE"
                  	LedgerStateDeleting LedgerState = "DELETING"
                  	LedgerStateDeleted  LedgerState = "DELETED"
                  )

                    Enum values for LedgerState

                    func (LedgerState) Values

                    func (LedgerState) Values() []LedgerState

                      Values returns all known values for LedgerState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                      type LedgerSummary

                      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
                      
                      	// The name of the ledger.
                      	Name *string
                      
                      	// The current status of the ledger.
                      	State LedgerState
                      }

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

                        type LimitExceededException

                        type LimitExceededException struct {
                        	Message *string
                        
                        	ResourceType *string
                        }

                          You have reached the limit on the maximum number of resources allowed.

                          func (*LimitExceededException) Error

                          func (e *LimitExceededException) Error() string

                          func (*LimitExceededException) ErrorCode

                          func (e *LimitExceededException) ErrorCode() string

                          func (*LimitExceededException) ErrorFault

                          func (e *LimitExceededException) ErrorFault() smithy.ErrorFault

                          func (*LimitExceededException) ErrorMessage

                          func (e *LimitExceededException) ErrorMessage() string

                          type PermissionsMode

                          type PermissionsMode string
                          const (
                          	PermissionsModeAllowAll PermissionsMode = "ALLOW_ALL"
                          )

                            Enum values for PermissionsMode

                            func (PermissionsMode) Values

                            func (PermissionsMode) Values() []PermissionsMode

                              Values returns all known values for PermissionsMode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                              type ResourceAlreadyExistsException

                              type ResourceAlreadyExistsException struct {
                              	Message *string
                              
                              	ResourceType *string
                              	ResourceName *string
                              }

                                The specified resource already exists.

                                func (*ResourceAlreadyExistsException) Error

                                func (*ResourceAlreadyExistsException) ErrorCode

                                func (e *ResourceAlreadyExistsException) ErrorCode() string

                                func (*ResourceAlreadyExistsException) ErrorFault

                                func (*ResourceAlreadyExistsException) ErrorMessage

                                func (e *ResourceAlreadyExistsException) ErrorMessage() string

                                type ResourceInUseException

                                type ResourceInUseException struct {
                                	Message *string
                                
                                	ResourceType *string
                                	ResourceName *string
                                }

                                  The specified resource can't be modified at this time.

                                  func (*ResourceInUseException) Error

                                  func (e *ResourceInUseException) Error() string

                                  func (*ResourceInUseException) ErrorCode

                                  func (e *ResourceInUseException) ErrorCode() string

                                  func (*ResourceInUseException) ErrorFault

                                  func (e *ResourceInUseException) ErrorFault() smithy.ErrorFault

                                  func (*ResourceInUseException) ErrorMessage

                                  func (e *ResourceInUseException) ErrorMessage() string

                                  type ResourceNotFoundException

                                  type ResourceNotFoundException struct {
                                  	Message *string
                                  
                                  	ResourceType *string
                                  	ResourceName *string
                                  }

                                    The specified resource doesn't exist.

                                    func (*ResourceNotFoundException) Error

                                    func (e *ResourceNotFoundException) Error() string

                                    func (*ResourceNotFoundException) ErrorCode

                                    func (e *ResourceNotFoundException) ErrorCode() string

                                    func (*ResourceNotFoundException) ErrorFault

                                    func (*ResourceNotFoundException) ErrorMessage

                                    func (e *ResourceNotFoundException) ErrorMessage() string

                                    type ResourcePreconditionNotMetException

                                    type ResourcePreconditionNotMetException struct {
                                    	Message *string
                                    
                                    	ResourceType *string
                                    	ResourceName *string
                                    }

                                      The operation failed because a condition wasn't satisfied in advance.

                                      func (*ResourcePreconditionNotMetException) Error

                                      func (*ResourcePreconditionNotMetException) ErrorCode

                                      func (*ResourcePreconditionNotMetException) ErrorFault

                                      func (*ResourcePreconditionNotMetException) ErrorMessage

                                      func (e *ResourcePreconditionNotMetException) ErrorMessage() string

                                      type S3EncryptionConfiguration

                                      type S3EncryptionConfiguration struct {
                                      
                                      	// 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.
                                      	//
                                      	// This member is required.
                                      	ObjectEncryptionType S3ObjectEncryptionType
                                      
                                      	// The Amazon Resource Name (ARN) for a symmetric customer master key (CMK) in AWS
                                      	// Key Management Service (AWS KMS). Amazon QLDB does not support asymmetric CMKs.
                                      	// 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
                                      }

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

                                        type S3ExportConfiguration

                                        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.
                                        	//
                                        	// This member is required.
                                        	Bucket *string
                                        
                                        	// The encryption settings that are used by a journal export job to write data in
                                        	// an Amazon S3 bucket.
                                        	//
                                        	// This member is required.
                                        	EncryptionConfiguration *S3EncryptionConfiguration
                                        
                                        	// 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/
                                        	//
                                        	// This member is required.
                                        	Prefix *string
                                        }

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

                                          type S3ObjectEncryptionType

                                          type S3ObjectEncryptionType string
                                          const (
                                          	S3ObjectEncryptionTypeSseKms       S3ObjectEncryptionType = "SSE_KMS"
                                          	S3ObjectEncryptionTypeSseS3        S3ObjectEncryptionType = "SSE_S3"
                                          	S3ObjectEncryptionTypeNoEncryption S3ObjectEncryptionType = "NO_ENCRYPTION"
                                          )

                                            Enum values for S3ObjectEncryptionType

                                            func (S3ObjectEncryptionType) Values

                                              Values returns all known values for S3ObjectEncryptionType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                              type StreamStatus

                                              type StreamStatus string
                                              const (
                                              	StreamStatusActive    StreamStatus = "ACTIVE"
                                              	StreamStatusCompleted StreamStatus = "COMPLETED"
                                              	StreamStatusCanceled  StreamStatus = "CANCELED"
                                              	StreamStatusFailed    StreamStatus = "FAILED"
                                              	StreamStatusImpaired  StreamStatus = "IMPAIRED"
                                              )

                                                Enum values for StreamStatus

                                                func (StreamStatus) Values

                                                func (StreamStatus) Values() []StreamStatus

                                                  Values returns all known values for StreamStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                                  type ValueHolder

                                                  type ValueHolder struct {
                                                  
                                                  	// An Amazon Ion plaintext value contained in a ValueHolder structure.
                                                  	IonText *string
                                                  }

                                                    A structure that can contain a value in multiple encoding formats.