aws-sdk-geomaps 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-geomaps/client.rb +1070 -0
- data/lib/aws-sdk-geomaps/client_api.rb +231 -0
- data/lib/aws-sdk-geomaps/customizations.rb +0 -0
- data/lib/aws-sdk-geomaps/endpoint_parameters.rb +69 -0
- data/lib/aws-sdk-geomaps/endpoint_provider.rb +78 -0
- data/lib/aws-sdk-geomaps/endpoints.rb +20 -0
- data/lib/aws-sdk-geomaps/errors.rb +120 -0
- data/lib/aws-sdk-geomaps/plugins/endpoints.rb +77 -0
- data/lib/aws-sdk-geomaps/resource.rb +26 -0
- data/lib/aws-sdk-geomaps/types.rb +740 -0
- data/lib/aws-sdk-geomaps.rb +61 -0
- data/sig/client.rbs +171 -0
- data/sig/errors.rbs +30 -0
- data/sig/resource.rbs +82 -0
- data/sig/types.rbs +130 -0
- data/sig/waiters.rbs +13 -0
- metadata +99 -0
@@ -0,0 +1,1070 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
require 'seahorse/client/plugins/content_length.rb'
|
11
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
12
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
13
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
14
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
15
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
16
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
17
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
18
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
19
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
20
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
21
|
+
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
22
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
23
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
24
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
25
|
+
require 'aws-sdk-core/plugins/invocation_id.rb'
|
26
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
27
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
28
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
29
|
+
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
30
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
31
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
32
|
+
require 'aws-sdk-core/plugins/request_compression.rb'
|
33
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
34
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
35
|
+
require 'aws-sdk-core/plugins/telemetry.rb'
|
36
|
+
require 'aws-sdk-core/plugins/sign.rb'
|
37
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
38
|
+
|
39
|
+
module Aws::GeoMaps
|
40
|
+
# An API client for GeoMaps. To construct a client, you need to configure a `:region` and `:credentials`.
|
41
|
+
#
|
42
|
+
# client = Aws::GeoMaps::Client.new(
|
43
|
+
# region: region_name,
|
44
|
+
# credentials: credentials,
|
45
|
+
# # ...
|
46
|
+
# )
|
47
|
+
#
|
48
|
+
# For details on configuring region and credentials see
|
49
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
50
|
+
#
|
51
|
+
# See {#initialize} for a full list of supported configuration options.
|
52
|
+
class Client < Seahorse::Client::Base
|
53
|
+
|
54
|
+
include Aws::ClientStubs
|
55
|
+
|
56
|
+
@identifier = :geomaps
|
57
|
+
|
58
|
+
set_api(ClientApi::API)
|
59
|
+
|
60
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
61
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
62
|
+
add_plugin(Aws::Plugins::Logging)
|
63
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
64
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
65
|
+
add_plugin(Aws::Plugins::UserAgent)
|
66
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
67
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
68
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
69
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
70
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
71
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
72
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
73
|
+
add_plugin(Aws::Plugins::StubResponses)
|
74
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
75
|
+
add_plugin(Aws::Plugins::InvocationId)
|
76
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
77
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
78
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
79
|
+
add_plugin(Aws::Plugins::TransferEncoding)
|
80
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
81
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
82
|
+
add_plugin(Aws::Plugins::RequestCompression)
|
83
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
84
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
85
|
+
add_plugin(Aws::Plugins::Telemetry)
|
86
|
+
add_plugin(Aws::Plugins::Sign)
|
87
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
88
|
+
add_plugin(Aws::GeoMaps::Plugins::Endpoints)
|
89
|
+
|
90
|
+
# @overload initialize(options)
|
91
|
+
# @param [Hash] options
|
92
|
+
#
|
93
|
+
# @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
|
94
|
+
# A list of plugins to apply to the client. Each plugin is either a
|
95
|
+
# class name or an instance of a plugin class.
|
96
|
+
#
|
97
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
98
|
+
# Your AWS credentials. This can be an instance of any one of the
|
99
|
+
# following classes:
|
100
|
+
#
|
101
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
102
|
+
# credentials.
|
103
|
+
#
|
104
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
105
|
+
# shared file, such as `~/.aws/config`.
|
106
|
+
#
|
107
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
108
|
+
#
|
109
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
110
|
+
# assume a role after providing credentials via the web.
|
111
|
+
#
|
112
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
113
|
+
# access token generated from `aws login`.
|
114
|
+
#
|
115
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
116
|
+
# process that outputs to stdout.
|
117
|
+
#
|
118
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
119
|
+
# from an EC2 IMDS on an EC2 instance.
|
120
|
+
#
|
121
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
122
|
+
# instances running in ECS.
|
123
|
+
#
|
124
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
125
|
+
# from the Cognito Identity service.
|
126
|
+
#
|
127
|
+
# When `:credentials` are not configured directly, the following
|
128
|
+
# locations will be searched for credentials:
|
129
|
+
#
|
130
|
+
# * `Aws.config[:credentials]`
|
131
|
+
# * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
|
132
|
+
# `:account_id` options.
|
133
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'],
|
134
|
+
# ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
|
135
|
+
# * `~/.aws/credentials`
|
136
|
+
# * `~/.aws/config`
|
137
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
138
|
+
# are very aggressive. Construct and pass an instance of
|
139
|
+
# `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
|
140
|
+
# enable retries and extended timeouts. Instance profile credential
|
141
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
142
|
+
# to true.
|
143
|
+
#
|
144
|
+
# @option options [required, String] :region
|
145
|
+
# The AWS region to connect to. The configured `:region` is
|
146
|
+
# used to determine the service `:endpoint`. When not passed,
|
147
|
+
# a default `:region` is searched for in the following locations:
|
148
|
+
#
|
149
|
+
# * `Aws.config[:region]`
|
150
|
+
# * `ENV['AWS_REGION']`
|
151
|
+
# * `ENV['AMAZON_REGION']`
|
152
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
153
|
+
# * `~/.aws/credentials`
|
154
|
+
# * `~/.aws/config`
|
155
|
+
#
|
156
|
+
# @option options [String] :access_key_id
|
157
|
+
#
|
158
|
+
# @option options [String] :account_id
|
159
|
+
#
|
160
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
161
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
162
|
+
# the background every 60 secs (default). Defaults to `false`.
|
163
|
+
#
|
164
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
165
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
166
|
+
# until there is sufficent client side capacity to retry the request.
|
167
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
168
|
+
# not retry instead of sleeping.
|
169
|
+
#
|
170
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
171
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
172
|
+
# this client.
|
173
|
+
#
|
174
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
175
|
+
# Allows you to provide an identifier for this client which will be attached to
|
176
|
+
# all generated client side metrics. Defaults to an empty string.
|
177
|
+
#
|
178
|
+
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
|
179
|
+
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
|
180
|
+
# side monitoring agent is running on, where client metrics will be published via UDP.
|
181
|
+
#
|
182
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
183
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
184
|
+
# agent is running on, where client metrics will be published via UDP.
|
185
|
+
#
|
186
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
187
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
188
|
+
# will use the Client Side Monitoring Agent Publisher.
|
189
|
+
#
|
190
|
+
# @option options [Boolean] :convert_params (true)
|
191
|
+
# When `true`, an attempt is made to coerce request parameters into
|
192
|
+
# the required types.
|
193
|
+
#
|
194
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
195
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
196
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
197
|
+
#
|
198
|
+
# @option options [String] :defaults_mode ("legacy")
|
199
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
200
|
+
# accepted modes and the configuration defaults that are included.
|
201
|
+
#
|
202
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
203
|
+
# Set to true to disable SDK automatically adding host prefix
|
204
|
+
# to default service endpoint when available.
|
205
|
+
#
|
206
|
+
# @option options [Boolean] :disable_request_compression (false)
|
207
|
+
# When set to 'true' the request body will not be compressed
|
208
|
+
# for supported operations.
|
209
|
+
#
|
210
|
+
# @option options [String, URI::HTTPS, URI::HTTP] :endpoint
|
211
|
+
# Normally you should not configure the `:endpoint` option
|
212
|
+
# directly. This is normally constructed from the `:region`
|
213
|
+
# option. Configuring `:endpoint` is normally reserved for
|
214
|
+
# connecting to test or custom endpoints. The endpoint should
|
215
|
+
# be a URI formatted like:
|
216
|
+
#
|
217
|
+
# 'http://example.com'
|
218
|
+
# 'https://example.com'
|
219
|
+
# 'http://example.com:123'
|
220
|
+
#
|
221
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
222
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
223
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
224
|
+
#
|
225
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
226
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
227
|
+
#
|
228
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
229
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
230
|
+
# Use this option to config the time interval in seconds for making
|
231
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
232
|
+
#
|
233
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
234
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
235
|
+
#
|
236
|
+
# @option options [Boolean] :ignore_configured_endpoint_urls
|
237
|
+
# Setting to true disables use of endpoint URLs provided via environment
|
238
|
+
# variables and the shared configuration file.
|
239
|
+
#
|
240
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
241
|
+
# The log formatter.
|
242
|
+
#
|
243
|
+
# @option options [Symbol] :log_level (:info)
|
244
|
+
# The log level to send messages to the `:logger` at.
|
245
|
+
#
|
246
|
+
# @option options [Logger] :logger
|
247
|
+
# The Logger instance to send log messages to. If this option
|
248
|
+
# is not set, logging will be disabled.
|
249
|
+
#
|
250
|
+
# @option options [Integer] :max_attempts (3)
|
251
|
+
# An integer representing the maximum number attempts that will be made for
|
252
|
+
# a single request, including the initial attempt. For example,
|
253
|
+
# setting this value to 5 will result in a request being retried up to
|
254
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
255
|
+
#
|
256
|
+
# @option options [String] :profile ("default")
|
257
|
+
# Used when loading credentials from the shared credentials file
|
258
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
259
|
+
#
|
260
|
+
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
261
|
+
# The minimum size in bytes that triggers compression for request
|
262
|
+
# bodies. The value must be non-negative integer value between 0
|
263
|
+
# and 10485780 bytes inclusive.
|
264
|
+
#
|
265
|
+
# @option options [Proc] :retry_backoff
|
266
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
267
|
+
# This option is only used in the `legacy` retry mode.
|
268
|
+
#
|
269
|
+
# @option options [Float] :retry_base_delay (0.3)
|
270
|
+
# The base delay in seconds used by the default backoff function. This option
|
271
|
+
# is only used in the `legacy` retry mode.
|
272
|
+
#
|
273
|
+
# @option options [Symbol] :retry_jitter (:none)
|
274
|
+
# A delay randomiser function used by the default backoff function.
|
275
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
276
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
277
|
+
# in the `legacy` retry mode.
|
278
|
+
#
|
279
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
280
|
+
#
|
281
|
+
# @option options [Integer] :retry_limit (3)
|
282
|
+
# The maximum number of times to retry failed requests. Only
|
283
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
284
|
+
# are retried. Generally, these are throttling errors, data
|
285
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
286
|
+
# endpoint discovery, and errors from expired credentials.
|
287
|
+
# This option is only used in the `legacy` retry mode.
|
288
|
+
#
|
289
|
+
# @option options [Integer] :retry_max_delay (0)
|
290
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
291
|
+
# used by the default backoff function. This option is only used in the
|
292
|
+
# `legacy` retry mode.
|
293
|
+
#
|
294
|
+
# @option options [String] :retry_mode ("legacy")
|
295
|
+
# Specifies which retry algorithm to use. Values are:
|
296
|
+
#
|
297
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
298
|
+
# no retry mode is provided.
|
299
|
+
#
|
300
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
301
|
+
# This includes support for retry quotas, which limit the number of
|
302
|
+
# unsuccessful retries a client can make.
|
303
|
+
#
|
304
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
305
|
+
# functionality of `standard` mode along with automatic client side
|
306
|
+
# throttling. This is a provisional mode that may change behavior
|
307
|
+
# in the future.
|
308
|
+
#
|
309
|
+
# @option options [String] :sdk_ua_app_id
|
310
|
+
# A unique and opaque application ID that is appended to the
|
311
|
+
# User-Agent header as app/sdk_ua_app_id. It should have a
|
312
|
+
# maximum length of 50. This variable is sourced from environment
|
313
|
+
# variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
|
314
|
+
#
|
315
|
+
# @option options [String] :secret_access_key
|
316
|
+
#
|
317
|
+
# @option options [String] :session_token
|
318
|
+
#
|
319
|
+
# @option options [Array] :sigv4a_signing_region_set
|
320
|
+
# A list of regions that should be signed with SigV4a signing. When
|
321
|
+
# not passed, a default `:sigv4a_signing_region_set` is searched for
|
322
|
+
# in the following locations:
|
323
|
+
#
|
324
|
+
# * `Aws.config[:sigv4a_signing_region_set]`
|
325
|
+
# * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']`
|
326
|
+
# * `~/.aws/config`
|
327
|
+
#
|
328
|
+
# @option options [Boolean] :stub_responses (false)
|
329
|
+
# Causes the client to return stubbed responses. By default
|
330
|
+
# fake responses are generated and returned. You can specify
|
331
|
+
# the response data to return or errors to raise by calling
|
332
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
333
|
+
#
|
334
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
335
|
+
# requests are made, and retries are disabled.
|
336
|
+
#
|
337
|
+
# @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
|
338
|
+
# Allows you to provide a telemetry provider, which is used to
|
339
|
+
# emit telemetry data. By default, uses `NoOpTelemetryProvider` which
|
340
|
+
# will not record or emit any telemetry data. The SDK supports the
|
341
|
+
# following telemetry providers:
|
342
|
+
#
|
343
|
+
# * OpenTelemetry (OTel) - To use the OTel provider, install and require the
|
344
|
+
# `opentelemetry-sdk` gem and then, pass in an instance of a
|
345
|
+
# `Aws::Telemetry::OTelProvider` for telemetry provider.
|
346
|
+
#
|
347
|
+
# @option options [Aws::TokenProvider] :token_provider
|
348
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
349
|
+
# following classes:
|
350
|
+
#
|
351
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
352
|
+
# tokens.
|
353
|
+
#
|
354
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
355
|
+
# access token generated from `aws login`.
|
356
|
+
#
|
357
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
358
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
359
|
+
#
|
360
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
361
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
362
|
+
# will be used if available.
|
363
|
+
#
|
364
|
+
# @option options [Boolean] :use_fips_endpoint
|
365
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
366
|
+
# When a `fips` region is used, the region is normalized and this config
|
367
|
+
# is set to `true`.
|
368
|
+
#
|
369
|
+
# @option options [Boolean] :validate_params (true)
|
370
|
+
# When `true`, request parameters are validated before
|
371
|
+
# sending the request.
|
372
|
+
#
|
373
|
+
# @option options [Aws::GeoMaps::EndpointProvider] :endpoint_provider
|
374
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to
|
375
|
+
# `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
|
376
|
+
# `Aws::GeoMaps::EndpointParameters`.
|
377
|
+
#
|
378
|
+
# @option options [Float] :http_continue_timeout (1)
|
379
|
+
# The number of seconds to wait for a 100-continue response before sending the
|
380
|
+
# request body. This option has no effect unless the request has "Expect"
|
381
|
+
# header set to "100-continue". Defaults to `nil` which disables this
|
382
|
+
# behaviour. This value can safely be set per request on the session.
|
383
|
+
#
|
384
|
+
# @option options [Float] :http_idle_timeout (5)
|
385
|
+
# The number of seconds a connection is allowed to sit idle before it
|
386
|
+
# is considered stale. Stale connections are closed and removed from the
|
387
|
+
# pool before making a request.
|
388
|
+
#
|
389
|
+
# @option options [Float] :http_open_timeout (15)
|
390
|
+
# The default number of seconds to wait for response data.
|
391
|
+
# This value can safely be set per-request on the session.
|
392
|
+
#
|
393
|
+
# @option options [URI::HTTP,String] :http_proxy
|
394
|
+
# A proxy to send requests through. Formatted like 'http://proxy.com:123'.
|
395
|
+
#
|
396
|
+
# @option options [Float] :http_read_timeout (60)
|
397
|
+
# The default number of seconds to wait for response data.
|
398
|
+
# This value can safely be set per-request on the session.
|
399
|
+
#
|
400
|
+
# @option options [Boolean] :http_wire_trace (false)
|
401
|
+
# When `true`, HTTP debug output will be sent to the `:logger`.
|
402
|
+
#
|
403
|
+
# @option options [Proc] :on_chunk_received
|
404
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
405
|
+
# of the response body is received. It provides three arguments: the chunk,
|
406
|
+
# the number of bytes received, and the total number of
|
407
|
+
# bytes in the response (or nil if the server did not send a `content-length`).
|
408
|
+
#
|
409
|
+
# @option options [Proc] :on_chunk_sent
|
410
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
411
|
+
# of the request body is sent. It provides three arguments: the chunk,
|
412
|
+
# the number of bytes read from the body, and the total number of
|
413
|
+
# bytes in the body.
|
414
|
+
#
|
415
|
+
# @option options [Boolean] :raise_response_errors (true)
|
416
|
+
# When `true`, response errors are raised.
|
417
|
+
#
|
418
|
+
# @option options [String] :ssl_ca_bundle
|
419
|
+
# Full path to the SSL certificate authority bundle file that should be used when
|
420
|
+
# verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
|
421
|
+
# `:ssl_ca_directory` the the system default will be used if available.
|
422
|
+
#
|
423
|
+
# @option options [String] :ssl_ca_directory
|
424
|
+
# Full path of the directory that contains the unbundled SSL certificate
|
425
|
+
# authority files for verifying peer certificates. If you do
|
426
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
|
427
|
+
# default will be used if available.
|
428
|
+
#
|
429
|
+
# @option options [String] :ssl_ca_store
|
430
|
+
# Sets the X509::Store to verify peer certificate.
|
431
|
+
#
|
432
|
+
# @option options [OpenSSL::X509::Certificate] :ssl_cert
|
433
|
+
# Sets a client certificate when creating http connections.
|
434
|
+
#
|
435
|
+
# @option options [OpenSSL::PKey] :ssl_key
|
436
|
+
# Sets a client key when creating http connections.
|
437
|
+
#
|
438
|
+
# @option options [Float] :ssl_timeout
|
439
|
+
# Sets the SSL timeout in seconds
|
440
|
+
#
|
441
|
+
# @option options [Boolean] :ssl_verify_peer (true)
|
442
|
+
# When `true`, SSL peer certificates are verified when establishing a connection.
|
443
|
+
#
|
444
|
+
def initialize(*args)
|
445
|
+
super
|
446
|
+
end
|
447
|
+
|
448
|
+
# @!group API Operations
|
449
|
+
|
450
|
+
# Returns the map's glyphs.
|
451
|
+
#
|
452
|
+
# @option params [required, String] :font_stack
|
453
|
+
# Name of the `FontStack` to retrieve.
|
454
|
+
#
|
455
|
+
# Example: `Amazon Ember Bold,Noto Sans Bold`.
|
456
|
+
#
|
457
|
+
# The supported font stacks are as follows:
|
458
|
+
#
|
459
|
+
# * Amazon Ember Bold
|
460
|
+
#
|
461
|
+
# * Amazon Ember Bold Italic
|
462
|
+
#
|
463
|
+
# * Amazon Ember Bold,Noto Sans Bold
|
464
|
+
#
|
465
|
+
# * Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold
|
466
|
+
#
|
467
|
+
# * Amazon Ember Condensed RC BdItalic
|
468
|
+
#
|
469
|
+
# * Amazon Ember Condensed RC Bold
|
470
|
+
#
|
471
|
+
# * Amazon Ember Condensed RC Bold Italic
|
472
|
+
#
|
473
|
+
# * Amazon Ember Condensed RC Bold,Noto Sans Bold
|
474
|
+
#
|
475
|
+
# * Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic
|
476
|
+
# Condensed Bold
|
477
|
+
#
|
478
|
+
# * Amazon Ember Condensed RC Light
|
479
|
+
#
|
480
|
+
# * Amazon Ember Condensed RC Light Italic
|
481
|
+
#
|
482
|
+
# * Amazon Ember Condensed RC LtItalic
|
483
|
+
#
|
484
|
+
# * Amazon Ember Condensed RC Regular
|
485
|
+
#
|
486
|
+
# * Amazon Ember Condensed RC Regular Italic
|
487
|
+
#
|
488
|
+
# * Amazon Ember Condensed RC Regular,Noto Sans Regular
|
489
|
+
#
|
490
|
+
# * Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic
|
491
|
+
# Condensed Regular
|
492
|
+
#
|
493
|
+
# * Amazon Ember Condensed RC RgItalic
|
494
|
+
#
|
495
|
+
# * Amazon Ember Condensed RC ThItalic
|
496
|
+
#
|
497
|
+
# * Amazon Ember Condensed RC Thin
|
498
|
+
#
|
499
|
+
# * Amazon Ember Condensed RC Thin Italic
|
500
|
+
#
|
501
|
+
# * Amazon Ember Heavy
|
502
|
+
#
|
503
|
+
# * Amazon Ember Heavy Italic
|
504
|
+
#
|
505
|
+
# * Amazon Ember Light
|
506
|
+
#
|
507
|
+
# * Amazon Ember Light Italic
|
508
|
+
#
|
509
|
+
# * Amazon Ember Medium
|
510
|
+
#
|
511
|
+
# * Amazon Ember Medium Italic
|
512
|
+
#
|
513
|
+
# * Amazon Ember Medium,Noto Sans Medium
|
514
|
+
#
|
515
|
+
# * Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium
|
516
|
+
#
|
517
|
+
# * Amazon Ember Regular
|
518
|
+
#
|
519
|
+
# * Amazon Ember Regular Italic
|
520
|
+
#
|
521
|
+
# * Amazon Ember Regular Italic,Noto Sans Italic
|
522
|
+
#
|
523
|
+
# * Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic
|
524
|
+
# Regular
|
525
|
+
#
|
526
|
+
# * Amazon Ember Regular,Noto Sans Regular
|
527
|
+
#
|
528
|
+
# * Amazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular
|
529
|
+
#
|
530
|
+
# * Amazon Ember Thin
|
531
|
+
#
|
532
|
+
# * Amazon Ember Thin Italic
|
533
|
+
#
|
534
|
+
# * AmazonEmberCdRC\_Bd
|
535
|
+
#
|
536
|
+
# * AmazonEmberCdRC\_BdIt
|
537
|
+
#
|
538
|
+
# * AmazonEmberCdRC\_Lt
|
539
|
+
#
|
540
|
+
# * AmazonEmberCdRC\_LtIt
|
541
|
+
#
|
542
|
+
# * AmazonEmberCdRC\_Rg
|
543
|
+
#
|
544
|
+
# * AmazonEmberCdRC\_RgIt
|
545
|
+
#
|
546
|
+
# * AmazonEmberCdRC\_Th
|
547
|
+
#
|
548
|
+
# * AmazonEmberCdRC\_ThIt
|
549
|
+
#
|
550
|
+
# * AmazonEmber\_Bd
|
551
|
+
#
|
552
|
+
# * AmazonEmber\_BdIt
|
553
|
+
#
|
554
|
+
# * AmazonEmber\_He
|
555
|
+
#
|
556
|
+
# * AmazonEmber\_HeIt
|
557
|
+
#
|
558
|
+
# * AmazonEmber\_Lt
|
559
|
+
#
|
560
|
+
# * AmazonEmber\_LtIt
|
561
|
+
#
|
562
|
+
# * AmazonEmber\_Md
|
563
|
+
#
|
564
|
+
# * AmazonEmber\_MdIt
|
565
|
+
#
|
566
|
+
# * AmazonEmber\_Rg
|
567
|
+
#
|
568
|
+
# * AmazonEmber\_RgIt
|
569
|
+
#
|
570
|
+
# * AmazonEmber\_Th
|
571
|
+
#
|
572
|
+
# * AmazonEmber\_ThIt
|
573
|
+
#
|
574
|
+
# * Noto Sans Black
|
575
|
+
#
|
576
|
+
# * Noto Sans Black Italic
|
577
|
+
#
|
578
|
+
# * Noto Sans Bold
|
579
|
+
#
|
580
|
+
# * Noto Sans Bold Italic
|
581
|
+
#
|
582
|
+
# * Noto Sans Extra Bold
|
583
|
+
#
|
584
|
+
# * Noto Sans Extra Bold Italic
|
585
|
+
#
|
586
|
+
# * Noto Sans Extra Light
|
587
|
+
#
|
588
|
+
# * Noto Sans Extra Light Italic
|
589
|
+
#
|
590
|
+
# * Noto Sans Italic
|
591
|
+
#
|
592
|
+
# * Noto Sans Light
|
593
|
+
#
|
594
|
+
# * Noto Sans Light Italic
|
595
|
+
#
|
596
|
+
# * Noto Sans Medium
|
597
|
+
#
|
598
|
+
# * Noto Sans Medium Italic
|
599
|
+
#
|
600
|
+
# * Noto Sans Regular
|
601
|
+
#
|
602
|
+
# * Noto Sans Semi Bold
|
603
|
+
#
|
604
|
+
# * Noto Sans Semi Bold Italic
|
605
|
+
#
|
606
|
+
# * Noto Sans Thin
|
607
|
+
#
|
608
|
+
# * Noto Sans Thin Italic
|
609
|
+
#
|
610
|
+
# * NotoSans-Bold
|
611
|
+
#
|
612
|
+
# * NotoSans-Italic
|
613
|
+
#
|
614
|
+
# * NotoSans-Medium
|
615
|
+
#
|
616
|
+
# * NotoSans-Regular
|
617
|
+
#
|
618
|
+
# * Open Sans Regular,Arial Unicode MS Regular
|
619
|
+
#
|
620
|
+
# @option params [required, String] :font_unicode_range
|
621
|
+
# A Unicode range of characters to download glyphs for. This must be
|
622
|
+
# aligned to multiples of 256.
|
623
|
+
#
|
624
|
+
# Example: `0-255.pdf`
|
625
|
+
#
|
626
|
+
# @return [Types::GetGlyphsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
627
|
+
#
|
628
|
+
# * {Types::GetGlyphsResponse#blob #blob} => IO
|
629
|
+
# * {Types::GetGlyphsResponse#content_type #content_type} => String
|
630
|
+
# * {Types::GetGlyphsResponse#cache_control #cache_control} => String
|
631
|
+
# * {Types::GetGlyphsResponse#etag #etag} => String
|
632
|
+
#
|
633
|
+
# @example Request syntax with placeholder values
|
634
|
+
#
|
635
|
+
# resp = client.get_glyphs({
|
636
|
+
# font_stack: "GetGlyphsRequestFontStackString", # required
|
637
|
+
# font_unicode_range: "GetGlyphsRequestFontUnicodeRangeString", # required
|
638
|
+
# })
|
639
|
+
#
|
640
|
+
# @example Response structure
|
641
|
+
#
|
642
|
+
# resp.blob #=> IO
|
643
|
+
# resp.content_type #=> String
|
644
|
+
# resp.cache_control #=> String
|
645
|
+
# resp.etag #=> String
|
646
|
+
#
|
647
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-maps-2020-11-19/GetGlyphs AWS API Documentation
|
648
|
+
#
|
649
|
+
# @overload get_glyphs(params = {})
|
650
|
+
# @param [Hash] params ({})
|
651
|
+
def get_glyphs(params = {}, options = {}, &block)
|
652
|
+
req = build_request(:get_glyphs, params)
|
653
|
+
req.send_request(options, &block)
|
654
|
+
end
|
655
|
+
|
656
|
+
# Returns the map's sprites.
|
657
|
+
#
|
658
|
+
# @option params [required, String] :file_name
|
659
|
+
# `Sprites` API: The name of the sprite file to retrieve, following
|
660
|
+
# pattern `sprites(@2x)?\.(png|json)`.
|
661
|
+
#
|
662
|
+
# Example: `sprites.png`
|
663
|
+
#
|
664
|
+
# @option params [required, String] :style
|
665
|
+
# Style specifies the desired map style for the `Sprites` APIs.
|
666
|
+
#
|
667
|
+
# @option params [required, String] :color_scheme
|
668
|
+
# Sets color tone for map such as dark and light for specific map
|
669
|
+
# styles. It applies to only vector map styles such as Standard and
|
670
|
+
# Monochrome.
|
671
|
+
#
|
672
|
+
# Example: `Light`
|
673
|
+
#
|
674
|
+
# Default value: `Light`
|
675
|
+
#
|
676
|
+
# <note markdown="1"> Valid values for ColorScheme are case sensitive.
|
677
|
+
#
|
678
|
+
# </note>
|
679
|
+
#
|
680
|
+
# @option params [required, String] :variant
|
681
|
+
# Optimizes map styles for specific use case or industry. You can choose
|
682
|
+
# allowed variant only with Standard map style.
|
683
|
+
#
|
684
|
+
# Example: `Default`
|
685
|
+
#
|
686
|
+
# <note markdown="1"> Valid values for Variant are case sensitive.
|
687
|
+
#
|
688
|
+
# </note>
|
689
|
+
#
|
690
|
+
# @return [Types::GetSpritesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
691
|
+
#
|
692
|
+
# * {Types::GetSpritesResponse#blob #blob} => IO
|
693
|
+
# * {Types::GetSpritesResponse#content_type #content_type} => String
|
694
|
+
# * {Types::GetSpritesResponse#cache_control #cache_control} => String
|
695
|
+
# * {Types::GetSpritesResponse#etag #etag} => String
|
696
|
+
#
|
697
|
+
# @example Request syntax with placeholder values
|
698
|
+
#
|
699
|
+
# resp = client.get_sprites({
|
700
|
+
# file_name: "GetSpritesRequestFileNameString", # required
|
701
|
+
# style: "Standard", # required, accepts Standard, Monochrome, Hybrid, Satellite
|
702
|
+
# color_scheme: "Light", # required, accepts Light, Dark
|
703
|
+
# variant: "Default", # required, accepts Default
|
704
|
+
# })
|
705
|
+
#
|
706
|
+
# @example Response structure
|
707
|
+
#
|
708
|
+
# resp.blob #=> IO
|
709
|
+
# resp.content_type #=> String
|
710
|
+
# resp.cache_control #=> String
|
711
|
+
# resp.etag #=> String
|
712
|
+
#
|
713
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-maps-2020-11-19/GetSprites AWS API Documentation
|
714
|
+
#
|
715
|
+
# @overload get_sprites(params = {})
|
716
|
+
# @param [Hash] params ({})
|
717
|
+
def get_sprites(params = {}, options = {}, &block)
|
718
|
+
req = build_request(:get_sprites, params)
|
719
|
+
req.send_request(options, &block)
|
720
|
+
end
|
721
|
+
|
722
|
+
# Provides high-quality static map images with customizable options. You
|
723
|
+
# can modify the map's appearance and overlay additional information.
|
724
|
+
# It's an ideal solution for applications requiring tailored static map
|
725
|
+
# snapshots.
|
726
|
+
#
|
727
|
+
# @option params [String] :bounding_box
|
728
|
+
# Takes in two pairs of coordinates, \[Lon, Lat\], denoting
|
729
|
+
# south-westerly and north-easterly edges of the image. The underlying
|
730
|
+
# area becomes the view of the image.
|
731
|
+
#
|
732
|
+
# Example: -123.17075,49.26959,-123.08125,49.31429
|
733
|
+
#
|
734
|
+
# @option params [String] :bounded_positions
|
735
|
+
# Takes in two or more pair of coordinates, \[Lon, Lat\], with each
|
736
|
+
# coordinate separated by a comma. The API will generate an image to
|
737
|
+
# encompass all of the provided coordinates.
|
738
|
+
#
|
739
|
+
# <note markdown="1"> Cannot be used with `Zoom` and or `Radius`
|
740
|
+
#
|
741
|
+
# </note>
|
742
|
+
#
|
743
|
+
# Example: 97.170451,78.039098,99.045536,27.176178
|
744
|
+
#
|
745
|
+
# @option params [String] :center
|
746
|
+
# Takes in a pair of coordinates, \[Lon, Lat\], which becomes the center
|
747
|
+
# point of the image. This parameter requires that either zoom or radius
|
748
|
+
# is set.
|
749
|
+
#
|
750
|
+
# <note markdown="1"> Cannot be used with `Zoom` and or `Radius`
|
751
|
+
#
|
752
|
+
# </note>
|
753
|
+
#
|
754
|
+
# Example: 49.295,-123.108
|
755
|
+
#
|
756
|
+
# @option params [String] :compact_overlay
|
757
|
+
# Takes in a string to draw geometries on the image. The input is a
|
758
|
+
# comma separated format as follows format: `[Lon, Lat]`
|
759
|
+
#
|
760
|
+
# Example:
|
761
|
+
# `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
|
762
|
+
# Hill Market;size=large;text-color=%23DD0000;color=#EE4B2B`
|
763
|
+
#
|
764
|
+
# <note markdown="1"> Currently it supports the following geometry types: point, line and
|
765
|
+
# polygon. It does not support multiPoint , multiLine and multiPolgyon.
|
766
|
+
#
|
767
|
+
# </note>
|
768
|
+
#
|
769
|
+
# @option params [String] :geo_json_overlay
|
770
|
+
# Takes in a string to draw geometries on the image. The input is a
|
771
|
+
# valid GeoJSON collection object.
|
772
|
+
#
|
773
|
+
# Example: `\{"type":"FeatureCollection","features":
|
774
|
+
# [\{"type":"Feature","geometry":\{"type":"MultiPoint","coordinates":
|
775
|
+
# [[-90.076345,51.504107],[-0.074451,51.506892]]\},"properties":
|
776
|
+
# \{"color":"#00DD00"\}\}]\}`
|
777
|
+
#
|
778
|
+
# @option params [required, Integer] :height
|
779
|
+
# Specifies the height of the map image.
|
780
|
+
#
|
781
|
+
# @option params [String] :key
|
782
|
+
# Optional: The API key to be used for authorization. Either an API key
|
783
|
+
# or valid SigV4 signature must be provided when making a request.
|
784
|
+
#
|
785
|
+
# @option params [Integer] :padding
|
786
|
+
# Applies additional space (in pixels) around overlay feature to prevent
|
787
|
+
# them from being cut or obscured.
|
788
|
+
#
|
789
|
+
# <note markdown="1"> Value for max and min is determined by:
|
790
|
+
#
|
791
|
+
# Min: `1`
|
792
|
+
#
|
793
|
+
# Max: `min(height, width)/4`
|
794
|
+
#
|
795
|
+
# </note>
|
796
|
+
#
|
797
|
+
# Example: `100`
|
798
|
+
#
|
799
|
+
# @option params [Integer] :radius
|
800
|
+
# Used with center parameter, it specifies the zoom of the image where
|
801
|
+
# you can control it on a granular level. Takes in any value `>= 1`.
|
802
|
+
#
|
803
|
+
# Example: `1500`
|
804
|
+
#
|
805
|
+
# <note markdown="1"> Cannot be used with `Zoom`.
|
806
|
+
#
|
807
|
+
# </note>
|
808
|
+
#
|
809
|
+
# **Unit**: `Meters`
|
810
|
+
#
|
811
|
+
# @option params [required, String] :file_name
|
812
|
+
# The map scaling parameter to size the image, icons, and labels. It
|
813
|
+
# follows the pattern of `^map(@2x)?$`.
|
814
|
+
#
|
815
|
+
# Example: `map, map@2x`
|
816
|
+
#
|
817
|
+
# @option params [String] :scale_bar_unit
|
818
|
+
# Displays a scale on the bottom right of the map image with the unit
|
819
|
+
# specified in the input.
|
820
|
+
#
|
821
|
+
# Example: `KilometersMiles, Miles, Kilometers, MilesKilometers`
|
822
|
+
#
|
823
|
+
# @option params [String] :style
|
824
|
+
# Style specifies the desired map style for the `Style` APIs.
|
825
|
+
#
|
826
|
+
# @option params [required, Integer] :width
|
827
|
+
# Specifies the width of the map image.
|
828
|
+
#
|
829
|
+
# @option params [Float] :zoom
|
830
|
+
# Specifies the zoom level of the map image.
|
831
|
+
#
|
832
|
+
# <note markdown="1"> Cannot be used with `Radius`.
|
833
|
+
#
|
834
|
+
# </note>
|
835
|
+
#
|
836
|
+
# @return [Types::GetStaticMapResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
837
|
+
#
|
838
|
+
# * {Types::GetStaticMapResponse#blob #blob} => IO
|
839
|
+
# * {Types::GetStaticMapResponse#content_type #content_type} => String
|
840
|
+
# * {Types::GetStaticMapResponse#cache_control #cache_control} => String
|
841
|
+
# * {Types::GetStaticMapResponse#etag #etag} => String
|
842
|
+
# * {Types::GetStaticMapResponse#pricing_bucket #pricing_bucket} => String
|
843
|
+
#
|
844
|
+
# @example Request syntax with placeholder values
|
845
|
+
#
|
846
|
+
# resp = client.get_static_map({
|
847
|
+
# bounding_box: "PositionListString",
|
848
|
+
# bounded_positions: "PositionListString",
|
849
|
+
# center: "PositionString",
|
850
|
+
# compact_overlay: "CompactOverlay",
|
851
|
+
# geo_json_overlay: "GeoJsonOverlay",
|
852
|
+
# height: 1, # required
|
853
|
+
# key: "ApiKey",
|
854
|
+
# padding: 1,
|
855
|
+
# radius: 1,
|
856
|
+
# file_name: "GetStaticMapRequestFileNameString", # required
|
857
|
+
# scale_bar_unit: "Kilometers", # accepts Kilometers, KilometersMiles, Miles, MilesKilometers
|
858
|
+
# style: "Satellite", # accepts Satellite
|
859
|
+
# width: 1, # required
|
860
|
+
# zoom: 1.0,
|
861
|
+
# })
|
862
|
+
#
|
863
|
+
# @example Response structure
|
864
|
+
#
|
865
|
+
# resp.blob #=> IO
|
866
|
+
# resp.content_type #=> String
|
867
|
+
# resp.cache_control #=> String
|
868
|
+
# resp.etag #=> String
|
869
|
+
# resp.pricing_bucket #=> String
|
870
|
+
#
|
871
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-maps-2020-11-19/GetStaticMap AWS API Documentation
|
872
|
+
#
|
873
|
+
# @overload get_static_map(params = {})
|
874
|
+
# @param [Hash] params ({})
|
875
|
+
def get_static_map(params = {}, options = {}, &block)
|
876
|
+
req = build_request(:get_static_map, params)
|
877
|
+
req.send_request(options, &block)
|
878
|
+
end
|
879
|
+
|
880
|
+
# Returns information about the style.
|
881
|
+
#
|
882
|
+
# @option params [required, String] :style
|
883
|
+
# Style specifies the desired map style.
|
884
|
+
#
|
885
|
+
# @option params [String] :color_scheme
|
886
|
+
# Sets color tone for map such as dark and light for specific map
|
887
|
+
# styles. It applies to only vector map styles such as Standard and
|
888
|
+
# Monochrome.
|
889
|
+
#
|
890
|
+
# Example: `Light`
|
891
|
+
#
|
892
|
+
# Default value: `Light`
|
893
|
+
#
|
894
|
+
# <note markdown="1"> Valid values for ColorScheme are case sensitive.
|
895
|
+
#
|
896
|
+
# </note>
|
897
|
+
#
|
898
|
+
# @option params [String] :political_view
|
899
|
+
# Specifies the political view using ISO 3166-2 or ISO 3166-3 country
|
900
|
+
# code format.
|
901
|
+
#
|
902
|
+
# The following political views are currently supported:
|
903
|
+
#
|
904
|
+
# * `ARG`: Argentina's view on the Southern Patagonian Ice Field and
|
905
|
+
# Tierra Del Fuego, including the Falkland Islands, South Georgia, and
|
906
|
+
# South Sandwich Islands
|
907
|
+
#
|
908
|
+
# * `EGY`: Egypt's view on Bir Tawil
|
909
|
+
#
|
910
|
+
# * `IND`: India's view on Gilgit-Baltistan
|
911
|
+
#
|
912
|
+
# * `KEN`: Kenya's view on the Ilemi Triangle
|
913
|
+
#
|
914
|
+
# * `MAR`: Morocco's view on Western Sahara
|
915
|
+
#
|
916
|
+
# * `PAK`: Pakistan's view on Jammu and Kashmir and the Junagadh Area
|
917
|
+
#
|
918
|
+
# * `RUS`: Russia's view on Crimea
|
919
|
+
#
|
920
|
+
# * `SDN`: Sudan's view on the Halaib Triangle
|
921
|
+
#
|
922
|
+
# * `SRB`: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands
|
923
|
+
#
|
924
|
+
# * `SUR`: Suriname's view on the Courantyne Headwaters and Lawa
|
925
|
+
# Headwaters
|
926
|
+
#
|
927
|
+
# * `SYR`: Syria's view on the Golan Heights
|
928
|
+
#
|
929
|
+
# * `TUR`: Turkey's view on Cyprus and Northern Cyprus
|
930
|
+
#
|
931
|
+
# * `TZA`: Tanzania's view on Lake Malawi
|
932
|
+
#
|
933
|
+
# * `URY`: Uruguay's view on Rincon de Artigas
|
934
|
+
#
|
935
|
+
# * `VNM`: Vietnam's view on the Paracel Islands and Spratly Islands
|
936
|
+
#
|
937
|
+
# @option params [String] :key
|
938
|
+
# Optional: The API key to be used for authorization. Either an API key
|
939
|
+
# or valid SigV4 signature must be provided when making a request.
|
940
|
+
#
|
941
|
+
# @return [Types::GetStyleDescriptorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
942
|
+
#
|
943
|
+
# * {Types::GetStyleDescriptorResponse#blob #blob} => IO
|
944
|
+
# * {Types::GetStyleDescriptorResponse#content_type #content_type} => String
|
945
|
+
# * {Types::GetStyleDescriptorResponse#cache_control #cache_control} => String
|
946
|
+
# * {Types::GetStyleDescriptorResponse#etag #etag} => String
|
947
|
+
#
|
948
|
+
# @example Request syntax with placeholder values
|
949
|
+
#
|
950
|
+
# resp = client.get_style_descriptor({
|
951
|
+
# style: "Standard", # required, accepts Standard, Monochrome, Hybrid, Satellite
|
952
|
+
# color_scheme: "Light", # accepts Light, Dark
|
953
|
+
# political_view: "CountryCode",
|
954
|
+
# key: "ApiKey",
|
955
|
+
# })
|
956
|
+
#
|
957
|
+
# @example Response structure
|
958
|
+
#
|
959
|
+
# resp.blob #=> IO
|
960
|
+
# resp.content_type #=> String
|
961
|
+
# resp.cache_control #=> String
|
962
|
+
# resp.etag #=> String
|
963
|
+
#
|
964
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-maps-2020-11-19/GetStyleDescriptor AWS API Documentation
|
965
|
+
#
|
966
|
+
# @overload get_style_descriptor(params = {})
|
967
|
+
# @param [Hash] params ({})
|
968
|
+
def get_style_descriptor(params = {}, options = {}, &block)
|
969
|
+
req = build_request(:get_style_descriptor, params)
|
970
|
+
req.send_request(options, &block)
|
971
|
+
end
|
972
|
+
|
973
|
+
# Returns a tile. Map tiles are used by clients to render a map.
|
974
|
+
# they're addressed using a grid arrangement with an X coordinate, Y
|
975
|
+
# coordinate, and Z (zoom) level.
|
976
|
+
#
|
977
|
+
# @option params [required, String] :tileset
|
978
|
+
# Specifies the desired tile set.
|
979
|
+
#
|
980
|
+
# Valid Values: `raster.satellite | vector.basemap`
|
981
|
+
#
|
982
|
+
# @option params [required, String] :z
|
983
|
+
# The zoom value for the map tile.
|
984
|
+
#
|
985
|
+
# @option params [required, String] :x
|
986
|
+
# The X axis value for the map tile. Must be between 0 and 19.
|
987
|
+
#
|
988
|
+
# @option params [required, String] :y
|
989
|
+
# The Y axis value for the map tile.
|
990
|
+
#
|
991
|
+
# @option params [String] :key
|
992
|
+
# Optional: The API key to be used for authorization. Either an API key
|
993
|
+
# or valid SigV4 signature must be provided when making a request.
|
994
|
+
#
|
995
|
+
# @return [Types::GetTileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
996
|
+
#
|
997
|
+
# * {Types::GetTileResponse#blob #blob} => IO
|
998
|
+
# * {Types::GetTileResponse#content_type #content_type} => String
|
999
|
+
# * {Types::GetTileResponse#cache_control #cache_control} => String
|
1000
|
+
# * {Types::GetTileResponse#etag #etag} => String
|
1001
|
+
# * {Types::GetTileResponse#pricing_bucket #pricing_bucket} => String
|
1002
|
+
#
|
1003
|
+
# @example Request syntax with placeholder values
|
1004
|
+
#
|
1005
|
+
# resp = client.get_tile({
|
1006
|
+
# tileset: "Tileset", # required
|
1007
|
+
# z: "GetTileRequestZString", # required
|
1008
|
+
# x: "GetTileRequestXString", # required
|
1009
|
+
# y: "GetTileRequestYString", # required
|
1010
|
+
# key: "ApiKey",
|
1011
|
+
# })
|
1012
|
+
#
|
1013
|
+
# @example Response structure
|
1014
|
+
#
|
1015
|
+
# resp.blob #=> IO
|
1016
|
+
# resp.content_type #=> String
|
1017
|
+
# resp.cache_control #=> String
|
1018
|
+
# resp.etag #=> String
|
1019
|
+
# resp.pricing_bucket #=> String
|
1020
|
+
#
|
1021
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-maps-2020-11-19/GetTile AWS API Documentation
|
1022
|
+
#
|
1023
|
+
# @overload get_tile(params = {})
|
1024
|
+
# @param [Hash] params ({})
|
1025
|
+
def get_tile(params = {}, options = {}, &block)
|
1026
|
+
req = build_request(:get_tile, params)
|
1027
|
+
req.send_request(options, &block)
|
1028
|
+
end
|
1029
|
+
|
1030
|
+
# @!endgroup
|
1031
|
+
|
1032
|
+
# @param params ({})
|
1033
|
+
# @api private
|
1034
|
+
def build_request(operation_name, params = {})
|
1035
|
+
handlers = @handlers.for(operation_name)
|
1036
|
+
tracer = config.telemetry_provider.tracer_provider.tracer(
|
1037
|
+
Aws::Telemetry.module_to_tracer_name('Aws::GeoMaps')
|
1038
|
+
)
|
1039
|
+
context = Seahorse::Client::RequestContext.new(
|
1040
|
+
operation_name: operation_name,
|
1041
|
+
operation: config.api.operation(operation_name),
|
1042
|
+
client: self,
|
1043
|
+
params: params,
|
1044
|
+
config: config,
|
1045
|
+
tracer: tracer
|
1046
|
+
)
|
1047
|
+
context[:gem_name] = 'aws-sdk-geomaps'
|
1048
|
+
context[:gem_version] = '1.0.0'
|
1049
|
+
Seahorse::Client::Request.new(handlers, context)
|
1050
|
+
end
|
1051
|
+
|
1052
|
+
# @api private
|
1053
|
+
# @deprecated
|
1054
|
+
def waiter_names
|
1055
|
+
[]
|
1056
|
+
end
|
1057
|
+
|
1058
|
+
class << self
|
1059
|
+
|
1060
|
+
# @api private
|
1061
|
+
attr_reader :identifier
|
1062
|
+
|
1063
|
+
# @api private
|
1064
|
+
def errors_module
|
1065
|
+
Errors
|
1066
|
+
end
|
1067
|
+
|
1068
|
+
end
|
1069
|
+
end
|
1070
|
+
end
|