airflow.providers.amazon.aws.sensors.s3

Module Contents

Classes

S3KeySensor

Waits for a key (a file-like instance on S3) to be present in a S3 bucket.

S3KeySizeSensor

Waits for a key (a file-like instance on S3) to be present and be more than

S3KeysUnchangedSensor

Checks for changes in the number of objects at prefix in AWS S3

S3PrefixSensor

Waits for a prefix or all prefixes to exist. A prefix is the first part of a key,
class airflow.providers.amazon.aws.sensors.s3.S3KeySensor(*, bucket_key: str, bucket_name: Optional[str] = None, wildcard_match: bool = False, aws_conn_id: str = 'aws_default', verify: Optional[Union[str, bool]] = None, **kwargs)[source]

Bases: airflow.sensors.base.BaseSensorOperator

Waits for a key (a file-like instance on S3) to be present in a S3 bucket. S3 being a key/value it does not support folders. The path is just a key a resource.

Parameters

  • bucket_key (str) -- The key being waited on. Supports full s3:// style url or relative path from root level. When it's specified as a full s3:// url, please leave bucket_name as None.

  • bucket_name (str) -- Name of the S3 bucket. Only needed when bucket_key is not provided as a full s3:// url.

  • wildcard_match (bool) -- whether the bucket_key should be interpreted as a Unix wildcard pattern

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

  • verify (bool or 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.

template_fields :Sequence[str] = ['bucket_key', 'bucket_name'][source]
poke(self, context: airflow.utils.context.Context)[source]

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

get_hook(self) → airflow.providers.amazon.aws.hooks.s3.S3Hook[source]

Create and return an S3Hook

class airflow.providers.amazon.aws.sensors.s3.S3KeySizeSensor(*, check_fn: Optional[Callable[Ellipsis, bool]] = None, **kwargs)[source]

Bases: S3KeySensor

Waits for a key (a file-like instance on S3) to be present and be more than some size in a S3 bucket. S3 being a key/value it does not support folders. The path is just a key a resource.

Parameters

  • bucket_key (str) -- The key being waited on. Supports full s3:// style url or relative path from root level. When it's specified as a full s3:// url, please leave bucket_name as None.

  • bucket_name (str) -- Name of the S3 bucket. Only needed when bucket_key is not provided as a full s3:// url.

  • wildcard_match (bool) -- whether the bucket_key should be interpreted as a Unix wildcard pattern

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

  • verify (bool or 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.

  • check_fn (Optional[Callable[..., bool]]) --

    Function that receives the list of the S3 objects, and returns the boolean: - True: a certain criteria is met - False: the criteria isn't met Example: Wait for any S3 object size more than 1 megabyte

    def check_fn(self, data: List) -> bool:
    return any(f.get('Size', 0) > 1048576 for f in data if isinstance(f, dict))

poke(self, context: airflow.utils.context.Context)[source]

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

get_files(self, s3_hook: airflow.providers.amazon.aws.hooks.s3.S3Hook, delimiter: Optional[str] = '/') → List[source]

Gets a list of files in the bucket

check_fn(self, data: List, object_min_size: Optional[Union[int, float]] = 0) → bool[source]

Default function for checking that S3 Objects have size more than 0

Parameters

  • data (list) -- List of the objects in S3 bucket.

  • object_min_size (int) -- Checks if the objects sizes are greater then this value.

class airflow.providers.amazon.aws.sensors.s3.S3KeysUnchangedSensor(*, 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.

Parameters

  • 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 :Sequence[str] = ['bucket_name', 'prefix'][source]
hook(self)[source]

Returns S3Hook.

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

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

Parameters

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

poke(self, context: airflow.utils.context.Context)[source]

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

class airflow.providers.amazon.aws.sensors.s3.S3PrefixSensor(*, bucket_name: str, prefix: Union[str, List[str]], delimiter: str = '/', aws_conn_id: str = 'aws_default', verify: Optional[Union[str, bool]] = None, **kwargs)[source]

Bases: airflow.sensors.base.BaseSensorOperator

Waits for a prefix or all prefixes to exist. A prefix is the first part of a key, thus enabling checking of constructs similar to glob airfl* or SQL LIKE 'airfl%'. There is the possibility to precise a delimiter to indicate the hierarchy or keys, meaning that the match will stop at that delimiter. Current code accepts sane delimiters, i.e. characters that are NOT special characters in the Python regex engine.

Parameters

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

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

  • delimiter (str) -- The delimiter intended to show hierarchy. Defaults to '/'.

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

  • verify (bool or 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.

template_fields :Sequence[str] = ['prefix', 'bucket_name'][source]
poke(self, context: airflow.utils.context.Context)[source]

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

get_hook(self) → airflow.providers.amazon.aws.hooks.s3.S3Hook[source]

Create and return an S3Hook

Was this entry helpful?