Skip to content

start_image_builder 

start_image_builder(
    *,
    config_overrides: Optional[AppStreamClientConfig] = None,
    name: Optional[String] = None,
    appstream_agent_version: Optional[AppstreamAgentVersion] = None,
) -> StartImageBuilderResult

Starts the specified image builder.

Parameters:

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

    The name of the image builder.

  • appstream_agent_version (Optional[AppstreamAgentVersion], default: None ) –

    The version of the WorkSpaces Applications agent to use for this image builder. To use the latest version of the WorkSpaces Applications agent, specify [LATEST].

Raises:

Source code in docs_src/capo_appstream/_services/app_stream.py 
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
def start_image_builder(
    self,
    *,
    config_overrides: Optional[AppStreamClientConfig] = None,
    name: Optional["capo_appstream.types.string.String"] = None,
    appstream_agent_version: Optional[
        "capo_appstream.types.appstream_agent_version.AppstreamAgentVersion"
    ] = None,
) -> "capo_appstream.types.start_image_builder_result.StartImageBuilderResult":
    """<p>Starts the specified image builder.</p>

    Args:
        name: <p>The name of the image builder.</p>
        appstream_agent_version: <p>The version of the WorkSpaces Applications agent to use for this image builder. To use the latest version of the WorkSpaces Applications agent, specify [LATEST]. </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.incompatible_image_exception.IncompatibleImageException: <p>The image can't be updated because it's not compatible for updates.</p>
        capo_appstream.errors.invalid_account_status_exception.InvalidAccountStatusException: <p>The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support. </p>
        capo_appstream.errors.resource_not_available_exception.ResourceNotAvailableException: <p>The specified resource exists and is not in use, but isn't available.</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.start_image_builder_request.StartImageBuilderRequest]",
    ) -> OperationResponse[
        "capo_appstream.types.start_image_builder_result.StartImageBuilderResult"
    ]:
        import capo_appstream._operations.photon_admin_proxy_service.start_image_builder

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartImageBuilder")
    )
    input_: capo_appstream.types.start_image_builder_request.StartImageBuilderRequest = {}
    if name is not None:
        input_["name"] = name
    if appstream_agent_version is not None:
        input_["appstream_agent_version"] = appstream_agent_version

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