C# Class Amazon.Batch.AmazonBatchClient

Implementation for accessing Batch AWS Batch enables you to run batch computing workloads on the AWS Cloud. Batch computing is a common way for developers, scientists, and engineers to access large amounts of compute resources, and AWS Batch removes the undifferentiated heavy lifting of configuring and managing the required infrastructure. AWS Batch will be familiar to users of traditional batch computing software. This service can efficiently provision resources in response to jobs submitted in order to eliminate capacity constraints, reduce compute costs, and deliver results quickly.

As a fully managed service, AWS Batch enables developers, scientists, and engineers to run batch computing workloads of any scale. AWS Batch automatically provisions compute resources and optimizes the workload distribution based on the quantity and scale of the workloads. With AWS Batch, there is no need to install or manage batch computing software, which allows you to focus on analyzing results and solving problems. AWS Batch reduces operational complexities, saves time, and reduces costs, which makes it easy for developers, scientists, and engineers to run their batch jobs in the AWS Cloud.

Inheritance: AmazonServiceClient, IAmazonBatch
Mostra file Open project: aws/aws-sdk-net

Public Methods

Method Description
AmazonBatchClient ( ) : System

Constructs AmazonBatchClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

AmazonBatchClient ( AWSCredentials credentials ) : System

Constructs AmazonBatchClient with AWS Credentials

AmazonBatchClient ( AWSCredentials credentials, AmazonBatchConfig clientConfig ) : System

Constructs AmazonBatchClient with AWS Credentials and an AmazonBatchClient Configuration object.

AmazonBatchClient ( AWSCredentials credentials, RegionEndpoint region ) : System

Constructs AmazonBatchClient with AWS Credentials

AmazonBatchClient ( AmazonBatchConfig config ) : System

Constructs AmazonBatchClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

AmazonBatchClient ( RegionEndpoint region ) : System

Constructs AmazonBatchClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

AmazonBatchClient ( string awsAccessKeyId, string awsSecretAccessKey ) : System

Constructs AmazonBatchClient with AWS Access Key ID and AWS Secret Key

AmazonBatchClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonBatchConfig clientConfig ) : System

Constructs AmazonBatchClient with AWS Access Key ID, AWS Secret Key and an AmazonBatchClient Configuration object.

AmazonBatchClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System

Constructs AmazonBatchClient with AWS Access Key ID and AWS Secret Key

AmazonBatchClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System

Constructs AmazonBatchClient with AWS Access Key ID and AWS Secret Key

AmazonBatchClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonBatchConfig clientConfig ) : System

Constructs AmazonBatchClient with AWS Access Key ID, AWS Secret Key and an AmazonBatchClient Configuration object.

AmazonBatchClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System

Constructs AmazonBatchClient with AWS Access Key ID and AWS Secret Key

BeginCancelJob ( CancelJobRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the CancelJob operation.

BeginCreateComputeEnvironment ( CreateComputeEnvironmentRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the CreateComputeEnvironment operation.

BeginCreateJobQueue ( CreateJobQueueRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the CreateJobQueue operation.

BeginDeleteComputeEnvironment ( DeleteComputeEnvironmentRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DeleteComputeEnvironment operation.

BeginDeleteJobQueue ( DeleteJobQueueRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DeleteJobQueue operation.

BeginDeregisterJobDefinition ( DeregisterJobDefinitionRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DeregisterJobDefinition operation.

BeginDescribeComputeEnvironments ( DescribeComputeEnvironmentsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeComputeEnvironments operation.

BeginDescribeJobDefinitions ( DescribeJobDefinitionsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeJobDefinitions operation.

BeginDescribeJobQueues ( DescribeJobQueuesRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeJobQueues operation.

BeginDescribeJobs ( DescribeJobsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeJobs operation.

BeginListJobs ( ListJobsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the ListJobs operation.

BeginRegisterJobDefinition ( RegisterJobDefinitionRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the RegisterJobDefinition operation.

BeginSubmitJob ( SubmitJobRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the SubmitJob operation.

BeginTerminateJob ( TerminateJobRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the TerminateJob operation.

BeginUpdateComputeEnvironment ( UpdateComputeEnvironmentRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the UpdateComputeEnvironment operation.

BeginUpdateJobQueue ( UpdateJobQueueRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the UpdateJobQueue operation.

CancelJob ( CancelJobRequest request ) : CancelJobResponse

Cancels jobs 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 jobs are cancelled); these jobs must be terminated with the TerminateJob operation.

CancelJobAsync ( CancelJobRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the CancelJob operation.

CreateComputeEnvironment ( CreateComputeEnvironmentRequest request ) : CreateComputeEnvironmentResponse

Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGEDcompute 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 the latest Amazon ECS-optimized AMI. You can choose to use Amazon EC2 On-Demand instances in your managed compute environment, or you can use Amazon EC2 Spot instances that only launch when the Spot bid price is below a specified percentage of the On-Demand price.

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 EC2 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 EC2 Container Service Developer Guide.

CreateComputeEnvironmentAsync ( CreateComputeEnvironmentRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the CreateComputeEnvironment operation.

CreateJobQueue ( CreateJobQueueRequest request ) : CreateJobQueueResponse

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.

CreateJobQueueAsync ( CreateJobQueueRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the CreateJobQueue operation.

DeleteComputeEnvironment ( DeleteComputeEnvironmentRequest request ) : DeleteComputeEnvironmentResponse

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.

DeleteComputeEnvironmentAsync ( DeleteComputeEnvironmentRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DeleteComputeEnvironment operation.

DeleteJobQueue ( DeleteJobQueueRequest request ) : DeleteJobQueueResponse

Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation and terminate any jobs that have not completed with the TerminateJob.

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

DeleteJobQueueAsync ( DeleteJobQueueRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DeleteJobQueue operation.

DeregisterJobDefinition ( DeregisterJobDefinitionRequest request ) : DeregisterJobDefinitionResponse

Deregisters an AWS Batch job definition.

DeregisterJobDefinitionAsync ( DeregisterJobDefinitionRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DeregisterJobDefinition operation.

DescribeComputeEnvironments ( DescribeComputeEnvironmentsRequest request ) : DescribeComputeEnvironmentsResponse

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.

DescribeComputeEnvironmentsAsync ( DescribeComputeEnvironmentsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeComputeEnvironments operation.

DescribeJobDefinitions ( DescribeJobDefinitionsRequest request ) : DescribeJobDefinitionsResponse

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

DescribeJobDefinitionsAsync ( DescribeJobDefinitionsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeJobDefinitions operation.

DescribeJobQueues ( DescribeJobQueuesRequest request ) : DescribeJobQueuesResponse

Describes one or more of your job queues.

DescribeJobQueuesAsync ( DescribeJobQueuesRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeJobQueues operation.

DescribeJobs ( DescribeJobsRequest request ) : DescribeJobsResponse

Describes a list of AWS Batch jobs.

DescribeJobsAsync ( DescribeJobsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeJobs operation.

EndCancelJob ( IAsyncResult asyncResult ) : CancelJobResponse

Finishes the asynchronous execution of the CancelJob operation.

EndCreateComputeEnvironment ( IAsyncResult asyncResult ) : CreateComputeEnvironmentResponse

Finishes the asynchronous execution of the CreateComputeEnvironment operation.

EndCreateJobQueue ( IAsyncResult asyncResult ) : CreateJobQueueResponse

Finishes the asynchronous execution of the CreateJobQueue operation.

EndDeleteComputeEnvironment ( IAsyncResult asyncResult ) : DeleteComputeEnvironmentResponse

Finishes the asynchronous execution of the DeleteComputeEnvironment operation.

EndDeleteJobQueue ( IAsyncResult asyncResult ) : DeleteJobQueueResponse

Finishes the asynchronous execution of the DeleteJobQueue operation.

EndDeregisterJobDefinition ( IAsyncResult asyncResult ) : DeregisterJobDefinitionResponse

Finishes the asynchronous execution of the DeregisterJobDefinition operation.

EndDescribeComputeEnvironments ( IAsyncResult asyncResult ) : DescribeComputeEnvironmentsResponse

Finishes the asynchronous execution of the DescribeComputeEnvironments operation.

EndDescribeJobDefinitions ( IAsyncResult asyncResult ) : DescribeJobDefinitionsResponse

Finishes the asynchronous execution of the DescribeJobDefinitions operation.

EndDescribeJobQueues ( IAsyncResult asyncResult ) : DescribeJobQueuesResponse

Finishes the asynchronous execution of the DescribeJobQueues operation.

EndDescribeJobs ( IAsyncResult asyncResult ) : DescribeJobsResponse

Finishes the asynchronous execution of the DescribeJobs operation.

EndListJobs ( IAsyncResult asyncResult ) : ListJobsResponse

Finishes the asynchronous execution of the ListJobs operation.

EndRegisterJobDefinition ( IAsyncResult asyncResult ) : RegisterJobDefinitionResponse

Finishes the asynchronous execution of the RegisterJobDefinition operation.

EndSubmitJob ( IAsyncResult asyncResult ) : SubmitJobResponse

Finishes the asynchronous execution of the SubmitJob operation.

EndTerminateJob ( IAsyncResult asyncResult ) : TerminateJobResponse

Finishes the asynchronous execution of the TerminateJob operation.

EndUpdateComputeEnvironment ( IAsyncResult asyncResult ) : UpdateComputeEnvironmentResponse

Finishes the asynchronous execution of the UpdateComputeEnvironment operation.

EndUpdateJobQueue ( IAsyncResult asyncResult ) : UpdateJobQueueResponse

Finishes the asynchronous execution of the UpdateJobQueue operation.

ListJobs ( ListJobsRequest request ) : ListJobsResponse

Returns a list of task jobs for a specified job queue. You can filter the results by job status with the jobStatus parameter.

ListJobsAsync ( ListJobsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the ListJobs operation.

RegisterJobDefinition ( RegisterJobDefinitionRequest request ) : RegisterJobDefinitionResponse

Registers an AWS Batch job definition.

RegisterJobDefinitionAsync ( RegisterJobDefinitionRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the RegisterJobDefinition operation.

SubmitJob ( SubmitJobRequest request ) : SubmitJobResponse

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

SubmitJobAsync ( SubmitJobRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the SubmitJob operation.

TerminateJob ( TerminateJobRequest request ) : TerminateJobResponse

Terminates jobs 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.

TerminateJobAsync ( TerminateJobRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the TerminateJob operation.

UpdateComputeEnvironment ( UpdateComputeEnvironmentRequest request ) : UpdateComputeEnvironmentResponse

Updates an AWS Batch compute environment.

UpdateComputeEnvironmentAsync ( UpdateComputeEnvironmentRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the UpdateComputeEnvironment operation.

UpdateJobQueue ( UpdateJobQueueRequest request ) : UpdateJobQueueResponse

Updates a job queue.

UpdateJobQueueAsync ( UpdateJobQueueRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the UpdateJobQueue operation.

Protected Methods

Method Description
CreateSigner ( ) : AbstractAWSSigner

Creates the signer for the service.

Dispose ( bool disposing ) : void

Disposes the service client.

Method Details

AmazonBatchClient() public method

Constructs AmazonBatchClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>
public AmazonBatchClient ( ) : System
return System

AmazonBatchClient() public method

Constructs AmazonBatchClient with AWS Credentials
public AmazonBatchClient ( AWSCredentials credentials ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
return System

AmazonBatchClient() public method

Constructs AmazonBatchClient with AWS Credentials and an AmazonBatchClient Configuration object.
public AmazonBatchClient ( AWSCredentials credentials, AmazonBatchConfig clientConfig ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
clientConfig AmazonBatchConfig The AmazonBatchClient Configuration Object
return System

AmazonBatchClient() public method

Constructs AmazonBatchClient with AWS Credentials
public AmazonBatchClient ( AWSCredentials credentials, RegionEndpoint region ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
region RegionEndpoint The region to connect.
return System

AmazonBatchClient() public method

Constructs AmazonBatchClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>
public AmazonBatchClient ( AmazonBatchConfig config ) : System
config AmazonBatchConfig The AmazonBatchClient Configuration Object
return System

AmazonBatchClient() public method

Constructs AmazonBatchClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>
public AmazonBatchClient ( RegionEndpoint region ) : System
region RegionEndpoint The region to connect.
return System

AmazonBatchClient() public method

Constructs AmazonBatchClient with AWS Access Key ID and AWS Secret Key
public AmazonBatchClient ( string awsAccessKeyId, string awsSecretAccessKey ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
return System

AmazonBatchClient() public method

Constructs AmazonBatchClient with AWS Access Key ID, AWS Secret Key and an AmazonBatchClient Configuration object.
public AmazonBatchClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonBatchConfig clientConfig ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
clientConfig AmazonBatchConfig The AmazonBatchClient Configuration Object
return System

AmazonBatchClient() public method

Constructs AmazonBatchClient with AWS Access Key ID and AWS Secret Key
public AmazonBatchClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
region RegionEndpoint The region to connect.
return System

AmazonBatchClient() public method

Constructs AmazonBatchClient with AWS Access Key ID and AWS Secret Key
public AmazonBatchClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
return System

AmazonBatchClient() public method

Constructs AmazonBatchClient with AWS Access Key ID, AWS Secret Key and an AmazonBatchClient Configuration object.
public AmazonBatchClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonBatchConfig clientConfig ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
clientConfig AmazonBatchConfig The AmazonBatchClient Configuration Object
return System

AmazonBatchClient() public method

Constructs AmazonBatchClient with AWS Access Key ID and AWS Secret Key
public AmazonBatchClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
region RegionEndpoint The region to connect.
return System

BeginCancelJob() public method

Initiates the asynchronous execution of the CancelJob operation.
public BeginCancelJob ( CancelJobRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.Batch.Model.CancelJobRequest Container for the necessary parameters to execute the CancelJob operation on AmazonBatchClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginCreateComputeEnvironment() public method

Initiates the asynchronous execution of the CreateComputeEnvironment operation.
public BeginCreateComputeEnvironment ( CreateComputeEnvironmentRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.Batch.Model.CreateComputeEnvironmentRequest Container for the necessary parameters to execute the CreateComputeEnvironment operation on AmazonBatchClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginCreateJobQueue() public method

Initiates the asynchronous execution of the CreateJobQueue operation.
public BeginCreateJobQueue ( CreateJobQueueRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.Batch.Model.CreateJobQueueRequest Container for the necessary parameters to execute the CreateJobQueue operation on AmazonBatchClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDeleteComputeEnvironment() public method

Initiates the asynchronous execution of the DeleteComputeEnvironment operation.
public BeginDeleteComputeEnvironment ( DeleteComputeEnvironmentRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.Batch.Model.DeleteComputeEnvironmentRequest Container for the necessary parameters to execute the DeleteComputeEnvironment operation on AmazonBatchClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDeleteJobQueue() public method

Initiates the asynchronous execution of the DeleteJobQueue operation.
public BeginDeleteJobQueue ( DeleteJobQueueRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.Batch.Model.DeleteJobQueueRequest Container for the necessary parameters to execute the DeleteJobQueue operation on AmazonBatchClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDeregisterJobDefinition() public method

Initiates the asynchronous execution of the DeregisterJobDefinition operation.
public BeginDeregisterJobDefinition ( DeregisterJobDefinitionRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.Batch.Model.DeregisterJobDefinitionRequest Container for the necessary parameters to execute the DeregisterJobDefinition operation on AmazonBatchClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeComputeEnvironments() public method

Initiates the asynchronous execution of the DescribeComputeEnvironments operation.
public BeginDescribeComputeEnvironments ( DescribeComputeEnvironmentsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.Batch.Model.DescribeComputeEnvironmentsRequest Container for the necessary parameters to execute the DescribeComputeEnvironments operation on AmazonBatchClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeJobDefinitions() public method

Initiates the asynchronous execution of the DescribeJobDefinitions operation.
public BeginDescribeJobDefinitions ( DescribeJobDefinitionsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.Batch.Model.DescribeJobDefinitionsRequest Container for the necessary parameters to execute the DescribeJobDefinitions operation on AmazonBatchClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeJobQueues() public method

Initiates the asynchronous execution of the DescribeJobQueues operation.
public BeginDescribeJobQueues ( DescribeJobQueuesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.Batch.Model.DescribeJobQueuesRequest Container for the necessary parameters to execute the DescribeJobQueues operation on AmazonBatchClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeJobs() public method

Initiates the asynchronous execution of the DescribeJobs operation.
public BeginDescribeJobs ( DescribeJobsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.Batch.Model.DescribeJobsRequest Container for the necessary parameters to execute the DescribeJobs operation on AmazonBatchClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginListJobs() public method

Initiates the asynchronous execution of the ListJobs operation.
public BeginListJobs ( ListJobsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.Batch.Model.ListJobsRequest Container for the necessary parameters to execute the ListJobs operation on AmazonBatchClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginRegisterJobDefinition() public method

Initiates the asynchronous execution of the RegisterJobDefinition operation.
public BeginRegisterJobDefinition ( RegisterJobDefinitionRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.Batch.Model.RegisterJobDefinitionRequest Container for the necessary parameters to execute the RegisterJobDefinition operation on AmazonBatchClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginSubmitJob() public method

Initiates the asynchronous execution of the SubmitJob operation.
public BeginSubmitJob ( SubmitJobRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.Batch.Model.SubmitJobRequest Container for the necessary parameters to execute the SubmitJob operation on AmazonBatchClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginTerminateJob() public method

Initiates the asynchronous execution of the TerminateJob operation.
public BeginTerminateJob ( TerminateJobRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.Batch.Model.TerminateJobRequest Container for the necessary parameters to execute the TerminateJob operation on AmazonBatchClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginUpdateComputeEnvironment() public method

Initiates the asynchronous execution of the UpdateComputeEnvironment operation.
public BeginUpdateComputeEnvironment ( UpdateComputeEnvironmentRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.Batch.Model.UpdateComputeEnvironmentRequest Container for the necessary parameters to execute the UpdateComputeEnvironment operation on AmazonBatchClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginUpdateJobQueue() public method

Initiates the asynchronous execution of the UpdateJobQueue operation.
public BeginUpdateJobQueue ( UpdateJobQueueRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.Batch.Model.UpdateJobQueueRequest Container for the necessary parameters to execute the UpdateJobQueue operation on AmazonBatchClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

CancelJob() public method

Cancels jobs 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 jobs are cancelled); these jobs must be terminated with the TerminateJob operation.
/// These errors are usually caused by a client action, such as using an action or resource /// on behalf of a user that doesn't have permission to use the action or resource, or /// specifying an identifier that is not valid. /// /// These errors are usually caused by a server issue. ///
public CancelJob ( CancelJobRequest request ) : CancelJobResponse
request Amazon.Batch.Model.CancelJobRequest Container for the necessary parameters to execute the CancelJob service method.
return CancelJobResponse

CancelJobAsync() public method

Initiates the asynchronous execution of the CancelJob operation.
public CancelJobAsync ( CancelJobRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.Batch.Model.CancelJobRequest Container for the necessary parameters to execute the CancelJob operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

CreateComputeEnvironment() public method

Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGEDcompute 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 the latest Amazon ECS-optimized AMI. You can choose to use Amazon EC2 On-Demand instances in your managed compute environment, or you can use Amazon EC2 Spot instances that only launch when the Spot bid price is below a specified percentage of the On-Demand price.

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 EC2 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 EC2 Container Service Developer Guide.

/// These errors are usually caused by a client action, such as using an action or resource /// on behalf of a user that doesn't have permission to use the action or resource, or /// specifying an identifier that is not valid. /// /// These errors are usually caused by a server issue. ///
public CreateComputeEnvironment ( CreateComputeEnvironmentRequest request ) : CreateComputeEnvironmentResponse
request Amazon.Batch.Model.CreateComputeEnvironmentRequest Container for the necessary parameters to execute the CreateComputeEnvironment service method.
return Amazon.Batch.Model.CreateComputeEnvironmentResponse

CreateComputeEnvironmentAsync() public method

Initiates the asynchronous execution of the CreateComputeEnvironment operation.
public CreateComputeEnvironmentAsync ( CreateComputeEnvironmentRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.Batch.Model.CreateComputeEnvironmentRequest Container for the necessary parameters to execute the CreateComputeEnvironment operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

CreateJobQueue() public method

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.

/// These errors are usually caused by a client action, such as using an action or resource /// on behalf of a user that doesn't have permission to use the action or resource, or /// specifying an identifier that is not valid. /// /// These errors are usually caused by a server issue. ///
public CreateJobQueue ( CreateJobQueueRequest request ) : CreateJobQueueResponse
request Amazon.Batch.Model.CreateJobQueueRequest Container for the necessary parameters to execute the CreateJobQueue service method.
return Amazon.Batch.Model.CreateJobQueueResponse

CreateJobQueueAsync() public method

Initiates the asynchronous execution of the CreateJobQueue operation.
public CreateJobQueueAsync ( CreateJobQueueRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.Batch.Model.CreateJobQueueRequest Container for the necessary parameters to execute the CreateJobQueue operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

CreateSigner() protected method

Creates the signer for the service.
protected CreateSigner ( ) : AbstractAWSSigner
return Amazon.Runtime.Internal.Auth.AbstractAWSSigner

DeleteComputeEnvironment() public method

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.

/// These errors are usually caused by a client action, such as using an action or resource /// on behalf of a user that doesn't have permission to use the action or resource, or /// specifying an identifier that is not valid. /// /// These errors are usually caused by a server issue. ///
public DeleteComputeEnvironment ( DeleteComputeEnvironmentRequest request ) : DeleteComputeEnvironmentResponse
request Amazon.Batch.Model.DeleteComputeEnvironmentRequest Container for the necessary parameters to execute the DeleteComputeEnvironment service method.
return DeleteComputeEnvironmentResponse

DeleteComputeEnvironmentAsync() public method

Initiates the asynchronous execution of the DeleteComputeEnvironment operation.
public DeleteComputeEnvironmentAsync ( DeleteComputeEnvironmentRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.Batch.Model.DeleteComputeEnvironmentRequest Container for the necessary parameters to execute the DeleteComputeEnvironment operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteJobQueue() public method

Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation and terminate any jobs that have not completed with the TerminateJob.

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

/// These errors are usually caused by a client action, such as using an action or resource /// on behalf of a user that doesn't have permission to use the action or resource, or /// specifying an identifier that is not valid. /// /// These errors are usually caused by a server issue. ///
public DeleteJobQueue ( DeleteJobQueueRequest request ) : DeleteJobQueueResponse
request Amazon.Batch.Model.DeleteJobQueueRequest Container for the necessary parameters to execute the DeleteJobQueue service method.
return DeleteJobQueueResponse

DeleteJobQueueAsync() public method

Initiates the asynchronous execution of the DeleteJobQueue operation.
public DeleteJobQueueAsync ( DeleteJobQueueRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.Batch.Model.DeleteJobQueueRequest Container for the necessary parameters to execute the DeleteJobQueue operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeregisterJobDefinition() public method

Deregisters an AWS Batch job definition.
/// These errors are usually caused by a client action, such as using an action or resource /// on behalf of a user that doesn't have permission to use the action or resource, or /// specifying an identifier that is not valid. /// /// These errors are usually caused by a server issue. ///
public DeregisterJobDefinition ( DeregisterJobDefinitionRequest request ) : DeregisterJobDefinitionResponse
request Amazon.Batch.Model.DeregisterJobDefinitionRequest Container for the necessary parameters to execute the DeregisterJobDefinition service method.
return DeregisterJobDefinitionResponse

DeregisterJobDefinitionAsync() public method

Initiates the asynchronous execution of the DeregisterJobDefinition operation.
public DeregisterJobDefinitionAsync ( DeregisterJobDefinitionRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.Batch.Model.DeregisterJobDefinitionRequest Container for the necessary parameters to execute the DeregisterJobDefinition operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeComputeEnvironments() public method

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.

/// These errors are usually caused by a client action, such as using an action or resource /// on behalf of a user that doesn't have permission to use the action or resource, or /// specifying an identifier that is not valid. /// /// These errors are usually caused by a server issue. ///
public DescribeComputeEnvironments ( DescribeComputeEnvironmentsRequest request ) : DescribeComputeEnvironmentsResponse
request Amazon.Batch.Model.DescribeComputeEnvironmentsRequest Container for the necessary parameters to execute the DescribeComputeEnvironments service method.
return Amazon.Batch.Model.DescribeComputeEnvironmentsResponse

DescribeComputeEnvironmentsAsync() public method

Initiates the asynchronous execution of the DescribeComputeEnvironments operation.
public DescribeComputeEnvironmentsAsync ( DescribeComputeEnvironmentsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.Batch.Model.DescribeComputeEnvironmentsRequest Container for the necessary parameters to execute the DescribeComputeEnvironments operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeJobDefinitions() public method

Describes a list of job definitions. You can specify a status (such as ACTIVE) to only return job definitions that match that status.
/// These errors are usually caused by a client action, such as using an action or resource /// on behalf of a user that doesn't have permission to use the action or resource, or /// specifying an identifier that is not valid. /// /// These errors are usually caused by a server issue. ///
public DescribeJobDefinitions ( DescribeJobDefinitionsRequest request ) : DescribeJobDefinitionsResponse
request Amazon.Batch.Model.DescribeJobDefinitionsRequest Container for the necessary parameters to execute the DescribeJobDefinitions service method.
return Amazon.Batch.Model.DescribeJobDefinitionsResponse

DescribeJobDefinitionsAsync() public method

Initiates the asynchronous execution of the DescribeJobDefinitions operation.
public DescribeJobDefinitionsAsync ( DescribeJobDefinitionsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.Batch.Model.DescribeJobDefinitionsRequest Container for the necessary parameters to execute the DescribeJobDefinitions operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeJobQueues() public method

Describes one or more of your job queues.
/// These errors are usually caused by a client action, such as using an action or resource /// on behalf of a user that doesn't have permission to use the action or resource, or /// specifying an identifier that is not valid. /// /// These errors are usually caused by a server issue. ///
public DescribeJobQueues ( DescribeJobQueuesRequest request ) : DescribeJobQueuesResponse
request Amazon.Batch.Model.DescribeJobQueuesRequest Container for the necessary parameters to execute the DescribeJobQueues service method.
return Amazon.Batch.Model.DescribeJobQueuesResponse

DescribeJobQueuesAsync() public method

Initiates the asynchronous execution of the DescribeJobQueues operation.
public DescribeJobQueuesAsync ( DescribeJobQueuesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.Batch.Model.DescribeJobQueuesRequest Container for the necessary parameters to execute the DescribeJobQueues operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeJobs() public method

Describes a list of AWS Batch jobs.
/// These errors are usually caused by a client action, such as using an action or resource /// on behalf of a user that doesn't have permission to use the action or resource, or /// specifying an identifier that is not valid. /// /// These errors are usually caused by a server issue. ///
public DescribeJobs ( DescribeJobsRequest request ) : DescribeJobsResponse
request Amazon.Batch.Model.DescribeJobsRequest Container for the necessary parameters to execute the DescribeJobs service method.
return Amazon.Batch.Model.DescribeJobsResponse

DescribeJobsAsync() public method

Initiates the asynchronous execution of the DescribeJobs operation.
public DescribeJobsAsync ( DescribeJobsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.Batch.Model.DescribeJobsRequest Container for the necessary parameters to execute the DescribeJobs operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

Dispose() protected method

Disposes the service client.
protected Dispose ( bool disposing ) : void
disposing bool
return void

EndCancelJob() public method

Finishes the asynchronous execution of the CancelJob operation.
public EndCancelJob ( IAsyncResult asyncResult ) : CancelJobResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginCancelJob.
return CancelJobResponse

EndCreateComputeEnvironment() public method

Finishes the asynchronous execution of the CreateComputeEnvironment operation.
public EndCreateComputeEnvironment ( IAsyncResult asyncResult ) : CreateComputeEnvironmentResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginCreateComputeEnvironment.
return Amazon.Batch.Model.CreateComputeEnvironmentResponse

EndCreateJobQueue() public method

Finishes the asynchronous execution of the CreateJobQueue operation.
public EndCreateJobQueue ( IAsyncResult asyncResult ) : CreateJobQueueResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginCreateJobQueue.
return Amazon.Batch.Model.CreateJobQueueResponse

EndDeleteComputeEnvironment() public method

Finishes the asynchronous execution of the DeleteComputeEnvironment operation.
public EndDeleteComputeEnvironment ( IAsyncResult asyncResult ) : DeleteComputeEnvironmentResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDeleteComputeEnvironment.
return DeleteComputeEnvironmentResponse

EndDeleteJobQueue() public method

Finishes the asynchronous execution of the DeleteJobQueue operation.
public EndDeleteJobQueue ( IAsyncResult asyncResult ) : DeleteJobQueueResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDeleteJobQueue.
return DeleteJobQueueResponse

EndDeregisterJobDefinition() public method

Finishes the asynchronous execution of the DeregisterJobDefinition operation.
public EndDeregisterJobDefinition ( IAsyncResult asyncResult ) : DeregisterJobDefinitionResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDeregisterJobDefinition.
return DeregisterJobDefinitionResponse

EndDescribeComputeEnvironments() public method

Finishes the asynchronous execution of the DescribeComputeEnvironments operation.
public EndDescribeComputeEnvironments ( IAsyncResult asyncResult ) : DescribeComputeEnvironmentsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeComputeEnvironments.
return Amazon.Batch.Model.DescribeComputeEnvironmentsResponse

EndDescribeJobDefinitions() public method

Finishes the asynchronous execution of the DescribeJobDefinitions operation.
public EndDescribeJobDefinitions ( IAsyncResult asyncResult ) : DescribeJobDefinitionsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeJobDefinitions.
return Amazon.Batch.Model.DescribeJobDefinitionsResponse

EndDescribeJobQueues() public method

Finishes the asynchronous execution of the DescribeJobQueues operation.
public EndDescribeJobQueues ( IAsyncResult asyncResult ) : DescribeJobQueuesResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeJobQueues.
return Amazon.Batch.Model.DescribeJobQueuesResponse

EndDescribeJobs() public method

Finishes the asynchronous execution of the DescribeJobs operation.
public EndDescribeJobs ( IAsyncResult asyncResult ) : DescribeJobsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeJobs.
return Amazon.Batch.Model.DescribeJobsResponse

EndListJobs() public method

Finishes the asynchronous execution of the ListJobs operation.
public EndListJobs ( IAsyncResult asyncResult ) : ListJobsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginListJobs.
return Amazon.Batch.Model.ListJobsResponse

EndRegisterJobDefinition() public method

Finishes the asynchronous execution of the RegisterJobDefinition operation.
public EndRegisterJobDefinition ( IAsyncResult asyncResult ) : RegisterJobDefinitionResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginRegisterJobDefinition.
return Amazon.Batch.Model.RegisterJobDefinitionResponse

EndSubmitJob() public method

Finishes the asynchronous execution of the SubmitJob operation.
public EndSubmitJob ( IAsyncResult asyncResult ) : SubmitJobResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginSubmitJob.
return Amazon.Batch.Model.SubmitJobResponse

EndTerminateJob() public method

Finishes the asynchronous execution of the TerminateJob operation.
public EndTerminateJob ( IAsyncResult asyncResult ) : TerminateJobResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginTerminateJob.
return TerminateJobResponse

EndUpdateComputeEnvironment() public method

Finishes the asynchronous execution of the UpdateComputeEnvironment operation.
public EndUpdateComputeEnvironment ( IAsyncResult asyncResult ) : UpdateComputeEnvironmentResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginUpdateComputeEnvironment.
return Amazon.Batch.Model.UpdateComputeEnvironmentResponse

EndUpdateJobQueue() public method

Finishes the asynchronous execution of the UpdateJobQueue operation.
public EndUpdateJobQueue ( IAsyncResult asyncResult ) : UpdateJobQueueResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginUpdateJobQueue.
return Amazon.Batch.Model.UpdateJobQueueResponse

ListJobs() public method

Returns a list of task jobs for a specified job queue. You can filter the results by job status with the jobStatus parameter.
/// These errors are usually caused by a client action, such as using an action or resource /// on behalf of a user that doesn't have permission to use the action or resource, or /// specifying an identifier that is not valid. /// /// These errors are usually caused by a server issue. ///
public ListJobs ( ListJobsRequest request ) : ListJobsResponse
request Amazon.Batch.Model.ListJobsRequest Container for the necessary parameters to execute the ListJobs service method.
return Amazon.Batch.Model.ListJobsResponse

ListJobsAsync() public method

Initiates the asynchronous execution of the ListJobs operation.
public ListJobsAsync ( ListJobsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.Batch.Model.ListJobsRequest Container for the necessary parameters to execute the ListJobs operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

RegisterJobDefinition() public method

Registers an AWS Batch job definition.
/// These errors are usually caused by a client action, such as using an action or resource /// on behalf of a user that doesn't have permission to use the action or resource, or /// specifying an identifier that is not valid. /// /// These errors are usually caused by a server issue. ///
public RegisterJobDefinition ( RegisterJobDefinitionRequest request ) : RegisterJobDefinitionResponse
request Amazon.Batch.Model.RegisterJobDefinitionRequest Container for the necessary parameters to execute the RegisterJobDefinition service method.
return Amazon.Batch.Model.RegisterJobDefinitionResponse

RegisterJobDefinitionAsync() public method

Initiates the asynchronous execution of the RegisterJobDefinition operation.
public RegisterJobDefinitionAsync ( RegisterJobDefinitionRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.Batch.Model.RegisterJobDefinitionRequest Container for the necessary parameters to execute the RegisterJobDefinition operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

SubmitJob() public method

Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition.
/// These errors are usually caused by a client action, such as using an action or resource /// on behalf of a user that doesn't have permission to use the action or resource, or /// specifying an identifier that is not valid. /// /// These errors are usually caused by a server issue. ///
public SubmitJob ( SubmitJobRequest request ) : SubmitJobResponse
request Amazon.Batch.Model.SubmitJobRequest Container for the necessary parameters to execute the SubmitJob service method.
return Amazon.Batch.Model.SubmitJobResponse

SubmitJobAsync() public method

Initiates the asynchronous execution of the SubmitJob operation.
public SubmitJobAsync ( SubmitJobRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.Batch.Model.SubmitJobRequest Container for the necessary parameters to execute the SubmitJob operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

TerminateJob() public method

Terminates jobs 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.
/// These errors are usually caused by a client action, such as using an action or resource /// on behalf of a user that doesn't have permission to use the action or resource, or /// specifying an identifier that is not valid. /// /// These errors are usually caused by a server issue. ///
public TerminateJob ( TerminateJobRequest request ) : TerminateJobResponse
request Amazon.Batch.Model.TerminateJobRequest Container for the necessary parameters to execute the TerminateJob service method.
return TerminateJobResponse

TerminateJobAsync() public method

Initiates the asynchronous execution of the TerminateJob operation.
public TerminateJobAsync ( TerminateJobRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.Batch.Model.TerminateJobRequest Container for the necessary parameters to execute the TerminateJob operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

UpdateComputeEnvironment() public method

Updates an AWS Batch compute environment.
/// These errors are usually caused by a client action, such as using an action or resource /// on behalf of a user that doesn't have permission to use the action or resource, or /// specifying an identifier that is not valid. /// /// These errors are usually caused by a server issue. ///
public UpdateComputeEnvironment ( UpdateComputeEnvironmentRequest request ) : UpdateComputeEnvironmentResponse
request Amazon.Batch.Model.UpdateComputeEnvironmentRequest Container for the necessary parameters to execute the UpdateComputeEnvironment service method.
return Amazon.Batch.Model.UpdateComputeEnvironmentResponse

UpdateComputeEnvironmentAsync() public method

Initiates the asynchronous execution of the UpdateComputeEnvironment operation.
public UpdateComputeEnvironmentAsync ( UpdateComputeEnvironmentRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.Batch.Model.UpdateComputeEnvironmentRequest Container for the necessary parameters to execute the UpdateComputeEnvironment operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

UpdateJobQueue() public method

Updates a job queue.
/// These errors are usually caused by a client action, such as using an action or resource /// on behalf of a user that doesn't have permission to use the action or resource, or /// specifying an identifier that is not valid. /// /// These errors are usually caused by a server issue. ///
public UpdateJobQueue ( UpdateJobQueueRequest request ) : UpdateJobQueueResponse
request Amazon.Batch.Model.UpdateJobQueueRequest Container for the necessary parameters to execute the UpdateJobQueue service method.
return Amazon.Batch.Model.UpdateJobQueueResponse

UpdateJobQueueAsync() public method

Initiates the asynchronous execution of the UpdateJobQueue operation.
public UpdateJobQueueAsync ( UpdateJobQueueRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.Batch.Model.UpdateJobQueueRequest Container for the necessary parameters to execute the UpdateJobQueue operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task