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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists world templates.

This operation returns paginated results.

Creating a Request

data ListWorldTemplates Source #

See: newListWorldTemplates smart constructor.

Constructors

ListWorldTemplates'

Fields

maxResults :: Maybe Int
When this parameter is used, ListWorldTemplates 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 ListWorldTemplates request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorldTemplates 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 ListWorldTemplates 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 ListWorldTemplates Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldTemplates Methods toJSON :: ListWorldTemplates -> Value # toEncoding :: ListWorldTemplates -> Encoding # toJSONList :: [ListWorldTemplates] -> Value # toEncodingList :: [ListWorldTemplates] -> Encoding #
ToHeaders ListWorldTemplates Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldTemplates Methods toHeaders :: ListWorldTemplates -> [Header] #
ToPath ListWorldTemplates Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldTemplates Methods toPath :: ListWorldTemplates -> ByteString #
ToQuery ListWorldTemplates Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldTemplates Methods toQuery :: ListWorldTemplates -> QueryString #
AWSPager ListWorldTemplates Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldTemplates Methods page :: ListWorldTemplates -> AWSResponse ListWorldTemplates -> Maybe ListWorldTemplates #
AWSRequest ListWorldTemplates Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldTemplates Associated Types type AWSResponse ListWorldTemplates # Methods request :: (Service -> Service) -> ListWorldTemplates -> Request ListWorldTemplates # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListWorldTemplates -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListWorldTemplates))) #
Generic ListWorldTemplates Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldTemplates Associated Types type Rep ListWorldTemplates :: Type -> Type # Methods from :: ListWorldTemplates -> Rep ListWorldTemplates x # to :: Rep ListWorldTemplates x -> ListWorldTemplates #
Read ListWorldTemplates Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldTemplates Methods readsPrec :: Int -> ReadS ListWorldTemplates # readList :: ReadS [ListWorldTemplates] # readPrec :: ReadPrec ListWorldTemplates # readListPrec :: ReadPrec [ListWorldTemplates] #
Show ListWorldTemplates Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldTemplates Methods showsPrec :: Int -> ListWorldTemplates -> ShowS # show :: ListWorldTemplates -> String # showList :: [ListWorldTemplates] -> ShowS #
NFData ListWorldTemplates Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldTemplates Methods rnf :: ListWorldTemplates -> () #
Eq ListWorldTemplates Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldTemplates Methods (==) :: ListWorldTemplates -> ListWorldTemplates -> Bool # (/=) :: ListWorldTemplates -> ListWorldTemplates -> Bool #
Hashable ListWorldTemplates Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldTemplates Methods hashWithSalt :: Int -> ListWorldTemplates -> Int # hash :: ListWorldTemplates -> Int #
type AWSResponse ListWorldTemplates Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldTemplates type AWSResponse ListWorldTemplates = ListWorldTemplatesResponse
type Rep ListWorldTemplates Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldTemplates type Rep ListWorldTemplates = D1 ('MetaData "ListWorldTemplates" "Amazonka.RobOMaker.ListWorldTemplates" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "ListWorldTemplates'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListWorldTemplates :: ListWorldTemplates Source #

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

ListWorldTemplates, listWorldTemplates_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 ListWorldTemplates 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

listWorldTemplates_maxResults :: Lens' ListWorldTemplates (Maybe Int) Source #

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

listWorldTemplates_nextToken :: Lens' ListWorldTemplates (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 ListWorldTemplates 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 ListWorldTemplatesResponse Source #

See: newListWorldTemplatesResponse smart constructor.

Constructors

ListWorldTemplatesResponse'

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 ListWorldTemplates 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.
templateSummaries :: Maybe [TemplateSummary]
Summary information for templates.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListWorldTemplatesResponse Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldTemplates Associated Types type Rep ListWorldTemplatesResponse :: Type -> Type # Methods from :: ListWorldTemplatesResponse -> Rep ListWorldTemplatesResponse x # to :: Rep ListWorldTemplatesResponse x -> ListWorldTemplatesResponse #
Read ListWorldTemplatesResponse Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldTemplates Methods readsPrec :: Int -> ReadS ListWorldTemplatesResponse # readList :: ReadS [ListWorldTemplatesResponse] # readPrec :: ReadPrec ListWorldTemplatesResponse # readListPrec :: ReadPrec [ListWorldTemplatesResponse] #
Show ListWorldTemplatesResponse Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldTemplates Methods showsPrec :: Int -> ListWorldTemplatesResponse -> ShowS # show :: ListWorldTemplatesResponse -> String # showList :: [ListWorldTemplatesResponse] -> ShowS #
NFData ListWorldTemplatesResponse Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldTemplates Methods rnf :: ListWorldTemplatesResponse -> () #
Eq ListWorldTemplatesResponse Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldTemplates Methods (==) :: ListWorldTemplatesResponse -> ListWorldTemplatesResponse -> Bool # (/=) :: ListWorldTemplatesResponse -> ListWorldTemplatesResponse -> Bool #
type Rep ListWorldTemplatesResponse Source #
Instance details Defined in Amazonka.RobOMaker.ListWorldTemplates type Rep ListWorldTemplatesResponse = D1 ('MetaData "ListWorldTemplatesResponse" "Amazonka.RobOMaker.ListWorldTemplates" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "ListWorldTemplatesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "templateSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TemplateSummary])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListWorldTemplatesResponse Source #

Arguments

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

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

ListWorldTemplates, listWorldTemplatesResponse_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 ListWorldTemplates 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:templateSummaries:ListWorldTemplatesResponse', listWorldTemplatesResponse_templateSummaries - Summary information for templates.

$sel:httpStatus:ListWorldTemplatesResponse', listWorldTemplatesResponse_httpStatus - The response's http status code.

Response Lenses

listWorldTemplatesResponse_nextToken :: Lens' ListWorldTemplatesResponse (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 ListWorldTemplates 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.

listWorldTemplatesResponse_templateSummaries :: Lens' ListWorldTemplatesResponse (Maybe [TemplateSummary]) Source #

Summary information for templates.

listWorldTemplatesResponse_httpStatus :: Lens' ListWorldTemplatesResponse Int Source #

The response's http status code.