Skip to content

ListAppsInput

Source code in docs_src/capo_simspaceweaver/types/list_apps_input.py
class ListAppsInput(TypedDict, closed=True):
    simulation: "capo_simspaceweaver.types.sim_space_weaver_resource_name.SimSpaceWeaverResourceName"
    """<p>The name of the simulation that you want to list apps for.</p>"""
    domain: NotRequired[
        "capo_simspaceweaver.types.sim_space_weaver_resource_name.SimSpaceWeaverResourceName"
    ]
    """<p>The name of the domain that you want to list apps for.</p>"""
    max_results: NotRequired[
        "capo_simspaceweaver.types.positive_integer.PositiveInteger"
    ]
    """<p>The maximum number of apps to list.</p>"""
    next_token: NotRequired["capo_simspaceweaver.types.optional_string.OptionalString"]
    """<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>"""

domain instance-attribute

domain: NotRequired[SimSpaceWeaverResourceName]

The name of the domain that you want to list apps for.

max_results instance-attribute

max_results: NotRequired[PositiveInteger]

The maximum number of apps to list.

next_token instance-attribute

next_token: NotRequired[OptionalString]

If SimSpace Weaver returns nextToken, then there are more results available. The value of nextToken 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 nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

simulation instance-attribute

The name of the simulation that you want to list apps for.