@aws-sdk/client-iotthingsgraph 3.533.0 → 3.535.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/IoTThingsGraph.d.ts +11 -1
- package/dist-types/IoTThingsGraphClient.d.ts +1 -1
- package/dist-types/commands/AssociateEntityToThingCommand.d.ts +3 -3
- package/dist-types/commands/CreateFlowTemplateCommand.d.ts +3 -3
- package/dist-types/commands/CreateSystemInstanceCommand.d.ts +3 -3
- package/dist-types/commands/CreateSystemTemplateCommand.d.ts +3 -3
- package/dist-types/commands/DeleteFlowTemplateCommand.d.ts +3 -3
- package/dist-types/commands/DeleteNamespaceCommand.d.ts +3 -3
- package/dist-types/commands/DeleteSystemInstanceCommand.d.ts +3 -3
- package/dist-types/commands/DeleteSystemTemplateCommand.d.ts +3 -3
- package/dist-types/commands/DeploySystemInstanceCommand.d.ts +3 -3
- package/dist-types/commands/DeprecateFlowTemplateCommand.d.ts +3 -3
- package/dist-types/commands/DeprecateSystemTemplateCommand.d.ts +3 -3
- package/dist-types/commands/DescribeNamespaceCommand.d.ts +3 -3
- package/dist-types/commands/DissociateEntityFromThingCommand.d.ts +3 -3
- package/dist-types/commands/GetEntitiesCommand.d.ts +3 -3
- package/dist-types/commands/GetFlowTemplateCommand.d.ts +3 -3
- package/dist-types/commands/GetFlowTemplateRevisionsCommand.d.ts +3 -3
- package/dist-types/commands/GetNamespaceDeletionStatusCommand.d.ts +3 -3
- package/dist-types/commands/GetSystemInstanceCommand.d.ts +3 -3
- package/dist-types/commands/GetSystemTemplateCommand.d.ts +3 -3
- package/dist-types/commands/GetSystemTemplateRevisionsCommand.d.ts +3 -3
- package/dist-types/commands/GetUploadStatusCommand.d.ts +3 -3
- package/dist-types/commands/ListFlowExecutionMessagesCommand.d.ts +3 -3
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -3
- package/dist-types/commands/SearchEntitiesCommand.d.ts +3 -3
- package/dist-types/commands/SearchFlowExecutionsCommand.d.ts +3 -3
- package/dist-types/commands/SearchFlowTemplatesCommand.d.ts +3 -3
- package/dist-types/commands/SearchSystemInstancesCommand.d.ts +3 -3
- package/dist-types/commands/SearchSystemTemplatesCommand.d.ts +3 -3
- package/dist-types/commands/SearchThingsCommand.d.ts +3 -3
- package/dist-types/commands/TagResourceCommand.d.ts +3 -3
- package/dist-types/commands/UndeploySystemInstanceCommand.d.ts +3 -3
- package/dist-types/commands/UntagResourceCommand.d.ts +3 -3
- package/dist-types/commands/UpdateFlowTemplateCommand.d.ts +3 -3
- package/dist-types/commands/UpdateSystemTemplateCommand.d.ts +3 -3
- package/dist-types/commands/UploadEntityDefinitionsCommand.d.ts +3 -3
- package/dist-types/models/models_0.d.ts +221 -221
- package/dist-types/ts3.4/IoTThingsGraph.d.ts +10 -0
- package/dist-types/ts3.4/commands/AssociateEntityToThingCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateFlowTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateSystemInstanceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateSystemTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteFlowTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteNamespaceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteSystemInstanceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteSystemTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeploySystemInstanceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeprecateFlowTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeprecateSystemTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeNamespaceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DissociateEntityFromThingCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetEntitiesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetFlowTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetFlowTemplateRevisionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetNamespaceDeletionStatusCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetSystemInstanceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetSystemTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetSystemTemplateRevisionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetUploadStatusCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListFlowExecutionMessagesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchEntitiesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchFlowExecutionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchFlowTemplatesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchSystemInstancesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchSystemTemplatesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchThingsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UndeploySystemInstanceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateFlowTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateSystemTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UploadEntityDefinitionsCommand.d.ts +9 -0
- package/package.json +40 -40
|
@@ -5,22 +5,22 @@ import { IoTThingsGraphServiceException as __BaseException } from "./IoTThingsGr
|
|
|
5
5
|
*/
|
|
6
6
|
export interface AssociateEntityToThingRequest {
|
|
7
7
|
/**
|
|
8
|
-
* @public
|
|
9
8
|
* <p>The name of the thing to which the entity is to be associated.</p>
|
|
9
|
+
* @public
|
|
10
10
|
*/
|
|
11
11
|
thingName: string | undefined;
|
|
12
12
|
/**
|
|
13
|
-
* @public
|
|
14
13
|
* <p>The ID of the device to be associated with the thing.</p>
|
|
15
14
|
* <p>The ID should be in the following format.</p>
|
|
16
15
|
* <p>
|
|
17
16
|
* <code>urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME</code>
|
|
18
17
|
* </p>
|
|
18
|
+
* @public
|
|
19
19
|
*/
|
|
20
20
|
entityId: string | undefined;
|
|
21
21
|
/**
|
|
22
|
-
* @public
|
|
23
22
|
* <p>The version of the user's namespace. Defaults to the latest version of the user's namespace.</p>
|
|
23
|
+
* @public
|
|
24
24
|
*/
|
|
25
25
|
namespaceVersion?: number;
|
|
26
26
|
}
|
|
@@ -30,8 +30,8 @@ export interface AssociateEntityToThingRequest {
|
|
|
30
30
|
export interface AssociateEntityToThingResponse {
|
|
31
31
|
}
|
|
32
32
|
/**
|
|
33
|
-
* @public
|
|
34
33
|
* <p></p>
|
|
34
|
+
* @public
|
|
35
35
|
*/
|
|
36
36
|
export declare class InternalFailureException extends __BaseException {
|
|
37
37
|
readonly name: "InternalFailureException";
|
|
@@ -42,8 +42,8 @@ export declare class InternalFailureException extends __BaseException {
|
|
|
42
42
|
constructor(opts: __ExceptionOptionType<InternalFailureException, __BaseException>);
|
|
43
43
|
}
|
|
44
44
|
/**
|
|
45
|
-
* @public
|
|
46
45
|
* <p></p>
|
|
46
|
+
* @public
|
|
47
47
|
*/
|
|
48
48
|
export declare class InvalidRequestException extends __BaseException {
|
|
49
49
|
readonly name: "InvalidRequestException";
|
|
@@ -54,8 +54,8 @@ export declare class InvalidRequestException extends __BaseException {
|
|
|
54
54
|
constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
|
|
55
55
|
}
|
|
56
56
|
/**
|
|
57
|
-
* @public
|
|
58
57
|
* <p></p>
|
|
58
|
+
* @public
|
|
59
59
|
*/
|
|
60
60
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
61
61
|
readonly name: "ResourceNotFoundException";
|
|
@@ -66,8 +66,8 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
66
66
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
67
67
|
}
|
|
68
68
|
/**
|
|
69
|
-
* @public
|
|
70
69
|
* <p></p>
|
|
70
|
+
* @public
|
|
71
71
|
*/
|
|
72
72
|
export declare class ThrottlingException extends __BaseException {
|
|
73
73
|
readonly name: "ThrottlingException";
|
|
@@ -89,18 +89,18 @@ export declare const DefinitionLanguage: {
|
|
|
89
89
|
*/
|
|
90
90
|
export type DefinitionLanguage = (typeof DefinitionLanguage)[keyof typeof DefinitionLanguage];
|
|
91
91
|
/**
|
|
92
|
-
* @public
|
|
93
92
|
* <p>A document that defines an entity. </p>
|
|
93
|
+
* @public
|
|
94
94
|
*/
|
|
95
95
|
export interface DefinitionDocument {
|
|
96
96
|
/**
|
|
97
|
-
* @public
|
|
98
97
|
* <p>The language used to define the entity. <code>GRAPHQL</code> is the only valid value.</p>
|
|
98
|
+
* @public
|
|
99
99
|
*/
|
|
100
100
|
language: DefinitionLanguage | undefined;
|
|
101
101
|
/**
|
|
102
|
-
* @public
|
|
103
102
|
* <p>The GraphQL text that defines the entity.</p>
|
|
103
|
+
* @public
|
|
104
104
|
*/
|
|
105
105
|
text: string | undefined;
|
|
106
106
|
}
|
|
@@ -109,40 +109,40 @@ export interface DefinitionDocument {
|
|
|
109
109
|
*/
|
|
110
110
|
export interface CreateFlowTemplateRequest {
|
|
111
111
|
/**
|
|
112
|
-
* @public
|
|
113
112
|
* <p>The workflow <code>DefinitionDocument</code>.</p>
|
|
113
|
+
* @public
|
|
114
114
|
*/
|
|
115
115
|
definition: DefinitionDocument | undefined;
|
|
116
116
|
/**
|
|
117
|
-
* @public
|
|
118
117
|
* <p>The namespace version in which the workflow is to be created.</p>
|
|
119
118
|
* <p>If no value is specified, the latest version is used by default.</p>
|
|
119
|
+
* @public
|
|
120
120
|
*/
|
|
121
121
|
compatibleNamespaceVersion?: number;
|
|
122
122
|
}
|
|
123
123
|
/**
|
|
124
|
-
* @public
|
|
125
124
|
* <p>An object that contains summary information about a workflow.</p>
|
|
125
|
+
* @public
|
|
126
126
|
*/
|
|
127
127
|
export interface FlowTemplateSummary {
|
|
128
128
|
/**
|
|
129
|
-
* @public
|
|
130
129
|
* <p>The ID of the workflow.</p>
|
|
130
|
+
* @public
|
|
131
131
|
*/
|
|
132
132
|
id?: string;
|
|
133
133
|
/**
|
|
134
|
-
* @public
|
|
135
134
|
* <p>The ARN of the workflow.</p>
|
|
135
|
+
* @public
|
|
136
136
|
*/
|
|
137
137
|
arn?: string;
|
|
138
138
|
/**
|
|
139
|
-
* @public
|
|
140
139
|
* <p>The revision number of the workflow.</p>
|
|
140
|
+
* @public
|
|
141
141
|
*/
|
|
142
142
|
revisionNumber?: number;
|
|
143
143
|
/**
|
|
144
|
-
* @public
|
|
145
144
|
* <p>The date when the workflow was created.</p>
|
|
145
|
+
* @public
|
|
146
146
|
*/
|
|
147
147
|
createdAt?: Date;
|
|
148
148
|
}
|
|
@@ -151,14 +151,14 @@ export interface FlowTemplateSummary {
|
|
|
151
151
|
*/
|
|
152
152
|
export interface CreateFlowTemplateResponse {
|
|
153
153
|
/**
|
|
154
|
-
* @public
|
|
155
154
|
* <p>The summary object that describes the created workflow.</p>
|
|
155
|
+
* @public
|
|
156
156
|
*/
|
|
157
157
|
summary?: FlowTemplateSummary;
|
|
158
158
|
}
|
|
159
159
|
/**
|
|
160
|
-
* @public
|
|
161
160
|
* <p></p>
|
|
161
|
+
* @public
|
|
162
162
|
*/
|
|
163
163
|
export declare class LimitExceededException extends __BaseException {
|
|
164
164
|
readonly name: "LimitExceededException";
|
|
@@ -169,8 +169,8 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
169
169
|
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
170
170
|
}
|
|
171
171
|
/**
|
|
172
|
-
* @public
|
|
173
172
|
* <p></p>
|
|
173
|
+
* @public
|
|
174
174
|
*/
|
|
175
175
|
export declare class ResourceAlreadyExistsException extends __BaseException {
|
|
176
176
|
readonly name: "ResourceAlreadyExistsException";
|
|
@@ -181,34 +181,34 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
|
|
|
181
181
|
constructor(opts: __ExceptionOptionType<ResourceAlreadyExistsException, __BaseException>);
|
|
182
182
|
}
|
|
183
183
|
/**
|
|
184
|
-
* @public
|
|
185
184
|
* <p>An object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics.</p>
|
|
185
|
+
* @public
|
|
186
186
|
*/
|
|
187
187
|
export interface MetricsConfiguration {
|
|
188
188
|
/**
|
|
189
|
-
* @public
|
|
190
189
|
* <p>A Boolean that specifies whether cloud metrics are collected.</p>
|
|
190
|
+
* @public
|
|
191
191
|
*/
|
|
192
192
|
cloudMetricEnabled?: boolean;
|
|
193
193
|
/**
|
|
194
|
-
* @public
|
|
195
194
|
* <p>The ARN of the role that is used to collect cloud metrics.</p>
|
|
195
|
+
* @public
|
|
196
196
|
*/
|
|
197
197
|
metricRuleRoleArn?: string;
|
|
198
198
|
}
|
|
199
199
|
/**
|
|
200
|
-
* @public
|
|
201
200
|
* <p>Metadata assigned to an AWS IoT Things Graph resource consisting of a key-value pair.</p>
|
|
201
|
+
* @public
|
|
202
202
|
*/
|
|
203
203
|
export interface Tag {
|
|
204
204
|
/**
|
|
205
|
-
* @public
|
|
206
205
|
* <p>The required name of the tag. The string value can be from 1 to 128 Unicode characters in length.</p>
|
|
206
|
+
* @public
|
|
207
207
|
*/
|
|
208
208
|
key: string | undefined;
|
|
209
209
|
/**
|
|
210
|
-
* @public
|
|
211
210
|
* <p>The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length.</p>
|
|
211
|
+
* @public
|
|
212
212
|
*/
|
|
213
213
|
value: string | undefined;
|
|
214
214
|
}
|
|
@@ -229,42 +229,42 @@ export type DeploymentTarget = (typeof DeploymentTarget)[keyof typeof Deployment
|
|
|
229
229
|
*/
|
|
230
230
|
export interface CreateSystemInstanceRequest {
|
|
231
231
|
/**
|
|
232
|
-
* @public
|
|
233
232
|
* <p>Metadata, consisting of key-value pairs, that can be used to categorize your system instances.</p>
|
|
233
|
+
* @public
|
|
234
234
|
*/
|
|
235
235
|
tags?: Tag[];
|
|
236
236
|
/**
|
|
237
|
-
* @public
|
|
238
237
|
* <p>A document that defines an entity. </p>
|
|
238
|
+
* @public
|
|
239
239
|
*/
|
|
240
240
|
definition: DefinitionDocument | undefined;
|
|
241
241
|
/**
|
|
242
|
-
* @public
|
|
243
242
|
* <p>The target type of the deployment. Valid values are <code>GREENGRASS</code> and <code>CLOUD</code>.</p>
|
|
243
|
+
* @public
|
|
244
244
|
*/
|
|
245
245
|
target: DeploymentTarget | undefined;
|
|
246
246
|
/**
|
|
247
|
-
* @public
|
|
248
247
|
* <p>The name of the Greengrass group where the system instance will be deployed. This value is required if
|
|
249
248
|
* the value of the <code>target</code> parameter is <code>GREENGRASS</code>.</p>
|
|
249
|
+
* @public
|
|
250
250
|
*/
|
|
251
251
|
greengrassGroupName?: string;
|
|
252
252
|
/**
|
|
253
|
-
* @public
|
|
254
253
|
* <p>The name of the Amazon Simple Storage Service bucket that will be used to store and deploy the system instance's resource file. This value is required if
|
|
255
254
|
* the value of the <code>target</code> parameter is <code>GREENGRASS</code>.</p>
|
|
255
|
+
* @public
|
|
256
256
|
*/
|
|
257
257
|
s3BucketName?: string;
|
|
258
258
|
/**
|
|
259
|
-
* @public
|
|
260
259
|
* <p>An object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics.</p>
|
|
260
|
+
* @public
|
|
261
261
|
*/
|
|
262
262
|
metricsConfiguration?: MetricsConfiguration;
|
|
263
263
|
/**
|
|
264
|
-
* @public
|
|
265
264
|
* <p>The ARN of the IAM role that AWS IoT Things Graph will assume when it executes the flow. This role must have
|
|
266
265
|
* read and write access to AWS Lambda and AWS IoT and any other AWS services that the flow uses when it executes. This
|
|
267
266
|
* value is required if the value of the <code>target</code> parameter is <code>CLOUD</code>.</p>
|
|
267
|
+
* @public
|
|
268
268
|
*/
|
|
269
269
|
flowActionsRoleArn?: string;
|
|
270
270
|
}
|
|
@@ -287,55 +287,55 @@ export declare const SystemInstanceDeploymentStatus: {
|
|
|
287
287
|
*/
|
|
288
288
|
export type SystemInstanceDeploymentStatus = (typeof SystemInstanceDeploymentStatus)[keyof typeof SystemInstanceDeploymentStatus];
|
|
289
289
|
/**
|
|
290
|
-
* @public
|
|
291
290
|
* <p>An object that contains summary information about a system instance.</p>
|
|
291
|
+
* @public
|
|
292
292
|
*/
|
|
293
293
|
export interface SystemInstanceSummary {
|
|
294
294
|
/**
|
|
295
|
-
* @public
|
|
296
295
|
* <p>The ID of the system instance.</p>
|
|
296
|
+
* @public
|
|
297
297
|
*/
|
|
298
298
|
id?: string;
|
|
299
299
|
/**
|
|
300
|
-
* @public
|
|
301
300
|
* <p>The ARN of the system instance.</p>
|
|
301
|
+
* @public
|
|
302
302
|
*/
|
|
303
303
|
arn?: string;
|
|
304
304
|
/**
|
|
305
|
-
* @public
|
|
306
305
|
* <p>The status of the system instance.</p>
|
|
306
|
+
* @public
|
|
307
307
|
*/
|
|
308
308
|
status?: SystemInstanceDeploymentStatus;
|
|
309
309
|
/**
|
|
310
|
-
* @public
|
|
311
310
|
* <p>The target of the system instance.</p>
|
|
311
|
+
* @public
|
|
312
312
|
*/
|
|
313
313
|
target?: DeploymentTarget;
|
|
314
314
|
/**
|
|
315
|
-
* @public
|
|
316
315
|
* <p>The ID of the Greengrass group where the system instance is deployed.</p>
|
|
316
|
+
* @public
|
|
317
317
|
*/
|
|
318
318
|
greengrassGroupName?: string;
|
|
319
319
|
/**
|
|
320
|
-
* @public
|
|
321
320
|
* <p>The date when the system instance was created.</p>
|
|
321
|
+
* @public
|
|
322
322
|
*/
|
|
323
323
|
createdAt?: Date;
|
|
324
324
|
/**
|
|
325
|
-
* @public
|
|
326
325
|
* <p>
|
|
327
326
|
*
|
|
328
327
|
* The date and time when the system instance was last updated.</p>
|
|
328
|
+
* @public
|
|
329
329
|
*/
|
|
330
330
|
updatedAt?: Date;
|
|
331
331
|
/**
|
|
332
|
-
* @public
|
|
333
332
|
* <p>The ID of the Greengrass group where the system instance is deployed.</p>
|
|
333
|
+
* @public
|
|
334
334
|
*/
|
|
335
335
|
greengrassGroupId?: string;
|
|
336
336
|
/**
|
|
337
|
-
* @public
|
|
338
337
|
* <p>The version of the Greengrass group where the system instance is deployed.</p>
|
|
338
|
+
* @public
|
|
339
339
|
*/
|
|
340
340
|
greengrassGroupVersionId?: string;
|
|
341
341
|
}
|
|
@@ -344,8 +344,8 @@ export interface SystemInstanceSummary {
|
|
|
344
344
|
*/
|
|
345
345
|
export interface CreateSystemInstanceResponse {
|
|
346
346
|
/**
|
|
347
|
-
* @public
|
|
348
347
|
* <p>The summary object that describes the new system instance.</p>
|
|
348
|
+
* @public
|
|
349
349
|
*/
|
|
350
350
|
summary?: SystemInstanceSummary;
|
|
351
351
|
}
|
|
@@ -354,40 +354,40 @@ export interface CreateSystemInstanceResponse {
|
|
|
354
354
|
*/
|
|
355
355
|
export interface CreateSystemTemplateRequest {
|
|
356
356
|
/**
|
|
357
|
-
* @public
|
|
358
357
|
* <p>The <code>DefinitionDocument</code> used to create the system.</p>
|
|
358
|
+
* @public
|
|
359
359
|
*/
|
|
360
360
|
definition: DefinitionDocument | undefined;
|
|
361
361
|
/**
|
|
362
|
-
* @public
|
|
363
362
|
* <p>The namespace version in which the system is to be created.</p>
|
|
364
363
|
* <p>If no value is specified, the latest version is used by default.</p>
|
|
364
|
+
* @public
|
|
365
365
|
*/
|
|
366
366
|
compatibleNamespaceVersion?: number;
|
|
367
367
|
}
|
|
368
368
|
/**
|
|
369
|
-
* @public
|
|
370
369
|
* <p>An object that contains information about a system.</p>
|
|
370
|
+
* @public
|
|
371
371
|
*/
|
|
372
372
|
export interface SystemTemplateSummary {
|
|
373
373
|
/**
|
|
374
|
-
* @public
|
|
375
374
|
* <p>The ID of the system.</p>
|
|
375
|
+
* @public
|
|
376
376
|
*/
|
|
377
377
|
id?: string;
|
|
378
378
|
/**
|
|
379
|
-
* @public
|
|
380
379
|
* <p>The ARN of the system.</p>
|
|
380
|
+
* @public
|
|
381
381
|
*/
|
|
382
382
|
arn?: string;
|
|
383
383
|
/**
|
|
384
|
-
* @public
|
|
385
384
|
* <p>The revision number of the system.</p>
|
|
385
|
+
* @public
|
|
386
386
|
*/
|
|
387
387
|
revisionNumber?: number;
|
|
388
388
|
/**
|
|
389
|
-
* @public
|
|
390
389
|
* <p>The date when the system was created.</p>
|
|
390
|
+
* @public
|
|
391
391
|
*/
|
|
392
392
|
createdAt?: Date;
|
|
393
393
|
}
|
|
@@ -396,8 +396,8 @@ export interface SystemTemplateSummary {
|
|
|
396
396
|
*/
|
|
397
397
|
export interface CreateSystemTemplateResponse {
|
|
398
398
|
/**
|
|
399
|
-
* @public
|
|
400
399
|
* <p>The summary object that describes the created system.</p>
|
|
400
|
+
* @public
|
|
401
401
|
*/
|
|
402
402
|
summary?: SystemTemplateSummary;
|
|
403
403
|
}
|
|
@@ -406,12 +406,12 @@ export interface CreateSystemTemplateResponse {
|
|
|
406
406
|
*/
|
|
407
407
|
export interface DeleteFlowTemplateRequest {
|
|
408
408
|
/**
|
|
409
|
-
* @public
|
|
410
409
|
* <p>The ID of the workflow to be deleted.</p>
|
|
411
410
|
* <p>The ID should be in the following format.</p>
|
|
412
411
|
* <p>
|
|
413
412
|
* <code>urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME</code>
|
|
414
413
|
* </p>
|
|
414
|
+
* @public
|
|
415
415
|
*/
|
|
416
416
|
id: string | undefined;
|
|
417
417
|
}
|
|
@@ -421,8 +421,8 @@ export interface DeleteFlowTemplateRequest {
|
|
|
421
421
|
export interface DeleteFlowTemplateResponse {
|
|
422
422
|
}
|
|
423
423
|
/**
|
|
424
|
-
* @public
|
|
425
424
|
* <p></p>
|
|
425
|
+
* @public
|
|
426
426
|
*/
|
|
427
427
|
export declare class ResourceInUseException extends __BaseException {
|
|
428
428
|
readonly name: "ResourceInUseException";
|
|
@@ -442,13 +442,13 @@ export interface DeleteNamespaceRequest {
|
|
|
442
442
|
*/
|
|
443
443
|
export interface DeleteNamespaceResponse {
|
|
444
444
|
/**
|
|
445
|
-
* @public
|
|
446
445
|
* <p>The ARN of the namespace to be deleted.</p>
|
|
446
|
+
* @public
|
|
447
447
|
*/
|
|
448
448
|
namespaceArn?: string;
|
|
449
449
|
/**
|
|
450
|
-
* @public
|
|
451
450
|
* <p>The name of the namespace to be deleted.</p>
|
|
451
|
+
* @public
|
|
452
452
|
*/
|
|
453
453
|
namespaceName?: string;
|
|
454
454
|
}
|
|
@@ -457,8 +457,8 @@ export interface DeleteNamespaceResponse {
|
|
|
457
457
|
*/
|
|
458
458
|
export interface DeleteSystemInstanceRequest {
|
|
459
459
|
/**
|
|
460
|
-
* @public
|
|
461
460
|
* <p>The ID of the system instance to be deleted.</p>
|
|
461
|
+
* @public
|
|
462
462
|
*/
|
|
463
463
|
id?: string;
|
|
464
464
|
}
|
|
@@ -472,12 +472,12 @@ export interface DeleteSystemInstanceResponse {
|
|
|
472
472
|
*/
|
|
473
473
|
export interface DeleteSystemTemplateRequest {
|
|
474
474
|
/**
|
|
475
|
-
* @public
|
|
476
475
|
* <p>The ID of the system to be deleted.</p>
|
|
477
476
|
* <p>The ID should be in the following format.</p>
|
|
478
477
|
* <p>
|
|
479
478
|
* <code>urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME</code>
|
|
480
479
|
* </p>
|
|
480
|
+
* @public
|
|
481
481
|
*/
|
|
482
482
|
id: string | undefined;
|
|
483
483
|
}
|
|
@@ -487,18 +487,18 @@ export interface DeleteSystemTemplateRequest {
|
|
|
487
487
|
export interface DeleteSystemTemplateResponse {
|
|
488
488
|
}
|
|
489
489
|
/**
|
|
490
|
-
* @public
|
|
491
490
|
* <p>An object that contains the ID and revision number of a workflow or system that is part of a deployment.</p>
|
|
491
|
+
* @public
|
|
492
492
|
*/
|
|
493
493
|
export interface DependencyRevision {
|
|
494
494
|
/**
|
|
495
|
-
* @public
|
|
496
495
|
* <p>The ID of the workflow or system.</p>
|
|
496
|
+
* @public
|
|
497
497
|
*/
|
|
498
498
|
id?: string;
|
|
499
499
|
/**
|
|
500
|
-
* @public
|
|
501
500
|
* <p>The revision number of the workflow or system.</p>
|
|
501
|
+
* @public
|
|
502
502
|
*/
|
|
503
503
|
revisionNumber?: number;
|
|
504
504
|
}
|
|
@@ -507,12 +507,12 @@ export interface DependencyRevision {
|
|
|
507
507
|
*/
|
|
508
508
|
export interface DeploySystemInstanceRequest {
|
|
509
509
|
/**
|
|
510
|
-
* @public
|
|
511
510
|
* <p>The ID of the system instance. This value is returned by the <code>CreateSystemInstance</code> action.</p>
|
|
512
511
|
* <p>The ID should be in the following format.</p>
|
|
513
512
|
* <p>
|
|
514
513
|
* <code>urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME</code>
|
|
515
514
|
* </p>
|
|
515
|
+
* @public
|
|
516
516
|
*/
|
|
517
517
|
id?: string;
|
|
518
518
|
}
|
|
@@ -521,13 +521,13 @@ export interface DeploySystemInstanceRequest {
|
|
|
521
521
|
*/
|
|
522
522
|
export interface DeploySystemInstanceResponse {
|
|
523
523
|
/**
|
|
524
|
-
* @public
|
|
525
524
|
* <p>An object that contains summary information about a system instance that was deployed. </p>
|
|
525
|
+
* @public
|
|
526
526
|
*/
|
|
527
527
|
summary: SystemInstanceSummary | undefined;
|
|
528
528
|
/**
|
|
529
|
-
* @public
|
|
530
529
|
* <p>The ID of the Greengrass deployment used to deploy the system instance.</p>
|
|
530
|
+
* @public
|
|
531
531
|
*/
|
|
532
532
|
greengrassDeploymentId?: string;
|
|
533
533
|
}
|
|
@@ -536,12 +536,12 @@ export interface DeploySystemInstanceResponse {
|
|
|
536
536
|
*/
|
|
537
537
|
export interface DeprecateFlowTemplateRequest {
|
|
538
538
|
/**
|
|
539
|
-
* @public
|
|
540
539
|
* <p>The ID of the workflow to be deleted.</p>
|
|
541
540
|
* <p>The ID should be in the following format.</p>
|
|
542
541
|
* <p>
|
|
543
542
|
* <code>urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME</code>
|
|
544
543
|
* </p>
|
|
544
|
+
* @public
|
|
545
545
|
*/
|
|
546
546
|
id: string | undefined;
|
|
547
547
|
}
|
|
@@ -555,12 +555,12 @@ export interface DeprecateFlowTemplateResponse {
|
|
|
555
555
|
*/
|
|
556
556
|
export interface DeprecateSystemTemplateRequest {
|
|
557
557
|
/**
|
|
558
|
-
* @public
|
|
559
558
|
* <p>The ID of the system to delete.</p>
|
|
560
559
|
* <p>The ID should be in the following format.</p>
|
|
561
560
|
* <p>
|
|
562
561
|
* <code>urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME</code>
|
|
563
562
|
* </p>
|
|
563
|
+
* @public
|
|
564
564
|
*/
|
|
565
565
|
id: string | undefined;
|
|
566
566
|
}
|
|
@@ -574,8 +574,8 @@ export interface DeprecateSystemTemplateResponse {
|
|
|
574
574
|
*/
|
|
575
575
|
export interface DescribeNamespaceRequest {
|
|
576
576
|
/**
|
|
577
|
-
* @public
|
|
578
577
|
* <p>The name of the user's namespace. Set this to <code>aws</code> to get the public namespace.</p>
|
|
578
|
+
* @public
|
|
579
579
|
*/
|
|
580
580
|
namespaceName?: string;
|
|
581
581
|
}
|
|
@@ -584,28 +584,28 @@ export interface DescribeNamespaceRequest {
|
|
|
584
584
|
*/
|
|
585
585
|
export interface DescribeNamespaceResponse {
|
|
586
586
|
/**
|
|
587
|
-
* @public
|
|
588
587
|
* <p>The ARN of the namespace.</p>
|
|
588
|
+
* @public
|
|
589
589
|
*/
|
|
590
590
|
namespaceArn?: string;
|
|
591
591
|
/**
|
|
592
|
-
* @public
|
|
593
592
|
* <p>The name of the namespace.</p>
|
|
593
|
+
* @public
|
|
594
594
|
*/
|
|
595
595
|
namespaceName?: string;
|
|
596
596
|
/**
|
|
597
|
-
* @public
|
|
598
597
|
* <p>The name of the public namespace that the latest namespace version is tracking.</p>
|
|
598
|
+
* @public
|
|
599
599
|
*/
|
|
600
600
|
trackingNamespaceName?: string;
|
|
601
601
|
/**
|
|
602
|
-
* @public
|
|
603
602
|
* <p>The version of the public namespace that the latest version is tracking.</p>
|
|
603
|
+
* @public
|
|
604
604
|
*/
|
|
605
605
|
trackingNamespaceVersion?: number;
|
|
606
606
|
/**
|
|
607
|
-
* @public
|
|
608
607
|
* <p>The version of the user's namespace to describe.</p>
|
|
608
|
+
* @public
|
|
609
609
|
*/
|
|
610
610
|
namespaceVersion?: number;
|
|
611
611
|
}
|
|
@@ -634,13 +634,13 @@ export type EntityType = (typeof EntityType)[keyof typeof EntityType];
|
|
|
634
634
|
*/
|
|
635
635
|
export interface DissociateEntityFromThingRequest {
|
|
636
636
|
/**
|
|
637
|
-
* @public
|
|
638
637
|
* <p>The name of the thing to disassociate.</p>
|
|
638
|
+
* @public
|
|
639
639
|
*/
|
|
640
640
|
thingName: string | undefined;
|
|
641
641
|
/**
|
|
642
|
-
* @public
|
|
643
642
|
* <p>The entity type from which to disassociate the thing.</p>
|
|
643
|
+
* @public
|
|
644
644
|
*/
|
|
645
645
|
entityType: EntityType | undefined;
|
|
646
646
|
}
|
|
@@ -650,33 +650,33 @@ export interface DissociateEntityFromThingRequest {
|
|
|
650
650
|
export interface DissociateEntityFromThingResponse {
|
|
651
651
|
}
|
|
652
652
|
/**
|
|
653
|
-
* @public
|
|
654
653
|
* <p>Describes the properties of an entity.</p>
|
|
654
|
+
* @public
|
|
655
655
|
*/
|
|
656
656
|
export interface EntityDescription {
|
|
657
657
|
/**
|
|
658
|
-
* @public
|
|
659
658
|
* <p>The entity ID.</p>
|
|
659
|
+
* @public
|
|
660
660
|
*/
|
|
661
661
|
id?: string;
|
|
662
662
|
/**
|
|
663
|
-
* @public
|
|
664
663
|
* <p>The entity ARN.</p>
|
|
664
|
+
* @public
|
|
665
665
|
*/
|
|
666
666
|
arn?: string;
|
|
667
667
|
/**
|
|
668
|
-
* @public
|
|
669
668
|
* <p>The entity type.</p>
|
|
669
|
+
* @public
|
|
670
670
|
*/
|
|
671
671
|
type?: EntityType;
|
|
672
672
|
/**
|
|
673
|
-
* @public
|
|
674
673
|
* <p>The time at which the entity was created.</p>
|
|
674
|
+
* @public
|
|
675
675
|
*/
|
|
676
676
|
createdAt?: Date;
|
|
677
677
|
/**
|
|
678
|
-
* @public
|
|
679
678
|
* <p>The definition document of the entity.</p>
|
|
679
|
+
* @public
|
|
680
680
|
*/
|
|
681
681
|
definition?: DefinitionDocument;
|
|
682
682
|
}
|
|
@@ -695,21 +695,21 @@ export declare const EntityFilterName: {
|
|
|
695
695
|
*/
|
|
696
696
|
export type EntityFilterName = (typeof EntityFilterName)[keyof typeof EntityFilterName];
|
|
697
697
|
/**
|
|
698
|
-
* @public
|
|
699
698
|
* <p>An object that filters an entity search. Multiple filters function as OR criteria in the search. For example a search that includes
|
|
700
699
|
* a <code>NAMESPACE</code> and a <code>REFERENCED_ENTITY_ID</code> filter searches for entities in the specified namespace that use the entity specified by
|
|
701
700
|
* the value of <code>REFERENCED_ENTITY_ID</code>.</p>
|
|
701
|
+
* @public
|
|
702
702
|
*/
|
|
703
703
|
export interface EntityFilter {
|
|
704
704
|
/**
|
|
705
|
-
* @public
|
|
706
705
|
* <p>The name of the entity search filter field. <code>REFERENCED_ENTITY_ID</code> filters on entities that are used by the entity in the result set. For example,
|
|
707
706
|
* you can filter on the ID of a property that is used in a state.</p>
|
|
707
|
+
* @public
|
|
708
708
|
*/
|
|
709
709
|
name?: EntityFilterName;
|
|
710
710
|
/**
|
|
711
|
-
* @public
|
|
712
711
|
* <p>An array of string values for the search filter field. Multiple values function as AND criteria in the search.</p>
|
|
712
|
+
* @public
|
|
713
713
|
*/
|
|
714
714
|
value?: string[];
|
|
715
715
|
}
|
|
@@ -741,28 +741,28 @@ export declare const FlowExecutionEventType: {
|
|
|
741
741
|
*/
|
|
742
742
|
export type FlowExecutionEventType = (typeof FlowExecutionEventType)[keyof typeof FlowExecutionEventType];
|
|
743
743
|
/**
|
|
744
|
-
* @public
|
|
745
744
|
* <p>An object that contains information about a flow event.</p>
|
|
745
|
+
* @public
|
|
746
746
|
*/
|
|
747
747
|
export interface FlowExecutionMessage {
|
|
748
748
|
/**
|
|
749
|
-
* @public
|
|
750
749
|
* <p>The unique identifier of the message.</p>
|
|
750
|
+
* @public
|
|
751
751
|
*/
|
|
752
752
|
messageId?: string;
|
|
753
753
|
/**
|
|
754
|
-
* @public
|
|
755
754
|
* <p>The type of flow event .</p>
|
|
755
|
+
* @public
|
|
756
756
|
*/
|
|
757
757
|
eventType?: FlowExecutionEventType;
|
|
758
758
|
/**
|
|
759
|
-
* @public
|
|
760
759
|
* <p>The date and time when the message was last updated.</p>
|
|
760
|
+
* @public
|
|
761
761
|
*/
|
|
762
762
|
timestamp?: Date;
|
|
763
763
|
/**
|
|
764
|
-
* @public
|
|
765
764
|
* <p>A string containing information about the flow event.</p>
|
|
765
|
+
* @public
|
|
766
766
|
*/
|
|
767
767
|
payload?: string;
|
|
768
768
|
}
|
|
@@ -781,59 +781,59 @@ export declare const FlowExecutionStatus: {
|
|
|
781
781
|
*/
|
|
782
782
|
export type FlowExecutionStatus = (typeof FlowExecutionStatus)[keyof typeof FlowExecutionStatus];
|
|
783
783
|
/**
|
|
784
|
-
* @public
|
|
785
784
|
* <p>An object that contains summary information about a flow execution.</p>
|
|
785
|
+
* @public
|
|
786
786
|
*/
|
|
787
787
|
export interface FlowExecutionSummary {
|
|
788
788
|
/**
|
|
789
|
-
* @public
|
|
790
789
|
* <p>The ID of the flow execution.</p>
|
|
790
|
+
* @public
|
|
791
791
|
*/
|
|
792
792
|
flowExecutionId?: string;
|
|
793
793
|
/**
|
|
794
|
-
* @public
|
|
795
794
|
* <p>The current status of the flow execution.</p>
|
|
795
|
+
* @public
|
|
796
796
|
*/
|
|
797
797
|
status?: FlowExecutionStatus;
|
|
798
798
|
/**
|
|
799
|
-
* @public
|
|
800
799
|
* <p>The ID of the system instance that contains the flow.</p>
|
|
800
|
+
* @public
|
|
801
801
|
*/
|
|
802
802
|
systemInstanceId?: string;
|
|
803
803
|
/**
|
|
804
|
-
* @public
|
|
805
804
|
* <p>The ID of the flow.</p>
|
|
805
|
+
* @public
|
|
806
806
|
*/
|
|
807
807
|
flowTemplateId?: string;
|
|
808
808
|
/**
|
|
809
|
-
* @public
|
|
810
809
|
* <p>The date and time when the flow execution summary was created.</p>
|
|
810
|
+
* @public
|
|
811
811
|
*/
|
|
812
812
|
createdAt?: Date;
|
|
813
813
|
/**
|
|
814
|
-
* @public
|
|
815
814
|
* <p>The date and time when the flow execution summary was last updated.</p>
|
|
815
|
+
* @public
|
|
816
816
|
*/
|
|
817
817
|
updatedAt?: Date;
|
|
818
818
|
}
|
|
819
819
|
/**
|
|
820
|
-
* @public
|
|
821
820
|
* <p>An object that contains a workflow's definition and summary information.</p>
|
|
821
|
+
* @public
|
|
822
822
|
*/
|
|
823
823
|
export interface FlowTemplateDescription {
|
|
824
824
|
/**
|
|
825
|
-
* @public
|
|
826
825
|
* <p>An object that contains summary information about a workflow.</p>
|
|
826
|
+
* @public
|
|
827
827
|
*/
|
|
828
828
|
summary?: FlowTemplateSummary;
|
|
829
829
|
/**
|
|
830
|
-
* @public
|
|
831
830
|
* <p>A workflow's definition document.</p>
|
|
831
|
+
* @public
|
|
832
832
|
*/
|
|
833
833
|
definition?: DefinitionDocument;
|
|
834
834
|
/**
|
|
835
|
-
* @public
|
|
836
835
|
* <p>The version of the user's namespace against which the workflow was validated. Use this value in your system instance.</p>
|
|
836
|
+
* @public
|
|
837
837
|
*/
|
|
838
838
|
validatedNamespaceVersion?: number;
|
|
839
839
|
}
|
|
@@ -849,18 +849,18 @@ export declare const FlowTemplateFilterName: {
|
|
|
849
849
|
*/
|
|
850
850
|
export type FlowTemplateFilterName = (typeof FlowTemplateFilterName)[keyof typeof FlowTemplateFilterName];
|
|
851
851
|
/**
|
|
852
|
-
* @public
|
|
853
852
|
* <p>An object that filters a workflow search.</p>
|
|
853
|
+
* @public
|
|
854
854
|
*/
|
|
855
855
|
export interface FlowTemplateFilter {
|
|
856
856
|
/**
|
|
857
|
-
* @public
|
|
858
857
|
* <p>The name of the search filter field.</p>
|
|
858
|
+
* @public
|
|
859
859
|
*/
|
|
860
860
|
name: FlowTemplateFilterName | undefined;
|
|
861
861
|
/**
|
|
862
|
-
* @public
|
|
863
862
|
* <p>An array of string values for the search filter field. Multiple values function as AND criteria in the search.</p>
|
|
863
|
+
* @public
|
|
864
864
|
*/
|
|
865
865
|
value: string[] | undefined;
|
|
866
866
|
}
|
|
@@ -869,17 +869,17 @@ export interface FlowTemplateFilter {
|
|
|
869
869
|
*/
|
|
870
870
|
export interface GetEntitiesRequest {
|
|
871
871
|
/**
|
|
872
|
-
* @public
|
|
873
872
|
* <p>An array of entity IDs.</p>
|
|
874
873
|
* <p>The IDs should be in the following format.</p>
|
|
875
874
|
* <p>
|
|
876
875
|
* <code>urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME</code>
|
|
877
876
|
* </p>
|
|
877
|
+
* @public
|
|
878
878
|
*/
|
|
879
879
|
ids: string[] | undefined;
|
|
880
880
|
/**
|
|
881
|
-
* @public
|
|
882
881
|
* <p>The version of the user's namespace. Defaults to the latest version of the user's namespace.</p>
|
|
882
|
+
* @public
|
|
883
883
|
*/
|
|
884
884
|
namespaceVersion?: number;
|
|
885
885
|
}
|
|
@@ -888,8 +888,8 @@ export interface GetEntitiesRequest {
|
|
|
888
888
|
*/
|
|
889
889
|
export interface GetEntitiesResponse {
|
|
890
890
|
/**
|
|
891
|
-
* @public
|
|
892
891
|
* <p>An array of descriptions for the specified entities.</p>
|
|
892
|
+
* @public
|
|
893
893
|
*/
|
|
894
894
|
descriptions?: EntityDescription[];
|
|
895
895
|
}
|
|
@@ -898,17 +898,17 @@ export interface GetEntitiesResponse {
|
|
|
898
898
|
*/
|
|
899
899
|
export interface GetFlowTemplateRequest {
|
|
900
900
|
/**
|
|
901
|
-
* @public
|
|
902
901
|
* <p>The ID of the workflow.</p>
|
|
903
902
|
* <p>The ID should be in the following format.</p>
|
|
904
903
|
* <p>
|
|
905
904
|
* <code>urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME</code>
|
|
906
905
|
* </p>
|
|
906
|
+
* @public
|
|
907
907
|
*/
|
|
908
908
|
id: string | undefined;
|
|
909
909
|
/**
|
|
910
|
-
* @public
|
|
911
910
|
* <p>The number of the workflow revision to retrieve.</p>
|
|
911
|
+
* @public
|
|
912
912
|
*/
|
|
913
913
|
revisionNumber?: number;
|
|
914
914
|
}
|
|
@@ -917,8 +917,8 @@ export interface GetFlowTemplateRequest {
|
|
|
917
917
|
*/
|
|
918
918
|
export interface GetFlowTemplateResponse {
|
|
919
919
|
/**
|
|
920
|
-
* @public
|
|
921
920
|
* <p>The object that describes the specified workflow.</p>
|
|
921
|
+
* @public
|
|
922
922
|
*/
|
|
923
923
|
description?: FlowTemplateDescription;
|
|
924
924
|
}
|
|
@@ -927,22 +927,22 @@ export interface GetFlowTemplateResponse {
|
|
|
927
927
|
*/
|
|
928
928
|
export interface GetFlowTemplateRevisionsRequest {
|
|
929
929
|
/**
|
|
930
|
-
* @public
|
|
931
930
|
* <p>The ID of the workflow.</p>
|
|
932
931
|
* <p>The ID should be in the following format.</p>
|
|
933
932
|
* <p>
|
|
934
933
|
* <code>urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME</code>
|
|
935
934
|
* </p>
|
|
935
|
+
* @public
|
|
936
936
|
*/
|
|
937
937
|
id: string | undefined;
|
|
938
938
|
/**
|
|
939
|
-
* @public
|
|
940
939
|
* <p>The string that specifies the next page of results. Use this when you're paginating results.</p>
|
|
940
|
+
* @public
|
|
941
941
|
*/
|
|
942
942
|
nextToken?: string;
|
|
943
943
|
/**
|
|
944
|
-
* @public
|
|
945
944
|
* <p>The maximum number of results to return in the response.</p>
|
|
945
|
+
* @public
|
|
946
946
|
*/
|
|
947
947
|
maxResults?: number;
|
|
948
948
|
}
|
|
@@ -951,13 +951,13 @@ export interface GetFlowTemplateRevisionsRequest {
|
|
|
951
951
|
*/
|
|
952
952
|
export interface GetFlowTemplateRevisionsResponse {
|
|
953
953
|
/**
|
|
954
|
-
* @public
|
|
955
954
|
* <p>An array of objects that provide summary data about each revision.</p>
|
|
955
|
+
* @public
|
|
956
956
|
*/
|
|
957
957
|
summaries?: FlowTemplateSummary[];
|
|
958
958
|
/**
|
|
959
|
-
* @public
|
|
960
959
|
* <p>The string to specify as <code>nextToken</code> when you request the next page of results.</p>
|
|
960
|
+
* @public
|
|
961
961
|
*/
|
|
962
962
|
nextToken?: string;
|
|
963
963
|
}
|
|
@@ -995,28 +995,28 @@ export type NamespaceDeletionStatus = (typeof NamespaceDeletionStatus)[keyof typ
|
|
|
995
995
|
*/
|
|
996
996
|
export interface GetNamespaceDeletionStatusResponse {
|
|
997
997
|
/**
|
|
998
|
-
* @public
|
|
999
998
|
* <p>The ARN of the namespace that is being deleted.</p>
|
|
999
|
+
* @public
|
|
1000
1000
|
*/
|
|
1001
1001
|
namespaceArn?: string;
|
|
1002
1002
|
/**
|
|
1003
|
-
* @public
|
|
1004
1003
|
* <p>The name of the namespace that is being deleted.</p>
|
|
1004
|
+
* @public
|
|
1005
1005
|
*/
|
|
1006
1006
|
namespaceName?: string;
|
|
1007
1007
|
/**
|
|
1008
|
-
* @public
|
|
1009
1008
|
* <p>The status of the deletion request.</p>
|
|
1009
|
+
* @public
|
|
1010
1010
|
*/
|
|
1011
1011
|
status?: NamespaceDeletionStatus;
|
|
1012
1012
|
/**
|
|
1013
|
-
* @public
|
|
1014
1013
|
* <p>An error code returned by the namespace deletion task.</p>
|
|
1014
|
+
* @public
|
|
1015
1015
|
*/
|
|
1016
1016
|
errorCode?: NamespaceDeletionStatusErrorCodes;
|
|
1017
1017
|
/**
|
|
1018
|
-
* @public
|
|
1019
1018
|
* <p>An error code returned by the namespace deletion task.</p>
|
|
1019
|
+
* @public
|
|
1020
1020
|
*/
|
|
1021
1021
|
errorMessage?: string;
|
|
1022
1022
|
}
|
|
@@ -1025,55 +1025,55 @@ export interface GetNamespaceDeletionStatusResponse {
|
|
|
1025
1025
|
*/
|
|
1026
1026
|
export interface GetSystemInstanceRequest {
|
|
1027
1027
|
/**
|
|
1028
|
-
* @public
|
|
1029
1028
|
* <p>The ID of the system deployment instance. This value is returned by <code>CreateSystemInstance</code>.</p>
|
|
1030
1029
|
* <p>The ID should be in the following format.</p>
|
|
1031
1030
|
* <p>
|
|
1032
1031
|
* <code>urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME</code>
|
|
1033
1032
|
* </p>
|
|
1033
|
+
* @public
|
|
1034
1034
|
*/
|
|
1035
1035
|
id: string | undefined;
|
|
1036
1036
|
}
|
|
1037
1037
|
/**
|
|
1038
|
-
* @public
|
|
1039
1038
|
* <p>An object that contains a system instance definition and summary information.</p>
|
|
1039
|
+
* @public
|
|
1040
1040
|
*/
|
|
1041
1041
|
export interface SystemInstanceDescription {
|
|
1042
1042
|
/**
|
|
1043
|
-
* @public
|
|
1044
1043
|
* <p>An object that contains summary information about a system instance.</p>
|
|
1044
|
+
* @public
|
|
1045
1045
|
*/
|
|
1046
1046
|
summary?: SystemInstanceSummary;
|
|
1047
1047
|
/**
|
|
1048
|
-
* @public
|
|
1049
1048
|
* <p>A document that defines an entity. </p>
|
|
1049
|
+
* @public
|
|
1050
1050
|
*/
|
|
1051
1051
|
definition?: DefinitionDocument;
|
|
1052
1052
|
/**
|
|
1053
|
-
* @public
|
|
1054
1053
|
* <p>The Amazon Simple Storage Service bucket where information about a system instance is stored.</p>
|
|
1054
|
+
* @public
|
|
1055
1055
|
*/
|
|
1056
1056
|
s3BucketName?: string;
|
|
1057
1057
|
/**
|
|
1058
|
-
* @public
|
|
1059
1058
|
* <p>An object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics.</p>
|
|
1059
|
+
* @public
|
|
1060
1060
|
*/
|
|
1061
1061
|
metricsConfiguration?: MetricsConfiguration;
|
|
1062
1062
|
/**
|
|
1063
|
-
* @public
|
|
1064
1063
|
* <p>The version of the user's namespace against which the system instance was validated.</p>
|
|
1064
|
+
* @public
|
|
1065
1065
|
*/
|
|
1066
1066
|
validatedNamespaceVersion?: number;
|
|
1067
1067
|
/**
|
|
1068
|
-
* @public
|
|
1069
1068
|
* <p>A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.</p>
|
|
1069
|
+
* @public
|
|
1070
1070
|
*/
|
|
1071
1071
|
validatedDependencyRevisions?: DependencyRevision[];
|
|
1072
1072
|
/**
|
|
1073
|
-
* @public
|
|
1074
1073
|
* <p>The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a
|
|
1075
1074
|
* cloud deployment. This role must have read and write permissionss to AWS Lambda and AWS IoT and to any other
|
|
1076
1075
|
* AWS services that the flow uses.</p>
|
|
1076
|
+
* @public
|
|
1077
1077
|
*/
|
|
1078
1078
|
flowActionsRoleArn?: string;
|
|
1079
1079
|
}
|
|
@@ -1082,8 +1082,8 @@ export interface SystemInstanceDescription {
|
|
|
1082
1082
|
*/
|
|
1083
1083
|
export interface GetSystemInstanceResponse {
|
|
1084
1084
|
/**
|
|
1085
|
-
* @public
|
|
1086
1085
|
* <p>An object that describes the system instance.</p>
|
|
1086
|
+
* @public
|
|
1087
1087
|
*/
|
|
1088
1088
|
description?: SystemInstanceDescription;
|
|
1089
1089
|
}
|
|
@@ -1092,38 +1092,38 @@ export interface GetSystemInstanceResponse {
|
|
|
1092
1092
|
*/
|
|
1093
1093
|
export interface GetSystemTemplateRequest {
|
|
1094
1094
|
/**
|
|
1095
|
-
* @public
|
|
1096
1095
|
* <p>The ID of the system to get. This ID must be in the user's namespace.</p>
|
|
1097
1096
|
* <p>The ID should be in the following format.</p>
|
|
1098
1097
|
* <p>
|
|
1099
1098
|
* <code>urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME</code>
|
|
1100
1099
|
* </p>
|
|
1100
|
+
* @public
|
|
1101
1101
|
*/
|
|
1102
1102
|
id: string | undefined;
|
|
1103
1103
|
/**
|
|
1104
|
-
* @public
|
|
1105
1104
|
* <p>The number that specifies the revision of the system to get.</p>
|
|
1105
|
+
* @public
|
|
1106
1106
|
*/
|
|
1107
1107
|
revisionNumber?: number;
|
|
1108
1108
|
}
|
|
1109
1109
|
/**
|
|
1110
|
-
* @public
|
|
1111
1110
|
* <p>An object that contains a system's definition document and summary information.</p>
|
|
1111
|
+
* @public
|
|
1112
1112
|
*/
|
|
1113
1113
|
export interface SystemTemplateDescription {
|
|
1114
1114
|
/**
|
|
1115
|
-
* @public
|
|
1116
1115
|
* <p>An object that contains summary information about a system.</p>
|
|
1116
|
+
* @public
|
|
1117
1117
|
*/
|
|
1118
1118
|
summary?: SystemTemplateSummary;
|
|
1119
1119
|
/**
|
|
1120
|
-
* @public
|
|
1121
1120
|
* <p>The definition document of a system.</p>
|
|
1121
|
+
* @public
|
|
1122
1122
|
*/
|
|
1123
1123
|
definition?: DefinitionDocument;
|
|
1124
1124
|
/**
|
|
1125
|
-
* @public
|
|
1126
1125
|
* <p>The namespace version against which the system was validated. Use this value in your system instance.</p>
|
|
1126
|
+
* @public
|
|
1127
1127
|
*/
|
|
1128
1128
|
validatedNamespaceVersion?: number;
|
|
1129
1129
|
}
|
|
@@ -1132,8 +1132,8 @@ export interface SystemTemplateDescription {
|
|
|
1132
1132
|
*/
|
|
1133
1133
|
export interface GetSystemTemplateResponse {
|
|
1134
1134
|
/**
|
|
1135
|
-
* @public
|
|
1136
1135
|
* <p>An object that contains summary data about the system.</p>
|
|
1136
|
+
* @public
|
|
1137
1137
|
*/
|
|
1138
1138
|
description?: SystemTemplateDescription;
|
|
1139
1139
|
}
|
|
@@ -1142,22 +1142,22 @@ export interface GetSystemTemplateResponse {
|
|
|
1142
1142
|
*/
|
|
1143
1143
|
export interface GetSystemTemplateRevisionsRequest {
|
|
1144
1144
|
/**
|
|
1145
|
-
* @public
|
|
1146
1145
|
* <p>The ID of the system template.</p>
|
|
1147
1146
|
* <p>The ID should be in the following format.</p>
|
|
1148
1147
|
* <p>
|
|
1149
1148
|
* <code>urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME</code>
|
|
1150
1149
|
* </p>
|
|
1150
|
+
* @public
|
|
1151
1151
|
*/
|
|
1152
1152
|
id: string | undefined;
|
|
1153
1153
|
/**
|
|
1154
|
-
* @public
|
|
1155
1154
|
* <p>The string that specifies the next page of results. Use this when you're paginating results.</p>
|
|
1155
|
+
* @public
|
|
1156
1156
|
*/
|
|
1157
1157
|
nextToken?: string;
|
|
1158
1158
|
/**
|
|
1159
|
-
* @public
|
|
1160
1159
|
* <p>The maximum number of results to return in the response.</p>
|
|
1160
|
+
* @public
|
|
1161
1161
|
*/
|
|
1162
1162
|
maxResults?: number;
|
|
1163
1163
|
}
|
|
@@ -1166,13 +1166,13 @@ export interface GetSystemTemplateRevisionsRequest {
|
|
|
1166
1166
|
*/
|
|
1167
1167
|
export interface GetSystemTemplateRevisionsResponse {
|
|
1168
1168
|
/**
|
|
1169
|
-
* @public
|
|
1170
1169
|
* <p>An array of objects that contain summary data about the system template revisions.</p>
|
|
1170
|
+
* @public
|
|
1171
1171
|
*/
|
|
1172
1172
|
summaries?: SystemTemplateSummary[];
|
|
1173
1173
|
/**
|
|
1174
|
-
* @public
|
|
1175
1174
|
* <p>The string to specify as <code>nextToken</code> when you request the next page of results. </p>
|
|
1175
|
+
* @public
|
|
1176
1176
|
*/
|
|
1177
1177
|
nextToken?: string;
|
|
1178
1178
|
}
|
|
@@ -1181,8 +1181,8 @@ export interface GetSystemTemplateRevisionsResponse {
|
|
|
1181
1181
|
*/
|
|
1182
1182
|
export interface GetUploadStatusRequest {
|
|
1183
1183
|
/**
|
|
1184
|
-
* @public
|
|
1185
1184
|
* <p>The ID of the upload. This value is returned by the <code>UploadEntityDefinitions</code> action.</p>
|
|
1185
|
+
* @public
|
|
1186
1186
|
*/
|
|
1187
1187
|
uploadId: string | undefined;
|
|
1188
1188
|
}
|
|
@@ -1204,38 +1204,38 @@ export type UploadStatus = (typeof UploadStatus)[keyof typeof UploadStatus];
|
|
|
1204
1204
|
*/
|
|
1205
1205
|
export interface GetUploadStatusResponse {
|
|
1206
1206
|
/**
|
|
1207
|
-
* @public
|
|
1208
1207
|
* <p>The ID of the upload.</p>
|
|
1208
|
+
* @public
|
|
1209
1209
|
*/
|
|
1210
1210
|
uploadId: string | undefined;
|
|
1211
1211
|
/**
|
|
1212
|
-
* @public
|
|
1213
1212
|
* <p>The status of the upload. The initial status is <code>IN_PROGRESS</code>. The response show all validation failures if the upload fails.</p>
|
|
1213
|
+
* @public
|
|
1214
1214
|
*/
|
|
1215
1215
|
uploadStatus: UploadStatus | undefined;
|
|
1216
1216
|
/**
|
|
1217
|
-
* @public
|
|
1218
1217
|
* <p>The ARN of the upload.</p>
|
|
1218
|
+
* @public
|
|
1219
1219
|
*/
|
|
1220
1220
|
namespaceArn?: string;
|
|
1221
1221
|
/**
|
|
1222
|
-
* @public
|
|
1223
1222
|
* <p>The name of the upload's namespace.</p>
|
|
1223
|
+
* @public
|
|
1224
1224
|
*/
|
|
1225
1225
|
namespaceName?: string;
|
|
1226
1226
|
/**
|
|
1227
|
-
* @public
|
|
1228
1227
|
* <p>The version of the user's namespace. Defaults to the latest version of the user's namespace.</p>
|
|
1228
|
+
* @public
|
|
1229
1229
|
*/
|
|
1230
1230
|
namespaceVersion?: number;
|
|
1231
1231
|
/**
|
|
1232
|
-
* @public
|
|
1233
1232
|
* <p>The reason for an upload failure.</p>
|
|
1233
|
+
* @public
|
|
1234
1234
|
*/
|
|
1235
1235
|
failureReason?: string[];
|
|
1236
1236
|
/**
|
|
1237
|
-
* @public
|
|
1238
1237
|
* <p>The date at which the upload was created.</p>
|
|
1238
|
+
* @public
|
|
1239
1239
|
*/
|
|
1240
1240
|
createdDate: Date | undefined;
|
|
1241
1241
|
}
|
|
@@ -1244,18 +1244,18 @@ export interface GetUploadStatusResponse {
|
|
|
1244
1244
|
*/
|
|
1245
1245
|
export interface ListFlowExecutionMessagesRequest {
|
|
1246
1246
|
/**
|
|
1247
|
-
* @public
|
|
1248
1247
|
* <p>The ID of the flow execution.</p>
|
|
1248
|
+
* @public
|
|
1249
1249
|
*/
|
|
1250
1250
|
flowExecutionId: string | undefined;
|
|
1251
1251
|
/**
|
|
1252
|
-
* @public
|
|
1253
1252
|
* <p>The string that specifies the next page of results. Use this when you're paginating results.</p>
|
|
1253
|
+
* @public
|
|
1254
1254
|
*/
|
|
1255
1255
|
nextToken?: string;
|
|
1256
1256
|
/**
|
|
1257
|
-
* @public
|
|
1258
1257
|
* <p>The maximum number of results to return in the response.</p>
|
|
1258
|
+
* @public
|
|
1259
1259
|
*/
|
|
1260
1260
|
maxResults?: number;
|
|
1261
1261
|
}
|
|
@@ -1264,13 +1264,13 @@ export interface ListFlowExecutionMessagesRequest {
|
|
|
1264
1264
|
*/
|
|
1265
1265
|
export interface ListFlowExecutionMessagesResponse {
|
|
1266
1266
|
/**
|
|
1267
|
-
* @public
|
|
1268
1267
|
* <p>A list of objects that contain information about events in the specified flow execution.</p>
|
|
1268
|
+
* @public
|
|
1269
1269
|
*/
|
|
1270
1270
|
messages?: FlowExecutionMessage[];
|
|
1271
1271
|
/**
|
|
1272
|
-
* @public
|
|
1273
1272
|
* <p>The string to specify as <code>nextToken</code> when you request the next page of results. </p>
|
|
1273
|
+
* @public
|
|
1274
1274
|
*/
|
|
1275
1275
|
nextToken?: string;
|
|
1276
1276
|
}
|
|
@@ -1279,18 +1279,18 @@ export interface ListFlowExecutionMessagesResponse {
|
|
|
1279
1279
|
*/
|
|
1280
1280
|
export interface ListTagsForResourceRequest {
|
|
1281
1281
|
/**
|
|
1282
|
-
* @public
|
|
1283
1282
|
* <p>The maximum number of tags to return.</p>
|
|
1283
|
+
* @public
|
|
1284
1284
|
*/
|
|
1285
1285
|
maxResults?: number;
|
|
1286
1286
|
/**
|
|
1287
|
-
* @public
|
|
1288
1287
|
* <p>The Amazon Resource Name (ARN) of the resource whose tags are to be returned.</p>
|
|
1288
|
+
* @public
|
|
1289
1289
|
*/
|
|
1290
1290
|
resourceArn: string | undefined;
|
|
1291
1291
|
/**
|
|
1292
|
-
* @public
|
|
1293
1292
|
* <p>The token that specifies the next page of results to return.</p>
|
|
1293
|
+
* @public
|
|
1294
1294
|
*/
|
|
1295
1295
|
nextToken?: string;
|
|
1296
1296
|
}
|
|
@@ -1299,13 +1299,13 @@ export interface ListTagsForResourceRequest {
|
|
|
1299
1299
|
*/
|
|
1300
1300
|
export interface ListTagsForResourceResponse {
|
|
1301
1301
|
/**
|
|
1302
|
-
* @public
|
|
1303
1302
|
* <p>List of tags returned by the <code>ListTagsForResource</code> operation.</p>
|
|
1303
|
+
* @public
|
|
1304
1304
|
*/
|
|
1305
1305
|
tags?: Tag[];
|
|
1306
1306
|
/**
|
|
1307
|
-
* @public
|
|
1308
1307
|
* <p>The token that specifies the next page of results to return.</p>
|
|
1308
|
+
* @public
|
|
1309
1309
|
*/
|
|
1310
1310
|
nextToken?: string;
|
|
1311
1311
|
}
|
|
@@ -1314,32 +1314,32 @@ export interface ListTagsForResourceResponse {
|
|
|
1314
1314
|
*/
|
|
1315
1315
|
export interface SearchEntitiesRequest {
|
|
1316
1316
|
/**
|
|
1317
|
-
* @public
|
|
1318
1317
|
* <p>The entity types for which to search.</p>
|
|
1318
|
+
* @public
|
|
1319
1319
|
*/
|
|
1320
1320
|
entityTypes: EntityType[] | undefined;
|
|
1321
1321
|
/**
|
|
1322
|
-
* @public
|
|
1323
1322
|
* <p>Optional filter to apply to the search. Valid filters are <code>NAME</code>
|
|
1324
1323
|
* <code>NAMESPACE</code>, <code>SEMANTIC_TYPE_PATH</code> and <code>REFERENCED_ENTITY_ID</code>.
|
|
1325
1324
|
* <code>REFERENCED_ENTITY_ID</code> filters on entities that are used by the entity in the result set. For example,
|
|
1326
1325
|
* you can filter on the ID of a property that is used in a state.</p>
|
|
1327
1326
|
* <p>Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.</p>
|
|
1327
|
+
* @public
|
|
1328
1328
|
*/
|
|
1329
1329
|
filters?: EntityFilter[];
|
|
1330
1330
|
/**
|
|
1331
|
-
* @public
|
|
1332
1331
|
* <p>The string that specifies the next page of results. Use this when you're paginating results.</p>
|
|
1332
|
+
* @public
|
|
1333
1333
|
*/
|
|
1334
1334
|
nextToken?: string;
|
|
1335
1335
|
/**
|
|
1336
|
-
* @public
|
|
1337
1336
|
* <p>The maximum number of results to return in the response.</p>
|
|
1337
|
+
* @public
|
|
1338
1338
|
*/
|
|
1339
1339
|
maxResults?: number;
|
|
1340
1340
|
/**
|
|
1341
|
-
* @public
|
|
1342
1341
|
* <p>The version of the user's namespace. Defaults to the latest version of the user's namespace.</p>
|
|
1342
|
+
* @public
|
|
1343
1343
|
*/
|
|
1344
1344
|
namespaceVersion?: number;
|
|
1345
1345
|
}
|
|
@@ -1348,13 +1348,13 @@ export interface SearchEntitiesRequest {
|
|
|
1348
1348
|
*/
|
|
1349
1349
|
export interface SearchEntitiesResponse {
|
|
1350
1350
|
/**
|
|
1351
|
-
* @public
|
|
1352
1351
|
* <p>An array of descriptions for each entity returned in the search result.</p>
|
|
1352
|
+
* @public
|
|
1353
1353
|
*/
|
|
1354
1354
|
descriptions?: EntityDescription[];
|
|
1355
1355
|
/**
|
|
1356
|
-
* @public
|
|
1357
1356
|
* <p>The string to specify as <code>nextToken</code> when you request the next page of results.</p>
|
|
1357
|
+
* @public
|
|
1358
1358
|
*/
|
|
1359
1359
|
nextToken?: string;
|
|
1360
1360
|
}
|
|
@@ -1363,33 +1363,33 @@ export interface SearchEntitiesResponse {
|
|
|
1363
1363
|
*/
|
|
1364
1364
|
export interface SearchFlowExecutionsRequest {
|
|
1365
1365
|
/**
|
|
1366
|
-
* @public
|
|
1367
1366
|
* <p>The ID of the system instance that contains the flow.</p>
|
|
1367
|
+
* @public
|
|
1368
1368
|
*/
|
|
1369
1369
|
systemInstanceId: string | undefined;
|
|
1370
1370
|
/**
|
|
1371
|
-
* @public
|
|
1372
1371
|
* <p>The ID of a flow execution.</p>
|
|
1372
|
+
* @public
|
|
1373
1373
|
*/
|
|
1374
1374
|
flowExecutionId?: string;
|
|
1375
1375
|
/**
|
|
1376
|
-
* @public
|
|
1377
1376
|
* <p>The date and time of the earliest flow execution to return.</p>
|
|
1377
|
+
* @public
|
|
1378
1378
|
*/
|
|
1379
1379
|
startTime?: Date;
|
|
1380
1380
|
/**
|
|
1381
|
-
* @public
|
|
1382
1381
|
* <p>The date and time of the latest flow execution to return.</p>
|
|
1382
|
+
* @public
|
|
1383
1383
|
*/
|
|
1384
1384
|
endTime?: Date;
|
|
1385
1385
|
/**
|
|
1386
|
-
* @public
|
|
1387
1386
|
* <p>The string that specifies the next page of results. Use this when you're paginating results.</p>
|
|
1387
|
+
* @public
|
|
1388
1388
|
*/
|
|
1389
1389
|
nextToken?: string;
|
|
1390
1390
|
/**
|
|
1391
|
-
* @public
|
|
1392
1391
|
* <p>The maximum number of results to return in the response.</p>
|
|
1392
|
+
* @public
|
|
1393
1393
|
*/
|
|
1394
1394
|
maxResults?: number;
|
|
1395
1395
|
}
|
|
@@ -1398,13 +1398,13 @@ export interface SearchFlowExecutionsRequest {
|
|
|
1398
1398
|
*/
|
|
1399
1399
|
export interface SearchFlowExecutionsResponse {
|
|
1400
1400
|
/**
|
|
1401
|
-
* @public
|
|
1402
1401
|
* <p>An array of objects that contain summary information about each workflow execution in the result set.</p>
|
|
1402
|
+
* @public
|
|
1403
1403
|
*/
|
|
1404
1404
|
summaries?: FlowExecutionSummary[];
|
|
1405
1405
|
/**
|
|
1406
|
-
* @public
|
|
1407
1406
|
* <p>The string to specify as <code>nextToken</code> when you request the next page of results.</p>
|
|
1407
|
+
* @public
|
|
1408
1408
|
*/
|
|
1409
1409
|
nextToken?: string;
|
|
1410
1410
|
}
|
|
@@ -1413,18 +1413,18 @@ export interface SearchFlowExecutionsResponse {
|
|
|
1413
1413
|
*/
|
|
1414
1414
|
export interface SearchFlowTemplatesRequest {
|
|
1415
1415
|
/**
|
|
1416
|
-
* @public
|
|
1417
1416
|
* <p>An array of objects that limit the result set. The only valid filter is <code>DEVICE_MODEL_ID</code>.</p>
|
|
1417
|
+
* @public
|
|
1418
1418
|
*/
|
|
1419
1419
|
filters?: FlowTemplateFilter[];
|
|
1420
1420
|
/**
|
|
1421
|
-
* @public
|
|
1422
1421
|
* <p>The string that specifies the next page of results. Use this when you're paginating results.</p>
|
|
1422
|
+
* @public
|
|
1423
1423
|
*/
|
|
1424
1424
|
nextToken?: string;
|
|
1425
1425
|
/**
|
|
1426
|
-
* @public
|
|
1427
1426
|
* <p>The maximum number of results to return in the response.</p>
|
|
1427
|
+
* @public
|
|
1428
1428
|
*/
|
|
1429
1429
|
maxResults?: number;
|
|
1430
1430
|
}
|
|
@@ -1433,13 +1433,13 @@ export interface SearchFlowTemplatesRequest {
|
|
|
1433
1433
|
*/
|
|
1434
1434
|
export interface SearchFlowTemplatesResponse {
|
|
1435
1435
|
/**
|
|
1436
|
-
* @public
|
|
1437
1436
|
* <p>An array of objects that contain summary information about each workflow in the result set.</p>
|
|
1437
|
+
* @public
|
|
1438
1438
|
*/
|
|
1439
1439
|
summaries?: FlowTemplateSummary[];
|
|
1440
1440
|
/**
|
|
1441
|
-
* @public
|
|
1442
1441
|
* <p>The string to specify as <code>nextToken</code> when you request the next page of results.</p>
|
|
1442
|
+
* @public
|
|
1443
1443
|
*/
|
|
1444
1444
|
nextToken?: string;
|
|
1445
1445
|
}
|
|
@@ -1457,20 +1457,20 @@ export declare const SystemInstanceFilterName: {
|
|
|
1457
1457
|
*/
|
|
1458
1458
|
export type SystemInstanceFilterName = (typeof SystemInstanceFilterName)[keyof typeof SystemInstanceFilterName];
|
|
1459
1459
|
/**
|
|
1460
|
-
* @public
|
|
1461
1460
|
* <p>An object that filters a system instance search.
|
|
1462
1461
|
* Multiple filters function as OR criteria in the search. For example a search that includes a GREENGRASS_GROUP_NAME and a
|
|
1463
1462
|
* STATUS filter searches for system instances in the specified Greengrass group that have the specified status.</p>
|
|
1463
|
+
* @public
|
|
1464
1464
|
*/
|
|
1465
1465
|
export interface SystemInstanceFilter {
|
|
1466
1466
|
/**
|
|
1467
|
-
* @public
|
|
1468
1467
|
* <p>The name of the search filter field.</p>
|
|
1468
|
+
* @public
|
|
1469
1469
|
*/
|
|
1470
1470
|
name?: SystemInstanceFilterName;
|
|
1471
1471
|
/**
|
|
1472
|
-
* @public
|
|
1473
1472
|
* <p>An array of string values for the search filter field. Multiple values function as AND criteria in the search. </p>
|
|
1473
|
+
* @public
|
|
1474
1474
|
*/
|
|
1475
1475
|
value?: string[];
|
|
1476
1476
|
}
|
|
@@ -1479,20 +1479,20 @@ export interface SystemInstanceFilter {
|
|
|
1479
1479
|
*/
|
|
1480
1480
|
export interface SearchSystemInstancesRequest {
|
|
1481
1481
|
/**
|
|
1482
|
-
* @public
|
|
1483
1482
|
* <p>Optional filter to apply to the search. Valid filters are <code>SYSTEM_TEMPLATE_ID</code>, <code>STATUS</code>, and
|
|
1484
1483
|
* <code>GREENGRASS_GROUP_NAME</code>.</p>
|
|
1485
1484
|
* <p>Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.</p>
|
|
1485
|
+
* @public
|
|
1486
1486
|
*/
|
|
1487
1487
|
filters?: SystemInstanceFilter[];
|
|
1488
1488
|
/**
|
|
1489
|
-
* @public
|
|
1490
1489
|
* <p>The string that specifies the next page of results. Use this when you're paginating results.</p>
|
|
1490
|
+
* @public
|
|
1491
1491
|
*/
|
|
1492
1492
|
nextToken?: string;
|
|
1493
1493
|
/**
|
|
1494
|
-
* @public
|
|
1495
1494
|
* <p>The maximum number of results to return in the response.</p>
|
|
1495
|
+
* @public
|
|
1496
1496
|
*/
|
|
1497
1497
|
maxResults?: number;
|
|
1498
1498
|
}
|
|
@@ -1501,13 +1501,13 @@ export interface SearchSystemInstancesRequest {
|
|
|
1501
1501
|
*/
|
|
1502
1502
|
export interface SearchSystemInstancesResponse {
|
|
1503
1503
|
/**
|
|
1504
|
-
* @public
|
|
1505
1504
|
* <p>An array of objects that contain summary data abour the system instances in the result set.</p>
|
|
1505
|
+
* @public
|
|
1506
1506
|
*/
|
|
1507
1507
|
summaries?: SystemInstanceSummary[];
|
|
1508
1508
|
/**
|
|
1509
|
-
* @public
|
|
1510
1509
|
* <p>The string to specify as <code>nextToken</code> when you request the next page of results. </p>
|
|
1510
|
+
* @public
|
|
1511
1511
|
*/
|
|
1512
1512
|
nextToken?: string;
|
|
1513
1513
|
}
|
|
@@ -1523,18 +1523,18 @@ export declare const SystemTemplateFilterName: {
|
|
|
1523
1523
|
*/
|
|
1524
1524
|
export type SystemTemplateFilterName = (typeof SystemTemplateFilterName)[keyof typeof SystemTemplateFilterName];
|
|
1525
1525
|
/**
|
|
1526
|
-
* @public
|
|
1527
1526
|
* <p>An object that filters a system search.</p>
|
|
1527
|
+
* @public
|
|
1528
1528
|
*/
|
|
1529
1529
|
export interface SystemTemplateFilter {
|
|
1530
1530
|
/**
|
|
1531
|
-
* @public
|
|
1532
1531
|
* <p>The name of the system search filter field.</p>
|
|
1532
|
+
* @public
|
|
1533
1533
|
*/
|
|
1534
1534
|
name: SystemTemplateFilterName | undefined;
|
|
1535
1535
|
/**
|
|
1536
|
-
* @public
|
|
1537
1536
|
* <p>An array of string values for the search filter field. Multiple values function as AND criteria in the search.</p>
|
|
1537
|
+
* @public
|
|
1538
1538
|
*/
|
|
1539
1539
|
value: string[] | undefined;
|
|
1540
1540
|
}
|
|
@@ -1543,18 +1543,18 @@ export interface SystemTemplateFilter {
|
|
|
1543
1543
|
*/
|
|
1544
1544
|
export interface SearchSystemTemplatesRequest {
|
|
1545
1545
|
/**
|
|
1546
|
-
* @public
|
|
1547
1546
|
* <p>An array of filters that limit the result set. The only valid filter is <code>FLOW_TEMPLATE_ID</code>.</p>
|
|
1547
|
+
* @public
|
|
1548
1548
|
*/
|
|
1549
1549
|
filters?: SystemTemplateFilter[];
|
|
1550
1550
|
/**
|
|
1551
|
-
* @public
|
|
1552
1551
|
* <p>The string that specifies the next page of results. Use this when you're paginating results.</p>
|
|
1552
|
+
* @public
|
|
1553
1553
|
*/
|
|
1554
1554
|
nextToken?: string;
|
|
1555
1555
|
/**
|
|
1556
|
-
* @public
|
|
1557
1556
|
* <p>The maximum number of results to return in the response.</p>
|
|
1557
|
+
* @public
|
|
1558
1558
|
*/
|
|
1559
1559
|
maxResults?: number;
|
|
1560
1560
|
}
|
|
@@ -1563,13 +1563,13 @@ export interface SearchSystemTemplatesRequest {
|
|
|
1563
1563
|
*/
|
|
1564
1564
|
export interface SearchSystemTemplatesResponse {
|
|
1565
1565
|
/**
|
|
1566
|
-
* @public
|
|
1567
1566
|
* <p>An array of objects that contain summary information about each system deployment in the result set.</p>
|
|
1567
|
+
* @public
|
|
1568
1568
|
*/
|
|
1569
1569
|
summaries?: SystemTemplateSummary[];
|
|
1570
1570
|
/**
|
|
1571
|
-
* @public
|
|
1572
1571
|
* <p>The string to specify as <code>nextToken</code> when you request the next page of results.</p>
|
|
1572
|
+
* @public
|
|
1573
1573
|
*/
|
|
1574
1574
|
nextToken?: string;
|
|
1575
1575
|
}
|
|
@@ -1578,43 +1578,43 @@ export interface SearchSystemTemplatesResponse {
|
|
|
1578
1578
|
*/
|
|
1579
1579
|
export interface SearchThingsRequest {
|
|
1580
1580
|
/**
|
|
1581
|
-
* @public
|
|
1582
1581
|
* <p>The ID of the entity to which the things are associated.</p>
|
|
1583
1582
|
* <p>The IDs should be in the following format.</p>
|
|
1584
1583
|
* <p>
|
|
1585
1584
|
* <code>urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME</code>
|
|
1586
1585
|
* </p>
|
|
1586
|
+
* @public
|
|
1587
1587
|
*/
|
|
1588
1588
|
entityId: string | undefined;
|
|
1589
1589
|
/**
|
|
1590
|
-
* @public
|
|
1591
1590
|
* <p>The string that specifies the next page of results. Use this when you're paginating results.</p>
|
|
1591
|
+
* @public
|
|
1592
1592
|
*/
|
|
1593
1593
|
nextToken?: string;
|
|
1594
1594
|
/**
|
|
1595
|
-
* @public
|
|
1596
1595
|
* <p>The maximum number of results to return in the response.</p>
|
|
1596
|
+
* @public
|
|
1597
1597
|
*/
|
|
1598
1598
|
maxResults?: number;
|
|
1599
1599
|
/**
|
|
1600
|
-
* @public
|
|
1601
1600
|
* <p>The version of the user's namespace. Defaults to the latest version of the user's namespace.</p>
|
|
1601
|
+
* @public
|
|
1602
1602
|
*/
|
|
1603
1603
|
namespaceVersion?: number;
|
|
1604
1604
|
}
|
|
1605
1605
|
/**
|
|
1606
|
-
* @public
|
|
1607
1606
|
* <p>An AWS IoT thing.</p>
|
|
1607
|
+
* @public
|
|
1608
1608
|
*/
|
|
1609
1609
|
export interface Thing {
|
|
1610
1610
|
/**
|
|
1611
|
-
* @public
|
|
1612
1611
|
* <p>The ARN of the thing.</p>
|
|
1612
|
+
* @public
|
|
1613
1613
|
*/
|
|
1614
1614
|
thingArn?: string;
|
|
1615
1615
|
/**
|
|
1616
|
-
* @public
|
|
1617
1616
|
* <p>The name of the thing.</p>
|
|
1617
|
+
* @public
|
|
1618
1618
|
*/
|
|
1619
1619
|
thingName?: string;
|
|
1620
1620
|
}
|
|
@@ -1623,13 +1623,13 @@ export interface Thing {
|
|
|
1623
1623
|
*/
|
|
1624
1624
|
export interface SearchThingsResponse {
|
|
1625
1625
|
/**
|
|
1626
|
-
* @public
|
|
1627
1626
|
* <p>An array of things in the result set.</p>
|
|
1627
|
+
* @public
|
|
1628
1628
|
*/
|
|
1629
1629
|
things?: Thing[];
|
|
1630
1630
|
/**
|
|
1631
|
-
* @public
|
|
1632
1631
|
* <p>The string to specify as <code>nextToken</code> when you request the next page of results.</p>
|
|
1632
|
+
* @public
|
|
1633
1633
|
*/
|
|
1634
1634
|
nextToken?: string;
|
|
1635
1635
|
}
|
|
@@ -1638,13 +1638,13 @@ export interface SearchThingsResponse {
|
|
|
1638
1638
|
*/
|
|
1639
1639
|
export interface TagResourceRequest {
|
|
1640
1640
|
/**
|
|
1641
|
-
* @public
|
|
1642
1641
|
* <p>The Amazon Resource Name (ARN) of the resource whose tags are returned.</p>
|
|
1642
|
+
* @public
|
|
1643
1643
|
*/
|
|
1644
1644
|
resourceArn: string | undefined;
|
|
1645
1645
|
/**
|
|
1646
|
-
* @public
|
|
1647
1646
|
* <p>A list of tags to add to the resource.></p>
|
|
1647
|
+
* @public
|
|
1648
1648
|
*/
|
|
1649
1649
|
tags: Tag[] | undefined;
|
|
1650
1650
|
}
|
|
@@ -1658,8 +1658,8 @@ export interface TagResourceResponse {
|
|
|
1658
1658
|
*/
|
|
1659
1659
|
export interface UndeploySystemInstanceRequest {
|
|
1660
1660
|
/**
|
|
1661
|
-
* @public
|
|
1662
1661
|
* <p>The ID of the system instance to remove from its target.</p>
|
|
1662
|
+
* @public
|
|
1663
1663
|
*/
|
|
1664
1664
|
id?: string;
|
|
1665
1665
|
}
|
|
@@ -1668,8 +1668,8 @@ export interface UndeploySystemInstanceRequest {
|
|
|
1668
1668
|
*/
|
|
1669
1669
|
export interface UndeploySystemInstanceResponse {
|
|
1670
1670
|
/**
|
|
1671
|
-
* @public
|
|
1672
1671
|
* <p>An object that contains summary information about the system instance that was removed from its target.</p>
|
|
1672
|
+
* @public
|
|
1673
1673
|
*/
|
|
1674
1674
|
summary?: SystemInstanceSummary;
|
|
1675
1675
|
}
|
|
@@ -1678,14 +1678,14 @@ export interface UndeploySystemInstanceResponse {
|
|
|
1678
1678
|
*/
|
|
1679
1679
|
export interface UntagResourceRequest {
|
|
1680
1680
|
/**
|
|
1681
|
-
* @public
|
|
1682
1681
|
* <p>The Amazon Resource Name (ARN) of the resource whose tags are to be removed.</p>
|
|
1682
|
+
* @public
|
|
1683
1683
|
*/
|
|
1684
1684
|
resourceArn: string | undefined;
|
|
1685
1685
|
/**
|
|
1686
|
-
* @public
|
|
1687
1686
|
* <p>A list of tag key names to remove from the resource. You don't specify the value. Both the key and its associated value are removed. </p>
|
|
1688
1687
|
* <p>This parameter to the API requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html#cli-using-param-json">Using JSON for Parameters</a> in the <i>AWS CLI User Guide</i>. </p>
|
|
1688
|
+
* @public
|
|
1689
1689
|
*/
|
|
1690
1690
|
tagKeys: string[] | undefined;
|
|
1691
1691
|
}
|
|
@@ -1699,24 +1699,24 @@ export interface UntagResourceResponse {
|
|
|
1699
1699
|
*/
|
|
1700
1700
|
export interface UpdateFlowTemplateRequest {
|
|
1701
1701
|
/**
|
|
1702
|
-
* @public
|
|
1703
1702
|
* <p>The ID of the workflow to be updated.</p>
|
|
1704
1703
|
* <p>The ID should be in the following format.</p>
|
|
1705
1704
|
* <p>
|
|
1706
1705
|
* <code>urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME</code>
|
|
1707
1706
|
* </p>
|
|
1707
|
+
* @public
|
|
1708
1708
|
*/
|
|
1709
1709
|
id: string | undefined;
|
|
1710
1710
|
/**
|
|
1711
|
-
* @public
|
|
1712
1711
|
* <p>The <code>DefinitionDocument</code> that contains the updated workflow definition.</p>
|
|
1712
|
+
* @public
|
|
1713
1713
|
*/
|
|
1714
1714
|
definition: DefinitionDocument | undefined;
|
|
1715
1715
|
/**
|
|
1716
|
-
* @public
|
|
1717
1716
|
* <p>The version of the user's namespace.</p>
|
|
1718
1717
|
* <p>If no value is specified, the latest version is used by default. Use the <code>GetFlowTemplateRevisions</code> if you want to find earlier revisions of the flow
|
|
1719
1718
|
* to update.</p>
|
|
1719
|
+
* @public
|
|
1720
1720
|
*/
|
|
1721
1721
|
compatibleNamespaceVersion?: number;
|
|
1722
1722
|
}
|
|
@@ -1725,8 +1725,8 @@ export interface UpdateFlowTemplateRequest {
|
|
|
1725
1725
|
*/
|
|
1726
1726
|
export interface UpdateFlowTemplateResponse {
|
|
1727
1727
|
/**
|
|
1728
|
-
* @public
|
|
1729
1728
|
* <p>An object containing summary information about the updated workflow.</p>
|
|
1729
|
+
* @public
|
|
1730
1730
|
*/
|
|
1731
1731
|
summary?: FlowTemplateSummary;
|
|
1732
1732
|
}
|
|
@@ -1735,23 +1735,23 @@ export interface UpdateFlowTemplateResponse {
|
|
|
1735
1735
|
*/
|
|
1736
1736
|
export interface UpdateSystemTemplateRequest {
|
|
1737
1737
|
/**
|
|
1738
|
-
* @public
|
|
1739
1738
|
* <p>The ID of the system to be updated.</p>
|
|
1740
1739
|
* <p>The ID should be in the following format.</p>
|
|
1741
1740
|
* <p>
|
|
1742
1741
|
* <code>urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME</code>
|
|
1743
1742
|
* </p>
|
|
1743
|
+
* @public
|
|
1744
1744
|
*/
|
|
1745
1745
|
id: string | undefined;
|
|
1746
1746
|
/**
|
|
1747
|
-
* @public
|
|
1748
1747
|
* <p>The <code>DefinitionDocument</code> that contains the updated system definition.</p>
|
|
1748
|
+
* @public
|
|
1749
1749
|
*/
|
|
1750
1750
|
definition: DefinitionDocument | undefined;
|
|
1751
1751
|
/**
|
|
1752
|
-
* @public
|
|
1753
1752
|
* <p>The version of the user's namespace. Defaults to the latest version of the user's namespace.</p>
|
|
1754
1753
|
* <p>If no value is specified, the latest version is used by default.</p>
|
|
1754
|
+
* @public
|
|
1755
1755
|
*/
|
|
1756
1756
|
compatibleNamespaceVersion?: number;
|
|
1757
1757
|
}
|
|
@@ -1760,8 +1760,8 @@ export interface UpdateSystemTemplateRequest {
|
|
|
1760
1760
|
*/
|
|
1761
1761
|
export interface UpdateSystemTemplateResponse {
|
|
1762
1762
|
/**
|
|
1763
|
-
* @public
|
|
1764
1763
|
* <p>An object containing summary information about the updated system.</p>
|
|
1764
|
+
* @public
|
|
1765
1765
|
*/
|
|
1766
1766
|
summary?: SystemTemplateSummary;
|
|
1767
1767
|
}
|
|
@@ -1770,19 +1770,19 @@ export interface UpdateSystemTemplateResponse {
|
|
|
1770
1770
|
*/
|
|
1771
1771
|
export interface UploadEntityDefinitionsRequest {
|
|
1772
1772
|
/**
|
|
1773
|
-
* @public
|
|
1774
1773
|
* <p>The <code>DefinitionDocument</code> that defines the updated entities.</p>
|
|
1774
|
+
* @public
|
|
1775
1775
|
*/
|
|
1776
1776
|
document?: DefinitionDocument;
|
|
1777
1777
|
/**
|
|
1778
|
-
* @public
|
|
1779
1778
|
* <p>A Boolean that specifies whether to synchronize with the latest version of the public namespace. If set to <code>true</code>, the upload will create a new namespace version.</p>
|
|
1779
|
+
* @public
|
|
1780
1780
|
*/
|
|
1781
1781
|
syncWithPublicNamespace?: boolean;
|
|
1782
1782
|
/**
|
|
1783
|
-
* @public
|
|
1784
1783
|
* <p>A Boolean that specifies whether to deprecate all entities in the latest version before uploading the new <code>DefinitionDocument</code>.
|
|
1785
1784
|
* If set to <code>true</code>, the upload will create a new namespace version.</p>
|
|
1785
|
+
* @public
|
|
1786
1786
|
*/
|
|
1787
1787
|
deprecateExistingEntities?: boolean;
|
|
1788
1788
|
}
|
|
@@ -1791,8 +1791,8 @@ export interface UploadEntityDefinitionsRequest {
|
|
|
1791
1791
|
*/
|
|
1792
1792
|
export interface UploadEntityDefinitionsResponse {
|
|
1793
1793
|
/**
|
|
1794
|
-
* @public
|
|
1795
1794
|
* <p>The ID that specifies the upload action. You can use this to track the status of the upload.</p>
|
|
1795
|
+
* @public
|
|
1796
1796
|
*/
|
|
1797
1797
|
uploadId: string | undefined;
|
|
1798
1798
|
}
|