Package software.amazon.awssdk.services.batch

Interface BatchClient

  • All Superinterfaces:
    AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
    @Generated("software.amazon.awssdk:codegen")
@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.

    • Method Detail

      • 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:
        AWS API Documentation

      • 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:
        AWS API Documentation

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

        Multi-node parallel jobs aren't supported on Spot Instances.

        In an unmanaged compute environment, you can manage your own EC2 compute resources and have flexibility with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the Amazon Elastic Container Service Developer Guide.

        To create a compute environment that uses EKS resources, the caller must have permissions to call eks:DescribeCluster.

        Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it also doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is available. You're responsible for the management of the guest operating system. This includes any updates and security patches. You're also responsible for any additional application software or utilities that you install on the compute resources. There are two ways to use a new AMI for your Batch jobs. The original method is to complete these steps:

        1. Create a new compute environment with the new AMI.

        2. Add the compute environment to an existing job queue.

        3. Remove the earlier compute environment from your job queue.

        4. Delete the earlier compute environment.

        In April 2022, Batch added enhanced support for updating compute environments. For more information, see Updating compute environments. To use the enhanced updating of compute environments to update AMIs, follow these rules:

        • Either don't set the service role (serviceRole) parameter or set it to the AWSBatchServiceRole service-linked role.

        • Set the allocation strategy (allocationStrategy) parameter to BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED, or SPOT_PRICE_CAPACITY_OPTIMIZED.

        • Set the update to latest image version (updateToLatestImageVersion) parameter to true. The updateToLatestImageVersion parameter is used when you update a compute environment. This parameter is ignored when you create a compute environment.

        • Don't specify an AMI ID in imageId, imageIdOverride (in ec2Configuration ), or in the launch template (launchTemplate). In that case, Batch selects the latest Amazon ECS optimized AMI that's supported by Batch at the time the infrastructure update is initiated. Alternatively, you can specify the AMI ID in the imageId or imageIdOverride parameters, or the launch template identified by the LaunchTemplate properties. Changing any of these properties starts an infrastructure update. If the AMI ID is specified in the launch template, it can't be replaced by specifying an AMI ID in either the imageId or imageIdOverride parameters. It can only be replaced by specifying a different launch template, or if the launch template version is set to $Default or $Latest, by setting either a new default version for the launch template (if $Default) or by adding a new version to the launch template (if $Latest).

        If these rules are followed, any update that starts an infrastructure update causes the AMI ID to be re-selected. If the version setting in the launch template (launchTemplate) is set to $Latest or $Default, the latest or default version of the launch template is evaluated up at the time of the infrastructure update, even if the launchTemplate wasn't updated.

        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:
        AWS API Documentation

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

        Multi-node parallel jobs aren't supported on Spot Instances.

        In an unmanaged compute environment, you can manage your own EC2 compute resources and have flexibility with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the Amazon Elastic Container Service Developer Guide.

        To create a compute environment that uses EKS resources, the caller must have permissions to call eks:DescribeCluster.

        Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it also doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is available. You're responsible for the management of the guest operating system. This includes any updates and security patches. You're also responsible for any additional application software or utilities that you install on the compute resources. There are two ways to use a new AMI for your Batch jobs. The original method is to complete these steps:

        1. Create a new compute environment with the new AMI.

        2. Add the compute environment to an existing job queue.

        3. Remove the earlier compute environment from your job queue.

        4. Delete the earlier compute environment.

        In April 2022, Batch added enhanced support for updating compute environments. For more information, see Updating compute environments. To use the enhanced updating of compute environments to update AMIs, follow these rules:

        • Either don't set the service role (serviceRole) parameter or set it to the AWSBatchServiceRole service-linked role.

        • Set the allocation strategy (allocationStrategy) parameter to BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED, or SPOT_PRICE_CAPACITY_OPTIMIZED.

        • Set the update to latest image version (updateToLatestImageVersion) parameter to true. The updateToLatestImageVersion parameter is used when you update a compute environment. This parameter is ignored when you create a compute environment.

        • Don't specify an AMI ID in imageId, imageIdOverride (in ec2Configuration ), or in the launch template (launchTemplate). In that case, Batch selects the latest Amazon ECS optimized AMI that's supported by Batch at the time the infrastructure update is initiated. Alternatively, you can specify the AMI ID in the imageId or imageIdOverride parameters, or the launch template identified by the LaunchTemplate properties. Changing any of these properties starts an infrastructure update. If the AMI ID is specified in the launch template, it can't be replaced by specifying an AMI ID in either the imageId or imageIdOverride parameters. It can only be replaced by specifying a different launch template, or if the launch template version is set to $Default or $Latest, by setting either a new default version for the launch template (if $Default) or by adding a new version to the launch template (if $Latest).

        If these rules are followed, any update that starts an infrastructure update causes the AMI ID to be re-selected. If the version setting in the launch template (launchTemplate) is set to $Latest or $Default, the latest or default version of the launch template is evaluated up at the time of the infrastructure update, even if the launchTemplate wasn't updated.


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

        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:
        AWS API Documentation

      • 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:
        AWS API Documentation

      • 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:
        AWS API Documentation

      • 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:
        AWS API Documentation

      • 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:
        AWS API Documentation

      • deleteJobQueue

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

        Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are eventually terminated when you delete a job queue. The jobs are terminated at a rate of about 16 jobs each second.

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

        Parameters:
        deleteJobQueueRequest - Contains the parameters 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:
        AWS API Documentation

      • 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:
        AWS API Documentation

      • 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:
        AWS API Documentation

      • 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:
        AWS API Documentation

      • 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(DescribeComputeEnvironmentsRequest), AWS API Documentation

      • 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:
        AWS API Documentation

      • 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:
        AWS API Documentation

      • 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:
        AWS API Documentation

      • 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(DescribeJobDefinitionsRequest), AWS API Documentation

      • 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:
        AWS API Documentation

      • 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:
        AWS API Documentation

      • 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:
        AWS API Documentation

      • 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(DescribeJobQueuesRequest), AWS API Documentation

      • 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:
        AWS API Documentation

      • 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:
        AWS API Documentation

      • 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:
        AWS API Documentation

      • 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:
        AWS API Documentation

      • getJobQueueSnapshot

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

        Provides a list of the first 100 RUNNABLE jobs associated to a single job queue.

        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:
        AWS API Documentation

      • listJobs

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

        Returns a list of Batch jobs.

        You must specify only one of the following items:

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

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

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

        You can filter the results by job status with the jobStatus parameter. If you don't specify a status, only RUNNING jobs are returned.

        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:
        AWS API Documentation

      • listJobs

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

        Returns a list of Batch jobs.

        You must specify only one of the following items:

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

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

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

        You can filter the results by job status with the jobStatus parameter. If you don't specify a status, only RUNNING jobs are returned.


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

        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:
        AWS API Documentation

      • 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:
        AWS API Documentation

      • 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:
        AWS API Documentation

      • 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:
        AWS API Documentation

      • 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:
        AWS API Documentation

      • 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:
        AWS API Documentation

      • 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:
        AWS API Documentation

      • 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:
        AWS API Documentation

      • 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 fair share identifiers at a time.

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

        Parameters:
        submitJobRequest - Contains the parameters 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:
        AWS API Documentation

      • 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 fair share identifiers at a time.

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


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

        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:
        AWS API Documentation

      • 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:
        AWS API Documentation

      • 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:
        AWS API Documentation

      • 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:
        AWS API Documentation

      • 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:
        AWS API Documentation

      • 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:
        AWS API Documentation

      • 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:
        AWS API Documentation

      • 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:
        AWS API Documentation