An Amazon S3 table represents a structured dataset consisting of tabular data in Apache Parquet format and related metadata. This data is stored inside an S3 table as a subresource. All tables in a table bucket are stored in the Apache Iceberg table format. Through integration with the Amazon Web Services Glue Data Catalog you can interact with your tables using Amazon Web Services analytics services, such as Amazon Athena and Amazon Redshift. Amazon S3 manages maintenance of your tables through automatic file compaction and snapshot management. For more information, see Amazon S3 table buckets.
", "operations": { "CompleteTableMigration": "Completes the migration of a table. The table's most recent migration must be in the succeeded, failed or cancelled state. After you complete the migration, you can't sync the table again, and you can write to and maintain the table as you do any other table: compaction starts, and unreferenced file removal follows the table bucket's configuration. You can't undo this operation. Calling it again for the same table returns a ConflictException.
You must have the s3tables:CompleteTableMigration permission to use this operation.
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.
You must have the s3tables:CreateNamespace permission to use this operation.
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.
You must have the s3tables:CreateTable permission to use this operation.
If you use this operation with the optional metadata request parameter you must have the s3tables:PutTableData permission.
If you use this operation with the optional encryptionConfiguration request parameter you must have the s3tables:PutTableEncryption permission.
If you use this operation with the storageClassConfiguration request parameter, you must have the s3tables:PutTableStorageClass permission.
To create a table with tags, you must have the s3tables:TagResource permission in addition to s3tables:CreateTable permission.
Additionally, If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption.
Creates a table bucket. For more information, see Creating a table bucket in the Amazon Simple Storage Service User Guide.
You must have the s3tables:CreateTableBucket permission to use this operation.
If you use this operation with the optional encryptionConfiguration parameter you must have the s3tables:PutTableBucketEncryption permission.
If you use this operation with the storageClassConfiguration request parameter, you must have the s3tables:PutTableBucketStorageClass permission.
To create a table bucket with tags, you must have the s3tables:TagResource permission in addition to s3tables:CreateTableBucket permission.
Deletes a namespace. For more information, see Delete a namespace in the Amazon Simple Storage Service User Guide.
You must have the s3tables:DeleteNamespace permission to use this operation.
Deletes a table. For more information, see Deleting an Amazon S3 table in the Amazon Simple Storage Service User Guide.
You must have the s3tables:DeleteTable permission to use this operation.
Deletes a table bucket. For more information, see Deleting a table bucket in the Amazon Simple Storage Service User Guide.
You must have the s3tables:DeleteTableBucket permission to use this operation.
Deletes the encryption configuration for a table bucket.
You must have the s3tables:DeleteTableBucketEncryption permission to use this operation.
Deletes the metrics configuration for a table bucket.
You must have the s3tables:DeleteTableBucketMetricsConfiguration permission to use this operation.
Deletes a table bucket policy. For more information, see Deleting a table bucket policy in the Amazon Simple Storage Service User Guide.
You must have the s3tables:DeleteTableBucketPolicy permission to use this operation.
Deletes the replication configuration for a table bucket. After deletion, new table updates will no longer be replicated to destination buckets, though existing replicated tables will remain in destination buckets.
You must have the s3tables:DeleteTableBucketReplication permission to use this operation.
Deletes a table policy. For more information, see Deleting a table policy in the Amazon Simple Storage Service User Guide.
You must have the s3tables:DeleteTablePolicy permission to use this operation.
Deletes the replication configuration for a specific table. After deletion, new updates to this table will no longer be replicated to destination tables, though existing replicated copies will remain in destination buckets.
You must have the s3tables:DeleteTableReplication permission to use this operation.
Gets details about a namespace. For more information, see Table namespaces in the Amazon Simple Storage Service User Guide.
You must have the s3tables:GetNamespace permission to use this operation.
Gets details about a table. For more information, see S3 Tables in the Amazon Simple Storage Service User Guide.
You must have the s3tables:GetTable permission to use this operation.
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.
You must have the s3tables:GetTableBucket permission to use this operation.
Gets the encryption configuration for a table bucket.
You must have the s3tables:GetTableBucketEncryption permission to use this operation.
Gets the server access logging configuration for a table bucket. For more information, see Server access logging for table buckets in the Amazon Simple Storage Service User Guide.
You must have the s3tables:GetTableBucketLogging permission to use this operation.
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.
You must have the s3tables:GetTableBucketMaintenanceConfiguration permission to use this operation.
Gets the metrics configuration for a table bucket.
You must have the s3tables:GetTableBucketMetricsConfiguration permission to use this operation.
Gets details about a table bucket policy. For more information, see Viewing a table bucket policy in the Amazon Simple Storage Service User Guide.
You must have the s3tables:GetTableBucketPolicy permission to use this operation.
Retrieves the replication configuration for a table bucket.This operation returns the IAM role, versionToken, and replication rules that define how tables in this bucket are replicated to other buckets.
You must have the s3tables:GetTableBucketReplication permission to use this operation.
Retrieves the storage class configuration for a specific table. This allows you to view the storage class settings that apply to an individual table, which may differ from the table bucket's default configuration.
You must have the s3tables:GetTableBucketStorageClass permission to use this operation.
Gets the encryption configuration for a table.
You must have the s3tables:GetTableEncryption permission to use this operation.
Gets details about the maintenance configuration of a table. For more information, see S3 Tables maintenance in the Amazon Simple Storage Service User Guide.
You must have the s3tables:GetTableMaintenanceConfiguration permission to use this operation.
You must have the s3tables:GetTableData permission to use set the compaction strategy to sort or zorder.
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.
You must have the s3tables:GetTableMaintenanceJobStatus permission to use this operation.
Gets the location of the table metadata.
You must have the s3tables:GetTableMetadataLocation permission to use this operation.
Gets the details of a migration, including its state, the reason it failed, its statistics and the location of its reports. Identify the migration by its migrationId, or specify the tableARN of a destination table to get that table's most recent migration.
You must have the s3tables:GetTableMigration permission to use this operation.
Gets details about a table policy. For more information, see Viewing a table policy in the Amazon Simple Storage Service User Guide.
You must have the s3tables:GetTablePolicy permission to use this operation.
Retrieves the expiration configuration settings for records in a table, and the status of the configuration. If the status of the configuration is enabled, records expire and are automatically removed from the table after the specified number of days.
You must have the s3tables:GetTableRecordExpirationConfiguration permission to use this operation.
Retrieves the status, metrics, and details of the latest record expiration job for a table. This includes when the job ran, and whether it succeeded or failed. If the job ran successfully, this also includes statistics about the records that were removed.
You must have the s3tables:GetTableRecordExpirationJobStatus permission to use this operation.
Retrieves the replication configuration for a specific table.
You must have the s3tables:GetTableReplication permission to use this operation.
Retrieves the replication status for a table, including the status of replication to each destination. This operation provides visibility into replication health and progress.
You must have the s3tables:GetTableReplicationStatus permission to use this operation.
Retrieves the storage class configuration for a specific table. This allows you to view the storage class settings that apply to an individual table, which may differ from the table bucket's default configuration.
You must have the s3tables:GetTableStorageClass permission to use this operation.
Lists the namespaces within a table bucket. For more information, see Table namespaces in the Amazon Simple Storage Service User Guide.
You must have the s3tables:ListNamespaces permission to use this operation.
Lists table buckets for your account. For more information, see S3 Table buckets in the Amazon Simple Storage Service User Guide.
You must have the s3tables:ListTableBuckets permission to use this operation.
Lists the migrations whose destination is in a table bucket, a namespace or a table. Specify a tableBucketARN to list the migrations into a table bucket, and add a namespace, or a namespace and a name, to narrow the list. Or specify a tableARN to list the migrations into a table.
Migrations are listed newest first. Results are paginated: use maxResults to set the page size, and pass the nextToken from a response to retrieve the next page of results. A page can contain fewer migrations than maxResults, or none, and still return a nextToken. Continue until a response has no nextToken.
You must have the s3tables:ListTableMigrations permission to use this operation.
List tables in the given table bucket. For more information, see S3 Tables in the Amazon Simple Storage Service User Guide.
You must have the s3tables:ListTables permission to use this operation.
Lists all of the tags applied to a specified Amazon S3 Tables resource. Each tag is a label consisting of a key and value pair. Tags can help you organize, track costs for, and control access to resources.
For a list of S3 resources that support tagging, see Managing tags for Amazon S3 resources.
For tables and table buckets, you must have the s3tables:ListTagsForResource permission to use this operation.
Sets the encryption configuration for a table bucket.
You must have the s3tables:PutTableBucketEncryption permission to use this operation.
If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption in the Amazon Simple Storage Service User Guide.
Sets, updates, or removes the server access logging configuration for a table bucket. When logging is enabled, Amazon S3 delivers a record of the requests made to the table bucket and its tables to the target general purpose bucket that you specify. To disable logging, call this operation with an empty tableBucketLoggingStatus. For more information, see Server access logging for table buckets in the Amazon Simple Storage Service User Guide.
You must have the s3tables:PutTableBucketLogging permission to use this operation.
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.
You must have the s3tables:PutTableBucketMaintenanceConfiguration permission to use this operation.
Sets the metrics configuration for a table bucket.
You must have the s3tables:PutTableBucketMetricsConfiguration permission to use this operation.
Creates a new table bucket policy or replaces an existing table bucket policy for a table bucket. For more information, see Adding a table bucket policy in the Amazon Simple Storage Service User Guide.
You must have the s3tables:PutTableBucketPolicy permission to use this operation.
Creates or updates the replication configuration for a table bucket. This operation defines how tables in the source bucket are replicated to destination buckets. Replication helps ensure data availability and disaster recovery across regions or accounts.
You must have the s3tables:PutTableBucketReplication permission to use this operation. The IAM role specified in the configuration must have permissions to read from the source bucket and write permissions to all destination buckets.
You must also have the following permissions:
s3tables:GetTable permission on the source table.
s3tables:ListTables permission on the bucket containing the table.
s3tables:CreateTable permission for the destination.
s3tables:CreateNamespace permission for the destination.
s3tables:GetTableMaintenanceConfig permission for the source bucket.
s3tables:PutTableMaintenanceConfig permission for the destination bucket.
You must have iam:PassRole permission with condition allowing roles to be passed to replication.s3tables.amazonaws.com.
Sets or updates the storage class configuration for a table bucket. This configuration serves as the default storage class for all new tables created in the bucket, allowing you to optimize storage costs at the bucket level.
You must have the s3tables:PutTableBucketStorageClass permission to use this operation.
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.
You must have the s3tables:PutTableMaintenanceConfiguration permission to use this operation.
Creates a new table policy or replaces an existing table policy for a table. For more information, see Adding a table policy in the Amazon Simple Storage Service User Guide.
You must have the s3tables:PutTablePolicy permission to use this operation.
Creates or updates the expiration configuration settings for records in a table, including the status of the configuration. If you enable record expiration for a table, records expire and are automatically removed from the table after the number of days that you specify.
You must have the s3tables:PutTableRecordExpirationConfiguration permission to use this operation.
Creates or updates the replication configuration for a specific table. This operation allows you to define table-level replication independently of bucket-level replication, providing granular control over which tables are replicated and where.
You must have the s3tables:PutTableReplication permission to use this operation. The IAM role specified in the configuration must have permissions to read from the source table and write to all destination tables.
You must also have the following permissions:
s3tables:GetTable permission on the source table being replicated.
s3tables:CreateTable permission for the destination.
s3tables:CreateNamespace permission for the destination.
s3tables:GetTableMaintenanceConfig permission for the source table.
s3tables:PutTableMaintenanceConfig permission for the destination table.
You must have iam:PassRole permission with condition allowing roles to be passed to replication.s3tables.amazonaws.com.
Renames a table or a namespace. For more information, see S3 Tables in the Amazon Simple Storage Service User Guide.
You must have the s3tables:RenameTable permission to use this operation.
Starts migrating an Amazon Web Services Glue Data Catalog table into a new table in a table bucket. The migration runs asynchronously: this operation returns the migration ID and its initial state, and you track progress with GetTableMigration.
The namespace must already exist, and a table with the specified name must not. The migration creates the table during planning and commits data to it as it runs. Until you call CompleteTableMigration, you can read the table but you can't write to it. If the migration fails or is cancelled, the table and the data already committed to it remain.
The migration first checks the source and the destination, and writes the table compatibility and object compatibility reports to the bucket that you specify in migrationOutput. If you set reviewMigrationPlan to true, the migration waits in the pendingReview state so that you can review the reports, and continues only when you call UpdateTableMigration with requestedState set to queued. If you don't continue or cancel the migration within 30 days, the migration fails. Otherwise it continues to migrate the data, and writes the object migration report when the migration ends. If planning fails, the migration writes no object migration report.
You must have the s3tables:StartTableMigration permission to use this operation.
You must have the iam:PassRole permission on the role that you specify in roleARN, with a condition that allows passing it to migration.s3tables.amazonaws.com. The associated resource is the table bucket.
If destinationTable specifies SSE-KMS encryption, you must have the kms:DescribeKey and kms:GenerateDataKey permissions on the KMS key. You must also grant the S3 Tables maintenance principal access to the key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption.
Migrates the changes in the source table since the previous start or sync, such as added and deleted source objects, into the destination table. The sync runs asynchronously: this operation returns the migration ID of the sync and its initial state, and you track progress with GetTableMigration.
A sync uses the source, destination and data migration settings of the table's migration, and plans the work and writes its reports in the same way as StartTableMigration. You can sync after a start or sync that succeeded, failed or was cancelled, if an earlier start or sync of the table has a valid plan (hasValidPlan). You can't sync a table while a start or sync is in progress for it, and you can sync a table until you call CompleteTableMigration for it. If a source object that an earlier migration migrated has since been overwritten, the sync fails.
You must have the s3tables:SyncTableMigration permission to use this operation.
You must have the iam:PassRole permission on the role that you specify in roleARN, with a condition that allows passing it to migration.s3tables.amazonaws.com. The associated resource is the table.
Applies one or more user-defined tags to an Amazon S3 Tables resource or updates existing tags. Each tag is a label consisting of a key and value pair. Tags can help you organize, track costs for, and control access to your resources. You can add up to 50 tags for each S3 resource.
For a list of S3 resources that support tagging, see Managing tags for Amazon S3 resources.
For tables and table buckets, you must have the s3tables:TagResource permission to use this operation.
Removes the specified user-defined tags from an Amazon S3 Tables resource. You can pass one or more tag keys.
For a list of S3 resources that support tagging, see Managing tags for Amazon S3 resources.
For tables and table buckets, you must have the s3tables:UntagResource permission to use this operation.
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.
You must have the s3tables:UpdateTableMetadataLocation permission to use this operation.
Requests a state change for a migration. Identify the migration by its migrationId or by the tableARN of its destination table.
Set requestedState to queued to continue a migration in the pendingReview state; the migration moves to queued or migrating. Set it to cancelled to cancel a migration in the new, planning, pendingReview, queued or migrating state; the migration moves to cancelling, finishes the work in progress, and then ends in the cancelled state, or in the failed state if any objects failed to migrate. Data that the migration already committed stays in the destination table.
You must have the s3tables:UpdateTableMigration permission to use this operation.
The action cannot be performed because you do not have the required permission.
", "refs": {} }, "AccountId": { "base": null, "refs": { "GetNamespaceResponse$createdBy": "The ID of the account that created the namespace.
", "GetNamespaceResponse$ownerAccountId": "The ID of the account that owns the namespcace.
", "GetTableBucketResponse$ownerAccountId": "The ID of the account that owns the table bucket.
", "GetTableResponse$createdBy": "The ID of the account that created the table.
", "GetTableResponse$modifiedBy": "The ID of the account that last modified the table.
", "GetTableResponse$ownerAccountId": "The ID of the account that owns the table.
", "NamespaceSummary$createdBy": "The ID of the account that created the namespace.
", "NamespaceSummary$ownerAccountId": "The ID of the account that owns the namespace.
", "TableBucketSummary$ownerAccountId": "The ID of the account that owns the table bucket.
" } }, "BadRequestException": { "base": "The request is invalid or malformed.
", "refs": {} }, "Boolean": { "base": null, "refs": { "GetTableMigrationResponse$reviewMigrationPlan": "A Boolean value that specifies whether the migration waits in the pendingReview state, so that you can review the compatibility reports before it migrates any data.
A Boolean value that specifies whether planning produced a plan that the migration can run. If planning hasn't finished, this value isn't returned.
", "ListTableMigrationsRequest$hasValidPlan": "The hasValidPlan value to filter the list by. Migrations that are still planning aren't listed, whichever value you specify.
A Boolean value that specifies whether planning produced a plan that the migration can run. If planning hasn't finished, this value isn't returned.
", "MigrationTableProperties$dictionaryEncoding": "Specifies whether the data files use dictionary encoding. The default is true.
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.
A Boolean value that specifies whether values are required for each row in this field. If this is true, the field does not allow null values.
Specifies whether the migration waits in the pendingReview state, so that you can review the compatibility reports before it migrates any data. If true, the migration continues when you call UpdateTableMigration with requestedState set to queued. If you don't continue or cancel the migration within 30 days, the migration fails. The default is false.
Specifies whether the sync waits in the pendingReview state, so that you can review the compatibility reports before it migrates any data. If true, the migration continues when you call UpdateTableMigration with requestedState set to queued. If you don't continue or cancel the migration within 30 days, the migration fails. The default is false.
The Base64-encoded CRC64NVME checksum of the object that key names. For a report that has a manifest, the manifest lists the checksum of each report file. This value is returned after the migration writes the report.
The compression codec of the data files. The default is zstd.
The request failed because there is a conflict with a previous write. You can retry the request.
", "refs": {} }, "CreateNamespaceRequest": { "base": null, "refs": {} }, "CreateNamespaceRequestNamespaceList": { "base": null, "refs": { "CreateNamespaceRequest$namespace": "A name for the namespace.
" } }, "CreateNamespaceResponse": { "base": null, "refs": {} }, "CreateTableBucketRequest": { "base": null, "refs": {} }, "CreateTableBucketResponse": { "base": null, "refs": {} }, "CreateTableRequest": { "base": null, "refs": {} }, "CreateTableResponse": { "base": null, "refs": {} }, "DataFileFormat": { "base": null, "refs": { "MigrationTableProperties$writeFormat": "The file format of the data files. The only supported format is parquet, the default.
The maintenance settings and migration policies for the destination table.
", "refs": { "GetTableMigrationResponse$dataMigration": "The maintenance settings and migration policies for the destination table.
" } }, "DataMigrationSettings": { "base": "The maintenance settings and migration policies for the destination table.
", "refs": { "StartTableMigrationRequest$dataMigration": "The maintenance settings and migration policies for the destination table.
" } }, "DeleteNamespaceRequest": { "base": null, "refs": {} }, "DeleteTableBucketEncryptionRequest": { "base": null, "refs": {} }, "DeleteTableBucketMetricsConfigurationRequest": { "base": null, "refs": {} }, "DeleteTableBucketPolicyRequest": { "base": null, "refs": {} }, "DeleteTableBucketReplicationRequest": { "base": null, "refs": {} }, "DeleteTableBucketRequest": { "base": null, "refs": {} }, "DeleteTablePolicyRequest": { "base": null, "refs": {} }, "DeleteTableReplicationRequest": { "base": null, "refs": {} }, "DeleteTableRequest": { "base": null, "refs": {} }, "DestinationTable": { "base": "The table that a migration creates in a table bucket and migrates the source into.
", "refs": { "StartTableMigrationRequest$destinationTable": "The table to create and migrate the source into.
" } }, "Document": { "base": null, "refs": { "SchemaV2Field$type": "The data type of the field. This can be a primitive type string such as boolean, int, long, float, double, string, binary, date, timestamp, or timestamptz, or a complex type represented as a JSON object for nested types such as struct, list, or map. For more information, see the Apache Iceberg schemas and data types documentation.
Configuration specifying how data should be encrypted. This structure defines the encryption algorithm and optional KMS key to be used for server-side encryption.
", "refs": { "CreateTableBucketRequest$encryptionConfiguration": "The encryption configuration to use for the table bucket. This configuration specifies the default encryption settings that will be applied to all tables created in this bucket unless overridden at the table level. The configuration includes the encryption algorithm and, if using SSE-KMS, the KMS key to use.
", "CreateTableRequest$encryptionConfiguration": "The encryption configuration to use for the table. This configuration specifies the encryption algorithm and, if using SSE-KMS, the KMS key to use for encrypting the table.
If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption.
The encryption configuration for the table. If you don't specify one, the table uses the default encryption configuration of its table bucket. If you specify an encryption configuration, the migration role must have the s3tables:PutTableEncryption permission. If you choose SSE-KMS, the migration role must have the kms:DescribeKey, kms:GenerateDataKey and kms:Decrypt permissions on the KMS key, and the S3 Tables maintenance principal must have access to it. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption.
The encryption configuration for the table bucket.
", "GetTableEncryptionResponse$encryptionConfiguration": "The encryption configuration for the table.
", "PutTableBucketEncryptionRequest$encryptionConfiguration": "The encryption configuration to apply to the table bucket.
" } }, "EncryptionConfigurationKmsKeyArnString": { "base": null, "refs": { "EncryptionConfiguration$kmsKeyArn": "The Amazon Resource Name (ARN) of the KMS key to use for encryption. This field is required only when sseAlgorithm is set to aws:kms.
The category of a compatibility report finding, by what you change to fix it. Valid values:
access - A permission or a request setting. You don't need to change the source.
metadata - The Amazon Web Services Glue table definition, or properties of a source object, such as its size, storage class, encryption or Parquet types.
data - The contents of a source object, such as a partition value that can't be read, an object overwritten after an earlier migration, or a corrupt file.
internal - An internal error in S3 Tables. Retry the migration, and contact Amazon Web Services Support if the error persists.
For the compatibility reports, the number of blocking findings in each category. The object compatibility report counts each blocked object once, under its most severe finding. Categories with no blocking findings are left out.
" } }, "ForbiddenException": { "base": "The caller isn't authorized to make the request.
", "refs": {} }, "GetNamespaceRequest": { "base": null, "refs": {} }, "GetNamespaceResponse": { "base": null, "refs": {} }, "GetTableBucketEncryptionRequest": { "base": null, "refs": {} }, "GetTableBucketEncryptionResponse": { "base": null, "refs": {} }, "GetTableBucketLoggingRequest": { "base": null, "refs": {} }, "GetTableBucketLoggingResponse": { "base": null, "refs": {} }, "GetTableBucketMaintenanceConfigurationRequest": { "base": null, "refs": {} }, "GetTableBucketMaintenanceConfigurationResponse": { "base": null, "refs": {} }, "GetTableBucketMetricsConfigurationRequest": { "base": null, "refs": {} }, "GetTableBucketMetricsConfigurationResponse": { "base": null, "refs": {} }, "GetTableBucketPolicyRequest": { "base": null, "refs": {} }, "GetTableBucketPolicyResponse": { "base": null, "refs": {} }, "GetTableBucketReplicationRequest": { "base": null, "refs": {} }, "GetTableBucketReplicationResponse": { "base": null, "refs": {} }, "GetTableBucketRequest": { "base": null, "refs": {} }, "GetTableBucketResponse": { "base": null, "refs": {} }, "GetTableBucketStorageClassRequest": { "base": null, "refs": {} }, "GetTableBucketStorageClassResponse": { "base": null, "refs": {} }, "GetTableEncryptionRequest": { "base": null, "refs": {} }, "GetTableEncryptionResponse": { "base": null, "refs": {} }, "GetTableMaintenanceConfigurationRequest": { "base": null, "refs": {} }, "GetTableMaintenanceConfigurationResponse": { "base": null, "refs": {} }, "GetTableMaintenanceJobStatusRequest": { "base": null, "refs": {} }, "GetTableMaintenanceJobStatusResponse": { "base": null, "refs": {} }, "GetTableMetadataLocationRequest": { "base": null, "refs": {} }, "GetTableMetadataLocationResponse": { "base": null, "refs": {} }, "GetTableMigrationRequest": { "base": null, "refs": {} }, "GetTableMigrationResponse": { "base": null, "refs": {} }, "GetTablePolicyRequest": { "base": null, "refs": {} }, "GetTablePolicyResponse": { "base": null, "refs": {} }, "GetTableRecordExpirationConfigurationRequest": { "base": null, "refs": {} }, "GetTableRecordExpirationConfigurationResponse": { "base": null, "refs": {} }, "GetTableRecordExpirationJobStatusRequest": { "base": null, "refs": {} }, "GetTableRecordExpirationJobStatusResponse": { "base": null, "refs": {} }, "GetTableReplicationRequest": { "base": null, "refs": {} }, "GetTableReplicationResponse": { "base": null, "refs": {} }, "GetTableReplicationStatusRequest": { "base": null, "refs": {} }, "GetTableReplicationStatusResponse": { "base": null, "refs": {} }, "GetTableRequest": { "base": null, "refs": {} }, "GetTableResponse": { "base": null, "refs": {} }, "GetTableStorageClassRequest": { "base": null, "refs": {} }, "GetTableStorageClassResponse": { "base": null, "refs": {} }, "GlueTableSource": { "base": "An Amazon Web Services Glue Data Catalog table to migrate. The table must be an external Apache Hive table whose data is stored as Parquet in a general purpose bucket in the same account and Region as the table bucket. Views, transactional (ACID) tables, tables in an open table format such as Apache Iceberg, and tables registered with Amazon Web Services Lake Formation can't be migrated. If the table can't be migrated, the migration fails, and the table compatibility report lists the reason.
", "refs": { "SourceConfiguration$glueTable": "An Amazon Web Services Glue Data Catalog table to migrate. The table must be an external Apache Hive table whose data is stored as Parquet in a general purpose bucket in the same account and Region as the table bucket. Views, transactional (ACID) tables, tables in an open table format such as Apache Iceberg, and tables registered with Amazon Web Services Lake Formation can't be migrated. If the table can't be migrated, the migration fails, and the table compatibility report lists the reason.
" } }, "GlueTableSourceCatalogIdString": { "base": null, "refs": { "GlueTableSource$catalogId": "The ID of the Data Catalog that contains the table. It must be your account ID.
" } }, "GlueTableSourceDatabaseNameString": { "base": null, "refs": { "GlueTableSource$databaseName": "The name of the database that contains the table.
" } }, "GlueTableSourceTableNameString": { "base": null, "refs": { "GlueTableSource$tableName": "The name of the table.
" } }, "IAMRole": { "base": null, "refs": { "TableBucketReplicationConfiguration$role": "The Amazon Resource Name (ARN) of the IAM role that S3 Tables assumes to replicate tables on your behalf.
", "TableReplicationConfiguration$role": "The Amazon Resource Name (ARN) of the IAM role that S3 Tables assumes to replicate the table on your behalf.
" } }, "IcebergCompactionSettings": { "base": "Contains details about the compaction settings for an Iceberg table.
", "refs": { "TableMaintenanceSettings$icebergCompaction": "Contains details about the Iceberg compaction settings for the table.
" } }, "IcebergCompactionStrategy": { "base": null, "refs": { "IcebergCompactionSettings$strategy": "The compaction strategy to use for the table. This determines how files are selected and combined during compaction operations.
", "MigrationCompactionSettings$strategy": "The compaction strategy. The only valid value is binpack, which is the default.
Contains details about the metadata for an Iceberg table.
", "refs": { "TableMetadata$iceberg": "Contains details about the metadata of an Iceberg table.
" } }, "IcebergNullOrder": { "base": null, "refs": { "IcebergSortField$nullOrder": "Specifies how null values are ordered. Valid values are nulls-first to place nulls before non-null values, or nulls-last to place nulls after non-null values.
Defines a single partition field in an Iceberg partition specification.
", "refs": { "IcebergPartitionFieldList$member": null } }, "IcebergPartitionFieldList": { "base": null, "refs": { "IcebergPartitionSpec$fields": "The list of partition fields that define how the table data is partitioned. Each field specifies a source field and a transform to apply. This field is required if partitionSpec is provided.
Defines how data in an Iceberg table is partitioned. Partitioning helps optimize query performance by organizing data into separate files based on field values. Each partition field specifies a transform to apply to a source field.
", "refs": { "IcebergMetadata$partitionSpec": "The partition specification for the Iceberg table. Partitioning organizes data into separate files based on the values of one or more fields, which can improve query performance by reducing the amount of data scanned. Each partition field applies a transform (such as identity, year, month, or bucket) to a single field.
" } }, "IcebergSchema": { "base": "Contains details about the schema for an Iceberg table.
", "refs": { "IcebergMetadata$schema": "The schema for an Iceberg table. Use this property to define table schemas with primitive types only. For schemas that include nested or complex types such as struct, list, or map, use schemaV2 instead.
Contains details about the schema for an Iceberg table using the V2 format. This schema format supports nested and complex data types such as struct, list, and map, in addition to primitive types.
The schema of the table to create. If you don't specify a schema, the migration infers it from the source table, with every column optional. A schema that you specify must include every partition column of the source table. It can leave out other columns only if unmatchedSourceFieldsPolicy is drop. A struct column must have the same fields as the source column. Column default values aren't supported. If you mark a column as required, every source object must have a value for it: an object with a null value in a required column fails to migrate. The destination table is partitioned in the same way as the source table. To specify fields in icebergSortOrder, you must specify a schema.
The schema for an Iceberg table using the V2 format. Use this property to define table schemas that include nested or complex data types such as struct, list, or map, in addition to primitive types. For schemas with only primitive types, you can use either schema or schemaV2.
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.
Contains details about the Iceberg snapshot management settings for the table.
" } }, "IcebergSortDirection": { "base": null, "refs": { "IcebergSortField$direction": "The sort direction. Valid values are asc for ascending order or desc for descending order.
Defines a single sort field in an Iceberg sort order specification.
", "refs": { "IcebergSortFieldList$member": null } }, "IcebergSortFieldList": { "base": null, "refs": { "IcebergSortOrder$fields": "The list of sort fields that define how data is sorted within files. Each field specifies a source field, sort direction, and null ordering. This field is required if writeOrder is provided.
Defines the sort order for data within an Iceberg table. Sorting data can improve query performance by enabling more efficient data skipping.
", "refs": { "DestinationTable$icebergSortOrder": "The sort order of the rows within each data file that the migration writes. A sort order can have up to five fields, each naming a column of the schema that you specify by its field ID, so to use a sort order you must specify a schema. StartTableMigration rejects a field that names no column of the schema, or whose transform doesn't fit the column's type.
The sort order for the Iceberg table. Sort order defines how data is sorted within data files, which can improve query performance by enabling more efficient data skipping and filtering.
" } }, "IcebergUnreferencedFileRemovalSettings": { "base": "Contains details about the unreferenced file removal settings for an Iceberg table bucket.
", "refs": { "TableBucketMaintenanceSettings$icebergUnreferencedFileRemoval": "The unreferenced file removal settings for the table bucket.
" } }, "IncompatibleValuesPolicy": { "base": null, "refs": { "MigrationPolicies$incompatibleValuesPolicy": "The migration policy for a source value that the destination column's type can't hold. Valid values:
fail - Fails the migration. This is the default.
setNull - Writes null for a value that the destination column's type can't hold. If a column's type in a source object is incompatible with the destination column's type, the column is null for that whole object.
A required column, or a type that migration doesn't support, fails the migration under either value.
" } }, "Integer": { "base": null, "refs": { "IcebergPartitionField$sourceId": "The ID of the source schema field to partition by. This must reference a valid field ID from the table schema.
", "IcebergPartitionField$fieldId": "An optional unique identifier for this partition field. If not specified, S3 Tables automatically assigns a field ID.
", "IcebergPartitionSpec$specId": "The unique identifier for this partition specification. If not specified, defaults to 0.
An optional unique identifier for the schema. Schema IDs are used by Apache Iceberg to track schema evolution.
", "IcebergSortField$sourceId": "The ID of the source schema field to sort by. This must reference a valid field ID from the table schema.
", "IcebergSortOrder$orderId": "The unique identifier for this sort order. If not specified, defaults to 1. The order ID is used by Apache Iceberg to track sort order evolution.
The Iceberg format version of the destination table. Valid values are 2 and 3. The default is 2.
An optional unique identifier for the schema field. Field IDs are used by Apache Iceberg to track schema evolution and maintain compatibility across schema changes. If not specified, S3 Tables automatically assigns field IDs.
", "SchemaV2Field$id": "The unique identifier for the schema field. Field IDs are used by Apache Iceberg to track schema evolution and maintain compatibility across schema changes.
" } }, "IntegerList": { "base": null, "refs": { "IcebergSchemaV2$identifierFieldIds": "A list of field IDs that are used as the identifier fields for the table. Identifier fields uniquely identify a row in the table.
" } }, "InternalServerErrorException": { "base": "The request failed due to an internal server error.
", "refs": {} }, "JobStatus": { "base": null, "refs": { "TableMaintenanceJobStatusValue$status": "The status of the job.
" } }, "LastSuccessfulReplicatedUpdate": { "base": "Contains information about the most recent successful replication update to a destination.
", "refs": { "ReplicationDestinationStatusModel$lastSuccessfulReplicatedUpdate": "Information about the most recent successful replication update to this destination.
" } }, "ListNamespacesLimit": { "base": null, "refs": { "ListNamespacesRequest$maxNamespaces": "The maximum number of namespaces to return in the list.
" } }, "ListNamespacesRequest": { "base": null, "refs": {} }, "ListNamespacesRequestPrefixString": { "base": null, "refs": { "ListNamespacesRequest$prefix": "The prefix of the namespaces.
" } }, "ListNamespacesResponse": { "base": null, "refs": {} }, "ListTableBucketsLimit": { "base": null, "refs": { "ListTableBucketsRequest$maxBuckets": "The maximum number of table buckets to return in the list.
" } }, "ListTableBucketsRequest": { "base": null, "refs": {} }, "ListTableBucketsRequestPrefixString": { "base": null, "refs": { "ListTableBucketsRequest$prefix": "The prefix of the table buckets.
" } }, "ListTableBucketsResponse": { "base": null, "refs": {} }, "ListTableMigrationsLimit": { "base": null, "refs": { "ListTableMigrationsRequest$maxResults": "The maximum number of migrations to return, from 1 to 1,000. If you don't specify a value, the default is 100.
" } }, "ListTableMigrationsRequest": { "base": null, "refs": {} }, "ListTableMigrationsResponse": { "base": null, "refs": {} }, "ListTablesLimit": { "base": null, "refs": { "ListTablesRequest$maxTables": "The maximum number of tables to return.
" } }, "ListTablesRequest": { "base": null, "refs": {} }, "ListTablesRequestPrefixString": { "base": null, "refs": { "ListTablesRequest$prefix": "The prefix of the tables.
" } }, "ListTablesResponse": { "base": null, "refs": {} }, "ListTagsForResourceRequest": { "base": null, "refs": {} }, "ListTagsForResourceResponse": { "base": null, "refs": {} }, "LoggingEnabled": { "base": "Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a table bucket.
", "refs": { "TableBucketLoggingStatus$loggingEnabled": "Where logs for the table bucket are delivered and how the log objects are named. Must be populated to enable logging.
" } }, "LoggingTargetBucket": { "base": null, "refs": { "LoggingEnabled$targetBucket": "The name of the general purpose bucket that logs are delivered to. The bucket must be in the same Amazon Web Services Region and owned by the same Amazon Web Services account as the table bucket. The bucket can't use SSE-KMS or DSSE-KMS default encryption, can't have S3 Object Lock enabled, and can't have Requester Pays enabled. You can deliver logs from multiple table buckets to the same target bucket. In this case, choose a different targetPrefix for each table bucket so that you can tell their log objects apart.
The prefix for the keys of the log objects that are delivered to the target bucket.
" } }, "Long": { "base": null, "refs": { "FindingCategoryCounts$value": null, "MigrationStats$objectsMigrated": "The number of source objects whose data the migration wrote to the destination table. Migrated data can be queried after the migration commits it. If the migration fails or is cancelled, some migrated objects might not be committed.
", "MigrationStats$objectsFailedMigration": "The number of source objects that didn't migrate, because they failed or because another object, such as an object in the same partition, failed. The object migration report lists the cause for each object.
", "MigrationStats$objectsPendingMigration": "The number of source objects that haven't migrated or failed yet. When a migration fails or is cancelled, these are the objects that it didn't migrate.
", "PlanningStats$objectsScanned": "The number of source objects that the migration found under the source table's location, whether or not it migrates them. The object compatibility report has one row for each.
", "PlanningStats$objectsPlanned": "The number of source objects in the migration. For a start, these are the data files in the Amazon Web Services Glue table's partitions, or under the table's location if the table isn't partitioned. For a sync, these are all the data files of the table after the sync, including files that earlier migrations migrated.
", "PlanningStats$partitionCount": "The number of partitions in the destination table after this migration, or 0 if the source table isn't partitioned. This value is returned when planning produces a valid plan.
", "TableRecordExpirationJobMetrics$deletedDataFiles": "The total number of data files that were removed when the job ran.
", "TableRecordExpirationJobMetrics$deletedRecords": "The total number of records that were removed when the job ran.
", "TableRecordExpirationJobMetrics$removedFilesSize": "The total size (in bytes) of the data files that were removed when the job ran.
" } }, "MaintenanceSettings": { "base": "The maintenance settings for the destination table. The migration applies them when it creates the table: snapshot management starts then, and compaction starts after you complete the migration. If you don't specify a setting, the migration uses its default: a target file size of 512 MB, the binpack compaction strategy, at least 3 snapshots, and a maximum snapshot age of 120 hours. Unreferenced file removal follows the table bucket's configuration after you complete the migration.
", "refs": { "DataMigrationOverview$maintenanceSettings": "The maintenance settings for the destination table. The migration applies them when it creates the table: snapshot management starts then, and compaction starts after you complete the migration. If you don't specify a setting, the migration uses its default: a target file size of 512 MB, the binpack compaction strategy, at least 3 snapshots, and a maximum snapshot age of 120 hours. Unreferenced file removal follows the table bucket's configuration after you complete the migration.
", "DataMigrationSettings$maintenanceSettings": "The maintenance settings for the destination table. The migration applies them when it creates the table: snapshot management starts then, and compaction starts after you complete the migration. If you don't specify a setting, the migration uses its default: a target file size of 512 MB, the binpack compaction strategy, at least 3 snapshots, and a maximum snapshot age of 120 hours. Unreferenced file removal follows the table bucket's configuration after you complete the migration.
" } }, "MaintenanceStatus": { "base": null, "refs": { "TableBucketMaintenanceConfigurationValue$status": "The status of the maintenance configuration.
", "TableMaintenanceConfigurationValue$status": "The status of the maintenance configuration.
" } }, "ManagedTableInformation": { "base": "Contains information about tables that are managed by S3 Tables, including replication information for replica tables.
", "refs": { "GetTableResponse$managedTableInformation": "If this table is managed by S3 Tables, contains additional information such as replication details.
" } }, "MetadataLocation": { "base": null, "refs": { "GetTableMetadataLocationResponse$metadataLocation": "The metadata location.
", "GetTableResponse$metadataLocation": "The metadata location of the table.
", "LastSuccessfulReplicatedUpdate$metadataLocation": "The S3 location of the metadata that was successfully replicated.
", "UpdateTableMetadataLocationRequest$metadataLocation": "The new metadata location for the table.
", "UpdateTableMetadataLocationResponse$metadataLocation": "The metadata location of the table.
" } }, "MethodNotAllowedException": { "base": "The requested operation is not allowed on this resource. This may occur when attempting to modify a resource that is managed by a service or has restrictions that prevent the operation.
", "refs": {} }, "MigrationCompactionSettings": { "base": "The compaction settings that a migration applies to the destination table.
", "refs": { "MaintenanceSettings$icebergCompaction": "The compaction settings.
" } }, "MigrationFailureCode": { "base": "The reason a migration failed. Each code names the cause, or the report that lists the findings.
", "refs": { "MigrationFailureReason$code": "The failure code. It names the cause or the report that lists the findings. Valid values:
rolePermissions - S3 Tables couldn't assume the migration role, or the role doesn't have a permission that the migration needs. detail is the role ARN.
sourcePermissions - The migration role couldn't read the Amazon Web Services Glue table or the source objects. detail names the table (database.table) or the source bucket.
destinationPermissions - The migration role couldn't write to the table bucket or the report bucket. detail names the bucket.
resourceNotFound - A resource that you specified doesn't exist, such as the Amazon Web Services Glue table or the source bucket. detail names it.
sourceNotSupported - The source table can't be migrated, for example because it is empty, has too many objects, or has columns or partitions that can't be migrated. The table compatibility report lists the findings.
tableCompatibilityReport - The migration couldn't create the destination table, for example because a table with that name already exists or the KMS key can't be used. For a sync, the destination table changed after the previous migration. The table compatibility report lists the finding.
objectCompatibilityReport - Some source objects can't be migrated, for example because they are archived, or because they were overwritten after an earlier migration migrated them. The object compatibility report lists them.
objectMigrationReport - Some source objects failed to migrate. The object migration report lists them and the cause for each.
reportBucketNotSupported - The report bucket can't receive the migration's reports, for example because it is in a different Region than the table bucket.
internalError - S3 Tables encountered an internal error. Retry the migration, and contact Amazon Web Services Support if the error persists.
The resource that the failure applies to, such as the role ARN, the Amazon Web Services Glue table (database.table) or a bucket. For sourceNotSupported, the reason that the source isn't supported.
The resource that the failure applies to, such as the role ARN, the Amazon Web Services Glue table (database.table) or a bucket. For sourceNotSupported, the reason that the source isn't supported, such as EMPTY_TABLE. This value isn't returned for the report codes or for internalError.
The reason that a migration failed: a code and, when there is one, the resource or reason it applies to. This value is returned only when the migration is in the failed state.
The reason that the migration failed. The code names the cause, such as a migration role that S3 Tables can't assume or an Amazon Web Services Glue table that doesn't exist, or the report that lists the findings. This value is returned only when the migration is in the failed state.
The ID of the migration to get. Specify either migrationId or tableARN, not both.
The ID of the migration.
", "MigrationSummary$migrationId": "The ID of the migration.
", "StartTableMigrationResponse$migrationId": "The ID of the migration.
", "SyncTableMigrationResponse$migrationId": "The migration ID of the sync.
", "UpdateTableMigrationRequest$migrationId": "The ID of the migration to update. Specify either migrationId or tableARN, not both.
The ID of the migration.
" } }, "MigrationMinSnapshotsToKeep": { "base": null, "refs": { "MigrationSnapshotManagementSettings$minSnapshotsToKeep": "The minimum number of snapshots to keep. The value must be 3 or more. The default is 3.
" } }, "MigrationOutputConfiguration": { "base": "The bucket and prefixes that a migration writes its reports to. Every report goes to one bucket, each under its own prefix.
", "refs": { "StartTableMigrationRequest$migrationOutput": "The bucket and prefixes that the migration writes its reports to. The bucket must be a general purpose bucket in your account and in the same Region as the table bucket, and the migration role must be able to write objects to it. Otherwise, the migration fails when it writes its first report.
", "SyncTableMigrationRequest$migrationOutput": "The bucket and prefixes that the sync writes its reports to. The bucket must be a general purpose bucket in your account and in the same Region as the table bucket, and the migration role must be able to write objects to it. Otherwise, the migration fails when it writes its first report.
" } }, "MigrationOutputOverview": { "base": "Where a migration writes its reports, and the location of each report once it is written.
", "refs": { "GetTableMigrationResponse$migrationOutput": "The bucket and prefixes for the migration's reports, and the location of each report once it is written.
" } }, "MigrationPolicies": { "base": "The policies for source data that doesn't fit the destination schema.
", "refs": { "DataMigrationOverview$migrationPolicies": "The policies for source data that doesn't fit the destination schema.
", "DataMigrationSettings$migrationPolicies": "The policies for source data that doesn't fit the destination schema.
" } }, "MigrationReportPrefix": { "base": null, "refs": { "MigrationReportPrefixes$tableCompatibilityReport": "The key prefix for the table compatibility report, up to 512 bytes. If not specified, the report's keys start at the root of the bucket.
", "MigrationReportPrefixes$objectCompatibilityReport": "The key prefix for the object compatibility report, up to 512 bytes. If not specified, the report's keys start at the root of the bucket.
", "MigrationReportPrefixes$objectMigrationReport": "The key prefix for the object migration report, up to 512 bytes. If not specified, the report's keys start at the root of the bucket.
", "ReportOverview$prefix": "The key prefix that the report is written under.
" } }, "MigrationReportPrefixes": { "base": "The key prefix for each report. If you don't specify a prefix for a report, its keys start at the root of the bucket.
", "refs": { "MigrationOutputConfiguration$prefixes": "The key prefix for each report.
" } }, "MigrationRequestedState": { "base": null, "refs": { "UpdateTableMigrationRequest$requestedState": "The state to move the migration to: queued to continue a migration in the pendingReview state, or cancelled to cancel a migration in the new, planning, pendingReview, queued or migrating state.
The snapshot management settings that a migration applies to the destination table.
", "refs": { "MaintenanceSettings$icebergSnapshotManagement": "The snapshot management settings.
" } }, "MigrationSourceType": { "base": "The type of source that a migration reads from. It names the member that is set in SourceConfiguration.
The type of the migration's source.
", "StartTableMigrationRequest$sourceType": "The type of the source. It must match the member that you set in source.
The state of the migration. Valid values:
new - S3 Tables accepted the request.
planning - The migration is checking the source table, its objects and the destination for compatibility, and writing the compatibility reports.
pendingReview - Planning finished, and the migration waits for you to continue or cancel it with UpdateTableMigration.
queued - The migration is waiting to start migrating data.
migrating - The migration is running the plan from the planning state: it copies data and commits it to the destination table. A migration reaches this state only if hasValidPlan is true.
succeeded - Every planned object migrated.
failed - The migration failed. Check failureReason for the cause.
cancelling - You cancelled the migration, and it is finishing the work in progress.
cancelled - The migration is cancelled.
A migration ends in the succeeded, failed or cancelled state. You can cancel it until it ends.
The state to filter the list by. For the valid values, see the state member of GetTableMigration.
The state of the migration. Valid values:
new - S3 Tables accepted the request.
planning - The migration is checking the source table, its objects and the destination for compatibility, and writing the compatibility reports.
pendingReview - Planning finished, and the migration waits for you to continue or cancel it with UpdateTableMigration.
queued - The migration is waiting to start migrating data.
migrating - The migration is running the plan from the planning state: it copies data and commits it to the destination table. A migration reaches this state only if hasValidPlan is true.
succeeded - Every planned object migrated.
failed - The migration failed. Check failureReason for the cause.
cancelling - You cancelled the migration, and it is finishing the work in progress.
cancelled - The migration is cancelled.
The state of the migration when the request is accepted, such as planning.
The state of the migration when the request is accepted, such as planning.
The state of the migration after the update, such as queued, migrating or cancelling.
The number of source objects that migrated, failed or are pending. For a sync, the counts cover every object of the table after the sync, including objects that earlier migrations migrated. The counts are set when planning finishes and updated when the migration ends.
", "refs": { "GetTableMigrationResponse$migrationStats": "The number of objects that migrated, failed or are pending. These counts are set when planning finishes and updated when the migration ends.
" } }, "MigrationSummary": { "base": "A summary of a migration.
", "refs": { "MigrationSummaryList$member": null } }, "MigrationSummaryList": { "base": null, "refs": { "ListTableMigrationsResponse$migrations": "The migrations, newest first.
" } }, "MigrationTableProperties": { "base": "The properties of the data files that a migration writes. The migration also sets the compression codec and dictionary encoding as the destination table's write properties, so they remain the table's defaults after you complete the migration.
", "refs": { "DestinationTable$properties": "The properties of the destination table, such as its Iceberg format version and the format of its data files.
" } }, "MigrationTargetFileSizeMB": { "base": null, "refs": { "MigrationCompactionSettings$targetFileSizeMB": "The target size, from 64 to 512 MB, of the data files that the migration writes, and of the files that compaction writes after you complete the migration. The default is 512.
" } }, "MigrationType": { "base": null, "refs": { "GetTableMigrationResponse$type": "The type of the migration. Valid values:
start - A migration that StartTableMigration started.
sync - A migration that SyncTableMigration started.
The type of the migration. Valid values:
start - A migration that StartTableMigration started.
sync - A migration that SyncTableMigration started.
The unique identifier of the namespace.
", "GetTableResponse$namespaceId": "The unique identifier of the namespace containing this table.
", "NamespaceSummary$namespaceId": "The system-assigned unique identifier for the namespace.
", "TableSummary$namespaceId": "The unique identifier for the namespace that contains this table.
" } }, "NamespaceList": { "base": null, "refs": { "CreateNamespaceResponse$namespace": "The name of the namespace.
", "GetNamespaceResponse$namespace": "The name of the namespace.
", "GetTableResponse$namespace": "The namespace associated with the table.
", "NamespaceSummary$namespace": "The name of the namespace.
", "TableSummary$namespace": "The name of the namespace.
", "UpdateTableMetadataLocationResponse$namespace": "The namespace the table is associated with.
" } }, "NamespaceName": { "base": null, "refs": { "CreateNamespaceRequestNamespaceList$member": null, "CreateTableRequest$namespace": "The namespace to associated with the table.
", "DeleteNamespaceRequest$namespace": "The name of the namespace.
", "DeleteTablePolicyRequest$namespace": "The namespace associated with the table.
", "DeleteTableRequest$namespace": "The namespace associated with the table.
", "DestinationTable$namespace": "The namespace to create the table in.
", "GetNamespaceRequest$namespace": "The name of the namespace.
", "GetTableEncryptionRequest$namespace": "The namespace associated with the table.
", "GetTableMaintenanceConfigurationRequest$namespace": "The namespace associated with the table.
", "GetTableMaintenanceJobStatusRequest$namespace": "The name of the namespace the table is associated with.
", "GetTableMetadataLocationRequest$namespace": "The namespace of the table.
", "GetTableMigrationResponse$namespace": "The namespace of the destination table.
", "GetTablePolicyRequest$namespace": "The namespace associated with the table.
", "GetTableRequest$namespace": "The name of the namespace the table is associated with.
", "GetTableStorageClassRequest$namespace": "The namespace associated with the table.
", "ListTableMigrationsRequest$namespace": "The namespace to list migrations for. Requires tableBucketARN.
The namespace of the tables.
", "MigrationSummary$namespace": "The namespace of the destination table.
", "NamespaceList$member": null, "PutTableMaintenanceConfigurationRequest$namespace": "The namespace of the table.
", "PutTablePolicyRequest$namespace": "The namespace associated with the table.
", "RenameTableRequest$namespace": "The namespace associated with the table.
", "RenameTableRequest$newNamespaceName": "The new name for the namespace.
", "UpdateTableMetadataLocationRequest$namespace": "The namespace of the table.
" } }, "NamespaceSummary": { "base": "Contains details about a namespace.
", "refs": { "NamespaceSummaryList$member": null } }, "NamespaceSummaryList": { "base": null, "refs": { "ListNamespacesResponse$namespaces": "A list of namespaces.
" } }, "NextToken": { "base": null, "refs": { "ListNamespacesRequest$continuationToken": " 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.
The ContinuationToken for pagination of the list results.
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.
You can use this ContinuationToken for pagination of the list results.
The nextToken from a previous response, to get the next page of results.
A token to pass as nextToken to get the next page of results. If there are no more results, this value isn't returned.
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.
You can use this ContinuationToken for pagination of the list results.
The request was rejected because the specified resource could not be found.
", "refs": {} }, "OpenTableFormat": { "base": null, "refs": { "CreateTableRequest$format": "The format for the table.
", "GetTableResponse$format": "The format of the table.
" } }, "PartitionDateSource": { "base": null, "refs": { "PartitionedPrefix$partitionDateSource": "The date to use for the log object key partitions. Valid values are EventTime, the time that the requests in the log were made, and DeliveryTime, the time that the log was delivered.
Amazon S3 keys for log objects are partitioned in the following format: [targetPrefix][SourceAccountId]/[SourceRegion]/[SourceTableBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]
Partitions log object keys by date.
" } }, "PlanningStats": { "base": "Statistics about the source and the partitions in a migration.
", "refs": { "GetTableMigrationResponse$planningStats": "Statistics about the source and the partitions in the migration. This value is returned after planning finishes.
" } }, "PositiveInteger": { "base": null, "refs": { "IcebergCompactionSettings$targetFileSizeMB": "The target file size for the table in MB.
", "IcebergSnapshotManagementSettings$minSnapshotsToKeep": "The minimum number of snapshots to keep.
", "IcebergSnapshotManagementSettings$maxSnapshotAgeHours": "The maximum age of a snapshot before it can be expired.
", "IcebergUnreferencedFileRemovalSettings$unreferencedDays": "The number of days an object has to be unreferenced before it is marked as non-current.
", "IcebergUnreferencedFileRemovalSettings$nonCurrentDays": "The number of days an object has to be non-current before it is deleted.
", "MigrationSnapshotManagementSettings$maxSnapshotAgeHours": "The maximum age, in hours, of a snapshot before it can be expired. The default is 120.
", "TableRecordExpirationSettings$days": "If you enable record expiration for a table, you can specify the number of days to retain your table records. For example, to retain your table records for one year, set this value to 365.
Specifies a destination table bucket for replication.
", "refs": { "ReplicationDestinations$member": null } }, "ReplicationDestinationStatusModel": { "base": "Contains status information for a replication destination, including the current replication state, last successful update, and any error messages.
", "refs": { "ReplicationDestinationStatuses$member": null } }, "ReplicationDestinationStatuses": { "base": null, "refs": { "GetTableReplicationStatusResponse$destinations": "An array of status information for each replication destination, including the current state, last successful update, and any error messages.
" } }, "ReplicationDestinations": { "base": null, "refs": { "TableBucketReplicationRule$destinations": "An array of destination table buckets where tables should be replicated.
", "TableReplicationRule$destinations": "An array of destination table buckets where this table should be replicated.
" } }, "ReplicationInformation": { "base": "Contains information about the source of a replicated table.
", "refs": { "ManagedTableInformation$replicationInformation": "If this table is a replica, contains information about the source table from which it is replicated.
" } }, "ReplicationStatus": { "base": null, "refs": { "ReplicationDestinationStatusModel$replicationStatus": "The current status of replication to this destination.
" } }, "ReportObjectKey": { "base": null, "refs": { "ReportOverview$key": "The key of the report object in the bucket. For the object compatibility and object migration reports, this is the report's manifest; for the table compatibility report, it is the report itself. This value is returned after the migration writes the report. A migration doesn't always write every report. For example, a migration that fails during planning doesn't write the object migration report.
" } }, "ReportOverview": { "base": "A report of a migration: the prefix it is written under and, once it is written, its key, its checksum and, for the compatibility reports, the number of blocking findings in each category.
", "refs": { "MigrationOutputOverview$tableCompatibilityReport": "The table compatibility report: the sample object that the schema is inferred from, the table-level findings, and one row for each destination column with its type change and how the migration policies apply to it. The migration writes it when planning finishes, before any data migrates. If planning fails, the report might not be written.
", "MigrationOutputOverview$objectCompatibilityReport": "The object compatibility report: one row for each source object under the source table's location, with whether the migration includes the object and its most severe finding. The migration writes it when planning finishes. If planning fails, the report might not be written.
", "MigrationOutputOverview$objectMigrationReport": "The object migration report: one row for each source object that the migration tried to migrate, with whether it migrated, how it was transformed, and why it failed. The migration writes it once, when the migration ends. It isn't written if planning fails or if a sync has nothing to migrate.
" } }, "ResourceArn": { "base": null, "refs": { "ListTagsForResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the Amazon S3 Tables resource that you want to list tags for. The tagged resource can be a table bucket or a table. For a list of all S3 resources that support tagging, see Managing tags for Amazon S3 resources.
", "TagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the Amazon S3 Tables resource that you're applying tags to. The tagged resource can be a table bucket or a table. For a list of all S3 resources that support tagging, see Managing tags for Amazon S3 resources.
", "UntagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the Amazon S3 Tables resource that you're removing tags from. The tagged resource can be a table bucket or a table. For a list of all S3 resources that support tagging, see Managing tags for Amazon S3 resources.
" } }, "ResourcePolicy": { "base": null, "refs": { "GetTableBucketPolicyResponse$resourcePolicy": "The JSON that defines the policy.
The JSON that defines the policy.
The JSON that defines the policy.
The JSON that defines the policy.
The Amazon Resource Name (ARN) of the IAM role that the migration uses.
", "StartTableMigrationRequest$roleARN": "The Amazon Resource Name (ARN) of the IAM role that the migration uses to read the source table and its data and to write the destination table and the reports. The role must be in your account, and its trust policy must allow migration.s3tables.amazonaws.com to assume it. You can limit the trust policy to the destination table bucket with the aws:SourceArn and aws:SourceAccount condition keys.
The Amazon Resource Name (ARN) of the IAM role that the sync uses to read the source table and its data and to write the destination table and the reports. The role must be in your account, and its trust policy must allow migration.s3tables.amazonaws.com to assume it. You can limit the trust policy to the destination table bucket with the aws:SourceArn and aws:SourceAccount condition keys.
The general purpose bucket that the migration writes every report to.
", "MigrationOutputOverview$bucket": "The general purpose bucket that the migration writes every report to.
" } }, "SSEAlgorithm": { "base": null, "refs": { "EncryptionConfiguration$sseAlgorithm": "The server-side encryption algorithm to use. Valid values are AES256 for S3-managed encryption keys, or aws:kms for Amazon Web Services KMS-managed encryption keys. If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption.
Contains details about a schema field.
", "refs": { "SchemaFieldList$member": null } }, "SchemaFieldList": { "base": null, "refs": { "IcebergSchema$fields": "The schema fields for the table
" } }, "SchemaV2Field": { "base": "Contains details about a schema field in the V2 format. This field format supports nested and complex data types such as struct, list, and map, in addition to primitive types.
The schema fields for the table. Each field defines a column in the table, including its name, type, and whether it is required.
" } }, "SchemaV2FieldType": { "base": null, "refs": { "IcebergSchemaV2$type": "The type of the top-level schema, which is always a struct type as defined in the Apache Iceberg specification. This value must be struct.
The source to migrate from. Set exactly one member, and set sourceType to match it.
The source table of the migration.
", "StartTableMigrationRequest$source": "The source table to migrate.
" } }, "StartTableMigrationRequest": { "base": null, "refs": {} }, "StartTableMigrationResponse": { "base": null, "refs": {} }, "StorageClass": { "base": null, "refs": { "StorageClassConfiguration$storageClass": "The storage class for the table or table bucket. Valid values include storage classes optimized for different access patterns and cost profiles.
" } }, "StorageClassConfiguration": { "base": "The configuration details for the storage class of tables or table buckets. This allows you to optimize storage costs by selecting the appropriate storage class based on your access patterns and performance requirements.
", "refs": { "CreateTableBucketRequest$storageClassConfiguration": "The default storage class configuration for the table bucket. This configuration will be applied to all new tables created in this bucket unless overridden at the table level. If not specified, the service default storage class will be used.
", "CreateTableRequest$storageClassConfiguration": "The storage class configuration for the table. If not specified, the table inherits the storage class configuration from its table bucket. Specify this parameter to override the bucket's default storage class for this table.
", "DestinationTable$storageClassConfiguration": "The storage class configuration for the table. If you don't specify one, the table inherits the storage class configuration of its table bucket. If you specify a storage class configuration, the migration role must have the s3tables:PutTableStorageClass permission.
The storage class configuration for the table bucket.
", "GetTableStorageClassResponse$storageClassConfiguration": "The storage class configuration for the table.
", "PutTableBucketStorageClassRequest$storageClassConfiguration": "The storage class configuration to apply to the table bucket. This configuration will serve as the default for new tables created in this bucket.
" } }, "String": { "base": null, "refs": { "DeleteTableReplicationRequest$versionToken": "A version token from a previous GetTableReplication call. Use this token to ensure you're deleting the expected version of the configuration.
", "GetTableBucketMetricsConfigurationResponse$id": "The unique identifier of the metrics configuration.
", "GetTableRecordExpirationJobStatusResponse$failureMessage": "If the job failed, this field contains an error message describing the failure reason.
", "GetTableReplicationResponse$versionToken": "A version token that represents the current state of the table's replication configuration. Use this token when updating the configuration to ensure consistency.
", "GetTableResponse$managedByService": "The service that manages the table.
", "IcebergPartitionField$transform": "The partition transform to apply to the source field. Supported transforms include identity, year, month, day, hour, bucket, and truncate. For more information, see the Apache Iceberg partition transforms documentation.
The name for this partition field. This name is used in the partitioned file paths.
", "IcebergSortField$transform": "The transform to apply to the source field before sorting. Use identity to sort by the field value directly, or specify other transforms as needed.
The status of the replication configuration operation.
", "PutTableReplicationRequest$versionToken": "A version token from a previous GetTableReplication call. Use this token to ensure you're updating the expected version of the configuration.
", "PutTableReplicationResponse$versionToken": "A new version token representing the updated replication configuration.
", "PutTableReplicationResponse$status": "The status of the replication configuration operation.
", "ReplicationDestinationStatusModel$failureMessage": "If replication has failed, this field contains an error message describing the failure reason.
", "SchemaField$name": "The name of the field.
", "SchemaField$type": "The field type. S3 Tables supports all Apache Iceberg primitive types. For more information, see the Apache Iceberg documentation.
", "SchemaV2Field$name": "The name of the field.
", "SchemaV2Field$doc": "An optional description of the field.
", "TableMaintenanceJobStatusValue$failureMessage": "The failure message of a failed job.
", "TableProperties$key": null, "TableProperties$value": null, "TableSummary$managedByService": "The Amazon Web Services service managing this table, if applicable. For example, a replicated table is managed by the S3 Tables replication service.
" } }, "SyncTableMigrationRequest": { "base": null, "refs": {} }, "SyncTableMigrationResponse": { "base": null, "refs": {} }, "SyntheticTimestamp_date_time": { "base": null, "refs": { "GetNamespaceResponse$createdAt": "The date and time the namespace was created at.
", "GetTableBucketResponse$createdAt": "The date and time the table bucket was created.
", "GetTableMigrationResponse$createdAt": "The date and time that the migration was created.
", "GetTableMigrationResponse$stateUpdatedAt": "The date and time that the migration's state last changed.
", "GetTableRecordExpirationJobStatusResponse$lastRunTimestamp": "The timestamp when the expiration job was last executed.
", "GetTableResponse$createdAt": "The date and time the table bucket was created at.
", "GetTableResponse$modifiedAt": "The date and time the table was last modified on.
", "LastSuccessfulReplicatedUpdate$timestamp": "The timestamp when the replication update completed successfully.
", "MigrationSummary$createdAt": "The date and time that the migration was created.
", "MigrationSummary$stateUpdatedAt": "The date and time that the migration's state last changed.
", "NamespaceSummary$createdAt": "The date and time the namespace was created at.
", "TableBucketSummary$createdAt": "The date and time the table bucket was created at.
", "TableMaintenanceJobStatusValue$lastRunTimestamp": "The date and time that the maintenance job was last run.
", "TableSummary$createdAt": "The date and time the table was created at.
", "TableSummary$modifiedAt": "The date and time the table was last modified at.
" } }, "TableARN": { "base": null, "refs": { "CompleteTableMigrationRequest$tableARN": "The Amazon Resource Name (ARN) of the migrated table to complete the migration of.
", "CreateTableResponse$tableARN": "The Amazon Resource Name (ARN) of the table.
", "DeleteTableReplicationRequest$tableArn": "The Amazon Resource Name (ARN) of the table.
", "GetTableMaintenanceConfigurationResponse$tableARN": "The Amazon Resource Name (ARN) of the table.
", "GetTableMaintenanceJobStatusResponse$tableARN": "The Amazon Resource Name (ARN) of the table.
", "GetTableMigrationRequest$tableARN": "The Amazon Resource Name (ARN) of the destination table. Gets the table's most recent migration. Specify either tableARN or migrationId, not both.
The Amazon Resource Name (ARN) of the destination table, once the migration creates it.
", "GetTableRecordExpirationConfigurationRequest$tableArn": "The Amazon Resource Name (ARN) of the table.
", "GetTableRecordExpirationJobStatusRequest$tableArn": "The Amazon Resource Name (ARN) of the table.
", "GetTableReplicationRequest$tableArn": "The Amazon Resource Name (ARN) of the table.
", "GetTableReplicationStatusRequest$tableArn": "The Amazon Resource Name (ARN) of the table.
", "GetTableReplicationStatusResponse$sourceTableArn": "The Amazon Resource Name (ARN) of the source table being replicated.
", "GetTableRequest$tableArn": "The Amazon Resource Name (ARN) of the table.
", "GetTableResponse$tableARN": "The Amazon Resource Name (ARN) of the table.
", "ListTableMigrationsRequest$tableARN": "The Amazon Resource Name (ARN) of the table to list migrations for. The list includes the migrations into this table. To also list migrations into an earlier table of the same name, specify tableBucketARN, namespace and name instead. Specify either tableARN or tableBucketARN, not both.
The Amazon Resource Name (ARN) of the destination table, once the migration creates it.
", "PutTableRecordExpirationConfigurationRequest$tableArn": "The Amazon Resource Name (ARN) of the table.
", "PutTableReplicationRequest$tableArn": "The Amazon Resource Name (ARN) of the source table.
", "ReplicationDestinationStatusModel$destinationTableArn": "The Amazon Resource Name (ARN) of the destination table.
", "ReplicationInformation$sourceTableARN": "The Amazon Resource Name (ARN) of the source table from which this table is replicated.
", "SyncTableMigrationRequest$tableARN": "The Amazon Resource Name (ARN) of the destination table to sync. The table must have a migration, and you must not have called CompleteTableMigration for it.
The Amazon Resource Name (ARN) of the table.
", "UpdateTableMetadataLocationResponse$tableARN": "The Amazon Resource Name (ARN) of the table.
", "UpdateTableMigrationRequest$tableARN": "The Amazon Resource Name (ARN) of the destination table. Updates the table's most recent migration. Until the migration creates the destination table, specify migrationId. Specify either tableARN or migrationId, not both.
The Amazon Resource Name (ARN) of the destination table.
" } }, "TableBucketARN": { "base": null, "refs": { "CreateNamespaceRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket to create the namespace in.
", "CreateNamespaceResponse$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket the namespace was created in.
", "CreateTableBucketResponse$arn": "The Amazon Resource Name (ARN) of the table bucket.
", "CreateTableRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket to create the table in.
", "DeleteNamespaceRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket associated with the namespace.
", "DeleteTableBucketEncryptionRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket.
", "DeleteTableBucketMetricsConfigurationRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket.
", "DeleteTableBucketPolicyRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket.
", "DeleteTableBucketReplicationRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket.
", "DeleteTableBucketRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket.
", "DeleteTablePolicyRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket that contains the table.
", "DeleteTableRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket that contains the table.
", "DestinationTable$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket to create the table in.
", "GetNamespaceRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket.
", "GetTableBucketEncryptionRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket.
", "GetTableBucketLoggingRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket.
", "GetTableBucketMaintenanceConfigurationRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket associated with the maintenance configuration.
", "GetTableBucketMaintenanceConfigurationResponse$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket associated with the maintenance configuration.
", "GetTableBucketMetricsConfigurationRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket.
", "GetTableBucketMetricsConfigurationResponse$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket.
", "GetTableBucketPolicyRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket.
", "GetTableBucketReplicationRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket.
", "GetTableBucketRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket.
", "GetTableBucketResponse$arn": "The Amazon Resource Name (ARN) of the table bucket.
", "GetTableBucketStorageClassRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket.
", "GetTableEncryptionRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket containing the table.
", "GetTableMaintenanceConfigurationRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket.
", "GetTableMaintenanceJobStatusRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket.
", "GetTableMetadataLocationRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket.
", "GetTableMigrationResponse$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket that contains the destination table.
", "GetTablePolicyRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket that contains the table.
", "GetTableRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket associated with the table.
", "GetTableStorageClassRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket that contains the table.
", "ListNamespacesRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket.
", "ListTableMigrationsRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket to list migrations for.
", "ListTablesRequest$tableBucketARN": "The Amazon resource Name (ARN) of the table bucket.
", "MigrationSummary$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket that contains the destination table.
", "PutTableBucketEncryptionRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket.
", "PutTableBucketLoggingRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket.
", "PutTableBucketMaintenanceConfigurationRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket associated with the maintenance configuration.
", "PutTableBucketMetricsConfigurationRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket.
", "PutTableBucketPolicyRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket.
", "PutTableBucketReplicationRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the source table bucket.
", "PutTableBucketStorageClassRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket.
", "PutTableMaintenanceConfigurationRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table associated with the maintenance configuration.
", "PutTablePolicyRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket that contains the table.
", "RenameTableRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket.
", "ReplicationDestination$destinationTableBucketARN": "The Amazon Resource Name (ARN) of the destination table bucket where tables will be replicated.
", "ReplicationDestinationStatusModel$destinationTableBucketArn": "The Amazon Resource Name (ARN) of the destination table bucket.
", "TableBucketSummary$arn": "The Amazon Resource Name (ARN) of the table bucket.
", "UpdateTableMetadataLocationRequest$tableBucketARN": "The Amazon Resource Name (ARN) of the table bucket.
" } }, "TableBucketId": { "base": null, "refs": { "GetNamespaceResponse$tableBucketId": "The unique identifier of the table bucket containing this namespace.
", "GetTableBucketResponse$tableBucketId": "The unique identifier of the table bucket.
", "GetTableResponse$tableBucketId": "The unique identifier of the table bucket containing this table.
", "NamespaceSummary$tableBucketId": "The system-assigned unique identifier for the table bucket that contains this namespace.
", "TableBucketSummary$tableBucketId": "The system-assigned unique identifier for the table bucket.
", "TableSummary$tableBucketId": "The unique identifier for the table bucket that contains this table.
" } }, "TableBucketLoggingStatus": { "base": "The server access logging status of a table bucket. To enable logging, specify loggingEnabled. To disable logging, specify an empty TableBucketLoggingStatus.
The logging status of the table bucket. If logging is disabled, loggingEnabled is absent.
The logging status to apply to the table bucket. To disable logging, specify an empty tableBucketLoggingStatus.
Details about the maintenance configuration for the table bucket.
" } }, "TableBucketMaintenanceConfigurationValue": { "base": "Details about the values that define the maintenance configuration for a table bucket.
", "refs": { "PutTableBucketMaintenanceConfigurationRequest$value": "Defines the values of the maintenance configuration for the table bucket.
", "TableBucketMaintenanceConfiguration$value": null } }, "TableBucketMaintenanceSettings": { "base": "Contains details about the maintenance settings for the table bucket.
", "refs": { "TableBucketMaintenanceConfigurationValue$settings": "Contains details about the settings of the maintenance configuration.
" } }, "TableBucketMaintenanceType": { "base": null, "refs": { "PutTableBucketMaintenanceConfigurationRequest$type": "The type of the maintenance configuration.
", "TableBucketMaintenanceConfiguration$key": null } }, "TableBucketName": { "base": null, "refs": { "CreateTableBucketRequest$name": "The name for the table bucket.
", "GetTableBucketResponse$name": "The name of the table bucket
", "TableBucketSummary$name": "The name of the table bucket.
" } }, "TableBucketReplicationConfiguration": { "base": "The replication configuration for a table bucket. This configuration defines how tables in the source bucket are replicated to destination table buckets, including the IAM role used for replication.
", "refs": { "GetTableBucketReplicationResponse$configuration": "The replication configuration for the table bucket, including the IAM role and replication rules.
", "PutTableBucketReplicationRequest$configuration": "The replication configuration to apply, including the IAM role and replication rules.
" } }, "TableBucketReplicationRule": { "base": "Defines a rule for replicating tables from a source table bucket to one or more destination table buckets.
", "refs": { "TableBucketReplicationRules$member": null } }, "TableBucketReplicationRules": { "base": null, "refs": { "TableBucketReplicationConfiguration$rules": "An array of replication rules that define which tables to replicate and where to replicate them.
" } }, "TableBucketSummary": { "base": "Contains details about a table bucket.
", "refs": { "TableBucketSummaryList$member": null } }, "TableBucketSummaryList": { "base": null, "refs": { "ListTableBucketsResponse$tableBuckets": "A list of table buckets.
" } }, "TableBucketType": { "base": null, "refs": { "GetTableBucketResponse$type": "The type of the table bucket.
", "ListTableBucketsRequest$type": "The type of table buckets to filter by in the list.
", "TableBucketSummary$type": "The type of the table bucket.
" } }, "TableMaintenanceConfiguration": { "base": null, "refs": { "GetTableMaintenanceConfigurationResponse$configuration": "Details about the maintenance configuration for the table bucket.
" } }, "TableMaintenanceConfigurationValue": { "base": "The values that define a maintenance configuration for a table.
", "refs": { "PutTableMaintenanceConfigurationRequest$value": "Defines the values of the maintenance configuration for the table.
", "TableMaintenanceConfiguration$value": null } }, "TableMaintenanceJobStatus": { "base": null, "refs": { "GetTableMaintenanceJobStatusResponse$status": "The status of the maintenance job.
" } }, "TableMaintenanceJobStatusValue": { "base": "Details about the status of a maintenance job.
", "refs": { "TableMaintenanceJobStatus$value": null } }, "TableMaintenanceJobType": { "base": null, "refs": { "TableMaintenanceJobStatus$key": null } }, "TableMaintenanceSettings": { "base": "Contains details about maintenance settings for the table.
", "refs": { "TableMaintenanceConfigurationValue$settings": "Contains details about the settings for the maintenance configuration.
" } }, "TableMaintenanceType": { "base": null, "refs": { "PutTableMaintenanceConfigurationRequest$type": "The type of the maintenance configuration.
", "TableMaintenanceConfiguration$key": null } }, "TableMetadata": { "base": "Contains details about the table metadata.
", "refs": { "CreateTableRequest$metadata": "The metadata for the table.
" } }, "TableName": { "base": null, "refs": { "CreateTableRequest$name": "The name for the table.
", "DeleteTablePolicyRequest$name": "The table name.
", "DeleteTableRequest$name": "The name of the table.
", "DestinationTable$name": "The name of the table to create.
", "GetTableEncryptionRequest$name": "The name of the table.
", "GetTableMaintenanceConfigurationRequest$name": "The name of the table.
", "GetTableMaintenanceJobStatusRequest$name": "The name of the table containing the maintenance job status you want to check.
", "GetTableMetadataLocationRequest$name": "The name of the table.
", "GetTableMigrationResponse$name": "The name of the destination table.
", "GetTablePolicyRequest$name": "The name of the table.
", "GetTableRequest$name": "The name of the table.
", "GetTableResponse$name": "The name of the table.
", "GetTableStorageClassRequest$name": "The name of the table.
", "ListTableMigrationsRequest$name": "The name of the table to list migrations for. Requires tableBucketARN and namespace.
The name of the destination table.
", "PutTableMaintenanceConfigurationRequest$name": "The name of the table.
", "PutTablePolicyRequest$name": "The name of the table.
", "RenameTableRequest$name": "The current name of the table.
", "RenameTableRequest$newName": "The new name for the table.
", "TableSummary$name": "The name of the table.
", "UpdateTableMetadataLocationRequest$name": "The name of the table.
", "UpdateTableMetadataLocationResponse$name": "The name of the table.
" } }, "TableProperties": { "base": null, "refs": { "IcebergMetadata$properties": "A map of custom configuration properties for the Iceberg table.
" } }, "TableRecordExpirationConfigurationValue": { "base": "The expiration configuration settings for records in a table, and the status of the configuration. If the status of the configuration is enabled, records expire and are automatically removed after the number of days specified in the record expiration settings for the table.
", "refs": { "GetTableRecordExpirationConfigurationResponse$configuration": "The record expiration configuration for the table, including the status and retention settings.
", "PutTableRecordExpirationConfigurationRequest$value": "The record expiration configuration to apply to the table, including the status (enabled or disabled) and retention period in days.
Provides metrics for the record expiration job that most recently ran for a table. The metrics provide insight into the amount of data that was removed when the job ran.
", "refs": { "GetTableRecordExpirationJobStatusResponse$metrics": "Metrics about the most recent expiration job execution, including the number of records and files deleted.
" } }, "TableRecordExpirationJobStatus": { "base": null, "refs": { "GetTableRecordExpirationJobStatusResponse$status": "The current status of the most recent expiration job.
" } }, "TableRecordExpirationSettings": { "base": "The record expiration setting that specifies when records expire and are automatically removed from a table.
", "refs": { "TableRecordExpirationConfigurationValue$settings": "The expiration settings for records in the table.
" } }, "TableRecordExpirationStatus": { "base": null, "refs": { "TableRecordExpirationConfigurationValue$status": "The status of the expiration settings for records in the table.
" } }, "TableReplicationConfiguration": { "base": "The replication configuration for an individual table. This configuration defines how the table is replicated to destination tables.
", "refs": { "GetTableReplicationResponse$configuration": "The replication configuration for the table, including the IAM role and replication rules.
", "PutTableReplicationRequest$configuration": "The replication configuration to apply to the table, including the IAM role and replication rules.
" } }, "TableReplicationRule": { "base": "Defines a rule for replicating a table to one or more destination tables.
", "refs": { "TableReplicationRules$member": null } }, "TableReplicationRules": { "base": null, "refs": { "TableReplicationConfiguration$rules": "An array of replication rules that define where this table should be replicated.
" } }, "TableSummary": { "base": "Contains details about a table.
", "refs": { "TableSummaryList$member": null } }, "TableSummaryList": { "base": null, "refs": { "ListTablesResponse$tables": "A list of tables.
" } }, "TableType": { "base": null, "refs": { "GetTableResponse$type": "The type of the table.
", "TableSummary$type": "The type of the table.
" } }, "TagKey": { "base": null, "refs": { "TagKeyList$member": null, "Tags$key": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "The array of tag keys that you're removing from the S3 Tables resource. For more information, see Tagging for cost allocation or attribute-based access control (ABAC).
" } }, "TagResourceRequest": { "base": null, "refs": {} }, "TagResourceResponse": { "base": null, "refs": {} }, "TagValue": { "base": null, "refs": { "Tags$value": null } }, "Tags": { "base": null, "refs": { "CreateTableBucketRequest$tags": "A map of user-defined tags that you would like to apply to the table bucket that you are creating. A tag is a key-value pair that you apply to your resources. Tags can help you organize and control access to resources. For more information, see Tagging for cost allocation or attribute-based access control (ABAC).
You must have the s3tables:TagResource permission in addition to s3tables:CreateTableBucket permisson to create a table bucket with tags.
A map of user-defined tags that you would like to apply to the table that you are creating. A tag is a key-value pair that you apply to your resources. Tags can help you organize, track costs for, and control access to resources. For more information, see Tagging for cost allocation or attribute-based access control (ABAC).
You must have the s3tables:TagResource permission in addition to s3tables:CreateTable permission to create a table with tags.
The tags to add to the table. A tag is a key-value pair that you apply to your resources. For more information, see Tagging for cost allocation or attribute-based access control (ABAC). If you specify tags, the migration role must have the s3tables:TagResource permission.
The user-defined tags that are applied to the resource. For more information, see Tagging for cost allocation or attribute-based access control (ABAC).
", "TagResourceRequest$tags": "The user-defined tag that you want to add to the specified S3 Tables resource. For more information, see Tagging for cost allocation or attribute-based access control (ABAC).
" } }, "TargetObjectKeyFormat": { "base": "The key format of the log objects. Only partitionedPrefix is supported.
The key format of the log objects. Log object keys are always partitioned by date.
" } }, "TooManyRequestsException": { "base": "The limit on the number of requests per second was exceeded.
", "refs": {} }, "UnmatchedSourceFieldsPolicy": { "base": null, "refs": { "MigrationPolicies$unmatchedSourceFieldsPolicy": "The migration policy for a source field that has no matching column in the destination schema. Valid values:
fail - Fails the migration. This is the default.
drop - Leaves source columns that the destination schema doesn't have out of the destination table, and doesn't migrate source objects outside the Amazon Web Services Glue table's partition locations.
A destination schema that leaves out a partition column or a field of a struct column fails the migration under either value.
" } }, "UntagResourceRequest": { "base": null, "refs": {} }, "UntagResourceResponse": { "base": null, "refs": {} }, "UpdateTableMetadataLocationRequest": { "base": null, "refs": {} }, "UpdateTableMetadataLocationResponse": { "base": null, "refs": {} }, "UpdateTableMigrationRequest": { "base": null, "refs": {} }, "UpdateTableMigrationRequestUpdateDescriptionString": { "base": null, "refs": { "UpdateTableMigrationRequest$updateDescription": "A description of the update, up to 1,024 characters, with no control characters. GetTableMigration doesn't return it.
The version token of the table.
", "DeleteTableBucketReplicationRequest$versionToken": "A version token from a previous GetTableBucketReplication call. Use this token to ensure you're deleting the expected version of the configuration.
", "DeleteTableRequest$versionToken": "The version token of the table.
", "GetTableBucketReplicationResponse$versionToken": "A version token that represents the current state of the replication configuration. Use this token when updating the configuration to ensure consistency.
", "GetTableMetadataLocationResponse$versionToken": "The version token.
", "GetTableResponse$versionToken": "The version token of the table.
", "PutTableBucketReplicationRequest$versionToken": "A version token from a previous GetTableBucketReplication call. Use this token to ensure you're updating the expected version of the configuration.
", "PutTableBucketReplicationResponse$versionToken": "A new version token representing the updated replication configuration.
", "RenameTableRequest$versionToken": "The version token of the table.
", "UpdateTableMetadataLocationRequest$versionToken": "The version token of the table.
", "UpdateTableMetadataLocationResponse$versionToken": "The version token of the table.
" } }, "WarehouseLocation": { "base": null, "refs": { "GetTableMetadataLocationResponse$warehouseLocation": "The warehouse location.
", "GetTableResponse$warehouseLocation": "The warehouse location of the table.
" } } } }