software.amazon.awssdk.services.batch.DefaultBatchClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of batch Show documentation
Show all versions of batch Show documentation
The AWS Java SDK for AWS Batch module holds the client classes that are used for communicating with AWS
Batch.
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.batch;
import java.util.Collections;
import java.util.List;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkInternalApi;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.awscore.client.handler.AwsSyncClientHandler;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.ApiName;
import software.amazon.awssdk.core.RequestOverrideConfiguration;
import software.amazon.awssdk.core.client.config.SdkClientConfiguration;
import software.amazon.awssdk.core.client.config.SdkClientOption;
import software.amazon.awssdk.core.client.handler.ClientExecutionParams;
import software.amazon.awssdk.core.client.handler.SyncClientHandler;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.core.http.HttpResponseHandler;
import software.amazon.awssdk.core.metrics.CoreMetric;
import software.amazon.awssdk.core.util.VersionInfo;
import software.amazon.awssdk.metrics.MetricCollector;
import software.amazon.awssdk.metrics.MetricPublisher;
import software.amazon.awssdk.metrics.NoOpMetricCollector;
import software.amazon.awssdk.protocols.core.ExceptionMetadata;
import software.amazon.awssdk.protocols.json.AwsJsonProtocol;
import software.amazon.awssdk.protocols.json.AwsJsonProtocolFactory;
import software.amazon.awssdk.protocols.json.BaseAwsJsonProtocolFactory;
import software.amazon.awssdk.protocols.json.JsonOperationMetadata;
import software.amazon.awssdk.services.batch.model.BatchException;
import software.amazon.awssdk.services.batch.model.BatchRequest;
import software.amazon.awssdk.services.batch.model.CancelJobRequest;
import software.amazon.awssdk.services.batch.model.CancelJobResponse;
import software.amazon.awssdk.services.batch.model.ClientException;
import software.amazon.awssdk.services.batch.model.CreateComputeEnvironmentRequest;
import software.amazon.awssdk.services.batch.model.CreateComputeEnvironmentResponse;
import software.amazon.awssdk.services.batch.model.CreateJobQueueRequest;
import software.amazon.awssdk.services.batch.model.CreateJobQueueResponse;
import software.amazon.awssdk.services.batch.model.CreateSchedulingPolicyRequest;
import software.amazon.awssdk.services.batch.model.CreateSchedulingPolicyResponse;
import software.amazon.awssdk.services.batch.model.DeleteComputeEnvironmentRequest;
import software.amazon.awssdk.services.batch.model.DeleteComputeEnvironmentResponse;
import software.amazon.awssdk.services.batch.model.DeleteJobQueueRequest;
import software.amazon.awssdk.services.batch.model.DeleteJobQueueResponse;
import software.amazon.awssdk.services.batch.model.DeleteSchedulingPolicyRequest;
import software.amazon.awssdk.services.batch.model.DeleteSchedulingPolicyResponse;
import software.amazon.awssdk.services.batch.model.DeregisterJobDefinitionRequest;
import software.amazon.awssdk.services.batch.model.DeregisterJobDefinitionResponse;
import software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsRequest;
import software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsResponse;
import software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsRequest;
import software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsResponse;
import software.amazon.awssdk.services.batch.model.DescribeJobQueuesRequest;
import software.amazon.awssdk.services.batch.model.DescribeJobQueuesResponse;
import software.amazon.awssdk.services.batch.model.DescribeJobsRequest;
import software.amazon.awssdk.services.batch.model.DescribeJobsResponse;
import software.amazon.awssdk.services.batch.model.DescribeSchedulingPoliciesRequest;
import software.amazon.awssdk.services.batch.model.DescribeSchedulingPoliciesResponse;
import software.amazon.awssdk.services.batch.model.ListJobsRequest;
import software.amazon.awssdk.services.batch.model.ListJobsResponse;
import software.amazon.awssdk.services.batch.model.ListSchedulingPoliciesRequest;
import software.amazon.awssdk.services.batch.model.ListSchedulingPoliciesResponse;
import software.amazon.awssdk.services.batch.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.batch.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.batch.model.RegisterJobDefinitionRequest;
import software.amazon.awssdk.services.batch.model.RegisterJobDefinitionResponse;
import software.amazon.awssdk.services.batch.model.ServerException;
import software.amazon.awssdk.services.batch.model.SubmitJobRequest;
import software.amazon.awssdk.services.batch.model.SubmitJobResponse;
import software.amazon.awssdk.services.batch.model.TagResourceRequest;
import software.amazon.awssdk.services.batch.model.TagResourceResponse;
import software.amazon.awssdk.services.batch.model.TerminateJobRequest;
import software.amazon.awssdk.services.batch.model.TerminateJobResponse;
import software.amazon.awssdk.services.batch.model.UntagResourceRequest;
import software.amazon.awssdk.services.batch.model.UntagResourceResponse;
import software.amazon.awssdk.services.batch.model.UpdateComputeEnvironmentRequest;
import software.amazon.awssdk.services.batch.model.UpdateComputeEnvironmentResponse;
import software.amazon.awssdk.services.batch.model.UpdateJobQueueRequest;
import software.amazon.awssdk.services.batch.model.UpdateJobQueueResponse;
import software.amazon.awssdk.services.batch.model.UpdateSchedulingPolicyRequest;
import software.amazon.awssdk.services.batch.model.UpdateSchedulingPolicyResponse;
import software.amazon.awssdk.services.batch.paginators.DescribeComputeEnvironmentsIterable;
import software.amazon.awssdk.services.batch.paginators.DescribeJobDefinitionsIterable;
import software.amazon.awssdk.services.batch.paginators.DescribeJobQueuesIterable;
import software.amazon.awssdk.services.batch.paginators.ListJobsIterable;
import software.amazon.awssdk.services.batch.paginators.ListSchedulingPoliciesIterable;
import software.amazon.awssdk.services.batch.transform.CancelJobRequestMarshaller;
import software.amazon.awssdk.services.batch.transform.CreateComputeEnvironmentRequestMarshaller;
import software.amazon.awssdk.services.batch.transform.CreateJobQueueRequestMarshaller;
import software.amazon.awssdk.services.batch.transform.CreateSchedulingPolicyRequestMarshaller;
import software.amazon.awssdk.services.batch.transform.DeleteComputeEnvironmentRequestMarshaller;
import software.amazon.awssdk.services.batch.transform.DeleteJobQueueRequestMarshaller;
import software.amazon.awssdk.services.batch.transform.DeleteSchedulingPolicyRequestMarshaller;
import software.amazon.awssdk.services.batch.transform.DeregisterJobDefinitionRequestMarshaller;
import software.amazon.awssdk.services.batch.transform.DescribeComputeEnvironmentsRequestMarshaller;
import software.amazon.awssdk.services.batch.transform.DescribeJobDefinitionsRequestMarshaller;
import software.amazon.awssdk.services.batch.transform.DescribeJobQueuesRequestMarshaller;
import software.amazon.awssdk.services.batch.transform.DescribeJobsRequestMarshaller;
import software.amazon.awssdk.services.batch.transform.DescribeSchedulingPoliciesRequestMarshaller;
import software.amazon.awssdk.services.batch.transform.ListJobsRequestMarshaller;
import software.amazon.awssdk.services.batch.transform.ListSchedulingPoliciesRequestMarshaller;
import software.amazon.awssdk.services.batch.transform.ListTagsForResourceRequestMarshaller;
import software.amazon.awssdk.services.batch.transform.RegisterJobDefinitionRequestMarshaller;
import software.amazon.awssdk.services.batch.transform.SubmitJobRequestMarshaller;
import software.amazon.awssdk.services.batch.transform.TagResourceRequestMarshaller;
import software.amazon.awssdk.services.batch.transform.TerminateJobRequestMarshaller;
import software.amazon.awssdk.services.batch.transform.UntagResourceRequestMarshaller;
import software.amazon.awssdk.services.batch.transform.UpdateComputeEnvironmentRequestMarshaller;
import software.amazon.awssdk.services.batch.transform.UpdateJobQueueRequestMarshaller;
import software.amazon.awssdk.services.batch.transform.UpdateSchedulingPolicyRequestMarshaller;
import software.amazon.awssdk.utils.Logger;
/**
* Internal implementation of {@link BatchClient}.
*
* @see BatchClient#builder()
*/
@Generated("software.amazon.awssdk:codegen")
@SdkInternalApi
final class DefaultBatchClient implements BatchClient {
private static final Logger log = Logger.loggerFor(DefaultBatchClient.class);
private final SyncClientHandler clientHandler;
private final AwsJsonProtocolFactory protocolFactory;
private final SdkClientConfiguration clientConfiguration;
protected DefaultBatchClient(SdkClientConfiguration clientConfiguration) {
this.clientHandler = new AwsSyncClientHandler(clientConfiguration);
this.clientConfiguration = clientConfiguration;
this.protocolFactory = init(AwsJsonProtocolFactory.builder()).build();
}
@Override
public final String serviceName() {
return SERVICE_NAME;
}
/**
*
* Cancels a job in an Batch job queue. Jobs that are in the SUBMITTED, PENDING, or
* RUNNABLE state are canceled. Jobs that have progressed to STARTING or
* RUNNING aren't canceled, but the API operation still succeeds, even if no job is canceled. These
* jobs must be terminated with the TerminateJob operation.
*
*
* @param cancelJobRequest
* Contains the parameters for CancelJob.
* @return Result of the CancelJob operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.CancelJob
* @see AWS API
* Documentation
*/
@Override
public CancelJobResponse cancelJob(CancelJobRequest cancelJobRequest) throws ClientException, ServerException,
AwsServiceException, SdkClientException, BatchException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(operationMetadata,
CancelJobResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
List metricPublishers = resolveMetricPublishers(clientConfiguration, cancelJobRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Batch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "CancelJob");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("CancelJob").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(cancelJobRequest)
.withMetricCollector(apiCallMetricCollector).withMarshaller(new CancelJobRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* 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 a lot of flexibility
* with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify
* that each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container
* instance AMIs in the Amazon Elastic Container Service Developer Guide. After you created your
* unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon
* ECS cluster that's associated with it. Then, launch your container instances into that Amazon ECS cluster. For
* more information, see Launching an
* Amazon ECS container instance in the Amazon Elastic Container Service Developer Guide.
*
*
*
* Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it also
* doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is
* available. You're responsible for the management of the guest operating system. This includes any updates and
* security patches. You're also responsible for any additional application software or utilities that you install
* on the compute resources. There are two ways to use a new AMI for your Batch jobs. The original method is to
* complete these steps:
*
*
* -
*
* Create a new compute environment with the new AMI.
*
*
* -
*
* Add the compute environment to an existing job queue.
*
*
* -
*
* Remove the earlier compute environment from your job queue.
*
*
* -
*
* Delete the earlier compute environment.
*
*
*
*
* In April 2022, Batch added enhanced support for updating compute environments. For more information, see Updating compute
* environments. To use the enhanced updating of compute environments to update AMIs, follow these rules:
*
*
* -
*
* Either do not 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 or
* SPOT_CAPACITY_OPTIMIZED.
*
*
* -
*
* Set the update to latest image version (updateToLatestImageVersion) parameter to true.
*
*
* -
*
* Do not specify an AMI ID in imageId, imageIdOverride (in
* ec2Configuration ), or in the launch template (launchTemplate). In that case Batch
* will select the latest Amazon ECS optimized AMI 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 will trigger an infrastructure update. If the AMI ID is specified in the launch template, it can
* not 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 triggers an infrastructure update will cause 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 will be
* evaluated up at the time of the infrastructure update, even if the launchTemplate was not updated.
*
*
*
* @param createComputeEnvironmentRequest
* Contains the parameters for CreateComputeEnvironment.
* @return Result of the CreateComputeEnvironment operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.CreateComputeEnvironment
* @see AWS API Documentation
*/
@Override
public CreateComputeEnvironmentResponse createComputeEnvironment(
CreateComputeEnvironmentRequest createComputeEnvironmentRequest) throws ClientException, ServerException,
AwsServiceException, SdkClientException, BatchException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(
operationMetadata, CreateComputeEnvironmentResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
List metricPublishers = resolveMetricPublishers(clientConfiguration, createComputeEnvironmentRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Batch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "CreateComputeEnvironment");
return clientHandler
.execute(new ClientExecutionParams()
.withOperationName("CreateComputeEnvironment").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(createComputeEnvironmentRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new CreateComputeEnvironmentRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* 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.
*
*
* @param createJobQueueRequest
* Contains the parameters for CreateJobQueue.
* @return Result of the CreateJobQueue operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.CreateJobQueue
* @see AWS API
* Documentation
*/
@Override
public CreateJobQueueResponse createJobQueue(CreateJobQueueRequest createJobQueueRequest) throws ClientException,
ServerException, AwsServiceException, SdkClientException, BatchException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(operationMetadata,
CreateJobQueueResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
List metricPublishers = resolveMetricPublishers(clientConfiguration, createJobQueueRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Batch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "CreateJobQueue");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("CreateJobQueue").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(createJobQueueRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new CreateJobQueueRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Creates an Batch scheduling policy.
*
*
* @param createSchedulingPolicyRequest
* Contains the parameters for CreateSchedulingPolicy.
* @return Result of the CreateSchedulingPolicy operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.CreateSchedulingPolicy
* @see AWS
* API Documentation
*/
@Override
public CreateSchedulingPolicyResponse createSchedulingPolicy(CreateSchedulingPolicyRequest createSchedulingPolicyRequest)
throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(
operationMetadata, CreateSchedulingPolicyResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
List metricPublishers = resolveMetricPublishers(clientConfiguration, createSchedulingPolicyRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Batch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "CreateSchedulingPolicy");
return clientHandler
.execute(new ClientExecutionParams()
.withOperationName("CreateSchedulingPolicy").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(createSchedulingPolicyRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new CreateSchedulingPolicyRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* 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.
*
*
* @param deleteComputeEnvironmentRequest
* Contains the parameters for DeleteComputeEnvironment.
* @return Result of the DeleteComputeEnvironment operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.DeleteComputeEnvironment
* @see AWS API Documentation
*/
@Override
public DeleteComputeEnvironmentResponse deleteComputeEnvironment(
DeleteComputeEnvironmentRequest deleteComputeEnvironmentRequest) throws ClientException, ServerException,
AwsServiceException, SdkClientException, BatchException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(
operationMetadata, DeleteComputeEnvironmentResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
List metricPublishers = resolveMetricPublishers(clientConfiguration, deleteComputeEnvironmentRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Batch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "DeleteComputeEnvironment");
return clientHandler
.execute(new ClientExecutionParams()
.withOperationName("DeleteComputeEnvironment").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(deleteComputeEnvironmentRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new DeleteComputeEnvironmentRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* 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.
*
*
* @param deleteJobQueueRequest
* Contains the parameters for DeleteJobQueue.
* @return Result of the DeleteJobQueue operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.DeleteJobQueue
* @see AWS API
* Documentation
*/
@Override
public DeleteJobQueueResponse deleteJobQueue(DeleteJobQueueRequest deleteJobQueueRequest) throws ClientException,
ServerException, AwsServiceException, SdkClientException, BatchException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(operationMetadata,
DeleteJobQueueResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
List metricPublishers = resolveMetricPublishers(clientConfiguration, deleteJobQueueRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Batch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "DeleteJobQueue");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("DeleteJobQueue").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(deleteJobQueueRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new DeleteJobQueueRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Deletes the specified scheduling policy.
*
*
* You can't delete a scheduling policy that's used in any job queues.
*
*
* @param deleteSchedulingPolicyRequest
* Contains the parameters for DeleteSchedulingPolicy.
* @return Result of the DeleteSchedulingPolicy operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.DeleteSchedulingPolicy
* @see AWS
* API Documentation
*/
@Override
public DeleteSchedulingPolicyResponse deleteSchedulingPolicy(DeleteSchedulingPolicyRequest deleteSchedulingPolicyRequest)
throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(
operationMetadata, DeleteSchedulingPolicyResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
List metricPublishers = resolveMetricPublishers(clientConfiguration, deleteSchedulingPolicyRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Batch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "DeleteSchedulingPolicy");
return clientHandler
.execute(new ClientExecutionParams()
.withOperationName("DeleteSchedulingPolicy").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(deleteSchedulingPolicyRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new DeleteSchedulingPolicyRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Deregisters an Batch job definition. Job definitions are permanently deleted after 180 days.
*
*
* @param deregisterJobDefinitionRequest
* @return Result of the DeregisterJobDefinition operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.DeregisterJobDefinition
* @see AWS
* API Documentation
*/
@Override
public DeregisterJobDefinitionResponse deregisterJobDefinition(DeregisterJobDefinitionRequest deregisterJobDefinitionRequest)
throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(
operationMetadata, DeregisterJobDefinitionResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
List metricPublishers = resolveMetricPublishers(clientConfiguration, deregisterJobDefinitionRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Batch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "DeregisterJobDefinition");
return clientHandler
.execute(new ClientExecutionParams()
.withOperationName("DeregisterJobDefinition").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(deregisterJobDefinitionRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new DeregisterJobDefinitionRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* 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.
*
*
* @param describeComputeEnvironmentsRequest
* Contains the parameters for DescribeComputeEnvironments.
* @return Result of the DescribeComputeEnvironments operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.DescribeComputeEnvironments
* @see AWS API Documentation
*/
@Override
public DescribeComputeEnvironmentsResponse describeComputeEnvironments(
DescribeComputeEnvironmentsRequest describeComputeEnvironmentsRequest) throws ClientException, ServerException,
AwsServiceException, SdkClientException, BatchException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(
operationMetadata, DescribeComputeEnvironmentsResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
List metricPublishers = resolveMetricPublishers(clientConfiguration, describeComputeEnvironmentsRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Batch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "DescribeComputeEnvironments");
return clientHandler
.execute(new ClientExecutionParams()
.withOperationName("DescribeComputeEnvironments").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(describeComputeEnvironmentsRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new DescribeComputeEnvironmentsRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Describes one or more of your compute environments.
*
*
* If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment
* operation to determine the ecsClusterArn that you launch your Amazon ECS container instances into.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeComputeEnvironments(software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsRequest)}
* operation.
*
*
* @param describeComputeEnvironmentsRequest
* Contains the parameters for DescribeComputeEnvironments.
* @return 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, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.DescribeComputeEnvironments
* @see AWS API Documentation
*/
@Override
public DescribeComputeEnvironmentsIterable describeComputeEnvironmentsPaginator(
DescribeComputeEnvironmentsRequest describeComputeEnvironmentsRequest) throws ClientException, ServerException,
AwsServiceException, SdkClientException, BatchException {
return new DescribeComputeEnvironmentsIterable(this, applyPaginatorUserAgent(describeComputeEnvironmentsRequest));
}
/**
*
* Describes a list of job definitions. You can specify a status (such as ACTIVE) to only
* return job definitions that match that status.
*
*
* @param describeJobDefinitionsRequest
* Contains the parameters for DescribeJobDefinitions.
* @return Result of the DescribeJobDefinitions operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.DescribeJobDefinitions
* @see AWS
* API Documentation
*/
@Override
public DescribeJobDefinitionsResponse describeJobDefinitions(DescribeJobDefinitionsRequest describeJobDefinitionsRequest)
throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(
operationMetadata, DescribeJobDefinitionsResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
List metricPublishers = resolveMetricPublishers(clientConfiguration, describeJobDefinitionsRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Batch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "DescribeJobDefinitions");
return clientHandler
.execute(new ClientExecutionParams()
.withOperationName("DescribeJobDefinitions").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(describeJobDefinitionsRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new DescribeJobDefinitionsRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Describes a list of job definitions. You can specify a status (such as ACTIVE) to only
* return job definitions that match that status.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeJobDefinitions(software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsRequest)}
* operation.
*
*
* @param describeJobDefinitionsRequest
* Contains the parameters for DescribeJobDefinitions.
* @return 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, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.DescribeJobDefinitions
* @see AWS
* API Documentation
*/
@Override
public DescribeJobDefinitionsIterable describeJobDefinitionsPaginator(
DescribeJobDefinitionsRequest describeJobDefinitionsRequest) throws ClientException, ServerException,
AwsServiceException, SdkClientException, BatchException {
return new DescribeJobDefinitionsIterable(this, applyPaginatorUserAgent(describeJobDefinitionsRequest));
}
/**
*
* Describes one or more of your job queues.
*
*
* @param describeJobQueuesRequest
* Contains the parameters for DescribeJobQueues.
* @return Result of the DescribeJobQueues operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.DescribeJobQueues
* @see AWS API
* Documentation
*/
@Override
public DescribeJobQueuesResponse describeJobQueues(DescribeJobQueuesRequest describeJobQueuesRequest) throws ClientException,
ServerException, AwsServiceException, SdkClientException, BatchException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(operationMetadata,
DescribeJobQueuesResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
List metricPublishers = resolveMetricPublishers(clientConfiguration, describeJobQueuesRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Batch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "DescribeJobQueues");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("DescribeJobQueues").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(describeJobQueuesRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new DescribeJobQueuesRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Describes one or more of your job queues.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeJobQueues(software.amazon.awssdk.services.batch.model.DescribeJobQueuesRequest)} operation.
*
*
* @param describeJobQueuesRequest
* Contains the parameters for DescribeJobQueues.
* @return 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, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.DescribeJobQueues
* @see AWS API
* Documentation
*/
@Override
public DescribeJobQueuesIterable describeJobQueuesPaginator(DescribeJobQueuesRequest describeJobQueuesRequest)
throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException {
return new DescribeJobQueuesIterable(this, applyPaginatorUserAgent(describeJobQueuesRequest));
}
/**
*
* Describes a list of Batch jobs.
*
*
* @param describeJobsRequest
* Contains the parameters for DescribeJobs.
* @return Result of the DescribeJobs operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.DescribeJobs
* @see AWS API
* Documentation
*/
@Override
public DescribeJobsResponse describeJobs(DescribeJobsRequest describeJobsRequest) throws ClientException, ServerException,
AwsServiceException, SdkClientException, BatchException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(operationMetadata,
DescribeJobsResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
List metricPublishers = resolveMetricPublishers(clientConfiguration, describeJobsRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Batch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "DescribeJobs");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("DescribeJobs").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(describeJobsRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new DescribeJobsRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Describes one or more of your scheduling policies.
*
*
* @param describeSchedulingPoliciesRequest
* Contains the parameters for DescribeSchedulingPolicies.
* @return Result of the DescribeSchedulingPolicies operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.DescribeSchedulingPolicies
* @see AWS API Documentation
*/
@Override
public DescribeSchedulingPoliciesResponse describeSchedulingPolicies(
DescribeSchedulingPoliciesRequest describeSchedulingPoliciesRequest) throws ClientException, ServerException,
AwsServiceException, SdkClientException, BatchException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(
operationMetadata, DescribeSchedulingPoliciesResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
List metricPublishers = resolveMetricPublishers(clientConfiguration, describeSchedulingPoliciesRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Batch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "DescribeSchedulingPolicies");
return clientHandler
.execute(new ClientExecutionParams()
.withOperationName("DescribeSchedulingPolicies").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(describeSchedulingPoliciesRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new DescribeSchedulingPoliciesRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* 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.
*
*
* @param listJobsRequest
* Contains the parameters for ListJobs.
* @return Result of the ListJobs operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.ListJobs
* @see AWS API
* Documentation
*/
@Override
public ListJobsResponse listJobs(ListJobsRequest listJobsRequest) throws ClientException, ServerException,
AwsServiceException, SdkClientException, BatchException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(operationMetadata,
ListJobsResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
List metricPublishers = resolveMetricPublishers(clientConfiguration, listJobsRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Batch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "ListJobs");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("ListJobs").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(listJobsRequest)
.withMetricCollector(apiCallMetricCollector).withMarshaller(new ListJobsRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Returns a list of Batch jobs.
*
*
* You must specify only one of the following items:
*
*
* -
*
* A job queue ID to return a list of jobs in that job queue
*
*
* -
*
* A multi-node parallel job ID to return a list of nodes for that job
*
*
* -
*
* An array job ID to return a list of the children for that job
*
*
*
*
* You can filter the results by job status with the jobStatus parameter. If you don't specify a
* status, only RUNNING jobs are returned.
*
*
*
* This is a variant of {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listJobs(software.amazon.awssdk.services.batch.model.ListJobsRequest)} operation.
*
*
* @param listJobsRequest
* Contains the parameters for ListJobs.
* @return 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, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.ListJobs
* @see AWS API
* Documentation
*/
@Override
public ListJobsIterable listJobsPaginator(ListJobsRequest listJobsRequest) throws ClientException, ServerException,
AwsServiceException, SdkClientException, BatchException {
return new ListJobsIterable(this, applyPaginatorUserAgent(listJobsRequest));
}
/**
*
* Returns a list of Batch scheduling policies.
*
*
* @param listSchedulingPoliciesRequest
* Contains the parameters for ListSchedulingPolicies.
* @return Result of the ListSchedulingPolicies operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.ListSchedulingPolicies
* @see AWS
* API Documentation
*/
@Override
public ListSchedulingPoliciesResponse listSchedulingPolicies(ListSchedulingPoliciesRequest listSchedulingPoliciesRequest)
throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(
operationMetadata, ListSchedulingPoliciesResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
List metricPublishers = resolveMetricPublishers(clientConfiguration, listSchedulingPoliciesRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Batch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "ListSchedulingPolicies");
return clientHandler
.execute(new ClientExecutionParams()
.withOperationName("ListSchedulingPolicies").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(listSchedulingPoliciesRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new ListSchedulingPoliciesRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Returns a list of Batch scheduling policies.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listSchedulingPolicies(software.amazon.awssdk.services.batch.model.ListSchedulingPoliciesRequest)}
* operation.
*
*
* @param listSchedulingPoliciesRequest
* Contains the parameters for ListSchedulingPolicies.
* @return 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, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.ListSchedulingPolicies
* @see AWS
* API Documentation
*/
@Override
public ListSchedulingPoliciesIterable listSchedulingPoliciesPaginator(
ListSchedulingPoliciesRequest listSchedulingPoliciesRequest) throws ClientException, ServerException,
AwsServiceException, SdkClientException, BatchException {
return new ListSchedulingPoliciesIterable(this, applyPaginatorUserAgent(listSchedulingPoliciesRequest));
}
/**
*
* 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
* are not supported.
*
*
* @param listTagsForResourceRequest
* Contains the parameters for ListTagsForResource.
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.ListTagsForResource
* @see AWS API
* Documentation
*/
@Override
public ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(
operationMetadata, ListTagsForResourceResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
List metricPublishers = resolveMetricPublishers(clientConfiguration, listTagsForResourceRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Batch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "ListTagsForResource");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("ListTagsForResource").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(listTagsForResourceRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new ListTagsForResourceRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Registers an Batch job definition.
*
*
* @param registerJobDefinitionRequest
* Contains the parameters for RegisterJobDefinition.
* @return Result of the RegisterJobDefinition operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.RegisterJobDefinition
* @see AWS
* API Documentation
*/
@Override
public RegisterJobDefinitionResponse registerJobDefinition(RegisterJobDefinitionRequest registerJobDefinitionRequest)
throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(
operationMetadata, RegisterJobDefinitionResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
List metricPublishers = resolveMetricPublishers(clientConfiguration, registerJobDefinitionRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Batch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "RegisterJobDefinition");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("RegisterJobDefinition").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(registerJobDefinitionRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new RegisterJobDefinitionRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* 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.
*
*
*
* @param submitJobRequest
* Contains the parameters for SubmitJob.
* @return Result of the SubmitJob operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.SubmitJob
* @see AWS API
* Documentation
*/
@Override
public SubmitJobResponse submitJob(SubmitJobRequest submitJobRequest) throws ClientException, ServerException,
AwsServiceException, SdkClientException, BatchException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(operationMetadata,
SubmitJobResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
List metricPublishers = resolveMetricPublishers(clientConfiguration, submitJobRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Batch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "SubmitJob");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("SubmitJob").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(submitJobRequest)
.withMetricCollector(apiCallMetricCollector).withMarshaller(new SubmitJobRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* 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 are not supported.
*
*
* @param tagResourceRequest
* Contains the parameters for TagResource.
* @return Result of the TagResource operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.TagResource
* @see AWS API
* Documentation
*/
@Override
public TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ClientException, ServerException,
AwsServiceException, SdkClientException, BatchException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(operationMetadata,
TagResourceResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
List metricPublishers = resolveMetricPublishers(clientConfiguration, tagResourceRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Batch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "TagResource");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("TagResource").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(tagResourceRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new TagResourceRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* 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.
*
*
* @param terminateJobRequest
* Contains the parameters for TerminateJob.
* @return Result of the TerminateJob operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.TerminateJob
* @see AWS API
* Documentation
*/
@Override
public TerminateJobResponse terminateJob(TerminateJobRequest terminateJobRequest) throws ClientException, ServerException,
AwsServiceException, SdkClientException, BatchException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(operationMetadata,
TerminateJobResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
List metricPublishers = resolveMetricPublishers(clientConfiguration, terminateJobRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Batch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "TerminateJob");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("TerminateJob").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(terminateJobRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new TerminateJobRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Deletes specified tags from an Batch resource.
*
*
* @param untagResourceRequest
* Contains the parameters for UntagResource.
* @return Result of the UntagResource operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.UntagResource
* @see AWS API
* Documentation
*/
@Override
public UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ClientException,
ServerException, AwsServiceException, SdkClientException, BatchException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(operationMetadata,
UntagResourceResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
List metricPublishers = resolveMetricPublishers(clientConfiguration, untagResourceRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Batch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "UntagResource");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("UntagResource").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(untagResourceRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new UntagResourceRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Updates an Batch compute environment.
*
*
* @param updateComputeEnvironmentRequest
* Contains the parameters for UpdateComputeEnvironment.
* @return Result of the UpdateComputeEnvironment operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.UpdateComputeEnvironment
* @see AWS API Documentation
*/
@Override
public UpdateComputeEnvironmentResponse updateComputeEnvironment(
UpdateComputeEnvironmentRequest updateComputeEnvironmentRequest) throws ClientException, ServerException,
AwsServiceException, SdkClientException, BatchException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(
operationMetadata, UpdateComputeEnvironmentResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
List metricPublishers = resolveMetricPublishers(clientConfiguration, updateComputeEnvironmentRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Batch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "UpdateComputeEnvironment");
return clientHandler
.execute(new ClientExecutionParams()
.withOperationName("UpdateComputeEnvironment").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(updateComputeEnvironmentRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new UpdateComputeEnvironmentRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Updates a job queue.
*
*
* @param updateJobQueueRequest
* Contains the parameters for UpdateJobQueue.
* @return Result of the UpdateJobQueue operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.UpdateJobQueue
* @see AWS API
* Documentation
*/
@Override
public UpdateJobQueueResponse updateJobQueue(UpdateJobQueueRequest updateJobQueueRequest) throws ClientException,
ServerException, AwsServiceException, SdkClientException, BatchException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(operationMetadata,
UpdateJobQueueResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
List metricPublishers = resolveMetricPublishers(clientConfiguration, updateJobQueueRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Batch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "UpdateJobQueue");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("UpdateJobQueue").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(updateJobQueueRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new UpdateJobQueueRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Updates a scheduling policy.
*
*
* @param updateSchedulingPolicyRequest
* Contains the parameters for UpdateSchedulingPolicy.
* @return Result of the UpdateSchedulingPolicy operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action, such as using an action or resource on behalf of a
* user that doesn't have permissions to use the action or resource, or specifying an identifier that's not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws BatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BatchClient.UpdateSchedulingPolicy
* @see AWS
* API Documentation
*/
@Override
public UpdateSchedulingPolicyResponse updateSchedulingPolicy(UpdateSchedulingPolicyRequest updateSchedulingPolicyRequest)
throws ClientException, ServerException, AwsServiceException, SdkClientException, BatchException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(
operationMetadata, UpdateSchedulingPolicyResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
List metricPublishers = resolveMetricPublishers(clientConfiguration, updateSchedulingPolicyRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Batch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "UpdateSchedulingPolicy");
return clientHandler
.execute(new ClientExecutionParams()
.withOperationName("UpdateSchedulingPolicy").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(updateSchedulingPolicyRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new UpdateSchedulingPolicyRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
private static List resolveMetricPublishers(SdkClientConfiguration clientConfiguration,
RequestOverrideConfiguration requestOverrideConfiguration) {
List publishers = null;
if (requestOverrideConfiguration != null) {
publishers = requestOverrideConfiguration.metricPublishers();
}
if (publishers == null || publishers.isEmpty()) {
publishers = clientConfiguration.option(SdkClientOption.METRIC_PUBLISHERS);
}
if (publishers == null) {
publishers = Collections.emptyList();
}
return publishers;
}
private HttpResponseHandler createErrorResponseHandler(BaseAwsJsonProtocolFactory protocolFactory,
JsonOperationMetadata operationMetadata) {
return protocolFactory.createErrorResponseHandler(operationMetadata);
}
private > T init(T builder) {
return builder
.clientConfiguration(clientConfiguration)
.defaultServiceExceptionSupplier(BatchException::builder)
.protocol(AwsJsonProtocol.REST_JSON)
.protocolVersion("1.1")
.registerModeledException(
ExceptionMetadata.builder().errorCode("ServerException")
.exceptionBuilderSupplier(ServerException::builder).httpStatusCode(500).build())
.registerModeledException(
ExceptionMetadata.builder().errorCode("ClientException")
.exceptionBuilderSupplier(ClientException::builder).httpStatusCode(400).build());
}
@Override
public void close() {
clientHandler.close();
}
private T applyPaginatorUserAgent(T request) {
Consumer userAgentApplier = b -> b.addApiName(ApiName.builder()
.version(VersionInfo.SDK_VERSION).name("PAGINATED").build());
AwsRequestOverrideConfiguration overrideConfiguration = request.overrideConfiguration()
.map(c -> c.toBuilder().applyMutation(userAgentApplier).build())
.orElse((AwsRequestOverrideConfiguration.builder().applyMutation(userAgentApplier).build()));
return (T) request.toBuilder().overrideConfiguration(overrideConfiguration).build();
}
}