Skip to content

ListSimulationsInput

Source code in docs_src/capo_simspaceweaver/types/list_simulations_input.py 
12
13
14
15
16
17
18
class ListSimulationsInput(TypedDict, closed=True):
    max_results: NotRequired[
        "capo_simspaceweaver.types.positive_integer.PositiveInteger"
    ]
    """<p>The maximum number of simulations 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>"""

max_results instance-attribute 

max_results: NotRequired[PositiveInteger]

The maximum number of simulations 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.