GetTableMaintenanceJobStatusCommand

Suggest an Edit

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

Example Syntax

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

import { S3TablesClient, GetTableMaintenanceJobStatusCommand } from "@aws-sdk/client-s3tables"; // ES Modules import
// const { S3TablesClient, GetTableMaintenanceJobStatusCommand } = require("@aws-sdk/client-s3tables"); // CommonJS import
const client = new S3TablesClient(config);
const input = { // GetTableMaintenanceJobStatusRequest
  tableBucketARN: "STRING_VALUE", // required
  namespace: "STRING_VALUE", // required
  name: "STRING_VALUE", // required
};
const command = new GetTableMaintenanceJobStatusCommand(input);
const response = await client.send(command);
// { // GetTableMaintenanceJobStatusResponse
//   tableARN: "STRING_VALUE", // required
//   status: { // TableMaintenanceJobStatus // required
//     "<keys>": { // TableMaintenanceJobStatusValue
//       status: "Not_Yet_Run" || "Successful" || "Failed" || "Disabled", // required
//       lastRunTimestamp: new Date("TIMESTAMP"),
//       failureMessage: "STRING_VALUE",
//     },
//   },
// };

GetTableMaintenanceJobStatusCommand Input

See GetTableMaintenanceJobStatusCommandInput for more details

Parameter
Type
Description
name
Required
string | undefined

The name of the maintenance job.

namespace
Required
string | undefined

The name of the namespace the table is associated with.

tableBucketARN
Required
string | undefined

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

GetTableMaintenanceJobStatusCommand Output

See GetTableMaintenanceJobStatusCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
status
Required
Partial<Record<TableMaintenanceJobType, TableMaintenanceJobStatusValue> | undefined

The status of the maintenance job.

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.