SDK for PHP 3.x

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

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.
DeleteTableBucketPolicy ( array $params = [] )
Deletes a table bucket policy.
DeleteTablePolicy ( array $params = [] )
Deletes a table policy.
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.
GetTableBucketMaintenanceConfiguration ( array $params = [] )
Gets details about a maintenance configuration for a given table bucket.
GetTableBucketPolicy ( array $params = [] )
Gets details about a table bucket policy.
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.
GetTablePolicy ( array $params = [] )
Gets details about a table policy.
ListNamespaces ( array $params = [] )
Lists the namespaces within a table bucket.
ListTableBuckets ( array $params = [] )
Lists table buckets for your account.
ListTables ( array $params = [] )
List tables in the given table bucket.
PutTableBucketMaintenanceConfiguration ( array $params = [] )
Creates a new maintenance configuration or replaces an existing maintenance configuration for a table bucket.
PutTableBucketPolicy ( array $params = [] )
Creates a new maintenance configuration or replaces an existing table bucket policy 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 maintenance configuration or replaces an existing table policy for a table.
RenameTable ( array $params = [] )
Renames a table or a namespace.
UpdateTableMetadataLocation ( array $params = [] )
Updates the metadata location for a table.

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
ListTables

Operations

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.

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

Parameter Syntax

$result = $client->createTable([
    'format' => 'ICEBERG', // REQUIRED
    'metadata' => [
        'iceberg' => [
            'schema' => [ // REQUIRED
                'fields' => [ // REQUIRED
                    [
                        'name' => '<string>', // REQUIRED
                        'required' => true || false,
                        'type' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
        ],
    ],
    'name' => '<string>', // REQUIRED
    'namespace' => '<string>', // REQUIRED
    'tableBucketARN' => '<string>', // REQUIRED
]);

Parameter Details

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

tableBucketARN
Required: Yes
Type: string

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

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.

Parameter Syntax

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

Parameter Details

Members
name
Required: Yes
Type: string

The name for the table bucket.

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.

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.

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.

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>', ...],
    'ownerAccountId' => '<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.

ownerAccountId
Required: Yes
Type: string

The ID of the account that owns the namespcace.

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>', // 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 name of the namespace the table is associated with.

tableBucketARN
Required: Yes
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>',
    'metadataLocation' => '<string>',
    'modifiedAt' => <DateTime>,
    'modifiedBy' => '<string>',
    'name' => '<string>',
    'namespace' => ['<string>', ...],
    'ownerAccountId' => '<string>',
    'tableARN' => '<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.

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.

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.

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>',
]

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.

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.

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.

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.

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.

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' => [
                    '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 maintenance job.

namespace
Required: Yes
Type: string

The name of the namespace the table is associated with.

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

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.

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>', ...],
            'ownerAccountId' => '<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>',
]);

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.

Result Syntax

[
    'continuationToken' => '<string>',
    'tableBuckets' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'name' => '<string>',
            'ownerAccountId' => '<string>',
        ],
        // ...
    ],
]

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.

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>,
            'modifiedAt' => <DateTime>,
            'name' => '<string>',
            'namespace' => ['<string>', ...],
            'tableARN' => '<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.

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.

PutTableBucketPolicy

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

Creates a new maintenance configuration 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.

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' => [
                'targetFileSizeMB' => <integer>,
            ],
            'icebergSnapshotManagement' => [
                'maxSnapshotAgeHours' => <integer>,
                'minSnapshotsToKeep' => <integer>,
            ],
        ],
        'status' => 'enabled|disabled',
    ],
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the maintenance configuration.

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 maintenance configuration 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.

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.

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.

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

ForbiddenException

Description

The caller isn't authorized to make the request.

Members
message
Type: string

IcebergCompactionSettings

Description

Contains details about the compaction settings for an Iceberg table.

Members
targetFileSizeMB
Type: int

The target file size for the table in MB.

IcebergMetadata

Description

Contains details about the metadata for an Iceberg table.

Members
schema
Required: Yes
Type: IcebergSchema structure

The schema for an Iceberg table.

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

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.

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.

</p> 
unreferencedDays
Type: int

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

 </p> 

InternalServerErrorException

Description

The request failed due to an internal server error.

Members
message
Type: string

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.

ownerAccountId
Required: Yes
Type: string

The ID of the account that owns the namespace.

NotFoundException

Description

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

Members
message
Type: string

SchemaField

Description

Contains details about a schema field.

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

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.

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.

TableMaintenanceConfigurationValue

Description

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

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.

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.

tableARN
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the table.

type
Required: Yes
Type: string

The type of the table.

TooManyRequestsException

Description

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

Members
message
Type: string