Add documentation for provider packages - 2021-02-04

docs-archive/apache-airflow-providers-amazon/1.1.0/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: c71db0640d6b904b175c3468ba33238c
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs-archive/apache-airflow-providers-amazon/1.1.0/_sources/_api/airflow/providers/amazon/aws/hooks/athena/index.rst.txt

@@ -0,0 +1,146 @@
+:mod:`airflow.providers.amazon.aws.hooks.athena`
+================================================
+
+.. py:module:: airflow.providers.amazon.aws.hooks.athena
+
+.. autoapi-nested-parse::
+
+   This module contains AWS Athena hook
+
+
+
+Module Contents
+---------------
+
+.. py:class:: AWSAthenaHook(*args, sleep_time: int = 30, **kwargs)
+
+   Bases: :class:`airflow.providers.amazon.aws.hooks.base_aws.AwsBaseHook`
+
+   Interact with AWS Athena to run, poll queries and return query results
+
+   Additional arguments (such as ``aws_conn_id``) may be specified and
+   are passed down to the underlying AwsBaseHook.
+
+   .. seealso::
+       :class:`~airflow.providers.amazon.aws.hooks.base_aws.AwsBaseHook`
+
+   :param sleep_time: Time (in seconds) to wait between two consecutive calls to check query status on Athena
+   :type sleep_time: int
+
+   .. attribute:: INTERMEDIATE_STATES
+      :annotation: = ['QUEUED', 'RUNNING']
+
+
+
+   .. attribute:: FAILURE_STATES
+      :annotation: = ['FAILED', 'CANCELLED']
+
+
+
+   .. attribute:: SUCCESS_STATES
+      :annotation: = ['SUCCEEDED']
+
+
+
+
+   .. method:: run_query(self, query: str, query_context: Dict[str, str], result_configuration: Dict[str, Any], client_request_token: Optional[str] = None, workgroup: str = 'primary')
+
+      Run Presto query on athena with provided config and return submitted query_execution_id
+
+      :param query: Presto query to run
+      :type query: str
+      :param query_context: Context in which query need to be run
+      :type query_context: dict
+      :param result_configuration: Dict with path to store results in and config related to encryption
+      :type result_configuration: dict
+      :param client_request_token: Unique token created by user to avoid multiple executions of same query
+      :type client_request_token: str
+      :param workgroup: Athena workgroup name, when not specified, will be 'primary'
+      :type workgroup: str
+      :return: str
+
+
+
+
+   .. method:: check_query_status(self, query_execution_id: str)
+
+      Fetch the status of submitted athena query. Returns None or one of valid query states.
+
+      :param query_execution_id: Id of submitted athena query
+      :type query_execution_id: str
+      :return: str
+
+
+
+
+   .. method:: get_state_change_reason(self, query_execution_id: str)
+
+      Fetch the reason for a state change (e.g. error message). Returns None or reason string.
+
+      :param query_execution_id: Id of submitted athena query
+      :type query_execution_id: str
+      :return: str
+
+
+
+
+   .. method:: get_query_results(self, query_execution_id: str, next_token_id: Optional[str] = None, max_results: int = 1000)
+
+      Fetch submitted athena query results. returns none if query is in intermediate state or
+      failed/cancelled state else dict of query output
+
+      :param query_execution_id: Id of submitted athena query
+      :type query_execution_id: str
+      :param next_token_id:  The token that specifies where to start pagination.
+      :type next_token_id: str
+      :param max_results: The maximum number of results (rows) to return in this request.
+      :type max_results: int
+      :return: dict
+
+
+
+
+   .. method:: get_query_results_paginator(self, query_execution_id: str, max_items: Optional[int] = None, page_size: Optional[int] = None, starting_token: Optional[str] = None)
+
+      Fetch submitted athena query results. returns none if query is in intermediate state or
+      failed/cancelled state else a paginator to iterate through pages of results. If you
+      wish to get all results at once, call build_full_result() on the returned PageIterator
+
+      :param query_execution_id: Id of submitted athena query
+      :type query_execution_id: str
+      :param max_items: The total number of items to return.
+      :type max_items: int
+      :param page_size: The size of each page.
+      :type page_size: int
+      :param starting_token: A token to specify where to start paginating.
+      :type starting_token: str
+      :return: PageIterator
+
+
+
+
+   .. method:: poll_query_status(self, query_execution_id: str, max_tries: Optional[int] = None)
+
+      Poll the status of submitted athena query until query state reaches final state.
+      Returns one of the final states
+
+      :param query_execution_id: Id of submitted athena query
+      :type query_execution_id: str
+      :param max_tries: Number of times to poll for query state before function exits
+      :type max_tries: int
+      :return: str
+
+
+
+
+   .. method:: stop_query(self, query_execution_id: str)
+
+      Cancel the submitted athena query
+
+      :param query_execution_id: Id of submitted athena query
+      :type query_execution_id: str
+      :return: dict
+
+
+
+

docs-archive/apache-airflow-providers-amazon/1.1.0/_sources/_api/airflow/providers/amazon/aws/hooks/aws_dynamodb/index.rst.txt

@@ -0,0 +1,11 @@
+:mod:`airflow.providers.amazon.aws.hooks.aws_dynamodb`
+======================================================
+
+.. py:module:: airflow.providers.amazon.aws.hooks.aws_dynamodb
+
+.. autoapi-nested-parse::
+
+   This module is deprecated. Please use `airflow.providers.amazon.aws.hooks.dynamodb`.
+
+
+

docs-archive/apache-airflow-providers-amazon/1.1.0/_sources/_api/airflow/providers/amazon/aws/hooks/base_aws/index.rst.txt

@@ -0,0 +1,204 @@
+:mod:`airflow.providers.amazon.aws.hooks.base_aws`
+==================================================
+
+.. py:module:: airflow.providers.amazon.aws.hooks.base_aws
+
+.. autoapi-nested-parse::
+
+   This module contains Base AWS Hook.
+
+   .. seealso::
+       For more information on how to use this hook, take a look at the guide:
+       :ref:`howto/connection:AWSHook`
+
+
+
+Module Contents
+---------------
+
+.. py:class:: _SessionFactory(conn: Connection, region_name: Optional[str], config: Config)
+
+   Bases: :class:`airflow.utils.log.logging_mixin.LoggingMixin`
+
+
+   .. method:: create_session(self)
+
+      Create AWS session.
+
+
+
+
+   .. method:: _create_basic_session(self, session_kwargs: Dict[str, Any])
+
+
+
+
+   .. method:: _impersonate_to_role(self, role_arn: str, session: boto3.session.Session, session_kwargs: Dict[str, Any])
+
+
+
+
+   .. method:: _read_role_arn_from_extra_config(self)
+
+
+
+
+   .. method:: _read_credentials_from_connection(self)
+
+
+
+
+   .. method:: _assume_role(self, sts_client: boto3.client, role_arn: str, assume_role_kwargs: Dict[str, Any])
+
+
+
+
+   .. method:: _assume_role_with_saml(self, sts_client: boto3.client, role_arn: str, assume_role_kwargs: Dict[str, Any])
+
+
+
+
+   .. method:: _fetch_saml_assertion_using_http_spegno_auth(self, saml_config: Dict[str, Any])
+
+
+
+
+   .. method:: _assume_role_with_web_identity(self, role_arn, assume_role_kwargs, base_session)
+
+
+
+
+   .. method:: _get_google_identity_token_loader(self)
+
+
+
+
+.. py:class:: AwsBaseHook(aws_conn_id: Optional[str] = default_conn_name, verify: Union[bool, str, None] = None, region_name: Optional[str] = None, client_type: Optional[str] = None, resource_type: Optional[str] = None, config: Optional[Config] = None)
+
+   Bases: :class:`airflow.hooks.base.BaseHook`
+
+   Interact with AWS.
+   This class is a thin wrapper around the boto3 python library.
+
+   :param aws_conn_id: The Airflow connection used for AWS credentials.
+       If this is None or empty then the default boto3 behaviour is used. If
+       running Airflow in a distributed manner and aws_conn_id is None or
+       empty, then default boto3 configuration would be used (and must be
+       maintained on each worker node).
+   :type aws_conn_id: str
+   :param verify: Whether or not to verify SSL certificates.
+       https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html
+   :type verify: Union[bool, str, None]
+   :param region_name: AWS region_name. If not specified then the default boto3 behaviour is used.
+   :type region_name: Optional[str]
+   :param client_type: boto3.client client_type. Eg 's3', 'emr' etc
+   :type client_type: Optional[str]
+   :param resource_type: boto3.resource resource_type. Eg 'dynamodb' etc
+   :type resource_type: Optional[str]
+   :param config: Configuration for botocore client.
+       (https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html)
+   :type config: Optional[botocore.client.Config]
+
+   .. attribute:: conn_name_attr
+      :annotation: = aws_conn_id
+
+
+
+   .. attribute:: default_conn_name
+      :annotation: = aws_default
+
+
+
+   .. attribute:: conn_type
+      :annotation: = aws
+
+
+
+   .. attribute:: hook_name
+      :annotation: = Amazon Web Services
+
+
+
+
+   .. method:: _get_credentials(self, region_name: Optional[str])
+
+
+
+
+   .. method:: get_client_type(self, client_type: str, region_name: Optional[str] = None, config: Optional[Config] = None)
+
+      Get the underlying boto3 client using boto3 session
+
+
+
+
+   .. method:: get_resource_type(self, resource_type: str, region_name: Optional[str] = None, config: Optional[Config] = None)
+
+      Get the underlying boto3 resource using boto3 session
+
+
+
+
+   .. method:: conn(self)
+
+      Get the underlying boto3 client/resource (cached)
+
+      :return: boto3.client or boto3.resource
+      :rtype: Union[boto3.client, boto3.resource]
+
+
+
+
+   .. method:: get_conn(self)
+
+      Get the underlying boto3 client/resource (cached)
+
+      Implemented so that caching works as intended. It exists for compatibility
+      with subclasses that rely on a super().get_conn() method.
+
+      :return: boto3.client or boto3.resource
+      :rtype: Union[boto3.client, boto3.resource]
+
+
+
+
+   .. method:: get_session(self, region_name: Optional[str] = None)
+
+      Get the underlying boto3.session.
+
+
+
+
+   .. method:: get_credentials(self, region_name: Optional[str] = None)
+
+      Get the underlying `botocore.Credentials` object.
+
+      This contains the following authentication attributes: access_key, secret_key and token.
+
+
+
+
+   .. method:: expand_role(self, role: str)
+
+      If the IAM role is a role name, get the Amazon Resource Name (ARN) for the role.
+      If IAM role is already an IAM role ARN, no change is made.
+
+      :param role: IAM role name or ARN
+      :return: IAM role ARN
+
+
+
+
+.. function:: _parse_s3_config(config_file_name: str, config_format: Optional[str] = 'boto', profile: Optional[str] = None) -> Tuple[Optional[str], Optional[str]]
+   Parses a config file for s3 credentials. Can currently
+   parse boto, s3cmd.conf and AWS SDK config formats
+
+   :param config_file_name: path to the config file
+   :type config_file_name: str
+   :param config_format: config type. One of "boto", "s3cmd" or "aws".
+       Defaults to "boto"
+   :type config_format: str
+   :param profile: profile name in AWS type config file
+   :type profile: str
+
+