Struct Client 

pub struct Client { /* private fields */ }

Client for Amazon Location Service Maps V2

Client for invoking operations on Amazon Location Service Maps V2. Each operation on Amazon Location Service Maps V2 is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_geomaps::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_geomaps::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the GetGlyphs operation has a Client::get_glyphs, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.get_glyphs()
    .font_stack("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn get_glyphs(&self) -> GetGlyphsFluentBuilder

Constructs a fluent builder for the GetGlyphs operation.

• The fluent builder is configurable:
  • font_stack(impl Into<String>) / set_font_stack(Option<String>):
    required: true
    

    Name of the FontStack to retrieve.

    Example: Amazon Ember Bold,Noto Sans Bold.

    The supported font stacks are as follows:

    • Amazon Ember Bold

    • Amazon Ember Bold Italic

    • Amazon Ember Bold,Noto Sans Bold

    • Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold

    • Amazon Ember Condensed RC BdItalic

    • Amazon Ember Condensed RC Bold

    • Amazon Ember Condensed RC Bold Italic

    • Amazon Ember Condensed RC Bold,Noto Sans Bold

    • Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic Condensed Bold

    • Amazon Ember Condensed RC Light

    • Amazon Ember Condensed RC Light Italic

    • Amazon Ember Condensed RC LtItalic

    • Amazon Ember Condensed RC Regular

    • Amazon Ember Condensed RC Regular Italic

    • Amazon Ember Condensed RC Regular,Noto Sans Regular

    • Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic Condensed Regular

    • Amazon Ember Condensed RC RgItalic

    • Amazon Ember Condensed RC ThItalic

    • Amazon Ember Condensed RC Thin

    • Amazon Ember Condensed RC Thin Italic

    • Amazon Ember Heavy

    • Amazon Ember Heavy Italic

    • Amazon Ember Light

    • Amazon Ember Light Italic

    • Amazon Ember Medium

    • Amazon Ember Medium Italic

    • Amazon Ember Medium,Noto Sans Medium

    • Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium

    • Amazon Ember Regular

    • Amazon Ember Regular Italic

    • Amazon Ember Regular Italic,Noto Sans Italic

    • Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic Regular

    • Amazon Ember Regular,Noto Sans Regular

    • Amazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular

    • Amazon Ember Thin

    • Amazon Ember Thin Italic

    • AmazonEmberCdRC_Bd

    • AmazonEmberCdRC_BdIt

    • AmazonEmberCdRC_Lt

    • AmazonEmberCdRC_LtIt

    • AmazonEmberCdRC_Rg

    • AmazonEmberCdRC_RgIt

    • AmazonEmberCdRC_Th

    • AmazonEmberCdRC_ThIt

    • AmazonEmber_Bd

    • AmazonEmber_BdIt

    • AmazonEmber_He

    • AmazonEmber_HeIt

    • AmazonEmber_Lt

    • AmazonEmber_LtIt

    • AmazonEmber_Md

    • AmazonEmber_MdIt

    • AmazonEmber_Rg

    • AmazonEmber_RgIt

    • AmazonEmber_Th

    • AmazonEmber_ThIt

    • Noto Sans Black

    • Noto Sans Black Italic

    • Noto Sans Bold

    • Noto Sans Bold Italic

    • Noto Sans Extra Bold

    • Noto Sans Extra Bold Italic

    • Noto Sans Extra Light

    • Noto Sans Extra Light Italic

    • Noto Sans Italic

    • Noto Sans Light

    • Noto Sans Light Italic

    • Noto Sans Medium

    • Noto Sans Medium Italic

    • Noto Sans Regular

    • Noto Sans Semi Bold

    • Noto Sans Semi Bold Italic

    • Noto Sans Thin

    • Noto Sans Thin Italic

    • NotoSans-Bold

    • NotoSans-Italic

    • NotoSans-Medium

    • NotoSans-Regular

    • Open Sans Regular,Arial Unicode MS Regular

    
    
  • font_unicode_range(impl Into<String>) / set_font_unicode_range(Option<String>):
    required: true
    

    A Unicode range of characters to download glyphs for. This must be aligned to multiples of 256.

    Example: 0-255.pdf

    
    
• On success, responds with GetGlyphsOutput with field(s):
  • blob(Option<Blob>):

    The Glyph, as a binary blob.

  • content_type(Option<String>):

    Header that represents the format of the response. The response returns the following as the HTTP body.

  • cache_control(Option<String>):

    Header that instructs caching configuration for the client.

  • e_tag(Option<String>):

    The glyph’s Etag.

• On failure, responds with SdkError<GetGlyphsError>

impl Client

pub fn get_sprites(&self) -> GetSpritesFluentBuilder

Constructs a fluent builder for the GetSprites operation.

• The fluent builder is configurable:
  • file_name(impl Into<String>) / set_file_name(Option<String>):
    required: true
    

    Sprites API: The name of the sprite file to retrieve, following pattern sprites(@2x)?.(png|json).

    Example: sprites.png

    
    
  • style(MapStyle) / set_style(Option<MapStyle>):
    required: true
    

    Style specifies the desired map style for the Sprites APIs.

    
    
  • color_scheme(ColorScheme) / set_color_scheme(Option<ColorScheme>):
    required: true
    

    Sets color tone for map such as dark and light for specific map styles. It applies to only vector map styles such as Standard and Monochrome.

    Example: Light

    Default value: Light

    Valid values for ColorScheme are case sensitive.

    
    
  • variant(Variant) / set_variant(Option<Variant>):
    required: true
    

    Optimizes map styles for specific use case or industry. You can choose allowed variant only with Standard map style.

    Example: Default

    Valid values for Variant are case sensitive.

    
    
• On success, responds with GetSpritesOutput with field(s):
  • blob(Option<Blob>):

    The body of the sprite sheet or JSON offset file (image/png or application/json, depending on input).

  • content_type(Option<String>):

    Header that represents the format of the response. The response returns the following as the HTTP body.

  • cache_control(Option<String>):

    Header that instructs caching configuration for the client.

  • e_tag(Option<String>):

    The sprite’s Etag.

• On failure, responds with SdkError<GetSpritesError>

impl Client

pub fn get_static_map(&self) -> GetStaticMapFluentBuilder

Constructs a fluent builder for the GetStaticMap operation.

• The fluent builder is configurable:
  • bounding_box(impl Into<String>) / set_bounding_box(Option<String>):
    required: false
    

    Takes in two pairs of coordinates, [Lon, Lat], denoting south-westerly and north-easterly edges of the image. The underlying area becomes the view of the image.

    Example: -123.17075,49.26959,-123.08125,49.31429

    
    
  • bounded_positions(impl Into<String>) / set_bounded_positions(Option<String>):
    required: false
    

    Takes in two or more pair of coordinates, [Lon, Lat], with each coordinate separated by a comma. The API will generate an image to encompass all of the provided coordinates.

    Cannot be used with Zoom and or Radius

    Example: 97.170451,78.039098,99.045536,27.176178

    
    
  • center(impl Into<String>) / set_center(Option<String>):
    required: false
    

    Takes in a pair of coordinates, [Lon, Lat], which becomes the center point of the image. This parameter requires that either zoom or radius is set.

    Cannot be used with Zoom and or Radius

    Example: 49.295,-123.108

    
    
  • color_scheme(ColorScheme) / set_color_scheme(Option<ColorScheme>):
    required: false
    

    Sets color tone for map, such as dark and light for specific map styles. It only applies to vector map styles, such as Standard.

    Example: Light

    Default value: Light

    Valid values for ColorScheme are case sensitive.

    
    
  • compact_overlay(impl Into<String>) / set_compact_overlay(Option<String>):
    required: false
    

    Takes in a string to draw geometries on the image. The input is a comma separated format as follows format: [Lon, Lat]

    Example: line:-122.407653,37.798557,-122.413291,37.802443;color=%23DD0000;width=7;outline-color=#00DD00;outline-width=5yd|point:-122.40572,37.80004;label=Fog Hill Market;size=large;text-color=%23DD0000;color=#EE4B2B

    Currently it supports the following geometry types: point, line and polygon. It does not support multiPoint , multiLine and multiPolgyon.

    
    
  • crop_labels(bool) / set_crop_labels(Option<bool>):
    required: false
    

    It is a flag that takes in true or false. It prevents the labels that are on the edge of the image from being cut or obscured.

    
    
  • geo_json_overlay(impl Into<String>) / set_geo_json_overlay(Option<String>):
    required: false
    

    Takes in a string to draw geometries on the image. The input is a valid GeoJSON collection object.

    Example: {“type”:“FeatureCollection”,“features”: [{“type”:“Feature”,“geometry”:{“type”:“MultiPoint”,“coordinates”: [[-90.076345,51.504107],[-0.074451,51.506892]]},“properties”: {“color”:“#00DD00”}}]}

    
    
  • height(i32) / set_height(Option<i32>):
    required: true
    

    Specifies the height of the map image.

    
    
  • key(impl Into<String>) / set_key(Option<String>):
    required: false
    

    Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

    
    
  • label_size(LabelSize) / set_label_size(Option<LabelSize>):
    required: false
    

    Overrides the label size auto-calculated by FileName. Takes in one of the values - Small or Large.

    
    
  • language(impl Into<String>) / set_language(Option<String>):
    required: false
    

    Specifies the language on the map labels using the BCP 47 language tag, limited to ISO 639-1 two-letter language codes. If the specified language data isn’t available for the map image, the labels will default to the regional primary language.

    Supported codes:

    • ar

    • as

    • az

    • be

    • bg

    • bn

    • bs

    • ca

    • cs

    • cy

    • da

    • de

    • el

    • en

    • es

    • et

    • eu

    • fi

    • fo

    • fr

    • ga

    • gl

    • gn

    • gu

    • he

    • hi

    • hr

    • hu

    • hy

    • id

    • is

    • it

    • ja

    • ka

    • kk

    • km

    • kn

    • ko

    • ky

    • lt

    • lv

    • mk

    • ml

    • mr

    • ms

    • mt

    • my

    • nl

    • no

    • or

    • pa

    • pl

    • pt

    • ro

    • ru

    • sk

    • sl

    • sq

    • sr

    • sv

    • ta

    • te

    • th

    • tr

    • uk

    • uz

    • vi

    • zh

    
    
  • padding(i32) / set_padding(Option<i32>):
    required: false
    

    Applies additional space (in pixels) around overlay feature to prevent them from being cut or obscured.

    Value for max and min is determined by:

    Min: 1

    Max: min(height, width)/4

    Example: 100

    
    
  • political_view(impl Into<String>) / set_political_view(Option<String>):
    required: false
    

    Specifies the political view, using ISO 3166-2 or ISO 3166-3 country code format.

    The following political views are currently supported:

    • ARG: Argentina’s view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands

    • EGY: Egypt’s view on Bir Tawil

    • IND: India’s view on Gilgit-Baltistan

    • KEN: Kenya’s view on the Ilemi Triangle

    • MAR: Morocco’s view on Western Sahara

    • RUS: Russia’s view on Crimea

    • SDN: Sudan’s view on the Halaib Triangle

    • SRB: Serbia’s view on Kosovo, Vukovar, and Sarengrad Islands

    • SUR: Suriname’s view on the Courantyne Headwaters and Lawa Headwaters

    • SYR: Syria’s view on the Golan Heights

    • TUR: Turkey’s view on Cyprus and Northern Cyprus

    • TZA: Tanzania’s view on Lake Malawi

    • URY: Uruguay’s view on Rincon de Artigas

    • VNM: Vietnam’s view on the Paracel Islands and Spratly Islands

    
    
  • points_of_interests(MapFeatureMode) / set_points_of_interests(Option<MapFeatureMode>):
    required: false
    

    Determines if the result image will display icons representing points of interest on the map.

    
    
  • radius(i64) / set_radius(Option<i64>):
    required: false
    

    Used with center parameter, it specifies the zoom of the image where you can control it on a granular level. Takes in any value >= 1.

    Example: 1500

    Cannot be used with Zoom.

    Unit: Meters

    
    
  • file_name(impl Into<String>) / set_file_name(Option<String>):
    required: true
    

    The map scaling parameter to size the image, icons, and labels. It follows the pattern of ^map(@2x)?$.

    Example: map, map@2x

    
    
  • scale_bar_unit(ScaleBarUnit) / set_scale_bar_unit(Option<ScaleBarUnit>):
    required: false
    

    Displays a scale on the bottom right of the map image with the unit specified in the input.

    Example: KilometersMiles, Miles, Kilometers, MilesKilometers

    
    
  • style(StaticMapStyle) / set_style(Option<StaticMapStyle>):
    required: false
    

    Style specifies the desired map style.

    
    
  • width(i32) / set_width(Option<i32>):
    required: true
    

    Specifies the width of the map image.

    
    
  • zoom(f32) / set_zoom(Option<f32>):
    required: false
    

    Specifies the zoom level of the map image.

    Cannot be used with Radius.

    
    
• On success, responds with GetStaticMapOutput with field(s):
  • blob(Option<Blob>):

    The blob represents a map image as a jpeg for the GetStaticMap API.

  • content_type(Option<String>):

    Header that represents the format of the response. The response returns the following as the HTTP body.

  • cache_control(Option<String>):

    Header that instructs caching configuration for the client.

  • e_tag(Option<String>):

    The static map’s Etag.

  • pricing_bucket(String):

    The pricing bucket for which the request is charged at.

• On failure, responds with SdkError<GetStaticMapError>

impl Client

pub fn get_style_descriptor(&self) -> GetStyleDescriptorFluentBuilder

Constructs a fluent builder for the GetStyleDescriptor operation.

• The fluent builder is configurable:
  • style(MapStyle) / set_style(Option<MapStyle>):
    required: true
    

    Style specifies the desired map style.

    
    
  • color_scheme(ColorScheme) / set_color_scheme(Option<ColorScheme>):
    required: false
    

    Sets color tone for map such as dark and light for specific map styles. It applies to only vector map styles such as Standard and Monochrome.

    Example: Light

    Default value: Light

    Valid values for ColorScheme are case sensitive.

    
    
  • political_view(impl Into<String>) / set_political_view(Option<String>):
    required: false
    

    Specifies the political view using ISO 3166-2 or ISO 3166-3 country code format.

    The following political views are currently supported:

    • ARG: Argentina’s view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands

    • EGY: Egypt’s view on Bir Tawil

    • IND: India’s view on Gilgit-Baltistan

    • KEN: Kenya’s view on the Ilemi Triangle

    • MAR: Morocco’s view on Western Sahara

    • RUS: Russia’s view on Crimea

    • SDN: Sudan’s view on the Halaib Triangle

    • SRB: Serbia’s view on Kosovo, Vukovar, and Sarengrad Islands

    • SUR: Suriname’s view on the Courantyne Headwaters and Lawa Headwaters

    • SYR: Syria’s view on the Golan Heights

    • TUR: Turkey’s view on Cyprus and Northern Cyprus

    • TZA: Tanzania’s view on Lake Malawi

    • URY: Uruguay’s view on Rincon de Artigas

    • VNM: Vietnam’s view on the Paracel Islands and Spratly Islands

    
    
  • key(impl Into<String>) / set_key(Option<String>):
    required: false
    

    Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

    
    
• On success, responds with GetStyleDescriptorOutput with field(s):
  • blob(Option<Blob>):

    This Blob contains the body of the style descriptor which is in application/json format.

  • content_type(Option<String>):

    Header that represents the format of the response. The response returns the following as the HTTP body.

  • cache_control(Option<String>):

    Header that instructs caching configuration for the client.

  • e_tag(Option<String>):

    The style descriptor’s Etag.

• On failure, responds with SdkError<GetStyleDescriptorError>

impl Client

pub fn get_tile(&self) -> GetTileFluentBuilder

Constructs a fluent builder for the GetTile operation.

• The fluent builder is configurable:
  • tileset(impl Into<String>) / set_tileset(Option<String>):
    required: true
    

    Specifies the desired tile set.

    Valid Values: raster.satellite | vector.basemap

    
    
  • z(impl Into<String>) / set_z(Option<String>):
    required: true
    

    The zoom value for the map tile.

    
    
  • x(impl Into<String>) / set_x(Option<String>):
    required: true
    

    The X axis value for the map tile. Must be between 0 and 19.

    
    
  • y(impl Into<String>) / set_y(Option<String>):
    required: true
    

    The Y axis value for the map tile.

    
    
  • key(impl Into<String>) / set_key(Option<String>):
    required: false
    

    Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

    
    
• On success, responds with GetTileOutput with field(s):
  • blob(Option<Blob>):

    The blob represents a vector tile in mvt or a raster tile in an image format.

  • content_type(Option<String>):

    Header that represents the format of the response. The response returns the following as the HTTP body.

  • cache_control(Option<String>):

    Header that instructs caching configuration for the client.

  • e_tag(Option<String>):

    The pricing bucket for which the request is charged at.

  • pricing_bucket(String):

    The pricing bucket for which the request is charged at.

• On failure, responds with SdkError<GetTileError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.