GetTableMaintenanceJobStatus
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.
Request Syntax
GET /tables/tableBucketARN/namespace/name/maintenance-job-status HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- name
-
The name of the maintenance job.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[0-9a-z_]*Required: Yes
- namespace
-
The name of the namespace the table is associated with.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[0-9a-z_]*Required: Yes
- tableBucketARN
-
The Amazon Resource Name (ARN) of the table bucket.
Pattern:
(arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:bucket/[a-z0-9_-]{3,63})Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"status": {
"string" : {
"failureMessage": "string",
"lastRunTimestamp": "string",
"status": "string"
}
},
"tableARN": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- status
-
The status of the maintenance job.
Type: String to TableMaintenanceJobStatusValue object map
Valid Keys:
icebergCompaction | icebergSnapshotManagement | icebergUnreferencedFileRemoval - tableARN
-
The Amazon Resource Name (ARN) of the table.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
(arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:bucket/[a-z0-9_-]{3,63}/table/[a-zA-Z0-9-_]{1,255})
Errors
- BadRequestException
-
The request is invalid or malformed.
HTTP Status Code: 400
- ConflictException
-
The request failed because there is a conflict with a previous write. You can retry the request.
HTTP Status Code: 409
- ForbiddenException
-
The caller isn't authorized to make the request.
HTTP Status Code: 403
- InternalServerErrorException
-
The request failed due to an internal server error.
HTTP Status Code: 500
- NotFoundException
-
The request was rejected because the specified resource could not be found.
HTTP Status Code: 404
- TooManyRequestsException
-
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
