Icon

AWS Batch (version v1.*.*)

cancel_job

Cancels a job in an AWS Batch job queue. Jobs that are in the SUBMITTED, PENDING, or RUNNABLE state are cancelled. Jobs that have progressed to STARTING or RUNNING are not cancelled (but the API operation still succeeds, even if no job is cancelled); these jobs must be terminated with the TerminateJob operation.

Parameters

$body

Type: object

{
"jobId" : "The AWS Batch job ID of the job to cancel.",
"reason" : "A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs."
}

create_compute_environment

Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute environments.
In a managed compute environment, AWS Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the launch template that you specify when you create the compute environment. You can choose to use Amazon EC2 On-Demand Instances or Spot Instances in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is below a specified percentage of the On-Demand price.
Multi-node parallel jobs are not supported on Spot Instances.
In an unmanaged compute environment, you can manage your own compute resources. This provides more compute resource configuration options, such as using a custom AMI, but you must ensure that your AMI meets the Amazon ECS container instance AMI specification. For more information, see Container Instance AMIs in the Amazon Elastic Container Service Developer Guide. After you have created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that is associated with it. Then, manually launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS Container Instance in the Amazon Elastic Container Service Developer Guide.
AWS Batch does not upgrade the AMIs in a compute environment after it is created (for example, when a newer version of the Amazon ECS-optimized AMI is available). You are responsible for the management of the guest operating system (including updates and security patches) and any additional application software or utilities that you install on the compute resources. To use a new AMI for your AWS Batch jobs:
Create a new compute environment with the new AMI.
Add the compute environment to an existing job queue.
Remove the old compute environment from your job queue.
Delete the old compute environment.

Parameters

$body

Type: object

{
"serviceRole" : "The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. \nIf your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. \nDepending on how you created your AWS Batch service role, its ARN may contain the service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.",
"computeResources" : {
"spotIamFleetRole" : "The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. For more information, see Amazon EC2 Spot Fleet Role in the AWS Batch User Guide.",
"ec2KeyPair" : "The Amazon EC2 key pair that is used for instances launched in the compute environment.",
"imageId" : "The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.",
"instanceTypes" : [ "string" ],
"desiredvCpus" : "The desired number of Amazon EC2 vCPUS in the compute environment.",
"type" : "The type of compute environment: EC2 or SPOT.",
"instanceRole" : "The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole . For more information, see Amazon ECS Instance Role in the AWS Batch User Guide.",
"minvCpus" : "The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).",
"bidPercentage" : "The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price.",
"allocationStrategy" : "The allocation strategy to use for the compute resource in case not enough instances of the best fitting instance type can be allocated. This could be due to availability of the instance type in the region or Amazon EC2 service limits. If this is not specified, the default is BEST_FIT, which will use only the best fitting instance type, waiting for additional capacity if it's not available. This allocation strategy keeps costs lower but can limit scaling. BEST_FIT_PROGRESSIVE will select an additional instance type that is large enough to meet the requirements of the jobs in the queue, with a preference for an instance type with a lower cost. SPOT_CAPACITY_OPTIMIZED is only available for Spot Instance compute resources and will select an additional instance type that is large enough to meet the requirements of the jobs in the queue, with a preference for an instance type that is less likely to be interrupted.",
"tags" : "Key-value pair tags to be applied to resources that are launched in the compute environment. For AWS Batch, these take the form of \"String1\": \"String2\", where String1 is the tag key and String2 is the tag value—for example, { \"Name\": \"AWS Batch Instance - C4OnDemand\" }.",
"securityGroupIds" : [ "string" ],
"launchTemplate" : {
"launchTemplateId" : "The ID of the launch template.",
"version" : "The version number of the launch template. \nDefault: The default version of the launch template.",
"launchTemplateName" : "The name of the launch template."
},
"subnets" : [ "string" ],
"placementGroup" : "The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.",
"maxvCpus" : "The maximum number of Amazon EC2 vCPUs that an environment can reach."
},
"state" : "The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.",
"type" : "The type of the compute environment. For more information, see Compute Environments in the AWS Batch User Guide.",
"computeEnvironmentName" : "The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed."
}

create_job_queue

Creates an AWS Batch job queue. When you create a job queue, you associate one or more compute environments to the queue and assign an order of preference for the compute environments.
You also set a priority to the job queue that determines the order in which the AWS Batch scheduler places jobs onto its associated compute environments. For example, if a compute environment is associated with more than one job queue, the job queue with a higher priority is given preference for scheduling jobs to that compute environment.

Parameters

$body

Type: object

{
"computeEnvironmentOrder" : [ {
"computeEnvironment" : "The Amazon Resource Name (ARN) of the compute environment.",
"order" : "The order of the compute environment."
} ],
"jobQueueName" : "The name of the job queue.",
"state" : "The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs.",
"priority" : "The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1."
}

delete_compute_environment

Deletes an AWS Batch compute environment.
Before you can delete a compute environment, you must set its state to DISABLED with the UpdateComputeEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation.

Parameters

$body

Type: object

{
"computeEnvironment" : "The name or Amazon Resource Name (ARN) of the compute environment to delete."
}

delete_job_queue

Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are terminated when you delete a job queue.
It is not necessary to disassociate compute environments from a queue before submitting a DeleteJobQueue request.

Parameters

$body

Type: object

{
"jobQueue" : "The short name or full Amazon Resource Name (ARN) of the queue to delete."
}

deregister_job_definition

Deregisters an AWS Batch job definition.

Parameters

$body

Type: object

{
"jobDefinition" : "The name and revision (name:revision) or full Amazon Resource Name (ARN) of the job definition to deregister."
}

describe_compute_environments

Describes one or more of your compute environments.
If you are 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.

Parameters

$body

Type: object

{
"computeEnvironments" : [ "string" ]
}

describe_job_definitions

Describes a list of job definitions. You can specify a status (such as ACTIVE) to only return job definitions that match that status.

Parameters

$body

Type: object

{
"jobDefinitionName" : "The name of the job definition to describe.",
"jobDefinitions" : [ "string" ],
"status" : "The status with which to filter job definitions."
}

describe_job_queues

Describes one or more of your job queues.

Parameters

$body

Type: object

{
"jobQueues" : [ "string" ]
}

describe_jobs

Describes a list of AWS Batch jobs.

Parameters

$body

Type: object

{
"jobs" : [ "string" ]
}

list_jobs

Returns a list of AWS Batch jobs.
You must specify only one of the following:
a job queue ID to return a list of jobs in that job queue
a multi-node parallel job ID to return a list of that job's nodes
an array job ID to return a list of that job's children
You can filter the results by job status with the jobStatus parameter. If you do not specify a status, only RUNNING jobs are returned.

Parameters

$body

Type: object

{
"jobStatus" : "The job status with which to filter jobs in the specified queue. If you do not specify a status, only RUNNING jobs are returned.",
"jobQueue" : "The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.",
"multiNodeJobId" : "The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.",
"arrayJobId" : "The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array."
}

register_job_definition

Registers an AWS Batch job definition.

Parameters

$body

Type: object

{
"containerProperties" : {
"image" : "The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run. \n Images in Amazon ECR repositories use the full registry and repository URI (for example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>). \n Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo). \n Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent). \n Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu). ",
"memory" : "The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. \nIf you are trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide.",
"instanceType" : "The instance type to use for a multi-node parallel job. Currently all node groups in a multi-node parallel job must use the same instance type. This parameter is not valid for single-node container jobs.",
"volumes" : [ {
"host" : {
"sourcePath" : "The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported."
},
"name" : "The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints."
} ],
"vcpus" : "The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.",
"command" : [ "string" ],
"privileged" : "When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.",
"resourceRequirements" : [ {
"type" : "The type of resource to assign to a container. Currently, the only supported resource type is GPU.",
"value" : "The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job should not exceed the number of available GPUs on the compute resource that the job is launched on."
} ],
"environment" : [ {
"name" : "The name of the key-value pair. For environment variables, this is the name of the environment variable.",
"value" : "The value of the key-value pair. For environment variables, this is the value of the environment variable."
} ],
"ulimits" : [ {
"name" : "The type of the ulimit.",
"hardLimit" : "The hard limit for the ulimit type.",
"softLimit" : "The soft limit for the ulimit type."
} ],
"readonlyRootFilesystem" : "When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.",
"mountPoints" : [ {
"readOnly" : "If this value is true, the container has read-only access to the volume; otherwise, the container can write to the volume. The default value is false.",
"containerPath" : "The path on the container at which to mount the host volume.",
"sourceVolume" : "The name of the volume to mount."
} ],
"jobRoleArn" : "The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.",
"user" : "The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.",
"linuxParameters" : {
"devices" : [ {
"permissions" : [ "string. Possible values: READ | WRITE | MKNOD" ],
"containerPath" : "The path inside the container at which to expose the host device. By default the hostPath value is used.",
"hostPath" : "The path for the device on the host container instance."
} ]
}
},
"jobDefinitionName" : "The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.",
"type" : "The type of job definition.",
"retryStrategy" : {
"attempts" : "The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value."
},
"parameters" : "Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.",
"timeout" : {
"attemptDurationSeconds" : "The time duration in seconds (measured from the job attempt's startedAt timestamp) after which AWS Batch terminates your jobs if they have not finished."
},
"nodeProperties" : {
"nodeRangeProperties" : [ {
"container" : {
"image" : "The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run. \n Images in Amazon ECR repositories use the full registry and repository URI (for example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>). \n Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo). \n Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent). \n Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu). ",
"memory" : "The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. \nIf you are trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide.",
"instanceType" : "The instance type to use for a multi-node parallel job. Currently all node groups in a multi-node parallel job must use the same instance type. This parameter is not valid for single-node container jobs.",
"volumes" : [ {
"host" : {
"sourcePath" : "The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported."
},
"name" : "The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints."
} ],
"vcpus" : "The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.",
"command" : [ "string" ],
"privileged" : "When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.",
"resourceRequirements" : [ {
"type" : "The type of resource to assign to a container. Currently, the only supported resource type is GPU.",
"value" : "The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job should not exceed the number of available GPUs on the compute resource that the job is launched on."
} ],
"environment" : [ {
"name" : "The name of the key-value pair. For environment variables, this is the name of the environment variable.",
"value" : "The value of the key-value pair. For environment variables, this is the value of the environment variable."
} ],
"ulimits" : [ {
"name" : "The type of the ulimit.",
"hardLimit" : "The hard limit for the ulimit type.",
"softLimit" : "The soft limit for the ulimit type."
} ],
"readonlyRootFilesystem" : "When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.",
"mountPoints" : [ {
"readOnly" : "If this value is true, the container has read-only access to the volume; otherwise, the container can write to the volume. The default value is false.",
"containerPath" : "The path on the container at which to mount the host volume.",
"sourceVolume" : "The name of the volume to mount."
} ],
"jobRoleArn" : "The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.",
"user" : "The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.",
"linuxParameters" : {
"devices" : [ {
"permissions" : [ "string. Possible values: READ | WRITE | MKNOD" ],
"containerPath" : "The path inside the container at which to expose the host device. By default the hostPath value is used.",
"hostPath" : "The path for the device on the host container instance."
} ]
}
},
"targetNodes" : "The range of nodes, using node index values. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted (:n), then 0 is used to start the range. If the ending range value is omitted (n:), then the highest possible node index is used to end the range. Your accumulative node ranges must account for all nodes (0:n). You may nest node ranges, for example 0:10 and 4:5, in which case the 4:5 range properties override the 0:10 properties."
} ],
"numNodes" : "The number of nodes associated with a multi-node parallel job.",
"mainNode" : "Specifies the node index for the main node of a multi-node parallel job. This node index value must be fewer than the number of nodes."
}
}

submit_job

Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition.

Parameters

$body

Type: object

{
"jobName" : "The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.",
"containerOverrides" : {
"resourceRequirements" : [ {
"type" : "The type of resource to assign to a container. Currently, the only supported resource type is GPU.",
"value" : "The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job should not exceed the number of available GPUs on the compute resource that the job is launched on."
} ],
"environment" : [ {
"name" : "The name of the key-value pair. For environment variables, this is the name of the environment variable.",
"value" : "The value of the key-value pair. For environment variables, this is the value of the environment variable."
} ],
"memory" : "The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.",
"instanceType" : "The instance type to use for a multi-node parallel job. This parameter is not valid for single-node container jobs.",
"vcpus" : "The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.",
"command" : [ "string" ]
},
"jobQueue" : "The job queue into which the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.",
"dependsOn" : [ {
"jobId" : "The job ID of the AWS Batch job associated with this dependency.",
"type" : "The type of the job dependency."
} ],
"nodeOverrides" : {
"numNodes" : "The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are specified in the job definition. To use this override: \n There must be at least one node range in your job definition that has an open upper boundary (such as : or n:). \n The lower boundary of the node range specified in the job definition must be fewer than the number of nodes specified in the override. \n The main node index specified in the job definition must be fewer than the number of nodes specified in the override. ",
"nodePropertyOverrides" : [ {
"containerOverrides" : {
"resourceRequirements" : [ {
"type" : "The type of resource to assign to a container. Currently, the only supported resource type is GPU.",
"value" : "The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job should not exceed the number of available GPUs on the compute resource that the job is launched on."
} ],
"environment" : [ {
"name" : "The name of the key-value pair. For environment variables, this is the name of the environment variable.",
"value" : "The value of the key-value pair. For environment variables, this is the value of the environment variable."
} ],
"memory" : "The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.",
"instanceType" : "The instance type to use for a multi-node parallel job. This parameter is not valid for single-node container jobs.",
"vcpus" : "The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.",
"command" : [ "string" ]
},
"targetNodes" : "The range of nodes, using node index values, with which to override. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted (:n), then 0 is used to start the range. If the ending range value is omitted (n:), then the highest possible node index is used to end the range."
} ]
},
"arrayProperties" : {
"size" : "The size of the array job."
},
"retryStrategy" : {
"attempts" : "The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value."
},
"parameters" : "Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.",
"jobDefinition" : "The job definition used by this job. This value can be either a name:revision or the Amazon Resource Name (ARN) for the job definition.",
"timeout" : {
"attemptDurationSeconds" : "The time duration in seconds (measured from the job attempt's startedAt timestamp) after which AWS Batch terminates your jobs if they have not finished."
}
}

terminate_job

Terminates a job in a job queue. Jobs that are in the STARTING or RUNNING state are terminated, which causes them to transition to FAILED. Jobs that have not progressed to the STARTING state are cancelled.

Parameters

$body

Type: object

{
"jobId" : "The AWS Batch job ID of the job to terminate.",
"reason" : "A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs."
}

update_compute_environment

Updates an AWS Batch compute environment.

Parameters

$body

Type: object

{
"computeEnvironment" : "The name or full Amazon Resource Name (ARN) of the compute environment to update.",
"serviceRole" : "The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. \nIf your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. \nDepending on how you created your AWS Batch service role, its ARN may contain the service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.",
"computeResources" : {
"desiredvCpus" : "The desired number of Amazon EC2 vCPUS in the compute environment.",
"maxvCpus" : "The maximum number of Amazon EC2 vCPUs that an environment can reach.",
"minvCpus" : "The minimum number of Amazon EC2 vCPUs that an environment should maintain."
},
"state" : "The state of the compute environment. Compute environments in the ENABLED state can accept jobs from a queue and scale in or out automatically based on the workload demand of its associated queues."
}

update_job_queue

Updates a job queue.

Parameters

$body

Type: object

{
"computeEnvironmentOrder" : [ {
"computeEnvironment" : "The Amazon Resource Name (ARN) of the compute environment.",
"order" : "The order of the compute environment."
} ],
"jobQueue" : "The name or the Amazon Resource Name (ARN) of the job queue.",
"state" : "Describes the queue's ability to accept new jobs.",
"priority" : "The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1."
}