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

Description

Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level.

The origin (0, 0) is the top left of the map. Increasing the zoom level by 1 doubles both the X and Y dimensions, so a tile containing data for the entire world at (0/0/0) will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).

Synopsis

Creating a Request

data GetMapTile Source #

See: newGetMapTile smart constructor.

Constructors

GetMapTile' 

Fields

  • mapName :: Text

    The map resource to retrieve the map tiles from.

  • x :: Text

    The X axis value for the map tile.

  • y :: Text

    The Y axis value for the map tile.

  • z :: Text

    The zoom value for the map tile.

Instances

Instances details
ToHeaders GetMapTile Source # 
Instance details

Defined in Amazonka.Location.GetMapTile

Methods

toHeaders :: GetMapTile -> [Header] #

ToPath GetMapTile Source # 
Instance details

Defined in Amazonka.Location.GetMapTile

ToQuery GetMapTile Source # 
Instance details

Defined in Amazonka.Location.GetMapTile

AWSRequest GetMapTile Source # 
Instance details

Defined in Amazonka.Location.GetMapTile

Associated Types

type AWSResponse GetMapTile #

Generic GetMapTile Source # 
Instance details

Defined in Amazonka.Location.GetMapTile

Associated Types

type Rep GetMapTile :: Type -> Type #

Read GetMapTile Source # 
Instance details

Defined in Amazonka.Location.GetMapTile

Show GetMapTile Source # 
Instance details

Defined in Amazonka.Location.GetMapTile

NFData GetMapTile Source # 
Instance details

Defined in Amazonka.Location.GetMapTile

Methods

rnf :: GetMapTile -> () #

Eq GetMapTile Source # 
Instance details

Defined in Amazonka.Location.GetMapTile

Hashable GetMapTile Source # 
Instance details

Defined in Amazonka.Location.GetMapTile

type AWSResponse GetMapTile Source # 
Instance details

Defined in Amazonka.Location.GetMapTile

type Rep GetMapTile Source # 
Instance details

Defined in Amazonka.Location.GetMapTile

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

newGetMapTile Source #

Create a value of GetMapTile 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:

GetMapTile, getMapTile_mapName - The map resource to retrieve the map tiles from.

$sel:x:GetMapTile', getMapTile_x - The X axis value for the map tile.

$sel:y:GetMapTile', getMapTile_y - The Y axis value for the map tile.

$sel:z:GetMapTile', getMapTile_z - The zoom value for the map tile.

Request Lenses

getMapTile_mapName :: Lens' GetMapTile Text Source #

The map resource to retrieve the map tiles from.

getMapTile_x :: Lens' GetMapTile Text Source #

The X axis value for the map tile.

getMapTile_y :: Lens' GetMapTile Text Source #

The Y axis value for the map tile.

getMapTile_z :: Lens' GetMapTile Text Source #

The zoom value for the map tile.

Destructuring the Response

data GetMapTileResponse Source #

See: newGetMapTileResponse smart constructor.

Constructors

GetMapTileResponse' 

Fields

Instances

Instances details
Generic GetMapTileResponse Source # 
Instance details

Defined in Amazonka.Location.GetMapTile

Associated Types

type Rep GetMapTileResponse :: Type -> Type #

Read GetMapTileResponse Source # 
Instance details

Defined in Amazonka.Location.GetMapTile

Show GetMapTileResponse Source # 
Instance details

Defined in Amazonka.Location.GetMapTile

NFData GetMapTileResponse Source # 
Instance details

Defined in Amazonka.Location.GetMapTile

Methods

rnf :: GetMapTileResponse -> () #

Eq GetMapTileResponse Source # 
Instance details

Defined in Amazonka.Location.GetMapTile

type Rep GetMapTileResponse Source # 
Instance details

Defined in Amazonka.Location.GetMapTile

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

newGetMapTileResponse Source #

Create a value of GetMapTileResponse 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:GetMapTileResponse', getMapTileResponse_blob - Contains Mapbox Vector Tile (MVT) data.

$sel:contentType:GetMapTileResponse', getMapTileResponse_contentType - The map tile's content type. For example, application/vnd.mapbox-vector-tile.

$sel:httpStatus:GetMapTileResponse', getMapTileResponse_httpStatus - The response's http status code.

Response Lenses

getMapTileResponse_blob :: Lens' GetMapTileResponse (Maybe ByteString) Source #

Contains Mapbox Vector Tile (MVT) data.

getMapTileResponse_contentType :: Lens' GetMapTileResponse (Maybe Text) Source #

The map tile's content type. For example, application/vnd.mapbox-vector-tile.