Querying Landing Zone Configurations

Function

This API is used to query all configurations of the current landing zone.

URI

GET https://{endpoint}/v1/landing-zone/configuration

Request Parameters

None

Response Parameters

Status code: 200

**Table 1** Response body parameters
Parameter	Type	Description
common_configuration	CommonConfiguration object	Landing zone configurations.
logging_configuration	LoggingConfiguration object	Log configurations of the landing zone.
organization_structure	Array of OrganizationStructureBaseLineRsp objects	Basic settings of the account management system.
regions	Array of RegionConfigurationList objects	Information about the regions under governance.

**Table 2** CommonConfiguration
Parameter	Type	Description
home_region	String	Name of the home region.
cloud_trail_type	Boolean	CTS configuration status.
identity_center_status	String	Whether to set IAM Identity Center for the landing zone.
organization_structure_type	String	Organization type. It can be STANDARD or NON_STANDARD.

**Table 3** LoggingConfiguration
Parameter	Type	Description
logging_bucket_name	String	Name of a log aggregation bucket.
access_logging_bucket	AccessLoggingBucketBaseline object	Basic settings of access logs.
logging_bucket	LoggingBucketBaseline object	Basic log settings.

**Table 4** AccessLoggingBucketBaseline
Parameter	Type	Description
retention_days	Integer	Retention days of a bucket.
enable_multi_az	Boolean	Whether multi-AZ storage is allowed.

**Table 5** LoggingBucketBaseline
Parameter	Type	Description
retention_days	Integer	Retention days of a bucket.
enable_multi_az	Boolean	Whether multi-AZ storage is allowed.

**Table 6** OrganizationStructureBaseLineRsp
Parameter	Type	Description
organizational_unit_name	String	Name of a registered OU.
organizational_unit_type	String	Type of the registered OU. It can be a foundational OU or a custom OU.
accounts	Array of AccountBaselineRsp objects	Basic information about an enrolled account.

**Table 7** AccountBaselineRsp
Parameter	Type	Description
account_name	String	Name of an enrolled account.
account_id	String	A unique ID of an enrolled account.
account_type	String	Type of an enrolled account. It can be LOGGING or SECURITY.

**Table 8** RegionConfigurationList
Parameter	Type	Description
region	String	Region name.
region_configuration_status	String	Region status.

Status code: 403

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Unique ID of the request.
encoded_authorization_message	String	Encrypted error message.
details	Array of ForbiddenErrorDetail objects	Error message indicating no permissions for cross-service invoking.

**Table 10** ForbiddenErrorDetail
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

Querying all configurations of the current landing zone

GET https://{endpoint}/v1/landing-zone/configuration

Example Responses

Status code: 200

Request succeeded.

{
  "common_configuration" : {
    "home_region" : "string",
    "cloud_trail_type" : true
  },
  "logging_configuration" : {
    "access_logging_bucket" : {
      "retention_days" : 5475
    },
    "logging_bucket" : {
      "retention_days" : 5475
    }
  },
  "organization_structure" : [ {
    "organizational_unit_name" : "string",
    "organizational_unit_type" : "CORE",
    "accounts" : [ {
      "account_name" : "string",
      "account_type" : "LOGGING"
    } ]
  } ],
  "regions" : [ {
    "region" : "string",
    "region_configuration_status" : "ENABLED"
  } ]
}