airflow.providers.amazon.aws.sensors.glacier

Module Contents

Classes

JobStatus

Glacier jobs description

GlacierJobOperationSensor

Glacier sensor for checking job state. This operator runs only in reschedule mode.
class airflow.providers.amazon.aws.sensors.glacier.JobStatus[source]

Bases: enum.Enum

Glacier jobs description

IN_PROGRESS = InProgress[source]
SUCCEEDED = Succeeded[source]
class airflow.providers.amazon.aws.sensors.glacier.GlacierJobOperationSensor(*, aws_conn_id: str = 'aws_default', vault_name: str, job_id: str, poke_interval: int = 60 * 20, mode: str = 'reschedule', **kwargs: Any)[source]

Bases: airflow.sensors.base.BaseSensorOperator

Glacier sensor for checking job state. This operator runs only in reschedule mode.

See also

For more information on how to use this operator, take a look at the guide: GlacierJobOperationSensor

Parameters

  • aws_conn_id (str) -- The reference to the AWS connection details

  • vault_name (str) -- name of Glacier vault on which job is executed

  • job_id (str) -- the job ID was returned by retrieve_inventory()

  • poke_interval (float) -- Time in seconds that the job should wait in between each tries

  • mode (str) -- How the sensor operates. Options are: { poke | reschedule }, default is poke. When set to poke the sensor is taking up a worker slot for its whole execution time and sleeps between pokes. Use this mode if the expected runtime of the sensor is short or if a short poke interval is required. Note that the sensor will hold onto a worker slot and a pool slot for the duration of the sensor's runtime in this mode. When set to reschedule the sensor task frees the worker slot when the criteria is not yet met and it's rescheduled at a later time. Use this mode if the time before the criteria is met is expected to be quite long. The poke interval should be more than one minute to prevent too much load on the scheduler.

template_fields :Sequence[str] = ['vault_name', 'job_id'][source]
poke(self, context: airflow.utils.context.Context) → bool[source]

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

Was this entry helpful?