aws-sdk-supplychain 1.15.0 → 1.17.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-supplychain/client.rb +2664 -40
- data/lib/aws-sdk-supplychain/client_api.rb +637 -0
- data/lib/aws-sdk-supplychain/endpoints.rb +198 -0
- data/lib/aws-sdk-supplychain/plugins/endpoints.rb +36 -0
- data/lib/aws-sdk-supplychain/types.rb +1246 -14
- data/lib/aws-sdk-supplychain.rb +1 -1
- data/sig/client.rbs +313 -0
- data/sig/types.rbs +335 -0
- metadata +2 -2
@@ -83,7 +83,15 @@ module Aws::SupplyChain
|
|
83
83
|
# @return [String]
|
84
84
|
#
|
85
85
|
# @!attribute [rw] client_token
|
86
|
-
# An idempotency token
|
86
|
+
# An idempotency token ensures the API request is only completed no
|
87
|
+
# more than once. This way, retrying the request will not trigger the
|
88
|
+
# operation multiple times. A client token is a unique, case-sensitive
|
89
|
+
# string of 33 to 128 ASCII characters. To make an idempotent API
|
90
|
+
# request, specify a client token in the request. You should not reuse
|
91
|
+
# the same client token for other requests. If you retry a successful
|
92
|
+
# request with the same client token, the request will succeed with no
|
93
|
+
# further actions being taken, and you will receive the same API
|
94
|
+
# response as the original successful request.
|
87
95
|
#
|
88
96
|
# **A suitable default value is auto-generated.** You should normally
|
89
97
|
# not need to pass this option.
|
@@ -113,35 +121,880 @@ module Aws::SupplyChain
|
|
113
121
|
include Aws::Structure
|
114
122
|
end
|
115
123
|
|
124
|
+
# The request parameters for CreateDataIntegrationFlow.
|
125
|
+
#
|
126
|
+
# @!attribute [rw] instance_id
|
127
|
+
# The Amazon Web Services Supply Chain instance identifier.
|
128
|
+
# @return [String]
|
129
|
+
#
|
130
|
+
# @!attribute [rw] name
|
131
|
+
# Name of the DataIntegrationFlow.
|
132
|
+
# @return [String]
|
133
|
+
#
|
134
|
+
# @!attribute [rw] sources
|
135
|
+
# The source configurations for DataIntegrationFlow.
|
136
|
+
# @return [Array<Types::DataIntegrationFlowSource>]
|
137
|
+
#
|
138
|
+
# @!attribute [rw] transformation
|
139
|
+
# The transformation configurations for DataIntegrationFlow.
|
140
|
+
# @return [Types::DataIntegrationFlowTransformation]
|
141
|
+
#
|
142
|
+
# @!attribute [rw] target
|
143
|
+
# The target configurations for DataIntegrationFlow.
|
144
|
+
# @return [Types::DataIntegrationFlowTarget]
|
145
|
+
#
|
146
|
+
# @!attribute [rw] tags
|
147
|
+
# The tags of the DataIntegrationFlow to be created
|
148
|
+
# @return [Hash<String,String>]
|
149
|
+
#
|
150
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/CreateDataIntegrationFlowRequest AWS API Documentation
|
151
|
+
#
|
152
|
+
class CreateDataIntegrationFlowRequest < Struct.new(
|
153
|
+
:instance_id,
|
154
|
+
:name,
|
155
|
+
:sources,
|
156
|
+
:transformation,
|
157
|
+
:target,
|
158
|
+
:tags)
|
159
|
+
SENSITIVE = []
|
160
|
+
include Aws::Structure
|
161
|
+
end
|
162
|
+
|
163
|
+
# The response parameters for CreateDataIntegrationFlow.
|
164
|
+
#
|
165
|
+
# @!attribute [rw] instance_id
|
166
|
+
# The Amazon Web Services Supply Chain instance identifier.
|
167
|
+
# @return [String]
|
168
|
+
#
|
169
|
+
# @!attribute [rw] name
|
170
|
+
# The name of the DataIntegrationFlow created.
|
171
|
+
# @return [String]
|
172
|
+
#
|
173
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/CreateDataIntegrationFlowResponse AWS API Documentation
|
174
|
+
#
|
175
|
+
class CreateDataIntegrationFlowResponse < Struct.new(
|
176
|
+
:instance_id,
|
177
|
+
:name)
|
178
|
+
SENSITIVE = []
|
179
|
+
include Aws::Structure
|
180
|
+
end
|
181
|
+
|
182
|
+
# The request parameters for CreateDataLakeDataset.
|
183
|
+
#
|
184
|
+
# @!attribute [rw] instance_id
|
185
|
+
# The Amazon Web Services Supply Chain instance identifier.
|
186
|
+
# @return [String]
|
187
|
+
#
|
188
|
+
# @!attribute [rw] namespace
|
189
|
+
# The name space of the dataset.
|
190
|
+
#
|
191
|
+
# * **asc** - For information on the Amazon Web Services Supply Chain
|
192
|
+
# supported datasets see
|
193
|
+
# [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html][1].
|
194
|
+
#
|
195
|
+
# * **default** - For datasets with custom user-defined schemas.
|
196
|
+
#
|
197
|
+
#
|
198
|
+
#
|
199
|
+
# [1]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
|
200
|
+
# @return [String]
|
201
|
+
#
|
202
|
+
# @!attribute [rw] name
|
203
|
+
# The name of the dataset. For **asc** name space, the name must be
|
204
|
+
# one of the supported data entities under
|
205
|
+
# [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html][1].
|
206
|
+
#
|
207
|
+
#
|
208
|
+
#
|
209
|
+
# [1]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
|
210
|
+
# @return [String]
|
211
|
+
#
|
212
|
+
# @!attribute [rw] schema
|
213
|
+
# The custom schema of the data lake dataset and is only required when
|
214
|
+
# the name space is *default*.
|
215
|
+
# @return [Types::DataLakeDatasetSchema]
|
216
|
+
#
|
217
|
+
# @!attribute [rw] description
|
218
|
+
# The description of the dataset.
|
219
|
+
# @return [String]
|
220
|
+
#
|
221
|
+
# @!attribute [rw] tags
|
222
|
+
# The tags of the dataset.
|
223
|
+
# @return [Hash<String,String>]
|
224
|
+
#
|
225
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/CreateDataLakeDatasetRequest AWS API Documentation
|
226
|
+
#
|
227
|
+
class CreateDataLakeDatasetRequest < Struct.new(
|
228
|
+
:instance_id,
|
229
|
+
:namespace,
|
230
|
+
:name,
|
231
|
+
:schema,
|
232
|
+
:description,
|
233
|
+
:tags)
|
234
|
+
SENSITIVE = []
|
235
|
+
include Aws::Structure
|
236
|
+
end
|
237
|
+
|
238
|
+
# The response parameters of CreateDataLakeDataset.
|
239
|
+
#
|
240
|
+
# @!attribute [rw] dataset
|
241
|
+
# The detail of created dataset.
|
242
|
+
# @return [Types::DataLakeDataset]
|
243
|
+
#
|
244
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/CreateDataLakeDatasetResponse AWS API Documentation
|
245
|
+
#
|
246
|
+
class CreateDataLakeDatasetResponse < Struct.new(
|
247
|
+
:dataset)
|
248
|
+
SENSITIVE = []
|
249
|
+
include Aws::Structure
|
250
|
+
end
|
251
|
+
|
252
|
+
# The request parameters for CreateInstance.
|
253
|
+
#
|
254
|
+
# @!attribute [rw] instance_name
|
255
|
+
# The AWS Supply Chain instance name.
|
256
|
+
# @return [String]
|
257
|
+
#
|
258
|
+
# @!attribute [rw] instance_description
|
259
|
+
# The AWS Supply Chain instance description.
|
260
|
+
# @return [String]
|
261
|
+
#
|
262
|
+
# @!attribute [rw] kms_key_arn
|
263
|
+
# The ARN (Amazon Resource Name) of the Key Management Service (KMS)
|
264
|
+
# key you provide for encryption. This is required if you do not want
|
265
|
+
# to use the Amazon Web Services owned KMS key. If you don't provide
|
266
|
+
# anything here, AWS Supply Chain uses the Amazon Web Services owned
|
267
|
+
# KMS key.
|
268
|
+
# @return [String]
|
269
|
+
#
|
270
|
+
# @!attribute [rw] tags
|
271
|
+
# The Amazon Web Services tags of an instance to be created.
|
272
|
+
# @return [Hash<String,String>]
|
273
|
+
#
|
274
|
+
# @!attribute [rw] client_token
|
275
|
+
# The client token for idempotency.
|
276
|
+
#
|
277
|
+
# **A suitable default value is auto-generated.** You should normally
|
278
|
+
# not need to pass this option.
|
279
|
+
# @return [String]
|
280
|
+
#
|
281
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/CreateInstanceRequest AWS API Documentation
|
282
|
+
#
|
283
|
+
class CreateInstanceRequest < Struct.new(
|
284
|
+
:instance_name,
|
285
|
+
:instance_description,
|
286
|
+
:kms_key_arn,
|
287
|
+
:tags,
|
288
|
+
:client_token)
|
289
|
+
SENSITIVE = []
|
290
|
+
include Aws::Structure
|
291
|
+
end
|
292
|
+
|
293
|
+
# The response parameters for CreateInstance.
|
294
|
+
#
|
295
|
+
# @!attribute [rw] instance
|
296
|
+
# The AWS Supply Chain instance resource data details.
|
297
|
+
# @return [Types::Instance]
|
298
|
+
#
|
299
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/CreateInstanceResponse AWS API Documentation
|
300
|
+
#
|
301
|
+
class CreateInstanceResponse < Struct.new(
|
302
|
+
:instance)
|
303
|
+
SENSITIVE = []
|
304
|
+
include Aws::Structure
|
305
|
+
end
|
306
|
+
|
307
|
+
# The DataIntegrationFlow details.
|
308
|
+
#
|
309
|
+
# @!attribute [rw] instance_id
|
310
|
+
# The DataIntegrationFlow instance ID.
|
311
|
+
# @return [String]
|
312
|
+
#
|
313
|
+
# @!attribute [rw] name
|
314
|
+
# The DataIntegrationFlow name.
|
315
|
+
# @return [String]
|
316
|
+
#
|
317
|
+
# @!attribute [rw] sources
|
318
|
+
# The DataIntegrationFlow source configurations.
|
319
|
+
# @return [Array<Types::DataIntegrationFlowSource>]
|
320
|
+
#
|
321
|
+
# @!attribute [rw] transformation
|
322
|
+
# The DataIntegrationFlow transformation configurations.
|
323
|
+
# @return [Types::DataIntegrationFlowTransformation]
|
324
|
+
#
|
325
|
+
# @!attribute [rw] target
|
326
|
+
# The DataIntegrationFlow target configuration.
|
327
|
+
# @return [Types::DataIntegrationFlowTarget]
|
328
|
+
#
|
329
|
+
# @!attribute [rw] created_time
|
330
|
+
# The DataIntegrationFlow creation timestamp.
|
331
|
+
# @return [Time]
|
332
|
+
#
|
333
|
+
# @!attribute [rw] last_modified_time
|
334
|
+
# The DataIntegrationFlow last modified timestamp.
|
335
|
+
# @return [Time]
|
336
|
+
#
|
337
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlow AWS API Documentation
|
338
|
+
#
|
339
|
+
class DataIntegrationFlow < Struct.new(
|
340
|
+
:instance_id,
|
341
|
+
:name,
|
342
|
+
:sources,
|
343
|
+
:transformation,
|
344
|
+
:target,
|
345
|
+
:created_time,
|
346
|
+
:last_modified_time)
|
347
|
+
SENSITIVE = []
|
348
|
+
include Aws::Structure
|
349
|
+
end
|
350
|
+
|
351
|
+
# The dataset options used in dataset source and target configurations.
|
352
|
+
#
|
353
|
+
# @!attribute [rw] load_type
|
354
|
+
# The dataset data load type in dataset options.
|
355
|
+
# @return [String]
|
356
|
+
#
|
357
|
+
# @!attribute [rw] dedupe_records
|
358
|
+
# The dataset load option to remove duplicates.
|
359
|
+
# @return [Boolean]
|
360
|
+
#
|
361
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowDatasetOptions AWS API Documentation
|
362
|
+
#
|
363
|
+
class DataIntegrationFlowDatasetOptions < Struct.new(
|
364
|
+
:load_type,
|
365
|
+
:dedupe_records)
|
366
|
+
SENSITIVE = []
|
367
|
+
include Aws::Structure
|
368
|
+
end
|
369
|
+
|
370
|
+
# The dataset DataIntegrationFlow source configuration parameters.
|
371
|
+
#
|
372
|
+
# @!attribute [rw] dataset_identifier
|
373
|
+
# The ARN of the dataset.
|
374
|
+
# @return [String]
|
375
|
+
#
|
376
|
+
# @!attribute [rw] options
|
377
|
+
# The dataset DataIntegrationFlow source options.
|
378
|
+
# @return [Types::DataIntegrationFlowDatasetOptions]
|
379
|
+
#
|
380
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowDatasetSourceConfiguration AWS API Documentation
|
381
|
+
#
|
382
|
+
class DataIntegrationFlowDatasetSourceConfiguration < Struct.new(
|
383
|
+
:dataset_identifier,
|
384
|
+
:options)
|
385
|
+
SENSITIVE = []
|
386
|
+
include Aws::Structure
|
387
|
+
end
|
388
|
+
|
389
|
+
# The dataset DataIntegrationFlow target configuration parameters.
|
390
|
+
#
|
391
|
+
# @!attribute [rw] dataset_identifier
|
392
|
+
# The dataset ARN.
|
393
|
+
# @return [String]
|
394
|
+
#
|
395
|
+
# @!attribute [rw] options
|
396
|
+
# The dataset DataIntegrationFlow target options.
|
397
|
+
# @return [Types::DataIntegrationFlowDatasetOptions]
|
398
|
+
#
|
399
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowDatasetTargetConfiguration AWS API Documentation
|
400
|
+
#
|
401
|
+
class DataIntegrationFlowDatasetTargetConfiguration < Struct.new(
|
402
|
+
:dataset_identifier,
|
403
|
+
:options)
|
404
|
+
SENSITIVE = []
|
405
|
+
include Aws::Structure
|
406
|
+
end
|
407
|
+
|
408
|
+
# The Amazon S3 options used in S3 source and target configurations.
|
409
|
+
#
|
410
|
+
# @!attribute [rw] file_type
|
411
|
+
# The Amazon S3 file type in S3 options.
|
412
|
+
# @return [String]
|
413
|
+
#
|
414
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowS3Options AWS API Documentation
|
415
|
+
#
|
416
|
+
class DataIntegrationFlowS3Options < Struct.new(
|
417
|
+
:file_type)
|
418
|
+
SENSITIVE = []
|
419
|
+
include Aws::Structure
|
420
|
+
end
|
421
|
+
|
422
|
+
# The S3 DataIntegrationFlow source configuration parameters.
|
423
|
+
#
|
424
|
+
# @!attribute [rw] bucket_name
|
425
|
+
# The bucketName of the S3 source objects.
|
426
|
+
# @return [String]
|
427
|
+
#
|
428
|
+
# @!attribute [rw] prefix
|
429
|
+
# The prefix of the S3 source objects.
|
430
|
+
# @return [String]
|
431
|
+
#
|
432
|
+
# @!attribute [rw] options
|
433
|
+
# The other options of the S3 DataIntegrationFlow source.
|
434
|
+
# @return [Types::DataIntegrationFlowS3Options]
|
435
|
+
#
|
436
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowS3SourceConfiguration AWS API Documentation
|
437
|
+
#
|
438
|
+
class DataIntegrationFlowS3SourceConfiguration < Struct.new(
|
439
|
+
:bucket_name,
|
440
|
+
:prefix,
|
441
|
+
:options)
|
442
|
+
SENSITIVE = []
|
443
|
+
include Aws::Structure
|
444
|
+
end
|
445
|
+
|
446
|
+
# The S3 DataIntegrationFlow target configuration parameters.
|
447
|
+
#
|
448
|
+
# @!attribute [rw] bucket_name
|
449
|
+
# The bucketName of the S3 target objects.
|
450
|
+
# @return [String]
|
451
|
+
#
|
452
|
+
# @!attribute [rw] prefix
|
453
|
+
# The prefix of the S3 target objects.
|
454
|
+
# @return [String]
|
455
|
+
#
|
456
|
+
# @!attribute [rw] options
|
457
|
+
# The S3 DataIntegrationFlow target options.
|
458
|
+
# @return [Types::DataIntegrationFlowS3Options]
|
459
|
+
#
|
460
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowS3TargetConfiguration AWS API Documentation
|
461
|
+
#
|
462
|
+
class DataIntegrationFlowS3TargetConfiguration < Struct.new(
|
463
|
+
:bucket_name,
|
464
|
+
:prefix,
|
465
|
+
:options)
|
466
|
+
SENSITIVE = []
|
467
|
+
include Aws::Structure
|
468
|
+
end
|
469
|
+
|
470
|
+
# The SQL DataIntegrationFlow transformation configuration parameters.
|
471
|
+
#
|
472
|
+
# @!attribute [rw] query
|
473
|
+
# The transformation SQL query body based on SparkSQL.
|
474
|
+
# @return [String]
|
475
|
+
#
|
476
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowSQLTransformationConfiguration AWS API Documentation
|
477
|
+
#
|
478
|
+
class DataIntegrationFlowSQLTransformationConfiguration < Struct.new(
|
479
|
+
:query)
|
480
|
+
SENSITIVE = []
|
481
|
+
include Aws::Structure
|
482
|
+
end
|
483
|
+
|
484
|
+
# The DataIntegrationFlow source parameters.
|
485
|
+
#
|
486
|
+
# @!attribute [rw] source_type
|
487
|
+
# The DataIntegrationFlow source type.
|
488
|
+
# @return [String]
|
489
|
+
#
|
490
|
+
# @!attribute [rw] source_name
|
491
|
+
# The DataIntegrationFlow source name that can be used as table alias
|
492
|
+
# in SQL transformation query.
|
493
|
+
# @return [String]
|
494
|
+
#
|
495
|
+
# @!attribute [rw] s3_source
|
496
|
+
# The S3 DataIntegrationFlow source.
|
497
|
+
# @return [Types::DataIntegrationFlowS3SourceConfiguration]
|
498
|
+
#
|
499
|
+
# @!attribute [rw] dataset_source
|
500
|
+
# The dataset DataIntegrationFlow source.
|
501
|
+
# @return [Types::DataIntegrationFlowDatasetSourceConfiguration]
|
502
|
+
#
|
503
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowSource AWS API Documentation
|
504
|
+
#
|
505
|
+
class DataIntegrationFlowSource < Struct.new(
|
506
|
+
:source_type,
|
507
|
+
:source_name,
|
508
|
+
:s3_source,
|
509
|
+
:dataset_source)
|
510
|
+
SENSITIVE = []
|
511
|
+
include Aws::Structure
|
512
|
+
end
|
513
|
+
|
514
|
+
# The DataIntegrationFlow target parameters.
|
515
|
+
#
|
516
|
+
# @!attribute [rw] target_type
|
517
|
+
# The DataIntegrationFlow target type.
|
518
|
+
# @return [String]
|
519
|
+
#
|
520
|
+
# @!attribute [rw] s3_target
|
521
|
+
# The S3 DataIntegrationFlow target.
|
522
|
+
# @return [Types::DataIntegrationFlowS3TargetConfiguration]
|
523
|
+
#
|
524
|
+
# @!attribute [rw] dataset_target
|
525
|
+
# The dataset DataIntegrationFlow target.
|
526
|
+
# @return [Types::DataIntegrationFlowDatasetTargetConfiguration]
|
527
|
+
#
|
528
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowTarget AWS API Documentation
|
529
|
+
#
|
530
|
+
class DataIntegrationFlowTarget < Struct.new(
|
531
|
+
:target_type,
|
532
|
+
:s3_target,
|
533
|
+
:dataset_target)
|
534
|
+
SENSITIVE = []
|
535
|
+
include Aws::Structure
|
536
|
+
end
|
537
|
+
|
538
|
+
# The DataIntegrationFlow transformation parameters.
|
539
|
+
#
|
540
|
+
# @!attribute [rw] transformation_type
|
541
|
+
# The DataIntegrationFlow transformation type.
|
542
|
+
# @return [String]
|
543
|
+
#
|
544
|
+
# @!attribute [rw] sql_transformation
|
545
|
+
# The SQL DataIntegrationFlow transformation configuration.
|
546
|
+
# @return [Types::DataIntegrationFlowSQLTransformationConfiguration]
|
547
|
+
#
|
548
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowTransformation AWS API Documentation
|
549
|
+
#
|
550
|
+
class DataIntegrationFlowTransformation < Struct.new(
|
551
|
+
:transformation_type,
|
552
|
+
:sql_transformation)
|
553
|
+
SENSITIVE = []
|
554
|
+
include Aws::Structure
|
555
|
+
end
|
556
|
+
|
557
|
+
# The data lake dataset details.
|
558
|
+
#
|
559
|
+
# @!attribute [rw] instance_id
|
560
|
+
# The Amazon Web Services Supply Chain instance identifier.
|
561
|
+
# @return [String]
|
562
|
+
#
|
563
|
+
# @!attribute [rw] namespace
|
564
|
+
# The name space of the dataset. The available values are:
|
565
|
+
#
|
566
|
+
# * **asc** - For information on the Amazon Web Services Supply Chain
|
567
|
+
# supported datasets see
|
568
|
+
# [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html][1].
|
569
|
+
#
|
570
|
+
# * **default** - For datasets with custom user-defined schemas.
|
571
|
+
#
|
572
|
+
#
|
573
|
+
#
|
574
|
+
# [1]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
|
575
|
+
# @return [String]
|
576
|
+
#
|
577
|
+
# @!attribute [rw] name
|
578
|
+
# The name of the dataset. For **asc** name space, the name must be
|
579
|
+
# one of the supported data entities under
|
580
|
+
# [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html][1].
|
581
|
+
#
|
582
|
+
#
|
583
|
+
#
|
584
|
+
# [1]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
|
585
|
+
# @return [String]
|
586
|
+
#
|
587
|
+
# @!attribute [rw] arn
|
588
|
+
# The arn of the dataset.
|
589
|
+
# @return [String]
|
590
|
+
#
|
591
|
+
# @!attribute [rw] schema
|
592
|
+
# The schema of the dataset.
|
593
|
+
# @return [Types::DataLakeDatasetSchema]
|
594
|
+
#
|
595
|
+
# @!attribute [rw] description
|
596
|
+
# The description of the dataset.
|
597
|
+
# @return [String]
|
598
|
+
#
|
599
|
+
# @!attribute [rw] created_time
|
600
|
+
# The creation time of the dataset.
|
601
|
+
# @return [Time]
|
602
|
+
#
|
603
|
+
# @!attribute [rw] last_modified_time
|
604
|
+
# The last modified time of the dataset.
|
605
|
+
# @return [Time]
|
606
|
+
#
|
607
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataLakeDataset AWS API Documentation
|
608
|
+
#
|
609
|
+
class DataLakeDataset < Struct.new(
|
610
|
+
:instance_id,
|
611
|
+
:namespace,
|
612
|
+
:name,
|
613
|
+
:arn,
|
614
|
+
:schema,
|
615
|
+
:description,
|
616
|
+
:created_time,
|
617
|
+
:last_modified_time)
|
618
|
+
SENSITIVE = []
|
619
|
+
include Aws::Structure
|
620
|
+
end
|
621
|
+
|
622
|
+
# The schema details of the dataset.
|
623
|
+
#
|
624
|
+
# @!attribute [rw] name
|
625
|
+
# The name of the dataset schema.
|
626
|
+
# @return [String]
|
627
|
+
#
|
628
|
+
# @!attribute [rw] fields
|
629
|
+
# The list of field details of the dataset schema.
|
630
|
+
# @return [Array<Types::DataLakeDatasetSchemaField>]
|
631
|
+
#
|
632
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataLakeDatasetSchema AWS API Documentation
|
633
|
+
#
|
634
|
+
class DataLakeDatasetSchema < Struct.new(
|
635
|
+
:name,
|
636
|
+
:fields)
|
637
|
+
SENSITIVE = []
|
638
|
+
include Aws::Structure
|
639
|
+
end
|
640
|
+
|
641
|
+
# The dataset field details.
|
642
|
+
#
|
643
|
+
# @!attribute [rw] name
|
644
|
+
# The dataset field name.
|
645
|
+
# @return [String]
|
646
|
+
#
|
647
|
+
# @!attribute [rw] type
|
648
|
+
# The dataset field type.
|
649
|
+
# @return [String]
|
650
|
+
#
|
651
|
+
# @!attribute [rw] is_required
|
652
|
+
# Indicate if the field is required or not.
|
653
|
+
# @return [Boolean]
|
654
|
+
#
|
655
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataLakeDatasetSchemaField AWS API Documentation
|
656
|
+
#
|
657
|
+
class DataLakeDatasetSchemaField < Struct.new(
|
658
|
+
:name,
|
659
|
+
:type,
|
660
|
+
:is_required)
|
661
|
+
SENSITIVE = []
|
662
|
+
include Aws::Structure
|
663
|
+
end
|
664
|
+
|
665
|
+
# The request parameters for DeleteDataIntegrationFlow.
|
666
|
+
#
|
667
|
+
# @!attribute [rw] instance_id
|
668
|
+
# The Amazon Web Services Supply Chain instance identifier.
|
669
|
+
# @return [String]
|
670
|
+
#
|
671
|
+
# @!attribute [rw] name
|
672
|
+
# The name of the DataIntegrationFlow to be deleted.
|
673
|
+
# @return [String]
|
674
|
+
#
|
675
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DeleteDataIntegrationFlowRequest AWS API Documentation
|
676
|
+
#
|
677
|
+
class DeleteDataIntegrationFlowRequest < Struct.new(
|
678
|
+
:instance_id,
|
679
|
+
:name)
|
680
|
+
SENSITIVE = []
|
681
|
+
include Aws::Structure
|
682
|
+
end
|
683
|
+
|
684
|
+
# The response parameters for DeleteDataIntegrationFlow.
|
685
|
+
#
|
686
|
+
# @!attribute [rw] instance_id
|
687
|
+
# The Amazon Web Services Supply Chain instance identifier.
|
688
|
+
# @return [String]
|
689
|
+
#
|
690
|
+
# @!attribute [rw] name
|
691
|
+
# The name of the DataIntegrationFlow deleted.
|
692
|
+
# @return [String]
|
693
|
+
#
|
694
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DeleteDataIntegrationFlowResponse AWS API Documentation
|
695
|
+
#
|
696
|
+
class DeleteDataIntegrationFlowResponse < Struct.new(
|
697
|
+
:instance_id,
|
698
|
+
:name)
|
699
|
+
SENSITIVE = []
|
700
|
+
include Aws::Structure
|
701
|
+
end
|
702
|
+
|
703
|
+
# The request parameters of DeleteDataLakeDataset.
|
704
|
+
#
|
705
|
+
# @!attribute [rw] instance_id
|
706
|
+
# The AWS Supply Chain instance identifier.
|
707
|
+
# @return [String]
|
708
|
+
#
|
709
|
+
# @!attribute [rw] namespace
|
710
|
+
# The namespace of the dataset. The available values are:
|
711
|
+
#
|
712
|
+
# * asc: for [ AWS Supply Chain supported datasets ][1].
|
713
|
+
#
|
714
|
+
# * default: for datasets with custom user-defined schemas.
|
715
|
+
#
|
716
|
+
#
|
717
|
+
#
|
718
|
+
# [1]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
|
719
|
+
# @return [String]
|
720
|
+
#
|
721
|
+
# @!attribute [rw] name
|
722
|
+
# The name of the dataset. If the namespace is *asc*, the name must be
|
723
|
+
# one of the supported [data entities ][1].
|
724
|
+
#
|
725
|
+
#
|
726
|
+
#
|
727
|
+
# [1]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
|
728
|
+
# @return [String]
|
729
|
+
#
|
730
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DeleteDataLakeDatasetRequest AWS API Documentation
|
731
|
+
#
|
732
|
+
class DeleteDataLakeDatasetRequest < Struct.new(
|
733
|
+
:instance_id,
|
734
|
+
:namespace,
|
735
|
+
:name)
|
736
|
+
SENSITIVE = []
|
737
|
+
include Aws::Structure
|
738
|
+
end
|
739
|
+
|
740
|
+
# The response parameters of DeleteDataLakeDataset.
|
741
|
+
#
|
742
|
+
# @!attribute [rw] instance_id
|
743
|
+
# The AWS Supply Chain instance identifier.
|
744
|
+
# @return [String]
|
745
|
+
#
|
746
|
+
# @!attribute [rw] namespace
|
747
|
+
# The namespace of deleted dataset.
|
748
|
+
# @return [String]
|
749
|
+
#
|
750
|
+
# @!attribute [rw] name
|
751
|
+
# The name of deleted dataset.
|
752
|
+
# @return [String]
|
753
|
+
#
|
754
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DeleteDataLakeDatasetResponse AWS API Documentation
|
755
|
+
#
|
756
|
+
class DeleteDataLakeDatasetResponse < Struct.new(
|
757
|
+
:instance_id,
|
758
|
+
:namespace,
|
759
|
+
:name)
|
760
|
+
SENSITIVE = []
|
761
|
+
include Aws::Structure
|
762
|
+
end
|
763
|
+
|
764
|
+
# The request parameters for DeleteInstance.
|
765
|
+
#
|
766
|
+
# @!attribute [rw] instance_id
|
767
|
+
# The AWS Supply Chain instance identifier.
|
768
|
+
# @return [String]
|
769
|
+
#
|
770
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DeleteInstanceRequest AWS API Documentation
|
771
|
+
#
|
772
|
+
class DeleteInstanceRequest < Struct.new(
|
773
|
+
:instance_id)
|
774
|
+
SENSITIVE = []
|
775
|
+
include Aws::Structure
|
776
|
+
end
|
777
|
+
|
778
|
+
# The response parameters for DeleteInstance.
|
779
|
+
#
|
780
|
+
# @!attribute [rw] instance
|
781
|
+
# The AWS Supply Chain instance resource data details.
|
782
|
+
# @return [Types::Instance]
|
783
|
+
#
|
784
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DeleteInstanceResponse AWS API Documentation
|
785
|
+
#
|
786
|
+
class DeleteInstanceResponse < Struct.new(
|
787
|
+
:instance)
|
788
|
+
SENSITIVE = []
|
789
|
+
include Aws::Structure
|
790
|
+
end
|
791
|
+
|
116
792
|
# The request parameters for GetBillOfMaterialsImportJob.
|
117
793
|
#
|
118
794
|
# @!attribute [rw] instance_id
|
119
|
-
# The AWS Supply Chain instance identifier.
|
795
|
+
# The AWS Supply Chain instance identifier.
|
796
|
+
# @return [String]
|
797
|
+
#
|
798
|
+
# @!attribute [rw] job_id
|
799
|
+
# The BillOfMaterialsImportJob identifier.
|
800
|
+
# @return [String]
|
801
|
+
#
|
802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/GetBillOfMaterialsImportJobRequest AWS API Documentation
|
803
|
+
#
|
804
|
+
class GetBillOfMaterialsImportJobRequest < Struct.new(
|
805
|
+
:instance_id,
|
806
|
+
:job_id)
|
807
|
+
SENSITIVE = []
|
808
|
+
include Aws::Structure
|
809
|
+
end
|
810
|
+
|
811
|
+
# The response parameters for GetBillOfMaterialsImportJob.
|
812
|
+
#
|
813
|
+
# @!attribute [rw] job
|
814
|
+
# The BillOfMaterialsImportJob.
|
815
|
+
# @return [Types::BillOfMaterialsImportJob]
|
816
|
+
#
|
817
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/GetBillOfMaterialsImportJobResponse AWS API Documentation
|
818
|
+
#
|
819
|
+
class GetBillOfMaterialsImportJobResponse < Struct.new(
|
820
|
+
:job)
|
821
|
+
SENSITIVE = []
|
822
|
+
include Aws::Structure
|
823
|
+
end
|
824
|
+
|
825
|
+
# The request parameters for GetDataIntegrationFlow.
|
826
|
+
#
|
827
|
+
# @!attribute [rw] instance_id
|
828
|
+
# The Amazon Web Services Supply Chain instance identifier.
|
829
|
+
# @return [String]
|
830
|
+
#
|
831
|
+
# @!attribute [rw] name
|
832
|
+
# The name of the DataIntegrationFlow created.
|
833
|
+
# @return [String]
|
834
|
+
#
|
835
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/GetDataIntegrationFlowRequest AWS API Documentation
|
836
|
+
#
|
837
|
+
class GetDataIntegrationFlowRequest < Struct.new(
|
838
|
+
:instance_id,
|
839
|
+
:name)
|
840
|
+
SENSITIVE = []
|
841
|
+
include Aws::Structure
|
842
|
+
end
|
843
|
+
|
844
|
+
# The response parameters for GetDataIntegrationFlow.
|
845
|
+
#
|
846
|
+
# @!attribute [rw] flow
|
847
|
+
# The details of the DataIntegrationFlow returned.
|
848
|
+
# @return [Types::DataIntegrationFlow]
|
849
|
+
#
|
850
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/GetDataIntegrationFlowResponse AWS API Documentation
|
851
|
+
#
|
852
|
+
class GetDataIntegrationFlowResponse < Struct.new(
|
853
|
+
:flow)
|
854
|
+
SENSITIVE = []
|
855
|
+
include Aws::Structure
|
856
|
+
end
|
857
|
+
|
858
|
+
# The request parameters for GetDataLakeDataset.
|
859
|
+
#
|
860
|
+
# @!attribute [rw] instance_id
|
861
|
+
# The Amazon Web Services Supply Chain instance identifier.
|
120
862
|
# @return [String]
|
121
863
|
#
|
122
|
-
# @!attribute [rw]
|
123
|
-
# The
|
864
|
+
# @!attribute [rw] namespace
|
865
|
+
# The name space of the dataset. The available values are:
|
866
|
+
#
|
867
|
+
# * **asc** - For information on the Amazon Web Services Supply Chain
|
868
|
+
# supported datasets see
|
869
|
+
# [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html][1].
|
870
|
+
#
|
871
|
+
# * **default** - For datasets with custom user-defined schemas.
|
872
|
+
#
|
873
|
+
#
|
874
|
+
#
|
875
|
+
# [1]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
|
124
876
|
# @return [String]
|
125
877
|
#
|
126
|
-
#
|
878
|
+
# @!attribute [rw] name
|
879
|
+
# The name of the dataset. For **asc** name space, the name must be
|
880
|
+
# one of the supported data entities under
|
881
|
+
# [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html][1].
|
127
882
|
#
|
128
|
-
|
883
|
+
#
|
884
|
+
#
|
885
|
+
# [1]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
|
886
|
+
# @return [String]
|
887
|
+
#
|
888
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/GetDataLakeDatasetRequest AWS API Documentation
|
889
|
+
#
|
890
|
+
class GetDataLakeDatasetRequest < Struct.new(
|
129
891
|
:instance_id,
|
130
|
-
:
|
892
|
+
:namespace,
|
893
|
+
:name)
|
131
894
|
SENSITIVE = []
|
132
895
|
include Aws::Structure
|
133
896
|
end
|
134
897
|
|
135
|
-
# The response parameters for
|
898
|
+
# The response parameters for UpdateDataLakeDataset.
|
136
899
|
#
|
137
|
-
# @!attribute [rw]
|
138
|
-
# The
|
139
|
-
# @return [Types::
|
900
|
+
# @!attribute [rw] dataset
|
901
|
+
# The fetched dataset details.
|
902
|
+
# @return [Types::DataLakeDataset]
|
140
903
|
#
|
141
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/
|
904
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/GetDataLakeDatasetResponse AWS API Documentation
|
142
905
|
#
|
143
|
-
class
|
144
|
-
:
|
906
|
+
class GetDataLakeDatasetResponse < Struct.new(
|
907
|
+
:dataset)
|
908
|
+
SENSITIVE = []
|
909
|
+
include Aws::Structure
|
910
|
+
end
|
911
|
+
|
912
|
+
# The request parameters for GetInstance.
|
913
|
+
#
|
914
|
+
# @!attribute [rw] instance_id
|
915
|
+
# The AWS Supply Chain instance identifier
|
916
|
+
# @return [String]
|
917
|
+
#
|
918
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/GetInstanceRequest AWS API Documentation
|
919
|
+
#
|
920
|
+
class GetInstanceRequest < Struct.new(
|
921
|
+
:instance_id)
|
922
|
+
SENSITIVE = []
|
923
|
+
include Aws::Structure
|
924
|
+
end
|
925
|
+
|
926
|
+
# The response parameters for GetInstance.
|
927
|
+
#
|
928
|
+
# @!attribute [rw] instance
|
929
|
+
# The instance resource data details.
|
930
|
+
# @return [Types::Instance]
|
931
|
+
#
|
932
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/GetInstanceResponse AWS API Documentation
|
933
|
+
#
|
934
|
+
class GetInstanceResponse < Struct.new(
|
935
|
+
:instance)
|
936
|
+
SENSITIVE = []
|
937
|
+
include Aws::Structure
|
938
|
+
end
|
939
|
+
|
940
|
+
# The details of the instance.
|
941
|
+
#
|
942
|
+
# @!attribute [rw] instance_id
|
943
|
+
# The Amazon Web Services Supply Chain instance identifier.
|
944
|
+
# @return [String]
|
945
|
+
#
|
946
|
+
# @!attribute [rw] aws_account_id
|
947
|
+
# The Amazon Web Services account ID that owns the instance.
|
948
|
+
# @return [String]
|
949
|
+
#
|
950
|
+
# @!attribute [rw] state
|
951
|
+
# The state of the instance.
|
952
|
+
# @return [String]
|
953
|
+
#
|
954
|
+
# @!attribute [rw] web_app_dns_domain
|
955
|
+
# The WebApp DNS domain name of the instance.
|
956
|
+
# @return [String]
|
957
|
+
#
|
958
|
+
# @!attribute [rw] created_time
|
959
|
+
# The instance creation timestamp.
|
960
|
+
# @return [Time]
|
961
|
+
#
|
962
|
+
# @!attribute [rw] last_modified_time
|
963
|
+
# The instance last modified timestamp.
|
964
|
+
# @return [Time]
|
965
|
+
#
|
966
|
+
# @!attribute [rw] instance_name
|
967
|
+
# The Amazon Web Services Supply Chain instance name.
|
968
|
+
# @return [String]
|
969
|
+
#
|
970
|
+
# @!attribute [rw] instance_description
|
971
|
+
# The Amazon Web Services Supply Chain instance description.
|
972
|
+
# @return [String]
|
973
|
+
#
|
974
|
+
# @!attribute [rw] kms_key_arn
|
975
|
+
# The ARN (Amazon Resource Name) of the Key Management Service (KMS)
|
976
|
+
# key you optionally provided for encryption. If you did not provide
|
977
|
+
# anything here, AWS Supply Chain uses the Amazon Web Services owned
|
978
|
+
# KMS key and nothing is returned.
|
979
|
+
# @return [String]
|
980
|
+
#
|
981
|
+
# @!attribute [rw] version_number
|
982
|
+
# The version number of the instance.
|
983
|
+
# @return [Float]
|
984
|
+
#
|
985
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/Instance AWS API Documentation
|
986
|
+
#
|
987
|
+
class Instance < Struct.new(
|
988
|
+
:instance_id,
|
989
|
+
:aws_account_id,
|
990
|
+
:state,
|
991
|
+
:web_app_dns_domain,
|
992
|
+
:created_time,
|
993
|
+
:last_modified_time,
|
994
|
+
:instance_name,
|
995
|
+
:instance_description,
|
996
|
+
:kms_key_arn,
|
997
|
+
:version_number)
|
145
998
|
SENSITIVE = []
|
146
999
|
include Aws::Structure
|
147
1000
|
end
|
@@ -159,6 +1012,186 @@ module Aws::SupplyChain
|
|
159
1012
|
include Aws::Structure
|
160
1013
|
end
|
161
1014
|
|
1015
|
+
# The request parameters for ListDataIntegrationFlows.
|
1016
|
+
#
|
1017
|
+
# @!attribute [rw] instance_id
|
1018
|
+
# The Amazon Web Services Supply Chain instance identifier.
|
1019
|
+
# @return [String]
|
1020
|
+
#
|
1021
|
+
# @!attribute [rw] next_token
|
1022
|
+
# The pagination token to fetch the next page of the
|
1023
|
+
# DataIntegrationFlows.
|
1024
|
+
# @return [String]
|
1025
|
+
#
|
1026
|
+
# @!attribute [rw] max_results
|
1027
|
+
# Specify the maximum number of DataIntegrationFlows to fetch in one
|
1028
|
+
# paginated request.
|
1029
|
+
# @return [Integer]
|
1030
|
+
#
|
1031
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/ListDataIntegrationFlowsRequest AWS API Documentation
|
1032
|
+
#
|
1033
|
+
class ListDataIntegrationFlowsRequest < Struct.new(
|
1034
|
+
:instance_id,
|
1035
|
+
:next_token,
|
1036
|
+
:max_results)
|
1037
|
+
SENSITIVE = []
|
1038
|
+
include Aws::Structure
|
1039
|
+
end
|
1040
|
+
|
1041
|
+
# The response parameters for ListDataIntegrationFlows.
|
1042
|
+
#
|
1043
|
+
# @!attribute [rw] flows
|
1044
|
+
# The response parameters for ListDataIntegrationFlows.
|
1045
|
+
# @return [Array<Types::DataIntegrationFlow>]
|
1046
|
+
#
|
1047
|
+
# @!attribute [rw] next_token
|
1048
|
+
# The pagination token to fetch the next page of the
|
1049
|
+
# DataIntegrationFlows.
|
1050
|
+
# @return [String]
|
1051
|
+
#
|
1052
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/ListDataIntegrationFlowsResponse AWS API Documentation
|
1053
|
+
#
|
1054
|
+
class ListDataIntegrationFlowsResponse < Struct.new(
|
1055
|
+
:flows,
|
1056
|
+
:next_token)
|
1057
|
+
SENSITIVE = []
|
1058
|
+
include Aws::Structure
|
1059
|
+
end
|
1060
|
+
|
1061
|
+
# The request parameters of ListDataLakeDatasets.
|
1062
|
+
#
|
1063
|
+
# @!attribute [rw] instance_id
|
1064
|
+
# The Amazon Web Services Supply Chain instance identifier.
|
1065
|
+
# @return [String]
|
1066
|
+
#
|
1067
|
+
# @!attribute [rw] namespace
|
1068
|
+
# The namespace of the dataset. The available values are:
|
1069
|
+
#
|
1070
|
+
# * asc: for [ AWS Supply Chain supported datasets ][1].
|
1071
|
+
#
|
1072
|
+
# * default: for datasets with custom user-defined schemas.
|
1073
|
+
#
|
1074
|
+
#
|
1075
|
+
#
|
1076
|
+
# [1]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
|
1077
|
+
# @return [String]
|
1078
|
+
#
|
1079
|
+
# @!attribute [rw] next_token
|
1080
|
+
# The pagination token to fetch next page of datasets.
|
1081
|
+
# @return [String]
|
1082
|
+
#
|
1083
|
+
# @!attribute [rw] max_results
|
1084
|
+
# The max number of datasets to fetch in this paginated request.
|
1085
|
+
# @return [Integer]
|
1086
|
+
#
|
1087
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/ListDataLakeDatasetsRequest AWS API Documentation
|
1088
|
+
#
|
1089
|
+
class ListDataLakeDatasetsRequest < Struct.new(
|
1090
|
+
:instance_id,
|
1091
|
+
:namespace,
|
1092
|
+
:next_token,
|
1093
|
+
:max_results)
|
1094
|
+
SENSITIVE = []
|
1095
|
+
include Aws::Structure
|
1096
|
+
end
|
1097
|
+
|
1098
|
+
# The response parameters of ListDataLakeDatasets.
|
1099
|
+
#
|
1100
|
+
# @!attribute [rw] datasets
|
1101
|
+
# The list of fetched dataset details.
|
1102
|
+
# @return [Array<Types::DataLakeDataset>]
|
1103
|
+
#
|
1104
|
+
# @!attribute [rw] next_token
|
1105
|
+
# The pagination token to fetch next page of datasets.
|
1106
|
+
# @return [String]
|
1107
|
+
#
|
1108
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/ListDataLakeDatasetsResponse AWS API Documentation
|
1109
|
+
#
|
1110
|
+
class ListDataLakeDatasetsResponse < Struct.new(
|
1111
|
+
:datasets,
|
1112
|
+
:next_token)
|
1113
|
+
SENSITIVE = []
|
1114
|
+
include Aws::Structure
|
1115
|
+
end
|
1116
|
+
|
1117
|
+
# The request parameters for ListInstances.
|
1118
|
+
#
|
1119
|
+
# @!attribute [rw] next_token
|
1120
|
+
# The pagination token to fetch the next page of instances.
|
1121
|
+
# @return [String]
|
1122
|
+
#
|
1123
|
+
# @!attribute [rw] max_results
|
1124
|
+
# Specify the maximum number of instances to fetch in this paginated
|
1125
|
+
# request.
|
1126
|
+
# @return [Integer]
|
1127
|
+
#
|
1128
|
+
# @!attribute [rw] instance_name_filter
|
1129
|
+
# The filter to ListInstances based on their names.
|
1130
|
+
# @return [Array<String>]
|
1131
|
+
#
|
1132
|
+
# @!attribute [rw] instance_state_filter
|
1133
|
+
# The filter to ListInstances based on their state.
|
1134
|
+
# @return [Array<String>]
|
1135
|
+
#
|
1136
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/ListInstancesRequest AWS API Documentation
|
1137
|
+
#
|
1138
|
+
class ListInstancesRequest < Struct.new(
|
1139
|
+
:next_token,
|
1140
|
+
:max_results,
|
1141
|
+
:instance_name_filter,
|
1142
|
+
:instance_state_filter)
|
1143
|
+
SENSITIVE = []
|
1144
|
+
include Aws::Structure
|
1145
|
+
end
|
1146
|
+
|
1147
|
+
# The response parameters for ListInstances.
|
1148
|
+
#
|
1149
|
+
# @!attribute [rw] instances
|
1150
|
+
# The list of instances resource data details.
|
1151
|
+
# @return [Array<Types::Instance>]
|
1152
|
+
#
|
1153
|
+
# @!attribute [rw] next_token
|
1154
|
+
# The pagination token to fetch the next page of instances.
|
1155
|
+
# @return [String]
|
1156
|
+
#
|
1157
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/ListInstancesResponse AWS API Documentation
|
1158
|
+
#
|
1159
|
+
class ListInstancesResponse < Struct.new(
|
1160
|
+
:instances,
|
1161
|
+
:next_token)
|
1162
|
+
SENSITIVE = []
|
1163
|
+
include Aws::Structure
|
1164
|
+
end
|
1165
|
+
|
1166
|
+
# The request parameters of ListTagsForResource.
|
1167
|
+
#
|
1168
|
+
# @!attribute [rw] resource_arn
|
1169
|
+
# The Amazon Web Services Supply chain resource ARN that needs tags to
|
1170
|
+
# be listed.
|
1171
|
+
# @return [String]
|
1172
|
+
#
|
1173
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/ListTagsForResourceRequest AWS API Documentation
|
1174
|
+
#
|
1175
|
+
class ListTagsForResourceRequest < Struct.new(
|
1176
|
+
:resource_arn)
|
1177
|
+
SENSITIVE = []
|
1178
|
+
include Aws::Structure
|
1179
|
+
end
|
1180
|
+
|
1181
|
+
# The response parameters of ListTagsForResource.
|
1182
|
+
#
|
1183
|
+
# @!attribute [rw] tags
|
1184
|
+
# The tags added to an Amazon Web Services Supply Chain resource.
|
1185
|
+
# @return [Hash<String,String>]
|
1186
|
+
#
|
1187
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/ListTagsForResourceResponse AWS API Documentation
|
1188
|
+
#
|
1189
|
+
class ListTagsForResourceResponse < Struct.new(
|
1190
|
+
:tags)
|
1191
|
+
SENSITIVE = []
|
1192
|
+
include Aws::Structure
|
1193
|
+
end
|
1194
|
+
|
162
1195
|
# Request references a resource which does not exist.
|
163
1196
|
#
|
164
1197
|
# @!attribute [rw] message
|
@@ -248,6 +1281,33 @@ module Aws::SupplyChain
|
|
248
1281
|
include Aws::Structure
|
249
1282
|
end
|
250
1283
|
|
1284
|
+
# The request parameters of TagResource.
|
1285
|
+
#
|
1286
|
+
# @!attribute [rw] resource_arn
|
1287
|
+
# The Amazon Web Services Supply chain resource ARN that needs to be
|
1288
|
+
# tagged.
|
1289
|
+
# @return [String]
|
1290
|
+
#
|
1291
|
+
# @!attribute [rw] tags
|
1292
|
+
# The tags of the Amazon Web Services Supply chain resource to be
|
1293
|
+
# created.
|
1294
|
+
# @return [Hash<String,String>]
|
1295
|
+
#
|
1296
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/TagResourceRequest AWS API Documentation
|
1297
|
+
#
|
1298
|
+
class TagResourceRequest < Struct.new(
|
1299
|
+
:resource_arn,
|
1300
|
+
:tags)
|
1301
|
+
SENSITIVE = []
|
1302
|
+
include Aws::Structure
|
1303
|
+
end
|
1304
|
+
|
1305
|
+
# The response parameters for TagResource.
|
1306
|
+
#
|
1307
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/TagResourceResponse AWS API Documentation
|
1308
|
+
#
|
1309
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
1310
|
+
|
251
1311
|
# Request was denied due to request throttling.
|
252
1312
|
#
|
253
1313
|
# @!attribute [rw] message
|
@@ -261,6 +1321,178 @@ module Aws::SupplyChain
|
|
261
1321
|
include Aws::Structure
|
262
1322
|
end
|
263
1323
|
|
1324
|
+
# The request parameters of UntagResource.
|
1325
|
+
#
|
1326
|
+
# @!attribute [rw] resource_arn
|
1327
|
+
# The Amazon Web Services Supply chain resource ARN that needs to be
|
1328
|
+
# untagged.
|
1329
|
+
# @return [String]
|
1330
|
+
#
|
1331
|
+
# @!attribute [rw] tag_keys
|
1332
|
+
# The list of tag keys to be deleted for an Amazon Web Services Supply
|
1333
|
+
# Chain resource.
|
1334
|
+
# @return [Array<String>]
|
1335
|
+
#
|
1336
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/UntagResourceRequest AWS API Documentation
|
1337
|
+
#
|
1338
|
+
class UntagResourceRequest < Struct.new(
|
1339
|
+
:resource_arn,
|
1340
|
+
:tag_keys)
|
1341
|
+
SENSITIVE = []
|
1342
|
+
include Aws::Structure
|
1343
|
+
end
|
1344
|
+
|
1345
|
+
# The response parameters of UntagResource.
|
1346
|
+
#
|
1347
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/UntagResourceResponse AWS API Documentation
|
1348
|
+
#
|
1349
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
1350
|
+
|
1351
|
+
# The request parameters for UpdateDataIntegrationFlow.
|
1352
|
+
#
|
1353
|
+
# @!attribute [rw] instance_id
|
1354
|
+
# The Amazon Web Services Supply Chain instance identifier.
|
1355
|
+
# @return [String]
|
1356
|
+
#
|
1357
|
+
# @!attribute [rw] name
|
1358
|
+
# The name of the DataIntegrationFlow to be updated.
|
1359
|
+
# @return [String]
|
1360
|
+
#
|
1361
|
+
# @!attribute [rw] sources
|
1362
|
+
# The new source configurations for the DataIntegrationFlow.
|
1363
|
+
# @return [Array<Types::DataIntegrationFlowSource>]
|
1364
|
+
#
|
1365
|
+
# @!attribute [rw] transformation
|
1366
|
+
# The new transformation configurations for the DataIntegrationFlow.
|
1367
|
+
# @return [Types::DataIntegrationFlowTransformation]
|
1368
|
+
#
|
1369
|
+
# @!attribute [rw] target
|
1370
|
+
# The new target configurations for the DataIntegrationFlow.
|
1371
|
+
# @return [Types::DataIntegrationFlowTarget]
|
1372
|
+
#
|
1373
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/UpdateDataIntegrationFlowRequest AWS API Documentation
|
1374
|
+
#
|
1375
|
+
class UpdateDataIntegrationFlowRequest < Struct.new(
|
1376
|
+
:instance_id,
|
1377
|
+
:name,
|
1378
|
+
:sources,
|
1379
|
+
:transformation,
|
1380
|
+
:target)
|
1381
|
+
SENSITIVE = []
|
1382
|
+
include Aws::Structure
|
1383
|
+
end
|
1384
|
+
|
1385
|
+
# The response parameters for UpdateDataIntegrationFlow.
|
1386
|
+
#
|
1387
|
+
# @!attribute [rw] flow
|
1388
|
+
# The details of the updated DataIntegrationFlow.
|
1389
|
+
# @return [Types::DataIntegrationFlow]
|
1390
|
+
#
|
1391
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/UpdateDataIntegrationFlowResponse AWS API Documentation
|
1392
|
+
#
|
1393
|
+
class UpdateDataIntegrationFlowResponse < Struct.new(
|
1394
|
+
:flow)
|
1395
|
+
SENSITIVE = []
|
1396
|
+
include Aws::Structure
|
1397
|
+
end
|
1398
|
+
|
1399
|
+
# The request parameters of UpdateDataLakeDataset.
|
1400
|
+
#
|
1401
|
+
# @!attribute [rw] instance_id
|
1402
|
+
# The Amazon Web Services Chain instance identifier.
|
1403
|
+
# @return [String]
|
1404
|
+
#
|
1405
|
+
# @!attribute [rw] namespace
|
1406
|
+
# The name space of the dataset. The available values are:
|
1407
|
+
#
|
1408
|
+
# * **asc** - For information on the Amazon Web Services Supply Chain
|
1409
|
+
# supported datasets see
|
1410
|
+
# [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html][1].
|
1411
|
+
#
|
1412
|
+
# * **default** - For datasets with custom user-defined schemas.
|
1413
|
+
#
|
1414
|
+
#
|
1415
|
+
#
|
1416
|
+
# [1]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
|
1417
|
+
# @return [String]
|
1418
|
+
#
|
1419
|
+
# @!attribute [rw] name
|
1420
|
+
# The name of the dataset. For **asc** name space, the name must be
|
1421
|
+
# one of the supported data entities under
|
1422
|
+
# [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html][1].
|
1423
|
+
#
|
1424
|
+
#
|
1425
|
+
#
|
1426
|
+
# [1]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
|
1427
|
+
# @return [String]
|
1428
|
+
#
|
1429
|
+
# @!attribute [rw] description
|
1430
|
+
# The updated description of the data lake dataset.
|
1431
|
+
# @return [String]
|
1432
|
+
#
|
1433
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/UpdateDataLakeDatasetRequest AWS API Documentation
|
1434
|
+
#
|
1435
|
+
class UpdateDataLakeDatasetRequest < Struct.new(
|
1436
|
+
:instance_id,
|
1437
|
+
:namespace,
|
1438
|
+
:name,
|
1439
|
+
:description)
|
1440
|
+
SENSITIVE = []
|
1441
|
+
include Aws::Structure
|
1442
|
+
end
|
1443
|
+
|
1444
|
+
# The response parameters of UpdateDataLakeDataset.
|
1445
|
+
#
|
1446
|
+
# @!attribute [rw] dataset
|
1447
|
+
# The updated dataset details.
|
1448
|
+
# @return [Types::DataLakeDataset]
|
1449
|
+
#
|
1450
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/UpdateDataLakeDatasetResponse AWS API Documentation
|
1451
|
+
#
|
1452
|
+
class UpdateDataLakeDatasetResponse < Struct.new(
|
1453
|
+
:dataset)
|
1454
|
+
SENSITIVE = []
|
1455
|
+
include Aws::Structure
|
1456
|
+
end
|
1457
|
+
|
1458
|
+
# The request parameters for UpdateInstance.
|
1459
|
+
#
|
1460
|
+
# @!attribute [rw] instance_id
|
1461
|
+
# The AWS Supply Chain instance identifier.
|
1462
|
+
# @return [String]
|
1463
|
+
#
|
1464
|
+
# @!attribute [rw] instance_name
|
1465
|
+
# The AWS Supply Chain instance name.
|
1466
|
+
# @return [String]
|
1467
|
+
#
|
1468
|
+
# @!attribute [rw] instance_description
|
1469
|
+
# The AWS Supply Chain instance description.
|
1470
|
+
# @return [String]
|
1471
|
+
#
|
1472
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/UpdateInstanceRequest AWS API Documentation
|
1473
|
+
#
|
1474
|
+
class UpdateInstanceRequest < Struct.new(
|
1475
|
+
:instance_id,
|
1476
|
+
:instance_name,
|
1477
|
+
:instance_description)
|
1478
|
+
SENSITIVE = []
|
1479
|
+
include Aws::Structure
|
1480
|
+
end
|
1481
|
+
|
1482
|
+
# The response parameters for UpdateInstance.
|
1483
|
+
#
|
1484
|
+
# @!attribute [rw] instance
|
1485
|
+
# The instance resource data details.
|
1486
|
+
# @return [Types::Instance]
|
1487
|
+
#
|
1488
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/UpdateInstanceResponse AWS API Documentation
|
1489
|
+
#
|
1490
|
+
class UpdateInstanceResponse < Struct.new(
|
1491
|
+
:instance)
|
1492
|
+
SENSITIVE = []
|
1493
|
+
include Aws::Structure
|
1494
|
+
end
|
1495
|
+
|
264
1496
|
# The input does not satisfy the constraints specified by an AWS
|
265
1497
|
# service.
|
266
1498
|
#
|