Skip to content

BatchQueue

Bases: DuploTenantResourceV3

Manage AWS Batch Job Resources

Run batch jobs as a managed service on AWS infrastructure.

Read more docs here: https://docs.duplocloud.com/docs/overview/aws-services/batch

apply

Apply a BatchQueue

Create or Update a BatchQueue resource with Duplocloud cli.

CLI Usage

duploctl batchqueue apply -f 'batchqueue.yaml'
Contents of the batchqueue.yaml file
JobQueueName: duploctl
Priority: '1'
ComputeEnvironmentOrder:
- ComputeEnvironment: duploservices-duploctl-duploctl
  Order: 1

Parameters:

Name Type Description Default
body BODY

The resource to apply.

required
wait WAIT

Wait for the resource to be created.

False
patches PATCHES

The patches to apply to the resource.

None

Returns:

Name Type Description
message dict

Success message.

create

Create a Batch Job Queue.

Creates a new Batch Job Queue with the specified configuration.

Basic CLI Use
duploctl batch_queue create -f batch_queue.yaml

Parameters:

Name Type Description Default
body BODY

The configuration for the Batch Job Queue.

required

Returns:

Name Type Description
dict dict

The created Batch Job Queue object.

delete

Delete a BatchQueue resource by name.

cli usage
duploctl batchqueue delete <name>

Parameters:

Name Type Description Default
name NAME

The name of the BatchQueue resource to delete.

required

Returns:

Name Type Description
message dict

A success message.

Raises:

Type Description
DuploError

If the {{kind}} resource could not be found or deleted.

disable

Disable a Batch Compute Environment.

cli usage
duploctl batch_compute delete <name>

Parameters:

Name Type Description Default
name NAME

The name of the Batch Compute Environment to delete.

required

Returns:

Name Type Description
message dict

A success message.

Raises:

Type Description
DuploError

If the Batch Compute Environment could not be found or deleted.

find

Find a Single Batch Job Queue by name.

cli usage
duploctl batch_queue find <name>

Parameters:

Name Type Description Default
name NAME

The name of the Batch Job Queue to find.

required

Returns:

Name Type Description
resource dict

The Batch Job Queue object.

list

Retrieve a List of BatchQueue resources

cli usage
duploctl batchqueue list

Returns:

Name Type Description
list list

A list of BatchQueue.

update

Update a V3 resource by name.

Parameters:

Name Type Description Default
name NAME

The name of the resource to update.

None
body BODY

The resource to update.

None
patches PATCHES

The patches to apply to the resource.

None

Returns:

Name Type Description
message

Success message.

Raises:

Type Description
DuploError

If the resource could not be created.