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 |
Retrieves the place index resource details.
Synopsis
- data DescribePlaceIndex = DescribePlaceIndex' {}
- newDescribePlaceIndex :: Text -> DescribePlaceIndex
- describePlaceIndex_indexName :: Lens' DescribePlaceIndex Text
- data DescribePlaceIndexResponse = DescribePlaceIndexResponse' {}
- newDescribePlaceIndexResponse :: Int -> UTCTime -> Text -> DataSourceConfiguration -> Text -> Text -> Text -> UTCTime -> DescribePlaceIndexResponse
- describePlaceIndexResponse_pricingPlan :: Lens' DescribePlaceIndexResponse (Maybe PricingPlan)
- 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_updateTime :: Lens' DescribePlaceIndexResponse UTCTime
Creating a Request
data DescribePlaceIndex Source #
See: newDescribePlaceIndex
smart constructor.
Instances
newDescribePlaceIndex Source #
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:
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.
DescribePlaceIndexResponse' | |
|
Instances
newDescribePlaceIndexResponse Source #
:: Int | |
-> UTCTime | |
-> Text | |
-> DataSourceConfiguration | |
-> Text | |
-> Text | |
-> Text | |
-> UTCTime | |
-> 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:
DescribePlaceIndexResponse
, describePlaceIndexResponse_pricingPlan
- No longer used. Always returns RequestBasedUsage
.
$sel:tags:DescribePlaceIndexResponse'
, describePlaceIndexResponse_tags
- Tags associated with place index resource.
$sel:httpStatus:DescribePlaceIndexResponse'
, describePlaceIndexResponse_httpStatus
- The response's http status code.
DescribePlaceIndexResponse
, describePlaceIndexResponse_createTime
- The timestamp for when the place index resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
DescribePlaceIndexResponse
, describePlaceIndexResponse_dataSource
- The data provider of geospatial data. Values can be one of the
following:
Esri
Here
For more information about data providers, see Amazon Location Service data providers.
$sel:dataSourceConfiguration:DescribePlaceIndexResponse'
, describePlaceIndexResponse_dataSourceConfiguration
- The specified data storage option for requesting Places.
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
DescribePlaceIndex
, describePlaceIndexResponse_indexName
- The name of the place index resource being described.
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_pricingPlan :: Lens' DescribePlaceIndexResponse (Maybe PricingPlan) Source #
No longer used. Always returns RequestBasedUsage
.
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. Values can be one of the following:
Esri
Here
For more information about 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_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
.