types

package
v1.25.8 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 19, 2024 License: Apache-2.0 Imports: 4 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type EncryptionStatus added in v1.5.0 

type EncryptionStatus string
const (
	EncryptionStatusEnabled            EncryptionStatus = "ENABLED"
	EncryptionStatusUpdating           EncryptionStatus = "UPDATING"
	EncryptionStatusKmsKeyInaccessible EncryptionStatus = "KMS_KEY_INACCESSIBLE"
)

Enum values for EncryptionStatus

func (EncryptionStatus) Values added in v1.5.0 

func (EncryptionStatus) Values() []EncryptionStatus

Values returns all known values for EncryptionStatus. 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 ErrorCause 

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

Enum values for ErrorCause

func (ErrorCause) Values added in v0.29.0 

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 added in v0.29.0 

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

	ErrorCodeOverride *string

	ParameterName *string
	// contains filtered or unexported fields
}

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 (e *InvalidParameterException) ErrorFault() smithy.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 a
	// 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 UUID (represented in Base62-encoded text) of the 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 undefined, 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
	// 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.

type JournalS3ExportDescription 

type JournalS3ExportDescription struct {

	// The exclusive end date and time for the range of journal contents that was
	// 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 UUID (represented in Base62-encoded text) of the journal export job.
	//
	// This member is required.
	ExportId *string

	// The inclusive start date and time for the range of journal contents that was
	// 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 managed key in Key Management Service (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 output format of the exported journal data.
	OutputFormat OutputFormat
	// 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.

type KinesisConfiguration 

type KinesisConfiguration struct {

	// The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.
	//
	// This member is required.
	StreamArn *string

	// 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]and [Consumer De-aggregation] in the
	// Amazon Kinesis Data Streams Developer Guide.
	//
	// [Consumer De-aggregation]: https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-consumer-deaggregation.html
	// [KPL Key Concepts]: https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-concepts.html
	AggregationEnabled *bool
	// contains filtered or unexported fields
}

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

type LedgerEncryptionDescription added in v1.5.0 

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.
	//
	// This member is required.
	EncryptionStatus EncryptionStatus

	// 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.
	//
	// This member is required.
	KmsKeyArn *string

	// 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
	// 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 in the Amazon QLDB Developer Guide.

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 added in v0.29.0 

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
	// contains filtered or unexported fields
}

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

type LimitExceededException 

type LimitExceededException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceType *string
	// contains filtered or unexported fields
}

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 OutputFormat added in v1.10.0 

type OutputFormat string
const (
	OutputFormatIonBinary OutputFormat = "ION_BINARY"
	OutputFormatIonText   OutputFormat = "ION_TEXT"
	OutputFormatJson      OutputFormat = "JSON"
)

Enum values for OutputFormat

func (OutputFormat) Values added in v1.10.0 

func (OutputFormat) Values() []OutputFormat

Values returns all known values for OutputFormat. 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 PermissionsMode 

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

Enum values for PermissionsMode

func (PermissionsMode) Values added in v0.29.0 

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

	ErrorCodeOverride *string

	ResourceType *string
	ResourceName *string
	// contains filtered or unexported fields
}

The specified resource already exists.

func (*ResourceAlreadyExistsException) Error 

func (e *ResourceAlreadyExistsException) Error() string

func (*ResourceAlreadyExistsException) ErrorCode 

func (e *ResourceAlreadyExistsException) ErrorCode() string

func (*ResourceAlreadyExistsException) ErrorFault 

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

func (*ResourceAlreadyExistsException) ErrorMessage 

func (e *ResourceAlreadyExistsException) ErrorMessage() string

type ResourceInUseException 

type ResourceInUseException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceType *string
	ResourceName *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string

	ResourceType *string
	ResourceName *string
	// contains filtered or unexported fields
}

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 (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourcePreconditionNotMetException 

type ResourcePreconditionNotMetException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceType *string
	ResourceName *string
	// contains filtered or unexported fields
}

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

func (*ResourcePreconditionNotMetException) Error 

func (e *ResourcePreconditionNotMetException) Error() string

func (*ResourcePreconditionNotMetException) ErrorCode 

func (e *ResourcePreconditionNotMetException) ErrorCode() string

func (*ResourcePreconditionNotMetException) ErrorFault 

func (e *ResourcePreconditionNotMetException) ErrorFault() smithy.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] in the
	// Amazon S3 Developer Guide.
	//
	// [Protecting Data Using Server-Side Encryption]: https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html
	//
	// This member is required.
	ObjectEncryptionType S3ObjectEncryptionType

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

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]in the Amazon S3 Developer Guide.
	//
	// [Bucket Restrictions and Limitations]: https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html
	//
	// 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]in the Amazon S3 Developer Guide.
	//
	// The following are examples of valid Prefix values:
	//
	//   - JournalExports-ForMyLedger/Testing/
	//
	//   - JournalExports
	//
	//   - My:Tests/
	//
	// [Object Key and Metadata]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html
	//
	// This member is required.
	Prefix *string
	// contains filtered or unexported fields
}

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 added in v0.29.0 

func (S3ObjectEncryptionType) Values() []S3ObjectEncryptionType

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 added in v0.29.0 

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
	// contains filtered or unexported fields
}

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.