AWS SDK for C++  1.9.2
AWS SDK for C++
Public Types | Public Member Functions | List of all members
Aws::Batch::BatchClient Class Reference

#include <BatchClient.h>

+ Inheritance diagram for Aws::Batch::BatchClient:

Public Types

typedef Aws::Client::AWSJsonClient BASECLASS
 
- Public Types inherited from Aws::Client::AWSJsonClient
typedef AWSClient BASECLASS
 

Public Member Functions

 BatchClient (const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 BatchClient (const Aws::Auth::AWSCredentials &credentials, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 BatchClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
virtual ~BatchClient ()
 
virtual Model::CancelJobOutcome CancelJob (const Model::CancelJobRequest &request) const
 
virtual Model::CancelJobOutcomeCallable CancelJobCallable (const Model::CancelJobRequest &request) const
 
virtual void CancelJobAsync (const Model::CancelJobRequest &request, const CancelJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::CreateComputeEnvironmentOutcome CreateComputeEnvironment (const Model::CreateComputeEnvironmentRequest &request) const
 
virtual Model::CreateComputeEnvironmentOutcomeCallable CreateComputeEnvironmentCallable (const Model::CreateComputeEnvironmentRequest &request) const
 
virtual void CreateComputeEnvironmentAsync (const Model::CreateComputeEnvironmentRequest &request, const CreateComputeEnvironmentResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::CreateJobQueueOutcome CreateJobQueue (const Model::CreateJobQueueRequest &request) const
 
virtual Model::CreateJobQueueOutcomeCallable CreateJobQueueCallable (const Model::CreateJobQueueRequest &request) const
 
virtual void CreateJobQueueAsync (const Model::CreateJobQueueRequest &request, const CreateJobQueueResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteComputeEnvironmentOutcome DeleteComputeEnvironment (const Model::DeleteComputeEnvironmentRequest &request) const
 
virtual Model::DeleteComputeEnvironmentOutcomeCallable DeleteComputeEnvironmentCallable (const Model::DeleteComputeEnvironmentRequest &request) const
 
virtual void DeleteComputeEnvironmentAsync (const Model::DeleteComputeEnvironmentRequest &request, const DeleteComputeEnvironmentResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteJobQueueOutcome DeleteJobQueue (const Model::DeleteJobQueueRequest &request) const
 
virtual Model::DeleteJobQueueOutcomeCallable DeleteJobQueueCallable (const Model::DeleteJobQueueRequest &request) const
 
virtual void DeleteJobQueueAsync (const Model::DeleteJobQueueRequest &request, const DeleteJobQueueResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeregisterJobDefinitionOutcome DeregisterJobDefinition (const Model::DeregisterJobDefinitionRequest &request) const
 
virtual Model::DeregisterJobDefinitionOutcomeCallable DeregisterJobDefinitionCallable (const Model::DeregisterJobDefinitionRequest &request) const
 
virtual void DeregisterJobDefinitionAsync (const Model::DeregisterJobDefinitionRequest &request, const DeregisterJobDefinitionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeComputeEnvironmentsOutcome DescribeComputeEnvironments (const Model::DescribeComputeEnvironmentsRequest &request) const
 
virtual Model::DescribeComputeEnvironmentsOutcomeCallable DescribeComputeEnvironmentsCallable (const Model::DescribeComputeEnvironmentsRequest &request) const
 
virtual void DescribeComputeEnvironmentsAsync (const Model::DescribeComputeEnvironmentsRequest &request, const DescribeComputeEnvironmentsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeJobDefinitionsOutcome DescribeJobDefinitions (const Model::DescribeJobDefinitionsRequest &request) const
 
virtual Model::DescribeJobDefinitionsOutcomeCallable DescribeJobDefinitionsCallable (const Model::DescribeJobDefinitionsRequest &request) const
 
virtual void DescribeJobDefinitionsAsync (const Model::DescribeJobDefinitionsRequest &request, const DescribeJobDefinitionsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeJobQueuesOutcome DescribeJobQueues (const Model::DescribeJobQueuesRequest &request) const
 
virtual Model::DescribeJobQueuesOutcomeCallable DescribeJobQueuesCallable (const Model::DescribeJobQueuesRequest &request) const
 
virtual void DescribeJobQueuesAsync (const Model::DescribeJobQueuesRequest &request, const DescribeJobQueuesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeJobsOutcome DescribeJobs (const Model::DescribeJobsRequest &request) const
 
virtual Model::DescribeJobsOutcomeCallable DescribeJobsCallable (const Model::DescribeJobsRequest &request) const
 
virtual void DescribeJobsAsync (const Model::DescribeJobsRequest &request, const DescribeJobsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListJobsOutcome ListJobs (const Model::ListJobsRequest &request) const
 
virtual Model::ListJobsOutcomeCallable ListJobsCallable (const Model::ListJobsRequest &request) const
 
virtual void ListJobsAsync (const Model::ListJobsRequest &request, const ListJobsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListTagsForResourceOutcome ListTagsForResource (const Model::ListTagsForResourceRequest &request) const
 
virtual Model::ListTagsForResourceOutcomeCallable ListTagsForResourceCallable (const Model::ListTagsForResourceRequest &request) const
 
virtual void ListTagsForResourceAsync (const Model::ListTagsForResourceRequest &request, const ListTagsForResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::RegisterJobDefinitionOutcome RegisterJobDefinition (const Model::RegisterJobDefinitionRequest &request) const
 
virtual Model::RegisterJobDefinitionOutcomeCallable RegisterJobDefinitionCallable (const Model::RegisterJobDefinitionRequest &request) const
 
virtual void RegisterJobDefinitionAsync (const Model::RegisterJobDefinitionRequest &request, const RegisterJobDefinitionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::SubmitJobOutcome SubmitJob (const Model::SubmitJobRequest &request) const
 
virtual Model::SubmitJobOutcomeCallable SubmitJobCallable (const Model::SubmitJobRequest &request) const
 
virtual void SubmitJobAsync (const Model::SubmitJobRequest &request, const SubmitJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::TagResourceOutcome TagResource (const Model::TagResourceRequest &request) const
 
virtual Model::TagResourceOutcomeCallable TagResourceCallable (const Model::TagResourceRequest &request) const
 
virtual void TagResourceAsync (const Model::TagResourceRequest &request, const TagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::TerminateJobOutcome TerminateJob (const Model::TerminateJobRequest &request) const
 
virtual Model::TerminateJobOutcomeCallable TerminateJobCallable (const Model::TerminateJobRequest &request) const
 
virtual void TerminateJobAsync (const Model::TerminateJobRequest &request, const TerminateJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UntagResourceOutcome UntagResource (const Model::UntagResourceRequest &request) const
 
virtual Model::UntagResourceOutcomeCallable UntagResourceCallable (const Model::UntagResourceRequest &request) const
 
virtual void UntagResourceAsync (const Model::UntagResourceRequest &request, const UntagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UpdateComputeEnvironmentOutcome UpdateComputeEnvironment (const Model::UpdateComputeEnvironmentRequest &request) const
 
virtual Model::UpdateComputeEnvironmentOutcomeCallable UpdateComputeEnvironmentCallable (const Model::UpdateComputeEnvironmentRequest &request) const
 
virtual void UpdateComputeEnvironmentAsync (const Model::UpdateComputeEnvironmentRequest &request, const UpdateComputeEnvironmentResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UpdateJobQueueOutcome UpdateJobQueue (const Model::UpdateJobQueueRequest &request) const
 
virtual Model::UpdateJobQueueOutcomeCallable UpdateJobQueueCallable (const Model::UpdateJobQueueRequest &request) const
 
virtual void UpdateJobQueueAsync (const Model::UpdateJobQueueRequest &request, const UpdateJobQueueResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
void OverrideEndpoint (const Aws::String &endpoint)
 
- Public Member Functions inherited from Aws::Client::AWSJsonClient
 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSJsonClient ()=default
 
- Public Member Functions inherited from Aws::Client::AWSClient
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSClient ()
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
void DisableRequestProcessing ()
 
void EnableRequestProcessing ()
 
virtual const char * GetServiceClientName () const
 
virtual void SetServiceClientName (const Aws::String &name)
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::Client::AWSJsonClient
virtual AWSError< CoreErrorsBuildAWSError (const std::shared_ptr< Aws::Http::HttpResponse > &response) const override
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeEventStreamRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 
- Protected Member Functions inherited from Aws::Client::AWSClient
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod httpMethod, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, Http::HttpMethod httpMethod, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const Aws::AmazonWebServiceRequest &request, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
virtual void BuildHttpRequest (const Aws::AmazonWebServiceRequest &request, const std::shared_ptr< Aws::Http::HttpRequest > &httpRequest) const
 
const std::shared_ptr< AWSErrorMarshaller > & GetErrorMarshaller () const
 
Aws::Client::AWSAuthSignerGetSignerByName (const char *name) const
 
std::shared_ptr< Aws::Http::HttpRequestBuildAndSignHttpRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method, const char *signerName) const
 
std::shared_ptr< Aws::Http::HttpResponseMakeHttpRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 
- Protected Attributes inherited from Aws::Client::AWSClient
Aws::String m_region
 

Detailed Description

Using AWS Batch, you can run batch computing workloads on the AWS Cloud. Batch computing is a common means for developers, scientists, and engineers to access large amounts of compute resources. AWS Batch uses the advantages of this computing workload to remove the undifferentiated heavy lifting of configuring and managing required infrastructure. At the same time, it also adopts a familiar batch computing software approach. Given these advantages, AWS Batch can help you to efficiently provision resources in response to jobs submitted, thus effectively helping you to eliminate capacity constraints, reduce compute costs, and deliver your results more quickly.

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

Definition at line 172 of file BatchClient.h.

Member Typedef Documentation

◆ BASECLASS

Definition at line 175 of file BatchClient.h.

Constructor & Destructor Documentation

◆ BatchClient() [1/3]

Aws::Batch::BatchClient::BatchClient ( const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration())

Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ BatchClient() [2/3]

Aws::Batch::BatchClient::BatchClient ( const Aws::Auth::AWSCredentials credentials,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration() 
)

Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ BatchClient() [3/3]

Aws::Batch::BatchClient::BatchClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration() 
)

Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used

◆ ~BatchClient()

virtual Aws::Batch::BatchClient::~BatchClient ( )
virtual

Member Function Documentation

◆ CancelJob()

virtual Model::CancelJobOutcome Aws::Batch::BatchClient::CancelJob ( const Model::CancelJobRequest request) const
virtual

Cancels a job in an AWS 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.

See Also:

AWS API Reference

◆ CancelJobAsync()

virtual void Aws::Batch::BatchClient::CancelJobAsync ( const Model::CancelJobRequest request,
const CancelJobResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Cancels a job in an AWS 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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ CancelJobCallable()

virtual Model::CancelJobOutcomeCallable Aws::Batch::BatchClient::CancelJobCallable ( const Model::CancelJobRequest request) const
virtual

Cancels a job in an AWS 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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ CreateComputeEnvironment()

virtual Model::CreateComputeEnvironmentOutcome Aws::Batch::BatchClient::CreateComputeEnvironment ( const Model::CreateComputeEnvironmentRequest request) const
virtual

Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute environments. MANAGED compute environments can use Amazon EC2 or AWS Fargate resources. UNMANAGED compute environments can only use EC2 resources.

In a managed compute environment, AWS 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.

AWS Batch doesn't upgrade the AMIs in a compute environment after the environment is created. For example, it doesn't update the AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore, you're responsible for managing the guest operating system (including its updates and security patches) and any additional application software or utilities that you install on the compute resources. To use a new AMI for your AWS Batch jobs, complete these steps:

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

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

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

  4. Delete the earlier compute environment.

See Also:

AWS API Reference

◆ CreateComputeEnvironmentAsync()

virtual void Aws::Batch::BatchClient::CreateComputeEnvironmentAsync ( const Model::CreateComputeEnvironmentRequest request,
const CreateComputeEnvironmentResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute environments. MANAGED compute environments can use Amazon EC2 or AWS Fargate resources. UNMANAGED compute environments can only use EC2 resources.

In a managed compute environment, AWS 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.

AWS Batch doesn't upgrade the AMIs in a compute environment after the environment is created. For example, it doesn't update the AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore, you're responsible for managing the guest operating system (including its updates and security patches) and any additional application software or utilities that you install on the compute resources. To use a new AMI for your AWS Batch jobs, complete these steps:

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

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

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

  4. Delete the earlier compute environment.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ CreateComputeEnvironmentCallable()

virtual Model::CreateComputeEnvironmentOutcomeCallable Aws::Batch::BatchClient::CreateComputeEnvironmentCallable ( const Model::CreateComputeEnvironmentRequest request) const
virtual

Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute environments. MANAGED compute environments can use Amazon EC2 or AWS Fargate resources. UNMANAGED compute environments can only use EC2 resources.

In a managed compute environment, AWS 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.

AWS Batch doesn't upgrade the AMIs in a compute environment after the environment is created. For example, it doesn't update the AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore, you're responsible for managing the guest operating system (including its updates and security patches) and any additional application software or utilities that you install on the compute resources. To use a new AMI for your AWS Batch jobs, complete these steps:

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

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

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

  4. Delete the earlier compute environment.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ CreateJobQueue()

virtual Model::CreateJobQueueOutcome Aws::Batch::BatchClient::CreateJobQueue ( const Model::CreateJobQueueRequest request) const
virtual

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.

You also set a priority to the job queue that determines the order that 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.

See Also:

AWS API Reference

◆ CreateJobQueueAsync()

virtual void Aws::Batch::BatchClient::CreateJobQueueAsync ( const Model::CreateJobQueueRequest request,
const CreateJobQueueResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

You also set a priority to the job queue that determines the order that 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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ CreateJobQueueCallable()

virtual Model::CreateJobQueueOutcomeCallable Aws::Batch::BatchClient::CreateJobQueueCallable ( const Model::CreateJobQueueRequest request) const
virtual

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.

You also set a priority to the job queue that determines the order that 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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeleteComputeEnvironment()

virtual Model::DeleteComputeEnvironmentOutcome Aws::Batch::BatchClient::DeleteComputeEnvironment ( const Model::DeleteComputeEnvironmentRequest request) const
virtual

Deletes an AWS 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 AWS 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.

See Also:

AWS API Reference

◆ DeleteComputeEnvironmentAsync()

virtual void Aws::Batch::BatchClient::DeleteComputeEnvironmentAsync ( const Model::DeleteComputeEnvironmentRequest request,
const DeleteComputeEnvironmentResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deletes an AWS 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 AWS 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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeleteComputeEnvironmentCallable()

virtual Model::DeleteComputeEnvironmentOutcomeCallable Aws::Batch::BatchClient::DeleteComputeEnvironmentCallable ( const Model::DeleteComputeEnvironmentRequest request) const
virtual

Deletes an AWS 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 AWS 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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeleteJobQueue()

virtual Model::DeleteJobQueueOutcome Aws::Batch::BatchClient::DeleteJobQueue ( const Model::DeleteJobQueueRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ DeleteJobQueueAsync()

virtual void Aws::Batch::BatchClient::DeleteJobQueueAsync ( const Model::DeleteJobQueueRequest request,
const DeleteJobQueueResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeleteJobQueueCallable()

virtual Model::DeleteJobQueueOutcomeCallable Aws::Batch::BatchClient::DeleteJobQueueCallable ( const Model::DeleteJobQueueRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeregisterJobDefinition()

virtual Model::DeregisterJobDefinitionOutcome Aws::Batch::BatchClient::DeregisterJobDefinition ( const Model::DeregisterJobDefinitionRequest request) const
virtual

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

See Also:

AWS API Reference

◆ DeregisterJobDefinitionAsync()

virtual void Aws::Batch::BatchClient::DeregisterJobDefinitionAsync ( const Model::DeregisterJobDefinitionRequest request,
const DeregisterJobDefinitionResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeregisterJobDefinitionCallable()

virtual Model::DeregisterJobDefinitionOutcomeCallable Aws::Batch::BatchClient::DeregisterJobDefinitionCallable ( const Model::DeregisterJobDefinitionRequest request) const
virtual

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

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeComputeEnvironments()

virtual Model::DescribeComputeEnvironmentsOutcome Aws::Batch::BatchClient::DescribeComputeEnvironments ( const Model::DescribeComputeEnvironmentsRequest request) const
virtual

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 should launch your Amazon ECS container instances into.

See Also:

AWS API Reference

◆ DescribeComputeEnvironmentsAsync()

virtual void Aws::Batch::BatchClient::DescribeComputeEnvironmentsAsync ( const Model::DescribeComputeEnvironmentsRequest request,
const DescribeComputeEnvironmentsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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 should launch your Amazon ECS container instances into.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeComputeEnvironmentsCallable()

virtual Model::DescribeComputeEnvironmentsOutcomeCallable Aws::Batch::BatchClient::DescribeComputeEnvironmentsCallable ( const Model::DescribeComputeEnvironmentsRequest request) const
virtual

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 should launch your Amazon ECS container instances into.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeJobDefinitions()

virtual Model::DescribeJobDefinitionsOutcome Aws::Batch::BatchClient::DescribeJobDefinitions ( const Model::DescribeJobDefinitionsRequest request) const
virtual

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

See Also:

AWS API Reference

◆ DescribeJobDefinitionsAsync()

virtual void Aws::Batch::BatchClient::DescribeJobDefinitionsAsync ( const Model::DescribeJobDefinitionsRequest request,
const DescribeJobDefinitionsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeJobDefinitionsCallable()

virtual Model::DescribeJobDefinitionsOutcomeCallable Aws::Batch::BatchClient::DescribeJobDefinitionsCallable ( const Model::DescribeJobDefinitionsRequest request) const
virtual

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

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeJobQueues()

virtual Model::DescribeJobQueuesOutcome Aws::Batch::BatchClient::DescribeJobQueues ( const Model::DescribeJobQueuesRequest request) const
virtual

Describes one or more of your job queues.

See Also:

AWS API Reference

◆ DescribeJobQueuesAsync()

virtual void Aws::Batch::BatchClient::DescribeJobQueuesAsync ( const Model::DescribeJobQueuesRequest request,
const DescribeJobQueuesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Describes one or more of your job queues.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeJobQueuesCallable()

virtual Model::DescribeJobQueuesOutcomeCallable Aws::Batch::BatchClient::DescribeJobQueuesCallable ( const Model::DescribeJobQueuesRequest request) const
virtual

Describes one or more of your job queues.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeJobs()

virtual Model::DescribeJobsOutcome Aws::Batch::BatchClient::DescribeJobs ( const Model::DescribeJobsRequest request) const
virtual

Describes a list of AWS Batch jobs.

See Also:

AWS API Reference

◆ DescribeJobsAsync()

virtual void Aws::Batch::BatchClient::DescribeJobsAsync ( const Model::DescribeJobsRequest request,
const DescribeJobsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Describes a list of AWS Batch jobs.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeJobsCallable()

virtual Model::DescribeJobsOutcomeCallable Aws::Batch::BatchClient::DescribeJobsCallable ( const Model::DescribeJobsRequest request) const
virtual

Describes a list of AWS Batch jobs.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListJobs()

virtual Model::ListJobsOutcome Aws::Batch::BatchClient::ListJobs ( const Model::ListJobsRequest request) const
virtual

Returns a list of AWS 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.

See Also:

AWS API Reference

◆ ListJobsAsync()

virtual void Aws::Batch::BatchClient::ListJobsAsync ( const Model::ListJobsRequest request,
const ListJobsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns a list of AWS 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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListJobsCallable()

virtual Model::ListJobsOutcomeCallable Aws::Batch::BatchClient::ListJobsCallable ( const Model::ListJobsRequest request) const
virtual

Returns a list of AWS 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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListTagsForResource()

virtual Model::ListTagsForResourceOutcome Aws::Batch::BatchClient::ListTagsForResource ( const Model::ListTagsForResourceRequest request) const
virtual

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

See Also:

AWS API Reference

◆ ListTagsForResourceAsync()

virtual void Aws::Batch::BatchClient::ListTagsForResourceAsync ( const Model::ListTagsForResourceRequest request,
const ListTagsForResourceResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListTagsForResourceCallable()

virtual Model::ListTagsForResourceOutcomeCallable Aws::Batch::BatchClient::ListTagsForResourceCallable ( const Model::ListTagsForResourceRequest request) const
virtual

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

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ OverrideEndpoint()

void Aws::Batch::BatchClient::OverrideEndpoint ( const Aws::String endpoint)

◆ RegisterJobDefinition()

virtual Model::RegisterJobDefinitionOutcome Aws::Batch::BatchClient::RegisterJobDefinition ( const Model::RegisterJobDefinitionRequest request) const
virtual

Registers an AWS Batch job definition.

See Also:

AWS API Reference

◆ RegisterJobDefinitionAsync()

virtual void Aws::Batch::BatchClient::RegisterJobDefinitionAsync ( const Model::RegisterJobDefinitionRequest request,
const RegisterJobDefinitionResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Registers an AWS Batch job definition.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ RegisterJobDefinitionCallable()

virtual Model::RegisterJobDefinitionOutcomeCallable Aws::Batch::BatchClient::RegisterJobDefinitionCallable ( const Model::RegisterJobDefinitionRequest request) const
virtual

Registers an AWS Batch job definition.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ SubmitJob()

virtual Model::SubmitJobOutcome Aws::Batch::BatchClient::SubmitJob ( const Model::SubmitJobRequest request) const
virtual

Submits an AWS 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.

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.

See Also:


AWS API Reference

◆ SubmitJobAsync()

virtual void Aws::Batch::BatchClient::SubmitJobAsync ( const Model::SubmitJobRequest request,
const SubmitJobResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Submits an AWS 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.

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.

See Also:


AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ SubmitJobCallable()

virtual Model::SubmitJobOutcomeCallable Aws::Batch::BatchClient::SubmitJobCallable ( const Model::SubmitJobRequest request) const
virtual

Submits an AWS 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.

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.

See Also:


AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ TagResource()

virtual Model::TagResourceOutcome Aws::Batch::BatchClient::TagResource ( const Model::TagResourceRequest request) const
virtual

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 associated with that resource are deleted as well. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

See Also:

AWS API Reference

◆ TagResourceAsync()

virtual void Aws::Batch::BatchClient::TagResourceAsync ( const Model::TagResourceRequest request,
const TagResourceResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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 associated with that resource are deleted as well. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ TagResourceCallable()

virtual Model::TagResourceOutcomeCallable Aws::Batch::BatchClient::TagResourceCallable ( const Model::TagResourceRequest request) const
virtual

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 associated with that resource are deleted as well. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ TerminateJob()

virtual Model::TerminateJobOutcome Aws::Batch::BatchClient::TerminateJob ( const Model::TerminateJobRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ TerminateJobAsync()

virtual void Aws::Batch::BatchClient::TerminateJobAsync ( const Model::TerminateJobRequest request,
const TerminateJobResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ TerminateJobCallable()

virtual Model::TerminateJobOutcomeCallable Aws::Batch::BatchClient::TerminateJobCallable ( const Model::TerminateJobRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UntagResource()

virtual Model::UntagResourceOutcome Aws::Batch::BatchClient::UntagResource ( const Model::UntagResourceRequest request) const
virtual

Deletes specified tags from an AWS Batch resource.

See Also:


AWS API Reference

◆ UntagResourceAsync()

virtual void Aws::Batch::BatchClient::UntagResourceAsync ( const Model::UntagResourceRequest request,
const UntagResourceResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deletes specified tags from an AWS Batch resource.

See Also:


AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UntagResourceCallable()

virtual Model::UntagResourceOutcomeCallable Aws::Batch::BatchClient::UntagResourceCallable ( const Model::UntagResourceRequest request) const
virtual

Deletes specified tags from an AWS Batch resource.

See Also:


AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UpdateComputeEnvironment()

virtual Model::UpdateComputeEnvironmentOutcome Aws::Batch::BatchClient::UpdateComputeEnvironment ( const Model::UpdateComputeEnvironmentRequest request) const
virtual

Updates an AWS Batch compute environment.

See Also:

AWS API Reference

◆ UpdateComputeEnvironmentAsync()

virtual void Aws::Batch::BatchClient::UpdateComputeEnvironmentAsync ( const Model::UpdateComputeEnvironmentRequest request,
const UpdateComputeEnvironmentResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Updates an AWS Batch compute environment.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UpdateComputeEnvironmentCallable()

virtual Model::UpdateComputeEnvironmentOutcomeCallable Aws::Batch::BatchClient::UpdateComputeEnvironmentCallable ( const Model::UpdateComputeEnvironmentRequest request) const
virtual

Updates an AWS Batch compute environment.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UpdateJobQueue()

virtual Model::UpdateJobQueueOutcome Aws::Batch::BatchClient::UpdateJobQueue ( const Model::UpdateJobQueueRequest request) const
virtual

Updates a job queue.

See Also:

AWS API Reference

◆ UpdateJobQueueAsync()

virtual void Aws::Batch::BatchClient::UpdateJobQueueAsync ( const Model::UpdateJobQueueRequest request,
const UpdateJobQueueResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Updates a job queue.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UpdateJobQueueCallable()

virtual Model::UpdateJobQueueOutcomeCallable Aws::Batch::BatchClient::UpdateJobQueueCallable ( const Model::UpdateJobQueueRequest request) const
virtual

Updates a job queue.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.


The documentation for this class was generated from the following file: