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

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

data ListSimulationJobs Source #

See: newListSimulationJobs smart constructor.

Constructors

ListSimulationJobs' 

Fields

  • filters :: Maybe (NonEmpty Filter)

    Optional filters to limit results.

    The filter names status and simulationApplicationName and robotApplicationName 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 Preparing or the status Running.

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

Instances

Instances details
Eq ListSimulationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobs

Read ListSimulationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobs

Show ListSimulationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobs

Generic ListSimulationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobs

Associated Types

type Rep ListSimulationJobs :: Type -> Type #

NFData ListSimulationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobs

Methods

rnf :: ListSimulationJobs -> () #

Hashable ListSimulationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobs

ToJSON ListSimulationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobs

AWSPager ListSimulationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobs

AWSRequest ListSimulationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobs

Associated Types

type AWSResponse ListSimulationJobs #

ToHeaders ListSimulationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobs

ToPath ListSimulationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobs

ToQuery ListSimulationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobs

type Rep ListSimulationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobs

type Rep ListSimulationJobs = D1 ('MetaData "ListSimulationJobs" "Amazonka.RobOMaker.ListSimulationJobs" "libZSservicesZSamazonka-robomakerZSamazonka-robomaker" 'False) (C1 ('MetaCons "ListSimulationJobs'" '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 ListSimulationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobs

newListSimulationJobs :: ListSimulationJobs Source #

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

The filter names status and simulationApplicationName and robotApplicationName 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 Preparing or the status Running.

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

Request Lenses

listSimulationJobs_filters :: Lens' ListSimulationJobs (Maybe (NonEmpty Filter)) Source #

Optional filters to limit results.

The filter names status and simulationApplicationName and robotApplicationName 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 Preparing or the status Running.

listSimulationJobs_nextToken :: Lens' ListSimulationJobs (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 ListSimulationJobs 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.

listSimulationJobs_maxResults :: Lens' ListSimulationJobs (Maybe Int) Source #

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

Destructuring the Response

data ListSimulationJobsResponse Source #

See: newListSimulationJobsResponse smart constructor.

Constructors

ListSimulationJobsResponse' 

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

  • simulationJobSummaries :: [SimulationJobSummary]

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

Instances

Instances details
Eq ListSimulationJobsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobs

Read ListSimulationJobsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobs

Show ListSimulationJobsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobs

Generic ListSimulationJobsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobs

Associated Types

type Rep ListSimulationJobsResponse :: Type -> Type #

NFData ListSimulationJobsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobs

type Rep ListSimulationJobsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobs

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

newListSimulationJobsResponse Source #

Create a value of ListSimulationJobsResponse 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:nextToken:ListSimulationJobs', listSimulationJobsResponse_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 ListSimulationJobs 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:ListSimulationJobsResponse', listSimulationJobsResponse_httpStatus - The response's http status code.

$sel:simulationJobSummaries:ListSimulationJobsResponse', listSimulationJobsResponse_simulationJobSummaries - A list of simulation job summaries that meet the criteria of the request.

Response Lenses

listSimulationJobsResponse_nextToken :: Lens' ListSimulationJobsResponse (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 ListSimulationJobs 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.

listSimulationJobsResponse_simulationJobSummaries :: Lens' ListSimulationJobsResponse [SimulationJobSummary] Source #

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