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

airflow.providers.amazon.aws.hooks.ecs

Module Contents

Classes

EcsClusterStates	Contains the possible State values of an ECS Cluster.
EcsTaskDefinitionStates	Contains the possible State values of an ECS Task Definition.
EcsTaskStates	Contains the possible State values of an ECS Task.
EcsHook	Interact with Amazon Elastic Container Service (ECS).
EcsTaskLogFetcher	Fetches Cloudwatch log events with specific interval as a thread
EcsProtocol	A structured Protocol for boto3.client('ecs'). This is used for type hints on

Functions

should_retry(exception)	Check if exception is related to ECS resource quota (CPU, MEM).
should_retry_eni(exception)	Check if exception is related to ENI (Elastic Network Interfaces).

airflow.providers.amazon.aws.hooks.ecs.should_retry(exception)

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

airflow.providers.amazon.aws.hooks.ecs.should_retry_eni(exception)

Check if exception is related to ENI (Elastic Network Interfaces).

class airflow.providers.amazon.aws.hooks.ecs.EcsClusterStates

Bases: enum.Enum

Contains the possible State values of an ECS Cluster.

ACTIVE = 'ACTIVE'

PROVISIONING = 'PROVISIONING'

DEPROVISIONING = 'DEPROVISIONING'

FAILED = 'FAILED'

INACTIVE = 'INACTIVE'

class airflow.providers.amazon.aws.hooks.ecs.EcsTaskDefinitionStates

Bases: enum.Enum

Contains the possible State values of an ECS Task Definition.

ACTIVE = 'ACTIVE'

INACTIVE = 'INACTIVE'

class airflow.providers.amazon.aws.hooks.ecs.EcsTaskStates

Bases: enum.Enum

Contains the possible State values of an ECS Task.

PROVISIONING = 'PROVISIONING'

PENDING = 'PENDING'

ACTIVATING = 'ACTIVATING'

RUNNING = 'RUNNING'

DEACTIVATING = 'DEACTIVATING'

STOPPING = 'STOPPING'

DEPROVISIONING = 'DEPROVISIONING'

STOPPED = 'STOPPED'

NONE = 'NONE'

class airflow.providers.amazon.aws.hooks.ecs.EcsHook(*args, **kwargs)

Bases: airflow.providers.amazon.aws.hooks.base_aws.AwsGenericHook

Interact with Amazon Elastic Container Service (ECS). Provide thin wrapper around boto3.client("ecs").

Additional arguments (such as aws_conn_id) may be specified and are passed down to the underlying AwsBaseHook.

See also

• airflow.providers.amazon.aws.hooks.base_aws.AwsBaseHook

• Amazon Elastic Container Service

get_cluster_state(cluster_name)

Get ECS Cluster state.

See also

• ECS.Client.describe_clusters()

Parameters

cluster_name (str) – ECS Cluster name or full cluster Amazon Resource Name (ARN) entry.

get_task_definition_state(task_definition)

Get ECS Task Definition state.

See also

• ECS.Client.describe_task_definition()

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 to describe.

get_task_state(cluster, task)

Get ECS Task state.

See also

• ECS.Client.describe_tasks()

Parameters

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

• task – Task ID or full ARN entry.

class airflow.providers.amazon.aws.hooks.ecs.EcsTaskLogFetcher(*, log_group, log_stream_name, fetch_interval, logger, aws_conn_id='aws_default', region_name=None)

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()

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(number_messages)

get_last_log_message()

is_stopped()

stop()

class airflow.providers.amazon.aws.hooks.ecs.EcsProtocol

Bases: airflow.typing_compat.Protocol

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

See also

• https://mypy.readthedocs.io/en/latest/protocols.html

• https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ecs.html

run_task(**kwargs)

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

get_waiter(x)

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

describe_tasks(cluster, tasks)

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

stop_task(cluster, task, reason)

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

describe_task_definition(taskDefinition)

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

list_tasks(cluster, launchType, desiredStatus, family)

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

Previous Next

Was this entry helpful?