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.ListSimulationApplications

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

data ListSimulationApplications Source #

See: newListSimulationApplications smart constructor.

Constructors

ListSimulationApplications' 

Fields

  • filters :: Maybe (NonEmpty Filter)

    Optional list of 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, ListSimulationApplications 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 ListSimulationApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListSimulationApplications 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 ListSimulationApplications 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 simulation application.

Instances

Instances details
ToJSON ListSimulationApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationApplications

ToHeaders ListSimulationApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationApplications

ToPath ListSimulationApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationApplications

ToQuery ListSimulationApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationApplications

AWSPager ListSimulationApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationApplications

AWSRequest ListSimulationApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationApplications

Generic ListSimulationApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationApplications

Associated Types

type Rep ListSimulationApplications :: Type -> Type #

Read ListSimulationApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationApplications

Show ListSimulationApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationApplications

NFData ListSimulationApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationApplications

Eq ListSimulationApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationApplications

Hashable ListSimulationApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationApplications

type AWSResponse ListSimulationApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationApplications

type Rep ListSimulationApplications Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationApplications

type Rep ListSimulationApplications = D1 ('MetaData "ListSimulationApplications" "Amazonka.RobOMaker.ListSimulationApplications" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "ListSimulationApplications'" '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)))))

newListSimulationApplications :: ListSimulationApplications Source #

Create a value of ListSimulationApplications 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:ListSimulationApplications', listSimulationApplications_filters - Optional list of 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:ListSimulationApplications', listSimulationApplications_maxResults - When this parameter is used, ListSimulationApplications 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 ListSimulationApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListSimulationApplications returns up to 100 results and a nextToken value if applicable.

ListSimulationApplications, listSimulationApplications_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 ListSimulationApplications 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:ListSimulationApplications', listSimulationApplications_versionQualifier - The version qualifier of the simulation application.

Request Lenses

listSimulationApplications_filters :: Lens' ListSimulationApplications (Maybe (NonEmpty Filter)) Source #

Optional list of 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.

listSimulationApplications_maxResults :: Lens' ListSimulationApplications (Maybe Int) Source #

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

listSimulationApplications_nextToken :: Lens' ListSimulationApplications (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 ListSimulationApplications 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.

listSimulationApplications_versionQualifier :: Lens' ListSimulationApplications (Maybe Text) Source #

The version qualifier of the simulation application.

Destructuring the Response

data ListSimulationApplicationsResponse Source #

Constructors

ListSimulationApplicationsResponse' 

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 ListSimulationApplications 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.

  • simulationApplicationSummaries :: Maybe [SimulationApplicationSummary]

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListSimulationApplicationsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationApplications

Associated Types

type Rep ListSimulationApplicationsResponse :: Type -> Type #

Read ListSimulationApplicationsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationApplications

Show ListSimulationApplicationsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationApplications

NFData ListSimulationApplicationsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationApplications

Eq ListSimulationApplicationsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationApplications

type Rep ListSimulationApplicationsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationApplications

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

newListSimulationApplicationsResponse Source #

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

ListSimulationApplications, listSimulationApplicationsResponse_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 ListSimulationApplications 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:simulationApplicationSummaries:ListSimulationApplicationsResponse', listSimulationApplicationsResponse_simulationApplicationSummaries - A list of simulation application summaries that meet the criteria of the request.

$sel:httpStatus:ListSimulationApplicationsResponse', listSimulationApplicationsResponse_httpStatus - The response's http status code.

Response Lenses

listSimulationApplicationsResponse_nextToken :: Lens' ListSimulationApplicationsResponse (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 ListSimulationApplications 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.