GetTableMaintenanceConfigurationCommand

Suggest an Edit

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

Permissions

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { S3TablesClient, GetTableMaintenanceConfigurationCommand } from "@aws-sdk/client-s3tables"; // ES Modules import
// const { S3TablesClient, GetTableMaintenanceConfigurationCommand } = require("@aws-sdk/client-s3tables"); // CommonJS import
const client = new S3TablesClient(config);
const input = { // GetTableMaintenanceConfigurationRequest
  tableBucketARN: "STRING_VALUE", // required
  namespace: "STRING_VALUE", // required
  name: "STRING_VALUE", // required
};
const command = new GetTableMaintenanceConfigurationCommand(input);
const response = await client.send(command);
// { // GetTableMaintenanceConfigurationResponse
//   tableARN: "STRING_VALUE", // required
//   configuration: { // TableMaintenanceConfiguration // required
//     "<keys>": { // TableMaintenanceConfigurationValue
//       status: "enabled" || "disabled",
//       settings: { // TableMaintenanceSettings Union: only one key present
//         icebergCompaction: { // IcebergCompactionSettings
//           targetFileSizeMB: Number("int"),
//         },
//         icebergSnapshotManagement: { // IcebergSnapshotManagementSettings
//           minSnapshotsToKeep: Number("int"),
//           maxSnapshotAgeHours: Number("int"),
//         },
//       },
//     },
//   },
// };

GetTableMaintenanceConfigurationCommand Input

See GetTableMaintenanceConfigurationCommandInput for more details

Parameter
Type
Description
name
Required
string | undefined

The name of the table.

namespace
Required
string | undefined

The namespace associated with the table.

tableBucketARN
Required
string | undefined

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

GetTableMaintenanceConfigurationCommand Output

See GetTableMaintenanceConfigurationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
configuration
Required
Partial<Record<TableMaintenanceType, TableMaintenanceConfigurationValue> | undefined

Details about the maintenance configuration for the table bucket.

tableARN
Required
string | undefined

The Amazon Resource Name (ARN) of the table.

Throws

Name
Fault
Details
BadRequestException
client

The request is invalid or malformed.

ConflictException
client

The request failed because there is a conflict with a previous write. You can retry the request.

ForbiddenException
client

The caller isn't authorized to make the request.

InternalServerErrorException
server

The request failed due to an internal server error.

NotFoundException
client

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

TooManyRequestsException
client

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

S3TablesServiceException
Base exception class for all service exceptions from S3Tables service.