/* * Copyright 2012-2017 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 com.amazonaws.services.batch; import org.w3c.dom.*; import java.net.*; import java.util.*; import javax.annotation.Generated; import org.apache.commons.logging.*; import com.amazonaws.*; import com.amazonaws.annotation.SdkInternalApi; import com.amazonaws.auth.*; import com.amazonaws.handlers.*; import com.amazonaws.http.*; import com.amazonaws.internal.*; import com.amazonaws.internal.auth.*; import com.amazonaws.metrics.*; import com.amazonaws.regions.*; import com.amazonaws.transform.*; import com.amazonaws.util.*; import com.amazonaws.protocol.json.*; import com.amazonaws.util.AWSRequestMetrics.Field; import com.amazonaws.annotation.ThreadSafe; import com.amazonaws.client.AwsSyncClientParams; import com.amazonaws.services.batch.AWSBatchClientBuilder; import com.amazonaws.AmazonServiceException; import com.amazonaws.services.batch.model.*; import com.amazonaws.services.batch.model.transform.*; /** * Client for accessing AWS Batch. All service calls made using this client are blocking, and will not return until the * service call completes. * <p> * <p> * AWS Batch enables you to run batch computing workloads on the AWS Cloud. Batch computing is a common way for * developers, scientists, and engineers to access large amounts of compute resources, and AWS Batch removes the * undifferentiated heavy lifting of configuring and managing the required infrastructure. AWS Batch will be familiar to * users of traditional batch computing software. This service can efficiently provision resources in response to jobs * submitted in order to eliminate capacity constraints, reduce compute costs, and deliver results quickly. * </p> * <p> * As a fully managed service, AWS Batch enables developers, scientists, and engineers to run batch computing workloads * of any scale. AWS Batch automatically provisions compute resources and optimizes the workload distribution based on * the quantity and scale of the workloads. With AWS Batch, there is no need to install or manage batch computing * software, which allows you to focus on analyzing results and solving problems. AWS Batch reduces operational * complexities, saves time, and reduces costs, which makes it easy for developers, scientists, and engineers to run * their batch jobs in the AWS Cloud. * </p> */ @ThreadSafe @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AWSBatchClient extends AmazonWebServiceClient implements AWSBatch { /** Provider for AWS credentials. */ private final AWSCredentialsProvider awsCredentialsProvider; private static final Log log = LogFactory.getLog(AWSBatch.class); /** Default signing name for the service. */ private static final String DEFAULT_SIGNING_NAME = "batch"; /** Client configuration factory providing ClientConfigurations tailored to this client */ protected static final ClientConfigurationFactory configFactory = new ClientConfigurationFactory(); private final com.amazonaws.protocol.json.SdkJsonProtocolFactory protocolFactory = new com.amazonaws.protocol.json.SdkJsonProtocolFactory( new JsonClientMetadata() .withProtocolVersion("1.1") .withSupportsCbor(false) .withSupportsIon(false) .withContentTypeOverride("") .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ServerException").withModeledClass( com.amazonaws.services.batch.model.ServerException.class)) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ClientException").withModeledClass( com.amazonaws.services.batch.model.ClientException.class)) .withBaseServiceExceptionClass(com.amazonaws.services.batch.model.AWSBatchException.class)); /** * Constructs a new client to invoke service methods on AWS Batch. A credentials provider chain will be used that * searches for credentials in this order: * <ul> * <li>Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY</li> * <li>Java System Properties - aws.accessKeyId and aws.secretKey</li> * <li>Instance profile credentials delivered through the Amazon EC2 metadata service</li> * </ul> * * <p> * All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @see DefaultAWSCredentialsProviderChain * @deprecated use {@link AWSBatchClientBuilder#defaultClient()} */ @Deprecated public AWSBatchClient() { this(DefaultAWSCredentialsProviderChain.getInstance(), configFactory.getConfig()); } /** * Constructs a new client to invoke service methods on AWS Batch. A credentials provider chain will be used that * searches for credentials in this order: * <ul> * <li>Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY</li> * <li>Java System Properties - aws.accessKeyId and aws.secretKey</li> * <li>Instance profile credentials delivered through the Amazon EC2 metadata service</li> * </ul> * * <p> * All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientConfiguration * The client configuration options controlling how this client connects to AWS Batch (ex: proxy settings, * retry counts, etc.). * * @see DefaultAWSCredentialsProviderChain * @deprecated use {@link AWSBatchClientBuilder#withClientConfiguration(ClientConfiguration)} */ @Deprecated public AWSBatchClient(ClientConfiguration clientConfiguration) { this(DefaultAWSCredentialsProviderChain.getInstance(), clientConfiguration); } /** * Constructs a new client to invoke service methods on AWS Batch using the specified AWS account credentials. * * <p> * All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param awsCredentials * The AWS credentials (access key ID and secret key) to use when authenticating with AWS services. * @deprecated use {@link AWSBatchClientBuilder#withCredentials(AWSCredentialsProvider)} for example: * {@code AWSBatchClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();} */ @Deprecated public AWSBatchClient(AWSCredentials awsCredentials) { this(awsCredentials, configFactory.getConfig()); } /** * Constructs a new client to invoke service methods on AWS Batch using the specified AWS account credentials and * client configuration options. * * <p> * All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param awsCredentials * The AWS credentials (access key ID and secret key) to use when authenticating with AWS services. * @param clientConfiguration * The client configuration options controlling how this client connects to AWS Batch (ex: proxy settings, * retry counts, etc.). * @deprecated use {@link AWSBatchClientBuilder#withCredentials(AWSCredentialsProvider)} and * {@link AWSBatchClientBuilder#withClientConfiguration(ClientConfiguration)} */ @Deprecated public AWSBatchClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) { super(clientConfiguration); this.awsCredentialsProvider = new StaticCredentialsProvider(awsCredentials); init(); } /** * Constructs a new client to invoke service methods on AWS Batch using the specified AWS account credentials * provider. * * <p> * All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param awsCredentialsProvider * The AWS credentials provider which will provide credentials to authenticate requests with AWS services. * @deprecated use {@link AWSBatchClientBuilder#withCredentials(AWSCredentialsProvider)} */ @Deprecated public AWSBatchClient(AWSCredentialsProvider awsCredentialsProvider) { this(awsCredentialsProvider, configFactory.getConfig()); } /** * Constructs a new client to invoke service methods on AWS Batch using the specified AWS account credentials * provider and client configuration options. * * <p> * All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param awsCredentialsProvider * The AWS credentials provider which will provide credentials to authenticate requests with AWS services. * @param clientConfiguration * The client configuration options controlling how this client connects to AWS Batch (ex: proxy settings, * retry counts, etc.). * @deprecated use {@link AWSBatchClientBuilder#withCredentials(AWSCredentialsProvider)} and * {@link AWSBatchClientBuilder#withClientConfiguration(ClientConfiguration)} */ @Deprecated public AWSBatchClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) { this(awsCredentialsProvider, clientConfiguration, null); } /** * Constructs a new client to invoke service methods on AWS Batch using the specified AWS account credentials * provider, client configuration options, and request metric collector. * * <p> * All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param awsCredentialsProvider * The AWS credentials provider which will provide credentials to authenticate requests with AWS services. * @param clientConfiguration * The client configuration options controlling how this client connects to AWS Batch (ex: proxy settings, * retry counts, etc.). * @param requestMetricCollector * optional request metric collector * @deprecated use {@link AWSBatchClientBuilder#withCredentials(AWSCredentialsProvider)} and * {@link AWSBatchClientBuilder#withClientConfiguration(ClientConfiguration)} and * {@link AWSBatchClientBuilder#withMetricsCollector(RequestMetricCollector)} */ @Deprecated public AWSBatchClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) { super(clientConfiguration, requestMetricCollector); this.awsCredentialsProvider = awsCredentialsProvider; init(); } public static AWSBatchClientBuilder builder() { return AWSBatchClientBuilder.standard(); } /** * Constructs a new client to invoke service methods on AWS Batch using the specified parameters. * * <p> * All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AWSBatchClient(AwsSyncClientParams clientParams) { super(clientParams); this.awsCredentialsProvider = clientParams.getCredentialsProvider(); init(); } private void init() { setServiceNameIntern(DEFAULT_SIGNING_NAME); setEndpointPrefix(ENDPOINT_PREFIX); // calling this.setEndPoint(...) will also modify the signer accordingly setEndpoint("batch.us-east-1.amazonaws.com"); HandlerChainFactory chainFactory = new HandlerChainFactory(); requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/batch/request.handlers")); requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/batch/request.handler2s")); requestHandler2s.addAll(chainFactory.getGlobalHandlers()); } /** * <p> * Cancels jobs in an AWS Batch job queue. Jobs that are in the <code>SUBMITTED</code>, <code>PENDING</code>, or * <code>RUNNABLE</code> state are cancelled. Jobs that have progressed to <code>STARTING</code> or * <code>RUNNING</code> are not cancelled (but the API operation still succeeds, even if no jobs are cancelled); * these jobs must be terminated with the <a>TerminateJob</a> operation. * </p> * * @param cancelJobRequest * @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 permission to use the action or resource, or specifying an identifier that is not * valid. * @throws ServerException * These errors are usually caused by a server issue. * @sample AWSBatch.CancelJob * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CancelJob" target="_top">AWS API * Documentation</a> */ @Override public CancelJobResult cancelJob(CancelJobRequest request) { request = beforeClientExecution(request); return executeCancelJob(request); } @SdkInternalApi final CancelJobResult executeCancelJob(CancelJobRequest cancelJobRequest) { ExecutionContext executionContext = createExecutionContext(cancelJobRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request<CancelJobRequest> request = null; Response<CancelJobResult> response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new CancelJobRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(cancelJobRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler<AmazonWebServiceResponse<CancelJobResult>> responseHandler = protocolFactory.createResponseHandler(new JsonOperationMetadata() .withPayloadJson(true).withHasStreamingSuccessResponse(false), new CancelJobResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** * <p> * Creates an AWS Batch compute environment. You can create <code>MANAGED</code> or <code>UNMANAGED</code> compute * environments. * </p> * <p> * In a managed compute environment, AWS Batch manages the compute resources within the environment, based on the * compute resources that you specify. Instances launched into a managed compute environment use the latest Amazon * ECS-optimized AMI. You can choose to use Amazon EC2 On-Demand instances in your managed compute environment, or * you can use Amazon EC2 Spot instances that only launch when the Spot bid price is below a specified percentage of * the On-Demand price. * </p> * <p> * In an unmanaged compute environment, you can manage your own compute resources. This provides more compute * resource configuration options, such as using a custom AMI, but you must ensure that your AMI meets the Amazon * ECS container instance AMI specification. For more information, see <a * href="http://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html">Container Instance * AMIs</a> in the <i>Amazon EC2 Container Service Developer Guide</i>. After you have created your unmanaged * compute environment, you can use the <a>DescribeComputeEnvironments</a> operation to find the Amazon ECS cluster * that is associated with it and then manually launch your container instances into that Amazon ECS cluster. For * more information, see <a * href="http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html">Launching an * Amazon ECS Container Instance</a> in the <i>Amazon EC2 Container Service Developer Guide</i>. * </p> * * @param createComputeEnvironmentRequest * @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 permission to use the action or resource, or specifying an identifier that is not * valid. * @throws ServerException * These errors are usually caused by a server issue. * @sample AWSBatch.CreateComputeEnvironment * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateComputeEnvironment" target="_top">AWS * API Documentation</a> */ @Override public CreateComputeEnvironmentResult createComputeEnvironment(CreateComputeEnvironmentRequest request) { request = beforeClientExecution(request); return executeCreateComputeEnvironment(request); } @SdkInternalApi final CreateComputeEnvironmentResult executeCreateComputeEnvironment(CreateComputeEnvironmentRequest createComputeEnvironmentRequest) { ExecutionContext executionContext = createExecutionContext(createComputeEnvironmentRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request<CreateComputeEnvironmentRequest> request = null; Response<CreateComputeEnvironmentResult> response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new CreateComputeEnvironmentRequestProtocolMarshaller(protocolFactory).marshall(super .beforeMarshalling(createComputeEnvironmentRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler<AmazonWebServiceResponse<CreateComputeEnvironmentResult>> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new CreateComputeEnvironmentResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** * <p> * Creates an AWS 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. * </p> * <p> * You also set a priority to the job queue that determines the order in which the AWS 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. * </p> * * @param createJobQueueRequest * @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 permission to use the action or resource, or specifying an identifier that is not * valid. * @throws ServerException * These errors are usually caused by a server issue. * @sample AWSBatch.CreateJobQueue * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateJobQueue" target="_top">AWS API * Documentation</a> */ @Override public CreateJobQueueResult createJobQueue(CreateJobQueueRequest request) { request = beforeClientExecution(request); return executeCreateJobQueue(request); } @SdkInternalApi final CreateJobQueueResult executeCreateJobQueue(CreateJobQueueRequest createJobQueueRequest) { ExecutionContext executionContext = createExecutionContext(createJobQueueRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request<CreateJobQueueRequest> request = null; Response<CreateJobQueueResult> response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new CreateJobQueueRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(createJobQueueRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler<AmazonWebServiceResponse<CreateJobQueueResult>> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new CreateJobQueueResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** * <p> * Deletes an AWS Batch compute environment. * </p> * <p> * Before you can delete a compute environment, you must set its state to <code>DISABLED</code> with the * <a>UpdateComputeEnvironment</a> API operation and disassociate it from any job queues with the * <a>UpdateJobQueue</a> API operation. * </p> * * @param deleteComputeEnvironmentRequest * @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 permission to use the action or resource, or specifying an identifier that is not * valid. * @throws ServerException * These errors are usually caused by a server issue. * @sample AWSBatch.DeleteComputeEnvironment * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeleteComputeEnvironment" target="_top">AWS * API Documentation</a> */ @Override public DeleteComputeEnvironmentResult deleteComputeEnvironment(DeleteComputeEnvironmentRequest request) { request = beforeClientExecution(request); return executeDeleteComputeEnvironment(request); } @SdkInternalApi final DeleteComputeEnvironmentResult executeDeleteComputeEnvironment(DeleteComputeEnvironmentRequest deleteComputeEnvironmentRequest) { ExecutionContext executionContext = createExecutionContext(deleteComputeEnvironmentRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request<DeleteComputeEnvironmentRequest> request = null; Response<DeleteComputeEnvironmentResult> response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new DeleteComputeEnvironmentRequestProtocolMarshaller(protocolFactory).marshall(super .beforeMarshalling(deleteComputeEnvironmentRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler<AmazonWebServiceResponse<DeleteComputeEnvironmentResult>> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new DeleteComputeEnvironmentResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** * <p> * Deletes the specified job queue. You must first disable submissions for a queue with the <a>UpdateJobQueue</a> * operation and terminate any jobs that have not completed with the <a>TerminateJob</a>. * </p> * <p> * It is not necessary to disassociate compute environments from a queue before submitting a * <code>DeleteJobQueue</code> request. * </p> * * @param deleteJobQueueRequest * @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 permission to use the action or resource, or specifying an identifier that is not * valid. * @throws ServerException * These errors are usually caused by a server issue. * @sample AWSBatch.DeleteJobQueue * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeleteJobQueue" target="_top">AWS API * Documentation</a> */ @Override public DeleteJobQueueResult deleteJobQueue(DeleteJobQueueRequest request) { request = beforeClientExecution(request); return executeDeleteJobQueue(request); } @SdkInternalApi final DeleteJobQueueResult executeDeleteJobQueue(DeleteJobQueueRequest deleteJobQueueRequest) { ExecutionContext executionContext = createExecutionContext(deleteJobQueueRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request<DeleteJobQueueRequest> request = null; Response<DeleteJobQueueResult> response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new DeleteJobQueueRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(deleteJobQueueRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler<AmazonWebServiceResponse<DeleteJobQueueResult>> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new DeleteJobQueueResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** * <p> * Deregisters an AWS Batch job definition. * </p> * * @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 permission to use the action or resource, or specifying an identifier that is not * valid. * @throws ServerException * These errors are usually caused by a server issue. * @sample AWSBatch.DeregisterJobDefinition * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeregisterJobDefinition" target="_top">AWS * API Documentation</a> */ @Override public DeregisterJobDefinitionResult deregisterJobDefinition(DeregisterJobDefinitionRequest request) { request = beforeClientExecution(request); return executeDeregisterJobDefinition(request); } @SdkInternalApi final DeregisterJobDefinitionResult executeDeregisterJobDefinition(DeregisterJobDefinitionRequest deregisterJobDefinitionRequest) { ExecutionContext executionContext = createExecutionContext(deregisterJobDefinitionRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request<DeregisterJobDefinitionRequest> request = null; Response<DeregisterJobDefinitionResult> response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new DeregisterJobDefinitionRequestProtocolMarshaller(protocolFactory).marshall(super .beforeMarshalling(deregisterJobDefinitionRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler<AmazonWebServiceResponse<DeregisterJobDefinitionResult>> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new DeregisterJobDefinitionResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** * <p> * Describes one or more of your compute environments. * </p> * <p> * If you are using an unmanaged compute environment, you can use the <code>DescribeComputeEnvironment</code> * operation to determine the <code>ecsClusterArn</code> that you should launch your Amazon ECS container instances * into. * </p> * * @param describeComputeEnvironmentsRequest * @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 permission to use the action or resource, or specifying an identifier that is not * valid. * @throws ServerException * These errors are usually caused by a server issue. * @sample AWSBatch.DescribeComputeEnvironments * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeComputeEnvironments" * target="_top">AWS API Documentation</a> */ @Override public DescribeComputeEnvironmentsResult describeComputeEnvironments(DescribeComputeEnvironmentsRequest request) { request = beforeClientExecution(request); return executeDescribeComputeEnvironments(request); } @SdkInternalApi final DescribeComputeEnvironmentsResult executeDescribeComputeEnvironments(DescribeComputeEnvironmentsRequest describeComputeEnvironmentsRequest) { ExecutionContext executionContext = createExecutionContext(describeComputeEnvironmentsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request<DescribeComputeEnvironmentsRequest> request = null; Response<DescribeComputeEnvironmentsResult> response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new DescribeComputeEnvironmentsRequestProtocolMarshaller(protocolFactory).marshall(super .beforeMarshalling(describeComputeEnvironmentsRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler<AmazonWebServiceResponse<DescribeComputeEnvironmentsResult>> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new DescribeComputeEnvironmentsResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** * <p> * Describes a list of job definitions. You can specify a <code>status</code> (such as <code>ACTIVE</code>) to only * return job definitions that match that status. * </p> * * @param describeJobDefinitionsRequest * @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 permission to use the action or resource, or specifying an identifier that is not * valid. * @throws ServerException * These errors are usually caused by a server issue. * @sample AWSBatch.DescribeJobDefinitions * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobDefinitions" target="_top">AWS * API Documentation</a> */ @Override public DescribeJobDefinitionsResult describeJobDefinitions(DescribeJobDefinitionsRequest request) { request = beforeClientExecution(request); return executeDescribeJobDefinitions(request); } @SdkInternalApi final DescribeJobDefinitionsResult executeDescribeJobDefinitions(DescribeJobDefinitionsRequest describeJobDefinitionsRequest) { ExecutionContext executionContext = createExecutionContext(describeJobDefinitionsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request<DescribeJobDefinitionsRequest> request = null; Response<DescribeJobDefinitionsResult> response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new DescribeJobDefinitionsRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(describeJobDefinitionsRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler<AmazonWebServiceResponse<DescribeJobDefinitionsResult>> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new DescribeJobDefinitionsResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** * <p> * Describes one or more of your job queues. * </p> * * @param describeJobQueuesRequest * @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 permission to use the action or resource, or specifying an identifier that is not * valid. * @throws ServerException * These errors are usually caused by a server issue. * @sample AWSBatch.DescribeJobQueues * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobQueues" target="_top">AWS API * Documentation</a> */ @Override public DescribeJobQueuesResult describeJobQueues(DescribeJobQueuesRequest request) { request = beforeClientExecution(request); return executeDescribeJobQueues(request); } @SdkInternalApi final DescribeJobQueuesResult executeDescribeJobQueues(DescribeJobQueuesRequest describeJobQueuesRequest) { ExecutionContext executionContext = createExecutionContext(describeJobQueuesRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request<DescribeJobQueuesRequest> request = null; Response<DescribeJobQueuesResult> response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new DescribeJobQueuesRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(describeJobQueuesRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler<AmazonWebServiceResponse<DescribeJobQueuesResult>> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new DescribeJobQueuesResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** * <p> * Describes a list of AWS Batch jobs. * </p> * * @param describeJobsRequest * @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 permission to use the action or resource, or specifying an identifier that is not * valid. * @throws ServerException * These errors are usually caused by a server issue. * @sample AWSBatch.DescribeJobs * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobs" target="_top">AWS API * Documentation</a> */ @Override public DescribeJobsResult describeJobs(DescribeJobsRequest request) { request = beforeClientExecution(request); return executeDescribeJobs(request); } @SdkInternalApi final DescribeJobsResult executeDescribeJobs(DescribeJobsRequest describeJobsRequest) { ExecutionContext executionContext = createExecutionContext(describeJobsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request<DescribeJobsRequest> request = null; Response<DescribeJobsResult> response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new DescribeJobsRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(describeJobsRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler<AmazonWebServiceResponse<DescribeJobsResult>> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new DescribeJobsResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** * <p> * Returns a list of task jobs for a specified job queue. You can filter the results by job status with the * <code>jobStatus</code> parameter. * </p> * * @param listJobsRequest * @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 permission to use the action or resource, or specifying an identifier that is not * valid. * @throws ServerException * These errors are usually caused by a server issue. * @sample AWSBatch.ListJobs * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListJobs" target="_top">AWS API * Documentation</a> */ @Override public ListJobsResult listJobs(ListJobsRequest request) { request = beforeClientExecution(request); return executeListJobs(request); } @SdkInternalApi final ListJobsResult executeListJobs(ListJobsRequest listJobsRequest) { ExecutionContext executionContext = createExecutionContext(listJobsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request<ListJobsRequest> request = null; Response<ListJobsResult> response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new ListJobsRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(listJobsRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler<AmazonWebServiceResponse<ListJobsResult>> responseHandler = protocolFactory.createResponseHandler(new JsonOperationMetadata() .withPayloadJson(true).withHasStreamingSuccessResponse(false), new ListJobsResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** * <p> * Registers an AWS Batch job definition. * </p> * * @param registerJobDefinitionRequest * @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 permission to use the action or resource, or specifying an identifier that is not * valid. * @throws ServerException * These errors are usually caused by a server issue. * @sample AWSBatch.RegisterJobDefinition * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/RegisterJobDefinition" target="_top">AWS * API Documentation</a> */ @Override public RegisterJobDefinitionResult registerJobDefinition(RegisterJobDefinitionRequest request) { request = beforeClientExecution(request); return executeRegisterJobDefinition(request); } @SdkInternalApi final RegisterJobDefinitionResult executeRegisterJobDefinition(RegisterJobDefinitionRequest registerJobDefinitionRequest) { ExecutionContext executionContext = createExecutionContext(registerJobDefinitionRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request<RegisterJobDefinitionRequest> request = null; Response<RegisterJobDefinitionResult> response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new RegisterJobDefinitionRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(registerJobDefinitionRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler<AmazonWebServiceResponse<RegisterJobDefinitionResult>> responseHandler = protocolFactory .createResponseHandler(new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new RegisterJobDefinitionResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** * <p> * Submits an AWS Batch job from a job definition. Parameters specified during <a>SubmitJob</a> override parameters * defined in the job definition. * </p> * * @param submitJobRequest * @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 permission to use the action or resource, or specifying an identifier that is not * valid. * @throws ServerException * These errors are usually caused by a server issue. * @sample AWSBatch.SubmitJob * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/SubmitJob" target="_top">AWS API * Documentation</a> */ @Override public SubmitJobResult submitJob(SubmitJobRequest request) { request = beforeClientExecution(request); return executeSubmitJob(request); } @SdkInternalApi final SubmitJobResult executeSubmitJob(SubmitJobRequest submitJobRequest) { ExecutionContext executionContext = createExecutionContext(submitJobRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request<SubmitJobRequest> request = null; Response<SubmitJobResult> response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new SubmitJobRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(submitJobRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler<AmazonWebServiceResponse<SubmitJobResult>> responseHandler = protocolFactory.createResponseHandler(new JsonOperationMetadata() .withPayloadJson(true).withHasStreamingSuccessResponse(false), new SubmitJobResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** * <p> * Terminates jobs in a job queue. Jobs that are in the <code>STARTING</code> or <code>RUNNING</code> state are * terminated, which causes them to transition to <code>FAILED</code>. Jobs that have not progressed to the * <code>STARTING</code> state are cancelled. * </p> * * @param terminateJobRequest * @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 permission to use the action or resource, or specifying an identifier that is not * valid. * @throws ServerException * These errors are usually caused by a server issue. * @sample AWSBatch.TerminateJob * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/TerminateJob" target="_top">AWS API * Documentation</a> */ @Override public TerminateJobResult terminateJob(TerminateJobRequest request) { request = beforeClientExecution(request); return executeTerminateJob(request); } @SdkInternalApi final TerminateJobResult executeTerminateJob(TerminateJobRequest terminateJobRequest) { ExecutionContext executionContext = createExecutionContext(terminateJobRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request<TerminateJobRequest> request = null; Response<TerminateJobResult> response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new TerminateJobRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(terminateJobRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler<AmazonWebServiceResponse<TerminateJobResult>> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new TerminateJobResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** * <p> * Updates an AWS Batch compute environment. * </p> * * @param updateComputeEnvironmentRequest * @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 permission to use the action or resource, or specifying an identifier that is not * valid. * @throws ServerException * These errors are usually caused by a server issue. * @sample AWSBatch.UpdateComputeEnvironment * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateComputeEnvironment" target="_top">AWS * API Documentation</a> */ @Override public UpdateComputeEnvironmentResult updateComputeEnvironment(UpdateComputeEnvironmentRequest request) { request = beforeClientExecution(request); return executeUpdateComputeEnvironment(request); } @SdkInternalApi final UpdateComputeEnvironmentResult executeUpdateComputeEnvironment(UpdateComputeEnvironmentRequest updateComputeEnvironmentRequest) { ExecutionContext executionContext = createExecutionContext(updateComputeEnvironmentRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request<UpdateComputeEnvironmentRequest> request = null; Response<UpdateComputeEnvironmentResult> response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new UpdateComputeEnvironmentRequestProtocolMarshaller(protocolFactory).marshall(super .beforeMarshalling(updateComputeEnvironmentRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler<AmazonWebServiceResponse<UpdateComputeEnvironmentResult>> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new UpdateComputeEnvironmentResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** * <p> * Updates a job queue. * </p> * * @param updateJobQueueRequest * @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 permission to use the action or resource, or specifying an identifier that is not * valid. * @throws ServerException * These errors are usually caused by a server issue. * @sample AWSBatch.UpdateJobQueue * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateJobQueue" target="_top">AWS API * Documentation</a> */ @Override public UpdateJobQueueResult updateJobQueue(UpdateJobQueueRequest request) { request = beforeClientExecution(request); return executeUpdateJobQueue(request); } @SdkInternalApi final UpdateJobQueueResult executeUpdateJobQueue(UpdateJobQueueRequest updateJobQueueRequest) { ExecutionContext executionContext = createExecutionContext(updateJobQueueRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request<UpdateJobQueueRequest> request = null; Response<UpdateJobQueueResult> response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new UpdateJobQueueRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(updateJobQueueRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler<AmazonWebServiceResponse<UpdateJobQueueResult>> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new UpdateJobQueueResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** * Returns additional metadata for a previously executed successful, request, typically used for debugging issues * where a service isn't acting as expected. This data isn't considered part of the result data returned by an * operation, so it's available through this separate, diagnostic interface. * <p> * Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic * information for an executed request, you should use this method to retrieve it as soon as possible after * executing the request. * * @param request * The originally executed request * * @return The response metadata for the specified request, or null if none is available. */ public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) { return client.getResponseMetadataForRequest(request); } /** * Normal invoke with authentication. Credentials are required and may be overriden at the request level. **/ private <X, Y extends AmazonWebServiceRequest> Response<X> invoke(Request<Y> request, HttpResponseHandler<AmazonWebServiceResponse<X>> responseHandler, ExecutionContext executionContext) { executionContext.setCredentialsProvider(CredentialUtils.getCredentialsProvider(request.getOriginalRequest(), awsCredentialsProvider)); return doInvoke(request, responseHandler, executionContext); } /** * Invoke with no authentication. Credentials are not required and any credentials set on the client or request will * be ignored for this operation. **/ private <X, Y extends AmazonWebServiceRequest> Response<X> anonymousInvoke(Request<Y> request, HttpResponseHandler<AmazonWebServiceResponse<X>> responseHandler, ExecutionContext executionContext) { return doInvoke(request, responseHandler, executionContext); } /** * Invoke the request using the http client. Assumes credentials (or lack thereof) have been configured in the * ExecutionContext beforehand. **/ private <X, Y extends AmazonWebServiceRequest> Response<X> doInvoke(Request<Y> request, HttpResponseHandler<AmazonWebServiceResponse<X>> responseHandler, ExecutionContext executionContext) { request.setEndpoint(endpoint); request.setTimeOffset(timeOffset); HttpResponseHandler<AmazonServiceException> errorResponseHandler = protocolFactory.createErrorResponseHandler(new JsonErrorResponseMetadata()); return client.execute(request, responseHandler, errorResponseHandler, executionContext); } }