docs-archive/apache-airflow-providers-amazon/1.0.0/_sources/operators/ecs.rst.txt

 .. Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at

 ..   http://www.apache.org/licenses/LICENSE-2.0

 .. Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.


.. _howto/operator:ECSOperator:

ECS Operator
============

.. contents::
  :depth: 1
  :local:

Prerequisite Tasks
------------------

.. include:: _partials/prerequisite_tasks.rst

Using Operator
--------------

Use the
:class:`~airflow.providers.amazon.aws.operators.ecs.ECSOperator`
to run a task defined in AWS ECS.

In the following example,
the task "hello_world" runs ``hello-world`` task in ``c`` cluster.
It overrides the command in the ``hello-world-container`` container.

Before using ECSOperator, *cluster* and *task definition* need to be created.

.. exampleinclude:: /../../airflow/providers/amazon/aws/example_dags/example_ecs_fargate.py
    :language: python
    :start-after: [START howto_operator_ecs]
    :end-before: [END howto_operator_ecs]

More information
----------------

For further information, look at the documentation of :meth:`~ECS.Client.run_task` method
in `boto3`_.

.. _boto3: https://pypi.org/project/boto3/