Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api.deno.dev/v0.3/services/batch.ts?docs=full";

§Classes

Batch

§Interfaces

ArrayProperties

An object representing an Batch array job.

ArrayPropertiesDetail

An object representing the array properties of a job.

ArrayPropertiesSummary

An object representing the array properties of a job.

AttemptContainerDetail

An object representing the details of a container that's part of a job attempt.

AttemptDetail

An object representing a job attempt.

CancelJobRequest

Contains the parameters for CancelJob.

ComputeEnvironmentDetail

An object representing an Batch compute environment.

ComputeEnvironmentOrder

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. Compute environments must be in the VALID state before you can associate them with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

ComputeResource

An object representing an Batch compute resource. For more information, see Compute Environments in the Batch User Guide.

ComputeResourceUpdate

An object representing the attributes of a compute environment that can be updated. For more information, see Compute Environments in the Batch User Guide.

ContainerDetail

An object representing the details of a container that's part of a job.

ContainerOverrides

The overrides that should be sent to a container.

ContainerProperties

Container properties are used in job definitions to describe the container that's launched as part of a job.

ContainerSummary

An object representing summary details of a container within a job.

CreateComputeEnvironmentRequest

Contains the parameters for CreateComputeEnvironment.

CreateComputeEnvironmentResponse
CreateJobQueueRequest

Contains the parameters for CreateJobQueue.

CreateJobQueueResponse
CreateSchedulingPolicyRequest
CreateSchedulingPolicyResponse
DeleteComputeEnvironmentRequest

Contains the parameters for DeleteComputeEnvironment.

DeleteJobQueueRequest

Contains the parameters for DeleteJobQueue.

DeleteSchedulingPolicyRequest
DeregisterJobDefinitionRequest
DescribeComputeEnvironmentsRequest

Contains the parameters for DescribeComputeEnvironments.

DescribeComputeEnvironmentsResponse
DescribeJobDefinitionsRequest

Contains the parameters for DescribeJobDefinitions.

DescribeJobDefinitionsResponse
DescribeJobQueuesRequest

Contains the parameters for DescribeJobQueues.

DescribeJobQueuesResponse
DescribeJobsRequest

Contains the parameters for DescribeJobs.

DescribeJobsResponse
DescribeSchedulingPoliciesRequest
DescribeSchedulingPoliciesResponse
Device

An object representing a container instance host device.

Ec2Configuration

Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL2 (Amazon Linux 2).

EFSAuthorizationConfig

The authorization configuration details for the Amazon EFS file system.

EFSVolumeConfiguration

This is used when you're using an Amazon Elastic File System file system for job storage. For more information, see Amazon EFS Volumes in the Batch User Guide.

EvaluateOnExit

Specifies a set of conditions to be met, and an action to take (RETRY or EXIT) if all conditions are met.

FairsharePolicy

The fair share policy for a scheduling policy.

FargatePlatformConfiguration

The platform configuration for jobs that are running on Fargate resources. Jobs that run on EC2 resources must not specify this parameter.

Host

Determine whether your data volume persists on the host container instance and where it is stored. If this parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data isn't guaranteed to persist after the containers associated with it stop running.

JobDefinition

An object representing an Batch job definition.

JobDependency

An object representing an Batch job dependency.

JobDetail

An object representing an Batch job.

JobQueueDetail

An object representing the details of an Batch job queue.

JobSummary

An object representing summary details of a job.

JobTimeout

An object representing a job timeout configuration.

KeyValuePair

A key-value pair object.

KeyValuesPair

A filter name and value pair that's used to return a more specific list of results from a ListJobs API operation.

LaunchTemplateSpecification

An object representing a launch template associated with a compute resource. You must specify either the launch template ID or launch template name in the request, but not both.

LinuxParameters

Linux-specific modifications that are applied to the container, such as details for device mappings.

ListJobsRequest

Contains the parameters for ListJobs.

ListJobsResponse
ListSchedulingPoliciesRequest
ListSchedulingPoliciesResponse
ListTagsForResourceRequest
ListTagsForResourceResponse
LogConfiguration

Log configuration options to send to a custom log driver for the container.

MountPoint

Details on a Docker volume mount point that's used in a job's container properties. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

NetworkConfiguration

The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.

NetworkInterface

An object representing the elastic network interface for a multi-node parallel job node.

NodeDetails

An object representing the details of a multi-node parallel job node.

NodeOverrides

Object representing any node overrides to a job definition that's used in a "SubmitJob" API operation.

NodeProperties

An object representing the node properties of a multi-node parallel job.

NodePropertiesSummary

An object representing the properties of a node that's associated with a multi-node parallel job.

NodePropertyOverride

Object representing any node overrides to a job definition that's used in a "SubmitJob" API operation.

NodeRangeProperty

An object representing the properties of the node range for a multi-node parallel job.

RegisterJobDefinitionRequest

Contains the parameters for RegisterJobDefinition.

RegisterJobDefinitionResponse
ResourceRequirement

The type and amount of a resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

RetryStrategy

The retry strategy associated with a job. For more information, see Automated job retries in the Batch User Guide.

SchedulingPolicyDetail

An object that represents a scheduling policy.

SchedulingPolicyListingDetail

An object that contains the details of a scheduling policy that's returned in a ListSchedulingPolicy action.

Secret

An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:

ShareAttributes

Specifies the weights for the fair share identifiers for the fair share policy. Fair share identifiers that aren't included have a default weight of 1.0.

SubmitJobRequest

Contains the parameters for SubmitJob.

SubmitJobResponse
TagResourceRequest
TerminateJobRequest

Contains the parameters for TerminateJob.

Tmpfs

The container path, mount options, and size of the tmpfs mount.

Ulimit

The ulimit settings to pass to the container.

UntagResourceRequest
UpdateComputeEnvironmentRequest

Contains the parameters for UpdateComputeEnvironment.

UpdateComputeEnvironmentResponse
UpdateJobQueueRequest

Contains the parameters for UpdateJobQueue.

UpdateJobQueueResponse
UpdateSchedulingPolicyRequest
Volume

A data volume used in a job's container properties.

§Type Aliases

ArrayJobDependency
AssignPublicIp
CEState
CEStatus
CEType
CRAllocationStrategy
CRType
DeviceCgroupPermission
EFSAuthorizationConfigIAM
EFSTransitEncryption
JobDefinitionType
JobStatus
JQState
JQStatus
LogDriver
PlatformCapability
ResourceType
RetryAction