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

Description

Lists world generator jobs.

This operation returns paginated results.

Synopsis

Creating a Request

data ListWorldGenerationJobs Source #

See: newListWorldGenerationJobs smart constructor.

Constructors

ListWorldGenerationJobs' 

Fields

  • filters :: Maybe (NonEmpty Filter)

    Optional filters to limit results. You can use status and templateId.

  • maxResults :: Maybe Int

    When this parameter is used, ListWorldGeneratorJobs 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 ListWorldGeneratorJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorldGeneratorJobs 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 ListWorldGenerationJobsRequest 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

Instances details
ToJSON ListWorldGenerationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldGenerationJobs

ToHeaders ListWorldGenerationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldGenerationJobs

ToPath ListWorldGenerationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldGenerationJobs

ToQuery ListWorldGenerationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldGenerationJobs

AWSPager ListWorldGenerationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldGenerationJobs

AWSRequest ListWorldGenerationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldGenerationJobs

Generic ListWorldGenerationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldGenerationJobs

Associated Types

type Rep ListWorldGenerationJobs :: Type -> Type #

Read ListWorldGenerationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldGenerationJobs

Show ListWorldGenerationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldGenerationJobs

NFData ListWorldGenerationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldGenerationJobs

Methods

rnf :: ListWorldGenerationJobs -> () #

Eq ListWorldGenerationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldGenerationJobs

Hashable ListWorldGenerationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldGenerationJobs

type AWSResponse ListWorldGenerationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldGenerationJobs

type Rep ListWorldGenerationJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldGenerationJobs

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

newListWorldGenerationJobs :: ListWorldGenerationJobs Source #

Create a value of ListWorldGenerationJobs 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:ListWorldGenerationJobs', listWorldGenerationJobs_filters - Optional filters to limit results. You can use status and templateId.

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

ListWorldGenerationJobs, listWorldGenerationJobs_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 ListWorldGenerationJobsRequest 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

listWorldGenerationJobs_filters :: Lens' ListWorldGenerationJobs (Maybe (NonEmpty Filter)) Source #

Optional filters to limit results. You can use status and templateId.

listWorldGenerationJobs_maxResults :: Lens' ListWorldGenerationJobs (Maybe Int) Source #

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

listWorldGenerationJobs_nextToken :: Lens' ListWorldGenerationJobs (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 ListWorldGenerationJobsRequest 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 ListWorldGenerationJobsResponse Source #

See: newListWorldGenerationJobsResponse smart constructor.

Constructors

ListWorldGenerationJobsResponse' 

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

  • worldGenerationJobSummaries :: [WorldGenerationJobSummary]

    Summary information for world generator jobs.

Instances

Instances details
Generic ListWorldGenerationJobsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldGenerationJobs

Associated Types

type Rep ListWorldGenerationJobsResponse :: Type -> Type #

Read ListWorldGenerationJobsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldGenerationJobs

Show ListWorldGenerationJobsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldGenerationJobs

NFData ListWorldGenerationJobsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldGenerationJobs

Eq ListWorldGenerationJobsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldGenerationJobs

type Rep ListWorldGenerationJobsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldGenerationJobs

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

newListWorldGenerationJobsResponse Source #

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

ListWorldGenerationJobs, listWorldGenerationJobsResponse_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 ListWorldGeneratorJobsRequest 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:ListWorldGenerationJobsResponse', listWorldGenerationJobsResponse_httpStatus - The response's http status code.

$sel:worldGenerationJobSummaries:ListWorldGenerationJobsResponse', listWorldGenerationJobsResponse_worldGenerationJobSummaries - Summary information for world generator jobs.

Response Lenses

listWorldGenerationJobsResponse_nextToken :: Lens' ListWorldGenerationJobsResponse (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 ListWorldGeneratorJobsRequest 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.