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.4/services/batch.ts?docs=full";

§Classes

Batch

§Interfaces

ArrayProperties

An object that represents an Batch array job.

ArrayPropertiesDetail

An object that represents the array properties of a job.

ArrayPropertiesSummary

An object that represents the array properties of a job.

AttemptContainerDetail

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

AttemptDetail

An object that represents a job attempt.

CancelJobRequest

Contains the parameters for CancelJob.

ComputeEnvironmentDetail

An object that represents an Batch compute environment.

ComputeEnvironmentOrder

The order that compute environments are tried in 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 that represents an Batch compute resource. For more information, see Compute environments in the Batch User Guide.

ComputeResourceUpdate

An object that represents the attributes of a compute environment that can be updated. For more information, see Updating compute environments in the Batch User Guide.

ContainerDetail

An object that represents 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 for Amazon ECS based job definitions. These properties to describe the container that's launched as part of a job.

ContainerSummary

An object that represents summary details of a container within a job.

CreateComputeEnvironmentRequest

Contains the parameters for CreateComputeEnvironment.

CreateComputeEnvironmentResponse
CreateJobQueueRequest

Contains the parameters for CreateJobQueue.

CreateJobQueueResponse
CreateSchedulingPolicyRequest

Contains the parameters for CreateSchedulingPolicy.

CreateSchedulingPolicyResponse
DeleteComputeEnvironmentRequest

Contains the parameters for DeleteComputeEnvironment.

DeleteJobQueueRequest

Contains the parameters for DeleteJobQueue.

DeleteSchedulingPolicyRequest

Contains the parameters for DeleteSchedulingPolicy.

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

Contains the parameters for DescribeSchedulingPolicies.

DescribeSchedulingPoliciesResponse
Device

An object that represents 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.

EksAttemptContainerDetail

An object that represents the details for an attempt for a job attempt that an Amazon EKS container runs.

EksAttemptDetail

An object that represents the details of a job attempt for a job attempt by an Amazon EKS container.

EksConfiguration

Configuration for the Amazon EKS cluster that supports the Batch compute environment. The cluster must exist before the compute environment can be created.

EksContainer

EKS container properties are used in job definitions for Amazon EKS based job definitions to describe the properties for a container node in the pod that's launched as part of a job. This can't be specified for Amazon ECS based job definitions.

EksContainerDetail

The details for container properties that are returned by DescribeJobs for jobs that use Amazon EKS.

EksContainerEnvironmentVariable

An environment variable.

EksContainerOverride

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

EksContainerResourceRequirements

The type and amount of resources to assign to a container. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

EksContainerSecurityContext

The security context for a job. For more information, see Configure a security context for a pod or container in the Kubernetes documentation.

EksContainerVolumeMount

The volume mounts for a container for an Amazon EKS job. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.

EksEmptyDir

Specifies the configuration of a Kubernetes emptyDir volume. An emptyDir volume is first created when a pod is assigned to a node. It exists as long as that pod is running on that node. The emptyDir volume is initially empty. All containers in the pod can read and write the files in the emptyDir volume. However, the emptyDir volume can be mounted at the same or different paths in each container. When a pod is removed from a node for any reason, the data in the emptyDir is deleted permanently. For more information, see emptyDir in the Kubernetes documentation.

EksHostPath

Specifies the configuration of a Kubernetes hostPath volume. A hostPath volume mounts an existing file or directory from the host node's filesystem into your pod. For more information, see hostPath in the Kubernetes documentation.

EksPodProperties

The properties for the pod.

EksPodPropertiesDetail

The details for the pod.

EksPodPropertiesOverride

An object that contains overrides for the Kubernetes pod properties of a job.

EksProperties

An object that contains the properties for the Kubernetes resources of a job.

EksPropertiesDetail

An object that contains the details for the Kubernetes resources of a job.

EksPropertiesOverride

An object that contains overrides for the Kubernetes resources of a job.

EksSecret

Specifies the configuration of a Kubernetes secret volume. For more information, see secret in the Kubernetes documentation.

EksVolume

Specifies an Amazon EKS volume for a job definition.

EvaluateOnExit

Specifies an array of up to 5 conditions to be met, and an action to take (RETRY or EXIT) if all conditions are met. If none of the EvaluateOnExit conditions in a RetryStrategy match, then the job is retried.

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's stored. If this parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.

JobDefinition

An object that represents an Batch job definition.

JobDependency

An object that represents an Batch job dependency.

JobDetail

An object that represents an Batch job.

JobQueueDetail

An object that represents the details for an Batch job queue.

JobSummary

An object that represents summary details of a job.

JobTimeout

An object that represents 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 that represents a launch template that's 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

Contains the parameters for ListSchedulingPolicies.

ListSchedulingPoliciesResponse
ListTagsForResourceRequest

Contains the parameters for ListTagsForResource.

ListTagsForResourceResponse
LogConfiguration

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

MountPoint

Details for 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 that represents the elastic network interface for a multi-node parallel job node.

NodeDetails

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

NodeOverrides

An object that represents any node overrides to a job definition that's used in a "SubmitJob" API operation.

NodeProperties

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

NodePropertiesSummary

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

NodePropertyOverride

The object that represents any node overrides to a job definition that's used in a "SubmitJob" API operation.

NodeRangeProperty

An object that represents 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 that's 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 that represents 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

Contains the parameters for TagResource.

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

Contains the parameters for UntagResource.

UpdateComputeEnvironmentRequest

Contains the parameters for UpdateComputeEnvironment.

UpdateComputeEnvironmentResponse
UpdateJobQueueRequest

Contains the parameters for UpdateJobQueue.

UpdateJobQueueResponse
UpdatePolicy

Specifies the infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.

UpdateSchedulingPolicyRequest

Contains the parameters for UpdateSchedulingPolicy.

Volume

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

§Type Aliases

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