Class: Aws::S3Tables::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::S3Tables::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb
Overview
An API client for S3Tables. To construct a client, you need to configure a :region and :credentials.
client = Aws::S3Tables::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#complete_table_migration(params = {}) ⇒ Struct
Completes the migration of a table.
-
#create_namespace(params = {}) ⇒ Types::CreateNamespaceResponse
Creates a namespace.
-
#create_table(params = {}) ⇒ Types::CreateTableResponse
Creates a new table associated with the given namespace in a table bucket.
-
#create_table_bucket(params = {}) ⇒ Types::CreateTableBucketResponse
Creates a table bucket.
-
#delete_namespace(params = {}) ⇒ Struct
Deletes a namespace.
-
#delete_table(params = {}) ⇒ Struct
Deletes a table.
-
#delete_table_bucket(params = {}) ⇒ Struct
Deletes a table bucket.
-
#delete_table_bucket_encryption(params = {}) ⇒ Struct
Deletes the encryption configuration for a table bucket.
-
#delete_table_bucket_metrics_configuration(params = {}) ⇒ Struct
Deletes the metrics configuration for a table bucket.
-
#delete_table_bucket_policy(params = {}) ⇒ Struct
Deletes a table bucket policy.
-
#delete_table_bucket_replication(params = {}) ⇒ Struct
Deletes the replication configuration for a table bucket.
-
#delete_table_policy(params = {}) ⇒ Struct
Deletes a table policy.
-
#delete_table_replication(params = {}) ⇒ Struct
Deletes the replication configuration for a specific table.
-
#disassociate_table_replication(params = {}) ⇒ Struct
Disassociates a replica table from replication, making it a standalone writable table.
-
#get_namespace(params = {}) ⇒ Types::GetNamespaceResponse
Gets details about a namespace.
-
#get_table(params = {}) ⇒ Types::GetTableResponse
Gets details about a table.
-
#get_table_bucket(params = {}) ⇒ Types::GetTableBucketResponse
Gets details on a table bucket.
-
#get_table_bucket_encryption(params = {}) ⇒ Types::GetTableBucketEncryptionResponse
Gets the encryption configuration for a table bucket.
-
#get_table_bucket_logging(params = {}) ⇒ Types::GetTableBucketLoggingResponse
Gets the server access logging configuration for a table bucket.
-
#get_table_bucket_maintenance_configuration(params = {}) ⇒ Types::GetTableBucketMaintenanceConfigurationResponse
Gets details about a maintenance configuration for a given table bucket.
-
#get_table_bucket_metrics_configuration(params = {}) ⇒ Types::GetTableBucketMetricsConfigurationResponse
Gets the metrics configuration for a table bucket.
-
#get_table_bucket_policy(params = {}) ⇒ Types::GetTableBucketPolicyResponse
Gets details about a table bucket policy.
-
#get_table_bucket_replication(params = {}) ⇒ Types::GetTableBucketReplicationResponse
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. -
#get_table_bucket_storage_class(params = {}) ⇒ Types::GetTableBucketStorageClassResponse
Retrieves the storage class configuration for a specific table.
-
#get_table_encryption(params = {}) ⇒ Types::GetTableEncryptionResponse
Gets the encryption configuration for a table.
-
#get_table_maintenance_configuration(params = {}) ⇒ Types::GetTableMaintenanceConfigurationResponse
Gets details about the maintenance configuration of a table.
-
#get_table_maintenance_job_status(params = {}) ⇒ Types::GetTableMaintenanceJobStatusResponse
Gets the status of a maintenance job for a table.
-
#get_table_metadata_location(params = {}) ⇒ Types::GetTableMetadataLocationResponse
Gets the location of the table metadata.
-
#get_table_migration(params = {}) ⇒ Types::GetTableMigrationResponse
Gets the details of a migration, including its state, the reason it failed, its statistics and the location of its reports.
-
#get_table_policy(params = {}) ⇒ Types::GetTablePolicyResponse
Gets details about a table policy.
-
#get_table_record_expiration_configuration(params = {}) ⇒ Types::GetTableRecordExpirationConfigurationResponse
Retrieves the expiration configuration settings for records in a table, and the status of the configuration.
-
#get_table_record_expiration_job_status(params = {}) ⇒ Types::GetTableRecordExpirationJobStatusResponse
Retrieves the status, metrics, and details of the latest record expiration job for a table.
-
#get_table_replication(params = {}) ⇒ Types::GetTableReplicationResponse
Retrieves the replication configuration for a specific table.
-
#get_table_replication_status(params = {}) ⇒ Types::GetTableReplicationStatusResponse
Retrieves the replication status for a table, including the status of replication to each destination.
-
#get_table_storage_class(params = {}) ⇒ Types::GetTableStorageClassResponse
Retrieves the storage class configuration for a specific table.
-
#list_namespaces(params = {}) ⇒ Types::ListNamespacesResponse
Lists the namespaces within a table bucket.
-
#list_table_buckets(params = {}) ⇒ Types::ListTableBucketsResponse
Lists table buckets for your account.
-
#list_table_migrations(params = {}) ⇒ Types::ListTableMigrationsResponse
Lists the migrations whose destination is in a table bucket, a namespace or a table.
-
#list_tables(params = {}) ⇒ Types::ListTablesResponse
List tables in the given table bucket.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all of the tags applied to a specified Amazon S3 Tables resource.
-
#put_table_bucket_encryption(params = {}) ⇒ Struct
Sets the encryption configuration for a table bucket.
-
#put_table_bucket_logging(params = {}) ⇒ Struct
Sets, updates, or removes the server access logging configuration for a table bucket.
-
#put_table_bucket_maintenance_configuration(params = {}) ⇒ Struct
Creates a new maintenance configuration or replaces an existing maintenance configuration for a table bucket.
-
#put_table_bucket_metrics_configuration(params = {}) ⇒ Struct
Sets the metrics configuration for a table bucket.
-
#put_table_bucket_policy(params = {}) ⇒ Struct
Creates a new table bucket policy or replaces an existing table bucket policy for a table bucket.
-
#put_table_bucket_replication(params = {}) ⇒ Types::PutTableBucketReplicationResponse
Creates or updates the replication configuration for a table bucket.
-
#put_table_bucket_storage_class(params = {}) ⇒ Struct
Sets or updates the storage class configuration for a table bucket.
-
#put_table_maintenance_configuration(params = {}) ⇒ Struct
Creates a new maintenance configuration or replaces an existing maintenance configuration for a table.
-
#put_table_policy(params = {}) ⇒ Struct
Creates a new table policy or replaces an existing table policy for a table.
-
#put_table_record_expiration_configuration(params = {}) ⇒ Struct
Creates or updates the expiration configuration settings for records in a table, including the status of the configuration.
-
#put_table_replication(params = {}) ⇒ Types::PutTableReplicationResponse
Creates or updates the replication configuration for a specific table.
-
#rename_table(params = {}) ⇒ Struct
Renames a table or a namespace.
-
#start_table_migration(params = {}) ⇒ Types::StartTableMigrationResponse
Starts migrating an Amazon Web Services Glue Data Catalog table into a new table in a table bucket.
-
#sync_table_migration(params = {}) ⇒ Types::SyncTableMigrationResponse
Migrates the changes in the source table since the previous start or sync, such as added and deleted source objects, into the destination table.
-
#tag_resource(params = {}) ⇒ Struct
Applies one or more user-defined tags to an Amazon S3 Tables resource or updates existing tags.
-
#untag_resource(params = {}) ⇒ Struct
Removes the specified user-defined tags from an Amazon S3 Tables resource.
-
#update_table_metadata_location(params = {}) ⇒ Types::UpdateTableMetadataLocationResponse
Updates the metadata location for a table.
-
#update_table_migration(params = {}) ⇒ Types::UpdateTableMigrationResponse
Requests a state change for a migration.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
479 480 481 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 479 def initialize(*args) super end |
Instance Method Details
#complete_table_migration(params = {}) ⇒ Struct
Completes the migration of a table. The table's most recent migration
must be in the succeeded, failed or cancelled state. After you
complete the migration, you can't sync the table again, and you can
write to and maintain the table as you do any other table: compaction
starts, and unreferenced file removal follows the table bucket's
configuration. You can't undo this operation. Calling it again for
the same table returns a ConflictException.
- Permissions
- You must have the
s3tables:CompleteTableMigrationpermission to use this operation.
^
- You must have the
515 516 517 518 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 515 def complete_table_migration(params = {}, = {}) req = build_request(:complete_table_migration, params) req.send_request() end |
#create_namespace(params = {}) ⇒ Types::CreateNamespaceResponse
Creates a namespace. A namespace is a logical grouping of tables within your table bucket, which you can use to organize tables. For more information, see Create a namespace in the Amazon Simple Storage Service User Guide.
- Permissions
You must have the
s3tables:CreateNamespacepermission to use this operation.
563 564 565 566 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 563 def create_namespace(params = {}, = {}) req = build_request(:create_namespace, params) req.send_request() end |
#create_table(params = {}) ⇒ Types::CreateTableResponse
Creates a new table associated with the given namespace in a table bucket. For more information, see Creating an Amazon S3 table in the Amazon Simple Storage Service User Guide.
- Permissions
You must have the
s3tables:CreateTablepermission to use this operation.If you use this operation with the optional
metadatarequest parameter you must have thes3tables:PutTableDatapermission.If you use this operation with the optional
encryptionConfigurationrequest parameter you must have thes3tables:PutTableEncryptionpermission.If you use this operation with the
storageClassConfigurationrequest parameter, you must have thes3tables:PutTableStorageClasspermission.To create a table with tags, you must have the
s3tables:TagResourcepermission in addition tos3tables:CreateTablepermission.
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.
743 744 745 746 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 743 def create_table(params = {}, = {}) req = build_request(:create_table, params) req.send_request() end |
#create_table_bucket(params = {}) ⇒ Types::CreateTableBucketResponse
Creates a table bucket. For more information, see Creating a table bucket in the Amazon Simple Storage Service User Guide.
- Permissions
You must have the
s3tables:CreateTableBucketpermission to use this operation.If you use this operation with the optional
encryptionConfigurationparameter you must have thes3tables:PutTableBucketEncryptionpermission.If you use this operation with the
storageClassConfigurationrequest parameter, you must have thes3tables:PutTableBucketStorageClasspermission.To create a table bucket with tags, you must have the
s3tables:TagResourcepermission in addition tos3tables:CreateTableBucketpermission.
832 833 834 835 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 832 def create_table_bucket(params = {}, = {}) req = build_request(:create_table_bucket, params) req.send_request() end |
#delete_namespace(params = {}) ⇒ Struct
Deletes a namespace. For more information, see Delete a namespace in the Amazon Simple Storage Service User Guide.
- Permissions
You must have the
s3tables:DeleteNamespacepermission to use this operation.
869 870 871 872 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 869 def delete_namespace(params = {}, = {}) req = build_request(:delete_namespace, params) req.send_request() end |
#delete_table(params = {}) ⇒ Struct
Deletes a table. For more information, see Deleting an Amazon S3 table in the Amazon Simple Storage Service User Guide.
- Permissions
You must have the
s3tables:DeleteTablepermission to use this operation.
914 915 916 917 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 914 def delete_table(params = {}, = {}) req = build_request(:delete_table, params) req.send_request() end |
#delete_table_bucket(params = {}) ⇒ Struct
Deletes a table bucket. For more information, see Deleting a table bucket in the Amazon Simple Storage Service User Guide.
- Permissions
You must have the
s3tables:DeleteTableBucketpermission to use this operation.
946 947 948 949 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 946 def delete_table_bucket(params = {}, = {}) req = build_request(:delete_table_bucket, params) req.send_request() end |
#delete_table_bucket_encryption(params = {}) ⇒ Struct
Deletes the encryption configuration for a table bucket.
- Permissions
You must have the
s3tables:DeleteTableBucketEncryptionpermission to use this operation.
973 974 975 976 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 973 def delete_table_bucket_encryption(params = {}, = {}) req = build_request(:delete_table_bucket_encryption, params) req.send_request() end |
#delete_table_bucket_metrics_configuration(params = {}) ⇒ Struct
Deletes the metrics configuration for a table bucket.
- Permissions
You must have the
s3tables:DeleteTableBucketMetricsConfigurationpermission to use this operation.
1000 1001 1002 1003 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1000 def delete_table_bucket_metrics_configuration(params = {}, = {}) req = build_request(:delete_table_bucket_metrics_configuration, params) req.send_request() end |
#delete_table_bucket_policy(params = {}) ⇒ Struct
Deletes a table bucket policy. For more information, see Deleting a table bucket policy in the Amazon Simple Storage Service User Guide.
- Permissions
You must have the
s3tables:DeleteTableBucketPolicypermission to use this operation.
1033 1034 1035 1036 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1033 def delete_table_bucket_policy(params = {}, = {}) req = build_request(:delete_table_bucket_policy, params) req.send_request() end |
#delete_table_bucket_replication(params = {}) ⇒ Struct
Deletes the replication configuration for a table bucket. After deletion, new table updates will no longer be replicated to destination buckets, though existing replicated tables will remain in destination buckets.
- Permissions
You must have the
s3tables:DeleteTableBucketReplicationpermission to use this operation.
1069 1070 1071 1072 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1069 def delete_table_bucket_replication(params = {}, = {}) req = build_request(:delete_table_bucket_replication, params) req.send_request() end |
#delete_table_policy(params = {}) ⇒ Struct
Deletes a table policy. For more information, see Deleting a table policy in the Amazon Simple Storage Service User Guide.
- Permissions
You must have the
s3tables:DeleteTablePolicypermission to use this operation.
1110 1111 1112 1113 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1110 def delete_table_policy(params = {}, = {}) req = build_request(:delete_table_policy, params) req.send_request() end |
#delete_table_replication(params = {}) ⇒ Struct
Deletes the replication configuration for a specific table. After deletion, new updates to this table will no longer be replicated to destination tables, though existing replicated copies will remain in destination buckets.
- Permissions
You must have the
s3tables:DeleteTableReplicationpermission to use this operation.
1146 1147 1148 1149 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1146 def delete_table_replication(params = {}, = {}) req = build_request(:delete_table_replication, params) req.send_request() end |
#disassociate_table_replication(params = {}) ⇒ Struct
Disassociates a replica table from replication, making it a standalone writable table. Any in-progress replication to the table stops, and in-flight commits fail without being committed to the table. Disassociating a table from replication is permanent and can't be reversed.
You can only disassociate a replica table. If you call this operation on a table that isn't a replica table, including a table that you have already disassociated, the request fails.
After you disassociate a table from replication, you can write to the
table as you do any other table. GetTable no longer returns
managedByService and managedTableInformation for the table, and
ListTables no longer returns managedByService for it. On the
source table, GetTableReplicationStatus reports a failure for this
destination the next time replication to it is attempted.
Disassociating a table from replication doesn't change its maintenance configuration. Review the maintenance settings of the table, such as compaction, after you disassociate it.
- Permissions
You must have the
s3tables:DisassociateTableReplicationpermission to use this operation.
1193 1194 1195 1196 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1193 def disassociate_table_replication(params = {}, = {}) req = build_request(:disassociate_table_replication, params) req.send_request() end |
#get_namespace(params = {}) ⇒ Types::GetNamespaceResponse
Gets details about a namespace. For more information, see Table namespaces in the Amazon Simple Storage Service User Guide.
- Permissions
You must have the
s3tables:GetNamespacepermission to use this operation.
1246 1247 1248 1249 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1246 def get_namespace(params = {}, = {}) req = build_request(:get_namespace, params) req.send_request() end |
#get_table(params = {}) ⇒ Types::GetTableResponse
Gets details about a table. For more information, see S3 Tables in the Amazon Simple Storage Service User Guide.
- Permissions
You must have the
s3tables:GetTablepermission to use this operation.
1330 1331 1332 1333 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1330 def get_table(params = {}, = {}) req = build_request(:get_table, params) req.send_request() end |
#get_table_bucket(params = {}) ⇒ Types::GetTableBucketResponse
Gets details on a table bucket. For more information, see Viewing details about an Amazon S3 table bucket in the Amazon Simple Storage Service User Guide.
- Permissions
You must have the
s3tables:GetTableBucketpermission to use this operation.
1379 1380 1381 1382 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1379 def get_table_bucket(params = {}, = {}) req = build_request(:get_table_bucket, params) req.send_request() end |
#get_table_bucket_encryption(params = {}) ⇒ Types::GetTableBucketEncryptionResponse
Gets the encryption configuration for a table bucket.
- Permissions
You must have the
s3tables:GetTableBucketEncryptionpermission to use this operation.
1413 1414 1415 1416 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1413 def get_table_bucket_encryption(params = {}, = {}) req = build_request(:get_table_bucket_encryption, params) req.send_request() end |
#get_table_bucket_logging(params = {}) ⇒ Types::GetTableBucketLoggingResponse
Gets the server access logging configuration for a table bucket. For more information, see Server access logging for table buckets in the Amazon Simple Storage Service User Guide.
- Permissions
You must have the
s3tables:GetTableBucketLoggingpermission to use this operation.
1493 1494 1495 1496 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1493 def get_table_bucket_logging(params = {}, = {}) req = build_request(:get_table_bucket_logging, params) req.send_request() end |
#get_table_bucket_maintenance_configuration(params = {}) ⇒ Types::GetTableBucketMaintenanceConfigurationResponse
Gets details about a maintenance configuration for a given table bucket. For more information, see Amazon S3 table bucket maintenance in the Amazon Simple Storage Service User Guide.
- Permissions
You must have the
s3tables:GetTableBucketMaintenanceConfigurationpermission to use this operation.
1538 1539 1540 1541 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1538 def get_table_bucket_maintenance_configuration(params = {}, = {}) req = build_request(:get_table_bucket_maintenance_configuration, params) req.send_request() end |
#get_table_bucket_metrics_configuration(params = {}) ⇒ Types::GetTableBucketMetricsConfigurationResponse
Gets the metrics configuration for a table bucket.
- Permissions
You must have the
s3tables:GetTableBucketMetricsConfigurationpermission to use this operation.
1573 1574 1575 1576 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1573 def get_table_bucket_metrics_configuration(params = {}, = {}) req = build_request(:get_table_bucket_metrics_configuration, params) req.send_request() end |
#get_table_bucket_policy(params = {}) ⇒ Types::GetTableBucketPolicyResponse
Gets details about a table bucket policy. For more information, see Viewing a table bucket policy in the Amazon Simple Storage Service User Guide.
- Permissions
You must have the
s3tables:GetTableBucketPolicypermission to use this operation.
1612 1613 1614 1615 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1612 def get_table_bucket_policy(params = {}, = {}) req = build_request(:get_table_bucket_policy, params) req.send_request() end |
#get_table_bucket_replication(params = {}) ⇒ Types::GetTableBucketReplicationResponse
Retrieves the replication configuration for a table bucket.This
operation returns the IAM role, versionToken, and replication rules
that define how tables in this bucket are replicated to other buckets.
- Permissions
You must have the
s3tables:GetTableBucketReplicationpermission to use this operation.
1652 1653 1654 1655 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1652 def get_table_bucket_replication(params = {}, = {}) req = build_request(:get_table_bucket_replication, params) req.send_request() end |
#get_table_bucket_storage_class(params = {}) ⇒ Types::GetTableBucketStorageClassResponse
Retrieves the storage class configuration for a specific table. This allows you to view the storage class settings that apply to an individual table, which may differ from the table bucket's default configuration.
- Permissions
You must have the
s3tables:GetTableBucketStorageClasspermission to use this operation.
1688 1689 1690 1691 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1688 def get_table_bucket_storage_class(params = {}, = {}) req = build_request(:get_table_bucket_storage_class, params) req.send_request() end |
#get_table_encryption(params = {}) ⇒ Types::GetTableEncryptionResponse
Gets the encryption configuration for a table.
- Permissions
You must have the
s3tables:GetTableEncryptionpermission to use this operation.
1731 1732 1733 1734 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1731 def get_table_encryption(params = {}, = {}) req = build_request(:get_table_encryption, params) req.send_request() end |
#get_table_maintenance_configuration(params = {}) ⇒ Types::GetTableMaintenanceConfigurationResponse
Gets details about the maintenance configuration of a table. For more information, see S3 Tables maintenance in the Amazon Simple Storage Service User Guide.
- Permissions
You must have the
s3tables:GetTableMaintenanceConfigurationpermission to use this operation.You must have the
s3tables:GetTableDatapermission to use set the compaction strategy tosortorzorder.
1787 1788 1789 1790 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1787 def get_table_maintenance_configuration(params = {}, = {}) req = build_request(:get_table_maintenance_configuration, params) req.send_request() end |
#get_table_maintenance_job_status(params = {}) ⇒ Types::GetTableMaintenanceJobStatusResponse
Gets the status of a maintenance job for a table. For more information, see S3 Tables maintenance in the Amazon Simple Storage Service User Guide.
- Permissions
You must have the
s3tables:GetTableMaintenanceJobStatuspermission to use this operation.
1840 1841 1842 1843 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1840 def get_table_maintenance_job_status(params = {}, = {}) req = build_request(:get_table_maintenance_job_status, params) req.send_request() end |
#get_table_metadata_location(params = {}) ⇒ Types::GetTableMetadataLocationResponse
Gets the location of the table metadata.
- Permissions
You must have the
s3tables:GetTableMetadataLocationpermission to use this operation.
1885 1886 1887 1888 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1885 def (params = {}, = {}) req = build_request(:get_table_metadata_location, params) req.send_request() end |
#get_table_migration(params = {}) ⇒ Types::GetTableMigrationResponse
Gets the details of a migration, including its state, the reason it
failed, its statistics and the location of its reports. Identify the
migration by its migrationId, or specify the tableARN of a
destination table to get that table's most recent migration.
- Permissions
- You must have the
s3tables:GetTableMigrationpermission to use this operation.
^
- You must have the
1992 1993 1994 1995 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 1992 def get_table_migration(params = {}, = {}) req = build_request(:get_table_migration, params) req.send_request() end |
#get_table_policy(params = {}) ⇒ Types::GetTablePolicyResponse
Gets details about a table policy. For more information, see Viewing a table policy in the Amazon Simple Storage Service User Guide.
- Permissions
You must have the
s3tables:GetTablePolicypermission to use this operation.
2039 2040 2041 2042 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2039 def get_table_policy(params = {}, = {}) req = build_request(:get_table_policy, params) req.send_request() end |
#get_table_record_expiration_configuration(params = {}) ⇒ Types::GetTableRecordExpirationConfigurationResponse
Retrieves the expiration configuration settings for records in a
table, and the status of the configuration. If the status of the
configuration is enabled, records expire and are automatically
removed from the table after the specified number of days.
- Permissions
You must have the
s3tables:GetTableRecordExpirationConfigurationpermission to use this operation.
2076 2077 2078 2079 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2076 def get_table_record_expiration_configuration(params = {}, = {}) req = build_request(:get_table_record_expiration_configuration, params) req.send_request() end |
#get_table_record_expiration_job_status(params = {}) ⇒ Types::GetTableRecordExpirationJobStatusResponse
Retrieves the status, metrics, and details of the latest record expiration job for a table. This includes when the job ran, and whether it succeeded or failed. If the job ran successfully, this also includes statistics about the records that were removed.
- Permissions
You must have the
s3tables:GetTableRecordExpirationJobStatuspermission to use this operation.
2120 2121 2122 2123 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2120 def get_table_record_expiration_job_status(params = {}, = {}) req = build_request(:get_table_record_expiration_job_status, params) req.send_request() end |
#get_table_replication(params = {}) ⇒ Types::GetTableReplicationResponse
Retrieves the replication configuration for a specific table.
- Permissions
You must have the
s3tables:GetTableReplicationpermission to use this operation.
2158 2159 2160 2161 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2158 def get_table_replication(params = {}, = {}) req = build_request(:get_table_replication, params) req.send_request() end |
#get_table_replication_status(params = {}) ⇒ Types::GetTableReplicationStatusResponse
Retrieves the replication status for a table, including the status of replication to each destination. This operation provides visibility into replication health and progress.
- Permissions
You must have the
s3tables:GetTableReplicationStatuspermission to use this operation.
2201 2202 2203 2204 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2201 def get_table_replication_status(params = {}, = {}) req = build_request(:get_table_replication_status, params) req.send_request() end |
#get_table_storage_class(params = {}) ⇒ Types::GetTableStorageClassResponse
Retrieves the storage class configuration for a specific table. This allows you to view the storage class settings that apply to an individual table, which may differ from the table bucket's default configuration.
- Permissions
You must have the
s3tables:GetTableStorageClasspermission to use this operation.
2246 2247 2248 2249 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2246 def get_table_storage_class(params = {}, = {}) req = build_request(:get_table_storage_class, params) req.send_request() end |
#list_namespaces(params = {}) ⇒ Types::ListNamespacesResponse
Lists the namespaces within a table bucket. For more information, see Table namespaces in the Amazon Simple Storage Service User Guide.
- Permissions
You must have the
s3tables:ListNamespacespermission to use this operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2311 2312 2313 2314 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2311 def list_namespaces(params = {}, = {}) req = build_request(:list_namespaces, params) req.send_request() end |
#list_table_buckets(params = {}) ⇒ Types::ListTableBucketsResponse
Lists table buckets for your account. For more information, see S3 Table buckets in the Amazon Simple Storage Service User Guide.
- Permissions
You must have the
s3tables:ListTableBucketspermission to use this operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2374 2375 2376 2377 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2374 def list_table_buckets(params = {}, = {}) req = build_request(:list_table_buckets, params) req.send_request() end |
#list_table_migrations(params = {}) ⇒ Types::ListTableMigrationsResponse
Lists the migrations whose destination is in a table bucket, a
namespace or a table. Specify a tableBucketARN to list the
migrations into a table bucket, and add a namespace, or a
namespace and a name, to narrow the list. Or specify a tableARN
to list the migrations into a table.
Migrations are listed newest first. Results are paginated: use
maxResults to set the page size, and pass the nextToken from a
response to retrieve the next page of results. A page can contain
fewer migrations than maxResults, or none, and still return a
nextToken. Continue until a response has no nextToken.
- Permissions
- You must have the
s3tables:ListTableMigrationspermission to use this operation.
^
- You must have the
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2470 2471 2472 2473 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2470 def list_table_migrations(params = {}, = {}) req = build_request(:list_table_migrations, params) req.send_request() end |
#list_tables(params = {}) ⇒ Types::ListTablesResponse
List tables in the given table bucket. For more information, see S3 Tables in the Amazon Simple Storage Service User Guide.
- Permissions
You must have the
s3tables:ListTablespermission to use this operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2541 2542 2543 2544 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2541 def list_tables(params = {}, = {}) req = build_request(:list_tables, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
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.
- Permissions
For tables and table buckets, you must have the
s3tables:ListTagsForResourcepermission to use this operation.
2594 2595 2596 2597 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2594 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_table_bucket_encryption(params = {}) ⇒ Struct
Sets the encryption configuration for a table bucket.
- Permissions
You must have the
s3tables:PutTableBucketEncryptionpermission 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.
2639 2640 2641 2642 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2639 def put_table_bucket_encryption(params = {}, = {}) req = build_request(:put_table_bucket_encryption, params) req.send_request() end |
#put_table_bucket_logging(params = {}) ⇒ Struct
Sets, updates, or removes the server access logging configuration for
a table bucket. When logging is enabled, Amazon S3 delivers a record
of the requests made to the table bucket and its tables to the target
general purpose bucket that you specify. To disable logging, call this
operation with an empty tableBucketLoggingStatus. For more
information, see Server access logging for table buckets in the
Amazon Simple Storage Service User Guide.
- Permissions
You must have the
s3tables:PutTableBucketLoggingpermission to use this operation.
2722 2723 2724 2725 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2722 def put_table_bucket_logging(params = {}, = {}) req = build_request(:put_table_bucket_logging, params) req.send_request() end |
#put_table_bucket_maintenance_configuration(params = {}) ⇒ Struct
Creates a new maintenance configuration or replaces an existing maintenance configuration for a table bucket. For more information, see Amazon S3 table bucket maintenance in the Amazon Simple Storage Service User Guide.
- Permissions
You must have the
s3tables:PutTableBucketMaintenanceConfigurationpermission to use this operation.
2774 2775 2776 2777 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2774 def put_table_bucket_maintenance_configuration(params = {}, = {}) req = build_request(:put_table_bucket_maintenance_configuration, params) req.send_request() end |
#put_table_bucket_metrics_configuration(params = {}) ⇒ Struct
Sets the metrics configuration for a table bucket.
- Permissions
You must have the
s3tables:PutTableBucketMetricsConfigurationpermission to use this operation.
2801 2802 2803 2804 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2801 def put_table_bucket_metrics_configuration(params = {}, = {}) req = build_request(:put_table_bucket_metrics_configuration, params) req.send_request() end |
#put_table_bucket_policy(params = {}) ⇒ Struct
Creates a new table bucket policy or replaces an existing table bucket policy for a table bucket. For more information, see Adding a table bucket policy in the Amazon Simple Storage Service User Guide.
- Permissions
You must have the
s3tables:PutTableBucketPolicypermission to use this operation.
2838 2839 2840 2841 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2838 def put_table_bucket_policy(params = {}, = {}) req = build_request(:put_table_bucket_policy, params) req.send_request() end |
#put_table_bucket_replication(params = {}) ⇒ Types::PutTableBucketReplicationResponse
Creates or updates the replication configuration for a table bucket. This operation defines how tables in the source bucket are replicated to destination buckets. Replication helps ensure data availability and disaster recovery across regions or accounts.
- Permissions
You must have the
s3tables:PutTableBucketReplicationpermission 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:GetTablepermission on the source table.s3tables:ListTablespermission on the bucket containing the table.s3tables:CreateTablepermission for the destination.s3tables:CreateNamespacepermission for the destination.s3tables:GetTableMaintenanceConfigpermission for the source bucket.s3tables:PutTableMaintenanceConfigpermission for the destination bucket.
- You must have
iam:PassRolepermission with condition allowing roles to be passed toreplication.s3tables.amazonaws.com.
2918 2919 2920 2921 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2918 def put_table_bucket_replication(params = {}, = {}) req = build_request(:put_table_bucket_replication, params) req.send_request() end |
#put_table_bucket_storage_class(params = {}) ⇒ Struct
Sets or updates the storage class configuration for a table bucket. This configuration serves as the default storage class for all new tables created in the bucket, allowing you to optimize storage costs at the bucket level.
- Permissions
You must have the
s3tables:PutTableBucketStorageClasspermission to use this operation.
2956 2957 2958 2959 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 2956 def put_table_bucket_storage_class(params = {}, = {}) req = build_request(:put_table_bucket_storage_class, params) req.send_request() end |
#put_table_maintenance_configuration(params = {}) ⇒ Struct
Creates a new maintenance configuration or replaces an existing maintenance configuration for a table. For more information, see S3 Tables maintenance in the Amazon Simple Storage Service User Guide.
- Permissions
You must have the
s3tables:PutTableMaintenanceConfigurationpermission to use this operation.
3019 3020 3021 3022 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 3019 def put_table_maintenance_configuration(params = {}, = {}) req = build_request(:put_table_maintenance_configuration, params) req.send_request() end |
#put_table_policy(params = {}) ⇒ Struct
Creates a new table policy or replaces an existing table policy for a table. For more information, see Adding a table policy in the Amazon Simple Storage Service User Guide.
- Permissions
You must have the
s3tables:PutTablePolicypermission to use this operation.
3065 3066 3067 3068 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 3065 def put_table_policy(params = {}, = {}) req = build_request(:put_table_policy, params) req.send_request() end |
#put_table_record_expiration_configuration(params = {}) ⇒ Struct
Creates or updates the expiration configuration settings for records in a table, including the status of the configuration. If you enable record expiration for a table, records expire and are automatically removed from the table after the number of days that you specify.
- Permissions
You must have the
s3tables:PutTableRecordExpirationConfigurationpermission to use this operation.
3105 3106 3107 3108 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 3105 def put_table_record_expiration_configuration(params = {}, = {}) req = build_request(:put_table_record_expiration_configuration, params) req.send_request() end |
#put_table_replication(params = {}) ⇒ Types::PutTableReplicationResponse
Creates or updates the replication configuration for a specific table. This operation allows you to define table-level replication independently of bucket-level replication, providing granular control over which tables are replicated and where.
- Permissions
You must have the
s3tables:PutTableReplicationpermission 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:GetTablepermission on the source table being replicated.s3tables:CreateTablepermission for the destination.s3tables:CreateNamespacepermission for the destination.s3tables:GetTableMaintenanceConfigpermission for the source table.s3tables:PutTableMaintenanceConfigpermission for the destination table.
- You must have
iam:PassRolepermission with condition allowing roles to be passed toreplication.s3tables.amazonaws.com.
3183 3184 3185 3186 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 3183 def put_table_replication(params = {}, = {}) req = build_request(:put_table_replication, params) req.send_request() end |
#rename_table(params = {}) ⇒ Struct
Renames a table or a namespace. For more information, see S3 Tables in the Amazon Simple Storage Service User Guide.
- Permissions
You must have the
s3tables:RenameTablepermission to use this operation.
3235 3236 3237 3238 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 3235 def rename_table(params = {}, = {}) req = build_request(:rename_table, params) req.send_request() end |
#start_table_migration(params = {}) ⇒ Types::StartTableMigrationResponse
Starts migrating an Amazon Web Services Glue Data Catalog table into a
new table in a table bucket. The migration runs asynchronously: this
operation returns the migration ID and its initial state, and you
track progress with GetTableMigration.
The namespace must already exist, and a table with the specified name
must not. The migration creates the table during planning and commits
data to it as it runs. Until you call CompleteTableMigration, you
can read the table but you can't write to it. If the migration fails
or is cancelled, the table and the data already committed to it
remain.
The migration first checks the source and the destination, and writes
the table compatibility and object compatibility reports to the bucket
that you specify in migrationOutput. If you set
reviewMigrationPlan to true, the migration waits in the
pendingReview state so that you can review the reports, and
continues only when you call UpdateTableMigration with
requestedState set to queued. If you don't continue or cancel the
migration within 30 days, the migration fails. Otherwise it continues
to migrate the data, and writes the object migration report when the
migration ends. If planning fails, the migration writes no object
migration report.
- Permissions
You must have the
s3tables:StartTableMigrationpermission to use this operation.You must have the
iam:PassRolepermission on the role that you specify inroleARN, with a condition that allows passing it tomigration.s3tables.amazonaws.com. The associated resource is the table bucket.If
destinationTablespecifies SSE-KMS encryption, you must have thekms:DescribeKeyandkms:GenerateDataKeypermissions 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.
3420 3421 3422 3423 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 3420 def start_table_migration(params = {}, = {}) req = build_request(:start_table_migration, params) req.send_request() end |
#sync_table_migration(params = {}) ⇒ Types::SyncTableMigrationResponse
Migrates the changes in the source table since the previous start or
sync, such as added and deleted source objects, into the destination
table. The sync runs asynchronously: this operation returns the
migration ID of the sync and its initial state, and you track progress
with GetTableMigration.
A sync uses the source, destination and data migration settings of the
table's migration, and plans the work and writes its reports in the
same way as StartTableMigration. You can sync after a start or sync
that succeeded, failed or was cancelled, if an earlier start or sync
of the table has a valid plan (hasValidPlan). You can't sync a
table while a start or sync is in progress for it, and you can sync a
table until you call CompleteTableMigration for it. If a source
object that an earlier migration migrated has since been overwritten,
the sync fails.
- Permissions
You must have the
s3tables:SyncTableMigrationpermission to use this operation.You must have the
iam:PassRolepermission on the role that you specify inroleARN, with a condition that allows passing it tomigration.s3tables.amazonaws.com. The associated resource is the table.
3508 3509 3510 3511 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 3508 def sync_table_migration(params = {}, = {}) req = build_request(:sync_table_migration, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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.
- Permissions
For tables and table buckets, you must have the
s3tables:TagResourcepermission to use this operation.
3567 3568 3569 3570 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 3567 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the specified user-defined tags from an Amazon S3 Tables resource. You can pass one or more tag keys.
- Permissions
For tables and table buckets, you must have the
s3tables:UntagResourcepermission to use this operation.
3621 3622 3623 3624 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 3621 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_table_metadata_location(params = {}) ⇒ Types::UpdateTableMetadataLocationResponse
Updates the metadata location for a table. The metadata location of a
table must be an S3 URI that begins with the table's warehouse
location. The metadata location for an Apache Iceberg table must end
with .metadata.json, or if the metadata file is Gzip-compressed,
.metadata.json.gz.
- Permissions
You must have the
s3tables:UpdateTableMetadataLocationpermission to use this operation.
3683 3684 3685 3686 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 3683 def (params = {}, = {}) req = build_request(:update_table_metadata_location, params) req.send_request() end |
#update_table_migration(params = {}) ⇒ Types::UpdateTableMigrationResponse
Requests a state change for a migration. Identify the migration by its
migrationId or by the tableARN of its destination table.
Set requestedState to queued to continue a migration in the
pendingReview state; the migration moves to queued or migrating.
Set it to cancelled to cancel a migration in the new, planning,
pendingReview, queued or migrating state; the migration moves to
cancelling, finishes the work in progress, and then ends in the
cancelled state, or in the failed state if any objects failed to
migrate. Data that the migration already committed stays in the
destination table.
- Permissions
- You must have the
s3tables:UpdateTableMigrationpermission to use this operation.
^
- You must have the
3750 3751 3752 3753 |
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/client.rb', line 3750 def update_table_migration(params = {}, = {}) req = build_request(:update_table_migration, params) req.send_request() end |