ControlTower / Client / list_landing_zones

list_landing_zones#

ControlTower.Client.list_landing_zones(**kwargs)#

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

response = client.list_landing_zones(
    maxResults=123,
    nextToken='string'
)

Parameters:

maxResults (integer) – The maximum number of returned landing zone ARNs, which is one.
nextToken (string) – The token to continue the list from a previous API call with the same parameters.

Return type:

dict

Returns:

Response Syntax

{
    'landingZones': [
        {
            'arn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- landingZones (list) –
  
  The ARN of the landing zone.
  - (dict) –
    
    Returns a summary of information about a landing zone.
    - arn (string) –
      
      The ARN of the landing zone.
- nextToken (string) –
  
  Retrieves the next page of results. If the string is empty, the response is the end of the results.

Exceptions

ControlTower.Client.exceptions.ValidationException
ControlTower.Client.exceptions.InternalServerException
ControlTower.Client.exceptions.AccessDeniedException
ControlTower.Client.exceptions.ThrottlingException