diff --git a/clients/client-s3tables/src/commands/CreateNamespaceCommand.ts b/clients/client-s3tables/src/commands/CreateNamespaceCommand.ts index 715570f9ed8e..8b448125f80e 100644 --- a/clients/client-s3tables/src/commands/CreateNamespaceCommand.ts +++ b/clients/client-s3tables/src/commands/CreateNamespaceCommand.ts @@ -28,7 +28,13 @@ export interface CreateNamespaceCommandInput extends CreateNamespaceRequest {} export interface CreateNamespaceCommandOutput extends CreateNamespaceResponse, __MetadataBearer {} /** - *

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 Table namespaces.

+ *

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.

+ *
+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3tables/src/commands/CreateTableBucketCommand.ts b/clients/client-s3tables/src/commands/CreateTableBucketCommand.ts index 764d94d4bd5c..cd607ae19bfb 100644 --- a/clients/client-s3tables/src/commands/CreateTableBucketCommand.ts +++ b/clients/client-s3tables/src/commands/CreateTableBucketCommand.ts @@ -28,7 +28,13 @@ export interface CreateTableBucketCommandInput extends CreateTableBucketRequest export interface CreateTableBucketCommandOutput extends CreateTableBucketResponse, __MetadataBearer {} /** - *

Creates a table bucket.

+ *

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.

+ *
+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3tables/src/commands/CreateTableCommand.ts b/clients/client-s3tables/src/commands/CreateTableCommand.ts index 6afecdc4c8d2..eab597b5a565 100644 --- a/clients/client-s3tables/src/commands/CreateTableCommand.ts +++ b/clients/client-s3tables/src/commands/CreateTableCommand.ts @@ -28,7 +28,16 @@ export interface CreateTableCommandInput extends CreateTableRequest {} export interface CreateTableCommandOutput extends CreateTableResponse, __MetadataBearer {} /** - *

Creates a new table associated with the given namespace in a table bucket.

+ *

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.

+ * + *
+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -40,6 +49,19 @@ export interface CreateTableCommandOutput extends CreateTableResponse, __Metadat * namespace: "STRING_VALUE", // required * name: "STRING_VALUE", // required * format: "ICEBERG", // required + * metadata: { // TableMetadata Union: only one key present + * iceberg: { // IcebergMetadata + * schema: { // IcebergSchema + * fields: [ // SchemaFieldList // required + * { // SchemaField + * name: "STRING_VALUE", // required + * type: "STRING_VALUE", // required + * required: true || false, + * }, + * ], + * }, + * }, + * }, * }; * const command = new CreateTableCommand(input); * const response = await client.send(command); diff --git a/clients/client-s3tables/src/commands/DeleteNamespaceCommand.ts b/clients/client-s3tables/src/commands/DeleteNamespaceCommand.ts index f0a2d9a2a2ec..df5d1637a4cd 100644 --- a/clients/client-s3tables/src/commands/DeleteNamespaceCommand.ts +++ b/clients/client-s3tables/src/commands/DeleteNamespaceCommand.ts @@ -28,7 +28,13 @@ export interface DeleteNamespaceCommandInput extends DeleteNamespaceRequest {} export interface DeleteNamespaceCommandOutput extends __MetadataBearer {} /** - *

Deletes a namespace.

+ *

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.

+ *
+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3tables/src/commands/DeleteTableBucketCommand.ts b/clients/client-s3tables/src/commands/DeleteTableBucketCommand.ts index 80b419e92a69..5515265dc3bc 100644 --- a/clients/client-s3tables/src/commands/DeleteTableBucketCommand.ts +++ b/clients/client-s3tables/src/commands/DeleteTableBucketCommand.ts @@ -28,7 +28,13 @@ export interface DeleteTableBucketCommandInput extends DeleteTableBucketRequest export interface DeleteTableBucketCommandOutput extends __MetadataBearer {} /** - *

Deletes a table bucket.

+ *

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.

+ *
+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3tables/src/commands/DeleteTableBucketPolicyCommand.ts b/clients/client-s3tables/src/commands/DeleteTableBucketPolicyCommand.ts index abdeffa1c03d..24f93088d8dd 100644 --- a/clients/client-s3tables/src/commands/DeleteTableBucketPolicyCommand.ts +++ b/clients/client-s3tables/src/commands/DeleteTableBucketPolicyCommand.ts @@ -28,7 +28,13 @@ export interface DeleteTableBucketPolicyCommandInput extends DeleteTableBucketPo export interface DeleteTableBucketPolicyCommandOutput extends __MetadataBearer {} /** - *

Deletes a table bucket policy.

+ *

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.

+ *
+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3tables/src/commands/DeleteTableCommand.ts b/clients/client-s3tables/src/commands/DeleteTableCommand.ts index e28a33deb80d..888c4e7a77df 100644 --- a/clients/client-s3tables/src/commands/DeleteTableCommand.ts +++ b/clients/client-s3tables/src/commands/DeleteTableCommand.ts @@ -28,7 +28,13 @@ export interface DeleteTableCommandInput extends DeleteTableRequest {} export interface DeleteTableCommandOutput extends __MetadataBearer {} /** - *

Deletes a table.

+ *

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.

+ *
+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3tables/src/commands/DeleteTablePolicyCommand.ts b/clients/client-s3tables/src/commands/DeleteTablePolicyCommand.ts index 34a6de494f55..cc68e85b938f 100644 --- a/clients/client-s3tables/src/commands/DeleteTablePolicyCommand.ts +++ b/clients/client-s3tables/src/commands/DeleteTablePolicyCommand.ts @@ -28,7 +28,13 @@ export interface DeleteTablePolicyCommandInput extends DeleteTablePolicyRequest export interface DeleteTablePolicyCommandOutput extends __MetadataBearer {} /** - *

Deletes a table policy.

+ *

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.

+ *
+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3tables/src/commands/GetNamespaceCommand.ts b/clients/client-s3tables/src/commands/GetNamespaceCommand.ts index 3e379c3f3ada..a45e37ffe526 100644 --- a/clients/client-s3tables/src/commands/GetNamespaceCommand.ts +++ b/clients/client-s3tables/src/commands/GetNamespaceCommand.ts @@ -28,7 +28,13 @@ export interface GetNamespaceCommandInput extends GetNamespaceRequest {} export interface GetNamespaceCommandOutput extends GetNamespaceResponse, __MetadataBearer {} /** - *

Gets details about a namespace.

+ *

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.

+ *
+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3tables/src/commands/GetTableBucketCommand.ts b/clients/client-s3tables/src/commands/GetTableBucketCommand.ts index 5ff23ea5a175..b010fb2e4c31 100644 --- a/clients/client-s3tables/src/commands/GetTableBucketCommand.ts +++ b/clients/client-s3tables/src/commands/GetTableBucketCommand.ts @@ -28,7 +28,13 @@ export interface GetTableBucketCommandInput extends GetTableBucketRequest {} export interface GetTableBucketCommandOutput extends GetTableBucketResponse, __MetadataBearer {} /** - *

Gets details on a table bucket.

+ *

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.

+ *
+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3tables/src/commands/GetTableBucketMaintenanceConfigurationCommand.ts b/clients/client-s3tables/src/commands/GetTableBucketMaintenanceConfigurationCommand.ts index d7de8e28fd06..0699e0acbb5f 100644 --- a/clients/client-s3tables/src/commands/GetTableBucketMaintenanceConfigurationCommand.ts +++ b/clients/client-s3tables/src/commands/GetTableBucketMaintenanceConfigurationCommand.ts @@ -37,7 +37,13 @@ export interface GetTableBucketMaintenanceConfigurationCommandOutput __MetadataBearer {} /** - *

Gets details about a maintenance configuration for a given table bucket.

+ *

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.

+ *
+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3tables/src/commands/GetTableBucketPolicyCommand.ts b/clients/client-s3tables/src/commands/GetTableBucketPolicyCommand.ts index 8e5874713106..f9e406dd8a9b 100644 --- a/clients/client-s3tables/src/commands/GetTableBucketPolicyCommand.ts +++ b/clients/client-s3tables/src/commands/GetTableBucketPolicyCommand.ts @@ -28,7 +28,13 @@ export interface GetTableBucketPolicyCommandInput extends GetTableBucketPolicyRe export interface GetTableBucketPolicyCommandOutput extends GetTableBucketPolicyResponse, __MetadataBearer {} /** - *

Gets details about a table bucket policy.

+ *

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.

+ *
+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3tables/src/commands/GetTableCommand.ts b/clients/client-s3tables/src/commands/GetTableCommand.ts index e66fa3a0c078..2d98cfb80703 100644 --- a/clients/client-s3tables/src/commands/GetTableCommand.ts +++ b/clients/client-s3tables/src/commands/GetTableCommand.ts @@ -28,7 +28,13 @@ export interface GetTableCommandInput extends GetTableRequest {} export interface GetTableCommandOutput extends GetTableResponse, __MetadataBearer {} /** - *

Gets details about a table.

+ *

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.

+ *
+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3tables/src/commands/GetTableMaintenanceConfigurationCommand.ts b/clients/client-s3tables/src/commands/GetTableMaintenanceConfigurationCommand.ts index 962247b9cc2f..23f70f33a460 100644 --- a/clients/client-s3tables/src/commands/GetTableMaintenanceConfigurationCommand.ts +++ b/clients/client-s3tables/src/commands/GetTableMaintenanceConfigurationCommand.ts @@ -33,7 +33,13 @@ export interface GetTableMaintenanceConfigurationCommandOutput __MetadataBearer {} /** - *

Gets details about the maintenance configuration of a table.

+ *

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.

+ *
+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3tables/src/commands/GetTableMaintenanceJobStatusCommand.ts b/clients/client-s3tables/src/commands/GetTableMaintenanceJobStatusCommand.ts index bb73556badfa..543519bd30c1 100644 --- a/clients/client-s3tables/src/commands/GetTableMaintenanceJobStatusCommand.ts +++ b/clients/client-s3tables/src/commands/GetTableMaintenanceJobStatusCommand.ts @@ -33,7 +33,13 @@ export interface GetTableMaintenanceJobStatusCommandOutput __MetadataBearer {} /** - *

Gets the status of a maintenance job for a table.

+ *

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.

+ *
+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3tables/src/commands/GetTableMetadataLocationCommand.ts b/clients/client-s3tables/src/commands/GetTableMetadataLocationCommand.ts index c336d2cee6fb..6f9a24522c8d 100644 --- a/clients/client-s3tables/src/commands/GetTableMetadataLocationCommand.ts +++ b/clients/client-s3tables/src/commands/GetTableMetadataLocationCommand.ts @@ -29,6 +29,12 @@ export interface GetTableMetadataLocationCommandOutput extends GetTableMetadataL /** *

Gets the location of the table metadata.

+ *
+ *
Permissions
+ *
+ *

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

+ *
+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3tables/src/commands/GetTablePolicyCommand.ts b/clients/client-s3tables/src/commands/GetTablePolicyCommand.ts index 2e9e9c0c8c5f..896d5ca5cb37 100644 --- a/clients/client-s3tables/src/commands/GetTablePolicyCommand.ts +++ b/clients/client-s3tables/src/commands/GetTablePolicyCommand.ts @@ -28,7 +28,13 @@ export interface GetTablePolicyCommandInput extends GetTablePolicyRequest {} export interface GetTablePolicyCommandOutput extends GetTablePolicyResponse, __MetadataBearer {} /** - *

Gets details about a table policy.

+ *

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.

+ *
+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3tables/src/commands/ListNamespacesCommand.ts b/clients/client-s3tables/src/commands/ListNamespacesCommand.ts index b58e42a4c388..8b01f39a7196 100644 --- a/clients/client-s3tables/src/commands/ListNamespacesCommand.ts +++ b/clients/client-s3tables/src/commands/ListNamespacesCommand.ts @@ -28,7 +28,13 @@ export interface ListNamespacesCommandInput extends ListNamespacesRequest {} export interface ListNamespacesCommandOutput extends ListNamespacesResponse, __MetadataBearer {} /** - *

Lists the namespaces within a table bucket.

+ *

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.

+ *
+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3tables/src/commands/ListTableBucketsCommand.ts b/clients/client-s3tables/src/commands/ListTableBucketsCommand.ts index 0ccc5b44674c..a34b22b73fef 100644 --- a/clients/client-s3tables/src/commands/ListTableBucketsCommand.ts +++ b/clients/client-s3tables/src/commands/ListTableBucketsCommand.ts @@ -28,7 +28,13 @@ export interface ListTableBucketsCommandInput extends ListTableBucketsRequest {} export interface ListTableBucketsCommandOutput extends ListTableBucketsResponse, __MetadataBearer {} /** - *

Lists table buckets for your account.

+ *

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.

+ *
+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3tables/src/commands/ListTablesCommand.ts b/clients/client-s3tables/src/commands/ListTablesCommand.ts index 9e56b62040ad..41271f1f9b28 100644 --- a/clients/client-s3tables/src/commands/ListTablesCommand.ts +++ b/clients/client-s3tables/src/commands/ListTablesCommand.ts @@ -28,7 +28,13 @@ export interface ListTablesCommandInput extends ListTablesRequest {} export interface ListTablesCommandOutput extends ListTablesResponse, __MetadataBearer {} /** - *

List tables in the given table bucket.

+ *

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.

+ *
+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3tables/src/commands/PutTableBucketMaintenanceConfigurationCommand.ts b/clients/client-s3tables/src/commands/PutTableBucketMaintenanceConfigurationCommand.ts index 59dc8fe4bf66..f7ad89af4d97 100644 --- a/clients/client-s3tables/src/commands/PutTableBucketMaintenanceConfigurationCommand.ts +++ b/clients/client-s3tables/src/commands/PutTableBucketMaintenanceConfigurationCommand.ts @@ -33,7 +33,13 @@ export interface PutTableBucketMaintenanceConfigurationCommandOutput extends __M /** *

Creates a new maintenance configuration or replaces an existing maintenance configuration - * for a table bucket.

+ * 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.

+ *
+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3tables/src/commands/PutTableBucketPolicyCommand.ts b/clients/client-s3tables/src/commands/PutTableBucketPolicyCommand.ts index a84aa8d08c47..dbd3ee4bd045 100644 --- a/clients/client-s3tables/src/commands/PutTableBucketPolicyCommand.ts +++ b/clients/client-s3tables/src/commands/PutTableBucketPolicyCommand.ts @@ -29,7 +29,13 @@ export interface PutTableBucketPolicyCommandOutput extends __MetadataBearer {} /** *

Creates a new maintenance configuration or replaces an existing table bucket policy for a - * table bucket.

+ * 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.

+ *
+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3tables/src/commands/PutTableMaintenanceConfigurationCommand.ts b/clients/client-s3tables/src/commands/PutTableMaintenanceConfigurationCommand.ts index 2e43e466bdc6..389aedb6c17b 100644 --- a/clients/client-s3tables/src/commands/PutTableMaintenanceConfigurationCommand.ts +++ b/clients/client-s3tables/src/commands/PutTableMaintenanceConfigurationCommand.ts @@ -32,7 +32,13 @@ export interface PutTableMaintenanceConfigurationCommandOutput extends __Metadat /** *

Creates a new maintenance configuration or replaces an existing maintenance configuration - * for a table.

+ * 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.

+ *
+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3tables/src/commands/PutTablePolicyCommand.ts b/clients/client-s3tables/src/commands/PutTablePolicyCommand.ts index 900f8cc805b9..bec29b25b931 100644 --- a/clients/client-s3tables/src/commands/PutTablePolicyCommand.ts +++ b/clients/client-s3tables/src/commands/PutTablePolicyCommand.ts @@ -28,8 +28,14 @@ export interface PutTablePolicyCommandInput extends PutTablePolicyRequest {} export interface PutTablePolicyCommandOutput extends __MetadataBearer {} /** - *

Creates a new maintenance configuration or replaces an existing table policy for a table. + *

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.

+ *
+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3tables/src/commands/RenameTableCommand.ts b/clients/client-s3tables/src/commands/RenameTableCommand.ts index 3da95bbc59ba..e81942f93be8 100644 --- a/clients/client-s3tables/src/commands/RenameTableCommand.ts +++ b/clients/client-s3tables/src/commands/RenameTableCommand.ts @@ -28,7 +28,13 @@ export interface RenameTableCommandInput extends RenameTableRequest {} export interface RenameTableCommandOutput extends __MetadataBearer {} /** - *

Renames a table or a namespace.

+ *

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.

+ *
+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3tables/src/commands/UpdateTableMetadataLocationCommand.ts b/clients/client-s3tables/src/commands/UpdateTableMetadataLocationCommand.ts index 3b0f377dbc45..3374a660a673 100644 --- a/clients/client-s3tables/src/commands/UpdateTableMetadataLocationCommand.ts +++ b/clients/client-s3tables/src/commands/UpdateTableMetadataLocationCommand.ts @@ -33,7 +33,13 @@ export interface UpdateTableMetadataLocationCommandOutput __MetadataBearer {} /** - *

Updates the metadata location for a table.

+ *

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.

+ *
+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3tables/src/models/models_0.ts b/clients/client-s3tables/src/models/models_0.ts index 4c28128dc956..4bb88dac8eee 100644 --- a/clients/client-s3tables/src/models/models_0.ts +++ b/clients/client-s3tables/src/models/models_0.ts @@ -191,6 +191,92 @@ export const OpenTableFormat = { */ export type OpenTableFormat = (typeof OpenTableFormat)[keyof typeof OpenTableFormat]; +/** + *

Contains details about a schema field.

+ * @public + */ +export interface SchemaField { + /** + *

The name of the field.

+ * @public + */ + name: string | undefined; + + /** + *

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

+ * @public + */ + type: string | undefined; + + /** + *

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.

+ * @public + */ + required?: boolean | undefined; +} + +/** + *

Contains details about the schema for an Iceberg table.

+ * @public + */ +export interface IcebergSchema { + /** + *

The schema fields for the table

+ * @public + */ + fields: SchemaField[] | undefined; +} + +/** + *

Contains details about the metadata for an Iceberg table.

+ * @public + */ +export interface IcebergMetadata { + /** + *

The schema for an Iceberg table.

+ * @public + */ + schema: IcebergSchema | undefined; +} + +/** + *

Contains details about the table metadata.

+ * @public + */ +export type TableMetadata = TableMetadata.IcebergMember | TableMetadata.$UnknownMember; + +/** + * @public + */ +export namespace TableMetadata { + /** + *

Contains details about the metadata of an Iceberg table.

+ * @public + */ + export interface IcebergMember { + iceberg: IcebergMetadata; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + iceberg?: never; + $unknown: [string, any]; + } + + export interface Visitor { + iceberg: (value: IcebergMetadata) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: TableMetadata, visitor: Visitor): T => { + if (value.iceberg !== undefined) return visitor.iceberg(value.iceberg); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; +} + /** * @public */ @@ -218,6 +304,12 @@ export interface CreateTableRequest { * @public */ format: OpenTableFormat | undefined; + + /** + *

The metadata for the table.

+ * @public + */ + metadata?: TableMetadata | undefined; } /** @@ -321,7 +413,7 @@ export interface DeleteTableBucketRequest { */ export interface DeleteTableBucketPolicyRequest { /** - *

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

+ *

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

* @public */ tableBucketARN: string | undefined; @@ -332,7 +424,7 @@ export interface DeleteTableBucketPolicyRequest { */ export interface DeleteTablePolicyRequest { /** - *

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

+ *

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

* @public */ tableBucketARN: string | undefined; @@ -706,7 +798,7 @@ export interface GetTableBucketMaintenanceConfigurationResponse { */ export interface GetTableBucketPolicyRequest { /** - *

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

+ *

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

* @public */ tableBucketARN: string | undefined; @@ -717,7 +809,7 @@ export interface GetTableBucketPolicyRequest { */ export interface GetTableBucketPolicyResponse { /** - *

The name of the resource policy.

+ *

The JSON that defines the policy.

* @public */ resourcePolicy: string | undefined; @@ -1031,7 +1123,7 @@ export interface GetTableMetadataLocationResponse { */ export interface GetTablePolicyRequest { /** - *

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

+ *

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

* @public */ tableBucketARN: string | undefined; @@ -1054,7 +1146,7 @@ export interface GetTablePolicyRequest { */ export interface GetTablePolicyResponse { /** - *

The name of the resource policy.

+ *

The JSON that defines the policy.

* @public */ resourcePolicy: string | undefined; @@ -1171,7 +1263,7 @@ export interface ListTableBucketsRequest { */ export interface TableBucketSummary { /** - *

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

+ *

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

* @public */ arn: string | undefined; @@ -1217,7 +1309,7 @@ export interface ListTableBucketsResponse { */ export interface ListTablesRequest { /** - *

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

+ *

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

* @public */ tableBucketARN: string | undefined; @@ -1274,7 +1366,7 @@ export interface TableSummary { type: TableType | undefined; /** - *

The Amazon Resource Number (ARN) of the table.

+ *

The Amazon Resource Name (ARN) of the table.

* @public */ tableARN: string | undefined; @@ -1338,13 +1430,13 @@ export interface PutTableBucketMaintenanceConfigurationRequest { */ export interface PutTableBucketPolicyRequest { /** - *

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

+ *

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

* @public */ tableBucketARN: string | undefined; /** - *

The name of the resource policy.

+ *

The JSON that defines the policy.

* @public */ resourcePolicy: string | undefined; @@ -1391,7 +1483,7 @@ export interface PutTableMaintenanceConfigurationRequest { */ export interface PutTablePolicyRequest { /** - *

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

+ *

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

* @public */ tableBucketARN: string | undefined; @@ -1409,7 +1501,7 @@ export interface PutTablePolicyRequest { name: string | undefined; /** - *

The name of the resource policy.

+ *

The JSON that defines the policy.

* @public */ resourcePolicy: string | undefined; @@ -1502,7 +1594,7 @@ export interface UpdateTableMetadataLocationResponse { name: string | undefined; /** - *

The Amazon Resource Number (ARN) of the table.

+ *

The Amazon Resource Name (ARN) of the table.

* @public */ tableARN: string | undefined; diff --git a/clients/client-s3tables/src/protocols/Aws_restJson1.ts b/clients/client-s3tables/src/protocols/Aws_restJson1.ts index b7d9f85028d6..9b0be81d59b8 100644 --- a/clients/client-s3tables/src/protocols/Aws_restJson1.ts +++ b/clients/client-s3tables/src/protocols/Aws_restJson1.ts @@ -84,11 +84,14 @@ import { ConflictException, ForbiddenException, IcebergCompactionSettings, + IcebergMetadata, + IcebergSchema, IcebergSnapshotManagementSettings, IcebergUnreferencedFileRemovalSettings, InternalServerErrorException, NamespaceSummary, NotFoundException, + SchemaField, TableBucketMaintenanceConfigurationValue, TableBucketMaintenanceSettings, TableBucketSummary, @@ -96,6 +99,7 @@ import { TableMaintenanceJobStatusValue, TableMaintenanceJobType, TableMaintenanceSettings, + TableMetadata, TableSummary, TooManyRequestsException, } from "../models/models_0"; @@ -142,6 +146,7 @@ export const se_CreateTableCommand = async ( body = JSON.stringify( take(input, { format: [], + metadata: (_) => _json(_), name: [], }) ); @@ -1339,12 +1344,20 @@ const de_TooManyRequestsExceptionRes = async ( // se_IcebergCompactionSettings omitted. +// se_IcebergMetadata omitted. + +// se_IcebergSchema omitted. + // se_IcebergSnapshotManagementSettings omitted. // se_IcebergUnreferencedFileRemovalSettings omitted. // se_NamespaceList omitted. +// se_SchemaField omitted. + +// se_SchemaFieldList omitted. + // se_TableBucketMaintenanceConfigurationValue omitted. // se_TableBucketMaintenanceSettings omitted. @@ -1353,6 +1366,8 @@ const de_TooManyRequestsExceptionRes = async ( // se_TableMaintenanceSettings omitted. +// se_TableMetadata omitted. + // de_IcebergCompactionSettings omitted. // de_IcebergSnapshotManagementSettings omitted. diff --git a/codegen/sdk-codegen/aws-models/s3tables.json b/codegen/sdk-codegen/aws-models/s3tables.json index 0d0c8014e966..432bc7c878bd 100644 --- a/codegen/sdk-codegen/aws-models/s3tables.json +++ b/codegen/sdk-codegen/aws-models/s3tables.json @@ -79,7 +79,7 @@ } ], "traits": { - "smithy.api#documentation": "

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 Table namespaces.

", + "smithy.api#documentation": "

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.

\n
\n
Permissions
\n
\n

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

\n
\n
", "smithy.api#http": { "uri": "/namespaces/{tableBucketARN}", "method": "PUT", @@ -165,7 +165,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new table associated with the given namespace in a table bucket.

", + "smithy.api#documentation": "

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.

\n
\n
Permissions
\n
\n

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

\n \n

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

\n \n
\n
", "smithy.api#http": { "uri": "/tables/{tableBucketARN}/{namespace}", "method": "PUT", @@ -202,7 +202,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a table bucket.

", + "smithy.api#documentation": "

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

\n
\n
Permissions
\n
\n

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

\n
\n
", "smithy.api#http": { "uri": "/buckets", "method": "PUT", @@ -272,6 +272,12 @@ "smithy.api#documentation": "

The format for the table.

", "smithy.api#required": {} } + }, + "metadata": { + "target": "com.amazonaws.s3tables#TableMetadata", + "traits": { + "smithy.api#documentation": "

The metadata for the table.

" + } } }, "traits": { @@ -329,7 +335,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a namespace.

", + "smithy.api#documentation": "

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

\n
\n
Permissions
\n
\n

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

\n
\n
", "smithy.api#http": { "uri": "/namespaces/{tableBucketARN}/{namespace}", "method": "DELETE", @@ -391,7 +397,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a table.

", + "smithy.api#documentation": "

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

\n
\n
Permissions
\n
\n

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

\n
\n
", "smithy.api#http": { "uri": "/tables/{tableBucketARN}/{namespace}/{name}", "method": "DELETE", @@ -429,7 +435,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a table bucket.

", + "smithy.api#documentation": "

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

\n
\n
Permissions
\n
\n

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

\n
\n
", "smithy.api#http": { "uri": "/buckets/{tableBucketARN}", "method": "DELETE", @@ -467,7 +473,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a table bucket policy.

", + "smithy.api#documentation": "

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

\n
\n
Permissions
\n
\n

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

\n
\n
", "smithy.api#http": { "uri": "/buckets/{tableBucketARN}/policy", "method": "DELETE", @@ -482,7 +488,7 @@ "tableBucketARN": { "target": "com.amazonaws.s3tables#TableBucketARN", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -537,7 +543,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a table policy.

", + "smithy.api#documentation": "

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

\n
\n
Permissions
\n
\n

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

\n
\n
", "smithy.api#http": { "uri": "/tables/{tableBucketARN}/{namespace}/{name}/policy", "method": "DELETE", @@ -552,7 +558,7 @@ "tableBucketARN": { "target": "com.amazonaws.s3tables#TableBucketARN", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -665,7 +671,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets details about a namespace.

", + "smithy.api#documentation": "

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

\n
\n
Permissions
\n
\n

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

\n
\n
", "smithy.api#http": { "uri": "/namespaces/{tableBucketARN}/{namespace}", "method": "GET" @@ -784,7 +790,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets details about a table.

", + "smithy.api#documentation": "

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

\n
\n
Permissions
\n
\n

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

\n
\n
", "smithy.api#http": { "uri": "/tables/{tableBucketARN}/{namespace}/{name}", "method": "GET" @@ -843,7 +849,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets details on a table bucket.

", + "smithy.api#documentation": "

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.

\n
\n
Permissions
\n
\n

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

\n
\n
", "smithy.api#http": { "uri": "/buckets/{tableBucketARN}", "method": "GET" @@ -897,7 +903,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets details about a maintenance configuration for a given table bucket.

", + "smithy.api#documentation": "

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.

\n
\n
Permissions
\n
\n

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

\n
\n
", "smithy.api#http": { "uri": "/buckets/{tableBucketARN}/maintenance", "method": "GET" @@ -972,7 +978,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets details about a table bucket policy.

", + "smithy.api#documentation": "

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

\n
\n
Permissions
\n
\n

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

\n
\n
", "smithy.api#http": { "uri": "/buckets/{tableBucketARN}/policy", "method": "GET" @@ -986,7 +992,7 @@ "tableBucketARN": { "target": "com.amazonaws.s3tables#TableBucketARN", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1002,7 +1008,7 @@ "resourcePolicy": { "target": "com.amazonaws.s3tables#ResourcePolicy", "traits": { - "smithy.api#documentation": "

The name of the resource policy.

", + "smithy.api#documentation": "

The JSON that defines the policy.

", "smithy.api#required": {} } } @@ -1093,7 +1099,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets details about the maintenance configuration of a table.

", + "smithy.api#documentation": "

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

\n
\n
Permissions
\n
\n

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

\n
\n
", "smithy.api#http": { "uri": "/tables/{tableBucketARN}/{namespace}/{name}/maintenance", "method": "GET" @@ -1184,7 +1190,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the status of a maintenance job for a table.

", + "smithy.api#documentation": "

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.

\n
\n
Permissions
\n
\n

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

\n
\n
", "smithy.api#http": { "uri": "/tables/{tableBucketARN}/{namespace}/{name}/maintenance-job-status", "method": "GET" @@ -1275,7 +1281,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the location of the table metadata.

", + "smithy.api#documentation": "

Gets the location of the table metadata.

\n
\n
Permissions
\n
\n

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

\n
\n
", "smithy.api#http": { "uri": "/tables/{tableBucketARN}/{namespace}/{name}/metadata-location", "method": "GET" @@ -1372,7 +1378,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets details about a table policy.

", + "smithy.api#documentation": "

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

\n
\n
Permissions
\n
\n

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

\n
\n
", "smithy.api#http": { "uri": "/tables/{tableBucketARN}/{namespace}/{name}/policy", "method": "GET" @@ -1386,7 +1392,7 @@ "tableBucketARN": { "target": "com.amazonaws.s3tables#TableBucketARN", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1418,7 +1424,7 @@ "resourcePolicy": { "target": "com.amazonaws.s3tables#ResourcePolicy", "traits": { - "smithy.api#documentation": "

The name of the resource policy.

", + "smithy.api#documentation": "

The JSON that defines the policy.

", "smithy.api#required": {} } } @@ -1579,6 +1585,36 @@ "smithy.api#documentation": "

Contains details about the compaction settings for an Iceberg table. \n

" } }, + "com.amazonaws.s3tables#IcebergMetadata": { + "type": "structure", + "members": { + "schema": { + "target": "com.amazonaws.s3tables#IcebergSchema", + "traits": { + "smithy.api#documentation": "

The schema for an Iceberg table.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about the metadata for an Iceberg table.

" + } + }, + "com.amazonaws.s3tables#IcebergSchema": { + "type": "structure", + "members": { + "fields": { + "target": "com.amazonaws.s3tables#SchemaFieldList", + "traits": { + "smithy.api#documentation": "

The schema fields for the table

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about the schema for an Iceberg table.

" + } + }, "com.amazonaws.s3tables#IcebergSnapshotManagementSettings": { "type": "structure", "members": { @@ -1693,7 +1729,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the namespaces within a table bucket.

", + "smithy.api#documentation": "

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

\n
\n
Permissions
\n
\n

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

\n
\n
", "smithy.api#http": { "uri": "/namespaces/{tableBucketARN}", "method": "GET" @@ -1827,7 +1863,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists table buckets for your account.

", + "smithy.api#documentation": "

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

\n
\n
Permissions
\n
\n

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

\n
\n
", "smithy.api#http": { "uri": "/buckets", "method": "GET" @@ -1946,7 +1982,7 @@ } ], "traits": { - "smithy.api#documentation": "

List tables in the given table bucket.

", + "smithy.api#documentation": "

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

\n
\n
Permissions
\n
\n

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

\n
\n
", "smithy.api#http": { "uri": "/tables/{tableBucketARN}", "method": "GET" @@ -1960,7 +1996,7 @@ "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { - "id": "GetTable_AccessDeniedException", + "id": "ListTables_AccessDeniedException", "params": { "tableBucketARN": "arn:aws:s3tables:us-east-1:123456789012:bucket/does-not-exist" }, @@ -1992,7 +2028,7 @@ "tableBucketARN": { "target": "com.amazonaws.s3tables#TableBucketARN", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2228,7 +2264,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new maintenance configuration or replaces an existing maintenance configuration\n for a table bucket.

", + "smithy.api#documentation": "

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

\n
\n
Permissions
\n
\n

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

\n
\n
", "smithy.api#http": { "uri": "/buckets/{tableBucketARN}/maintenance/{type}", "method": "PUT", @@ -2296,7 +2332,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new maintenance configuration or replaces an existing table bucket policy for a\n table bucket.

", + "smithy.api#documentation": "

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

\n
\n
Permissions
\n
\n

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

\n
\n
", "smithy.api#http": { "uri": "/buckets/{tableBucketARN}/policy", "method": "PUT", @@ -2311,7 +2347,7 @@ "tableBucketARN": { "target": "com.amazonaws.s3tables#TableBucketARN", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2319,7 +2355,7 @@ "resourcePolicy": { "target": "com.amazonaws.s3tables#ResourcePolicy", "traits": { - "smithy.api#documentation": "

The name of the resource policy.

", + "smithy.api#documentation": "

The JSON that defines the policy.

", "smithy.api#required": {} } } @@ -2357,7 +2393,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new maintenance configuration or replaces an existing maintenance configuration\n for a table.

", + "smithy.api#documentation": "

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

\n
\n
Permissions
\n
\n

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

\n
\n
", "smithy.api#http": { "uri": "/tables/{tableBucketARN}/{namespace}/{name}/maintenance/{type}", "method": "PUT", @@ -2441,7 +2477,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new maintenance configuration or replaces an existing table policy for a table.\n

", + "smithy.api#documentation": "

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.\n

\n
\n
Permissions
\n
\n

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

\n
\n
", "smithy.api#http": { "uri": "/tables/{tableBucketARN}/{namespace}/{name}/policy", "method": "PUT", @@ -2456,7 +2492,7 @@ "tableBucketARN": { "target": "com.amazonaws.s3tables#TableBucketARN", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2480,7 +2516,7 @@ "resourcePolicy": { "target": "com.amazonaws.s3tables#ResourcePolicy", "traits": { - "smithy.api#documentation": "

The name of the resource policy.

", + "smithy.api#documentation": "

The JSON that defines the policy.

", "smithy.api#required": {} } } @@ -2518,7 +2554,7 @@ } ], "traits": { - "smithy.api#documentation": "

Renames a table or a namespace.

", + "smithy.api#documentation": "

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

\n
\n
Permissions
\n
\n

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

\n
\n
", "smithy.api#http": { "uri": "/tables/{tableBucketARN}/{namespace}/{name}/rename", "method": "PUT", @@ -3284,6 +3320,41 @@ } } }, + "com.amazonaws.s3tables#SchemaField": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the field.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "required": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

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.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about a schema field.

" + } + }, + "com.amazonaws.s3tables#SchemaFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3tables#SchemaField" + } + }, "com.amazonaws.s3tables#TableARN": { "type": "string", "traits": { @@ -3419,7 +3490,7 @@ "arn": { "target": "com.amazonaws.s3tables#TableBucketARN", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, @@ -3582,6 +3653,20 @@ } } }, + "com.amazonaws.s3tables#TableMetadata": { + "type": "union", + "members": { + "iceberg": { + "target": "com.amazonaws.s3tables#IcebergMetadata", + "traits": { + "smithy.api#documentation": "

Contains details about the metadata of an Iceberg table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about the table metadata.

" + } + }, "com.amazonaws.s3tables#TableName": { "type": "string", "traits": { @@ -3674,7 +3759,7 @@ "tableARN": { "target": "com.amazonaws.s3tables#TableARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the table.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table.

", "smithy.api#required": {} } }, @@ -3764,7 +3849,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the metadata location for a table.

", + "smithy.api#documentation": "

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.

\n
\n
Permissions
\n
\n

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

\n
\n
", "smithy.api#http": { "uri": "/tables/{tableBucketARN}/{namespace}/{name}/metadata-location", "method": "PUT" @@ -3830,7 +3915,7 @@ "tableARN": { "target": "com.amazonaws.s3tables#TableARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the table.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table.

", "smithy.api#required": {} } },