Skip to content

create_image_builder_streaming_url

create_image_builder_streaming_url(
    *,
    config_overrides: Optional[AppStreamClientConfig] = None,
    name: Optional[String] = None,
    validity: Optional[Long] = None,
) -> CreateImageBuilderStreamingURLResult

Creates a URL to start an image builder streaming session.

Parameters:

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

    The name of the image builder.

  • validity (Optional[Long], default: None ) –

    The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 3600 seconds.

Raises:

Source code in docs_src/capo_appstream/_services/app_stream.py
def create_image_builder_streaming_url(
    self,
    *,
    config_overrides: Optional[AppStreamClientConfig] = None,
    name: Optional["capo_appstream.types.string.String"] = None,
    validity: Optional["capo_appstream.types.long.Long"] = None,
) -> "capo_appstream.types.create_image_builder_streaming_url_result.CreateImageBuilderStreamingURLResult":
    """<p>Creates a URL to start an image builder streaming session.</p>

    Args:
        name: <p>The name of the image builder.</p>
        validity: <p>The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 3600 seconds.</p>

    Raises:
        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.create_image_builder_streaming_url_request.CreateImageBuilderStreamingURLRequest]",
    ) -> OperationResponse[
        "capo_appstream.types.create_image_builder_streaming_url_result.CreateImageBuilderStreamingURLResult"
    ]:
        import capo_appstream._operations.photon_admin_proxy_service.create_image_builder_streaming_url

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateImageBuilderStreamingURL")
    )
    input_: capo_appstream.types.create_image_builder_streaming_url_request.CreateImageBuilderStreamingURLRequest = {}
    if name is not None:
        input_["name"] = name
    if validity is not None:
        input_["validity"] = validity

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