ControlTower / Client / get_landing_zone

get_landing_zone

ControlTower.Client.get_landing_zone(**kwargs)

Returns details about the landing zone. Displays a message in case of error.

See also: AWS API Documentation

Request Syntax

response = client.get_landing_zone(
    landingZoneIdentifier='string'
)
Parameters:

landingZoneIdentifier (string) –

[REQUIRED]

The unique identifier of the landing zone.

Return type:

dict

Returns:

Response Syntax

{
    'landingZone': {
        'arn': 'string',
        'driftStatus': {
            'status': 'DRIFTED'|'IN_SYNC'
        },
        'latestAvailableVersion': 'string',
        'manifest': {...}|[...]|123|123.4|'string'|True|None,
        'status': 'ACTIVE'|'PROCESSING'|'FAILED',
        'version': 'string'
    }
}

Response Structure

  • (dict) –

    • landingZone (dict) –

      Information about the landing zone.

      • arn (string) –

        The ARN of the landing zone.

      • driftStatus (dict) –

        The drift status of the landing zone.

        • status (string) –

          The drift status of the landing zone.

          Valid values:

          • DRIFTED: The landing zone deployed in this configuration does not match the configuration that Amazon Web Services Control Tower expected.

          • IN_SYNC: The landing zone deployed in this configuration matches the configuration that Amazon Web Services Control Tower expected.

      • latestAvailableVersion (string) –

        The latest available version of the landing zone.

      • manifest (document) –

        The landing zone manifest JSON text file that specifies the landing zone configurations.

      • status (string) –

        The landing zone deployment status. One of ACTIVE, PROCESSING, FAILED.

      • version (string) –

        The landing zone’s current deployed version.

Exceptions