libZSservicesZSamazonka-locationZSamazonka-location
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Location.CreateMap

Description

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

Synopsis

Creating a Request

data CreateMap Source #

See: newCreateMap smart constructor.

Constructors

CreateMap' 

Fields

  • description :: Maybe Text

    An optional description for the map resource.

  • 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: + - = . _ : / @.
  • configuration :: MapConfiguration

    Specifies the map style selected from an available data provider.

  • 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.
  • pricingPlan :: PricingPlan

    Specifies the pricing plan for your map resource.

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

Instances

Instances details
Eq CreateMap Source # 
Instance details

Defined in Amazonka.Location.CreateMap

Methods

(==) :: CreateMap -> CreateMap -> Bool #

(/=) :: CreateMap -> CreateMap -> Bool #

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 #

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 #

NFData CreateMap Source # 
Instance details

Defined in Amazonka.Location.CreateMap

Methods

rnf :: CreateMap -> () #

Hashable CreateMap Source # 
Instance details

Defined in Amazonka.Location.CreateMap

Methods

hashWithSalt :: Int -> CreateMap -> Int #

hash :: CreateMap -> Int #

ToJSON CreateMap Source # 
Instance details

Defined in Amazonka.Location.CreateMap

Methods

toJSON :: CreateMap -> Value #

toEncoding :: CreateMap -> Encoding #

toJSONList :: [CreateMap] -> Value #

toEncodingList :: [CreateMap] -> Encoding #

AWSRequest CreateMap Source # 
Instance details

Defined in Amazonka.Location.CreateMap

Associated Types

type AWSResponse CreateMap #

Methods

request :: CreateMap -> Request CreateMap #

response :: MonadResource m => Logger -> Service -> Proxy CreateMap -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateMap))) #

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 #

type Rep CreateMap Source # 
Instance details

Defined in Amazonka.Location.CreateMap

type Rep CreateMap = D1 ('MetaData "CreateMap" "Amazonka.Location.CreateMap" "libZSservicesZSamazonka-locationZSamazonka-location" 'False) (C1 ('MetaCons "CreateMap'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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) :*: S1 ('MetaSel ('Just "pricingPlan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PricingPlan)))))
type AWSResponse CreateMap Source # 
Instance details

Defined in Amazonka.Location.CreateMap

type AWSResponse CreateMap = CreateMapResponse

newCreateMap Source #

Arguments

:: MapConfiguration

$sel:configuration:CreateMap'

-> Text

$sel:mapName:CreateMap'

-> PricingPlan

$sel:pricingPlan: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:

$sel:description:CreateMap', createMap_description - An optional description for the map resource.

$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: + - = . _ : / @.

$sel:configuration:CreateMap', createMap_configuration - Specifies the map style selected from an available data provider.

$sel:mapName: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.

$sel:pricingPlan:CreateMap', createMap_pricingPlan - Specifies the pricing plan for your map resource.

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

Request Lenses

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

An optional description for the map resource.

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: + - = . _ : / @.

createMap_configuration :: Lens' CreateMap MapConfiguration Source #

Specifies the map style selected from an available data provider.

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.

createMap_pricingPlan :: Lens' CreateMap PricingPlan Source #

Specifies the pricing plan for your map resource.

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

Destructuring the Response

data CreateMapResponse Source #

See: newCreateMapResponse smart constructor.

Constructors

CreateMapResponse' 

Fields

  • httpStatus :: Int

    The response's http status code.

  • createTime :: POSIX

    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:maps/ExampleMap
  • mapName :: Text

    The name of the map resource.

Instances

Instances details
Eq CreateMapResponse Source # 
Instance details

Defined in Amazonka.Location.CreateMap

Methods

(==) :: CreateMapResponse -> CreateMapResponse -> Bool #

(/=) :: CreateMapResponse -> CreateMapResponse -> Bool #

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 #

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 #

NFData CreateMapResponse Source # 
Instance details

Defined in Amazonka.Location.CreateMap

Methods

rnf :: CreateMapResponse -> () #

type Rep CreateMapResponse Source # 
Instance details

Defined in Amazonka.Location.CreateMap

type Rep CreateMapResponse = D1 ('MetaData "CreateMapResponse" "Amazonka.Location.CreateMap" "libZSservicesZSamazonka-locationZSamazonka-location" 'False) (C1 ('MetaCons "CreateMapResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "createTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)) :*: (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

$sel:createTime:CreateMapResponse'

-> Text

$sel:mapArn:CreateMapResponse'

-> Text

$sel:mapName: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.

$sel:createTime: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:maps/ExampleMap

$sel:mapName: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:maps/ExampleMap

createMapResponse_mapName :: Lens' CreateMapResponse Text Source #

The name of the map resource.