Skip to content

start_app async

start_app(
    simulation: SimSpaceWeaverResourceName,
    domain: SimSpaceWeaverResourceName,
    name: SimSpaceWeaverResourceName,
    *,
    config_overrides: Optional[AsyncSimSpaceWeaverClientConfig] = None,
    client_token: Optional[ClientToken] = None,
    description: Optional[Description] = None,
    launch_overrides: Optional[LaunchOverrides] = None,
) -> StartAppOutput

Starts a custom app with the configuration specified in the simulation schema.

Parameters:

Raises:

Source code in docs_src/capo_simspaceweaver/_services/async_sim_space_weaver.py
async def start_app(
    self,
    simulation: "capo_simspaceweaver.types.sim_space_weaver_resource_name.SimSpaceWeaverResourceName",
    domain: "capo_simspaceweaver.types.sim_space_weaver_resource_name.SimSpaceWeaverResourceName",
    name: "capo_simspaceweaver.types.sim_space_weaver_resource_name.SimSpaceWeaverResourceName",
    *,
    config_overrides: Optional[AsyncSimSpaceWeaverClientConfig] = None,
    client_token: Optional[
        "capo_simspaceweaver.types.client_token.ClientToken"
    ] = None,
    description: Optional[
        "capo_simspaceweaver.types.description.Description"
    ] = None,
    launch_overrides: Optional[
        "capo_simspaceweaver.types.launch_overrides.LaunchOverrides"
    ] = None,
) -> "capo_simspaceweaver.types.start_app_output.StartAppOutput":
    """<p>Starts a custom app with the configuration specified in the simulation schema.</p>

    Args:
        client_token: <p>A value that you provide to ensure that repeated calls to this API operation using the same parameters complete only once. A <code>ClientToken</code> is also known as an <i>idempotency token</i>. A <code>ClientToken</code> expires after 24 hours.</p>
        simulation: <p>The name of the simulation of the app.</p>
        domain: <p>The name of the domain of the app.</p>
        name: <p>The name of the app.</p>
        description: <p>The description of the app.</p>

    Raises:
        capo_simspaceweaver.errors.access_denied_exception.AccessDeniedException: <p/>
        capo_simspaceweaver.errors.conflict_exception.ConflictException: <p/>
        capo_simspaceweaver.errors.internal_server_exception.InternalServerException: <p/>
        capo_simspaceweaver.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p/>
        capo_simspaceweaver.errors.validation_exception.ValidationException: <p/>
        capo_simspaceweaver.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_simspaceweaver.types.start_app_input.StartAppInput]",
    ) -> AsyncOperationResponse[
        "capo_simspaceweaver.types.start_app_output.StartAppOutput"
    ]:
        import capo_simspaceweaver._operations.sim_space_weaver.start_app

        (
            output,
            http_response,
        ) = await capo_simspaceweaver._operations.sim_space_weaver.start_app.async_start_app(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_simspaceweaver.types.start_app_input.StartAppInput",
    ) -> dict[str, Any]:
        import capo_simspaceweaver.types.start_app_input

        return capo_simspaceweaver.types.start_app_input.redact_sensitive(input_)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartApp", redact_input=_redact_input)
    )
    input_: capo_simspaceweaver.types.start_app_input.StartAppInput = {
        "simulation": simulation,
        "domain": domain,
        "name": name,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if description is not None:
        input_["description"] = description
    if launch_overrides is not None:
        input_["launch_overrides"] = launch_overrides

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output