Trait rusoto_batch::Batch[−][src]

pub trait Batch {
    fn cancel_job(
        &self, 
        input: CancelJobRequest
    ) -> RusotoFuture<CancelJobResponse, CancelJobError>;

    fn create_compute_environment(
        &self, 
        input: CreateComputeEnvironmentRequest
    ) -> RusotoFuture<CreateComputeEnvironmentResponse, CreateComputeEnvironmentError>;

    fn create_job_queue(
        &self, 
        input: CreateJobQueueRequest
    ) -> RusotoFuture<CreateJobQueueResponse, CreateJobQueueError>;

    fn delete_compute_environment(
        &self, 
        input: DeleteComputeEnvironmentRequest
    ) -> RusotoFuture<DeleteComputeEnvironmentResponse, DeleteComputeEnvironmentError>;

    fn delete_job_queue(
        &self, 
        input: DeleteJobQueueRequest
    ) -> RusotoFuture<DeleteJobQueueResponse, DeleteJobQueueError>;

    fn deregister_job_definition(
        &self, 
        input: DeregisterJobDefinitionRequest
    ) -> RusotoFuture<DeregisterJobDefinitionResponse, DeregisterJobDefinitionError>;

    fn describe_compute_environments(
        &self, 
        input: DescribeComputeEnvironmentsRequest
    ) -> RusotoFuture<DescribeComputeEnvironmentsResponse, DescribeComputeEnvironmentsError>;

    fn describe_job_definitions(
        &self, 
        input: DescribeJobDefinitionsRequest
    ) -> RusotoFuture<DescribeJobDefinitionsResponse, DescribeJobDefinitionsError>;

    fn describe_job_queues(
        &self, 
        input: DescribeJobQueuesRequest
    ) -> RusotoFuture<DescribeJobQueuesResponse, DescribeJobQueuesError>;

    fn describe_jobs(
        &self, 
        input: DescribeJobsRequest
    ) -> RusotoFuture<DescribeJobsResponse, DescribeJobsError>;

    fn list_jobs(
        &self, 
        input: ListJobsRequest
    ) -> RusotoFuture<ListJobsResponse, ListJobsError>;

    fn register_job_definition(
        &self, 
        input: RegisterJobDefinitionRequest
    ) -> RusotoFuture<RegisterJobDefinitionResponse, RegisterJobDefinitionError>;

    fn submit_job(
        &self, 
        input: SubmitJobRequest
    ) -> RusotoFuture<SubmitJobResponse, SubmitJobError>;

    fn terminate_job(
        &self, 
        input: TerminateJobRequest
    ) -> RusotoFuture<TerminateJobResponse, TerminateJobError>;

    fn update_compute_environment(
        &self, 
        input: UpdateComputeEnvironmentRequest
    ) -> RusotoFuture<UpdateComputeEnvironmentResponse, UpdateComputeEnvironmentError>;

    fn update_job_queue(
        &self, 
        input: UpdateJobQueueRequest
    ) -> RusotoFuture<UpdateJobQueueResponse, UpdateJobQueueError>;
}

Trait representing the capabilities of the AWS Batch API. AWS Batch clients implement this trait.

Required Methods

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

Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED 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 Container Instance AMIs in the Amazon Elastic Container Service Developer Guide. After you have created your unmanaged compute environment, you can use the DescribeComputeEnvironments 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 Launching an Amazon ECS Container Instance in the Amazon Elastic Container Service Developer Guide.

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 environment.

Deletes an AWS Batch compute environment.

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

Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue 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 DeleteJobQueue request.

Deregisters an AWS Batch job definition.

Describes one or more of your compute environments.

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

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

Describes one or more of your job queues.

Describes a list of AWS Batch jobs.

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

Registers an AWS Batch job definition.

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

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.

Updates an AWS Batch compute environment.

Updates a job queue.

Implementors