airflow.providers.amazon.aws.operators.ecs

Module Contents

Classes

ECSProtocol

A structured Protocol for boto3.client('ecs'). This is used for type hints on

ECSTaskLogFetcher

Fetches Cloudwatch log events with specific interval as a thread

ECSOperator

Execute a task on AWS ECS (Elastic Container Service)

Functions

should_retry(exception: Exception)

Check if exception is related to ECS resource quota (CPU, MEM).
airflow.providers.amazon.aws.operators.ecs.should_retry(exception: Exception)[source]

Check if exception is related to ECS resource quota (CPU, MEM).

class airflow.providers.amazon.aws.operators.ecs.ECSProtocol[source]

Bases: airflow.typing_compat.Protocol

A structured Protocol for boto3.client('ecs'). This is used for type hints on ECSOperator.client().

See also

run_task(self, **kwargs) → Dict[source]

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ecs.html#ECS.Client.run_task

get_waiter(self, x: str) → botocore.waiter.Waiter[source]

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ecs.html#ECS.Client.get_waiter

describe_tasks(self, cluster: str, tasks) → Dict[source]

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ecs.html#ECS.Client.describe_tasks

stop_task(self, cluster, task, reason: str) → Dict[source]

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ecs.html#ECS.Client.stop_task

describe_task_definition(self, taskDefinition: str) → Dict[source]

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ecs.html#ECS.Client.describe_task_definition

list_tasks(self, cluster: str, launchType: str, desiredStatus: str, family: str) → Dict[source]

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ecs.html#ECS.Client.list_tasks

class airflow.providers.amazon.aws.operators.ecs.ECSTaskLogFetcher(*, aws_conn_id: Optional[str] = 'aws_default', region_name: Optional[str] = None, log_group: str, log_stream_name: str, fetch_interval: datetime.timedelta, logger: logging.Logger)[source]

Bases: threading.Thread

Fetches Cloudwatch log events with specific interval as a thread and sends the log events to the info channel of the provided logger.

run(self) → None[source]

Method representing the thread's activity.

You may override this method in a subclass. The standard run() method invokes the callable object passed to the object's constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.

get_last_log_messages(self, number_messages) → list[source]
get_last_log_message(self) → Optional[str][source]
is_stopped(self) → bool[source]
stop(self)[source]
class airflow.providers.amazon.aws.operators.ecs.ECSOperator(*, task_definition: str, cluster: str, overrides: dict, aws_conn_id: Optional[str] = None, region_name: Optional[str] = None, launch_type: str = 'EC2', capacity_provider_strategy: Optional[list] = None, group: Optional[str] = None, placement_constraints: Optional[list] = None, placement_strategy: Optional[list] = None, platform_version: Optional[str] = None, network_configuration: Optional[dict] = None, tags: Optional[dict] = None, awslogs_group: Optional[str] = None, awslogs_region: Optional[str] = None, awslogs_stream_prefix: Optional[str] = None, awslogs_fetch_interval: datetime.timedelta = timedelta(seconds=30), propagate_tags: Optional[str] = None, quota_retry: Optional[dict] = None, reattach: bool = False, number_logs_exception: int = 10, **kwargs)[source]

Bases: airflow.models.BaseOperator

Execute a task on AWS ECS (Elastic Container Service)

See also

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

Parameters

  • task_definition (str) -- the task definition name on Elastic Container Service

  • cluster (str) -- the cluster name on Elastic Container Service

  • overrides (dict) -- the same parameter that boto3 will receive (templated): https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ecs.html#ECS.Client.run_task

  • aws_conn_id (str) -- connection id of AWS credentials / region name. If None, credential boto3 strategy will be used (http://boto3.readthedocs.io/en/latest/guide/configuration.html).

  • region_name (str) -- region name to use in AWS Hook. Override the region_name in connection (if provided)

  • launch_type (str) -- the launch type on which to run your task ('EC2' or 'FARGATE')

  • capacity_provider_strategy (list) -- the capacity provider strategy to use for the task. When capacity_provider_strategy is specified, the launch_type parameter is omitted. If no capacity_provider_strategy or launch_type is specified, the default capacity provider strategy for the cluster is used.

  • group (str) -- the name of the task group associated with the task

  • placement_constraints (list) -- an array of placement constraint objects to use for the task

  • placement_strategy (list) -- an array of placement strategy objects to use for the task

  • platform_version (str) -- the platform version on which your task is running

  • network_configuration (dict) -- the network configuration for the task

  • tags (dict) -- a dictionary of tags in the form of {'tagKey': 'tagValue'}.

  • awslogs_group (str) -- the CloudWatch group where your ECS container logs are stored. Only required if you want logs to be shown in the Airflow UI after your job has finished.

  • awslogs_region (str) -- the region in which your CloudWatch logs are stored. If None, this is the same as the region_name parameter. If that is also None, this is the default AWS region based on your connection settings.

  • awslogs_stream_prefix (str) -- the stream prefix that is used for the CloudWatch logs. This is usually based on some custom name combined with the name of the container. Only required if you want logs to be shown in the Airflow UI after your job has finished.

  • awslogs_fetch_interval (timedelta) -- the interval that the ECS task log fetcher should wait in between each Cloudwatch logs fetches.

  • quota_retry (dict) -- Config if and how to retry the launch of a new ECS task, to handle transient errors.

  • reattach (bool) -- If set to True, will check if the task previously launched by the task_instance is already running. If so, the operator will attach to it instead of starting a new task. This is to avoid relaunching a new task when the connection drops between Airflow and ECS while the task is running (when the Airflow worker is restarted for example).

  • number_logs_exception (int) -- Number of lines from the last Cloudwatch logs to return in the AirflowException if an ECS task is stopped (to receive Airflow alerts with the logs of what failed in the code running in ECS).

ui_color = #f0ede4[source]
template_fields :Sequence[str] = ['overrides'][source]
template_fields_renderers[source]
REATTACH_XCOM_KEY = ecs_task_arn[source]
REATTACH_XCOM_TASK_ID_TEMPLATE = {task_id}_task_arn[source]
execute(self, context, session=None)[source]

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.

get_hook(self) → airflow.providers.amazon.aws.hooks.base_aws.AwsBaseHook[source]

Create and return an AwsHook.

on_kill(self) → None[source]

Override this method to cleanup subprocesses when a task instance gets killed. Any use of the threading, subprocess or multiprocessing module within an operator needs to be cleaned up or it will leave ghost processes behind.

Was this entry helpful?