Struct aws_sdk_robomaker::client::fluent_builders::ListRobots

pub struct ListRobots { /* private fields */ }

Fluent builder constructing a request to ListRobots.

Returns a list of robots. You can optionally provide filters to retrieve specific robots.

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

Implementations

impl ListRobots

pub async fn send(self) -> Result<ListRobotsOutput, SdkError<ListRobotsError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> ListRobotsPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn next_token(self, input: impl Into<String>) -> Self

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 set_next_token(self, input: Option<String>) -> Self

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, input: i32) -> Self

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 set_max_results(self, input: Option<i32>) -> Self

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, input: Filter) -> Self

Appends an item to filters.

To override the contents of this collection use set_filters.

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.

pub fn set_filters(self, input: Option<Vec<Filter>>) -> Self

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 ListRobots

fn clone(&self) -> ListRobots

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListRobots

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

Formats the value using the given formatter.