Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.RobOMaker.ListWorldExportJobs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists world export jobs.

This operation returns paginated results.

Synopsis

data ListWorldExportJobs = ListWorldExportJobs' {
- filters :: Maybe (NonEmpty Filter)
- maxResults :: Maybe Int
- nextToken :: Maybe Text
}
newListWorldExportJobs :: ListWorldExportJobs
listWorldExportJobs_filters :: Lens' ListWorldExportJobs (Maybe (NonEmpty Filter))
listWorldExportJobs_maxResults :: Lens' ListWorldExportJobs (Maybe Int)
listWorldExportJobs_nextToken :: Lens' ListWorldExportJobs (Maybe Text)
data ListWorldExportJobsResponse = ListWorldExportJobsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- worldExportJobSummaries :: [WorldExportJobSummary]
}
newListWorldExportJobsResponse :: Int -> ListWorldExportJobsResponse
listWorldExportJobsResponse_nextToken :: Lens' ListWorldExportJobsResponse (Maybe Text)
listWorldExportJobsResponse_httpStatus :: Lens' ListWorldExportJobsResponse Int
listWorldExportJobsResponse_worldExportJobSummaries :: Lens' ListWorldExportJobsResponse [WorldExportJobSummary]

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 Methods toJSON :: ListWorldExportJobs -> Value # toEncoding :: ListWorldExportJobs -> Encoding # toJSONList :: [ListWorldExportJobs] -> Value # toEncodingList :: [ListWorldExportJobs] -> Encoding #
ToHeaders ListWorldExportJobs Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldExportJobs Methods toHeaders :: ListWorldExportJobs -> [Header] #
ToPath ListWorldExportJobs Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldExportJobs Methods toPath :: ListWorldExportJobs -> ByteString #
ToQuery ListWorldExportJobs Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldExportJobs Methods toQuery :: ListWorldExportJobs -> QueryString #
AWSPager ListWorldExportJobs Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldExportJobs Methods page :: ListWorldExportJobs -> AWSResponse ListWorldExportJobs -> Maybe ListWorldExportJobs #
AWSRequest ListWorldExportJobs Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldExportJobs Associated Types type AWSResponse ListWorldExportJobs # Methods request :: (Service -> Service) -> ListWorldExportJobs -> Request ListWorldExportJobs # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListWorldExportJobs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListWorldExportJobs))) #
Generic ListWorldExportJobs Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldExportJobs Associated Types type Rep ListWorldExportJobs :: Type -> Type # Methods from :: ListWorldExportJobs -> Rep ListWorldExportJobs x # to :: Rep ListWorldExportJobs x -> ListWorldExportJobs #
Read ListWorldExportJobs Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldExportJobs Methods readsPrec :: Int -> ReadS ListWorldExportJobs # readList :: ReadS [ListWorldExportJobs] # readPrec :: ReadPrec ListWorldExportJobs # readListPrec :: ReadPrec [ListWorldExportJobs] #
Show ListWorldExportJobs Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldExportJobs Methods showsPrec :: Int -> ListWorldExportJobs -> ShowS # show :: ListWorldExportJobs -> String # showList :: [ListWorldExportJobs] -> ShowS #
NFData ListWorldExportJobs Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldExportJobs Methods rnf :: ListWorldExportJobs -> () #
Eq ListWorldExportJobs Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldExportJobs Methods (==) :: ListWorldExportJobs -> ListWorldExportJobs -> Bool # (/=) :: ListWorldExportJobs -> ListWorldExportJobs -> Bool #
Hashable ListWorldExportJobs Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldExportJobs Methods hashWithSalt :: Int -> ListWorldExportJobs -> Int # hash :: ListWorldExportJobs -> Int #
type AWSResponse ListWorldExportJobs Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldExportJobs type AWSResponse ListWorldExportJobs = ListWorldExportJobsResponse
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 # Methods from :: ListWorldExportJobsResponse -> Rep ListWorldExportJobsResponse x # to :: Rep ListWorldExportJobsResponse x -> ListWorldExportJobsResponse #
Read ListWorldExportJobsResponse Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldExportJobs Methods readsPrec :: Int -> ReadS ListWorldExportJobsResponse # readList :: ReadS [ListWorldExportJobsResponse] # readPrec :: ReadPrec ListWorldExportJobsResponse # readListPrec :: ReadPrec [ListWorldExportJobsResponse] #
Show ListWorldExportJobsResponse Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldExportJobs Methods showsPrec :: Int -> ListWorldExportJobsResponse -> ShowS # show :: ListWorldExportJobsResponse -> String # showList :: [ListWorldExportJobsResponse] -> ShowS #
NFData ListWorldExportJobsResponse Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldExportJobs Methods rnf :: ListWorldExportJobsResponse -> () #
Eq ListWorldExportJobsResponse Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldExportJobs Methods (==) :: ListWorldExportJobsResponse -> ListWorldExportJobsResponse -> Bool # (/=) :: ListWorldExportJobsResponse -> ListWorldExportJobsResponse -> Bool #
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 #

Arguments

:: Int	`$sel:httpStatus:ListWorldExportJobsResponse'`
-> ListWorldExportJobsResponse

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.

listWorldExportJobsResponse_httpStatus :: Lens' ListWorldExportJobsResponse Int Source #

The response's http status code.

listWorldExportJobsResponse_worldExportJobSummaries :: Lens' ListWorldExportJobsResponse [WorldExportJobSummary] Source #

Summary information for world export jobs.