BatchClient Class

Member Function Documentation

BatchClient::BatchClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a BatchClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

BatchClient::BatchClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads BatchClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] CancelJobResponse *BatchClient::cancelJob(const CancelJobRequest &request)

Sends request to the BatchClient service, and returns a pointer to an CancelJobResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Cancels a job in an AWS Batch job queue. Jobs that are in the <code>SUBMITTED</code>, <code>PENDING</code>, or <code>RUNNABLE</code> state are cancelled. Jobs that have progressed to <code>STARTING</code> or <code>RUNNING</code> are not cancelled (but the API operation still succeeds, even if no job is cancelled); these jobs must be terminated with the <a>TerminateJob</a>

[slot] CreateComputeEnvironmentResponse *BatchClient::createComputeEnvironment(const CreateComputeEnvironmentRequest &request)

Sends request to the BatchClient service, and returns a pointer to an CreateComputeEnvironmentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates an AWS Batch compute environment. You can create <code>MANAGED</code> or <code>UNMANAGED</code> compute

environments>

In a managed compute environment, AWS Batch manages the compute resources within the environment, based on the compute resources that you specify. Instances launched into a managed compute environment use a recent, approved version of the Amazon ECS-optimized AMI. You can choose to use Amazon EC2 On-Demand Instances in your managed compute environment, or you can use Amazon EC2 Spot Instances that only launch when the Spot bid price is below a specified percentage of the On-Demand

price>

In an unmanaged compute environment, you can manage your own compute resources. This provides more compute resource configuration options, such as using a custom AMI, but you must ensure that your AMI meets the Amazon ECS container instance AMI specification. For more information, see <a href="http://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html">Container Instance AMIs</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. After you have created your unmanaged compute environment, you can use the <a>DescribeComputeEnvironments</a> operation to find the Amazon ECS cluster that is associated with it and then manually launch your container instances into that Amazon ECS cluster. For more information, see <a href="http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html">Launching an Amazon ECS Container Instance</a> in the <i>Amazon Elastic Container Service Developer

[slot] CreateJobQueueResponse *BatchClient::createJobQueue(const CreateJobQueueRequest &request)

Sends request to the BatchClient service, and returns a pointer to an CreateJobQueueResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 in which the AWS Batch scheduler places jobs onto its associated compute environments. For example, if a compute environment is associated with more than one job queue, the job queue with a higher priority is given preference for scheduling jobs to that compute

[slot] DeleteComputeEnvironmentResponse *BatchClient::deleteComputeEnvironment(const DeleteComputeEnvironmentRequest &request)

Sends request to the BatchClient service, and returns a pointer to an DeleteComputeEnvironmentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes an AWS Batch compute

environment>

Before you can delete a compute environment, you must set its state to <code>DISABLED</code> with the <a>UpdateComputeEnvironment</a> API operation and disassociate it from any job queues with the <a>UpdateJobQueue</a> API

[slot] DeleteJobQueueResponse *BatchClient::deleteJobQueue(const DeleteJobQueueRequest &request)

Sends request to the BatchClient service, and returns a pointer to an DeleteJobQueueResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified job queue. You must first disable submissions for a queue with the <a>UpdateJobQueue</a> operation. All jobs in the queue are terminated when you delete a job

queue>

It is not necessary to disassociate compute environments from a queue before submitting a <code>DeleteJobQueue</code> request.

[slot] DeregisterJobDefinitionResponse *BatchClient::deregisterJobDefinition(const DeregisterJobDefinitionRequest &request)

Sends request to the BatchClient service, and returns a pointer to an DeregisterJobDefinitionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deregisters an AWS Batch job

[slot] DescribeComputeEnvironmentsResponse *BatchClient::describeComputeEnvironments(const DescribeComputeEnvironmentsRequest &request)

Sends request to the BatchClient service, and returns a pointer to an DescribeComputeEnvironmentsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes one or more of your compute

environments>

If you are using an unmanaged compute environment, you can use the <code>DescribeComputeEnvironment</code> operation to determine the <code>ecsClusterArn</code> that you should launch your Amazon ECS container instances

[slot] DescribeJobDefinitionsResponse *BatchClient::describeJobDefinitions(const DescribeJobDefinitionsRequest &request)

Sends request to the BatchClient service, and returns a pointer to an DescribeJobDefinitionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeJobQueuesResponse *BatchClient::describeJobQueues(const DescribeJobQueuesRequest &request)

Sends request to the BatchClient service, and returns a pointer to an DescribeJobQueuesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes one or more of your job

[slot] DescribeJobsResponse *BatchClient::describeJobs(const DescribeJobsRequest &request)

Sends request to the BatchClient service, and returns a pointer to an DescribeJobsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes a list of AWS Batch

[slot] ListJobsResponse *BatchClient::listJobs(const ListJobsRequest &request)

Sends request to the BatchClient service, and returns a pointer to an ListJobsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns a list of task jobs for a specified job queue. You can filter the results by job status with the <code>jobStatus</code> parameter. If you do not specify a status, only <code>RUNNING</code> jobs are

[slot] RegisterJobDefinitionResponse *BatchClient::registerJobDefinition(const RegisterJobDefinitionRequest &request)

Sends request to the BatchClient service, and returns a pointer to an RegisterJobDefinitionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Registers an AWS Batch job definition.

[slot] SubmitJobResponse *BatchClient::submitJob(const SubmitJobRequest &request)

Sends request to the BatchClient service, and returns a pointer to an SubmitJobResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Submits an AWS Batch job from a job definition. Parameters specified during <a>SubmitJob</a> override parameters defined in the job definition.

[slot] TerminateJobResponse *BatchClient::terminateJob(const TerminateJobRequest &request)

Sends request to the BatchClient service, and returns a pointer to an TerminateJobResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Terminates a job in a job queue. Jobs that are in the <code>STARTING</code> or <code>RUNNING</code> state are terminated, which causes them to transition to <code>FAILED</code>. Jobs that have not progressed to the <code>STARTING</code> state are

[slot] UpdateComputeEnvironmentResponse *BatchClient::updateComputeEnvironment(const UpdateComputeEnvironmentRequest &request)

Sends request to the BatchClient service, and returns a pointer to an UpdateComputeEnvironmentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates an AWS Batch compute

[slot] UpdateJobQueueResponse *BatchClient::updateJobQueue(const UpdateJobQueueRequest &request)

Sends request to the BatchClient service, and returns a pointer to an UpdateJobQueueResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates a job