aws-sdk-iotthingsgraph 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
File without changes
@@ -0,0 +1,126 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::IoTThingsGraph
9
+ module Errors
10
+
11
+ extend Aws::Errors::DynamicErrors
12
+
13
+ class InternalFailureException < ServiceError
14
+
15
+ # @param [Seahorse::Client::RequestContext] context
16
+ # @param [String] message
17
+ # @param [Aws::IoTThingsGraph::Types::InternalFailureException] data
18
+ def initialize(context, message, data = Aws::EmptyStructure.new)
19
+ super(context, message, data)
20
+ end
21
+
22
+ # @return [String]
23
+ def message
24
+ @message || @data[:message]
25
+ end
26
+
27
+ end
28
+
29
+ class InvalidRequestException < ServiceError
30
+
31
+ # @param [Seahorse::Client::RequestContext] context
32
+ # @param [String] message
33
+ # @param [Aws::IoTThingsGraph::Types::InvalidRequestException] data
34
+ def initialize(context, message, data = Aws::EmptyStructure.new)
35
+ super(context, message, data)
36
+ end
37
+
38
+ # @return [String]
39
+ def message
40
+ @message || @data[:message]
41
+ end
42
+
43
+ end
44
+
45
+ class LimitExceededException < ServiceError
46
+
47
+ # @param [Seahorse::Client::RequestContext] context
48
+ # @param [String] message
49
+ # @param [Aws::IoTThingsGraph::Types::LimitExceededException] data
50
+ def initialize(context, message, data = Aws::EmptyStructure.new)
51
+ super(context, message, data)
52
+ end
53
+
54
+ # @return [String]
55
+ def message
56
+ @message || @data[:message]
57
+ end
58
+
59
+ end
60
+
61
+ class ResourceAlreadyExistsException < ServiceError
62
+
63
+ # @param [Seahorse::Client::RequestContext] context
64
+ # @param [String] message
65
+ # @param [Aws::IoTThingsGraph::Types::ResourceAlreadyExistsException] data
66
+ def initialize(context, message, data = Aws::EmptyStructure.new)
67
+ super(context, message, data)
68
+ end
69
+
70
+ # @return [String]
71
+ def message
72
+ @message || @data[:message]
73
+ end
74
+
75
+ end
76
+
77
+ class ResourceInUseException < ServiceError
78
+
79
+ # @param [Seahorse::Client::RequestContext] context
80
+ # @param [String] message
81
+ # @param [Aws::IoTThingsGraph::Types::ResourceInUseException] data
82
+ def initialize(context, message, data = Aws::EmptyStructure.new)
83
+ super(context, message, data)
84
+ end
85
+
86
+ # @return [String]
87
+ def message
88
+ @message || @data[:message]
89
+ end
90
+
91
+ end
92
+
93
+ class ResourceNotFoundException < ServiceError
94
+
95
+ # @param [Seahorse::Client::RequestContext] context
96
+ # @param [String] message
97
+ # @param [Aws::IoTThingsGraph::Types::ResourceNotFoundException] data
98
+ def initialize(context, message, data = Aws::EmptyStructure.new)
99
+ super(context, message, data)
100
+ end
101
+
102
+ # @return [String]
103
+ def message
104
+ @message || @data[:message]
105
+ end
106
+
107
+ end
108
+
109
+ class ThrottlingException < ServiceError
110
+
111
+ # @param [Seahorse::Client::RequestContext] context
112
+ # @param [String] message
113
+ # @param [Aws::IoTThingsGraph::Types::ThrottlingException] data
114
+ def initialize(context, message, data = Aws::EmptyStructure.new)
115
+ super(context, message, data)
116
+ end
117
+
118
+ # @return [String]
119
+ def message
120
+ @message || @data[:message]
121
+ end
122
+
123
+ end
124
+
125
+ end
126
+ end
@@ -0,0 +1,23 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::IoTThingsGraph
9
+ class Resource
10
+
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
16
+
17
+ # @return [Client]
18
+ def client
19
+ @client
20
+ end
21
+
22
+ end
23
+ end
@@ -0,0 +1,1998 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::IoTThingsGraph
9
+ module Types
10
+
11
+ # @note When making an API call, you may pass AssociateEntityToThingRequest
12
+ # data as a hash:
13
+ #
14
+ # {
15
+ # thing_name: "ThingName", # required
16
+ # entity_id: "Urn", # required
17
+ # namespace_version: 1,
18
+ # }
19
+ #
20
+ # @!attribute [rw] thing_name
21
+ # The name of the thing to which the entity is to be associated.
22
+ # @return [String]
23
+ #
24
+ # @!attribute [rw] entity_id
25
+ # The ID of the device to be associated with the thing.
26
+ #
27
+ # The ID should be in the following format.
28
+ #
29
+ # `urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME`
30
+ # @return [String]
31
+ #
32
+ # @!attribute [rw] namespace_version
33
+ # The version of the user's namespace. Defaults to the latest version
34
+ # of the user's namespace.
35
+ # @return [Integer]
36
+ #
37
+ class AssociateEntityToThingRequest < Struct.new(
38
+ :thing_name,
39
+ :entity_id,
40
+ :namespace_version)
41
+ include Aws::Structure
42
+ end
43
+
44
+ class AssociateEntityToThingResponse < Aws::EmptyStructure; end
45
+
46
+ # @note When making an API call, you may pass CreateFlowTemplateRequest
47
+ # data as a hash:
48
+ #
49
+ # {
50
+ # definition: { # required
51
+ # language: "GRAPHQL", # required, accepts GRAPHQL
52
+ # text: "DefinitionText", # required
53
+ # },
54
+ # compatible_namespace_version: 1,
55
+ # }
56
+ #
57
+ # @!attribute [rw] definition
58
+ # The workflow `DefinitionDocument`.
59
+ # @return [Types::DefinitionDocument]
60
+ #
61
+ # @!attribute [rw] compatible_namespace_version
62
+ # The namespace version in which the workflow is to be created.
63
+ #
64
+ # If no value is specified, the latest version is used by default.
65
+ # @return [Integer]
66
+ #
67
+ class CreateFlowTemplateRequest < Struct.new(
68
+ :definition,
69
+ :compatible_namespace_version)
70
+ include Aws::Structure
71
+ end
72
+
73
+ # @!attribute [rw] summary
74
+ # The summary object that describes the created workflow.
75
+ # @return [Types::FlowTemplateSummary]
76
+ #
77
+ class CreateFlowTemplateResponse < Struct.new(
78
+ :summary)
79
+ include Aws::Structure
80
+ end
81
+
82
+ # @note When making an API call, you may pass CreateSystemInstanceRequest
83
+ # data as a hash:
84
+ #
85
+ # {
86
+ # tags: [
87
+ # {
88
+ # key: "TagKey", # required
89
+ # value: "TagValue", # required
90
+ # },
91
+ # ],
92
+ # definition: { # required
93
+ # language: "GRAPHQL", # required, accepts GRAPHQL
94
+ # text: "DefinitionText", # required
95
+ # },
96
+ # target: "GREENGRASS", # required, accepts GREENGRASS, CLOUD
97
+ # greengrass_group_name: "GroupName",
98
+ # s3_bucket_name: "S3BucketName",
99
+ # metrics_configuration: {
100
+ # cloud_metric_enabled: false,
101
+ # metric_rule_role_arn: "RoleArn",
102
+ # },
103
+ # flow_actions_role_arn: "RoleArn",
104
+ # }
105
+ #
106
+ # @!attribute [rw] tags
107
+ # Metadata, consisting of key-value pairs, that can be used to
108
+ # categorize your system instances.
109
+ # @return [Array<Types::Tag>]
110
+ #
111
+ # @!attribute [rw] definition
112
+ # A document that defines an entity.
113
+ # @return [Types::DefinitionDocument]
114
+ #
115
+ # @!attribute [rw] target
116
+ # The target type of the deployment. Valid values are `GREENGRASS` and
117
+ # `CLOUD`.
118
+ # @return [String]
119
+ #
120
+ # @!attribute [rw] greengrass_group_name
121
+ # The name of the Greengrass group where the system instance will be
122
+ # deployed. This value is required if the value of the `target`
123
+ # parameter is `GREENGRASS`.
124
+ # @return [String]
125
+ #
126
+ # @!attribute [rw] s3_bucket_name
127
+ # The name of the Amazon Simple Storage Service bucket that will be
128
+ # used to store and deploy the system instance's resource file. This
129
+ # value is required if the value of the `target` parameter is
130
+ # `GREENGRASS`.
131
+ # @return [String]
132
+ #
133
+ # @!attribute [rw] metrics_configuration
134
+ # An object that specifies whether cloud metrics are collected in a
135
+ # deployment and, if so, what role is used to collect metrics.
136
+ # @return [Types::MetricsConfiguration]
137
+ #
138
+ # @!attribute [rw] flow_actions_role_arn
139
+ # The ARN of the IAM role that AWS IoT Things Graph will assume when
140
+ # it executes the flow. This role must have read and write access to
141
+ # AWS Lambda and AWS IoT and any other AWS services that the flow uses
142
+ # when it executes. This value is required if the value of the
143
+ # `target` parameter is `CLOUD`.
144
+ # @return [String]
145
+ #
146
+ class CreateSystemInstanceRequest < Struct.new(
147
+ :tags,
148
+ :definition,
149
+ :target,
150
+ :greengrass_group_name,
151
+ :s3_bucket_name,
152
+ :metrics_configuration,
153
+ :flow_actions_role_arn)
154
+ include Aws::Structure
155
+ end
156
+
157
+ # @!attribute [rw] summary
158
+ # The summary object that describes the new system instance.
159
+ # @return [Types::SystemInstanceSummary]
160
+ #
161
+ class CreateSystemInstanceResponse < Struct.new(
162
+ :summary)
163
+ include Aws::Structure
164
+ end
165
+
166
+ # @note When making an API call, you may pass CreateSystemTemplateRequest
167
+ # data as a hash:
168
+ #
169
+ # {
170
+ # definition: { # required
171
+ # language: "GRAPHQL", # required, accepts GRAPHQL
172
+ # text: "DefinitionText", # required
173
+ # },
174
+ # compatible_namespace_version: 1,
175
+ # }
176
+ #
177
+ # @!attribute [rw] definition
178
+ # The `DefinitionDocument` used to create the system.
179
+ # @return [Types::DefinitionDocument]
180
+ #
181
+ # @!attribute [rw] compatible_namespace_version
182
+ # The namespace version in which the system is to be created.
183
+ #
184
+ # If no value is specified, the latest version is used by default.
185
+ # @return [Integer]
186
+ #
187
+ class CreateSystemTemplateRequest < Struct.new(
188
+ :definition,
189
+ :compatible_namespace_version)
190
+ include Aws::Structure
191
+ end
192
+
193
+ # @!attribute [rw] summary
194
+ # The summary object that describes the created system.
195
+ # @return [Types::SystemTemplateSummary]
196
+ #
197
+ class CreateSystemTemplateResponse < Struct.new(
198
+ :summary)
199
+ include Aws::Structure
200
+ end
201
+
202
+ # A document that defines an entity.
203
+ #
204
+ # @note When making an API call, you may pass DefinitionDocument
205
+ # data as a hash:
206
+ #
207
+ # {
208
+ # language: "GRAPHQL", # required, accepts GRAPHQL
209
+ # text: "DefinitionText", # required
210
+ # }
211
+ #
212
+ # @!attribute [rw] language
213
+ # The language used to define the entity. `GRAPHQL` is the only valid
214
+ # value.
215
+ # @return [String]
216
+ #
217
+ # @!attribute [rw] text
218
+ # The GraphQL text that defines the entity.
219
+ # @return [String]
220
+ #
221
+ class DefinitionDocument < Struct.new(
222
+ :language,
223
+ :text)
224
+ include Aws::Structure
225
+ end
226
+
227
+ # @note When making an API call, you may pass DeleteFlowTemplateRequest
228
+ # data as a hash:
229
+ #
230
+ # {
231
+ # id: "Urn", # required
232
+ # }
233
+ #
234
+ # @!attribute [rw] id
235
+ # The ID of the workflow to be deleted.
236
+ #
237
+ # The ID should be in the following format.
238
+ #
239
+ # `urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME`
240
+ # @return [String]
241
+ #
242
+ class DeleteFlowTemplateRequest < Struct.new(
243
+ :id)
244
+ include Aws::Structure
245
+ end
246
+
247
+ class DeleteFlowTemplateResponse < Aws::EmptyStructure; end
248
+
249
+ # @api private
250
+ #
251
+ class DeleteNamespaceRequest < Aws::EmptyStructure; end
252
+
253
+ # @!attribute [rw] namespace_arn
254
+ # The ARN of the namespace to be deleted.
255
+ # @return [String]
256
+ #
257
+ # @!attribute [rw] namespace_name
258
+ # The name of the namespace to be deleted.
259
+ # @return [String]
260
+ #
261
+ class DeleteNamespaceResponse < Struct.new(
262
+ :namespace_arn,
263
+ :namespace_name)
264
+ include Aws::Structure
265
+ end
266
+
267
+ # @note When making an API call, you may pass DeleteSystemInstanceRequest
268
+ # data as a hash:
269
+ #
270
+ # {
271
+ # id: "Urn",
272
+ # }
273
+ #
274
+ # @!attribute [rw] id
275
+ # The ID of the system instance to be deleted.
276
+ # @return [String]
277
+ #
278
+ class DeleteSystemInstanceRequest < Struct.new(
279
+ :id)
280
+ include Aws::Structure
281
+ end
282
+
283
+ class DeleteSystemInstanceResponse < Aws::EmptyStructure; end
284
+
285
+ # @note When making an API call, you may pass DeleteSystemTemplateRequest
286
+ # data as a hash:
287
+ #
288
+ # {
289
+ # id: "Urn", # required
290
+ # }
291
+ #
292
+ # @!attribute [rw] id
293
+ # The ID of the system to be deleted.
294
+ #
295
+ # The ID should be in the following format.
296
+ #
297
+ # `urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME`
298
+ # @return [String]
299
+ #
300
+ class DeleteSystemTemplateRequest < Struct.new(
301
+ :id)
302
+ include Aws::Structure
303
+ end
304
+
305
+ class DeleteSystemTemplateResponse < Aws::EmptyStructure; end
306
+
307
+ # An object that contains the ID and revision number of a workflow or
308
+ # system that is part of a deployment.
309
+ #
310
+ # @!attribute [rw] id
311
+ # The ID of the workflow or system.
312
+ # @return [String]
313
+ #
314
+ # @!attribute [rw] revision_number
315
+ # The revision number of the workflow or system.
316
+ # @return [Integer]
317
+ #
318
+ class DependencyRevision < Struct.new(
319
+ :id,
320
+ :revision_number)
321
+ include Aws::Structure
322
+ end
323
+
324
+ # @note When making an API call, you may pass DeploySystemInstanceRequest
325
+ # data as a hash:
326
+ #
327
+ # {
328
+ # id: "Urn",
329
+ # }
330
+ #
331
+ # @!attribute [rw] id
332
+ # The ID of the system instance. This value is returned by the
333
+ # `CreateSystemInstance` action.
334
+ #
335
+ # The ID should be in the following format.
336
+ #
337
+ # `urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME`
338
+ # @return [String]
339
+ #
340
+ class DeploySystemInstanceRequest < Struct.new(
341
+ :id)
342
+ include Aws::Structure
343
+ end
344
+
345
+ # @!attribute [rw] summary
346
+ # An object that contains summary information about a system instance
347
+ # that was deployed.
348
+ # @return [Types::SystemInstanceSummary]
349
+ #
350
+ # @!attribute [rw] greengrass_deployment_id
351
+ # The ID of the Greengrass deployment used to deploy the system
352
+ # instance.
353
+ # @return [String]
354
+ #
355
+ class DeploySystemInstanceResponse < Struct.new(
356
+ :summary,
357
+ :greengrass_deployment_id)
358
+ include Aws::Structure
359
+ end
360
+
361
+ # @note When making an API call, you may pass DeprecateFlowTemplateRequest
362
+ # data as a hash:
363
+ #
364
+ # {
365
+ # id: "Urn", # required
366
+ # }
367
+ #
368
+ # @!attribute [rw] id
369
+ # The ID of the workflow to be deleted.
370
+ #
371
+ # The ID should be in the following format.
372
+ #
373
+ # `urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME`
374
+ # @return [String]
375
+ #
376
+ class DeprecateFlowTemplateRequest < Struct.new(
377
+ :id)
378
+ include Aws::Structure
379
+ end
380
+
381
+ class DeprecateFlowTemplateResponse < Aws::EmptyStructure; end
382
+
383
+ # @note When making an API call, you may pass DeprecateSystemTemplateRequest
384
+ # data as a hash:
385
+ #
386
+ # {
387
+ # id: "Urn", # required
388
+ # }
389
+ #
390
+ # @!attribute [rw] id
391
+ # The ID of the system to delete.
392
+ #
393
+ # The ID should be in the following format.
394
+ #
395
+ # `urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME`
396
+ # @return [String]
397
+ #
398
+ class DeprecateSystemTemplateRequest < Struct.new(
399
+ :id)
400
+ include Aws::Structure
401
+ end
402
+
403
+ class DeprecateSystemTemplateResponse < Aws::EmptyStructure; end
404
+
405
+ # @note When making an API call, you may pass DescribeNamespaceRequest
406
+ # data as a hash:
407
+ #
408
+ # {
409
+ # namespace_name: "NamespaceName",
410
+ # }
411
+ #
412
+ # @!attribute [rw] namespace_name
413
+ # The name of the user's namespace. Set this to `aws` to get the
414
+ # public namespace.
415
+ # @return [String]
416
+ #
417
+ class DescribeNamespaceRequest < Struct.new(
418
+ :namespace_name)
419
+ include Aws::Structure
420
+ end
421
+
422
+ # @!attribute [rw] namespace_arn
423
+ # The ARN of the namespace.
424
+ # @return [String]
425
+ #
426
+ # @!attribute [rw] namespace_name
427
+ # The name of the namespace.
428
+ # @return [String]
429
+ #
430
+ # @!attribute [rw] tracking_namespace_name
431
+ # The name of the public namespace that the latest namespace version
432
+ # is tracking.
433
+ # @return [String]
434
+ #
435
+ # @!attribute [rw] tracking_namespace_version
436
+ # The version of the public namespace that the latest version is
437
+ # tracking.
438
+ # @return [Integer]
439
+ #
440
+ # @!attribute [rw] namespace_version
441
+ # The version of the user's namespace to describe.
442
+ # @return [Integer]
443
+ #
444
+ class DescribeNamespaceResponse < Struct.new(
445
+ :namespace_arn,
446
+ :namespace_name,
447
+ :tracking_namespace_name,
448
+ :tracking_namespace_version,
449
+ :namespace_version)
450
+ include Aws::Structure
451
+ end
452
+
453
+ # @note When making an API call, you may pass DissociateEntityFromThingRequest
454
+ # data as a hash:
455
+ #
456
+ # {
457
+ # thing_name: "ThingName", # required
458
+ # entity_type: "DEVICE", # required, accepts DEVICE, SERVICE, DEVICE_MODEL, CAPABILITY, STATE, ACTION, EVENT, PROPERTY, MAPPING, ENUM
459
+ # }
460
+ #
461
+ # @!attribute [rw] thing_name
462
+ # The name of the thing to disassociate.
463
+ # @return [String]
464
+ #
465
+ # @!attribute [rw] entity_type
466
+ # The entity type from which to disassociate the thing.
467
+ # @return [String]
468
+ #
469
+ class DissociateEntityFromThingRequest < Struct.new(
470
+ :thing_name,
471
+ :entity_type)
472
+ include Aws::Structure
473
+ end
474
+
475
+ class DissociateEntityFromThingResponse < Aws::EmptyStructure; end
476
+
477
+ # Describes the properties of an entity.
478
+ #
479
+ # @!attribute [rw] id
480
+ # The entity ID.
481
+ # @return [String]
482
+ #
483
+ # @!attribute [rw] arn
484
+ # The entity ARN.
485
+ # @return [String]
486
+ #
487
+ # @!attribute [rw] type
488
+ # The entity type.
489
+ # @return [String]
490
+ #
491
+ # @!attribute [rw] created_at
492
+ # The time at which the entity was created.
493
+ # @return [Time]
494
+ #
495
+ # @!attribute [rw] definition
496
+ # The definition document of the entity.
497
+ # @return [Types::DefinitionDocument]
498
+ #
499
+ class EntityDescription < Struct.new(
500
+ :id,
501
+ :arn,
502
+ :type,
503
+ :created_at,
504
+ :definition)
505
+ include Aws::Structure
506
+ end
507
+
508
+ # An object that filters an entity search. Multiple filters function as
509
+ # OR criteria in the search. For example a search that includes a
510
+ # `NAMESPACE` and a `REFERENCED_ENTITY_ID` filter searches for entities
511
+ # in the specified namespace that use the entity specified by the value
512
+ # of `REFERENCED_ENTITY_ID`.
513
+ #
514
+ # @note When making an API call, you may pass EntityFilter
515
+ # data as a hash:
516
+ #
517
+ # {
518
+ # name: "NAME", # accepts NAME, NAMESPACE, SEMANTIC_TYPE_PATH, REFERENCED_ENTITY_ID
519
+ # value: ["EntityFilterValue"],
520
+ # }
521
+ #
522
+ # @!attribute [rw] name
523
+ # The name of the entity search filter field. `REFERENCED_ENTITY_ID`
524
+ # filters on entities that are used by the entity in the result set.
525
+ # For example, you can filter on the ID of a property that is used in
526
+ # a state.
527
+ # @return [String]
528
+ #
529
+ # @!attribute [rw] value
530
+ # An array of string values for the search filter field. Multiple
531
+ # values function as AND criteria in the search.
532
+ # @return [Array<String>]
533
+ #
534
+ class EntityFilter < Struct.new(
535
+ :name,
536
+ :value)
537
+ include Aws::Structure
538
+ end
539
+
540
+ # An object that contains information about a flow event.
541
+ #
542
+ # @!attribute [rw] message_id
543
+ # The unique identifier of the message.
544
+ # @return [String]
545
+ #
546
+ # @!attribute [rw] event_type
547
+ # The type of flow event .
548
+ # @return [String]
549
+ #
550
+ # @!attribute [rw] timestamp
551
+ # The date and time when the message was last updated.
552
+ # @return [Time]
553
+ #
554
+ # @!attribute [rw] payload
555
+ # A string containing information about the flow event.
556
+ # @return [String]
557
+ #
558
+ class FlowExecutionMessage < Struct.new(
559
+ :message_id,
560
+ :event_type,
561
+ :timestamp,
562
+ :payload)
563
+ include Aws::Structure
564
+ end
565
+
566
+ # An object that contains summary information about a flow execution.
567
+ #
568
+ # @!attribute [rw] flow_execution_id
569
+ # The ID of the flow execution.
570
+ # @return [String]
571
+ #
572
+ # @!attribute [rw] status
573
+ # The current status of the flow execution.
574
+ # @return [String]
575
+ #
576
+ # @!attribute [rw] system_instance_id
577
+ # The ID of the system instance that contains the flow.
578
+ # @return [String]
579
+ #
580
+ # @!attribute [rw] flow_template_id
581
+ # The ID of the flow.
582
+ # @return [String]
583
+ #
584
+ # @!attribute [rw] created_at
585
+ # The date and time when the flow execution summary was created.
586
+ # @return [Time]
587
+ #
588
+ # @!attribute [rw] updated_at
589
+ # The date and time when the flow execution summary was last updated.
590
+ # @return [Time]
591
+ #
592
+ class FlowExecutionSummary < Struct.new(
593
+ :flow_execution_id,
594
+ :status,
595
+ :system_instance_id,
596
+ :flow_template_id,
597
+ :created_at,
598
+ :updated_at)
599
+ include Aws::Structure
600
+ end
601
+
602
+ # An object that contains a workflow's definition and summary
603
+ # information.
604
+ #
605
+ # @!attribute [rw] summary
606
+ # An object that contains summary information about a workflow.
607
+ # @return [Types::FlowTemplateSummary]
608
+ #
609
+ # @!attribute [rw] definition
610
+ # A workflow's definition document.
611
+ # @return [Types::DefinitionDocument]
612
+ #
613
+ # @!attribute [rw] validated_namespace_version
614
+ # The version of the user's namespace against which the workflow was
615
+ # validated. Use this value in your system instance.
616
+ # @return [Integer]
617
+ #
618
+ class FlowTemplateDescription < Struct.new(
619
+ :summary,
620
+ :definition,
621
+ :validated_namespace_version)
622
+ include Aws::Structure
623
+ end
624
+
625
+ # An object that filters a workflow search.
626
+ #
627
+ # @note When making an API call, you may pass FlowTemplateFilter
628
+ # data as a hash:
629
+ #
630
+ # {
631
+ # name: "DEVICE_MODEL_ID", # required, accepts DEVICE_MODEL_ID
632
+ # value: ["FlowTemplateFilterValue"], # required
633
+ # }
634
+ #
635
+ # @!attribute [rw] name
636
+ # The name of the search filter field.
637
+ # @return [String]
638
+ #
639
+ # @!attribute [rw] value
640
+ # An array of string values for the search filter field. Multiple
641
+ # values function as AND criteria in the search.
642
+ # @return [Array<String>]
643
+ #
644
+ class FlowTemplateFilter < Struct.new(
645
+ :name,
646
+ :value)
647
+ include Aws::Structure
648
+ end
649
+
650
+ # An object that contains summary information about a workflow.
651
+ #
652
+ # @!attribute [rw] id
653
+ # The ID of the workflow.
654
+ # @return [String]
655
+ #
656
+ # @!attribute [rw] arn
657
+ # The ARN of the workflow.
658
+ # @return [String]
659
+ #
660
+ # @!attribute [rw] revision_number
661
+ # The revision number of the workflow.
662
+ # @return [Integer]
663
+ #
664
+ # @!attribute [rw] created_at
665
+ # The date when the workflow was created.
666
+ # @return [Time]
667
+ #
668
+ class FlowTemplateSummary < Struct.new(
669
+ :id,
670
+ :arn,
671
+ :revision_number,
672
+ :created_at)
673
+ include Aws::Structure
674
+ end
675
+
676
+ # @note When making an API call, you may pass GetEntitiesRequest
677
+ # data as a hash:
678
+ #
679
+ # {
680
+ # ids: ["Urn"], # required
681
+ # namespace_version: 1,
682
+ # }
683
+ #
684
+ # @!attribute [rw] ids
685
+ # An array of entity IDs.
686
+ #
687
+ # The IDs should be in the following format.
688
+ #
689
+ # `urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME`
690
+ # @return [Array<String>]
691
+ #
692
+ # @!attribute [rw] namespace_version
693
+ # The version of the user's namespace. Defaults to the latest version
694
+ # of the user's namespace.
695
+ # @return [Integer]
696
+ #
697
+ class GetEntitiesRequest < Struct.new(
698
+ :ids,
699
+ :namespace_version)
700
+ include Aws::Structure
701
+ end
702
+
703
+ # @!attribute [rw] descriptions
704
+ # An array of descriptions for the specified entities.
705
+ # @return [Array<Types::EntityDescription>]
706
+ #
707
+ class GetEntitiesResponse < Struct.new(
708
+ :descriptions)
709
+ include Aws::Structure
710
+ end
711
+
712
+ # @note When making an API call, you may pass GetFlowTemplateRequest
713
+ # data as a hash:
714
+ #
715
+ # {
716
+ # id: "Urn", # required
717
+ # revision_number: 1,
718
+ # }
719
+ #
720
+ # @!attribute [rw] id
721
+ # The ID of the workflow.
722
+ #
723
+ # The ID should be in the following format.
724
+ #
725
+ # `urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME`
726
+ # @return [String]
727
+ #
728
+ # @!attribute [rw] revision_number
729
+ # The number of the workflow revision to retrieve.
730
+ # @return [Integer]
731
+ #
732
+ class GetFlowTemplateRequest < Struct.new(
733
+ :id,
734
+ :revision_number)
735
+ include Aws::Structure
736
+ end
737
+
738
+ # @!attribute [rw] description
739
+ # The object that describes the specified workflow.
740
+ # @return [Types::FlowTemplateDescription]
741
+ #
742
+ class GetFlowTemplateResponse < Struct.new(
743
+ :description)
744
+ include Aws::Structure
745
+ end
746
+
747
+ # @note When making an API call, you may pass GetFlowTemplateRevisionsRequest
748
+ # data as a hash:
749
+ #
750
+ # {
751
+ # id: "Urn", # required
752
+ # next_token: "NextToken",
753
+ # max_results: 1,
754
+ # }
755
+ #
756
+ # @!attribute [rw] id
757
+ # The ID of the workflow.
758
+ #
759
+ # The ID should be in the following format.
760
+ #
761
+ # `urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME`
762
+ # @return [String]
763
+ #
764
+ # @!attribute [rw] next_token
765
+ # The string that specifies the next page of results. Use this when
766
+ # you're paginating results.
767
+ # @return [String]
768
+ #
769
+ # @!attribute [rw] max_results
770
+ # The maximum number of results to return in the response.
771
+ # @return [Integer]
772
+ #
773
+ class GetFlowTemplateRevisionsRequest < Struct.new(
774
+ :id,
775
+ :next_token,
776
+ :max_results)
777
+ include Aws::Structure
778
+ end
779
+
780
+ # @!attribute [rw] summaries
781
+ # An array of objects that provide summary data about each revision.
782
+ # @return [Array<Types::FlowTemplateSummary>]
783
+ #
784
+ # @!attribute [rw] next_token
785
+ # The string to specify as `nextToken` when you request the next page
786
+ # of results.
787
+ # @return [String]
788
+ #
789
+ class GetFlowTemplateRevisionsResponse < Struct.new(
790
+ :summaries,
791
+ :next_token)
792
+ include Aws::Structure
793
+ end
794
+
795
+ # @api private
796
+ #
797
+ class GetNamespaceDeletionStatusRequest < Aws::EmptyStructure; end
798
+
799
+ # @!attribute [rw] namespace_arn
800
+ # The ARN of the namespace that is being deleted.
801
+ # @return [String]
802
+ #
803
+ # @!attribute [rw] namespace_name
804
+ # The name of the namespace that is being deleted.
805
+ # @return [String]
806
+ #
807
+ # @!attribute [rw] status
808
+ # The status of the deletion request.
809
+ # @return [String]
810
+ #
811
+ # @!attribute [rw] error_code
812
+ # An error code returned by the namespace deletion task.
813
+ # @return [String]
814
+ #
815
+ # @!attribute [rw] error_message
816
+ # An error code returned by the namespace deletion task.
817
+ # @return [String]
818
+ #
819
+ class GetNamespaceDeletionStatusResponse < Struct.new(
820
+ :namespace_arn,
821
+ :namespace_name,
822
+ :status,
823
+ :error_code,
824
+ :error_message)
825
+ include Aws::Structure
826
+ end
827
+
828
+ # @note When making an API call, you may pass GetSystemInstanceRequest
829
+ # data as a hash:
830
+ #
831
+ # {
832
+ # id: "Urn", # required
833
+ # }
834
+ #
835
+ # @!attribute [rw] id
836
+ # The ID of the system deployment instance. This value is returned by
837
+ # `CreateSystemInstance`.
838
+ #
839
+ # The ID should be in the following format.
840
+ #
841
+ # `urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME`
842
+ # @return [String]
843
+ #
844
+ class GetSystemInstanceRequest < Struct.new(
845
+ :id)
846
+ include Aws::Structure
847
+ end
848
+
849
+ # @!attribute [rw] description
850
+ # An object that describes the system instance.
851
+ # @return [Types::SystemInstanceDescription]
852
+ #
853
+ class GetSystemInstanceResponse < Struct.new(
854
+ :description)
855
+ include Aws::Structure
856
+ end
857
+
858
+ # @note When making an API call, you may pass GetSystemTemplateRequest
859
+ # data as a hash:
860
+ #
861
+ # {
862
+ # id: "Urn", # required
863
+ # revision_number: 1,
864
+ # }
865
+ #
866
+ # @!attribute [rw] id
867
+ # The ID of the system to get. This ID must be in the user's
868
+ # namespace.
869
+ #
870
+ # The ID should be in the following format.
871
+ #
872
+ # `urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME`
873
+ # @return [String]
874
+ #
875
+ # @!attribute [rw] revision_number
876
+ # The number that specifies the revision of the system to get.
877
+ # @return [Integer]
878
+ #
879
+ class GetSystemTemplateRequest < Struct.new(
880
+ :id,
881
+ :revision_number)
882
+ include Aws::Structure
883
+ end
884
+
885
+ # @!attribute [rw] description
886
+ # An object that contains summary data about the system.
887
+ # @return [Types::SystemTemplateDescription]
888
+ #
889
+ class GetSystemTemplateResponse < Struct.new(
890
+ :description)
891
+ include Aws::Structure
892
+ end
893
+
894
+ # @note When making an API call, you may pass GetSystemTemplateRevisionsRequest
895
+ # data as a hash:
896
+ #
897
+ # {
898
+ # id: "Urn", # required
899
+ # next_token: "NextToken",
900
+ # max_results: 1,
901
+ # }
902
+ #
903
+ # @!attribute [rw] id
904
+ # The ID of the system template.
905
+ #
906
+ # The ID should be in the following format.
907
+ #
908
+ # `urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME`
909
+ # @return [String]
910
+ #
911
+ # @!attribute [rw] next_token
912
+ # The string that specifies the next page of results. Use this when
913
+ # you're paginating results.
914
+ # @return [String]
915
+ #
916
+ # @!attribute [rw] max_results
917
+ # The maximum number of results to return in the response.
918
+ # @return [Integer]
919
+ #
920
+ class GetSystemTemplateRevisionsRequest < Struct.new(
921
+ :id,
922
+ :next_token,
923
+ :max_results)
924
+ include Aws::Structure
925
+ end
926
+
927
+ # @!attribute [rw] summaries
928
+ # An array of objects that contain summary data about the system
929
+ # template revisions.
930
+ # @return [Array<Types::SystemTemplateSummary>]
931
+ #
932
+ # @!attribute [rw] next_token
933
+ # The string to specify as `nextToken` when you request the next page
934
+ # of results.
935
+ # @return [String]
936
+ #
937
+ class GetSystemTemplateRevisionsResponse < Struct.new(
938
+ :summaries,
939
+ :next_token)
940
+ include Aws::Structure
941
+ end
942
+
943
+ # @note When making an API call, you may pass GetUploadStatusRequest
944
+ # data as a hash:
945
+ #
946
+ # {
947
+ # upload_id: "UploadId", # required
948
+ # }
949
+ #
950
+ # @!attribute [rw] upload_id
951
+ # The ID of the upload. This value is returned by the
952
+ # `UploadEntityDefinitions` action.
953
+ # @return [String]
954
+ #
955
+ class GetUploadStatusRequest < Struct.new(
956
+ :upload_id)
957
+ include Aws::Structure
958
+ end
959
+
960
+ # @!attribute [rw] upload_id
961
+ # The ID of the upload.
962
+ # @return [String]
963
+ #
964
+ # @!attribute [rw] upload_status
965
+ # The status of the upload. The initial status is `IN_PROGRESS`. The
966
+ # response show all validation failures if the upload fails.
967
+ # @return [String]
968
+ #
969
+ # @!attribute [rw] namespace_arn
970
+ # The ARN of the upload.
971
+ # @return [String]
972
+ #
973
+ # @!attribute [rw] namespace_name
974
+ # The name of the upload's namespace.
975
+ # @return [String]
976
+ #
977
+ # @!attribute [rw] namespace_version
978
+ # The version of the user's namespace. Defaults to the latest version
979
+ # of the user's namespace.
980
+ # @return [Integer]
981
+ #
982
+ # @!attribute [rw] failure_reason
983
+ # The reason for an upload failure.
984
+ # @return [Array<String>]
985
+ #
986
+ # @!attribute [rw] created_date
987
+ # The date at which the upload was created.
988
+ # @return [Time]
989
+ #
990
+ class GetUploadStatusResponse < Struct.new(
991
+ :upload_id,
992
+ :upload_status,
993
+ :namespace_arn,
994
+ :namespace_name,
995
+ :namespace_version,
996
+ :failure_reason,
997
+ :created_date)
998
+ include Aws::Structure
999
+ end
1000
+
1001
+ # @!attribute [rw] message
1002
+ # @return [String]
1003
+ #
1004
+ class InternalFailureException < Struct.new(
1005
+ :message)
1006
+ include Aws::Structure
1007
+ end
1008
+
1009
+ # @!attribute [rw] message
1010
+ # @return [String]
1011
+ #
1012
+ class InvalidRequestException < Struct.new(
1013
+ :message)
1014
+ include Aws::Structure
1015
+ end
1016
+
1017
+ # @!attribute [rw] message
1018
+ # @return [String]
1019
+ #
1020
+ class LimitExceededException < Struct.new(
1021
+ :message)
1022
+ include Aws::Structure
1023
+ end
1024
+
1025
+ # @note When making an API call, you may pass ListFlowExecutionMessagesRequest
1026
+ # data as a hash:
1027
+ #
1028
+ # {
1029
+ # flow_execution_id: "FlowExecutionId", # required
1030
+ # next_token: "NextToken",
1031
+ # max_results: 1,
1032
+ # }
1033
+ #
1034
+ # @!attribute [rw] flow_execution_id
1035
+ # The ID of the flow execution.
1036
+ # @return [String]
1037
+ #
1038
+ # @!attribute [rw] next_token
1039
+ # The string that specifies the next page of results. Use this when
1040
+ # you're paginating results.
1041
+ # @return [String]
1042
+ #
1043
+ # @!attribute [rw] max_results
1044
+ # The maximum number of results to return in the response.
1045
+ # @return [Integer]
1046
+ #
1047
+ class ListFlowExecutionMessagesRequest < Struct.new(
1048
+ :flow_execution_id,
1049
+ :next_token,
1050
+ :max_results)
1051
+ include Aws::Structure
1052
+ end
1053
+
1054
+ # @!attribute [rw] messages
1055
+ # A list of objects that contain information about events in the
1056
+ # specified flow execution.
1057
+ # @return [Array<Types::FlowExecutionMessage>]
1058
+ #
1059
+ # @!attribute [rw] next_token
1060
+ # The string to specify as `nextToken` when you request the next page
1061
+ # of results.
1062
+ # @return [String]
1063
+ #
1064
+ class ListFlowExecutionMessagesResponse < Struct.new(
1065
+ :messages,
1066
+ :next_token)
1067
+ include Aws::Structure
1068
+ end
1069
+
1070
+ # @note When making an API call, you may pass ListTagsForResourceRequest
1071
+ # data as a hash:
1072
+ #
1073
+ # {
1074
+ # max_results: 1,
1075
+ # resource_arn: "ResourceArn", # required
1076
+ # next_token: "NextToken",
1077
+ # }
1078
+ #
1079
+ # @!attribute [rw] max_results
1080
+ # The maximum number of tags to return.
1081
+ # @return [Integer]
1082
+ #
1083
+ # @!attribute [rw] resource_arn
1084
+ # The Amazon Resource Name (ARN) of the resource whose tags are to be
1085
+ # returned.
1086
+ # @return [String]
1087
+ #
1088
+ # @!attribute [rw] next_token
1089
+ # The token that specifies the next page of results to return.
1090
+ # @return [String]
1091
+ #
1092
+ class ListTagsForResourceRequest < Struct.new(
1093
+ :max_results,
1094
+ :resource_arn,
1095
+ :next_token)
1096
+ include Aws::Structure
1097
+ end
1098
+
1099
+ # @!attribute [rw] tags
1100
+ # List of tags returned by the `ListTagsForResource` operation.
1101
+ # @return [Array<Types::Tag>]
1102
+ #
1103
+ # @!attribute [rw] next_token
1104
+ # The token that specifies the next page of results to return.
1105
+ # @return [String]
1106
+ #
1107
+ class ListTagsForResourceResponse < Struct.new(
1108
+ :tags,
1109
+ :next_token)
1110
+ include Aws::Structure
1111
+ end
1112
+
1113
+ # An object that specifies whether cloud metrics are collected in a
1114
+ # deployment and, if so, what role is used to collect metrics.
1115
+ #
1116
+ # @note When making an API call, you may pass MetricsConfiguration
1117
+ # data as a hash:
1118
+ #
1119
+ # {
1120
+ # cloud_metric_enabled: false,
1121
+ # metric_rule_role_arn: "RoleArn",
1122
+ # }
1123
+ #
1124
+ # @!attribute [rw] cloud_metric_enabled
1125
+ # A Boolean that specifies whether cloud metrics are collected.
1126
+ # @return [Boolean]
1127
+ #
1128
+ # @!attribute [rw] metric_rule_role_arn
1129
+ # The ARN of the role that is used to collect cloud metrics.
1130
+ # @return [String]
1131
+ #
1132
+ class MetricsConfiguration < Struct.new(
1133
+ :cloud_metric_enabled,
1134
+ :metric_rule_role_arn)
1135
+ include Aws::Structure
1136
+ end
1137
+
1138
+ # @!attribute [rw] message
1139
+ # @return [String]
1140
+ #
1141
+ class ResourceAlreadyExistsException < Struct.new(
1142
+ :message)
1143
+ include Aws::Structure
1144
+ end
1145
+
1146
+ # @!attribute [rw] message
1147
+ # @return [String]
1148
+ #
1149
+ class ResourceInUseException < Struct.new(
1150
+ :message)
1151
+ include Aws::Structure
1152
+ end
1153
+
1154
+ # @!attribute [rw] message
1155
+ # @return [String]
1156
+ #
1157
+ class ResourceNotFoundException < Struct.new(
1158
+ :message)
1159
+ include Aws::Structure
1160
+ end
1161
+
1162
+ # @note When making an API call, you may pass SearchEntitiesRequest
1163
+ # data as a hash:
1164
+ #
1165
+ # {
1166
+ # entity_types: ["DEVICE"], # required, accepts DEVICE, SERVICE, DEVICE_MODEL, CAPABILITY, STATE, ACTION, EVENT, PROPERTY, MAPPING, ENUM
1167
+ # filters: [
1168
+ # {
1169
+ # name: "NAME", # accepts NAME, NAMESPACE, SEMANTIC_TYPE_PATH, REFERENCED_ENTITY_ID
1170
+ # value: ["EntityFilterValue"],
1171
+ # },
1172
+ # ],
1173
+ # next_token: "NextToken",
1174
+ # max_results: 1,
1175
+ # namespace_version: 1,
1176
+ # }
1177
+ #
1178
+ # @!attribute [rw] entity_types
1179
+ # The entity types for which to search.
1180
+ # @return [Array<String>]
1181
+ #
1182
+ # @!attribute [rw] filters
1183
+ # Optional filter to apply to the search. Valid filters are `NAME`
1184
+ # `NAMESPACE`, `SEMANTIC_TYPE_PATH` and `REFERENCED_ENTITY_ID`.
1185
+ # `REFERENCED_ENTITY_ID` filters on entities that are used by the
1186
+ # entity in the result set. For example, you can filter on the ID of a
1187
+ # property that is used in a state.
1188
+ #
1189
+ # Multiple filters function as OR criteria in the query. Multiple
1190
+ # values passed inside the filter function as AND criteria.
1191
+ # @return [Array<Types::EntityFilter>]
1192
+ #
1193
+ # @!attribute [rw] next_token
1194
+ # The string that specifies the next page of results. Use this when
1195
+ # you're paginating results.
1196
+ # @return [String]
1197
+ #
1198
+ # @!attribute [rw] max_results
1199
+ # The maximum number of results to return in the response.
1200
+ # @return [Integer]
1201
+ #
1202
+ # @!attribute [rw] namespace_version
1203
+ # The version of the user's namespace. Defaults to the latest version
1204
+ # of the user's namespace.
1205
+ # @return [Integer]
1206
+ #
1207
+ class SearchEntitiesRequest < Struct.new(
1208
+ :entity_types,
1209
+ :filters,
1210
+ :next_token,
1211
+ :max_results,
1212
+ :namespace_version)
1213
+ include Aws::Structure
1214
+ end
1215
+
1216
+ # @!attribute [rw] descriptions
1217
+ # An array of descriptions for each entity returned in the search
1218
+ # result.
1219
+ # @return [Array<Types::EntityDescription>]
1220
+ #
1221
+ # @!attribute [rw] next_token
1222
+ # The string to specify as `nextToken` when you request the next page
1223
+ # of results.
1224
+ # @return [String]
1225
+ #
1226
+ class SearchEntitiesResponse < Struct.new(
1227
+ :descriptions,
1228
+ :next_token)
1229
+ include Aws::Structure
1230
+ end
1231
+
1232
+ # @note When making an API call, you may pass SearchFlowExecutionsRequest
1233
+ # data as a hash:
1234
+ #
1235
+ # {
1236
+ # system_instance_id: "Urn", # required
1237
+ # flow_execution_id: "FlowExecutionId",
1238
+ # start_time: Time.now,
1239
+ # end_time: Time.now,
1240
+ # next_token: "NextToken",
1241
+ # max_results: 1,
1242
+ # }
1243
+ #
1244
+ # @!attribute [rw] system_instance_id
1245
+ # The ID of the system instance that contains the flow.
1246
+ # @return [String]
1247
+ #
1248
+ # @!attribute [rw] flow_execution_id
1249
+ # The ID of a flow execution.
1250
+ # @return [String]
1251
+ #
1252
+ # @!attribute [rw] start_time
1253
+ # The date and time of the earliest flow execution to return.
1254
+ # @return [Time]
1255
+ #
1256
+ # @!attribute [rw] end_time
1257
+ # The date and time of the latest flow execution to return.
1258
+ # @return [Time]
1259
+ #
1260
+ # @!attribute [rw] next_token
1261
+ # The string that specifies the next page of results. Use this when
1262
+ # you're paginating results.
1263
+ # @return [String]
1264
+ #
1265
+ # @!attribute [rw] max_results
1266
+ # The maximum number of results to return in the response.
1267
+ # @return [Integer]
1268
+ #
1269
+ class SearchFlowExecutionsRequest < Struct.new(
1270
+ :system_instance_id,
1271
+ :flow_execution_id,
1272
+ :start_time,
1273
+ :end_time,
1274
+ :next_token,
1275
+ :max_results)
1276
+ include Aws::Structure
1277
+ end
1278
+
1279
+ # @!attribute [rw] summaries
1280
+ # An array of objects that contain summary information about each
1281
+ # workflow execution in the result set.
1282
+ # @return [Array<Types::FlowExecutionSummary>]
1283
+ #
1284
+ # @!attribute [rw] next_token
1285
+ # The string to specify as `nextToken` when you request the next page
1286
+ # of results.
1287
+ # @return [String]
1288
+ #
1289
+ class SearchFlowExecutionsResponse < Struct.new(
1290
+ :summaries,
1291
+ :next_token)
1292
+ include Aws::Structure
1293
+ end
1294
+
1295
+ # @note When making an API call, you may pass SearchFlowTemplatesRequest
1296
+ # data as a hash:
1297
+ #
1298
+ # {
1299
+ # filters: [
1300
+ # {
1301
+ # name: "DEVICE_MODEL_ID", # required, accepts DEVICE_MODEL_ID
1302
+ # value: ["FlowTemplateFilterValue"], # required
1303
+ # },
1304
+ # ],
1305
+ # next_token: "NextToken",
1306
+ # max_results: 1,
1307
+ # }
1308
+ #
1309
+ # @!attribute [rw] filters
1310
+ # An array of objects that limit the result set. The only valid filter
1311
+ # is `DEVICE_MODEL_ID`.
1312
+ # @return [Array<Types::FlowTemplateFilter>]
1313
+ #
1314
+ # @!attribute [rw] next_token
1315
+ # The string that specifies the next page of results. Use this when
1316
+ # you're paginating results.
1317
+ # @return [String]
1318
+ #
1319
+ # @!attribute [rw] max_results
1320
+ # The maximum number of results to return in the response.
1321
+ # @return [Integer]
1322
+ #
1323
+ class SearchFlowTemplatesRequest < Struct.new(
1324
+ :filters,
1325
+ :next_token,
1326
+ :max_results)
1327
+ include Aws::Structure
1328
+ end
1329
+
1330
+ # @!attribute [rw] summaries
1331
+ # An array of objects that contain summary information about each
1332
+ # workflow in the result set.
1333
+ # @return [Array<Types::FlowTemplateSummary>]
1334
+ #
1335
+ # @!attribute [rw] next_token
1336
+ # The string to specify as `nextToken` when you request the next page
1337
+ # of results.
1338
+ # @return [String]
1339
+ #
1340
+ class SearchFlowTemplatesResponse < Struct.new(
1341
+ :summaries,
1342
+ :next_token)
1343
+ include Aws::Structure
1344
+ end
1345
+
1346
+ # @note When making an API call, you may pass SearchSystemInstancesRequest
1347
+ # data as a hash:
1348
+ #
1349
+ # {
1350
+ # filters: [
1351
+ # {
1352
+ # name: "SYSTEM_TEMPLATE_ID", # accepts SYSTEM_TEMPLATE_ID, STATUS, GREENGRASS_GROUP_NAME
1353
+ # value: ["SystemInstanceFilterValue"],
1354
+ # },
1355
+ # ],
1356
+ # next_token: "NextToken",
1357
+ # max_results: 1,
1358
+ # }
1359
+ #
1360
+ # @!attribute [rw] filters
1361
+ # Optional filter to apply to the search. Valid filters are
1362
+ # `SYSTEM_TEMPLATE_ID`, `STATUS`, and `GREENGRASS_GROUP_NAME`.
1363
+ #
1364
+ # Multiple filters function as OR criteria in the query. Multiple
1365
+ # values passed inside the filter function as AND criteria.
1366
+ # @return [Array<Types::SystemInstanceFilter>]
1367
+ #
1368
+ # @!attribute [rw] next_token
1369
+ # The string that specifies the next page of results. Use this when
1370
+ # you're paginating results.
1371
+ # @return [String]
1372
+ #
1373
+ # @!attribute [rw] max_results
1374
+ # The maximum number of results to return in the response.
1375
+ # @return [Integer]
1376
+ #
1377
+ class SearchSystemInstancesRequest < Struct.new(
1378
+ :filters,
1379
+ :next_token,
1380
+ :max_results)
1381
+ include Aws::Structure
1382
+ end
1383
+
1384
+ # @!attribute [rw] summaries
1385
+ # An array of objects that contain summary data abour the system
1386
+ # instances in the result set.
1387
+ # @return [Array<Types::SystemInstanceSummary>]
1388
+ #
1389
+ # @!attribute [rw] next_token
1390
+ # The string to specify as `nextToken` when you request the next page
1391
+ # of results.
1392
+ # @return [String]
1393
+ #
1394
+ class SearchSystemInstancesResponse < Struct.new(
1395
+ :summaries,
1396
+ :next_token)
1397
+ include Aws::Structure
1398
+ end
1399
+
1400
+ # @note When making an API call, you may pass SearchSystemTemplatesRequest
1401
+ # data as a hash:
1402
+ #
1403
+ # {
1404
+ # filters: [
1405
+ # {
1406
+ # name: "FLOW_TEMPLATE_ID", # required, accepts FLOW_TEMPLATE_ID
1407
+ # value: ["SystemTemplateFilterValue"], # required
1408
+ # },
1409
+ # ],
1410
+ # next_token: "NextToken",
1411
+ # max_results: 1,
1412
+ # }
1413
+ #
1414
+ # @!attribute [rw] filters
1415
+ # An array of filters that limit the result set. The only valid filter
1416
+ # is `FLOW_TEMPLATE_ID`.
1417
+ # @return [Array<Types::SystemTemplateFilter>]
1418
+ #
1419
+ # @!attribute [rw] next_token
1420
+ # The string that specifies the next page of results. Use this when
1421
+ # you're paginating results.
1422
+ # @return [String]
1423
+ #
1424
+ # @!attribute [rw] max_results
1425
+ # The maximum number of results to return in the response.
1426
+ # @return [Integer]
1427
+ #
1428
+ class SearchSystemTemplatesRequest < Struct.new(
1429
+ :filters,
1430
+ :next_token,
1431
+ :max_results)
1432
+ include Aws::Structure
1433
+ end
1434
+
1435
+ # @!attribute [rw] summaries
1436
+ # An array of objects that contain summary information about each
1437
+ # system deployment in the result set.
1438
+ # @return [Array<Types::SystemTemplateSummary>]
1439
+ #
1440
+ # @!attribute [rw] next_token
1441
+ # The string to specify as `nextToken` when you request the next page
1442
+ # of results.
1443
+ # @return [String]
1444
+ #
1445
+ class SearchSystemTemplatesResponse < Struct.new(
1446
+ :summaries,
1447
+ :next_token)
1448
+ include Aws::Structure
1449
+ end
1450
+
1451
+ # @note When making an API call, you may pass SearchThingsRequest
1452
+ # data as a hash:
1453
+ #
1454
+ # {
1455
+ # entity_id: "Urn", # required
1456
+ # next_token: "NextToken",
1457
+ # max_results: 1,
1458
+ # namespace_version: 1,
1459
+ # }
1460
+ #
1461
+ # @!attribute [rw] entity_id
1462
+ # The ID of the entity to which the things are associated.
1463
+ #
1464
+ # The IDs should be in the following format.
1465
+ #
1466
+ # `urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME`
1467
+ # @return [String]
1468
+ #
1469
+ # @!attribute [rw] next_token
1470
+ # The string that specifies the next page of results. Use this when
1471
+ # you're paginating results.
1472
+ # @return [String]
1473
+ #
1474
+ # @!attribute [rw] max_results
1475
+ # The maximum number of results to return in the response.
1476
+ # @return [Integer]
1477
+ #
1478
+ # @!attribute [rw] namespace_version
1479
+ # The version of the user's namespace. Defaults to the latest version
1480
+ # of the user's namespace.
1481
+ # @return [Integer]
1482
+ #
1483
+ class SearchThingsRequest < Struct.new(
1484
+ :entity_id,
1485
+ :next_token,
1486
+ :max_results,
1487
+ :namespace_version)
1488
+ include Aws::Structure
1489
+ end
1490
+
1491
+ # @!attribute [rw] things
1492
+ # An array of things in the result set.
1493
+ # @return [Array<Types::Thing>]
1494
+ #
1495
+ # @!attribute [rw] next_token
1496
+ # The string to specify as `nextToken` when you request the next page
1497
+ # of results.
1498
+ # @return [String]
1499
+ #
1500
+ class SearchThingsResponse < Struct.new(
1501
+ :things,
1502
+ :next_token)
1503
+ include Aws::Structure
1504
+ end
1505
+
1506
+ # An object that contains a system instance definition and summary
1507
+ # information.
1508
+ #
1509
+ # @!attribute [rw] summary
1510
+ # An object that contains summary information about a system instance.
1511
+ # @return [Types::SystemInstanceSummary]
1512
+ #
1513
+ # @!attribute [rw] definition
1514
+ # A document that defines an entity.
1515
+ # @return [Types::DefinitionDocument]
1516
+ #
1517
+ # @!attribute [rw] s3_bucket_name
1518
+ # The Amazon Simple Storage Service bucket where information about a
1519
+ # system instance is stored.
1520
+ # @return [String]
1521
+ #
1522
+ # @!attribute [rw] metrics_configuration
1523
+ # An object that specifies whether cloud metrics are collected in a
1524
+ # deployment and, if so, what role is used to collect metrics.
1525
+ # @return [Types::MetricsConfiguration]
1526
+ #
1527
+ # @!attribute [rw] validated_namespace_version
1528
+ # The version of the user's namespace against which the system
1529
+ # instance was validated.
1530
+ # @return [Integer]
1531
+ #
1532
+ # @!attribute [rw] validated_dependency_revisions
1533
+ # A list of objects that contain all of the IDs and revision numbers
1534
+ # of workflows and systems that are used in a system instance.
1535
+ # @return [Array<Types::DependencyRevision>]
1536
+ #
1537
+ # @!attribute [rw] flow_actions_role_arn
1538
+ # The AWS Identity and Access Management (IAM) role that AWS IoT
1539
+ # Things Graph assumes during flow execution in a cloud deployment.
1540
+ # This role must have read and write permissionss to AWS Lambda and
1541
+ # AWS IoT and to any other AWS services that the flow uses.
1542
+ # @return [String]
1543
+ #
1544
+ class SystemInstanceDescription < Struct.new(
1545
+ :summary,
1546
+ :definition,
1547
+ :s3_bucket_name,
1548
+ :metrics_configuration,
1549
+ :validated_namespace_version,
1550
+ :validated_dependency_revisions,
1551
+ :flow_actions_role_arn)
1552
+ include Aws::Structure
1553
+ end
1554
+
1555
+ # An object that filters a system instance search. Multiple filters
1556
+ # function as OR criteria in the search. For example a search that
1557
+ # includes a GREENGRASS\_GROUP\_NAME and a STATUS filter searches for
1558
+ # system instances in the specified Greengrass group that have the
1559
+ # specified status.
1560
+ #
1561
+ # @note When making an API call, you may pass SystemInstanceFilter
1562
+ # data as a hash:
1563
+ #
1564
+ # {
1565
+ # name: "SYSTEM_TEMPLATE_ID", # accepts SYSTEM_TEMPLATE_ID, STATUS, GREENGRASS_GROUP_NAME
1566
+ # value: ["SystemInstanceFilterValue"],
1567
+ # }
1568
+ #
1569
+ # @!attribute [rw] name
1570
+ # The name of the search filter field.
1571
+ # @return [String]
1572
+ #
1573
+ # @!attribute [rw] value
1574
+ # An array of string values for the search filter field. Multiple
1575
+ # values function as AND criteria in the search.
1576
+ # @return [Array<String>]
1577
+ #
1578
+ class SystemInstanceFilter < Struct.new(
1579
+ :name,
1580
+ :value)
1581
+ include Aws::Structure
1582
+ end
1583
+
1584
+ # An object that contains summary information about a system instance.
1585
+ #
1586
+ # @!attribute [rw] id
1587
+ # The ID of the system instance.
1588
+ # @return [String]
1589
+ #
1590
+ # @!attribute [rw] arn
1591
+ # The ARN of the system instance.
1592
+ # @return [String]
1593
+ #
1594
+ # @!attribute [rw] status
1595
+ # The status of the system instance.
1596
+ # @return [String]
1597
+ #
1598
+ # @!attribute [rw] target
1599
+ # The target of the system instance.
1600
+ # @return [String]
1601
+ #
1602
+ # @!attribute [rw] greengrass_group_name
1603
+ # The ID of the Greengrass group where the system instance is
1604
+ # deployed.
1605
+ # @return [String]
1606
+ #
1607
+ # @!attribute [rw] created_at
1608
+ # The date when the system instance was created.
1609
+ # @return [Time]
1610
+ #
1611
+ # @!attribute [rw] updated_at
1612
+ # The date and time when the system instance was last updated.
1613
+ # @return [Time]
1614
+ #
1615
+ # @!attribute [rw] greengrass_group_id
1616
+ # The ID of the Greengrass group where the system instance is
1617
+ # deployed.
1618
+ # @return [String]
1619
+ #
1620
+ # @!attribute [rw] greengrass_group_version_id
1621
+ # The version of the Greengrass group where the system instance is
1622
+ # deployed.
1623
+ # @return [String]
1624
+ #
1625
+ class SystemInstanceSummary < Struct.new(
1626
+ :id,
1627
+ :arn,
1628
+ :status,
1629
+ :target,
1630
+ :greengrass_group_name,
1631
+ :created_at,
1632
+ :updated_at,
1633
+ :greengrass_group_id,
1634
+ :greengrass_group_version_id)
1635
+ include Aws::Structure
1636
+ end
1637
+
1638
+ # An object that contains a system's definition document and summary
1639
+ # information.
1640
+ #
1641
+ # @!attribute [rw] summary
1642
+ # An object that contains summary information about a system.
1643
+ # @return [Types::SystemTemplateSummary]
1644
+ #
1645
+ # @!attribute [rw] definition
1646
+ # The definition document of a system.
1647
+ # @return [Types::DefinitionDocument]
1648
+ #
1649
+ # @!attribute [rw] validated_namespace_version
1650
+ # The namespace version against which the system was validated. Use
1651
+ # this value in your system instance.
1652
+ # @return [Integer]
1653
+ #
1654
+ class SystemTemplateDescription < Struct.new(
1655
+ :summary,
1656
+ :definition,
1657
+ :validated_namespace_version)
1658
+ include Aws::Structure
1659
+ end
1660
+
1661
+ # An object that filters a system search.
1662
+ #
1663
+ # @note When making an API call, you may pass SystemTemplateFilter
1664
+ # data as a hash:
1665
+ #
1666
+ # {
1667
+ # name: "FLOW_TEMPLATE_ID", # required, accepts FLOW_TEMPLATE_ID
1668
+ # value: ["SystemTemplateFilterValue"], # required
1669
+ # }
1670
+ #
1671
+ # @!attribute [rw] name
1672
+ # The name of the system search filter field.
1673
+ # @return [String]
1674
+ #
1675
+ # @!attribute [rw] value
1676
+ # An array of string values for the search filter field. Multiple
1677
+ # values function as AND criteria in the search.
1678
+ # @return [Array<String>]
1679
+ #
1680
+ class SystemTemplateFilter < Struct.new(
1681
+ :name,
1682
+ :value)
1683
+ include Aws::Structure
1684
+ end
1685
+
1686
+ # An object that contains information about a system.
1687
+ #
1688
+ # @!attribute [rw] id
1689
+ # The ID of the system.
1690
+ # @return [String]
1691
+ #
1692
+ # @!attribute [rw] arn
1693
+ # The ARN of the system.
1694
+ # @return [String]
1695
+ #
1696
+ # @!attribute [rw] revision_number
1697
+ # The revision number of the system.
1698
+ # @return [Integer]
1699
+ #
1700
+ # @!attribute [rw] created_at
1701
+ # The date when the system was created.
1702
+ # @return [Time]
1703
+ #
1704
+ class SystemTemplateSummary < Struct.new(
1705
+ :id,
1706
+ :arn,
1707
+ :revision_number,
1708
+ :created_at)
1709
+ include Aws::Structure
1710
+ end
1711
+
1712
+ # Metadata assigned to an AWS IoT Things Graph resource consisting of a
1713
+ # key-value pair.
1714
+ #
1715
+ # @note When making an API call, you may pass Tag
1716
+ # data as a hash:
1717
+ #
1718
+ # {
1719
+ # key: "TagKey", # required
1720
+ # value: "TagValue", # required
1721
+ # }
1722
+ #
1723
+ # @!attribute [rw] key
1724
+ # The required name of the tag. The string value can be from 1 to 128
1725
+ # Unicode characters in length.
1726
+ # @return [String]
1727
+ #
1728
+ # @!attribute [rw] value
1729
+ # The optional value of the tag. The string value can be from 1 to 256
1730
+ # Unicode characters in length.
1731
+ # @return [String]
1732
+ #
1733
+ class Tag < Struct.new(
1734
+ :key,
1735
+ :value)
1736
+ include Aws::Structure
1737
+ end
1738
+
1739
+ # @note When making an API call, you may pass TagResourceRequest
1740
+ # data as a hash:
1741
+ #
1742
+ # {
1743
+ # resource_arn: "ResourceArn", # required
1744
+ # tags: [ # required
1745
+ # {
1746
+ # key: "TagKey", # required
1747
+ # value: "TagValue", # required
1748
+ # },
1749
+ # ],
1750
+ # }
1751
+ #
1752
+ # @!attribute [rw] resource_arn
1753
+ # The Amazon Resource Name (ARN) of the resource whose tags are
1754
+ # returned.
1755
+ # @return [String]
1756
+ #
1757
+ # @!attribute [rw] tags
1758
+ # A list of tags to add to the resource.&gt;
1759
+ # @return [Array<Types::Tag>]
1760
+ #
1761
+ class TagResourceRequest < Struct.new(
1762
+ :resource_arn,
1763
+ :tags)
1764
+ include Aws::Structure
1765
+ end
1766
+
1767
+ class TagResourceResponse < Aws::EmptyStructure; end
1768
+
1769
+ # An AWS IoT thing.
1770
+ #
1771
+ # @!attribute [rw] thing_arn
1772
+ # The ARN of the thing.
1773
+ # @return [String]
1774
+ #
1775
+ # @!attribute [rw] thing_name
1776
+ # The name of the thing.
1777
+ # @return [String]
1778
+ #
1779
+ class Thing < Struct.new(
1780
+ :thing_arn,
1781
+ :thing_name)
1782
+ include Aws::Structure
1783
+ end
1784
+
1785
+ # @!attribute [rw] message
1786
+ # @return [String]
1787
+ #
1788
+ class ThrottlingException < Struct.new(
1789
+ :message)
1790
+ include Aws::Structure
1791
+ end
1792
+
1793
+ # @note When making an API call, you may pass UndeploySystemInstanceRequest
1794
+ # data as a hash:
1795
+ #
1796
+ # {
1797
+ # id: "Urn",
1798
+ # }
1799
+ #
1800
+ # @!attribute [rw] id
1801
+ # The ID of the system instance to remove from its target.
1802
+ # @return [String]
1803
+ #
1804
+ class UndeploySystemInstanceRequest < Struct.new(
1805
+ :id)
1806
+ include Aws::Structure
1807
+ end
1808
+
1809
+ # @!attribute [rw] summary
1810
+ # An object that contains summary information about the system
1811
+ # instance that was removed from its target.
1812
+ # @return [Types::SystemInstanceSummary]
1813
+ #
1814
+ class UndeploySystemInstanceResponse < Struct.new(
1815
+ :summary)
1816
+ include Aws::Structure
1817
+ end
1818
+
1819
+ # @note When making an API call, you may pass UntagResourceRequest
1820
+ # data as a hash:
1821
+ #
1822
+ # {
1823
+ # resource_arn: "ResourceArn", # required
1824
+ # tag_keys: ["TagKey"], # required
1825
+ # }
1826
+ #
1827
+ # @!attribute [rw] resource_arn
1828
+ # The Amazon Resource Name (ARN) of the resource whose tags are to be
1829
+ # removed.
1830
+ # @return [String]
1831
+ #
1832
+ # @!attribute [rw] tag_keys
1833
+ # A list of tag key names to remove from the resource. You don't
1834
+ # specify the value. Both the key and its associated value are
1835
+ # removed.
1836
+ #
1837
+ # This parameter to the API requires a JSON text string argument. For
1838
+ # information on how to format a JSON parameter for the various
1839
+ # command line tool environments, see [Using JSON for Parameters][1]
1840
+ # in the *AWS CLI User Guide*.
1841
+ #
1842
+ #
1843
+ #
1844
+ # [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html#cli-using-param-json
1845
+ # @return [Array<String>]
1846
+ #
1847
+ class UntagResourceRequest < Struct.new(
1848
+ :resource_arn,
1849
+ :tag_keys)
1850
+ include Aws::Structure
1851
+ end
1852
+
1853
+ class UntagResourceResponse < Aws::EmptyStructure; end
1854
+
1855
+ # @note When making an API call, you may pass UpdateFlowTemplateRequest
1856
+ # data as a hash:
1857
+ #
1858
+ # {
1859
+ # id: "Urn", # required
1860
+ # definition: { # required
1861
+ # language: "GRAPHQL", # required, accepts GRAPHQL
1862
+ # text: "DefinitionText", # required
1863
+ # },
1864
+ # compatible_namespace_version: 1,
1865
+ # }
1866
+ #
1867
+ # @!attribute [rw] id
1868
+ # The ID of the workflow to be updated.
1869
+ #
1870
+ # The ID should be in the following format.
1871
+ #
1872
+ # `urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME`
1873
+ # @return [String]
1874
+ #
1875
+ # @!attribute [rw] definition
1876
+ # The `DefinitionDocument` that contains the updated workflow
1877
+ # definition.
1878
+ # @return [Types::DefinitionDocument]
1879
+ #
1880
+ # @!attribute [rw] compatible_namespace_version
1881
+ # The version of the user's namespace.
1882
+ #
1883
+ # If no value is specified, the latest version is used by default. Use
1884
+ # the `GetFlowTemplateRevisions` if you want to find earlier revisions
1885
+ # of the flow to update.
1886
+ # @return [Integer]
1887
+ #
1888
+ class UpdateFlowTemplateRequest < Struct.new(
1889
+ :id,
1890
+ :definition,
1891
+ :compatible_namespace_version)
1892
+ include Aws::Structure
1893
+ end
1894
+
1895
+ # @!attribute [rw] summary
1896
+ # An object containing summary information about the updated workflow.
1897
+ # @return [Types::FlowTemplateSummary]
1898
+ #
1899
+ class UpdateFlowTemplateResponse < Struct.new(
1900
+ :summary)
1901
+ include Aws::Structure
1902
+ end
1903
+
1904
+ # @note When making an API call, you may pass UpdateSystemTemplateRequest
1905
+ # data as a hash:
1906
+ #
1907
+ # {
1908
+ # id: "Urn", # required
1909
+ # definition: { # required
1910
+ # language: "GRAPHQL", # required, accepts GRAPHQL
1911
+ # text: "DefinitionText", # required
1912
+ # },
1913
+ # compatible_namespace_version: 1,
1914
+ # }
1915
+ #
1916
+ # @!attribute [rw] id
1917
+ # The ID of the system to be updated.
1918
+ #
1919
+ # The ID should be in the following format.
1920
+ #
1921
+ # `urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME`
1922
+ # @return [String]
1923
+ #
1924
+ # @!attribute [rw] definition
1925
+ # The `DefinitionDocument` that contains the updated system
1926
+ # definition.
1927
+ # @return [Types::DefinitionDocument]
1928
+ #
1929
+ # @!attribute [rw] compatible_namespace_version
1930
+ # The version of the user's namespace. Defaults to the latest version
1931
+ # of the user's namespace.
1932
+ #
1933
+ # If no value is specified, the latest version is used by default.
1934
+ # @return [Integer]
1935
+ #
1936
+ class UpdateSystemTemplateRequest < Struct.new(
1937
+ :id,
1938
+ :definition,
1939
+ :compatible_namespace_version)
1940
+ include Aws::Structure
1941
+ end
1942
+
1943
+ # @!attribute [rw] summary
1944
+ # An object containing summary information about the updated system.
1945
+ # @return [Types::SystemTemplateSummary]
1946
+ #
1947
+ class UpdateSystemTemplateResponse < Struct.new(
1948
+ :summary)
1949
+ include Aws::Structure
1950
+ end
1951
+
1952
+ # @note When making an API call, you may pass UploadEntityDefinitionsRequest
1953
+ # data as a hash:
1954
+ #
1955
+ # {
1956
+ # document: {
1957
+ # language: "GRAPHQL", # required, accepts GRAPHQL
1958
+ # text: "DefinitionText", # required
1959
+ # },
1960
+ # sync_with_public_namespace: false,
1961
+ # deprecate_existing_entities: false,
1962
+ # }
1963
+ #
1964
+ # @!attribute [rw] document
1965
+ # The `DefinitionDocument` that defines the updated entities.
1966
+ # @return [Types::DefinitionDocument]
1967
+ #
1968
+ # @!attribute [rw] sync_with_public_namespace
1969
+ # A Boolean that specifies whether to synchronize with the latest
1970
+ # version of the public namespace. If set to `true`, the upload will
1971
+ # create a new namespace version.
1972
+ # @return [Boolean]
1973
+ #
1974
+ # @!attribute [rw] deprecate_existing_entities
1975
+ # A Boolean that specifies whether to deprecate all entities in the
1976
+ # latest version before uploading the new `DefinitionDocument`. If set
1977
+ # to `true`, the upload will create a new namespace version.
1978
+ # @return [Boolean]
1979
+ #
1980
+ class UploadEntityDefinitionsRequest < Struct.new(
1981
+ :document,
1982
+ :sync_with_public_namespace,
1983
+ :deprecate_existing_entities)
1984
+ include Aws::Structure
1985
+ end
1986
+
1987
+ # @!attribute [rw] upload_id
1988
+ # The ID that specifies the upload action. You can use this to track
1989
+ # the status of the upload.
1990
+ # @return [String]
1991
+ #
1992
+ class UploadEntityDefinitionsResponse < Struct.new(
1993
+ :upload_id)
1994
+ include Aws::Structure
1995
+ end
1996
+
1997
+ end
1998
+ end