Amazonka.Location.DescribePlaceIndex

Retrieves the place index resource details.

Creating a Request

data DescribePlaceIndex

See: newDescribePlaceIndex smart constructor.

Constructors

DescribePlaceIndex'

Fields

• indexName :: Text

  The name of the place index resource.

Instances

ToHeaders DescribePlaceIndex

Defined in Amazonka.Location.DescribePlaceIndex

Methods

toHeaders :: DescribePlaceIndex -> [Header]

ToPath DescribePlaceIndex

Defined in Amazonka.Location.DescribePlaceIndex

Methods

toPath :: DescribePlaceIndex -> ByteString

ToQuery DescribePlaceIndex

Defined in Amazonka.Location.DescribePlaceIndex

Methods

toQuery :: DescribePlaceIndex -> QueryString

AWSRequest DescribePlaceIndex

Defined in Amazonka.Location.DescribePlaceIndex

Associated Types

type AWSResponse DescribePlaceIndex

Methods

request :: (Service -> Service) -> DescribePlaceIndex -> Request DescribePlaceIndex

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribePlaceIndex -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribePlaceIndex)))

Generic DescribePlaceIndex

Defined in Amazonka.Location.DescribePlaceIndex

Associated Types

type Rep DescribePlaceIndex :: Type -> Type

Methods

from :: DescribePlaceIndex -> Rep DescribePlaceIndex x

to :: Rep DescribePlaceIndex x -> DescribePlaceIndex

Read DescribePlaceIndex

Defined in Amazonka.Location.DescribePlaceIndex

Methods

readsPrec :: Int -> ReadS DescribePlaceIndex

readList :: ReadS [DescribePlaceIndex]

readPrec :: ReadPrec DescribePlaceIndex

readListPrec :: ReadPrec [DescribePlaceIndex]

Show DescribePlaceIndex

Defined in Amazonka.Location.DescribePlaceIndex

Methods

showsPrec :: Int -> DescribePlaceIndex -> ShowS

show :: DescribePlaceIndex -> String

showList :: [DescribePlaceIndex] -> ShowS

NFData DescribePlaceIndex

Defined in Amazonka.Location.DescribePlaceIndex

Methods

rnf :: DescribePlaceIndex -> ()

Eq DescribePlaceIndex

Defined in Amazonka.Location.DescribePlaceIndex

Methods

(==) :: DescribePlaceIndex -> DescribePlaceIndex -> Bool

(/=) :: DescribePlaceIndex -> DescribePlaceIndex -> Bool

Hashable DescribePlaceIndex

Defined in Amazonka.Location.DescribePlaceIndex

Methods

hashWithSalt :: Int -> DescribePlaceIndex -> Int

hash :: DescribePlaceIndex -> Int

type AWSResponse DescribePlaceIndex

Defined in Amazonka.Location.DescribePlaceIndex

type AWSResponse DescribePlaceIndex = DescribePlaceIndexResponse

type Rep DescribePlaceIndex

Defined in Amazonka.Location.DescribePlaceIndex

type Rep DescribePlaceIndex = D1 ('MetaData "DescribePlaceIndex" "Amazonka.Location.DescribePlaceIndex" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "DescribePlaceIndex'" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribePlaceIndex

Arguments

:: Text

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:

DescribePlaceIndex, describePlaceIndex_indexName - The name of the place index resource.

Request Lenses

describePlaceIndex_indexName :: Lens' DescribePlaceIndex Text

The name of the place index resource.

Destructuring the Response

data DescribePlaceIndexResponse

See: newDescribePlaceIndexResponse smart constructor.

Constructors

DescribePlaceIndexResponse'

Fields

• pricingPlan :: Maybe PricingPlan

  No longer used. Always returns RequestBasedUsage.

• tags :: Maybe (HashMap Text Text)

  Tags associated with place index resource.

• httpStatus :: Int

  The response's http status code.

• createTime :: ISO8601

  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. Values can be one of the following:

  • Esri

  • Here

  For more information about 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.

• updateTime :: ISO8601

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

Instances

Generic DescribePlaceIndexResponse

Defined in Amazonka.Location.DescribePlaceIndex

Associated Types

type Rep DescribePlaceIndexResponse :: Type -> Type

Methods

from :: DescribePlaceIndexResponse -> Rep DescribePlaceIndexResponse x

to :: Rep DescribePlaceIndexResponse x -> DescribePlaceIndexResponse

Read DescribePlaceIndexResponse

Defined in Amazonka.Location.DescribePlaceIndex

Methods

readsPrec :: Int -> ReadS DescribePlaceIndexResponse

readList :: ReadS [DescribePlaceIndexResponse]

readPrec :: ReadPrec DescribePlaceIndexResponse

readListPrec :: ReadPrec [DescribePlaceIndexResponse]

Show DescribePlaceIndexResponse

Defined in Amazonka.Location.DescribePlaceIndex

Methods

showsPrec :: Int -> DescribePlaceIndexResponse -> ShowS

show :: DescribePlaceIndexResponse -> String

showList :: [DescribePlaceIndexResponse] -> ShowS

NFData DescribePlaceIndexResponse

Defined in Amazonka.Location.DescribePlaceIndex

Methods

rnf :: DescribePlaceIndexResponse -> ()

Eq DescribePlaceIndexResponse

Defined in Amazonka.Location.DescribePlaceIndex

Methods

(==) :: DescribePlaceIndexResponse -> DescribePlaceIndexResponse -> Bool

(/=) :: DescribePlaceIndexResponse -> DescribePlaceIndexResponse -> Bool

type Rep DescribePlaceIndexResponse

Defined in Amazonka.Location.DescribePlaceIndex

type Rep DescribePlaceIndexResponse = D1 ('MetaData "DescribePlaceIndexResponse" "Amazonka.Location.DescribePlaceIndex" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "DescribePlaceIndexResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "pricingPlan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PricingPlan)) :*: 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 ISO8601) :*: 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 "updateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601))))))

newDescribePlaceIndexResponse

Arguments

:: Int

$sel:httpStatus:DescribePlaceIndexResponse'

-> UTCTime

DescribePlaceIndexResponse

-> Text

DescribePlaceIndexResponse

-> DataSourceConfiguration

$sel:dataSourceConfiguration:DescribePlaceIndexResponse'

-> Text

DescribePlaceIndexResponse

-> Text

$sel:indexArn:DescribePlaceIndexResponse'

-> Text

DescribePlaceIndex

-> UTCTime

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:

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)

No longer used. Always returns RequestBasedUsage.

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

Tags associated with place index resource.

describePlaceIndexResponse_httpStatus :: Lens' DescribePlaceIndexResponse Int

The response's http status code.

describePlaceIndexResponse_createTime :: Lens' DescribePlaceIndexResponse UTCTime

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

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

The specified data storage option for requesting Places.

describePlaceIndexResponse_description :: Lens' DescribePlaceIndexResponse Text

The optional description for the place index resource.

describePlaceIndexResponse_indexArn :: Lens' DescribePlaceIndexResponse 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

describePlaceIndexResponse_indexName :: Lens' DescribePlaceIndexResponse Text

The name of the place index resource being described.

describePlaceIndexResponse_updateTime :: Lens' DescribePlaceIndexResponse UTCTime

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