@datafire/amazonaws_batch

Client library for AWS Batch

Installation and Usage

npm install --save @datafire/amazonaws_batch

let amazonaws_batch = require('@datafire/amazonaws_batch').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_batch.CancelJob({
  "jobId": "",
  "reason": ""
}).then(data => {
  console.log(data);
});

Description

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.

Actions

CancelJob

amazonaws_batch.CancelJob({
  "jobId": "",
  "reason": ""
}, context)

Input

• input object
  • jobId required String
  • reason required String

Output

• output CancelJobResponse

CreateComputeEnvironment

amazonaws_batch.CreateComputeEnvironment({
  "computeEnvironmentName": "",
  "type": "",
  "serviceRole": ""
}, context)

Input

• input object
  • computeEnvironmentName required String
  • computeResources ComputeResource
  • serviceRole required String
  • state CEState
  • type required CEType

Output

• output CreateComputeEnvironmentResponse

CreateJobQueue

amazonaws_batch.CreateJobQueue({
  "jobQueueName": "",
  "priority": 0,
  "computeEnvironmentOrder": []
}, context)

Input

• input object
  • computeEnvironmentOrder required ComputeEnvironmentOrders
  • jobQueueName required String
  • priority required Integer
  • state JQState

Output

• output CreateJobQueueResponse

DeleteComputeEnvironment

amazonaws_batch.DeleteComputeEnvironment({
  "computeEnvironment": ""
}, context)

Input

• input object
  • computeEnvironment required String

Output

• output DeleteComputeEnvironmentResponse

DeleteJobQueue

amazonaws_batch.DeleteJobQueue({
  "jobQueue": ""
}, context)

Input

• input object
  • jobQueue required String

Output

• output DeleteJobQueueResponse

DeregisterJobDefinition

amazonaws_batch.DeregisterJobDefinition({
  "jobDefinition": ""
}, context)

Input

• input object
  • jobDefinition required String

Output

• output DeregisterJobDefinitionResponse

DescribeComputeEnvironments

amazonaws_batch.DescribeComputeEnvironments({}, context)

Input

• input object
  • computeEnvironments StringList
  • maxResults Integer
  • nextToken String

Output

• output DescribeComputeEnvironmentsResponse

DescribeJobDefinitions

amazonaws_batch.DescribeJobDefinitions({}, context)

Input

• input object
  • jobDefinitionName String
  • jobDefinitions StringList
  • maxResults Integer
  • nextToken String
  • status String

Output

• output DescribeJobDefinitionsResponse

DescribeJobQueues

amazonaws_batch.DescribeJobQueues({}, context)

Input

• input object
  • jobQueues StringList
  • maxResults Integer
  • nextToken String

Output

• output DescribeJobQueuesResponse

DescribeJobs

amazonaws_batch.DescribeJobs({
  "jobs": []
}, context)

Input

• input object
  • jobs required StringList

Output

• output DescribeJobsResponse

ListJobs

amazonaws_batch.ListJobs({}, context)

Input

• input object
  • arrayJobId String
  • jobQueue String
  • jobStatus JobStatus
  • maxResults Integer
  • nextToken String

Output

• output ListJobsResponse

RegisterJobDefinition

amazonaws_batch.RegisterJobDefinition({
  "jobDefinitionName": "",
  "type": ""
}, context)

Input

• input object
  • containerProperties ContainerProperties
  • jobDefinitionName required String
  • parameters ParametersMap
  • retryStrategy RetryStrategy
  • type required JobDefinitionType

Output

• output RegisterJobDefinitionResponse

SubmitJob

amazonaws_batch.SubmitJob({
  "jobName": "",
  "jobQueue": "",
  "jobDefinition": ""
}, context)

Input

• input object
  • arrayProperties ArrayProperties
  • containerOverrides ContainerOverrides
  • dependsOn JobDependencyList
  • jobDefinition required String
  • jobName required String
  • jobQueue required String
  • parameters ParametersMap
  • retryStrategy RetryStrategy

Output

• output SubmitJobResponse

TerminateJob

amazonaws_batch.TerminateJob({
  "jobId": "",
  "reason": ""
}, context)

Input

• input object
  • jobId required String
  • reason required String

Output

• output TerminateJobResponse

UpdateComputeEnvironment

amazonaws_batch.UpdateComputeEnvironment({
  "computeEnvironment": ""
}, context)

Input

• input object
  • computeEnvironment required String
  • computeResources ComputeResourceUpdate
  • serviceRole String
  • state CEState

Output

• output UpdateComputeEnvironmentResponse

UpdateJobQueue

amazonaws_batch.UpdateJobQueue({
  "jobQueue": ""
}, context)

Input

• input object
  • computeEnvironmentOrder ComputeEnvironmentOrders
  • jobQueue required String
  • priority Integer
  • state JQState

Output

• output UpdateJobQueueResponse

Definitions

ArrayJobDependency

• ArrayJobDependency string (values: N_TO_N, SEQUENTIAL)

ArrayJobStatusSummary

• ArrayJobStatusSummary array
  • items object
    • key String
    • value Integer

ArrayProperties

• ArrayProperties object: An object representing an AWS Batch array job.
  • size Integer

ArrayPropertiesDetail

• ArrayPropertiesDetail object: An object representing the array properties of a job.
  • index Integer
  • size Integer
  • statusSummary ArrayJobStatusSummary

ArrayPropertiesSummary

• ArrayPropertiesSummary object: An object representing the array properties of a job.
  • index Integer
  • size Integer

AttemptContainerDetail

• AttemptContainerDetail object: An object representing the details of a container that is part of a job attempt.
  • containerInstanceArn String
  • exitCode Integer
  • logStreamName String
  • reason String
  • taskArn String

AttemptDetail

• AttemptDetail object: An object representing a job attempt.
  • container AttemptContainerDetail
  • startedAt Long
  • statusReason String
  • stoppedAt Long

AttemptDetails

• AttemptDetails array
  • items AttemptDetail

Boolean

• Boolean boolean

CEState

• CEState string (values: ENABLED, DISABLED)

CEStatus

• CEStatus string (values: CREATING, UPDATING, DELETING, DELETED, VALID, INVALID)

CEType

• CEType string (values: MANAGED, UNMANAGED)

CRType

• CRType string (values: EC2, SPOT)

CancelJobRequest

• CancelJobRequest object
  • jobId required String
  • reason required String

CancelJobResponse

• CancelJobResponse object

ClientException

• ClientException object: 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 permissions to use the action or resource, or specifying an identifier that is not valid.
  • message String

ComputeEnvironmentDetail

• ComputeEnvironmentDetail object: An object representing an AWS Batch compute environment.
  • computeEnvironmentArn required String
  • computeEnvironmentName required String
  • computeResources ComputeResource
  • ecsClusterArn required String
  • serviceRole String
  • state CEState
  • status CEStatus
  • statusReason String
  • type CEType

ComputeEnvironmentDetailList

• ComputeEnvironmentDetailList array
  • items ComputeEnvironmentDetail

ComputeEnvironmentOrder

• ComputeEnvironmentOrder object: The order in which compute environments are tried for job placement within a queue. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.
  • computeEnvironment required String
  • order required Integer

ComputeEnvironmentOrders

• ComputeEnvironmentOrders array
  • items ComputeEnvironmentOrder

ComputeResource

• ComputeResource object: An object representing an AWS Batch compute resource.
  • bidPercentage Integer
  • desiredvCpus Integer
  • ec2KeyPair String
  • imageId String
  • instanceRole required String
  • instanceTypes required StringList
  • maxvCpus required Integer
  • minvCpus required Integer
  • securityGroupIds required StringList
  • spotIamFleetRole String
  • subnets required StringList
  • tags TagsMap
  • type required CRType

ComputeResourceUpdate

• ComputeResourceUpdate object: An object representing the attributes of a compute environment that can be updated.
  • desiredvCpus Integer
  • maxvCpus Integer
  • minvCpus Integer

ContainerDetail

• ContainerDetail object: An object representing the details of a container that is part of a job.
  • command StringList
  • containerInstanceArn String
  • environment EnvironmentVariables
  • exitCode Integer
  • image String
  • jobRoleArn String
  • logStreamName String
  • memory Integer
  • mountPoints MountPoints
  • privileged Boolean
  • readonlyRootFilesystem Boolean
  • reason String
  • taskArn String
  • ulimits Ulimits
  • user String
  • vcpus Integer
  • volumes Volumes

ContainerOverrides

• ContainerOverrides object: The overrides that should be sent to a container.
  • command StringList
  • environment EnvironmentVariables
  • memory Integer
  • vcpus Integer

ContainerProperties

• ContainerProperties object: Container properties are used in job definitions to describe the container that is launched as part of a job.
  • command StringList
  • environment EnvironmentVariables
  • image required String
  • jobRoleArn String
  • memory required Integer
  • mountPoints MountPoints
  • privileged Boolean
  • readonlyRootFilesystem Boolean
  • ulimits Ulimits
  • user String
  • vcpus required Integer
  • volumes Volumes

ContainerSummary

• ContainerSummary object: An object representing summary details of a container within a job.
  • exitCode Integer
  • reason String

CreateComputeEnvironmentRequest

• CreateComputeEnvironmentRequest object
  • computeEnvironmentName required String
  • computeResources ComputeResource
  • serviceRole required String
  • state CEState
  • type required CEType

CreateComputeEnvironmentResponse

• CreateComputeEnvironmentResponse object
  • computeEnvironmentArn String
  • computeEnvironmentName String

CreateJobQueueRequest

• CreateJobQueueRequest object
  • computeEnvironmentOrder required ComputeEnvironmentOrders
  • jobQueueName required String
  • priority required Integer
  • state JQState

CreateJobQueueResponse

• CreateJobQueueResponse object
  • jobQueueArn required String
  • jobQueueName required String

DeleteComputeEnvironmentRequest

• DeleteComputeEnvironmentRequest object
  • computeEnvironment required String

DeleteComputeEnvironmentResponse

• DeleteComputeEnvironmentResponse object

DeleteJobQueueRequest

• DeleteJobQueueRequest object
  • jobQueue required String

DeleteJobQueueResponse

• DeleteJobQueueResponse object

DeregisterJobDefinitionRequest

• DeregisterJobDefinitionRequest object
  • jobDefinition required String

DeregisterJobDefinitionResponse

• DeregisterJobDefinitionResponse object

DescribeComputeEnvironmentsRequest

• DescribeComputeEnvironmentsRequest object
  • computeEnvironments StringList
  • maxResults Integer
  • nextToken String

DescribeComputeEnvironmentsResponse

• DescribeComputeEnvironmentsResponse object
  • computeEnvironments ComputeEnvironmentDetailList
  • nextToken String

DescribeJobDefinitionsRequest

• DescribeJobDefinitionsRequest object
  • jobDefinitionName String
  • jobDefinitions StringList
  • maxResults Integer
  • nextToken String
  • status String

DescribeJobDefinitionsResponse

• DescribeJobDefinitionsResponse object
  • jobDefinitions JobDefinitionList
  • nextToken String

DescribeJobQueuesRequest

• DescribeJobQueuesRequest object
  • jobQueues StringList
  • maxResults Integer
  • nextToken String

DescribeJobQueuesResponse

• DescribeJobQueuesResponse object
  • jobQueues JobQueueDetailList
  • nextToken String

DescribeJobsRequest

• DescribeJobsRequest object
  • jobs required StringList

DescribeJobsResponse

• DescribeJobsResponse object
  • jobs JobDetailList

EnvironmentVariables

• EnvironmentVariables array
  • items KeyValuePair

Host

• Host object: The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running.
  • sourcePath String

Integer

• Integer integer

JQState

• JQState string (values: ENABLED, DISABLED)

JQStatus

• JQStatus string (values: CREATING, UPDATING, DELETING, DELETED, VALID, INVALID)

JobDefinition

• JobDefinition object: An object representing an AWS Batch job definition.
  • containerProperties ContainerProperties
  • jobDefinitionArn required String
  • jobDefinitionName required String
  • parameters ParametersMap
  • retryStrategy RetryStrategy
  • revision required Integer
  • status String
  • type required String

JobDefinitionList

• JobDefinitionList array
  • items JobDefinition

JobDefinitionType

• JobDefinitionType string (values: container)

JobDependency

• JobDependency object: An object representing an AWS Batch job dependency.
  • jobId String
  • type ArrayJobDependency

JobDependencyList

• JobDependencyList array
  • items JobDependency

JobDetail

• JobDetail object: An object representing an AWS Batch job.
  • arrayProperties ArrayPropertiesDetail
  • attempts AttemptDetails
  • container ContainerDetail
  • createdAt Long
  • dependsOn JobDependencyList
  • jobDefinition required String
  • jobId required String
  • jobName required String
  • jobQueue required String
  • parameters ParametersMap
  • retryStrategy RetryStrategy
  • startedAt required Long
  • status required JobStatus
  • statusReason String
  • stoppedAt Long

JobDetailList

• JobDetailList array
  • items JobDetail

JobQueueDetail

• JobQueueDetail object: An object representing the details of an AWS Batch job queue.
  • computeEnvironmentOrder required ComputeEnvironmentOrders
  • jobQueueArn required String
  • jobQueueName required String
  • priority required Integer
  • state required JQState
  • status JQStatus
  • statusReason String

JobQueueDetailList

• JobQueueDetailList array
  • items JobQueueDetail

JobStatus

• JobStatus string (values: SUBMITTED, PENDING, RUNNABLE, STARTING, RUNNING, SUCCEEDED, FAILED)

JobSummary

• JobSummary object: An object representing summary details of a job.
  • arrayProperties ArrayPropertiesSummary
  • container ContainerSummary
  • createdAt Long
  • jobId required String
  • jobName required String
  • startedAt Long
  • status JobStatus
  • statusReason String
  • stoppedAt Long

JobSummaryList

• JobSummaryList array
  • items JobSummary

KeyValuePair

• KeyValuePair object: A key-value pair object.
  • name String
  • value String

ListJobsRequest

• ListJobsRequest object
  • arrayJobId String
  • jobQueue String
  • jobStatus JobStatus
  • maxResults Integer
  • nextToken String

ListJobsResponse

• ListJobsResponse object
  • jobSummaryList required JobSummaryList
  • nextToken String

Long

• Long integer

MountPoint

• MountPoint object: Details on a Docker volume mount point that is used in a job's container properties.
  • containerPath String
  • readOnly Boolean
  • sourceVolume String

MountPoints

• MountPoints array
  • items MountPoint

ParametersMap

• ParametersMap array
  • items object
    • key String
    • value String

RegisterJobDefinitionRequest

• RegisterJobDefinitionRequest object
  • containerProperties ContainerProperties
  • jobDefinitionName required String
  • parameters ParametersMap
  • retryStrategy RetryStrategy
  • type required JobDefinitionType

RegisterJobDefinitionResponse

• RegisterJobDefinitionResponse object
  • jobDefinitionArn required String
  • jobDefinitionName required String
  • revision required Integer

RetryStrategy

• RetryStrategy object: The retry strategy associated with a job.
  • attempts Integer

ServerException

• ServerException object: These errors are usually caused by a server issue.
  • message String

String

• String string

StringList

• StringList array
  • items String

SubmitJobRequest

• SubmitJobRequest object
  • arrayProperties ArrayProperties
  • containerOverrides ContainerOverrides
  • dependsOn JobDependencyList
  • jobDefinition required String
  • jobName required String
  • jobQueue required String
  • parameters ParametersMap
  • retryStrategy RetryStrategy

SubmitJobResponse

• SubmitJobResponse object
  • jobId required String
  • jobName required String

TagsMap

• TagsMap array
  • items object
    • key String
    • value String

TerminateJobRequest

• TerminateJobRequest object
  • jobId required String
  • reason required String

TerminateJobResponse

• TerminateJobResponse object

Ulimit

• Ulimit object: The ulimit settings to pass to the container.
  • hardLimit required Integer
  • name required String
  • softLimit required Integer

Ulimits

• Ulimits array
  • items Ulimit

UpdateComputeEnvironmentRequest

• UpdateComputeEnvironmentRequest object
  • computeEnvironment required String
  • computeResources ComputeResourceUpdate
  • serviceRole String
  • state CEState

UpdateComputeEnvironmentResponse

• UpdateComputeEnvironmentResponse object
  • computeEnvironmentArn String
  • computeEnvironmentName String

UpdateJobQueueRequest

• UpdateJobQueueRequest object
  • computeEnvironmentOrder ComputeEnvironmentOrders
  • jobQueue required String
  • priority Integer
  • state JQState

UpdateJobQueueResponse

• UpdateJobQueueResponse object
  • jobQueueArn String
  • jobQueueName String

Volume

• Volume object: A data volume used in a job's container properties.
  • host Host
  • name String

Volumes

• Volumes array
  • items Volume