airflow.providers.amazon.aws.sensors.batch

Module Contents

Classes

BatchSensor

Asks for the state of the Batch Job execution until it reaches a failure state or success state.

BatchComputeEnvironmentSensor

Asks for the state of the Batch compute environment until it reaches a failure state or success state.

BatchJobQueueSensor

Asks for the state of the Batch job queue until it reaches a failure state or success state.
class airflow.providers.amazon.aws.sensors.batch.BatchSensor(*, job_id, aws_conn_id='aws_default', region_name=None, **kwargs)[source]

Bases: airflow.sensors.base.BaseSensorOperator

Asks for the state of the Batch Job execution until it reaches a failure state or success state. If the job fails, the task will fail.

See also

For more information on how to use this sensor, take a look at the guide: Wait on an AWS Batch job state

Parameters

  • job_id (str) – Batch job_id to check the state for

  • aws_conn_id (str) – aws connection to use, defaults to ‘aws_default’

  • region_name (str | None) – aws region name associated with the client

template_fields :Sequence[str] = ['job_id'][source]
template_ext :Sequence[str] = [][source]
ui_color = #66c3ff[source]
poke(context)[source]

Function that the sensors defined while deriving this class should override.

get_hook()[source]

Create and return a BatchClientHook

class airflow.providers.amazon.aws.sensors.batch.BatchComputeEnvironmentSensor(compute_environment, aws_conn_id='aws_default', region_name=None, **kwargs)[source]

Bases: airflow.sensors.base.BaseSensorOperator

Asks for the state of the Batch compute environment until it reaches a failure state or success state. If the environment fails, the task will fail.

See also

For more information on how to use this sensor, take a look at the guide: Wait on an AWS Batch compute environment status

Parameters

  • compute_environment (str) – Batch compute environment name

  • aws_conn_id (str) – aws connection to use, defaults to ‘aws_default’

  • region_name (str | None) – aws region name associated with the client

template_fields :Sequence[str] = ['compute_environment'][source]
template_ext :Sequence[str] = [][source]
ui_color = #66c3ff[source]
hook()[source]

Create and return a BatchClientHook

poke(context)[source]

Function that the sensors defined while deriving this class should override.

class airflow.providers.amazon.aws.sensors.batch.BatchJobQueueSensor(job_queue, treat_non_existing_as_deleted=False, aws_conn_id='aws_default', region_name=None, **kwargs)[source]

Bases: airflow.sensors.base.BaseSensorOperator

Asks for the state of the Batch job queue until it reaches a failure state or success state. If the queue fails, the task will fail.

See also

For more information on how to use this sensor, take a look at the guide: Wait on an AWS Batch job queue status

Parameters

  • job_queue (str) – Batch job queue name

  • treat_non_existing_as_deleted (bool) – If True, a non-existing Batch job queue is considered as a deleted queue and as such a valid case.

  • aws_conn_id (str) – aws connection to use, defaults to ‘aws_default’

  • region_name (str | None) – aws region name associated with the client

template_fields :Sequence[str] = ['job_queue'][source]
template_ext :Sequence[str] = [][source]
ui_color = #66c3ff[source]
hook()[source]

Create and return a BatchClientHook

poke(context)[source]

Function that the sensors defined while deriving this class should override.

Was this entry helpful?