aws_sdk_robomaker/client/

list_simulation_applications.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListSimulationApplications`](crate::operation::list_simulation_applications::builders::ListSimulationApplicationsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_simulation_applications::builders::ListSimulationApplicationsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`version_qualifier(impl Into<String>)`](crate::operation::list_simulation_applications::builders::ListSimulationApplicationsFluentBuilder::version_qualifier) / [`set_version_qualifier(Option<String>)`](crate::operation::list_simulation_applications::builders::ListSimulationApplicationsFluentBuilder::set_version_qualifier):<br>required: **false**<br><p>The version qualifier of the simulation application.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_simulation_applications::builders::ListSimulationApplicationsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_simulation_applications::builders::ListSimulationApplicationsFluentBuilder::set_next_token):<br>required: **false**<br><p>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListSimulationApplications</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_simulation_applications::builders::ListSimulationApplicationsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_simulation_applications::builders::ListSimulationApplicationsFluentBuilder::set_max_results):<br>required: **false**<br><p>When this parameter is used, <code>ListSimulationApplications</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListSimulationApplications</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListSimulationApplications</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p><br>
    ///   - [`filters(Filter)`](crate::operation::list_simulation_applications::builders::ListSimulationApplicationsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::list_simulation_applications::builders::ListSimulationApplicationsFluentBuilder::set_filters):<br>required: **false**<br><p>Optional list of filters to limit results.</p> <p>The filter name <code>name</code> is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.</p><br>
    /// - On success, responds with [`ListSimulationApplicationsOutput`](crate::operation::list_simulation_applications::ListSimulationApplicationsOutput) with field(s):
    ///   - [`simulation_application_summaries(Option<Vec::<SimulationApplicationSummary>>)`](crate::operation::list_simulation_applications::ListSimulationApplicationsOutput::simulation_application_summaries): <p>A list of simulation application summaries that meet the criteria of the request.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_simulation_applications::ListSimulationApplicationsOutput::next_token): <p>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListSimulationApplications</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.</p>
    /// - On failure, responds with [`SdkError<ListSimulationApplicationsError>`](crate::operation::list_simulation_applications::ListSimulationApplicationsError)
    pub fn list_simulation_applications(&self) -> crate::operation::list_simulation_applications::builders::ListSimulationApplicationsFluentBuilder {
        crate::operation::list_simulation_applications::builders::ListSimulationApplicationsFluentBuilder::new(self.handle.clone())
    }
}