Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Location.DescribePlaceIndex

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the place index resource details.

Synopsis

data DescribePlaceIndex = DescribePlaceIndex' {
- indexName :: Text
}
newDescribePlaceIndex :: Text -> DescribePlaceIndex
describePlaceIndex_indexName :: Lens' DescribePlaceIndex Text
data DescribePlaceIndexResponse = DescribePlaceIndexResponse' {
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
- createTime :: POSIX
- dataSource :: Text
- dataSourceConfiguration :: DataSourceConfiguration
- description :: Text
- indexArn :: Text
- indexName :: Text
- pricingPlan :: PricingPlan
- updateTime :: POSIX
}
newDescribePlaceIndexResponse :: Int -> UTCTime -> Text -> DataSourceConfiguration -> Text -> Text -> Text -> PricingPlan -> UTCTime -> DescribePlaceIndexResponse
describePlaceIndexResponse_tags :: Lens' DescribePlaceIndexResponse (Maybe (HashMap Text Text))
describePlaceIndexResponse_httpStatus :: Lens' DescribePlaceIndexResponse Int
describePlaceIndexResponse_createTime :: Lens' DescribePlaceIndexResponse UTCTime
describePlaceIndexResponse_dataSource :: Lens' DescribePlaceIndexResponse Text
describePlaceIndexResponse_dataSourceConfiguration :: Lens' DescribePlaceIndexResponse DataSourceConfiguration
describePlaceIndexResponse_description :: Lens' DescribePlaceIndexResponse Text
describePlaceIndexResponse_indexArn :: Lens' DescribePlaceIndexResponse Text
describePlaceIndexResponse_indexName :: Lens' DescribePlaceIndexResponse Text
describePlaceIndexResponse_pricingPlan :: Lens' DescribePlaceIndexResponse PricingPlan
describePlaceIndexResponse_updateTime :: Lens' DescribePlaceIndexResponse UTCTime

Creating a Request

data DescribePlaceIndex Source #

See: newDescribePlaceIndex smart constructor.

Constructors

DescribePlaceIndex'
Fields indexName :: Text The name of the place index resource.

Instances

Instances details

Eq DescribePlaceIndex Source #
Instance details Defined in Amazonka.Location.DescribePlaceIndex Methods (==) :: DescribePlaceIndex -> DescribePlaceIndex -> Bool # (/=) :: DescribePlaceIndex -> DescribePlaceIndex -> Bool #
Read DescribePlaceIndex Source #
Instance details Defined in Amazonka.Location.DescribePlaceIndex Methods readsPrec :: Int -> ReadS DescribePlaceIndex # readList :: ReadS [DescribePlaceIndex] # readPrec :: ReadPrec DescribePlaceIndex # readListPrec :: ReadPrec [DescribePlaceIndex] #
Show DescribePlaceIndex Source #
Instance details Defined in Amazonka.Location.DescribePlaceIndex Methods showsPrec :: Int -> DescribePlaceIndex -> ShowS # show :: DescribePlaceIndex -> String # showList :: [DescribePlaceIndex] -> ShowS #
Generic DescribePlaceIndex Source #
Instance details Defined in Amazonka.Location.DescribePlaceIndex Associated Types type Rep DescribePlaceIndex :: Type -> Type # Methods from :: DescribePlaceIndex -> Rep DescribePlaceIndex x # to :: Rep DescribePlaceIndex x -> DescribePlaceIndex #
NFData DescribePlaceIndex Source #
Instance details Defined in Amazonka.Location.DescribePlaceIndex Methods rnf :: DescribePlaceIndex -> () #
Hashable DescribePlaceIndex Source #
Instance details Defined in Amazonka.Location.DescribePlaceIndex Methods hashWithSalt :: Int -> DescribePlaceIndex -> Int # hash :: DescribePlaceIndex -> Int #
AWSRequest DescribePlaceIndex Source #
Instance details Defined in Amazonka.Location.DescribePlaceIndex Associated Types type AWSResponse DescribePlaceIndex # Methods request :: DescribePlaceIndex -> Request DescribePlaceIndex # response :: MonadResource m => Logger -> Service -> Proxy DescribePlaceIndex -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribePlaceIndex))) #
ToHeaders DescribePlaceIndex Source #
Instance details Defined in Amazonka.Location.DescribePlaceIndex Methods toHeaders :: DescribePlaceIndex -> [Header] #
ToPath DescribePlaceIndex Source #
Instance details Defined in Amazonka.Location.DescribePlaceIndex Methods toPath :: DescribePlaceIndex -> ByteString #
ToQuery DescribePlaceIndex Source #
Instance details Defined in Amazonka.Location.DescribePlaceIndex Methods toQuery :: DescribePlaceIndex -> QueryString #
type Rep DescribePlaceIndex Source #
Instance details Defined in Amazonka.Location.DescribePlaceIndex type Rep DescribePlaceIndex = D1 ('MetaData "DescribePlaceIndex" "Amazonka.Location.DescribePlaceIndex" "libZSservicesZSamazonka-locationZSamazonka-location" 'False) (C1 ('MetaCons "DescribePlaceIndex'" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribePlaceIndex Source #
Instance details Defined in Amazonka.Location.DescribePlaceIndex type AWSResponse DescribePlaceIndex = DescribePlaceIndexResponse

newDescribePlaceIndex Source #

Arguments

:: Text	`$sel:indexName:DescribePlaceIndex'`
-> DescribePlaceIndex

Create a value of DescribePlaceIndex 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:indexName:DescribePlaceIndex', describePlaceIndex_indexName - The name of the place index resource.

Request Lenses

describePlaceIndex_indexName :: Lens' DescribePlaceIndex Text Source #

The name of the place index resource.

Destructuring the Response

data DescribePlaceIndexResponse Source #

See: newDescribePlaceIndexResponse smart constructor.

Constructors

DescribePlaceIndexResponse'

Fields

tags :: Maybe (HashMap Text Text)
Tags associated with place index resource.
httpStatus :: Int
The response's http status code.
createTime :: POSIX
The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
dataSource :: Text
The data provider of geospatial data. Indicates one of the available providers:
- ```
Esri
```
- ```
Here
```
For additional details on data providers, see Amazon Location Service data providers.
dataSourceConfiguration :: DataSourceConfiguration
The specified data storage option for requesting Places.
description :: Text
The optional description for the place index resource.
indexArn :: Text
The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.
- Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
indexName :: Text
The name of the place index resource being described.
pricingPlan :: PricingPlan
The pricing plan selected for the specified place index resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
updateTime :: POSIX
The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Instances

Instances details

Eq DescribePlaceIndexResponse Source #
Instance details Defined in Amazonka.Location.DescribePlaceIndex Methods (==) :: DescribePlaceIndexResponse -> DescribePlaceIndexResponse -> Bool # (/=) :: DescribePlaceIndexResponse -> DescribePlaceIndexResponse -> Bool #
Read DescribePlaceIndexResponse Source #
Instance details Defined in Amazonka.Location.DescribePlaceIndex Methods readsPrec :: Int -> ReadS DescribePlaceIndexResponse # readList :: ReadS [DescribePlaceIndexResponse] # readPrec :: ReadPrec DescribePlaceIndexResponse # readListPrec :: ReadPrec [DescribePlaceIndexResponse] #
Show DescribePlaceIndexResponse Source #
Instance details Defined in Amazonka.Location.DescribePlaceIndex Methods showsPrec :: Int -> DescribePlaceIndexResponse -> ShowS # show :: DescribePlaceIndexResponse -> String # showList :: [DescribePlaceIndexResponse] -> ShowS #
Generic DescribePlaceIndexResponse Source #
Instance details Defined in Amazonka.Location.DescribePlaceIndex Associated Types type Rep DescribePlaceIndexResponse :: Type -> Type # Methods from :: DescribePlaceIndexResponse -> Rep DescribePlaceIndexResponse x # to :: Rep DescribePlaceIndexResponse x -> DescribePlaceIndexResponse #
NFData DescribePlaceIndexResponse Source #
Instance details Defined in Amazonka.Location.DescribePlaceIndex Methods rnf :: DescribePlaceIndexResponse -> () #
type Rep DescribePlaceIndexResponse Source #
Instance details Defined in Amazonka.Location.DescribePlaceIndex type Rep DescribePlaceIndexResponse = D1 ('MetaData "DescribePlaceIndexResponse" "Amazonka.Location.DescribePlaceIndex" "libZSservicesZSamazonka-locationZSamazonka-location" 'False) (C1 ('MetaCons "DescribePlaceIndexResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "createTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: (S1 ('MetaSel ('Just "dataSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "dataSourceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DataSourceConfiguration)))) :: ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "indexArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "pricingPlan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PricingPlan) :*: S1 ('MetaSel ('Just "updateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))))

newDescribePlaceIndexResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribePlaceIndexResponse'`
-> UTCTime	`$sel:createTime:DescribePlaceIndexResponse'`
-> Text	`$sel:dataSource:DescribePlaceIndexResponse'`
-> DataSourceConfiguration	`$sel:dataSourceConfiguration:DescribePlaceIndexResponse'`
-> Text	`$sel:description:DescribePlaceIndexResponse'`
-> Text	`$sel:indexArn:DescribePlaceIndexResponse'`
-> Text	`$sel:indexName:DescribePlaceIndex'`
-> PricingPlan	`$sel:pricingPlan:DescribePlaceIndexResponse'`
-> UTCTime	`$sel:updateTime:DescribePlaceIndexResponse'`
-> DescribePlaceIndexResponse

Create a value of DescribePlaceIndexResponse 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:tags:DescribePlaceIndexResponse', describePlaceIndexResponse_tags - Tags associated with place index resource.

$sel:httpStatus:DescribePlaceIndexResponse', describePlaceIndexResponse_httpStatus - The response's http status code.

$sel:createTime:DescribePlaceIndexResponse', describePlaceIndexResponse_createTime - The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

$sel:dataSource:DescribePlaceIndexResponse', describePlaceIndexResponse_dataSource - The data provider of geospatial data. Indicates one of the available providers:

```
Esri
```
```
Here
```

For additional details on data providers, see Amazon Location Service data providers.

$sel:dataSourceConfiguration:DescribePlaceIndexResponse', describePlaceIndexResponse_dataSourceConfiguration - The specified data storage option for requesting Places.

$sel:description:DescribePlaceIndexResponse', describePlaceIndexResponse_description - The optional description for the place index resource.

$sel:indexArn:DescribePlaceIndexResponse', describePlaceIndexResponse_indexArn - The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.

Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

$sel:indexName:DescribePlaceIndex', describePlaceIndexResponse_indexName - The name of the place index resource being described.

$sel:pricingPlan:DescribePlaceIndexResponse', describePlaceIndexResponse_pricingPlan - The pricing plan selected for the specified place index resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

$sel:updateTime:DescribePlaceIndexResponse', describePlaceIndexResponse_updateTime - The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Response Lenses

describePlaceIndexResponse_tags :: Lens' DescribePlaceIndexResponse (Maybe (HashMap Text Text)) Source #

Tags associated with place index resource.

describePlaceIndexResponse_httpStatus :: Lens' DescribePlaceIndexResponse Int Source #

The response's http status code.

describePlaceIndexResponse_createTime :: Lens' DescribePlaceIndexResponse UTCTime Source #

The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

describePlaceIndexResponse_dataSource :: Lens' DescribePlaceIndexResponse Text Source #

The data provider of geospatial data. Indicates one of the available providers:

```
Esri
```
```
Here
```

For additional details on data providers, see Amazon Location Service data providers.

describePlaceIndexResponse_dataSourceConfiguration :: Lens' DescribePlaceIndexResponse DataSourceConfiguration Source #

The specified data storage option for requesting Places.

describePlaceIndexResponse_description :: Lens' DescribePlaceIndexResponse Text Source #

The optional description for the place index resource.

describePlaceIndexResponse_indexArn :: Lens' DescribePlaceIndexResponse Text Source #

The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.

Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

describePlaceIndexResponse_indexName :: Lens' DescribePlaceIndexResponse Text Source #

The name of the place index resource being described.

describePlaceIndexResponse_pricingPlan :: Lens' DescribePlaceIndexResponse PricingPlan Source #

The pricing plan selected for the specified place index resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

describePlaceIndexResponse_updateTime :: Lens' DescribePlaceIndexResponse UTCTime Source #

The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.