PutTableMaintenanceConfigurationCommand

Suggest an Edit

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:PutTableMaintenanceConfiguration permission to use this operation.

Example Syntax

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

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

PutTableMaintenanceConfigurationCommand Input

See PutTableMaintenanceConfigurationCommandInput for more details

Parameter
Type
Description
name
Required
string | undefined

The name of the maintenance configuration.

namespace
Required
string | undefined

The namespace of the table.

tableBucketARN
Required
string | undefined

The Amazon Resource Name (ARN) of the table associated with the maintenance configuration.

type
Required
TableMaintenanceType | undefined

The type of the maintenance configuration.

value
Required
TableMaintenanceConfigurationValue | undefined

Defines the values of the maintenance configuration for the table.

PutTableMaintenanceConfigurationCommand Output

See PutTableMaintenanceConfigurationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

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.