@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface BatchClient extends AwsClient
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 d, 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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.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 or PENDING are
canceled. A job inRUNNABLE remains in RUNNABLE until it reaches the head of the job
queue. Then the job status is updated to FAILED.
A PENDING job is canceled after all dependency jobs are completed. Therefore, it may take longer
than expected to cancel a job in PENDING 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 or RUNNING 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.
cancelJobRequest - Contains the parameters for CancelJob.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 or PENDING are
canceled. A job inRUNNABLE remains in RUNNABLE until it reaches the head of the job
queue. Then the job status is updated to FAILED.
A PENDING job is canceled after all dependency jobs are completed. Therefore, it may take longer
than expected to cancel a job in PENDING 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 or RUNNING 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 via CancelJobRequest.builder()
cancelJobRequest - A Consumer that will call methods on
CancelJobRequest.Builder to create a request. Contains
the parameters for CancelJob.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateComputeEnvironmentResponse createComputeEnvironment(CreateComputeEnvironmentRequest createComputeEnvironmentRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException
Creates an Batch compute environment. You can create MANAGED or UNMANAGED 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 to BEST_FIT_PROGRESSIVE,
SPOT_CAPACITY_OPTIMIZED, or SPOT_PRICE_CAPACITY_OPTIMIZED.
Set the update to latest image version (updateToLatestImageVersion) parameter to true.
The updateToLatestImageVersion 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 (in
ec2Configuration ), 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 the imageId or imageIdOverride
parameters, or the launch template identified by the LaunchTemplate 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 the imageId or imageIdOverride parameters.
It can only be replaced by specifying a different launch template, or if the launch template version is set to
$Default or $Latest, by setting either a new default version for the launch
template (if $Default) or by adding a new version to the launch template (if
$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 to
$Latest or $Default, the latest or default version of the launch template is
evaluated up at the time of the infrastructure update, even if the launchTemplate wasn't updated.
createComputeEnvironmentRequest - Contains the parameters for CreateComputeEnvironment.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateComputeEnvironmentResponse createComputeEnvironment(Consumer<CreateComputeEnvironmentRequest.Builder> createComputeEnvironmentRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException
Creates an Batch compute environment. You can create MANAGED or UNMANAGED 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 to BEST_FIT_PROGRESSIVE,
SPOT_CAPACITY_OPTIMIZED, or SPOT_PRICE_CAPACITY_OPTIMIZED.
Set the update to latest image version (updateToLatestImageVersion) parameter to true.
The updateToLatestImageVersion 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 (in
ec2Configuration ), 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 the imageId or imageIdOverride
parameters, or the launch template identified by the LaunchTemplate 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 the imageId or imageIdOverride parameters.
It can only be replaced by specifying a different launch template, or if the launch template version is set to
$Default or $Latest, by setting either a new default version for the launch
template (if $Default) or by adding a new version to the launch template (if
$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 to
$Latest or $Default, the latest or default version of the launch template is
evaluated up at the time of the infrastructure update, even if the launchTemplate wasn't updated.
This is a convenience which creates an instance of the CreateComputeEnvironmentRequest.Builder avoiding
the need to create one manually via CreateComputeEnvironmentRequest.builder()
createComputeEnvironmentRequest - A Consumer that will call methods on
CreateComputeEnvironmentRequest.Builder to create a
request. Contains the parameters for CreateComputeEnvironment.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createJobQueueRequest - Contains the parameters for CreateJobQueue.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via CreateJobQueueRequest.builder()
createJobQueueRequest - A Consumer that will call methods on
CreateJobQueueRequest.Builder to create a request.
Contains the parameters for CreateJobQueue.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateSchedulingPolicyResponse createSchedulingPolicy(CreateSchedulingPolicyRequest createSchedulingPolicyRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException
Creates an Batch scheduling policy.
createSchedulingPolicyRequest - Contains the parameters for CreateSchedulingPolicy.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via CreateSchedulingPolicyRequest.builder()
createSchedulingPolicyRequest - A Consumer that will call methods on
CreateSchedulingPolicyRequest.Builder to create a
request. Contains the parameters for CreateSchedulingPolicy.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteComputeEnvironmentRequest - Contains the parameters for DeleteComputeEnvironment.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteComputeEnvironmentRequest.builder()
deleteComputeEnvironmentRequest - A Consumer that will call methods on
DeleteComputeEnvironmentRequest.Builder to create a
request. Contains the parameters for DeleteComputeEnvironment.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteJobQueueRequest - Contains the parameters for DeleteJobQueue.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteJobQueueRequest.builder()
deleteJobQueueRequest - A Consumer that will call methods on
DeleteJobQueueRequest.Builder to create a request.
Contains the parameters for DeleteJobQueue.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteSchedulingPolicyRequest - Contains the parameters for DeleteSchedulingPolicy.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteSchedulingPolicyRequest.builder()
deleteSchedulingPolicyRequest - A Consumer that will call methods on
DeleteSchedulingPolicyRequest.Builder to create a
request. Contains the parameters for DeleteSchedulingPolicy.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeregisterJobDefinitionResponse deregisterJobDefinition(DeregisterJobDefinitionRequest deregisterJobDefinitionRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException
Deregisters an Batch job definition. Job definitions are permanently deleted after 180 days.
deregisterJobDefinitionRequest - ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeregisterJobDefinitionRequest.builder()
deregisterJobDefinitionRequest - A Consumer that will call methods on
DeregisterJobDefinitionRequest.Builder to create a
request.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 the ecsClusterArn that you launch your Amazon ECS container instances into.
describeComputeEnvironmentsRequest - Contains the parameters for DescribeComputeEnvironments.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 the ecsClusterArn 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 via DescribeComputeEnvironmentsRequest.builder()
describeComputeEnvironmentsRequest - A Consumer that will call methods on
DescribeComputeEnvironmentsRequest.Builder to create a
request. Contains the parameters for DescribeComputeEnvironments.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeComputeEnvironmentsResponse describeComputeEnvironments() 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 the ecsClusterArn that you launch your Amazon ECS container instances into.
ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeComputeEnvironments(DescribeComputeEnvironmentsRequest),
AWS API Documentationdefault DescribeComputeEnvironmentsIterable describeComputeEnvironmentsPaginator() 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 the ecsClusterArn that you launch your Amazon ECS container instances into.
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 Stream
software.amazon.awssdk.services.batch.paginators.DescribeComputeEnvironmentsIterable responses = client.describeComputeEnvironmentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeComputeEnvironmentsPaginator(DescribeComputeEnvironmentsRequest),
AWS API Documentationdefault DescribeComputeEnvironmentsIterable describeComputeEnvironmentsPaginator(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 the ecsClusterArn that you launch your Amazon ECS container instances into.
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 Stream
software.amazon.awssdk.services.batch.paginators.DescribeComputeEnvironmentsIterable responses = client.describeComputeEnvironmentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
describeComputeEnvironmentsRequest - Contains the parameters for DescribeComputeEnvironments.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeComputeEnvironmentsIterable describeComputeEnvironmentsPaginator(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 the ecsClusterArn that you launch your Amazon ECS container instances into.
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 Stream
software.amazon.awssdk.services.batch.paginators.DescribeComputeEnvironmentsIterable responses = client.describeComputeEnvironmentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via DescribeComputeEnvironmentsRequest.builder()
describeComputeEnvironmentsRequest - A Consumer that will call methods on
DescribeComputeEnvironmentsRequest.Builder to create a
request. Contains the parameters for DescribeComputeEnvironments.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeJobDefinitionsResponse describeJobDefinitions(DescribeJobDefinitionsRequest describeJobDefinitionsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException
Describes a list of job definitions. You can specify a status (such as ACTIVE) to only
return job definitions that match that status.
describeJobDefinitionsRequest - Contains the parameters for DescribeJobDefinitions.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeJobDefinitionsResponse describeJobDefinitions(Consumer<DescribeJobDefinitionsRequest.Builder> describeJobDefinitionsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException
Describes a list of job definitions. You can specify a status (such as ACTIVE) 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 via DescribeJobDefinitionsRequest.builder()
describeJobDefinitionsRequest - A Consumer that will call methods on
DescribeJobDefinitionsRequest.Builder to create a
request. Contains the parameters for DescribeJobDefinitions.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeJobDefinitionsResponse describeJobDefinitions() throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException
Describes a list of job definitions. You can specify a status (such as ACTIVE) to only
return job definitions that match that status.
ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeJobDefinitions(DescribeJobDefinitionsRequest),
AWS
API Documentationdefault DescribeJobDefinitionsIterable describeJobDefinitionsPaginator() throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException
Describes a list of job definitions. You can specify a status (such as ACTIVE) to only
return job definitions that match that status.
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 Stream
software.amazon.awssdk.services.batch.paginators.DescribeJobDefinitionsIterable responses = client.describeJobDefinitionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeJobDefinitionsPaginator(DescribeJobDefinitionsRequest),
AWS
API Documentationdefault DescribeJobDefinitionsIterable describeJobDefinitionsPaginator(DescribeJobDefinitionsRequest describeJobDefinitionsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException
Describes a list of job definitions. You can specify a status (such as ACTIVE) to only
return job definitions that match that status.
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 Stream
software.amazon.awssdk.services.batch.paginators.DescribeJobDefinitionsIterable responses = client.describeJobDefinitionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
describeJobDefinitionsRequest - Contains the parameters for DescribeJobDefinitions.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeJobDefinitionsIterable describeJobDefinitionsPaginator(Consumer<DescribeJobDefinitionsRequest.Builder> describeJobDefinitionsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException
Describes a list of job definitions. You can specify a status (such as ACTIVE) to only
return job definitions that match that status.
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 Stream
software.amazon.awssdk.services.batch.paginators.DescribeJobDefinitionsIterable responses = client.describeJobDefinitionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via DescribeJobDefinitionsRequest.builder()
describeJobDefinitionsRequest - A Consumer that will call methods on
DescribeJobDefinitionsRequest.Builder to create a
request. Contains the parameters for DescribeJobDefinitions.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeJobQueuesResponse describeJobQueues(DescribeJobQueuesRequest describeJobQueuesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException
Describes one or more of your job queues.
describeJobQueuesRequest - Contains the parameters for DescribeJobQueues.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeJobQueuesRequest.builder()
describeJobQueuesRequest - A Consumer that will call methods on
DescribeJobQueuesRequest.Builder to create a request.
Contains the parameters for DescribeJobQueues.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeJobQueuesResponse describeJobQueues() throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException
Describes one or more of your job queues.
ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeJobQueues(DescribeJobQueuesRequest),
AWS API
Documentationdefault DescribeJobQueuesIterable describeJobQueuesPaginator() throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException
Describes one or more of your job queues.
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 Stream
software.amazon.awssdk.services.batch.paginators.DescribeJobQueuesIterable responses = client.describeJobQueuesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeJobQueuesPaginator(DescribeJobQueuesRequest),
AWS API
Documentationdefault DescribeJobQueuesIterable describeJobQueuesPaginator(DescribeJobQueuesRequest describeJobQueuesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException
Describes one or more of your job queues.
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 Stream
software.amazon.awssdk.services.batch.paginators.DescribeJobQueuesIterable responses = client.describeJobQueuesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
describeJobQueuesRequest - Contains the parameters for DescribeJobQueues.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeJobQueuesIterable describeJobQueuesPaginator(Consumer<DescribeJobQueuesRequest.Builder> describeJobQueuesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException
Describes one or more of your job queues.
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 Stream
software.amazon.awssdk.services.batch.paginators.DescribeJobQueuesIterable responses = client.describeJobQueuesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via DescribeJobQueuesRequest.builder()
describeJobQueuesRequest - A Consumer that will call methods on
DescribeJobQueuesRequest.Builder to create a request.
Contains the parameters for DescribeJobQueues.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeJobsResponse describeJobs(DescribeJobsRequest describeJobsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException
Describes a list of Batch jobs.
describeJobsRequest - Contains the parameters for DescribeJobs.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeJobsRequest.builder()
describeJobsRequest - A Consumer that will call methods on
DescribeJobsRequest.Builder to create a request.
Contains the parameters for DescribeJobs.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSchedulingPoliciesResponse describeSchedulingPolicies(DescribeSchedulingPoliciesRequest describeSchedulingPoliciesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException
Describes one or more of your scheduling policies.
describeSchedulingPoliciesRequest - Contains the parameters for DescribeSchedulingPolicies.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeSchedulingPoliciesRequest.builder()
describeSchedulingPoliciesRequest - A Consumer that will call methods on
DescribeSchedulingPoliciesRequest.Builder to create a
request. Contains the parameters for DescribeSchedulingPolicies.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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, only RUNNING jobs are returned.
listJobsRequest - Contains the parameters for ListJobs.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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, only RUNNING jobs are returned.
This is a convenience which creates an instance of the ListJobsRequest.Builder avoiding the need to
create one manually via ListJobsRequest.builder()
listJobsRequest - A Consumer that will call methods on
ListJobsRequest.Builder to create a request. Contains
the parameters for ListJobs.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListJobsIterable listJobsPaginator(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, only RUNNING jobs are returned.
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 Stream
software.amazon.awssdk.services.batch.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listJobsRequest - Contains the parameters for ListJobs.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListJobsIterable listJobsPaginator(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, only RUNNING jobs are returned.
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 Stream
software.amazon.awssdk.services.batch.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListJobsRequest.builder()
listJobsRequest - A Consumer that will call methods on
ListJobsRequest.Builder to create a request. Contains
the parameters for ListJobs.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSchedulingPoliciesResponse listSchedulingPolicies(ListSchedulingPoliciesRequest listSchedulingPoliciesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException
Returns a list of Batch scheduling policies.
listSchedulingPoliciesRequest - Contains the parameters for ListSchedulingPolicies.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListSchedulingPoliciesRequest.builder()
listSchedulingPoliciesRequest - A Consumer that will call methods on
ListSchedulingPoliciesRequest.Builder to create a
request. Contains the parameters for ListSchedulingPolicies.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSchedulingPoliciesIterable listSchedulingPoliciesPaginator(ListSchedulingPoliciesRequest listSchedulingPoliciesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException
Returns a list of Batch scheduling policies.
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 Stream
software.amazon.awssdk.services.batch.paginators.ListSchedulingPoliciesIterable responses = client.listSchedulingPoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listSchedulingPoliciesRequest - Contains the parameters for ListSchedulingPolicies.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSchedulingPoliciesIterable listSchedulingPoliciesPaginator(Consumer<ListSchedulingPoliciesRequest.Builder> listSchedulingPoliciesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException
Returns a list of Batch scheduling policies.
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 Stream
software.amazon.awssdk.services.batch.paginators.ListSchedulingPoliciesIterable responses = client.listSchedulingPoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListSchedulingPoliciesRequest.builder()
listSchedulingPoliciesRequest - A Consumer that will call methods on
ListSchedulingPoliciesRequest.Builder to create a
request. Contains the parameters for ListSchedulingPolicies.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listTagsForResourceRequest - Contains the parameters for ListTagsForResource.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create a
request. Contains the parameters for ListTagsForResource.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterJobDefinitionResponse registerJobDefinition(RegisterJobDefinitionRequest registerJobDefinitionRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException
Registers an Batch job definition.
registerJobDefinitionRequest - Contains the parameters for RegisterJobDefinition.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via RegisterJobDefinitionRequest.builder()
registerJobDefinitionRequest - A Consumer that will call methods on
RegisterJobDefinitionRequest.Builder to create a
request. Contains the parameters for RegisterJobDefinition.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 the memory and vcpus parameters. Rather, you must specify updates to job
definition parameters in a resourceRequirements object that's included in the
containerOverrides 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.
submitJobRequest - Contains the parameters for SubmitJob.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 the memory and vcpus parameters. Rather, you must specify updates to job
definition parameters in a resourceRequirements object that's included in the
containerOverrides 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 via SubmitJobRequest.builder()
submitJobRequest - A Consumer that will call methods on
SubmitJobRequest.Builder to create a request. Contains
the parameters for SubmitJob.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
tagResourceRequest - Contains the parameters for TagResource.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a request.
Contains the parameters for TagResource.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TerminateJobResponse terminateJob(TerminateJobRequest terminateJobRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException
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.
terminateJobRequest - Contains the parameters for TerminateJob.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 or RUNNING state are
terminated, which causes them to transition to FAILED. Jobs that have not progressed to the
STARTING state are cancelled.
This is a convenience which creates an instance of the TerminateJobRequest.Builder avoiding the need to
create one manually via TerminateJobRequest.builder()
terminateJobRequest - A Consumer that will call methods on
TerminateJobRequest.Builder to create a request.
Contains the parameters for TerminateJob.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException
Deletes specified tags from an Batch resource.
untagResourceRequest - Contains the parameters for UntagResource.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a request.
Contains the parameters for UntagResource.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateComputeEnvironmentResponse updateComputeEnvironment(UpdateComputeEnvironmentRequest updateComputeEnvironmentRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException
Updates an Batch compute environment.
updateComputeEnvironmentRequest - Contains the parameters for UpdateComputeEnvironment.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UpdateComputeEnvironmentRequest.builder()
updateComputeEnvironmentRequest - A Consumer that will call methods on
UpdateComputeEnvironmentRequest.Builder to create a
request. Contains the parameters for UpdateComputeEnvironment.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateJobQueueResponse updateJobQueue(UpdateJobQueueRequest updateJobQueueRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException
Updates a job queue.
updateJobQueueRequest - Contains the parameters for UpdateJobQueue.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UpdateJobQueueRequest.builder()
updateJobQueueRequest - A Consumer that will call methods on
UpdateJobQueueRequest.Builder to create a request.
Contains the parameters for UpdateJobQueue.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateSchedulingPolicyResponse updateSchedulingPolicy(UpdateSchedulingPolicyRequest updateSchedulingPolicyRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException
Updates a scheduling policy.
updateSchedulingPolicyRequest - Contains the parameters for UpdateSchedulingPolicy.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UpdateSchedulingPolicyRequest.builder()
updateSchedulingPolicyRequest - A Consumer that will call methods on
UpdateSchedulingPolicyRequest.Builder to create a
request. Contains the parameters for UpdateSchedulingPolicy.ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on
behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
an identifier that's not valid.ServerException - These errors are usually caused by a server issue.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BatchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic BatchClient create()
BatchClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static BatchClientBuilder builder()
BatchClient.static ServiceMetadata serviceMetadata()
default BatchServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.