CreateSchedulingPolicy - Amazon Batch
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

CreateSchedulingPolicy

Creates an Amazon Batch scheduling policy.

Request Syntax

POST /v1/createschedulingpolicy HTTP/1.1 Content-type: application/json { "fairsharePolicy": { "computeReservation": number, "shareDecaySeconds": number, "shareDistribution": [ { "shareIdentifier": "string", "weightFactor": number } ] }, "name": "string", "tags": { "string" : "string" } }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

fairsharePolicy

The fair share policy of the scheduling policy.

Type: FairsharePolicy object

Required: No

name

The name of the scheduling policy. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

Type: String

Required: Yes

tags

The tags that you apply to the scheduling policy to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Resources in Amazon General Reference.

These tags can be updated or removed using the TagResource and UntagResource API operations.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "arn": "string", "name": "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.

arn

The Amazon Resource Name (ARN) of the scheduling policy. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy.

Type: String

name

The name of the scheduling policy.

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 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) or one of the Amazon SDKs to make requests to Amazon, 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 creates a scheduling policy with the specified fair share identifiers and fair share identifier prefixes.

Sample Request

POST /v1/createschedulingpolicy HTTP/1.1 Host: batch.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.20.21 Python/3.6.9 Linux/4.4.0-19041-Microsoft botocore/1.21.21 X-Amz-Date: 20210928T231724Z X-Amz-Security-Token: [security-token] Authorization: [authorization-params] Content-Length: [content-length] { "name": "ExampleFairSharePolicy", "fairsharePolicy": { "shareDecaySeconds": 3600, "computeReservation": 1, "shareDistribution": [ { "shareIdentifier": "A1*", "weightFactor": 0.1 }, { "shareIdentifier": "A2", "weightFactor": 0.2 }, { "shareIdentifier": "B*", "weightFactor": 0.8 }, { "shareIdentifier": "C", "weightFactor": 1.2 }, { "shareIdentifier": "D*", "weightFactor": 1.5 }, { "shareIdentifier": "E", "weightFactor": 1.8 } ] }, "tags": { "Hot": "Dog", "Beef": "Brisket", "Pork": "Ribs", "Department": "Engineering" } }

Sample Response

HTTP/1.1 200 OK Date: Tue, 28 Sep 2021 23:17:50 GMT Content-Type: application/json Content-Length: [content-length] x-amzn-RequestId: [request-id] Access-Control-Allow-Origin: * x-amz-apigw-id: [apigw-id] Access-Control-Expose-Headers: X-amzn-errortype,X-amzn-requestid,X-amzn-errormessage,X-amzn-trace-id,X-amz-apigw-id,date X-Amzn-Trace-Id: [trace-id] Connection: keep-alive { "schedulingPolicies": [{ "arn": "arn:aws:batch:us-east-1:012345678910:scheduling-policy/ExampleFairSharePolicy" }] }

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: