libZSservicesZSamazonka-robomakerZSamazonka-robomaker
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.RobOMaker.ListWorldTemplates

Description

Lists world templates.

This operation returns paginated results.

Synopsis

Creating a Request

data ListWorldTemplates Source #

See: newListWorldTemplates smart constructor.

Constructors

ListWorldTemplates' 

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.

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

Instances

Instances details
Eq ListWorldTemplates Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldTemplates

Read ListWorldTemplates Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldTemplates

Show ListWorldTemplates Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldTemplates

Generic ListWorldTemplates Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldTemplates

Associated Types

type Rep ListWorldTemplates :: Type -> Type #

NFData ListWorldTemplates Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldTemplates

Methods

rnf :: ListWorldTemplates -> () #

Hashable ListWorldTemplates Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldTemplates

ToJSON ListWorldTemplates Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldTemplates

AWSPager ListWorldTemplates Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldTemplates

AWSRequest ListWorldTemplates Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldTemplates

Associated Types

type AWSResponse ListWorldTemplates #

ToHeaders ListWorldTemplates Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldTemplates

ToPath ListWorldTemplates Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldTemplates

ToQuery ListWorldTemplates Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldTemplates

type Rep ListWorldTemplates Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldTemplates

type Rep ListWorldTemplates = D1 ('MetaData "ListWorldTemplates" "Amazonka.RobOMaker.ListWorldTemplates" "libZSservicesZSamazonka-robomakerZSamazonka-robomaker" 'False) (C1 ('MetaCons "ListWorldTemplates'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))
type AWSResponse ListWorldTemplates Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldTemplates

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

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

Request Lenses

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.

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.

Destructuring the Response

data ListWorldTemplatesResponse Source #

See: newListWorldTemplatesResponse smart constructor.

Constructors

ListWorldTemplatesResponse' 

Fields

  • templateSummaries :: Maybe [TemplateSummary]

    Summary information for templates.

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListWorldTemplatesResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldTemplates

Read ListWorldTemplatesResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldTemplates

Show ListWorldTemplatesResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldTemplates

Generic ListWorldTemplatesResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldTemplates

Associated Types

type Rep ListWorldTemplatesResponse :: Type -> Type #

NFData ListWorldTemplatesResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldTemplates

type Rep ListWorldTemplatesResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.ListWorldTemplates

type Rep ListWorldTemplatesResponse = D1 ('MetaData "ListWorldTemplatesResponse" "Amazonka.RobOMaker.ListWorldTemplates" "libZSservicesZSamazonka-robomakerZSamazonka-robomaker" 'False) (C1 ('MetaCons "ListWorldTemplatesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "templateSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TemplateSummary])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListWorldTemplatesResponse Source #

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:

$sel:templateSummaries:ListWorldTemplatesResponse', listWorldTemplatesResponse_templateSummaries - Summary information for templates.

$sel:nextToken: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: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.