Skip to content

Commit 8327164

Browse files
author
AWS
committed
AmazonMWAA Update: Introducing InvokeRestApi which allows users to invoke the Apache Airflow REST API on the webserver with the specified inputs.
1 parent f0293c3 commit 8327164

File tree

2 files changed

+152
-7
lines changed

2 files changed

+152
-7
lines changed

‎.changes/next-release/feature-AmazonMWAA-3e9ac22.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AmazonMWAA",
4+
"contributor": "",
5+
"description": "Introducing InvokeRestApi which allows users to invoke the Apache Airflow REST API on the webserver with the specified inputs."
6+
}

‎services/mwaa/src/main/resources/codegen-resources/service-2.json

Lines changed: 146 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"version":"2.0",
33
"metadata":{
44
"apiVersion":"2020-07-01",
5+
"auth":["aws.auth#sigv4"],
56
"endpointPrefix":"airflow",
67
"protocol":"rest-json",
78
"protocols":["rest-json"],
@@ -40,7 +41,7 @@
4041
{"shape":"ValidationException"},
4142
{"shape":"InternalServerException"}
4243
],
43-
"documentation":"<p>Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.</p>",
44+
"documentation":"<p>Creates an Amazon Managed Workflows for Apache Airflow (Amazon MWAA) environment.</p>",
4445
"endpoint":{"hostPrefix":"api."},
4546
"idempotent":true
4647
},
@@ -77,7 +78,7 @@
7778
{"shape":"ValidationException"},
7879
{"shape":"InternalServerException"}
7980
],
80-
"documentation":"<p>Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.</p>",
81+
"documentation":"<p>Deletes an Amazon Managed Workflows for Apache Airflow (Amazon MWAA) environment.</p>",
8182
"endpoint":{"hostPrefix":"api."},
8283
"idempotent":true
8384
},
@@ -98,6 +99,26 @@
9899
"documentation":"<p>Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.</p>",
99100
"endpoint":{"hostPrefix":"api."}
100101
},
102+
"InvokeRestApi":{
103+
"name":"InvokeRestApi",
104+
"http":{
105+
"method":"POST",
106+
"requestUri":"/restapi/{Name}",
107+
"responseCode":200
108+
},
109+
"input":{"shape":"InvokeRestApiRequest"},
110+
"output":{"shape":"InvokeRestApiResponse"},
111+
"errors":[
112+
{"shape":"RestApiClientException"},
113+
{"shape":"AccessDeniedException"},
114+
{"shape":"ResourceNotFoundException"},
115+
{"shape":"ValidationException"},
116+
{"shape":"InternalServerException"},
117+
{"shape":"RestApiServerException"}
118+
],
119+
"documentation":"<p>Invokes the Apache Airflow REST API on the webserver with the specified inputs. To learn more, see <a href=\"https://docs.aws.amazon.com/mwaa/latest/userguide/access-mwaa-apache-airflow-rest-api.html\">Using the Apache Airflow REST API</a> </p>",
120+
"endpoint":{"hostPrefix":"env."}
121+
},
101122
"ListEnvironments":{
102123
"name":"ListEnvironments",
103124
"http":{
@@ -356,7 +377,7 @@
356377
},
357378
"AirflowVersion":{
358379
"shape":"AirflowVersion",
359-
"documentation":"<p>The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version. For more information, see <a href=\"https://docs.aws.amazon.com/mwaa/latest/userguide/airflow-versions.html\">Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA)</a>.</p> <p>Valid values: <code>1.10.12</code>, <code>2.0.2</code>, <code>2.2.2</code>, <code>2.4.3</code>, <code>2.5.1</code>, <code>2.6.3</code>, <code>2.7.2</code> <code>2.8.1</code> </p>"
380+
"documentation":"<p>The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version. For more information, see <a href=\"https://docs.aws.amazon.com/mwaa/latest/userguide/airflow-versions.html\">Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (Amazon MWAA)</a>.</p> <p>Valid values: <code>1.10.12</code>, <code>2.0.2</code>, <code>2.2.2</code>, <code>2.4.3</code>, <code>2.5.1</code>, <code>2.6.3</code>, <code>2.7.2</code>, <code>2.8.1</code>, <code>2.9.2</code>, and <code>2.10.1</code>.</p>"
360381
},
361382
"LoggingConfiguration":{
362383
"shape":"LoggingConfigurationInput",
@@ -395,7 +416,7 @@
395416
"documentation":"<p> The maximum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for <code>MaxWebservers</code> when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network calls to the Apache Airflow REST API with a high transaction-per-second (TPS) rate, Amazon MWAA will increase the number of web servers up to the number set in <code>MaxWebserers</code>. As TPS rates decrease Amazon MWAA disposes of the additional web servers, and scales down to the number set in <code>MinxWebserers</code>. </p> <p>Valid values: Accepts between <code>2</code> and <code>5</code>. Defaults to <code>2</code>.</p>"
396417
}
397418
},
398-
"documentation":"<p>This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation to create an environment. For more information, see <a href=\"https://docs.aws.amazon.com/mwaa/latest/userguide/get-started.html\">Get started with Amazon Managed Workflows for Apache Airflow</a>.</p>"
419+
"documentation":"<p>This section contains the Amazon Managed Workflows for Apache Airflow (Amazon MWAA) API reference documentation to create an environment. For more information, see <a href=\"https://docs.aws.amazon.com/mwaa/latest/userguide/get-started.html\">Get started with Amazon Managed Workflows for Apache Airflow</a>.</p>"
399420
},
400421
"CreateEnvironmentOutput":{
401422
"type":"structure",
@@ -483,6 +504,12 @@
483504
"deprecated":true,
484505
"deprecatedMessage":"This type is for internal use and not meant for public use. Data set for this type will be ignored."
485506
},
507+
"Document":{
508+
"type":"structure",
509+
"members":{
510+
},
511+
"document":true
512+
},
486513
"Double":{
487514
"type":"double",
488515
"box":true
@@ -531,7 +558,7 @@
531558
},
532559
"AirflowVersion":{
533560
"shape":"AirflowVersion",
534-
"documentation":"<p>The Apache Airflow version on your environment.</p> <p>Valid values: <code>1.10.12</code>, <code>2.0.2</code>, <code>2.2.2</code>, <code>2.4.3</code>, <code>2.5.1</code>, <code>2.6.3</code>, <code>2.7.2</code>, <code>2.8.1</code>.</p>"
561+
"documentation":"<p>The Apache Airflow version on your environment.</p> <p>Valid values: <code>1.10.12</code>, <code>2.0.2</code>, <code>2.2.2</code>, <code>2.4.3</code>, <code>2.5.1</code>, <code>2.6.3</code>, <code>2.7.2</code>, <code>2.8.1</code>, <code>2.9.2</code>, and <code>2.10.1</code>.</p>"
535562
},
536563
"SourceBucketArn":{
537564
"shape":"S3BucketArn",
@@ -729,6 +756,51 @@
729756
"exception":true,
730757
"fault":true
731758
},
759+
"InvokeRestApiRequest":{
760+
"type":"structure",
761+
"required":[
762+
"Name",
763+
"Path",
764+
"Method"
765+
],
766+
"members":{
767+
"Name":{
768+
"shape":"EnvironmentName",
769+
"documentation":"<p>The name of the Amazon MWAA environment. For example, <code>MyMWAAEnvironment</code>.</p>",
770+
"location":"uri",
771+
"locationName":"Name"
772+
},
773+
"Path":{
774+
"shape":"RestApiPath",
775+
"documentation":"<p>The Apache Airflow REST API endpoint path to be called. For example, <code>/dags/123456/clearTaskInstances</code>. For more information, see <a href=\"https://airflow.apache.org/docs/apache-airflow/stable/stable-rest-api-ref.html\">Apache Airflow API</a> </p>"
776+
},
777+
"Method":{
778+
"shape":"RestApiMethod",
779+
"documentation":"<p>The HTTP method used for making Airflow REST API calls. For example, <code>POST</code>. </p>"
780+
},
781+
"QueryParameters":{
782+
"shape":"Document",
783+
"documentation":"<p>Query parameters to be included in the Apache Airflow REST API call, provided as a JSON object. </p>"
784+
},
785+
"Body":{
786+
"shape":"RestApiRequestBody",
787+
"documentation":"<p>The request body for the Apache Airflow REST API call, provided as a JSON object.</p>"
788+
}
789+
}
790+
},
791+
"InvokeRestApiResponse":{
792+
"type":"structure",
793+
"members":{
794+
"RestApiStatusCode":{
795+
"shape":"Integer",
796+
"documentation":"<p>The HTTP status code returned by the Apache Airflow REST API call.</p>"
797+
},
798+
"RestApiResponse":{
799+
"shape":"RestApiResponse",
800+
"documentation":"<p>The response data from the Apache Airflow REST API call, provided as a JSON object.</p>"
801+
}
802+
}
803+
},
732804
"KmsKey":{
733805
"type":"string",
734806
"max":1224,
@@ -1044,6 +1116,73 @@
10441116
},
10451117
"exception":true
10461118
},
1119+
"RestApiClientException":{
1120+
"type":"structure",
1121+
"members":{
1122+
"RestApiStatusCode":{
1123+
"shape":"Integer",
1124+
"documentation":"<p>The HTTP status code returned by the Apache Airflow REST API call.</p>"
1125+
},
1126+
"RestApiResponse":{
1127+
"shape":"RestApiResponse",
1128+
"documentation":"<p>The error response data from the Apache Airflow REST API call, provided as a JSON object.</p>"
1129+
}
1130+
},
1131+
"documentation":"<p>An exception indicating that a client-side error occurred during the Apache Airflow REST API call.</p>",
1132+
"error":{
1133+
"httpStatusCode":400,
1134+
"senderFault":true
1135+
},
1136+
"exception":true
1137+
},
1138+
"RestApiMethod":{
1139+
"type":"string",
1140+
"enum":[
1141+
"GET",
1142+
"PUT",
1143+
"POST",
1144+
"PATCH",
1145+
"DELETE"
1146+
]
1147+
},
1148+
"RestApiPath":{
1149+
"type":"string",
1150+
"max":64,
1151+
"min":1
1152+
},
1153+
"RestApiRequestBody":{
1154+
"type":"structure",
1155+
"members":{
1156+
},
1157+
"document":true,
1158+
"sensitive":true
1159+
},
1160+
"RestApiResponse":{
1161+
"type":"structure",
1162+
"members":{
1163+
},
1164+
"document":true,
1165+
"sensitive":true
1166+
},
1167+
"RestApiServerException":{
1168+
"type":"structure",
1169+
"members":{
1170+
"RestApiStatusCode":{
1171+
"shape":"Integer",
1172+
"documentation":"<p>The HTTP status code returned by the Apache Airflow REST API call.</p>"
1173+
},
1174+
"RestApiResponse":{
1175+
"shape":"RestApiResponse",
1176+
"documentation":"<p>The error response data from the Apache Airflow REST API call, provided as a JSON object.</p>"
1177+
}
1178+
},
1179+
"documentation":"<p>An exception indicating that a server-side error occurred during the Apache Airflow REST API call.</p>",
1180+
"error":{
1181+
"httpStatusCode":400,
1182+
"senderFault":true
1183+
},
1184+
"exception":true
1185+
},
10471186
"S3BucketArn":{
10481187
"type":"string",
10491188
"max":1224,
@@ -1238,7 +1377,7 @@
12381377
},
12391378
"AirflowVersion":{
12401379
"shape":"AirflowVersion",
1241-
"documentation":"<p>The Apache Airflow version for your environment. To upgrade your environment, specify a newer version of Apache Airflow supported by Amazon MWAA.</p> <p>Before you upgrade an environment, make sure your requirements, DAGs, plugins, and other resources used in your workflows are compatible with the new Apache Airflow version. For more information about updating your resources, see <a href=\"https://docs.aws.amazon.com/mwaa/latest/userguide/upgrading-environment.html\">Upgrading an Amazon MWAA environment</a>.</p> <p>Valid values: <code>1.10.12</code>, <code>2.0.2</code>, <code>2.2.2</code>, <code>2.4.3</code>, <code>2.5.1</code>, <code>2.6.3</code>, <code>2.7.2</code>, <code>2.8.1</code>.</p>"
1380+
"documentation":"<p>The Apache Airflow version for your environment. To upgrade your environment, specify a newer version of Apache Airflow supported by Amazon MWAA.</p> <p>Before you upgrade an environment, make sure your requirements, DAGs, plugins, and other resources used in your workflows are compatible with the new Apache Airflow version. For more information about updating your resources, see <a href=\"https://docs.aws.amazon.com/mwaa/latest/userguide/upgrading-environment.html\">Upgrading an Amazon MWAA environment</a>.</p> <p>Valid values: <code>1.10.12</code>, <code>2.0.2</code>, <code>2.2.2</code>, <code>2.4.3</code>, <code>2.5.1</code>, <code>2.6.3</code>, <code>2.7.2</code>, <code>2.8.1</code>, <code>2.9.2</code>, and <code>2.10.1</code>.</p>"
12421381
},
12431382
"SourceBucketArn":{
12441383
"shape":"S3BucketArn",
@@ -1404,5 +1543,5 @@
14041543
"pattern":".*(MON|TUE|WED|THU|FRI|SAT|SUN):([01]\\d|2[0-3]):(00|30).*"
14051544
}
14061545
},
1407-
"documentation":"<p><fullname>Amazon Managed Workflows for Apache Airflow</fullname> <p>This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation. For more information, see <a href=\"https://docs.aws.amazon.com/mwaa/latest/userguide/what-is-mwaa.html\">What is Amazon MWAA?</a>.</p> <p> <b>Endpoints</b> </p> <ul> <li> <p> <code>api.airflow.{region}.amazonaws.com</code> - This endpoint is used for environment management.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/mwaa/latest/API/API_CreateEnvironment.html\">CreateEnvironment</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/mwaa/latest/API/API_DeleteEnvironment.html\">DeleteEnvironment</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/mwaa/latest/API/API_GetEnvironment.html\">GetEnvironment</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/mwaa/latest/API/API_ListEnvironments.html\">ListEnvironments</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/mwaa/latest/API/API_ListTagsForResource.html\">ListTagsForResource</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/mwaa/latest/API/API_TagResource.html\">TagResource</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/mwaa/latest/API/API_UntagResource.html\">UntagResource</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/mwaa/latest/API/API_UpdateEnvironment.html\">UpdateEnvironment</a> </p> </li> </ul> </li> <li> <p> <code>env.airflow.{region}.amazonaws.com</code> - This endpoint is used to operate the Airflow environment.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/mwaa/latest/API/API_CreateCliToken.html \">CreateCliToken</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/mwaa/latest/API/API_CreateWebLoginToken.html\">CreateWebLoginToken</a> </p> </li> </ul> </li> </ul> <p> <b>Regions</b> </p> <p>For a list of supported regions, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/mwaa.html\">Amazon MWAA endpoints and quotas</a> in the <i>Amazon Web Services General Reference</i>.</p></p>"
1546+
"documentation":"<p><fullname>Amazon Managed Workflows for Apache Airflow</fullname> <p>This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation. For more information, see <a href=\"https://docs.aws.amazon.com/mwaa/latest/userguide/what-is-mwaa.html\">What is Amazon MWAA?</a>.</p> <p> <b>Endpoints</b> </p> <ul> <li> <p> <code>api.airflow.{region}.amazonaws.com</code> - This endpoint is used for environment management.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/mwaa/latest/API/API_CreateEnvironment.html\">CreateEnvironment</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/mwaa/latest/API/API_DeleteEnvironment.html\">DeleteEnvironment</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/mwaa/latest/API/API_GetEnvironment.html\">GetEnvironment</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/mwaa/latest/API/API_ListEnvironments.html\">ListEnvironments</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/mwaa/latest/API/API_ListTagsForResource.html\">ListTagsForResource</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/mwaa/latest/API/API_TagResource.html\">TagResource</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/mwaa/latest/API/API_UntagResource.html\">UntagResource</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/mwaa/latest/API/API_UpdateEnvironment.html\">UpdateEnvironment</a> </p> </li> </ul> </li> <li> <p> <code>env.airflow.{region}.amazonaws.com</code> - This endpoint is used to operate the Airflow environment.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/mwaa/latest/API/API_CreateCliToken.html \">CreateCliToken</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/mwaa/latest/API/API_CreateWebLoginToken.html\">CreateWebLoginToken</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/mwaa/latest/API/API_InvokeRestApi.html\">InvokeRestApi</a> </p> </li> </ul> </li> </ul> <p> <b>Regions</b> </p> <p>For a list of supported regions, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/mwaa.html\">Amazon MWAA endpoints and quotas</a> in the <i>Amazon Web Services General Reference</i>.</p></p>"
14081547
}

0 commit comments

Comments
 (0)