DeregisterJobDefinition
Deregisters an Amazon Batch job definition. Job definitions are permanently deleted after 180 days.
Request Syntax
POST /v1/deregisterjobdefinition HTTP/1.1
Content-type: application/json
{
"jobDefinition": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- jobDefinition
-
The name and revision (
name:revision
) or full Amazon Resource Name (ARN) of the job definition to deregister.Type: String
Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
- ClientException
-
These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.
HTTP Status Code: 400
- ServerException
-
These errors are usually caused by a server issue.
HTTP Status Code: 500
Examples
In the following example or examples, the Authorization header contents
(
[authorization-params]
) must be replaced with an Amazon Signature Version 4
signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the
Amazon
General Reference.
You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the Amazon Command Line Interface (Amazon CLI)
Example
This example deregisters a job definition called sleep10
.
Sample Request
POST /v1/deregisterjobdefinition HTTP/1.1
Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: [content-length]
Authorization: [authorization-params]
X-Amz-Date: 20161128T215745Z
User-Agent: aws-cli/1.11.21 Python/2.7.12 Darwin/16.1.0 botocore/1.4.78
{
"jobDefinition": "sleep10:1"
}
Sample Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2
Connection: keep-alive
Date: Mon, 28 Nov 2016 21:57:45 GMT
x-amzn-RequestId: [request-id]
X-Amzn-Trace-Id: [trace-id]
X-Cache: Miss from cloudfront
Via: 1.1 e892630891779ff1ccadccf205a776f3.cloudfront.net (CloudFront)
X-Amz-Cf-Id: wKAY_NOTbvY8PFcmo1aGja0xqGLxsTJgEtuc1KosPYAPYL8icYwvKw==
{}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: