Amazonka.RobOMaker.ListSimulationJobs

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

This operation returns paginated results.

Creating a Request

data ListSimulationJobs

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.

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

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

Instances

ToJSON ListSimulationJobs

Defined in Amazonka.RobOMaker.ListSimulationJobs

Methods

toJSON :: ListSimulationJobs -> Value

toEncoding :: ListSimulationJobs -> Encoding

toJSONList :: [ListSimulationJobs] -> Value

toEncodingList :: [ListSimulationJobs] -> Encoding

ToHeaders ListSimulationJobs

Defined in Amazonka.RobOMaker.ListSimulationJobs

Methods

toHeaders :: ListSimulationJobs -> [Header]

ToPath ListSimulationJobs

Defined in Amazonka.RobOMaker.ListSimulationJobs

Methods

toPath :: ListSimulationJobs -> ByteString

ToQuery ListSimulationJobs

Defined in Amazonka.RobOMaker.ListSimulationJobs

Methods

toQuery :: ListSimulationJobs -> QueryString

AWSPager ListSimulationJobs

Defined in Amazonka.RobOMaker.ListSimulationJobs

Methods

page :: ListSimulationJobs -> AWSResponse ListSimulationJobs -> Maybe ListSimulationJobs

AWSRequest ListSimulationJobs

Defined in Amazonka.RobOMaker.ListSimulationJobs

Associated Types

type AWSResponse ListSimulationJobs

Methods

request :: (Service -> Service) -> ListSimulationJobs -> Request ListSimulationJobs

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListSimulationJobs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListSimulationJobs)))

Generic ListSimulationJobs

Defined in Amazonka.RobOMaker.ListSimulationJobs

Associated Types

type Rep ListSimulationJobs :: Type -> Type

Methods

from :: ListSimulationJobs -> Rep ListSimulationJobs x

to :: Rep ListSimulationJobs x -> ListSimulationJobs

Read ListSimulationJobs

Defined in Amazonka.RobOMaker.ListSimulationJobs

Methods

readsPrec :: Int -> ReadS ListSimulationJobs

readList :: ReadS [ListSimulationJobs]

readPrec :: ReadPrec ListSimulationJobs

readListPrec :: ReadPrec [ListSimulationJobs]

Show ListSimulationJobs

Defined in Amazonka.RobOMaker.ListSimulationJobs

Methods

showsPrec :: Int -> ListSimulationJobs -> ShowS

show :: ListSimulationJobs -> String

showList :: [ListSimulationJobs] -> ShowS

NFData ListSimulationJobs

Defined in Amazonka.RobOMaker.ListSimulationJobs

Methods

rnf :: ListSimulationJobs -> ()

Eq ListSimulationJobs

Defined in Amazonka.RobOMaker.ListSimulationJobs

Methods

(==) :: ListSimulationJobs -> ListSimulationJobs -> Bool

(/=) :: ListSimulationJobs -> ListSimulationJobs -> Bool

Hashable ListSimulationJobs

Defined in Amazonka.RobOMaker.ListSimulationJobs

Methods

hashWithSalt :: Int -> ListSimulationJobs -> Int

hash :: ListSimulationJobs -> Int

type AWSResponse ListSimulationJobs

Defined in Amazonka.RobOMaker.ListSimulationJobs

type AWSResponse ListSimulationJobs = ListSimulationJobsResponse

type Rep ListSimulationJobs

Defined in Amazonka.RobOMaker.ListSimulationJobs

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

newListSimulationJobs :: ListSimulationJobs

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

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.

Request Lenses

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

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

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

Destructuring the Response

data ListSimulationJobsResponse

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

Generic ListSimulationJobsResponse

Defined in Amazonka.RobOMaker.ListSimulationJobs

Associated Types

type Rep ListSimulationJobsResponse :: Type -> Type

Methods

from :: ListSimulationJobsResponse -> Rep ListSimulationJobsResponse x

to :: Rep ListSimulationJobsResponse x -> ListSimulationJobsResponse

Read ListSimulationJobsResponse

Defined in Amazonka.RobOMaker.ListSimulationJobs

Methods

readsPrec :: Int -> ReadS ListSimulationJobsResponse

readList :: ReadS [ListSimulationJobsResponse]

readPrec :: ReadPrec ListSimulationJobsResponse

readListPrec :: ReadPrec [ListSimulationJobsResponse]

Show ListSimulationJobsResponse

Defined in Amazonka.RobOMaker.ListSimulationJobs

Methods

showsPrec :: Int -> ListSimulationJobsResponse -> ShowS

show :: ListSimulationJobsResponse -> String

showList :: [ListSimulationJobsResponse] -> ShowS

NFData ListSimulationJobsResponse

Defined in Amazonka.RobOMaker.ListSimulationJobs

Methods

rnf :: ListSimulationJobsResponse -> ()

Eq ListSimulationJobsResponse

Defined in Amazonka.RobOMaker.ListSimulationJobs

Methods

(==) :: ListSimulationJobsResponse -> ListSimulationJobsResponse -> Bool

(/=) :: ListSimulationJobsResponse -> ListSimulationJobsResponse -> Bool

type Rep ListSimulationJobsResponse

Defined in Amazonka.RobOMaker.ListSimulationJobs

type Rep ListSimulationJobsResponse = D1 ('MetaData "ListSimulationJobsResponse" "Amazonka.RobOMaker.ListSimulationJobs" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" '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

Arguments

:: Int

$sel:httpStatus:ListSimulationJobsResponse'

-> ListSimulationJobsResponse

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:

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)

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_httpStatus :: Lens' ListSimulationJobsResponse Int

The response's http status code.

listSimulationJobsResponse_simulationJobSummaries :: Lens' ListSimulationJobsResponse [SimulationJobSummary]

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