list_apps ¶

def list_apps(
    self,
    simulation: "capo_simspaceweaver.types.sim_space_weaver_resource_name.SimSpaceWeaverResourceName",
    *,
    config_overrides: Optional[SimSpaceWeaverClientConfig] = None,
    domain: Optional[
        "capo_simspaceweaver.types.sim_space_weaver_resource_name.SimSpaceWeaverResourceName"
    ] = None,
    max_results: Optional[
        "capo_simspaceweaver.types.positive_integer.PositiveInteger"
    ] = None,
    next_token: Optional[
        "capo_simspaceweaver.types.optional_string.OptionalString"
    ] = None,
) -> "capo_simspaceweaver.types.list_apps_output.ListAppsOutput":
    """<p>Lists all custom apps or service apps for the given simulation and domain.</p>

    Args:
        simulation: <p>The name of the simulation that you want to list apps for.</p>
        domain: <p>The name of the domain that you want to list apps for.</p>
        max_results: <p>The maximum number of apps to list.</p>
        next_token: <p>If SimSpace Weaver returns <code>nextToken</code>, then there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an <i>HTTP 400 ValidationException</i> error.</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.list_apps_input.ListAppsInput]",
    ) -> OperationResponse[
        "capo_simspaceweaver.types.list_apps_output.ListAppsOutput"
    ]:
        import capo_simspaceweaver._operations.sim_space_weaver.list_apps

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListApps")
    )
    input_: capo_simspaceweaver.types.list_apps_input.ListAppsInput = {
        "simulation": simulation
    }
    if domain is not None:
        input_["domain"] = domain
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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