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

Description

Lists world export jobs.

This operation returns paginated results.

Synopsis

Creating a Request

data ListWorldExportJobs Source #

See: newListWorldExportJobs smart constructor.

Constructors

ListWorldExportJobs' 

Fields

  • filters :: Maybe (NonEmpty Filter)

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

  • maxResults :: Maybe Int

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

Defined in Amazonka.RobOMaker.ListWorldExportJobs

ToHeaders ListWorldExportJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldExportJobs

ToPath ListWorldExportJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldExportJobs

ToQuery ListWorldExportJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldExportJobs

AWSPager ListWorldExportJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldExportJobs

AWSRequest ListWorldExportJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldExportJobs

Associated Types

type AWSResponse ListWorldExportJobs #

Generic ListWorldExportJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldExportJobs

Associated Types

type Rep ListWorldExportJobs :: Type -> Type #

Read ListWorldExportJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldExportJobs

Show ListWorldExportJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldExportJobs

NFData ListWorldExportJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldExportJobs

Methods

rnf :: ListWorldExportJobs -> () #

Eq ListWorldExportJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldExportJobs

Hashable ListWorldExportJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldExportJobs

type AWSResponse ListWorldExportJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldExportJobs

type Rep ListWorldExportJobs Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldExportJobs

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

newListWorldExportJobs :: ListWorldExportJobs Source #

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

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

ListWorldExportJobs, listWorldExportJobs_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 ListWorldExportJobs 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

listWorldExportJobs_filters :: Lens' ListWorldExportJobs (Maybe (NonEmpty Filter)) Source #

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

listWorldExportJobs_maxResults :: Lens' ListWorldExportJobs (Maybe Int) Source #

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

listWorldExportJobs_nextToken :: Lens' ListWorldExportJobs (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 ListWorldExportJobs 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 ListWorldExportJobsResponse Source #

See: newListWorldExportJobsResponse smart constructor.

Constructors

ListWorldExportJobsResponse' 

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

  • worldExportJobSummaries :: [WorldExportJobSummary]

    Summary information for world export jobs.

Instances

Instances details
Generic ListWorldExportJobsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldExportJobs

Associated Types

type Rep ListWorldExportJobsResponse :: Type -> Type #

Read ListWorldExportJobsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldExportJobs

Show ListWorldExportJobsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldExportJobs

NFData ListWorldExportJobsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldExportJobs

Eq ListWorldExportJobsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldExportJobs

type Rep ListWorldExportJobsResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldExportJobs

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

newListWorldExportJobsResponse Source #

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

ListWorldExportJobs, listWorldExportJobsResponse_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 ListWorldExportJobsRequest 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:ListWorldExportJobsResponse', listWorldExportJobsResponse_httpStatus - The response's http status code.

$sel:worldExportJobSummaries:ListWorldExportJobsResponse', listWorldExportJobsResponse_worldExportJobSummaries - Summary information for world export jobs.

Response Lenses

listWorldExportJobsResponse_nextToken :: Lens' ListWorldExportJobsResponse (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 ListWorldExportJobsRequest 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.