Airflow Summit 2026 is coming August 31 - September 2 in Austin, TX. Register now to secure your spot!

airflow.providers.amazon.aws.sensors.dynamodb

Classes

DynamoDBValueSensor

Waits for an attribute value to be present for an item in a DynamoDB table.

Module Contents

class airflow.providers.amazon.aws.sensors.dynamodb.DynamoDBValueSensor(table_name, partition_key_name, partition_key_value, attribute_name, attribute_value, sort_key_name=None, sort_key_value=None, deferrable=conf.getboolean('operators', 'default_deferrable', fallback=False), **kwargs)[source]

Bases: airflow.providers.amazon.aws.sensors.base_aws.AwsBaseSensor[airflow.providers.amazon.aws.hooks.dynamodb.DynamoDBHook]

Waits for an attribute value to be present for an item in a DynamoDB table.

See also

For more information on how to use this sensor, take a look at the guide: Wait on Amazon DynamoDB item attribute value match

Parameters:
  • table_name (str) – DynamoDB table name

  • partition_key_name (str) – DynamoDB partition key name

  • partition_key_value (str) – DynamoDB partition key value

  • attribute_name (str) – DynamoDB attribute name

  • attribute_value (str | collections.abc.Iterable[str]) – DynamoDB attribute value

  • sort_key_name (str | None) – (optional) DynamoDB sort key name

  • sort_key_value (str | None) – (optional) DynamoDB sort key value

  • deferrable (bool) – If True, the sensor will operate in deferrable mode. This mode requires aiobotocore module to be installed. (default: False, but can be overridden in config file by setting default_deferrable to True)

  • aws_conn_id – The Airflow connection used for AWS credentials. If this is None or empty then the default boto3 behaviour is used. If running Airflow in a distributed manner and aws_conn_id is None or empty, then default boto3 configuration would be used (and must be maintained on each worker node).

  • region_name – AWS region_name. If not specified then the default boto3 behaviour is used.

  • verify – Whether or not to verify SSL certificates. See: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html

  • botocore_config – Configuration dictionary (key-values) for botocore client. See: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html

aws_hook_class[source]
template_fields: collections.abc.Sequence[str][source]
table_name[source]
partition_key_name[source]
partition_key_value[source]
attribute_name[source]
attribute_value[source]
sort_key_name = None[source]
sort_key_value = None[source]
deferrable[source]
execute(context)[source]

Derive when creating an operator.

The main method to execute the task. Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

execute_complete(context, event=None)[source]
poke(context)[source]

Test DynamoDB item for matching attribute value.

Was this entry helpful?