AWS mwaa documentation change
Summary
Updated documentation formatting and added explicit timeout details for InvokeRestApi operation
Security assessment
The changes primarily involve formatting adjustments (changing 'see' to 'refer to'), moving timeout details into bullet points, and clarifying operational aspects. While timeout configuration impacts reliability, there's no evidence this addresses a security vulnerability or weakness. The security-related IAM policy references remain unchanged.
Diff
diff --git a/mwaa/latest/userguide/access-mwaa-apache-airflow-rest-api.md b/mwaa/latest/userguide/access-mwaa-apache-airflow-rest-api.md index 7fe7dae61..78ee2ffdf 100644 --- a//mwaa/latest/userguide/access-mwaa-apache-airflow-rest-api.md +++ b//mwaa/latest/userguide/access-mwaa-apache-airflow-rest-api.md @@ -11 +11 @@ Amazon Managed Workflows for Apache Airflow (Amazon MWAA) supports interacting w -In order to support scalability while using the Apache Airflow REST API, Amazon MWAA provides you with the option to horizontally scale web server capacity to handle increased demand, whether from REST API requests, command line interface (CLI) usage, or more concurrent Apache Airflow user interface (UI) users. For more information on how Amazon MWAA scales web servers, see [Configuring Amazon MWAA web server automatic scaling](./mwaa-web-server-autoscaling.html). +In order to support scalability while using the Apache Airflow REST API, Amazon MWAA provides you with the option to horizontally scale web server capacity to handle increased demand, whether from REST API requests, command line interface (CLI) usage, or more concurrent Apache Airflow user interface (UI) users. For more information on how Amazon MWAA scales web servers, refer to [Configuring Amazon MWAA web server automatic scaling](./mwaa-web-server-autoscaling.html). @@ -24 +24 @@ You can use the Apache Airflow REST API to implement the following use-cases for -For more information about the Apache Airflow REST API, see [The Apache Airflow REST API Reference](https://airflow.apache.org/docs/apache-airflow/stable/stable-rest-api-ref.html). +For more information about the Apache Airflow REST API, refer to [The Apache Airflow REST API Reference](https://airflow.apache.org/docs/apache-airflow/stable/stable-rest-api-ref.html). @@ -28 +28,5 @@ By using `InvokeRestApi`, you can access the Apache Airflow REST API using AWS c -If you encounter an error with the message "Update your environment to use `InvokeRestApi`" while using the `InvokeRestApi` operation, it indicates that you need to update your Amazon MWAA environment. This error occurs when your Amazon MWAA environment is not compatible with the latest changes related to the `InvokeRestApi` feature. To resolve this issue, update your Amazon MWAA environment to incorporate the necessary changes for the `InvokeRestApi` feature. + * If you encounter an error with the message "Update your environment to use `InvokeRestApi`" while using the `InvokeRestApi` operation, it indicates that you need to update your Amazon MWAA environment. This error occurs when your Amazon MWAA environment is not compatible with the latest changes related to the `InvokeRestApi` feature. To resolve this issue, update your Amazon MWAA environment to incorporate the necessary changes for the `InvokeRestApi` feature. + + * The `InvokeRestApi` operation has a default timeout duration of 10 seconds. If the operation does not complete within this 10-second timeframe, it will be automatically terminated, and an error will be raised. Ensure that your REST API calls are designed to complete within this timeout period to avoid encountering errors. + + @@ -30 +33,0 @@ If you encounter an error with the message "Update your environment to use `Invo -The `InvokeRestApi` operation has a default timeout duration of 10 seconds. If the operation does not complete within this 10-second timeframe, it will be automatically terminated, and an error will be raised. Ensure that your REST API calls are designed to complete within this timeout period to avoid encountering errors. @@ -51 +54 @@ The following examples show how you to make API calls to the Apache Airflow REST -To access the Apache Airflow REST API using AWS credential, you must grant the `airflow:InvokeRestApi` permission in your IAM policy. In the following policy sample, specify the `Admin`, `Op`, `User`, `Viewer` or the `Public` role in `{airflow-role}` to customize the level of user access. For more information, see [Default Roles](https://airflow.apache.org/docs/apache-airflow/1.10.6/security.html?highlight=ldap#default-roles) in the _Apache Airflow reference guide_. +To access the Apache Airflow REST API using AWS credential, you must grant the `airflow:InvokeRestApi` permission in your IAM policy. In the following policy sample, specify the `Admin`, `Op`, `User`, `Viewer` or the `Public` role in `{airflow-role}` to customize the level of user access. For more information, refer to [Default Roles](https://airflow.apache.org/docs/apache-airflow/1.10.6/security.html?highlight=ldap#default-roles) in the _Apache Airflow reference guide_. @@ -77 +80 @@ JSON -While configuring a private web server, the `InvokeRestApi` action cannot be invoked from outside of a Virtual Private Cloud (VPC). You can use the `aws:SourceVpc` key to apply more granular access control for this operation. For more information, see [aws:SourceVpc](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcevpc). +While configuring a private web server, the `InvokeRestApi` action cannot be invoked from outside of a Virtual Private Cloud (VPC). You can use the `aws:SourceVpc` key to apply more granular access control for this operation. For more information, refer to [aws:SourceVpc](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcevpc). @@ -81 +84 @@ While configuring a private web server, the `InvokeRestApi` action cannot be inv -This following sample script covers how to use the Apache Airflow REST API to list the available DAGs in your environment and how to create an Apache Airflow variable: +The following sample script covers how to use the Apache Airflow REST API to list the available DAGs in your environment and how to create an Apache Airflow variable: