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

Description

Retrieves the sprite sheet corresponding to a map resource. The sprite sheet is a PNG image paired with a JSON document describing the offsets of individual icons that will be displayed on a rendered map.

Synopsis

Creating a Request

data GetMapSprites Source #

See: newGetMapSprites smart constructor.

Constructors

GetMapSprites' 

Fields

  • fileName :: Text

    The name of the sprite file. Use the following file names for the sprite sheet:

    • sprites.png
    • sprites@2x.png for high pixel density displays

    For the JSON document containing image offsets. Use the following file names:

    • sprites.json
    • sprites@2x.json for high pixel density displays
  • mapName :: Text

    The map resource associated with the sprite file.

Instances

Instances details
ToHeaders GetMapSprites Source # 
Instance details

Defined in Amazonka.Location.GetMapSprites

ToPath GetMapSprites Source # 
Instance details

Defined in Amazonka.Location.GetMapSprites

ToQuery GetMapSprites Source # 
Instance details

Defined in Amazonka.Location.GetMapSprites

AWSRequest GetMapSprites Source # 
Instance details

Defined in Amazonka.Location.GetMapSprites

Associated Types

type AWSResponse GetMapSprites #

Generic GetMapSprites Source # 
Instance details

Defined in Amazonka.Location.GetMapSprites

Associated Types

type Rep GetMapSprites :: Type -> Type #

Read GetMapSprites Source # 
Instance details

Defined in Amazonka.Location.GetMapSprites

Show GetMapSprites Source # 
Instance details

Defined in Amazonka.Location.GetMapSprites

NFData GetMapSprites Source # 
Instance details

Defined in Amazonka.Location.GetMapSprites

Methods

rnf :: GetMapSprites -> () #

Eq GetMapSprites Source # 
Instance details

Defined in Amazonka.Location.GetMapSprites

Hashable GetMapSprites Source # 
Instance details

Defined in Amazonka.Location.GetMapSprites

type AWSResponse GetMapSprites Source # 
Instance details

Defined in Amazonka.Location.GetMapSprites

type Rep GetMapSprites Source # 
Instance details

Defined in Amazonka.Location.GetMapSprites

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

newGetMapSprites Source #

Create a value of GetMapSprites 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:fileName:GetMapSprites', getMapSprites_fileName - The name of the sprite file. Use the following file names for the sprite sheet:

  • sprites.png
  • sprites@2x.png for high pixel density displays

For the JSON document containing image offsets. Use the following file names:

  • sprites.json
  • sprites@2x.json for high pixel density displays

GetMapSprites, getMapSprites_mapName - The map resource associated with the sprite file.

Request Lenses

getMapSprites_fileName :: Lens' GetMapSprites Text Source #

The name of the sprite file. Use the following file names for the sprite sheet:

  • sprites.png
  • sprites@2x.png for high pixel density displays

For the JSON document containing image offsets. Use the following file names:

  • sprites.json
  • sprites@2x.json for high pixel density displays

getMapSprites_mapName :: Lens' GetMapSprites Text Source #

The map resource associated with the sprite file.

Destructuring the Response

data GetMapSpritesResponse Source #

See: newGetMapSpritesResponse smart constructor.

Constructors

GetMapSpritesResponse' 

Fields

  • blob :: Maybe ByteString

    Contains the body of the sprite sheet or JSON offset file.

  • contentType :: Maybe Text

    The content type of the sprite sheet and offsets. For example, the sprite sheet content type is image/png, and the sprite offset JSON document is application/json.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic GetMapSpritesResponse Source # 
Instance details

Defined in Amazonka.Location.GetMapSprites

Associated Types

type Rep GetMapSpritesResponse :: Type -> Type #

Read GetMapSpritesResponse Source # 
Instance details

Defined in Amazonka.Location.GetMapSprites

Show GetMapSpritesResponse Source # 
Instance details

Defined in Amazonka.Location.GetMapSprites

NFData GetMapSpritesResponse Source # 
Instance details

Defined in Amazonka.Location.GetMapSprites

Methods

rnf :: GetMapSpritesResponse -> () #

Eq GetMapSpritesResponse Source # 
Instance details

Defined in Amazonka.Location.GetMapSprites

type Rep GetMapSpritesResponse Source # 
Instance details

Defined in Amazonka.Location.GetMapSprites

type Rep GetMapSpritesResponse = D1 ('MetaData "GetMapSpritesResponse" "Amazonka.Location.GetMapSprites" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "GetMapSpritesResponse'" '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))))

newGetMapSpritesResponse Source #

Create a value of GetMapSpritesResponse 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:GetMapSpritesResponse', getMapSpritesResponse_blob - Contains the body of the sprite sheet or JSON offset file.

$sel:contentType:GetMapSpritesResponse', getMapSpritesResponse_contentType - The content type of the sprite sheet and offsets. For example, the sprite sheet content type is image/png, and the sprite offset JSON document is application/json.

$sel:httpStatus:GetMapSpritesResponse', getMapSpritesResponse_httpStatus - The response's http status code.

Response Lenses

getMapSpritesResponse_blob :: Lens' GetMapSpritesResponse (Maybe ByteString) Source #

Contains the body of the sprite sheet or JSON offset file.

getMapSpritesResponse_contentType :: Lens' GetMapSpritesResponse (Maybe Text) Source #

The content type of the sprite sheet and offsets. For example, the sprite sheet content type is image/png, and the sprite offset JSON document is application/json.