Skip to content

BatchJob

Bases: DuploResourceV3

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

Commands

apply

Apply a BatchJob

Create or Update a BatchJob resource with Duplocloud cli.

CLI Usage 

duploctl batchjob apply -f 'batchjob.yaml'
Contents of the batchjob.yaml file 
shareIdentifier: SomeIdentifier
schedulingPriorityOverride: 3
JobName: duploctl-big
JobDefinition: duploctl
JobQueue: mublet
ContainerOverrides:
  Command:
  - echo
  - hiii
  Environment:
  - name: KEY1
    value: '123'

Returns:

Name Type Description
message dict

Success message.

Parameters:

--file, -f, --cli-input
A file to read the input from
FileType('r') action: YamlAction
--patches, --add, --remove, --copy, --replace, --test, --move
The json patch to apply
str action: JsonPatchAction

create

Create a Batch Job resource.

CLI Usage 

duploctl batch_job create -f 'batchjob.yaml'
Contents of the batchjob.yaml file 
shareIdentifier: SomeIdentifier
schedulingPriorityOverride: 3
JobName: duploctl-big
JobDefinition: duploctl
JobQueue: mublet
ContainerOverrides:
  Command:
  - echo
  - hiii
  Environment:
  - name: KEY1
    value: '123'

One liner example 
echo """
shareIdentifier: SomeIdentifier
schedulingPriorityOverride: 3
JobName: duploctl-big
JobDefinition: duploctl
JobQueue: mublet
ContainerOverrides:
  Command:
  - echo
  - hiii
  Environment:
  - name: KEY1
    value: '123'
""" | duploctl batch_job create -f -

Returns:

Name Type Description
message dict

Success message.

Raises:

Type Description
DuploError

If the resource could not be created.

Parameters:

--file, -f, --cli-input
A file to read the input from
FileType('r') action: YamlAction

delete

Delete a BatchJob resource by name.

cli usage 
duploctl batchjob delete <name>

Returns:

Name Type Description
message dict

A success message.

Raises:

Type Description
DuploError

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

Parameters:

name positional
The resource name
str

find

Find a Single Batch Job by name.

cli usage 
duploctl batch_definition find <name> <queue_name>

Returns:

Name Type Description
resource dict

The Batch Job Definition object.

Parameters:

name positional
The resource name
str
--queue, -BQ, -bq, --batch-queue
The name of a Batch Queue
str env: $DUPLO_BATCH_QUEUE

list

List all Batch Job Definitions.

Usage 
duploctl batch_job list <queue_name>

Returns:

Name Type Description
list list

A list of Batch Job Definitions.

Parameters:

--queue, -BQ, -bq, --batch-queue
The name of a Batch Queue
str env: $DUPLO_BATCH_QUEUE
--all, --all
Boolean flag to select all. Defaults to False.
bool

update

Update a V3 resource by name.

Returns:

Name Type Description
message

Success message.

Raises:

Type Description
DuploError

If the resource could not be created.

Parameters:

name positional
The resource name
str
--file, -f, --cli-input
A file to read the input from
FileType('r') action: YamlAction
--patches, --add, --remove, --copy, --replace, --test, --move
The json patch to apply
str action: JsonPatchAction

Methods

name_from_body