Skip to content

delete_stack

delete_stack(
    *,
    config_overrides: Optional[AppStreamClientConfig] = None,
    name: Optional[String] = None,
) -> DeleteStackResult

Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released.

Parameters:

Raises:

Source code in docs_src/capo_appstream/_services/app_stream.py
def delete_stack(
    self,
    *,
    config_overrides: Optional[AppStreamClientConfig] = None,
    name: Optional["capo_appstream.types.string.String"] = None,
) -> "capo_appstream.types.delete_stack_result.DeleteStackResult":
    """<p>Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released.</p>

    Args:
        name: <p>The name of the stack.</p>

    Raises:
        capo_appstream.errors.concurrent_modification_exception.ConcurrentModificationException: <p>An API error occurred. Wait a few minutes and try again.</p>
        capo_appstream.errors.operation_not_permitted_exception.OperationNotPermittedException: <p>The attempted operation is not permitted.</p>
        capo_appstream.errors.resource_in_use_exception.ResourceInUseException: <p>The specified resource is in use.</p>
        capo_appstream.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_appstream.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_appstream.types.delete_stack_request.DeleteStackRequest]",
    ) -> OperationResponse[
        "capo_appstream.types.delete_stack_result.DeleteStackResult"
    ]:
        import capo_appstream._operations.photon_admin_proxy_service.delete_stack

        output, http_response = (
            capo_appstream._operations.photon_admin_proxy_service.delete_stack.delete_stack(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteStack")
    )
    input_: capo_appstream.types.delete_stack_request.DeleteStackRequest = {}
    if name is not None:
        input_["name"] = name

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