Amazonka.Location.GetMapSprites

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.

Creating a Request

data GetMapSprites

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

  • [e-mail] for high pixel density displays

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

  • sprites.json

  • [e-mail] for high pixel density displays
• mapName :: Text

  The map resource associated with the sprite file.

Instances

ToHeaders GetMapSprites

Defined in Amazonka.Location.GetMapSprites

Methods

toHeaders :: GetMapSprites -> [Header]

ToPath GetMapSprites

Defined in Amazonka.Location.GetMapSprites

Methods

toPath :: GetMapSprites -> ByteString

ToQuery GetMapSprites

Defined in Amazonka.Location.GetMapSprites

Methods

toQuery :: GetMapSprites -> QueryString

AWSRequest GetMapSprites

Defined in Amazonka.Location.GetMapSprites

Associated Types

type AWSResponse GetMapSprites

Methods

request :: (Service -> Service) -> GetMapSprites -> Request GetMapSprites

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

Generic GetMapSprites

Defined in Amazonka.Location.GetMapSprites

Associated Types

type Rep GetMapSprites :: Type -> Type

Methods

from :: GetMapSprites -> Rep GetMapSprites x

to :: Rep GetMapSprites x -> GetMapSprites

Read GetMapSprites

Defined in Amazonka.Location.GetMapSprites

Methods

readsPrec :: Int -> ReadS GetMapSprites

readList :: ReadS [GetMapSprites]

readPrec :: ReadPrec GetMapSprites

readListPrec :: ReadPrec [GetMapSprites]

Show GetMapSprites

Defined in Amazonka.Location.GetMapSprites

Methods

showsPrec :: Int -> GetMapSprites -> ShowS

show :: GetMapSprites -> String

showList :: [GetMapSprites] -> ShowS

NFData GetMapSprites

Defined in Amazonka.Location.GetMapSprites

Methods

rnf :: GetMapSprites -> ()

Eq GetMapSprites

Defined in Amazonka.Location.GetMapSprites

Methods

(==) :: GetMapSprites -> GetMapSprites -> Bool

(/=) :: GetMapSprites -> GetMapSprites -> Bool

Hashable GetMapSprites

Defined in Amazonka.Location.GetMapSprites

Methods

hashWithSalt :: Int -> GetMapSprites -> Int

hash :: GetMapSprites -> Int

type AWSResponse GetMapSprites

Defined in Amazonka.Location.GetMapSprites

type AWSResponse GetMapSprites = GetMapSpritesResponse

type Rep GetMapSprites

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

Arguments

:: Text

$sel:fileName:GetMapSprites'

-> Text

GetMapSprites

-> GetMapSprites

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

• [e-mail] for high pixel density displays

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

• sprites.json

• [e-mail] for high pixel density displays

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

Request Lenses

getMapSprites_fileName :: Lens' GetMapSprites Text

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

• sprites.png

• [e-mail] for high pixel density displays

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

• sprites.json

• [e-mail] for high pixel density displays

getMapSprites_mapName :: Lens' GetMapSprites Text

The map resource associated with the sprite file.

Destructuring the Response

data GetMapSpritesResponse

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

Generic GetMapSpritesResponse

Defined in Amazonka.Location.GetMapSprites

Associated Types

type Rep GetMapSpritesResponse :: Type -> Type

Methods

from :: GetMapSpritesResponse -> Rep GetMapSpritesResponse x

to :: Rep GetMapSpritesResponse x -> GetMapSpritesResponse

Read GetMapSpritesResponse

Defined in Amazonka.Location.GetMapSprites

Methods

readsPrec :: Int -> ReadS GetMapSpritesResponse

readList :: ReadS [GetMapSpritesResponse]

readPrec :: ReadPrec GetMapSpritesResponse

readListPrec :: ReadPrec [GetMapSpritesResponse]

Show GetMapSpritesResponse

Defined in Amazonka.Location.GetMapSprites

Methods

showsPrec :: Int -> GetMapSpritesResponse -> ShowS

show :: GetMapSpritesResponse -> String

showList :: [GetMapSpritesResponse] -> ShowS

NFData GetMapSpritesResponse

Defined in Amazonka.Location.GetMapSprites

Methods

rnf :: GetMapSpritesResponse -> ()

Eq GetMapSpritesResponse

Defined in Amazonka.Location.GetMapSprites

Methods

(==) :: GetMapSpritesResponse -> GetMapSpritesResponse -> Bool

(/=) :: GetMapSpritesResponse -> GetMapSpritesResponse -> Bool

type Rep GetMapSpritesResponse

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

Arguments

:: Int

$sel:httpStatus:GetMapSpritesResponse'

-> GetMapSpritesResponse

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)

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

getMapSpritesResponse_contentType :: Lens' GetMapSpritesResponse (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.

getMapSpritesResponse_httpStatus :: Lens' GetMapSpritesResponse Int

The response's http status code.