DeregisterJobDefinition
Deregisters an AWS 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 (p. 31)
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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or 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
Examples
In the following example or examples, the Authorization header contents ( [authorization-params]
) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference.
You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.
Example
This example deregisters a job definition called sleep10.
Sample Request
User-Agent: aws-cli/1.11.21 Python/2.7.12 Darwin/16.1.0 botocore/1.4.78 {
"jobDefinition": "sleep10"
}
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 AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
See Also
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeComputeEnvironments
DescribeComputeEnvironments
Describes one or more of your compute environments.
If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances into.
Request Syntax
POST /v1/describecomputeenvironments HTTP/1.1 Content-type: application/json
{ "computeEnvironments": [ "string" ], "maxResults": number,
"nextToken": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
computeEnvironments (p. 34)
A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.
Type: Array of strings Required: No
maxResults (p. 34)
The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output. When this parameter is used, DescribeComputeEnvironments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeComputeEnvironments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeComputeEnvironments returns up to 100 results and a nextToken value if applicable.
Type: Integer Required: No nextToken (p. 34)
The nextToken value returned from a previous paginated DescribeComputeEnvironments request where maxResults was used and the results exceeded the value of that parameter.
Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
Response Syntax
NoteThis token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.
Type: String
"computeEnvironments": [ {
"computeEnvironmentArn": "string", "computeEnvironmentName": "string", "computeResources": {
"nextToken": "string"
}
Response Elements
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.
computeEnvironments (p. 35) The list of compute environments.
Type: Array of ComputeEnvironmentDetail (p. 120) objects nextToken (p. 35)
The nextToken value to include in a future DescribeComputeEnvironments request. When the results of a DescribeComputeEnvironments request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
Type: String
Errors
ClientException
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or 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 AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference.
You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.
Example
This example describes the P3OnDemand compute environment.
Sample Request
POST /v1/describecomputeenvironments HTTP/1.1 Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity Content-Length: [content-length]
See Also
Authorization: AUTHPARAMS X-Amz-Date: 20161128T193355Z
User-Agent: aws-cli/1.11.21 Python/2.7.12 Darwin/16.1.0 botocore/1.4.78 { "computeEnvironments": [
"P3OnDemand"
Date: Mon, 28 Nov 2016 19:33:56 GMT x-amzn-RequestId: [request-id]
X-Amzn-Trace-Id: [trace-id]
X-Cache: Miss from cloudfront
Via: 1.1 56908f89e8d17ba579c0607313114955.cloudfront.net (CloudFront) X-Amz-Cf-Id: FbgslaatWhj_yGhfkSCTPpPtjiuVuFOBns-kK5EsaasYQC5p2FnpiQ==
{ "computeEnvironments": [{
"computeEnvironmentName": "P3OnDemand",
"computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/
P3OnDemand",
"ecsClusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/P3OnDemand_Batch_2c06f29d-d1fe-3a49-879d-42394c86effc",
"type": "MANAGED", "state": "ENABLED", "status": "VALID",
"statusReason": "ComputeEnvironment Healthy", "computeResources": {
"type": "EC2", "minvCpus": 0, "maxvCpus": 128, "desiredvCpus": 48, "instanceTypes": ["p3"],
"subnets": ["subnet-220c0e0a", "subnet-1a95556d", "subnet-978f6dce"], "securityGroupIds": ["sg-cf5093b2"],
"ec2KeyPair": "id_rsa",
"instanceRole": "ecsInstanceRole", "tags": {
"Name": "Batch Instance - P3OnDemand", "Department": "Management"
} },
"serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole"
}]
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
See Also
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3