- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
PutTableBucketMaintenanceConfigurationCommand
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:PutTableBucketMaintenanceConfiguration
permission to use this operation.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { S3TablesClient, PutTableBucketMaintenanceConfigurationCommand } from "@aws-sdk/client-s3tables"; // ES Modules import
// const { S3TablesClient, PutTableBucketMaintenanceConfigurationCommand } = require("@aws-sdk/client-s3tables"); // CommonJS import
const client = new S3TablesClient(config);
const input = { // PutTableBucketMaintenanceConfigurationRequest
tableBucketARN: "STRING_VALUE", // required
type: "icebergUnreferencedFileRemoval", // required
value: { // TableBucketMaintenanceConfigurationValue
status: "enabled" || "disabled",
settings: { // TableBucketMaintenanceSettings Union: only one key present
icebergUnreferencedFileRemoval: { // IcebergUnreferencedFileRemovalSettings
unreferencedDays: Number("int"),
nonCurrentDays: Number("int"),
},
},
},
};
const command = new PutTableBucketMaintenanceConfigurationCommand(input);
const response = await client.send(command);
// {};
PutTableBucketMaintenanceConfigurationCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
tableBucketARN Required | string | undefined | The Amazon Resource Name (ARN) of the table bucket associated with the maintenance configuration. |
type Required | TableBucketMaintenanceType | undefined | The type of the maintenance configuration. |
value Required | TableBucketMaintenanceConfigurationValue | undefined | Defines the values of the maintenance configuration for the table bucket. |
PutTableBucketMaintenanceConfigurationCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
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. |