amazonka-location-2.0: Amazon Location Service 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.Location.ListPlaceIndexes

Description

Lists place index resources in your AWS account.

This operation returns paginated results.

Synopsis

Creating a Request

data ListPlaceIndexes Source #

See: newListPlaceIndexes smart constructor.

Constructors

ListPlaceIndexes' 

Fields

  • maxResults :: Maybe Natural

    An optional limit for the maximum number of results returned in a single call.

    Default value: 100

  • nextToken :: Maybe Text

    The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

    Default value: null

Instances

Instances details
ToJSON ListPlaceIndexes Source # 
Instance details

Defined in Amazonka.Location.ListPlaceIndexes

ToHeaders ListPlaceIndexes Source # 
Instance details

Defined in Amazonka.Location.ListPlaceIndexes

ToPath ListPlaceIndexes Source # 
Instance details

Defined in Amazonka.Location.ListPlaceIndexes

ToQuery ListPlaceIndexes Source # 
Instance details

Defined in Amazonka.Location.ListPlaceIndexes

AWSPager ListPlaceIndexes Source # 
Instance details

Defined in Amazonka.Location.ListPlaceIndexes

AWSRequest ListPlaceIndexes Source # 
Instance details

Defined in Amazonka.Location.ListPlaceIndexes

Associated Types

type AWSResponse ListPlaceIndexes #

Generic ListPlaceIndexes Source # 
Instance details

Defined in Amazonka.Location.ListPlaceIndexes

Associated Types

type Rep ListPlaceIndexes :: Type -> Type #

Read ListPlaceIndexes Source # 
Instance details

Defined in Amazonka.Location.ListPlaceIndexes

Show ListPlaceIndexes Source # 
Instance details

Defined in Amazonka.Location.ListPlaceIndexes

NFData ListPlaceIndexes Source # 
Instance details

Defined in Amazonka.Location.ListPlaceIndexes

Methods

rnf :: ListPlaceIndexes -> () #

Eq ListPlaceIndexes Source # 
Instance details

Defined in Amazonka.Location.ListPlaceIndexes

Hashable ListPlaceIndexes Source # 
Instance details

Defined in Amazonka.Location.ListPlaceIndexes

type AWSResponse ListPlaceIndexes Source # 
Instance details

Defined in Amazonka.Location.ListPlaceIndexes

type Rep ListPlaceIndexes Source # 
Instance details

Defined in Amazonka.Location.ListPlaceIndexes

type Rep ListPlaceIndexes = D1 ('MetaData "ListPlaceIndexes" "Amazonka.Location.ListPlaceIndexes" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "ListPlaceIndexes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListPlaceIndexes :: ListPlaceIndexes Source #

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

ListPlaceIndexes, listPlaceIndexes_maxResults - An optional limit for the maximum number of results returned in a single call.

Default value: 100

ListPlaceIndexes, listPlaceIndexes_nextToken - The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default value: null

Request Lenses

listPlaceIndexes_maxResults :: Lens' ListPlaceIndexes (Maybe Natural) Source #

An optional limit for the maximum number of results returned in a single call.

Default value: 100

listPlaceIndexes_nextToken :: Lens' ListPlaceIndexes (Maybe Text) Source #

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default value: null

Destructuring the Response

data ListPlaceIndexesResponse Source #

See: newListPlaceIndexesResponse smart constructor.

Constructors

ListPlaceIndexesResponse' 

Fields

Instances

Instances details
Generic ListPlaceIndexesResponse Source # 
Instance details

Defined in Amazonka.Location.ListPlaceIndexes

Associated Types

type Rep ListPlaceIndexesResponse :: Type -> Type #

Read ListPlaceIndexesResponse Source # 
Instance details

Defined in Amazonka.Location.ListPlaceIndexes

Show ListPlaceIndexesResponse Source # 
Instance details

Defined in Amazonka.Location.ListPlaceIndexes

NFData ListPlaceIndexesResponse Source # 
Instance details

Defined in Amazonka.Location.ListPlaceIndexes

Eq ListPlaceIndexesResponse Source # 
Instance details

Defined in Amazonka.Location.ListPlaceIndexes

type Rep ListPlaceIndexesResponse Source # 
Instance details

Defined in Amazonka.Location.ListPlaceIndexes

type Rep ListPlaceIndexesResponse = D1 ('MetaData "ListPlaceIndexesResponse" "Amazonka.Location.ListPlaceIndexes" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "ListPlaceIndexesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "entries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ListPlaceIndexesResponseEntry]))))

newListPlaceIndexesResponse Source #

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

ListPlaceIndexes, listPlaceIndexesResponse_nextToken - A pagination token indicating that there are additional pages available. You can use the token in a new request to fetch the next page of results.

$sel:httpStatus:ListPlaceIndexesResponse', listPlaceIndexesResponse_httpStatus - The response's http status code.

$sel:entries:ListPlaceIndexesResponse', listPlaceIndexesResponse_entries - Lists the place index resources that exist in your AWS account

Response Lenses

listPlaceIndexesResponse_nextToken :: Lens' ListPlaceIndexesResponse (Maybe Text) Source #

A pagination token indicating that there are additional pages available. You can use the token in a new request to fetch the next page of results.

listPlaceIndexesResponse_entries :: Lens' ListPlaceIndexesResponse [ListPlaceIndexesResponseEntry] Source #

Lists the place index resources that exist in your AWS account