Class: Aws::GeoMaps::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-geomaps/client.rb

Overview

An API client for GeoMaps. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::GeoMaps::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements ‘Aws::CredentialProvider`, or instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ‘ENV`, `ENV`, `ENV`, and `ENV`.

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting `ENV` to `true`.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: ‘sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV` or in shared config as `auth_scheme_preference`, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When ‘true`, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at ‘HOME/.aws/credentials`. When not specified, ’default’ is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements ‘Aws::TokenProvider`, or instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::GeoMaps::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::GeoMaps::EndpointParameters`.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



473
474
475
 
# File 'lib/aws-sdk-geomaps/client.rb', line 473

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1450
1451
1452
 
# File 'lib/aws-sdk-geomaps/client.rb', line 1450

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1453
1454
1455
 
# File 'lib/aws-sdk-geomaps/client.rb', line 1453

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
 
# File 'lib/aws-sdk-geomaps/client.rb', line 1423

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::GeoMaps')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-geomaps'
  context[:gem_version] = '1.25.0'
  Seahorse::Client::Request.new(handlers, context)
end

#get_glyphs(params = {}) ⇒ Types::GetGlyphsResponse

‘GetGlyphs` returns the map’s glyphs.

For more information, see [Style labels with glyphs] in the *Amazon Location Service Developer Guide*.

[1]: docs.aws.amazon.com/location/latest/developerguide/styling-labels-with-glyphs.html

Examples:

Request syntax with placeholder values


resp = client.get_glyphs({
  font_stack: "GetGlyphsRequestFontStackString", # required
  font_unicode_range: "GetGlyphsRequestFontUnicodeRangeString", # required
})

Response structure


resp.blob #=> IO
resp.content_type #=> String
resp.cache_control #=> String
resp.etag #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :font_stack (required, String) —

    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 (required, String) —

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

    Example: ‘0-255.pbf`

Returns:

See Also:



687
688
689
690
 
# File 'lib/aws-sdk-geomaps/client.rb', line 687

def get_glyphs(params = {}, options = {}, &block)
  req = build_request(:get_glyphs, params)
  req.send_request(options, &block)
end

#get_sprites(params = {}) ⇒ Types::GetSpritesResponse

‘GetSprites` returns the map’s sprites.

For more information, see [Style iconography with sprites] in the *Amazon Location Service Developer Guide*.

[1]: docs.aws.amazon.com/location/latest/developerguide/styling-iconography-with-sprites.html

Examples:

Request syntax with placeholder values


resp = client.get_sprites({
  file_name: "GetSpritesRequestFileNameString", # required
  style: "Standard", # required, accepts Standard, Monochrome, Hybrid, Satellite
  color_scheme: "Light", # required, accepts Light, Dark
  variant: "Default", # required, accepts Default
})

Response structure


resp.blob #=> IO
resp.content_type #=> String
resp.cache_control #=> String
resp.etag #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :file_name (required, String) —

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

    Example: ‘sprites.png`

  • :style (required, String) —

    Style specifies the desired map style for the ‘Sprites` APIs.

  • :color_scheme (required, String) —

    Sets the color tone for the map sprites, such as dark and light.

    Example: ‘Light`

    Default value: ‘Light`

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

    </note>
  • :variant (required, String) —

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

    Example: ‘Default`

    <note markdown=“1”> Valid values for Variant are case sensitive.

    </note>

Returns:

See Also:



758
759
760
761
 
# File 'lib/aws-sdk-geomaps/client.rb', line 758

def get_sprites(params = {}, options = {}, &block)
  req = build_request(:get_sprites, params)
  req.send_request(options, &block)
end

#get_static_map(params = {}) ⇒ Types::GetStaticMapResponse

<note markdown=“1”> This operation is not supported in ‘ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps] customers.

</note>

`GetStaticMap` provides high-quality static map images with

customizable options. You can modify the map’s appearance and overlay additional information. It’s an ideal solution for applications requiring tailored static map snapshots.

For more information, see the following topics in the *Amazon

Location Service Developer Guide*:

* [Static maps][2]
  • Customize static maps][3
  • Overlay on the static map][4

[1]: docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html [2]: docs.aws.amazon.com/location/latest/developerguide/static-maps.html [3]: docs.aws.amazon.com/location/latest/developerguide/customizing-static-maps.html [4]: docs.aws.amazon.com/location/latest/developerguide/overlaying-static-map.html

Examples:

Request syntax with placeholder values


resp = client.get_static_map({
  bounding_box: "GetStaticMapRequestBoundingBoxString",
  bounded_positions: "GetStaticMapRequestBoundedPositionsString",
  center: "PositionString",
  color_scheme: "Light", # accepts Light, Dark
  compact_overlay: "CompactOverlay",
  crop_labels: false,
  geo_json_overlay: "GeoJsonOverlay",
  height: 1, # required
  key: "ApiKey",
  label_size: "Small", # accepts Small, Large
  language: "LanguageTag",
  padding: 1,
  political_view: "CountryCode",
  points_of_interests: "Enabled", # accepts Enabled, Disabled
  radius: 1,
  file_name: "GetStaticMapRequestFileNameString", # required
  scale_bar_unit: "Kilometers", # accepts Kilometers, KilometersMiles, Miles, MilesKilometers
  style: "Satellite", # accepts Satellite, Standard
  width: 1, # required
  zoom: 1.0,
})

Response structure


resp.blob #=> IO
resp.content_type #=> String
resp.cache_control #=> String
resp.etag #=> String
resp.pricing_bucket #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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

  • :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

  • :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

  • :color_scheme (String) —

    Sets the color tone for the map, such as dark and light.

    Example: ‘Light`

    Default value: ‘Light`

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

    </note>
  • :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>
  • :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.

  • :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::Client.“color”:““color”:“#00DD00”}]}`

  • :height (required, Integer) —

    Specifies the height of the map image.

  • :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.

  • :label_size (String) —

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

  • :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`

  • :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`

  • :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

  • :points_of_interests (String) —

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

  • :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`

  • :file_name (required, String) —

    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 (String) —

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

    Example: ‘KilometersMiles, Miles, Kilometers, MilesKilometers`

  • :style (String) —

    ‘Style` specifies the desired map style.

  • :width (required, Integer) —

    Specifies the width of the map image.

  • :zoom (Float) —

    Specifies the zoom level of the map image.

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

    </note>

Returns:

See Also:



1151
1152
1153
1154
 
# File 'lib/aws-sdk-geomaps/client.rb', line 1151

def get_static_map(params = {}, options = {}, &block)
  req = build_request(:get_static_map, params)
  req.send_request(options, &block)
end

#get_style_descriptor(params = {}) ⇒ Types::GetStyleDescriptorResponse

‘GetStyleDescriptor` returns information about the style.

For more information, see [Style dynamic maps] in the *Amazon Location Service Developer Guide*.

[1]: docs.aws.amazon.com/location/latest/developerguide/styling-dynamic-maps.html

Examples:

Request syntax with placeholder values


resp = client.get_style_descriptor({
  style: "Standard", # required, accepts Standard, Monochrome, Hybrid, Satellite
  color_scheme: "Light", # accepts Light, Dark
  political_view: "CountryCode",
  terrain: "Hillshade", # accepts Hillshade, Terrain3D
  contour_density: "Low", # accepts Low, Medium, High
  traffic: "All", # accepts All, Congestion
  travel_modes: ["Transit"], # accepts Transit, Truck
  buildings: "Buildings3D", # accepts Buildings3D
  key: "ApiKey",
})

Response structure


resp.blob #=> IO
resp.content_type #=> String
resp.cache_control #=> String
resp.etag #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :style (required, String) —

    Style specifies the desired map style. For [GrabMaps] customers, ‘ap-southeast-1` and `ap-southeast-5` regions support only the `Standard` and `Monochrome` values.

    [1]: docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html

  • :color_scheme (String) —

    Sets the color tone for the map, such as dark and light.

    Example: ‘Light`

    Default value: ‘Light`

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

    </note>
  • :political_view (String) —

    Specifies the political view using ISO 3166-2 or ISO 3166-3 country code format. Not supported in ‘ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps] customers.

    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

    [1]: docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html

  • :terrain (String) —

    Adjusts how physical terrain details are rendered on the map. Not supported in ‘ap-southeast-1` and `ap-southeast-5` regions for

    GrabMaps][1

    customers.

    The following terrain styles are currently supported:

    • ‘Hillshade`: Displays the physical terrain details through shading and highlighting of elevation change and geographic features.

    • ‘Terrain3D`: Displays physical terrain details and elevations as a three-dimensional model.

    ‘Hillshade` is valid only for the `Standard` and `Monochrome` map styles.

    [1]: docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html

  • :contour_density (String) —

    Displays the shape and steepness of terrain features using elevation lines. The density value controls how densely the available contour line information is rendered on the map. Not supported in ‘ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps] customers.

    This parameter is valid for all map styles except ‘Satellite`.

    [1]: docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html

  • :traffic (String) —

    Displays real-time traffic information overlay on map, such as incident events and flow events. Not supported in ‘ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps] customers.

    This parameter is valid for all map styles except ‘Satellite`.

    [1]: docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html

  • :travel_modes (Array<String>) —

    Renders additional map information relevant to selected travel modes. Information for multiple travel modes can be displayed simultaneously, although this increases the overall information density rendered on the map. Not supported in ‘ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps] customers.

    This parameter is valid for all map styles except ‘Satellite`.

    [1]: docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html

  • :buildings (String) —

    Adjusts how building details are rendered on the map.

    The following building styles are currently supported:

    • ‘Buildings3D`: Displays buildings as three-dimensional extrusions on the map.

    ^

    ‘Buildings3D` is valid only for the `Standard` and `Monochrome` map styles.

  • :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:

See Also:



1333
1334
1335
1336
 
# File 'lib/aws-sdk-geomaps/client.rb', line 1333

def get_style_descriptor(params = {}, options = {}, &block)
  req = build_request(:get_style_descriptor, params)
  req.send_request(options, &block)
end

#get_tile(params = {}) ⇒ Types::GetTileResponse

‘GetTile` returns a tile. 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.

For more information, see [Tiles] in the *Amazon Location Service Developer Guide*.

[1]: docs.aws.amazon.com/location/latest/developerguide/tiles.html

Examples:

Request syntax with placeholder values


resp = client.get_tile({
  additional_features: ["ContourLines"], # accepts ContourLines, Hillshade, Logistics, Transit
  tileset: "Tileset", # required
  z: "GetTileRequestZString", # required
  x: "GetTileRequestXString", # required
  y: "GetTileRequestYString", # required
  key: "ApiKey",
})

Response structure


resp.blob #=> IO
resp.content_type #=> String
resp.cache_control #=> String
resp.etag #=> String
resp.pricing_bucket #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :additional_features (Array<String>) —

    A list of optional additional parameters such as map styles that can be requested for each result. Not supported in ‘ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps] customers.

    [1]: docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html

  • :tileset (required, String) —

    Specifies the desired tile set. For [GrabMaps] customers, ‘ap-southeast-1` and `ap-southeast-5` regions support only the `vector.basemap` value.

    Valid Values: ‘raster.satellite | vector.basemap | vector.traffic | raster.dem`

    [1]: docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html

  • :z (required, String) —

    The zoom value for the map tile.

  • :x (required, String) —

    The X axis value for the map tile.

  • :y (required, String) —

    The Y axis value for the map tile.

  • :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:

See Also:



1414
1415
1416
1417
 
# File 'lib/aws-sdk-geomaps/client.rb', line 1414

def get_tile(params = {}, options = {}, &block)
  req = build_request(:get_tile, params)
  req.send_request(options, &block)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1443
1444
1445
 
# File 'lib/aws-sdk-geomaps/client.rb', line 1443

def waiter_names
  []
end