SDK for PHP V3

Client: Aws\S3Tables\S3TablesClient
Service ID: s3tables
Version: 2018-05-10

This page describes the parameters and results for the operations of the Amazon S3 Tables (2018-05-10), and shows how to use the Aws\S3Tables\S3TablesClient object to call the described operations. This documentation is specific to the 2018-05-10 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CompleteTableMigration ( array $params = [] )
Completes the migration of a table.
CreateNamespace ( array $params = [] )
Creates a namespace.
CreateTable ( array $params = [] )
Creates a new table associated with the given namespace in a table bucket.
CreateTableBucket ( array $params = [] )
Creates a table bucket.
DeleteNamespace ( array $params = [] )
Deletes a namespace.
DeleteTable ( array $params = [] )
Deletes a table.
DeleteTableBucket ( array $params = [] )
Deletes a table bucket.
DeleteTableBucketEncryption ( array $params = [] )
Deletes the encryption configuration for a table bucket.
DeleteTableBucketMetricsConfiguration ( array $params = [] )
Deletes the metrics configuration for a table bucket.
DeleteTableBucketPolicy ( array $params = [] )
Deletes a table bucket policy.
DeleteTableBucketReplication ( array $params = [] )
Deletes the replication configuration for a table bucket.
DeleteTablePolicy ( array $params = [] )
Deletes a table policy.
DeleteTableReplication ( array $params = [] )
Deletes the replication configuration for a specific table.
GetNamespace ( array $params = [] )
Gets details about a namespace.
GetTable ( array $params = [] )
Gets details about a table.
GetTableBucket ( array $params = [] )
Gets details on a table bucket.
GetTableBucketEncryption ( array $params = [] )
Gets the encryption configuration for a table bucket.
GetTableBucketLogging ( array $params = [] )
Gets the server access logging configuration for a table bucket.
GetTableBucketMaintenanceConfiguration ( array $params = [] )
Gets details about a maintenance configuration for a given table bucket.
GetTableBucketMetricsConfiguration ( array $params = [] )
Gets the metrics configuration for a table bucket.
GetTableBucketPolicy ( array $params = [] )
Gets details about a table bucket policy.
GetTableBucketReplication ( array $params = [] )
Retrieves the replication configuration for a table bucket.
GetTableBucketStorageClass ( array $params = [] )
Retrieves the storage class configuration for a specific table.
GetTableEncryption ( array $params = [] )
Gets the encryption configuration for a table.
GetTableMaintenanceConfiguration ( array $params = [] )
Gets details about the maintenance configuration of a table.
GetTableMaintenanceJobStatus ( array $params = [] )
Gets the status of a maintenance job for a table.
GetTableMetadataLocation ( array $params = [] )
Gets the location of the table metadata.
GetTableMigration ( array $params = [] )
Gets the details of a migration, including its state, the reason it failed, its statistics and the location of its reports.
GetTablePolicy ( array $params = [] )
Gets details about a table policy.
GetTableRecordExpirationConfiguration ( array $params = [] )
Retrieves the expiration configuration settings for records in a table, and the status of the configuration.
GetTableRecordExpirationJobStatus ( array $params = [] )
Retrieves the status, metrics, and details of the latest record expiration job for a table.
GetTableReplication ( array $params = [] )
Retrieves the replication configuration for a specific table.
GetTableReplicationStatus ( array $params = [] )
Retrieves the replication status for a table, including the status of replication to each destination.
GetTableStorageClass ( array $params = [] )
Retrieves the storage class configuration for a specific table.
ListNamespaces ( array $params = [] )
Lists the namespaces within a table bucket.
ListTableBuckets ( array $params = [] )
Lists table buckets for your account.
ListTableMigrations ( array $params = [] )
Lists the migrations whose destination is in a table bucket, a namespace or a table.
ListTables ( array $params = [] )
List tables in the given table bucket.
ListTagsForResource ( array $params = [] )
Lists all of the tags applied to a specified Amazon S3 Tables resource.
PutTableBucketEncryption ( array $params = [] )
Sets the encryption configuration for a table bucket.
PutTableBucketLogging ( array $params = [] )
Sets, updates, or removes the server access logging configuration for a table bucket.
PutTableBucketMaintenanceConfiguration ( array $params = [] )
Creates a new maintenance configuration or replaces an existing maintenance configuration for a table bucket.
PutTableBucketMetricsConfiguration ( array $params = [] )
Sets the metrics configuration for a table bucket.
PutTableBucketPolicy ( array $params = [] )
Creates a new table bucket policy or replaces an existing table bucket policy for a table bucket.
PutTableBucketReplication ( array $params = [] )
Creates or updates the replication configuration for a table bucket.
PutTableBucketStorageClass ( array $params = [] )
Sets or updates the storage class configuration for a table bucket.
PutTableMaintenanceConfiguration ( array $params = [] )
Creates a new maintenance configuration or replaces an existing maintenance configuration for a table.
PutTablePolicy ( array $params = [] )
Creates a new table policy or replaces an existing table policy for a table.
PutTableRecordExpirationConfiguration ( array $params = [] )
Creates or updates the expiration configuration settings for records in a table, including the status of the configuration.
PutTableReplication ( array $params = [] )
Creates or updates the replication configuration for a specific table.
RenameTable ( array $params = [] )
Renames a table or a namespace.
StartTableMigration ( array $params = [] )
Starts migrating an Amazon Web Services Glue Data Catalog table into a new table in a table bucket.
SyncTableMigration ( array $params = [] )
Migrates the changes in the source table since the previous start or sync, such as added and deleted source objects, into the destination table.
TagResource ( array $params = [] )
Applies one or more user-defined tags to an Amazon S3 Tables resource or updates existing tags.
UntagResource ( array $params = [] )
Removes the specified user-defined tags from an Amazon S3 Tables resource.
UpdateTableMetadataLocation ( array $params = [] )
Updates the metadata location for a table.
UpdateTableMigration ( array $params = [] )
Requests a state change for a migration.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListNamespaces
ListTableBuckets
ListTableMigrations
ListTables

Operations

CompleteTableMigration

$result = $client->completeTableMigration([/* ... */]);
$promise = $client->completeTableMigrationAsync([/* ... */]);

Completes the migration of a table. The table's most recent migration must be in the succeeded, failed or cancelled state. After you complete the migration, you can't sync the table again, and you can write to and maintain the table as you do any other table: compaction starts, and unreferenced file removal follows the table bucket's configuration. You can't undo this operation. Calling it again for the same table returns a ConflictException.

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

Parameter Syntax

$result = $client->completeTableMigration([
    'tableARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
tableARN
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the migrated table to complete the migration of.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

AccessDeniedException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

CreateNamespace

$result = $client->createNamespace([/* ... */]);
$promise = $client->createNamespaceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createNamespace([
    'namespace' => ['<string>', ...], // REQUIRED
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
namespace
Required: Yes
Type: Array of strings

A name for the namespace.

tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[
    'namespace' => ['<string>', ...],
    'tableBucketARN' => '<string>',
]

Result Details

Members
namespace
Required: Yes
Type: Array of strings

The name of the namespace.

tableBucketARN
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the table bucket the namespace was created in.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

CreateTable

$result = $client->createTable([/* ... */]);
$promise = $client->createTableAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createTable([
    'encryptionConfiguration' => [
        'kmsKeyArn' => '<string>',
        'sseAlgorithm' => 'AES256|aws:kms', // REQUIRED
    ],
    'format' => 'ICEBERG', // REQUIRED
    'metadata' => [
        'iceberg' => [
            'partitionSpec' => [
                'fields' => [ // REQUIRED
                    [
                        'fieldId' => <integer>,
                        'name' => '<string>', // REQUIRED
                        'sourceId' => <integer>, // REQUIRED
                        'transform' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'specId' => <integer>,
            ],
            'properties' => ['<string>', ...],
            'schema' => [
                'fields' => [ // REQUIRED
                    [
                        'id' => <integer>,
                        'name' => '<string>', // REQUIRED
                        'required' => true || false,
                        'type' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            'schemaV2' => [
                'fields' => [ // REQUIRED
                    [
                        'doc' => '<string>',
                        'id' => <integer>, // REQUIRED
                        'name' => '<string>', // REQUIRED
                        'required' => true || false, // REQUIRED
                        'type' => [ // REQUIRED
                        ],
                    ],
                    // ...
                ],
                'identifierFieldIds' => [<integer>, ...],
                'schemaId' => <integer>,
                'type' => 'struct', // REQUIRED
            ],
            'writeOrder' => [
                'fields' => [ // REQUIRED
                    [
                        'direction' => 'asc|desc', // REQUIRED
                        'nullOrder' => 'nulls-first|nulls-last', // REQUIRED
                        'sourceId' => <integer>, // REQUIRED
                        'transform' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'orderId' => <integer>, // REQUIRED
            ],
        ],
    ],
    'name' => '<string>', // REQUIRED
    'namespace' => '<string>', // REQUIRED
    'storageClassConfiguration' => [
        'storageClass' => 'STANDARD|INTELLIGENT_TIERING', // REQUIRED
    ],
    'tableBucketARN' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
encryptionConfiguration
Type: EncryptionConfiguration structure

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.

format
Required: Yes
Type: string

The format for the table.

metadata
Type: TableMetadata structure

The metadata for the table.

name
Required: Yes
Type: string

The name for the table.

namespace
Required: Yes
Type: string

The namespace to associated with the table.

storageClassConfiguration
Type: StorageClassConfiguration structure

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.

tableBucketARN
Required: Yes
Type: string

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

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

[
    'tableARN' => '<string>',
    'versionToken' => '<string>',
]

Result Details

Members
tableARN
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the table.

versionToken
Required: Yes
Type: string

The version token of the table.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

CreateTableBucket

$result = $client->createTableBucket([/* ... */]);
$promise = $client->createTableBucketAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createTableBucket([
    'encryptionConfiguration' => [
        'kmsKeyArn' => '<string>',
        'sseAlgorithm' => 'AES256|aws:kms', // REQUIRED
    ],
    'name' => '<string>', // REQUIRED
    'storageClassConfiguration' => [
        'storageClass' => 'STANDARD|INTELLIGENT_TIERING', // REQUIRED
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
encryptionConfiguration
Type: EncryptionConfiguration structure

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.

name
Required: Yes
Type: string

The name for the table bucket.

storageClassConfiguration
Type: StorageClassConfiguration structure

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
Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

[
    'arn' => '<string>',
]

Result Details

Members
arn
Required: Yes
Type: string

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

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

DeleteNamespace

$result = $client->deleteNamespace([/* ... */]);
$promise = $client->deleteNamespaceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteNamespace([
    'namespace' => '<string>', // REQUIRED
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
namespace
Required: Yes
Type: string

The name of the namespace.

tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

DeleteTable

$result = $client->deleteTable([/* ... */]);
$promise = $client->deleteTableAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteTable([
    'name' => '<string>', // REQUIRED
    'namespace' => '<string>', // REQUIRED
    'tableBucketARN' => '<string>', // REQUIRED
    'versionToken' => '<string>',
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the table.

namespace
Required: Yes
Type: string

The namespace associated with the table.

tableBucketARN
Required: Yes
Type: string

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

versionToken
Type: string

The version token of the table.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

DeleteTableBucket

$result = $client->deleteTableBucket([/* ... */]);
$promise = $client->deleteTableBucketAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteTableBucket([
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

DeleteTableBucketEncryption

$result = $client->deleteTableBucketEncryption([/* ... */]);
$promise = $client->deleteTableBucketEncryptionAsync([/* ... */]);

Deletes the encryption configuration for a table bucket.

Permissions

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

Parameter Syntax

$result = $client->deleteTableBucketEncryption([
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

DeleteTableBucketMetricsConfiguration

$result = $client->deleteTableBucketMetricsConfiguration([/* ... */]);
$promise = $client->deleteTableBucketMetricsConfigurationAsync([/* ... */]);

Deletes the metrics configuration for a table bucket.

Permissions

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

Parameter Syntax

$result = $client->deleteTableBucketMetricsConfiguration([
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

DeleteTableBucketPolicy

$result = $client->deleteTableBucketPolicy([/* ... */]);
$promise = $client->deleteTableBucketPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteTableBucketPolicy([
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

DeleteTableBucketReplication

$result = $client->deleteTableBucketReplication([/* ... */]);
$promise = $client->deleteTableBucketReplicationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteTableBucketReplication([
    'tableBucketARN' => '<string>', // REQUIRED
    'versionToken' => '<string>',
]);

Parameter Details

Members
tableBucketARN
Required: Yes
Type: string

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

versionToken
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

AccessDeniedException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

DeleteTablePolicy

$result = $client->deleteTablePolicy([/* ... */]);
$promise = $client->deleteTablePolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteTablePolicy([
    'name' => '<string>', // REQUIRED
    'namespace' => '<string>', // REQUIRED
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The table name.

namespace
Required: Yes
Type: string

The namespace associated with the table.

tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

DeleteTableReplication

$result = $client->deleteTableReplication([/* ... */]);
$promise = $client->deleteTableReplicationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteTableReplication([
    'tableArn' => '<string>', // REQUIRED
    'versionToken' => '<string>', // REQUIRED
]);

Parameter Details

Members
tableArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the table.

versionToken
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

AccessDeniedException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

GetNamespace

$result = $client->getNamespace([/* ... */]);
$promise = $client->getNamespaceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getNamespace([
    'namespace' => '<string>', // REQUIRED
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
namespace
Required: Yes
Type: string

The name of the namespace.

tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'namespace' => ['<string>', ...],
    'namespaceId' => '<string>',
    'ownerAccountId' => '<string>',
    'tableBucketId' => '<string>',
]

Result Details

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the namespace was created at.

createdBy
Required: Yes
Type: string

The ID of the account that created the namespace.

namespace
Required: Yes
Type: Array of strings

The name of the namespace.

namespaceId
Type: string

The unique identifier of the namespace.

ownerAccountId
Required: Yes
Type: string

The ID of the account that owns the namespcace.

tableBucketId
Type: string

The unique identifier of the table bucket containing this namespace.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

AccessDeniedException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

GetTable

$result = $client->getTable([/* ... */]);
$promise = $client->getTableAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getTable([
    'name' => '<string>',
    'namespace' => '<string>',
    'tableArn' => '<string>',
    'tableBucketARN' => '<string>',
]);

Parameter Details

Members
name
Type: string

The name of the table.

namespace
Type: string

The name of the namespace the table is associated with.

tableArn
Type: string

The Amazon Resource Name (ARN) of the table.

tableBucketARN
Type: string

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

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'format' => 'ICEBERG',
    'managedByService' => '<string>',
    'managedTableInformation' => [
        'replicationInformation' => [
            'sourceTableARN' => '<string>',
        ],
    ],
    'metadataLocation' => '<string>',
    'modifiedAt' => <DateTime>,
    'modifiedBy' => '<string>',
    'name' => '<string>',
    'namespace' => ['<string>', ...],
    'namespaceId' => '<string>',
    'ownerAccountId' => '<string>',
    'tableARN' => '<string>',
    'tableBucketId' => '<string>',
    'type' => 'customer|aws',
    'versionToken' => '<string>',
    'warehouseLocation' => '<string>',
]

Result Details

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the table bucket was created at.

createdBy
Required: Yes
Type: string

The ID of the account that created the table.

format
Required: Yes
Type: string

The format of the table.

managedByService
Type: string

The service that manages the table.

managedTableInformation
Type: ManagedTableInformation structure

If this table is managed by S3 Tables, contains additional information such as replication details.

metadataLocation
Type: string

The metadata location of the table.

modifiedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the table was last modified on.

modifiedBy
Required: Yes
Type: string

The ID of the account that last modified the table.

name
Required: Yes
Type: string

The name of the table.

namespace
Required: Yes
Type: Array of strings

The namespace associated with the table.

namespaceId
Type: string

The unique identifier of the namespace containing this table.

ownerAccountId
Required: Yes
Type: string

The ID of the account that owns the table.

tableARN
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the table.

tableBucketId
Type: string

The unique identifier of the table bucket containing this table.

type
Required: Yes
Type: string

The type of the table.

versionToken
Required: Yes
Type: string

The version token of the table.

warehouseLocation
Required: Yes
Type: string

The warehouse location of the table.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

AccessDeniedException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

GetTableBucket

$result = $client->getTableBucket([/* ... */]);
$promise = $client->getTableBucketAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getTableBucket([
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'name' => '<string>',
    'ownerAccountId' => '<string>',
    'tableBucketId' => '<string>',
    'type' => 'customer|aws',
]

Result Details

Members
arn
Required: Yes
Type: string

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

createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the table bucket was created.

name
Required: Yes
Type: string

The name of the table bucket

ownerAccountId
Required: Yes
Type: string

The ID of the account that owns the table bucket.

tableBucketId
Type: string

The unique identifier of the table bucket.

type
Type: string

The type of the table bucket.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

AccessDeniedException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

GetTableBucketEncryption

$result = $client->getTableBucketEncryption([/* ... */]);
$promise = $client->getTableBucketEncryptionAsync([/* ... */]);

Gets the encryption configuration for a table bucket.

Permissions

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

Parameter Syntax

$result = $client->getTableBucketEncryption([
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[
    'encryptionConfiguration' => [
        'kmsKeyArn' => '<string>',
        'sseAlgorithm' => 'AES256|aws:kms',
    ],
]

Result Details

Members
encryptionConfiguration
Required: Yes
Type: EncryptionConfiguration structure

The encryption configuration for the table bucket.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

AccessDeniedException:

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

TooManyRequestsException:

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

BadRequestException:

The request is invalid or malformed.

GetTableBucketLogging

$result = $client->getTableBucketLogging([/* ... */]);
$promise = $client->getTableBucketLoggingAsync([/* ... */]);

Gets the server access logging configuration for a table bucket. For more information, see Server access logging for table buckets in the Amazon Simple Storage Service User Guide.

Permissions

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

Parameter Syntax

$result = $client->getTableBucketLogging([
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[
    'tableBucketLoggingStatus' => [
        'loggingEnabled' => [
            'targetBucket' => '<string>',
            'targetObjectKeyFormat' => [
                'partitionedPrefix' => [
                    'partitionDateSource' => 'EventTime|DeliveryTime',
                ],
            ],
            'targetPrefix' => '<string>',
        ],
    ],
]

Result Details

Members
tableBucketLoggingStatus
Required: Yes
Type: TableBucketLoggingStatus structure

The logging status of the table bucket. If logging is disabled, loggingEnabled is absent.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

Examples

Example 1: To get the server access logging configuration of a table bucket

The following example gets the server access logging configuration of a table bucket that has logging enabled.

$result = $client->getTableBucketLogging([
    'tableBucketARN' => 'arn:aws:s3tables:us-east-1:111122223333:bucket/amzn-s3-demo-table-bucket',
]);

Result syntax:

[
    'tableBucketLoggingStatus' => [
        'loggingEnabled' => [
            'targetBucket' => 'amzn-s3-demo-destination-bucket',
            'targetObjectKeyFormat' => [
                'partitionedPrefix' => [
                    'partitionDateSource' => 'EventTime',
                ],
            ],
            'targetPrefix' => 'logs/',
        ],
    ],
]
Example 2: To get the server access logging configuration of a table bucket that has logging disabled

The following example gets the server access logging configuration of a table bucket that has logging disabled. The response has an empty logging status.

$result = $client->getTableBucketLogging([
    'tableBucketARN' => 'arn:aws:s3tables:us-east-1:111122223333:bucket/amzn-s3-demo-table-bucket',
]);

Result syntax:

[
    'tableBucketLoggingStatus' => [
    ],
]

GetTableBucketMaintenanceConfiguration

$result = $client->getTableBucketMaintenanceConfiguration([/* ... */]);
$promise = $client->getTableBucketMaintenanceConfigurationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getTableBucketMaintenanceConfiguration([
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[
    'configuration' => [
        '<TableBucketMaintenanceType>' => [
            'settings' => [
                'icebergUnreferencedFileRemoval' => [
                    'nonCurrentDays' => <integer>,
                    'unreferencedDays' => <integer>,
                ],
            ],
            'status' => 'enabled|disabled',
        ],
        // ...
    ],
    'tableBucketARN' => '<string>',
]

Result Details

Members
configuration
Required: Yes
Type: Associative array of custom strings keys (TableBucketMaintenanceType) to TableBucketMaintenanceConfigurationValue structures

Details about the maintenance configuration for the table bucket.

tableBucketARN
Required: Yes
Type: string

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

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

GetTableBucketMetricsConfiguration

$result = $client->getTableBucketMetricsConfiguration([/* ... */]);
$promise = $client->getTableBucketMetricsConfigurationAsync([/* ... */]);

Gets the metrics configuration for a table bucket.

Permissions

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

Parameter Syntax

$result = $client->getTableBucketMetricsConfiguration([
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[
    'id' => '<string>',
    'tableBucketARN' => '<string>',
]

Result Details

Members
id
Type: string

The unique identifier of the metrics configuration.

tableBucketARN
Required: Yes
Type: string

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

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

GetTableBucketPolicy

$result = $client->getTableBucketPolicy([/* ... */]);
$promise = $client->getTableBucketPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getTableBucketPolicy([
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[
    'resourcePolicy' => '<string>',
]

Result Details

Members
resourcePolicy
Required: Yes
Type: string

The JSON that defines the policy.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

GetTableBucketReplication

$result = $client->getTableBucketReplication([/* ... */]);
$promise = $client->getTableBucketReplicationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getTableBucketReplication([
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[
    'configuration' => [
        'role' => '<string>',
        'rules' => [
            [
                'destinations' => [
                    [
                        'destinationTableBucketARN' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'versionToken' => '<string>',
]

Result Details

Members
configuration
Required: Yes
Type: TableBucketReplicationConfiguration structure

The replication configuration for the table bucket, including the IAM role and replication rules.

versionToken
Required: Yes
Type: string

A version token that represents the current state of the replication configuration. Use this token when updating the configuration to ensure consistency.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

AccessDeniedException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

GetTableBucketStorageClass

$result = $client->getTableBucketStorageClass([/* ... */]);
$promise = $client->getTableBucketStorageClassAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getTableBucketStorageClass([
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[
    'storageClassConfiguration' => [
        'storageClass' => 'STANDARD|INTELLIGENT_TIERING',
    ],
]

Result Details

Members
storageClassConfiguration
Required: Yes
Type: StorageClassConfiguration structure

The storage class configuration for the table bucket.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

AccessDeniedException:

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

TooManyRequestsException:

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

BadRequestException:

The request is invalid or malformed.

GetTableEncryption

$result = $client->getTableEncryption([/* ... */]);
$promise = $client->getTableEncryptionAsync([/* ... */]);

Gets the encryption configuration for a table.

Permissions

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

Parameter Syntax

$result = $client->getTableEncryption([
    'name' => '<string>', // REQUIRED
    'namespace' => '<string>', // REQUIRED
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the table.

namespace
Required: Yes
Type: string

The namespace associated with the table.

tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[
    'encryptionConfiguration' => [
        'kmsKeyArn' => '<string>',
        'sseAlgorithm' => 'AES256|aws:kms',
    ],
]

Result Details

Members
encryptionConfiguration
Required: Yes
Type: EncryptionConfiguration structure

The encryption configuration for the table.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

AccessDeniedException:

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

TooManyRequestsException:

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

BadRequestException:

The request is invalid or malformed.

GetTableMaintenanceConfiguration

$result = $client->getTableMaintenanceConfiguration([/* ... */]);
$promise = $client->getTableMaintenanceConfigurationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getTableMaintenanceConfiguration([
    'name' => '<string>', // REQUIRED
    'namespace' => '<string>', // REQUIRED
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the table.

namespace
Required: Yes
Type: string

The namespace associated with the table.

tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[
    'configuration' => [
        '<TableMaintenanceType>' => [
            'settings' => [
                'icebergCompaction' => [
                    'strategy' => 'auto|binpack|sort|z-order',
                    'targetFileSizeMB' => <integer>,
                ],
                'icebergSnapshotManagement' => [
                    'maxSnapshotAgeHours' => <integer>,
                    'minSnapshotsToKeep' => <integer>,
                ],
            ],
            'status' => 'enabled|disabled',
        ],
        // ...
    ],
    'tableARN' => '<string>',
]

Result Details

Members
configuration
Required: Yes
Type: Associative array of custom strings keys (TableMaintenanceType) to TableMaintenanceConfigurationValue structures

Details about the maintenance configuration for the table bucket.

tableARN
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the table.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

GetTableMaintenanceJobStatus

$result = $client->getTableMaintenanceJobStatus([/* ... */]);
$promise = $client->getTableMaintenanceJobStatusAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getTableMaintenanceJobStatus([
    'name' => '<string>', // REQUIRED
    'namespace' => '<string>', // REQUIRED
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

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

namespace
Required: Yes
Type: string

The name of the namespace the table is associated with.

tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[
    'status' => [
        '<TableMaintenanceJobType>' => [
            'failureMessage' => '<string>',
            'lastRunTimestamp' => <DateTime>,
            'status' => 'Not_Yet_Run|Successful|Failed|Disabled',
        ],
        // ...
    ],
    'tableARN' => '<string>',
]

Result Details

Members
status
Required: Yes
Type: Associative array of custom strings keys (TableMaintenanceJobType) to TableMaintenanceJobStatusValue structures

The status of the maintenance job.

tableARN
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the table.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

GetTableMetadataLocation

$result = $client->getTableMetadataLocation([/* ... */]);
$promise = $client->getTableMetadataLocationAsync([/* ... */]);

Gets the location of the table metadata.

Permissions

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

Parameter Syntax

$result = $client->getTableMetadataLocation([
    'name' => '<string>', // REQUIRED
    'namespace' => '<string>', // REQUIRED
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the table.

namespace
Required: Yes
Type: string

The namespace of the table.

tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[
    'metadataLocation' => '<string>',
    'versionToken' => '<string>',
    'warehouseLocation' => '<string>',
]

Result Details

Members
metadataLocation
Type: string

The metadata location.

versionToken
Required: Yes
Type: string

The version token.

warehouseLocation
Required: Yes
Type: string

The warehouse location.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

GetTableMigration

$result = $client->getTableMigration([/* ... */]);
$promise = $client->getTableMigrationAsync([/* ... */]);

Gets the details of a migration, including its state, the reason it failed, its statistics and the location of its reports. Identify the migration by its migrationId, or specify the tableARN of a destination table to get that table's most recent migration.

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

Parameter Syntax

$result = $client->getTableMigration([
    'migrationId' => '<string>',
    'tableARN' => '<string>',
]);

Parameter Details

Members
migrationId
Type: string

The ID of the migration to get. Specify either migrationId or tableARN, not both.

tableARN
Type: string

The Amazon Resource Name (ARN) of the destination table. Gets the table's most recent migration. Specify either tableARN or migrationId, not both.

Result Syntax

[
    'createdAt' => <DateTime>,
    'dataMigration' => [
        'maintenanceSettings' => [
            'icebergCompaction' => [
                'strategy' => 'auto|binpack|sort|z-order',
                'targetFileSizeMB' => <integer>,
            ],
            'icebergSnapshotManagement' => [
                'maxSnapshotAgeHours' => <integer>,
                'minSnapshotsToKeep' => <integer>,
            ],
        ],
        'migrationPolicies' => [
            'incompatibleValuesPolicy' => 'fail|setNull',
            'unmatchedSourceFieldsPolicy' => 'fail|drop',
        ],
    ],
    'failureReason' => [
        'code' => 'rolePermissions|sourcePermissions|destinationPermissions|resourceNotFound|sourceNotSupported|objectMigrationReport|objectCompatibilityReport|tableCompatibilityReport|internalError|reportBucketNotSupported',
        'detail' => '<string>',
    ],
    'hasValidPlan' => true || false,
    'migrationId' => '<string>',
    'migrationOutput' => [
        'bucket' => '<string>',
        'objectCompatibilityReport' => [
            'checksumCRC64NVME' => '<string>',
            'invalidFindings' => [<integer>, ...],
            'key' => '<string>',
            'prefix' => '<string>',
        ],
        'objectMigrationReport' => [
            'checksumCRC64NVME' => '<string>',
            'invalidFindings' => [<integer>, ...],
            'key' => '<string>',
            'prefix' => '<string>',
        ],
        'tableCompatibilityReport' => [
            'checksumCRC64NVME' => '<string>',
            'invalidFindings' => [<integer>, ...],
            'key' => '<string>',
            'prefix' => '<string>',
        ],
    ],
    'migrationStats' => [
        'objectsFailedMigration' => <integer>,
        'objectsMigrated' => <integer>,
        'objectsPendingMigration' => <integer>,
    ],
    'name' => '<string>',
    'namespace' => '<string>',
    'planningStats' => [
        'objectsPlanned' => <integer>,
        'objectsScanned' => <integer>,
        'partitionCount' => <integer>,
    ],
    'reviewMigrationPlan' => true || false,
    'roleARN' => '<string>',
    'source' => [
        'glueTable' => [
            'catalogId' => '<string>',
            'databaseName' => '<string>',
            'tableName' => '<string>',
        ],
    ],
    'sourceType' => 'glueTable',
    'state' => 'new|planning|pendingReview|queued|migrating|succeeded|failed|cancelling|cancelled',
    'stateUpdatedAt' => <DateTime>,
    'tableARN' => '<string>',
    'tableBucketARN' => '<string>',
    'type' => 'start|sync',
]

Result Details

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the migration was created.

dataMigration
Required: Yes
Type: DataMigrationOverview structure

The maintenance settings and migration policies for the destination table.

failureReason
Type: MigrationFailureReason structure

The reason that the migration failed. The code names the cause, such as a migration role that S3 Tables can't assume or an Amazon Web Services Glue table that doesn't exist, or the report that lists the findings. This value is returned only when the migration is in the failed state.

hasValidPlan
Type: boolean

A Boolean value that specifies whether planning produced a plan that the migration can run. If planning hasn't finished, this value isn't returned.

migrationId
Required: Yes
Type: string

The ID of the migration.

migrationOutput
Required: Yes
Type: MigrationOutputOverview structure

The bucket and prefixes for the migration's reports, and the location of each report once it is written.

migrationStats
Type: MigrationStats structure

The number of objects that migrated, failed or are pending. These counts are set when planning finishes and updated when the migration ends.

name
Required: Yes
Type: string

The name of the destination table.

namespace
Required: Yes
Type: string

The namespace of the destination table.

planningStats
Type: PlanningStats structure

Statistics about the source and the partitions in the migration. This value is returned after planning finishes.

reviewMigrationPlan
Required: Yes
Type: boolean

A Boolean value that specifies whether the migration waits in the pendingReview state, so that you can review the compatibility reports before it migrates any data.

roleARN
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the IAM role that the migration uses.

source
Required: Yes
Type: SourceConfiguration structure

The source table of the migration.

sourceType
Required: Yes
Type: string

The type of the migration's source.

state
Required: Yes
Type: string

The state of the migration. Valid values:

  • new - S3 Tables accepted the request.

  • planning - The migration is checking the source table, its objects and the destination for compatibility, and writing the compatibility reports.

  • pendingReview - Planning finished, and the migration waits for you to continue or cancel it with UpdateTableMigration.

  • queued - The migration is waiting to start migrating data.

  • migrating - The migration is running the plan from the planning state: it copies data and commits it to the destination table. A migration reaches this state only if hasValidPlan is true.

  • succeeded - Every planned object migrated.

  • failed - The migration failed. Check failureReason for the cause.

  • cancelling - You cancelled the migration, and it is finishing the work in progress.

  • cancelled - The migration is cancelled.

A migration ends in the succeeded, failed or cancelled state. You can cancel it until it ends.

stateUpdatedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the migration's state last changed.

tableARN
Type: string

The Amazon Resource Name (ARN) of the destination table, once the migration creates it.

tableBucketARN
Required: Yes
Type: string

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

type
Required: Yes
Type: string

The type of the migration. Valid values:

  • start - A migration that StartTableMigration started.

  • sync - A migration that SyncTableMigration started.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

AccessDeniedException:

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

TooManyRequestsException:

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

BadRequestException:

The request is invalid or malformed.

GetTablePolicy

$result = $client->getTablePolicy([/* ... */]);
$promise = $client->getTablePolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getTablePolicy([
    'name' => '<string>', // REQUIRED
    'namespace' => '<string>', // REQUIRED
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the table.

namespace
Required: Yes
Type: string

The namespace associated with the table.

tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[
    'resourcePolicy' => '<string>',
]

Result Details

Members
resourcePolicy
Required: Yes
Type: string

The JSON that defines the policy.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

GetTableRecordExpirationConfiguration

$result = $client->getTableRecordExpirationConfiguration([/* ... */]);
$promise = $client->getTableRecordExpirationConfigurationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getTableRecordExpirationConfiguration([
    'tableArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
tableArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the table.

Result Syntax

[
    'configuration' => [
        'settings' => [
            'days' => <integer>,
        ],
        'status' => 'enabled|disabled',
    ],
]

Result Details

Members
configuration
Required: Yes
Type: TableRecordExpirationConfigurationValue structure

The record expiration configuration for the table, including the status and retention settings.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

MethodNotAllowedException:

The requested operation is not allowed on this resource. This may occur when attempting to modify a resource that is managed by a service or has restrictions that prevent the operation.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

BadRequestException:

The request is invalid or malformed.

GetTableRecordExpirationJobStatus

$result = $client->getTableRecordExpirationJobStatus([/* ... */]);
$promise = $client->getTableRecordExpirationJobStatusAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getTableRecordExpirationJobStatus([
    'tableArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
tableArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the table.

Result Syntax

[
    'failureMessage' => '<string>',
    'lastRunTimestamp' => <DateTime>,
    'metrics' => [
        'deletedDataFiles' => <integer>,
        'deletedRecords' => <integer>,
        'removedFilesSize' => <integer>,
    ],
    'status' => 'NotYetRun|Successful|Failed|Disabled',
]

Result Details

Members
failureMessage
Type: string

If the job failed, this field contains an error message describing the failure reason.

lastRunTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the expiration job was last executed.

metrics

Metrics about the most recent expiration job execution, including the number of records and files deleted.

status
Required: Yes
Type: string

The current status of the most recent expiration job.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

MethodNotAllowedException:

The requested operation is not allowed on this resource. This may occur when attempting to modify a resource that is managed by a service or has restrictions that prevent the operation.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

BadRequestException:

The request is invalid or malformed.

GetTableReplication

$result = $client->getTableReplication([/* ... */]);
$promise = $client->getTableReplicationAsync([/* ... */]);

Retrieves the replication configuration for a specific table.

Permissions

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

Parameter Syntax

$result = $client->getTableReplication([
    'tableArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
tableArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the table.

Result Syntax

[
    'configuration' => [
        'role' => '<string>',
        'rules' => [
            [
                'destinations' => [
                    [
                        'destinationTableBucketARN' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'versionToken' => '<string>',
]

Result Details

Members
configuration
Required: Yes
Type: TableReplicationConfiguration structure

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

versionToken
Required: Yes
Type: string

A version token that represents the current state of the table's replication configuration. Use this token when updating the configuration to ensure consistency.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

AccessDeniedException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

GetTableReplicationStatus

$result = $client->getTableReplicationStatus([/* ... */]);
$promise = $client->getTableReplicationStatusAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getTableReplicationStatus([
    'tableArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
tableArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the table.

Result Syntax

[
    'destinations' => [
        [
            'destinationTableArn' => '<string>',
            'destinationTableBucketArn' => '<string>',
            'failureMessage' => '<string>',
            'lastSuccessfulReplicatedUpdate' => [
                'metadataLocation' => '<string>',
                'timestamp' => <DateTime>,
            ],
            'replicationStatus' => 'pending|completed|failed',
        ],
        // ...
    ],
    'sourceTableArn' => '<string>',
]

Result Details

Members
destinations
Required: Yes
Type: Array of ReplicationDestinationStatusModel structures

An array of status information for each replication destination, including the current state, last successful update, and any error messages.

sourceTableArn
Required: Yes
Type: string

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

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

GetTableStorageClass

$result = $client->getTableStorageClass([/* ... */]);
$promise = $client->getTableStorageClassAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getTableStorageClass([
    'name' => '<string>', // REQUIRED
    'namespace' => '<string>', // REQUIRED
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the table.

namespace
Required: Yes
Type: string

The namespace associated with the table.

tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[
    'storageClassConfiguration' => [
        'storageClass' => 'STANDARD|INTELLIGENT_TIERING',
    ],
]

Result Details

Members
storageClassConfiguration
Required: Yes
Type: StorageClassConfiguration structure

The storage class configuration for the table.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

AccessDeniedException:

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

TooManyRequestsException:

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

BadRequestException:

The request is invalid or malformed.

ListNamespaces

$result = $client->listNamespaces([/* ... */]);
$promise = $client->listNamespacesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listNamespaces([
    'continuationToken' => '<string>',
    'maxNamespaces' => <integer>,
    'prefix' => '<string>',
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
continuationToken
Type: 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.

maxNamespaces
Type: int

The maximum number of namespaces to return in the list.

prefix
Type: string

The prefix of the namespaces.

tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[
    'continuationToken' => '<string>',
    'namespaces' => [
        [
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'namespace' => ['<string>', ...],
            'namespaceId' => '<string>',
            'ownerAccountId' => '<string>',
            'tableBucketId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
continuationToken
Type: string

The ContinuationToken for pagination of the list results.

namespaces
Required: Yes
Type: Array of NamespaceSummary structures

A list of namespaces.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

AccessDeniedException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

ListTableBuckets

$result = $client->listTableBuckets([/* ... */]);
$promise = $client->listTableBucketsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listTableBuckets([
    'continuationToken' => '<string>',
    'maxBuckets' => <integer>,
    'prefix' => '<string>',
    'type' => 'customer|aws',
]);

Parameter Details

Members
continuationToken
Type: 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.

maxBuckets
Type: int

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

prefix
Type: string

The prefix of the table buckets.

type
Type: string

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

Result Syntax

[
    'continuationToken' => '<string>',
    'tableBuckets' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'name' => '<string>',
            'ownerAccountId' => '<string>',
            'tableBucketId' => '<string>',
            'type' => 'customer|aws',
        ],
        // ...
    ],
]

Result Details

Members
continuationToken
Type: string

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

tableBuckets
Required: Yes
Type: Array of TableBucketSummary structures

A list of table buckets.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

AccessDeniedException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

ListTableMigrations

$result = $client->listTableMigrations([/* ... */]);
$promise = $client->listTableMigrationsAsync([/* ... */]);

Lists the migrations whose destination is in a table bucket, a namespace or a table. Specify a tableBucketARN to list the migrations into a table bucket, and add a namespace, or a namespace and a name, to narrow the list. Or specify a tableARN to list the migrations into a table.

Migrations are listed newest first. Results are paginated: use maxResults to set the page size, and pass the nextToken from a response to retrieve the next page of results. A page can contain fewer migrations than maxResults, or none, and still return a nextToken. Continue until a response has no nextToken.

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

Parameter Syntax

$result = $client->listTableMigrations([
    'hasValidPlan' => true || false,
    'maxResults' => <integer>,
    'name' => '<string>',
    'namespace' => '<string>',
    'nextToken' => '<string>',
    'state' => 'new|planning|pendingReview|queued|migrating|succeeded|failed|cancelling|cancelled',
    'tableARN' => '<string>',
    'tableBucketARN' => '<string>',
]);

Parameter Details

Members
hasValidPlan
Type: boolean

The hasValidPlan value to filter the list by. Migrations that are still planning aren't listed, whichever value you specify.

maxResults
Type: int

The maximum number of migrations to return, from 1 to 1,000. If you don't specify a value, the default is 100.

name
Type: string

The name of the table to list migrations for. Requires tableBucketARN and namespace.

namespace
Type: string

The namespace to list migrations for. Requires tableBucketARN.

nextToken
Type: string

The nextToken from a previous response, to get the next page of results.

state
Type: string

The state to filter the list by. For the valid values, see the state member of GetTableMigration.

tableARN
Type: string

The Amazon Resource Name (ARN) of the table to list migrations for. The list includes the migrations into this table. To also list migrations into an earlier table of the same name, specify tableBucketARN, namespace and name instead. Specify either tableARN or tableBucketARN, not both.

tableBucketARN
Type: string

The Amazon Resource Name (ARN) of the table bucket to list migrations for.

Result Syntax

[
    'migrations' => [
        [
            'createdAt' => <DateTime>,
            'hasValidPlan' => true || false,
            'migrationId' => '<string>',
            'name' => '<string>',
            'namespace' => '<string>',
            'state' => 'new|planning|pendingReview|queued|migrating|succeeded|failed|cancelling|cancelled',
            'stateUpdatedAt' => <DateTime>,
            'tableARN' => '<string>',
            'tableBucketARN' => '<string>',
            'type' => 'start|sync',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
migrations
Required: Yes
Type: Array of MigrationSummary structures

The migrations, newest first.

nextToken
Type: string

A token to pass as nextToken to get the next page of results. If there are no more results, this value isn't returned.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

AccessDeniedException:

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

TooManyRequestsException:

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

BadRequestException:

The request is invalid or malformed.

ListTables

$result = $client->listTables([/* ... */]);
$promise = $client->listTablesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listTables([
    'continuationToken' => '<string>',
    'maxTables' => <integer>,
    'namespace' => '<string>',
    'prefix' => '<string>',
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
continuationToken
Type: 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.

maxTables
Type: int

The maximum number of tables to return.

namespace
Type: string

The namespace of the tables.

prefix
Type: string

The prefix of the tables.

tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[
    'continuationToken' => '<string>',
    'tables' => [
        [
            'createdAt' => <DateTime>,
            'managedByService' => '<string>',
            'modifiedAt' => <DateTime>,
            'name' => '<string>',
            'namespace' => ['<string>', ...],
            'namespaceId' => '<string>',
            'tableARN' => '<string>',
            'tableBucketId' => '<string>',
            'type' => 'customer|aws',
        ],
        // ...
    ],
]

Result Details

Members
continuationToken
Type: string

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

tables
Required: Yes
Type: Array of TableSummary structures

A list of tables.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: 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.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members
tags
Type: Associative array of custom strings keys (TagKey) to strings

The user-defined tags that are applied to the resource. For more information, see Tagging for cost allocation or attribute-based access control (ABAC).

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

PutTableBucketEncryption

$result = $client->putTableBucketEncryption([/* ... */]);
$promise = $client->putTableBucketEncryptionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putTableBucketEncryption([
    'encryptionConfiguration' => [ // REQUIRED
        'kmsKeyArn' => '<string>',
        'sseAlgorithm' => 'AES256|aws:kms', // REQUIRED
    ],
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
encryptionConfiguration
Required: Yes
Type: EncryptionConfiguration structure

The encryption configuration to apply to the table bucket.

tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

PutTableBucketLogging

$result = $client->putTableBucketLogging([/* ... */]);
$promise = $client->putTableBucketLoggingAsync([/* ... */]);

Sets, updates, or removes the server access logging configuration for a table bucket. When logging is enabled, Amazon S3 delivers a record of the requests made to the table bucket and its tables to the target general purpose bucket that you specify. To disable logging, call this operation with an empty tableBucketLoggingStatus. For more information, see Server access logging for table buckets in the Amazon Simple Storage Service User Guide.

Permissions

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

Parameter Syntax

$result = $client->putTableBucketLogging([
    'tableBucketARN' => '<string>', // REQUIRED
    'tableBucketLoggingStatus' => [ // REQUIRED
        'loggingEnabled' => [
            'targetBucket' => '<string>', // REQUIRED
            'targetObjectKeyFormat' => [ // REQUIRED
                'partitionedPrefix' => [ // REQUIRED
                    'partitionDateSource' => 'EventTime|DeliveryTime', // REQUIRED
                ],
            ],
            'targetPrefix' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Members
tableBucketARN
Required: Yes
Type: string

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

tableBucketLoggingStatus
Required: Yes
Type: TableBucketLoggingStatus structure

The logging status to apply to the table bucket. To disable logging, specify an empty tableBucketLoggingStatus.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

Examples

Example 1: To enable server access logging for a table bucket

The following example enables server access logging for a table bucket. Logs are delivered to the specified general purpose bucket, with object keys partitioned by the time of the logged events.

$result = $client->putTableBucketLogging([
    'tableBucketARN' => 'arn:aws:s3tables:us-east-1:111122223333:bucket/amzn-s3-demo-table-bucket',
    'tableBucketLoggingStatus' => [
        'loggingEnabled' => [
            'targetBucket' => 'amzn-s3-demo-destination-bucket',
            'targetObjectKeyFormat' => [
                'partitionedPrefix' => [
                    'partitionDateSource' => 'EventTime',
                ],
            ],
            'targetPrefix' => 'logs/',
        ],
    ],
]);
Example 2: To disable server access logging for a table bucket

The following example disables server access logging for a table bucket by specifying an empty logging status.

$result = $client->putTableBucketLogging([
    'tableBucketARN' => 'arn:aws:s3tables:us-east-1:111122223333:bucket/amzn-s3-demo-table-bucket',
    'tableBucketLoggingStatus' => [
    ],
]);

PutTableBucketMaintenanceConfiguration

$result = $client->putTableBucketMaintenanceConfiguration([/* ... */]);
$promise = $client->putTableBucketMaintenanceConfigurationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putTableBucketMaintenanceConfiguration([
    'tableBucketARN' => '<string>', // REQUIRED
    'type' => 'icebergUnreferencedFileRemoval', // REQUIRED
    'value' => [ // REQUIRED
        'settings' => [
            'icebergUnreferencedFileRemoval' => [
                'nonCurrentDays' => <integer>,
                'unreferencedDays' => <integer>,
            ],
        ],
        'status' => 'enabled|disabled',
    ],
]);

Parameter Details

Members
tableBucketARN
Required: Yes
Type: string

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

type
Required: Yes
Type: string

The type of the maintenance configuration.

value
Required: Yes
Type: TableBucketMaintenanceConfigurationValue structure

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

PutTableBucketMetricsConfiguration

$result = $client->putTableBucketMetricsConfiguration([/* ... */]);
$promise = $client->putTableBucketMetricsConfigurationAsync([/* ... */]);

Sets the metrics configuration for a table bucket.

Permissions

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

Parameter Syntax

$result = $client->putTableBucketMetricsConfiguration([
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

PutTableBucketPolicy

$result = $client->putTableBucketPolicy([/* ... */]);
$promise = $client->putTableBucketPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putTableBucketPolicy([
    'resourcePolicy' => '<string>', // REQUIRED
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
resourcePolicy
Required: Yes
Type: string

The JSON that defines the policy.

tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

PutTableBucketReplication

$result = $client->putTableBucketReplication([/* ... */]);
$promise = $client->putTableBucketReplicationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putTableBucketReplication([
    'configuration' => [ // REQUIRED
        'role' => '<string>', // REQUIRED
        'rules' => [ // REQUIRED
            [
                'destinations' => [ // REQUIRED
                    [
                        'destinationTableBucketARN' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'tableBucketARN' => '<string>', // REQUIRED
    'versionToken' => '<string>',
]);

Parameter Details

Members
configuration
Required: Yes
Type: TableBucketReplicationConfiguration structure

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

tableBucketARN
Required: Yes
Type: string

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

versionToken
Type: string

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

Result Syntax

[
    'status' => '<string>',
    'versionToken' => '<string>',
]

Result Details

Members
status
Required: Yes
Type: string

The status of the replication configuration operation.

versionToken
Required: Yes
Type: string

A new version token representing the updated replication configuration.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

AccessDeniedException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

PutTableBucketStorageClass

$result = $client->putTableBucketStorageClass([/* ... */]);
$promise = $client->putTableBucketStorageClassAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putTableBucketStorageClass([
    'storageClassConfiguration' => [ // REQUIRED
        'storageClass' => 'STANDARD|INTELLIGENT_TIERING', // REQUIRED
    ],
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
storageClassConfiguration
Required: Yes
Type: StorageClassConfiguration structure

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

tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

PutTableMaintenanceConfiguration

$result = $client->putTableMaintenanceConfiguration([/* ... */]);
$promise = $client->putTableMaintenanceConfigurationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putTableMaintenanceConfiguration([
    'name' => '<string>', // REQUIRED
    'namespace' => '<string>', // REQUIRED
    'tableBucketARN' => '<string>', // REQUIRED
    'type' => 'icebergCompaction|icebergSnapshotManagement', // REQUIRED
    'value' => [ // REQUIRED
        'settings' => [
            'icebergCompaction' => [
                'strategy' => 'auto|binpack|sort|z-order',
                'targetFileSizeMB' => <integer>,
            ],
            'icebergSnapshotManagement' => [
                'maxSnapshotAgeHours' => <integer>,
                'minSnapshotsToKeep' => <integer>,
            ],
        ],
        'status' => 'enabled|disabled',
    ],
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the table.

namespace
Required: Yes
Type: string

The namespace of the table.

tableBucketARN
Required: Yes
Type: string

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

type
Required: Yes
Type: string

The type of the maintenance configuration.

value
Required: Yes
Type: TableMaintenanceConfigurationValue structure

Defines the values of the maintenance configuration for the table.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

PutTablePolicy

$result = $client->putTablePolicy([/* ... */]);
$promise = $client->putTablePolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putTablePolicy([
    'name' => '<string>', // REQUIRED
    'namespace' => '<string>', // REQUIRED
    'resourcePolicy' => '<string>', // REQUIRED
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the table.

namespace
Required: Yes
Type: string

The namespace associated with the table.

resourcePolicy
Required: Yes
Type: string

The JSON that defines the policy.

tableBucketARN
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

PutTableRecordExpirationConfiguration

$result = $client->putTableRecordExpirationConfiguration([/* ... */]);
$promise = $client->putTableRecordExpirationConfigurationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putTableRecordExpirationConfiguration([
    'tableArn' => '<string>', // REQUIRED
    'value' => [ // REQUIRED
        'settings' => [
            'days' => <integer>,
        ],
        'status' => 'enabled|disabled',
    ],
]);

Parameter Details

Members
tableArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the table.

value
Required: Yes
Type: TableRecordExpirationConfigurationValue structure

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

MethodNotAllowedException:

The requested operation is not allowed on this resource. This may occur when attempting to modify a resource that is managed by a service or has restrictions that prevent the operation.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

BadRequestException:

The request is invalid or malformed.

PutTableReplication

$result = $client->putTableReplication([/* ... */]);
$promise = $client->putTableReplicationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putTableReplication([
    'configuration' => [ // REQUIRED
        'role' => '<string>', // REQUIRED
        'rules' => [ // REQUIRED
            [
                'destinations' => [ // REQUIRED
                    [
                        'destinationTableBucketARN' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'tableArn' => '<string>', // REQUIRED
    'versionToken' => '<string>',
]);

Parameter Details

Members
configuration
Required: Yes
Type: TableReplicationConfiguration structure

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

tableArn
Required: Yes
Type: string

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

versionToken
Type: string

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

Result Syntax

[
    'status' => '<string>',
    'versionToken' => '<string>',
]

Result Details

Members
status
Required: Yes
Type: string

The status of the replication configuration operation.

versionToken
Required: Yes
Type: string

A new version token representing the updated replication configuration.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

AccessDeniedException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

RenameTable

$result = $client->renameTable([/* ... */]);
$promise = $client->renameTableAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->renameTable([
    'name' => '<string>', // REQUIRED
    'namespace' => '<string>', // REQUIRED
    'newName' => '<string>',
    'newNamespaceName' => '<string>',
    'tableBucketARN' => '<string>', // REQUIRED
    'versionToken' => '<string>',
]);

Parameter Details

Members
name
Required: Yes
Type: string

The current name of the table.

namespace
Required: Yes
Type: string

The namespace associated with the table.

newName
Type: string

The new name for the table.

newNamespaceName
Type: string

The new name for the namespace.

tableBucketARN
Required: Yes
Type: string

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

versionToken
Type: string

The version token of the table.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

StartTableMigration

$result = $client->startTableMigration([/* ... */]);
$promise = $client->startTableMigrationAsync([/* ... */]);

Starts migrating an Amazon Web Services Glue Data Catalog table into a new table in a table bucket. The migration runs asynchronously: this operation returns the migration ID and its initial state, and you track progress with GetTableMigration.

The namespace must already exist, and a table with the specified name must not. The migration creates the table during planning and commits data to it as it runs. Until you call CompleteTableMigration, you can read the table but you can't write to it. If the migration fails or is cancelled, the table and the data already committed to it remain.

The migration first checks the source and the destination, and writes the table compatibility and object compatibility reports to the bucket that you specify in migrationOutput. If you set reviewMigrationPlan to true, the migration waits in the pendingReview state so that you can review the reports, and continues only when you call UpdateTableMigration with requestedState set to queued. If you don't continue or cancel the migration within 30 days, the migration fails. Otherwise it continues to migrate the data, and writes the object migration report when the migration ends. If planning fails, the migration writes no object migration report.

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

  • You must have the iam:PassRole permission on the role that you specify in roleARN, with a condition that allows passing it to migration.s3tables.amazonaws.com. The associated resource is the table bucket.

  • If destinationTable specifies SSE-KMS encryption, you must have the kms:DescribeKey and kms:GenerateDataKey permissions on the KMS key. You must also grant the S3 Tables maintenance principal access to the key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption.

Parameter Syntax

$result = $client->startTableMigration([
    'dataMigration' => [
        'maintenanceSettings' => [
            'icebergCompaction' => [
                'strategy' => 'auto|binpack|sort|z-order',
                'targetFileSizeMB' => <integer>,
            ],
            'icebergSnapshotManagement' => [
                'maxSnapshotAgeHours' => <integer>,
                'minSnapshotsToKeep' => <integer>,
            ],
        ],
        'migrationPolicies' => [
            'incompatibleValuesPolicy' => 'fail|setNull',
            'unmatchedSourceFieldsPolicy' => 'fail|drop',
        ],
    ],
    'destinationTable' => [ // REQUIRED
        'encryptionConfiguration' => [
            'kmsKeyArn' => '<string>',
            'sseAlgorithm' => 'AES256|aws:kms', // REQUIRED
        ],
        'icebergSortOrder' => [
            'fields' => [ // REQUIRED
                [
                    'direction' => 'asc|desc', // REQUIRED
                    'nullOrder' => 'nulls-first|nulls-last', // REQUIRED
                    'sourceId' => <integer>, // REQUIRED
                    'transform' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'orderId' => <integer>, // REQUIRED
        ],
        'name' => '<string>', // REQUIRED
        'namespace' => '<string>', // REQUIRED
        'properties' => [
            'compressionCodec' => 'zstd|snappy|gzip|uncompressed',
            'dictionaryEncoding' => true || false,
            'icebergFormatVersion' => <integer>,
            'writeFormat' => 'parquet',
        ],
        'schema' => [
            'fields' => [ // REQUIRED
                [
                    'doc' => '<string>',
                    'id' => <integer>, // REQUIRED
                    'name' => '<string>', // REQUIRED
                    'required' => true || false, // REQUIRED
                    'type' => [ // REQUIRED
                    ],
                ],
                // ...
            ],
            'identifierFieldIds' => [<integer>, ...],
            'schemaId' => <integer>,
            'type' => 'struct', // REQUIRED
        ],
        'storageClassConfiguration' => [
            'storageClass' => 'STANDARD|INTELLIGENT_TIERING', // REQUIRED
        ],
        'tableBucketARN' => '<string>', // REQUIRED
        'tags' => ['<string>', ...],
    ],
    'migrationOutput' => [ // REQUIRED
        'bucket' => '<string>', // REQUIRED
        'prefixes' => [
            'objectCompatibilityReport' => '<string>',
            'objectMigrationReport' => '<string>',
            'tableCompatibilityReport' => '<string>',
        ],
    ],
    'reviewMigrationPlan' => true || false,
    'roleARN' => '<string>', // REQUIRED
    'source' => [ // REQUIRED
        'glueTable' => [
            'catalogId' => '<string>', // REQUIRED
            'databaseName' => '<string>', // REQUIRED
            'tableName' => '<string>', // REQUIRED
        ],
    ],
    'sourceType' => 'glueTable', // REQUIRED
]);

Parameter Details

Members
dataMigration
Type: DataMigrationSettings structure

The maintenance settings and migration policies for the destination table.

destinationTable
Required: Yes
Type: DestinationTable structure

The table to create and migrate the source into.

migrationOutput
Required: Yes
Type: MigrationOutputConfiguration structure

The bucket and prefixes that the migration writes its reports to. The bucket must be a general purpose bucket in your account and in the same Region as the table bucket, and the migration role must be able to write objects to it. Otherwise, the migration fails when it writes its first report.

reviewMigrationPlan
Type: boolean

Specifies whether the migration waits in the pendingReview state, so that you can review the compatibility reports before it migrates any data. If true, the migration continues when you call UpdateTableMigration with requestedState set to queued. If you don't continue or cancel the migration within 30 days, the migration fails. The default is false.

roleARN
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the IAM role that the migration uses to read the source table and its data and to write the destination table and the reports. The role must be in your account, and its trust policy must allow migration.s3tables.amazonaws.com to assume it. You can limit the trust policy to the destination table bucket with the aws:SourceArn and aws:SourceAccount condition keys.

source
Required: Yes
Type: SourceConfiguration structure

The source table to migrate.

sourceType
Required: Yes
Type: string

The type of the source. It must match the member that you set in source.

Result Syntax

[
    'migrationId' => '<string>',
    'state' => 'new|planning|pendingReview|queued|migrating|succeeded|failed|cancelling|cancelled',
]

Result Details

Members
migrationId
Required: Yes
Type: string

The ID of the migration.

state
Required: Yes
Type: string

The state of the migration when the request is accepted, such as planning.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

AccessDeniedException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

SyncTableMigration

$result = $client->syncTableMigration([/* ... */]);
$promise = $client->syncTableMigrationAsync([/* ... */]);

Migrates the changes in the source table since the previous start or sync, such as added and deleted source objects, into the destination table. The sync runs asynchronously: this operation returns the migration ID of the sync and its initial state, and you track progress with GetTableMigration.

A sync uses the source, destination and data migration settings of the table's migration, and plans the work and writes its reports in the same way as StartTableMigration. You can sync after a start or sync that succeeded, failed or was cancelled, if an earlier start or sync of the table has a valid plan (hasValidPlan). You can't sync a table while a start or sync is in progress for it, and you can sync a table until you call CompleteTableMigration for it. If a source object that an earlier migration migrated has since been overwritten, the sync fails.

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

  • You must have the iam:PassRole permission on the role that you specify in roleARN, with a condition that allows passing it to migration.s3tables.amazonaws.com. The associated resource is the table.

Parameter Syntax

$result = $client->syncTableMigration([
    'migrationOutput' => [ // REQUIRED
        'bucket' => '<string>', // REQUIRED
        'prefixes' => [
            'objectCompatibilityReport' => '<string>',
            'objectMigrationReport' => '<string>',
            'tableCompatibilityReport' => '<string>',
        ],
    ],
    'reviewMigrationPlan' => true || false,
    'roleARN' => '<string>', // REQUIRED
    'tableARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
migrationOutput
Required: Yes
Type: MigrationOutputConfiguration structure

The bucket and prefixes that the sync writes its reports to. The bucket must be a general purpose bucket in your account and in the same Region as the table bucket, and the migration role must be able to write objects to it. Otherwise, the migration fails when it writes its first report.

reviewMigrationPlan
Type: boolean

Specifies whether the sync waits in the pendingReview state, so that you can review the compatibility reports before it migrates any data. If true, the migration continues when you call UpdateTableMigration with requestedState set to queued. If you don't continue or cancel the migration within 30 days, the migration fails. The default is false.

roleARN
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the IAM role that the sync uses to read the source table and its data and to write the destination table and the reports. The role must be in your account, and its trust policy must allow migration.s3tables.amazonaws.com to assume it. You can limit the trust policy to the destination table bucket with the aws:SourceArn and aws:SourceAccount condition keys.

tableARN
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the destination table to sync. The table must have a migration, and you must not have called CompleteTableMigration for it.

Result Syntax

[
    'migrationId' => '<string>',
    'state' => 'new|planning|pendingReview|queued|migrating|succeeded|failed|cancelling|cancelled',
]

Result Details

Members
migrationId
Required: Yes
Type: string

The migration ID of the sync.

state
Required: Yes
Type: string

The state of the migration when the request is accepted, such as planning.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

AccessDeniedException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Amazon S3 Tables resource that you're applying tags to. 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.

tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

The user-defined tag that you want to add to the specified S3 Tables resource. For more information, see Tagging for cost allocation or attribute-based access control (ABAC).

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Amazon S3 Tables resource that you're removing tags from. 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.

tagKeys
Required: Yes
Type: Array of strings

The array of tag keys that you're removing from the S3 Tables resource. For more information, see Tagging for cost allocation or attribute-based access control (ABAC).

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

UpdateTableMetadataLocation

$result = $client->updateTableMetadataLocation([/* ... */]);
$promise = $client->updateTableMetadataLocationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateTableMetadataLocation([
    'metadataLocation' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'namespace' => '<string>', // REQUIRED
    'tableBucketARN' => '<string>', // REQUIRED
    'versionToken' => '<string>', // REQUIRED
]);

Parameter Details

Members
metadataLocation
Required: Yes
Type: string

The new metadata location for the table.

name
Required: Yes
Type: string

The name of the table.

namespace
Required: Yes
Type: string

The namespace of the table.

tableBucketARN
Required: Yes
Type: string

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

versionToken
Required: Yes
Type: string

The version token of the table.

Result Syntax

[
    'metadataLocation' => '<string>',
    'name' => '<string>',
    'namespace' => ['<string>', ...],
    'tableARN' => '<string>',
    'versionToken' => '<string>',
]

Result Details

Members
metadataLocation
Required: Yes
Type: string

The metadata location of the table.

name
Required: Yes
Type: string

The name of the table.

namespace
Required: Yes
Type: Array of strings

The namespace the table is associated with.

tableARN
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the table.

versionToken
Required: Yes
Type: string

The version token of the table.

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

UpdateTableMigration

$result = $client->updateTableMigration([/* ... */]);
$promise = $client->updateTableMigrationAsync([/* ... */]);

Requests a state change for a migration. Identify the migration by its migrationId or by the tableARN of its destination table.

Set requestedState to queued to continue a migration in the pendingReview state; the migration moves to queued or migrating. Set it to cancelled to cancel a migration in the new, planning, pendingReview, queued or migrating state; the migration moves to cancelling, finishes the work in progress, and then ends in the cancelled state, or in the failed state if any objects failed to migrate. Data that the migration already committed stays in the destination table.

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

Parameter Syntax

$result = $client->updateTableMigration([
    'migrationId' => '<string>',
    'requestedState' => 'queued|cancelled', // REQUIRED
    'tableARN' => '<string>',
    'updateDescription' => '<string>',
]);

Parameter Details

Members
migrationId
Type: string

The ID of the migration to update. Specify either migrationId or tableARN, not both.

requestedState
Required: Yes
Type: string

The state to move the migration to: queued to continue a migration in the pendingReview state, or cancelled to cancel a migration in the new, planning, pendingReview, queued or migrating state.

tableARN
Type: string

The Amazon Resource Name (ARN) of the destination table. Updates the table's most recent migration. Until the migration creates the destination table, specify migrationId. Specify either tableARN or migrationId, not both.

updateDescription
Type: string

A description of the update, up to 1,024 characters, with no control characters. GetTableMigration doesn't return it.

Result Syntax

[
    'migrationId' => '<string>',
    'state' => 'new|planning|pendingReview|queued|migrating|succeeded|failed|cancelling|cancelled',
    'tableARN' => '<string>',
]

Result Details

Members
migrationId
Required: Yes
Type: string

The ID of the migration.

state
Required: Yes
Type: string

The state of the migration after the update, such as queued, migrating or cancelling.

tableARN
Type: string

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

Errors

InternalServerErrorException:

The request failed due to an internal server error.

ForbiddenException:

The caller isn't authorized to make the request.

NotFoundException:

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

AccessDeniedException:

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

TooManyRequestsException:

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

ConflictException:

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

BadRequestException:

The request is invalid or malformed.

Shapes

AccessDeniedException

Description

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

Members
message
Type: string

BadRequestException

Description

The request is invalid or malformed.

Members
message
Type: string

ConflictException

Description

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

Members
message
Type: string

DataMigrationOverview

Description

The maintenance settings and migration policies for the destination table.

Members
maintenanceSettings
Required: Yes
Type: MaintenanceSettings structure

The maintenance settings for the destination table. The migration applies them when it creates the table: snapshot management starts then, and compaction starts after you complete the migration. If you don't specify a setting, the migration uses its default: a target file size of 512 MB, the binpack compaction strategy, at least 3 snapshots, and a maximum snapshot age of 120 hours. Unreferenced file removal follows the table bucket's configuration after you complete the migration.

migrationPolicies
Required: Yes
Type: MigrationPolicies structure

The policies for source data that doesn't fit the destination schema.

DataMigrationSettings

Description

The maintenance settings and migration policies for the destination table.

Members
maintenanceSettings
Type: MaintenanceSettings structure

The maintenance settings for the destination table. The migration applies them when it creates the table: snapshot management starts then, and compaction starts after you complete the migration. If you don't specify a setting, the migration uses its default: a target file size of 512 MB, the binpack compaction strategy, at least 3 snapshots, and a maximum snapshot age of 120 hours. Unreferenced file removal follows the table bucket's configuration after you complete the migration.

migrationPolicies
Type: MigrationPolicies structure

The policies for source data that doesn't fit the destination schema.

DestinationTable

Description

The table that a migration creates in a table bucket and migrates the source into.

Members
encryptionConfiguration
Type: EncryptionConfiguration structure

The encryption configuration for the table. If you don't specify one, the table uses the default encryption configuration of its table bucket. If you specify an encryption configuration, the migration role must have the s3tables:PutTableEncryption permission. If you choose SSE-KMS, the migration role must have the kms:DescribeKey, kms:GenerateDataKey and kms:Decrypt permissions on the KMS key, and the S3 Tables maintenance principal must have access to it. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption.

icebergSortOrder
Type: IcebergSortOrder structure

The sort order of the rows within each data file that the migration writes. A sort order can have up to five fields, each naming a column of the schema that you specify by its field ID, so to use a sort order you must specify a schema. StartTableMigration rejects a field that names no column of the schema, or whose transform doesn't fit the column's type.

name
Required: Yes
Type: string

The name of the table to create.

namespace
Required: Yes
Type: string

The namespace to create the table in.

properties
Type: MigrationTableProperties structure

The properties of the destination table, such as its Iceberg format version and the format of its data files.

schema
Type: IcebergSchemaV2 structure

The schema of the table to create. If you don't specify a schema, the migration infers it from the source table, with every column optional. A schema that you specify must include every partition column of the source table. It can leave out other columns only if unmatchedSourceFieldsPolicy is drop. A struct column must have the same fields as the source column. Column default values aren't supported. If you mark a column as required, every source object must have a value for it: an object with a null value in a required column fails to migrate. The destination table is partitioned in the same way as the source table. To specify fields in icebergSortOrder, you must specify a schema.

storageClassConfiguration
Type: StorageClassConfiguration structure

The storage class configuration for the table. If you don't specify one, the table inherits the storage class configuration of its table bucket. If you specify a storage class configuration, the migration role must have the s3tables:PutTableStorageClass permission.

tableBucketARN
Required: Yes
Type: string

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

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags to add to the table. A tag is a key-value pair that you apply to your resources. For more information, see Tagging for cost allocation or attribute-based access control (ABAC). If you specify tags, the migration role must have the s3tables:TagResource permission.

Document

Members

EncryptionConfiguration

Description

Configuration specifying how data should be encrypted. This structure defines the encryption algorithm and optional KMS key to be used for server-side encryption.

Members
kmsKeyArn
Type: string

The Amazon Resource Name (ARN) of the KMS key to use for encryption. This field is required only when sseAlgorithm is set to aws:kms.

sseAlgorithm
Required: Yes
Type: string

The server-side encryption algorithm to use. Valid values are AES256 for S3-managed encryption keys, or aws:kms for Amazon Web Services KMS-managed encryption keys. 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.

ForbiddenException

Description

The caller isn't authorized to make the request.

Members
message
Type: string

GlueTableSource

Description

An Amazon Web Services Glue Data Catalog table to migrate. The table must be an external Apache Hive table whose data is stored as Parquet in a general purpose bucket in the same account and Region as the table bucket. Views, transactional (ACID) tables, tables in an open table format such as Apache Iceberg, and tables registered with Amazon Web Services Lake Formation can't be migrated. If the table can't be migrated, the migration fails, and the table compatibility report lists the reason.

Members
catalogId
Required: Yes
Type: string

The ID of the Data Catalog that contains the table. It must be your account ID.

databaseName
Required: Yes
Type: string

The name of the database that contains the table.

tableName
Required: Yes
Type: string

The name of the table.

IcebergCompactionSettings

Description

Contains details about the compaction settings for an Iceberg table.

Members
strategy
Type: string

The compaction strategy to use for the table. This determines how files are selected and combined during compaction operations.

targetFileSizeMB
Type: int

The target file size for the table in MB.

IcebergMetadata

Description

Contains details about the metadata for an Iceberg table.

Members
partitionSpec
Type: IcebergPartitionSpec structure

The partition specification for the Iceberg table. Partitioning organizes data into separate files based on the values of one or more fields, which can improve query performance by reducing the amount of data scanned. Each partition field applies a transform (such as identity, year, month, or bucket) to a single field.

properties
Type: Associative array of custom strings keys (String) to strings

A map of custom configuration properties for the Iceberg table.

schema
Type: IcebergSchema structure

The schema for an Iceberg table. Use this property to define table schemas with primitive types only. For schemas that include nested or complex types such as struct, list, or map, use schemaV2 instead.

schemaV2
Type: IcebergSchemaV2 structure

The schema for an Iceberg table using the V2 format. Use this property to define table schemas that include nested or complex data types such as struct, list, or map, in addition to primitive types. For schemas with only primitive types, you can use either schema or schemaV2.

writeOrder
Type: IcebergSortOrder structure

The sort order for the Iceberg table. Sort order defines how data is sorted within data files, which can improve query performance by enabling more efficient data skipping and filtering.

IcebergPartitionField

Description

Defines a single partition field in an Iceberg partition specification.

Members
fieldId
Type: int

An optional unique identifier for this partition field. If not specified, S3 Tables automatically assigns a field ID.

name
Required: Yes
Type: string

The name for this partition field. This name is used in the partitioned file paths.

sourceId
Required: Yes
Type: int

The ID of the source schema field to partition by. This must reference a valid field ID from the table schema.

transform
Required: Yes
Type: string

The partition transform to apply to the source field. Supported transforms include identity, year, month, day, hour, bucket, and truncate. For more information, see the Apache Iceberg partition transforms documentation.

IcebergPartitionSpec

Description

Defines how data in an Iceberg table is partitioned. Partitioning helps optimize query performance by organizing data into separate files based on field values. Each partition field specifies a transform to apply to a source field.

Members
fields
Required: Yes
Type: Array of IcebergPartitionField structures

The list of partition fields that define how the table data is partitioned. Each field specifies a source field and a transform to apply. This field is required if partitionSpec is provided.

specId
Type: int

The unique identifier for this partition specification. If not specified, defaults to 0.

IcebergSchema

Description

Contains details about the schema for an Iceberg table.

Members
fields
Required: Yes
Type: Array of SchemaField structures

The schema fields for the table

IcebergSchemaV2

Description

Contains details about the schema for an Iceberg table using the V2 format. This schema format supports nested and complex data types such as struct, list, and map, in addition to primitive types.

Members
fields
Required: Yes
Type: Array of SchemaV2Field structures

The schema fields for the table. Each field defines a column in the table, including its name, type, and whether it is required.

identifierFieldIds
Type: Array of ints

A list of field IDs that are used as the identifier fields for the table. Identifier fields uniquely identify a row in the table.

schemaId
Type: int

An optional unique identifier for the schema. Schema IDs are used by Apache Iceberg to track schema evolution.

type
Required: Yes
Type: string

The type of the top-level schema, which is always a struct type as defined in the Apache Iceberg specification. This value must be struct.

IcebergSnapshotManagementSettings

Description

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

Members
maxSnapshotAgeHours
Type: int

The maximum age of a snapshot before it can be expired.

minSnapshotsToKeep
Type: int

The minimum number of snapshots to keep.

IcebergSortField

Description

Defines a single sort field in an Iceberg sort order specification.

Members
direction
Required: Yes
Type: string

The sort direction. Valid values are asc for ascending order or desc for descending order.

nullOrder
Required: Yes
Type: string

Specifies how null values are ordered. Valid values are nulls-first to place nulls before non-null values, or nulls-last to place nulls after non-null values.

sourceId
Required: Yes
Type: int

The ID of the source schema field to sort by. This must reference a valid field ID from the table schema.

transform
Required: Yes
Type: string

The transform to apply to the source field before sorting. Use identity to sort by the field value directly, or specify other transforms as needed.

IcebergSortOrder

Description

Defines the sort order for data within an Iceberg table. Sorting data can improve query performance by enabling more efficient data skipping.

Members
fields
Required: Yes
Type: Array of IcebergSortField structures

The list of sort fields that define how data is sorted within files. Each field specifies a source field, sort direction, and null ordering. This field is required if writeOrder is provided.

orderId
Required: Yes
Type: int

The unique identifier for this sort order. If not specified, defaults to 1. The order ID is used by Apache Iceberg to track sort order evolution.

IcebergUnreferencedFileRemovalSettings

Description

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

Members
nonCurrentDays
Type: int

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

unreferencedDays
Type: int

The number of days an object has to be unreferenced before it is marked as non-current.

InternalServerErrorException

Description

The request failed due to an internal server error.

Members
message
Type: string

LastSuccessfulReplicatedUpdate

Description

Contains information about the most recent successful replication update to a destination.

Members
metadataLocation
Required: Yes
Type: string

The S3 location of the metadata that was successfully replicated.

timestamp
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the replication update completed successfully.

LoggingEnabled

Description

Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a table bucket.

Members
targetBucket
Required: Yes
Type: string

The name of the general purpose bucket that logs are delivered to. The bucket must be in the same Amazon Web Services Region and owned by the same Amazon Web Services account as the table bucket. The bucket can't use SSE-KMS or DSSE-KMS default encryption, can't have S3 Object Lock enabled, and can't have Requester Pays enabled. You can deliver logs from multiple table buckets to the same target bucket. In this case, choose a different targetPrefix for each table bucket so that you can tell their log objects apart.

targetObjectKeyFormat
Required: Yes
Type: TargetObjectKeyFormat structure

The key format of the log objects. Log object keys are always partitioned by date.

targetPrefix
Required: Yes
Type: string

The prefix for the keys of the log objects that are delivered to the target bucket.

MaintenanceSettings

Description

The maintenance settings for the destination table. The migration applies them when it creates the table: snapshot management starts then, and compaction starts after you complete the migration. If you don't specify a setting, the migration uses its default: a target file size of 512 MB, the binpack compaction strategy, at least 3 snapshots, and a maximum snapshot age of 120 hours. Unreferenced file removal follows the table bucket's configuration after you complete the migration.

Members
icebergCompaction
Type: MigrationCompactionSettings structure

The compaction settings.

icebergSnapshotManagement

The snapshot management settings.

ManagedTableInformation

Description

Contains information about tables that are managed by S3 Tables, including replication information for replica tables.

Members
replicationInformation
Type: ReplicationInformation structure

If this table is a replica, contains information about the source table from which it is replicated.

MethodNotAllowedException

Description

The requested operation is not allowed on this resource. This may occur when attempting to modify a resource that is managed by a service or has restrictions that prevent the operation.

Members
message
Type: string

MigrationCompactionSettings

Description

The compaction settings that a migration applies to the destination table.

Members
strategy
Type: string

The compaction strategy. The only valid value is binpack, which is the default.

targetFileSizeMB
Type: int

The target size, from 64 to 512 MB, of the data files that the migration writes, and of the files that compaction writes after you complete the migration. The default is 512.

MigrationFailureReason

Description

The reason that a migration failed: a code and, when there is one, the resource or reason it applies to. This value is returned only when the migration is in the failed state.

Members
code
Required: Yes
Type: string

The failure code. It names the cause or the report that lists the findings. Valid values:

  • rolePermissions - S3 Tables couldn't assume the migration role, or the role doesn't have a permission that the migration needs. detail is the role ARN.

  • sourcePermissions - The migration role couldn't read the Amazon Web Services Glue table or the source objects. detail names the table (database.table) or the source bucket.

  • destinationPermissions - The migration role couldn't write to the table bucket or the report bucket. detail names the bucket.

  • resourceNotFound - A resource that you specified doesn't exist, such as the Amazon Web Services Glue table or the source bucket. detail names it.

  • sourceNotSupported - The source table can't be migrated, for example because it is empty, has too many objects, or has columns or partitions that can't be migrated. The table compatibility report lists the findings.

  • tableCompatibilityReport - The migration couldn't create the destination table, for example because a table with that name already exists or the KMS key can't be used. For a sync, the destination table changed after the previous migration. The table compatibility report lists the finding.

  • objectCompatibilityReport - Some source objects can't be migrated, for example because they are archived, or because they were overwritten after an earlier migration migrated them. The object compatibility report lists them.

  • objectMigrationReport - Some source objects failed to migrate. The object migration report lists them and the cause for each.

  • reportBucketNotSupported - The report bucket can't receive the migration's reports, for example because it is in a different Region than the table bucket.

  • internalError - S3 Tables encountered an internal error. Retry the migration, and contact Amazon Web Services Support if the error persists.

detail
Type: string

The resource that the failure applies to, such as the role ARN, the Amazon Web Services Glue table (database.table) or a bucket. For sourceNotSupported, the reason that the source isn't supported, such as EMPTY_TABLE. This value isn't returned for the report codes or for internalError.

MigrationOutputConfiguration

Description

The bucket and prefixes that a migration writes its reports to. Every report goes to one bucket, each under its own prefix.

Members
bucket
Required: Yes
Type: string

The general purpose bucket that the migration writes every report to.

prefixes
Type: MigrationReportPrefixes structure

The key prefix for each report.

MigrationOutputOverview

Description

Where a migration writes its reports, and the location of each report once it is written.

Members
bucket
Required: Yes
Type: string

The general purpose bucket that the migration writes every report to.

objectCompatibilityReport
Required: Yes
Type: ReportOverview structure

The object compatibility report: one row for each source object under the source table's location, with whether the migration includes the object and its most severe finding. The migration writes it when planning finishes. If planning fails, the report might not be written.

objectMigrationReport
Required: Yes
Type: ReportOverview structure

The object migration report: one row for each source object that the migration tried to migrate, with whether it migrated, how it was transformed, and why it failed. The migration writes it once, when the migration ends. It isn't written if planning fails or if a sync has nothing to migrate.

tableCompatibilityReport
Required: Yes
Type: ReportOverview structure

The table compatibility report: the sample object that the schema is inferred from, the table-level findings, and one row for each destination column with its type change and how the migration policies apply to it. The migration writes it when planning finishes, before any data migrates. If planning fails, the report might not be written.

MigrationPolicies

Description

The policies for source data that doesn't fit the destination schema.

Members
incompatibleValuesPolicy
Type: string

The migration policy for a source value that the destination column's type can't hold. Valid values:

  • fail - Fails the migration. This is the default.

  • setNull - Writes null for a value that the destination column's type can't hold. If a column's type in a source object is incompatible with the destination column's type, the column is null for that whole object.

A required column, or a type that migration doesn't support, fails the migration under either value.

unmatchedSourceFieldsPolicy
Type: string

The migration policy for a source field that has no matching column in the destination schema. Valid values:

  • fail - Fails the migration. This is the default.

  • drop - Leaves source columns that the destination schema doesn't have out of the destination table, and doesn't migrate source objects outside the Amazon Web Services Glue table's partition locations.

A destination schema that leaves out a partition column or a field of a struct column fails the migration under either value.

MigrationReportPrefixes

Description

The key prefix for each report. If you don't specify a prefix for a report, its keys start at the root of the bucket.

Members
objectCompatibilityReport
Type: string

The key prefix for the object compatibility report, up to 512 bytes. If not specified, the report's keys start at the root of the bucket.

objectMigrationReport
Type: string

The key prefix for the object migration report, up to 512 bytes. If not specified, the report's keys start at the root of the bucket.

tableCompatibilityReport
Type: string

The key prefix for the table compatibility report, up to 512 bytes. If not specified, the report's keys start at the root of the bucket.

MigrationSnapshotManagementSettings

Description

The snapshot management settings that a migration applies to the destination table.

Members
maxSnapshotAgeHours
Type: int

The maximum age, in hours, of a snapshot before it can be expired. The default is 120.

minSnapshotsToKeep
Type: int

The minimum number of snapshots to keep. The value must be 3 or more. The default is 3.

MigrationStats

Description

The number of source objects that migrated, failed or are pending. For a sync, the counts cover every object of the table after the sync, including objects that earlier migrations migrated. The counts are set when planning finishes and updated when the migration ends.

Members
objectsFailedMigration
Type: long (int|float)

The number of source objects that didn't migrate, because they failed or because another object, such as an object in the same partition, failed. The object migration report lists the cause for each object.

objectsMigrated
Type: long (int|float)

The number of source objects whose data the migration wrote to the destination table. Migrated data can be queried after the migration commits it. If the migration fails or is cancelled, some migrated objects might not be committed.

objectsPendingMigration
Type: long (int|float)

The number of source objects that haven't migrated or failed yet. When a migration fails or is cancelled, these are the objects that it didn't migrate.

MigrationSummary

Description

A summary of a migration.

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the migration was created.

hasValidPlan
Type: boolean

A Boolean value that specifies whether planning produced a plan that the migration can run. If planning hasn't finished, this value isn't returned.

migrationId
Required: Yes
Type: string

The ID of the migration.

name
Required: Yes
Type: string

The name of the destination table.

namespace
Required: Yes
Type: string

The namespace of the destination table.

state
Required: Yes
Type: string

The state of the migration. Valid values:

  • new - S3 Tables accepted the request.

  • planning - The migration is checking the source table, its objects and the destination for compatibility, and writing the compatibility reports.

  • pendingReview - Planning finished, and the migration waits for you to continue or cancel it with UpdateTableMigration.

  • queued - The migration is waiting to start migrating data.

  • migrating - The migration is running the plan from the planning state: it copies data and commits it to the destination table. A migration reaches this state only if hasValidPlan is true.

  • succeeded - Every planned object migrated.

  • failed - The migration failed. Check failureReason for the cause.

  • cancelling - You cancelled the migration, and it is finishing the work in progress.

  • cancelled - The migration is cancelled.

stateUpdatedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the migration's state last changed.

tableARN
Type: string

The Amazon Resource Name (ARN) of the destination table, once the migration creates it.

tableBucketARN
Required: Yes
Type: string

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

type
Required: Yes
Type: string

The type of the migration. Valid values:

  • start - A migration that StartTableMigration started.

  • sync - A migration that SyncTableMigration started.

MigrationTableProperties

Description

The properties of the data files that a migration writes. The migration also sets the compression codec and dictionary encoding as the destination table's write properties, so they remain the table's defaults after you complete the migration.

Members
compressionCodec
Type: string

The compression codec of the data files. The default is zstd.

dictionaryEncoding
Type: boolean

Specifies whether the data files use dictionary encoding. The default is true.

icebergFormatVersion
Type: int

The Iceberg format version of the destination table. Valid values are 2 and 3. The default is 2.

writeFormat
Type: string

The file format of the data files. The only supported format is parquet, the default.

NamespaceSummary

Description

Contains details about a namespace.

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the namespace was created at.

createdBy
Required: Yes
Type: string

The ID of the account that created the namespace.

namespace
Required: Yes
Type: Array of strings

The name of the namespace.

namespaceId
Type: string

The system-assigned unique identifier for the namespace.

ownerAccountId
Required: Yes
Type: string

The ID of the account that owns the namespace.

tableBucketId
Type: string

The system-assigned unique identifier for the table bucket that contains this namespace.

NotFoundException

Description

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

Members
message
Type: string

PartitionedPrefix

Description

Amazon S3 keys for log objects are partitioned in the following format: [targetPrefix][SourceAccountId]/[SourceRegion]/[SourceTableBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]

Members
partitionDateSource
Required: Yes
Type: string

The date to use for the log object key partitions. Valid values are EventTime, the time that the requests in the log were made, and DeliveryTime, the time that the log was delivered.

PlanningStats

Description

Statistics about the source and the partitions in a migration.

Members
objectsPlanned
Type: long (int|float)

The number of source objects in the migration. For a start, these are the data files in the Amazon Web Services Glue table's partitions, or under the table's location if the table isn't partitioned. For a sync, these are all the data files of the table after the sync, including files that earlier migrations migrated.

objectsScanned
Type: long (int|float)

The number of source objects that the migration found under the source table's location, whether or not it migrates them. The object compatibility report has one row for each.

partitionCount
Type: long (int|float)

The number of partitions in the destination table after this migration, or 0 if the source table isn't partitioned. This value is returned when planning produces a valid plan.

ReplicationDestination

Description

Specifies a destination table bucket for replication.

Members
destinationTableBucketARN
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the destination table bucket where tables will be replicated.

ReplicationDestinationStatusModel

Description

Contains status information for a replication destination, including the current replication state, last successful update, and any error messages.

Members
destinationTableArn
Type: string

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

destinationTableBucketArn
Required: Yes
Type: string

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

failureMessage
Type: string

If replication has failed, this field contains an error message describing the failure reason.

lastSuccessfulReplicatedUpdate

Information about the most recent successful replication update to this destination.

replicationStatus
Required: Yes
Type: string

The current status of replication to this destination.

ReplicationInformation

Description

Contains information about the source of a replicated table.

Members
sourceTableARN
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the source table from which this table is replicated.

ReportOverview

Description

A report of a migration: the prefix it is written under and, once it is written, its key, its checksum and, for the compatibility reports, the number of blocking findings in each category.

Members
checksumCRC64NVME
Type: string

The Base64-encoded CRC64NVME checksum of the object that key names. For a report that has a manifest, the manifest lists the checksum of each report file. This value is returned after the migration writes the report.

invalidFindings
Type: Associative array of custom strings keys (FindingCategory) to long (int|float)s

For the compatibility reports, the number of blocking findings in each category. The object compatibility report counts each blocked object once, under its most severe finding. Categories with no blocking findings are left out.

key
Type: string

The key of the report object in the bucket. For the object compatibility and object migration reports, this is the report's manifest; for the table compatibility report, it is the report itself. This value is returned after the migration writes the report. A migration doesn't always write every report. For example, a migration that fails during planning doesn't write the object migration report.

prefix
Type: string

The key prefix that the report is written under.

SchemaField

Description

Contains details about a schema field.

Members
id
Type: int

An optional unique identifier for the schema field. Field IDs are used by Apache Iceberg to track schema evolution and maintain compatibility across schema changes. If not specified, S3 Tables automatically assigns field IDs.

name
Required: Yes
Type: string

The name of the field.

required
Type: boolean

A Boolean value that specifies whether values are required for each row in this field. By default, this is false and null values are allowed in the field. If this is true the field does not allow null values.

type
Required: Yes
Type: string

The field type. S3 Tables supports all Apache Iceberg primitive types. For more information, see the Apache Iceberg documentation.

SchemaV2Field

Description

Contains details about a schema field in the V2 format. This field format supports nested and complex data types such as struct, list, and map, in addition to primitive types.

Members
doc
Type: string

An optional description of the field.

id
Required: Yes
Type: int

The unique identifier for the schema field. Field IDs are used by Apache Iceberg to track schema evolution and maintain compatibility across schema changes.

name
Required: Yes
Type: string

The name of the field.

required
Required: Yes
Type: boolean

A Boolean value that specifies whether values are required for each row in this field. If this is true, the field does not allow null values.

type
Required: Yes
Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

The data type of the field. This can be a primitive type string such as boolean, int, long, float, double, string, binary, date, timestamp, or timestamptz, or a complex type represented as a JSON object for nested types such as struct, list, or map. For more information, see the Apache Iceberg schemas and data types documentation.

SourceConfiguration

Description

The source to migrate from. Set exactly one member, and set sourceType to match it.

Members
glueTable
Type: GlueTableSource structure

An Amazon Web Services Glue Data Catalog table to migrate. The table must be an external Apache Hive table whose data is stored as Parquet in a general purpose bucket in the same account and Region as the table bucket. Views, transactional (ACID) tables, tables in an open table format such as Apache Iceberg, and tables registered with Amazon Web Services Lake Formation can't be migrated. If the table can't be migrated, the migration fails, and the table compatibility report lists the reason.

StorageClassConfiguration

Description

The configuration details for the storage class of tables or table buckets. This allows you to optimize storage costs by selecting the appropriate storage class based on your access patterns and performance requirements.

Members
storageClass
Required: Yes
Type: string

The storage class for the table or table bucket. Valid values include storage classes optimized for different access patterns and cost profiles.

TableBucketLoggingStatus

Description

The server access logging status of a table bucket. To enable logging, specify loggingEnabled. To disable logging, specify an empty TableBucketLoggingStatus.

Members
loggingEnabled
Type: LoggingEnabled structure

Where logs for the table bucket are delivered and how the log objects are named. Must be populated to enable logging.

TableBucketMaintenanceConfigurationValue

Description

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

Members
settings

Contains details about the settings of the maintenance configuration.

status
Type: string

The status of the maintenance configuration.

TableBucketMaintenanceSettings

Description

Contains details about the maintenance settings for the table bucket.

Members
icebergUnreferencedFileRemoval

The unreferenced file removal settings for the table bucket.

TableBucketReplicationConfiguration

Description

The replication configuration for a table bucket. This configuration defines how tables in the source bucket are replicated to destination table buckets, including the IAM role used for replication.

Members
role
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the IAM role that S3 Tables assumes to replicate tables on your behalf.

rules
Required: Yes
Type: Array of TableBucketReplicationRule structures

An array of replication rules that define which tables to replicate and where to replicate them.

TableBucketReplicationRule

Description

Defines a rule for replicating tables from a source table bucket to one or more destination table buckets.

Members
destinations
Required: Yes
Type: Array of ReplicationDestination structures

An array of destination table buckets where tables should be replicated.

TableBucketSummary

Description

Contains details about a table bucket.

Members
arn
Required: Yes
Type: string

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

createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the table bucket was created at.

name
Required: Yes
Type: string

The name of the table bucket.

ownerAccountId
Required: Yes
Type: string

The ID of the account that owns the table bucket.

tableBucketId
Type: string

The system-assigned unique identifier for the table bucket.

type
Type: string

The type of the table bucket.

TableMaintenanceConfigurationValue

Description

The values that define a maintenance configuration for a table.

Members
settings
Type: TableMaintenanceSettings structure

Contains details about the settings for the maintenance configuration.

status
Type: string

The status of the maintenance configuration.

TableMaintenanceJobStatusValue

Description

Details about the status of a maintenance job.

Members
failureMessage
Type: string

The failure message of a failed job.

lastRunTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the maintenance job was last run.

status
Required: Yes
Type: string

The status of the job.

TableMaintenanceSettings

Description

Contains details about maintenance settings for the table.

Members
icebergCompaction
Type: IcebergCompactionSettings structure

Contains details about the Iceberg compaction settings for the table.

icebergSnapshotManagement

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

TableMetadata

Description

Contains details about the table metadata.

Members
iceberg
Type: IcebergMetadata structure

Contains details about the metadata of an Iceberg table.

TableRecordExpirationConfigurationValue

Description

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 after the number of days specified in the record expiration settings for the table.

Members
settings

The expiration settings for records in the table.

status
Type: string

The status of the expiration settings for records in the table.

TableRecordExpirationJobMetrics

Description

Provides metrics for the record expiration job that most recently ran for a table. The metrics provide insight into the amount of data that was removed when the job ran.

Members
deletedDataFiles
Type: long (int|float)

The total number of data files that were removed when the job ran.

deletedRecords
Type: long (int|float)

The total number of records that were removed when the job ran.

removedFilesSize
Type: long (int|float)

The total size (in bytes) of the data files that were removed when the job ran.

TableRecordExpirationSettings

Description

The record expiration setting that specifies when records expire and are automatically removed from a table.

Members
days
Type: int

If you enable record expiration for a table, you can specify the number of days to retain your table records. For example, to retain your table records for one year, set this value to 365.

TableReplicationConfiguration

Description

The replication configuration for an individual table. This configuration defines how the table is replicated to destination tables.

Members
role
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the IAM role that S3 Tables assumes to replicate the table on your behalf.

rules
Required: Yes
Type: Array of TableReplicationRule structures

An array of replication rules that define where this table should be replicated.

TableReplicationRule

Description

Defines a rule for replicating a table to one or more destination tables.

Members
destinations
Required: Yes
Type: Array of ReplicationDestination structures

An array of destination table buckets where this table should be replicated.

TableSummary

Description

Contains details about a table.

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the table was created at.

managedByService
Type: string

The Amazon Web Services service managing this table, if applicable. For example, a replicated table is managed by the S3 Tables replication service.

modifiedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the table was last modified at.

name
Required: Yes
Type: string

The name of the table.

namespace
Required: Yes
Type: Array of strings

The name of the namespace.

namespaceId
Type: string

The unique identifier for the namespace that contains this table.

tableARN
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the table.

tableBucketId
Type: string

The unique identifier for the table bucket that contains this table.

type
Required: Yes
Type: string

The type of the table.

TargetObjectKeyFormat

Description

The key format of the log objects. Only partitionedPrefix is supported.

Members
partitionedPrefix
Required: Yes
Type: PartitionedPrefix structure

Partitions log object keys by date.

TooManyRequestsException

Description

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

Members
message
Type: string