aws-sdk-sagemakergeospatial 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.
@@ -0,0 +1,1657 @@
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/jsonvalue_converter.rb'
26
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
31
+ require 'aws-sdk-core/plugins/defaults_mode.rb'
32
+ require 'aws-sdk-core/plugins/recursion_detection.rb'
33
+ require 'aws-sdk-core/plugins/sign.rb'
34
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
35
+
36
+ Aws::Plugins::GlobalConfiguration.add_identifier(:sagemakergeospatial)
37
+
38
+ module Aws::SageMakerGeospatial
39
+ # An API client for SageMakerGeospatial. To construct a client, you need to configure a `:region` and `:credentials`.
40
+ #
41
+ # client = Aws::SageMakerGeospatial::Client.new(
42
+ # region: region_name,
43
+ # credentials: credentials,
44
+ # # ...
45
+ # )
46
+ #
47
+ # For details on configuring region and credentials see
48
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
49
+ #
50
+ # See {#initialize} for a full list of supported configuration options.
51
+ class Client < Seahorse::Client::Base
52
+
53
+ include Aws::ClientStubs
54
+
55
+ @identifier = :sagemakergeospatial
56
+
57
+ set_api(ClientApi::API)
58
+
59
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
60
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
61
+ add_plugin(Aws::Plugins::Logging)
62
+ add_plugin(Aws::Plugins::ParamConverter)
63
+ add_plugin(Aws::Plugins::ParamValidator)
64
+ add_plugin(Aws::Plugins::UserAgent)
65
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
66
+ add_plugin(Aws::Plugins::RetryErrors)
67
+ add_plugin(Aws::Plugins::GlobalConfiguration)
68
+ add_plugin(Aws::Plugins::RegionalEndpoint)
69
+ add_plugin(Aws::Plugins::EndpointDiscovery)
70
+ add_plugin(Aws::Plugins::EndpointPattern)
71
+ add_plugin(Aws::Plugins::ResponsePaging)
72
+ add_plugin(Aws::Plugins::StubResponses)
73
+ add_plugin(Aws::Plugins::IdempotencyToken)
74
+ add_plugin(Aws::Plugins::JsonvalueConverter)
75
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
76
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
77
+ add_plugin(Aws::Plugins::TransferEncoding)
78
+ add_plugin(Aws::Plugins::HttpChecksum)
79
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
80
+ add_plugin(Aws::Plugins::DefaultsMode)
81
+ add_plugin(Aws::Plugins::RecursionDetection)
82
+ add_plugin(Aws::Plugins::Sign)
83
+ add_plugin(Aws::Plugins::Protocols::RestJson)
84
+ add_plugin(Aws::SageMakerGeospatial::Plugins::Endpoints)
85
+
86
+ # @overload initialize(options)
87
+ # @param [Hash] options
88
+ # @option options [required, Aws::CredentialProvider] :credentials
89
+ # Your AWS credentials. This can be an instance of any one of the
90
+ # following classes:
91
+ #
92
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
93
+ # credentials.
94
+ #
95
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
96
+ # shared file, such as `~/.aws/config`.
97
+ #
98
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
99
+ #
100
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
101
+ # assume a role after providing credentials via the web.
102
+ #
103
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
104
+ # access token generated from `aws login`.
105
+ #
106
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
107
+ # process that outputs to stdout.
108
+ #
109
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
110
+ # from an EC2 IMDS on an EC2 instance.
111
+ #
112
+ # * `Aws::ECSCredentials` - Used for loading credentials from
113
+ # instances running in ECS.
114
+ #
115
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
116
+ # from the Cognito Identity service.
117
+ #
118
+ # When `:credentials` are not configured directly, the following
119
+ # locations will be searched for credentials:
120
+ #
121
+ # * `Aws.config[:credentials]`
122
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
123
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
124
+ # * `~/.aws/credentials`
125
+ # * `~/.aws/config`
126
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
127
+ # are very aggressive. Construct and pass an instance of
128
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
129
+ # enable retries and extended timeouts. Instance profile credential
130
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
131
+ # to true.
132
+ #
133
+ # @option options [required, String] :region
134
+ # The AWS region to connect to. The configured `:region` is
135
+ # used to determine the service `:endpoint`. When not passed,
136
+ # a default `:region` is searched for in the following locations:
137
+ #
138
+ # * `Aws.config[:region]`
139
+ # * `ENV['AWS_REGION']`
140
+ # * `ENV['AMAZON_REGION']`
141
+ # * `ENV['AWS_DEFAULT_REGION']`
142
+ # * `~/.aws/credentials`
143
+ # * `~/.aws/config`
144
+ #
145
+ # @option options [String] :access_key_id
146
+ #
147
+ # @option options [Boolean] :active_endpoint_cache (false)
148
+ # When set to `true`, a thread polling for endpoints will be running in
149
+ # the background every 60 secs (default). Defaults to `false`.
150
+ #
151
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
152
+ # Used only in `adaptive` retry mode. When true, the request will sleep
153
+ # until there is sufficent client side capacity to retry the request.
154
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
155
+ # not retry instead of sleeping.
156
+ #
157
+ # @option options [Boolean] :client_side_monitoring (false)
158
+ # When `true`, client-side metrics will be collected for all API requests from
159
+ # this client.
160
+ #
161
+ # @option options [String] :client_side_monitoring_client_id ("")
162
+ # Allows you to provide an identifier for this client which will be attached to
163
+ # all generated client side metrics. Defaults to an empty string.
164
+ #
165
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
166
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
167
+ # side monitoring agent is running on, where client metrics will be published via UDP.
168
+ #
169
+ # @option options [Integer] :client_side_monitoring_port (31000)
170
+ # Required for publishing client metrics. The port that the client side monitoring
171
+ # agent is running on, where client metrics will be published via UDP.
172
+ #
173
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
174
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
175
+ # will use the Client Side Monitoring Agent Publisher.
176
+ #
177
+ # @option options [Boolean] :convert_params (true)
178
+ # When `true`, an attempt is made to coerce request parameters into
179
+ # the required types.
180
+ #
181
+ # @option options [Boolean] :correct_clock_skew (true)
182
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
183
+ # a clock skew correction and retry requests with skewed client clocks.
184
+ #
185
+ # @option options [String] :defaults_mode ("legacy")
186
+ # See {Aws::DefaultsModeConfiguration} for a list of the
187
+ # accepted modes and the configuration defaults that are included.
188
+ #
189
+ # @option options [Boolean] :disable_host_prefix_injection (false)
190
+ # Set to true to disable SDK automatically adding host prefix
191
+ # to default service endpoint when available.
192
+ #
193
+ # @option options [String] :endpoint
194
+ # The client endpoint is normally constructed from the `:region`
195
+ # option. You should only configure an `:endpoint` when connecting
196
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
197
+ #
198
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
199
+ # Used for the maximum size limit of the LRU cache storing endpoints data
200
+ # for endpoint discovery enabled operations. Defaults to 1000.
201
+ #
202
+ # @option options [Integer] :endpoint_cache_max_threads (10)
203
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
204
+ #
205
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
206
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
207
+ # Use this option to config the time interval in seconds for making
208
+ # requests fetching endpoints information. Defaults to 60 sec.
209
+ #
210
+ # @option options [Boolean] :endpoint_discovery (false)
211
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
212
+ #
213
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
214
+ # The log formatter.
215
+ #
216
+ # @option options [Symbol] :log_level (:info)
217
+ # The log level to send messages to the `:logger` at.
218
+ #
219
+ # @option options [Logger] :logger
220
+ # The Logger instance to send log messages to. If this option
221
+ # is not set, logging will be disabled.
222
+ #
223
+ # @option options [Integer] :max_attempts (3)
224
+ # An integer representing the maximum number attempts that will be made for
225
+ # a single request, including the initial attempt. For example,
226
+ # setting this value to 5 will result in a request being retried up to
227
+ # 4 times. Used in `standard` and `adaptive` retry modes.
228
+ #
229
+ # @option options [String] :profile ("default")
230
+ # Used when loading credentials from the shared credentials file
231
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
232
+ #
233
+ # @option options [Proc] :retry_backoff
234
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
235
+ # This option is only used in the `legacy` retry mode.
236
+ #
237
+ # @option options [Float] :retry_base_delay (0.3)
238
+ # The base delay in seconds used by the default backoff function. This option
239
+ # is only used in the `legacy` retry mode.
240
+ #
241
+ # @option options [Symbol] :retry_jitter (:none)
242
+ # A delay randomiser function used by the default backoff function.
243
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
244
+ # otherwise a Proc that takes and returns a number. This option is only used
245
+ # in the `legacy` retry mode.
246
+ #
247
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
248
+ #
249
+ # @option options [Integer] :retry_limit (3)
250
+ # The maximum number of times to retry failed requests. Only
251
+ # ~ 500 level server errors and certain ~ 400 level client errors
252
+ # are retried. Generally, these are throttling errors, data
253
+ # checksum errors, networking errors, timeout errors, auth errors,
254
+ # endpoint discovery, and errors from expired credentials.
255
+ # This option is only used in the `legacy` retry mode.
256
+ #
257
+ # @option options [Integer] :retry_max_delay (0)
258
+ # The maximum number of seconds to delay between retries (0 for no limit)
259
+ # used by the default backoff function. This option is only used in the
260
+ # `legacy` retry mode.
261
+ #
262
+ # @option options [String] :retry_mode ("legacy")
263
+ # Specifies which retry algorithm to use. Values are:
264
+ #
265
+ # * `legacy` - The pre-existing retry behavior. This is default value if
266
+ # no retry mode is provided.
267
+ #
268
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
269
+ # This includes support for retry quotas, which limit the number of
270
+ # unsuccessful retries a client can make.
271
+ #
272
+ # * `adaptive` - An experimental retry mode that includes all the
273
+ # functionality of `standard` mode along with automatic client side
274
+ # throttling. This is a provisional mode that may change behavior
275
+ # in the future.
276
+ #
277
+ #
278
+ # @option options [String] :secret_access_key
279
+ #
280
+ # @option options [String] :session_token
281
+ #
282
+ # @option options [Boolean] :stub_responses (false)
283
+ # Causes the client to return stubbed responses. By default
284
+ # fake responses are generated and returned. You can specify
285
+ # the response data to return or errors to raise by calling
286
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
287
+ #
288
+ # ** Please note ** When response stubbing is enabled, no HTTP
289
+ # requests are made, and retries are disabled.
290
+ #
291
+ # @option options [Aws::TokenProvider] :token_provider
292
+ # A Bearer Token Provider. This can be an instance of any one of the
293
+ # following classes:
294
+ #
295
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
296
+ # tokens.
297
+ #
298
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
299
+ # access token generated from `aws login`.
300
+ #
301
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
302
+ # will be used to search for tokens configured for your profile in shared configuration files.
303
+ #
304
+ # @option options [Boolean] :use_dualstack_endpoint
305
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
306
+ # will be used if available.
307
+ #
308
+ # @option options [Boolean] :use_fips_endpoint
309
+ # When set to `true`, fips compatible endpoints will be used if available.
310
+ # When a `fips` region is used, the region is normalized and this config
311
+ # is set to `true`.
312
+ #
313
+ # @option options [Boolean] :validate_params (true)
314
+ # When `true`, request parameters are validated before
315
+ # sending the request.
316
+ #
317
+ # @option options [Aws::SageMakerGeospatial::EndpointProvider] :endpoint_provider
318
+ # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::SageMakerGeospatial::EndpointParameters`
319
+ #
320
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
321
+ # requests through. Formatted like 'http://proxy.com:123'.
322
+ #
323
+ # @option options [Float] :http_open_timeout (15) The number of
324
+ # seconds to wait when opening a HTTP session before raising a
325
+ # `Timeout::Error`.
326
+ #
327
+ # @option options [Float] :http_read_timeout (60) The default
328
+ # number of seconds to wait for response data. This value can
329
+ # safely be set per-request on the session.
330
+ #
331
+ # @option options [Float] :http_idle_timeout (5) The number of
332
+ # seconds a connection is allowed to sit idle before it is
333
+ # considered stale. Stale connections are closed and removed
334
+ # from the pool before making a request.
335
+ #
336
+ # @option options [Float] :http_continue_timeout (1) The number of
337
+ # seconds to wait for a 100-continue response before sending the
338
+ # request body. This option has no effect unless the request has
339
+ # "Expect" header set to "100-continue". Defaults to `nil` which
340
+ # disables this behaviour. This value can safely be set per
341
+ # request on the session.
342
+ #
343
+ # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
344
+ # in seconds.
345
+ #
346
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
347
+ # HTTP debug output will be sent to the `:logger`.
348
+ #
349
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
350
+ # SSL peer certificates are verified when establishing a
351
+ # connection.
352
+ #
353
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
354
+ # certificate authority bundle file that should be used when
355
+ # verifying peer certificates. If you do not pass
356
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
357
+ # will be used if available.
358
+ #
359
+ # @option options [String] :ssl_ca_directory Full path of the
360
+ # directory that contains the unbundled SSL certificate
361
+ # authority files for verifying peer certificates. If you do
362
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
363
+ # system default will be used if available.
364
+ #
365
+ def initialize(*args)
366
+ super
367
+ end
368
+
369
+ # @!group API Operations
370
+
371
+ # Use this operation to delete an Earth Observation job.
372
+ #
373
+ # @option params [required, String] :arn
374
+ # The Amazon Resource Name (ARN) of the Earth Observation job being
375
+ # deleted.
376
+ #
377
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
378
+ #
379
+ # @example Request syntax with placeholder values
380
+ #
381
+ # resp = client.delete_earth_observation_job({
382
+ # arn: "EarthObservationJobArn", # required
383
+ # })
384
+ #
385
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-geospatial-2020-05-27/DeleteEarthObservationJob AWS API Documentation
386
+ #
387
+ # @overload delete_earth_observation_job(params = {})
388
+ # @param [Hash] params ({})
389
+ def delete_earth_observation_job(params = {}, options = {})
390
+ req = build_request(:delete_earth_observation_job, params)
391
+ req.send_request(options)
392
+ end
393
+
394
+ # Use this operation to delete a Vector Enrichment job.
395
+ #
396
+ # @option params [required, String] :arn
397
+ # The Amazon Resource Name (ARN) of the Vector Enrichment job being
398
+ # deleted.
399
+ #
400
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
401
+ #
402
+ # @example Request syntax with placeholder values
403
+ #
404
+ # resp = client.delete_vector_enrichment_job({
405
+ # arn: "VectorEnrichmentJobArn", # required
406
+ # })
407
+ #
408
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-geospatial-2020-05-27/DeleteVectorEnrichmentJob AWS API Documentation
409
+ #
410
+ # @overload delete_vector_enrichment_job(params = {})
411
+ # @param [Hash] params ({})
412
+ def delete_vector_enrichment_job(params = {}, options = {})
413
+ req = build_request(:delete_vector_enrichment_job, params)
414
+ req.send_request(options)
415
+ end
416
+
417
+ # Use this operation to export results of an Earth Observation job and
418
+ # optionally source images used as input to the EOJ to an S3 location.
419
+ #
420
+ # @option params [required, String] :arn
421
+ # The input Amazon Resource Name (ARN) of the Earth Observation job
422
+ # being exported.
423
+ #
424
+ # @option params [required, String] :execution_role_arn
425
+ # The Amazon Resource Name (ARN) of the IAM role that you specified for
426
+ # the job.
427
+ #
428
+ # @option params [Boolean] :export_source_images
429
+ # The source images provided to the Earth Observation job being
430
+ # exported.
431
+ #
432
+ # @option params [required, Types::OutputConfigInput] :output_config
433
+ # An object containing information about the output file.
434
+ #
435
+ # @return [Types::ExportEarthObservationJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
436
+ #
437
+ # * {Types::ExportEarthObservationJobOutput#arn #arn} => String
438
+ # * {Types::ExportEarthObservationJobOutput#creation_time #creation_time} => Time
439
+ # * {Types::ExportEarthObservationJobOutput#execution_role_arn #execution_role_arn} => String
440
+ # * {Types::ExportEarthObservationJobOutput#export_source_images #export_source_images} => Boolean
441
+ # * {Types::ExportEarthObservationJobOutput#export_status #export_status} => String
442
+ # * {Types::ExportEarthObservationJobOutput#output_config #output_config} => Types::OutputConfigInput
443
+ #
444
+ # @example Request syntax with placeholder values
445
+ #
446
+ # resp = client.export_earth_observation_job({
447
+ # arn: "EarthObservationJobArn", # required
448
+ # execution_role_arn: "String", # required
449
+ # export_source_images: false,
450
+ # output_config: { # required
451
+ # s3_data: { # required
452
+ # kms_key_id: "String",
453
+ # s3_uri: "String", # required
454
+ # },
455
+ # },
456
+ # })
457
+ #
458
+ # @example Response structure
459
+ #
460
+ # resp.arn #=> String
461
+ # resp.creation_time #=> Time
462
+ # resp.execution_role_arn #=> String
463
+ # resp.export_source_images #=> Boolean
464
+ # resp.export_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
465
+ # resp.output_config.s3_data.kms_key_id #=> String
466
+ # resp.output_config.s3_data.s3_uri #=> String
467
+ #
468
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-geospatial-2020-05-27/ExportEarthObservationJob AWS API Documentation
469
+ #
470
+ # @overload export_earth_observation_job(params = {})
471
+ # @param [Hash] params ({})
472
+ def export_earth_observation_job(params = {}, options = {})
473
+ req = build_request(:export_earth_observation_job, params)
474
+ req.send_request(options)
475
+ end
476
+
477
+ # Use this operation to copy results of a Vector Enrichment job to an S3
478
+ # location.
479
+ #
480
+ # @option params [required, String] :arn
481
+ # The Amazon Resource Name (ARN) of the Vector Enrichment job.
482
+ #
483
+ # @option params [required, String] :execution_role_arn
484
+ # The Amazon Resource Name (ARN) of the IAM rolewith permission to
485
+ # upload to the location in OutputConfig.
486
+ #
487
+ # @option params [required, Types::ExportVectorEnrichmentJobOutputConfig] :output_config
488
+ # Output location information for exporting Vector Enrichment Job
489
+ # results.
490
+ #
491
+ # @return [Types::ExportVectorEnrichmentJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
492
+ #
493
+ # * {Types::ExportVectorEnrichmentJobOutput#arn #arn} => String
494
+ # * {Types::ExportVectorEnrichmentJobOutput#creation_time #creation_time} => Time
495
+ # * {Types::ExportVectorEnrichmentJobOutput#execution_role_arn #execution_role_arn} => String
496
+ # * {Types::ExportVectorEnrichmentJobOutput#export_status #export_status} => String
497
+ # * {Types::ExportVectorEnrichmentJobOutput#output_config #output_config} => Types::ExportVectorEnrichmentJobOutputConfig
498
+ #
499
+ # @example Request syntax with placeholder values
500
+ #
501
+ # resp = client.export_vector_enrichment_job({
502
+ # arn: "VectorEnrichmentJobArn", # required
503
+ # execution_role_arn: "String", # required
504
+ # output_config: { # required
505
+ # s3_data: { # required
506
+ # kms_key_id: "String",
507
+ # s3_uri: "String", # required
508
+ # },
509
+ # },
510
+ # })
511
+ #
512
+ # @example Response structure
513
+ #
514
+ # resp.arn #=> String
515
+ # resp.creation_time #=> Time
516
+ # resp.execution_role_arn #=> String
517
+ # resp.export_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
518
+ # resp.output_config.s3_data.kms_key_id #=> String
519
+ # resp.output_config.s3_data.s3_uri #=> String
520
+ #
521
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-geospatial-2020-05-27/ExportVectorEnrichmentJob AWS API Documentation
522
+ #
523
+ # @overload export_vector_enrichment_job(params = {})
524
+ # @param [Hash] params ({})
525
+ def export_vector_enrichment_job(params = {}, options = {})
526
+ req = build_request(:export_vector_enrichment_job, params)
527
+ req.send_request(options)
528
+ end
529
+
530
+ # Get the details for a previously initiated Earth Observation job.
531
+ #
532
+ # @option params [required, String] :arn
533
+ # The Amazon Resource Name (ARN) of the Earth Observation job.
534
+ #
535
+ # @return [Types::GetEarthObservationJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
536
+ #
537
+ # * {Types::GetEarthObservationJobOutput#arn #arn} => String
538
+ # * {Types::GetEarthObservationJobOutput#creation_time #creation_time} => Time
539
+ # * {Types::GetEarthObservationJobOutput#duration_in_seconds #duration_in_seconds} => Integer
540
+ # * {Types::GetEarthObservationJobOutput#error_details #error_details} => Types::EarthObservationJobErrorDetails
541
+ # * {Types::GetEarthObservationJobOutput#execution_role_arn #execution_role_arn} => String
542
+ # * {Types::GetEarthObservationJobOutput#export_error_details #export_error_details} => Types::ExportErrorDetails
543
+ # * {Types::GetEarthObservationJobOutput#export_status #export_status} => String
544
+ # * {Types::GetEarthObservationJobOutput#input_config #input_config} => Types::InputConfigOutput
545
+ # * {Types::GetEarthObservationJobOutput#job_config #job_config} => Types::JobConfigInput
546
+ # * {Types::GetEarthObservationJobOutput#kms_key_id #kms_key_id} => String
547
+ # * {Types::GetEarthObservationJobOutput#name #name} => String
548
+ # * {Types::GetEarthObservationJobOutput#output_bands #output_bands} => Array&lt;Types::OutputBand&gt;
549
+ # * {Types::GetEarthObservationJobOutput#status #status} => String
550
+ # * {Types::GetEarthObservationJobOutput#tags #tags} => Hash&lt;String,String&gt;
551
+ #
552
+ # @example Request syntax with placeholder values
553
+ #
554
+ # resp = client.get_earth_observation_job({
555
+ # arn: "EarthObservationJobArn", # required
556
+ # })
557
+ #
558
+ # @example Response structure
559
+ #
560
+ # resp.arn #=> String
561
+ # resp.creation_time #=> Time
562
+ # resp.duration_in_seconds #=> Integer
563
+ # resp.error_details.message #=> String
564
+ # resp.error_details.type #=> String, one of "CLIENT_ERROR", "SERVER_ERROR"
565
+ # resp.execution_role_arn #=> String
566
+ # resp.export_error_details.export_results.message #=> String
567
+ # resp.export_error_details.export_results.type #=> String, one of "CLIENT_ERROR", "SERVER_ERROR"
568
+ # resp.export_error_details.export_source_images.message #=> String
569
+ # resp.export_error_details.export_source_images.type #=> String, one of "CLIENT_ERROR", "SERVER_ERROR"
570
+ # resp.export_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
571
+ # resp.input_config.data_source_config.s3_data.kms_key_id #=> String
572
+ # resp.input_config.data_source_config.s3_data.metadata_provider #=> String, one of "PLANET_ORDER"
573
+ # resp.input_config.data_source_config.s3_data.s3_uri #=> String
574
+ # resp.input_config.previous_earth_observation_job_arn #=> String
575
+ # resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.multi_polygon_geometry.coordinates #=> Array
576
+ # resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.multi_polygon_geometry.coordinates[0] #=> Array
577
+ # resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.multi_polygon_geometry.coordinates[0][0] #=> Array
578
+ # resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.multi_polygon_geometry.coordinates[0][0][0] #=> Array
579
+ # resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.multi_polygon_geometry.coordinates[0][0][0][0] #=> Float
580
+ # resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.polygon_geometry.coordinates #=> Array
581
+ # resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.polygon_geometry.coordinates[0] #=> Array
582
+ # resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.polygon_geometry.coordinates[0][0] #=> Array
583
+ # resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.polygon_geometry.coordinates[0][0][0] #=> Float
584
+ # resp.input_config.raster_data_collection_query.property_filters.logical_operator #=> String, one of "AND"
585
+ # resp.input_config.raster_data_collection_query.property_filters.properties #=> Array
586
+ # resp.input_config.raster_data_collection_query.property_filters.properties[0].property.eo_cloud_cover.lower_bound #=> Float
587
+ # resp.input_config.raster_data_collection_query.property_filters.properties[0].property.eo_cloud_cover.upper_bound #=> Float
588
+ # resp.input_config.raster_data_collection_query.property_filters.properties[0].property.landsat_cloud_cover_land.lower_bound #=> Float
589
+ # resp.input_config.raster_data_collection_query.property_filters.properties[0].property.landsat_cloud_cover_land.upper_bound #=> Float
590
+ # resp.input_config.raster_data_collection_query.property_filters.properties[0].property.platform.comparison_operator #=> String, one of "EQUALS", "NOT_EQUALS", "STARTS_WITH"
591
+ # resp.input_config.raster_data_collection_query.property_filters.properties[0].property.platform.value #=> String
592
+ # resp.input_config.raster_data_collection_query.property_filters.properties[0].property.view_off_nadir.lower_bound #=> Float
593
+ # resp.input_config.raster_data_collection_query.property_filters.properties[0].property.view_off_nadir.upper_bound #=> Float
594
+ # resp.input_config.raster_data_collection_query.property_filters.properties[0].property.view_sun_azimuth.lower_bound #=> Float
595
+ # resp.input_config.raster_data_collection_query.property_filters.properties[0].property.view_sun_azimuth.upper_bound #=> Float
596
+ # resp.input_config.raster_data_collection_query.property_filters.properties[0].property.view_sun_elevation.lower_bound #=> Float
597
+ # resp.input_config.raster_data_collection_query.property_filters.properties[0].property.view_sun_elevation.upper_bound #=> Float
598
+ # resp.input_config.raster_data_collection_query.raster_data_collection_arn #=> String
599
+ # resp.input_config.raster_data_collection_query.raster_data_collection_name #=> String
600
+ # resp.input_config.raster_data_collection_query.time_range_filter.end_time #=> Time
601
+ # resp.input_config.raster_data_collection_query.time_range_filter.start_time #=> Time
602
+ # resp.job_config.band_math_config.custom_indices.operations #=> Array
603
+ # resp.job_config.band_math_config.custom_indices.operations[0].equation #=> String
604
+ # resp.job_config.band_math_config.custom_indices.operations[0].name #=> String
605
+ # resp.job_config.band_math_config.custom_indices.operations[0].output_type #=> String, one of "INT32", "FLOAT32", "INT16", "FLOAT64", "UINT16"
606
+ # resp.job_config.band_math_config.predefined_indices #=> Array
607
+ # resp.job_config.band_math_config.predefined_indices[0] #=> String
608
+ # resp.job_config.cloud_removal_config.algorithm_name #=> String, one of "INTERPOLATION"
609
+ # resp.job_config.cloud_removal_config.interpolation_value #=> String
610
+ # resp.job_config.cloud_removal_config.target_bands #=> Array
611
+ # resp.job_config.cloud_removal_config.target_bands[0] #=> String
612
+ # resp.job_config.geo_mosaic_config.algorithm_name #=> String, one of "NEAR", "BILINEAR", "CUBIC", "CUBICSPLINE", "LANCZOS", "AVERAGE", "RMS", "MODE", "MAX", "MIN", "MED", "Q1", "Q3", "SUM"
613
+ # resp.job_config.geo_mosaic_config.target_bands #=> Array
614
+ # resp.job_config.geo_mosaic_config.target_bands[0] #=> String
615
+ # resp.job_config.resampling_config.algorithm_name #=> String, one of "NEAR", "BILINEAR", "CUBIC", "CUBICSPLINE", "LANCZOS", "AVERAGE", "RMS", "MODE", "MAX", "MIN", "MED", "Q1", "Q3", "SUM"
616
+ # resp.job_config.resampling_config.output_resolution.user_defined.unit #=> String, one of "METERS"
617
+ # resp.job_config.resampling_config.output_resolution.user_defined.value #=> Float
618
+ # resp.job_config.resampling_config.target_bands #=> Array
619
+ # resp.job_config.resampling_config.target_bands[0] #=> String
620
+ # resp.job_config.stack_config.output_resolution.predefined #=> String, one of "HIGHEST", "LOWEST", "AVERAGE"
621
+ # resp.job_config.stack_config.output_resolution.user_defined.unit #=> String, one of "METERS"
622
+ # resp.job_config.stack_config.output_resolution.user_defined.value #=> Float
623
+ # resp.job_config.stack_config.target_bands #=> Array
624
+ # resp.job_config.stack_config.target_bands[0] #=> String
625
+ # resp.job_config.temporal_statistics_config.group_by #=> String, one of "ALL", "YEARLY"
626
+ # resp.job_config.temporal_statistics_config.statistics #=> Array
627
+ # resp.job_config.temporal_statistics_config.statistics[0] #=> String, one of "MEAN", "MEDIAN", "STANDARD_DEVIATION"
628
+ # resp.job_config.temporal_statistics_config.target_bands #=> Array
629
+ # resp.job_config.temporal_statistics_config.target_bands[0] #=> String
630
+ # resp.job_config.zonal_statistics_config.statistics #=> Array
631
+ # resp.job_config.zonal_statistics_config.statistics[0] #=> String, one of "MEAN", "MEDIAN", "STANDARD_DEVIATION", "MAX", "MIN", "SUM"
632
+ # resp.job_config.zonal_statistics_config.target_bands #=> Array
633
+ # resp.job_config.zonal_statistics_config.target_bands[0] #=> String
634
+ # resp.job_config.zonal_statistics_config.zone_s3_path #=> String
635
+ # resp.kms_key_id #=> String
636
+ # resp.name #=> String
637
+ # resp.output_bands #=> Array
638
+ # resp.output_bands[0].band_name #=> String
639
+ # resp.output_bands[0].output_data_type #=> String, one of "INT32", "FLOAT32", "INT16", "FLOAT64", "UINT16"
640
+ # resp.status #=> String, one of "INITIALIZING", "IN_PROGRESS", "STOPPING", "COMPLETED", "STOPPED", "FAILED", "DELETING", "DELETED"
641
+ # resp.tags #=> Hash
642
+ # resp.tags["String"] #=> String
643
+ #
644
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-geospatial-2020-05-27/GetEarthObservationJob AWS API Documentation
645
+ #
646
+ # @overload get_earth_observation_job(params = {})
647
+ # @param [Hash] params ({})
648
+ def get_earth_observation_job(params = {}, options = {})
649
+ req = build_request(:get_earth_observation_job, params)
650
+ req.send_request(options)
651
+ end
652
+
653
+ # Use this operation to get details of a specific raster data
654
+ # collection.
655
+ #
656
+ # @option params [required, String] :arn
657
+ # The Amazon Resource Name (ARN) of the raster data collection.
658
+ #
659
+ # @return [Types::GetRasterDataCollectionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
660
+ #
661
+ # * {Types::GetRasterDataCollectionOutput#arn #arn} => String
662
+ # * {Types::GetRasterDataCollectionOutput#description #description} => String
663
+ # * {Types::GetRasterDataCollectionOutput#description_page_url #description_page_url} => String
664
+ # * {Types::GetRasterDataCollectionOutput#image_source_bands #image_source_bands} => Array&lt;String&gt;
665
+ # * {Types::GetRasterDataCollectionOutput#name #name} => String
666
+ # * {Types::GetRasterDataCollectionOutput#supported_filters #supported_filters} => Array&lt;Types::Filter&gt;
667
+ # * {Types::GetRasterDataCollectionOutput#tags #tags} => Hash&lt;String,String&gt;
668
+ # * {Types::GetRasterDataCollectionOutput#type #type} => String
669
+ #
670
+ # @example Request syntax with placeholder values
671
+ #
672
+ # resp = client.get_raster_data_collection({
673
+ # arn: "DataCollectionArn", # required
674
+ # })
675
+ #
676
+ # @example Response structure
677
+ #
678
+ # resp.arn #=> String
679
+ # resp.description #=> String
680
+ # resp.description_page_url #=> String
681
+ # resp.image_source_bands #=> Array
682
+ # resp.image_source_bands[0] #=> String
683
+ # resp.name #=> String
684
+ # resp.supported_filters #=> Array
685
+ # resp.supported_filters[0].maximum #=> Float
686
+ # resp.supported_filters[0].minimum #=> Float
687
+ # resp.supported_filters[0].name #=> String
688
+ # resp.supported_filters[0].type #=> String
689
+ # resp.tags #=> Hash
690
+ # resp.tags["String"] #=> String
691
+ # resp.type #=> String, one of "PUBLIC", "PREMIUM", "USER"
692
+ #
693
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-geospatial-2020-05-27/GetRasterDataCollection AWS API Documentation
694
+ #
695
+ # @overload get_raster_data_collection(params = {})
696
+ # @param [Hash] params ({})
697
+ def get_raster_data_collection(params = {}, options = {})
698
+ req = build_request(:get_raster_data_collection, params)
699
+ req.send_request(options)
700
+ end
701
+
702
+ # Gets a web mercator tile for the given Earth Observation job.
703
+ #
704
+ # @option params [required, String] :arn
705
+ # The Amazon Resource Name (ARN) of the tile operation.
706
+ #
707
+ # @option params [required, Array<String>] :image_assets
708
+ # The particular assets or bands to tile.
709
+ #
710
+ # @option params [Boolean] :image_mask
711
+ # Determines whether or not to return a valid data mask.
712
+ #
713
+ # @option params [String] :output_data_type
714
+ # The output data type of the tile operation.
715
+ #
716
+ # @option params [String] :output_format
717
+ # The data format of the output tile. The formats include .npy, .png and
718
+ # .jpg.
719
+ #
720
+ # @option params [String] :property_filters
721
+ # Property filters for the imagery to tile.
722
+ #
723
+ # @option params [required, String] :target
724
+ # Determines what part of the Earth Observation job to tile. 'INPUT'
725
+ # or 'OUTPUT' are the valid options.
726
+ #
727
+ # @option params [String] :time_range_filter
728
+ # Time range filter applied to imagery to find the images to tile.
729
+ #
730
+ # @option params [required, Integer] :x
731
+ # The x coordinate of the tile input.
732
+ #
733
+ # @option params [required, Integer] :y
734
+ # The y coordinate of the tile input.
735
+ #
736
+ # @option params [required, Integer] :z
737
+ # The z coordinate of the tile input.
738
+ #
739
+ # @return [Types::GetTileOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
740
+ #
741
+ # * {Types::GetTileOutput#binary_file #binary_file} => IO
742
+ #
743
+ # @example Request syntax with placeholder values
744
+ #
745
+ # resp = client.get_tile({
746
+ # arn: "EarthObservationJobArn", # required
747
+ # image_assets: ["String"], # required
748
+ # image_mask: false,
749
+ # output_data_type: "INT32", # accepts INT32, FLOAT32, INT16, FLOAT64, UINT16
750
+ # output_format: "String",
751
+ # property_filters: "String",
752
+ # target: "INPUT", # required, accepts INPUT, OUTPUT
753
+ # time_range_filter: "String",
754
+ # x: 1, # required
755
+ # y: 1, # required
756
+ # z: 1, # required
757
+ # })
758
+ #
759
+ # @example Response structure
760
+ #
761
+ # resp.binary_file #=> IO
762
+ #
763
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-geospatial-2020-05-27/GetTile AWS API Documentation
764
+ #
765
+ # @overload get_tile(params = {})
766
+ # @param [Hash] params ({})
767
+ def get_tile(params = {}, options = {}, &block)
768
+ req = build_request(:get_tile, params)
769
+ req.send_request(options, &block)
770
+ end
771
+
772
+ # Retrieves details of a Vector Enrichment Job for a given job Amazon
773
+ # Resource Name (ARN).
774
+ #
775
+ # @option params [required, String] :arn
776
+ # The Amazon Resource Name (ARN) of the Vector Enrichment job.
777
+ #
778
+ # @return [Types::GetVectorEnrichmentJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
779
+ #
780
+ # * {Types::GetVectorEnrichmentJobOutput#arn #arn} => String
781
+ # * {Types::GetVectorEnrichmentJobOutput#creation_time #creation_time} => Time
782
+ # * {Types::GetVectorEnrichmentJobOutput#duration_in_seconds #duration_in_seconds} => Integer
783
+ # * {Types::GetVectorEnrichmentJobOutput#error_details #error_details} => Types::VectorEnrichmentJobErrorDetails
784
+ # * {Types::GetVectorEnrichmentJobOutput#execution_role_arn #execution_role_arn} => String
785
+ # * {Types::GetVectorEnrichmentJobOutput#export_error_details #export_error_details} => Types::VectorEnrichmentJobExportErrorDetails
786
+ # * {Types::GetVectorEnrichmentJobOutput#export_status #export_status} => String
787
+ # * {Types::GetVectorEnrichmentJobOutput#input_config #input_config} => Types::VectorEnrichmentJobInputConfig
788
+ # * {Types::GetVectorEnrichmentJobOutput#job_config #job_config} => Types::VectorEnrichmentJobConfig
789
+ # * {Types::GetVectorEnrichmentJobOutput#kms_key_id #kms_key_id} => String
790
+ # * {Types::GetVectorEnrichmentJobOutput#name #name} => String
791
+ # * {Types::GetVectorEnrichmentJobOutput#status #status} => String
792
+ # * {Types::GetVectorEnrichmentJobOutput#tags #tags} => Hash&lt;String,String&gt;
793
+ # * {Types::GetVectorEnrichmentJobOutput#type #type} => String
794
+ #
795
+ # @example Request syntax with placeholder values
796
+ #
797
+ # resp = client.get_vector_enrichment_job({
798
+ # arn: "VectorEnrichmentJobArn", # required
799
+ # })
800
+ #
801
+ # @example Response structure
802
+ #
803
+ # resp.arn #=> String
804
+ # resp.creation_time #=> Time
805
+ # resp.duration_in_seconds #=> Integer
806
+ # resp.error_details.error_message #=> String
807
+ # resp.error_details.error_type #=> String, one of "CLIENT_ERROR", "SERVER_ERROR"
808
+ # resp.execution_role_arn #=> String
809
+ # resp.export_error_details.message #=> String
810
+ # resp.export_error_details.type #=> String, one of "CLIENT_ERROR", "SERVER_ERROR"
811
+ # resp.export_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
812
+ # resp.input_config.data_source_config.s3_data.kms_key_id #=> String
813
+ # resp.input_config.data_source_config.s3_data.s3_uri #=> String
814
+ # resp.input_config.document_type #=> String, one of "CSV"
815
+ # resp.job_config.map_matching_config.id_attribute_name #=> String
816
+ # resp.job_config.map_matching_config.timestamp_attribute_name #=> String
817
+ # resp.job_config.map_matching_config.x_attribute_name #=> String
818
+ # resp.job_config.map_matching_config.y_attribute_name #=> String
819
+ # resp.job_config.reverse_geocoding_config.x_attribute_name #=> String
820
+ # resp.job_config.reverse_geocoding_config.y_attribute_name #=> String
821
+ # resp.kms_key_id #=> String
822
+ # resp.name #=> String
823
+ # resp.status #=> String, one of "INITIALIZING", "IN_PROGRESS", "STOPPING", "STOPPED", "COMPLETED", "FAILED", "DELETING", "DELETED"
824
+ # resp.tags #=> Hash
825
+ # resp.tags["String"] #=> String
826
+ # resp.type #=> String, one of "REVERSE_GEOCODING", "MAP_MATCHING"
827
+ #
828
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-geospatial-2020-05-27/GetVectorEnrichmentJob AWS API Documentation
829
+ #
830
+ # @overload get_vector_enrichment_job(params = {})
831
+ # @param [Hash] params ({})
832
+ def get_vector_enrichment_job(params = {}, options = {})
833
+ req = build_request(:get_vector_enrichment_job, params)
834
+ req.send_request(options)
835
+ end
836
+
837
+ # Use this operation to get a list of the Earth Observation jobs
838
+ # associated with the calling Amazon Web Services account.
839
+ #
840
+ # @option params [Integer] :max_results
841
+ # The total number of items to return.
842
+ #
843
+ # @option params [String] :next_token
844
+ # If the previous response was truncated, you receive this token. Use it
845
+ # in your next request to receive the next set of results.
846
+ #
847
+ # @option params [String] :sort_by
848
+ # The parameter by which to sort the results.
849
+ #
850
+ # @option params [String] :sort_order
851
+ # An optional value that specifies whether you want the results sorted
852
+ # in `Ascending` or `Descending` order.
853
+ #
854
+ # @option params [String] :status_equals
855
+ # A filter that retrieves only jobs with a specific status.
856
+ #
857
+ # @return [Types::ListEarthObservationJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
858
+ #
859
+ # * {Types::ListEarthObservationJobOutput#earth_observation_job_summaries #earth_observation_job_summaries} => Array&lt;Types::ListEarthObservationJobOutputConfig&gt;
860
+ # * {Types::ListEarthObservationJobOutput#next_token #next_token} => String
861
+ #
862
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
863
+ #
864
+ # @example Request syntax with placeholder values
865
+ #
866
+ # resp = client.list_earth_observation_jobs({
867
+ # max_results: 1,
868
+ # next_token: "NextToken",
869
+ # sort_by: "String",
870
+ # sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
871
+ # status_equals: "INITIALIZING", # accepts INITIALIZING, IN_PROGRESS, STOPPING, COMPLETED, STOPPED, FAILED, DELETING, DELETED
872
+ # })
873
+ #
874
+ # @example Response structure
875
+ #
876
+ # resp.earth_observation_job_summaries #=> Array
877
+ # resp.earth_observation_job_summaries[0].arn #=> String
878
+ # resp.earth_observation_job_summaries[0].creation_time #=> Time
879
+ # resp.earth_observation_job_summaries[0].duration_in_seconds #=> Integer
880
+ # resp.earth_observation_job_summaries[0].name #=> String
881
+ # resp.earth_observation_job_summaries[0].operation_type #=> String
882
+ # resp.earth_observation_job_summaries[0].status #=> String, one of "INITIALIZING", "IN_PROGRESS", "STOPPING", "COMPLETED", "STOPPED", "FAILED", "DELETING", "DELETED"
883
+ # resp.earth_observation_job_summaries[0].tags #=> Hash
884
+ # resp.earth_observation_job_summaries[0].tags["String"] #=> String
885
+ # resp.next_token #=> String
886
+ #
887
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-geospatial-2020-05-27/ListEarthObservationJobs AWS API Documentation
888
+ #
889
+ # @overload list_earth_observation_jobs(params = {})
890
+ # @param [Hash] params ({})
891
+ def list_earth_observation_jobs(params = {}, options = {})
892
+ req = build_request(:list_earth_observation_jobs, params)
893
+ req.send_request(options)
894
+ end
895
+
896
+ # Use this operation to get raster data collections.
897
+ #
898
+ # @option params [Integer] :max_results
899
+ # The total number of items to return.
900
+ #
901
+ # @option params [String] :next_token
902
+ # If the previous response was truncated, you receive this token. Use it
903
+ # in your next request to receive the next set of results.
904
+ #
905
+ # @return [Types::ListRasterDataCollectionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
906
+ #
907
+ # * {Types::ListRasterDataCollectionsOutput#next_token #next_token} => String
908
+ # * {Types::ListRasterDataCollectionsOutput#raster_data_collection_summaries #raster_data_collection_summaries} => Array&lt;Types::RasterDataCollectionMetadata&gt;
909
+ #
910
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
911
+ #
912
+ # @example Request syntax with placeholder values
913
+ #
914
+ # resp = client.list_raster_data_collections({
915
+ # max_results: 1,
916
+ # next_token: "NextToken",
917
+ # })
918
+ #
919
+ # @example Response structure
920
+ #
921
+ # resp.next_token #=> String
922
+ # resp.raster_data_collection_summaries #=> Array
923
+ # resp.raster_data_collection_summaries[0].arn #=> String
924
+ # resp.raster_data_collection_summaries[0].description #=> String
925
+ # resp.raster_data_collection_summaries[0].description_page_url #=> String
926
+ # resp.raster_data_collection_summaries[0].name #=> String
927
+ # resp.raster_data_collection_summaries[0].supported_filters #=> Array
928
+ # resp.raster_data_collection_summaries[0].supported_filters[0].maximum #=> Float
929
+ # resp.raster_data_collection_summaries[0].supported_filters[0].minimum #=> Float
930
+ # resp.raster_data_collection_summaries[0].supported_filters[0].name #=> String
931
+ # resp.raster_data_collection_summaries[0].supported_filters[0].type #=> String
932
+ # resp.raster_data_collection_summaries[0].tags #=> Hash
933
+ # resp.raster_data_collection_summaries[0].tags["String"] #=> String
934
+ # resp.raster_data_collection_summaries[0].type #=> String, one of "PUBLIC", "PREMIUM", "USER"
935
+ #
936
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-geospatial-2020-05-27/ListRasterDataCollections AWS API Documentation
937
+ #
938
+ # @overload list_raster_data_collections(params = {})
939
+ # @param [Hash] params ({})
940
+ def list_raster_data_collections(params = {}, options = {})
941
+ req = build_request(:list_raster_data_collections, params)
942
+ req.send_request(options)
943
+ end
944
+
945
+ # Lists the tags attached to the resource.
946
+ #
947
+ # @option params [required, String] :resource_arn
948
+ # The Amazon Resource Name (ARN) of the resource you want to tag.
949
+ #
950
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
951
+ #
952
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt;
953
+ #
954
+ # @example Request syntax with placeholder values
955
+ #
956
+ # resp = client.list_tags_for_resource({
957
+ # resource_arn: "Arn", # required
958
+ # })
959
+ #
960
+ # @example Response structure
961
+ #
962
+ # resp.tags #=> Hash
963
+ # resp.tags["String"] #=> String
964
+ #
965
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-geospatial-2020-05-27/ListTagsForResource AWS API Documentation
966
+ #
967
+ # @overload list_tags_for_resource(params = {})
968
+ # @param [Hash] params ({})
969
+ def list_tags_for_resource(params = {}, options = {})
970
+ req = build_request(:list_tags_for_resource, params)
971
+ req.send_request(options)
972
+ end
973
+
974
+ # Retrieves a list of vector enrichment jobs.
975
+ #
976
+ # @option params [Integer] :max_results
977
+ # The maximum number of items to return.
978
+ #
979
+ # @option params [String] :next_token
980
+ # If the previous response was truncated, you receive this token. Use it
981
+ # in your next request to receive the next set of results.
982
+ #
983
+ # @option params [String] :sort_by
984
+ # The parameter by which to sort the results.
985
+ #
986
+ # @option params [String] :sort_order
987
+ # An optional value that specifies whether you want the results sorted
988
+ # in `Ascending` or `Descending` order.
989
+ #
990
+ # @option params [String] :status_equals
991
+ # A filter that retrieves only jobs with a specific status.
992
+ #
993
+ # @return [Types::ListVectorEnrichmentJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
994
+ #
995
+ # * {Types::ListVectorEnrichmentJobOutput#next_token #next_token} => String
996
+ # * {Types::ListVectorEnrichmentJobOutput#vector_enrichment_job_summaries #vector_enrichment_job_summaries} => Array&lt;Types::ListVectorEnrichmentJobOutputConfig&gt;
997
+ #
998
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
999
+ #
1000
+ # @example Request syntax with placeholder values
1001
+ #
1002
+ # resp = client.list_vector_enrichment_jobs({
1003
+ # max_results: 1,
1004
+ # next_token: "NextToken",
1005
+ # sort_by: "String",
1006
+ # sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
1007
+ # status_equals: "String",
1008
+ # })
1009
+ #
1010
+ # @example Response structure
1011
+ #
1012
+ # resp.next_token #=> String
1013
+ # resp.vector_enrichment_job_summaries #=> Array
1014
+ # resp.vector_enrichment_job_summaries[0].arn #=> String
1015
+ # resp.vector_enrichment_job_summaries[0].creation_time #=> Time
1016
+ # resp.vector_enrichment_job_summaries[0].duration_in_seconds #=> Integer
1017
+ # resp.vector_enrichment_job_summaries[0].name #=> String
1018
+ # resp.vector_enrichment_job_summaries[0].status #=> String, one of "INITIALIZING", "IN_PROGRESS", "STOPPING", "STOPPED", "COMPLETED", "FAILED", "DELETING", "DELETED"
1019
+ # resp.vector_enrichment_job_summaries[0].tags #=> Hash
1020
+ # resp.vector_enrichment_job_summaries[0].tags["String"] #=> String
1021
+ # resp.vector_enrichment_job_summaries[0].type #=> String, one of "REVERSE_GEOCODING", "MAP_MATCHING"
1022
+ #
1023
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-geospatial-2020-05-27/ListVectorEnrichmentJobs AWS API Documentation
1024
+ #
1025
+ # @overload list_vector_enrichment_jobs(params = {})
1026
+ # @param [Hash] params ({})
1027
+ def list_vector_enrichment_jobs(params = {}, options = {})
1028
+ req = build_request(:list_vector_enrichment_jobs, params)
1029
+ req.send_request(options)
1030
+ end
1031
+
1032
+ # Allows you run image query on a specific raster data collection to get
1033
+ # a list of the satellite imagery matching the selected filters.
1034
+ #
1035
+ # @option params [required, String] :arn
1036
+ # The Amazon Resource Name (ARN) of the raster data collection.
1037
+ #
1038
+ # @option params [String] :next_token
1039
+ # If the previous response was truncated, you receive this token. Use it
1040
+ # in your next request to receive the next set of results.
1041
+ #
1042
+ # @option params [required, Types::RasterDataCollectionQueryWithBandFilterInput] :raster_data_collection_query
1043
+ #
1044
+ # @return [Types::SearchRasterDataCollectionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1045
+ #
1046
+ # * {Types::SearchRasterDataCollectionOutput#approximate_result_count #approximate_result_count} => Integer
1047
+ # * {Types::SearchRasterDataCollectionOutput#items #items} => Array&lt;Types::ItemSource&gt;
1048
+ # * {Types::SearchRasterDataCollectionOutput#next_token #next_token} => String
1049
+ #
1050
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1051
+ #
1052
+ # @example Request syntax with placeholder values
1053
+ #
1054
+ # resp = client.search_raster_data_collection({
1055
+ # arn: "DataCollectionArn", # required
1056
+ # next_token: "NextToken",
1057
+ # raster_data_collection_query: { # required
1058
+ # area_of_interest: {
1059
+ # area_of_interest_geometry: {
1060
+ # multi_polygon_geometry: {
1061
+ # coordinates: [ # required
1062
+ # [
1063
+ # [
1064
+ # [1.0],
1065
+ # ],
1066
+ # ],
1067
+ # ],
1068
+ # },
1069
+ # polygon_geometry: {
1070
+ # coordinates: [ # required
1071
+ # [
1072
+ # [1.0],
1073
+ # ],
1074
+ # ],
1075
+ # },
1076
+ # },
1077
+ # },
1078
+ # band_filter: ["String"],
1079
+ # property_filters: {
1080
+ # logical_operator: "AND", # accepts AND
1081
+ # properties: [
1082
+ # {
1083
+ # property: { # required
1084
+ # eo_cloud_cover: {
1085
+ # lower_bound: 1.0, # required
1086
+ # upper_bound: 1.0, # required
1087
+ # },
1088
+ # landsat_cloud_cover_land: {
1089
+ # lower_bound: 1.0, # required
1090
+ # upper_bound: 1.0, # required
1091
+ # },
1092
+ # platform: {
1093
+ # comparison_operator: "EQUALS", # accepts EQUALS, NOT_EQUALS, STARTS_WITH
1094
+ # value: "String", # required
1095
+ # },
1096
+ # view_off_nadir: {
1097
+ # lower_bound: 1.0, # required
1098
+ # upper_bound: 1.0, # required
1099
+ # },
1100
+ # view_sun_azimuth: {
1101
+ # lower_bound: 1.0, # required
1102
+ # upper_bound: 1.0, # required
1103
+ # },
1104
+ # view_sun_elevation: {
1105
+ # lower_bound: 1.0, # required
1106
+ # upper_bound: 1.0, # required
1107
+ # },
1108
+ # },
1109
+ # },
1110
+ # ],
1111
+ # },
1112
+ # time_range_filter: { # required
1113
+ # end_time: Time.now, # required
1114
+ # start_time: Time.now, # required
1115
+ # },
1116
+ # },
1117
+ # })
1118
+ #
1119
+ # @example Response structure
1120
+ #
1121
+ # resp.approximate_result_count #=> Integer
1122
+ # resp.items #=> Array
1123
+ # resp.items[0].assets #=> Hash
1124
+ # resp.items[0].assets["String"].href #=> String
1125
+ # resp.items[0].date_time #=> Time
1126
+ # resp.items[0].geometry.coordinates #=> Array
1127
+ # resp.items[0].geometry.coordinates[0] #=> Array
1128
+ # resp.items[0].geometry.coordinates[0][0] #=> Array
1129
+ # resp.items[0].geometry.coordinates[0][0][0] #=> Float
1130
+ # resp.items[0].geometry.type #=> String
1131
+ # resp.items[0].id #=> String
1132
+ # resp.items[0].properties.eo_cloud_cover #=> Float
1133
+ # resp.items[0].properties.landsat_cloud_cover_land #=> Float
1134
+ # resp.items[0].properties.platform #=> String
1135
+ # resp.items[0].properties.view_off_nadir #=> Float
1136
+ # resp.items[0].properties.view_sun_azimuth #=> Float
1137
+ # resp.items[0].properties.view_sun_elevation #=> Float
1138
+ # resp.next_token #=> String
1139
+ #
1140
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-geospatial-2020-05-27/SearchRasterDataCollection AWS API Documentation
1141
+ #
1142
+ # @overload search_raster_data_collection(params = {})
1143
+ # @param [Hash] params ({})
1144
+ def search_raster_data_collection(params = {}, options = {})
1145
+ req = build_request(:search_raster_data_collection, params)
1146
+ req.send_request(options)
1147
+ end
1148
+
1149
+ # Use this operation to create an Earth observation job.
1150
+ #
1151
+ # @option params [String] :client_token
1152
+ # A unique token that guarantees that the call to this API is
1153
+ # idempotent.
1154
+ #
1155
+ # **A suitable default value is auto-generated.** You should normally
1156
+ # not need to pass this option.**
1157
+ #
1158
+ # @option params [String] :execution_role_arn
1159
+ # The Amazon Resource Name (ARN) of the IAM role that you specified for
1160
+ # the job.
1161
+ #
1162
+ # @option params [required, Types::InputConfigInput] :input_config
1163
+ # Input configuration information for the Earth Observation job.
1164
+ #
1165
+ # @option params [required, Types::JobConfigInput] :job_config
1166
+ # An object containing information about the job configuration.
1167
+ #
1168
+ # @option params [String] :kms_key_id
1169
+ # The Amazon Key Management Service (KMS) key ID for server-side
1170
+ # encryption.
1171
+ #
1172
+ # @option params [required, String] :name
1173
+ # The name of the Earth Observation job.
1174
+ #
1175
+ # @option params [Hash<String,String>] :tags
1176
+ # Each tag consists of a key and a value.
1177
+ #
1178
+ # @return [Types::StartEarthObservationJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1179
+ #
1180
+ # * {Types::StartEarthObservationJobOutput#arn #arn} => String
1181
+ # * {Types::StartEarthObservationJobOutput#creation_time #creation_time} => Time
1182
+ # * {Types::StartEarthObservationJobOutput#duration_in_seconds #duration_in_seconds} => Integer
1183
+ # * {Types::StartEarthObservationJobOutput#execution_role_arn #execution_role_arn} => String
1184
+ # * {Types::StartEarthObservationJobOutput#input_config #input_config} => Types::InputConfigOutput
1185
+ # * {Types::StartEarthObservationJobOutput#job_config #job_config} => Types::JobConfigInput
1186
+ # * {Types::StartEarthObservationJobOutput#kms_key_id #kms_key_id} => String
1187
+ # * {Types::StartEarthObservationJobOutput#name #name} => String
1188
+ # * {Types::StartEarthObservationJobOutput#status #status} => String
1189
+ # * {Types::StartEarthObservationJobOutput#tags #tags} => Hash&lt;String,String&gt;
1190
+ #
1191
+ # @example Request syntax with placeholder values
1192
+ #
1193
+ # resp = client.start_earth_observation_job({
1194
+ # client_token: "String",
1195
+ # execution_role_arn: "String",
1196
+ # input_config: { # required
1197
+ # data_source_config: {
1198
+ # s3_data: {
1199
+ # kms_key_id: "String",
1200
+ # metadata_provider: "PLANET_ORDER", # required, accepts PLANET_ORDER
1201
+ # s3_uri: "String", # required
1202
+ # },
1203
+ # },
1204
+ # previous_earth_observation_job_arn: "String",
1205
+ # raster_data_collection_query: {
1206
+ # area_of_interest: {
1207
+ # area_of_interest_geometry: {
1208
+ # multi_polygon_geometry: {
1209
+ # coordinates: [ # required
1210
+ # [
1211
+ # [
1212
+ # [1.0],
1213
+ # ],
1214
+ # ],
1215
+ # ],
1216
+ # },
1217
+ # polygon_geometry: {
1218
+ # coordinates: [ # required
1219
+ # [
1220
+ # [1.0],
1221
+ # ],
1222
+ # ],
1223
+ # },
1224
+ # },
1225
+ # },
1226
+ # property_filters: {
1227
+ # logical_operator: "AND", # accepts AND
1228
+ # properties: [
1229
+ # {
1230
+ # property: { # required
1231
+ # eo_cloud_cover: {
1232
+ # lower_bound: 1.0, # required
1233
+ # upper_bound: 1.0, # required
1234
+ # },
1235
+ # landsat_cloud_cover_land: {
1236
+ # lower_bound: 1.0, # required
1237
+ # upper_bound: 1.0, # required
1238
+ # },
1239
+ # platform: {
1240
+ # comparison_operator: "EQUALS", # accepts EQUALS, NOT_EQUALS, STARTS_WITH
1241
+ # value: "String", # required
1242
+ # },
1243
+ # view_off_nadir: {
1244
+ # lower_bound: 1.0, # required
1245
+ # upper_bound: 1.0, # required
1246
+ # },
1247
+ # view_sun_azimuth: {
1248
+ # lower_bound: 1.0, # required
1249
+ # upper_bound: 1.0, # required
1250
+ # },
1251
+ # view_sun_elevation: {
1252
+ # lower_bound: 1.0, # required
1253
+ # upper_bound: 1.0, # required
1254
+ # },
1255
+ # },
1256
+ # },
1257
+ # ],
1258
+ # },
1259
+ # raster_data_collection_arn: "String", # required
1260
+ # time_range_filter: { # required
1261
+ # end_time: Time.now, # required
1262
+ # start_time: Time.now, # required
1263
+ # },
1264
+ # },
1265
+ # },
1266
+ # job_config: { # required
1267
+ # band_math_config: {
1268
+ # custom_indices: {
1269
+ # operations: [
1270
+ # {
1271
+ # equation: "String", # required
1272
+ # name: "String", # required
1273
+ # output_type: "INT32", # accepts INT32, FLOAT32, INT16, FLOAT64, UINT16
1274
+ # },
1275
+ # ],
1276
+ # },
1277
+ # predefined_indices: ["String"],
1278
+ # },
1279
+ # cloud_masking_config: {
1280
+ # },
1281
+ # cloud_removal_config: {
1282
+ # algorithm_name: "INTERPOLATION", # accepts INTERPOLATION
1283
+ # interpolation_value: "String",
1284
+ # target_bands: ["String"],
1285
+ # },
1286
+ # geo_mosaic_config: {
1287
+ # algorithm_name: "NEAR", # accepts NEAR, BILINEAR, CUBIC, CUBICSPLINE, LANCZOS, AVERAGE, RMS, MODE, MAX, MIN, MED, Q1, Q3, SUM
1288
+ # target_bands: ["String"],
1289
+ # },
1290
+ # land_cover_segmentation_config: {
1291
+ # },
1292
+ # resampling_config: {
1293
+ # algorithm_name: "NEAR", # accepts NEAR, BILINEAR, CUBIC, CUBICSPLINE, LANCZOS, AVERAGE, RMS, MODE, MAX, MIN, MED, Q1, Q3, SUM
1294
+ # output_resolution: { # required
1295
+ # user_defined: { # required
1296
+ # unit: "METERS", # required, accepts METERS
1297
+ # value: 1.0, # required
1298
+ # },
1299
+ # },
1300
+ # target_bands: ["String"],
1301
+ # },
1302
+ # stack_config: {
1303
+ # output_resolution: {
1304
+ # predefined: "HIGHEST", # accepts HIGHEST, LOWEST, AVERAGE
1305
+ # user_defined: {
1306
+ # unit: "METERS", # required, accepts METERS
1307
+ # value: 1.0, # required
1308
+ # },
1309
+ # },
1310
+ # target_bands: ["String"],
1311
+ # },
1312
+ # temporal_statistics_config: {
1313
+ # group_by: "ALL", # accepts ALL, YEARLY
1314
+ # statistics: ["MEAN"], # required, accepts MEAN, MEDIAN, STANDARD_DEVIATION
1315
+ # target_bands: ["String"],
1316
+ # },
1317
+ # zonal_statistics_config: {
1318
+ # statistics: ["MEAN"], # required, accepts MEAN, MEDIAN, STANDARD_DEVIATION, MAX, MIN, SUM
1319
+ # target_bands: ["String"],
1320
+ # zone_s3_path: "String", # required
1321
+ # },
1322
+ # },
1323
+ # kms_key_id: "String",
1324
+ # name: "String", # required
1325
+ # tags: {
1326
+ # "String" => "String",
1327
+ # },
1328
+ # })
1329
+ #
1330
+ # @example Response structure
1331
+ #
1332
+ # resp.arn #=> String
1333
+ # resp.creation_time #=> Time
1334
+ # resp.duration_in_seconds #=> Integer
1335
+ # resp.execution_role_arn #=> String
1336
+ # resp.input_config.data_source_config.s3_data.kms_key_id #=> String
1337
+ # resp.input_config.data_source_config.s3_data.metadata_provider #=> String, one of "PLANET_ORDER"
1338
+ # resp.input_config.data_source_config.s3_data.s3_uri #=> String
1339
+ # resp.input_config.previous_earth_observation_job_arn #=> String
1340
+ # resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.multi_polygon_geometry.coordinates #=> Array
1341
+ # resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.multi_polygon_geometry.coordinates[0] #=> Array
1342
+ # resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.multi_polygon_geometry.coordinates[0][0] #=> Array
1343
+ # resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.multi_polygon_geometry.coordinates[0][0][0] #=> Array
1344
+ # resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.multi_polygon_geometry.coordinates[0][0][0][0] #=> Float
1345
+ # resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.polygon_geometry.coordinates #=> Array
1346
+ # resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.polygon_geometry.coordinates[0] #=> Array
1347
+ # resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.polygon_geometry.coordinates[0][0] #=> Array
1348
+ # resp.input_config.raster_data_collection_query.area_of_interest.area_of_interest_geometry.polygon_geometry.coordinates[0][0][0] #=> Float
1349
+ # resp.input_config.raster_data_collection_query.property_filters.logical_operator #=> String, one of "AND"
1350
+ # resp.input_config.raster_data_collection_query.property_filters.properties #=> Array
1351
+ # resp.input_config.raster_data_collection_query.property_filters.properties[0].property.eo_cloud_cover.lower_bound #=> Float
1352
+ # resp.input_config.raster_data_collection_query.property_filters.properties[0].property.eo_cloud_cover.upper_bound #=> Float
1353
+ # resp.input_config.raster_data_collection_query.property_filters.properties[0].property.landsat_cloud_cover_land.lower_bound #=> Float
1354
+ # resp.input_config.raster_data_collection_query.property_filters.properties[0].property.landsat_cloud_cover_land.upper_bound #=> Float
1355
+ # resp.input_config.raster_data_collection_query.property_filters.properties[0].property.platform.comparison_operator #=> String, one of "EQUALS", "NOT_EQUALS", "STARTS_WITH"
1356
+ # resp.input_config.raster_data_collection_query.property_filters.properties[0].property.platform.value #=> String
1357
+ # resp.input_config.raster_data_collection_query.property_filters.properties[0].property.view_off_nadir.lower_bound #=> Float
1358
+ # resp.input_config.raster_data_collection_query.property_filters.properties[0].property.view_off_nadir.upper_bound #=> Float
1359
+ # resp.input_config.raster_data_collection_query.property_filters.properties[0].property.view_sun_azimuth.lower_bound #=> Float
1360
+ # resp.input_config.raster_data_collection_query.property_filters.properties[0].property.view_sun_azimuth.upper_bound #=> Float
1361
+ # resp.input_config.raster_data_collection_query.property_filters.properties[0].property.view_sun_elevation.lower_bound #=> Float
1362
+ # resp.input_config.raster_data_collection_query.property_filters.properties[0].property.view_sun_elevation.upper_bound #=> Float
1363
+ # resp.input_config.raster_data_collection_query.raster_data_collection_arn #=> String
1364
+ # resp.input_config.raster_data_collection_query.raster_data_collection_name #=> String
1365
+ # resp.input_config.raster_data_collection_query.time_range_filter.end_time #=> Time
1366
+ # resp.input_config.raster_data_collection_query.time_range_filter.start_time #=> Time
1367
+ # resp.job_config.band_math_config.custom_indices.operations #=> Array
1368
+ # resp.job_config.band_math_config.custom_indices.operations[0].equation #=> String
1369
+ # resp.job_config.band_math_config.custom_indices.operations[0].name #=> String
1370
+ # resp.job_config.band_math_config.custom_indices.operations[0].output_type #=> String, one of "INT32", "FLOAT32", "INT16", "FLOAT64", "UINT16"
1371
+ # resp.job_config.band_math_config.predefined_indices #=> Array
1372
+ # resp.job_config.band_math_config.predefined_indices[0] #=> String
1373
+ # resp.job_config.cloud_removal_config.algorithm_name #=> String, one of "INTERPOLATION"
1374
+ # resp.job_config.cloud_removal_config.interpolation_value #=> String
1375
+ # resp.job_config.cloud_removal_config.target_bands #=> Array
1376
+ # resp.job_config.cloud_removal_config.target_bands[0] #=> String
1377
+ # resp.job_config.geo_mosaic_config.algorithm_name #=> String, one of "NEAR", "BILINEAR", "CUBIC", "CUBICSPLINE", "LANCZOS", "AVERAGE", "RMS", "MODE", "MAX", "MIN", "MED", "Q1", "Q3", "SUM"
1378
+ # resp.job_config.geo_mosaic_config.target_bands #=> Array
1379
+ # resp.job_config.geo_mosaic_config.target_bands[0] #=> String
1380
+ # resp.job_config.resampling_config.algorithm_name #=> String, one of "NEAR", "BILINEAR", "CUBIC", "CUBICSPLINE", "LANCZOS", "AVERAGE", "RMS", "MODE", "MAX", "MIN", "MED", "Q1", "Q3", "SUM"
1381
+ # resp.job_config.resampling_config.output_resolution.user_defined.unit #=> String, one of "METERS"
1382
+ # resp.job_config.resampling_config.output_resolution.user_defined.value #=> Float
1383
+ # resp.job_config.resampling_config.target_bands #=> Array
1384
+ # resp.job_config.resampling_config.target_bands[0] #=> String
1385
+ # resp.job_config.stack_config.output_resolution.predefined #=> String, one of "HIGHEST", "LOWEST", "AVERAGE"
1386
+ # resp.job_config.stack_config.output_resolution.user_defined.unit #=> String, one of "METERS"
1387
+ # resp.job_config.stack_config.output_resolution.user_defined.value #=> Float
1388
+ # resp.job_config.stack_config.target_bands #=> Array
1389
+ # resp.job_config.stack_config.target_bands[0] #=> String
1390
+ # resp.job_config.temporal_statistics_config.group_by #=> String, one of "ALL", "YEARLY"
1391
+ # resp.job_config.temporal_statistics_config.statistics #=> Array
1392
+ # resp.job_config.temporal_statistics_config.statistics[0] #=> String, one of "MEAN", "MEDIAN", "STANDARD_DEVIATION"
1393
+ # resp.job_config.temporal_statistics_config.target_bands #=> Array
1394
+ # resp.job_config.temporal_statistics_config.target_bands[0] #=> String
1395
+ # resp.job_config.zonal_statistics_config.statistics #=> Array
1396
+ # resp.job_config.zonal_statistics_config.statistics[0] #=> String, one of "MEAN", "MEDIAN", "STANDARD_DEVIATION", "MAX", "MIN", "SUM"
1397
+ # resp.job_config.zonal_statistics_config.target_bands #=> Array
1398
+ # resp.job_config.zonal_statistics_config.target_bands[0] #=> String
1399
+ # resp.job_config.zonal_statistics_config.zone_s3_path #=> String
1400
+ # resp.kms_key_id #=> String
1401
+ # resp.name #=> String
1402
+ # resp.status #=> String, one of "INITIALIZING", "IN_PROGRESS", "STOPPING", "COMPLETED", "STOPPED", "FAILED", "DELETING", "DELETED"
1403
+ # resp.tags #=> Hash
1404
+ # resp.tags["String"] #=> String
1405
+ #
1406
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-geospatial-2020-05-27/StartEarthObservationJob AWS API Documentation
1407
+ #
1408
+ # @overload start_earth_observation_job(params = {})
1409
+ # @param [Hash] params ({})
1410
+ def start_earth_observation_job(params = {}, options = {})
1411
+ req = build_request(:start_earth_observation_job, params)
1412
+ req.send_request(options)
1413
+ end
1414
+
1415
+ # Creates a Vector Enrichment job for the supplied job type. Currently,
1416
+ # there are two supported job types: reverse geocoding and map matching.
1417
+ #
1418
+ # @option params [String] :client_token
1419
+ # A unique token that guarantees that the call to this API is
1420
+ # idempotent.
1421
+ #
1422
+ # **A suitable default value is auto-generated.** You should normally
1423
+ # not need to pass this option.**
1424
+ #
1425
+ # @option params [required, String] :execution_role_arn
1426
+ # The Amazon Resource Name (ARN) of the IAM role that you specified for
1427
+ # the job.
1428
+ #
1429
+ # @option params [required, Types::VectorEnrichmentJobInputConfig] :input_config
1430
+ # Input configuration information for the Vector Enrichment job.
1431
+ #
1432
+ # @option params [required, Types::VectorEnrichmentJobConfig] :job_config
1433
+ # An object containing information about the job configuration.
1434
+ #
1435
+ # @option params [String] :kms_key_id
1436
+ # The Amazon Key Management Service (KMS) key ID for server-side
1437
+ # encryption.
1438
+ #
1439
+ # @option params [required, String] :name
1440
+ # The name of the Vector Enrichment job.
1441
+ #
1442
+ # @option params [Hash<String,String>] :tags
1443
+ # Each tag consists of a key and a value.
1444
+ #
1445
+ # @return [Types::StartVectorEnrichmentJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1446
+ #
1447
+ # * {Types::StartVectorEnrichmentJobOutput#arn #arn} => String
1448
+ # * {Types::StartVectorEnrichmentJobOutput#creation_time #creation_time} => Time
1449
+ # * {Types::StartVectorEnrichmentJobOutput#duration_in_seconds #duration_in_seconds} => Integer
1450
+ # * {Types::StartVectorEnrichmentJobOutput#execution_role_arn #execution_role_arn} => String
1451
+ # * {Types::StartVectorEnrichmentJobOutput#input_config #input_config} => Types::VectorEnrichmentJobInputConfig
1452
+ # * {Types::StartVectorEnrichmentJobOutput#job_config #job_config} => Types::VectorEnrichmentJobConfig
1453
+ # * {Types::StartVectorEnrichmentJobOutput#kms_key_id #kms_key_id} => String
1454
+ # * {Types::StartVectorEnrichmentJobOutput#name #name} => String
1455
+ # * {Types::StartVectorEnrichmentJobOutput#status #status} => String
1456
+ # * {Types::StartVectorEnrichmentJobOutput#tags #tags} => Hash&lt;String,String&gt;
1457
+ # * {Types::StartVectorEnrichmentJobOutput#type #type} => String
1458
+ #
1459
+ # @example Request syntax with placeholder values
1460
+ #
1461
+ # resp = client.start_vector_enrichment_job({
1462
+ # client_token: "String",
1463
+ # execution_role_arn: "String", # required
1464
+ # input_config: { # required
1465
+ # data_source_config: { # required
1466
+ # s3_data: {
1467
+ # kms_key_id: "String",
1468
+ # s3_uri: "String", # required
1469
+ # },
1470
+ # },
1471
+ # document_type: "CSV", # required, accepts CSV
1472
+ # },
1473
+ # job_config: { # required
1474
+ # map_matching_config: {
1475
+ # id_attribute_name: "String", # required
1476
+ # timestamp_attribute_name: "String", # required
1477
+ # x_attribute_name: "String", # required
1478
+ # y_attribute_name: "String", # required
1479
+ # },
1480
+ # reverse_geocoding_config: {
1481
+ # x_attribute_name: "String", # required
1482
+ # y_attribute_name: "String", # required
1483
+ # },
1484
+ # },
1485
+ # kms_key_id: "String",
1486
+ # name: "String", # required
1487
+ # tags: {
1488
+ # "String" => "String",
1489
+ # },
1490
+ # })
1491
+ #
1492
+ # @example Response structure
1493
+ #
1494
+ # resp.arn #=> String
1495
+ # resp.creation_time #=> Time
1496
+ # resp.duration_in_seconds #=> Integer
1497
+ # resp.execution_role_arn #=> String
1498
+ # resp.input_config.data_source_config.s3_data.kms_key_id #=> String
1499
+ # resp.input_config.data_source_config.s3_data.s3_uri #=> String
1500
+ # resp.input_config.document_type #=> String, one of "CSV"
1501
+ # resp.job_config.map_matching_config.id_attribute_name #=> String
1502
+ # resp.job_config.map_matching_config.timestamp_attribute_name #=> String
1503
+ # resp.job_config.map_matching_config.x_attribute_name #=> String
1504
+ # resp.job_config.map_matching_config.y_attribute_name #=> String
1505
+ # resp.job_config.reverse_geocoding_config.x_attribute_name #=> String
1506
+ # resp.job_config.reverse_geocoding_config.y_attribute_name #=> String
1507
+ # resp.kms_key_id #=> String
1508
+ # resp.name #=> String
1509
+ # resp.status #=> String, one of "INITIALIZING", "IN_PROGRESS", "STOPPING", "STOPPED", "COMPLETED", "FAILED", "DELETING", "DELETED"
1510
+ # resp.tags #=> Hash
1511
+ # resp.tags["String"] #=> String
1512
+ # resp.type #=> String, one of "REVERSE_GEOCODING", "MAP_MATCHING"
1513
+ #
1514
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-geospatial-2020-05-27/StartVectorEnrichmentJob AWS API Documentation
1515
+ #
1516
+ # @overload start_vector_enrichment_job(params = {})
1517
+ # @param [Hash] params ({})
1518
+ def start_vector_enrichment_job(params = {}, options = {})
1519
+ req = build_request(:start_vector_enrichment_job, params)
1520
+ req.send_request(options)
1521
+ end
1522
+
1523
+ # Use this operation to stop an existing earth observation job.
1524
+ #
1525
+ # @option params [required, String] :arn
1526
+ # The Amazon Resource Name (ARN) of the Earth Observation job being
1527
+ # stopped.
1528
+ #
1529
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1530
+ #
1531
+ # @example Request syntax with placeholder values
1532
+ #
1533
+ # resp = client.stop_earth_observation_job({
1534
+ # arn: "EarthObservationJobArn", # required
1535
+ # })
1536
+ #
1537
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-geospatial-2020-05-27/StopEarthObservationJob AWS API Documentation
1538
+ #
1539
+ # @overload stop_earth_observation_job(params = {})
1540
+ # @param [Hash] params ({})
1541
+ def stop_earth_observation_job(params = {}, options = {})
1542
+ req = build_request(:stop_earth_observation_job, params)
1543
+ req.send_request(options)
1544
+ end
1545
+
1546
+ # Stops the Vector Enrichment job for a given job ARN.
1547
+ #
1548
+ # @option params [required, String] :arn
1549
+ # The Amazon Resource Name (ARN) of the Vector Enrichment job.
1550
+ #
1551
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1552
+ #
1553
+ # @example Request syntax with placeholder values
1554
+ #
1555
+ # resp = client.stop_vector_enrichment_job({
1556
+ # arn: "VectorEnrichmentJobArn", # required
1557
+ # })
1558
+ #
1559
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-geospatial-2020-05-27/StopVectorEnrichmentJob AWS API Documentation
1560
+ #
1561
+ # @overload stop_vector_enrichment_job(params = {})
1562
+ # @param [Hash] params ({})
1563
+ def stop_vector_enrichment_job(params = {}, options = {})
1564
+ req = build_request(:stop_vector_enrichment_job, params)
1565
+ req.send_request(options)
1566
+ end
1567
+
1568
+ # The resource you want to tag.
1569
+ #
1570
+ # @option params [required, String] :resource_arn
1571
+ # The Amazon Resource Name (ARN) of the resource you want to tag.
1572
+ #
1573
+ # @option params [required, Hash<String,String>] :tags
1574
+ # Each tag consists of a key and a value.
1575
+ #
1576
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1577
+ #
1578
+ # @example Request syntax with placeholder values
1579
+ #
1580
+ # resp = client.tag_resource({
1581
+ # resource_arn: "Arn", # required
1582
+ # tags: { # required
1583
+ # "String" => "String",
1584
+ # },
1585
+ # })
1586
+ #
1587
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-geospatial-2020-05-27/TagResource AWS API Documentation
1588
+ #
1589
+ # @overload tag_resource(params = {})
1590
+ # @param [Hash] params ({})
1591
+ def tag_resource(params = {}, options = {})
1592
+ req = build_request(:tag_resource, params)
1593
+ req.send_request(options)
1594
+ end
1595
+
1596
+ # The resource you want to untag.
1597
+ #
1598
+ # @option params [required, String] :resource_arn
1599
+ # The Amazon Resource Name (ARN) of the resource you want to untag.
1600
+ #
1601
+ # @option params [required, Array<String>] :tag_keys
1602
+ # Keys of the tags you want to remove.
1603
+ #
1604
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1605
+ #
1606
+ # @example Request syntax with placeholder values
1607
+ #
1608
+ # resp = client.untag_resource({
1609
+ # resource_arn: "Arn", # required
1610
+ # tag_keys: ["String"], # required
1611
+ # })
1612
+ #
1613
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-geospatial-2020-05-27/UntagResource AWS API Documentation
1614
+ #
1615
+ # @overload untag_resource(params = {})
1616
+ # @param [Hash] params ({})
1617
+ def untag_resource(params = {}, options = {})
1618
+ req = build_request(:untag_resource, params)
1619
+ req.send_request(options)
1620
+ end
1621
+
1622
+ # @!endgroup
1623
+
1624
+ # @param params ({})
1625
+ # @api private
1626
+ def build_request(operation_name, params = {})
1627
+ handlers = @handlers.for(operation_name)
1628
+ context = Seahorse::Client::RequestContext.new(
1629
+ operation_name: operation_name,
1630
+ operation: config.api.operation(operation_name),
1631
+ client: self,
1632
+ params: params,
1633
+ config: config)
1634
+ context[:gem_name] = 'aws-sdk-sagemakergeospatial'
1635
+ context[:gem_version] = '1.0.0'
1636
+ Seahorse::Client::Request.new(handlers, context)
1637
+ end
1638
+
1639
+ # @api private
1640
+ # @deprecated
1641
+ def waiter_names
1642
+ []
1643
+ end
1644
+
1645
+ class << self
1646
+
1647
+ # @api private
1648
+ attr_reader :identifier
1649
+
1650
+ # @api private
1651
+ def errors_module
1652
+ Errors
1653
+ end
1654
+
1655
+ end
1656
+ end
1657
+ end