• Home
• airflow.providers.amazon
• airflow.providers.amazon.aws
• airflow.providers.amazon.aws.sensors
• airflow.providers.amazon.aws.sensors.ecs

airflow.providers.amazon.aws.sensors.ecs

Module Contents

Classes

EcsBaseSensor	Contains general sensor behavior for Elastic Container Service.
EcsClusterStateSensor	Poll the cluster state until it reaches a terminal state; raises AirflowException with the failure reason.
EcsTaskDefinitionStateSensor	Poll task definition until it reaches a terminal state; raise AirflowException with the failure reason.
EcsTaskStateSensor	Poll the task state until it reaches a terminal state; raises AirflowException with the failure reason.

Attributes

DEFAULT_CONN_ID

airflow.providers.amazon.aws.sensors.ecs.DEFAULT_CONN_ID: str = 'aws_default'

class airflow.providers.amazon.aws.sensors.ecs.EcsBaseSensor(*, aws_conn_id=DEFAULT_CONN_ID, region=None, **kwargs)

Bases: airflow.sensors.base.BaseSensorOperator

Contains general sensor behavior for Elastic Container Service.

hook()

Create and return an EcsHook.

client()

Create and return an EcsHook client.

class airflow.providers.amazon.aws.sensors.ecs.EcsClusterStateSensor(*, cluster_name, target_state=EcsClusterStates.ACTIVE, failure_states=None, **kwargs)

Bases: EcsBaseSensor

Poll the cluster state until it reaches a terminal state; raises AirflowException with the failure reason.

See also

For more information on how to use this operator, take a look at the guide: AWS ECS Cluster State Sensor

Parameters

• cluster_name (str) – The name of your cluster.

• target_state (airflow.providers.amazon.aws.hooks.ecs.EcsClusterStates | None) – Success state to watch for. (Default: “ACTIVE”)

• failure_states (set[airflow.providers.amazon.aws.hooks.ecs.EcsClusterStates] | None) – Fail if any of these states are reached before the Success State. (Default: “FAILED” or “INACTIVE”)

template_fields: Sequence[str] = ('cluster_name', 'target_state', 'failure_states')

poke(context)

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

class airflow.providers.amazon.aws.sensors.ecs.EcsTaskDefinitionStateSensor(*, task_definition, target_state=EcsTaskDefinitionStates.ACTIVE, **kwargs)

Bases: EcsBaseSensor

Poll task definition until it reaches a terminal state; raise AirflowException with the failure reason.

See also

For more information on how to use this operator, take a look at the guide: AWS ECS Task Definition State Sensor

Parameters

• task_definition (str) – The family for the latest ACTIVE revision, family and revision (family:revision ) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition.

• target_state (airflow.providers.amazon.aws.hooks.ecs.EcsTaskDefinitionStates | None) – Success state to watch for. (Default: “ACTIVE”)

template_fields: Sequence[str] = ('task_definition', 'target_state', 'failure_states')

poke(context)

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

class airflow.providers.amazon.aws.sensors.ecs.EcsTaskStateSensor(*, cluster, task, target_state=EcsTaskStates.RUNNING, failure_states=None, **kwargs)

Bases: EcsBaseSensor

Poll the task state until it reaches a terminal state; raises AirflowException with the failure reason.

See also

For more information on how to use this operator, take a look at the guide: AWS ECS Task State Sensor

Parameters

• cluster (str) – The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.

• task (str) – The task ID or full ARN of the task to poll.

• target_state (airflow.providers.amazon.aws.hooks.ecs.EcsTaskStates | None) – Success state to watch for. (Default: “ACTIVE”)

• failure_states (set[airflow.providers.amazon.aws.hooks.ecs.EcsTaskStates] | None) – Fail if any of these states are reached before the Success State. (Default: “STOPPED”)

template_fields: Sequence[str] = ('cluster', 'task', 'target_state', 'failure_states')

poke(context)

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

Previous Next

Was this entry helpful?