start_outpost_decommission `async` ¶

start_outpost_decommission(
    outpost_identifier: OutpostIdentifier,
    *,
    config_overrides: Optional[AsyncOutpostsClientConfig] = None,
    validate_only: Optional[ValidateOnly] = None,
) -> StartOutpostDecommissionOutput

Starts the decommission process to return the Outposts racks or servers.

Parameters:

outpost_identifier (OutpostIdentifier) –

The ID or ARN of the Outpost that you want to decommission.
validate_only (Optional[ValidateOnly], default: None ) –

Validates the request without starting the decommission process.

Raises:

AccessDeniedException –

You do not have permission to perform this operation.
ConflictException –

Updating or deleting this resource can cause an inconsistent state.
InternalServerException –

An internal error has occurred.
NotFoundException –

The specified request is not valid.
ValidationException –

A parameter is not valid.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_outposts/_services/async_outposts.py

async def start_outpost_decommission(
    self,
    outpost_identifier: "capo_outposts.types.outpost_identifier.OutpostIdentifier",
    *,
    config_overrides: Optional[AsyncOutpostsClientConfig] = None,
    validate_only: Optional[
        "capo_outposts.types.validate_only.ValidateOnly"
    ] = None,
) -> "capo_outposts.types.start_outpost_decommission_output.StartOutpostDecommissionOutput":
    """<p>Starts the decommission process to return the Outposts racks or servers.</p>

    Args:
        outpost_identifier: <p>The ID or ARN of the Outpost that you want to decommission.</p>
        validate_only: <p>Validates the request without starting the decommission process.</p>

    Raises:
        capo_outposts.errors.access_denied_exception.AccessDeniedException: <p>You do not have permission to perform this operation.</p>
        capo_outposts.errors.conflict_exception.ConflictException: <p>Updating or deleting this resource can cause an inconsistent state.</p>
        capo_outposts.errors.internal_server_exception.InternalServerException: <p>An internal error has occurred.</p>
        capo_outposts.errors.not_found_exception.NotFoundException: <p>The specified request is not valid.</p>
        capo_outposts.errors.validation_exception.ValidationException: <p>A parameter is not valid.</p>
        capo_outposts.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_outposts.types.start_outpost_decommission_input.StartOutpostDecommissionInput]",
    ) -> AsyncOperationResponse[
        "capo_outposts.types.start_outpost_decommission_output.StartOutpostDecommissionOutput"
    ]:
        import capo_outposts._operations.outposts_olaf_service.start_outpost_decommission

        (
            output,
            http_response,
        ) = await capo_outposts._operations.outposts_olaf_service.start_outpost_decommission.async_start_outpost_decommission(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartOutpostDecommission")
    )
    input_: capo_outposts.types.start_outpost_decommission_input.StartOutpostDecommissionInput = {
        "outpost_identifier": outpost_identifier
    }
    if validate_only is not None:
        input_["validate_only"] = validate_only

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

start_outpost_decommission async ¶

start_outpost_decommission `async` ¶