s3tables

package module
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: 43 Imported by: 6

Documentation

Overview

Package s3tables provides the API client, operations, and parameter types for Amazon S3 Tables.

An Amazon S3 table represents a structured dataset consisting of tabular data in Apache Parquetformat and related metadata. This data is stored inside an S3 table as a subresource. All tables in a table bucket are stored in the Apache Icebergtable format. Through integration with the AWS Glue Data Catalogyou can interact with your tables using AWS analytics services, such as Amazon Athenaand Amazon Redshift. Amazon S3 manages maintenance of your tables through automatic file compaction and snapshot management. For more information, see Amazon S3 table buckets.

Index

Constants

View Source
const ServiceAPIVersion = "2018-05-10"
View Source
const ServiceID = "S3Tables"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client

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

Client provides the API client to make operations call for Amazon S3 Tables.

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CreateNamespace

func (c *Client) CreateNamespace(ctx context.Context, params *CreateNamespaceInput, optFns ...func(*Options)) (*CreateNamespaceOutput, error)

Creates a namespace. A namespace is a logical grouping of tables within your table bucket, which you can use to organize tables. For more information, see Create a namespace in the Amazon Simple Storage Service User Guide.

Permissions You must have the s3tables:CreateNamespace permission to use this operation.

func (*Client) CreateTable

func (c *Client) CreateTable(ctx context.Context, params *CreateTableInput, optFns ...func(*Options)) (*CreateTableOutput, error)

Creates a new table associated with the given namespace in a table bucket. For more information, see Creating an Amazon S3 tablein the Amazon Simple Storage Service User Guide.

Permissions You must have the s3tables:CreateTable permission to use this operation.

Additionally, you must have the s3tables:PutTableData permission to use this operation with the optional metadata request parameter.

func (*Client) CreateTableBucket

func (c *Client) CreateTableBucket(ctx context.Context, params *CreateTableBucketInput, optFns ...func(*Options)) (*CreateTableBucketOutput, error)

Creates a table bucket. For more information, see Creating a table bucket in the Amazon Simple Storage Service User Guide.

Permissions You must have the s3tables:CreateTableBucket permission to use this operation.

func (*Client) DeleteNamespace

func (c *Client) DeleteNamespace(ctx context.Context, params *DeleteNamespaceInput, optFns ...func(*Options)) (*DeleteNamespaceOutput, error)

Deletes a namespace. For more information, see Delete a namespace in the Amazon Simple Storage Service User Guide.

Permissions You must have the s3tables:DeleteNamespace permission to use this operation.

func (*Client) DeleteTable

func (c *Client) DeleteTable(ctx context.Context, params *DeleteTableInput, optFns ...func(*Options)) (*DeleteTableOutput, error)

Deletes a table. For more information, see Deleting an Amazon S3 table in the Amazon Simple Storage Service User Guide.

Permissions You must have the s3tables:DeleteTable permission to use this operation.

func (*Client) DeleteTableBucket

func (c *Client) DeleteTableBucket(ctx context.Context, params *DeleteTableBucketInput, optFns ...func(*Options)) (*DeleteTableBucketOutput, error)

Deletes a table bucket. For more information, see Deleting a table bucket in the Amazon Simple Storage Service User Guide.

Permissions You must have the s3tables:DeleteTableBucket permission to use this operation.

func (*Client) DeleteTableBucketPolicy

func (c *Client) DeleteTableBucketPolicy(ctx context.Context, params *DeleteTableBucketPolicyInput, optFns ...func(*Options)) (*DeleteTableBucketPolicyOutput, error)

Deletes a table bucket policy. For more information, see Deleting a table bucket policy in the Amazon Simple Storage Service User Guide.

Permissions You must have the s3tables:DeleteTableBucketPolicy permission to use this operation.

func (*Client) DeleteTablePolicy

func (c *Client) DeleteTablePolicy(ctx context.Context, params *DeleteTablePolicyInput, optFns ...func(*Options)) (*DeleteTablePolicyOutput, error)

Deletes a table policy. For more information, see Deleting a table policy in the Amazon Simple Storage Service User Guide.

Permissions You must have the s3tables:DeleteTablePolicy permission to use this operation.

func (*Client) GetNamespace

func (c *Client) GetNamespace(ctx context.Context, params *GetNamespaceInput, optFns ...func(*Options)) (*GetNamespaceOutput, error)

Gets details about a namespace. For more information, see Table namespaces in the Amazon Simple Storage Service User Guide.

Permissions You must have the s3tables:GetNamespace permission to use this operation.

func (*Client) GetTable

func (c *Client) GetTable(ctx context.Context, params *GetTableInput, optFns ...func(*Options)) (*GetTableOutput, error)

Gets details about a table. For more information, see S3 Tables in the Amazon Simple Storage Service User Guide.

Permissions You must have the s3tables:GetTable permission to use this operation.

func (*Client) GetTableBucket

func (c *Client) GetTableBucket(ctx context.Context, params *GetTableBucketInput, optFns ...func(*Options)) (*GetTableBucketOutput, error)

Gets details on a table bucket. For more information, see Viewing details about an Amazon S3 table bucket in the Amazon Simple Storage Service User Guide.

Permissions You must have the s3tables:GetTableBucket permission to use this operation.

func (*Client) GetTableBucketMaintenanceConfiguration

func (c *Client) GetTableBucketMaintenanceConfiguration(ctx context.Context, params *GetTableBucketMaintenanceConfigurationInput, optFns ...func(*Options)) (*GetTableBucketMaintenanceConfigurationOutput, error)

Gets details about a maintenance configuration for a given table bucket. For more information, see Amazon S3 table bucket maintenancein the Amazon Simple Storage Service User Guide.

Permissions You must have the s3tables:GetTableBucketMaintenanceConfiguration permission to use this operation.

func (*Client) GetTableBucketPolicy

func (c *Client) GetTableBucketPolicy(ctx context.Context, params *GetTableBucketPolicyInput, optFns ...func(*Options)) (*GetTableBucketPolicyOutput, error)

Gets details about a table bucket policy. For more information, see Viewing a table bucket policy in the Amazon Simple Storage Service User Guide.

Permissions You must have the s3tables:GetTableBucketPolicy permission to use this operation.

func (*Client) GetTableMaintenanceConfiguration

func (c *Client) GetTableMaintenanceConfiguration(ctx context.Context, params *GetTableMaintenanceConfigurationInput, optFns ...func(*Options)) (*GetTableMaintenanceConfigurationOutput, error)

Gets details about the maintenance configuration of a table. For more information, see S3 Tables maintenancein the Amazon Simple Storage Service User Guide.

Permissions You must have the s3tables:GetTableMaintenanceConfiguration permission to use this operation.

func (*Client) GetTableMaintenanceJobStatus

func (c *Client) GetTableMaintenanceJobStatus(ctx context.Context, params *GetTableMaintenanceJobStatusInput, optFns ...func(*Options)) (*GetTableMaintenanceJobStatusOutput, error)

Gets the status of a maintenance job for a table. For more information, see S3 Tables maintenance in the Amazon Simple Storage Service User Guide.

Permissions You must have the s3tables:GetTableMaintenanceJobStatus permission to use this operation.

func (*Client) GetTableMetadataLocation

func (c *Client) GetTableMetadataLocation(ctx context.Context, params *GetTableMetadataLocationInput, optFns ...func(*Options)) (*GetTableMetadataLocationOutput, error)

Gets the location of the table metadata.

Permissions You must have the s3tables:GetTableMetadataLocation permission to use this operation.

func (*Client) GetTablePolicy

func (c *Client) GetTablePolicy(ctx context.Context, params *GetTablePolicyInput, optFns ...func(*Options)) (*GetTablePolicyOutput, error)

Gets details about a table policy. For more information, see Viewing a table policy in the Amazon Simple Storage Service User Guide.

Permissions You must have the s3tables:GetTablePolicy permission to use this operation.

func (*Client) ListNamespaces

func (c *Client) ListNamespaces(ctx context.Context, params *ListNamespacesInput, optFns ...func(*Options)) (*ListNamespacesOutput, error)

Lists the namespaces within a table bucket. For more information, see Table namespaces in the Amazon Simple Storage Service User Guide.

Permissions You must have the s3tables:ListNamespaces permission to use this operation.

func (*Client) ListTableBuckets

func (c *Client) ListTableBuckets(ctx context.Context, params *ListTableBucketsInput, optFns ...func(*Options)) (*ListTableBucketsOutput, error)

Lists table buckets for your account. For more information, see S3 Table buckets in the Amazon Simple Storage Service User Guide.

Permissions You must have the s3tables:ListTableBuckets permission to use this operation.

func (*Client) ListTables

func (c *Client) ListTables(ctx context.Context, params *ListTablesInput, optFns ...func(*Options)) (*ListTablesOutput, error)

List tables in the given table bucket. For more information, see S3 Tables in the Amazon Simple Storage Service User Guide.

Permissions You must have the s3tables:ListTables permission to use this operation.

func (*Client) Options

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutTableBucketMaintenanceConfiguration

func (c *Client) PutTableBucketMaintenanceConfiguration(ctx context.Context, params *PutTableBucketMaintenanceConfigurationInput, optFns ...func(*Options)) (*PutTableBucketMaintenanceConfigurationOutput, error)

Creates a new maintenance configuration or replaces an existing maintenance configuration for a table bucket. For more information, see Amazon S3 table bucket maintenancein the Amazon Simple Storage Service User Guide.

Permissions You must have the s3tables:PutTableBucketMaintenanceConfiguration permission to use this operation.

func (*Client) PutTableBucketPolicy

func (c *Client) PutTableBucketPolicy(ctx context.Context, params *PutTableBucketPolicyInput, optFns ...func(*Options)) (*PutTableBucketPolicyOutput, error)

Creates a new maintenance configuration or replaces an existing table bucket policy for a table bucket. For more information, see Adding a table bucket policyin the Amazon Simple Storage Service User Guide.

Permissions You must have the s3tables:PutTableBucketPolicy permission to use this operation.

func (*Client) PutTableMaintenanceConfiguration

func (c *Client) PutTableMaintenanceConfiguration(ctx context.Context, params *PutTableMaintenanceConfigurationInput, optFns ...func(*Options)) (*PutTableMaintenanceConfigurationOutput, error)

Creates a new maintenance configuration or replaces an existing maintenance configuration for a table. For more information, see S3 Tables maintenancein the Amazon Simple Storage Service User Guide.

Permissions You must have the s3tables:PutTableMaintenanceConfiguration permission to use this operation.

func (*Client) PutTablePolicy

func (c *Client) PutTablePolicy(ctx context.Context, params *PutTablePolicyInput, optFns ...func(*Options)) (*PutTablePolicyOutput, error)

Creates a new maintenance configuration or replaces an existing table policy for a table. For more information, see Adding a table policyin the Amazon Simple Storage Service User Guide.

Permissions You must have the s3tables:PutTablePolicy permission to use this operation.

func (*Client) RenameTable

func (c *Client) RenameTable(ctx context.Context, params *RenameTableInput, optFns ...func(*Options)) (*RenameTableOutput, error)

Renames a table or a namespace. For more information, see S3 Tables in the Amazon Simple Storage Service User Guide.

Permissions You must have the s3tables:RenameTable permission to use this operation.

func (*Client) UpdateTableMetadataLocation

func (c *Client) UpdateTableMetadataLocation(ctx context.Context, params *UpdateTableMetadataLocationInput, optFns ...func(*Options)) (*UpdateTableMetadataLocationOutput, error)

Updates the metadata location for a table. The metadata location of a table must be an S3 URI that begins with the table's warehouse location. The metadata location for an Apache Iceberg table must end with .metadata.json , or if the metadata file is Gzip-compressed, .metadata.json.gz .

Permissions You must have the s3tables:UpdateTableMetadataLocation permission to use this operation.

type CreateNamespaceInput

type CreateNamespaceInput struct {

	// A name for the namespace.
	//
	// This member is required.
	Namespace []string

	// The Amazon Resource Name (ARN) of the table bucket to create the namespace in.
	//
	// This member is required.
	TableBucketARN *string
	// contains filtered or unexported fields
}

type CreateNamespaceOutput

type CreateNamespaceOutput struct {

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

	// The Amazon Resource Name (ARN) of the table bucket the namespace was created in.
	//
	// This member is required.
	TableBucketARN *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateTableBucketInput

type CreateTableBucketInput struct {

	// The name for the table bucket.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type CreateTableBucketOutput

type CreateTableBucketOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateTableInput

type CreateTableInput struct {

	// The format for the table.
	//
	// This member is required.
	Format types.OpenTableFormat

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

	// The namespace to associated with the table.
	//
	// This member is required.
	Namespace *string

	// The Amazon Resource Name (ARN) of the table bucket to create the table in.
	//
	// This member is required.
	TableBucketARN *string

	// The metadata for the table.
	Metadata types.TableMetadata
	// contains filtered or unexported fields
}

type CreateTableOutput

type CreateTableOutput struct {

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

	// The version token of the table.
	//
	// This member is required.
	VersionToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteNamespaceInput

type DeleteNamespaceInput struct {

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

	// The Amazon Resource Name (ARN) of the table bucket associated with the
	// namespace.
	//
	// This member is required.
	TableBucketARN *string
	// contains filtered or unexported fields
}

type DeleteNamespaceOutput

type DeleteNamespaceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteTableBucketInput

type DeleteTableBucketInput struct {

	// The Amazon Resource Name (ARN) of the table bucket.
	//
	// This member is required.
	TableBucketARN *string
	// contains filtered or unexported fields
}

type DeleteTableBucketOutput

type DeleteTableBucketOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteTableBucketPolicyInput

type DeleteTableBucketPolicyInput struct {

	// The Amazon Resource Name (ARN) of the table bucket.
	//
	// This member is required.
	TableBucketARN *string
	// contains filtered or unexported fields
}

type DeleteTableBucketPolicyOutput

type DeleteTableBucketPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteTableInput

type DeleteTableInput struct {

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

	// The namespace associated with the table.
	//
	// This member is required.
	Namespace *string

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

	// The version token of the table.
	VersionToken *string
	// contains filtered or unexported fields
}

type DeleteTableOutput

type DeleteTableOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteTablePolicyInput

type DeleteTablePolicyInput struct {

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

	// The namespace associated with the table.
	//
	// This member is required.
	Namespace *string

	// The Amazon Resource Name (ARN) of the table bucket that contains the table.
	//
	// This member is required.
	TableBucketARN *string
	// contains filtered or unexported fields
}

type DeleteTablePolicyOutput

type DeleteTablePolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetNamespaceInput

type GetNamespaceInput struct {

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

	// The Amazon Resource Name (ARN) of the table bucket.
	//
	// This member is required.
	TableBucketARN *string
	// contains filtered or unexported fields
}

type GetNamespaceOutput

type GetNamespaceOutput 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 namespcace.
	//
	// This member is required.
	OwnerAccountId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTableBucketInput

type GetTableBucketInput struct {

	// The Amazon Resource Name (ARN) of the table bucket.
	//
	// This member is required.
	TableBucketARN *string
	// contains filtered or unexported fields
}

type GetTableBucketMaintenanceConfigurationInput

type GetTableBucketMaintenanceConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the table bucket associated with the
	// maintenance configuration.
	//
	// This member is required.
	TableBucketARN *string
	// contains filtered or unexported fields
}

type GetTableBucketMaintenanceConfigurationOutput

type GetTableBucketMaintenanceConfigurationOutput struct {

	// Details about the maintenance configuration for the table bucket.
	//
	// This member is required.
	Configuration map[string]types.TableBucketMaintenanceConfigurationValue

	// The Amazon Resource Name (ARN) of the table bucket associated with the
	// maintenance configuration.
	//
	// This member is required.
	TableBucketARN *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTableBucketOutput

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTableBucketPolicyInput

type GetTableBucketPolicyInput struct {

	// The Amazon Resource Name (ARN) of the table bucket.
	//
	// This member is required.
	TableBucketARN *string
	// contains filtered or unexported fields
}

type GetTableBucketPolicyOutput

type GetTableBucketPolicyOutput struct {

	// The JSON that defines the policy.
	//
	// This member is required.
	ResourcePolicy *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTableInput

type GetTableInput struct {

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

	// The name of the namespace the table is associated with.
	//
	// This member is required.
	Namespace *string

	// The Amazon Resource Name (ARN) of the table bucket associated with the table.
	//
	// This member is required.
	TableBucketARN *string
	// contains filtered or unexported fields
}

type GetTableMaintenanceConfigurationInput

type GetTableMaintenanceConfigurationInput struct {

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

	// The namespace associated with the table.
	//
	// This member is required.
	Namespace *string

	// The Amazon Resource Name (ARN) of the table bucket.
	//
	// This member is required.
	TableBucketARN *string
	// contains filtered or unexported fields
}

type GetTableMaintenanceConfigurationOutput

type GetTableMaintenanceConfigurationOutput struct {

	// Details about the maintenance configuration for the table bucket.
	//
	// This member is required.
	Configuration map[string]types.TableMaintenanceConfigurationValue

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTableMaintenanceJobStatusInput

type GetTableMaintenanceJobStatusInput struct {

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

	// The name of the namespace the table is associated with.
	//
	// This member is required.
	Namespace *string

	// The Amazon Resource Name (ARN) of the table bucket.
	//
	// This member is required.
	TableBucketARN *string
	// contains filtered or unexported fields
}

type GetTableMaintenanceJobStatusOutput

type GetTableMaintenanceJobStatusOutput struct {

	// The status of the maintenance job.
	//
	// This member is required.
	Status map[string]types.TableMaintenanceJobStatusValue

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTableMetadataLocationInput

type GetTableMetadataLocationInput struct {

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

	// The namespace of the table.
	//
	// This member is required.
	Namespace *string

	// The Amazon Resource Name (ARN) of the table bucket.
	//
	// This member is required.
	TableBucketARN *string
	// contains filtered or unexported fields
}

type GetTableMetadataLocationOutput

type GetTableMetadataLocationOutput struct {

	// The version token.
	//
	// This member is required.
	VersionToken *string

	// The warehouse location.
	//
	// This member is required.
	WarehouseLocation *string

	// The metadata location.
	MetadataLocation *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTableOutput

type GetTableOutput struct {

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

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

	// The format of the table.
	//
	// This member is required.
	Format types.OpenTableFormat

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

	// The ID of the account that last modified the table.
	//
	// This member is required.
	ModifiedBy *string

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

	// The namespace associated with the table.
	//
	// This member is required.
	Namespace []string

	// The ID of the account that owns the table.
	//
	// This member is required.
	OwnerAccountId *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 types.TableType

	// The version token of the table.
	//
	// This member is required.
	VersionToken *string

	// The warehouse location of the table.
	//
	// This member is required.
	WarehouseLocation *string

	// The service that manages the table.
	ManagedByService *string

	// The metadata location of the table.
	MetadataLocation *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTablePolicyInput

type GetTablePolicyInput struct {

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

	// The namespace associated with the table.
	//
	// This member is required.
	Namespace *string

	// The Amazon Resource Name (ARN) of the table bucket that contains the table.
	//
	// This member is required.
	TableBucketARN *string
	// contains filtered or unexported fields
}

type GetTablePolicyOutput

type GetTablePolicyOutput struct {

	// The JSON that defines the policy.
	//
	// This member is required.
	ResourcePolicy *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListNamespacesAPIClient

type ListNamespacesAPIClient interface {
	ListNamespaces(context.Context, *ListNamespacesInput, ...func(*Options)) (*ListNamespacesOutput, error)
}

ListNamespacesAPIClient is a client that implements the ListNamespaces operation.

type ListNamespacesInput

type ListNamespacesInput struct {

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

	// ContinuationToken indicates to Amazon S3 that the list is being continued on
	// this bucket with a token. ContinuationToken is obfuscated and is not a real
	// key. You can use this ContinuationToken for pagination of the list results.
	ContinuationToken *string

	// The maximum number of namespaces to return in the list.
	MaxNamespaces *int32

	// The prefix of the namespaces.
	Prefix *string
	// contains filtered or unexported fields
}

type ListNamespacesOutput

type ListNamespacesOutput struct {

	// A list of namespaces.
	//
	// This member is required.
	Namespaces []types.NamespaceSummary

	// The ContinuationToken for pagination of the list results.
	ContinuationToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListNamespacesPaginator

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

ListNamespacesPaginator is a paginator for ListNamespaces

func NewListNamespacesPaginator

func NewListNamespacesPaginator(client ListNamespacesAPIClient, params *ListNamespacesInput, optFns ...func(*ListNamespacesPaginatorOptions)) *ListNamespacesPaginator

NewListNamespacesPaginator returns a new ListNamespacesPaginator

func (*ListNamespacesPaginator) HasMorePages

func (p *ListNamespacesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListNamespacesPaginator) NextPage

func (p *ListNamespacesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListNamespacesOutput, error)

NextPage retrieves the next ListNamespaces page.

type ListNamespacesPaginatorOptions

type ListNamespacesPaginatorOptions struct {
	// The maximum number of namespaces to return in the list.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListNamespacesPaginatorOptions is the paginator options for ListNamespaces

type ListTableBucketsAPIClient

type ListTableBucketsAPIClient interface {
	ListTableBuckets(context.Context, *ListTableBucketsInput, ...func(*Options)) (*ListTableBucketsOutput, error)
}

ListTableBucketsAPIClient is a client that implements the ListTableBuckets operation.

type ListTableBucketsInput

type ListTableBucketsInput struct {

	// ContinuationToken indicates to Amazon S3 that the list is being continued on
	// this bucket with a token. ContinuationToken is obfuscated and is not a real
	// key. You can use this ContinuationToken for pagination of the list results.
	ContinuationToken *string

	// The maximum number of table buckets to return in the list.
	MaxBuckets *int32

	// The prefix of the table buckets.
	Prefix *string
	// contains filtered or unexported fields
}

type ListTableBucketsOutput

type ListTableBucketsOutput struct {

	// A list of table buckets.
	//
	// This member is required.
	TableBuckets []types.TableBucketSummary

	// You can use this ContinuationToken for pagination of the list results.
	ContinuationToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTableBucketsPaginator

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

ListTableBucketsPaginator is a paginator for ListTableBuckets

func NewListTableBucketsPaginator

func NewListTableBucketsPaginator(client ListTableBucketsAPIClient, params *ListTableBucketsInput, optFns ...func(*ListTableBucketsPaginatorOptions)) *ListTableBucketsPaginator

NewListTableBucketsPaginator returns a new ListTableBucketsPaginator

func (*ListTableBucketsPaginator) HasMorePages

func (p *ListTableBucketsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTableBucketsPaginator) NextPage

func (p *ListTableBucketsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTableBucketsOutput, error)

NextPage retrieves the next ListTableBuckets page.

type ListTableBucketsPaginatorOptions

type ListTableBucketsPaginatorOptions struct {
	// The maximum number of table buckets to return in the list.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTableBucketsPaginatorOptions is the paginator options for ListTableBuckets

type ListTablesAPIClient

type ListTablesAPIClient interface {
	ListTables(context.Context, *ListTablesInput, ...func(*Options)) (*ListTablesOutput, error)
}

ListTablesAPIClient is a client that implements the ListTables operation.

type ListTablesInput

type ListTablesInput struct {

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

	// ContinuationToken indicates to Amazon S3 that the list is being continued on
	// this bucket with a token. ContinuationToken is obfuscated and is not a real
	// key. You can use this ContinuationToken for pagination of the list results.
	ContinuationToken *string

	// The maximum number of tables to return.
	MaxTables *int32

	// The namespace of the tables.
	Namespace *string

	// The prefix of the tables.
	Prefix *string
	// contains filtered or unexported fields
}

type ListTablesOutput

type ListTablesOutput struct {

	// A list of tables.
	//
	// This member is required.
	Tables []types.TableSummary

	// You can use this ContinuationToken for pagination of the list results.
	ContinuationToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTablesPaginator

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

ListTablesPaginator is a paginator for ListTables

func NewListTablesPaginator

func NewListTablesPaginator(client ListTablesAPIClient, params *ListTablesInput, optFns ...func(*ListTablesPaginatorOptions)) *ListTablesPaginator

NewListTablesPaginator returns a new ListTablesPaginator

func (*ListTablesPaginator) HasMorePages

func (p *ListTablesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTablesPaginator) NextPage

func (p *ListTablesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTablesOutput, error)

NextPage retrieves the next ListTables page.

type ListTablesPaginatorOptions

type ListTablesPaginatorOptions struct {
	// The maximum number of tables to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTablesPaginatorOptions is the paginator options for ListTables

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutTableBucketMaintenanceConfigurationInput

type PutTableBucketMaintenanceConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the table bucket associated with the
	// maintenance configuration.
	//
	// This member is required.
	TableBucketARN *string

	// The type of the maintenance configuration.
	//
	// This member is required.
	Type types.TableBucketMaintenanceType

	// Defines the values of the maintenance configuration for the table bucket.
	//
	// This member is required.
	Value *types.TableBucketMaintenanceConfigurationValue
	// contains filtered or unexported fields
}

type PutTableBucketMaintenanceConfigurationOutput

type PutTableBucketMaintenanceConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutTableBucketPolicyInput

type PutTableBucketPolicyInput struct {

	// The JSON that defines the policy.
	//
	// This member is required.
	ResourcePolicy *string

	// The Amazon Resource Name (ARN) of the table bucket.
	//
	// This member is required.
	TableBucketARN *string
	// contains filtered or unexported fields
}

type PutTableBucketPolicyOutput

type PutTableBucketPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutTableMaintenanceConfigurationInput

type PutTableMaintenanceConfigurationInput struct {

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

	// The namespace of the table.
	//
	// This member is required.
	Namespace *string

	// The Amazon Resource Name (ARN) of the table associated with the maintenance
	// configuration.
	//
	// This member is required.
	TableBucketARN *string

	// The type of the maintenance configuration.
	//
	// This member is required.
	Type types.TableMaintenanceType

	// Defines the values of the maintenance configuration for the table.
	//
	// This member is required.
	Value *types.TableMaintenanceConfigurationValue
	// contains filtered or unexported fields
}

type PutTableMaintenanceConfigurationOutput

type PutTableMaintenanceConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutTablePolicyInput

type PutTablePolicyInput struct {

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

	// The namespace associated with the table.
	//
	// This member is required.
	Namespace *string

	// The JSON that defines the policy.
	//
	// This member is required.
	ResourcePolicy *string

	// The Amazon Resource Name (ARN) of the table bucket that contains the table.
	//
	// This member is required.
	TableBucketARN *string
	// contains filtered or unexported fields
}

type PutTablePolicyOutput

type PutTablePolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type RenameTableInput

type RenameTableInput struct {

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

	// The namespace associated with the table.
	//
	// This member is required.
	Namespace *string

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

	// The new name for the table.
	NewName *string

	// The new name for the namespace.
	NewNamespaceName *string

	// The version token of the table.
	VersionToken *string
	// contains filtered or unexported fields
}

type RenameTableOutput

type RenameTableOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type UpdateTableMetadataLocationInput

type UpdateTableMetadataLocationInput struct {

	// The new metadata location for the table.
	//
	// This member is required.
	MetadataLocation *string

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

	// The namespace of the table.
	//
	// This member is required.
	Namespace *string

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

	// The version token of the table.
	//
	// This member is required.
	VersionToken *string
	// contains filtered or unexported fields
}

type UpdateTableMetadataLocationOutput

type UpdateTableMetadataLocationOutput struct {

	// The metadata location of the table.
	//
	// This member is required.
	MetadataLocation *string

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

	// The namespace the table is associated with.
	//
	// This member is required.
	Namespace []string

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

	// The version token of the table.
	//
	// This member is required.
	VersionToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

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