Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateLandingZone

This API call updates the landing zone. It starts an asynchronous operation that updates the landing zone based on the new landing zone version, or on the changed parameters specified in the updated manifest file.

Request Syntax


POST /update-landingzone HTTP/1.1
Content-type: application/json

{
   "landingZoneIdentifier": "string",
   "manifest": JSON value,
   "version": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

landingZoneIdentifier

The unique identifier of the landing zone.

Type: String

Required: Yes

manifest

The manifest file (JSON) is a text file that describes your AWS resources. For an example, review Launch your landing zone. The example manifest file contains each of the available parameters. The schema for the landing zone's JSON manifest file is not published, by design.

Type: JSON value

Required: Yes

version

The landing zone version, for example, 3.2.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 10.

Pattern: ^\d+.\d+$

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "operationIdentifier": "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.

operationIdentifier

A unique identifier assigned to a UpdateLandingZone operation. You can use this identifier as an input of GetLandingZoneOperation to check the operation's status.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

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

ConflictException

Updating or deleting the resource can cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred during processing of a request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

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