libZSservicesZSamazonka-robomakerZSamazonka-robomaker
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.RobOMaker.ListRobots

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

data ListRobots Source #

See: newListRobots smart constructor.

Constructors

ListRobots' 

Fields

  • filters :: Maybe (NonEmpty 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.

  • nextToken :: Maybe Text

    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.

  • maxResults :: Maybe Int

    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.

Instances

Instances details
Eq ListRobots Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobots

Read ListRobots Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobots

Show ListRobots Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobots

Generic ListRobots Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobots

Associated Types

type Rep ListRobots :: Type -> Type #

NFData ListRobots Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobots

Methods

rnf :: ListRobots -> () #

Hashable ListRobots Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobots

ToJSON ListRobots Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobots

AWSPager ListRobots Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobots

AWSRequest ListRobots Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobots

Associated Types

type AWSResponse ListRobots #

ToHeaders ListRobots Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobots

Methods

toHeaders :: ListRobots -> [Header] #

ToPath ListRobots Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobots

ToQuery ListRobots Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobots

type Rep ListRobots Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobots

type Rep ListRobots = D1 ('MetaData "ListRobots" "Amazonka.RobOMaker.ListRobots" "libZSservicesZSamazonka-robomakerZSamazonka-robomaker" 'False) (C1 ('MetaCons "ListRobots'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Filter))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))
type AWSResponse ListRobots Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobots

newListRobots :: ListRobots Source #

Create a value of ListRobots with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:filters:ListRobots', listRobots_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.

$sel:nextToken:ListRobots', listRobots_nextToken - 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.

$sel:maxResults:ListRobots', listRobots_maxResults - 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.

Request Lenses

listRobots_filters :: Lens' ListRobots (Maybe (NonEmpty Filter)) Source #

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.

listRobots_nextToken :: Lens' ListRobots (Maybe Text) Source #

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.

listRobots_maxResults :: Lens' ListRobots (Maybe Int) Source #

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.

Destructuring the Response

data ListRobotsResponse Source #

See: newListRobotsResponse smart constructor.

Constructors

ListRobotsResponse' 

Fields

  • robots :: Maybe [Robot]

    A list of robots that meet the criteria of the request.

  • nextToken :: Maybe Text

    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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListRobotsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobots

Read ListRobotsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobots

Show ListRobotsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobots

Generic ListRobotsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobots

Associated Types

type Rep ListRobotsResponse :: Type -> Type #

NFData ListRobotsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobots

Methods

rnf :: ListRobotsResponse -> () #

type Rep ListRobotsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobots

type Rep ListRobotsResponse = D1 ('MetaData "ListRobotsResponse" "Amazonka.RobOMaker.ListRobots" "libZSservicesZSamazonka-robomakerZSamazonka-robomaker" 'False) (C1 ('MetaCons "ListRobotsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "robots") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Robot])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListRobotsResponse Source #

Create a value of ListRobotsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:robots:ListRobotsResponse', listRobotsResponse_robots - A list of robots that meet the criteria of the request.

$sel:nextToken:ListRobots', listRobotsResponse_nextToken - 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.

$sel:httpStatus:ListRobotsResponse', listRobotsResponse_httpStatus - The response's http status code.

Response Lenses

listRobotsResponse_robots :: Lens' ListRobotsResponse (Maybe [Robot]) Source #

A list of robots that meet the criteria of the request.

listRobotsResponse_nextToken :: Lens' ListRobotsResponse (Maybe Text) Source #

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.