@aws-sdk/client-s3tables 3.939.0 → 3.943.0

package/dist-types/models/models_0.d.ts

@@ -1,4 +1,4 @@
-import { IcebergCompactionStrategy, JobStatus, MaintenanceStatus, OpenTableFormat, SSEAlgorithm, TableBucketMaintenanceType, TableBucketType, TableMaintenanceJobType, TableMaintenanceType, TableType } from "./enums";
+import { IcebergCompactionStrategy, JobStatus, MaintenanceStatus, OpenTableFormat, ReplicationStatus, SSEAlgorithm, StorageClass, TableBucketMaintenanceType, TableBucketType, TableMaintenanceJobType, TableMaintenanceType, TableRecordExpirationJobStatus, TableRecordExpirationStatus, TableType } from "./enums";
 /**
  * @public
  */
@@ -87,6 +87,11 @@ export interface IcebergMetadata {
      * @public
      */
     schema: IcebergSchema | undefined;
+    /**
+     * <p>Contains configuration properties for an Iceberg table.</p>
+     * @public
+     */
+    properties?: Record<string, string> | undefined;
 }
 /**
  * <p>Contains details about the table metadata.</p>
@@ -121,6 +126,17 @@ export declare namespace TableMetadata {
         _: (name: string, value: any) => T;
     }
 }
+/**
+ * <p>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.</p>
+ * @public
+ */
+export interface StorageClassConfiguration {
+    /**
+     * <p>The storage class for the table or table bucket. Valid values include storage classes optimized for different access patterns and cost profiles.</p>
+     * @public
+     */
+    storageClass: StorageClass | undefined;
+}
 /**
  * @public
  */
@@ -155,6 +171,11 @@ export interface CreateTableRequest {
      * @public
      */
     encryptionConfiguration?: EncryptionConfiguration | undefined;
+    /**
+     * <p>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.</p>
+     * @public
+     */
+    storageClassConfiguration?: StorageClassConfiguration | undefined;
     /**
      * <p>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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html">Tagging for cost allocation or attribute-based access control (ABAC)</a>.</p> <note> <p>You must have the <code>s3tables:TagResource</code> permission in addition to <code>s3tables:CreateTable</code> permission to create a table with tags.</p> </note>
      * @public
@@ -190,6 +211,11 @@ export interface CreateTableBucketRequest {
      * @public
      */
     encryptionConfiguration?: EncryptionConfiguration | undefined;
+    /**
+     * <p>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.</p>
+     * @public
+     */
+    storageClassConfiguration?: StorageClassConfiguration | undefined;
     /**
      * <p>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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html">Tagging for cost allocation or attribute-based access control (ABAC)</a>.</p> <note> <p>You must have the <code>s3tables:TagResource</code> permission in addition to <code>s3tables:CreateTableBucket</code> permisson to create a table bucket with tags.</p> </note>
      * @public
@@ -286,6 +312,21 @@ export interface DeleteTableBucketPolicyRequest {
      */
     tableBucketARN: string | undefined;
 }
+/**
+ * @public
+ */
+export interface DeleteTableBucketReplicationRequest {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the table bucket.</p>
+     * @public
+     */
+    tableBucketARN: string | undefined;
+    /**
+     * <p>A version token from a previous GetTableBucketReplication call. Use this token to ensure you're deleting the expected version of the configuration.</p>
+     * @public
+     */
+    versionToken?: string | undefined;
+}
 /**
  * @public
  */
@@ -306,6 +347,21 @@ export interface DeleteTablePolicyRequest {
      */
     name: string | undefined;
 }
+/**
+ * @public
+ */
+export interface DeleteTableReplicationRequest {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the table.</p>
+     * @public
+     */
+    tableArn: string | undefined;
+    /**
+     * <p>A version token from a previous GetTableReplication call. Use this token to ensure you're deleting the expected version of the configuration.</p>
+     * @public
+     */
+    versionToken: string | undefined;
+}
 /**
  * @public
  */
@@ -381,6 +437,28 @@ export interface GetTableRequest {
      */
     tableArn?: string | undefined;
 }
+/**
+ * <p>Contains information about the source of a replicated table.</p>
+ * @public
+ */
+export interface ReplicationInformation {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the source table from which this table is replicated.</p>
+     * @public
+     */
+    sourceTableARN: string | undefined;
+}
+/**
+ * <p>Contains information about tables that are managed by S3 Tables, including replication information for replica tables.</p>
+ * @public
+ */
+export interface ManagedTableInformation {
+    /**
+     * <p>If this table is a replica, contains information about the source table from which it is replicated.</p>
+     * @public
+     */
+    replicationInformation?: ReplicationInformation | undefined;
+}
 /**
  * @public
  */
@@ -465,6 +543,11 @@ export interface GetTableResponse {
      * @public
      */
     tableBucketId?: string | undefined;
+    /**
+     * <p>If this table is managed by S3 Tables, contains additional information such as replication details.</p>
+     * @public
+     */
+    managedTableInformation?: ManagedTableInformation | undefined;
 }
 /**
  * @public
@@ -666,6 +749,89 @@ export interface GetTableBucketPolicyResponse {
      */
     resourcePolicy: string | undefined;
 }
+/**
+ * @public
+ */
+export interface GetTableBucketReplicationRequest {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the table bucket.</p>
+     * @public
+     */
+    tableBucketARN: string | undefined;
+}
+/**
+ * <p>Specifies a destination table bucket for replication.</p>
+ * @public
+ */
+export interface ReplicationDestination {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the destination table bucket where tables will be replicated.</p>
+     * @public
+     */
+    destinationTableBucketARN: string | undefined;
+}
+/**
+ * <p>Defines a rule for replicating tables from a source table bucket to one or more destination table buckets.</p>
+ * @public
+ */
+export interface TableBucketReplicationRule {
+    /**
+     * <p>An array of destination table buckets where tables should be replicated.</p>
+     * @public
+     */
+    destinations: ReplicationDestination[] | undefined;
+}
+/**
+ * <p>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.</p>
+ * @public
+ */
+export interface TableBucketReplicationConfiguration {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the IAM role that S3 Tables assumes to replicate tables on your behalf.</p>
+     * @public
+     */
+    role: string | undefined;
+    /**
+     * <p>An array of replication rules that define which tables to replicate and where to replicate them.</p>
+     * @public
+     */
+    rules: TableBucketReplicationRule[] | undefined;
+}
+/**
+ * @public
+ */
+export interface GetTableBucketReplicationResponse {
+    /**
+     * <p>A version token that represents the current state of the replication configuration. Use this token when updating the configuration to ensure consistency.</p>
+     * @public
+     */
+    versionToken: string | undefined;
+    /**
+     * <p>The replication configuration for the table bucket, including the IAM role and replication rules.</p>
+     * @public
+     */
+    configuration: TableBucketReplicationConfiguration | undefined;
+}
+/**
+ * @public
+ */
+export interface GetTableBucketStorageClassRequest {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the table bucket.</p>
+     * @public
+     */
+    tableBucketARN: string | undefined;
+}
+/**
+ * @public
+ */
+export interface GetTableBucketStorageClassResponse {
+    /**
+     * <p>The storage class configuration for the table bucket.</p>
+     * @public
+     */
+    storageClassConfiguration: StorageClassConfiguration | undefined;
+}
 /**
  * @public
  */
@@ -794,7 +960,7 @@ export declare namespace TableMaintenanceSettings {
     }
 }
 /**
- * <p>Contains the values that define a maintenance configuration for a table.</p>
+ * <p>The values that define a maintenance configuration for a table.</p>
  * @public
  */
 export interface TableMaintenanceConfigurationValue {
@@ -950,6 +1116,263 @@ export interface GetTablePolicyResponse {
      */
     resourcePolicy: string | undefined;
 }
+/**
+ * @public
+ */
+export interface GetTableRecordExpirationConfigurationRequest {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the table.</p>
+     * @public
+     */
+    tableArn: string | undefined;
+}
+/**
+ * <p>The record expiration setting that specifies when records expire and are automatically removed from a table.</p>
+ * @public
+ */
+export interface TableRecordExpirationSettings {
+    /**
+     * <p>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 <code>365</code>.</p>
+     * @public
+     */
+    days?: number | undefined;
+}
+/**
+ * <p>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.</p>
+ * @public
+ */
+export interface TableRecordExpirationConfigurationValue {
+    /**
+     * <p>The status of the expiration settings for records in the table.</p>
+     * @public
+     */
+    status?: TableRecordExpirationStatus | undefined;
+    /**
+     * <p>The expiration settings for records in the table.</p>
+     * @public
+     */
+    settings?: TableRecordExpirationSettings | undefined;
+}
+/**
+ * @public
+ */
+export interface GetTableRecordExpirationConfigurationResponse {
+    /**
+     * <p>The record expiration configuration for the table, including the status and retention settings.</p>
+     * @public
+     */
+    configuration: TableRecordExpirationConfigurationValue | undefined;
+}
+/**
+ * @public
+ */
+export interface GetTableRecordExpirationJobStatusRequest {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the table.</p>
+     * @public
+     */
+    tableArn: string | undefined;
+}
+/**
+ * <p>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.</p>
+ * @public
+ */
+export interface TableRecordExpirationJobMetrics {
+    /**
+     * <p>The total number of data files that were removed when the job ran.</p>
+     * @public
+     */
+    deletedDataFiles?: number | undefined;
+    /**
+     * <p>The total number of records that were removed when the job ran.</p>
+     * @public
+     */
+    deletedRecords?: number | undefined;
+    /**
+     * <p>The total size (in bytes) of the data files that were removed when the job ran.</p>
+     * @public
+     */
+    removedFilesSize?: number | undefined;
+}
+/**
+ * @public
+ */
+export interface GetTableRecordExpirationJobStatusResponse {
+    /**
+     * <p>The current status of the most recent expiration job.</p>
+     * @public
+     */
+    status: TableRecordExpirationJobStatus | undefined;
+    /**
+     * <p>The timestamp when the expiration job was last executed.</p>
+     * @public
+     */
+    lastRunTimestamp?: Date | undefined;
+    /**
+     * <p>If the job failed, this field contains an error message describing the failure reason.</p>
+     * @public
+     */
+    failureMessage?: string | undefined;
+    /**
+     * <p>Metrics about the most recent expiration job execution, including the number of records and files deleted.</p>
+     * @public
+     */
+    metrics?: TableRecordExpirationJobMetrics | undefined;
+}
+/**
+ * @public
+ */
+export interface GetTableReplicationRequest {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the table.</p>
+     * @public
+     */
+    tableArn: string | undefined;
+}
+/**
+ * <p>Defines a rule for replicating a table to one or more destination tables.</p>
+ * @public
+ */
+export interface TableReplicationRule {
+    /**
+     * <p>An array of destination table buckets where this table should be replicated.</p>
+     * @public
+     */
+    destinations: ReplicationDestination[] | undefined;
+}
+/**
+ * <p>The replication configuration for an individual table. This configuration defines how the table is replicated to destination tables.</p>
+ * @public
+ */
+export interface TableReplicationConfiguration {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the IAM role that S3 Tables assumes to replicate the table on your behalf.</p>
+     * @public
+     */
+    role: string | undefined;
+    /**
+     * <p>An array of replication rules that define where this table should be replicated.</p>
+     * @public
+     */
+    rules: TableReplicationRule[] | undefined;
+}
+/**
+ * @public
+ */
+export interface GetTableReplicationResponse {
+    /**
+     * <p>A version token that represents the current state of the table's replication configuration. Use this token when updating the configuration to ensure consistency.</p>
+     * @public
+     */
+    versionToken: string | undefined;
+    /**
+     * <p>The replication configuration for the table, including the IAM role and replication rules.</p>
+     * @public
+     */
+    configuration: TableReplicationConfiguration | undefined;
+}
+/**
+ * @public
+ */
+export interface GetTableReplicationStatusRequest {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the table.</p>
+     * @public
+     */
+    tableArn: string | undefined;
+}
+/**
+ * <p>Contains information about the most recent successful replication update to a destination.</p>
+ * @public
+ */
+export interface LastSuccessfulReplicatedUpdate {
+    /**
+     * <p>The S3 location of the metadata that was successfully replicated.</p>
+     * @public
+     */
+    metadataLocation: string | undefined;
+    /**
+     * <p>The timestamp when the replication update completed successfully.</p>
+     * @public
+     */
+    timestamp: Date | undefined;
+}
+/**
+ * <p>Contains status information for a replication destination, including the current replication state, last successful update, and any error messages.</p>
+ * @public
+ */
+export interface ReplicationDestinationStatusModel {
+    /**
+     * <p>The current status of replication to this destination.</p>
+     * @public
+     */
+    replicationStatus: ReplicationStatus | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the destination table bucket.</p>
+     * @public
+     */
+    destinationTableBucketArn: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the destination table.</p>
+     * @public
+     */
+    destinationTableArn?: string | undefined;
+    /**
+     * <p>Information about the most recent successful replication update to this destination.</p>
+     * @public
+     */
+    lastSuccessfulReplicatedUpdate?: LastSuccessfulReplicatedUpdate | undefined;
+    /**
+     * <p>If replication has failed, this field contains an error message describing the failure reason.</p>
+     * @public
+     */
+    failureMessage?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface GetTableReplicationStatusResponse {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the source table being replicated.</p>
+     * @public
+     */
+    sourceTableArn: string | undefined;
+    /**
+     * <p>An array of status information for each replication destination, including the current state, last successful update, and any error messages.</p>
+     * @public
+     */
+    destinations: ReplicationDestinationStatusModel[] | undefined;
+}
+/**
+ * @public
+ */
+export interface GetTableStorageClassRequest {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the table bucket that contains the table.</p>
+     * @public
+     */
+    tableBucketARN: string | undefined;
+    /**
+     * <p>The namespace associated with the table.</p>
+     * @public
+     */
+    namespace: string | undefined;
+    /**
+     * <p>The name of the table.</p>
+     * @public
+     */
+    name: string | undefined;
+}
+/**
+ * @public
+ */
+export interface GetTableStorageClassResponse {
+    /**
+     * <p>The storage class configuration for the table.</p>
+     * @public
+     */
+    storageClassConfiguration: StorageClassConfiguration | undefined;
+}
 /**
  * @public
  */
@@ -1167,6 +1590,11 @@ export interface TableSummary {
      * @public
      */
     modifiedAt: Date | undefined;
+    /**
+     * <p>The Amazon Web Services service managing this table, if applicable. For example, a replicated table is managed by the S3 Tables replication service.</p>
+     * @public
+     */
+    managedByService?: string | undefined;
     /**
      * <p>The unique identifier for the namespace that contains this table.</p>
      * @public
@@ -1273,6 +1701,56 @@ export interface PutTableBucketPolicyRequest {
      */
     resourcePolicy: string | undefined;
 }
+/**
+ * @public
+ */
+export interface PutTableBucketReplicationRequest {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the source table bucket.</p>
+     * @public
+     */
+    tableBucketARN: string | undefined;
+    /**
+     * <p>A version token from a previous GetTableBucketReplication call. Use this token to ensure you're updating the expected version of the configuration.</p>
+     * @public
+     */
+    versionToken?: string | undefined;
+    /**
+     * <p>The replication configuration to apply, including the IAM role and replication rules.</p>
+     * @public
+     */
+    configuration: TableBucketReplicationConfiguration | undefined;
+}
+/**
+ * @public
+ */
+export interface PutTableBucketReplicationResponse {
+    /**
+     * <p>A new version token representing the updated replication configuration.</p>
+     * @public
+     */
+    versionToken: string | undefined;
+    /**
+     * <p>The status of the replication configuration operation.</p>
+     * @public
+     */
+    status: string | undefined;
+}
+/**
+ * @public
+ */
+export interface PutTableBucketStorageClassRequest {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the table bucket.</p>
+     * @public
+     */
+    tableBucketARN: string | undefined;
+    /**
+     * <p>The storage class configuration to apply to the table bucket. This configuration will serve as the default for new tables created in this bucket.</p>
+     * @public
+     */
+    storageClassConfiguration: StorageClassConfiguration | undefined;
+}
 /**
  * @public
  */
@@ -1328,6 +1806,56 @@ export interface PutTablePolicyRequest {
      */
     resourcePolicy: string | undefined;
 }
+/**
+ * @public
+ */
+export interface PutTableRecordExpirationConfigurationRequest {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the table.</p>
+     * @public
+     */
+    tableArn: string | undefined;
+    /**
+     * <p>The record expiration configuration to apply to the table, including the status (<code>enabled</code> or <code>disabled</code>) and retention period in days.</p>
+     * @public
+     */
+    value: TableRecordExpirationConfigurationValue | undefined;
+}
+/**
+ * @public
+ */
+export interface PutTableReplicationRequest {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the source table.</p>
+     * @public
+     */
+    tableArn: string | undefined;
+    /**
+     * <p>A version token from a previous GetTableReplication call. Use this token to ensure you're updating the expected version of the configuration.</p>
+     * @public
+     */
+    versionToken?: string | undefined;
+    /**
+     * <p>The replication configuration to apply to the table, including the IAM role and replication rules.</p>
+     * @public
+     */
+    configuration: TableReplicationConfiguration | undefined;
+}
+/**
+ * @public
+ */
+export interface PutTableReplicationResponse {
+    /**
+     * <p>A new version token representing the updated replication configuration.</p>
+     * @public
+     */
+    versionToken: string | undefined;
+    /**
+     * <p>The status of the replication configuration operation.</p>
+     * @public
+     */
+    status: string | undefined;
+}
 /**
  * @public
  */