ListEnvironments - Amazon Managed Workflows for Apache Airflow

ListEnvironments

Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.

Request Syntax

GET /environments?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum number of results to retrieve per page. For example, 5 environments per page.

Valid Range: Minimum value of 1. Maximum value of 25.

NextToken

Retrieves the next page of the results.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Environments": [ "string" ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Environments

Returns a list of Amazon MWAA environments.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 80.

Pattern: ^[a-zA-Z][0-9a-zA-Z-_]*$

NextToken

Retrieves the next page of the results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

InternalServerException: An internal error has occurred.

HTTP Status Code: 500

ValidationException

ValidationException: The provided input is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: