UpdateProtectedJob
Updates the processing of a currently running job.
Request Syntax
PATCH /memberships/membershipIdentifier/protectedJobs/protectedJobIdentifier HTTP/1.1
Content-type: application/json
{
"targetStatus": "string"
}URI Request Parameters
The request uses the following URI parameters.
- membershipIdentifier
-
The identifier for a member of a protected job instance.
Length Constraints: Fixed length of 36.
Pattern:
[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}Required: Yes
- protectedJobIdentifier
-
The identifier of the protected job to update.
Length Constraints: Fixed length of 36.
Pattern:
[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}Required: Yes
Request Body
The request accepts the following data in JSON format.
- targetStatus
-
The target status of a protected job. Used to update the execution status of a currently running job.
Type: String
Valid Values:
CANCELLEDRequired: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"protectedJob": {
"createTime": number,
"error": {
"code": "string",
"message": "string"
},
"id": "string",
"jobParameters": {
"analysisTemplateArn": "string"
},
"membershipArn": "string",
"membershipId": "string",
"result": {
"output": { ... }
},
"resultConfiguration": {
"outputConfiguration": { ... }
},
"statistics": {
"billedResourceUtilization": {
"units": number
},
"totalDurationInMillis": number
},
"status": "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.
- protectedJob
-
The protected job output.
Type: ProtectedJob object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Caller does not have sufficient access to perform this action.
HTTP Status Code: 403
- ConflictException
-
Updating or deleting a resource can cause an inconsistent state.
HTTP Status Code: 409
- InternalServerException
-
Unexpected error during processing of request.
HTTP Status Code: 500
- ResourceNotFoundException
-
Request references a resource which does not exist.
HTTP Status Code: 404
- ThrottlingException
-
Request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the specified constraints.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
