Class: Aws::GeoMaps::Types::GetStaticMapRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-geomaps/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:bounding_box, :bounded_positions, :center, :compact_overlay, :geo_json_overlay, :height, :key, :padding, :political_view, :radius, :width, :zoom]

Instance Attribute Summary collapse

Instance Attribute Details

#bounded_positions ⇒ String

Takes in two or more pair of coordinates in World Geodetic System (WGS 84) format: [longitude, latitude], with each coordinate separated by a comma. The API will generate an image to encompass all of the provided coordinates.

<note markdown=“1”> Cannot be used with ‘Zoom` and or `Radius`

</note>

Example: 97.170451,78.039098,99.045536,27.176178

Returns:

  • (String) 


656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/aws-sdk-geomaps/types.rb', line 656

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :color_scheme,
  :compact_overlay,
  :crop_labels,
  :geo_json_overlay,
  :height,
  :key,
  :label_size,
  :language,
  :padding,
  :political_view,
  :points_of_interests,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:bounding_box, :bounded_positions, :center, :compact_overlay, :geo_json_overlay, :height, :key, :padding, :political_view, :radius, :width, :zoom]
  include Aws::Structure
end

#bounding_box ⇒ String

Takes in two pairs of coordinates in World Geodetic System (WGS 84) format: [longitude, latitude], 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

Returns:

  • (String) 


656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/aws-sdk-geomaps/types.rb', line 656

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :color_scheme,
  :compact_overlay,
  :crop_labels,
  :geo_json_overlay,
  :height,
  :key,
  :label_size,
  :language,
  :padding,
  :political_view,
  :points_of_interests,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:bounding_box, :bounded_positions, :center, :compact_overlay, :geo_json_overlay, :height, :key, :padding, :political_view, :radius, :width, :zoom]
  include Aws::Structure
end

#center ⇒ String

Takes in a pair of coordinates in World Geodetic System (WGS 84) format: [longitude, latitude], which becomes the center point of the image. This parameter requires that either zoom or radius is set.

<note markdown=“1”> Cannot be used with ‘Zoom` and or `Radius`

</note>

Example: 49.295,-123.108

Returns:

  • (String) 


656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/aws-sdk-geomaps/types.rb', line 656

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :color_scheme,
  :compact_overlay,
  :crop_labels,
  :geo_json_overlay,
  :height,
  :key,
  :label_size,
  :language,
  :padding,
  :political_view,
  :points_of_interests,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:bounding_box, :bounded_positions, :center, :compact_overlay, :geo_json_overlay, :height, :key, :padding, :political_view, :radius, :width, :zoom]
  include Aws::Structure
end

#color_scheme ⇒ String

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`

<note markdown=“1”> Valid values for ‘ColorScheme` are case sensitive.

</note>

Returns:

  • (String) 


656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/aws-sdk-geomaps/types.rb', line 656

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :color_scheme,
  :compact_overlay,
  :crop_labels,
  :geo_json_overlay,
  :height,
  :key,
  :label_size,
  :language,
  :padding,
  :political_view,
  :points_of_interests,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:bounding_box, :bounded_positions, :center, :compact_overlay, :geo_json_overlay, :height, :key, :padding, :political_view, :radius, :width, :zoom]
  include Aws::Structure
end

#compact_overlay ⇒ String

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`

<note markdown=“1”> Currently it supports the following geometry types: point, line and polygon. It does not support multiPoint , multiLine and multiPolgyon.

</note>

Returns:

  • (String) 


656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/aws-sdk-geomaps/types.rb', line 656

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :color_scheme,
  :compact_overlay,
  :crop_labels,
  :geo_json_overlay,
  :height,
  :key,
  :label_size,
  :language,
  :padding,
  :political_view,
  :points_of_interests,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:bounding_box, :bounded_positions, :center, :compact_overlay, :geo_json_overlay, :height, :key, :padding, :political_view, :radius, :width, :zoom]
  include Aws::Structure
end

#crop_labels ⇒ Boolean

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.

Returns:

  • (Boolean) 


656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/aws-sdk-geomaps/types.rb', line 656

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :color_scheme,
  :compact_overlay,
  :crop_labels,
  :geo_json_overlay,
  :height,
  :key,
  :label_size,
  :language,
  :padding,
  :political_view,
  :points_of_interests,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:bounding_box, :bounded_positions, :center, :compact_overlay, :geo_json_overlay, :height, :key, :padding, :political_view, :radius, :width, :zoom]
  include Aws::Structure
end

#file_name ⇒ String

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

Example: ‘map, map@2x`

Returns:

  • (String) 


656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/aws-sdk-geomaps/types.rb', line 656

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :color_scheme,
  :compact_overlay,
  :crop_labels,
  :geo_json_overlay,
  :height,
  :key,
  :label_size,
  :language,
  :padding,
  :political_view,
  :points_of_interests,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:bounding_box, :bounded_positions, :center, :compact_overlay, :geo_json_overlay, :height, :key, :padding, :political_view, :radius, :width, :zoom]
  include Aws::Structure
end

#geo_json_overlay ⇒ String

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

Example: ‘[{“type”:“Feature”,“geometry”:{“type”:“MultiPoint”,“coordinates”: [[-90.076345,51.504107],],“properties”: Aws::GeoMaps::Types::GetStaticMapRequest.“color”:““color”:“#00DD00”}]}`

Returns:

  • (String) 


656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/aws-sdk-geomaps/types.rb', line 656

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :color_scheme,
  :compact_overlay,
  :crop_labels,
  :geo_json_overlay,
  :height,
  :key,
  :label_size,
  :language,
  :padding,
  :political_view,
  :points_of_interests,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:bounding_box, :bounded_positions, :center, :compact_overlay, :geo_json_overlay, :height, :key, :padding, :political_view, :radius, :width, :zoom]
  include Aws::Structure
end

#height ⇒ Integer

Specifies the height of the map image.

Returns:

  • (Integer) 


656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/aws-sdk-geomaps/types.rb', line 656

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :color_scheme,
  :compact_overlay,
  :crop_labels,
  :geo_json_overlay,
  :height,
  :key,
  :label_size,
  :language,
  :padding,
  :political_view,
  :points_of_interests,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:bounding_box, :bounded_positions, :center, :compact_overlay, :geo_json_overlay, :height, :key, :padding, :political_view, :radius, :width, :zoom]
  include Aws::Structure
end

#key ⇒ String

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

Returns:

  • (String) 


656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/aws-sdk-geomaps/types.rb', line 656

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :color_scheme,
  :compact_overlay,
  :crop_labels,
  :geo_json_overlay,
  :height,
  :key,
  :label_size,
  :language,
  :padding,
  :political_view,
  :points_of_interests,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:bounding_box, :bounded_positions, :center, :compact_overlay, :geo_json_overlay, :height, :key, :padding, :political_view, :radius, :width, :zoom]
  include Aws::Structure
end

#label_size ⇒ String

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

Returns:

  • (String) 


656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/aws-sdk-geomaps/types.rb', line 656

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :color_scheme,
  :compact_overlay,
  :crop_labels,
  :geo_json_overlay,
  :height,
  :key,
  :label_size,
  :language,
  :padding,
  :political_view,
  :points_of_interests,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:bounding_box, :bounded_positions, :center, :compact_overlay, :geo_json_overlay, :height, :key, :padding, :political_view, :radius, :width, :zoom]
  include Aws::Structure
end

#language ⇒ String

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`

Returns:

  • (String) 


656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/aws-sdk-geomaps/types.rb', line 656

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :color_scheme,
  :compact_overlay,
  :crop_labels,
  :geo_json_overlay,
  :height,
  :key,
  :label_size,
  :language,
  :padding,
  :political_view,
  :points_of_interests,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:bounding_box, :bounded_positions, :center, :compact_overlay, :geo_json_overlay, :height, :key, :padding, :political_view, :radius, :width, :zoom]
  include Aws::Structure
end

#padding ⇒ Integer

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

<note markdown=“1”> Value for max and min is determined by:

Min: `1`

Max: `min(height, width)/4`

</note>

Example: ‘100`

Returns:

  • (Integer) 


656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/aws-sdk-geomaps/types.rb', line 656

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :color_scheme,
  :compact_overlay,
  :crop_labels,
  :geo_json_overlay,
  :height,
  :key,
  :label_size,
  :language,
  :padding,
  :political_view,
  :points_of_interests,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:bounding_box, :bounded_positions, :center, :compact_overlay, :geo_json_overlay, :height, :key, :padding, :political_view, :radius, :width, :zoom]
  include Aws::Structure
end

#points_of_interests ⇒ String

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

Returns:

  • (String) 


656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/aws-sdk-geomaps/types.rb', line 656

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :color_scheme,
  :compact_overlay,
  :crop_labels,
  :geo_json_overlay,
  :height,
  :key,
  :label_size,
  :language,
  :padding,
  :political_view,
  :points_of_interests,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:bounding_box, :bounded_positions, :center, :compact_overlay, :geo_json_overlay, :height, :key, :padding, :political_view, :radius, :width, :zoom]
  include Aws::Structure
end

#political_view ⇒ String

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

Returns:

  • (String) 


656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/aws-sdk-geomaps/types.rb', line 656

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :color_scheme,
  :compact_overlay,
  :crop_labels,
  :geo_json_overlay,
  :height,
  :key,
  :label_size,
  :language,
  :padding,
  :political_view,
  :points_of_interests,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:bounding_box, :bounded_positions, :center, :compact_overlay, :geo_json_overlay, :height, :key, :padding, :political_view, :radius, :width, :zoom]
  include Aws::Structure
end

#radius ⇒ Integer

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`

<note markdown=“1”> Cannot be used with ‘Zoom`.

</note>

Unit: ‘Meters`

Returns:

  • (Integer) 


656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/aws-sdk-geomaps/types.rb', line 656

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :color_scheme,
  :compact_overlay,
  :crop_labels,
  :geo_json_overlay,
  :height,
  :key,
  :label_size,
  :language,
  :padding,
  :political_view,
  :points_of_interests,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:bounding_box, :bounded_positions, :center, :compact_overlay, :geo_json_overlay, :height, :key, :padding, :political_view, :radius, :width, :zoom]
  include Aws::Structure
end

#scale_bar_unit ⇒ String

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

Example: ‘KilometersMiles, Miles, Kilometers, MilesKilometers`

Returns:

  • (String) 


656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/aws-sdk-geomaps/types.rb', line 656

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :color_scheme,
  :compact_overlay,
  :crop_labels,
  :geo_json_overlay,
  :height,
  :key,
  :label_size,
  :language,
  :padding,
  :political_view,
  :points_of_interests,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:bounding_box, :bounded_positions, :center, :compact_overlay, :geo_json_overlay, :height, :key, :padding, :political_view, :radius, :width, :zoom]
  include Aws::Structure
end

#style ⇒ String

‘Style` specifies the desired map style.

Returns:

  • (String) 


656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/aws-sdk-geomaps/types.rb', line 656

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :color_scheme,
  :compact_overlay,
  :crop_labels,
  :geo_json_overlay,
  :height,
  :key,
  :label_size,
  :language,
  :padding,
  :political_view,
  :points_of_interests,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:bounding_box, :bounded_positions, :center, :compact_overlay, :geo_json_overlay, :height, :key, :padding, :political_view, :radius, :width, :zoom]
  include Aws::Structure
end

#width ⇒ Integer

Specifies the width of the map image.

Returns:

  • (Integer) 


656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/aws-sdk-geomaps/types.rb', line 656

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :color_scheme,
  :compact_overlay,
  :crop_labels,
  :geo_json_overlay,
  :height,
  :key,
  :label_size,
  :language,
  :padding,
  :political_view,
  :points_of_interests,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:bounding_box, :bounded_positions, :center, :compact_overlay, :geo_json_overlay, :height, :key, :padding, :political_view, :radius, :width, :zoom]
  include Aws::Structure
end

#zoom ⇒ Float

Specifies the zoom level of the map image.

<note markdown=“1”> Cannot be used with ‘Radius`.

</note>

Returns:

  • (Float) 


656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/aws-sdk-geomaps/types.rb', line 656

class GetStaticMapRequest < Struct.new(
  :bounding_box,
  :bounded_positions,
  :center,
  :color_scheme,
  :compact_overlay,
  :crop_labels,
  :geo_json_overlay,
  :height,
  :key,
  :label_size,
  :language,
  :padding,
  :political_view,
  :points_of_interests,
  :radius,
  :file_name,
  :scale_bar_unit,
  :style,
  :width,
  :zoom)
  SENSITIVE = [:bounding_box, :bounded_positions, :center, :compact_overlay, :geo_json_overlay, :height, :key, :padding, :political_view, :radius, :width, :zoom]
  include Aws::Structure
end