Aws::Batch::BatchClient Class Reference

#include <BatchClient.h>

Inheritance diagram for Aws::Batch::BatchClient:

Public Types

typedef Aws::Client::AWSJsonClient BASECLASS

 

typedef BatchClientConfiguration ClientConfigurationType

 

typedef BatchEndpointProvider EndpointProviderType

 

Public Types inherited from Aws::Client::AWSJsonClient

typedef AWSClient BASECLASS

 

Public Member Functions

 BatchClient (const Aws::Batch::BatchClientConfiguration &clientConfiguration=Aws::Batch::BatchClientConfiguration(), std::shared_ptr< BatchEndpointProviderBase > endpointProvider=nullptr)

 

 BatchClient (const Aws::Auth::AWSCredentials &credentials, std::shared_ptr< BatchEndpointProviderBase > endpointProvider=nullptr, const Aws::Batch::BatchClientConfiguration &clientConfiguration=Aws::Batch::BatchClientConfiguration())

 

 BatchClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, std::shared_ptr< BatchEndpointProviderBase > endpointProvider=nullptr, const Aws::Batch::BatchClientConfiguration &clientConfiguration=Aws::Batch::BatchClientConfiguration())

 

 BatchClient (const Aws::Client::ClientConfiguration &clientConfiguration)

 

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

 

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

 

virtual ~BatchClient ()

 

virtual Model::CancelJobOutcome CancelJob (const Model::CancelJobRequest &request) const

 

template<typename CancelJobRequestT = Model::CancelJobRequest>

Model::CancelJobOutcomeCallable CancelJobCallable (const CancelJobRequestT &request) const

 

template<typename CancelJobRequestT = Model::CancelJobRequest>

void CancelJobAsync (const CancelJobRequestT &request, const CancelJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::CreateComputeEnvironmentOutcome CreateComputeEnvironment (const Model::CreateComputeEnvironmentRequest &request) const

 

template<typename CreateComputeEnvironmentRequestT = Model::CreateComputeEnvironmentRequest>

Model::CreateComputeEnvironmentOutcomeCallable CreateComputeEnvironmentCallable (const CreateComputeEnvironmentRequestT &request) const

 

template<typename CreateComputeEnvironmentRequestT = Model::CreateComputeEnvironmentRequest>

void CreateComputeEnvironmentAsync (const CreateComputeEnvironmentRequestT &request, const CreateComputeEnvironmentResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::CreateConsumableResourceOutcome CreateConsumableResource (const Model::CreateConsumableResourceRequest &request) const

 

template<typename CreateConsumableResourceRequestT = Model::CreateConsumableResourceRequest>

Model::CreateConsumableResourceOutcomeCallable CreateConsumableResourceCallable (const CreateConsumableResourceRequestT &request) const

 

template<typename CreateConsumableResourceRequestT = Model::CreateConsumableResourceRequest>

void CreateConsumableResourceAsync (const CreateConsumableResourceRequestT &request, const CreateConsumableResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::CreateJobQueueOutcome CreateJobQueue (const Model::CreateJobQueueRequest &request) const

 

template<typename CreateJobQueueRequestT = Model::CreateJobQueueRequest>

Model::CreateJobQueueOutcomeCallable CreateJobQueueCallable (const CreateJobQueueRequestT &request) const

 

template<typename CreateJobQueueRequestT = Model::CreateJobQueueRequest>

void CreateJobQueueAsync (const CreateJobQueueRequestT &request, const CreateJobQueueResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::CreateSchedulingPolicyOutcome CreateSchedulingPolicy (const Model::CreateSchedulingPolicyRequest &request) const

 

template<typename CreateSchedulingPolicyRequestT = Model::CreateSchedulingPolicyRequest>

Model::CreateSchedulingPolicyOutcomeCallable CreateSchedulingPolicyCallable (const CreateSchedulingPolicyRequestT &request) const

 

template<typename CreateSchedulingPolicyRequestT = Model::CreateSchedulingPolicyRequest>

void CreateSchedulingPolicyAsync (const CreateSchedulingPolicyRequestT &request, const CreateSchedulingPolicyResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DeleteComputeEnvironmentOutcome DeleteComputeEnvironment (const Model::DeleteComputeEnvironmentRequest &request) const

 

template<typename DeleteComputeEnvironmentRequestT = Model::DeleteComputeEnvironmentRequest>

Model::DeleteComputeEnvironmentOutcomeCallable DeleteComputeEnvironmentCallable (const DeleteComputeEnvironmentRequestT &request) const

 

template<typename DeleteComputeEnvironmentRequestT = Model::DeleteComputeEnvironmentRequest>

void DeleteComputeEnvironmentAsync (const DeleteComputeEnvironmentRequestT &request, const DeleteComputeEnvironmentResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DeleteConsumableResourceOutcome DeleteConsumableResource (const Model::DeleteConsumableResourceRequest &request) const

 

template<typename DeleteConsumableResourceRequestT = Model::DeleteConsumableResourceRequest>

Model::DeleteConsumableResourceOutcomeCallable DeleteConsumableResourceCallable (const DeleteConsumableResourceRequestT &request) const

 

template<typename DeleteConsumableResourceRequestT = Model::DeleteConsumableResourceRequest>

void DeleteConsumableResourceAsync (const DeleteConsumableResourceRequestT &request, const DeleteConsumableResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DeleteJobQueueOutcome DeleteJobQueue (const Model::DeleteJobQueueRequest &request) const

 

template<typename DeleteJobQueueRequestT = Model::DeleteJobQueueRequest>

Model::DeleteJobQueueOutcomeCallable DeleteJobQueueCallable (const DeleteJobQueueRequestT &request) const

 

template<typename DeleteJobQueueRequestT = Model::DeleteJobQueueRequest>

void DeleteJobQueueAsync (const DeleteJobQueueRequestT &request, const DeleteJobQueueResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DeleteSchedulingPolicyOutcome DeleteSchedulingPolicy (const Model::DeleteSchedulingPolicyRequest &request) const

 

template<typename DeleteSchedulingPolicyRequestT = Model::DeleteSchedulingPolicyRequest>

Model::DeleteSchedulingPolicyOutcomeCallable DeleteSchedulingPolicyCallable (const DeleteSchedulingPolicyRequestT &request) const

 

template<typename DeleteSchedulingPolicyRequestT = Model::DeleteSchedulingPolicyRequest>

void DeleteSchedulingPolicyAsync (const DeleteSchedulingPolicyRequestT &request, const DeleteSchedulingPolicyResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DeregisterJobDefinitionOutcome DeregisterJobDefinition (const Model::DeregisterJobDefinitionRequest &request) const

 

template<typename DeregisterJobDefinitionRequestT = Model::DeregisterJobDefinitionRequest>

Model::DeregisterJobDefinitionOutcomeCallable DeregisterJobDefinitionCallable (const DeregisterJobDefinitionRequestT &request) const

 

template<typename DeregisterJobDefinitionRequestT = Model::DeregisterJobDefinitionRequest>

void DeregisterJobDefinitionAsync (const DeregisterJobDefinitionRequestT &request, const DeregisterJobDefinitionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DescribeComputeEnvironmentsOutcome DescribeComputeEnvironments (const Model::DescribeComputeEnvironmentsRequest &request={}) const

 

template<typename DescribeComputeEnvironmentsRequestT = Model::DescribeComputeEnvironmentsRequest>

Model::DescribeComputeEnvironmentsOutcomeCallable DescribeComputeEnvironmentsCallable (const DescribeComputeEnvironmentsRequestT &request={}) const

 

template<typename DescribeComputeEnvironmentsRequestT = Model::DescribeComputeEnvironmentsRequest>

void DescribeComputeEnvironmentsAsync (const DescribeComputeEnvironmentsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const DescribeComputeEnvironmentsRequestT &request={}) const

 

virtual Model::DescribeConsumableResourceOutcome DescribeConsumableResource (const Model::DescribeConsumableResourceRequest &request) const

 

template<typename DescribeConsumableResourceRequestT = Model::DescribeConsumableResourceRequest>

Model::DescribeConsumableResourceOutcomeCallable DescribeConsumableResourceCallable (const DescribeConsumableResourceRequestT &request) const

 

template<typename DescribeConsumableResourceRequestT = Model::DescribeConsumableResourceRequest>

void DescribeConsumableResourceAsync (const DescribeConsumableResourceRequestT &request, const DescribeConsumableResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DescribeJobDefinitionsOutcome DescribeJobDefinitions (const Model::DescribeJobDefinitionsRequest &request={}) const

 

template<typename DescribeJobDefinitionsRequestT = Model::DescribeJobDefinitionsRequest>

Model::DescribeJobDefinitionsOutcomeCallable DescribeJobDefinitionsCallable (const DescribeJobDefinitionsRequestT &request={}) const

 

template<typename DescribeJobDefinitionsRequestT = Model::DescribeJobDefinitionsRequest>

void DescribeJobDefinitionsAsync (const DescribeJobDefinitionsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const DescribeJobDefinitionsRequestT &request={}) const

 

virtual Model::DescribeJobQueuesOutcome DescribeJobQueues (const Model::DescribeJobQueuesRequest &request={}) const

 

template<typename DescribeJobQueuesRequestT = Model::DescribeJobQueuesRequest>

Model::DescribeJobQueuesOutcomeCallable DescribeJobQueuesCallable (const DescribeJobQueuesRequestT &request={}) const

 

template<typename DescribeJobQueuesRequestT = Model::DescribeJobQueuesRequest>

void DescribeJobQueuesAsync (const DescribeJobQueuesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const DescribeJobQueuesRequestT &request={}) const

 

virtual Model::DescribeJobsOutcome DescribeJobs (const Model::DescribeJobsRequest &request) const

 

template<typename DescribeJobsRequestT = Model::DescribeJobsRequest>

Model::DescribeJobsOutcomeCallable DescribeJobsCallable (const DescribeJobsRequestT &request) const

 

template<typename DescribeJobsRequestT = Model::DescribeJobsRequest>

void DescribeJobsAsync (const DescribeJobsRequestT &request, const DescribeJobsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DescribeSchedulingPoliciesOutcome DescribeSchedulingPolicies (const Model::DescribeSchedulingPoliciesRequest &request) const

 

template<typename DescribeSchedulingPoliciesRequestT = Model::DescribeSchedulingPoliciesRequest>

Model::DescribeSchedulingPoliciesOutcomeCallable DescribeSchedulingPoliciesCallable (const DescribeSchedulingPoliciesRequestT &request) const

 

template<typename DescribeSchedulingPoliciesRequestT = Model::DescribeSchedulingPoliciesRequest>

void DescribeSchedulingPoliciesAsync (const DescribeSchedulingPoliciesRequestT &request, const DescribeSchedulingPoliciesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::GetJobQueueSnapshotOutcome GetJobQueueSnapshot (const Model::GetJobQueueSnapshotRequest &request) const

 

template<typename GetJobQueueSnapshotRequestT = Model::GetJobQueueSnapshotRequest>

Model::GetJobQueueSnapshotOutcomeCallable GetJobQueueSnapshotCallable (const GetJobQueueSnapshotRequestT &request) const

 

template<typename GetJobQueueSnapshotRequestT = Model::GetJobQueueSnapshotRequest>

void GetJobQueueSnapshotAsync (const GetJobQueueSnapshotRequestT &request, const GetJobQueueSnapshotResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::ListConsumableResourcesOutcome ListConsumableResources (const Model::ListConsumableResourcesRequest &request={}) const

 

template<typename ListConsumableResourcesRequestT = Model::ListConsumableResourcesRequest>

Model::ListConsumableResourcesOutcomeCallable ListConsumableResourcesCallable (const ListConsumableResourcesRequestT &request={}) const

 

template<typename ListConsumableResourcesRequestT = Model::ListConsumableResourcesRequest>

void ListConsumableResourcesAsync (const ListConsumableResourcesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const ListConsumableResourcesRequestT &request={}) const

 

virtual Model::ListJobsOutcome ListJobs (const Model::ListJobsRequest &request={}) const

 

template<typename ListJobsRequestT = Model::ListJobsRequest>

Model::ListJobsOutcomeCallable ListJobsCallable (const ListJobsRequestT &request={}) const

 

template<typename ListJobsRequestT = Model::ListJobsRequest>

void ListJobsAsync (const ListJobsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const ListJobsRequestT &request={}) const

 

virtual Model::ListJobsByConsumableResourceOutcome ListJobsByConsumableResource (const Model::ListJobsByConsumableResourceRequest &request) const

 

template<typename ListJobsByConsumableResourceRequestT = Model::ListJobsByConsumableResourceRequest>

Model::ListJobsByConsumableResourceOutcomeCallable ListJobsByConsumableResourceCallable (const ListJobsByConsumableResourceRequestT &request) const

 

template<typename ListJobsByConsumableResourceRequestT = Model::ListJobsByConsumableResourceRequest>

void ListJobsByConsumableResourceAsync (const ListJobsByConsumableResourceRequestT &request, const ListJobsByConsumableResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::ListSchedulingPoliciesOutcome ListSchedulingPolicies (const Model::ListSchedulingPoliciesRequest &request={}) const

 

template<typename ListSchedulingPoliciesRequestT = Model::ListSchedulingPoliciesRequest>

Model::ListSchedulingPoliciesOutcomeCallable ListSchedulingPoliciesCallable (const ListSchedulingPoliciesRequestT &request={}) const

 

template<typename ListSchedulingPoliciesRequestT = Model::ListSchedulingPoliciesRequest>

void ListSchedulingPoliciesAsync (const ListSchedulingPoliciesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const ListSchedulingPoliciesRequestT &request={}) const

 

virtual Model::ListTagsForResourceOutcome ListTagsForResource (const Model::ListTagsForResourceRequest &request) const

 

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

Model::ListTagsForResourceOutcomeCallable ListTagsForResourceCallable (const ListTagsForResourceRequestT &request) const

 

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

void ListTagsForResourceAsync (const ListTagsForResourceRequestT &request, const ListTagsForResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::RegisterJobDefinitionOutcome RegisterJobDefinition (const Model::RegisterJobDefinitionRequest &request) const

 

template<typename RegisterJobDefinitionRequestT = Model::RegisterJobDefinitionRequest>

Model::RegisterJobDefinitionOutcomeCallable RegisterJobDefinitionCallable (const RegisterJobDefinitionRequestT &request) const

 

template<typename RegisterJobDefinitionRequestT = Model::RegisterJobDefinitionRequest>

void RegisterJobDefinitionAsync (const RegisterJobDefinitionRequestT &request, const RegisterJobDefinitionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::SubmitJobOutcome SubmitJob (const Model::SubmitJobRequest &request) const

 

template<typename SubmitJobRequestT = Model::SubmitJobRequest>

Model::SubmitJobOutcomeCallable SubmitJobCallable (const SubmitJobRequestT &request) const

 

template<typename SubmitJobRequestT = Model::SubmitJobRequest>

void SubmitJobAsync (const SubmitJobRequestT &request, const SubmitJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::TagResourceOutcome TagResource (const Model::TagResourceRequest &request) const

 

template<typename TagResourceRequestT = Model::TagResourceRequest>

Model::TagResourceOutcomeCallable TagResourceCallable (const TagResourceRequestT &request) const

 

template<typename TagResourceRequestT = Model::TagResourceRequest>

void TagResourceAsync (const TagResourceRequestT &request, const TagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::TerminateJobOutcome TerminateJob (const Model::TerminateJobRequest &request) const

 

template<typename TerminateJobRequestT = Model::TerminateJobRequest>

Model::TerminateJobOutcomeCallable TerminateJobCallable (const TerminateJobRequestT &request) const

 

template<typename TerminateJobRequestT = Model::TerminateJobRequest>

void TerminateJobAsync (const TerminateJobRequestT &request, const TerminateJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::UntagResourceOutcome UntagResource (const Model::UntagResourceRequest &request) const

 

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

Model::UntagResourceOutcomeCallable UntagResourceCallable (const UntagResourceRequestT &request) const

 

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

void UntagResourceAsync (const UntagResourceRequestT &request, const UntagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::UpdateComputeEnvironmentOutcome UpdateComputeEnvironment (const Model::UpdateComputeEnvironmentRequest &request) const

 

template<typename UpdateComputeEnvironmentRequestT = Model::UpdateComputeEnvironmentRequest>

Model::UpdateComputeEnvironmentOutcomeCallable UpdateComputeEnvironmentCallable (const UpdateComputeEnvironmentRequestT &request) const

 

template<typename UpdateComputeEnvironmentRequestT = Model::UpdateComputeEnvironmentRequest>

void UpdateComputeEnvironmentAsync (const UpdateComputeEnvironmentRequestT &request, const UpdateComputeEnvironmentResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::UpdateConsumableResourceOutcome UpdateConsumableResource (const Model::UpdateConsumableResourceRequest &request) const

 

template<typename UpdateConsumableResourceRequestT = Model::UpdateConsumableResourceRequest>

Model::UpdateConsumableResourceOutcomeCallable UpdateConsumableResourceCallable (const UpdateConsumableResourceRequestT &request) const

 

template<typename UpdateConsumableResourceRequestT = Model::UpdateConsumableResourceRequest>

void UpdateConsumableResourceAsync (const UpdateConsumableResourceRequestT &request, const UpdateConsumableResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::UpdateJobQueueOutcome UpdateJobQueue (const Model::UpdateJobQueueRequest &request) const

 

template<typename UpdateJobQueueRequestT = Model::UpdateJobQueueRequest>

Model::UpdateJobQueueOutcomeCallable UpdateJobQueueCallable (const UpdateJobQueueRequestT &request) const

 

template<typename UpdateJobQueueRequestT = Model::UpdateJobQueueRequest>

void UpdateJobQueueAsync (const UpdateJobQueueRequestT &request, const UpdateJobQueueResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::UpdateSchedulingPolicyOutcome UpdateSchedulingPolicy (const Model::UpdateSchedulingPolicyRequest &request) const

 

template<typename UpdateSchedulingPolicyRequestT = Model::UpdateSchedulingPolicyRequest>

Model::UpdateSchedulingPolicyOutcomeCallable UpdateSchedulingPolicyCallable (const UpdateSchedulingPolicyRequestT &request) const

 

template<typename UpdateSchedulingPolicyRequestT = Model::UpdateSchedulingPolicyRequest>

void UpdateSchedulingPolicyAsync (const UpdateSchedulingPolicyRequestT &request, const UpdateSchedulingPolicyResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

void OverrideEndpoint (const Aws::String &endpoint)

 

std::shared_ptr< BatchEndpointProviderBase > & accessEndpointProvider ()

 

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 (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::Endpoint::AWSEndpoint &endpoint, Aws::Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const Aws::Http::HeaderValueCollection &customizedHeaders={}, uint64_t expirationInSeconds=0, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const 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 std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

const std::shared_ptr< Aws::Http::HttpClient > & GetHttpClient () const

 

void DisableRequestProcessing ()

 

void EnableRequestProcessing ()

 

virtual const char * GetServiceClientName () const

 

virtual void SetServiceClientName (const Aws::String &name)

 

void AppendToUserAgent (const Aws::String &valueToAppend)

 

Public Member Functions inherited from Aws::Client::ClientWithAsyncTemplateMethods< BatchClient >

 ClientWithAsyncTemplateMethods ()

 

 ClientWithAsyncTemplateMethods (const ClientWithAsyncTemplateMethods &other)

 

ClientWithAsyncTemplateMethods & operator= (const ClientWithAsyncTemplateMethods &other)

 

virtual ~ClientWithAsyncTemplateMethods ()

 

void SubmitAsync (OperationFuncT operationFunc, const RequestT &request, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

void SubmitAsync (OperationFuncT operationFunc, RequestT &request, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

void SubmitAsync (OperationFuncT operationFunc, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

auto SubmitCallable (OperationFuncT operationFunc, const RequestT &request) const -> std::future< decltype((static_cast< const AwsServiceClientT * >(nullptr) -> *operationFunc)(request))>

 

auto SubmitCallable (OperationFuncT operationFunc, RequestT &request) const -> std::future< decltype((static_cast< const AwsServiceClientT * >(nullptr) -> *operationFunc)(request))>

 

auto SubmitCallable (OperationFuncT operationFunc) const -> std::future< decltype((static_cast< const AwsServiceClientT * >(nullptr) -> *operationFunc)())>

 

Static Public Member Functions

static const char * GetServiceName ()

 

static const char * GetAllocationTag ()

 

Static Public Member Functions inherited from Aws::Client::ClientWithAsyncTemplateMethods< BatchClient >

static void ShutdownSdkClient (void *pThis, int64_t timeoutMs=-1)

 

Friends

class Aws::Client::ClientWithAsyncTemplateMethods< BatchClient >

 

Additional Inherited Members

Protected Member Functions inherited from Aws::Client::AWSJsonClient

virtual AWSError< CoreErrors > BuildAWSError (const std::shared_ptr< Aws::Http::HttpResponse > &response) const override

 

JsonOutcome MakeRequest (const Aws::AmazonWebServiceRequest &request, const Aws::Endpoint::AWSEndpoint &endpoint, 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::Endpoint::AWSEndpoint &endpoint, 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, 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

 

StreamOutcome MakeRequestWithUnparsedResponse (const Aws::AmazonWebServiceRequest &request, const Aws::Endpoint::AWSEndpoint &endpoint, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, 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

 

virtual void AddContentLengthToRequest (const std::shared_ptr< Aws::Http::HttpRequest > &httpRequest, const std::shared_ptr< Aws::IOStream > &body, bool isChunked) const

 

const std::shared_ptr< AWSErrorMarshaller > & GetErrorMarshaller () const

 

Aws::Client::AWSAuthSigner * GetSignerByName (const char *name) const

 

std::shared_ptr< Auth::AWSCredentialsProvider > GetCredentialsProvider () const

 

std::shared_ptr< Aws::Http::HttpRequest > BuildAndSignHttpRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method, const char *signerName) const

 

std::shared_ptr< Aws::Http::HttpResponse > MakeHttpRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const

 

Static Protected Member Functions inherited from Aws::Client::AWSClient

static void AppendRecursionDetectionHeader (std::shared_ptr< Aws::Http::HttpRequest > ioRequest)

 

static CoreErrors GuessBodylessErrorType (Aws::Http::HttpResponseCode responseCode)

 

static bool DoesResponseGenerateError (const std::shared_ptr< Aws::Http::HttpResponse > &response)

 

Protected Attributes inherited from Aws::Client::AWSClient

Aws::String m_region

 

std::shared_ptr< smithy::components::tracing::TelemetryProvider > m_telemetryProvider

 

std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > m_signerProvider

 

Protected Attributes inherited from Aws::Client::ClientWithAsyncTemplateMethods< BatchClient >

std::atomic< bool > m_isInitialized

 

std::atomic< size_t > m_operationsProcessed

 

std::condition_variable m_shutdownSignal

 

std::mutex m_shutdownMutex

 

Detailed Description

<fullname>Batch</fullname>

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

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

Definition at line 34 of file BatchClient.h.

Member Typedef Documentation

BASECLASS

typedef Aws::Client::AWSJsonClient Aws::Batch::BatchClient::BASECLASS

Definition at line 37 of file BatchClient.h.

ClientConfigurationType

typedef BatchClientConfiguration Aws::Batch::BatchClient::ClientConfigurationType

Definition at line 41 of file BatchClient.h.

EndpointProviderType

typedef BatchEndpointProvider Aws::Batch::BatchClient::EndpointProviderType

Definition at line 42 of file BatchClient.h.

Constructor & Destructor Documentation

BatchClient() [1/6]

Aws::Batch::BatchClient::BatchClient ( const Aws::Batch::BatchClientConfiguration &  clientConfiguration = Aws::Batch::BatchClientConfiguration(),

std::shared_ptr< BatchEndpointProviderBase >  endpointProvider = nullptr 

)

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/6]

Aws::Batch::BatchClient::BatchClient ( const Aws::Auth::AWSCredentials &  credentials,

std::shared_ptr< BatchEndpointProviderBase >  endpointProvider = nullptr,

const Aws::Batch::BatchClientConfiguration &  clientConfiguration = Aws::Batch::BatchClientConfiguration() 

)

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/6]

Aws::Batch::BatchClient::BatchClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,

std::shared_ptr< BatchEndpointProviderBase >  endpointProvider = nullptr,

const Aws::Batch::BatchClientConfiguration &  clientConfiguration = Aws::Batch::BatchClientConfiguration() 

)

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() [4/6]

Aws::Batch::BatchClient::BatchClient ( const Aws::Client::ClientConfiguration &  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() [5/6]

Aws::Batch::BatchClient::BatchClient ( const Aws::Auth::AWSCredentials &  credentials,

const Aws::Client::ClientConfiguration &  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() [6/6]

Aws::Batch::BatchClient::BatchClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,

const Aws::Client::ClientConfiguration &  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

accessEndpointProvider()

std::shared_ptr< BatchEndpointProviderBase > & Aws::Batch::BatchClient::accessEndpointProvider ( )

CancelJob()

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

virtual

Cancels a job in an Batch job queue. Jobs that are in a SUBMITTED, PENDING, or RUNNABLE state are cancelled and the job status is updated to FAILED.

A PENDING job is canceled after all dependency jobs are completed. Therefore, it may take longer than expected to cancel a job in PENDING status.

When you try to cancel an array parent job in PENDING, Batch attempts to cancel all child jobs. The array parent job is canceled when all child jobs are completed.

Jobs that progressed to the STARTING or RUNNING state aren't canceled. However, the API operation still succeeds, even if no job is canceled. These jobs must be terminated with the TerminateJob operation.

See Also:

AWS API Reference

CancelJobAsync()

template<typename CancelJobRequestT = Model::CancelJobRequest>

void Aws::Batch::BatchClient::CancelJobAsync ( const CancelJobRequestT &  request,

const CancelJobResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for CancelJob that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 123 of file BatchClient.h.

CancelJobCallable()

template<typename CancelJobRequestT = Model::CancelJobRequest>

Model::CancelJobOutcomeCallable Aws::Batch::BatchClient::CancelJobCallable ( const CancelJobRequestT &  request) const

inline

A Callable wrapper for CancelJob that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 114 of file BatchClient.h.

CreateComputeEnvironment()

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

virtual

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

In a managed compute environment, Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the launch template that you specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a specified percentage of the On-Demand price.

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

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

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

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

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

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

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

4. Delete the earlier compute environment.

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

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

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

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

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

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

See Also:

AWS API Reference

CreateComputeEnvironmentAsync()

template<typename CreateComputeEnvironmentRequestT = Model::CreateComputeEnvironmentRequest>

void Aws::Batch::BatchClient::CreateComputeEnvironmentAsync ( const CreateComputeEnvironmentRequestT &  request,

const CreateComputeEnvironmentResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for CreateComputeEnvironment that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 225 of file BatchClient.h.

CreateComputeEnvironmentCallable()

template<typename CreateComputeEnvironmentRequestT = Model::CreateComputeEnvironmentRequest>

Model::CreateComputeEnvironmentOutcomeCallable Aws::Batch::BatchClient::CreateComputeEnvironmentCallable ( const CreateComputeEnvironmentRequestT &  request) const

inline

A Callable wrapper for CreateComputeEnvironment that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 216 of file BatchClient.h.

CreateConsumableResource()

virtual Model::CreateConsumableResourceOutcome Aws::Batch::BatchClient::CreateConsumableResource ( const Model::CreateConsumableResourceRequest &  request) const

virtual

Creates an Batch consumable resource.

See Also:

AWS API Reference

CreateConsumableResourceAsync()

template<typename CreateConsumableResourceRequestT = Model::CreateConsumableResourceRequest>

void Aws::Batch::BatchClient::CreateConsumableResourceAsync ( const CreateConsumableResourceRequestT &  request,

const CreateConsumableResourceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for CreateConsumableResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 250 of file BatchClient.h.

CreateConsumableResourceCallable()

template<typename CreateConsumableResourceRequestT = Model::CreateConsumableResourceRequest>

Model::CreateConsumableResourceOutcomeCallable Aws::Batch::BatchClient::CreateConsumableResourceCallable ( const CreateConsumableResourceRequestT &  request) const

inline

A Callable wrapper for CreateConsumableResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 241 of file BatchClient.h.

CreateJobQueue()

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

virtual

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

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

See Also:

AWS API Reference

CreateJobQueueAsync()

template<typename CreateJobQueueRequestT = Model::CreateJobQueueRequest>

void Aws::Batch::BatchClient::CreateJobQueueAsync ( const CreateJobQueueRequestT &  request,

const CreateJobQueueResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for CreateJobQueue that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 282 of file BatchClient.h.

CreateJobQueueCallable()

template<typename CreateJobQueueRequestT = Model::CreateJobQueueRequest>

Model::CreateJobQueueOutcomeCallable Aws::Batch::BatchClient::CreateJobQueueCallable ( const CreateJobQueueRequestT &  request) const

inline

A Callable wrapper for CreateJobQueue that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 273 of file BatchClient.h.

CreateSchedulingPolicy()

virtual Model::CreateSchedulingPolicyOutcome Aws::Batch::BatchClient::CreateSchedulingPolicy ( const Model::CreateSchedulingPolicyRequest &  request) const

virtual

Creates an Batch scheduling policy.

See Also:

AWS API Reference

CreateSchedulingPolicyAsync()

template<typename CreateSchedulingPolicyRequestT = Model::CreateSchedulingPolicyRequest>

void Aws::Batch::BatchClient::CreateSchedulingPolicyAsync ( const CreateSchedulingPolicyRequestT &  request,

const CreateSchedulingPolicyResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for CreateSchedulingPolicy that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 307 of file BatchClient.h.

CreateSchedulingPolicyCallable()

template<typename CreateSchedulingPolicyRequestT = Model::CreateSchedulingPolicyRequest>

Model::CreateSchedulingPolicyOutcomeCallable Aws::Batch::BatchClient::CreateSchedulingPolicyCallable ( const CreateSchedulingPolicyRequestT &  request) const

inline

A Callable wrapper for CreateSchedulingPolicy that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 298 of file BatchClient.h.

DeleteComputeEnvironment()

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

virtual

Deletes an Batch compute environment.

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

See Also:

AWS API Reference

DeleteComputeEnvironmentAsync()

template<typename DeleteComputeEnvironmentRequestT = Model::DeleteComputeEnvironmentRequest>

void Aws::Batch::BatchClient::DeleteComputeEnvironmentAsync ( const DeleteComputeEnvironmentRequestT &  request,

const DeleteComputeEnvironmentResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DeleteComputeEnvironment that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 338 of file BatchClient.h.

DeleteComputeEnvironmentCallable()

template<typename DeleteComputeEnvironmentRequestT = Model::DeleteComputeEnvironmentRequest>

Model::DeleteComputeEnvironmentOutcomeCallable Aws::Batch::BatchClient::DeleteComputeEnvironmentCallable ( const DeleteComputeEnvironmentRequestT &  request) const

inline

A Callable wrapper for DeleteComputeEnvironment that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 329 of file BatchClient.h.

DeleteConsumableResource()

virtual Model::DeleteConsumableResourceOutcome Aws::Batch::BatchClient::DeleteConsumableResource ( const Model::DeleteConsumableResourceRequest &  request) const

virtual

Deletes the specified consumable resource.

See Also:

AWS API Reference

DeleteConsumableResourceAsync()

template<typename DeleteConsumableResourceRequestT = Model::DeleteConsumableResourceRequest>

void Aws::Batch::BatchClient::DeleteConsumableResourceAsync ( const DeleteConsumableResourceRequestT &  request,

const DeleteConsumableResourceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DeleteConsumableResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 363 of file BatchClient.h.

DeleteConsumableResourceCallable()

template<typename DeleteConsumableResourceRequestT = Model::DeleteConsumableResourceRequest>

Model::DeleteConsumableResourceOutcomeCallable Aws::Batch::BatchClient::DeleteConsumableResourceCallable ( const DeleteConsumableResourceRequestT &  request) const

inline

A Callable wrapper for DeleteConsumableResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 354 of file BatchClient.h.

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

template<typename DeleteJobQueueRequestT = Model::DeleteJobQueueRequest>

void Aws::Batch::BatchClient::DeleteJobQueueAsync ( const DeleteJobQueueRequestT &  request,

const DeleteJobQueueResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DeleteJobQueue that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 393 of file BatchClient.h.

DeleteJobQueueCallable()

template<typename DeleteJobQueueRequestT = Model::DeleteJobQueueRequest>

Model::DeleteJobQueueOutcomeCallable Aws::Batch::BatchClient::DeleteJobQueueCallable ( const DeleteJobQueueRequestT &  request) const

inline

A Callable wrapper for DeleteJobQueue that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 384 of file BatchClient.h.

DeleteSchedulingPolicy()

virtual Model::DeleteSchedulingPolicyOutcome Aws::Batch::BatchClient::DeleteSchedulingPolicy ( const Model::DeleteSchedulingPolicyRequest &  request) const

virtual

Deletes the specified scheduling policy.

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

See Also:

AWS API Reference

DeleteSchedulingPolicyAsync()

template<typename DeleteSchedulingPolicyRequestT = Model::DeleteSchedulingPolicyRequest>

void Aws::Batch::BatchClient::DeleteSchedulingPolicyAsync ( const DeleteSchedulingPolicyRequestT &  request,

const DeleteSchedulingPolicyResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DeleteSchedulingPolicy that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 419 of file BatchClient.h.

DeleteSchedulingPolicyCallable()

template<typename DeleteSchedulingPolicyRequestT = Model::DeleteSchedulingPolicyRequest>

Model::DeleteSchedulingPolicyOutcomeCallable Aws::Batch::BatchClient::DeleteSchedulingPolicyCallable ( const DeleteSchedulingPolicyRequestT &  request) const

inline

A Callable wrapper for DeleteSchedulingPolicy that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 410 of file BatchClient.h.

DeregisterJobDefinition()

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

virtual

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

See Also:

AWS API Reference

DeregisterJobDefinitionAsync()

template<typename DeregisterJobDefinitionRequestT = Model::DeregisterJobDefinitionRequest>

void Aws::Batch::BatchClient::DeregisterJobDefinitionAsync ( const DeregisterJobDefinitionRequestT &  request,

const DeregisterJobDefinitionResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DeregisterJobDefinition that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 445 of file BatchClient.h.

DeregisterJobDefinitionCallable()

template<typename DeregisterJobDefinitionRequestT = Model::DeregisterJobDefinitionRequest>

Model::DeregisterJobDefinitionOutcomeCallable Aws::Batch::BatchClient::DeregisterJobDefinitionCallable ( const DeregisterJobDefinitionRequestT &  request) const

inline

A Callable wrapper for DeregisterJobDefinition that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 436 of file BatchClient.h.

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

See Also:

AWS API Reference

DescribeComputeEnvironmentsAsync()

template<typename DescribeComputeEnvironmentsRequestT = Model::DescribeComputeEnvironmentsRequest>

void Aws::Batch::BatchClient::DescribeComputeEnvironmentsAsync ( const DescribeComputeEnvironmentsResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr,

const DescribeComputeEnvironmentsRequestT &  request = {} 

) const

inline

An Async wrapper for DescribeComputeEnvironments that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 474 of file BatchClient.h.

DescribeComputeEnvironmentsCallable()

template<typename DescribeComputeEnvironmentsRequestT = Model::DescribeComputeEnvironmentsRequest>

Model::DescribeComputeEnvironmentsOutcomeCallable Aws::Batch::BatchClient::DescribeComputeEnvironmentsCallable ( const DescribeComputeEnvironmentsRequestT &  request = {}) const

inline

A Callable wrapper for DescribeComputeEnvironments that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 465 of file BatchClient.h.

DescribeConsumableResource()

virtual Model::DescribeConsumableResourceOutcome Aws::Batch::BatchClient::DescribeConsumableResource ( const Model::DescribeConsumableResourceRequest &  request) const

virtual

Returns a description of the specified consumable resource.

See Also:

AWS API Reference

DescribeConsumableResourceAsync()

template<typename DescribeConsumableResourceRequestT = Model::DescribeConsumableResourceRequest>

void Aws::Batch::BatchClient::DescribeConsumableResourceAsync ( const DescribeConsumableResourceRequestT &  request,

const DescribeConsumableResourceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DescribeConsumableResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 500 of file BatchClient.h.

DescribeConsumableResourceCallable()

template<typename DescribeConsumableResourceRequestT = Model::DescribeConsumableResourceRequest>

Model::DescribeConsumableResourceOutcomeCallable Aws::Batch::BatchClient::DescribeConsumableResourceCallable ( const DescribeConsumableResourceRequestT &  request) const

inline

A Callable wrapper for DescribeConsumableResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 491 of file BatchClient.h.

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

template<typename DescribeJobDefinitionsRequestT = Model::DescribeJobDefinitionsRequest>

void Aws::Batch::BatchClient::DescribeJobDefinitionsAsync ( const DescribeJobDefinitionsResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr,

const DescribeJobDefinitionsRequestT &  request = {} 

) const

inline

An Async wrapper for DescribeJobDefinitions that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 527 of file BatchClient.h.

DescribeJobDefinitionsCallable()

template<typename DescribeJobDefinitionsRequestT = Model::DescribeJobDefinitionsRequest>

Model::DescribeJobDefinitionsOutcomeCallable Aws::Batch::BatchClient::DescribeJobDefinitionsCallable ( const DescribeJobDefinitionsRequestT &  request = {}) const

inline

A Callable wrapper for DescribeJobDefinitions that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 518 of file BatchClient.h.

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

template<typename DescribeJobQueuesRequestT = Model::DescribeJobQueuesRequest>

void Aws::Batch::BatchClient::DescribeJobQueuesAsync ( const DescribeJobQueuesResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr,

const DescribeJobQueuesRequestT &  request = {} 

) const

inline

An Async wrapper for DescribeJobQueues that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 552 of file BatchClient.h.

DescribeJobQueuesCallable()

template<typename DescribeJobQueuesRequestT = Model::DescribeJobQueuesRequest>

Model::DescribeJobQueuesOutcomeCallable Aws::Batch::BatchClient::DescribeJobQueuesCallable ( const DescribeJobQueuesRequestT &  request = {}) const

inline

A Callable wrapper for DescribeJobQueues that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 543 of file BatchClient.h.

DescribeJobs()

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

virtual

Describes a list of Batch jobs.

See Also:

AWS API Reference

DescribeJobsAsync()

template<typename DescribeJobsRequestT = Model::DescribeJobsRequest>

void Aws::Batch::BatchClient::DescribeJobsAsync ( const DescribeJobsRequestT &  request,

const DescribeJobsResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DescribeJobs that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 577 of file BatchClient.h.

DescribeJobsCallable()

template<typename DescribeJobsRequestT = Model::DescribeJobsRequest>

Model::DescribeJobsOutcomeCallable Aws::Batch::BatchClient::DescribeJobsCallable ( const DescribeJobsRequestT &  request) const

inline

A Callable wrapper for DescribeJobs that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 568 of file BatchClient.h.

DescribeSchedulingPolicies()

virtual Model::DescribeSchedulingPoliciesOutcome Aws::Batch::BatchClient::DescribeSchedulingPolicies ( const Model::DescribeSchedulingPoliciesRequest &  request) const

virtual

Describes one or more of your scheduling policies.

See Also:

AWS API Reference

DescribeSchedulingPoliciesAsync()

template<typename DescribeSchedulingPoliciesRequestT = Model::DescribeSchedulingPoliciesRequest>

void Aws::Batch::BatchClient::DescribeSchedulingPoliciesAsync ( const DescribeSchedulingPoliciesRequestT &  request,

const DescribeSchedulingPoliciesResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DescribeSchedulingPolicies that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 603 of file BatchClient.h.

DescribeSchedulingPoliciesCallable()

template<typename DescribeSchedulingPoliciesRequestT = Model::DescribeSchedulingPoliciesRequest>

Model::DescribeSchedulingPoliciesOutcomeCallable Aws::Batch::BatchClient::DescribeSchedulingPoliciesCallable ( const DescribeSchedulingPoliciesRequestT &  request) const

inline

A Callable wrapper for DescribeSchedulingPolicies that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 594 of file BatchClient.h.

GetAllocationTag()

static const char * Aws::Batch::BatchClient::GetAllocationTag ( )

static

GetJobQueueSnapshot()

virtual Model::GetJobQueueSnapshotOutcome Aws::Batch::BatchClient::GetJobQueueSnapshot ( const Model::GetJobQueueSnapshotRequest &  request) const

virtual

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

See Also:

AWS API Reference

GetJobQueueSnapshotAsync()

template<typename GetJobQueueSnapshotRequestT = Model::GetJobQueueSnapshotRequest>

void Aws::Batch::BatchClient::GetJobQueueSnapshotAsync ( const GetJobQueueSnapshotRequestT &  request,

const GetJobQueueSnapshotResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for GetJobQueueSnapshot that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 629 of file BatchClient.h.

GetJobQueueSnapshotCallable()

template<typename GetJobQueueSnapshotRequestT = Model::GetJobQueueSnapshotRequest>

Model::GetJobQueueSnapshotOutcomeCallable Aws::Batch::BatchClient::GetJobQueueSnapshotCallable ( const GetJobQueueSnapshotRequestT &  request) const

inline

A Callable wrapper for GetJobQueueSnapshot that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 620 of file BatchClient.h.

GetServiceName()

static const char * Aws::Batch::BatchClient::GetServiceName ( )

static

ListConsumableResources()

virtual Model::ListConsumableResourcesOutcome Aws::Batch::BatchClient::ListConsumableResources ( const Model::ListConsumableResourcesRequest &  request = {}) const

virtual

Returns a list of Batch consumable resources.

See Also:

AWS API Reference

ListConsumableResourcesAsync()

template<typename ListConsumableResourcesRequestT = Model::ListConsumableResourcesRequest>

void Aws::Batch::BatchClient::ListConsumableResourcesAsync ( const ListConsumableResourcesResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr,

const ListConsumableResourcesRequestT &  request = {} 

) const

inline

An Async wrapper for ListConsumableResources that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 654 of file BatchClient.h.

ListConsumableResourcesCallable()

template<typename ListConsumableResourcesRequestT = Model::ListConsumableResourcesRequest>

Model::ListConsumableResourcesOutcomeCallable Aws::Batch::BatchClient::ListConsumableResourcesCallable ( const ListConsumableResourcesRequestT &  request = {}) const

inline

A Callable wrapper for ListConsumableResources that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 645 of file BatchClient.h.

ListJobs()

virtual Model::ListJobsOutcome Aws::Batch::BatchClient::ListJobs ( const Model::ListJobsRequest &  request = {}) const

virtual

Returns a list of Batch jobs.

You must specify only one of the following items:

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

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

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

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

See Also:

AWS API Reference

ListJobsAsync()

template<typename ListJobsRequestT = Model::ListJobsRequest>

void Aws::Batch::BatchClient::ListJobsAsync ( const ListJobsResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr,

const ListJobsRequestT &  request = {} 

) const

inline

An Async wrapper for ListJobs that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 685 of file BatchClient.h.

ListJobsByConsumableResource()

virtual Model::ListJobsByConsumableResourceOutcome Aws::Batch::BatchClient::ListJobsByConsumableResource ( const Model::ListJobsByConsumableResourceRequest &  request) const

virtual

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

See Also:

AWS API Reference

ListJobsByConsumableResourceAsync()

template<typename ListJobsByConsumableResourceRequestT = Model::ListJobsByConsumableResourceRequest>

void Aws::Batch::BatchClient::ListJobsByConsumableResourceAsync ( const ListJobsByConsumableResourceRequestT &  request,

const ListJobsByConsumableResourceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for ListJobsByConsumableResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 711 of file BatchClient.h.

ListJobsByConsumableResourceCallable()

template<typename ListJobsByConsumableResourceRequestT = Model::ListJobsByConsumableResourceRequest>

Model::ListJobsByConsumableResourceOutcomeCallable Aws::Batch::BatchClient::ListJobsByConsumableResourceCallable ( const ListJobsByConsumableResourceRequestT &  request) const

inline

A Callable wrapper for ListJobsByConsumableResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 702 of file BatchClient.h.

ListJobsCallable()

template<typename ListJobsRequestT = Model::ListJobsRequest>

Model::ListJobsOutcomeCallable Aws::Batch::BatchClient::ListJobsCallable ( const ListJobsRequestT &  request = {}) const

inline

A Callable wrapper for ListJobs that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 676 of file BatchClient.h.

ListSchedulingPolicies()

virtual Model::ListSchedulingPoliciesOutcome Aws::Batch::BatchClient::ListSchedulingPolicies ( const Model::ListSchedulingPoliciesRequest &  request = {}) const

virtual

Returns a list of Batch scheduling policies.

See Also:

AWS API Reference

ListSchedulingPoliciesAsync()

template<typename ListSchedulingPoliciesRequestT = Model::ListSchedulingPoliciesRequest>

void Aws::Batch::BatchClient::ListSchedulingPoliciesAsync ( const ListSchedulingPoliciesResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr,

const ListSchedulingPoliciesRequestT &  request = {} 

) const

inline

An Async wrapper for ListSchedulingPolicies that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 736 of file BatchClient.h.

ListSchedulingPoliciesCallable()

template<typename ListSchedulingPoliciesRequestT = Model::ListSchedulingPoliciesRequest>

Model::ListSchedulingPoliciesOutcomeCallable Aws::Batch::BatchClient::ListSchedulingPoliciesCallable ( const ListSchedulingPoliciesRequestT &  request = {}) const

inline

A Callable wrapper for ListSchedulingPolicies that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 727 of file BatchClient.h.

ListTagsForResource()

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

virtual

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

See Also:

AWS API Reference

ListTagsForResourceAsync()

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

void Aws::Batch::BatchClient::ListTagsForResourceAsync ( const ListTagsForResourceRequestT &  request,

const ListTagsForResourceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for ListTagsForResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 764 of file BatchClient.h.

ListTagsForResourceCallable()

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

Model::ListTagsForResourceOutcomeCallable Aws::Batch::BatchClient::ListTagsForResourceCallable ( const ListTagsForResourceRequestT &  request) const

inline

A Callable wrapper for ListTagsForResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 755 of file BatchClient.h.

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 Batch job definition.

See Also:

AWS API Reference

RegisterJobDefinitionAsync()

template<typename RegisterJobDefinitionRequestT = Model::RegisterJobDefinitionRequest>

void Aws::Batch::BatchClient::RegisterJobDefinitionAsync ( const RegisterJobDefinitionRequestT &  request,

const RegisterJobDefinitionResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for RegisterJobDefinition that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 789 of file BatchClient.h.

RegisterJobDefinitionCallable()

template<typename RegisterJobDefinitionRequestT = Model::RegisterJobDefinitionRequest>

Model::RegisterJobDefinitionOutcomeCallable Aws::Batch::BatchClient::RegisterJobDefinitionCallable ( const RegisterJobDefinitionRequestT &  request) const

inline

A Callable wrapper for RegisterJobDefinition that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 780 of file BatchClient.h.

SubmitJob()

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

virtual

Submits an Batch job from a job definition. Parameters that are specified during SubmitJob override parameters defined in the job definition. vCPU and memory requirements that are specified in the resourceRequirements objects in the job definition are the exception. They can't be overridden this way using the memory and vcpus parameters. Rather, you must specify updates to job definition parameters in a resourceRequirements object that's included in the containerOverrides parameter.

Job queues with a scheduling policy are limited to 500 active share identifiers at a time.

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

See Also:

AWS API Reference

SubmitJobAsync()

template<typename SubmitJobRequestT = Model::SubmitJobRequest>

void Aws::Batch::BatchClient::SubmitJobAsync ( const SubmitJobRequestT &  request,

const SubmitJobResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for SubmitJob that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 826 of file BatchClient.h.

SubmitJobCallable()

template<typename SubmitJobRequestT = Model::SubmitJobRequest>

Model::SubmitJobOutcomeCallable Aws::Batch::BatchClient::SubmitJobCallable ( const SubmitJobRequestT &  request) const

inline

A Callable wrapper for SubmitJob that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 817 of file BatchClient.h.

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

See Also:

AWS API Reference

TagResourceAsync()

template<typename TagResourceRequestT = Model::TagResourceRequest>

void Aws::Batch::BatchClient::TagResourceAsync ( const TagResourceRequestT &  request,

const TagResourceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for TagResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 857 of file BatchClient.h.

TagResourceCallable()

template<typename TagResourceRequestT = Model::TagResourceRequest>

Model::TagResourceOutcomeCallable Aws::Batch::BatchClient::TagResourceCallable ( const TagResourceRequestT &  request) const

inline

A Callable wrapper for TagResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 848 of file BatchClient.h.

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

template<typename TerminateJobRequestT = Model::TerminateJobRequest>

void Aws::Batch::BatchClient::TerminateJobAsync ( const TerminateJobRequestT &  request,

const TerminateJobResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for TerminateJob that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 885 of file BatchClient.h.

TerminateJobCallable()

template<typename TerminateJobRequestT = Model::TerminateJobRequest>

Model::TerminateJobOutcomeCallable Aws::Batch::BatchClient::TerminateJobCallable ( const TerminateJobRequestT &  request) const

inline

A Callable wrapper for TerminateJob that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 876 of file BatchClient.h.

UntagResource()

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

virtual

Deletes specified tags from an Batch resource.

See Also:

AWS API Reference

UntagResourceAsync()

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

void Aws::Batch::BatchClient::UntagResourceAsync ( const UntagResourceRequestT &  request,

const UntagResourceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for UntagResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 910 of file BatchClient.h.

UntagResourceCallable()

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

Model::UntagResourceOutcomeCallable Aws::Batch::BatchClient::UntagResourceCallable ( const UntagResourceRequestT &  request) const

inline

A Callable wrapper for UntagResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 901 of file BatchClient.h.

UpdateComputeEnvironment()

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

virtual

Updates an Batch compute environment.

See Also:

AWS API Reference

UpdateComputeEnvironmentAsync()

template<typename UpdateComputeEnvironmentRequestT = Model::UpdateComputeEnvironmentRequest>

void Aws::Batch::BatchClient::UpdateComputeEnvironmentAsync ( const UpdateComputeEnvironmentRequestT &  request,

const UpdateComputeEnvironmentResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for UpdateComputeEnvironment that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 935 of file BatchClient.h.

UpdateComputeEnvironmentCallable()

template<typename UpdateComputeEnvironmentRequestT = Model::UpdateComputeEnvironmentRequest>

Model::UpdateComputeEnvironmentOutcomeCallable Aws::Batch::BatchClient::UpdateComputeEnvironmentCallable ( const UpdateComputeEnvironmentRequestT &  request) const

inline

A Callable wrapper for UpdateComputeEnvironment that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 926 of file BatchClient.h.

UpdateConsumableResource()

virtual Model::UpdateConsumableResourceOutcome Aws::Batch::BatchClient::UpdateConsumableResource ( const Model::UpdateConsumableResourceRequest &  request) const

virtual

Updates a consumable resource.

See Also:

AWS API Reference

UpdateConsumableResourceAsync()

template<typename UpdateConsumableResourceRequestT = Model::UpdateConsumableResourceRequest>

void Aws::Batch::BatchClient::UpdateConsumableResourceAsync ( const UpdateConsumableResourceRequestT &  request,

const UpdateConsumableResourceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for UpdateConsumableResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 960 of file BatchClient.h.

UpdateConsumableResourceCallable()

template<typename UpdateConsumableResourceRequestT = Model::UpdateConsumableResourceRequest>

Model::UpdateConsumableResourceOutcomeCallable Aws::Batch::BatchClient::UpdateConsumableResourceCallable ( const UpdateConsumableResourceRequestT &  request) const

inline

A Callable wrapper for UpdateConsumableResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 951 of file BatchClient.h.

UpdateJobQueue()

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

virtual

Updates a job queue.

See Also:

AWS API Reference

UpdateJobQueueAsync()

template<typename UpdateJobQueueRequestT = Model::UpdateJobQueueRequest>

void Aws::Batch::BatchClient::UpdateJobQueueAsync ( const UpdateJobQueueRequestT &  request,

const UpdateJobQueueResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for UpdateJobQueue that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 985 of file BatchClient.h.

UpdateJobQueueCallable()

template<typename UpdateJobQueueRequestT = Model::UpdateJobQueueRequest>

Model::UpdateJobQueueOutcomeCallable Aws::Batch::BatchClient::UpdateJobQueueCallable ( const UpdateJobQueueRequestT &  request) const

inline

A Callable wrapper for UpdateJobQueue that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 976 of file BatchClient.h.

UpdateSchedulingPolicy()

virtual Model::UpdateSchedulingPolicyOutcome Aws::Batch::BatchClient::UpdateSchedulingPolicy ( const Model::UpdateSchedulingPolicyRequest &  request) const

virtual

Updates a scheduling policy.

See Also:

AWS API Reference

UpdateSchedulingPolicyAsync()

template<typename UpdateSchedulingPolicyRequestT = Model::UpdateSchedulingPolicyRequest>

void Aws::Batch::BatchClient::UpdateSchedulingPolicyAsync ( const UpdateSchedulingPolicyRequestT &  request,

const UpdateSchedulingPolicyResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for UpdateSchedulingPolicy that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1010 of file BatchClient.h.

UpdateSchedulingPolicyCallable()

template<typename UpdateSchedulingPolicyRequestT = Model::UpdateSchedulingPolicyRequest>

Model::UpdateSchedulingPolicyOutcomeCallable Aws::Batch::BatchClient::UpdateSchedulingPolicyCallable ( const UpdateSchedulingPolicyRequestT &  request) const

inline

A Callable wrapper for UpdateSchedulingPolicy that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1001 of file BatchClient.h.

Friends And Related Symbol Documentation

Aws::Client::ClientWithAsyncTemplateMethods< BatchClient >

friend class Aws::Client::ClientWithAsyncTemplateMethods< BatchClient >

friend

Definition at line 1017 of file BatchClient.h.

---

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

• generated/src/aws-cpp-sdk-batch/include/aws/batch/BatchClient.h