crew_class_monitor_aws_batch: AWS Batch monitor class
In crew.aws.batch: A Crew Launcher Plugin for AWS Batch
crew_class_monitor_aws_batch R Documentation
AWS Batch monitor class
Description
AWS Batch monitor R6 class
Details
See crew_monitor_aws_batch().
IAM policies
In order for the AWS Batch crew monitor class to function
properly, your IAM policy needs permission to perform the SubmitJob,
TerminateJob, ListJobs, and DescribeJobs AWS Batch API calls.
In addition, to download CloudWatch logs with the log() method,
your IAM policy also needs permission to perform the GetLogEvents
CloudWatch logs API call.
For more information on AWS policies and permissions, please visit
https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html.
Active bindings
job_queueSee crew_monitor_aws_batch().
job_definitionSee crew_monitor_aws_batch().
log_groupSee crew_monitor_aws_batch().
configSee crew_monitor_aws_batch().
credentialsSee crew_monitor_aws_batch().
endpointSee crew_monitor_aws_batch().
regionSee crew_monitor_aws_batch().
Methods
Public methods
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Method new()
AWS Batch job definition constructor.
Usage
crew_class_monitor_aws_batch$new(
job_queue = NULL,
job_definition = NULL,
log_group = NULL,
config = NULL,
credentials = NULL,
endpoint = NULL,
region = NULL
)
Arguments
job_queueSee crew_monitor_aws_batch().
job_definitionSee crew_monitor_aws_batch().
log_groupSee crew_monitor_aws_batch().
configSee crew_monitor_aws_batch().
credentialsSee crew_monitor_aws_batch().
endpointSee crew_monitor_aws_batch().
regionSee crew_monitor_aws_batch().
Returns
AWS Batch job definition object.
Method validate()
Validate the object.
Usage
crew_class_monitor_aws_batch$validate()
Returns
NULL (invisibly). Throws an error if a field is invalid.
Method terminate()
Terminate one or more AWS Batch jobs.
Usage
crew_class_monitor_aws_batch$terminate(
ids = NULL,
all = FALSE,
reason = "cancelled/terminated by crew.aws.batch monitor",
verbose = TRUE
)
Arguments
idsCharacter vector with the IDs of the AWS Batch jobs
to terminate. Leave as NULL if all is TRUE.
allTRUE to terminate all jobs belonging to
the previously specified job definition. FALSE to terminate
only the job IDs given in the ids argument.
reasonCharacter of length 1, natural language explaining
the reason the job was terminated.
verboseLogical of length 1, whether to show a progress bar
if the R process is interactive and length(ids) is greater than 1.
Returns
NULL (invisibly).
Method status()
Get the status of a single job
Usage
crew_class_monitor_aws_batch$status(id)
Arguments
idCharacter of length 1, job ID. This is different
from the user-supplied job name.
Returns
A one-row tibble with information about the job.
Method log()
Get the CloudWatch log of a job.
Usage
crew_class_monitor_aws_batch$log(id, path = stdout(), start_from_head = FALSE)
Arguments
idCharacter of length 1, job ID. This is different
from the user-supplied job name.
pathCharacter string or stream (e.g. stdout()),
file path or connection passed to the con argument of
writeLines() to print the log messages.
Set to nullfile() to suppress output
(and use the invisibly returned tibble object instead).
start_from_headLogical of length 1, whether to print earlier
log events before later ones.
Details
This method assumes the job has log driver "awslogs"
(specifying AWS CloudWatch) and that the log group is the one
prespecified in the log_group argument of
crew_monitor_aws_batch(). This method cannot use
other log drivers such as Splunk, and it will fail if the log
group is wrong or missing.
Returns
log() invisibly returns a tibble with log information
and writes the messages to the stream or path given by the
path argument.
Method jobs()
List all the jobs in the given job queue
with the given job definition.
Usage
crew_class_monitor_aws_batch$jobs(
status = c("submitted", "pending", "runnable", "starting", "running", "succeeded",
"failed")
)
Arguments
statusCharacter vector of job states. Results are limited
to these job states.
Details
The output only includes jobs under the
job queue and job definition
that were supplied through crew_monitor_aws_batch().
Returns
A tibble with one row per job and columns
with job information.
Method active()
List active jobs: submitted, pending,
runnable, starting, or running (not succeeded or failed).
Usage
crew_class_monitor_aws_batch$active()
Details
The output only includes jobs under the
job queue and job definition
that were supplied through crew_monitor_aws_batch().
Returns
A tibble with one row per job and columns
with job information.
Method inactive()
List inactive jobs: ones whose status
is succeeded or failed (not submitted, pending,
runnable, starting, or running).
Usage
crew_class_monitor_aws_batch$inactive()
Details
The output only includes jobs under the
job queue and job definition
that were supplied through crew_monitor_aws_batch().
Returns
A tibble with one row per job and columns
with job information.
Method submitted()
List jobs whose status is "submitted".
Usage
crew_class_monitor_aws_batch$submitted()
Details
The output only includes jobs under the
job queue and job definition
that were supplied through crew_monitor_aws_batch().
Returns
A tibble with one row per job and columns
with job information.
Method pending()
List jobs whose status is "pending".
Usage
crew_class_monitor_aws_batch$pending()
Details
The output only includes jobs under the
job queue and job definition
that were supplied through crew_monitor_aws_batch().
Returns
A tibble with one row per job and columns
with job information.
Method runnable()
List jobs whose status is "runnable".
Usage
crew_class_monitor_aws_batch$runnable()
Details
The output only includes jobs under the
job queue and job definition
that were supplied through crew_monitor_aws_batch().
Returns
A tibble with one row per job and columns
with job information.
Method starting()
List jobs whose status is "starting".
Usage
crew_class_monitor_aws_batch$starting()
Details
The output only includes jobs under the
job queue and job definition
that were supplied through crew_monitor_aws_batch().
Returns
A tibble with one row per job and columns
with job information.
Method running()
List jobs whose status is "running".
Usage
crew_class_monitor_aws_batch$running()
Details
The output only includes jobs under the
job queue and job definition
that were supplied through crew_monitor_aws_batch().
Returns
A tibble with one row per job and columns
with job information.
Method succeeded()
List jobs whose status is "succeeded".
Usage
crew_class_monitor_aws_batch$succeeded()
Details
The output only includes jobs under the
job queue and job definition
that were supplied through crew_monitor_aws_batch().
Returns
A tibble with one row per job and columns
with job information.
Method failed()
List jobs whose status is "failed".
Usage
crew_class_monitor_aws_batch$failed()
Details
The output only includes jobs under the
job queue and job definition
that were supplied through crew_monitor_aws_batch().
Returns
A tibble with one row per job and columns
with job information.
See Also
Other monitor:
crew_monitor_aws_batch()
crew.aws.batch documentation built on June 9, 2025, 5:09 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| crew_class_monitor_aws_batch | R Documentation |
AWS Batch monitor class
Description
AWS Batch monitor R6 class
Details
See crew_monitor_aws_batch().
IAM policies
In order for the AWS Batch crew monitor class to function
properly, your IAM policy needs permission to perform the SubmitJob,
TerminateJob, ListJobs, and DescribeJobs AWS Batch API calls.
In addition, to download CloudWatch logs with the log() method,
your IAM policy also needs permission to perform the GetLogEvents
CloudWatch logs API call.
For more information on AWS policies and permissions, please visit
https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html.
Active bindings
job_queueSee
crew_monitor_aws_batch().job_definitionSee
crew_monitor_aws_batch().log_groupSee
crew_monitor_aws_batch().configSee
crew_monitor_aws_batch().credentialsSee
crew_monitor_aws_batch().endpointSee
crew_monitor_aws_batch().regionSee
crew_monitor_aws_batch().
Methods
Public methods
Method new()
AWS Batch job definition constructor.
Usage
crew_class_monitor_aws_batch$new( job_queue = NULL, job_definition = NULL, log_group = NULL, config = NULL, credentials = NULL, endpoint = NULL, region = NULL )
Arguments
job_queueSee
crew_monitor_aws_batch().job_definitionSee
crew_monitor_aws_batch().log_groupSee
crew_monitor_aws_batch().configSee
crew_monitor_aws_batch().credentialsSee
crew_monitor_aws_batch().endpointSee
crew_monitor_aws_batch().regionSee
crew_monitor_aws_batch().
Returns
AWS Batch job definition object.
Method validate()
Validate the object.
Usage
crew_class_monitor_aws_batch$validate()
Returns
NULL (invisibly). Throws an error if a field is invalid.
Method terminate()
Terminate one or more AWS Batch jobs.
Usage
crew_class_monitor_aws_batch$terminate( ids = NULL, all = FALSE, reason = "cancelled/terminated by crew.aws.batch monitor", verbose = TRUE )
Arguments
idsCharacter vector with the IDs of the AWS Batch jobs to terminate. Leave as
NULLifallisTRUE.allTRUEto terminate all jobs belonging to the previously specified job definition.FALSEto terminate only the job IDs given in theidsargument.reasonCharacter of length 1, natural language explaining the reason the job was terminated.
verboseLogical of length 1, whether to show a progress bar if the R process is interactive and
length(ids)is greater than 1.
Returns
NULL (invisibly).
Method status()
Get the status of a single job
Usage
crew_class_monitor_aws_batch$status(id)
Arguments
idCharacter of length 1, job ID. This is different from the user-supplied job name.
Returns
A one-row tibble with information about the job.
Method log()
Get the CloudWatch log of a job.
Usage
crew_class_monitor_aws_batch$log(id, path = stdout(), start_from_head = FALSE)
Arguments
idCharacter of length 1, job ID. This is different from the user-supplied job name.
pathCharacter string or stream (e.g.
stdout()), file path or connection passed to theconargument ofwriteLines()to print the log messages. Set tonullfile()to suppress output (and use the invisibly returnedtibbleobject instead).start_from_headLogical of length 1, whether to print earlier log events before later ones.
Details
This method assumes the job has log driver "awslogs"
(specifying AWS CloudWatch) and that the log group is the one
prespecified in the log_group argument of
crew_monitor_aws_batch(). This method cannot use
other log drivers such as Splunk, and it will fail if the log
group is wrong or missing.
Returns
log() invisibly returns a tibble with log information
and writes the messages to the stream or path given by the
path argument.
Method jobs()
List all the jobs in the given job queue with the given job definition.
Usage
crew_class_monitor_aws_batch$jobs(
status = c("submitted", "pending", "runnable", "starting", "running", "succeeded",
"failed")
)Arguments
statusCharacter vector of job states. Results are limited to these job states.
Details
The output only includes jobs under the
job queue and job definition
that were supplied through crew_monitor_aws_batch().
Returns
A tibble with one row per job and columns
with job information.
Method active()
List active jobs: submitted, pending, runnable, starting, or running (not succeeded or failed).
Usage
crew_class_monitor_aws_batch$active()
Details
The output only includes jobs under the
job queue and job definition
that were supplied through crew_monitor_aws_batch().
Returns
A tibble with one row per job and columns
with job information.
Method inactive()
List inactive jobs: ones whose status is succeeded or failed (not submitted, pending, runnable, starting, or running).
Usage
crew_class_monitor_aws_batch$inactive()
Details
The output only includes jobs under the
job queue and job definition
that were supplied through crew_monitor_aws_batch().
Returns
A tibble with one row per job and columns
with job information.
Method submitted()
List jobs whose status is "submitted".
Usage
crew_class_monitor_aws_batch$submitted()
Details
The output only includes jobs under the
job queue and job definition
that were supplied through crew_monitor_aws_batch().
Returns
A tibble with one row per job and columns
with job information.
Method pending()
List jobs whose status is "pending".
Usage
crew_class_monitor_aws_batch$pending()
Details
The output only includes jobs under the
job queue and job definition
that were supplied through crew_monitor_aws_batch().
Returns
A tibble with one row per job and columns
with job information.
Method runnable()
List jobs whose status is "runnable".
Usage
crew_class_monitor_aws_batch$runnable()
Details
The output only includes jobs under the
job queue and job definition
that were supplied through crew_monitor_aws_batch().
Returns
A tibble with one row per job and columns
with job information.
Method starting()
List jobs whose status is "starting".
Usage
crew_class_monitor_aws_batch$starting()
Details
The output only includes jobs under the
job queue and job definition
that were supplied through crew_monitor_aws_batch().
Returns
A tibble with one row per job and columns
with job information.
Method running()
List jobs whose status is "running".
Usage
crew_class_monitor_aws_batch$running()
Details
The output only includes jobs under the
job queue and job definition
that were supplied through crew_monitor_aws_batch().
Returns
A tibble with one row per job and columns
with job information.
Method succeeded()
List jobs whose status is "succeeded".
Usage
crew_class_monitor_aws_batch$succeeded()
Details
The output only includes jobs under the
job queue and job definition
that were supplied through crew_monitor_aws_batch().
Returns
A tibble with one row per job and columns
with job information.
Method failed()
List jobs whose status is "failed".
Usage
crew_class_monitor_aws_batch$failed()
Details
The output only includes jobs under the
job queue and job definition
that were supplied through crew_monitor_aws_batch().
Returns
A tibble with one row per job and columns
with job information.
See Also
Other monitor:
crew_monitor_aws_batch()
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.