list_simulations `async` ¶

list_simulations(
    *,
    config_overrides: Optional[AsyncSimSpaceWeaverClientConfig] = None,
    max_results: Optional[PositiveInteger] = None,
    next_token: Optional[OptionalString] = None,
) -> ListSimulationsOutput

Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.

Parameters:

max_results (Optional[PositiveInteger], default: None ) –

The maximum number of simulations to list.
next_token (Optional[OptionalString], default: None ) –

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.

Raises:

AccessDeniedException –
InternalServerException –
ValidationException –
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_simspaceweaver/_services/async_sim_space_weaver.py

async def list_simulations(
    self,
    *,
    config_overrides: Optional[AsyncSimSpaceWeaverClientConfig] = 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_simulations_output.ListSimulationsOutput":
    """<p>Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.</p>

    Args:
        max_results: <p>The maximum number of simulations 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.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.list_simulations_input.ListSimulationsInput]",
    ) -> AsyncOperationResponse[
        "capo_simspaceweaver.types.list_simulations_output.ListSimulationsOutput"
    ]:
        import capo_simspaceweaver._operations.sim_space_weaver.list_simulations

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListSimulations")
    )
    input_: capo_simspaceweaver.types.list_simulations_input.ListSimulationsInput = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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

list_simulations async ¶

list_simulations `async` ¶