Interface BatchClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Using Batch, you can run batch computing workloads on the Amazon Web Services Cloud. Batch computing is a common means for developers, scientists, and engineers to access large amounts of compute resources. Batch uses the advantages of the batch computing to remove the undifferentiated heavy lifting of configuring and managing required infrastructure. At the same time, it also adopts a familiar batch computing software approach. You can use Batch to efficiently provision resources, and work toward eliminating capacity constraints, reducing your overall compute costs, and delivering results more quickly.
As a fully managed service, Batch can run batch computing workloads of any scale. Batch automatically provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific workloads. With Batch, there's no need to install or manage batch computing software. This means that you can focus on analyzing results and solving your specific problems instead.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic BatchClientBuilder
builder()
Create a builder that can be used to configure and create aBatchClient
.default CancelJobResponse
cancelJob
(Consumer<CancelJobRequest.Builder> cancelJobRequest) Cancels a job in an Batch job queue.default CancelJobResponse
cancelJob
(CancelJobRequest cancelJobRequest) Cancels a job in an Batch job queue.static BatchClient
create()
Create aBatchClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateComputeEnvironmentResponse
createComputeEnvironment
(Consumer<CreateComputeEnvironmentRequest.Builder> createComputeEnvironmentRequest) Creates an Batch compute environment.default CreateComputeEnvironmentResponse
createComputeEnvironment
(CreateComputeEnvironmentRequest createComputeEnvironmentRequest) Creates an Batch compute environment.default CreateJobQueueResponse
createJobQueue
(Consumer<CreateJobQueueRequest.Builder> createJobQueueRequest) Creates an Batch job queue.default CreateJobQueueResponse
createJobQueue
(CreateJobQueueRequest createJobQueueRequest) Creates an Batch job queue.default CreateSchedulingPolicyResponse
createSchedulingPolicy
(Consumer<CreateSchedulingPolicyRequest.Builder> createSchedulingPolicyRequest) Creates an Batch scheduling policy.default CreateSchedulingPolicyResponse
createSchedulingPolicy
(CreateSchedulingPolicyRequest createSchedulingPolicyRequest) Creates an Batch scheduling policy.default DeleteComputeEnvironmentResponse
deleteComputeEnvironment
(Consumer<DeleteComputeEnvironmentRequest.Builder> deleteComputeEnvironmentRequest) Deletes an Batch compute environment.default DeleteComputeEnvironmentResponse
deleteComputeEnvironment
(DeleteComputeEnvironmentRequest deleteComputeEnvironmentRequest) Deletes an Batch compute environment.default DeleteJobQueueResponse
deleteJobQueue
(Consumer<DeleteJobQueueRequest.Builder> deleteJobQueueRequest) Deletes the specified job queue.default DeleteJobQueueResponse
deleteJobQueue
(DeleteJobQueueRequest deleteJobQueueRequest) Deletes the specified job queue.default DeleteSchedulingPolicyResponse
deleteSchedulingPolicy
(Consumer<DeleteSchedulingPolicyRequest.Builder> deleteSchedulingPolicyRequest) Deletes the specified scheduling policy.default DeleteSchedulingPolicyResponse
deleteSchedulingPolicy
(DeleteSchedulingPolicyRequest deleteSchedulingPolicyRequest) Deletes the specified scheduling policy.default DeregisterJobDefinitionResponse
deregisterJobDefinition
(Consumer<DeregisterJobDefinitionRequest.Builder> deregisterJobDefinitionRequest) Deregisters an Batch job definition.default DeregisterJobDefinitionResponse
deregisterJobDefinition
(DeregisterJobDefinitionRequest deregisterJobDefinitionRequest) Deregisters an Batch job definition.Describes one or more of your compute environments.describeComputeEnvironments
(Consumer<DescribeComputeEnvironmentsRequest.Builder> describeComputeEnvironmentsRequest) Describes one or more of your compute environments.describeComputeEnvironments
(DescribeComputeEnvironmentsRequest describeComputeEnvironmentsRequest) Describes one or more of your compute environments.This is a variant ofdescribeComputeEnvironments(software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsRequest)
operation.describeComputeEnvironmentsPaginator
(Consumer<DescribeComputeEnvironmentsRequest.Builder> describeComputeEnvironmentsRequest) This is a variant ofdescribeComputeEnvironments(software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsRequest)
operation.describeComputeEnvironmentsPaginator
(DescribeComputeEnvironmentsRequest describeComputeEnvironmentsRequest) This is a variant ofdescribeComputeEnvironments(software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsRequest)
operation.default DescribeJobDefinitionsResponse
Describes a list of job definitions.default DescribeJobDefinitionsResponse
describeJobDefinitions
(Consumer<DescribeJobDefinitionsRequest.Builder> describeJobDefinitionsRequest) Describes a list of job definitions.default DescribeJobDefinitionsResponse
describeJobDefinitions
(DescribeJobDefinitionsRequest describeJobDefinitionsRequest) Describes a list of job definitions.default DescribeJobDefinitionsIterable
This is a variant ofdescribeJobDefinitions(software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsRequest)
operation.default DescribeJobDefinitionsIterable
describeJobDefinitionsPaginator
(Consumer<DescribeJobDefinitionsRequest.Builder> describeJobDefinitionsRequest) This is a variant ofdescribeJobDefinitions(software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsRequest)
operation.default DescribeJobDefinitionsIterable
describeJobDefinitionsPaginator
(DescribeJobDefinitionsRequest describeJobDefinitionsRequest) This is a variant ofdescribeJobDefinitions(software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsRequest)
operation.default DescribeJobQueuesResponse
Describes one or more of your job queues.default DescribeJobQueuesResponse
describeJobQueues
(Consumer<DescribeJobQueuesRequest.Builder> describeJobQueuesRequest) Describes one or more of your job queues.default DescribeJobQueuesResponse
describeJobQueues
(DescribeJobQueuesRequest describeJobQueuesRequest) Describes one or more of your job queues.default DescribeJobQueuesIterable
This is a variant ofdescribeJobQueues(software.amazon.awssdk.services.batch.model.DescribeJobQueuesRequest)
operation.default DescribeJobQueuesIterable
describeJobQueuesPaginator
(Consumer<DescribeJobQueuesRequest.Builder> describeJobQueuesRequest) This is a variant ofdescribeJobQueues(software.amazon.awssdk.services.batch.model.DescribeJobQueuesRequest)
operation.default DescribeJobQueuesIterable
describeJobQueuesPaginator
(DescribeJobQueuesRequest describeJobQueuesRequest) This is a variant ofdescribeJobQueues(software.amazon.awssdk.services.batch.model.DescribeJobQueuesRequest)
operation.default DescribeJobsResponse
describeJobs
(Consumer<DescribeJobsRequest.Builder> describeJobsRequest) Describes a list of Batch jobs.default DescribeJobsResponse
describeJobs
(DescribeJobsRequest describeJobsRequest) Describes a list of Batch jobs.describeSchedulingPolicies
(Consumer<DescribeSchedulingPoliciesRequest.Builder> describeSchedulingPoliciesRequest) Describes one or more of your scheduling policies.describeSchedulingPolicies
(DescribeSchedulingPoliciesRequest describeSchedulingPoliciesRequest) Describes one or more of your scheduling policies.default ListJobsResponse
listJobs
(Consumer<ListJobsRequest.Builder> listJobsRequest) Returns a list of Batch jobs.default ListJobsResponse
listJobs
(ListJobsRequest listJobsRequest) Returns a list of Batch jobs.default ListJobsIterable
listJobsPaginator
(Consumer<ListJobsRequest.Builder> listJobsRequest) This is a variant oflistJobs(software.amazon.awssdk.services.batch.model.ListJobsRequest)
operation.default ListJobsIterable
listJobsPaginator
(ListJobsRequest listJobsRequest) This is a variant oflistJobs(software.amazon.awssdk.services.batch.model.ListJobsRequest)
operation.default ListSchedulingPoliciesResponse
listSchedulingPolicies
(Consumer<ListSchedulingPoliciesRequest.Builder> listSchedulingPoliciesRequest) Returns a list of Batch scheduling policies.default ListSchedulingPoliciesResponse
listSchedulingPolicies
(ListSchedulingPoliciesRequest listSchedulingPoliciesRequest) Returns a list of Batch scheduling policies.default ListSchedulingPoliciesIterable
listSchedulingPoliciesPaginator
(Consumer<ListSchedulingPoliciesRequest.Builder> listSchedulingPoliciesRequest) This is a variant oflistSchedulingPolicies(software.amazon.awssdk.services.batch.model.ListSchedulingPoliciesRequest)
operation.default ListSchedulingPoliciesIterable
listSchedulingPoliciesPaginator
(ListSchedulingPoliciesRequest listSchedulingPoliciesRequest) This is a variant oflistSchedulingPolicies(software.amazon.awssdk.services.batch.model.ListSchedulingPoliciesRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags for an Batch resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for an Batch resource.default RegisterJobDefinitionResponse
registerJobDefinition
(Consumer<RegisterJobDefinitionRequest.Builder> registerJobDefinitionRequest) Registers an Batch job definition.default RegisterJobDefinitionResponse
registerJobDefinition
(RegisterJobDefinitionRequest registerJobDefinitionRequest) Registers an Batch job definition.default BatchServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default SubmitJobResponse
submitJob
(Consumer<SubmitJobRequest.Builder> submitJobRequest) Submits an Batch job from a job definition.default SubmitJobResponse
submitJob
(SubmitJobRequest submitJobRequest) Submits an Batch job from a job definition.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Associates the specified tags to a resource with the specifiedresourceArn
.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Associates the specified tags to a resource with the specifiedresourceArn
.default TerminateJobResponse
terminateJob
(Consumer<TerminateJobRequest.Builder> terminateJobRequest) Terminates a job in a job queue.default TerminateJobResponse
terminateJob
(TerminateJobRequest terminateJobRequest) Terminates a job in a job queue.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deletes specified tags from an Batch resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Deletes specified tags from an Batch resource.default UpdateComputeEnvironmentResponse
updateComputeEnvironment
(Consumer<UpdateComputeEnvironmentRequest.Builder> updateComputeEnvironmentRequest) Updates an Batch compute environment.default UpdateComputeEnvironmentResponse
updateComputeEnvironment
(UpdateComputeEnvironmentRequest updateComputeEnvironmentRequest) Updates an Batch compute environment.default UpdateJobQueueResponse
updateJobQueue
(Consumer<UpdateJobQueueRequest.Builder> updateJobQueueRequest) Updates a job queue.default UpdateJobQueueResponse
updateJobQueue
(UpdateJobQueueRequest updateJobQueueRequest) Updates a job queue.default UpdateSchedulingPolicyResponse
updateSchedulingPolicy
(Consumer<UpdateSchedulingPolicyRequest.Builder> updateSchedulingPolicyRequest) Updates a scheduling policy.default UpdateSchedulingPolicyResponse
updateSchedulingPolicy
(UpdateSchedulingPolicyRequest updateSchedulingPolicyRequest) Updates a scheduling policy.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
cancelJob
default CancelJobResponse cancelJob(CancelJobRequest cancelJobRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Cancels a job in an Batch job queue. Jobs that are in the
SUBMITTED
orPENDING
are canceled. A job inRUNNABLE
remains inRUNNABLE
until it reaches the head of the job queue. Then the job status is updated toFAILED
.A
PENDING
job is canceled after all dependency jobs are completed. Therefore, it may take longer than expected to cancel a job inPENDING
status.When you try to cancel an array parent job in
PENDING
, Batch attempts to cancel all child jobs. The array parent job is canceled when all child jobs are completed.Jobs that progressed to the
STARTING
orRUNNING
state aren't canceled. However, the API operation still succeeds, even if no job is canceled. These jobs must be terminated with the TerminateJob operation.- Parameters:
cancelJobRequest
- Contains the parameters forCancelJob
.- Returns:
- Result of the CancelJob operation returned by the service.
- See Also:
-
cancelJob
default CancelJobResponse cancelJob(Consumer<CancelJobRequest.Builder> cancelJobRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Cancels a job in an Batch job queue. Jobs that are in the
SUBMITTED
orPENDING
are canceled. A job inRUNNABLE
remains inRUNNABLE
until it reaches the head of the job queue. Then the job status is updated toFAILED
.A
PENDING
job is canceled after all dependency jobs are completed. Therefore, it may take longer than expected to cancel a job inPENDING
status.When you try to cancel an array parent job in
PENDING
, Batch attempts to cancel all child jobs. The array parent job is canceled when all child jobs are completed.Jobs that progressed to the
STARTING
orRUNNING
state aren't canceled. However, the API operation still succeeds, even if no job is canceled. These jobs must be terminated with the TerminateJob operation.
This is a convenience which creates an instance of the
CancelJobRequest.Builder
avoiding the need to create one manually viaCancelJobRequest.builder()
- Parameters:
cancelJobRequest
- AConsumer
that will call methods onCancelJobRequest.Builder
to create a request. Contains the parameters forCancelJob
.- Returns:
- Result of the CancelJob operation returned by the service.
- See Also:
-
createComputeEnvironment
default CreateComputeEnvironmentResponse createComputeEnvironment(CreateComputeEnvironmentRequest createComputeEnvironmentRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Creates an Batch compute environment. You can create
MANAGED
orUNMANAGED
compute environments.MANAGED
compute environments can use Amazon EC2 or Fargate resources.UNMANAGED
compute environments can only use EC2 resources.In a managed compute environment, 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. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a specified percentage of the On-Demand price.
Multi-node parallel jobs aren't supported on Spot Instances.
In an unmanaged compute environment, you can manage your own EC2 compute resources and have flexibility with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, 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.
To create a compute environment that uses EKS resources, the caller must have permissions to call
eks:DescribeCluster
.Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it also doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is available. You're responsible for the management of the guest operating system. This includes any updates and security patches. You're also responsible for any additional application software or utilities that you install on the compute resources. There are two ways to use a new AMI for your Batch jobs. The original method is to complete these steps:
-
Create a new compute environment with the new AMI.
-
Add the compute environment to an existing job queue.
-
Remove the earlier compute environment from your job queue.
-
Delete the earlier compute environment.
In April 2022, Batch added enhanced support for updating compute environments. For more information, see Updating compute environments. To use the enhanced updating of compute environments to update AMIs, follow these rules:
-
Either don't set the service role (
serviceRole
) parameter or set it to the AWSBatchServiceRole service-linked role. -
Set the allocation strategy (
allocationStrategy
) parameter toBEST_FIT_PROGRESSIVE
,SPOT_CAPACITY_OPTIMIZED
, orSPOT_PRICE_CAPACITY_OPTIMIZED
. -
Set the update to latest image version (
updateToLatestImageVersion
) parameter totrue
. TheupdateToLatestImageVersion
parameter is used when you update a compute environment. This parameter is ignored when you create a compute environment. -
Don't specify an AMI ID in
imageId
,imageIdOverride
(inec2Configuration
), or in the launch template (launchTemplate
). In that case, Batch selects the latest Amazon ECS optimized AMI that's supported by Batch at the time the infrastructure update is initiated. Alternatively, you can specify the AMI ID in theimageId
orimageIdOverride
parameters, or the launch template identified by theLaunchTemplate
properties. Changing any of these properties starts an infrastructure update. If the AMI ID is specified in the launch template, it can't be replaced by specifying an AMI ID in either theimageId
orimageIdOverride
parameters. It can only be replaced by specifying a different launch template, or if the launch template version is set toinvalid input: '$'Default
orinvalid input: '$'Latest
, by setting either a new default version for the launch template (ifinvalid input: '$'Default
) or by adding a new version to the launch template (ifinvalid input: '$'Latest
).
If these rules are followed, any update that starts an infrastructure update causes the AMI ID to be re-selected. If the
version
setting in the launch template (launchTemplate
) is set toinvalid input: '$'Latest
orinvalid input: '$'Default
, the latest or default version of the launch template is evaluated up at the time of the infrastructure update, even if thelaunchTemplate
wasn't updated.- Parameters:
createComputeEnvironmentRequest
- Contains the parameters forCreateComputeEnvironment
.- Returns:
- Result of the CreateComputeEnvironment operation returned by the service.
- See Also:
-
-
createComputeEnvironment
default CreateComputeEnvironmentResponse createComputeEnvironment(Consumer<CreateComputeEnvironmentRequest.Builder> createComputeEnvironmentRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Creates an Batch compute environment. You can create
MANAGED
orUNMANAGED
compute environments.MANAGED
compute environments can use Amazon EC2 or Fargate resources.UNMANAGED
compute environments can only use EC2 resources.In a managed compute environment, 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. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a specified percentage of the On-Demand price.
Multi-node parallel jobs aren't supported on Spot Instances.
In an unmanaged compute environment, you can manage your own EC2 compute resources and have flexibility with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, 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.
To create a compute environment that uses EKS resources, the caller must have permissions to call
eks:DescribeCluster
.Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it also doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is available. You're responsible for the management of the guest operating system. This includes any updates and security patches. You're also responsible for any additional application software or utilities that you install on the compute resources. There are two ways to use a new AMI for your Batch jobs. The original method is to complete these steps:
-
Create a new compute environment with the new AMI.
-
Add the compute environment to an existing job queue.
-
Remove the earlier compute environment from your job queue.
-
Delete the earlier compute environment.
In April 2022, Batch added enhanced support for updating compute environments. For more information, see Updating compute environments. To use the enhanced updating of compute environments to update AMIs, follow these rules:
-
Either don't set the service role (
serviceRole
) parameter or set it to the AWSBatchServiceRole service-linked role. -
Set the allocation strategy (
allocationStrategy
) parameter toBEST_FIT_PROGRESSIVE
,SPOT_CAPACITY_OPTIMIZED
, orSPOT_PRICE_CAPACITY_OPTIMIZED
. -
Set the update to latest image version (
updateToLatestImageVersion
) parameter totrue
. TheupdateToLatestImageVersion
parameter is used when you update a compute environment. This parameter is ignored when you create a compute environment. -
Don't specify an AMI ID in
imageId
,imageIdOverride
(inec2Configuration
), or in the launch template (launchTemplate
). In that case, Batch selects the latest Amazon ECS optimized AMI that's supported by Batch at the time the infrastructure update is initiated. Alternatively, you can specify the AMI ID in theimageId
orimageIdOverride
parameters, or the launch template identified by theLaunchTemplate
properties. Changing any of these properties starts an infrastructure update. If the AMI ID is specified in the launch template, it can't be replaced by specifying an AMI ID in either theimageId
orimageIdOverride
parameters. It can only be replaced by specifying a different launch template, or if the launch template version is set toinvalid input: '$'Default
orinvalid input: '$'Latest
, by setting either a new default version for the launch template (ifinvalid input: '$'Default
) or by adding a new version to the launch template (ifinvalid input: '$'Latest
).
If these rules are followed, any update that starts an infrastructure update causes the AMI ID to be re-selected. If the
version
setting in the launch template (launchTemplate
) is set toinvalid input: '$'Latest
orinvalid input: '$'Default
, the latest or default version of the launch template is evaluated up at the time of the infrastructure update, even if thelaunchTemplate
wasn't updated.
This is a convenience which creates an instance of the
CreateComputeEnvironmentRequest.Builder
avoiding the need to create one manually viaCreateComputeEnvironmentRequest.builder()
- Parameters:
createComputeEnvironmentRequest
- AConsumer
that will call methods onCreateComputeEnvironmentRequest.Builder
to create a request. Contains the parameters forCreateComputeEnvironment
.- Returns:
- Result of the CreateComputeEnvironment operation returned by the service.
- See Also:
-
-
createJobQueue
default CreateJobQueueResponse createJobQueue(CreateJobQueueRequest createJobQueueRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Creates an 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 that the 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:
createJobQueueRequest
- Contains the parameters forCreateJobQueue
.- Returns:
- Result of the CreateJobQueue operation returned by the service.
- See Also:
-
createJobQueue
default CreateJobQueueResponse createJobQueue(Consumer<CreateJobQueueRequest.Builder> createJobQueueRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Creates an 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 that the 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.
This is a convenience which creates an instance of the
CreateJobQueueRequest.Builder
avoiding the need to create one manually viaCreateJobQueueRequest.builder()
- Parameters:
createJobQueueRequest
- AConsumer
that will call methods onCreateJobQueueRequest.Builder
to create a request. Contains the parameters forCreateJobQueue
.- Returns:
- Result of the CreateJobQueue operation returned by the service.
- See Also:
-
createSchedulingPolicy
default CreateSchedulingPolicyResponse createSchedulingPolicy(CreateSchedulingPolicyRequest createSchedulingPolicyRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Creates an Batch scheduling policy.
- Parameters:
createSchedulingPolicyRequest
- Contains the parameters forCreateSchedulingPolicy
.- Returns:
- Result of the CreateSchedulingPolicy operation returned by the service.
- See Also:
-
createSchedulingPolicy
default CreateSchedulingPolicyResponse createSchedulingPolicy(Consumer<CreateSchedulingPolicyRequest.Builder> createSchedulingPolicyRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Creates an Batch scheduling policy.
This is a convenience which creates an instance of the
CreateSchedulingPolicyRequest.Builder
avoiding the need to create one manually viaCreateSchedulingPolicyRequest.builder()
- Parameters:
createSchedulingPolicyRequest
- AConsumer
that will call methods onCreateSchedulingPolicyRequest.Builder
to create a request. Contains the parameters forCreateSchedulingPolicy
.- Returns:
- Result of the CreateSchedulingPolicy operation returned by the service.
- See Also:
-
deleteComputeEnvironment
default DeleteComputeEnvironmentResponse deleteComputeEnvironment(DeleteComputeEnvironmentRequest deleteComputeEnvironmentRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Deletes an 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. Compute environments that use Fargate resources must terminate all active jobs on that compute environment before deleting the compute environment. If this isn't done, the compute environment enters an invalid state.- Parameters:
deleteComputeEnvironmentRequest
- Contains the parameters forDeleteComputeEnvironment
.- Returns:
- Result of the DeleteComputeEnvironment operation returned by the service.
- See Also:
-
deleteComputeEnvironment
default DeleteComputeEnvironmentResponse deleteComputeEnvironment(Consumer<DeleteComputeEnvironmentRequest.Builder> deleteComputeEnvironmentRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Deletes an 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. Compute environments that use Fargate resources must terminate all active jobs on that compute environment before deleting the compute environment. If this isn't done, the compute environment enters an invalid state.
This is a convenience which creates an instance of the
DeleteComputeEnvironmentRequest.Builder
avoiding the need to create one manually viaDeleteComputeEnvironmentRequest.builder()
- Parameters:
deleteComputeEnvironmentRequest
- AConsumer
that will call methods onDeleteComputeEnvironmentRequest.Builder
to create a request. Contains the parameters forDeleteComputeEnvironment
.- Returns:
- Result of the DeleteComputeEnvironment operation returned by the service.
- See Also:
-
deleteJobQueue
default DeleteJobQueueResponse deleteJobQueue(DeleteJobQueueRequest deleteJobQueueRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are eventually terminated when you delete a job queue. The jobs are terminated at a rate of about 16 jobs each second.
It's not necessary to disassociate compute environments from a queue before submitting a
DeleteJobQueue
request.- Parameters:
deleteJobQueueRequest
- Contains the parameters forDeleteJobQueue
.- Returns:
- Result of the DeleteJobQueue operation returned by the service.
- See Also:
-
deleteJobQueue
default DeleteJobQueueResponse deleteJobQueue(Consumer<DeleteJobQueueRequest.Builder> deleteJobQueueRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are eventually terminated when you delete a job queue. The jobs are terminated at a rate of about 16 jobs each second.
It's not necessary to disassociate compute environments from a queue before submitting a
DeleteJobQueue
request.
This is a convenience which creates an instance of the
DeleteJobQueueRequest.Builder
avoiding the need to create one manually viaDeleteJobQueueRequest.builder()
- Parameters:
deleteJobQueueRequest
- AConsumer
that will call methods onDeleteJobQueueRequest.Builder
to create a request. Contains the parameters forDeleteJobQueue
.- Returns:
- Result of the DeleteJobQueue operation returned by the service.
- See Also:
-
deleteSchedulingPolicy
default DeleteSchedulingPolicyResponse deleteSchedulingPolicy(DeleteSchedulingPolicyRequest deleteSchedulingPolicyRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Deletes the specified scheduling policy.
You can't delete a scheduling policy that's used in any job queues.
- Parameters:
deleteSchedulingPolicyRequest
- Contains the parameters forDeleteSchedulingPolicy
.- Returns:
- Result of the DeleteSchedulingPolicy operation returned by the service.
- See Also:
-
deleteSchedulingPolicy
default DeleteSchedulingPolicyResponse deleteSchedulingPolicy(Consumer<DeleteSchedulingPolicyRequest.Builder> deleteSchedulingPolicyRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Deletes the specified scheduling policy.
You can't delete a scheduling policy that's used in any job queues.
This is a convenience which creates an instance of the
DeleteSchedulingPolicyRequest.Builder
avoiding the need to create one manually viaDeleteSchedulingPolicyRequest.builder()
- Parameters:
deleteSchedulingPolicyRequest
- AConsumer
that will call methods onDeleteSchedulingPolicyRequest.Builder
to create a request. Contains the parameters forDeleteSchedulingPolicy
.- Returns:
- Result of the DeleteSchedulingPolicy operation returned by the service.
- See Also:
-
deregisterJobDefinition
default DeregisterJobDefinitionResponse deregisterJobDefinition(DeregisterJobDefinitionRequest deregisterJobDefinitionRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Deregisters an Batch job definition. Job definitions are permanently deleted after 180 days.
- Parameters:
deregisterJobDefinitionRequest
-- Returns:
- Result of the DeregisterJobDefinition operation returned by the service.
- See Also:
-
deregisterJobDefinition
default DeregisterJobDefinitionResponse deregisterJobDefinition(Consumer<DeregisterJobDefinitionRequest.Builder> deregisterJobDefinitionRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Deregisters an Batch job definition. Job definitions are permanently deleted after 180 days.
This is a convenience which creates an instance of the
DeregisterJobDefinitionRequest.Builder
avoiding the need to create one manually viaDeregisterJobDefinitionRequest.builder()
- Parameters:
deregisterJobDefinitionRequest
- AConsumer
that will call methods onDeregisterJobDefinitionRequest.Builder
to create a request.- Returns:
- Result of the DeregisterJobDefinition operation returned by the service.
- See Also:
-
describeComputeEnvironments
default DescribeComputeEnvironmentsResponse describeComputeEnvironments(DescribeComputeEnvironmentsRequest describeComputeEnvironmentsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Describes one or more of your compute environments.
If you're using an unmanaged compute environment, you can use the
DescribeComputeEnvironment
operation to determine theecsClusterArn
that you launch your Amazon ECS container instances into.- Parameters:
describeComputeEnvironmentsRequest
- Contains the parameters forDescribeComputeEnvironments
.- Returns:
- Result of the DescribeComputeEnvironments operation returned by the service.
- See Also:
-
describeComputeEnvironments
default DescribeComputeEnvironmentsResponse describeComputeEnvironments(Consumer<DescribeComputeEnvironmentsRequest.Builder> describeComputeEnvironmentsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Describes one or more of your compute environments.
If you're using an unmanaged compute environment, you can use the
DescribeComputeEnvironment
operation to determine theecsClusterArn
that you launch your Amazon ECS container instances into.
This is a convenience which creates an instance of the
DescribeComputeEnvironmentsRequest.Builder
avoiding the need to create one manually viaDescribeComputeEnvironmentsRequest.builder()
- Parameters:
describeComputeEnvironmentsRequest
- AConsumer
that will call methods onDescribeComputeEnvironmentsRequest.Builder
to create a request. Contains the parameters forDescribeComputeEnvironments
.- Returns:
- Result of the DescribeComputeEnvironments operation returned by the service.
- See Also:
-
describeComputeEnvironments
default DescribeComputeEnvironmentsResponse describeComputeEnvironments() throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchExceptionDescribes one or more of your compute environments.
If you're using an unmanaged compute environment, you can use the
DescribeComputeEnvironment
operation to determine theecsClusterArn
that you launch your Amazon ECS container instances into.- Returns:
- Result of the DescribeComputeEnvironments operation returned by the service.
- See Also:
-
describeComputeEnvironmentsPaginator
default DescribeComputeEnvironmentsIterable describeComputeEnvironmentsPaginator() throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchExceptionThis is a variant of
describeComputeEnvironments(software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.batch.paginators.DescribeComputeEnvironmentsIterable responses = client.describeComputeEnvironmentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.batch.paginators.DescribeComputeEnvironmentsIterable responses = client .describeComputeEnvironmentsPaginator(request); for (software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.batch.paginators.DescribeComputeEnvironmentsIterable responses = client.describeComputeEnvironmentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeComputeEnvironments(software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeComputeEnvironmentsPaginator
default DescribeComputeEnvironmentsIterable describeComputeEnvironmentsPaginator(DescribeComputeEnvironmentsRequest describeComputeEnvironmentsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException This is a variant of
describeComputeEnvironments(software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.batch.paginators.DescribeComputeEnvironmentsIterable responses = client.describeComputeEnvironmentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.batch.paginators.DescribeComputeEnvironmentsIterable responses = client .describeComputeEnvironmentsPaginator(request); for (software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.batch.paginators.DescribeComputeEnvironmentsIterable responses = client.describeComputeEnvironmentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeComputeEnvironments(software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsRequest)
operation.- Parameters:
describeComputeEnvironmentsRequest
- Contains the parameters forDescribeComputeEnvironments
.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeComputeEnvironmentsPaginator
default DescribeComputeEnvironmentsIterable describeComputeEnvironmentsPaginator(Consumer<DescribeComputeEnvironmentsRequest.Builder> describeComputeEnvironmentsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException This is a variant of
describeComputeEnvironments(software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.batch.paginators.DescribeComputeEnvironmentsIterable responses = client.describeComputeEnvironmentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.batch.paginators.DescribeComputeEnvironmentsIterable responses = client .describeComputeEnvironmentsPaginator(request); for (software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.batch.paginators.DescribeComputeEnvironmentsIterable responses = client.describeComputeEnvironmentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeComputeEnvironments(software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsRequest)
operation.
This is a convenience which creates an instance of the
DescribeComputeEnvironmentsRequest.Builder
avoiding the need to create one manually viaDescribeComputeEnvironmentsRequest.builder()
- Parameters:
describeComputeEnvironmentsRequest
- AConsumer
that will call methods onDescribeComputeEnvironmentsRequest.Builder
to create a request. Contains the parameters forDescribeComputeEnvironments
.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeJobDefinitions
default DescribeJobDefinitionsResponse describeJobDefinitions(DescribeJobDefinitionsRequest describeJobDefinitionsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Describes a list of job definitions. You can specify a
status
(such asACTIVE
) to only return job definitions that match that status.- Parameters:
describeJobDefinitionsRequest
- Contains the parameters forDescribeJobDefinitions
.- Returns:
- Result of the DescribeJobDefinitions operation returned by the service.
- See Also:
-
describeJobDefinitions
default DescribeJobDefinitionsResponse describeJobDefinitions(Consumer<DescribeJobDefinitionsRequest.Builder> describeJobDefinitionsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Describes a list of job definitions. You can specify a
status
(such asACTIVE
) to only return job definitions that match that status.
This is a convenience which creates an instance of the
DescribeJobDefinitionsRequest.Builder
avoiding the need to create one manually viaDescribeJobDefinitionsRequest.builder()
- Parameters:
describeJobDefinitionsRequest
- AConsumer
that will call methods onDescribeJobDefinitionsRequest.Builder
to create a request. Contains the parameters forDescribeJobDefinitions
.- Returns:
- Result of the DescribeJobDefinitions operation returned by the service.
- See Also:
-
describeJobDefinitions
default DescribeJobDefinitionsResponse describeJobDefinitions() throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchExceptionDescribes a list of job definitions. You can specify a
status
(such asACTIVE
) to only return job definitions that match that status.- Returns:
- Result of the DescribeJobDefinitions operation returned by the service.
- See Also:
-
describeJobDefinitionsPaginator
default DescribeJobDefinitionsIterable describeJobDefinitionsPaginator() throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchExceptionThis is a variant of
describeJobDefinitions(software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.batch.paginators.DescribeJobDefinitionsIterable responses = client.describeJobDefinitionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.batch.paginators.DescribeJobDefinitionsIterable responses = client .describeJobDefinitionsPaginator(request); for (software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.batch.paginators.DescribeJobDefinitionsIterable responses = client.describeJobDefinitionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeJobDefinitions(software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeJobDefinitionsPaginator
default DescribeJobDefinitionsIterable describeJobDefinitionsPaginator(DescribeJobDefinitionsRequest describeJobDefinitionsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException This is a variant of
describeJobDefinitions(software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.batch.paginators.DescribeJobDefinitionsIterable responses = client.describeJobDefinitionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.batch.paginators.DescribeJobDefinitionsIterable responses = client .describeJobDefinitionsPaginator(request); for (software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.batch.paginators.DescribeJobDefinitionsIterable responses = client.describeJobDefinitionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeJobDefinitions(software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsRequest)
operation.- Parameters:
describeJobDefinitionsRequest
- Contains the parameters forDescribeJobDefinitions
.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeJobDefinitionsPaginator
default DescribeJobDefinitionsIterable describeJobDefinitionsPaginator(Consumer<DescribeJobDefinitionsRequest.Builder> describeJobDefinitionsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException This is a variant of
describeJobDefinitions(software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.batch.paginators.DescribeJobDefinitionsIterable responses = client.describeJobDefinitionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.batch.paginators.DescribeJobDefinitionsIterable responses = client .describeJobDefinitionsPaginator(request); for (software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.batch.paginators.DescribeJobDefinitionsIterable responses = client.describeJobDefinitionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeJobDefinitions(software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeJobDefinitionsRequest.Builder
avoiding the need to create one manually viaDescribeJobDefinitionsRequest.builder()
- Parameters:
describeJobDefinitionsRequest
- AConsumer
that will call methods onDescribeJobDefinitionsRequest.Builder
to create a request. Contains the parameters forDescribeJobDefinitions
.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeJobQueues
default DescribeJobQueuesResponse describeJobQueues(DescribeJobQueuesRequest describeJobQueuesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Describes one or more of your job queues.
- Parameters:
describeJobQueuesRequest
- Contains the parameters forDescribeJobQueues
.- Returns:
- Result of the DescribeJobQueues operation returned by the service.
- See Also:
-
describeJobQueues
default DescribeJobQueuesResponse describeJobQueues(Consumer<DescribeJobQueuesRequest.Builder> describeJobQueuesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Describes one or more of your job queues.
This is a convenience which creates an instance of the
DescribeJobQueuesRequest.Builder
avoiding the need to create one manually viaDescribeJobQueuesRequest.builder()
- Parameters:
describeJobQueuesRequest
- AConsumer
that will call methods onDescribeJobQueuesRequest.Builder
to create a request. Contains the parameters forDescribeJobQueues
.- Returns:
- Result of the DescribeJobQueues operation returned by the service.
- See Also:
-
describeJobQueues
default DescribeJobQueuesResponse describeJobQueues() throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchExceptionDescribes one or more of your job queues.
- Returns:
- Result of the DescribeJobQueues operation returned by the service.
- See Also:
-
describeJobQueuesPaginator
default DescribeJobQueuesIterable describeJobQueuesPaginator() throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchExceptionThis is a variant of
describeJobQueues(software.amazon.awssdk.services.batch.model.DescribeJobQueuesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.batch.paginators.DescribeJobQueuesIterable responses = client.describeJobQueuesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.batch.paginators.DescribeJobQueuesIterable responses = client .describeJobQueuesPaginator(request); for (software.amazon.awssdk.services.batch.model.DescribeJobQueuesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.batch.paginators.DescribeJobQueuesIterable responses = client.describeJobQueuesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeJobQueues(software.amazon.awssdk.services.batch.model.DescribeJobQueuesRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeJobQueuesPaginator
default DescribeJobQueuesIterable describeJobQueuesPaginator(DescribeJobQueuesRequest describeJobQueuesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException This is a variant of
describeJobQueues(software.amazon.awssdk.services.batch.model.DescribeJobQueuesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.batch.paginators.DescribeJobQueuesIterable responses = client.describeJobQueuesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.batch.paginators.DescribeJobQueuesIterable responses = client .describeJobQueuesPaginator(request); for (software.amazon.awssdk.services.batch.model.DescribeJobQueuesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.batch.paginators.DescribeJobQueuesIterable responses = client.describeJobQueuesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeJobQueues(software.amazon.awssdk.services.batch.model.DescribeJobQueuesRequest)
operation.- Parameters:
describeJobQueuesRequest
- Contains the parameters forDescribeJobQueues
.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeJobQueuesPaginator
default DescribeJobQueuesIterable describeJobQueuesPaginator(Consumer<DescribeJobQueuesRequest.Builder> describeJobQueuesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException This is a variant of
describeJobQueues(software.amazon.awssdk.services.batch.model.DescribeJobQueuesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.batch.paginators.DescribeJobQueuesIterable responses = client.describeJobQueuesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.batch.paginators.DescribeJobQueuesIterable responses = client .describeJobQueuesPaginator(request); for (software.amazon.awssdk.services.batch.model.DescribeJobQueuesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.batch.paginators.DescribeJobQueuesIterable responses = client.describeJobQueuesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeJobQueues(software.amazon.awssdk.services.batch.model.DescribeJobQueuesRequest)
operation.
This is a convenience which creates an instance of the
DescribeJobQueuesRequest.Builder
avoiding the need to create one manually viaDescribeJobQueuesRequest.builder()
- Parameters:
describeJobQueuesRequest
- AConsumer
that will call methods onDescribeJobQueuesRequest.Builder
to create a request. Contains the parameters forDescribeJobQueues
.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeJobs
default DescribeJobsResponse describeJobs(DescribeJobsRequest describeJobsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Describes a list of Batch jobs.
- Parameters:
describeJobsRequest
- Contains the parameters forDescribeJobs
.- Returns:
- Result of the DescribeJobs operation returned by the service.
- See Also:
-
describeJobs
default DescribeJobsResponse describeJobs(Consumer<DescribeJobsRequest.Builder> describeJobsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Describes a list of Batch jobs.
This is a convenience which creates an instance of the
DescribeJobsRequest.Builder
avoiding the need to create one manually viaDescribeJobsRequest.builder()
- Parameters:
describeJobsRequest
- AConsumer
that will call methods onDescribeJobsRequest.Builder
to create a request. Contains the parameters forDescribeJobs
.- Returns:
- Result of the DescribeJobs operation returned by the service.
- See Also:
-
describeSchedulingPolicies
default DescribeSchedulingPoliciesResponse describeSchedulingPolicies(DescribeSchedulingPoliciesRequest describeSchedulingPoliciesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Describes one or more of your scheduling policies.
- Parameters:
describeSchedulingPoliciesRequest
- Contains the parameters forDescribeSchedulingPolicies
.- Returns:
- Result of the DescribeSchedulingPolicies operation returned by the service.
- See Also:
-
describeSchedulingPolicies
default DescribeSchedulingPoliciesResponse describeSchedulingPolicies(Consumer<DescribeSchedulingPoliciesRequest.Builder> describeSchedulingPoliciesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Describes one or more of your scheduling policies.
This is a convenience which creates an instance of the
DescribeSchedulingPoliciesRequest.Builder
avoiding the need to create one manually viaDescribeSchedulingPoliciesRequest.builder()
- Parameters:
describeSchedulingPoliciesRequest
- AConsumer
that will call methods onDescribeSchedulingPoliciesRequest.Builder
to create a request. Contains the parameters forDescribeSchedulingPolicies
.- Returns:
- Result of the DescribeSchedulingPolicies operation returned by the service.
- See Also:
-
listJobs
default ListJobsResponse listJobs(ListJobsRequest listJobsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Returns a list of Batch jobs.
You must specify only one of the following items:
-
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 nodes for that job
-
An array job ID to return a list of the children for that job
You can filter the results by job status with the
jobStatus
parameter. If you don't specify a status, onlyRUNNING
jobs are returned.- Parameters:
listJobsRequest
- Contains the parameters forListJobs
.- Returns:
- Result of the ListJobs operation returned by the service.
- See Also:
-
-
listJobs
default ListJobsResponse listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Returns a list of Batch jobs.
You must specify only one of the following items:
-
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 nodes for that job
-
An array job ID to return a list of the children for that job
You can filter the results by job status with the
jobStatus
parameter. If you don't specify a status, onlyRUNNING
jobs are returned.
This is a convenience which creates an instance of the
ListJobsRequest.Builder
avoiding the need to create one manually viaListJobsRequest.builder()
- Parameters:
listJobsRequest
- AConsumer
that will call methods onListJobsRequest.Builder
to create a request. Contains the parameters forListJobs
.- Returns:
- Result of the ListJobs operation returned by the service.
- See Also:
-
-
listJobsPaginator
default ListJobsIterable listJobsPaginator(ListJobsRequest listJobsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException This is a variant of
listJobs(software.amazon.awssdk.services.batch.model.ListJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.batch.paginators.ListJobsIterable responses = client.listJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.batch.paginators.ListJobsIterable responses = client.listJobsPaginator(request); for (software.amazon.awssdk.services.batch.model.ListJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.batch.paginators.ListJobsIterable responses = client.listJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listJobs(software.amazon.awssdk.services.batch.model.ListJobsRequest)
operation.- Parameters:
listJobsRequest
- Contains the parameters forListJobs
.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listJobsPaginator
default ListJobsIterable listJobsPaginator(Consumer<ListJobsRequest.Builder> listJobsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException This is a variant of
listJobs(software.amazon.awssdk.services.batch.model.ListJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.batch.paginators.ListJobsIterable responses = client.listJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.batch.paginators.ListJobsIterable responses = client.listJobsPaginator(request); for (software.amazon.awssdk.services.batch.model.ListJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.batch.paginators.ListJobsIterable responses = client.listJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listJobs(software.amazon.awssdk.services.batch.model.ListJobsRequest)
operation.
This is a convenience which creates an instance of the
ListJobsRequest.Builder
avoiding the need to create one manually viaListJobsRequest.builder()
- Parameters:
listJobsRequest
- AConsumer
that will call methods onListJobsRequest.Builder
to create a request. Contains the parameters forListJobs
.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSchedulingPolicies
default ListSchedulingPoliciesResponse listSchedulingPolicies(ListSchedulingPoliciesRequest listSchedulingPoliciesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Returns a list of Batch scheduling policies.
- Parameters:
listSchedulingPoliciesRequest
- Contains the parameters forListSchedulingPolicies
.- Returns:
- Result of the ListSchedulingPolicies operation returned by the service.
- See Also:
-
listSchedulingPolicies
default ListSchedulingPoliciesResponse listSchedulingPolicies(Consumer<ListSchedulingPoliciesRequest.Builder> listSchedulingPoliciesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Returns a list of Batch scheduling policies.
This is a convenience which creates an instance of the
ListSchedulingPoliciesRequest.Builder
avoiding the need to create one manually viaListSchedulingPoliciesRequest.builder()
- Parameters:
listSchedulingPoliciesRequest
- AConsumer
that will call methods onListSchedulingPoliciesRequest.Builder
to create a request. Contains the parameters forListSchedulingPolicies
.- Returns:
- Result of the ListSchedulingPolicies operation returned by the service.
- See Also:
-
listSchedulingPoliciesPaginator
default ListSchedulingPoliciesIterable listSchedulingPoliciesPaginator(ListSchedulingPoliciesRequest listSchedulingPoliciesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException This is a variant of
listSchedulingPolicies(software.amazon.awssdk.services.batch.model.ListSchedulingPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.batch.paginators.ListSchedulingPoliciesIterable responses = client.listSchedulingPoliciesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.batch.paginators.ListSchedulingPoliciesIterable responses = client .listSchedulingPoliciesPaginator(request); for (software.amazon.awssdk.services.batch.model.ListSchedulingPoliciesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.batch.paginators.ListSchedulingPoliciesIterable responses = client.listSchedulingPoliciesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSchedulingPolicies(software.amazon.awssdk.services.batch.model.ListSchedulingPoliciesRequest)
operation.- Parameters:
listSchedulingPoliciesRequest
- Contains the parameters forListSchedulingPolicies
.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSchedulingPoliciesPaginator
default ListSchedulingPoliciesIterable listSchedulingPoliciesPaginator(Consumer<ListSchedulingPoliciesRequest.Builder> listSchedulingPoliciesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException This is a variant of
listSchedulingPolicies(software.amazon.awssdk.services.batch.model.ListSchedulingPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.batch.paginators.ListSchedulingPoliciesIterable responses = client.listSchedulingPoliciesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.batch.paginators.ListSchedulingPoliciesIterable responses = client .listSchedulingPoliciesPaginator(request); for (software.amazon.awssdk.services.batch.model.ListSchedulingPoliciesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.batch.paginators.ListSchedulingPoliciesIterable responses = client.listSchedulingPoliciesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSchedulingPolicies(software.amazon.awssdk.services.batch.model.ListSchedulingPoliciesRequest)
operation.
This is a convenience which creates an instance of the
ListSchedulingPoliciesRequest.Builder
avoiding the need to create one manually viaListSchedulingPoliciesRequest.builder()
- Parameters:
listSchedulingPoliciesRequest
- AConsumer
that will call methods onListSchedulingPoliciesRequest.Builder
to create a request. Contains the parameters forListSchedulingPolicies
.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Lists the tags for an Batch resource. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.
- Parameters:
listTagsForResourceRequest
- Contains the parameters forListTagsForResource
.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Lists the tags for an Batch resource. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request. Contains the parameters forListTagsForResource
.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
registerJobDefinition
default RegisterJobDefinitionResponse registerJobDefinition(RegisterJobDefinitionRequest registerJobDefinitionRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Registers an Batch job definition.
- Parameters:
registerJobDefinitionRequest
- Contains the parameters forRegisterJobDefinition
.- Returns:
- Result of the RegisterJobDefinition operation returned by the service.
- See Also:
-
registerJobDefinition
default RegisterJobDefinitionResponse registerJobDefinition(Consumer<RegisterJobDefinitionRequest.Builder> registerJobDefinitionRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Registers an Batch job definition.
This is a convenience which creates an instance of the
RegisterJobDefinitionRequest.Builder
avoiding the need to create one manually viaRegisterJobDefinitionRequest.builder()
- Parameters:
registerJobDefinitionRequest
- AConsumer
that will call methods onRegisterJobDefinitionRequest.Builder
to create a request. Contains the parameters forRegisterJobDefinition
.- Returns:
- Result of the RegisterJobDefinition operation returned by the service.
- See Also:
-
submitJob
default SubmitJobResponse submitJob(SubmitJobRequest submitJobRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Submits an Batch job from a job definition. Parameters that are specified during SubmitJob override parameters defined in the job definition. vCPU and memory requirements that are specified in the
resourceRequirements
objects in the job definition are the exception. They can't be overridden this way using thememory
andvcpus
parameters. Rather, you must specify updates to job definition parameters in aresourceRequirements
object that's included in thecontainerOverrides
parameter.Job queues with a scheduling policy are limited to 500 active fair share identifiers at a time.
Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14 days, Fargate resources might become unavailable and job might be terminated.
- Parameters:
submitJobRequest
- Contains the parameters forSubmitJob
.- Returns:
- Result of the SubmitJob operation returned by the service.
- See Also:
-
submitJob
default SubmitJobResponse submitJob(Consumer<SubmitJobRequest.Builder> submitJobRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Submits an Batch job from a job definition. Parameters that are specified during SubmitJob override parameters defined in the job definition. vCPU and memory requirements that are specified in the
resourceRequirements
objects in the job definition are the exception. They can't be overridden this way using thememory
andvcpus
parameters. Rather, you must specify updates to job definition parameters in aresourceRequirements
object that's included in thecontainerOverrides
parameter.Job queues with a scheduling policy are limited to 500 active fair share identifiers at a time.
Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14 days, Fargate resources might become unavailable and job might be terminated.
This is a convenience which creates an instance of the
SubmitJobRequest.Builder
avoiding the need to create one manually viaSubmitJobRequest.builder()
- Parameters:
submitJobRequest
- AConsumer
that will call methods onSubmitJobRequest.Builder
to create a request. Contains the parameters forSubmitJob
.- Returns:
- Result of the SubmitJob operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Associates the specified tags to a resource with the specified
resourceArn
. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags that are associated with that resource are deleted as well. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.- Parameters:
tagResourceRequest
- Contains the parameters forTagResource
.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Associates the specified tags to a resource with the specified
resourceArn
. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags that are associated with that resource are deleted as well. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request. Contains the parameters forTagResource
.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
terminateJob
default TerminateJobResponse terminateJob(TerminateJobRequest terminateJobRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Terminates a job in a job queue. Jobs that are in the
STARTING
orRUNNING
state are terminated, which causes them to transition toFAILED
. Jobs that have not progressed to theSTARTING
state are cancelled.- Parameters:
terminateJobRequest
- Contains the parameters forTerminateJob
.- Returns:
- Result of the TerminateJob operation returned by the service.
- See Also:
-
terminateJob
default TerminateJobResponse terminateJob(Consumer<TerminateJobRequest.Builder> terminateJobRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Terminates a job in a job queue. Jobs that are in the
STARTING
orRUNNING
state are terminated, which causes them to transition toFAILED
. Jobs that have not progressed to theSTARTING
state are cancelled.
This is a convenience which creates an instance of the
TerminateJobRequest.Builder
avoiding the need to create one manually viaTerminateJobRequest.builder()
- Parameters:
terminateJobRequest
- AConsumer
that will call methods onTerminateJobRequest.Builder
to create a request. Contains the parameters forTerminateJob
.- Returns:
- Result of the TerminateJob operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Deletes specified tags from an Batch resource.
- Parameters:
untagResourceRequest
- Contains the parameters forUntagResource
.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Deletes specified tags from an Batch resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request. Contains the parameters forUntagResource
.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateComputeEnvironment
default UpdateComputeEnvironmentResponse updateComputeEnvironment(UpdateComputeEnvironmentRequest updateComputeEnvironmentRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Updates an Batch compute environment.
- Parameters:
updateComputeEnvironmentRequest
- Contains the parameters forUpdateComputeEnvironment
.- Returns:
- Result of the UpdateComputeEnvironment operation returned by the service.
- See Also:
-
updateComputeEnvironment
default UpdateComputeEnvironmentResponse updateComputeEnvironment(Consumer<UpdateComputeEnvironmentRequest.Builder> updateComputeEnvironmentRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Updates an Batch compute environment.
This is a convenience which creates an instance of the
UpdateComputeEnvironmentRequest.Builder
avoiding the need to create one manually viaUpdateComputeEnvironmentRequest.builder()
- Parameters:
updateComputeEnvironmentRequest
- AConsumer
that will call methods onUpdateComputeEnvironmentRequest.Builder
to create a request. Contains the parameters forUpdateComputeEnvironment
.- Returns:
- Result of the UpdateComputeEnvironment operation returned by the service.
- See Also:
-
updateJobQueue
default UpdateJobQueueResponse updateJobQueue(UpdateJobQueueRequest updateJobQueueRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Updates a job queue.
- Parameters:
updateJobQueueRequest
- Contains the parameters forUpdateJobQueue
.- Returns:
- Result of the UpdateJobQueue operation returned by the service.
- See Also:
-
updateJobQueue
default UpdateJobQueueResponse updateJobQueue(Consumer<UpdateJobQueueRequest.Builder> updateJobQueueRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Updates a job queue.
This is a convenience which creates an instance of the
UpdateJobQueueRequest.Builder
avoiding the need to create one manually viaUpdateJobQueueRequest.builder()
- Parameters:
updateJobQueueRequest
- AConsumer
that will call methods onUpdateJobQueueRequest.Builder
to create a request. Contains the parameters forUpdateJobQueue
.- Returns:
- Result of the UpdateJobQueue operation returned by the service.
- See Also:
-
updateSchedulingPolicy
default UpdateSchedulingPolicyResponse updateSchedulingPolicy(UpdateSchedulingPolicyRequest updateSchedulingPolicyRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Updates a scheduling policy.
- Parameters:
updateSchedulingPolicyRequest
- Contains the parameters forUpdateSchedulingPolicy
.- Returns:
- Result of the UpdateSchedulingPolicy operation returned by the service.
- See Also:
-
updateSchedulingPolicy
default UpdateSchedulingPolicyResponse updateSchedulingPolicy(Consumer<UpdateSchedulingPolicyRequest.Builder> updateSchedulingPolicyRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException Updates a scheduling policy.
This is a convenience which creates an instance of the
UpdateSchedulingPolicyRequest.Builder
avoiding the need to create one manually viaUpdateSchedulingPolicyRequest.builder()
- Parameters:
updateSchedulingPolicyRequest
- AConsumer
that will call methods onUpdateSchedulingPolicyRequest.Builder
to create a request. Contains the parameters forUpdateSchedulingPolicy
.- Returns:
- Result of the UpdateSchedulingPolicy operation returned by the service.
- See Also:
-
create
Create aBatchClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aBatchClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-