Skip to content

stop_fleet

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

Stops the specified fleet.

Parameters:

Raises:

Source code in docs_src/capo_appstream/_services/app_stream.py
def stop_fleet(
    self,
    *,
    config_overrides: Optional[AppStreamClientConfig] = None,
    name: Optional["capo_appstream.types.string.String"] = None,
) -> "capo_appstream.types.stop_fleet_result.StopFleetResult":
    """<p>Stops the specified fleet.</p>

    Args:
        name: <p>The name of the fleet.</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.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.stop_fleet_request.StopFleetRequest]",
    ) -> OperationResponse[
        "capo_appstream.types.stop_fleet_result.StopFleetResult"
    ]:
        import capo_appstream._operations.photon_admin_proxy_service.stop_fleet

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopFleet")
    )
    input_: capo_appstream.types.stop_fleet_request.StopFleetRequest = {}
    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