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.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-iotroborunner/client.rb +1315 -0
- data/lib/aws-sdk-iotroborunner/client_api.rb +743 -0
- data/lib/aws-sdk-iotroborunner/customizations.rb +0 -0
- data/lib/aws-sdk-iotroborunner/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-iotroborunner/endpoint_provider.rb +111 -0
- data/lib/aws-sdk-iotroborunner/endpoints.rb +295 -0
- data/lib/aws-sdk-iotroborunner/errors.rb +166 -0
- data/lib/aws-sdk-iotroborunner/plugins/endpoints.rb +108 -0
- data/lib/aws-sdk-iotroborunner/resource.rb +26 -0
- data/lib/aws-sdk-iotroborunner/types.rb +1568 -0
- data/lib/aws-sdk-iotroborunner.rb +57 -0
- metadata +94 -0
@@ -0,0 +1,1568 @@
|
|
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
|
+
module Aws::IoTRoboRunner
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# User does not have sufficient access to perform this action.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] message
|
16
|
+
# @return [String]
|
17
|
+
#
|
18
|
+
class AccessDeniedException < Struct.new(
|
19
|
+
:message)
|
20
|
+
SENSITIVE = []
|
21
|
+
include Aws::Structure
|
22
|
+
end
|
23
|
+
|
24
|
+
# Cartesian coordinates in 3D space relative to the RoboRunner origin.
|
25
|
+
#
|
26
|
+
# @note When making an API call, you may pass CartesianCoordinates
|
27
|
+
# data as a hash:
|
28
|
+
#
|
29
|
+
# {
|
30
|
+
# x: 1.0, # required
|
31
|
+
# y: 1.0, # required
|
32
|
+
# z: 1.0,
|
33
|
+
# }
|
34
|
+
#
|
35
|
+
# @!attribute [rw] x
|
36
|
+
# X coordinate.
|
37
|
+
# @return [Float]
|
38
|
+
#
|
39
|
+
# @!attribute [rw] y
|
40
|
+
# Y coordinate.
|
41
|
+
# @return [Float]
|
42
|
+
#
|
43
|
+
# @!attribute [rw] z
|
44
|
+
# Z coordinate.
|
45
|
+
# @return [Float]
|
46
|
+
#
|
47
|
+
class CartesianCoordinates < Struct.new(
|
48
|
+
:x,
|
49
|
+
:y,
|
50
|
+
:z)
|
51
|
+
SENSITIVE = []
|
52
|
+
include Aws::Structure
|
53
|
+
end
|
54
|
+
|
55
|
+
# Exception thrown if a resource in a create request already exists.
|
56
|
+
#
|
57
|
+
# @!attribute [rw] message
|
58
|
+
# @return [String]
|
59
|
+
#
|
60
|
+
class ConflictException < Struct.new(
|
61
|
+
:message)
|
62
|
+
SENSITIVE = []
|
63
|
+
include Aws::Structure
|
64
|
+
end
|
65
|
+
|
66
|
+
# @note When making an API call, you may pass CreateDestinationRequest
|
67
|
+
# data as a hash:
|
68
|
+
#
|
69
|
+
# {
|
70
|
+
# client_token: "IdempotencyToken",
|
71
|
+
# name: "Name", # required
|
72
|
+
# site: "SiteGenericIdentifier", # required
|
73
|
+
# state: "ENABLED", # accepts ENABLED, DISABLED, DECOMMISSIONED
|
74
|
+
# additional_fixed_properties: "DestinationAdditionalFixedProperties",
|
75
|
+
# }
|
76
|
+
#
|
77
|
+
# @!attribute [rw] client_token
|
78
|
+
# Token used for detecting replayed requests. Replayed requests will
|
79
|
+
# not be performed multiple times.
|
80
|
+
#
|
81
|
+
# **A suitable default value is auto-generated.** You should normally
|
82
|
+
# not need to pass this option.
|
83
|
+
# @return [String]
|
84
|
+
#
|
85
|
+
# @!attribute [rw] name
|
86
|
+
# Human friendly name of the resource.
|
87
|
+
# @return [String]
|
88
|
+
#
|
89
|
+
# @!attribute [rw] site
|
90
|
+
# Site ARN.
|
91
|
+
# @return [String]
|
92
|
+
#
|
93
|
+
# @!attribute [rw] state
|
94
|
+
# The state of the destination. Default used if not specified.
|
95
|
+
# @return [String]
|
96
|
+
#
|
97
|
+
# @!attribute [rw] additional_fixed_properties
|
98
|
+
# JSON document containing additional fixed properties regarding the
|
99
|
+
# destination
|
100
|
+
# @return [String]
|
101
|
+
#
|
102
|
+
class CreateDestinationRequest < Struct.new(
|
103
|
+
:client_token,
|
104
|
+
:name,
|
105
|
+
:site,
|
106
|
+
:state,
|
107
|
+
:additional_fixed_properties)
|
108
|
+
SENSITIVE = []
|
109
|
+
include Aws::Structure
|
110
|
+
end
|
111
|
+
|
112
|
+
# @!attribute [rw] arn
|
113
|
+
# Destination ARN.
|
114
|
+
# @return [String]
|
115
|
+
#
|
116
|
+
# @!attribute [rw] id
|
117
|
+
# Filters access by the destination's identifier
|
118
|
+
# @return [String]
|
119
|
+
#
|
120
|
+
# @!attribute [rw] created_at
|
121
|
+
# Timestamp at which the resource was created.
|
122
|
+
# @return [Time]
|
123
|
+
#
|
124
|
+
# @!attribute [rw] updated_at
|
125
|
+
# Timestamp at which the resource was last updated.
|
126
|
+
# @return [Time]
|
127
|
+
#
|
128
|
+
# @!attribute [rw] state
|
129
|
+
# State of the destination.
|
130
|
+
# @return [String]
|
131
|
+
#
|
132
|
+
class CreateDestinationResponse < Struct.new(
|
133
|
+
:arn,
|
134
|
+
:id,
|
135
|
+
:created_at,
|
136
|
+
:updated_at,
|
137
|
+
:state)
|
138
|
+
SENSITIVE = []
|
139
|
+
include Aws::Structure
|
140
|
+
end
|
141
|
+
|
142
|
+
# @note When making an API call, you may pass CreateSiteRequest
|
143
|
+
# data as a hash:
|
144
|
+
#
|
145
|
+
# {
|
146
|
+
# client_token: "IdempotencyToken",
|
147
|
+
# name: "Name", # required
|
148
|
+
# country_code: "SiteCountryCode", # required
|
149
|
+
# description: "SiteDescription",
|
150
|
+
# }
|
151
|
+
#
|
152
|
+
# @!attribute [rw] client_token
|
153
|
+
# Token used for detecting replayed requests. Replayed requests will
|
154
|
+
# not be performed multiple times.
|
155
|
+
#
|
156
|
+
# **A suitable default value is auto-generated.** You should normally
|
157
|
+
# not need to pass this option.
|
158
|
+
# @return [String]
|
159
|
+
#
|
160
|
+
# @!attribute [rw] name
|
161
|
+
# Human friendly name of the resource.
|
162
|
+
# @return [String]
|
163
|
+
#
|
164
|
+
# @!attribute [rw] country_code
|
165
|
+
# A valid ISO 3166-1 alpha-2 code for the country in which the site
|
166
|
+
# resides. e.g., US.
|
167
|
+
# @return [String]
|
168
|
+
#
|
169
|
+
# @!attribute [rw] description
|
170
|
+
# A high-level description of the site.
|
171
|
+
# @return [String]
|
172
|
+
#
|
173
|
+
class CreateSiteRequest < Struct.new(
|
174
|
+
:client_token,
|
175
|
+
:name,
|
176
|
+
:country_code,
|
177
|
+
:description)
|
178
|
+
SENSITIVE = []
|
179
|
+
include Aws::Structure
|
180
|
+
end
|
181
|
+
|
182
|
+
# @!attribute [rw] arn
|
183
|
+
# Site ARN.
|
184
|
+
# @return [String]
|
185
|
+
#
|
186
|
+
# @!attribute [rw] id
|
187
|
+
# Filters access by the site's identifier
|
188
|
+
# @return [String]
|
189
|
+
#
|
190
|
+
# @!attribute [rw] created_at
|
191
|
+
# Timestamp at which the resource was created.
|
192
|
+
# @return [Time]
|
193
|
+
#
|
194
|
+
# @!attribute [rw] updated_at
|
195
|
+
# Timestamp at which the resource was last updated.
|
196
|
+
# @return [Time]
|
197
|
+
#
|
198
|
+
class CreateSiteResponse < Struct.new(
|
199
|
+
:arn,
|
200
|
+
:id,
|
201
|
+
:created_at,
|
202
|
+
:updated_at)
|
203
|
+
SENSITIVE = []
|
204
|
+
include Aws::Structure
|
205
|
+
end
|
206
|
+
|
207
|
+
# @note When making an API call, you may pass CreateWorkerFleetRequest
|
208
|
+
# data as a hash:
|
209
|
+
#
|
210
|
+
# {
|
211
|
+
# client_token: "IdempotencyToken",
|
212
|
+
# name: "Name", # required
|
213
|
+
# site: "SiteGenericIdentifier", # required
|
214
|
+
# additional_fixed_properties: "WorkerFleetAdditionalFixedProperties",
|
215
|
+
# }
|
216
|
+
#
|
217
|
+
# @!attribute [rw] client_token
|
218
|
+
# Token used for detecting replayed requests. Replayed requests will
|
219
|
+
# not be performed multiple times.
|
220
|
+
#
|
221
|
+
# **A suitable default value is auto-generated.** You should normally
|
222
|
+
# not need to pass this option.
|
223
|
+
# @return [String]
|
224
|
+
#
|
225
|
+
# @!attribute [rw] name
|
226
|
+
# Human friendly name of the resource.
|
227
|
+
# @return [String]
|
228
|
+
#
|
229
|
+
# @!attribute [rw] site
|
230
|
+
# Site ARN.
|
231
|
+
# @return [String]
|
232
|
+
#
|
233
|
+
# @!attribute [rw] additional_fixed_properties
|
234
|
+
# JSON blob containing additional fixed properties regarding the
|
235
|
+
# worker fleet
|
236
|
+
# @return [String]
|
237
|
+
#
|
238
|
+
class CreateWorkerFleetRequest < Struct.new(
|
239
|
+
:client_token,
|
240
|
+
:name,
|
241
|
+
:site,
|
242
|
+
:additional_fixed_properties)
|
243
|
+
SENSITIVE = []
|
244
|
+
include Aws::Structure
|
245
|
+
end
|
246
|
+
|
247
|
+
# @!attribute [rw] arn
|
248
|
+
# Full ARN of the worker fleet.
|
249
|
+
# @return [String]
|
250
|
+
#
|
251
|
+
# @!attribute [rw] id
|
252
|
+
# Filters access by the worker fleet's identifier
|
253
|
+
# @return [String]
|
254
|
+
#
|
255
|
+
# @!attribute [rw] created_at
|
256
|
+
# Timestamp at which the resource was created.
|
257
|
+
# @return [Time]
|
258
|
+
#
|
259
|
+
# @!attribute [rw] updated_at
|
260
|
+
# Timestamp at which the resource was last updated.
|
261
|
+
# @return [Time]
|
262
|
+
#
|
263
|
+
class CreateWorkerFleetResponse < Struct.new(
|
264
|
+
:arn,
|
265
|
+
:id,
|
266
|
+
:created_at,
|
267
|
+
:updated_at)
|
268
|
+
SENSITIVE = []
|
269
|
+
include Aws::Structure
|
270
|
+
end
|
271
|
+
|
272
|
+
# @note When making an API call, you may pass CreateWorkerRequest
|
273
|
+
# data as a hash:
|
274
|
+
#
|
275
|
+
# {
|
276
|
+
# client_token: "IdempotencyToken",
|
277
|
+
# name: "Name", # required
|
278
|
+
# fleet: "WorkerFleetGenericIdentifier", # required
|
279
|
+
# additional_transient_properties: "WorkerAdditionalTransientPropertiesJson",
|
280
|
+
# additional_fixed_properties: "WorkerAdditionalFixedPropertiesJson",
|
281
|
+
# vendor_properties: {
|
282
|
+
# vendor_worker_id: "VendorWorkerId", # required
|
283
|
+
# vendor_worker_ip_address: "VendorWorkerIpAddress",
|
284
|
+
# vendor_additional_transient_properties: "VendorAdditionalTransientPropertiesJson",
|
285
|
+
# vendor_additional_fixed_properties: "VendorAdditionalFixedPropertiesJson",
|
286
|
+
# },
|
287
|
+
# position: {
|
288
|
+
# cartesian_coordinates: {
|
289
|
+
# x: 1.0, # required
|
290
|
+
# y: 1.0, # required
|
291
|
+
# z: 1.0,
|
292
|
+
# },
|
293
|
+
# },
|
294
|
+
# orientation: {
|
295
|
+
# degrees: 1.0,
|
296
|
+
# },
|
297
|
+
# }
|
298
|
+
#
|
299
|
+
# @!attribute [rw] client_token
|
300
|
+
# Token used for detecting replayed requests. Replayed requests will
|
301
|
+
# not be performed multiple times.
|
302
|
+
#
|
303
|
+
# **A suitable default value is auto-generated.** You should normally
|
304
|
+
# not need to pass this option.
|
305
|
+
# @return [String]
|
306
|
+
#
|
307
|
+
# @!attribute [rw] name
|
308
|
+
# Human friendly name of the resource.
|
309
|
+
# @return [String]
|
310
|
+
#
|
311
|
+
# @!attribute [rw] fleet
|
312
|
+
# Full ARN of the worker fleet.
|
313
|
+
# @return [String]
|
314
|
+
#
|
315
|
+
# @!attribute [rw] additional_transient_properties
|
316
|
+
# JSON blob containing unstructured worker properties that are
|
317
|
+
# transient and may change during regular operation.
|
318
|
+
# @return [String]
|
319
|
+
#
|
320
|
+
# @!attribute [rw] additional_fixed_properties
|
321
|
+
# JSON blob containing unstructured worker properties that are fixed
|
322
|
+
# and won't change during regular operation.
|
323
|
+
# @return [String]
|
324
|
+
#
|
325
|
+
# @!attribute [rw] vendor_properties
|
326
|
+
# Properties of the worker that are provided by the vendor FMS.
|
327
|
+
# @return [Types::VendorProperties]
|
328
|
+
#
|
329
|
+
# @!attribute [rw] position
|
330
|
+
# Supported coordinates for worker position.
|
331
|
+
# @return [Types::PositionCoordinates]
|
332
|
+
#
|
333
|
+
# @!attribute [rw] orientation
|
334
|
+
# Worker orientation measured in units clockwise from north.
|
335
|
+
# @return [Types::Orientation]
|
336
|
+
#
|
337
|
+
class CreateWorkerRequest < Struct.new(
|
338
|
+
:client_token,
|
339
|
+
:name,
|
340
|
+
:fleet,
|
341
|
+
:additional_transient_properties,
|
342
|
+
:additional_fixed_properties,
|
343
|
+
:vendor_properties,
|
344
|
+
:position,
|
345
|
+
:orientation)
|
346
|
+
SENSITIVE = []
|
347
|
+
include Aws::Structure
|
348
|
+
end
|
349
|
+
|
350
|
+
# @!attribute [rw] arn
|
351
|
+
# Full ARN of the worker.
|
352
|
+
# @return [String]
|
353
|
+
#
|
354
|
+
# @!attribute [rw] id
|
355
|
+
# Filters access by the workers identifier
|
356
|
+
# @return [String]
|
357
|
+
#
|
358
|
+
# @!attribute [rw] created_at
|
359
|
+
# Timestamp at which the resource was created.
|
360
|
+
# @return [Time]
|
361
|
+
#
|
362
|
+
# @!attribute [rw] updated_at
|
363
|
+
# Timestamp at which the resource was last updated.
|
364
|
+
# @return [Time]
|
365
|
+
#
|
366
|
+
# @!attribute [rw] site
|
367
|
+
# Site ARN.
|
368
|
+
# @return [String]
|
369
|
+
#
|
370
|
+
class CreateWorkerResponse < Struct.new(
|
371
|
+
:arn,
|
372
|
+
:id,
|
373
|
+
:created_at,
|
374
|
+
:updated_at,
|
375
|
+
:site)
|
376
|
+
SENSITIVE = []
|
377
|
+
include Aws::Structure
|
378
|
+
end
|
379
|
+
|
380
|
+
# @note When making an API call, you may pass DeleteDestinationRequest
|
381
|
+
# data as a hash:
|
382
|
+
#
|
383
|
+
# {
|
384
|
+
# id: "DestinationGenericIdentifier", # required
|
385
|
+
# }
|
386
|
+
#
|
387
|
+
# @!attribute [rw] id
|
388
|
+
# Destination ARN.
|
389
|
+
# @return [String]
|
390
|
+
#
|
391
|
+
class DeleteDestinationRequest < Struct.new(
|
392
|
+
:id)
|
393
|
+
SENSITIVE = []
|
394
|
+
include Aws::Structure
|
395
|
+
end
|
396
|
+
|
397
|
+
class DeleteDestinationResponse < Aws::EmptyStructure; end
|
398
|
+
|
399
|
+
# @note When making an API call, you may pass DeleteSiteRequest
|
400
|
+
# data as a hash:
|
401
|
+
#
|
402
|
+
# {
|
403
|
+
# id: "SiteGenericIdentifier", # required
|
404
|
+
# }
|
405
|
+
#
|
406
|
+
# @!attribute [rw] id
|
407
|
+
# Site ARN.
|
408
|
+
# @return [String]
|
409
|
+
#
|
410
|
+
class DeleteSiteRequest < Struct.new(
|
411
|
+
:id)
|
412
|
+
SENSITIVE = []
|
413
|
+
include Aws::Structure
|
414
|
+
end
|
415
|
+
|
416
|
+
class DeleteSiteResponse < Aws::EmptyStructure; end
|
417
|
+
|
418
|
+
# @note When making an API call, you may pass DeleteWorkerFleetRequest
|
419
|
+
# data as a hash:
|
420
|
+
#
|
421
|
+
# {
|
422
|
+
# id: "WorkerFleetGenericIdentifier", # required
|
423
|
+
# }
|
424
|
+
#
|
425
|
+
# @!attribute [rw] id
|
426
|
+
# Full ARN of the worker fleet.
|
427
|
+
# @return [String]
|
428
|
+
#
|
429
|
+
class DeleteWorkerFleetRequest < Struct.new(
|
430
|
+
:id)
|
431
|
+
SENSITIVE = []
|
432
|
+
include Aws::Structure
|
433
|
+
end
|
434
|
+
|
435
|
+
class DeleteWorkerFleetResponse < Aws::EmptyStructure; end
|
436
|
+
|
437
|
+
# @note When making an API call, you may pass DeleteWorkerRequest
|
438
|
+
# data as a hash:
|
439
|
+
#
|
440
|
+
# {
|
441
|
+
# id: "WorkerGenericIdentifier", # required
|
442
|
+
# }
|
443
|
+
#
|
444
|
+
# @!attribute [rw] id
|
445
|
+
# Full ARN of the worker.
|
446
|
+
# @return [String]
|
447
|
+
#
|
448
|
+
class DeleteWorkerRequest < Struct.new(
|
449
|
+
:id)
|
450
|
+
SENSITIVE = []
|
451
|
+
include Aws::Structure
|
452
|
+
end
|
453
|
+
|
454
|
+
class DeleteWorkerResponse < Aws::EmptyStructure; end
|
455
|
+
|
456
|
+
# Area within a facility where work can be performed.
|
457
|
+
#
|
458
|
+
# @!attribute [rw] arn
|
459
|
+
# Destination ARN.
|
460
|
+
# @return [String]
|
461
|
+
#
|
462
|
+
# @!attribute [rw] id
|
463
|
+
# Filters access by the destination's identifier
|
464
|
+
# @return [String]
|
465
|
+
#
|
466
|
+
# @!attribute [rw] name
|
467
|
+
# Human friendly name of the resource.
|
468
|
+
# @return [String]
|
469
|
+
#
|
470
|
+
# @!attribute [rw] site
|
471
|
+
# Site ARN.
|
472
|
+
# @return [String]
|
473
|
+
#
|
474
|
+
# @!attribute [rw] created_at
|
475
|
+
# Timestamp at which the resource was created.
|
476
|
+
# @return [Time]
|
477
|
+
#
|
478
|
+
# @!attribute [rw] updated_at
|
479
|
+
# Timestamp at which the resource was last updated.
|
480
|
+
# @return [Time]
|
481
|
+
#
|
482
|
+
# @!attribute [rw] state
|
483
|
+
# State of the destination.
|
484
|
+
# @return [String]
|
485
|
+
#
|
486
|
+
# @!attribute [rw] additional_fixed_properties
|
487
|
+
# JSON document containing additional fixed properties regarding the
|
488
|
+
# destination
|
489
|
+
# @return [String]
|
490
|
+
#
|
491
|
+
class Destination < Struct.new(
|
492
|
+
:arn,
|
493
|
+
:id,
|
494
|
+
:name,
|
495
|
+
:site,
|
496
|
+
:created_at,
|
497
|
+
:updated_at,
|
498
|
+
:state,
|
499
|
+
:additional_fixed_properties)
|
500
|
+
SENSITIVE = []
|
501
|
+
include Aws::Structure
|
502
|
+
end
|
503
|
+
|
504
|
+
# @note When making an API call, you may pass GetDestinationRequest
|
505
|
+
# data as a hash:
|
506
|
+
#
|
507
|
+
# {
|
508
|
+
# id: "DestinationGenericIdentifier", # required
|
509
|
+
# }
|
510
|
+
#
|
511
|
+
# @!attribute [rw] id
|
512
|
+
# Destination ARN.
|
513
|
+
# @return [String]
|
514
|
+
#
|
515
|
+
class GetDestinationRequest < Struct.new(
|
516
|
+
:id)
|
517
|
+
SENSITIVE = []
|
518
|
+
include Aws::Structure
|
519
|
+
end
|
520
|
+
|
521
|
+
# @!attribute [rw] arn
|
522
|
+
# Destination ARN.
|
523
|
+
# @return [String]
|
524
|
+
#
|
525
|
+
# @!attribute [rw] id
|
526
|
+
# Filters access by the destination's identifier
|
527
|
+
# @return [String]
|
528
|
+
#
|
529
|
+
# @!attribute [rw] name
|
530
|
+
# Human friendly name of the resource.
|
531
|
+
# @return [String]
|
532
|
+
#
|
533
|
+
# @!attribute [rw] site
|
534
|
+
# Site ARN.
|
535
|
+
# @return [String]
|
536
|
+
#
|
537
|
+
# @!attribute [rw] created_at
|
538
|
+
# Timestamp at which the resource was created.
|
539
|
+
# @return [Time]
|
540
|
+
#
|
541
|
+
# @!attribute [rw] updated_at
|
542
|
+
# Timestamp at which the resource was last updated.
|
543
|
+
# @return [Time]
|
544
|
+
#
|
545
|
+
# @!attribute [rw] state
|
546
|
+
# State of the destination.
|
547
|
+
# @return [String]
|
548
|
+
#
|
549
|
+
# @!attribute [rw] additional_fixed_properties
|
550
|
+
# JSON document containing additional fixed properties regarding the
|
551
|
+
# destination
|
552
|
+
# @return [String]
|
553
|
+
#
|
554
|
+
class GetDestinationResponse < Struct.new(
|
555
|
+
:arn,
|
556
|
+
:id,
|
557
|
+
:name,
|
558
|
+
:site,
|
559
|
+
:created_at,
|
560
|
+
:updated_at,
|
561
|
+
:state,
|
562
|
+
:additional_fixed_properties)
|
563
|
+
SENSITIVE = []
|
564
|
+
include Aws::Structure
|
565
|
+
end
|
566
|
+
|
567
|
+
# @note When making an API call, you may pass GetSiteRequest
|
568
|
+
# data as a hash:
|
569
|
+
#
|
570
|
+
# {
|
571
|
+
# id: "SiteGenericIdentifier", # required
|
572
|
+
# }
|
573
|
+
#
|
574
|
+
# @!attribute [rw] id
|
575
|
+
# Site ARN.
|
576
|
+
# @return [String]
|
577
|
+
#
|
578
|
+
class GetSiteRequest < Struct.new(
|
579
|
+
:id)
|
580
|
+
SENSITIVE = []
|
581
|
+
include Aws::Structure
|
582
|
+
end
|
583
|
+
|
584
|
+
# @!attribute [rw] arn
|
585
|
+
# Site ARN.
|
586
|
+
# @return [String]
|
587
|
+
#
|
588
|
+
# @!attribute [rw] id
|
589
|
+
# Filters access by the site's identifier
|
590
|
+
# @return [String]
|
591
|
+
#
|
592
|
+
# @!attribute [rw] name
|
593
|
+
# Human friendly name of the resource.
|
594
|
+
# @return [String]
|
595
|
+
#
|
596
|
+
# @!attribute [rw] country_code
|
597
|
+
# A valid ISO 3166-1 alpha-2 code for the country in which the site
|
598
|
+
# resides. e.g., US.
|
599
|
+
# @return [String]
|
600
|
+
#
|
601
|
+
# @!attribute [rw] description
|
602
|
+
# A high-level description of the site.
|
603
|
+
# @return [String]
|
604
|
+
#
|
605
|
+
# @!attribute [rw] created_at
|
606
|
+
# Timestamp at which the resource was created.
|
607
|
+
# @return [Time]
|
608
|
+
#
|
609
|
+
# @!attribute [rw] updated_at
|
610
|
+
# Timestamp at which the resource was last updated.
|
611
|
+
# @return [Time]
|
612
|
+
#
|
613
|
+
class GetSiteResponse < Struct.new(
|
614
|
+
:arn,
|
615
|
+
:id,
|
616
|
+
:name,
|
617
|
+
:country_code,
|
618
|
+
:description,
|
619
|
+
:created_at,
|
620
|
+
:updated_at)
|
621
|
+
SENSITIVE = []
|
622
|
+
include Aws::Structure
|
623
|
+
end
|
624
|
+
|
625
|
+
# @note When making an API call, you may pass GetWorkerFleetRequest
|
626
|
+
# data as a hash:
|
627
|
+
#
|
628
|
+
# {
|
629
|
+
# id: "WorkerFleetGenericIdentifier", # required
|
630
|
+
# }
|
631
|
+
#
|
632
|
+
# @!attribute [rw] id
|
633
|
+
# Full ARN of the worker fleet.
|
634
|
+
# @return [String]
|
635
|
+
#
|
636
|
+
class GetWorkerFleetRequest < Struct.new(
|
637
|
+
:id)
|
638
|
+
SENSITIVE = []
|
639
|
+
include Aws::Structure
|
640
|
+
end
|
641
|
+
|
642
|
+
# @!attribute [rw] id
|
643
|
+
# Filters access by the worker fleet's identifier
|
644
|
+
# @return [String]
|
645
|
+
#
|
646
|
+
# @!attribute [rw] arn
|
647
|
+
# Full ARN of the worker fleet.
|
648
|
+
# @return [String]
|
649
|
+
#
|
650
|
+
# @!attribute [rw] name
|
651
|
+
# Human friendly name of the resource.
|
652
|
+
# @return [String]
|
653
|
+
#
|
654
|
+
# @!attribute [rw] site
|
655
|
+
# Site ARN.
|
656
|
+
# @return [String]
|
657
|
+
#
|
658
|
+
# @!attribute [rw] created_at
|
659
|
+
# Timestamp at which the resource was created.
|
660
|
+
# @return [Time]
|
661
|
+
#
|
662
|
+
# @!attribute [rw] updated_at
|
663
|
+
# Timestamp at which the resource was last updated.
|
664
|
+
# @return [Time]
|
665
|
+
#
|
666
|
+
# @!attribute [rw] additional_fixed_properties
|
667
|
+
# JSON blob containing additional fixed properties regarding the
|
668
|
+
# worker fleet
|
669
|
+
# @return [String]
|
670
|
+
#
|
671
|
+
class GetWorkerFleetResponse < Struct.new(
|
672
|
+
:id,
|
673
|
+
:arn,
|
674
|
+
:name,
|
675
|
+
:site,
|
676
|
+
:created_at,
|
677
|
+
:updated_at,
|
678
|
+
:additional_fixed_properties)
|
679
|
+
SENSITIVE = []
|
680
|
+
include Aws::Structure
|
681
|
+
end
|
682
|
+
|
683
|
+
# @note When making an API call, you may pass GetWorkerRequest
|
684
|
+
# data as a hash:
|
685
|
+
#
|
686
|
+
# {
|
687
|
+
# id: "WorkerGenericIdentifier", # required
|
688
|
+
# }
|
689
|
+
#
|
690
|
+
# @!attribute [rw] id
|
691
|
+
# Full ARN of the worker.
|
692
|
+
# @return [String]
|
693
|
+
#
|
694
|
+
class GetWorkerRequest < Struct.new(
|
695
|
+
:id)
|
696
|
+
SENSITIVE = []
|
697
|
+
include Aws::Structure
|
698
|
+
end
|
699
|
+
|
700
|
+
# @!attribute [rw] arn
|
701
|
+
# Full ARN of the worker.
|
702
|
+
# @return [String]
|
703
|
+
#
|
704
|
+
# @!attribute [rw] id
|
705
|
+
# Filters access by the workers identifier
|
706
|
+
# @return [String]
|
707
|
+
#
|
708
|
+
# @!attribute [rw] fleet
|
709
|
+
# Full ARN of the worker fleet.
|
710
|
+
# @return [String]
|
711
|
+
#
|
712
|
+
# @!attribute [rw] site
|
713
|
+
# Site ARN.
|
714
|
+
# @return [String]
|
715
|
+
#
|
716
|
+
# @!attribute [rw] created_at
|
717
|
+
# Timestamp at which the resource was created.
|
718
|
+
# @return [Time]
|
719
|
+
#
|
720
|
+
# @!attribute [rw] updated_at
|
721
|
+
# Timestamp at which the resource was last updated.
|
722
|
+
# @return [Time]
|
723
|
+
#
|
724
|
+
# @!attribute [rw] name
|
725
|
+
# Human friendly name of the resource.
|
726
|
+
# @return [String]
|
727
|
+
#
|
728
|
+
# @!attribute [rw] additional_transient_properties
|
729
|
+
# JSON blob containing unstructured worker properties that are
|
730
|
+
# transient and may change during regular operation.
|
731
|
+
# @return [String]
|
732
|
+
#
|
733
|
+
# @!attribute [rw] additional_fixed_properties
|
734
|
+
# JSON blob containing unstructured worker properties that are fixed
|
735
|
+
# and won't change during regular operation.
|
736
|
+
# @return [String]
|
737
|
+
#
|
738
|
+
# @!attribute [rw] vendor_properties
|
739
|
+
# Properties of the worker that are provided by the vendor FMS.
|
740
|
+
# @return [Types::VendorProperties]
|
741
|
+
#
|
742
|
+
# @!attribute [rw] position
|
743
|
+
# Supported coordinates for worker position.
|
744
|
+
# @return [Types::PositionCoordinates]
|
745
|
+
#
|
746
|
+
# @!attribute [rw] orientation
|
747
|
+
# Worker orientation measured in units clockwise from north.
|
748
|
+
# @return [Types::Orientation]
|
749
|
+
#
|
750
|
+
class GetWorkerResponse < Struct.new(
|
751
|
+
:arn,
|
752
|
+
:id,
|
753
|
+
:fleet,
|
754
|
+
:site,
|
755
|
+
:created_at,
|
756
|
+
:updated_at,
|
757
|
+
:name,
|
758
|
+
:additional_transient_properties,
|
759
|
+
:additional_fixed_properties,
|
760
|
+
:vendor_properties,
|
761
|
+
:position,
|
762
|
+
:orientation)
|
763
|
+
SENSITIVE = []
|
764
|
+
include Aws::Structure
|
765
|
+
end
|
766
|
+
|
767
|
+
# Exception thrown if something goes wrong within the service.
|
768
|
+
#
|
769
|
+
# @!attribute [rw] message
|
770
|
+
# @return [String]
|
771
|
+
#
|
772
|
+
class InternalServerException < Struct.new(
|
773
|
+
:message)
|
774
|
+
SENSITIVE = []
|
775
|
+
include Aws::Structure
|
776
|
+
end
|
777
|
+
|
778
|
+
# @note When making an API call, you may pass ListDestinationsRequest
|
779
|
+
# data as a hash:
|
780
|
+
#
|
781
|
+
# {
|
782
|
+
# site: "SiteGenericIdentifier", # required
|
783
|
+
# max_results: 1,
|
784
|
+
# next_token: "PaginationToken",
|
785
|
+
# state: "ENABLED", # accepts ENABLED, DISABLED, DECOMMISSIONED
|
786
|
+
# }
|
787
|
+
#
|
788
|
+
# @!attribute [rw] site
|
789
|
+
# Site ARN.
|
790
|
+
# @return [String]
|
791
|
+
#
|
792
|
+
# @!attribute [rw] max_results
|
793
|
+
# Maximum number of results to retrieve in a single call.
|
794
|
+
# @return [Integer]
|
795
|
+
#
|
796
|
+
# @!attribute [rw] next_token
|
797
|
+
# Pagination token returned when another page of data exists. Provide
|
798
|
+
# it in your next call to the API to receive the next page.
|
799
|
+
# @return [String]
|
800
|
+
#
|
801
|
+
# @!attribute [rw] state
|
802
|
+
# State of the destination.
|
803
|
+
# @return [String]
|
804
|
+
#
|
805
|
+
class ListDestinationsRequest < Struct.new(
|
806
|
+
:site,
|
807
|
+
:max_results,
|
808
|
+
:next_token,
|
809
|
+
:state)
|
810
|
+
SENSITIVE = []
|
811
|
+
include Aws::Structure
|
812
|
+
end
|
813
|
+
|
814
|
+
# @!attribute [rw] next_token
|
815
|
+
# Pagination token returned when another page of data exists. Provide
|
816
|
+
# it in your next call to the API to receive the next page.
|
817
|
+
# @return [String]
|
818
|
+
#
|
819
|
+
# @!attribute [rw] destinations
|
820
|
+
# List of destinations.
|
821
|
+
# @return [Array<Types::Destination>]
|
822
|
+
#
|
823
|
+
class ListDestinationsResponse < Struct.new(
|
824
|
+
:next_token,
|
825
|
+
:destinations)
|
826
|
+
SENSITIVE = []
|
827
|
+
include Aws::Structure
|
828
|
+
end
|
829
|
+
|
830
|
+
# @note When making an API call, you may pass ListSitesRequest
|
831
|
+
# data as a hash:
|
832
|
+
#
|
833
|
+
# {
|
834
|
+
# max_results: 1,
|
835
|
+
# next_token: "PaginationToken",
|
836
|
+
# }
|
837
|
+
#
|
838
|
+
# @!attribute [rw] max_results
|
839
|
+
# Maximum number of results to retrieve in a single ListSites call.
|
840
|
+
# @return [Integer]
|
841
|
+
#
|
842
|
+
# @!attribute [rw] next_token
|
843
|
+
# Pagination token returned when another page of data exists. Provide
|
844
|
+
# it in your next call to the API to receive the next page.
|
845
|
+
# @return [String]
|
846
|
+
#
|
847
|
+
class ListSitesRequest < Struct.new(
|
848
|
+
:max_results,
|
849
|
+
:next_token)
|
850
|
+
SENSITIVE = []
|
851
|
+
include Aws::Structure
|
852
|
+
end
|
853
|
+
|
854
|
+
# @!attribute [rw] next_token
|
855
|
+
# Pagination token returned when another page of data exists. Provide
|
856
|
+
# it in your next call to the API to receive the next page.
|
857
|
+
# @return [String]
|
858
|
+
#
|
859
|
+
# @!attribute [rw] sites
|
860
|
+
# List of facilities.
|
861
|
+
# @return [Array<Types::Site>]
|
862
|
+
#
|
863
|
+
class ListSitesResponse < Struct.new(
|
864
|
+
:next_token,
|
865
|
+
:sites)
|
866
|
+
SENSITIVE = []
|
867
|
+
include Aws::Structure
|
868
|
+
end
|
869
|
+
|
870
|
+
# @note When making an API call, you may pass ListWorkerFleetsRequest
|
871
|
+
# data as a hash:
|
872
|
+
#
|
873
|
+
# {
|
874
|
+
# site: "SiteGenericIdentifier", # required
|
875
|
+
# max_results: 1,
|
876
|
+
# next_token: "PaginationToken",
|
877
|
+
# }
|
878
|
+
#
|
879
|
+
# @!attribute [rw] site
|
880
|
+
# Site ARN.
|
881
|
+
# @return [String]
|
882
|
+
#
|
883
|
+
# @!attribute [rw] max_results
|
884
|
+
# Maximum number of results to retrieve in a single ListWorkerFleets
|
885
|
+
# call.
|
886
|
+
# @return [Integer]
|
887
|
+
#
|
888
|
+
# @!attribute [rw] next_token
|
889
|
+
# Pagination token returned when another page of data exists. Provide
|
890
|
+
# it in your next call to the API to receive the next page.
|
891
|
+
# @return [String]
|
892
|
+
#
|
893
|
+
class ListWorkerFleetsRequest < Struct.new(
|
894
|
+
:site,
|
895
|
+
:max_results,
|
896
|
+
:next_token)
|
897
|
+
SENSITIVE = []
|
898
|
+
include Aws::Structure
|
899
|
+
end
|
900
|
+
|
901
|
+
# @!attribute [rw] next_token
|
902
|
+
# Pagination token returned when another page of data exists. Provide
|
903
|
+
# it in your next call to the API to receive the next page.
|
904
|
+
# @return [String]
|
905
|
+
#
|
906
|
+
# @!attribute [rw] worker_fleets
|
907
|
+
# List of worker fleets.
|
908
|
+
# @return [Array<Types::WorkerFleet>]
|
909
|
+
#
|
910
|
+
class ListWorkerFleetsResponse < Struct.new(
|
911
|
+
:next_token,
|
912
|
+
:worker_fleets)
|
913
|
+
SENSITIVE = []
|
914
|
+
include Aws::Structure
|
915
|
+
end
|
916
|
+
|
917
|
+
# @note When making an API call, you may pass ListWorkersRequest
|
918
|
+
# data as a hash:
|
919
|
+
#
|
920
|
+
# {
|
921
|
+
# site: "SiteGenericIdentifier", # required
|
922
|
+
# max_results: 1,
|
923
|
+
# next_token: "PaginationToken",
|
924
|
+
# fleet: "WorkerFleetGenericIdentifier",
|
925
|
+
# }
|
926
|
+
#
|
927
|
+
# @!attribute [rw] site
|
928
|
+
# Site ARN.
|
929
|
+
# @return [String]
|
930
|
+
#
|
931
|
+
# @!attribute [rw] max_results
|
932
|
+
# Maximum number of results to retrieve in a single ListWorkers call.
|
933
|
+
# @return [Integer]
|
934
|
+
#
|
935
|
+
# @!attribute [rw] next_token
|
936
|
+
# Pagination token returned when another page of data exists. Provide
|
937
|
+
# it in your next call to the API to receive the next page.
|
938
|
+
# @return [String]
|
939
|
+
#
|
940
|
+
# @!attribute [rw] fleet
|
941
|
+
# Full ARN of the worker fleet.
|
942
|
+
# @return [String]
|
943
|
+
#
|
944
|
+
class ListWorkersRequest < Struct.new(
|
945
|
+
:site,
|
946
|
+
:max_results,
|
947
|
+
:next_token,
|
948
|
+
:fleet)
|
949
|
+
SENSITIVE = []
|
950
|
+
include Aws::Structure
|
951
|
+
end
|
952
|
+
|
953
|
+
# @!attribute [rw] next_token
|
954
|
+
# Pagination token returned when another page of data exists. Provide
|
955
|
+
# it in your next call to the API to receive the next page.
|
956
|
+
# @return [String]
|
957
|
+
#
|
958
|
+
# @!attribute [rw] workers
|
959
|
+
# List of workers.
|
960
|
+
# @return [Array<Types::Worker>]
|
961
|
+
#
|
962
|
+
class ListWorkersResponse < Struct.new(
|
963
|
+
:next_token,
|
964
|
+
:workers)
|
965
|
+
SENSITIVE = []
|
966
|
+
include Aws::Structure
|
967
|
+
end
|
968
|
+
|
969
|
+
# Worker orientation measured in units clockwise from north.
|
970
|
+
#
|
971
|
+
# @note Orientation is a union - when making an API calls you must set exactly one of the members.
|
972
|
+
#
|
973
|
+
# @note Orientation is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Orientation corresponding to the set member.
|
974
|
+
#
|
975
|
+
# @!attribute [rw] degrees
|
976
|
+
# Degrees, limited on \[0, 360)
|
977
|
+
# @return [Float]
|
978
|
+
#
|
979
|
+
class Orientation < Struct.new(
|
980
|
+
:degrees,
|
981
|
+
:unknown)
|
982
|
+
SENSITIVE = []
|
983
|
+
include Aws::Structure
|
984
|
+
include Aws::Structure::Union
|
985
|
+
|
986
|
+
class Degrees < Orientation; end
|
987
|
+
class Unknown < Orientation; end
|
988
|
+
end
|
989
|
+
|
990
|
+
# Supported coordinates for worker position.
|
991
|
+
#
|
992
|
+
# @note PositionCoordinates is a union - when making an API calls you must set exactly one of the members.
|
993
|
+
#
|
994
|
+
# @note PositionCoordinates is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of PositionCoordinates corresponding to the set member.
|
995
|
+
#
|
996
|
+
# @!attribute [rw] cartesian_coordinates
|
997
|
+
# Cartesian coordinates.
|
998
|
+
# @return [Types::CartesianCoordinates]
|
999
|
+
#
|
1000
|
+
class PositionCoordinates < Struct.new(
|
1001
|
+
:cartesian_coordinates,
|
1002
|
+
:unknown)
|
1003
|
+
SENSITIVE = []
|
1004
|
+
include Aws::Structure
|
1005
|
+
include Aws::Structure::Union
|
1006
|
+
|
1007
|
+
class CartesianCoordinates < PositionCoordinates; end
|
1008
|
+
class Unknown < PositionCoordinates; end
|
1009
|
+
end
|
1010
|
+
|
1011
|
+
# Exception thrown if a resource referenced in the request doesn't
|
1012
|
+
# exist.
|
1013
|
+
#
|
1014
|
+
# @!attribute [rw] message
|
1015
|
+
# @return [String]
|
1016
|
+
#
|
1017
|
+
class ResourceNotFoundException < Struct.new(
|
1018
|
+
:message)
|
1019
|
+
SENSITIVE = []
|
1020
|
+
include Aws::Structure
|
1021
|
+
end
|
1022
|
+
|
1023
|
+
# Exception thrown if the user's AWS account has reached a service
|
1024
|
+
# limit and the operation cannot proceed.
|
1025
|
+
#
|
1026
|
+
# @!attribute [rw] message
|
1027
|
+
# @return [String]
|
1028
|
+
#
|
1029
|
+
class ServiceQuotaExceededException < Struct.new(
|
1030
|
+
:message)
|
1031
|
+
SENSITIVE = []
|
1032
|
+
include Aws::Structure
|
1033
|
+
end
|
1034
|
+
|
1035
|
+
# Facility containing destinations, workers, activities, and tasks.
|
1036
|
+
#
|
1037
|
+
# @!attribute [rw] arn
|
1038
|
+
# Site ARN.
|
1039
|
+
# @return [String]
|
1040
|
+
#
|
1041
|
+
# @!attribute [rw] name
|
1042
|
+
# The name of the site. Mutable after creation and unique within a
|
1043
|
+
# given account.
|
1044
|
+
# @return [String]
|
1045
|
+
#
|
1046
|
+
# @!attribute [rw] country_code
|
1047
|
+
# A valid ISO 3166-1 alpha-2 code for the country in which the site
|
1048
|
+
# resides. e.g., US.
|
1049
|
+
# @return [String]
|
1050
|
+
#
|
1051
|
+
# @!attribute [rw] created_at
|
1052
|
+
# Timestamp at which the resource was created.
|
1053
|
+
# @return [Time]
|
1054
|
+
#
|
1055
|
+
class Site < Struct.new(
|
1056
|
+
:arn,
|
1057
|
+
:name,
|
1058
|
+
:country_code,
|
1059
|
+
:created_at)
|
1060
|
+
SENSITIVE = []
|
1061
|
+
include Aws::Structure
|
1062
|
+
end
|
1063
|
+
|
1064
|
+
# Exception thrown if the api has been called too quickly be the client.
|
1065
|
+
#
|
1066
|
+
# @!attribute [rw] message
|
1067
|
+
# @return [String]
|
1068
|
+
#
|
1069
|
+
class ThrottlingException < Struct.new(
|
1070
|
+
:message)
|
1071
|
+
SENSITIVE = []
|
1072
|
+
include Aws::Structure
|
1073
|
+
end
|
1074
|
+
|
1075
|
+
# @note When making an API call, you may pass UpdateDestinationRequest
|
1076
|
+
# data as a hash:
|
1077
|
+
#
|
1078
|
+
# {
|
1079
|
+
# id: "DestinationGenericIdentifier", # required
|
1080
|
+
# name: "Name",
|
1081
|
+
# state: "ENABLED", # accepts ENABLED, DISABLED, DECOMMISSIONED
|
1082
|
+
# additional_fixed_properties: "DestinationAdditionalFixedProperties",
|
1083
|
+
# }
|
1084
|
+
#
|
1085
|
+
# @!attribute [rw] id
|
1086
|
+
# Destination ARN.
|
1087
|
+
# @return [String]
|
1088
|
+
#
|
1089
|
+
# @!attribute [rw] name
|
1090
|
+
# Human friendly name of the resource.
|
1091
|
+
# @return [String]
|
1092
|
+
#
|
1093
|
+
# @!attribute [rw] state
|
1094
|
+
# State of the destination.
|
1095
|
+
# @return [String]
|
1096
|
+
#
|
1097
|
+
# @!attribute [rw] additional_fixed_properties
|
1098
|
+
# JSON document containing additional fixed properties regarding the
|
1099
|
+
# destination
|
1100
|
+
# @return [String]
|
1101
|
+
#
|
1102
|
+
class UpdateDestinationRequest < Struct.new(
|
1103
|
+
:id,
|
1104
|
+
:name,
|
1105
|
+
:state,
|
1106
|
+
:additional_fixed_properties)
|
1107
|
+
SENSITIVE = []
|
1108
|
+
include Aws::Structure
|
1109
|
+
end
|
1110
|
+
|
1111
|
+
# @!attribute [rw] arn
|
1112
|
+
# Destination ARN.
|
1113
|
+
# @return [String]
|
1114
|
+
#
|
1115
|
+
# @!attribute [rw] id
|
1116
|
+
# Filters access by the destination's identifier
|
1117
|
+
# @return [String]
|
1118
|
+
#
|
1119
|
+
# @!attribute [rw] name
|
1120
|
+
# Human friendly name of the resource.
|
1121
|
+
# @return [String]
|
1122
|
+
#
|
1123
|
+
# @!attribute [rw] updated_at
|
1124
|
+
# Timestamp at which the resource was last updated.
|
1125
|
+
# @return [Time]
|
1126
|
+
#
|
1127
|
+
# @!attribute [rw] state
|
1128
|
+
# State of the destination.
|
1129
|
+
# @return [String]
|
1130
|
+
#
|
1131
|
+
# @!attribute [rw] additional_fixed_properties
|
1132
|
+
# JSON document containing additional fixed properties regarding the
|
1133
|
+
# destination
|
1134
|
+
# @return [String]
|
1135
|
+
#
|
1136
|
+
class UpdateDestinationResponse < Struct.new(
|
1137
|
+
:arn,
|
1138
|
+
:id,
|
1139
|
+
:name,
|
1140
|
+
:updated_at,
|
1141
|
+
:state,
|
1142
|
+
:additional_fixed_properties)
|
1143
|
+
SENSITIVE = []
|
1144
|
+
include Aws::Structure
|
1145
|
+
end
|
1146
|
+
|
1147
|
+
# @note When making an API call, you may pass UpdateSiteRequest
|
1148
|
+
# data as a hash:
|
1149
|
+
#
|
1150
|
+
# {
|
1151
|
+
# id: "SiteGenericIdentifier", # required
|
1152
|
+
# name: "Name",
|
1153
|
+
# country_code: "SiteCountryCode",
|
1154
|
+
# description: "SiteDescription",
|
1155
|
+
# }
|
1156
|
+
#
|
1157
|
+
# @!attribute [rw] id
|
1158
|
+
# Site ARN.
|
1159
|
+
# @return [String]
|
1160
|
+
#
|
1161
|
+
# @!attribute [rw] name
|
1162
|
+
# Human friendly name of the resource.
|
1163
|
+
# @return [String]
|
1164
|
+
#
|
1165
|
+
# @!attribute [rw] country_code
|
1166
|
+
# A valid ISO 3166-1 alpha-2 code for the country in which the site
|
1167
|
+
# resides. e.g., US.
|
1168
|
+
# @return [String]
|
1169
|
+
#
|
1170
|
+
# @!attribute [rw] description
|
1171
|
+
# A high-level description of the site.
|
1172
|
+
# @return [String]
|
1173
|
+
#
|
1174
|
+
class UpdateSiteRequest < Struct.new(
|
1175
|
+
:id,
|
1176
|
+
:name,
|
1177
|
+
:country_code,
|
1178
|
+
:description)
|
1179
|
+
SENSITIVE = []
|
1180
|
+
include Aws::Structure
|
1181
|
+
end
|
1182
|
+
|
1183
|
+
# @!attribute [rw] arn
|
1184
|
+
# Site ARN.
|
1185
|
+
# @return [String]
|
1186
|
+
#
|
1187
|
+
# @!attribute [rw] id
|
1188
|
+
# Filters access by the site's identifier
|
1189
|
+
# @return [String]
|
1190
|
+
#
|
1191
|
+
# @!attribute [rw] name
|
1192
|
+
# Human friendly name of the resource.
|
1193
|
+
# @return [String]
|
1194
|
+
#
|
1195
|
+
# @!attribute [rw] country_code
|
1196
|
+
# A valid ISO 3166-1 alpha-2 code for the country in which the site
|
1197
|
+
# resides. e.g., US.
|
1198
|
+
# @return [String]
|
1199
|
+
#
|
1200
|
+
# @!attribute [rw] description
|
1201
|
+
# A high-level description of the site.
|
1202
|
+
# @return [String]
|
1203
|
+
#
|
1204
|
+
# @!attribute [rw] updated_at
|
1205
|
+
# Timestamp at which the resource was last updated.
|
1206
|
+
# @return [Time]
|
1207
|
+
#
|
1208
|
+
class UpdateSiteResponse < Struct.new(
|
1209
|
+
:arn,
|
1210
|
+
:id,
|
1211
|
+
:name,
|
1212
|
+
:country_code,
|
1213
|
+
:description,
|
1214
|
+
:updated_at)
|
1215
|
+
SENSITIVE = []
|
1216
|
+
include Aws::Structure
|
1217
|
+
end
|
1218
|
+
|
1219
|
+
# @note When making an API call, you may pass UpdateWorkerFleetRequest
|
1220
|
+
# data as a hash:
|
1221
|
+
#
|
1222
|
+
# {
|
1223
|
+
# id: "WorkerFleetGenericIdentifier", # required
|
1224
|
+
# name: "Name",
|
1225
|
+
# additional_fixed_properties: "WorkerFleetAdditionalFixedProperties",
|
1226
|
+
# }
|
1227
|
+
#
|
1228
|
+
# @!attribute [rw] id
|
1229
|
+
# Full ARN of the worker fleet.
|
1230
|
+
# @return [String]
|
1231
|
+
#
|
1232
|
+
# @!attribute [rw] name
|
1233
|
+
# Human friendly name of the resource.
|
1234
|
+
# @return [String]
|
1235
|
+
#
|
1236
|
+
# @!attribute [rw] additional_fixed_properties
|
1237
|
+
# JSON blob containing additional fixed properties regarding the
|
1238
|
+
# worker fleet
|
1239
|
+
# @return [String]
|
1240
|
+
#
|
1241
|
+
class UpdateWorkerFleetRequest < Struct.new(
|
1242
|
+
:id,
|
1243
|
+
:name,
|
1244
|
+
:additional_fixed_properties)
|
1245
|
+
SENSITIVE = []
|
1246
|
+
include Aws::Structure
|
1247
|
+
end
|
1248
|
+
|
1249
|
+
# @!attribute [rw] arn
|
1250
|
+
# Full ARN of the worker fleet.
|
1251
|
+
# @return [String]
|
1252
|
+
#
|
1253
|
+
# @!attribute [rw] id
|
1254
|
+
# Filters access by the worker fleet's identifier
|
1255
|
+
# @return [String]
|
1256
|
+
#
|
1257
|
+
# @!attribute [rw] name
|
1258
|
+
# Human friendly name of the resource.
|
1259
|
+
# @return [String]
|
1260
|
+
#
|
1261
|
+
# @!attribute [rw] updated_at
|
1262
|
+
# Timestamp at which the resource was last updated.
|
1263
|
+
# @return [Time]
|
1264
|
+
#
|
1265
|
+
# @!attribute [rw] additional_fixed_properties
|
1266
|
+
# JSON blob containing additional fixed properties regarding the
|
1267
|
+
# worker fleet
|
1268
|
+
# @return [String]
|
1269
|
+
#
|
1270
|
+
class UpdateWorkerFleetResponse < Struct.new(
|
1271
|
+
:arn,
|
1272
|
+
:id,
|
1273
|
+
:name,
|
1274
|
+
:updated_at,
|
1275
|
+
:additional_fixed_properties)
|
1276
|
+
SENSITIVE = []
|
1277
|
+
include Aws::Structure
|
1278
|
+
end
|
1279
|
+
|
1280
|
+
# @note When making an API call, you may pass UpdateWorkerRequest
|
1281
|
+
# data as a hash:
|
1282
|
+
#
|
1283
|
+
# {
|
1284
|
+
# id: "WorkerGenericIdentifier", # required
|
1285
|
+
# name: "Name",
|
1286
|
+
# additional_transient_properties: "WorkerAdditionalTransientPropertiesJson",
|
1287
|
+
# additional_fixed_properties: "WorkerAdditionalFixedPropertiesJson",
|
1288
|
+
# vendor_properties: {
|
1289
|
+
# vendor_worker_id: "VendorWorkerId", # required
|
1290
|
+
# vendor_worker_ip_address: "VendorWorkerIpAddress",
|
1291
|
+
# vendor_additional_transient_properties: "VendorAdditionalTransientPropertiesJson",
|
1292
|
+
# vendor_additional_fixed_properties: "VendorAdditionalFixedPropertiesJson",
|
1293
|
+
# },
|
1294
|
+
# position: {
|
1295
|
+
# cartesian_coordinates: {
|
1296
|
+
# x: 1.0, # required
|
1297
|
+
# y: 1.0, # required
|
1298
|
+
# z: 1.0,
|
1299
|
+
# },
|
1300
|
+
# },
|
1301
|
+
# orientation: {
|
1302
|
+
# degrees: 1.0,
|
1303
|
+
# },
|
1304
|
+
# }
|
1305
|
+
#
|
1306
|
+
# @!attribute [rw] id
|
1307
|
+
# Full ARN of the worker.
|
1308
|
+
# @return [String]
|
1309
|
+
#
|
1310
|
+
# @!attribute [rw] name
|
1311
|
+
# Human friendly name of the resource.
|
1312
|
+
# @return [String]
|
1313
|
+
#
|
1314
|
+
# @!attribute [rw] additional_transient_properties
|
1315
|
+
# JSON blob containing unstructured worker properties that are
|
1316
|
+
# transient and may change during regular operation.
|
1317
|
+
# @return [String]
|
1318
|
+
#
|
1319
|
+
# @!attribute [rw] additional_fixed_properties
|
1320
|
+
# JSON blob containing unstructured worker properties that are fixed
|
1321
|
+
# and won't change during regular operation.
|
1322
|
+
# @return [String]
|
1323
|
+
#
|
1324
|
+
# @!attribute [rw] vendor_properties
|
1325
|
+
# Properties of the worker that are provided by the vendor FMS.
|
1326
|
+
# @return [Types::VendorProperties]
|
1327
|
+
#
|
1328
|
+
# @!attribute [rw] position
|
1329
|
+
# Supported coordinates for worker position.
|
1330
|
+
# @return [Types::PositionCoordinates]
|
1331
|
+
#
|
1332
|
+
# @!attribute [rw] orientation
|
1333
|
+
# Worker orientation measured in units clockwise from north.
|
1334
|
+
# @return [Types::Orientation]
|
1335
|
+
#
|
1336
|
+
class UpdateWorkerRequest < Struct.new(
|
1337
|
+
:id,
|
1338
|
+
:name,
|
1339
|
+
:additional_transient_properties,
|
1340
|
+
:additional_fixed_properties,
|
1341
|
+
:vendor_properties,
|
1342
|
+
:position,
|
1343
|
+
:orientation)
|
1344
|
+
SENSITIVE = []
|
1345
|
+
include Aws::Structure
|
1346
|
+
end
|
1347
|
+
|
1348
|
+
# @!attribute [rw] arn
|
1349
|
+
# Full ARN of the worker.
|
1350
|
+
# @return [String]
|
1351
|
+
#
|
1352
|
+
# @!attribute [rw] id
|
1353
|
+
# Filters access by the workers identifier
|
1354
|
+
# @return [String]
|
1355
|
+
#
|
1356
|
+
# @!attribute [rw] fleet
|
1357
|
+
# Full ARN of the worker fleet.
|
1358
|
+
# @return [String]
|
1359
|
+
#
|
1360
|
+
# @!attribute [rw] updated_at
|
1361
|
+
# Timestamp at which the resource was last updated.
|
1362
|
+
# @return [Time]
|
1363
|
+
#
|
1364
|
+
# @!attribute [rw] name
|
1365
|
+
# Human friendly name of the resource.
|
1366
|
+
# @return [String]
|
1367
|
+
#
|
1368
|
+
# @!attribute [rw] additional_transient_properties
|
1369
|
+
# JSON blob containing unstructured worker properties that are
|
1370
|
+
# transient and may change during regular operation.
|
1371
|
+
# @return [String]
|
1372
|
+
#
|
1373
|
+
# @!attribute [rw] additional_fixed_properties
|
1374
|
+
# JSON blob containing unstructured worker properties that are fixed
|
1375
|
+
# and won't change during regular operation.
|
1376
|
+
# @return [String]
|
1377
|
+
#
|
1378
|
+
# @!attribute [rw] orientation
|
1379
|
+
# Worker orientation measured in units clockwise from north.
|
1380
|
+
# @return [Types::Orientation]
|
1381
|
+
#
|
1382
|
+
# @!attribute [rw] vendor_properties
|
1383
|
+
# Properties of the worker that are provided by the vendor FMS.
|
1384
|
+
# @return [Types::VendorProperties]
|
1385
|
+
#
|
1386
|
+
# @!attribute [rw] position
|
1387
|
+
# Supported coordinates for worker position.
|
1388
|
+
# @return [Types::PositionCoordinates]
|
1389
|
+
#
|
1390
|
+
class UpdateWorkerResponse < Struct.new(
|
1391
|
+
:arn,
|
1392
|
+
:id,
|
1393
|
+
:fleet,
|
1394
|
+
:updated_at,
|
1395
|
+
:name,
|
1396
|
+
:additional_transient_properties,
|
1397
|
+
:additional_fixed_properties,
|
1398
|
+
:orientation,
|
1399
|
+
:vendor_properties,
|
1400
|
+
:position)
|
1401
|
+
SENSITIVE = []
|
1402
|
+
include Aws::Structure
|
1403
|
+
end
|
1404
|
+
|
1405
|
+
# Exception thrown if an invalid parameter is provided to an API.
|
1406
|
+
#
|
1407
|
+
# @!attribute [rw] message
|
1408
|
+
# @return [String]
|
1409
|
+
#
|
1410
|
+
class ValidationException < Struct.new(
|
1411
|
+
:message)
|
1412
|
+
SENSITIVE = []
|
1413
|
+
include Aws::Structure
|
1414
|
+
end
|
1415
|
+
|
1416
|
+
# Properties of the worker that are provided by the vendor FMS.
|
1417
|
+
#
|
1418
|
+
# @note When making an API call, you may pass VendorProperties
|
1419
|
+
# data as a hash:
|
1420
|
+
#
|
1421
|
+
# {
|
1422
|
+
# vendor_worker_id: "VendorWorkerId", # required
|
1423
|
+
# vendor_worker_ip_address: "VendorWorkerIpAddress",
|
1424
|
+
# vendor_additional_transient_properties: "VendorAdditionalTransientPropertiesJson",
|
1425
|
+
# vendor_additional_fixed_properties: "VendorAdditionalFixedPropertiesJson",
|
1426
|
+
# }
|
1427
|
+
#
|
1428
|
+
# @!attribute [rw] vendor_worker_id
|
1429
|
+
# The worker ID defined by the vendor FMS.
|
1430
|
+
# @return [String]
|
1431
|
+
#
|
1432
|
+
# @!attribute [rw] vendor_worker_ip_address
|
1433
|
+
# The worker IP address defined by the vendor FMS.
|
1434
|
+
# @return [String]
|
1435
|
+
#
|
1436
|
+
# @!attribute [rw] vendor_additional_transient_properties
|
1437
|
+
# JSON blob containing unstructured vendor properties that are
|
1438
|
+
# transient and may change during regular operation.
|
1439
|
+
# @return [String]
|
1440
|
+
#
|
1441
|
+
# @!attribute [rw] vendor_additional_fixed_properties
|
1442
|
+
# JSON blob containing unstructured vendor properties that are fixed
|
1443
|
+
# and won't change during regular operation.
|
1444
|
+
# @return [String]
|
1445
|
+
#
|
1446
|
+
class VendorProperties < Struct.new(
|
1447
|
+
:vendor_worker_id,
|
1448
|
+
:vendor_worker_ip_address,
|
1449
|
+
:vendor_additional_transient_properties,
|
1450
|
+
:vendor_additional_fixed_properties)
|
1451
|
+
SENSITIVE = []
|
1452
|
+
include Aws::Structure
|
1453
|
+
end
|
1454
|
+
|
1455
|
+
# A unit capable of performing tasks.
|
1456
|
+
#
|
1457
|
+
# @!attribute [rw] arn
|
1458
|
+
# Full ARN of the worker.
|
1459
|
+
# @return [String]
|
1460
|
+
#
|
1461
|
+
# @!attribute [rw] id
|
1462
|
+
# Filters access by the workers identifier
|
1463
|
+
# @return [String]
|
1464
|
+
#
|
1465
|
+
# @!attribute [rw] fleet
|
1466
|
+
# Full ARN of the worker fleet.
|
1467
|
+
# @return [String]
|
1468
|
+
#
|
1469
|
+
# @!attribute [rw] created_at
|
1470
|
+
# Timestamp at which the resource was created.
|
1471
|
+
# @return [Time]
|
1472
|
+
#
|
1473
|
+
# @!attribute [rw] updated_at
|
1474
|
+
# Timestamp at which the resource was last updated.
|
1475
|
+
# @return [Time]
|
1476
|
+
#
|
1477
|
+
# @!attribute [rw] name
|
1478
|
+
# Human friendly name of the resource.
|
1479
|
+
# @return [String]
|
1480
|
+
#
|
1481
|
+
# @!attribute [rw] site
|
1482
|
+
# Site ARN.
|
1483
|
+
# @return [String]
|
1484
|
+
#
|
1485
|
+
# @!attribute [rw] additional_transient_properties
|
1486
|
+
# JSON blob containing unstructured worker properties that are
|
1487
|
+
# transient and may change during regular operation.
|
1488
|
+
# @return [String]
|
1489
|
+
#
|
1490
|
+
# @!attribute [rw] additional_fixed_properties
|
1491
|
+
# JSON blob containing unstructured worker properties that are fixed
|
1492
|
+
# and won't change during regular operation.
|
1493
|
+
# @return [String]
|
1494
|
+
#
|
1495
|
+
# @!attribute [rw] vendor_properties
|
1496
|
+
# Properties of the worker that are provided by the vendor FMS.
|
1497
|
+
# @return [Types::VendorProperties]
|
1498
|
+
#
|
1499
|
+
# @!attribute [rw] position
|
1500
|
+
# Supported coordinates for worker position.
|
1501
|
+
# @return [Types::PositionCoordinates]
|
1502
|
+
#
|
1503
|
+
# @!attribute [rw] orientation
|
1504
|
+
# Worker orientation measured in units clockwise from north.
|
1505
|
+
# @return [Types::Orientation]
|
1506
|
+
#
|
1507
|
+
class Worker < Struct.new(
|
1508
|
+
:arn,
|
1509
|
+
:id,
|
1510
|
+
:fleet,
|
1511
|
+
:created_at,
|
1512
|
+
:updated_at,
|
1513
|
+
:name,
|
1514
|
+
:site,
|
1515
|
+
:additional_transient_properties,
|
1516
|
+
:additional_fixed_properties,
|
1517
|
+
:vendor_properties,
|
1518
|
+
:position,
|
1519
|
+
:orientation)
|
1520
|
+
SENSITIVE = []
|
1521
|
+
include Aws::Structure
|
1522
|
+
end
|
1523
|
+
|
1524
|
+
# A collection of workers organized within a facility.
|
1525
|
+
#
|
1526
|
+
# @!attribute [rw] arn
|
1527
|
+
# Full ARN of the worker fleet.
|
1528
|
+
# @return [String]
|
1529
|
+
#
|
1530
|
+
# @!attribute [rw] id
|
1531
|
+
# Filters access by the worker fleet's identifier
|
1532
|
+
# @return [String]
|
1533
|
+
#
|
1534
|
+
# @!attribute [rw] name
|
1535
|
+
# Human friendly name of the resource.
|
1536
|
+
# @return [String]
|
1537
|
+
#
|
1538
|
+
# @!attribute [rw] site
|
1539
|
+
# Site ARN.
|
1540
|
+
# @return [String]
|
1541
|
+
#
|
1542
|
+
# @!attribute [rw] created_at
|
1543
|
+
# Timestamp at which the resource was created.
|
1544
|
+
# @return [Time]
|
1545
|
+
#
|
1546
|
+
# @!attribute [rw] updated_at
|
1547
|
+
# Timestamp at which the resource was last updated.
|
1548
|
+
# @return [Time]
|
1549
|
+
#
|
1550
|
+
# @!attribute [rw] additional_fixed_properties
|
1551
|
+
# JSON blob containing additional fixed properties regarding the
|
1552
|
+
# worker fleet
|
1553
|
+
# @return [String]
|
1554
|
+
#
|
1555
|
+
class WorkerFleet < Struct.new(
|
1556
|
+
:arn,
|
1557
|
+
:id,
|
1558
|
+
:name,
|
1559
|
+
:site,
|
1560
|
+
:created_at,
|
1561
|
+
:updated_at,
|
1562
|
+
:additional_fixed_properties)
|
1563
|
+
SENSITIVE = []
|
1564
|
+
include Aws::Structure
|
1565
|
+
end
|
1566
|
+
|
1567
|
+
end
|
1568
|
+
end
|