Package software.amazon.awssdk.services.batch

Interface BatchClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface BatchClient extends AwsClient
Service client for accessing AWS Batch. This can be created using the static builder() method. Batch

Using Batch, you can run batch computing workloads on the Amazon Web Services Cloud. Batch computing is a common means for developers, scientists, and engineers to access large amounts of compute resources. Batch uses the advantages of the batch computing to remove the undifferentiated heavy lifting of configuring and managing required infrastructure. At the same time, it also adopts a familiar batch computing software approach. You can use Batch to efficiently provision resources, and work toward eliminating capacity constraints, reducing your overall compute costs, and delivering results more quickly.

As a fully managed service, Batch can run batch computing workloads of any scale. Batch automatically provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific workloads. With Batch, there's no need to install or manage batch computing software. This means that you can focus on analyzing results and solving your specific problems instead.

  • Field Details

  • Method Details

    • cancelJob

      default CancelJobResponse cancelJob(CancelJobRequest cancelJobRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Cancels a job in an Batch job queue. Jobs that are in a SUBMITTED, PENDING, or RUNNABLE state are cancelled and 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.

      Parameters:
      cancelJobRequest - Contains the parameters for CancelJob.
      Returns:
      Result of the CancelJob operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • cancelJob

      default CancelJobResponse cancelJob(Consumer<CancelJobRequest.Builder> cancelJobRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Cancels a job in an Batch job queue. Jobs that are in a SUBMITTED, PENDING, or RUNNABLE state are cancelled and 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()

      Parameters:
      cancelJobRequest - A Consumer that will call methods on CancelJobRequest.Builder to create a request. Contains the parameters for CancelJob.
      Returns:
      Result of the CancelJob operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • createComputeEnvironment

      default 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.

      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.

      Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For more information on how to update a compute environment's AMI, see Updating compute environments in the Batch User Guide.

      Parameters:
      createComputeEnvironmentRequest - Contains the parameters for CreateComputeEnvironment.
      Returns:
      Result of the CreateComputeEnvironment operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • createComputeEnvironment

      default CreateComputeEnvironmentResponse createComputeEnvironment(Consumer<CreateComputeEnvironmentRequest.Builder> createComputeEnvironmentRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Creates an Batch compute environment. You can create MANAGED 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.

      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.

      Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For more information on how to update a compute environment's AMI, see Updating compute environments in the Batch User Guide.


      This is a convenience which creates an instance of the CreateComputeEnvironmentRequest.Builder avoiding the need to create one manually via CreateComputeEnvironmentRequest.builder()

      Parameters:
      createComputeEnvironmentRequest - A Consumer that will call methods on CreateComputeEnvironmentRequest.Builder to create a request. Contains the parameters for CreateComputeEnvironment.
      Returns:
      Result of the CreateComputeEnvironment operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • createConsumableResource

      default CreateConsumableResourceResponse createConsumableResource(CreateConsumableResourceRequest createConsumableResourceRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Creates an Batch consumable resource.

      Parameters:
      createConsumableResourceRequest -
      Returns:
      Result of the CreateConsumableResource operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • createConsumableResource

      default CreateConsumableResourceResponse createConsumableResource(Consumer<CreateConsumableResourceRequest.Builder> createConsumableResourceRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Creates an Batch consumable resource.


      This is a convenience which creates an instance of the CreateConsumableResourceRequest.Builder avoiding the need to create one manually via CreateConsumableResourceRequest.builder()

      Parameters:
      createConsumableResourceRequest - A Consumer that will call methods on CreateConsumableResourceRequest.Builder to create a request.
      Returns:
      Result of the CreateConsumableResource operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • createJobQueue

      default CreateJobQueueResponse createJobQueue(CreateJobQueueRequest createJobQueueRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Creates an Batch job queue. When you create a job queue, you associate one or more compute environments to the queue and assign an order of preference for the compute environments.

      You also set a priority to the job queue that determines the order that the Batch scheduler places jobs onto its associated compute environments. For example, if a compute environment is associated with more than one job queue, the job queue with a higher priority is given preference for scheduling jobs to that compute environment.

      Parameters:
      createJobQueueRequest - Contains the parameters for CreateJobQueue.
      Returns:
      Result of the CreateJobQueue operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • createJobQueue

      default CreateJobQueueResponse createJobQueue(Consumer<CreateJobQueueRequest.Builder> createJobQueueRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Creates an Batch job queue. When you create a job queue, you associate one or more compute environments to the queue and assign an order of preference for the compute environments.

      You also set a priority to the job queue that determines the order that the Batch scheduler places jobs onto its associated compute environments. For example, if a compute environment is associated with more than one job queue, the job queue with a higher priority is given preference for scheduling jobs to that compute environment.


      This is a convenience which creates an instance of the CreateJobQueueRequest.Builder avoiding the need to create one manually via CreateJobQueueRequest.builder()

      Parameters:
      createJobQueueRequest - A Consumer that will call methods on CreateJobQueueRequest.Builder to create a request. Contains the parameters for CreateJobQueue.
      Returns:
      Result of the CreateJobQueue operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • createQuotaShare

      default CreateQuotaShareResponse createQuotaShare(CreateQuotaShareRequest createQuotaShareRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Creates an Batch quota share. Each quota share operates as a virtual queue with a configured compute capacity, resource sharing strategy, and borrow limits.

      Parameters:
      createQuotaShareRequest -
      Returns:
      Result of the CreateQuotaShare operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • createQuotaShare

      default CreateQuotaShareResponse createQuotaShare(Consumer<CreateQuotaShareRequest.Builder> createQuotaShareRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Creates an Batch quota share. Each quota share operates as a virtual queue with a configured compute capacity, resource sharing strategy, and borrow limits.


      This is a convenience which creates an instance of the CreateQuotaShareRequest.Builder avoiding the need to create one manually via CreateQuotaShareRequest.builder()

      Parameters:
      createQuotaShareRequest - A Consumer that will call methods on CreateQuotaShareRequest.Builder to create a request.
      Returns:
      Result of the CreateQuotaShare operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • createSchedulingPolicy

      default CreateSchedulingPolicyResponse createSchedulingPolicy(CreateSchedulingPolicyRequest createSchedulingPolicyRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Creates an Batch scheduling policy.

      Parameters:
      createSchedulingPolicyRequest - Contains the parameters for CreateSchedulingPolicy.
      Returns:
      Result of the CreateSchedulingPolicy operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • createSchedulingPolicy

      default CreateSchedulingPolicyResponse createSchedulingPolicy(Consumer<CreateSchedulingPolicyRequest.Builder> createSchedulingPolicyRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Creates an Batch scheduling policy.


      This is a convenience which creates an instance of the CreateSchedulingPolicyRequest.Builder avoiding the need to create one manually via CreateSchedulingPolicyRequest.builder()

      Parameters:
      createSchedulingPolicyRequest - A Consumer that will call methods on CreateSchedulingPolicyRequest.Builder to create a request. Contains the parameters for CreateSchedulingPolicy.
      Returns:
      Result of the CreateSchedulingPolicy operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • createServiceEnvironment

      default CreateServiceEnvironmentResponse createServiceEnvironment(CreateServiceEnvironmentRequest createServiceEnvironmentRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Creates a service environment for running service jobs. Service environments define capacity limits for specific service types such as SageMaker Training jobs.

      Parameters:
      createServiceEnvironmentRequest -
      Returns:
      Result of the CreateServiceEnvironment operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • createServiceEnvironment

      default CreateServiceEnvironmentResponse createServiceEnvironment(Consumer<CreateServiceEnvironmentRequest.Builder> createServiceEnvironmentRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Creates a service environment for running service jobs. Service environments define capacity limits for specific service types such as SageMaker Training jobs.


      This is a convenience which creates an instance of the CreateServiceEnvironmentRequest.Builder avoiding the need to create one manually via CreateServiceEnvironmentRequest.builder()

      Parameters:
      createServiceEnvironmentRequest - A Consumer that will call methods on CreateServiceEnvironmentRequest.Builder to create a request.
      Returns:
      Result of the CreateServiceEnvironment operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • deleteComputeEnvironment

      default DeleteComputeEnvironmentResponse deleteComputeEnvironment(DeleteComputeEnvironmentRequest deleteComputeEnvironmentRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Deletes an Batch compute environment.

      Before you can delete a compute environment, you must set its state to DISABLED with the UpdateComputeEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation. Compute environments that use Fargate resources must terminate all active jobs on that compute environment before deleting the compute environment. If this isn't done, the compute environment enters an invalid state.

      Parameters:
      deleteComputeEnvironmentRequest - Contains the parameters for DeleteComputeEnvironment.
      Returns:
      Result of the DeleteComputeEnvironment operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • deleteComputeEnvironment

      default DeleteComputeEnvironmentResponse deleteComputeEnvironment(Consumer<DeleteComputeEnvironmentRequest.Builder> deleteComputeEnvironmentRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Deletes an Batch compute environment.

      Before you can delete a compute environment, you must set its state to DISABLED with the UpdateComputeEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation. Compute environments that use Fargate resources must terminate all active jobs on that compute environment before deleting the compute environment. If this isn't done, the compute environment enters an invalid state.


      This is a convenience which creates an instance of the DeleteComputeEnvironmentRequest.Builder avoiding the need to create one manually via DeleteComputeEnvironmentRequest.builder()

      Parameters:
      deleteComputeEnvironmentRequest - A Consumer that will call methods on DeleteComputeEnvironmentRequest.Builder to create a request. Contains the parameters for DeleteComputeEnvironment.
      Returns:
      Result of the DeleteComputeEnvironment operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • deleteConsumableResource

      default DeleteConsumableResourceResponse deleteConsumableResource(DeleteConsumableResourceRequest deleteConsumableResourceRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Deletes the specified consumable resource.

      Parameters:
      deleteConsumableResourceRequest -
      Returns:
      Result of the DeleteConsumableResource operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • deleteConsumableResource

      default DeleteConsumableResourceResponse deleteConsumableResource(Consumer<DeleteConsumableResourceRequest.Builder> deleteConsumableResourceRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Deletes the specified consumable resource.


      This is a convenience which creates an instance of the DeleteConsumableResourceRequest.Builder avoiding the need to create one manually via DeleteConsumableResourceRequest.builder()

      Parameters:
      deleteConsumableResourceRequest - A Consumer that will call methods on DeleteConsumableResourceRequest.Builder to create a request.
      Returns:
      Result of the DeleteConsumableResource operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • deleteJobQueue

      default DeleteJobQueueResponse deleteJobQueue(DeleteJobQueueRequest deleteJobQueueRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are eventually terminated when you delete a job queue.

      It's not necessary to disassociate compute environments from a queue before submitting a DeleteJobQueue request.

      Parameters:
      deleteJobQueueRequest - Contains the parameters for DeleteJobQueue.
      Returns:
      Result of the DeleteJobQueue operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • deleteJobQueue

      default DeleteJobQueueResponse deleteJobQueue(Consumer<DeleteJobQueueRequest.Builder> deleteJobQueueRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are eventually terminated when you delete a job queue.

      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()

      Parameters:
      deleteJobQueueRequest - A Consumer that will call methods on DeleteJobQueueRequest.Builder to create a request. Contains the parameters for DeleteJobQueue.
      Returns:
      Result of the DeleteJobQueue operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • deleteQuotaShare

      default DeleteQuotaShareResponse deleteQuotaShare(DeleteQuotaShareRequest deleteQuotaShareRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Deletes the specified quota share. You must first disable submissions for the share by updating the state to DISABLED using the UpdateQuotaShare operation. All jobs in the share are eventually terminated when you delete a quota share.

      Parameters:
      deleteQuotaShareRequest -
      Returns:
      Result of the DeleteQuotaShare operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • deleteQuotaShare

      default DeleteQuotaShareResponse deleteQuotaShare(Consumer<DeleteQuotaShareRequest.Builder> deleteQuotaShareRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Deletes the specified quota share. You must first disable submissions for the share by updating the state to DISABLED using the UpdateQuotaShare operation. All jobs in the share are eventually terminated when you delete a quota share.


      This is a convenience which creates an instance of the DeleteQuotaShareRequest.Builder avoiding the need to create one manually via DeleteQuotaShareRequest.builder()

      Parameters:
      deleteQuotaShareRequest - A Consumer that will call methods on DeleteQuotaShareRequest.Builder to create a request.
      Returns:
      Result of the DeleteQuotaShare operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • deleteSchedulingPolicy

      default DeleteSchedulingPolicyResponse deleteSchedulingPolicy(DeleteSchedulingPolicyRequest deleteSchedulingPolicyRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Deletes the specified scheduling policy.

      You can't delete a scheduling policy that's used in any job queues.

      Parameters:
      deleteSchedulingPolicyRequest - Contains the parameters for DeleteSchedulingPolicy.
      Returns:
      Result of the DeleteSchedulingPolicy operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • deleteSchedulingPolicy

      default DeleteSchedulingPolicyResponse deleteSchedulingPolicy(Consumer<DeleteSchedulingPolicyRequest.Builder> deleteSchedulingPolicyRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Deletes the specified scheduling policy.

      You can't delete a scheduling policy that's used in any job queues.


      This is a convenience which creates an instance of the DeleteSchedulingPolicyRequest.Builder avoiding the need to create one manually via DeleteSchedulingPolicyRequest.builder()

      Parameters:
      deleteSchedulingPolicyRequest - A Consumer that will call methods on DeleteSchedulingPolicyRequest.Builder to create a request. Contains the parameters for DeleteSchedulingPolicy.
      Returns:
      Result of the DeleteSchedulingPolicy operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • deleteServiceEnvironment

      default DeleteServiceEnvironmentResponse deleteServiceEnvironment(DeleteServiceEnvironmentRequest deleteServiceEnvironmentRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Deletes a Service environment. Before you can delete a service environment, you must first set its state to DISABLED with the UpdateServiceEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation.

      Parameters:
      deleteServiceEnvironmentRequest -
      Returns:
      Result of the DeleteServiceEnvironment operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • deleteServiceEnvironment

      default DeleteServiceEnvironmentResponse deleteServiceEnvironment(Consumer<DeleteServiceEnvironmentRequest.Builder> deleteServiceEnvironmentRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Deletes a Service environment. Before you can delete a service environment, you must first set its state to DISABLED with the UpdateServiceEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation.


      This is a convenience which creates an instance of the DeleteServiceEnvironmentRequest.Builder avoiding the need to create one manually via DeleteServiceEnvironmentRequest.builder()

      Parameters:
      deleteServiceEnvironmentRequest - A Consumer that will call methods on DeleteServiceEnvironmentRequest.Builder to create a request.
      Returns:
      Result of the DeleteServiceEnvironment operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • deregisterJobDefinition

      default DeregisterJobDefinitionResponse deregisterJobDefinition(DeregisterJobDefinitionRequest deregisterJobDefinitionRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Deregisters an Batch job definition. Job definitions are permanently deleted after 180 days.

      Parameters:
      deregisterJobDefinitionRequest -
      Returns:
      Result of the DeregisterJobDefinition operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • deregisterJobDefinition

      default DeregisterJobDefinitionResponse deregisterJobDefinition(Consumer<DeregisterJobDefinitionRequest.Builder> deregisterJobDefinitionRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Deregisters an Batch job definition. Job definitions are permanently deleted after 180 days.


      This is a convenience which creates an instance of the DeregisterJobDefinitionRequest.Builder avoiding the need to create one manually via DeregisterJobDefinitionRequest.builder()

      Parameters:
      deregisterJobDefinitionRequest - A Consumer that will call methods on DeregisterJobDefinitionRequest.Builder to create a request.
      Returns:
      Result of the DeregisterJobDefinition operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeComputeEnvironments

      default DescribeComputeEnvironmentsResponse describeComputeEnvironments(DescribeComputeEnvironmentsRequest describeComputeEnvironmentsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Describes one or more of your compute environments.

      If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment operation to determine the ecsClusterArn that you launch your Amazon ECS container instances into.

      Parameters:
      describeComputeEnvironmentsRequest - Contains the parameters for DescribeComputeEnvironments.
      Returns:
      Result of the DescribeComputeEnvironments operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeComputeEnvironments

      default DescribeComputeEnvironmentsResponse describeComputeEnvironments(Consumer<DescribeComputeEnvironmentsRequest.Builder> describeComputeEnvironmentsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Describes one or more of your compute environments.

      If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment operation to determine 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()

      Parameters:
      describeComputeEnvironmentsRequest - A Consumer that will call methods on DescribeComputeEnvironmentsRequest.Builder to create a request. Contains the parameters for DescribeComputeEnvironments.
      Returns:
      Result of the DescribeComputeEnvironments operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeComputeEnvironments

      default 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.

      Returns:
      Result of the DescribeComputeEnvironments operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeComputeEnvironmentsPaginator

      default DescribeComputeEnvironmentsIterable describeComputeEnvironmentsPaginator() throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      This is a variant of describeComputeEnvironments(software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a 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.

      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeComputeEnvironmentsPaginator

      default DescribeComputeEnvironmentsIterable describeComputeEnvironmentsPaginator(DescribeComputeEnvironmentsRequest describeComputeEnvironmentsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      This is a variant of describeComputeEnvironments(software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a 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.

      Parameters:
      describeComputeEnvironmentsRequest - Contains the parameters for DescribeComputeEnvironments.
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeComputeEnvironmentsPaginator

      default DescribeComputeEnvironmentsIterable describeComputeEnvironmentsPaginator(Consumer<DescribeComputeEnvironmentsRequest.Builder> describeComputeEnvironmentsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      This is a variant of describeComputeEnvironments(software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a 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()

      Parameters:
      describeComputeEnvironmentsRequest - A Consumer that will call methods on DescribeComputeEnvironmentsRequest.Builder to create a request. Contains the parameters for DescribeComputeEnvironments.
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeConsumableResource

      default DescribeConsumableResourceResponse describeConsumableResource(DescribeConsumableResourceRequest describeConsumableResourceRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Returns a description of the specified consumable resource.

      Parameters:
      describeConsumableResourceRequest -
      Returns:
      Result of the DescribeConsumableResource operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeConsumableResource

      default DescribeConsumableResourceResponse describeConsumableResource(Consumer<DescribeConsumableResourceRequest.Builder> describeConsumableResourceRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Returns a description of the specified consumable resource.


      This is a convenience which creates an instance of the DescribeConsumableResourceRequest.Builder avoiding the need to create one manually via DescribeConsumableResourceRequest.builder()

      Parameters:
      describeConsumableResourceRequest - A Consumer that will call methods on DescribeConsumableResourceRequest.Builder to create a request.
      Returns:
      Result of the DescribeConsumableResource operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeJobDefinitions

      default DescribeJobDefinitionsResponse describeJobDefinitions(DescribeJobDefinitionsRequest describeJobDefinitionsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

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

      Parameters:
      describeJobDefinitionsRequest - Contains the parameters for DescribeJobDefinitions.
      Returns:
      Result of the DescribeJobDefinitions operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeJobDefinitions

      default DescribeJobDefinitionsResponse describeJobDefinitions(Consumer<DescribeJobDefinitionsRequest.Builder> describeJobDefinitionsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Describes a list of job definitions. You can specify a status (such 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()

      Parameters:
      describeJobDefinitionsRequest - A Consumer that will call methods on DescribeJobDefinitionsRequest.Builder to create a request. Contains the parameters for DescribeJobDefinitions.
      Returns:
      Result of the DescribeJobDefinitions operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeJobDefinitions

      default 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.

      Returns:
      Result of the DescribeJobDefinitions operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeJobDefinitionsPaginator

      default DescribeJobDefinitionsIterable describeJobDefinitionsPaginator() throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      This is a variant of describeJobDefinitions(software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a 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.

      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeJobDefinitionsPaginator

      default DescribeJobDefinitionsIterable describeJobDefinitionsPaginator(DescribeJobDefinitionsRequest describeJobDefinitionsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      This is a variant of describeJobDefinitions(software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a 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.

      Parameters:
      describeJobDefinitionsRequest - Contains the parameters for DescribeJobDefinitions.
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeJobDefinitionsPaginator

      default DescribeJobDefinitionsIterable describeJobDefinitionsPaginator(Consumer<DescribeJobDefinitionsRequest.Builder> describeJobDefinitionsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      This is a variant of describeJobDefinitions(software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a 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()

      Parameters:
      describeJobDefinitionsRequest - A Consumer that will call methods on DescribeJobDefinitionsRequest.Builder to create a request. Contains the parameters for DescribeJobDefinitions.
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeJobQueues

      default DescribeJobQueuesResponse describeJobQueues(DescribeJobQueuesRequest describeJobQueuesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Describes one or more of your job queues.

      Parameters:
      describeJobQueuesRequest - Contains the parameters for DescribeJobQueues.
      Returns:
      Result of the DescribeJobQueues operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeJobQueues

      default DescribeJobQueuesResponse describeJobQueues(Consumer<DescribeJobQueuesRequest.Builder> describeJobQueuesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Describes one or more of your job queues.


      This is a convenience which creates an instance of the DescribeJobQueuesRequest.Builder avoiding the need to create one manually via DescribeJobQueuesRequest.builder()

      Parameters:
      describeJobQueuesRequest - A Consumer that will call methods on DescribeJobQueuesRequest.Builder to create a request. Contains the parameters for DescribeJobQueues.
      Returns:
      Result of the DescribeJobQueues operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeJobQueues

      default DescribeJobQueuesResponse describeJobQueues() throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Describes one or more of your job queues.

      Returns:
      Result of the DescribeJobQueues operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeJobQueuesPaginator

      default DescribeJobQueuesIterable describeJobQueuesPaginator() throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      This is a variant of describeJobQueues(software.amazon.awssdk.services.batch.model.DescribeJobQueuesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a 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.

      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeJobQueuesPaginator

      default DescribeJobQueuesIterable describeJobQueuesPaginator(DescribeJobQueuesRequest describeJobQueuesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      This is a variant of describeJobQueues(software.amazon.awssdk.services.batch.model.DescribeJobQueuesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a 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.

      Parameters:
      describeJobQueuesRequest - Contains the parameters for DescribeJobQueues.
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeJobQueuesPaginator

      default DescribeJobQueuesIterable describeJobQueuesPaginator(Consumer<DescribeJobQueuesRequest.Builder> describeJobQueuesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      This is a variant of describeJobQueues(software.amazon.awssdk.services.batch.model.DescribeJobQueuesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a 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()

      Parameters:
      describeJobQueuesRequest - A Consumer that will call methods on DescribeJobQueuesRequest.Builder to create a request. Contains the parameters for DescribeJobQueues.
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeJobs

      default DescribeJobsResponse describeJobs(DescribeJobsRequest describeJobsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Describes a list of Batch jobs.

      Parameters:
      describeJobsRequest - Contains the parameters for DescribeJobs.
      Returns:
      Result of the DescribeJobs operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeJobs

      default DescribeJobsResponse describeJobs(Consumer<DescribeJobsRequest.Builder> describeJobsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Describes a list of Batch jobs.


      This is a convenience which creates an instance of the DescribeJobsRequest.Builder avoiding the need to create one manually via DescribeJobsRequest.builder()

      Parameters:
      describeJobsRequest - A Consumer that will call methods on DescribeJobsRequest.Builder to create a request. Contains the parameters for DescribeJobs.
      Returns:
      Result of the DescribeJobs operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeQuotaShare

      default DescribeQuotaShareResponse describeQuotaShare(DescribeQuotaShareRequest describeQuotaShareRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Returns a description of the specified quota share.

      Parameters:
      describeQuotaShareRequest -
      Returns:
      Result of the DescribeQuotaShare operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeQuotaShare

      default DescribeQuotaShareResponse describeQuotaShare(Consumer<DescribeQuotaShareRequest.Builder> describeQuotaShareRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Returns a description of the specified quota share.


      This is a convenience which creates an instance of the DescribeQuotaShareRequest.Builder avoiding the need to create one manually via DescribeQuotaShareRequest.builder()

      Parameters:
      describeQuotaShareRequest - A Consumer that will call methods on DescribeQuotaShareRequest.Builder to create a request.
      Returns:
      Result of the DescribeQuotaShare operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeSchedulingPolicies

      default DescribeSchedulingPoliciesResponse describeSchedulingPolicies(DescribeSchedulingPoliciesRequest describeSchedulingPoliciesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Describes one or more of your scheduling policies.

      Parameters:
      describeSchedulingPoliciesRequest - Contains the parameters for DescribeSchedulingPolicies.
      Returns:
      Result of the DescribeSchedulingPolicies operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeSchedulingPolicies

      default DescribeSchedulingPoliciesResponse describeSchedulingPolicies(Consumer<DescribeSchedulingPoliciesRequest.Builder> describeSchedulingPoliciesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Describes one or more of your scheduling policies.


      This is a convenience which creates an instance of the DescribeSchedulingPoliciesRequest.Builder avoiding the need to create one manually via DescribeSchedulingPoliciesRequest.builder()

      Parameters:
      describeSchedulingPoliciesRequest - A Consumer that will call methods on DescribeSchedulingPoliciesRequest.Builder to create a request. Contains the parameters for DescribeSchedulingPolicies.
      Returns:
      Result of the DescribeSchedulingPolicies operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeServiceEnvironments

      default DescribeServiceEnvironmentsResponse describeServiceEnvironments(DescribeServiceEnvironmentsRequest describeServiceEnvironmentsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Describes one or more of your service environments.

      Parameters:
      describeServiceEnvironmentsRequest -
      Returns:
      Result of the DescribeServiceEnvironments operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeServiceEnvironments

      default DescribeServiceEnvironmentsResponse describeServiceEnvironments(Consumer<DescribeServiceEnvironmentsRequest.Builder> describeServiceEnvironmentsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Describes one or more of your service environments.


      This is a convenience which creates an instance of the DescribeServiceEnvironmentsRequest.Builder avoiding the need to create one manually via DescribeServiceEnvironmentsRequest.builder()

      Parameters:
      describeServiceEnvironmentsRequest - A Consumer that will call methods on DescribeServiceEnvironmentsRequest.Builder to create a request.
      Returns:
      Result of the DescribeServiceEnvironments operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeServiceEnvironmentsPaginator

      default DescribeServiceEnvironmentsIterable describeServiceEnvironmentsPaginator(DescribeServiceEnvironmentsRequest describeServiceEnvironmentsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      This is a variant of describeServiceEnvironments(software.amazon.awssdk.services.batch.model.DescribeServiceEnvironmentsRequest) 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.DescribeServiceEnvironmentsIterable responses = client.describeServiceEnvironmentsPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.batch.paginators.DescribeServiceEnvironmentsIterable responses = client
             .describeServiceEnvironmentsPaginator(request);
     for (software.amazon.awssdk.services.batch.model.DescribeServiceEnvironmentsResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.batch.paginators.DescribeServiceEnvironmentsIterable responses = client.describeServiceEnvironmentsPaginator(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 describeServiceEnvironments(software.amazon.awssdk.services.batch.model.DescribeServiceEnvironmentsRequest) operation.

      Parameters:
      describeServiceEnvironmentsRequest -
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeServiceEnvironmentsPaginator

      default DescribeServiceEnvironmentsIterable describeServiceEnvironmentsPaginator(Consumer<DescribeServiceEnvironmentsRequest.Builder> describeServiceEnvironmentsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      This is a variant of describeServiceEnvironments(software.amazon.awssdk.services.batch.model.DescribeServiceEnvironmentsRequest) 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.DescribeServiceEnvironmentsIterable responses = client.describeServiceEnvironmentsPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.batch.paginators.DescribeServiceEnvironmentsIterable responses = client
             .describeServiceEnvironmentsPaginator(request);
     for (software.amazon.awssdk.services.batch.model.DescribeServiceEnvironmentsResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.batch.paginators.DescribeServiceEnvironmentsIterable responses = client.describeServiceEnvironmentsPaginator(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 describeServiceEnvironments(software.amazon.awssdk.services.batch.model.DescribeServiceEnvironmentsRequest) operation.


      This is a convenience which creates an instance of the DescribeServiceEnvironmentsRequest.Builder avoiding the need to create one manually via DescribeServiceEnvironmentsRequest.builder()

      Parameters:
      describeServiceEnvironmentsRequest - A Consumer that will call methods on DescribeServiceEnvironmentsRequest.Builder to create a request.
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeServiceJob

      default DescribeServiceJobResponse describeServiceJob(DescribeServiceJobRequest describeServiceJobRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      The details of a service job.

      Parameters:
      describeServiceJobRequest -
      Returns:
      Result of the DescribeServiceJob operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • describeServiceJob

      default DescribeServiceJobResponse describeServiceJob(Consumer<DescribeServiceJobRequest.Builder> describeServiceJobRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      The details of a service job.


      This is a convenience which creates an instance of the DescribeServiceJobRequest.Builder avoiding the need to create one manually via DescribeServiceJobRequest.builder()

      Parameters:
      describeServiceJobRequest - A Consumer that will call methods on DescribeServiceJobRequest.Builder to create a request.
      Returns:
      Result of the DescribeServiceJob operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • getJobQueueSnapshot

      default GetJobQueueSnapshotResponse getJobQueueSnapshot(GetJobQueueSnapshotRequest getJobQueueSnapshotRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Provides a snapshot of job queue state, including ordering of RUNNABLE jobs, as well as capacity utilization for already dispatched jobs. The first 100 RUNNABLE jobs in the job queue are listed in order of dispatch. For job queues with an attached quota-share policy, the first RUNNABLE job in each quota share is also listed. Capacity utilization for the job queue is provided, as well as break downs by share for job queues with attached fair-share or quota-share scheduling policies.

      Parameters:
      getJobQueueSnapshotRequest -
      Returns:
      Result of the GetJobQueueSnapshot operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • getJobQueueSnapshot

      default GetJobQueueSnapshotResponse getJobQueueSnapshot(Consumer<GetJobQueueSnapshotRequest.Builder> getJobQueueSnapshotRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Provides a snapshot of job queue state, including ordering of RUNNABLE jobs, as well as capacity utilization for already dispatched jobs. The first 100 RUNNABLE jobs in the job queue are listed in order of dispatch. For job queues with an attached quota-share policy, the first RUNNABLE job in each quota share is also listed. Capacity utilization for the job queue is provided, as well as break downs by share for job queues with attached fair-share or quota-share scheduling policies.


      This is a convenience which creates an instance of the GetJobQueueSnapshotRequest.Builder avoiding the need to create one manually via GetJobQueueSnapshotRequest.builder()

      Parameters:
      getJobQueueSnapshotRequest - A Consumer that will call methods on GetJobQueueSnapshotRequest.Builder to create a request.
      Returns:
      Result of the GetJobQueueSnapshot operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • listConsumableResources

      default ListConsumableResourcesResponse listConsumableResources(ListConsumableResourcesRequest listConsumableResourcesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Returns a list of Batch consumable resources.

      Parameters:
      listConsumableResourcesRequest -
      Returns:
      Result of the ListConsumableResources operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • listConsumableResources

      default ListConsumableResourcesResponse listConsumableResources(Consumer<ListConsumableResourcesRequest.Builder> listConsumableResourcesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Returns a list of Batch consumable resources.


      This is a convenience which creates an instance of the ListConsumableResourcesRequest.Builder avoiding the need to create one manually via ListConsumableResourcesRequest.builder()

      Parameters:
      listConsumableResourcesRequest - A Consumer that will call methods on ListConsumableResourcesRequest.Builder to create a request.
      Returns:
      Result of the ListConsumableResources operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • listConsumableResourcesPaginator

      default ListConsumableResourcesIterable listConsumableResourcesPaginator(ListConsumableResourcesRequest listConsumableResourcesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      This is a variant of listConsumableResources(software.amazon.awssdk.services.batch.model.ListConsumableResourcesRequest) 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.ListConsumableResourcesIterable responses = client.listConsumableResourcesPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.batch.paginators.ListConsumableResourcesIterable responses = client
             .listConsumableResourcesPaginator(request);
     for (software.amazon.awssdk.services.batch.model.ListConsumableResourcesResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.batch.paginators.ListConsumableResourcesIterable responses = client.listConsumableResourcesPaginator(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 listConsumableResources(software.amazon.awssdk.services.batch.model.ListConsumableResourcesRequest) operation.

      Parameters:
      listConsumableResourcesRequest -
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      Throws:
      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.
      AwsServiceException
      See Also:

    • listConsumableResourcesPaginator

      default ListConsumableResourcesIterable listConsumableResourcesPaginator(Consumer<ListConsumableResourcesRequest.Builder> listConsumableResourcesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      This is a variant of listConsumableResources(software.amazon.awssdk.services.batch.model.ListConsumableResourcesRequest) 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.ListConsumableResourcesIterable responses = client.listConsumableResourcesPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.batch.paginators.ListConsumableResourcesIterable responses = client
             .listConsumableResourcesPaginator(request);
     for (software.amazon.awssdk.services.batch.model.ListConsumableResourcesResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.batch.paginators.ListConsumableResourcesIterable responses = client.listConsumableResourcesPaginator(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 listConsumableResources(software.amazon.awssdk.services.batch.model.ListConsumableResourcesRequest) operation.


      This is a convenience which creates an instance of the ListConsumableResourcesRequest.Builder avoiding the need to create one manually via ListConsumableResourcesRequest.builder()

      Parameters:
      listConsumableResourcesRequest - A Consumer that will call methods on ListConsumableResourcesRequest.Builder to create a request.
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      Throws:
      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.
      AwsServiceException
      See Also:

    • listJobs

      default ListJobsResponse listJobs(ListJobsRequest listJobsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Returns a list of Batch jobs.

      You must specify only one of the following items:

      • A job queue ID to return a list of jobs in that job queue

      • A multi-node parallel job ID to return a list of nodes for that job

      • An array job ID to return a list of the children for that job

      Parameters:
      listJobsRequest - Contains the parameters for ListJobs.
      Returns:
      Result of the ListJobs operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • listJobs

      default ListJobsResponse listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Returns a list of Batch jobs.

      You must specify only one of the following items:

      • A job queue ID to return a list of jobs in that job queue

      • A multi-node parallel job ID to return a list of nodes for that job

      • An array job ID to return a list of the children for that job


      This is a convenience which creates an instance of the ListJobsRequest.Builder avoiding the need to create one manually via ListJobsRequest.builder()

      Parameters:
      listJobsRequest - A Consumer that will call methods on ListJobsRequest.Builder to create a request. Contains the parameters for ListJobs.
      Returns:
      Result of the ListJobs operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • listJobsPaginator

      default ListJobsIterable listJobsPaginator(ListJobsRequest listJobsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      This is a variant of listJobs(software.amazon.awssdk.services.batch.model.ListJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a 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.

      Parameters:
      listJobsRequest - Contains the parameters for ListJobs.
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      Throws:
      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.
      AwsServiceException
      See Also:

    • listJobsPaginator

      default ListJobsIterable listJobsPaginator(Consumer<ListJobsRequest.Builder> listJobsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      This is a variant of listJobs(software.amazon.awssdk.services.batch.model.ListJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a 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()

      Parameters:
      listJobsRequest - A Consumer that will call methods on ListJobsRequest.Builder to create a request. Contains the parameters for ListJobs.
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      Throws:
      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.
      AwsServiceException
      See Also:

    • listJobsByConsumableResource

      default ListJobsByConsumableResourceResponse listJobsByConsumableResource(ListJobsByConsumableResourceRequest listJobsByConsumableResourceRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Returns a list of Batch jobs that require a specific consumable resource.

      Parameters:
      listJobsByConsumableResourceRequest -
      Returns:
      Result of the ListJobsByConsumableResource operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • listJobsByConsumableResource

      default ListJobsByConsumableResourceResponse listJobsByConsumableResource(Consumer<ListJobsByConsumableResourceRequest.Builder> listJobsByConsumableResourceRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Returns a list of Batch jobs that require a specific consumable resource.


      This is a convenience which creates an instance of the ListJobsByConsumableResourceRequest.Builder avoiding the need to create one manually via ListJobsByConsumableResourceRequest.builder()

      Parameters:
      listJobsByConsumableResourceRequest - A Consumer that will call methods on ListJobsByConsumableResourceRequest.Builder to create a request.
      Returns:
      Result of the ListJobsByConsumableResource operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • listJobsByConsumableResourcePaginator

      default ListJobsByConsumableResourceIterable listJobsByConsumableResourcePaginator(ListJobsByConsumableResourceRequest listJobsByConsumableResourceRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      This is a variant of listJobsByConsumableResource(software.amazon.awssdk.services.batch.model.ListJobsByConsumableResourceRequest) 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.ListJobsByConsumableResourceIterable responses = client.listJobsByConsumableResourcePaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.batch.paginators.ListJobsByConsumableResourceIterable responses = client
             .listJobsByConsumableResourcePaginator(request);
     for (software.amazon.awssdk.services.batch.model.ListJobsByConsumableResourceResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.batch.paginators.ListJobsByConsumableResourceIterable responses = client.listJobsByConsumableResourcePaginator(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 listJobsByConsumableResource(software.amazon.awssdk.services.batch.model.ListJobsByConsumableResourceRequest) operation.

      Parameters:
      listJobsByConsumableResourceRequest -
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      Throws:
      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.
      AwsServiceException
      See Also:

    • listJobsByConsumableResourcePaginator

      default ListJobsByConsumableResourceIterable listJobsByConsumableResourcePaginator(Consumer<ListJobsByConsumableResourceRequest.Builder> listJobsByConsumableResourceRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      This is a variant of listJobsByConsumableResource(software.amazon.awssdk.services.batch.model.ListJobsByConsumableResourceRequest) 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.ListJobsByConsumableResourceIterable responses = client.listJobsByConsumableResourcePaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.batch.paginators.ListJobsByConsumableResourceIterable responses = client
             .listJobsByConsumableResourcePaginator(request);
     for (software.amazon.awssdk.services.batch.model.ListJobsByConsumableResourceResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.batch.paginators.ListJobsByConsumableResourceIterable responses = client.listJobsByConsumableResourcePaginator(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 listJobsByConsumableResource(software.amazon.awssdk.services.batch.model.ListJobsByConsumableResourceRequest) operation.


      This is a convenience which creates an instance of the ListJobsByConsumableResourceRequest.Builder avoiding the need to create one manually via ListJobsByConsumableResourceRequest.builder()

      Parameters:
      listJobsByConsumableResourceRequest - A Consumer that will call methods on ListJobsByConsumableResourceRequest.Builder to create a request.
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      Throws:
      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.
      AwsServiceException
      See Also:

    • listQuotaShares

      default ListQuotaSharesResponse listQuotaShares(ListQuotaSharesRequest listQuotaSharesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Returns a list of Batch quota shares associated with a job queue.

      Parameters:
      listQuotaSharesRequest -
      Returns:
      Result of the ListQuotaShares operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • listQuotaShares

      default ListQuotaSharesResponse listQuotaShares(Consumer<ListQuotaSharesRequest.Builder> listQuotaSharesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Returns a list of Batch quota shares associated with a job queue.


      This is a convenience which creates an instance of the ListQuotaSharesRequest.Builder avoiding the need to create one manually via ListQuotaSharesRequest.builder()

      Parameters:
      listQuotaSharesRequest - A Consumer that will call methods on ListQuotaSharesRequest.Builder to create a request.
      Returns:
      Result of the ListQuotaShares operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • listQuotaSharesPaginator

      default ListQuotaSharesIterable listQuotaSharesPaginator(ListQuotaSharesRequest listQuotaSharesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      This is a variant of listQuotaShares(software.amazon.awssdk.services.batch.model.ListQuotaSharesRequest) 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.ListQuotaSharesIterable responses = client.listQuotaSharesPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.batch.paginators.ListQuotaSharesIterable responses = client.listQuotaSharesPaginator(request);
     for (software.amazon.awssdk.services.batch.model.ListQuotaSharesResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.batch.paginators.ListQuotaSharesIterable responses = client.listQuotaSharesPaginator(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 listQuotaShares(software.amazon.awssdk.services.batch.model.ListQuotaSharesRequest) operation.

      Parameters:
      listQuotaSharesRequest -
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      Throws:
      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.
      AwsServiceException
      See Also:

    • listQuotaSharesPaginator

      default ListQuotaSharesIterable listQuotaSharesPaginator(Consumer<ListQuotaSharesRequest.Builder> listQuotaSharesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      This is a variant of listQuotaShares(software.amazon.awssdk.services.batch.model.ListQuotaSharesRequest) 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.ListQuotaSharesIterable responses = client.listQuotaSharesPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.batch.paginators.ListQuotaSharesIterable responses = client.listQuotaSharesPaginator(request);
     for (software.amazon.awssdk.services.batch.model.ListQuotaSharesResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.batch.paginators.ListQuotaSharesIterable responses = client.listQuotaSharesPaginator(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 listQuotaShares(software.amazon.awssdk.services.batch.model.ListQuotaSharesRequest) operation.


      This is a convenience which creates an instance of the ListQuotaSharesRequest.Builder avoiding the need to create one manually via ListQuotaSharesRequest.builder()

      Parameters:
      listQuotaSharesRequest - A Consumer that will call methods on ListQuotaSharesRequest.Builder to create a request.
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      Throws:
      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.
      AwsServiceException
      See Also:

    • listSchedulingPolicies

      default ListSchedulingPoliciesResponse listSchedulingPolicies(ListSchedulingPoliciesRequest listSchedulingPoliciesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Returns a list of Batch scheduling policies.

      Parameters:
      listSchedulingPoliciesRequest - Contains the parameters for ListSchedulingPolicies.
      Returns:
      Result of the ListSchedulingPolicies operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • listSchedulingPolicies

      default ListSchedulingPoliciesResponse listSchedulingPolicies(Consumer<ListSchedulingPoliciesRequest.Builder> listSchedulingPoliciesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Returns a list of Batch scheduling policies.


      This is a convenience which creates an instance of the ListSchedulingPoliciesRequest.Builder avoiding the need to create one manually via ListSchedulingPoliciesRequest.builder()

      Parameters:
      listSchedulingPoliciesRequest - A Consumer that will call methods on ListSchedulingPoliciesRequest.Builder to create a request. Contains the parameters for ListSchedulingPolicies.
      Returns:
      Result of the ListSchedulingPolicies operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • listSchedulingPoliciesPaginator

      default ListSchedulingPoliciesIterable listSchedulingPoliciesPaginator(ListSchedulingPoliciesRequest listSchedulingPoliciesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      This is a variant of listSchedulingPolicies(software.amazon.awssdk.services.batch.model.ListSchedulingPoliciesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a 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.

      Parameters:
      listSchedulingPoliciesRequest - Contains the parameters for ListSchedulingPolicies.
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      Throws:
      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.
      AwsServiceException
      See Also:

    • listSchedulingPoliciesPaginator

      default ListSchedulingPoliciesIterable listSchedulingPoliciesPaginator(Consumer<ListSchedulingPoliciesRequest.Builder> listSchedulingPoliciesRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      This is a variant of listSchedulingPolicies(software.amazon.awssdk.services.batch.model.ListSchedulingPoliciesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a 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()

      Parameters:
      listSchedulingPoliciesRequest - A Consumer that will call methods on ListSchedulingPoliciesRequest.Builder to create a request. Contains the parameters for ListSchedulingPolicies.
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      Throws:
      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.
      AwsServiceException
      See Also:

    • listServiceJobs

      default ListServiceJobsResponse listServiceJobs(ListServiceJobsRequest listServiceJobsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Returns a list of service jobs for a specified job queue.

      Parameters:
      listServiceJobsRequest -
      Returns:
      Result of the ListServiceJobs operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • listServiceJobs

      default ListServiceJobsResponse listServiceJobs(Consumer<ListServiceJobsRequest.Builder> listServiceJobsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Returns a list of service jobs for a specified job queue.


      This is a convenience which creates an instance of the ListServiceJobsRequest.Builder avoiding the need to create one manually via ListServiceJobsRequest.builder()

      Parameters:
      listServiceJobsRequest - A Consumer that will call methods on ListServiceJobsRequest.Builder to create a request.
      Returns:
      Result of the ListServiceJobs operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • listServiceJobsPaginator

      default ListServiceJobsIterable listServiceJobsPaginator(ListServiceJobsRequest listServiceJobsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      This is a variant of listServiceJobs(software.amazon.awssdk.services.batch.model.ListServiceJobsRequest) 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.ListServiceJobsIterable responses = client.listServiceJobsPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.batch.paginators.ListServiceJobsIterable responses = client.listServiceJobsPaginator(request);
     for (software.amazon.awssdk.services.batch.model.ListServiceJobsResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.batch.paginators.ListServiceJobsIterable responses = client.listServiceJobsPaginator(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 listServiceJobs(software.amazon.awssdk.services.batch.model.ListServiceJobsRequest) operation.

      Parameters:
      listServiceJobsRequest -
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      Throws:
      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.
      AwsServiceException
      See Also:

    • listServiceJobsPaginator

      default ListServiceJobsIterable listServiceJobsPaginator(Consumer<ListServiceJobsRequest.Builder> listServiceJobsRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      This is a variant of listServiceJobs(software.amazon.awssdk.services.batch.model.ListServiceJobsRequest) 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.ListServiceJobsIterable responses = client.listServiceJobsPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.batch.paginators.ListServiceJobsIterable responses = client.listServiceJobsPaginator(request);
     for (software.amazon.awssdk.services.batch.model.ListServiceJobsResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.batch.paginators.ListServiceJobsIterable responses = client.listServiceJobsPaginator(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 listServiceJobs(software.amazon.awssdk.services.batch.model.ListServiceJobsRequest) operation.


      This is a convenience which creates an instance of the ListServiceJobsRequest.Builder avoiding the need to create one manually via ListServiceJobsRequest.builder()

      Parameters:
      listServiceJobsRequest - A Consumer that will call methods on ListServiceJobsRequest.Builder to create a request.
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      Throws:
      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.
      AwsServiceException
      See Also:

    • listTagsForResource

      default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Lists the tags for an Batch resource. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.

      Parameters:
      listTagsForResourceRequest - Contains the parameters for ListTagsForResource.
      Returns:
      Result of the ListTagsForResource operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • listTagsForResource

      default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Lists the tags for an Batch resource. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request. Contains the parameters for ListTagsForResource.
      Returns:
      Result of the ListTagsForResource operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • registerJobDefinition

      default RegisterJobDefinitionResponse registerJobDefinition(RegisterJobDefinitionRequest registerJobDefinitionRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Registers an Batch job definition.

      Parameters:
      registerJobDefinitionRequest - Contains the parameters for RegisterJobDefinition.
      Returns:
      Result of the RegisterJobDefinition operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • registerJobDefinition

      default RegisterJobDefinitionResponse registerJobDefinition(Consumer<RegisterJobDefinitionRequest.Builder> registerJobDefinitionRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Registers an Batch job definition.


      This is a convenience which creates an instance of the RegisterJobDefinitionRequest.Builder avoiding the need to create one manually via RegisterJobDefinitionRequest.builder()

      Parameters:
      registerJobDefinitionRequest - A Consumer that will call methods on RegisterJobDefinitionRequest.Builder to create a request. Contains the parameters for RegisterJobDefinition.
      Returns:
      Result of the RegisterJobDefinition operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • submitJob

      default SubmitJobResponse submitJob(SubmitJobRequest submitJobRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Submits an Batch job from a job definition. Parameters that are specified during SubmitJob override parameters defined in the job definition. vCPU and memory requirements that are specified in the resourceRequirements objects in the job definition are the exception. They can't be overridden this way using 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 share identifiers at a time.

      Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14 days, Fargate resources might become unavailable and job might be terminated.

      Parameters:
      submitJobRequest - Contains the parameters for SubmitJob.
      Returns:
      Result of the SubmitJob operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • submitJob

      default SubmitJobResponse submitJob(Consumer<SubmitJobRequest.Builder> submitJobRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Submits an Batch job from a job definition. Parameters that are specified during SubmitJob override parameters defined in the job definition. vCPU and memory requirements that are specified in the resourceRequirements objects in the job definition are the exception. They can't be overridden this way using 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 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()

      Parameters:
      submitJobRequest - A Consumer that will call methods on SubmitJobRequest.Builder to create a request. Contains the parameters for SubmitJob.
      Returns:
      Result of the SubmitJob operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • submitServiceJob

      default SubmitServiceJobResponse submitServiceJob(SubmitServiceJobRequest submitServiceJobRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Submits a service job to a specified job queue to run on SageMaker AI. A service job is a unit of work that you submit to Batch for execution on SageMaker AI.

      Parameters:
      submitServiceJobRequest -
      Returns:
      Result of the SubmitServiceJob operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • submitServiceJob

      default SubmitServiceJobResponse submitServiceJob(Consumer<SubmitServiceJobRequest.Builder> submitServiceJobRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Submits a service job to a specified job queue to run on SageMaker AI. A service job is a unit of work that you submit to Batch for execution on SageMaker AI.


      This is a convenience which creates an instance of the SubmitServiceJobRequest.Builder avoiding the need to create one manually via SubmitServiceJobRequest.builder()

      Parameters:
      submitServiceJobRequest - A Consumer that will call methods on SubmitServiceJobRequest.Builder to create a request.
      Returns:
      Result of the SubmitServiceJob operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • tagResource

      default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags that are associated with that resource are deleted as well. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.

      Parameters:
      tagResourceRequest - Contains the parameters for TagResource.
      Returns:
      Result of the TagResource operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • tagResource

      default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags that are associated with that resource are deleted as well. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.


      This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request. Contains the parameters for TagResource.
      Returns:
      Result of the TagResource operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • terminateJob

      default TerminateJobResponse terminateJob(TerminateJobRequest terminateJobRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

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

      Parameters:
      terminateJobRequest - Contains the parameters for TerminateJob.
      Returns:
      Result of the TerminateJob operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • terminateJob

      default TerminateJobResponse terminateJob(Consumer<TerminateJobRequest.Builder> terminateJobRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Terminates a job in a job queue. Jobs that are in the STARTING 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()

      Parameters:
      terminateJobRequest - A Consumer that will call methods on TerminateJobRequest.Builder to create a request. Contains the parameters for TerminateJob.
      Returns:
      Result of the TerminateJob operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • terminateServiceJob

      default TerminateServiceJobResponse terminateServiceJob(TerminateServiceJobRequest terminateServiceJobRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Terminates a service job in a job queue.

      Parameters:
      terminateServiceJobRequest -
      Returns:
      Result of the TerminateServiceJob operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • terminateServiceJob

      default TerminateServiceJobResponse terminateServiceJob(Consumer<TerminateServiceJobRequest.Builder> terminateServiceJobRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Terminates a service job in a job queue.


      This is a convenience which creates an instance of the TerminateServiceJobRequest.Builder avoiding the need to create one manually via TerminateServiceJobRequest.builder()

      Parameters:
      terminateServiceJobRequest - A Consumer that will call methods on TerminateServiceJobRequest.Builder to create a request.
      Returns:
      Result of the TerminateServiceJob operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • untagResource

      default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Deletes specified tags from an Batch resource.

      Parameters:
      untagResourceRequest - Contains the parameters for UntagResource.
      Returns:
      Result of the UntagResource operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • untagResource

      default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Deletes specified tags from an Batch resource.


      This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request. Contains the parameters for UntagResource.
      Returns:
      Result of the UntagResource operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • updateComputeEnvironment

      default UpdateComputeEnvironmentResponse updateComputeEnvironment(UpdateComputeEnvironmentRequest updateComputeEnvironmentRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Updates an Batch compute environment.

      Parameters:
      updateComputeEnvironmentRequest - Contains the parameters for UpdateComputeEnvironment.
      Returns:
      Result of the UpdateComputeEnvironment operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • updateComputeEnvironment

      default UpdateComputeEnvironmentResponse updateComputeEnvironment(Consumer<UpdateComputeEnvironmentRequest.Builder> updateComputeEnvironmentRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Updates an Batch compute environment.


      This is a convenience which creates an instance of the UpdateComputeEnvironmentRequest.Builder avoiding the need to create one manually via UpdateComputeEnvironmentRequest.builder()

      Parameters:
      updateComputeEnvironmentRequest - A Consumer that will call methods on UpdateComputeEnvironmentRequest.Builder to create a request. Contains the parameters for UpdateComputeEnvironment.
      Returns:
      Result of the UpdateComputeEnvironment operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • updateConsumableResource

      default UpdateConsumableResourceResponse updateConsumableResource(UpdateConsumableResourceRequest updateConsumableResourceRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Updates a consumable resource.

      Parameters:
      updateConsumableResourceRequest -
      Returns:
      Result of the UpdateConsumableResource operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • updateConsumableResource

      default UpdateConsumableResourceResponse updateConsumableResource(Consumer<UpdateConsumableResourceRequest.Builder> updateConsumableResourceRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Updates a consumable resource.


      This is a convenience which creates an instance of the UpdateConsumableResourceRequest.Builder avoiding the need to create one manually via UpdateConsumableResourceRequest.builder()

      Parameters:
      updateConsumableResourceRequest - A Consumer that will call methods on UpdateConsumableResourceRequest.Builder to create a request.
      Returns:
      Result of the UpdateConsumableResource operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • updateJobQueue

      default UpdateJobQueueResponse updateJobQueue(UpdateJobQueueRequest updateJobQueueRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Updates a job queue.

      Parameters:
      updateJobQueueRequest - Contains the parameters for UpdateJobQueue.
      Returns:
      Result of the UpdateJobQueue operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • updateJobQueue

      default UpdateJobQueueResponse updateJobQueue(Consumer<UpdateJobQueueRequest.Builder> updateJobQueueRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Updates a job queue.


      This is a convenience which creates an instance of the UpdateJobQueueRequest.Builder avoiding the need to create one manually via UpdateJobQueueRequest.builder()

      Parameters:
      updateJobQueueRequest - A Consumer that will call methods on UpdateJobQueueRequest.Builder to create a request. Contains the parameters for UpdateJobQueue.
      Returns:
      Result of the UpdateJobQueue operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • updateQuotaShare

      default UpdateQuotaShareResponse updateQuotaShare(UpdateQuotaShareRequest updateQuotaShareRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Updates a quota share.

      Parameters:
      updateQuotaShareRequest -
      Returns:
      Result of the UpdateQuotaShare operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • updateQuotaShare

      default UpdateQuotaShareResponse updateQuotaShare(Consumer<UpdateQuotaShareRequest.Builder> updateQuotaShareRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Updates a quota share.


      This is a convenience which creates an instance of the UpdateQuotaShareRequest.Builder avoiding the need to create one manually via UpdateQuotaShareRequest.builder()

      Parameters:
      updateQuotaShareRequest - A Consumer that will call methods on UpdateQuotaShareRequest.Builder to create a request.
      Returns:
      Result of the UpdateQuotaShare operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • updateSchedulingPolicy

      default UpdateSchedulingPolicyResponse updateSchedulingPolicy(UpdateSchedulingPolicyRequest updateSchedulingPolicyRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Updates a scheduling policy.

      Parameters:
      updateSchedulingPolicyRequest - Contains the parameters for UpdateSchedulingPolicy.
      Returns:
      Result of the UpdateSchedulingPolicy operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • updateSchedulingPolicy

      default UpdateSchedulingPolicyResponse updateSchedulingPolicy(Consumer<UpdateSchedulingPolicyRequest.Builder> updateSchedulingPolicyRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Updates a scheduling policy.


      This is a convenience which creates an instance of the UpdateSchedulingPolicyRequest.Builder avoiding the need to create one manually via UpdateSchedulingPolicyRequest.builder()

      Parameters:
      updateSchedulingPolicyRequest - A Consumer that will call methods on UpdateSchedulingPolicyRequest.Builder to create a request. Contains the parameters for UpdateSchedulingPolicy.
      Returns:
      Result of the UpdateSchedulingPolicy operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • updateServiceEnvironment

      default UpdateServiceEnvironmentResponse updateServiceEnvironment(UpdateServiceEnvironmentRequest updateServiceEnvironmentRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Updates a service environment. You can update the state of a service environment from ENABLED to DISABLED to prevent new service jobs from being placed in the service environment.

      Parameters:
      updateServiceEnvironmentRequest -
      Returns:
      Result of the UpdateServiceEnvironment operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • updateServiceEnvironment

      default UpdateServiceEnvironmentResponse updateServiceEnvironment(Consumer<UpdateServiceEnvironmentRequest.Builder> updateServiceEnvironmentRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Updates a service environment. You can update the state of a service environment from ENABLED to DISABLED to prevent new service jobs from being placed in the service environment.


      This is a convenience which creates an instance of the UpdateServiceEnvironmentRequest.Builder avoiding the need to create one manually via UpdateServiceEnvironmentRequest.builder()

      Parameters:
      updateServiceEnvironmentRequest - A Consumer that will call methods on UpdateServiceEnvironmentRequest.Builder to create a request.
      Returns:
      Result of the UpdateServiceEnvironment operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • updateServiceJob

      default UpdateServiceJobResponse updateServiceJob(UpdateServiceJobRequest updateServiceJobRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Updates the priority of a specified service job in an Batch job queue.

      Parameters:
      updateServiceJobRequest -
      Returns:
      Result of the UpdateServiceJob operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • updateServiceJob

      default UpdateServiceJobResponse updateServiceJob(Consumer<UpdateServiceJobRequest.Builder> updateServiceJobRequest) throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException

      Updates the priority of a specified service job in an Batch job queue.


      This is a convenience which creates an instance of the UpdateServiceJobRequest.Builder avoiding the need to create one manually via UpdateServiceJobRequest.builder()

      Parameters:
      updateServiceJobRequest - A Consumer that will call methods on UpdateServiceJobRequest.Builder to create a request.
      Returns:
      Result of the UpdateServiceJob operation returned by the service.
      Throws:
      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.
      AwsServiceException
      See Also:

    • create

      static BatchClient create()
      Create a BatchClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static BatchClientBuilder builder()
      Create a builder that can be used to configure and create a BatchClient.

    • serviceMetadata

      static ServiceMetadata serviceMetadata()

    • serviceClientConfiguration

      default BatchServiceClientConfiguration serviceClientConfiguration()
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient