Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Location.GetMapSprites

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Creating a Request

data GetMapSprites Source #

See: newGetMapSprites smart constructor.

Constructors

GetMapSprites'
Fields fileName :: Text The name of the sprite ﬁle. Use the following ﬁle names for the sprite sheet: sprites.png `sprites@2x.png` for high pixel density displays For the JSON document contain image offsets. Use the following ﬁle names: sprites.json `sprites@2x.json` for high pixel density displays mapName :: Text The map resource associated with the sprite ﬁle.

Instances

Instances details

Eq GetMapSprites Source #
Instance details Defined in Amazonka.Location.GetMapSprites Methods (==) :: GetMapSprites -> GetMapSprites -> Bool # (/=) :: GetMapSprites -> GetMapSprites -> Bool #
Read GetMapSprites Source #
Instance details Defined in Amazonka.Location.GetMapSprites Methods readsPrec :: Int -> ReadS GetMapSprites # readList :: ReadS [GetMapSprites] # readPrec :: ReadPrec GetMapSprites # readListPrec :: ReadPrec [GetMapSprites] #
Show GetMapSprites Source #
Instance details Defined in Amazonka.Location.GetMapSprites Methods showsPrec :: Int -> GetMapSprites -> ShowS # show :: GetMapSprites -> String # showList :: [GetMapSprites] -> ShowS #
Generic GetMapSprites Source #
Instance details Defined in Amazonka.Location.GetMapSprites Associated Types type Rep GetMapSprites :: Type -> Type # Methods from :: GetMapSprites -> Rep GetMapSprites x # to :: Rep GetMapSprites x -> GetMapSprites #
NFData GetMapSprites Source #
Instance details Defined in Amazonka.Location.GetMapSprites Methods rnf :: GetMapSprites -> () #
Hashable GetMapSprites Source #
Instance details Defined in Amazonka.Location.GetMapSprites Methods hashWithSalt :: Int -> GetMapSprites -> Int # hash :: GetMapSprites -> Int #
AWSRequest GetMapSprites Source #
Instance details Defined in Amazonka.Location.GetMapSprites Associated Types type AWSResponse GetMapSprites # Methods request :: GetMapSprites -> Request GetMapSprites # response :: MonadResource m => Logger -> Service -> Proxy GetMapSprites -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetMapSprites))) #
ToHeaders GetMapSprites Source #
Instance details Defined in Amazonka.Location.GetMapSprites Methods toHeaders :: GetMapSprites -> [Header] #
ToPath GetMapSprites Source #
Instance details Defined in Amazonka.Location.GetMapSprites Methods toPath :: GetMapSprites -> ByteString #
ToQuery GetMapSprites Source #
Instance details Defined in Amazonka.Location.GetMapSprites Methods toQuery :: GetMapSprites -> QueryString #
type Rep GetMapSprites Source #
Instance details Defined in Amazonka.Location.GetMapSprites type Rep GetMapSprites = D1 ('MetaData "GetMapSprites" "Amazonka.Location.GetMapSprites" "libZSservicesZSamazonka-locationZSamazonka-location" 'False) (C1 ('MetaCons "GetMapSprites'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fileName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "mapName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetMapSprites Source #
Instance details Defined in Amazonka.Location.GetMapSprites type AWSResponse GetMapSprites = GetMapSpritesResponse

newGetMapSprites Source #

Arguments

:: Text	`$sel:fileName:GetMapSprites'`
-> Text	`$sel:mapName: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 ﬁle. Use the following ﬁle names for the sprite sheet:

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

For the JSON document contain image offsets. Use the following ﬁle names:

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

$sel:mapName:GetMapSprites', getMapSprites_mapName - The map resource associated with the sprite ﬁle.

Request Lenses

getMapSprites_fileName :: Lens' GetMapSprites Text Source #

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

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

For the JSON document contain image offsets. Use the following ﬁle names:

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

getMapSprites_mapName :: Lens' GetMapSprites Text Source #

The map resource associated with the sprite ﬁle.

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 ﬁle. 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

Eq GetMapSpritesResponse Source #
Instance details Defined in Amazonka.Location.GetMapSprites Methods (==) :: GetMapSpritesResponse -> GetMapSpritesResponse -> Bool # (/=) :: GetMapSpritesResponse -> GetMapSpritesResponse -> Bool #
Read GetMapSpritesResponse Source #
Instance details Defined in Amazonka.Location.GetMapSprites Methods readsPrec :: Int -> ReadS GetMapSpritesResponse # readList :: ReadS [GetMapSpritesResponse] # readPrec :: ReadPrec GetMapSpritesResponse # readListPrec :: ReadPrec [GetMapSpritesResponse] #
Show GetMapSpritesResponse Source #
Instance details Defined in Amazonka.Location.GetMapSprites Methods showsPrec :: Int -> GetMapSpritesResponse -> ShowS # show :: GetMapSpritesResponse -> String # showList :: [GetMapSpritesResponse] -> ShowS #
Generic GetMapSpritesResponse Source #
Instance details Defined in Amazonka.Location.GetMapSprites Associated Types type Rep GetMapSpritesResponse :: Type -> Type # Methods from :: GetMapSpritesResponse -> Rep GetMapSpritesResponse x # to :: Rep GetMapSpritesResponse x -> GetMapSpritesResponse #
NFData GetMapSpritesResponse Source #
Instance details Defined in Amazonka.Location.GetMapSprites Methods rnf :: GetMapSpritesResponse -> () #
type Rep GetMapSpritesResponse Source #
Instance details Defined in Amazonka.Location.GetMapSprites type Rep GetMapSpritesResponse = D1 ('MetaData "GetMapSpritesResponse" "Amazonka.Location.GetMapSprites" "libZSservicesZSamazonka-locationZSamazonka-location" '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 #

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 ﬁle.

$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 ﬁle.

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.

getMapSpritesResponse_httpStatus :: Lens' GetMapSpritesResponse Int Source #

The response's http status code.