ListLandingZones - AWS Control Tower

ListLandingZones

Returns the landing zone ARN for the landing zone deployed in your managed account. This API also creates an ARN for existing accounts that do not yet have a landing zone ARN.

Returns one landing zone ARN.

Request Syntax

POST /list-landingzones HTTP/1.1 Content-type: application/json { "maxResults": number, "nextToken": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

maxResults

The maximum number of returned landing zone ARNs, which is one.

Type: Integer

Valid Range: Fixed value of 1.

Required: No

nextToken

The token to continue the list from a previous API call with the same parameters.

Type: String

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "landingZones": [ { "arn": "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.

landingZones

The ARN of the landing zone.

Type: Array of LandingZoneSummary objects

Array Members: Minimum number of 0 items. Maximum number of 1 item.

nextToken

Retrieves the next page of results. If the string is empty, the response is the end of the results.

Type: String

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred during processing of a request.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

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