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

Description

Returns a list simulation job batches. You can optionally provide filters to retrieve specific simulation batch jobs.

This operation returns paginated results.

Synopsis

Creating a Request

data ListSimulationJobBatches Source #

See: newListSimulationJobBatches smart constructor.

Constructors

ListSimulationJobBatches' 

Fields

  • filters :: Maybe (NonEmpty Filter)

    Optional filters to limit results.

  • 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 ListSimulationJobBatches 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, ListSimulationJobBatches 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 ListSimulationJobBatches request with the returned nextToken value.

Instances

Instances details
Eq ListSimulationJobBatches Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobBatches

Read ListSimulationJobBatches Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobBatches

Show ListSimulationJobBatches Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobBatches

Generic ListSimulationJobBatches Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobBatches

Associated Types

type Rep ListSimulationJobBatches :: Type -> Type #

NFData ListSimulationJobBatches Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobBatches

Hashable ListSimulationJobBatches Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobBatches

ToJSON ListSimulationJobBatches Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobBatches

AWSPager ListSimulationJobBatches Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobBatches

AWSRequest ListSimulationJobBatches Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobBatches

ToHeaders ListSimulationJobBatches Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobBatches

ToPath ListSimulationJobBatches Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobBatches

ToQuery ListSimulationJobBatches Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobBatches

type Rep ListSimulationJobBatches Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobBatches

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

Defined in Amazonka.RobOMaker.ListSimulationJobBatches

newListSimulationJobBatches :: ListSimulationJobBatches Source #

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

$sel:nextToken:ListSimulationJobBatches', listSimulationJobBatches_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 ListSimulationJobBatches 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:ListSimulationJobBatches', listSimulationJobBatches_maxResults - When this parameter is used, ListSimulationJobBatches 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 ListSimulationJobBatches request with the returned nextToken value.

Request Lenses

listSimulationJobBatches_nextToken :: Lens' ListSimulationJobBatches (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 ListSimulationJobBatches 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.

listSimulationJobBatches_maxResults :: Lens' ListSimulationJobBatches (Maybe Int) Source #

When this parameter is used, ListSimulationJobBatches 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 ListSimulationJobBatches request with the returned nextToken value.

Destructuring the Response

data ListSimulationJobBatchesResponse Source #

See: newListSimulationJobBatchesResponse smart constructor.

Constructors

ListSimulationJobBatchesResponse' 

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

  • simulationJobBatchSummaries :: Maybe [SimulationJobBatchSummary]

    A list of simulation job batch summaries.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListSimulationJobBatchesResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobBatches

Read ListSimulationJobBatchesResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobBatches

Show ListSimulationJobBatchesResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobBatches

Generic ListSimulationJobBatchesResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobBatches

Associated Types

type Rep ListSimulationJobBatchesResponse :: Type -> Type #

NFData ListSimulationJobBatchesResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobBatches

type Rep ListSimulationJobBatchesResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListSimulationJobBatches

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

newListSimulationJobBatchesResponse Source #

Create a value of ListSimulationJobBatchesResponse 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:ListSimulationJobBatches', listSimulationJobBatchesResponse_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 ListSimulationJobBatches 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:simulationJobBatchSummaries:ListSimulationJobBatchesResponse', listSimulationJobBatchesResponse_simulationJobBatchSummaries - A list of simulation job batch summaries.

$sel:httpStatus:ListSimulationJobBatchesResponse', listSimulationJobBatchesResponse_httpStatus - The response's http status code.

Response Lenses

listSimulationJobBatchesResponse_nextToken :: Lens' ListSimulationJobBatchesResponse (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 ListSimulationJobBatches 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.