types

package
v1.2.1 Latest Latest
Warning

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

Go to latest
Published: Mar 4, 2025 License: Apache-2.0 Imports: 4 Imported by: 4

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The action cannot be performed because you do not have the required permission.

func (*AccessDeniedException) Error

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault

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

func (*AccessDeniedException) ErrorMessage

func (e *AccessDeniedException) ErrorMessage() string

type BadRequestException

type BadRequestException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request is invalid or malformed.

func (*BadRequestException) Error

func (e *BadRequestException) Error() string

func (*BadRequestException) ErrorCode

func (e *BadRequestException) ErrorCode() string

func (*BadRequestException) ErrorFault

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

func (*BadRequestException) ErrorMessage

func (e *BadRequestException) ErrorMessage() string

type ConflictException

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request failed because there is a conflict with a previous write. You can retry the request.

func (*ConflictException) Error

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault

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

func (*ConflictException) ErrorMessage

func (e *ConflictException) ErrorMessage() string

type ForbiddenException

type ForbiddenException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The caller isn't authorized to make the request.

func (*ForbiddenException) Error

func (e *ForbiddenException) Error() string

func (*ForbiddenException) ErrorCode

func (e *ForbiddenException) ErrorCode() string

func (*ForbiddenException) ErrorFault

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

func (*ForbiddenException) ErrorMessage

func (e *ForbiddenException) ErrorMessage() string

type IcebergCompactionSettings

type IcebergCompactionSettings struct {

	// The target file size for the table in MB.
	TargetFileSizeMB *int32
	// contains filtered or unexported fields
}

Contains details about the compaction settings for an Iceberg table.

type IcebergMetadata added in v1.1.0

type IcebergMetadata struct {

	// The schema for an Iceberg table.
	//
	// This member is required.
	Schema *IcebergSchema
	// contains filtered or unexported fields
}

Contains details about the metadata for an Iceberg table.

type IcebergSchema added in v1.1.0

type IcebergSchema struct {

	// The schema fields for the table
	//
	// This member is required.
	Fields []SchemaField
	// contains filtered or unexported fields
}

Contains details about the schema for an Iceberg table.

type IcebergSnapshotManagementSettings

type IcebergSnapshotManagementSettings struct {

	// The maximum age of a snapshot before it can be expired.
	MaxSnapshotAgeHours *int32

	// The minimum number of snapshots to keep.
	MinSnapshotsToKeep *int32
	// contains filtered or unexported fields
}

Contains details about the snapshot management settings for an Iceberg table. The oldest snapshot expires when its age exceeds the maxSnapshotAgeHours and the total number of snapshots exceeds the value for the minimum number of snapshots to keep minSnapshotsToKeep .

type IcebergUnreferencedFileRemovalSettings

type IcebergUnreferencedFileRemovalSettings struct {

	// The number of days an object has to be non-current before it is deleted.
	NonCurrentDays *int32

	// The number of days an object has to be unreferenced before it is marked as
	// non-current.
	UnreferencedDays *int32
	// contains filtered or unexported fields
}

Contains details about the unreferenced file removal settings for an Iceberg table bucket.

type InternalServerErrorException

type InternalServerErrorException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request failed due to an internal server error.

func (*InternalServerErrorException) Error

func (*InternalServerErrorException) ErrorCode

func (e *InternalServerErrorException) ErrorCode() string

func (*InternalServerErrorException) ErrorFault

func (*InternalServerErrorException) ErrorMessage

func (e *InternalServerErrorException) ErrorMessage() string

type JobStatus

type JobStatus string
const (
	JobStatusNotYetRun  JobStatus = "Not_Yet_Run"
	JobStatusSuccessful JobStatus = "Successful"
	JobStatusFailed     JobStatus = "Failed"
	JobStatusDisabled   JobStatus = "Disabled"
)

Enum values for JobStatus

func (JobStatus) Values

func (JobStatus) Values() []JobStatus

Values returns all known values for JobStatus. 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 MaintenanceStatus

type MaintenanceStatus string
const (
	MaintenanceStatusEnabled  MaintenanceStatus = "enabled"
	MaintenanceStatusDisabled MaintenanceStatus = "disabled"
)

Enum values for MaintenanceStatus

func (MaintenanceStatus) Values

Values returns all known values for MaintenanceStatus. 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 NamespaceSummary

type NamespaceSummary struct {

	// The date and time the namespace was created at.
	//
	// This member is required.
	CreatedAt *time.Time

	// The ID of the account that created the namespace.
	//
	// This member is required.
	CreatedBy *string

	// The name of the namespace.
	//
	// This member is required.
	Namespace []string

	// The ID of the account that owns the namespace.
	//
	// This member is required.
	OwnerAccountId *string
	// contains filtered or unexported fields
}

Contains details about a namespace.

type NotFoundException

type NotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request was rejected because the specified resource could not be found.

func (*NotFoundException) Error

func (e *NotFoundException) Error() string

func (*NotFoundException) ErrorCode

func (e *NotFoundException) ErrorCode() string

func (*NotFoundException) ErrorFault

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

func (*NotFoundException) ErrorMessage

func (e *NotFoundException) ErrorMessage() string

type OpenTableFormat

type OpenTableFormat string
const (
	OpenTableFormatIceberg OpenTableFormat = "ICEBERG"
)

Enum values for OpenTableFormat

func (OpenTableFormat) Values

func (OpenTableFormat) Values() []OpenTableFormat

Values returns all known values for OpenTableFormat. 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 SchemaField added in v1.1.0

type SchemaField struct {

	// The name of the field.
	//
	// This member is required.
	Name *string

	// The field type. S3 Tables supports all Apache Iceberg primitive types. For more
	// information, see the [Apache Iceberg documentation].
	//
	// [Apache Iceberg documentation]: https://iceberg.apache.org/spec/#primitive-types
	//
	// This member is required.
	Type *string

	// A Boolean value that specifies whether values are required for each row in this
	// field. By default, this is false and null values are allowed in the field. If
	// this is true the field does not allow null values.
	Required bool
	// contains filtered or unexported fields
}

Contains details about a schema field.

type TableBucketMaintenanceConfigurationValue

type TableBucketMaintenanceConfigurationValue struct {

	// Contains details about the settings of the maintenance configuration.
	Settings TableBucketMaintenanceSettings

	// The status of the maintenance configuration.
	Status MaintenanceStatus
	// contains filtered or unexported fields
}

Details about the values that define the maintenance configuration for a table bucket.

type TableBucketMaintenanceSettings

type TableBucketMaintenanceSettings interface {
	// contains filtered or unexported methods
}

Contains details about the maintenance settings for the table bucket.

The following types satisfy this interface:

TableBucketMaintenanceSettingsMemberIcebergUnreferencedFileRemoval
Example (OutputUsage)
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/s3tables/types"
)

func main() {
	var union types.TableBucketMaintenanceSettings
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.TableBucketMaintenanceSettingsMemberIcebergUnreferencedFileRemoval:
		_ = v.Value // Value is types.IcebergUnreferencedFileRemovalSettings

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}
Output:

type TableBucketMaintenanceSettingsMemberIcebergUnreferencedFileRemoval

type TableBucketMaintenanceSettingsMemberIcebergUnreferencedFileRemoval struct {
	Value IcebergUnreferencedFileRemovalSettings
	// contains filtered or unexported fields
}

The unreferenced file removal settings for the table bucket.

type TableBucketMaintenanceType

type TableBucketMaintenanceType string
const (
	TableBucketMaintenanceTypeIcebergUnreferencedFileRemoval TableBucketMaintenanceType = "icebergUnreferencedFileRemoval"
)

Enum values for TableBucketMaintenanceType

func (TableBucketMaintenanceType) Values

Values returns all known values for TableBucketMaintenanceType. 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 TableBucketSummary

type TableBucketSummary struct {

	// The Amazon Resource Name (ARN) of the table bucket.
	//
	// This member is required.
	Arn *string

	// The date and time the table bucket was created at.
	//
	// This member is required.
	CreatedAt *time.Time

	// The name of the table bucket.
	//
	// This member is required.
	Name *string

	// The ID of the account that owns the table bucket.
	//
	// This member is required.
	OwnerAccountId *string
	// contains filtered or unexported fields
}

Contains details about a table bucket.

type TableMaintenanceConfigurationValue

type TableMaintenanceConfigurationValue struct {

	// Contains details about the settings for the maintenance configuration.
	Settings TableMaintenanceSettings

	// The status of the maintenance configuration.
	Status MaintenanceStatus
	// contains filtered or unexported fields
}

Contains the values that define a maintenance configuration for a table.

type TableMaintenanceJobStatusValue

type TableMaintenanceJobStatusValue struct {

	// The status of the job.
	//
	// This member is required.
	Status JobStatus

	// The failure message of a failed job.
	FailureMessage *string

	// The date and time that the maintenance job was last run.
	LastRunTimestamp *time.Time
	// contains filtered or unexported fields
}

Details about the status of a maintenance job.

type TableMaintenanceJobType

type TableMaintenanceJobType string
const (
	TableMaintenanceJobTypeIcebergCompaction              TableMaintenanceJobType = "icebergCompaction"
	TableMaintenanceJobTypeIcebergSnapshotManagement      TableMaintenanceJobType = "icebergSnapshotManagement"
	TableMaintenanceJobTypeIcebergUnreferencedFileRemoval TableMaintenanceJobType = "icebergUnreferencedFileRemoval"
)

Enum values for TableMaintenanceJobType

func (TableMaintenanceJobType) Values

Values returns all known values for TableMaintenanceJobType. 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 TableMaintenanceSettings

type TableMaintenanceSettings interface {
	// contains filtered or unexported methods
}

Contains details about maintenance settings for the table.

The following types satisfy this interface:

TableMaintenanceSettingsMemberIcebergCompaction
TableMaintenanceSettingsMemberIcebergSnapshotManagement
Example (OutputUsage)
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/s3tables/types"
)

func main() {
	var union types.TableMaintenanceSettings
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.TableMaintenanceSettingsMemberIcebergCompaction:
		_ = v.Value // Value is types.IcebergCompactionSettings

	case *types.TableMaintenanceSettingsMemberIcebergSnapshotManagement:
		_ = v.Value // Value is types.IcebergSnapshotManagementSettings

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}
Output:

type TableMaintenanceSettingsMemberIcebergCompaction

type TableMaintenanceSettingsMemberIcebergCompaction struct {
	Value IcebergCompactionSettings
	// contains filtered or unexported fields
}

Contains details about the Iceberg compaction settings for the table.

type TableMaintenanceSettingsMemberIcebergSnapshotManagement

type TableMaintenanceSettingsMemberIcebergSnapshotManagement struct {
	Value IcebergSnapshotManagementSettings
	// contains filtered or unexported fields
}

Contains details about the Iceberg snapshot management settings for the table.

type TableMaintenanceType

type TableMaintenanceType string
const (
	TableMaintenanceTypeIcebergCompaction         TableMaintenanceType = "icebergCompaction"
	TableMaintenanceTypeIcebergSnapshotManagement TableMaintenanceType = "icebergSnapshotManagement"
)

Enum values for TableMaintenanceType

func (TableMaintenanceType) Values

Values returns all known values for TableMaintenanceType. 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 TableMetadata added in v1.1.0

type TableMetadata interface {
	// contains filtered or unexported methods
}

Contains details about the table metadata.

The following types satisfy this interface:

TableMetadataMemberIceberg
Example (OutputUsage)
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/s3tables/types"
)

func main() {
	var union types.TableMetadata
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.TableMetadataMemberIceberg:
		_ = v.Value // Value is types.IcebergMetadata

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}
Output:

type TableMetadataMemberIceberg added in v1.1.0

type TableMetadataMemberIceberg struct {
	Value IcebergMetadata
	// contains filtered or unexported fields
}

Contains details about the metadata of an Iceberg table.

type TableSummary

type TableSummary struct {

	// The date and time the table was created at.
	//
	// This member is required.
	CreatedAt *time.Time

	// The date and time the table was last modified at.
	//
	// This member is required.
	ModifiedAt *time.Time

	// The name of the table.
	//
	// This member is required.
	Name *string

	// The name of the namespace.
	//
	// This member is required.
	Namespace []string

	// The Amazon Resource Name (ARN) of the table.
	//
	// This member is required.
	TableARN *string

	// The type of the table.
	//
	// This member is required.
	Type TableType
	// contains filtered or unexported fields
}

Contains details about a table.

type TableType

type TableType string
const (
	TableTypeCustomer TableType = "customer"
	TableTypeAws      TableType = "aws"
)

Enum values for TableType

func (TableType) Values

func (TableType) Values() []TableType

Values returns all known values for TableType. 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 TooManyRequestsException

type TooManyRequestsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The limit on the number of requests per second was exceeded.

func (*TooManyRequestsException) Error

func (e *TooManyRequestsException) Error() string

func (*TooManyRequestsException) ErrorCode

func (e *TooManyRequestsException) ErrorCode() string

func (*TooManyRequestsException) ErrorFault

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

func (*TooManyRequestsException) ErrorMessage

func (e *TooManyRequestsException) ErrorMessage() string

type UnknownUnionMember

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
JackTT - Gopher 🇻🇳