amazonka-location-2.0: Amazon Location Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Location.GetMapGlyphs

Description

Retrieves glyphs used to display labels on a map.

Synopsis

Creating a Request

data GetMapGlyphs Source #

See: newGetMapGlyphs smart constructor.

Constructors

GetMapGlyphs' 

Fields

  • fontStack :: Text

    A comma-separated list of fonts to load glyphs from in order of preference. For example, Noto Sans Regular, Arial Unicode.

    Valid fonts stacks for Esri styles:

    • VectorEsriDarkGrayCanvas – Ubuntu Medium Italic | Ubuntu Medium | Ubuntu Italic | Ubuntu Regular | Ubuntu Bold
    • VectorEsriLightGrayCanvas – Ubuntu Italic | Ubuntu Regular | Ubuntu Light | Ubuntu Bold
    • VectorEsriTopographic – Noto Sans Italic | Noto Sans Regular | Noto Sans Bold | Noto Serif Regular | Roboto Condensed Light Italic
    • VectorEsriStreets – Arial Regular | Arial Italic | Arial Bold
    • VectorEsriNavigation – Arial Regular | Arial Italic | Arial Bold

    Valid font stacks for HERE Technologies styles:

    • VectorHereContrast – Fira GO Regular | Fira GO Bold
    • VectorHereExplore, VectorHereExploreTruck, HybridHereExploreSatellite – Fira GO Italic | Fira GO Map | Fira GO Map Bold | Noto Sans CJK JP Bold | Noto Sans CJK JP Light | Noto Sans CJK JP Regular

    Valid font stacks for Open Data (Preview) styles:

    • VectorOpenDataStandardLight – Amazon Ember Regular,Noto Sans Regular | Amazon Ember Bold,Noto Sans Bold | Amazon Ember Medium,Noto Sans Medium | Amazon Ember Regular Italic,Noto Sans Italic | Amazon Ember Condensed RC Regular,Noto Sans Regular | Amazon Ember Condensed RC Bold,Noto Sans Bold

    The fonts used by VectorOpenDataStandardLight are combined fonts that use Amazon Ember for most glyphs but Noto Sans for glyphs unsupported by Amazon Ember.

  • fontUnicodeRange :: Text

    A Unicode range of characters to download glyphs for. Each response will contain 256 characters. For example, 0–255 includes all characters from range U+0000 to 00FF. Must be aligned to multiples of 256.

  • mapName :: Text

    The map resource associated with the glyph file.

Instances

Instances details
ToHeaders GetMapGlyphs Source # 
Instance details

Defined in Amazonka.Location.GetMapGlyphs

Methods

toHeaders :: GetMapGlyphs -> [Header] #

ToPath GetMapGlyphs Source # 
Instance details

Defined in Amazonka.Location.GetMapGlyphs

Methods

toPath :: GetMapGlyphs -> ByteString #

ToQuery GetMapGlyphs Source # 
Instance details

Defined in Amazonka.Location.GetMapGlyphs

Methods

toQuery :: GetMapGlyphs -> QueryString #

AWSRequest GetMapGlyphs Source # 
Instance details

Defined in Amazonka.Location.GetMapGlyphs

Associated Types

type AWSResponse GetMapGlyphs #

Methods

request :: (Service -> Service) -> GetMapGlyphs -> Request GetMapGlyphs #

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

Generic GetMapGlyphs Source # 
Instance details

Defined in Amazonka.Location.GetMapGlyphs

Associated Types

type Rep GetMapGlyphs :: Type -> Type #

Methods

from :: GetMapGlyphs -> Rep GetMapGlyphs x #

to :: Rep GetMapGlyphs x -> GetMapGlyphs #

Read GetMapGlyphs Source # 
Instance details

Defined in Amazonka.Location.GetMapGlyphs

Methods

readsPrec :: Int -> ReadS GetMapGlyphs #

readList :: ReadS [GetMapGlyphs] #

readPrec :: ReadPrec GetMapGlyphs #

readListPrec :: ReadPrec [GetMapGlyphs] #

Show GetMapGlyphs Source # 
Instance details

Defined in Amazonka.Location.GetMapGlyphs

Methods

showsPrec :: Int -> GetMapGlyphs -> ShowS #

show :: GetMapGlyphs -> String #

showList :: [GetMapGlyphs] -> ShowS #

NFData GetMapGlyphs Source # 
Instance details

Defined in Amazonka.Location.GetMapGlyphs

Methods

rnf :: GetMapGlyphs -> () #

Eq GetMapGlyphs Source # 
Instance details

Defined in Amazonka.Location.GetMapGlyphs

Methods

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

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

Hashable GetMapGlyphs Source # 
Instance details

Defined in Amazonka.Location.GetMapGlyphs

Methods

hashWithSalt :: Int -> GetMapGlyphs -> Int #

hash :: GetMapGlyphs -> Int #

type AWSResponse GetMapGlyphs Source # 
Instance details

Defined in Amazonka.Location.GetMapGlyphs

type AWSResponse GetMapGlyphs = GetMapGlyphsResponse
type Rep GetMapGlyphs Source # 
Instance details

Defined in Amazonka.Location.GetMapGlyphs

type Rep GetMapGlyphs = D1 ('MetaData "GetMapGlyphs" "Amazonka.Location.GetMapGlyphs" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "GetMapGlyphs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fontStack") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "fontUnicodeRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "mapName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetMapGlyphs Source #

Arguments

:: Text

$sel:fontStack:GetMapGlyphs'

-> Text

$sel:fontUnicodeRange:GetMapGlyphs'

-> Text

GetMapGlyphs

-> GetMapGlyphs 

Create a value of GetMapGlyphs 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:fontStack:GetMapGlyphs', getMapGlyphs_fontStack - A comma-separated list of fonts to load glyphs from in order of preference. For example, Noto Sans Regular, Arial Unicode.

Valid fonts stacks for Esri styles:

  • VectorEsriDarkGrayCanvas – Ubuntu Medium Italic | Ubuntu Medium | Ubuntu Italic | Ubuntu Regular | Ubuntu Bold
  • VectorEsriLightGrayCanvas – Ubuntu Italic | Ubuntu Regular | Ubuntu Light | Ubuntu Bold
  • VectorEsriTopographic – Noto Sans Italic | Noto Sans Regular | Noto Sans Bold | Noto Serif Regular | Roboto Condensed Light Italic
  • VectorEsriStreets – Arial Regular | Arial Italic | Arial Bold
  • VectorEsriNavigation – Arial Regular | Arial Italic | Arial Bold

Valid font stacks for HERE Technologies styles:

  • VectorHereContrast – Fira GO Regular | Fira GO Bold
  • VectorHereExplore, VectorHereExploreTruck, HybridHereExploreSatellite – Fira GO Italic | Fira GO Map | Fira GO Map Bold | Noto Sans CJK JP Bold | Noto Sans CJK JP Light | Noto Sans CJK JP Regular

Valid font stacks for Open Data (Preview) styles:

  • VectorOpenDataStandardLight – Amazon Ember Regular,Noto Sans Regular | Amazon Ember Bold,Noto Sans Bold | Amazon Ember Medium,Noto Sans Medium | Amazon Ember Regular Italic,Noto Sans Italic | Amazon Ember Condensed RC Regular,Noto Sans Regular | Amazon Ember Condensed RC Bold,Noto Sans Bold

The fonts used by VectorOpenDataStandardLight are combined fonts that use Amazon Ember for most glyphs but Noto Sans for glyphs unsupported by Amazon Ember.

$sel:fontUnicodeRange:GetMapGlyphs', getMapGlyphs_fontUnicodeRange - A Unicode range of characters to download glyphs for. Each response will contain 256 characters. For example, 0–255 includes all characters from range U+0000 to 00FF. Must be aligned to multiples of 256.

GetMapGlyphs, getMapGlyphs_mapName - The map resource associated with the glyph file.

Request Lenses

getMapGlyphs_fontStack :: Lens' GetMapGlyphs Text Source #

A comma-separated list of fonts to load glyphs from in order of preference. For example, Noto Sans Regular, Arial Unicode.

Valid fonts stacks for Esri styles:

  • VectorEsriDarkGrayCanvas – Ubuntu Medium Italic | Ubuntu Medium | Ubuntu Italic | Ubuntu Regular | Ubuntu Bold
  • VectorEsriLightGrayCanvas – Ubuntu Italic | Ubuntu Regular | Ubuntu Light | Ubuntu Bold
  • VectorEsriTopographic – Noto Sans Italic | Noto Sans Regular | Noto Sans Bold | Noto Serif Regular | Roboto Condensed Light Italic
  • VectorEsriStreets – Arial Regular | Arial Italic | Arial Bold
  • VectorEsriNavigation – Arial Regular | Arial Italic | Arial Bold

Valid font stacks for HERE Technologies styles:

  • VectorHereContrast – Fira GO Regular | Fira GO Bold
  • VectorHereExplore, VectorHereExploreTruck, HybridHereExploreSatellite – Fira GO Italic | Fira GO Map | Fira GO Map Bold | Noto Sans CJK JP Bold | Noto Sans CJK JP Light | Noto Sans CJK JP Regular

Valid font stacks for Open Data (Preview) styles:

  • VectorOpenDataStandardLight – Amazon Ember Regular,Noto Sans Regular | Amazon Ember Bold,Noto Sans Bold | Amazon Ember Medium,Noto Sans Medium | Amazon Ember Regular Italic,Noto Sans Italic | Amazon Ember Condensed RC Regular,Noto Sans Regular | Amazon Ember Condensed RC Bold,Noto Sans Bold

The fonts used by VectorOpenDataStandardLight are combined fonts that use Amazon Ember for most glyphs but Noto Sans for glyphs unsupported by Amazon Ember.

getMapGlyphs_fontUnicodeRange :: Lens' GetMapGlyphs Text Source #

A Unicode range of characters to download glyphs for. Each response will contain 256 characters. For example, 0–255 includes all characters from range U+0000 to 00FF. Must be aligned to multiples of 256.

getMapGlyphs_mapName :: Lens' GetMapGlyphs Text Source #

The map resource associated with the glyph file.

Destructuring the Response

data GetMapGlyphsResponse Source #

See: newGetMapGlyphsResponse smart constructor.

Constructors

GetMapGlyphsResponse' 

Fields

Instances

Instances details
Generic GetMapGlyphsResponse Source # 
Instance details

Defined in Amazonka.Location.GetMapGlyphs

Associated Types

type Rep GetMapGlyphsResponse :: Type -> Type #

Methods

from :: GetMapGlyphsResponse -> Rep GetMapGlyphsResponse x #

to :: Rep GetMapGlyphsResponse x -> GetMapGlyphsResponse #

Read GetMapGlyphsResponse Source # 
Instance details

Defined in Amazonka.Location.GetMapGlyphs

Methods

readsPrec :: Int -> ReadS GetMapGlyphsResponse #

readList :: ReadS [GetMapGlyphsResponse] #

readPrec :: ReadPrec GetMapGlyphsResponse #

readListPrec :: ReadPrec [GetMapGlyphsResponse] #

Show GetMapGlyphsResponse Source # 
Instance details

Defined in Amazonka.Location.GetMapGlyphs

Methods

showsPrec :: Int -> GetMapGlyphsResponse -> ShowS #

show :: GetMapGlyphsResponse -> String #

showList :: [GetMapGlyphsResponse] -> ShowS #

NFData GetMapGlyphsResponse Source # 
Instance details

Defined in Amazonka.Location.GetMapGlyphs

Methods

rnf :: GetMapGlyphsResponse -> () #

Eq GetMapGlyphsResponse Source # 
Instance details

Defined in Amazonka.Location.GetMapGlyphs

Methods

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

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

type Rep GetMapGlyphsResponse Source # 
Instance details

Defined in Amazonka.Location.GetMapGlyphs

type Rep GetMapGlyphsResponse = D1 ('MetaData "GetMapGlyphsResponse" "Amazonka.Location.GetMapGlyphs" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "GetMapGlyphsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "blob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ByteString)) :*: (S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetMapGlyphsResponse Source #

Arguments

:: Int

$sel:httpStatus:GetMapGlyphsResponse'

-> GetMapGlyphsResponse 

Create a value of GetMapGlyphsResponse 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:blob:GetMapGlyphsResponse', getMapGlyphsResponse_blob - The blob's content type.

$sel:contentType:GetMapGlyphsResponse', getMapGlyphsResponse_contentType - The map glyph content type. For example, application/octet-stream.

$sel:httpStatus:GetMapGlyphsResponse', getMapGlyphsResponse_httpStatus - The response's http status code.

Response Lenses

getMapGlyphsResponse_blob :: Lens' GetMapGlyphsResponse (Maybe ByteString) Source #

The blob's content type.

getMapGlyphsResponse_contentType :: Lens' GetMapGlyphsResponse (Maybe Text) Source #

The map glyph content type. For example, application/octet-stream.

getMapGlyphsResponse_httpStatus :: Lens' GetMapGlyphsResponse Int Source #

The response's http status code.