Class: Aws::S3Tables::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb

Overview

An API client for S3Tables. To construct a client, you need to configure a :region and :credentials.

client = Aws::S3Tables::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::S3Tables::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::S3Tables::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



473
474
475
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 473

def initialize(*args)
  super
end

Instance Method Details

#create_namespace(params = {}) ⇒ Types::CreateNamespaceResponse

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.

Examples:

Request syntax with placeholder values


resp = client.create_namespace({
  table_bucket_arn: "TableBucketARN", # required
  namespace: ["NamespaceName"], # required
})

Response structure


resp.table_bucket_arn #=> String
resp.namespace #=> Array
resp.namespace[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket to create the namespace in.

  • :namespace (required, Array<String>) —

    A name for the namespace.

Returns:

See Also:



522
523
524
525
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 522

def create_namespace(params = {}, options = {})
  req = build_request(:create_namespace, params)
  req.send_request(options)
end

#create_table(params = {}) ⇒ Types::CreateTableResponse

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

Permissions

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

  • If you use this operation with the optional metadata request parameter you must have the s3tables:PutTableData permission.

  • If you use this operation with the optional encryptionConfiguration request parameter you must have the s3tables:PutTableEncryption permission.

  • If you use this operation with the storageClassConfiguration request parameter, you must have the s3tables:PutTableStorageClass permission.

  • To create a table with tags, you must have the s3tables:TagResource permission in addition to s3tables:CreateTable permission.

Additionally, If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption.

Examples:

Request syntax with placeholder values


resp = client.create_table({
  table_bucket_arn: "TableBucketARN", # required
  namespace: "NamespaceName", # required
  name: "TableName", # required
  format: "ICEBERG", # required, accepts ICEBERG
  metadata: {
    iceberg: {
      schema: {
        fields: [ # required
          {
            id: 1,
            name: "String", # required
            type: "String", # required
            required: false,
          },
        ],
      },
      schema_v2: {
        type: "struct", # required, accepts struct
        fields: [ # required
          {
            id: 1, # required
            name: "String", # required
            type: { # required
            },
            required: false, # required
            doc: "String",
          },
        ],
        schema_id: 1,
        identifier_field_ids: [1],
      },
      partition_spec: {
        fields: [ # required
          {
            source_id: 1, # required
            transform: "String", # required
            name: "String", # required
            field_id: 1,
          },
        ],
        spec_id: 1,
      },
      write_order: {
        order_id: 1, # required
        fields: [ # required
          {
            source_id: 1, # required
            transform: "String", # required
            direction: "asc", # required, accepts asc, desc
            null_order: "nulls-first", # required, accepts nulls-first, nulls-last
          },
        ],
      },
      properties: {
        "String" => "String",
      },
    },
  },
  encryption_configuration: {
    sse_algorithm: "AES256", # required, accepts AES256, aws:kms
    kms_key_arn: "EncryptionConfigurationKmsKeyArnString",
  },
  storage_class_configuration: {
    storage_class: "STANDARD", # required, accepts STANDARD, INTELLIGENT_TIERING
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.table_arn #=> String
resp.version_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket to create the table in.

  • :namespace (required, String) —

    The namespace to associated with the table.

  • :name (required, String) —

    The name for the table.

  • :format (required, String) —

    The format for the table.

  • :metadata (Types::TableMetadata) —

    The metadata for the table.

  • :encryption_configuration (Types::EncryptionConfiguration) —

    The encryption configuration to use for the table. This configuration specifies the encryption algorithm and, if using SSE-KMS, the KMS key to use for encrypting the table.

    If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption.

  • :storage_class_configuration (Types::StorageClassConfiguration) —

    The storage class configuration for the table. If not specified, the table inherits the storage class configuration from its table bucket. Specify this parameter to override the bucket's default storage class for this table.

  • :tags (Hash<String,String>) —

    A map of user-defined tags that you would like to apply to the table that you are creating. A tag is a key-value pair that you apply to your resources. Tags can help you organize, track costs for, and control access to resources. For more information, see Tagging for cost allocation or attribute-based access control (ABAC).

    You must have the s3tables:TagResource permission in addition to s3tables:CreateTable permission to create a table with tags.

Returns:

See Also:



702
703
704
705
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 702

def create_table(params = {}, options = {})
  req = build_request(:create_table, params)
  req.send_request(options)
end

#create_table_bucket(params = {}) ⇒ Types::CreateTableBucketResponse

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.

  • If you use this operation with the optional encryptionConfiguration parameter you must have the s3tables:PutTableBucketEncryption permission.

  • If you use this operation with the storageClassConfiguration request parameter, you must have the s3tables:PutTableBucketStorageClass permission.

  • To create a table bucket with tags, you must have the s3tables:TagResource permission in addition to s3tables:CreateTableBucket permission.

Examples:

Request syntax with placeholder values


resp = client.create_table_bucket({
  name: "TableBucketName", # required
  encryption_configuration: {
    sse_algorithm: "AES256", # required, accepts AES256, aws:kms
    kms_key_arn: "EncryptionConfigurationKmsKeyArnString",
  },
  storage_class_configuration: {
    storage_class: "STANDARD", # required, accepts STANDARD, INTELLIGENT_TIERING
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name for the table bucket.

  • :encryption_configuration (Types::EncryptionConfiguration) —

    The encryption configuration to use for the table bucket. This configuration specifies the default encryption settings that will be applied to all tables created in this bucket unless overridden at the table level. The configuration includes the encryption algorithm and, if using SSE-KMS, the KMS key to use.

  • :storage_class_configuration (Types::StorageClassConfiguration) —

    The default storage class configuration for the table bucket. This configuration will be applied to all new tables created in this bucket unless overridden at the table level. If not specified, the service default storage class will be used.

  • :tags (Hash<String,String>) —

    A map of user-defined tags that you would like to apply to the table bucket that you are creating. A tag is a key-value pair that you apply to your resources. Tags can help you organize and control access to resources. For more information, see Tagging for cost allocation or attribute-based access control (ABAC).

    You must have the s3tables:TagResource permission in addition to s3tables:CreateTableBucket permisson to create a table bucket with tags.

Returns:

See Also:



791
792
793
794
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 791

def create_table_bucket(params = {}, options = {})
  req = build_request(:create_table_bucket, params)
  req.send_request(options)
end

#delete_namespace(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.delete_namespace({
  table_bucket_arn: "TableBucketARN", # required
  namespace: "NamespaceName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket associated with the namespace.

  • :namespace (required, String) —

    The name of the namespace.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



828
829
830
831
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 828

def delete_namespace(params = {}, options = {})
  req = build_request(:delete_namespace, params)
  req.send_request(options)
end

#delete_table(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.delete_table({
  table_bucket_arn: "TableBucketARN", # required
  namespace: "NamespaceName", # required
  name: "TableName", # required
  version_token: "VersionToken",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket that contains the table.

  • :namespace (required, String) —

    The namespace associated with the table.

  • :name (required, String) —

    The name of the table.

  • :version_token (String) —

    The version token of the table.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



873
874
875
876
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 873

def delete_table(params = {}, options = {})
  req = build_request(:delete_table, params)
  req.send_request(options)
end

#delete_table_bucket(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.delete_table_bucket({
  table_bucket_arn: "TableBucketARN", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



905
906
907
908
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 905

def delete_table_bucket(params = {}, options = {})
  req = build_request(:delete_table_bucket, params)
  req.send_request(options)
end

#delete_table_bucket_encryption(params = {}) ⇒ Struct

Deletes the encryption configuration for a table bucket.

Permissions

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

Examples:

Request syntax with placeholder values


resp = client.delete_table_bucket_encryption({
  table_bucket_arn: "TableBucketARN", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



932
933
934
935
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 932

def delete_table_bucket_encryption(params = {}, options = {})
  req = build_request(:delete_table_bucket_encryption, params)
  req.send_request(options)
end

#delete_table_bucket_metrics_configuration(params = {}) ⇒ Struct

Deletes the metrics configuration for a table bucket.

Permissions

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

Examples:

Request syntax with placeholder values


resp = client.delete_table_bucket_metrics_configuration({
  table_bucket_arn: "TableBucketARN", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



959
960
961
962
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 959

def delete_table_bucket_metrics_configuration(params = {}, options = {})
  req = build_request(:delete_table_bucket_metrics_configuration, params)
  req.send_request(options)
end

#delete_table_bucket_policy(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.delete_table_bucket_policy({
  table_bucket_arn: "TableBucketARN", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



992
993
994
995
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 992

def delete_table_bucket_policy(params = {}, options = {})
  req = build_request(:delete_table_bucket_policy, params)
  req.send_request(options)
end

#delete_table_bucket_replication(params = {}) ⇒ Struct

Deletes the replication configuration for a table bucket. After deletion, new table updates will no longer be replicated to destination buckets, though existing replicated tables will remain in destination buckets.

Permissions

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

Examples:

Request syntax with placeholder values


resp = client.delete_table_bucket_replication({
  table_bucket_arn: "TableBucketARN", # required
  version_token: "VersionToken",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket.

  • :version_token (String) —

    A version token from a previous GetTableBucketReplication call. Use this token to ensure you're deleting the expected version of the configuration.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1028
1029
1030
1031
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1028

def delete_table_bucket_replication(params = {}, options = {})
  req = build_request(:delete_table_bucket_replication, params)
  req.send_request(options)
end

#delete_table_policy(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.delete_table_policy({
  table_bucket_arn: "TableBucketARN", # required
  namespace: "NamespaceName", # required
  name: "TableName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket that contains the table.

  • :namespace (required, String) —

    The namespace associated with the table.

  • :name (required, String) —

    The table name.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1069
1070
1071
1072
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1069

def delete_table_policy(params = {}, options = {})
  req = build_request(:delete_table_policy, params)
  req.send_request(options)
end

#delete_table_replication(params = {}) ⇒ Struct

Deletes the replication configuration for a specific table. After deletion, new updates to this table will no longer be replicated to destination tables, though existing replicated copies will remain in destination buckets.

Permissions

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

Examples:

Request syntax with placeholder values


resp = client.delete_table_replication({
  table_arn: "TableARN", # required
  version_token: "String", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_arn (required, String) —

    The Amazon Resource Name (ARN) of the table.

  • :version_token (required, String) —

    A version token from a previous GetTableReplication call. Use this token to ensure you're deleting the expected version of the configuration.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1105
1106
1107
1108
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1105

def delete_table_replication(params = {}, options = {})
  req = build_request(:delete_table_replication, params)
  req.send_request(options)
end

#get_namespace(params = {}) ⇒ Types::GetNamespaceResponse

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.

Examples:

Request syntax with placeholder values


resp = client.get_namespace({
  table_bucket_arn: "TableBucketARN", # required
  namespace: "NamespaceName", # required
})

Response structure


resp.namespace #=> Array
resp.namespace[0] #=> String
resp.created_at #=> Time
resp.created_by #=> String
resp. #=> String
resp.namespace_id #=> String
resp.table_bucket_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket.

  • :namespace (required, String) —

    The name of the namespace.

Returns:

See Also:



1158
1159
1160
1161
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1158

def get_namespace(params = {}, options = {})
  req = build_request(:get_namespace, params)
  req.send_request(options)
end

#get_table(params = {}) ⇒ Types::GetTableResponse

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.

Examples:

Request syntax with placeholder values


resp = client.get_table({
  table_bucket_arn: "TableBucketARN",
  namespace: "NamespaceName",
  name: "TableName",
  table_arn: "TableARN",
})

Response structure


resp.name #=> String
resp.type #=> String, one of "customer", "aws"
resp.table_arn #=> String
resp.namespace #=> Array
resp.namespace[0] #=> String
resp.namespace_id #=> String
resp.version_token #=> String
resp.metadata_location #=> String
resp.warehouse_location #=> String
resp.created_at #=> Time
resp.created_by #=> String
resp.managed_by_service #=> String
resp.modified_at #=> Time
resp.modified_by #=> String
resp. #=> String
resp.format #=> String, one of "ICEBERG"
resp.table_bucket_id #=> String
resp.managed_table_information.replication_information.source_table_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (String) —

    The Amazon Resource Name (ARN) of the table bucket associated with the table.

  • :namespace (String) —

    The name of the namespace the table is associated with.

  • :name (String) —

    The name of the table.

  • :table_arn (String) —

    The Amazon Resource Name (ARN) of the table.

Returns:

See Also:



1242
1243
1244
1245
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1242

def get_table(params = {}, options = {})
  req = build_request(:get_table, params)
  req.send_request(options)
end

#get_table_bucket(params = {}) ⇒ Types::GetTableBucketResponse

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.

Examples:

Request syntax with placeholder values


resp = client.get_table_bucket({
  table_bucket_arn: "TableBucketARN", # required
})

Response structure


resp.arn #=> String
resp.name #=> String
resp. #=> String
resp.created_at #=> Time
resp.table_bucket_id #=> String
resp.type #=> String, one of "customer", "aws"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket.

Returns:

See Also:



1291
1292
1293
1294
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1291

def get_table_bucket(params = {}, options = {})
  req = build_request(:get_table_bucket, params)
  req.send_request(options)
end

#get_table_bucket_encryption(params = {}) ⇒ Types::GetTableBucketEncryptionResponse

Gets the encryption configuration for a table bucket.

Permissions

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

Examples:

Request syntax with placeholder values


resp = client.get_table_bucket_encryption({
  table_bucket_arn: "TableBucketARN", # required
})

Response structure


resp.encryption_configuration.sse_algorithm #=> String, one of "AES256", "aws:kms"
resp.encryption_configuration.kms_key_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket.

Returns:

See Also:



1325
1326
1327
1328
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1325

def get_table_bucket_encryption(params = {}, options = {})
  req = build_request(:get_table_bucket_encryption, params)
  req.send_request(options)
end

#get_table_bucket_maintenance_configuration(params = {}) ⇒ Types::GetTableBucketMaintenanceConfigurationResponse

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

Permissions

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

Examples:

Request syntax with placeholder values


resp = client.get_table_bucket_maintenance_configuration({
  table_bucket_arn: "TableBucketARN", # required
})

Response structure


resp.table_bucket_arn #=> String
resp.configuration #=> Hash
resp.configuration["TableBucketMaintenanceType"].status #=> String, one of "enabled", "disabled"
resp.configuration["TableBucketMaintenanceType"].settings.iceberg_unreferenced_file_removal.unreferenced_days #=> Integer
resp.configuration["TableBucketMaintenanceType"].settings.iceberg_unreferenced_file_removal.non_current_days #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket associated with the maintenance configuration.

Returns:

See Also:



1370
1371
1372
1373
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1370

def get_table_bucket_maintenance_configuration(params = {}, options = {})
  req = build_request(:get_table_bucket_maintenance_configuration, params)
  req.send_request(options)
end

#get_table_bucket_metrics_configuration(params = {}) ⇒ Types::GetTableBucketMetricsConfigurationResponse

Gets the metrics configuration for a table bucket.

Permissions

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

Examples:

Request syntax with placeholder values


resp = client.get_table_bucket_metrics_configuration({
  table_bucket_arn: "TableBucketARN", # required
})

Response structure


resp.table_bucket_arn #=> String
resp.id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket.

Returns:

See Also:



1405
1406
1407
1408
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1405

def get_table_bucket_metrics_configuration(params = {}, options = {})
  req = build_request(:get_table_bucket_metrics_configuration, params)
  req.send_request(options)
end

#get_table_bucket_policy(params = {}) ⇒ Types::GetTableBucketPolicyResponse

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.

Examples:

Request syntax with placeholder values


resp = client.get_table_bucket_policy({
  table_bucket_arn: "TableBucketARN", # required
})

Response structure


resp.resource_policy #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket.

Returns:

See Also:



1444
1445
1446
1447
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1444

def get_table_bucket_policy(params = {}, options = {})
  req = build_request(:get_table_bucket_policy, params)
  req.send_request(options)
end

#get_table_bucket_replication(params = {}) ⇒ Types::GetTableBucketReplicationResponse

Retrieves the replication configuration for a table bucket.This operation returns the IAM role, versionToken, and replication rules that define how tables in this bucket are replicated to other buckets.

Permissions

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

Examples:

Request syntax with placeholder values


resp = client.get_table_bucket_replication({
  table_bucket_arn: "TableBucketARN", # required
})

Response structure


resp.version_token #=> String
resp.configuration.role #=> String
resp.configuration.rules #=> Array
resp.configuration.rules[0].destinations #=> Array
resp.configuration.rules[0].destinations[0].destination_table_bucket_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket.

Returns:

See Also:



1484
1485
1486
1487
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1484

def get_table_bucket_replication(params = {}, options = {})
  req = build_request(:get_table_bucket_replication, params)
  req.send_request(options)
end

#get_table_bucket_storage_class(params = {}) ⇒ Types::GetTableBucketStorageClassResponse

Retrieves the storage class configuration for a specific table. This allows you to view the storage class settings that apply to an individual table, which may differ from the table bucket's default configuration.

Permissions

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

Examples:

Request syntax with placeholder values


resp = client.get_table_bucket_storage_class({
  table_bucket_arn: "TableBucketARN", # required
})

Response structure


resp.storage_class_configuration.storage_class #=> String, one of "STANDARD", "INTELLIGENT_TIERING"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket.

Returns:

See Also:



1520
1521
1522
1523
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1520

def get_table_bucket_storage_class(params = {}, options = {})
  req = build_request(:get_table_bucket_storage_class, params)
  req.send_request(options)
end

#get_table_encryption(params = {}) ⇒ Types::GetTableEncryptionResponse

Gets the encryption configuration for a table.

Permissions

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

Examples:

Request syntax with placeholder values


resp = client.get_table_encryption({
  table_bucket_arn: "TableBucketARN", # required
  namespace: "NamespaceName", # required
  name: "TableName", # required
})

Response structure


resp.encryption_configuration.sse_algorithm #=> String, one of "AES256", "aws:kms"
resp.encryption_configuration.kms_key_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket containing the table.

  • :namespace (required, String) —

    The namespace associated with the table.

  • :name (required, String) —

    The name of the table.

Returns:

See Also:



1563
1564
1565
1566
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1563

def get_table_encryption(params = {}, options = {})
  req = build_request(:get_table_encryption, params)
  req.send_request(options)
end

#get_table_maintenance_configuration(params = {}) ⇒ Types::GetTableMaintenanceConfigurationResponse

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

Permissions

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

  • You must have the s3tables:GetTableData permission to use set the compaction strategy to sort or zorder.

Examples:

Request syntax with placeholder values


resp = client.get_table_maintenance_configuration({
  table_bucket_arn: "TableBucketARN", # required
  namespace: "NamespaceName", # required
  name: "TableName", # required
})

Response structure


resp.table_arn #=> String
resp.configuration #=> Hash
resp.configuration["TableMaintenanceType"].status #=> String, one of "enabled", "disabled"
resp.configuration["TableMaintenanceType"].settings.iceberg_compaction.target_file_size_mb #=> Integer
resp.configuration["TableMaintenanceType"].settings.iceberg_compaction.strategy #=> String, one of "auto", "binpack", "sort", "z-order"
resp.configuration["TableMaintenanceType"].settings.iceberg_snapshot_management.min_snapshots_to_keep #=> Integer
resp.configuration["TableMaintenanceType"].settings.iceberg_snapshot_management.max_snapshot_age_hours #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket.

  • :namespace (required, String) —

    The namespace associated with the table.

  • :name (required, String) —

    The name of the table.

Returns:

See Also:



1619
1620
1621
1622
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1619

def get_table_maintenance_configuration(params = {}, options = {})
  req = build_request(:get_table_maintenance_configuration, params)
  req.send_request(options)
end

#get_table_maintenance_job_status(params = {}) ⇒ Types::GetTableMaintenanceJobStatusResponse

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.

Examples:

Request syntax with placeholder values


resp = client.get_table_maintenance_job_status({
  table_bucket_arn: "TableBucketARN", # required
  namespace: "NamespaceName", # required
  name: "TableName", # required
})

Response structure


resp.table_arn #=> String
resp.status #=> Hash
resp.status["TableMaintenanceJobType"].status #=> String, one of "Not_Yet_Run", "Successful", "Failed", "Disabled"
resp.status["TableMaintenanceJobType"].last_run_timestamp #=> Time
resp.status["TableMaintenanceJobType"].failure_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket.

  • :namespace (required, String) —

    The name of the namespace the table is associated with.

  • :name (required, String) —

    The name of the table containing the maintenance job status you want to check.

Returns:

See Also:



1672
1673
1674
1675
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1672

def get_table_maintenance_job_status(params = {}, options = {})
  req = build_request(:get_table_maintenance_job_status, params)
  req.send_request(options)
end

#get_table_metadata_location(params = {}) ⇒ Types::GetTableMetadataLocationResponse

Gets the location of the table metadata.

Permissions

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

Examples:

Request syntax with placeholder values


resp = client.get_table_metadata_location({
  table_bucket_arn: "TableBucketARN", # required
  namespace: "NamespaceName", # required
  name: "TableName", # required
})

Response structure


resp.version_token #=> String
resp.metadata_location #=> String
resp.warehouse_location #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket.

  • :namespace (required, String) —

    The namespace of the table.

  • :name (required, String) —

    The name of the table.

Returns:

See Also:



1717
1718
1719
1720
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1717

def get_table_metadata_location(params = {}, options = {})
  req = build_request(:get_table_metadata_location, params)
  req.send_request(options)
end

#get_table_policy(params = {}) ⇒ Types::GetTablePolicyResponse

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.

Examples:

Request syntax with placeholder values


resp = client.get_table_policy({
  table_bucket_arn: "TableBucketARN", # required
  namespace: "NamespaceName", # required
  name: "TableName", # required
})

Response structure


resp.resource_policy #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket that contains the table.

  • :namespace (required, String) —

    The namespace associated with the table.

  • :name (required, String) —

    The name of the table.

Returns:

See Also:



1764
1765
1766
1767
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1764

def get_table_policy(params = {}, options = {})
  req = build_request(:get_table_policy, params)
  req.send_request(options)
end

#get_table_record_expiration_configuration(params = {}) ⇒ Types::GetTableRecordExpirationConfigurationResponse

Retrieves the expiration configuration settings for records in a table, and the status of the configuration. If the status of the configuration is enabled, records expire and are automatically removed from the table after the specified number of days.

Permissions

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

Examples:

Request syntax with placeholder values


resp = client.get_table_record_expiration_configuration({
  table_arn: "TableARN", # required
})

Response structure


resp.configuration.status #=> String, one of "enabled", "disabled"
resp.configuration.settings.days #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_arn (required, String) —

    The Amazon Resource Name (ARN) of the table.

Returns:

See Also:



1801
1802
1803
1804
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1801

def get_table_record_expiration_configuration(params = {}, options = {})
  req = build_request(:get_table_record_expiration_configuration, params)
  req.send_request(options)
end

#get_table_record_expiration_job_status(params = {}) ⇒ Types::GetTableRecordExpirationJobStatusResponse

Retrieves the status, metrics, and details of the latest record expiration job for a table. This includes when the job ran, and whether it succeeded or failed. If the job ran successfully, this also includes statistics about the records that were removed.

Permissions

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

Examples:

Request syntax with placeholder values


resp = client.get_table_record_expiration_job_status({
  table_arn: "TableARN", # required
})

Response structure


resp.status #=> String, one of "NotYetRun", "Successful", "Failed", "Disabled"
resp.last_run_timestamp #=> Time
resp.failure_message #=> String
resp.metrics.deleted_data_files #=> Integer
resp.metrics.deleted_records #=> Integer
resp.metrics.removed_files_size #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_arn (required, String) —

    The Amazon Resource Name (ARN) of the table.

Returns:

See Also:



1845
1846
1847
1848
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1845

def get_table_record_expiration_job_status(params = {}, options = {})
  req = build_request(:get_table_record_expiration_job_status, params)
  req.send_request(options)
end

#get_table_replication(params = {}) ⇒ Types::GetTableReplicationResponse

Retrieves the replication configuration for a specific table.

Permissions

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

Examples:

Request syntax with placeholder values


resp = client.get_table_replication({
  table_arn: "TableARN", # required
})

Response structure


resp.version_token #=> String
resp.configuration.role #=> String
resp.configuration.rules #=> Array
resp.configuration.rules[0].destinations #=> Array
resp.configuration.rules[0].destinations[0].destination_table_bucket_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_arn (required, String) —

    The Amazon Resource Name (ARN) of the table.

Returns:

See Also:



1883
1884
1885
1886
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1883

def get_table_replication(params = {}, options = {})
  req = build_request(:get_table_replication, params)
  req.send_request(options)
end

#get_table_replication_status(params = {}) ⇒ Types::GetTableReplicationStatusResponse

Retrieves the replication status for a table, including the status of replication to each destination. This operation provides visibility into replication health and progress.

Permissions

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

Examples:

Request syntax with placeholder values


resp = client.get_table_replication_status({
  table_arn: "TableARN", # required
})

Response structure


resp.source_table_arn #=> String
resp.destinations #=> Array
resp.destinations[0].replication_status #=> String, one of "pending", "completed", "failed"
resp.destinations[0].destination_table_bucket_arn #=> String
resp.destinations[0].destination_table_arn #=> String
resp.destinations[0].last_successful_replicated_update.metadata_location #=> String
resp.destinations[0].last_successful_replicated_update.timestamp #=> Time
resp.destinations[0].failure_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_arn (required, String) —

    The Amazon Resource Name (ARN) of the table.

Returns:

See Also:



1926
1927
1928
1929
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1926

def get_table_replication_status(params = {}, options = {})
  req = build_request(:get_table_replication_status, params)
  req.send_request(options)
end

#get_table_storage_class(params = {}) ⇒ Types::GetTableStorageClassResponse

Retrieves the storage class configuration for a specific table. This allows you to view the storage class settings that apply to an individual table, which may differ from the table bucket's default configuration.

Permissions

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

Examples:

Request syntax with placeholder values


resp = client.get_table_storage_class({
  table_bucket_arn: "TableBucketARN", # required
  namespace: "NamespaceName", # required
  name: "TableName", # required
})

Response structure


resp.storage_class_configuration.storage_class #=> String, one of "STANDARD", "INTELLIGENT_TIERING"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket that contains the table.

  • :namespace (required, String) —

    The namespace associated with the table.

  • :name (required, String) —

    The name of the table.

Returns:

See Also:



1971
1972
1973
1974
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1971

def get_table_storage_class(params = {}, options = {})
  req = build_request(:get_table_storage_class, params)
  req.send_request(options)
end

#list_namespaces(params = {}) ⇒ Types::ListNamespacesResponse

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_namespaces({
  table_bucket_arn: "TableBucketARN", # required
  prefix: "ListNamespacesRequestPrefixString",
  continuation_token: "NextToken",
  max_namespaces: 1,
})

Response structure


resp.namespaces #=> Array
resp.namespaces[0].namespace #=> Array
resp.namespaces[0].namespace[0] #=> String
resp.namespaces[0].created_at #=> Time
resp.namespaces[0].created_by #=> String
resp.namespaces[0]. #=> String
resp.namespaces[0].namespace_id #=> String
resp.namespaces[0].table_bucket_id #=> String
resp.continuation_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket.

  • :prefix (String) —

    The prefix of the namespaces.

  • :continuation_token (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.

  • :max_namespaces (Integer) —

    The maximum number of namespaces to return in the list.

Returns:

See Also:



2036
2037
2038
2039
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2036

def list_namespaces(params = {}, options = {})
  req = build_request(:list_namespaces, params)
  req.send_request(options)
end

#list_table_buckets(params = {}) ⇒ Types::ListTableBucketsResponse

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_table_buckets({
  prefix: "ListTableBucketsRequestPrefixString",
  continuation_token: "NextToken",
  max_buckets: 1,
  type: "customer", # accepts customer, aws
})

Response structure


resp.table_buckets #=> Array
resp.table_buckets[0].arn #=> String
resp.table_buckets[0].name #=> String
resp.table_buckets[0]. #=> String
resp.table_buckets[0].created_at #=> Time
resp.table_buckets[0].table_bucket_id #=> String
resp.table_buckets[0].type #=> String, one of "customer", "aws"
resp.continuation_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :prefix (String) —

    The prefix of the table buckets.

  • :continuation_token (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.

  • :max_buckets (Integer) —

    The maximum number of table buckets to return in the list.

  • :type (String) —

    The type of table buckets to filter by in the list.

Returns:

See Also:



2099
2100
2101
2102
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2099

def list_table_buckets(params = {}, options = {})
  req = build_request(:list_table_buckets, params)
  req.send_request(options)
end

#list_tables(params = {}) ⇒ Types::ListTablesResponse

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_tables({
  table_bucket_arn: "TableBucketARN", # required
  namespace: "NamespaceName",
  prefix: "ListTablesRequestPrefixString",
  continuation_token: "NextToken",
  max_tables: 1,
})

Response structure


resp.tables #=> Array
resp.tables[0].namespace #=> Array
resp.tables[0].namespace[0] #=> String
resp.tables[0].name #=> String
resp.tables[0].type #=> String, one of "customer", "aws"
resp.tables[0].table_arn #=> String
resp.tables[0].created_at #=> Time
resp.tables[0].modified_at #=> Time
resp.tables[0].managed_by_service #=> String
resp.tables[0].namespace_id #=> String
resp.tables[0].table_bucket_id #=> String
resp.continuation_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon resource Name (ARN) of the table bucket.

  • :namespace (String) —

    The namespace of the tables.

  • :prefix (String) —

    The prefix of the tables.

  • :continuation_token (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.

  • :max_tables (Integer) —

    The maximum number of tables to return.

Returns:

See Also:



2170
2171
2172
2173
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2170

def list_tables(params = {}, options = {})
  req = build_request(:list_tables, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists all of the tags applied to a specified Amazon S3 Tables resource. Each tag is a label consisting of a key and value pair. Tags can help you organize, track costs for, and control access to resources.

For a list of S3 resources that support tagging, see Managing tags for Amazon S3 resources.

Permissions

For tables and table buckets, you must have the s3tables:ListTagsForResource permission to use this operation.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ResourceArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the Amazon S3 Tables resource that you want to list tags for. The tagged resource can be a table bucket or a table. For a list of all S3 resources that support tagging, see Managing tags for Amazon S3 resources.

Returns:

See Also:



2223
2224
2225
2226
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2223

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#put_table_bucket_encryption(params = {}) ⇒ Struct

Sets the encryption configuration for a table bucket.

Permissions

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

If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption in the Amazon Simple Storage Service User Guide.

Examples:

Request syntax with placeholder values


resp = client.put_table_bucket_encryption({
  table_bucket_arn: "TableBucketARN", # required
  encryption_configuration: { # required
    sse_algorithm: "AES256", # required, accepts AES256, aws:kms
    kms_key_arn: "EncryptionConfigurationKmsKeyArnString",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket.

  • :encryption_configuration (required, Types::EncryptionConfiguration) —

    The encryption configuration to apply to the table bucket.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2268
2269
2270
2271
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2268

def put_table_bucket_encryption(params = {}, options = {})
  req = build_request(:put_table_bucket_encryption, params)
  req.send_request(options)
end

#put_table_bucket_maintenance_configuration(params = {}) ⇒ Struct

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

Permissions

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

Examples:

Request syntax with placeholder values


resp = client.put_table_bucket_maintenance_configuration({
  table_bucket_arn: "TableBucketARN", # required
  type: "icebergUnreferencedFileRemoval", # required, accepts icebergUnreferencedFileRemoval
  value: { # required
    status: "enabled", # accepts enabled, disabled
    settings: {
      iceberg_unreferenced_file_removal: {
        unreferenced_days: 1,
        non_current_days: 1,
      },
    },
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket associated with the maintenance configuration.

  • :type (required, String) —

    The type of the maintenance configuration.

  • :value (required, Types::TableBucketMaintenanceConfigurationValue) —

    Defines the values of the maintenance configuration for the table bucket.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2320
2321
2322
2323
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2320

def put_table_bucket_maintenance_configuration(params = {}, options = {})
  req = build_request(:put_table_bucket_maintenance_configuration, params)
  req.send_request(options)
end

#put_table_bucket_metrics_configuration(params = {}) ⇒ Struct

Sets the metrics configuration for a table bucket.

Permissions

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

Examples:

Request syntax with placeholder values


resp = client.put_table_bucket_metrics_configuration({
  table_bucket_arn: "TableBucketARN", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2347
2348
2349
2350
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2347

def put_table_bucket_metrics_configuration(params = {}, options = {})
  req = build_request(:put_table_bucket_metrics_configuration, params)
  req.send_request(options)
end

#put_table_bucket_policy(params = {}) ⇒ Struct

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

Permissions

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

Examples:

Request syntax with placeholder values


resp = client.put_table_bucket_policy({
  table_bucket_arn: "TableBucketARN", # required
  resource_policy: "ResourcePolicy", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket.

  • :resource_policy (required, String) —

    The JSON that defines the policy.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2384
2385
2386
2387
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2384

def put_table_bucket_policy(params = {}, options = {})
  req = build_request(:put_table_bucket_policy, params)
  req.send_request(options)
end

#put_table_bucket_replication(params = {}) ⇒ Types::PutTableBucketReplicationResponse

Creates or updates the replication configuration for a table bucket. This operation defines how tables in the source bucket are replicated to destination buckets. Replication helps ensure data availability and disaster recovery across regions or accounts.

Permissions

  • You must have the s3tables:PutTableBucketReplication permission to use this operation. The IAM role specified in the configuration must have permissions to read from the source bucket and write permissions to all destination buckets.

  • You must also have the following permissions:

    • s3tables:GetTable permission on the source table.

    • s3tables:ListTables permission on the bucket containing the table.

    • s3tables:CreateTable permission for the destination.

    • s3tables:CreateNamespace permission for the destination.

    • s3tables:GetTableMaintenanceConfig permission for the source bucket.

    • s3tables:PutTableMaintenanceConfig permission for the destination bucket.

  • You must have iam:PassRole permission with condition allowing roles to be passed to replication.s3tables.amazonaws.com.

Examples:

Request syntax with placeholder values


resp = client.put_table_bucket_replication({
  table_bucket_arn: "TableBucketARN", # required
  version_token: "VersionToken",
  configuration: { # required
    role: "IAMRole", # required
    rules: [ # required
      {
        destinations: [ # required
          {
            destination_table_bucket_arn: "TableBucketARN", # required
          },
        ],
      },
    ],
  },
})

Response structure


resp.version_token #=> String
resp.status #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the source table bucket.

  • :version_token (String) —

    A version token from a previous GetTableBucketReplication call. Use this token to ensure you're updating the expected version of the configuration.

  • :configuration (required, Types::TableBucketReplicationConfiguration) —

    The replication configuration to apply, including the IAM role and replication rules.

Returns:

See Also:



2464
2465
2466
2467
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2464

def put_table_bucket_replication(params = {}, options = {})
  req = build_request(:put_table_bucket_replication, params)
  req.send_request(options)
end

#put_table_bucket_storage_class(params = {}) ⇒ Struct

Sets or updates the storage class configuration for a table bucket. This configuration serves as the default storage class for all new tables created in the bucket, allowing you to optimize storage costs at the bucket level.

Permissions

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

Examples:

Request syntax with placeholder values


resp = client.put_table_bucket_storage_class({
  table_bucket_arn: "TableBucketARN", # required
  storage_class_configuration: { # required
    storage_class: "STANDARD", # required, accepts STANDARD, INTELLIGENT_TIERING
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket.

  • :storage_class_configuration (required, Types::StorageClassConfiguration) —

    The storage class configuration to apply to the table bucket. This configuration will serve as the default for new tables created in this bucket.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2502
2503
2504
2505
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2502

def put_table_bucket_storage_class(params = {}, options = {})
  req = build_request(:put_table_bucket_storage_class, params)
  req.send_request(options)
end

#put_table_maintenance_configuration(params = {}) ⇒ Struct

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

Permissions

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

Examples:

Request syntax with placeholder values


resp = client.put_table_maintenance_configuration({
  table_bucket_arn: "TableBucketARN", # required
  namespace: "NamespaceName", # required
  name: "TableName", # required
  type: "icebergCompaction", # required, accepts icebergCompaction, icebergSnapshotManagement
  value: { # required
    status: "enabled", # accepts enabled, disabled
    settings: {
      iceberg_compaction: {
        target_file_size_mb: 1,
        strategy: "auto", # accepts auto, binpack, sort, z-order
      },
      iceberg_snapshot_management: {
        min_snapshots_to_keep: 1,
        max_snapshot_age_hours: 1,
      },
    },
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table associated with the maintenance configuration.

  • :namespace (required, String) —

    The namespace of the table.

  • :name (required, String) —

    The name of the table.

  • :type (required, String) —

    The type of the maintenance configuration.

  • :value (required, Types::TableMaintenanceConfigurationValue) —

    Defines the values of the maintenance configuration for the table.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2565
2566
2567
2568
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2565

def put_table_maintenance_configuration(params = {}, options = {})
  req = build_request(:put_table_maintenance_configuration, params)
  req.send_request(options)
end

#put_table_policy(params = {}) ⇒ Struct

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

Permissions

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

Examples:

Request syntax with placeholder values


resp = client.put_table_policy({
  table_bucket_arn: "TableBucketARN", # required
  namespace: "NamespaceName", # required
  name: "TableName", # required
  resource_policy: "ResourcePolicy", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket that contains the table.

  • :namespace (required, String) —

    The namespace associated with the table.

  • :name (required, String) —

    The name of the table.

  • :resource_policy (required, String) —

    The JSON that defines the policy.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2611
2612
2613
2614
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2611

def put_table_policy(params = {}, options = {})
  req = build_request(:put_table_policy, params)
  req.send_request(options)
end

#put_table_record_expiration_configuration(params = {}) ⇒ Struct

Creates or updates the expiration configuration settings for records in a table, including the status of the configuration. If you enable record expiration for a table, records expire and are automatically removed from the table after the number of days that you specify.

Permissions

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

Examples:

Request syntax with placeholder values


resp = client.put_table_record_expiration_configuration({
  table_arn: "TableARN", # required
  value: { # required
    status: "enabled", # accepts enabled, disabled
    settings: {
      days: 1,
    },
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_arn (required, String) —

    The Amazon Resource Name (ARN) of the table.

  • :value (required, Types::TableRecordExpirationConfigurationValue) —

    The record expiration configuration to apply to the table, including the status (enabled or disabled) and retention period in days.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2651
2652
2653
2654
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2651

def put_table_record_expiration_configuration(params = {}, options = {})
  req = build_request(:put_table_record_expiration_configuration, params)
  req.send_request(options)
end

#put_table_replication(params = {}) ⇒ Types::PutTableReplicationResponse

Creates or updates the replication configuration for a specific table. This operation allows you to define table-level replication independently of bucket-level replication, providing granular control over which tables are replicated and where.

Permissions

  • You must have the s3tables:PutTableReplication permission to use this operation. The IAM role specified in the configuration must have permissions to read from the source table and write to all destination tables.

  • You must also have the following permissions:

    • s3tables:GetTable permission on the source table being replicated.

    • s3tables:CreateTable permission for the destination.

    • s3tables:CreateNamespace permission for the destination.

    • s3tables:GetTableMaintenanceConfig permission for the source table.

    • s3tables:PutTableMaintenanceConfig permission for the destination table.

  • You must have iam:PassRole permission with condition allowing roles to be passed to replication.s3tables.amazonaws.com.

Examples:

Request syntax with placeholder values


resp = client.put_table_replication({
  table_arn: "TableARN", # required
  version_token: "String",
  configuration: { # required
    role: "IAMRole", # required
    rules: [ # required
      {
        destinations: [ # required
          {
            destination_table_bucket_arn: "TableBucketARN", # required
          },
        ],
      },
    ],
  },
})

Response structure


resp.version_token #=> String
resp.status #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_arn (required, String) —

    The Amazon Resource Name (ARN) of the source table.

  • :version_token (String) —

    A version token from a previous GetTableReplication call. Use this token to ensure you're updating the expected version of the configuration.

  • :configuration (required, Types::TableReplicationConfiguration) —

    The replication configuration to apply to the table, including the IAM role and replication rules.

Returns:

See Also:



2729
2730
2731
2732
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2729

def put_table_replication(params = {}, options = {})
  req = build_request(:put_table_replication, params)
  req.send_request(options)
end

#rename_table(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.rename_table({
  table_bucket_arn: "TableBucketARN", # required
  namespace: "NamespaceName", # required
  name: "TableName", # required
  new_namespace_name: "NamespaceName",
  new_name: "TableName",
  version_token: "VersionToken",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket.

  • :namespace (required, String) —

    The namespace associated with the table.

  • :name (required, String) —

    The current name of the table.

  • :new_namespace_name (String) —

    The new name for the namespace.

  • :new_name (String) —

    The new name for the table.

  • :version_token (String) —

    The version token of the table.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2781
2782
2783
2784
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2781

def rename_table(params = {}, options = {})
  req = build_request(:rename_table, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Applies one or more user-defined tags to an Amazon S3 Tables resource or updates existing tags. Each tag is a label consisting of a key and value pair. Tags can help you organize, track costs for, and control access to your resources. You can add up to 50 tags for each S3 resource.

For a list of S3 resources that support tagging, see Managing tags for Amazon S3 resources.

Permissions

For tables and table buckets, you must have the s3tables:TagResource permission to use this operation.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ResourceArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2840
2841
2842
2843
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2840

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes the specified user-defined tags from an Amazon S3 Tables resource. You can pass one or more tag keys.

For a list of S3 resources that support tagging, see Managing tags for Amazon S3 resources.

Permissions

For tables and table buckets, you must have the s3tables:UntagResource permission to use this operation.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2894
2895
2896
2897
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2894

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_table_metadata_location(params = {}) ⇒ Types::UpdateTableMetadataLocationResponse

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.

Examples:

Request syntax with placeholder values


resp = client.update_table_metadata_location({
  table_bucket_arn: "TableBucketARN", # required
  namespace: "NamespaceName", # required
  name: "TableName", # required
  version_token: "VersionToken", # required
  metadata_location: "MetadataLocation", # required
})

Response structure


resp.name #=> String
resp.table_arn #=> String
resp.namespace #=> Array
resp.namespace[0] #=> String
resp.version_token #=> String
resp.metadata_location #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :table_bucket_arn (required, String) —

    The Amazon Resource Name (ARN) of the table bucket.

  • :namespace (required, String) —

    The namespace of the table.

  • :name (required, String) —

    The name of the table.

  • :version_token (required, String) —

    The version token of the table.

  • :metadata_location (required, String) —

    The new metadata location for the table.

Returns:

See Also:



2956
2957
2958
2959
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2956

def update_table_metadata_location(params = {}, options = {})
  req = build_request(:update_table_metadata_location, params)
  req.send_request(options)
end