• Home
• airflow.providers.amazon
• airflow.providers.amazon.aws
• airflow.providers.amazon.aws.operators
• airflow.providers.amazon.aws.operators.appflow

airflow.providers.amazon.aws.operators.appflow

Module Contents

Classes

AppflowBaseOperator	Amazon Appflow Base Operator class (not supposed to be used directly in DAGs).
AppflowRunOperator	Execute a Appflow run with filters as is.
AppflowRunFullOperator	Execute a Appflow full run removing any filter.
AppflowRunBeforeOperator	Execute a Appflow run after updating the filters to select only previous data.
AppflowRunAfterOperator	Execute a Appflow run after updating the filters to select only future data.
AppflowRunDailyOperator	Execute a Appflow run after updating the filters to select only a single day.
AppflowRecordsShortCircuitOperator	Short-circuit in case of a empty Appflow's run.

Attributes

SUPPORTED_SOURCES
MANDATORY_FILTER_DATE_MSG
NOT_SUPPORTED_SOURCE_MSG

airflow.providers.amazon.aws.operators.appflow.SUPPORTED_SOURCES

airflow.providers.amazon.aws.operators.appflow.MANDATORY_FILTER_DATE_MSG = 'The filter_date argument is mandatory for {entity}!'

airflow.providers.amazon.aws.operators.appflow.NOT_SUPPORTED_SOURCE_MSG = 'Source {source} is not supported for {entity}!'

class airflow.providers.amazon.aws.operators.appflow.AppflowBaseOperator(source, flow_name, flow_update, source_field=None, filter_date=None, poll_interval=20, aws_conn_id='aws_default', region=None, wait_for_completion=True, **kwargs)

Bases: airflow.models.BaseOperator

Amazon Appflow Base Operator class (not supposed to be used directly in DAGs).

Parameters

• source (str) – The source name (Supported: salesforce, zendesk)

• flow_name (str) – The flow name

• flow_update (bool) – A boolean to enable/disable a flow update before the run

• source_field (str | None) – The field name to apply filters

• filter_date (str | None) – The date value (or template) to be used in filters.

• poll_interval (int) – how often in seconds to check the query status

• aws_conn_id (str) – aws connection to use

• region (str | None) – aws region to use

• wait_for_completion (bool) – whether to wait for the run to end to return

ui_color = '#2bccbd'

UPDATE_PROPAGATION_TIME: int = 15

hook()

Create and return an AppflowHook.

execute(context)

This is the main method to derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.amazon.aws.operators.appflow.AppflowRunOperator(source, flow_name, poll_interval=20, aws_conn_id='aws_default', region=None, wait_for_completion=True, **kwargs)

Bases: AppflowBaseOperator

Execute a Appflow run with filters as is.

See also

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

Parameters

• source (str) – The source name (Supported: salesforce, zendesk)

• flow_name (str) – The flow name

• poll_interval (int) – how often in seconds to check the query status

• aws_conn_id (str) – aws connection to use

• region (str | None) – aws region to use

• wait_for_completion (bool) – whether to wait for the run to end to return

class airflow.providers.amazon.aws.operators.appflow.AppflowRunFullOperator(source, flow_name, poll_interval=20, aws_conn_id='aws_default', region=None, wait_for_completion=True, **kwargs)

Bases: AppflowBaseOperator

Execute a Appflow full run removing any filter.

See also

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

Parameters

• source (str) – The source name (Supported: salesforce, zendesk)

• flow_name (str) – The flow name

• poll_interval (int) – how often in seconds to check the query status

• aws_conn_id (str) – aws connection to use

• region (str | None) – aws region to use

• wait_for_completion (bool) – whether to wait for the run to end to return

class airflow.providers.amazon.aws.operators.appflow.AppflowRunBeforeOperator(source, flow_name, source_field, filter_date, poll_interval=20, aws_conn_id='aws_default', region=None, wait_for_completion=True, **kwargs)

Bases: AppflowBaseOperator

Execute a Appflow run after updating the filters to select only previous data.

See also

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

Parameters

• source (str) – The source name (Supported: salesforce)

• flow_name (str) – The flow name

• source_field (str) – The field name to apply filters

• filter_date (str) – The date value (or template) to be used in filters.

• poll_interval (int) – how often in seconds to check the query status

• aws_conn_id (str) – aws connection to use

• region (str | None) – aws region to use

• wait_for_completion (bool) – whether to wait for the run to end to return

template_fields = ('filter_date',)

class airflow.providers.amazon.aws.operators.appflow.AppflowRunAfterOperator(source, flow_name, source_field, filter_date, poll_interval=20, aws_conn_id='aws_default', region=None, wait_for_completion=True, **kwargs)

Bases: AppflowBaseOperator

Execute a Appflow run after updating the filters to select only future data.

See also

For more information on how to use this operator, take a look at the guide: Skipping Tasks For Empty Runs

Parameters

• source (str) – The source name (Supported: salesforce, zendesk)

• flow_name (str) – The flow name

• source_field (str) – The field name to apply filters

• filter_date (str) – The date value (or template) to be used in filters.

• poll_interval (int) – how often in seconds to check the query status

• aws_conn_id (str) – aws connection to use

• region (str | None) – aws region to use

• wait_for_completion (bool) – whether to wait for the run to end to return

template_fields = ('filter_date',)

class airflow.providers.amazon.aws.operators.appflow.AppflowRunDailyOperator(source, flow_name, source_field, filter_date, poll_interval=20, aws_conn_id='aws_default', region=None, wait_for_completion=True, **kwargs)

Bases: AppflowBaseOperator

Execute a Appflow run after updating the filters to select only a single day.

See also

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

Parameters

• source (str) – The source name (Supported: salesforce)

• flow_name (str) – The flow name

• source_field (str) – The field name to apply filters

• filter_date (str) – The date value (or template) to be used in filters.

• poll_interval (int) – how often in seconds to check the query status

• aws_conn_id (str) – aws connection to use

• region (str | None) – aws region to use

• wait_for_completion (bool) – whether to wait for the run to end to return

template_fields = ('filter_date',)

class airflow.providers.amazon.aws.operators.appflow.AppflowRecordsShortCircuitOperator(*, flow_name, appflow_run_task_id, ignore_downstream_trigger_rules=True, aws_conn_id='aws_default', region=None, **kwargs)

Bases: airflow.operators.python.ShortCircuitOperator

Short-circuit in case of a empty Appflow’s run.

See also

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

Parameters

• flow_name (str) – The flow name

• appflow_run_task_id (str) – Run task ID from where this operator should extract the execution ID

• ignore_downstream_trigger_rules (bool) – Ignore downstream trigger rules

• aws_conn_id (str) – aws connection to use

• region (str | None) – aws region to use

ui_color = '#33ffec'

hook()

Create and return an AppflowHook.

Previous Next

Was this entry helpful?