Skip to content

stop_app_block_builder

stop_app_block_builder(
    *,
    config_overrides: Optional[AppStreamClientConfig] = None,
    name: Optional[Name] = None,
) -> StopAppBlockBuilderResult

Stops an app block builder.

Stopping an app block builder terminates the instance, and the instance state is not persisted.

Parameters:

  • name (Optional[Name], default: None ) –

    The name of the app block builder.

Raises:

Source code in docs_src/capo_appstream/_services/app_stream.py
def stop_app_block_builder(
    self,
    *,
    config_overrides: Optional[AppStreamClientConfig] = None,
    name: Optional["capo_appstream.types.name.Name"] = None,
) -> "capo_appstream.types.stop_app_block_builder_result.StopAppBlockBuilderResult":
    """<p>Stops an app block builder.</p> <p>Stopping an app block builder terminates the instance, and the instance state is not persisted.</p>

    Args:
        name: <p>The name of the app block builder.</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_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_app_block_builder_request.StopAppBlockBuilderRequest]",
    ) -> OperationResponse[
        "capo_appstream.types.stop_app_block_builder_result.StopAppBlockBuilderResult"
    ]:
        import capo_appstream._operations.photon_admin_proxy_service.stop_app_block_builder

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

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