Aws/batch

@swamp/aws/batchv2026.08.01.1· 1d agoMODELS

01README

AWS BATCH infrastructure models

02Models7

@swamp/aws/batch/compute-environmentv2026.06.15.1compute_environment.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
ComputeEnvironmentName?	string	no
ComputeResources?	object	no
ReplaceComputeEnvironment?	boolean	no
ServiceRole?	string	no
State?	string	no
Tags?	record	no	A key-value pair to associate with a resource.
Type	string	yes
UpdatePolicy?	object	no
UnmanagedvCpus?	number	no
EksConfiguration?	object	no
Context?	string	no

fn create()

Create a Batch ComputeEnvironment

fn get(identifier: string)

Get a Batch ComputeEnvironment

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Batch ComputeEnvironment

fn update()

Update a Batch ComputeEnvironment

fn delete(identifier: string)

Delete a Batch ComputeEnvironment

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Batch ComputeEnvironment

fn sync()

Sync Batch ComputeEnvironment state from AWS

Resources

state(infinite)— Batch ComputeEnvironment resource state

@swamp/aws/batch/consumable-resourcev2026.06.15.1consumable_resource.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
ConsumableResourceName?	string	no	Name of ConsumableResource.
TotalQuantity	number	yes	Total Quantity of ConsumableResource.
ResourceType	enum	yes	Type of Consumable Resource.
Tags?	record	no	A key-value pair to associate with a resource.

fn create()

Create a Batch ConsumableResource

fn get(identifier: string)

Get a Batch ConsumableResource

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Batch ConsumableResource

fn update()

Update a Batch ConsumableResource

fn delete(identifier: string)

Delete a Batch ConsumableResource

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Batch ConsumableResource

fn sync()

Sync Batch ConsumableResource state from AWS

Resources

state(infinite)— Batch ConsumableResource resource state

@swamp/aws/batch/job-definitionv2026.06.15.1job_definition.ts

Global Arguments

Argument	Type	Required	Description
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
ContainerProperties?	object	no
EcsProperties?	object	no
NodeProperties?	object	no
JobDefinitionName?	string	no
SchedulingPriority?	number	no
Parameters?	record	no
PlatformCapabilities?	array	no
PropagateTags?	boolean	no
RetryStrategy?	object	no
ResourceRetentionPolicy?	object	no
Timeout?	object	no
Type	string	yes
Tags?	record	no	A key-value pair to associate with a resource.
EksProperties?	object	no
ConsumableResourceProperties?	object	no

fn create()

Create a Batch JobDefinition

fn get(identifier: string)

Get a Batch JobDefinition

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Batch JobDefinition

fn update()

Update a Batch JobDefinition

fn delete(identifier: string)

Delete a Batch JobDefinition

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Batch JobDefinition

fn sync()

Sync Batch JobDefinition state from AWS

Resources

state(infinite)— Batch JobDefinition resource state

@swamp/aws/batch/job-queuev2026.06.15.1job_queue.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
JobQueueName?	string	no
JobQueueType?	string	no
ComputeEnvironmentOrder?	array	no
ServiceEnvironmentOrder?	array	no
JobStateTimeLimitActions?	array	no
Priority	number	yes
State?	enum	no
SchedulingPolicyArn?	string	no
Tags?	record	no	A key-value pair to associate with a resource.

fn create()

Create a Batch JobQueue

fn get(identifier: string)

Get a Batch JobQueue

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Batch JobQueue

fn update()

Update a Batch JobQueue

fn delete(identifier: string)

Delete a Batch JobQueue

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Batch JobQueue

fn sync()

Sync Batch JobQueue state from AWS

Resources

state(infinite)— Batch JobQueue resource state

@swamp/aws/batch/quota-sharev2026.06.15.1quota_share.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
QuotaShareName	string	yes	The name of the quota share. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
JobQueue	string	yes	The AWS Batch job queue associated with the quota share. This can be the job queue name or ARN. A job queue must be in the `VALID` state before you can associate it with a quota share.
CapacityLimits	array	yes	A list that specifies the quantity and type of compute capacity allocated to the quota share.
ResourceSharingConfiguration	object	yes	Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.
PreemptionConfiguration	object	yes	Specifies the preemption behavior for jobs in a quota share.
State?	enum	no	The state of the quota share. If the quota share is `ENABLED`, it is able to accept jobs. If the quota share is `DISABLED`, new jobs won't be accepted but jobs already submitted can finish. The default state is `ENABLED`.
Tags?	record	no	The tags that you apply to the quota share to help you categorize and organize your resources. Each tag consists of a key and an optional value.

fn create()

Create a Batch QuotaShare

fn get(identifier: string)

Get a Batch QuotaShare

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Batch QuotaShare

fn update()

Update a Batch QuotaShare

fn delete(identifier: string)

Delete a Batch QuotaShare

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Batch QuotaShare

fn sync()

Sync Batch QuotaShare state from AWS

Resources

state(infinite)— Batch QuotaShare resource state

@swamp/aws/batch/scheduling-policyv2026.06.15.1scheduling_policy.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Name?	string	no	Name of Scheduling Policy.
FairsharePolicy?	object	no	Fair Share Policy for the Job Queue.
QuotaSharePolicy?	object	no	Quota Share Policy for the Job Queue.
Tags?	record	no	A key-value pair to associate with a resource.

fn create()

Create a Batch SchedulingPolicy

fn get(identifier: string)

Get a Batch SchedulingPolicy

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Batch SchedulingPolicy

fn update()

Update a Batch SchedulingPolicy

fn delete(identifier: string)

Delete a Batch SchedulingPolicy

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Batch SchedulingPolicy

fn sync()

Sync Batch SchedulingPolicy state from AWS

Resources

state(infinite)— Batch SchedulingPolicy resource state

@swamp/aws/batch/service-environmentv2026.06.15.1service_environment.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
ServiceEnvironmentName?	string	no
State?	string	no
ServiceEnvironmentType	string	yes
CapacityLimits	array	yes
Tags?	record	no	A key-value pair to associate with a resource.

fn create()

Create a Batch ServiceEnvironment

fn get(identifier: string)

Get a Batch ServiceEnvironment

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Batch ServiceEnvironment

fn update()

Update a Batch ServiceEnvironment

fn delete(identifier: string)

Delete a Batch ServiceEnvironment

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the Batch ServiceEnvironment

fn sync()

Sync Batch ServiceEnvironment state from AWS

Resources

state(infinite)— Batch ServiceEnvironment resource state

03Previous Versions19

2026.07.31.1Jul 31, 2026

2026.07.30.1Jul 30, 2026

2026.07.29.1Jul 29, 2026

2026.07.28.1Jul 28, 2026

2026.07.27.1Jul 27, 2026

2026.07.26.1Jul 26, 2026

2026.07.25.1Jul 25, 2026

2026.07.24.1Jul 24, 2026

2026.07.20.1Jul 20, 2026

2026.07.18.3Jul 18, 2026

2026.07.18.2Jul 18, 2026

Added 7, removed 1 models

2026.06.15.1Jun 15, 2026

Updated: compute_environment, consumable_resource, job_definition, job_queue, quota_share, scheduling_policy, service_environment

2026.06.08.2Jun 8, 2026

Updated: compute_environment, consumable_resource, job_definition, job_queue, quota_share, scheduling_policy, service_environment

2026.06.06.1Jun 6, 2026

Updated: compute_environment, consumable_resource, job_definition, job_queue, quota_share, scheduling_policy, service_environment

2026.05.19.1May 19, 2026

Updated: consumable_resource, job_queue, scheduling_policy

2026.05.18.1May 18, 2026

2026.05.01.1May 1, 2026

Updated: job_definition

2026.04.23.3Apr 23, 2026

2026.04.23.2Apr 23, 2026

Updated: compute_environment, consumable_resource, job_definition, job_queue, quota_share, scheduling_policy, service_environment

04Stats

100 / 100

Downloads

Archive size

1.6 MB

Verified by Swamp

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types (deprecated)1/1earned
Dependencies pass trust audit2/2earned
Has description1/1earned
Platform support declared (or universal)2/2earned
License declared1/1earned
Verified public repository2/2earned

Repository

https://github.com/swamp-club/swamp-extensions

05Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

06Labels

#aws #batch #cloud #infrastructure