:mod:`airflow.contrib.operators.s3_to_sftp_operator`
====================================================

.. py:module:: airflow.contrib.operators.s3_to_sftp_operator


Module Contents
---------------

.. py:class:: S3ToSFTPOperator(s3_bucket, s3_key, sftp_path, sftp_conn_id='ssh_default', s3_conn_id='aws_default', *args, **kwargs)

   Bases: :class:`airflow.models.BaseOperator`

   This operator enables the transferring of files from S3 to a SFTP server.

   :param sftp_conn_id: The sftp connection id. The name or identifier for
       establishing a connection to the SFTP server.
   :type sftp_conn_id: string
   :param sftp_path: The sftp remote path. This is the specified file path for
       uploading file to the SFTP server.
   :type sftp_path: string
   :param s3_conn_id: The s3 connection id. The name or identifier for
       establishing a connection to S3
   :type s3_conn_id: string
   :param s3_bucket: The targeted s3 bucket. This is the S3 bucket from
       where the file is downloaded.
   :type s3_bucket: string
   :param s3_key: The targeted s3 key. This is the specified file path for
       downloading the file from S3.
   :type s3_key: string

   .. attribute:: template_fields
      :annotation: = ['s3_key', 'sftp_path']

      
   .. staticmethod:: get_s3_key(s3_key)

      This parses the correct format for S3 keys
      regardless of how the S3 url is passed.


   .. method:: execute(self, context)