Skip to content

describe_app

describe_app(
    simulation: SimSpaceWeaverResourceName,
    domain: SimSpaceWeaverResourceName,
    app: SimSpaceWeaverLongResourceName,
    *,
    config_overrides: Optional[SimSpaceWeaverClientConfig] = None,
) -> DescribeAppOutput

Returns the state of the given custom app.

Parameters:

Raises:

Source code in docs_src/capo_simspaceweaver/_services/sim_space_weaver.py
def describe_app(
    self,
    simulation: "capo_simspaceweaver.types.sim_space_weaver_resource_name.SimSpaceWeaverResourceName",
    domain: "capo_simspaceweaver.types.sim_space_weaver_resource_name.SimSpaceWeaverResourceName",
    app: "capo_simspaceweaver.types.sim_space_weaver_long_resource_name.SimSpaceWeaverLongResourceName",
    *,
    config_overrides: Optional[SimSpaceWeaverClientConfig] = None,
) -> "capo_simspaceweaver.types.describe_app_output.DescribeAppOutput":
    """<p>Returns the state of the given custom app.</p>

    Args:
        simulation: <p>The name of the simulation of the app.</p>
        domain: <p>The name of the domain of the app.</p>
        app: <p>The name of the app.</p>

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

    def _handler(
        req: "OperationRequest[capo_simspaceweaver.types.describe_app_input.DescribeAppInput]",
    ) -> OperationResponse[
        "capo_simspaceweaver.types.describe_app_output.DescribeAppOutput"
    ]:
        import capo_simspaceweaver._operations.sim_space_weaver.describe_app

        output, http_response = (
            capo_simspaceweaver._operations.sim_space_weaver.describe_app.describe_app(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeApp")
    )
    input_: capo_simspaceweaver.types.describe_app_input.DescribeAppInput = {
        "simulation": simulation,
        "domain": domain,
        "app": app,
    }

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