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

Amazonka.Location.DescribeMap

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the map resource details.

Synopsis

data DescribeMap = DescribeMap' {
- mapName :: Text
}
newDescribeMap :: Text -> DescribeMap
describeMap_mapName :: Lens' DescribeMap Text
data DescribeMapResponse = DescribeMapResponse' {
- pricingPlan :: Maybe PricingPlan
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
- configuration :: MapConfiguration
- createTime :: ISO8601
- dataSource :: Text
- description :: Text
- mapArn :: Text
- mapName :: Text
- updateTime :: ISO8601
}
newDescribeMapResponse :: Int -> MapConfiguration -> UTCTime -> Text -> Text -> Text -> Text -> UTCTime -> DescribeMapResponse
describeMapResponse_pricingPlan :: Lens' DescribeMapResponse (Maybe PricingPlan)
describeMapResponse_tags :: Lens' DescribeMapResponse (Maybe (HashMap Text Text))
describeMapResponse_httpStatus :: Lens' DescribeMapResponse Int
describeMapResponse_configuration :: Lens' DescribeMapResponse MapConfiguration
describeMapResponse_createTime :: Lens' DescribeMapResponse UTCTime
describeMapResponse_dataSource :: Lens' DescribeMapResponse Text
describeMapResponse_description :: Lens' DescribeMapResponse Text
describeMapResponse_mapArn :: Lens' DescribeMapResponse Text
describeMapResponse_mapName :: Lens' DescribeMapResponse Text
describeMapResponse_updateTime :: Lens' DescribeMapResponse UTCTime

Creating a Request

data DescribeMap Source #

See: newDescribeMap smart constructor.

Constructors

DescribeMap'
Fields mapName :: Text The name of the map resource.

Instances

Instances details

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

newDescribeMap Source #

Arguments

:: Text	`DescribeMap`
-> DescribeMap

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

DescribeMap, describeMap_mapName - The name of the map resource.

Request Lenses

describeMap_mapName :: Lens' DescribeMap Text Source #

The name of the map resource.

Destructuring the Response

data DescribeMapResponse Source #

See: newDescribeMapResponse smart constructor.

Constructors

DescribeMapResponse'

Fields

pricingPlan :: Maybe PricingPlan
No longer used. Always returns RequestBasedUsage.
tags :: Maybe (HashMap Text Text)
Tags associated with the map resource.
httpStatus :: Int
The response's http status code.
configuration :: MapConfiguration
Specifies the map tile style selected from a partner data provider.
createTime :: ISO8601
The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
dataSource :: Text
Specifies the data provider for the associated map tiles.
description :: Text
The optional description for the map resource.
mapArn :: Text
The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.
- Format example: arn:aws:geo:region:account-id:map/ExampleMap
mapName :: Text
The map style selected from an available provider.
updateTime :: ISO8601
The timestamp for when the map resource was last update in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Instances

Instances details

Generic DescribeMapResponse Source #
Instance details Defined in Amazonka.Location.DescribeMap Associated Types type Rep DescribeMapResponse :: Type -> Type # Methods from :: DescribeMapResponse -> Rep DescribeMapResponse x # to :: Rep DescribeMapResponse x -> DescribeMapResponse #
Read DescribeMapResponse Source #
Instance details Defined in Amazonka.Location.DescribeMap Methods readsPrec :: Int -> ReadS DescribeMapResponse # readList :: ReadS [DescribeMapResponse] # readPrec :: ReadPrec DescribeMapResponse # readListPrec :: ReadPrec [DescribeMapResponse] #
Show DescribeMapResponse Source #
Instance details Defined in Amazonka.Location.DescribeMap Methods showsPrec :: Int -> DescribeMapResponse -> ShowS # show :: DescribeMapResponse -> String # showList :: [DescribeMapResponse] -> ShowS #
NFData DescribeMapResponse Source #
Instance details Defined in Amazonka.Location.DescribeMap Methods rnf :: DescribeMapResponse -> () #
Eq DescribeMapResponse Source #
Instance details Defined in Amazonka.Location.DescribeMap Methods (==) :: DescribeMapResponse -> DescribeMapResponse -> Bool # (/=) :: DescribeMapResponse -> DescribeMapResponse -> Bool #
type Rep DescribeMapResponse Source #
Instance details Defined in Amazonka.Location.DescribeMap type Rep DescribeMapResponse = D1 ('MetaData "DescribeMapResponse" "Amazonka.Location.DescribeMap" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "DescribeMapResponse'" '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 "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MapConfiguration) :: S1 ('MetaSel ('Just "createTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601)))) :: ((S1 ('MetaSel ('Just "dataSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "mapArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "mapName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "updateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601))))))

newDescribeMapResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeMapResponse'`
-> MapConfiguration	`$sel:configuration:DescribeMapResponse'`
-> UTCTime	`DescribeMapResponse`
-> Text	`DescribeMapResponse`
-> Text	`DescribeMapResponse`
-> Text	`$sel:mapArn:DescribeMapResponse'`
-> Text	`DescribeMap`
-> UTCTime	`DescribeMapResponse`
-> DescribeMapResponse

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

DescribeMapResponse, describeMapResponse_pricingPlan - No longer used. Always returns RequestBasedUsage.

$sel:tags:DescribeMapResponse', describeMapResponse_tags - Tags associated with the map resource.

$sel:httpStatus:DescribeMapResponse', describeMapResponse_httpStatus - The response's http status code.

$sel:configuration:DescribeMapResponse', describeMapResponse_configuration - Specifies the map tile style selected from a partner data provider.

DescribeMapResponse, describeMapResponse_createTime - The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

DescribeMapResponse, describeMapResponse_dataSource - Specifies the data provider for the associated map tiles.

DescribeMapResponse, describeMapResponse_description - The optional description for the map resource.

$sel:mapArn:DescribeMapResponse', describeMapResponse_mapArn - The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.

Format example: arn:aws:geo:region:account-id:map/ExampleMap

DescribeMap, describeMapResponse_mapName - The map style selected from an available provider.

DescribeMapResponse, describeMapResponse_updateTime - The timestamp for when the map resource was last update in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.