crew_class_launcher_aws_batch {crew.aws.batch} | R Documentation |
AWS Batch launcher R6
class
See crew_launcher_aws_batch()
.
In order for the AWS Batch crew
plugin to function properly, your IAM
policy needs permission to perform the SubmitJob
and TerminateJob
AWS Batch API calls. For more information on AWS policies and permissions,
please visit
https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html.
The AWS Batch controller and launcher accept many arguments
which start with "aws_batch_"
. These arguments are AWS-Batch-specific
parameters forwarded directly to the submit_job()
method for
the Batch client in the paws.compute
R package
For a full description of each argument, including its meaning and format, please visit https://www.paws-r-sdk.com/docs/batch_submit_job/. The upstream API documentation is at https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html and the analogous CLI documentation is at https://docs.aws.amazon.com/cli/latest/reference/batch/submit-job.html.
The actual argument names may vary slightly, depending
on which : for example, the aws_batch_job_definition
argument of
the crew
AWS Batch launcher/controller corresponds to the
jobDefinition
argument of the web API and
paws.compute::batch()$submit_job()
, and both correspond to the
--job-definition
argument of the CLI.
Control verbosity with the paws.log_level
global option in R.
Set to 0 for minimum verbosity and 3 for maximum verbosity.
crew::crew_class_launcher
-> crew_class_launcher_aws_batch
aws_batch_config
aws_batch_credentials
aws_batch_endpoint
aws_batch_region
aws_batch_job_definition
aws_batch_job_queue
aws_batch_share_identifier
aws_batch_scheduling_priority_override
aws_batch_parameters
aws_batch_container_overrides
aws_batch_node_overrides
aws_batch_retry_strategy
aws_batch_propagate_tags
aws_batch_timeout
aws_batch_tags
aws_batch_eks_properties_override
crew::crew_class_launcher$active()
crew::crew_class_launcher$booting()
crew::crew_class_launcher$call()
crew::crew_class_launcher$done()
crew::crew_class_launcher$errors()
crew::crew_class_launcher$forward()
crew::crew_class_launcher$launch()
crew::crew_class_launcher$rotate()
crew::crew_class_launcher$scale()
crew::crew_class_launcher$set_name()
crew::crew_class_launcher$settings()
crew::crew_class_launcher$start()
crew::crew_class_launcher$summary()
crew::crew_class_launcher$tally()
crew::crew_class_launcher$terminate()
crew::crew_class_launcher$terminate_workers()
crew::crew_class_launcher$unlaunched()
crew::crew_class_launcher$wait()
new()
Abstract launcher constructor.
crew_class_launcher_aws_batch$new( name = NULL, seconds_interval = NULL, seconds_timeout = NULL, seconds_launch = NULL, seconds_idle = NULL, seconds_wall = NULL, tasks_max = NULL, tasks_timers = NULL, reset_globals = NULL, reset_packages = NULL, reset_options = NULL, garbage_collection = NULL, launch_max = NULL, tls = NULL, processes = NULL, aws_batch_config = NULL, aws_batch_credentials = NULL, aws_batch_endpoint = NULL, aws_batch_region = NULL, aws_batch_job_definition = NULL, aws_batch_job_queue = NULL, aws_batch_share_identifier = NULL, aws_batch_scheduling_priority_override = NULL, aws_batch_parameters = NULL, aws_batch_container_overrides = NULL, aws_batch_node_overrides = NULL, aws_batch_retry_strategy = NULL, aws_batch_propagate_tags = NULL, aws_batch_timeout = NULL, aws_batch_tags = NULL, aws_batch_eks_properties_override = NULL )
name
seconds_interval
seconds_timeout
seconds_launch
seconds_idle
seconds_wall
tasks_max
tasks_timers
reset_globals
reset_packages
reset_options
garbage_collection
launch_max
tls
processes
aws_batch_config
aws_batch_credentials
aws_batch_endpoint
aws_batch_region
aws_batch_job_definition
aws_batch_job_queue
aws_batch_share_identifier
aws_batch_scheduling_priority_override
aws_batch_parameters
aws_batch_container_overrides
aws_batch_node_overrides
aws_batch_retry_strategy
aws_batch_propagate_tags
aws_batch_timeout
aws_batch_tags
aws_batch_eks_properties_override
An abstract launcher object.
validate()
Validate the launcher.
crew_class_launcher_aws_batch$validate()
NULL
(invisibly). Throws an error if a field is invalid.
launch_worker()
Launch a local process worker which will dial into a socket.
crew_class_launcher_aws_batch$launch_worker( call, name, launcher, worker, instance )
call
Character of length 1, a namespaced call to
crew::crew_worker()
which will run in the worker and accept tasks.
name
Character of length 1, an informative worker name.
launcher
Character of length 1, name of the launcher.
worker
Positive integer of length 1, index of the worker. This worker index remains the same even when the current instance of the worker exits and a new instance launches. It is always between 1 and the maximum number of concurrent workers.
instance
Character of length 1 to uniquely identify the current instance of the worker.
The call
argument is R code that will run to
initiate the worker.
A handle object to allow the termination of the worker later on.
terminate_worker()
Terminate a local process worker.
crew_class_launcher_aws_batch$terminate_worker(handle)
handle
A process handle object previously
returned by launch_worker()
.
NULL
(invisibly).
Other plugin_aws_batch:
crew_controller_aws_batch()
,
crew_launcher_aws_batch()