Struct aws_sdk_robomaker::input::ListRobotsInput

#[non_exhaustive]
pub struct ListRobotsInput {
    pub next_token: Option<String>,
    pub max_results: Option<i32>,
    pub filters: Option<Vec<Filter>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

next_token: Option<String>

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobots again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

max_results: Option<i32>

When this parameter is used, ListRobots only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRobots request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListRobots returns up to 200 results and a nextToken value if applicable.

filters: Option<Vec<Filter>>

Optional filters to limit results.

The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Registered or the status Available.

Implementations

impl ListRobotsInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<ListRobots, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<ListRobots>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture ListRobotsInput

impl ListRobotsInput

pub fn next_token(&self) -> Option<&str>

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobots again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

pub fn max_results(&self) -> Option<i32>

When this parameter is used, ListRobots only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRobots request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListRobots returns up to 200 results and a nextToken value if applicable.

pub fn filters(&self) -> Option<&[Filter]>

Optional filters to limit results.

The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Registered or the status Available.

Trait Implementations

impl Clone for ListRobotsInput

fn clone(&self) -> ListRobotsInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListRobotsInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<ListRobotsInput> for ListRobotsInput

fn eq(&self, other: &ListRobotsInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ListRobotsInput) -> bool

This method tests for !=.

impl StructuralPartialEq for ListRobotsInput