aws-sdk-iotroborunner 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,1315 @@
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(:iotroborunner)
37
+
38
+ module Aws::IoTRoboRunner
39
+ # An API client for IoTRoboRunner. To construct a client, you need to configure a `:region` and `:credentials`.
40
+ #
41
+ # client = Aws::IoTRoboRunner::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 = :iotroborunner
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::IoTRoboRunner::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::IoTRoboRunner::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::IoTRoboRunner::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
+ # Grants permission to create a destination
372
+ #
373
+ # @option params [String] :client_token
374
+ # Token used for detecting replayed requests. Replayed requests will not
375
+ # be performed multiple times.
376
+ #
377
+ # **A suitable default value is auto-generated.** You should normally
378
+ # not need to pass this option.**
379
+ #
380
+ # @option params [required, String] :name
381
+ # Human friendly name of the resource.
382
+ #
383
+ # @option params [required, String] :site
384
+ # Site ARN.
385
+ #
386
+ # @option params [String] :state
387
+ # The state of the destination. Default used if not specified.
388
+ #
389
+ # @option params [String] :additional_fixed_properties
390
+ # JSON document containing additional fixed properties regarding the
391
+ # destination
392
+ #
393
+ # @return [Types::CreateDestinationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
394
+ #
395
+ # * {Types::CreateDestinationResponse#arn #arn} => String
396
+ # * {Types::CreateDestinationResponse#id #id} => String
397
+ # * {Types::CreateDestinationResponse#created_at #created_at} => Time
398
+ # * {Types::CreateDestinationResponse#updated_at #updated_at} => Time
399
+ # * {Types::CreateDestinationResponse#state #state} => String
400
+ #
401
+ # @example Request syntax with placeholder values
402
+ #
403
+ # resp = client.create_destination({
404
+ # client_token: "IdempotencyToken",
405
+ # name: "Name", # required
406
+ # site: "SiteGenericIdentifier", # required
407
+ # state: "ENABLED", # accepts ENABLED, DISABLED, DECOMMISSIONED
408
+ # additional_fixed_properties: "DestinationAdditionalFixedProperties",
409
+ # })
410
+ #
411
+ # @example Response structure
412
+ #
413
+ # resp.arn #=> String
414
+ # resp.id #=> String
415
+ # resp.created_at #=> Time
416
+ # resp.updated_at #=> Time
417
+ # resp.state #=> String, one of "ENABLED", "DISABLED", "DECOMMISSIONED"
418
+ #
419
+ # @overload create_destination(params = {})
420
+ # @param [Hash] params ({})
421
+ def create_destination(params = {}, options = {})
422
+ req = build_request(:create_destination, params)
423
+ req.send_request(options)
424
+ end
425
+
426
+ # Grants permission to create a site
427
+ #
428
+ # @option params [String] :client_token
429
+ # Token used for detecting replayed requests. Replayed requests will not
430
+ # be performed multiple times.
431
+ #
432
+ # **A suitable default value is auto-generated.** You should normally
433
+ # not need to pass this option.**
434
+ #
435
+ # @option params [required, String] :name
436
+ # Human friendly name of the resource.
437
+ #
438
+ # @option params [required, String] :country_code
439
+ # A valid ISO 3166-1 alpha-2 code for the country in which the site
440
+ # resides. e.g., US.
441
+ #
442
+ # @option params [String] :description
443
+ # A high-level description of the site.
444
+ #
445
+ # @return [Types::CreateSiteResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
446
+ #
447
+ # * {Types::CreateSiteResponse#arn #arn} => String
448
+ # * {Types::CreateSiteResponse#id #id} => String
449
+ # * {Types::CreateSiteResponse#created_at #created_at} => Time
450
+ # * {Types::CreateSiteResponse#updated_at #updated_at} => Time
451
+ #
452
+ # @example Request syntax with placeholder values
453
+ #
454
+ # resp = client.create_site({
455
+ # client_token: "IdempotencyToken",
456
+ # name: "Name", # required
457
+ # country_code: "SiteCountryCode", # required
458
+ # description: "SiteDescription",
459
+ # })
460
+ #
461
+ # @example Response structure
462
+ #
463
+ # resp.arn #=> String
464
+ # resp.id #=> String
465
+ # resp.created_at #=> Time
466
+ # resp.updated_at #=> Time
467
+ #
468
+ # @overload create_site(params = {})
469
+ # @param [Hash] params ({})
470
+ def create_site(params = {}, options = {})
471
+ req = build_request(:create_site, params)
472
+ req.send_request(options)
473
+ end
474
+
475
+ # Grants permission to create a worker
476
+ #
477
+ # @option params [String] :client_token
478
+ # Token used for detecting replayed requests. Replayed requests will not
479
+ # be performed multiple times.
480
+ #
481
+ # **A suitable default value is auto-generated.** You should normally
482
+ # not need to pass this option.**
483
+ #
484
+ # @option params [required, String] :name
485
+ # Human friendly name of the resource.
486
+ #
487
+ # @option params [required, String] :fleet
488
+ # Full ARN of the worker fleet.
489
+ #
490
+ # @option params [String] :additional_transient_properties
491
+ # JSON blob containing unstructured worker properties that are transient
492
+ # and may change during regular operation.
493
+ #
494
+ # @option params [String] :additional_fixed_properties
495
+ # JSON blob containing unstructured worker properties that are fixed and
496
+ # won't change during regular operation.
497
+ #
498
+ # @option params [Types::VendorProperties] :vendor_properties
499
+ # Properties of the worker that are provided by the vendor FMS.
500
+ #
501
+ # @option params [Types::PositionCoordinates] :position
502
+ # Supported coordinates for worker position.
503
+ #
504
+ # @option params [Types::Orientation] :orientation
505
+ # Worker orientation measured in units clockwise from north.
506
+ #
507
+ # @return [Types::CreateWorkerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
508
+ #
509
+ # * {Types::CreateWorkerResponse#arn #arn} => String
510
+ # * {Types::CreateWorkerResponse#id #id} => String
511
+ # * {Types::CreateWorkerResponse#created_at #created_at} => Time
512
+ # * {Types::CreateWorkerResponse#updated_at #updated_at} => Time
513
+ # * {Types::CreateWorkerResponse#site #site} => String
514
+ #
515
+ # @example Request syntax with placeholder values
516
+ #
517
+ # resp = client.create_worker({
518
+ # client_token: "IdempotencyToken",
519
+ # name: "Name", # required
520
+ # fleet: "WorkerFleetGenericIdentifier", # required
521
+ # additional_transient_properties: "WorkerAdditionalTransientPropertiesJson",
522
+ # additional_fixed_properties: "WorkerAdditionalFixedPropertiesJson",
523
+ # vendor_properties: {
524
+ # vendor_worker_id: "VendorWorkerId", # required
525
+ # vendor_worker_ip_address: "VendorWorkerIpAddress",
526
+ # vendor_additional_transient_properties: "VendorAdditionalTransientPropertiesJson",
527
+ # vendor_additional_fixed_properties: "VendorAdditionalFixedPropertiesJson",
528
+ # },
529
+ # position: {
530
+ # cartesian_coordinates: {
531
+ # x: 1.0, # required
532
+ # y: 1.0, # required
533
+ # z: 1.0,
534
+ # },
535
+ # },
536
+ # orientation: {
537
+ # degrees: 1.0,
538
+ # },
539
+ # })
540
+ #
541
+ # @example Response structure
542
+ #
543
+ # resp.arn #=> String
544
+ # resp.id #=> String
545
+ # resp.created_at #=> Time
546
+ # resp.updated_at #=> Time
547
+ # resp.site #=> String
548
+ #
549
+ # @overload create_worker(params = {})
550
+ # @param [Hash] params ({})
551
+ def create_worker(params = {}, options = {})
552
+ req = build_request(:create_worker, params)
553
+ req.send_request(options)
554
+ end
555
+
556
+ # Grants permission to create a worker fleet
557
+ #
558
+ # @option params [String] :client_token
559
+ # Token used for detecting replayed requests. Replayed requests will not
560
+ # be performed multiple times.
561
+ #
562
+ # **A suitable default value is auto-generated.** You should normally
563
+ # not need to pass this option.**
564
+ #
565
+ # @option params [required, String] :name
566
+ # Human friendly name of the resource.
567
+ #
568
+ # @option params [required, String] :site
569
+ # Site ARN.
570
+ #
571
+ # @option params [String] :additional_fixed_properties
572
+ # JSON blob containing additional fixed properties regarding the worker
573
+ # fleet
574
+ #
575
+ # @return [Types::CreateWorkerFleetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
576
+ #
577
+ # * {Types::CreateWorkerFleetResponse#arn #arn} => String
578
+ # * {Types::CreateWorkerFleetResponse#id #id} => String
579
+ # * {Types::CreateWorkerFleetResponse#created_at #created_at} => Time
580
+ # * {Types::CreateWorkerFleetResponse#updated_at #updated_at} => Time
581
+ #
582
+ # @example Request syntax with placeholder values
583
+ #
584
+ # resp = client.create_worker_fleet({
585
+ # client_token: "IdempotencyToken",
586
+ # name: "Name", # required
587
+ # site: "SiteGenericIdentifier", # required
588
+ # additional_fixed_properties: "WorkerFleetAdditionalFixedProperties",
589
+ # })
590
+ #
591
+ # @example Response structure
592
+ #
593
+ # resp.arn #=> String
594
+ # resp.id #=> String
595
+ # resp.created_at #=> Time
596
+ # resp.updated_at #=> Time
597
+ #
598
+ # @overload create_worker_fleet(params = {})
599
+ # @param [Hash] params ({})
600
+ def create_worker_fleet(params = {}, options = {})
601
+ req = build_request(:create_worker_fleet, params)
602
+ req.send_request(options)
603
+ end
604
+
605
+ # Grants permission to delete a destination
606
+ #
607
+ # @option params [required, String] :id
608
+ # Destination ARN.
609
+ #
610
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
611
+ #
612
+ # @example Request syntax with placeholder values
613
+ #
614
+ # resp = client.delete_destination({
615
+ # id: "DestinationGenericIdentifier", # required
616
+ # })
617
+ #
618
+ # @overload delete_destination(params = {})
619
+ # @param [Hash] params ({})
620
+ def delete_destination(params = {}, options = {})
621
+ req = build_request(:delete_destination, params)
622
+ req.send_request(options)
623
+ end
624
+
625
+ # Grants permission to delete a site
626
+ #
627
+ # @option params [required, String] :id
628
+ # Site ARN.
629
+ #
630
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
631
+ #
632
+ # @example Request syntax with placeholder values
633
+ #
634
+ # resp = client.delete_site({
635
+ # id: "SiteGenericIdentifier", # required
636
+ # })
637
+ #
638
+ # @overload delete_site(params = {})
639
+ # @param [Hash] params ({})
640
+ def delete_site(params = {}, options = {})
641
+ req = build_request(:delete_site, params)
642
+ req.send_request(options)
643
+ end
644
+
645
+ # Grants permission to delete a worker
646
+ #
647
+ # @option params [required, String] :id
648
+ # Full ARN of the worker.
649
+ #
650
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
651
+ #
652
+ # @example Request syntax with placeholder values
653
+ #
654
+ # resp = client.delete_worker({
655
+ # id: "WorkerGenericIdentifier", # required
656
+ # })
657
+ #
658
+ # @overload delete_worker(params = {})
659
+ # @param [Hash] params ({})
660
+ def delete_worker(params = {}, options = {})
661
+ req = build_request(:delete_worker, params)
662
+ req.send_request(options)
663
+ end
664
+
665
+ # Grants permission to delete a worker fleet
666
+ #
667
+ # @option params [required, String] :id
668
+ # Full ARN of the worker fleet.
669
+ #
670
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
671
+ #
672
+ # @example Request syntax with placeholder values
673
+ #
674
+ # resp = client.delete_worker_fleet({
675
+ # id: "WorkerFleetGenericIdentifier", # required
676
+ # })
677
+ #
678
+ # @overload delete_worker_fleet(params = {})
679
+ # @param [Hash] params ({})
680
+ def delete_worker_fleet(params = {}, options = {})
681
+ req = build_request(:delete_worker_fleet, params)
682
+ req.send_request(options)
683
+ end
684
+
685
+ # Grants permission to get a destination
686
+ #
687
+ # @option params [required, String] :id
688
+ # Destination ARN.
689
+ #
690
+ # @return [Types::GetDestinationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
691
+ #
692
+ # * {Types::GetDestinationResponse#arn #arn} => String
693
+ # * {Types::GetDestinationResponse#id #id} => String
694
+ # * {Types::GetDestinationResponse#name #name} => String
695
+ # * {Types::GetDestinationResponse#site #site} => String
696
+ # * {Types::GetDestinationResponse#created_at #created_at} => Time
697
+ # * {Types::GetDestinationResponse#updated_at #updated_at} => Time
698
+ # * {Types::GetDestinationResponse#state #state} => String
699
+ # * {Types::GetDestinationResponse#additional_fixed_properties #additional_fixed_properties} => String
700
+ #
701
+ # @example Request syntax with placeholder values
702
+ #
703
+ # resp = client.get_destination({
704
+ # id: "DestinationGenericIdentifier", # required
705
+ # })
706
+ #
707
+ # @example Response structure
708
+ #
709
+ # resp.arn #=> String
710
+ # resp.id #=> String
711
+ # resp.name #=> String
712
+ # resp.site #=> String
713
+ # resp.created_at #=> Time
714
+ # resp.updated_at #=> Time
715
+ # resp.state #=> String, one of "ENABLED", "DISABLED", "DECOMMISSIONED"
716
+ # resp.additional_fixed_properties #=> String
717
+ #
718
+ # @overload get_destination(params = {})
719
+ # @param [Hash] params ({})
720
+ def get_destination(params = {}, options = {})
721
+ req = build_request(:get_destination, params)
722
+ req.send_request(options)
723
+ end
724
+
725
+ # Grants permission to get a site
726
+ #
727
+ # @option params [required, String] :id
728
+ # Site ARN.
729
+ #
730
+ # @return [Types::GetSiteResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
731
+ #
732
+ # * {Types::GetSiteResponse#arn #arn} => String
733
+ # * {Types::GetSiteResponse#id #id} => String
734
+ # * {Types::GetSiteResponse#name #name} => String
735
+ # * {Types::GetSiteResponse#country_code #country_code} => String
736
+ # * {Types::GetSiteResponse#description #description} => String
737
+ # * {Types::GetSiteResponse#created_at #created_at} => Time
738
+ # * {Types::GetSiteResponse#updated_at #updated_at} => Time
739
+ #
740
+ # @example Request syntax with placeholder values
741
+ #
742
+ # resp = client.get_site({
743
+ # id: "SiteGenericIdentifier", # required
744
+ # })
745
+ #
746
+ # @example Response structure
747
+ #
748
+ # resp.arn #=> String
749
+ # resp.id #=> String
750
+ # resp.name #=> String
751
+ # resp.country_code #=> String
752
+ # resp.description #=> String
753
+ # resp.created_at #=> Time
754
+ # resp.updated_at #=> Time
755
+ #
756
+ # @overload get_site(params = {})
757
+ # @param [Hash] params ({})
758
+ def get_site(params = {}, options = {})
759
+ req = build_request(:get_site, params)
760
+ req.send_request(options)
761
+ end
762
+
763
+ # Grants permission to get a worker
764
+ #
765
+ # @option params [required, String] :id
766
+ # Full ARN of the worker.
767
+ #
768
+ # @return [Types::GetWorkerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
769
+ #
770
+ # * {Types::GetWorkerResponse#arn #arn} => String
771
+ # * {Types::GetWorkerResponse#id #id} => String
772
+ # * {Types::GetWorkerResponse#fleet #fleet} => String
773
+ # * {Types::GetWorkerResponse#site #site} => String
774
+ # * {Types::GetWorkerResponse#created_at #created_at} => Time
775
+ # * {Types::GetWorkerResponse#updated_at #updated_at} => Time
776
+ # * {Types::GetWorkerResponse#name #name} => String
777
+ # * {Types::GetWorkerResponse#additional_transient_properties #additional_transient_properties} => String
778
+ # * {Types::GetWorkerResponse#additional_fixed_properties #additional_fixed_properties} => String
779
+ # * {Types::GetWorkerResponse#vendor_properties #vendor_properties} => Types::VendorProperties
780
+ # * {Types::GetWorkerResponse#position #position} => Types::PositionCoordinates
781
+ # * {Types::GetWorkerResponse#orientation #orientation} => Types::Orientation
782
+ #
783
+ # @example Request syntax with placeholder values
784
+ #
785
+ # resp = client.get_worker({
786
+ # id: "WorkerGenericIdentifier", # required
787
+ # })
788
+ #
789
+ # @example Response structure
790
+ #
791
+ # resp.arn #=> String
792
+ # resp.id #=> String
793
+ # resp.fleet #=> String
794
+ # resp.site #=> String
795
+ # resp.created_at #=> Time
796
+ # resp.updated_at #=> Time
797
+ # resp.name #=> String
798
+ # resp.additional_transient_properties #=> String
799
+ # resp.additional_fixed_properties #=> String
800
+ # resp.vendor_properties.vendor_worker_id #=> String
801
+ # resp.vendor_properties.vendor_worker_ip_address #=> String
802
+ # resp.vendor_properties.vendor_additional_transient_properties #=> String
803
+ # resp.vendor_properties.vendor_additional_fixed_properties #=> String
804
+ # resp.position.cartesian_coordinates.x #=> Float
805
+ # resp.position.cartesian_coordinates.y #=> Float
806
+ # resp.position.cartesian_coordinates.z #=> Float
807
+ # resp.orientation.degrees #=> Float
808
+ #
809
+ # @overload get_worker(params = {})
810
+ # @param [Hash] params ({})
811
+ def get_worker(params = {}, options = {})
812
+ req = build_request(:get_worker, params)
813
+ req.send_request(options)
814
+ end
815
+
816
+ # Grants permission to get a worker fleet
817
+ #
818
+ # @option params [required, String] :id
819
+ # Full ARN of the worker fleet.
820
+ #
821
+ # @return [Types::GetWorkerFleetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
822
+ #
823
+ # * {Types::GetWorkerFleetResponse#id #id} => String
824
+ # * {Types::GetWorkerFleetResponse#arn #arn} => String
825
+ # * {Types::GetWorkerFleetResponse#name #name} => String
826
+ # * {Types::GetWorkerFleetResponse#site #site} => String
827
+ # * {Types::GetWorkerFleetResponse#created_at #created_at} => Time
828
+ # * {Types::GetWorkerFleetResponse#updated_at #updated_at} => Time
829
+ # * {Types::GetWorkerFleetResponse#additional_fixed_properties #additional_fixed_properties} => String
830
+ #
831
+ # @example Request syntax with placeholder values
832
+ #
833
+ # resp = client.get_worker_fleet({
834
+ # id: "WorkerFleetGenericIdentifier", # required
835
+ # })
836
+ #
837
+ # @example Response structure
838
+ #
839
+ # resp.id #=> String
840
+ # resp.arn #=> String
841
+ # resp.name #=> String
842
+ # resp.site #=> String
843
+ # resp.created_at #=> Time
844
+ # resp.updated_at #=> Time
845
+ # resp.additional_fixed_properties #=> String
846
+ #
847
+ # @overload get_worker_fleet(params = {})
848
+ # @param [Hash] params ({})
849
+ def get_worker_fleet(params = {}, options = {})
850
+ req = build_request(:get_worker_fleet, params)
851
+ req.send_request(options)
852
+ end
853
+
854
+ # Grants permission to list destinations
855
+ #
856
+ # @option params [required, String] :site
857
+ # Site ARN.
858
+ #
859
+ # @option params [Integer] :max_results
860
+ # Maximum number of results to retrieve in a single call.
861
+ #
862
+ # @option params [String] :next_token
863
+ # Pagination token returned when another page of data exists. Provide it
864
+ # in your next call to the API to receive the next page.
865
+ #
866
+ # @option params [String] :state
867
+ # State of the destination.
868
+ #
869
+ # @return [Types::ListDestinationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
870
+ #
871
+ # * {Types::ListDestinationsResponse#next_token #next_token} => String
872
+ # * {Types::ListDestinationsResponse#destinations #destinations} => Array&lt;Types::Destination&gt;
873
+ #
874
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
875
+ #
876
+ # @example Request syntax with placeholder values
877
+ #
878
+ # resp = client.list_destinations({
879
+ # site: "SiteGenericIdentifier", # required
880
+ # max_results: 1,
881
+ # next_token: "PaginationToken",
882
+ # state: "ENABLED", # accepts ENABLED, DISABLED, DECOMMISSIONED
883
+ # })
884
+ #
885
+ # @example Response structure
886
+ #
887
+ # resp.next_token #=> String
888
+ # resp.destinations #=> Array
889
+ # resp.destinations[0].arn #=> String
890
+ # resp.destinations[0].id #=> String
891
+ # resp.destinations[0].name #=> String
892
+ # resp.destinations[0].site #=> String
893
+ # resp.destinations[0].created_at #=> Time
894
+ # resp.destinations[0].updated_at #=> Time
895
+ # resp.destinations[0].state #=> String, one of "ENABLED", "DISABLED", "DECOMMISSIONED"
896
+ # resp.destinations[0].additional_fixed_properties #=> String
897
+ #
898
+ # @overload list_destinations(params = {})
899
+ # @param [Hash] params ({})
900
+ def list_destinations(params = {}, options = {})
901
+ req = build_request(:list_destinations, params)
902
+ req.send_request(options)
903
+ end
904
+
905
+ # Grants permission to list sites
906
+ #
907
+ # @option params [Integer] :max_results
908
+ # Maximum number of results to retrieve in a single ListSites call.
909
+ #
910
+ # @option params [String] :next_token
911
+ # Pagination token returned when another page of data exists. Provide it
912
+ # in your next call to the API to receive the next page.
913
+ #
914
+ # @return [Types::ListSitesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
915
+ #
916
+ # * {Types::ListSitesResponse#next_token #next_token} => String
917
+ # * {Types::ListSitesResponse#sites #sites} => Array&lt;Types::Site&gt;
918
+ #
919
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
920
+ #
921
+ # @example Request syntax with placeholder values
922
+ #
923
+ # resp = client.list_sites({
924
+ # max_results: 1,
925
+ # next_token: "PaginationToken",
926
+ # })
927
+ #
928
+ # @example Response structure
929
+ #
930
+ # resp.next_token #=> String
931
+ # resp.sites #=> Array
932
+ # resp.sites[0].arn #=> String
933
+ # resp.sites[0].name #=> String
934
+ # resp.sites[0].country_code #=> String
935
+ # resp.sites[0].created_at #=> Time
936
+ #
937
+ # @overload list_sites(params = {})
938
+ # @param [Hash] params ({})
939
+ def list_sites(params = {}, options = {})
940
+ req = build_request(:list_sites, params)
941
+ req.send_request(options)
942
+ end
943
+
944
+ # Grants permission to list worker fleets
945
+ #
946
+ # @option params [required, String] :site
947
+ # Site ARN.
948
+ #
949
+ # @option params [Integer] :max_results
950
+ # Maximum number of results to retrieve in a single ListWorkerFleets
951
+ # call.
952
+ #
953
+ # @option params [String] :next_token
954
+ # Pagination token returned when another page of data exists. Provide it
955
+ # in your next call to the API to receive the next page.
956
+ #
957
+ # @return [Types::ListWorkerFleetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
958
+ #
959
+ # * {Types::ListWorkerFleetsResponse#next_token #next_token} => String
960
+ # * {Types::ListWorkerFleetsResponse#worker_fleets #worker_fleets} => Array&lt;Types::WorkerFleet&gt;
961
+ #
962
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
963
+ #
964
+ # @example Request syntax with placeholder values
965
+ #
966
+ # resp = client.list_worker_fleets({
967
+ # site: "SiteGenericIdentifier", # required
968
+ # max_results: 1,
969
+ # next_token: "PaginationToken",
970
+ # })
971
+ #
972
+ # @example Response structure
973
+ #
974
+ # resp.next_token #=> String
975
+ # resp.worker_fleets #=> Array
976
+ # resp.worker_fleets[0].arn #=> String
977
+ # resp.worker_fleets[0].id #=> String
978
+ # resp.worker_fleets[0].name #=> String
979
+ # resp.worker_fleets[0].site #=> String
980
+ # resp.worker_fleets[0].created_at #=> Time
981
+ # resp.worker_fleets[0].updated_at #=> Time
982
+ # resp.worker_fleets[0].additional_fixed_properties #=> String
983
+ #
984
+ # @overload list_worker_fleets(params = {})
985
+ # @param [Hash] params ({})
986
+ def list_worker_fleets(params = {}, options = {})
987
+ req = build_request(:list_worker_fleets, params)
988
+ req.send_request(options)
989
+ end
990
+
991
+ # Grants permission to list workers
992
+ #
993
+ # @option params [required, String] :site
994
+ # Site ARN.
995
+ #
996
+ # @option params [Integer] :max_results
997
+ # Maximum number of results to retrieve in a single ListWorkers call.
998
+ #
999
+ # @option params [String] :next_token
1000
+ # Pagination token returned when another page of data exists. Provide it
1001
+ # in your next call to the API to receive the next page.
1002
+ #
1003
+ # @option params [String] :fleet
1004
+ # Full ARN of the worker fleet.
1005
+ #
1006
+ # @return [Types::ListWorkersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1007
+ #
1008
+ # * {Types::ListWorkersResponse#next_token #next_token} => String
1009
+ # * {Types::ListWorkersResponse#workers #workers} => Array&lt;Types::Worker&gt;
1010
+ #
1011
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1012
+ #
1013
+ # @example Request syntax with placeholder values
1014
+ #
1015
+ # resp = client.list_workers({
1016
+ # site: "SiteGenericIdentifier", # required
1017
+ # max_results: 1,
1018
+ # next_token: "PaginationToken",
1019
+ # fleet: "WorkerFleetGenericIdentifier",
1020
+ # })
1021
+ #
1022
+ # @example Response structure
1023
+ #
1024
+ # resp.next_token #=> String
1025
+ # resp.workers #=> Array
1026
+ # resp.workers[0].arn #=> String
1027
+ # resp.workers[0].id #=> String
1028
+ # resp.workers[0].fleet #=> String
1029
+ # resp.workers[0].created_at #=> Time
1030
+ # resp.workers[0].updated_at #=> Time
1031
+ # resp.workers[0].name #=> String
1032
+ # resp.workers[0].site #=> String
1033
+ # resp.workers[0].additional_transient_properties #=> String
1034
+ # resp.workers[0].additional_fixed_properties #=> String
1035
+ # resp.workers[0].vendor_properties.vendor_worker_id #=> String
1036
+ # resp.workers[0].vendor_properties.vendor_worker_ip_address #=> String
1037
+ # resp.workers[0].vendor_properties.vendor_additional_transient_properties #=> String
1038
+ # resp.workers[0].vendor_properties.vendor_additional_fixed_properties #=> String
1039
+ # resp.workers[0].position.cartesian_coordinates.x #=> Float
1040
+ # resp.workers[0].position.cartesian_coordinates.y #=> Float
1041
+ # resp.workers[0].position.cartesian_coordinates.z #=> Float
1042
+ # resp.workers[0].orientation.degrees #=> Float
1043
+ #
1044
+ # @overload list_workers(params = {})
1045
+ # @param [Hash] params ({})
1046
+ def list_workers(params = {}, options = {})
1047
+ req = build_request(:list_workers, params)
1048
+ req.send_request(options)
1049
+ end
1050
+
1051
+ # Grants permission to update a destination
1052
+ #
1053
+ # @option params [required, String] :id
1054
+ # Destination ARN.
1055
+ #
1056
+ # @option params [String] :name
1057
+ # Human friendly name of the resource.
1058
+ #
1059
+ # @option params [String] :state
1060
+ # State of the destination.
1061
+ #
1062
+ # @option params [String] :additional_fixed_properties
1063
+ # JSON document containing additional fixed properties regarding the
1064
+ # destination
1065
+ #
1066
+ # @return [Types::UpdateDestinationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1067
+ #
1068
+ # * {Types::UpdateDestinationResponse#arn #arn} => String
1069
+ # * {Types::UpdateDestinationResponse#id #id} => String
1070
+ # * {Types::UpdateDestinationResponse#name #name} => String
1071
+ # * {Types::UpdateDestinationResponse#updated_at #updated_at} => Time
1072
+ # * {Types::UpdateDestinationResponse#state #state} => String
1073
+ # * {Types::UpdateDestinationResponse#additional_fixed_properties #additional_fixed_properties} => String
1074
+ #
1075
+ # @example Request syntax with placeholder values
1076
+ #
1077
+ # resp = client.update_destination({
1078
+ # id: "DestinationGenericIdentifier", # required
1079
+ # name: "Name",
1080
+ # state: "ENABLED", # accepts ENABLED, DISABLED, DECOMMISSIONED
1081
+ # additional_fixed_properties: "DestinationAdditionalFixedProperties",
1082
+ # })
1083
+ #
1084
+ # @example Response structure
1085
+ #
1086
+ # resp.arn #=> String
1087
+ # resp.id #=> String
1088
+ # resp.name #=> String
1089
+ # resp.updated_at #=> Time
1090
+ # resp.state #=> String, one of "ENABLED", "DISABLED", "DECOMMISSIONED"
1091
+ # resp.additional_fixed_properties #=> String
1092
+ #
1093
+ # @overload update_destination(params = {})
1094
+ # @param [Hash] params ({})
1095
+ def update_destination(params = {}, options = {})
1096
+ req = build_request(:update_destination, params)
1097
+ req.send_request(options)
1098
+ end
1099
+
1100
+ # Grants permission to update a site
1101
+ #
1102
+ # @option params [required, String] :id
1103
+ # Site ARN.
1104
+ #
1105
+ # @option params [String] :name
1106
+ # Human friendly name of the resource.
1107
+ #
1108
+ # @option params [String] :country_code
1109
+ # A valid ISO 3166-1 alpha-2 code for the country in which the site
1110
+ # resides. e.g., US.
1111
+ #
1112
+ # @option params [String] :description
1113
+ # A high-level description of the site.
1114
+ #
1115
+ # @return [Types::UpdateSiteResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1116
+ #
1117
+ # * {Types::UpdateSiteResponse#arn #arn} => String
1118
+ # * {Types::UpdateSiteResponse#id #id} => String
1119
+ # * {Types::UpdateSiteResponse#name #name} => String
1120
+ # * {Types::UpdateSiteResponse#country_code #country_code} => String
1121
+ # * {Types::UpdateSiteResponse#description #description} => String
1122
+ # * {Types::UpdateSiteResponse#updated_at #updated_at} => Time
1123
+ #
1124
+ # @example Request syntax with placeholder values
1125
+ #
1126
+ # resp = client.update_site({
1127
+ # id: "SiteGenericIdentifier", # required
1128
+ # name: "Name",
1129
+ # country_code: "SiteCountryCode",
1130
+ # description: "SiteDescription",
1131
+ # })
1132
+ #
1133
+ # @example Response structure
1134
+ #
1135
+ # resp.arn #=> String
1136
+ # resp.id #=> String
1137
+ # resp.name #=> String
1138
+ # resp.country_code #=> String
1139
+ # resp.description #=> String
1140
+ # resp.updated_at #=> Time
1141
+ #
1142
+ # @overload update_site(params = {})
1143
+ # @param [Hash] params ({})
1144
+ def update_site(params = {}, options = {})
1145
+ req = build_request(:update_site, params)
1146
+ req.send_request(options)
1147
+ end
1148
+
1149
+ # Grants permission to update a worker
1150
+ #
1151
+ # @option params [required, String] :id
1152
+ # Full ARN of the worker.
1153
+ #
1154
+ # @option params [String] :name
1155
+ # Human friendly name of the resource.
1156
+ #
1157
+ # @option params [String] :additional_transient_properties
1158
+ # JSON blob containing unstructured worker properties that are transient
1159
+ # and may change during regular operation.
1160
+ #
1161
+ # @option params [String] :additional_fixed_properties
1162
+ # JSON blob containing unstructured worker properties that are fixed and
1163
+ # won't change during regular operation.
1164
+ #
1165
+ # @option params [Types::VendorProperties] :vendor_properties
1166
+ # Properties of the worker that are provided by the vendor FMS.
1167
+ #
1168
+ # @option params [Types::PositionCoordinates] :position
1169
+ # Supported coordinates for worker position.
1170
+ #
1171
+ # @option params [Types::Orientation] :orientation
1172
+ # Worker orientation measured in units clockwise from north.
1173
+ #
1174
+ # @return [Types::UpdateWorkerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1175
+ #
1176
+ # * {Types::UpdateWorkerResponse#arn #arn} => String
1177
+ # * {Types::UpdateWorkerResponse#id #id} => String
1178
+ # * {Types::UpdateWorkerResponse#fleet #fleet} => String
1179
+ # * {Types::UpdateWorkerResponse#updated_at #updated_at} => Time
1180
+ # * {Types::UpdateWorkerResponse#name #name} => String
1181
+ # * {Types::UpdateWorkerResponse#additional_transient_properties #additional_transient_properties} => String
1182
+ # * {Types::UpdateWorkerResponse#additional_fixed_properties #additional_fixed_properties} => String
1183
+ # * {Types::UpdateWorkerResponse#orientation #orientation} => Types::Orientation
1184
+ # * {Types::UpdateWorkerResponse#vendor_properties #vendor_properties} => Types::VendorProperties
1185
+ # * {Types::UpdateWorkerResponse#position #position} => Types::PositionCoordinates
1186
+ #
1187
+ # @example Request syntax with placeholder values
1188
+ #
1189
+ # resp = client.update_worker({
1190
+ # id: "WorkerGenericIdentifier", # required
1191
+ # name: "Name",
1192
+ # additional_transient_properties: "WorkerAdditionalTransientPropertiesJson",
1193
+ # additional_fixed_properties: "WorkerAdditionalFixedPropertiesJson",
1194
+ # vendor_properties: {
1195
+ # vendor_worker_id: "VendorWorkerId", # required
1196
+ # vendor_worker_ip_address: "VendorWorkerIpAddress",
1197
+ # vendor_additional_transient_properties: "VendorAdditionalTransientPropertiesJson",
1198
+ # vendor_additional_fixed_properties: "VendorAdditionalFixedPropertiesJson",
1199
+ # },
1200
+ # position: {
1201
+ # cartesian_coordinates: {
1202
+ # x: 1.0, # required
1203
+ # y: 1.0, # required
1204
+ # z: 1.0,
1205
+ # },
1206
+ # },
1207
+ # orientation: {
1208
+ # degrees: 1.0,
1209
+ # },
1210
+ # })
1211
+ #
1212
+ # @example Response structure
1213
+ #
1214
+ # resp.arn #=> String
1215
+ # resp.id #=> String
1216
+ # resp.fleet #=> String
1217
+ # resp.updated_at #=> Time
1218
+ # resp.name #=> String
1219
+ # resp.additional_transient_properties #=> String
1220
+ # resp.additional_fixed_properties #=> String
1221
+ # resp.orientation.degrees #=> Float
1222
+ # resp.vendor_properties.vendor_worker_id #=> String
1223
+ # resp.vendor_properties.vendor_worker_ip_address #=> String
1224
+ # resp.vendor_properties.vendor_additional_transient_properties #=> String
1225
+ # resp.vendor_properties.vendor_additional_fixed_properties #=> String
1226
+ # resp.position.cartesian_coordinates.x #=> Float
1227
+ # resp.position.cartesian_coordinates.y #=> Float
1228
+ # resp.position.cartesian_coordinates.z #=> Float
1229
+ #
1230
+ # @overload update_worker(params = {})
1231
+ # @param [Hash] params ({})
1232
+ def update_worker(params = {}, options = {})
1233
+ req = build_request(:update_worker, params)
1234
+ req.send_request(options)
1235
+ end
1236
+
1237
+ # Grants permission to update a worker fleet
1238
+ #
1239
+ # @option params [required, String] :id
1240
+ # Full ARN of the worker fleet.
1241
+ #
1242
+ # @option params [String] :name
1243
+ # Human friendly name of the resource.
1244
+ #
1245
+ # @option params [String] :additional_fixed_properties
1246
+ # JSON blob containing additional fixed properties regarding the worker
1247
+ # fleet
1248
+ #
1249
+ # @return [Types::UpdateWorkerFleetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1250
+ #
1251
+ # * {Types::UpdateWorkerFleetResponse#arn #arn} => String
1252
+ # * {Types::UpdateWorkerFleetResponse#id #id} => String
1253
+ # * {Types::UpdateWorkerFleetResponse#name #name} => String
1254
+ # * {Types::UpdateWorkerFleetResponse#updated_at #updated_at} => Time
1255
+ # * {Types::UpdateWorkerFleetResponse#additional_fixed_properties #additional_fixed_properties} => String
1256
+ #
1257
+ # @example Request syntax with placeholder values
1258
+ #
1259
+ # resp = client.update_worker_fleet({
1260
+ # id: "WorkerFleetGenericIdentifier", # required
1261
+ # name: "Name",
1262
+ # additional_fixed_properties: "WorkerFleetAdditionalFixedProperties",
1263
+ # })
1264
+ #
1265
+ # @example Response structure
1266
+ #
1267
+ # resp.arn #=> String
1268
+ # resp.id #=> String
1269
+ # resp.name #=> String
1270
+ # resp.updated_at #=> Time
1271
+ # resp.additional_fixed_properties #=> String
1272
+ #
1273
+ # @overload update_worker_fleet(params = {})
1274
+ # @param [Hash] params ({})
1275
+ def update_worker_fleet(params = {}, options = {})
1276
+ req = build_request(:update_worker_fleet, params)
1277
+ req.send_request(options)
1278
+ end
1279
+
1280
+ # @!endgroup
1281
+
1282
+ # @param params ({})
1283
+ # @api private
1284
+ def build_request(operation_name, params = {})
1285
+ handlers = @handlers.for(operation_name)
1286
+ context = Seahorse::Client::RequestContext.new(
1287
+ operation_name: operation_name,
1288
+ operation: config.api.operation(operation_name),
1289
+ client: self,
1290
+ params: params,
1291
+ config: config)
1292
+ context[:gem_name] = 'aws-sdk-iotroborunner'
1293
+ context[:gem_version] = '1.0.0'
1294
+ Seahorse::Client::Request.new(handlers, context)
1295
+ end
1296
+
1297
+ # @api private
1298
+ # @deprecated
1299
+ def waiter_names
1300
+ []
1301
+ end
1302
+
1303
+ class << self
1304
+
1305
+ # @api private
1306
+ attr_reader :identifier
1307
+
1308
+ # @api private
1309
+ def errors_module
1310
+ Errors
1311
+ end
1312
+
1313
+ end
1314
+ end
1315
+ end