amazonka-robomaker-2.0: Amazon RoboMaker SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.RobOMaker.ListRobotApplications

Description

Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.

This operation returns paginated results.

Synopsis

Creating a Request

data ListRobotApplications Source #

See: newListRobotApplications smart constructor.

Constructors

ListRobotApplications' 

Fields

  • filters :: Maybe (NonEmpty Filter)

    Optional filters to limit results.

    The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.

  • maxResults :: Maybe Int

    When this parameter is used, ListRobotApplications 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 ListRobotApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListRobotApplications returns up to 100 results and a nextToken value if applicable.

  • 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 ListRobotApplications 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.

  • versionQualifier :: Maybe Text

    The version qualifier of the robot application.

Instances

Instances details
ToJSON ListRobotApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobotApplications

ToHeaders ListRobotApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobotApplications

ToPath ListRobotApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobotApplications

ToQuery ListRobotApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobotApplications

AWSPager ListRobotApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobotApplications

AWSRequest ListRobotApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobotApplications

Associated Types

type AWSResponse ListRobotApplications #

Generic ListRobotApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobotApplications

Associated Types

type Rep ListRobotApplications :: Type -> Type #

Read ListRobotApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobotApplications

Show ListRobotApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobotApplications

NFData ListRobotApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobotApplications

Methods

rnf :: ListRobotApplications -> () #

Eq ListRobotApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobotApplications

Hashable ListRobotApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobotApplications

type AWSResponse ListRobotApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobotApplications

type Rep ListRobotApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobotApplications

type Rep ListRobotApplications = D1 ('MetaData "ListRobotApplications" "Amazonka.RobOMaker.ListRobotApplications" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "ListRobotApplications'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Filter))) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "versionQualifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListRobotApplications :: ListRobotApplications Source #

Create a value of ListRobotApplications 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:ListRobotApplications', listRobotApplications_filters - Optional filters to limit results.

The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.

$sel:maxResults:ListRobotApplications', listRobotApplications_maxResults - When this parameter is used, ListRobotApplications 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 ListRobotApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListRobotApplications returns up to 100 results and a nextToken value if applicable.

ListRobotApplications, listRobotApplications_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 ListRobotApplications 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:versionQualifier:ListRobotApplications', listRobotApplications_versionQualifier - The version qualifier of the robot application.

Request Lenses

listRobotApplications_filters :: Lens' ListRobotApplications (Maybe (NonEmpty Filter)) Source #

Optional filters to limit results.

The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.

listRobotApplications_maxResults :: Lens' ListRobotApplications (Maybe Int) Source #

When this parameter is used, ListRobotApplications 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 ListRobotApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListRobotApplications returns up to 100 results and a nextToken value if applicable.

listRobotApplications_nextToken :: Lens' ListRobotApplications (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 ListRobotApplications 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.

listRobotApplications_versionQualifier :: Lens' ListRobotApplications (Maybe Text) Source #

The version qualifier of the robot application.

Destructuring the Response

data ListRobotApplicationsResponse Source #

See: newListRobotApplicationsResponse smart constructor.

Constructors

ListRobotApplicationsResponse' 

Fields

  • 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 ListRobotApplications 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.

  • robotApplicationSummaries :: Maybe [RobotApplicationSummary]

    A list of robot application summaries that meet the criteria of the request.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListRobotApplicationsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobotApplications

Associated Types

type Rep ListRobotApplicationsResponse :: Type -> Type #

Read ListRobotApplicationsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobotApplications

Show ListRobotApplicationsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobotApplications

NFData ListRobotApplicationsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobotApplications

Eq ListRobotApplicationsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobotApplications

type Rep ListRobotApplicationsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListRobotApplications

type Rep ListRobotApplicationsResponse = D1 ('MetaData "ListRobotApplicationsResponse" "Amazonka.RobOMaker.ListRobotApplications" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "ListRobotApplicationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "robotApplicationSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RobotApplicationSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListRobotApplicationsResponse Source #

Create a value of ListRobotApplicationsResponse 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:

ListRobotApplications, listRobotApplicationsResponse_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 ListRobotApplications 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:robotApplicationSummaries:ListRobotApplicationsResponse', listRobotApplicationsResponse_robotApplicationSummaries - A list of robot application summaries that meet the criteria of the request.

$sel:httpStatus:ListRobotApplicationsResponse', listRobotApplicationsResponse_httpStatus - The response's http status code.

Response Lenses

listRobotApplicationsResponse_nextToken :: Lens' ListRobotApplicationsResponse (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 ListRobotApplications 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.

listRobotApplicationsResponse_robotApplicationSummaries :: Lens' ListRobotApplicationsResponse (Maybe [RobotApplicationSummary]) Source #

A list of robot application summaries that meet the criteria of the request.