Module Contents

class*, bucket_name: str, prefix: str, aws_conn_id: str = 'aws_default', verify: Optional[Union[bool, str]] = None, inactivity_period: float = 60 * 60, min_objects: int = 1, previous_objects: Optional[Set[str]] = None, allow_delete: bool = True, **kwargs)[source]

Bases: airflow.sensors.base.BaseSensorOperator

Checks for changes in the number of objects at prefix in AWS S3 bucket and returns True if the inactivity period has passed with no increase in the number of objects. Note, this sensor will not behave correctly in reschedule mode, as the state of the listed objects in the S3 bucket will be lost between rescheduled invocations.

  • bucket_name (str) -- Name of the S3 bucket

  • prefix (str) -- The prefix being waited on. Relative path from bucket root level.

  • aws_conn_id (str) -- a reference to the s3 connection

  • verify (Optional[Union[bool, str]]) --

    Whether or not to verify SSL certificates for S3 connection. By default SSL certificates are verified. You can provide the following values:

    • False: do not validate SSL certificates. SSL will still be used

      (unless use_ssl is False), but SSL certificates will not be verified.

    • path/to/cert/bundle.pem: A filename of the CA cert bundle to uses.

      You can specify this argument if you want to use a different CA cert bundle than the one used by botocore.

  • inactivity_period (float) -- The total seconds of inactivity to designate keys unchanged. Note, this mechanism is not real time and this operator may not return until a poke_interval after this period has passed with no additional objects sensed.

  • min_objects (int) -- The minimum number of objects needed for keys unchanged sensor to be considered valid.

  • previous_objects (Optional[Set[str]]) -- The set of object ids found during the last poke.

  • allow_delete (bool) -- Should this sensor consider objects being deleted between pokes valid behavior. If true a warning message will be logged when this happens. If false an error will be raised.

template_fields = ['bucket_name', 'prefix'][source]

Returns S3Hook.

is_keys_unchanged(self, current_objects: Set[str])[source]

Checks whether new objects have been uploaded and the inactivity_period has passed and updates the state of the sensor accordingly.


current_objects (set[str]) -- set of object ids in bucket during last poke.

poke(self, context)[source]

Was this entry helpful?