Organize Amazon providers docs index (#30541)

apache · Apr 14, 2023 · 38f2b4a · 38f2b4a
1 parent 0d2e6dc
commit 38f2b4a
Show file tree

Hide file tree

Showing 53 changed files with 187 additions and 69 deletions.
diff --git a/airflow/providers/amazon/provider.yaml b/airflow/providers/amazon/provider.yaml
@@ -127,26 +127,26 @@ integrations:
   - integration-name: Amazon EMR
     external-doc-url: https://aws.amazon.com/emr/
     how-to-guide:
-      - /docs/apache-airflow-providers-amazon/operators/emr.rst
+      - /docs/apache-airflow-providers-amazon/operators/emr/emr.rst
     logo: /integration-logos/aws/Amazon-EMR_light-bg@4x.png
     tags: [aws]
   - integration-name: Amazon EMR on EKS
     external-doc-url: https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/emr-eks.html
     how-to-guide:
-      - /docs/apache-airflow-providers-amazon/operators/emr_eks.rst
+      - /docs/apache-airflow-providers-amazon/operators/emr/emr_eks.rst
     logo: /integration-logos/aws/Amazon-EMR_light-bg@4x.png
     tags: [aws]
   - integration-name: Amazon EMR Serverless
     external-doc-url: https://docs.aws.amazon.com/emr/latest/EMR-Serverless-UserGuide/emr-serverless.html
     how-to-guide:
-      - /docs/apache-airflow-providers-amazon/operators/emr_serverless.rst
+      - /docs/apache-airflow-providers-amazon/operators/emr/emr_serverless.rst
     logo: /integration-logos/aws/Amazon-EMR_light-bg@4x.png
     tags: [aws]
   - integration-name: Amazon Glacier
     external-doc-url: https://aws.amazon.com/glacier/
     logo: /integration-logos/aws/Amazon-S3-Glacier_light-bg@4x.png
     how-to-guide:
-      - /docs/apache-airflow-providers-amazon/operators/glacier.rst
+      - /docs/apache-airflow-providers-amazon/operators/s3/glacier.rst
     tags: [aws]
   - integration-name: Amazon Kinesis Data Firehose
     external-doc-url: https://aws.amazon.com/kinesis/data-firehose/
@@ -162,14 +162,14 @@ integrations:
     external-doc-url: https://aws.amazon.com/redshift/
     logo: /integration-logos/aws/Amazon-Redshift_light-bg@4x.png
     how-to-guide:
-      - /docs/apache-airflow-providers-amazon/operators/redshift_sql.rst
-      - /docs/apache-airflow-providers-amazon/operators/redshift_cluster.rst
+      - /docs/apache-airflow-providers-amazon/operators/redshift/redshift_sql.rst
+      - /docs/apache-airflow-providers-amazon/operators/redshift/redshift_cluster.rst
     tags: [aws]
   - integration-name: Amazon Redshift Data
     external-doc-url: https://aws.amazon.com/redshift/
     logo: /integration-logos/aws/Amazon-Redshift_light-bg@4x.png
     how-to-guide:
-      - /docs/apache-airflow-providers-amazon/operators/redshift_data.rst
+      - /docs/apache-airflow-providers-amazon/operators/redshift/redshift_data.rst
     tags: [aws]
   - integration-name: Amazon SageMaker
     external-doc-url: https://aws.amazon.com/sagemaker/
@@ -203,7 +203,7 @@ integrations:
     external-doc-url: https://aws.amazon.com/s3/
     logo: /integration-logos/aws/Amazon-Simple-Storage-Service-S3_light-bg@4x.png
     how-to-guide:
-      - /docs/apache-airflow-providers-amazon/operators/s3.rst
+      - /docs/apache-airflow-providers-amazon/operators/s3/s3.rst
     tags: [aws]
   - integration-name: Amazon Systems Manager (SSM)
     external-doc-url: https://aws.amazon.com/systems-manager/
@@ -506,74 +506,74 @@ hooks:
 transfers:
   - source-integration-name: Amazon DynamoDB
     target-integration-name: Amazon Simple Storage Service (S3)
-    how-to-guide: /docs/apache-airflow-providers-amazon/operators/transfer/dynamodb_to_s3.rst
+    how-to-guide: /docs/apache-airflow-providers-amazon/transfer/dynamodb_to_s3.rst
     python-module: airflow.providers.amazon.aws.transfers.dynamodb_to_s3
   - source-integration-name: Google Cloud Storage (GCS)
     target-integration-name: Amazon Simple Storage Service (S3)
-    how-to-guide: /docs/apache-airflow-providers-amazon/operators/transfer/gcs_to_s3.rst
+    how-to-guide: /docs/apache-airflow-providers-amazon/transfer/gcs_to_s3.rst
     python-module: airflow.providers.amazon.aws.transfers.gcs_to_s3
   - source-integration-name: Amazon Glacier
     target-integration-name: Google Cloud Storage (GCS)
-    how-to-guide: /docs/apache-airflow-providers-amazon/operators/transfer/glacier_to_gcs.rst
+    how-to-guide: /docs/apache-airflow-providers-amazon/transfer/glacier_to_gcs.rst
     python-module: airflow.providers.amazon.aws.transfers.glacier_to_gcs
   - source-integration-name: Google
     target-integration-name: Amazon Simple Storage Service (S3)
-    how-to-guide: /docs/apache-airflow-providers-amazon/operators/transfer/google_api_to_s3.rst
+    how-to-guide: /docs/apache-airflow-providers-amazon/transfer/google_api_to_s3.rst
     python-module: airflow.providers.amazon.aws.transfers.google_api_to_s3
   - source-integration-name: Apache Hive
     target-integration-name: Amazon DynamoDB
-    how-to-guide: /docs/apache-airflow-providers-amazon/operators/transfer/hive_to_dynamodb.rst
+    how-to-guide: /docs/apache-airflow-providers-amazon/transfer/hive_to_dynamodb.rst
     python-module: airflow.providers.amazon.aws.transfers.hive_to_dynamodb
   - source-integration-name: Internet Message Access Protocol (IMAP)
     target-integration-name: Amazon Simple Storage Service (S3)
-    how-to-guide: /docs/apache-airflow-providers-amazon/operators/transfer/imap_attachment_to_s3.rst
+    how-to-guide: /docs/apache-airflow-providers-amazon/transfer/imap_attachment_to_s3.rst
     python-module: airflow.providers.amazon.aws.transfers.imap_attachment_to_s3
   - source-integration-name: MongoDB
     target-integration-name: Amazon Simple Storage Service (S3)
-    how-to-guide: /docs/apache-airflow-providers-amazon/operators/transfer/mongo_to_s3.rst
+    how-to-guide: /docs/apache-airflow-providers-amazon/transfer/mongo_to_s3.rst
     python-module: airflow.providers.amazon.aws.transfers.mongo_to_s3
   - source-integration-name: Amazon Redshift
     target-integration-name: Amazon Simple Storage Service (S3)
-    how-to-guide: /docs/apache-airflow-providers-amazon/operators/transfer/redshift_to_s3.rst
+    how-to-guide: /docs/apache-airflow-providers-amazon/transfer/redshift_to_s3.rst
     python-module: airflow.providers.amazon.aws.transfers.redshift_to_s3
   - source-integration-name: Amazon Simple Storage Service (S3)
     target-integration-name: Amazon Redshift
-    how-to-guide: /docs/apache-airflow-providers-amazon/operators/transfer/s3_to_redshift.rst
+    how-to-guide: /docs/apache-airflow-providers-amazon/transfer/s3_to_redshift.rst
     python-module: airflow.providers.amazon.aws.transfers.s3_to_redshift
   - source-integration-name: Amazon Simple Storage Service (S3)
     target-integration-name: SSH File Transfer Protocol (SFTP)
-    how-to-guide: /docs/apache-airflow-providers-amazon/operators/transfer/s3_to_sftp.rst
+    how-to-guide: /docs/apache-airflow-providers-amazon/transfer/s3_to_sftp.rst
     python-module: airflow.providers.amazon.aws.transfers.s3_to_sftp
   - source-integration-name: SSH File Transfer Protocol (SFTP)
     target-integration-name: Amazon Simple Storage Service (S3)
-    how-to-guide: /docs/apache-airflow-providers-amazon/operators/transfer/sftp_to_s3.rst
+    how-to-guide: /docs/apache-airflow-providers-amazon/transfer/sftp_to_s3.rst
     python-module: airflow.providers.amazon.aws.transfers.sftp_to_s3
   - source-integration-name: Amazon Simple Storage Service (S3)
     target-integration-name: File Transfer Protocol (FTP)
-    how-to-guide: /docs/apache-airflow-providers-amazon/operators/transfer/s3_to_ftp.rst
+    how-to-guide: /docs/apache-airflow-providers-amazon/transfer/s3_to_ftp.rst
     python-module: airflow.providers.amazon.aws.transfers.s3_to_ftp
   - source-integration-name: Exasol
     target-integration-name: Amazon Simple Storage Service (S3)
     python-module: airflow.providers.amazon.aws.transfers.exasol_to_s3
   - source-integration-name: File Transfer Protocol (FTP)
     target-integration-name: Amazon Simple Storage Service (S3)
-    how-to-guide: /docs/apache-airflow-providers-amazon/operators/transfer/ftp_to_s3.rst
+    how-to-guide: /docs/apache-airflow-providers-amazon/transfer/ftp_to_s3.rst
     python-module: airflow.providers.amazon.aws.transfers.ftp_to_s3
   - source-integration-name: Salesforce
     target-integration-name: Amazon Simple Storage Service (S3)
-    how-to-guide: /docs/apache-airflow-providers-amazon/operators/transfer/salesforce_to_s3.rst
+    how-to-guide: /docs/apache-airflow-providers-amazon/transfer/salesforce_to_s3.rst
     python-module: airflow.providers.amazon.aws.transfers.salesforce_to_s3
   - source-integration-name: Local
     target-integration-name: Amazon Simple Storage Service (S3)
-    how-to-guide: /docs/apache-airflow-providers-amazon/operators/transfer/local_to_s3.rst
+    how-to-guide: /docs/apache-airflow-providers-amazon/transfer/local_to_s3.rst
     python-module: airflow.providers.amazon.aws.transfers.local_to_s3
   - source-integration-name: Common SQL
     target-integration-name: Amazon Simple Storage Service (S3)
-    how-to-guide: /docs/apache-airflow-providers-amazon/operators/transfer/sql_to_s3.rst
+    how-to-guide: /docs/apache-airflow-providers-amazon/transfer/sql_to_s3.rst
     python-module: airflow.providers.amazon.aws.transfers.sql_to_s3
   - source-integration-name: Amazon Simple Storage Service (S3)
     target-integration-name: Common SQL
-    how-to-guide: /docs/apache-airflow-providers-amazon/operators/transfer/s3_to_sql.rst
+    how-to-guide: /docs/apache-airflow-providers-amazon/transfer/s3_to_sql.rst
     python-module: airflow.providers.amazon.aws.transfers.s3_to_sql
   - source-integration-name: Amazon Web Services
     target-integration-name: Amazon Web Services

diff --git a/...perators/_partials/prerequisite_tasks.rst → ...s-amazon/_partials/prerequisite_tasks.rst b/...perators/_partials/prerequisite_tasks.rst → ...s-amazon/_partials/prerequisite_tasks.rst
diff --git a/docs/apache-airflow-providers-amazon/index.rst b/docs/apache-airflow-providers-amazon/index.rst
@@ -27,6 +27,7 @@ Content
 
     Connection types <connections/index>
     Operators <operators/index>
+    Transfers <transfer/index>
     Deferrable Operators <deferrable>
     Secrets backends <secrets-backends/index>
     Logging for Tasks <logging/index>

diff --git a/docs/apache-airflow-providers-amazon/operators/appflow.rst b/docs/apache-airflow-providers-amazon/operators/appflow.rst
@@ -33,7 +33,7 @@ AWS PrivateLink, reducing exposure to security threats.
 Prerequisite Tasks
 ------------------
 
-.. include:: _partials/prerequisite_tasks.rst
+.. include:: ../_partials/prerequisite_tasks.rst
 
 Operators
 ---------

diff --git a/docs/apache-airflow-providers-amazon/operators/athena.rst b/docs/apache-airflow-providers-amazon/operators/athena.rst
@@ -28,7 +28,7 @@ to your data in S3, define the schema, and start querying using standard SQL.
 Prerequisite Tasks
 ------------------
 
-.. include:: _partials/prerequisite_tasks.rst
+.. include:: ../_partials/prerequisite_tasks.rst
 
 Operators
 ---------

diff --git a/docs/apache-airflow-providers-amazon/operators/batch.rst b/docs/apache-airflow-providers-amazon/operators/batch.rst
@@ -27,7 +27,7 @@ infrastructure.
 Prerequisite Tasks
 ------------------
 
-.. include:: _partials/prerequisite_tasks.rst
+.. include:: ../_partials/prerequisite_tasks.rst
 
 Operators
 ---------

diff --git a/docs/apache-airflow-providers-amazon/operators/cloudformation.rst b/docs/apache-airflow-providers-amazon/operators/cloudformation.rst
@@ -29,7 +29,7 @@ create and delete a collection of resources together as a single unit (a stack).
 Prerequisite Tasks
 ------------------
 
-.. include:: _partials/prerequisite_tasks.rst
+.. include:: ../_partials/prerequisite_tasks.rst
 
 Operators
 ---------

diff --git a/docs/apache-airflow-providers-amazon/operators/datasync.rst b/docs/apache-airflow-providers-amazon/operators/datasync.rst
@@ -26,7 +26,7 @@ the internet or AWS Direct Connect.
 Prerequisite Tasks
 ------------------
 
-.. include:: _partials/prerequisite_tasks.rst
+.. include:: ../_partials/prerequisite_tasks.rst
 
 Operators
 ---------

diff --git a/docs/apache-airflow-providers-amazon/operators/dms.rst b/docs/apache-airflow-providers-amazon/operators/dms.rst
@@ -34,7 +34,7 @@ different database engines, such as from an Oracle database to a PostgreSQL data
 Prerequisite Tasks
 ------------------
 
-.. include:: _partials/prerequisite_tasks.rst
+.. include:: ../_partials/prerequisite_tasks.rst
 
 Operators
 ---------

diff --git a/docs/apache-airflow-providers-amazon/operators/dynamodb.rst b/docs/apache-airflow-providers-amazon/operators/dynamodb.rst
@@ -28,7 +28,7 @@ data import and export tools.
 Prerequisite Tasks
 ------------------
 
-.. include:: _partials/prerequisite_tasks.rst
+.. include:: ../_partials/prerequisite_tasks.rst
 
 
 Sensors

diff --git a/docs/apache-airflow-providers-amazon/operators/ec2.rst b/docs/apache-airflow-providers-amazon/operators/ec2.rst
@@ -15,17 +15,17 @@
     specific language governing permissions and limitations
     under the License.
 
-=========================================
-Amazon Amazon Elastic Compute Cloud (EC2)
-=========================================
+==================================
+Amazon Elastic Compute Cloud (EC2)
+==================================
 
 `Amazon Elastic Compute Cloud (Amazon EC2) <https://aws.amazon.com/ec2/>`__ is a web service that provides resizable
 computing capacity—literally, servers in Amazon's data centers—that you use to build and host your software systems.
 
 Prerequisite Tasks
 ------------------
 
-.. include:: _partials/prerequisite_tasks.rst
+.. include:: ../_partials/prerequisite_tasks.rst
 
 Operators
 ---------

diff --git a/docs/apache-airflow-providers-amazon/operators/ecs.rst b/docs/apache-airflow-providers-amazon/operators/ecs.rst
@@ -28,7 +28,7 @@ Airflow provides operators to run Task Definitions on an ECS cluster.
 Prerequisite Tasks
 ------------------
 
-.. include:: _partials/prerequisite_tasks.rst
+.. include:: ../_partials/prerequisite_tasks.rst
 
 Operators
 ---------

diff --git a/docs/apache-airflow-providers-amazon/operators/eks.rst b/docs/apache-airflow-providers-amazon/operators/eks.rst
@@ -29,7 +29,7 @@ Airflow provides operators to create and interact with the EKS clusters and comp
 Prerequisite Tasks
 ------------------
 
-.. include:: _partials/prerequisite_tasks.rst
+.. include:: ../_partials/prerequisite_tasks.rst
 
 Operators
 ---------

diff --git a/...irflow-providers-amazon/operators/emr.rst → ...ow-providers-amazon/operators/emr/emr.rst b/...irflow-providers-amazon/operators/emr.rst → ...ow-providers-amazon/operators/emr/emr.rst
@@ -30,7 +30,7 @@ Storage Service (Amazon S3) and Amazon DynamoDB.
 Prerequisite Tasks
 ------------------
 
-.. include:: _partials/prerequisite_tasks.rst
+.. include:: ../../_partials/prerequisite_tasks.rst
 
 Operators
 ---------

diff --git a/...ow-providers-amazon/operators/emr_eks.rst → ...roviders-amazon/operators/emr/emr_eks.rst b/...ow-providers-amazon/operators/emr_eks.rst → ...roviders-amazon/operators/emr/emr_eks.rst
@@ -26,7 +26,7 @@ Amazon EKS.
 Prerequisite Tasks
 ------------------
 
-.. include:: _partials/prerequisite_tasks.rst
+.. include:: ../../_partials/prerequisite_tasks.rst
 
 Operators
 ---------

diff --git a/...iders-amazon/operators/emr_serverless.rst → ...s-amazon/operators/emr/emr_serverless.rst b/...iders-amazon/operators/emr_serverless.rst → ...s-amazon/operators/emr/emr_serverless.rst
@@ -29,7 +29,7 @@ and manage clusters.
 Prerequisite Tasks
 ------------------
 
-.. include:: _partials/prerequisite_tasks.rst
+.. include:: ../../_partials/prerequisite_tasks.rst
 
 Operators
 ---------

diff --git a/docs/apache-airflow-providers-amazon/operators/emr/index.rst b/docs/apache-airflow-providers-amazon/operators/emr/index.rst
@@ -0,0 +1,28 @@
+ .. 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.
+
+
+
+Amazon EMR Operators
+====================
+
+
+.. toctree::
+    :maxdepth: 1
+    :glob:
+
+    *
diff --git a/docs/apache-airflow-providers-amazon/operators/glue.rst b/docs/apache-airflow-providers-amazon/operators/glue.rst
@@ -27,7 +27,7 @@ your data and putting it to use in minutes instead of months.
 Prerequisite Tasks
 ------------------
 
-.. include:: _partials/prerequisite_tasks.rst
+.. include:: ../_partials/prerequisite_tasks.rst
 
 Operators
 ---------

diff --git a/docs/apache-airflow-providers-amazon/operators/index.rst b/docs/apache-airflow-providers-amazon/operators/index.rst
@@ -25,5 +25,7 @@ Amazon AWS Operators
     :maxdepth: 1
     :glob:
 
+    emr/index
+    redshift/index
+    s3/index
     *
-    transfer/index
diff --git a/docs/apache-airflow-providers-amazon/operators/lambda.rst b/docs/apache-airflow-providers-amazon/operators/lambda.rst
@@ -28,7 +28,7 @@ You can set up your code to automatically trigger from other AWS services or cal
 Prerequisite Tasks
 ------------------
 
-.. include:: _partials/prerequisite_tasks.rst
+.. include:: ../_partials/prerequisite_tasks.rst
 
 Operators
 ---------

diff --git a/docs/apache-airflow-providers-amazon/operators/quicksight.rst b/docs/apache-airflow-providers-amazon/operators/quicksight.rst
@@ -28,7 +28,7 @@ QuickSight Super-fast, Parallel, In-Memory, Calculation Engine (SPICE).
 Prerequisite Tasks
 ------------------
 
-.. include:: _partials/prerequisite_tasks.rst
+.. include:: ../_partials/prerequisite_tasks.rst
 
 Operators
 ---------

diff --git a/docs/apache-airflow-providers-amazon/operators/rds.rst b/docs/apache-airflow-providers-amazon/operators/rds.rst
@@ -27,7 +27,7 @@ common database administration tasks.
 Prerequisite Tasks
 ------------------
 
-.. include:: _partials/prerequisite_tasks.rst
+.. include:: ../_partials/prerequisite_tasks.rst
 
 Operators
 ---------

diff --git a/docs/apache-airflow-providers-amazon/operators/redshift/index.rst b/docs/apache-airflow-providers-amazon/operators/redshift/index.rst
@@ -0,0 +1,28 @@
+ .. 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.
+
+
+
+Amazon Redshift Operators
+=========================
+
+
+.. toctree::
+    :maxdepth: 1
+    :glob:
+
+    *