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.CreateMap

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.

If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you may only use HERE as your geolocation provider. See section 82 of the AWS service terms for more details.

Synopsis

data CreateMap = CreateMap' {
- description :: Maybe Text
- pricingPlan :: Maybe PricingPlan
- tags :: Maybe (HashMap Text Text)
- configuration :: MapConfiguration
- mapName :: Text
}
newCreateMap :: MapConfiguration -> Text -> CreateMap
createMap_description :: Lens' CreateMap (Maybe Text)
createMap_pricingPlan :: Lens' CreateMap (Maybe PricingPlan)
createMap_tags :: Lens' CreateMap (Maybe (HashMap Text Text))
createMap_configuration :: Lens' CreateMap MapConfiguration
createMap_mapName :: Lens' CreateMap Text
data CreateMapResponse = CreateMapResponse' {
- httpStatus :: Int
- createTime :: ISO8601
- mapArn :: Text
- mapName :: Text
}
newCreateMapResponse :: Int -> UTCTime -> Text -> Text -> CreateMapResponse
createMapResponse_httpStatus :: Lens' CreateMapResponse Int
createMapResponse_createTime :: Lens' CreateMapResponse UTCTime
createMapResponse_mapArn :: Lens' CreateMapResponse Text
createMapResponse_mapName :: Lens' CreateMapResponse Text

Creating a Request

data CreateMap Source #

See: newCreateMap smart constructor.

Constructors

CreateMap'

Fields

description :: Maybe Text
An optional description for the map resource.
pricingPlan :: Maybe PricingPlan
No longer used. If included, the only allowed value is RequestBasedUsage.
tags :: Maybe (HashMap Text Text)
Applies one or more tags to the map resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.
Format: "key" : "value"
Restrictions:
- Maximum 50 tags per resource
- Each resource tag must be unique with a maximum of one value.
- Maximum key length: 128 Unicode characters in UTF-8
- Maximum value length: 256 Unicode characters in UTF-8
- Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
- Cannot use "aws:" as a prefix for a key.
configuration :: MapConfiguration
Specifies the MapConfiguration, including the map style, for the map resource that you create. The map style defines the look of maps and the data provider for your map resource.
mapName :: Text
The name for the map resource.
Requirements:
- Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
- Must be a unique map resource name.
- No spaces allowed. For example, ExampleMap.

Instances

Instances details

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

newCreateMap Source #

Arguments

:: MapConfiguration	`$sel:configuration:CreateMap'`
-> Text	`CreateMap`
-> CreateMap

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

CreateMap, createMap_description - An optional description for the map resource.

CreateMap, createMap_pricingPlan - No longer used. If included, the only allowed value is RequestBasedUsage.

$sel:tags:CreateMap', createMap_tags - Applies one or more tags to the map resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

Maximum 50 tags per resource
Each resource tag must be unique with a maximum of one value.
Maximum key length: 128 Unicode characters in UTF-8
Maximum value length: 256 Unicode characters in UTF-8
Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
Cannot use "aws:" as a prefix for a key.

$sel:configuration:CreateMap', createMap_configuration - Specifies the MapConfiguration, including the map style, for the map resource that you create. The map style defines the look of maps and the data provider for your map resource.

CreateMap, createMap_mapName - The name for the map resource.

Requirements:

Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
Must be a unique map resource name.
No spaces allowed. For example, ExampleMap.

Request Lenses

createMap_description :: Lens' CreateMap (Maybe Text) Source #

An optional description for the map resource.

createMap_pricingPlan :: Lens' CreateMap (Maybe PricingPlan) Source #

No longer used. If included, the only allowed value is RequestBasedUsage.

createMap_tags :: Lens' CreateMap (Maybe (HashMap Text Text)) Source #

Applies one or more tags to the map resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

Maximum 50 tags per resource
Each resource tag must be unique with a maximum of one value.
Maximum key length: 128 Unicode characters in UTF-8
Maximum value length: 256 Unicode characters in UTF-8
Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
Cannot use "aws:" as a prefix for a key.

createMap_configuration :: Lens' CreateMap MapConfiguration Source #

Specifies the MapConfiguration, including the map style, for the map resource that you create. The map style defines the look of maps and the data provider for your map resource.

createMap_mapName :: Lens' CreateMap Text Source #

The name for the map resource.

Requirements:

Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
Must be a unique map resource name.
No spaces allowed. For example, ExampleMap.

Destructuring the Response

data CreateMapResponse Source #

See: newCreateMapResponse smart constructor.

Constructors

CreateMapResponse'
Fields httpStatus :: Int The response's http status code. createTime :: ISO8601 The timestamp for when the map resource was created in ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ`. 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 name of the map resource.

Instances

Instances details

Generic CreateMapResponse Source #
Instance details Defined in Amazonka.Location.CreateMap Associated Types type Rep CreateMapResponse :: Type -> Type # Methods from :: CreateMapResponse -> Rep CreateMapResponse x # to :: Rep CreateMapResponse x -> CreateMapResponse #
Read CreateMapResponse Source #
Instance details Defined in Amazonka.Location.CreateMap Methods readsPrec :: Int -> ReadS CreateMapResponse # readList :: ReadS [CreateMapResponse] # readPrec :: ReadPrec CreateMapResponse # readListPrec :: ReadPrec [CreateMapResponse] #
Show CreateMapResponse Source #
Instance details Defined in Amazonka.Location.CreateMap Methods showsPrec :: Int -> CreateMapResponse -> ShowS # show :: CreateMapResponse -> String # showList :: [CreateMapResponse] -> ShowS #
NFData CreateMapResponse Source #
Instance details Defined in Amazonka.Location.CreateMap Methods rnf :: CreateMapResponse -> () #
Eq CreateMapResponse Source #
Instance details Defined in Amazonka.Location.CreateMap Methods (==) :: CreateMapResponse -> CreateMapResponse -> Bool # (/=) :: CreateMapResponse -> CreateMapResponse -> Bool #
type Rep CreateMapResponse Source #
Instance details Defined in Amazonka.Location.CreateMap type Rep CreateMapResponse = D1 ('MetaData "CreateMapResponse" "Amazonka.Location.CreateMap" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "CreateMapResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "createTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601)) :: (S1 ('MetaSel ('Just "mapArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "mapName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateMapResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateMapResponse'`
-> UTCTime	`CreateMapResponse`
-> Text	`$sel:mapArn:CreateMapResponse'`
-> Text	`CreateMap`
-> CreateMapResponse

Create a value of CreateMapResponse 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:httpStatus:CreateMapResponse', createMapResponse_httpStatus - The response's http status code.

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

$sel:mapArn:CreateMapResponse', createMapResponse_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

CreateMap, createMapResponse_mapName - The name of the map resource.

Response Lenses

createMapResponse_httpStatus :: Lens' CreateMapResponse Int Source #

The response's http status code.

createMapResponse_createTime :: Lens' CreateMapResponse UTCTime Source #

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

createMapResponse_mapArn :: Lens' CreateMapResponse Text Source #

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

createMapResponse_mapName :: Lens' CreateMapResponse Text Source #

The name of the map resource.