Skip to content

update_landing_zone

update_landing_zone(
    version: LandingZoneVersion,
    landing_zone_identifier: str,
    *,
    config_overrides: Optional[ControlTowerClientConfig] = None,
    remediation_types: Optional[RemediationTypes] = None,
    manifest: Optional[Manifest] = None,
) -> UpdateLandingZoneOutput

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.

Parameters:

  • version (LandingZoneVersion) –

    The landing zone version, for example, 3.2.

  • remediation_types (Optional[RemediationTypes], default: None ) –

    Specifies the types of remediation actions to apply when updating the landing zone configuration.

  • landing_zone_identifier (str) –

    The unique identifier of the landing zone.

  • manifest (Optional[Manifest], default: None ) –

    The manifest file (JSON) is a text file that describes your Amazon Web Services 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.

Raises:

Source code in docs_src/capo_controltower/_services/control_tower.py
def update_landing_zone(
    self,
    version: "capo_controltower.types.landing_zone_version.LandingZoneVersion",
    landing_zone_identifier: str,
    *,
    config_overrides: Optional[ControlTowerClientConfig] = None,
    remediation_types: Optional[
        "capo_controltower.types.remediation_types.RemediationTypes"
    ] = None,
    manifest: Optional["capo_controltower.types.manifest.Manifest"] = None,
) -> "capo_controltower.types.update_landing_zone_output.UpdateLandingZoneOutput":
    """<p>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. </p>

    Args:
        version: <p>The landing zone version, for example, 3.2.</p>
        remediation_types: <p>Specifies the types of remediation actions to apply when updating the landing zone configuration.</p>
        landing_zone_identifier: <p>The unique identifier of the landing zone.</p>
        manifest: <p>The manifest file (JSON) is a text file that describes your Amazon Web Services resources. For an example, review <a href="https://docs.aws.amazon.com/controltower/latest/userguide/lz-api-launch">Launch your landing zone</a>. 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.</p>

    Raises:
        capo_controltower.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_controltower.errors.conflict_exception.ConflictException: <p>Updating or deleting the resource can cause an inconsistent state.</p>
        capo_controltower.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred during processing of a request.</p>
        capo_controltower.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request references a resource that does not exist.</p>
        capo_controltower.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_controltower.errors.validation_exception.ValidationException: <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_controltower.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_controltower.types.update_landing_zone_input.UpdateLandingZoneInput]",
    ) -> OperationResponse[
        "capo_controltower.types.update_landing_zone_output.UpdateLandingZoneOutput"
    ]:
        import capo_controltower._operations.aws_control_tower_apis.update_landing_zone

        output, http_response = (
            capo_controltower._operations.aws_control_tower_apis.update_landing_zone.update_landing_zone(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateLandingZone")
    )
    input_: capo_controltower.types.update_landing_zone_input.UpdateLandingZoneInput = {
        "version": version,
        "landing_zone_identifier": landing_zone_identifier,
    }
    if remediation_types is not None:
        input_["remediation_types"] = remediation_types
    if manifest is not None:
        input_["manifest"] = manifest

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output