@aws-sdk/client-greengrassv2 3.529.1 → 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/GreengrassV2.d.ts +8 -1
- package/dist-types/GreengrassV2Client.d.ts +1 -1
- package/dist-types/commands/AssociateServiceRoleToAccountCommand.d.ts +2 -1
- package/dist-types/commands/BatchAssociateClientDeviceWithCoreDeviceCommand.d.ts +2 -1
- package/dist-types/commands/BatchDisassociateClientDeviceFromCoreDeviceCommand.d.ts +2 -1
- package/dist-types/commands/CancelDeploymentCommand.d.ts +2 -1
- package/dist-types/commands/CreateComponentVersionCommand.d.ts +3 -2
- package/dist-types/commands/CreateDeploymentCommand.d.ts +2 -1
- package/dist-types/commands/DeleteComponentCommand.d.ts +2 -1
- package/dist-types/commands/DeleteCoreDeviceCommand.d.ts +2 -1
- package/dist-types/commands/DeleteDeploymentCommand.d.ts +2 -1
- package/dist-types/commands/DescribeComponentCommand.d.ts +2 -1
- package/dist-types/commands/DisassociateServiceRoleFromAccountCommand.d.ts +2 -1
- package/dist-types/commands/GetComponentCommand.d.ts +3 -2
- package/dist-types/commands/GetComponentVersionArtifactCommand.d.ts +2 -1
- package/dist-types/commands/GetConnectivityInfoCommand.d.ts +2 -1
- package/dist-types/commands/GetCoreDeviceCommand.d.ts +2 -1
- package/dist-types/commands/GetDeploymentCommand.d.ts +2 -1
- package/dist-types/commands/GetServiceRoleForAccountCommand.d.ts +2 -1
- package/dist-types/commands/ListClientDevicesAssociatedWithCoreDeviceCommand.d.ts +2 -1
- package/dist-types/commands/ListComponentVersionsCommand.d.ts +2 -1
- package/dist-types/commands/ListComponentsCommand.d.ts +2 -1
- package/dist-types/commands/ListCoreDevicesCommand.d.ts +2 -1
- package/dist-types/commands/ListDeploymentsCommand.d.ts +2 -1
- package/dist-types/commands/ListEffectiveDeploymentsCommand.d.ts +2 -1
- package/dist-types/commands/ListInstalledComponentsCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/ResolveComponentCandidatesCommand.d.ts +3 -2
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateConnectivityInfoCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +338 -338
- package/dist-types/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/runtimeConfig.d.ts +2 -2
- package/dist-types/runtimeConfig.native.d.ts +2 -2
- package/dist-types/runtimeConfig.shared.d.ts +2 -2
- package/dist-types/ts3.4/GreengrassV2.d.ts +7 -0
- package/dist-types/ts3.4/commands/AssociateServiceRoleToAccountCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/BatchAssociateClientDeviceWithCoreDeviceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/BatchDisassociateClientDeviceFromCoreDeviceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CancelDeploymentCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateComponentVersionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateDeploymentCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteComponentCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteCoreDeviceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteDeploymentCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeComponentCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisassociateServiceRoleFromAccountCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetComponentCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetComponentVersionArtifactCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetConnectivityInfoCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetCoreDeviceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetDeploymentCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetServiceRoleForAccountCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListClientDevicesAssociatedWithCoreDeviceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListComponentVersionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListComponentsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListCoreDevicesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListDeploymentsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListEffectiveDeploymentsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListInstalledComponentsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ResolveComponentCandidatesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateConnectivityInfoCommand.d.ts +9 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
- package/package.json +40 -40
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { GreengrassV2ServiceException as __BaseException } from "./GreengrassV2ServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>You don't have permission to perform the action.</p>
|
|
5
|
+
* @public
|
|
6
6
|
*/
|
|
7
7
|
export declare class AccessDeniedException extends __BaseException {
|
|
8
8
|
readonly name: "AccessDeniedException";
|
|
@@ -13,54 +13,54 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
13
13
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
|
-
* @public
|
|
17
16
|
* <p>Contains a request to associate a client device with a core device. The <a href="https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchAssociateClientDeviceWithCoreDevice.html">BatchAssociateClientDeviceWithCoreDevice</a> operation consumes a list of these
|
|
18
17
|
* requests.</p>
|
|
18
|
+
* @public
|
|
19
19
|
*/
|
|
20
20
|
export interface AssociateClientDeviceWithCoreDeviceEntry {
|
|
21
21
|
/**
|
|
22
|
-
* @public
|
|
23
22
|
* <p>The name of the IoT thing that represents the client device to associate.</p>
|
|
23
|
+
* @public
|
|
24
24
|
*/
|
|
25
25
|
thingName: string | undefined;
|
|
26
26
|
}
|
|
27
27
|
/**
|
|
28
|
-
* @public
|
|
29
28
|
* <p>Contains an error that occurs from a request to associate a client device with a core
|
|
30
29
|
* device. The <a href="https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchAssociateClientDeviceWithCoreDevice.html">BatchAssociateClientDeviceWithCoreDevice</a> operation returns a list of these
|
|
31
30
|
* errors.</p>
|
|
31
|
+
* @public
|
|
32
32
|
*/
|
|
33
33
|
export interface AssociateClientDeviceWithCoreDeviceErrorEntry {
|
|
34
34
|
/**
|
|
35
|
-
* @public
|
|
36
35
|
* <p>The name of the IoT thing whose associate request failed.</p>
|
|
36
|
+
* @public
|
|
37
37
|
*/
|
|
38
38
|
thingName?: string;
|
|
39
39
|
/**
|
|
40
|
-
* @public
|
|
41
40
|
* <p>The error code for the request.</p>
|
|
41
|
+
* @public
|
|
42
42
|
*/
|
|
43
43
|
code?: string;
|
|
44
44
|
/**
|
|
45
|
-
* @public
|
|
46
45
|
* <p>A message that provides additional information about the error.</p>
|
|
46
|
+
* @public
|
|
47
47
|
*/
|
|
48
48
|
message?: string;
|
|
49
49
|
}
|
|
50
50
|
/**
|
|
51
|
-
* @public
|
|
52
51
|
* <p>Contains information about a client device that is associated to a core device for cloud
|
|
53
52
|
* discovery.</p>
|
|
53
|
+
* @public
|
|
54
54
|
*/
|
|
55
55
|
export interface AssociatedClientDevice {
|
|
56
56
|
/**
|
|
57
|
-
* @public
|
|
58
57
|
* <p>The name of the IoT thing that represents the associated client device.</p>
|
|
58
|
+
* @public
|
|
59
59
|
*/
|
|
60
60
|
thingName?: string;
|
|
61
61
|
/**
|
|
62
|
-
* @public
|
|
63
62
|
* <p>The time that the client device was associated, expressed in ISO 8601 format.</p>
|
|
63
|
+
* @public
|
|
64
64
|
*/
|
|
65
65
|
associationTimestamp?: Date;
|
|
66
66
|
}
|
|
@@ -69,9 +69,9 @@ export interface AssociatedClientDevice {
|
|
|
69
69
|
*/
|
|
70
70
|
export interface AssociateServiceRoleToAccountRequest {
|
|
71
71
|
/**
|
|
72
|
-
* @public
|
|
73
72
|
* <p>The Amazon Resource Name (ARN) of the service role to associate with IoT Greengrass for your
|
|
74
73
|
* Amazon Web Services account in this Amazon Web Services Region.</p>
|
|
74
|
+
* @public
|
|
75
75
|
*/
|
|
76
76
|
roleArn: string | undefined;
|
|
77
77
|
}
|
|
@@ -80,22 +80,22 @@ export interface AssociateServiceRoleToAccountRequest {
|
|
|
80
80
|
*/
|
|
81
81
|
export interface AssociateServiceRoleToAccountResponse {
|
|
82
82
|
/**
|
|
83
|
-
* @public
|
|
84
83
|
* <p>The time when the service role was associated with IoT Greengrass for your Amazon Web Services account in this
|
|
85
84
|
* Amazon Web Services Region.</p>
|
|
85
|
+
* @public
|
|
86
86
|
*/
|
|
87
87
|
associatedAt?: string;
|
|
88
88
|
}
|
|
89
89
|
/**
|
|
90
|
-
* @public
|
|
91
90
|
* <p>IoT Greengrass can't process your request right now. Try again later.</p>
|
|
91
|
+
* @public
|
|
92
92
|
*/
|
|
93
93
|
export declare class InternalServerException extends __BaseException {
|
|
94
94
|
readonly name: "InternalServerException";
|
|
95
95
|
readonly $fault: "server";
|
|
96
96
|
/**
|
|
97
|
-
* @public
|
|
98
97
|
* <p>The amount of time to wait before you retry the request.</p>
|
|
98
|
+
* @public
|
|
99
99
|
*/
|
|
100
100
|
retryAfterSeconds?: number;
|
|
101
101
|
/**
|
|
@@ -104,18 +104,18 @@ export declare class InternalServerException extends __BaseException {
|
|
|
104
104
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
105
105
|
}
|
|
106
106
|
/**
|
|
107
|
-
* @public
|
|
108
107
|
* <p>Contains information about a validation exception field.</p>
|
|
108
|
+
* @public
|
|
109
109
|
*/
|
|
110
110
|
export interface ValidationExceptionField {
|
|
111
111
|
/**
|
|
112
|
-
* @public
|
|
113
112
|
* <p>The name of the exception field.</p>
|
|
113
|
+
* @public
|
|
114
114
|
*/
|
|
115
115
|
name: string | undefined;
|
|
116
116
|
/**
|
|
117
|
-
* @public
|
|
118
117
|
* <p>The message of the exception field.</p>
|
|
118
|
+
* @public
|
|
119
119
|
*/
|
|
120
120
|
message: string | undefined;
|
|
121
121
|
}
|
|
@@ -134,21 +134,21 @@ export declare const ValidationExceptionReason: {
|
|
|
134
134
|
*/
|
|
135
135
|
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
136
136
|
/**
|
|
137
|
-
* @public
|
|
138
137
|
* <p>The request isn't valid. This can occur if your request contains malformed JSON or
|
|
139
138
|
* unsupported characters.</p>
|
|
139
|
+
* @public
|
|
140
140
|
*/
|
|
141
141
|
export declare class ValidationException extends __BaseException {
|
|
142
142
|
readonly name: "ValidationException";
|
|
143
143
|
readonly $fault: "client";
|
|
144
144
|
/**
|
|
145
|
-
* @public
|
|
146
145
|
* <p>The reason for the validation exception.</p>
|
|
146
|
+
* @public
|
|
147
147
|
*/
|
|
148
148
|
reason?: ValidationExceptionReason;
|
|
149
149
|
/**
|
|
150
|
-
* @public
|
|
151
150
|
* <p>The list of fields that failed to validate.</p>
|
|
151
|
+
* @public
|
|
152
152
|
*/
|
|
153
153
|
fields?: ValidationExceptionField[];
|
|
154
154
|
/**
|
|
@@ -161,13 +161,13 @@ export declare class ValidationException extends __BaseException {
|
|
|
161
161
|
*/
|
|
162
162
|
export interface BatchAssociateClientDeviceWithCoreDeviceRequest {
|
|
163
163
|
/**
|
|
164
|
-
* @public
|
|
165
164
|
* <p>The list of client devices to associate.</p>
|
|
165
|
+
* @public
|
|
166
166
|
*/
|
|
167
167
|
entries?: AssociateClientDeviceWithCoreDeviceEntry[];
|
|
168
168
|
/**
|
|
169
|
-
* @public
|
|
170
169
|
* <p>The name of the core device. This is also the name of the IoT thing.</p>
|
|
170
|
+
* @public
|
|
171
171
|
*/
|
|
172
172
|
coreDeviceThingName: string | undefined;
|
|
173
173
|
}
|
|
@@ -176,27 +176,27 @@ export interface BatchAssociateClientDeviceWithCoreDeviceRequest {
|
|
|
176
176
|
*/
|
|
177
177
|
export interface BatchAssociateClientDeviceWithCoreDeviceResponse {
|
|
178
178
|
/**
|
|
179
|
-
* @public
|
|
180
179
|
* <p>The list of any errors for the entries in the request. Each error entry contains the name
|
|
181
180
|
* of the IoT thing that failed to associate.</p>
|
|
181
|
+
* @public
|
|
182
182
|
*/
|
|
183
183
|
errorEntries?: AssociateClientDeviceWithCoreDeviceErrorEntry[];
|
|
184
184
|
}
|
|
185
185
|
/**
|
|
186
|
-
* @public
|
|
187
186
|
* <p>The requested resource can't be found.</p>
|
|
187
|
+
* @public
|
|
188
188
|
*/
|
|
189
189
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
190
190
|
readonly name: "ResourceNotFoundException";
|
|
191
191
|
readonly $fault: "client";
|
|
192
192
|
/**
|
|
193
|
-
* @public
|
|
194
193
|
* <p>The ID of the resource that isn't found.</p>
|
|
194
|
+
* @public
|
|
195
195
|
*/
|
|
196
196
|
resourceId: string | undefined;
|
|
197
197
|
/**
|
|
198
|
-
* @public
|
|
199
198
|
* <p>The type of the resource that isn't found.</p>
|
|
199
|
+
* @public
|
|
200
200
|
*/
|
|
201
201
|
resourceType: string | undefined;
|
|
202
202
|
/**
|
|
@@ -205,26 +205,26 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
205
205
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
206
206
|
}
|
|
207
207
|
/**
|
|
208
|
-
* @public
|
|
209
208
|
* <p>Your request exceeded a request rate quota. For example, you might have exceeded the
|
|
210
209
|
* amount of times that you can retrieve device or deployment status per second.</p>
|
|
210
|
+
* @public
|
|
211
211
|
*/
|
|
212
212
|
export declare class ThrottlingException extends __BaseException {
|
|
213
213
|
readonly name: "ThrottlingException";
|
|
214
214
|
readonly $fault: "client";
|
|
215
215
|
/**
|
|
216
|
-
* @public
|
|
217
216
|
* <p>The code for the quota in <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html">Service Quotas</a>.</p>
|
|
217
|
+
* @public
|
|
218
218
|
*/
|
|
219
219
|
quotaCode?: string;
|
|
220
220
|
/**
|
|
221
|
-
* @public
|
|
222
221
|
* <p>The code for the service in <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html">Service Quotas</a>.</p>
|
|
222
|
+
* @public
|
|
223
223
|
*/
|
|
224
224
|
serviceCode?: string;
|
|
225
225
|
/**
|
|
226
|
-
* @public
|
|
227
226
|
* <p>The amount of time to wait before you retry the request.</p>
|
|
227
|
+
* @public
|
|
228
228
|
*/
|
|
229
229
|
retryAfterSeconds?: number;
|
|
230
230
|
/**
|
|
@@ -233,14 +233,14 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
233
233
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
234
234
|
}
|
|
235
235
|
/**
|
|
236
|
-
* @public
|
|
237
236
|
* <p>Contains a request to disassociate a client device from a core device. The <a href="https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchDisassociateClientDeviceWithCoreDevice.html">BatchDisassociateClientDeviceWithCoreDevice</a> operation consumes a list of these
|
|
238
237
|
* requests.</p>
|
|
238
|
+
* @public
|
|
239
239
|
*/
|
|
240
240
|
export interface DisassociateClientDeviceFromCoreDeviceEntry {
|
|
241
241
|
/**
|
|
242
|
-
* @public
|
|
243
242
|
* <p>The name of the IoT thing that represents the client device to disassociate.</p>
|
|
243
|
+
* @public
|
|
244
244
|
*/
|
|
245
245
|
thingName: string | undefined;
|
|
246
246
|
}
|
|
@@ -249,36 +249,36 @@ export interface DisassociateClientDeviceFromCoreDeviceEntry {
|
|
|
249
249
|
*/
|
|
250
250
|
export interface BatchDisassociateClientDeviceFromCoreDeviceRequest {
|
|
251
251
|
/**
|
|
252
|
-
* @public
|
|
253
252
|
* <p>The list of client devices to disassociate.</p>
|
|
253
|
+
* @public
|
|
254
254
|
*/
|
|
255
255
|
entries?: DisassociateClientDeviceFromCoreDeviceEntry[];
|
|
256
256
|
/**
|
|
257
|
-
* @public
|
|
258
257
|
* <p>The name of the core device. This is also the name of the IoT thing.</p>
|
|
258
|
+
* @public
|
|
259
259
|
*/
|
|
260
260
|
coreDeviceThingName: string | undefined;
|
|
261
261
|
}
|
|
262
262
|
/**
|
|
263
|
-
* @public
|
|
264
263
|
* <p>Contains an error that occurs from a request to disassociate a client device from a core
|
|
265
264
|
* device. The <a href="https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchDisassociateClientDeviceWithCoreDevice.html">BatchDisassociateClientDeviceWithCoreDevice</a> operation returns a list of these
|
|
266
265
|
* errors.</p>
|
|
266
|
+
* @public
|
|
267
267
|
*/
|
|
268
268
|
export interface DisassociateClientDeviceFromCoreDeviceErrorEntry {
|
|
269
269
|
/**
|
|
270
|
-
* @public
|
|
271
270
|
* <p>The name of the IoT thing whose disassociate request failed.</p>
|
|
271
|
+
* @public
|
|
272
272
|
*/
|
|
273
273
|
thingName?: string;
|
|
274
274
|
/**
|
|
275
|
-
* @public
|
|
276
275
|
* <p>The error code for the request.</p>
|
|
276
|
+
* @public
|
|
277
277
|
*/
|
|
278
278
|
code?: string;
|
|
279
279
|
/**
|
|
280
|
-
* @public
|
|
281
280
|
* <p>A message that provides additional information about the error.</p>
|
|
281
|
+
* @public
|
|
282
282
|
*/
|
|
283
283
|
message?: string;
|
|
284
284
|
}
|
|
@@ -287,9 +287,9 @@ export interface DisassociateClientDeviceFromCoreDeviceErrorEntry {
|
|
|
287
287
|
*/
|
|
288
288
|
export interface BatchDisassociateClientDeviceFromCoreDeviceResponse {
|
|
289
289
|
/**
|
|
290
|
-
* @public
|
|
291
290
|
* <p>The list of any errors for the entries in the request. Each error entry contains the name
|
|
292
291
|
* of the IoT thing that failed to disassociate.</p>
|
|
292
|
+
* @public
|
|
293
293
|
*/
|
|
294
294
|
errorEntries?: DisassociateClientDeviceFromCoreDeviceErrorEntry[];
|
|
295
295
|
}
|
|
@@ -298,8 +298,8 @@ export interface BatchDisassociateClientDeviceFromCoreDeviceResponse {
|
|
|
298
298
|
*/
|
|
299
299
|
export interface CancelDeploymentRequest {
|
|
300
300
|
/**
|
|
301
|
-
* @public
|
|
302
301
|
* <p>The ID of the deployment.</p>
|
|
302
|
+
* @public
|
|
303
303
|
*/
|
|
304
304
|
deploymentId: string | undefined;
|
|
305
305
|
}
|
|
@@ -308,27 +308,27 @@ export interface CancelDeploymentRequest {
|
|
|
308
308
|
*/
|
|
309
309
|
export interface CancelDeploymentResponse {
|
|
310
310
|
/**
|
|
311
|
-
* @public
|
|
312
311
|
* <p>A message that communicates if the cancel was successful.</p>
|
|
312
|
+
* @public
|
|
313
313
|
*/
|
|
314
314
|
message?: string;
|
|
315
315
|
}
|
|
316
316
|
/**
|
|
317
|
-
* @public
|
|
318
317
|
* <p>Your request has conflicting operations. This can occur if you're trying to perform more
|
|
319
318
|
* than one operation on the same resource at the same time.</p>
|
|
319
|
+
* @public
|
|
320
320
|
*/
|
|
321
321
|
export declare class ConflictException extends __BaseException {
|
|
322
322
|
readonly name: "ConflictException";
|
|
323
323
|
readonly $fault: "client";
|
|
324
324
|
/**
|
|
325
|
-
* @public
|
|
326
325
|
* <p>The ID of the resource that conflicts with the request.</p>
|
|
326
|
+
* @public
|
|
327
327
|
*/
|
|
328
328
|
resourceId: string | undefined;
|
|
329
329
|
/**
|
|
330
|
-
* @public
|
|
331
330
|
* <p>The type of the resource that conflicts with the request.</p>
|
|
331
|
+
* @public
|
|
332
332
|
*/
|
|
333
333
|
resourceType: string | undefined;
|
|
334
334
|
/**
|
|
@@ -365,31 +365,30 @@ export declare const VendorGuidance: {
|
|
|
365
365
|
*/
|
|
366
366
|
export type VendorGuidance = (typeof VendorGuidance)[keyof typeof VendorGuidance];
|
|
367
367
|
/**
|
|
368
|
-
* @public
|
|
369
368
|
* <p>Contains the status of a component version in the IoT Greengrass service.</p>
|
|
369
|
+
* @public
|
|
370
370
|
*/
|
|
371
371
|
export interface CloudComponentStatus {
|
|
372
372
|
/**
|
|
373
|
-
* @public
|
|
374
373
|
* <p>The state of the component version.</p>
|
|
374
|
+
* @public
|
|
375
375
|
*/
|
|
376
376
|
componentState?: CloudComponentState;
|
|
377
377
|
/**
|
|
378
|
-
* @public
|
|
379
378
|
* <p>A message that communicates details, such as errors, about the status of the component
|
|
380
379
|
* version.</p>
|
|
380
|
+
* @public
|
|
381
381
|
*/
|
|
382
382
|
message?: string;
|
|
383
383
|
/**
|
|
384
|
-
* @public
|
|
385
384
|
* <p>A dictionary of errors that communicate why the component version is in an error state.
|
|
386
385
|
* For example, if IoT Greengrass can't access an artifact for the component version, then
|
|
387
386
|
* <code>errors</code> contains the artifact's URI as a key, and the error message as the value
|
|
388
387
|
* for that key.</p>
|
|
388
|
+
* @public
|
|
389
389
|
*/
|
|
390
390
|
errors?: Record<string, string>;
|
|
391
391
|
/**
|
|
392
|
-
* @public
|
|
393
392
|
* <p>The vendor guidance state for the component version. This state indicates whether
|
|
394
393
|
* the component version has any issues that you should consider before you deploy it. The vendor guidance state can be:</p>
|
|
395
394
|
* <ul>
|
|
@@ -408,127 +407,127 @@ export interface CloudComponentStatus {
|
|
|
408
407
|
* deploy it. If you have any existing deployments that specify this component version, those deployments will fail.</p>
|
|
409
408
|
* </li>
|
|
410
409
|
* </ul>
|
|
410
|
+
* @public
|
|
411
411
|
*/
|
|
412
412
|
vendorGuidance?: VendorGuidance;
|
|
413
413
|
/**
|
|
414
|
-
* @public
|
|
415
414
|
* <p>A message that communicates details about the vendor guidance state
|
|
416
415
|
* of the component version. This message communicates why a component version is discontinued or deleted.</p>
|
|
416
|
+
* @public
|
|
417
417
|
*/
|
|
418
418
|
vendorGuidanceMessage?: string;
|
|
419
419
|
}
|
|
420
420
|
/**
|
|
421
|
-
* @public
|
|
422
421
|
* <p>Contains information about a platform that a component supports.</p>
|
|
422
|
+
* @public
|
|
423
423
|
*/
|
|
424
424
|
export interface ComponentPlatform {
|
|
425
425
|
/**
|
|
426
|
-
* @public
|
|
427
426
|
* <p>The friendly name of the platform. This name helps you identify the platform.</p>
|
|
428
427
|
* <p>If you omit this parameter, IoT Greengrass creates a friendly name from the <code>os</code> and
|
|
429
428
|
* <code>architecture</code> of the platform.</p>
|
|
429
|
+
* @public
|
|
430
430
|
*/
|
|
431
431
|
name?: string;
|
|
432
432
|
/**
|
|
433
|
-
* @public
|
|
434
433
|
* <p>A dictionary of attributes for the platform. The IoT Greengrass Core software defines the
|
|
435
434
|
* <code>os</code> and <code>architecture</code> by default. You can specify additional
|
|
436
435
|
* platform attributes for a core device when you deploy the Greengrass nucleus component. For more
|
|
437
436
|
* information, see the <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html">Greengrass nucleus
|
|
438
437
|
* component</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
|
|
438
|
+
* @public
|
|
439
439
|
*/
|
|
440
440
|
attributes?: Record<string, string>;
|
|
441
441
|
}
|
|
442
442
|
/**
|
|
443
|
-
* @public
|
|
444
443
|
* <p>Contains information about the latest version of a component.</p>
|
|
444
|
+
* @public
|
|
445
445
|
*/
|
|
446
446
|
export interface ComponentLatestVersion {
|
|
447
447
|
/**
|
|
448
|
-
* @public
|
|
449
448
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
|
|
449
|
+
* @public
|
|
450
450
|
*/
|
|
451
451
|
arn?: string;
|
|
452
452
|
/**
|
|
453
|
-
* @public
|
|
454
453
|
* <p>The version of the component.</p>
|
|
454
|
+
* @public
|
|
455
455
|
*/
|
|
456
456
|
componentVersion?: string;
|
|
457
457
|
/**
|
|
458
|
-
* @public
|
|
459
458
|
* <p>The time at which the component was created, expressed in ISO 8601 format.</p>
|
|
459
|
+
* @public
|
|
460
460
|
*/
|
|
461
461
|
creationTimestamp?: Date;
|
|
462
462
|
/**
|
|
463
|
-
* @public
|
|
464
463
|
* <p>The description of the component version.</p>
|
|
464
|
+
* @public
|
|
465
465
|
*/
|
|
466
466
|
description?: string;
|
|
467
467
|
/**
|
|
468
|
-
* @public
|
|
469
468
|
* <p>The publisher of the component version.</p>
|
|
469
|
+
* @public
|
|
470
470
|
*/
|
|
471
471
|
publisher?: string;
|
|
472
472
|
/**
|
|
473
|
-
* @public
|
|
474
473
|
* <p>The platforms that the component version supports.</p>
|
|
474
|
+
* @public
|
|
475
475
|
*/
|
|
476
476
|
platforms?: ComponentPlatform[];
|
|
477
477
|
}
|
|
478
478
|
/**
|
|
479
|
-
* @public
|
|
480
479
|
* <p>Contains information about a component.</p>
|
|
480
|
+
* @public
|
|
481
481
|
*/
|
|
482
482
|
export interface Component {
|
|
483
483
|
/**
|
|
484
|
-
* @public
|
|
485
484
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
|
|
485
|
+
* @public
|
|
486
486
|
*/
|
|
487
487
|
arn?: string;
|
|
488
488
|
/**
|
|
489
|
-
* @public
|
|
490
489
|
* <p>The name of the component.</p>
|
|
490
|
+
* @public
|
|
491
491
|
*/
|
|
492
492
|
componentName?: string;
|
|
493
493
|
/**
|
|
494
|
-
* @public
|
|
495
494
|
* <p>The latest version of the component and its details.</p>
|
|
495
|
+
* @public
|
|
496
496
|
*/
|
|
497
497
|
latestVersion?: ComponentLatestVersion;
|
|
498
498
|
}
|
|
499
499
|
/**
|
|
500
|
-
* @public
|
|
501
500
|
* <p>Contains information about a component that is a candidate to deploy to a Greengrass core
|
|
502
501
|
* device.</p>
|
|
502
|
+
* @public
|
|
503
503
|
*/
|
|
504
504
|
export interface ComponentCandidate {
|
|
505
505
|
/**
|
|
506
|
-
* @public
|
|
507
506
|
* <p>The name of the component.</p>
|
|
507
|
+
* @public
|
|
508
508
|
*/
|
|
509
509
|
componentName?: string;
|
|
510
510
|
/**
|
|
511
|
-
* @public
|
|
512
511
|
* <p>The version of the component.</p>
|
|
512
|
+
* @public
|
|
513
513
|
*/
|
|
514
514
|
componentVersion?: string;
|
|
515
515
|
/**
|
|
516
|
-
* @public
|
|
517
516
|
* <p>The version requirements for the component's dependencies. Greengrass core devices get the
|
|
518
517
|
* version requirements from component recipes.</p>
|
|
519
518
|
* <p>IoT Greengrass V2 uses semantic version constraints. For more information, see <a href="https://semver.org/">Semantic Versioning</a>.</p>
|
|
519
|
+
* @public
|
|
520
520
|
*/
|
|
521
521
|
versionRequirements?: Record<string, string>;
|
|
522
522
|
}
|
|
523
523
|
/**
|
|
524
|
-
* @public
|
|
525
524
|
* <p>Contains information about a deployment's update to a component's configuration on
|
|
526
525
|
* Greengrass core devices. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html">Update component
|
|
527
526
|
* configurations</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
|
|
527
|
+
* @public
|
|
528
528
|
*/
|
|
529
529
|
export interface ComponentConfigurationUpdate {
|
|
530
530
|
/**
|
|
531
|
-
* @public
|
|
532
531
|
* <p>A serialized JSON string that contains the configuration object to merge to target
|
|
533
532
|
* devices. The core device merges this configuration with the component's existing
|
|
534
533
|
* configuration. If this is the first time a component deploys on a device, the core device
|
|
@@ -536,16 +535,17 @@ export interface ComponentConfigurationUpdate {
|
|
|
536
535
|
* device keeps it's existing configuration for keys and values that you don't specify in this
|
|
537
536
|
* object. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html#merge-configuration-update">Merge configuration updates</a> in the <i>IoT Greengrass V2 Developer
|
|
538
537
|
* Guide</i>.</p>
|
|
538
|
+
* @public
|
|
539
539
|
*/
|
|
540
540
|
merge?: string;
|
|
541
541
|
/**
|
|
542
|
-
* @public
|
|
543
542
|
* <p>The list of configuration nodes to reset to default values on target devices. Use JSON
|
|
544
543
|
* pointers to specify each node to reset. JSON pointers start with a forward slash
|
|
545
544
|
* (<code>/</code>) and use forward slashes to separate the key for each level in the object.
|
|
546
545
|
* For more information, see the <a href="https://tools.ietf.org/html/rfc6901">JSON pointer
|
|
547
546
|
* specification</a> and <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html#reset-configuration-update">Reset configuration updates</a> in the <i>IoT Greengrass V2 Developer
|
|
548
547
|
* Guide</i>.</p>
|
|
548
|
+
* @public
|
|
549
549
|
*/
|
|
550
550
|
reset?: string[];
|
|
551
551
|
}
|
|
@@ -562,18 +562,17 @@ export declare const ComponentDependencyType: {
|
|
|
562
562
|
*/
|
|
563
563
|
export type ComponentDependencyType = (typeof ComponentDependencyType)[keyof typeof ComponentDependencyType];
|
|
564
564
|
/**
|
|
565
|
-
* @public
|
|
566
565
|
* <p>Contains information about a component dependency for a Lambda function component.</p>
|
|
566
|
+
* @public
|
|
567
567
|
*/
|
|
568
568
|
export interface ComponentDependencyRequirement {
|
|
569
569
|
/**
|
|
570
|
-
* @public
|
|
571
570
|
* <p>The component version requirement for the component dependency.</p>
|
|
572
571
|
* <p>IoT Greengrass V2 uses semantic version constraints. For more information, see <a href="https://semver.org/">Semantic Versioning</a>.</p>
|
|
572
|
+
* @public
|
|
573
573
|
*/
|
|
574
574
|
versionRequirement?: string;
|
|
575
575
|
/**
|
|
576
|
-
* @public
|
|
577
576
|
* <p>The type of this dependency. Choose from the following options:</p>
|
|
578
577
|
* <ul>
|
|
579
578
|
* <li>
|
|
@@ -589,23 +588,23 @@ export interface ComponentDependencyRequirement {
|
|
|
589
588
|
* </ul>
|
|
590
589
|
* <p>Default: <code>HARD</code>
|
|
591
590
|
* </p>
|
|
591
|
+
* @public
|
|
592
592
|
*/
|
|
593
593
|
dependencyType?: ComponentDependencyType;
|
|
594
594
|
}
|
|
595
595
|
/**
|
|
596
|
-
* @public
|
|
597
596
|
* <p>Contains information about system resource limits that the IoT Greengrass Core software applies to a
|
|
598
597
|
* component's processes. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-system-resource-limits">Configure system resource limits for components</a>.</p>
|
|
598
|
+
* @public
|
|
599
599
|
*/
|
|
600
600
|
export interface SystemResourceLimits {
|
|
601
601
|
/**
|
|
602
|
-
* @public
|
|
603
602
|
* <p>The maximum amount of RAM, expressed in kilobytes, that a component's processes can use on
|
|
604
603
|
* the core device.</p>
|
|
604
|
+
* @public
|
|
605
605
|
*/
|
|
606
606
|
memory?: number;
|
|
607
607
|
/**
|
|
608
|
-
* @public
|
|
609
608
|
* <p>The maximum amount of CPU time that a component's processes can use on the core device. A
|
|
610
609
|
* core device's total CPU time is equivalent to the device's number of CPU cores. For example,
|
|
611
610
|
* on a core device with 4 CPU cores, you can set this value to <code>2</code> to limit the
|
|
@@ -613,18 +612,18 @@ export interface SystemResourceLimits {
|
|
|
613
612
|
* can set this value to <code>0.25</code> to limit the component's processes to 25 percent usage
|
|
614
613
|
* of the CPU. If you set this value to a number greater than the number of CPU cores, the IoT Greengrass Core
|
|
615
614
|
* software doesn't limit the component's CPU usage.</p>
|
|
615
|
+
* @public
|
|
616
616
|
*/
|
|
617
617
|
cpus?: number;
|
|
618
618
|
}
|
|
619
619
|
/**
|
|
620
|
-
* @public
|
|
621
620
|
* <p>Contains information system user and group that the IoT Greengrass Core software uses to run component
|
|
622
621
|
* processes on the core device. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user">Configure the user and group that run components</a> in the <i>IoT Greengrass V2 Developer
|
|
623
622
|
* Guide</i>.</p>
|
|
623
|
+
* @public
|
|
624
624
|
*/
|
|
625
625
|
export interface ComponentRunWith {
|
|
626
626
|
/**
|
|
627
|
-
* @public
|
|
628
627
|
* <p>The POSIX system user and, optionally, group to use to run this component on Linux core
|
|
629
628
|
* devices. The user, and group if specified, must exist on each Linux core device. Specify the
|
|
630
629
|
* user and group separated by a colon (<code>:</code>) in the following format:
|
|
@@ -632,38 +631,38 @@ export interface ComponentRunWith {
|
|
|
632
631
|
* software uses the primary user for the group.</p>
|
|
633
632
|
* <p>If you omit this parameter, the IoT Greengrass Core software uses the default system user and group that
|
|
634
633
|
* you configure on the Greengrass nucleus component. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user">Configure the user and group that run components</a>.</p>
|
|
634
|
+
* @public
|
|
635
635
|
*/
|
|
636
636
|
posixUser?: string;
|
|
637
637
|
/**
|
|
638
|
-
* @public
|
|
639
638
|
* <p>The system resource limits to apply to this component's process on the core device. IoT Greengrass
|
|
640
639
|
* currently supports this feature on only Linux core devices.</p>
|
|
641
640
|
* <p>If you omit this parameter, the IoT Greengrass Core software uses the default system resource limits
|
|
642
641
|
* that you configure on the Greengrass nucleus component. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-system-resource-limits">Configure system resource limits for components</a>.</p>
|
|
642
|
+
* @public
|
|
643
643
|
*/
|
|
644
644
|
systemResourceLimits?: SystemResourceLimits;
|
|
645
645
|
/**
|
|
646
|
-
* @public
|
|
647
646
|
* <p>The Windows user to use to run this component on Windows core devices. The user must exist
|
|
648
647
|
* on each Windows core device, and its name and password must be in the LocalSystem account's
|
|
649
648
|
* Credentials Manager instance.</p>
|
|
650
649
|
* <p>If you omit this parameter, the IoT Greengrass Core software uses the default Windows user that you
|
|
651
650
|
* configure on the Greengrass nucleus component. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user">Configure the user and group that run components</a>.</p>
|
|
651
|
+
* @public
|
|
652
652
|
*/
|
|
653
653
|
windowsUser?: string;
|
|
654
654
|
}
|
|
655
655
|
/**
|
|
656
|
-
* @public
|
|
657
656
|
* <p>Contains information about a component to deploy.</p>
|
|
657
|
+
* @public
|
|
658
658
|
*/
|
|
659
659
|
export interface ComponentDeploymentSpecification {
|
|
660
660
|
/**
|
|
661
|
-
* @public
|
|
662
661
|
* <p>The version of the component.</p>
|
|
662
|
+
* @public
|
|
663
663
|
*/
|
|
664
664
|
componentVersion?: string;
|
|
665
665
|
/**
|
|
666
|
-
* @public
|
|
667
666
|
* <p>The configuration updates to deploy for the component. You can define
|
|
668
667
|
* <i>reset</i> updates and <i>merge</i> updates. A reset updates
|
|
669
668
|
* the keys that you specify to the default configuration for the component. A merge updates the
|
|
@@ -671,35 +670,36 @@ export interface ComponentDeploymentSpecification {
|
|
|
671
670
|
* software applies reset updates before it applies merge updates. For more information, see
|
|
672
671
|
* <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html">Update component
|
|
673
672
|
* configurations</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
|
|
673
|
+
* @public
|
|
674
674
|
*/
|
|
675
675
|
configurationUpdate?: ComponentConfigurationUpdate;
|
|
676
676
|
/**
|
|
677
|
-
* @public
|
|
678
677
|
* <p>The system user and group that the IoT Greengrass Core software uses to run component processes on the
|
|
679
678
|
* core device. If you omit this parameter, the IoT Greengrass Core software uses the system user and group
|
|
680
679
|
* that you configure for the core device. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user">Configure the user and group that run components</a> in the <i>IoT Greengrass V2 Developer
|
|
681
680
|
* Guide</i>.</p>
|
|
681
|
+
* @public
|
|
682
682
|
*/
|
|
683
683
|
runWith?: ComponentRunWith;
|
|
684
684
|
}
|
|
685
685
|
/**
|
|
686
|
-
* @public
|
|
687
686
|
* <p>Contains information about a component version in a list.</p>
|
|
687
|
+
* @public
|
|
688
688
|
*/
|
|
689
689
|
export interface ComponentVersionListItem {
|
|
690
690
|
/**
|
|
691
|
-
* @public
|
|
692
691
|
* <p>The name of the component.</p>
|
|
692
|
+
* @public
|
|
693
693
|
*/
|
|
694
694
|
componentName?: string;
|
|
695
695
|
/**
|
|
696
|
-
* @public
|
|
697
696
|
* <p>The version of the component.</p>
|
|
697
|
+
* @public
|
|
698
698
|
*/
|
|
699
699
|
componentVersion?: string;
|
|
700
700
|
/**
|
|
701
|
-
* @public
|
|
702
701
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
|
|
702
|
+
* @public
|
|
703
703
|
*/
|
|
704
704
|
arn?: string;
|
|
705
705
|
}
|
|
@@ -716,31 +716,31 @@ export declare const ComponentVisibilityScope: {
|
|
|
716
716
|
*/
|
|
717
717
|
export type ComponentVisibilityScope = (typeof ComponentVisibilityScope)[keyof typeof ComponentVisibilityScope];
|
|
718
718
|
/**
|
|
719
|
-
* @public
|
|
720
719
|
* <p>Contains information about an endpoint and port where client devices can connect to an
|
|
721
720
|
* MQTT broker on a Greengrass core device.</p>
|
|
721
|
+
* @public
|
|
722
722
|
*/
|
|
723
723
|
export interface ConnectivityInfo {
|
|
724
724
|
/**
|
|
725
|
-
* @public
|
|
726
725
|
* <p>An ID for the connectivity information.</p>
|
|
726
|
+
* @public
|
|
727
727
|
*/
|
|
728
728
|
id?: string;
|
|
729
729
|
/**
|
|
730
|
-
* @public
|
|
731
730
|
* <p>The IP address or DNS address where client devices can connect to an MQTT broker on the
|
|
732
731
|
* Greengrass core device.</p>
|
|
732
|
+
* @public
|
|
733
733
|
*/
|
|
734
734
|
hostAddress?: string;
|
|
735
735
|
/**
|
|
736
|
-
* @public
|
|
737
736
|
* <p>The port where the MQTT broker operates on the core device. This port is typically 8883,
|
|
738
737
|
* which is the default port for the MQTT broker component that runs on core devices.</p>
|
|
738
|
+
* @public
|
|
739
739
|
*/
|
|
740
740
|
portNumber?: number;
|
|
741
741
|
/**
|
|
742
|
-
* @public
|
|
743
742
|
* <p>Additional metadata to provide to client devices that connect to this core device.</p>
|
|
743
|
+
* @public
|
|
744
744
|
*/
|
|
745
745
|
metadata?: string;
|
|
746
746
|
}
|
|
@@ -757,18 +757,17 @@ export declare const CoreDeviceStatus: {
|
|
|
757
757
|
*/
|
|
758
758
|
export type CoreDeviceStatus = (typeof CoreDeviceStatus)[keyof typeof CoreDeviceStatus];
|
|
759
759
|
/**
|
|
760
|
-
* @public
|
|
761
760
|
* <p>Contains information about a Greengrass core device, which is an IoT thing that runs the IoT Greengrass
|
|
762
761
|
* Core software.</p>
|
|
762
|
+
* @public
|
|
763
763
|
*/
|
|
764
764
|
export interface CoreDevice {
|
|
765
765
|
/**
|
|
766
|
-
* @public
|
|
767
766
|
* <p>The name of the core device. This is also the name of the IoT thing.</p>
|
|
767
|
+
* @public
|
|
768
768
|
*/
|
|
769
769
|
coreDeviceThingName?: string;
|
|
770
770
|
/**
|
|
771
|
-
* @public
|
|
772
771
|
* <p>The status of the core device. Core devices can have the following
|
|
773
772
|
* statuses:</p>
|
|
774
773
|
* <ul>
|
|
@@ -782,12 +781,13 @@ export interface CoreDevice {
|
|
|
782
781
|
* on the core device.</p>
|
|
783
782
|
* </li>
|
|
784
783
|
* </ul>
|
|
784
|
+
* @public
|
|
785
785
|
*/
|
|
786
786
|
status?: CoreDeviceStatus;
|
|
787
787
|
/**
|
|
788
|
-
* @public
|
|
789
788
|
* <p>The time at which the core device's status last updated, expressed in ISO 8601
|
|
790
789
|
* format.</p>
|
|
790
|
+
* @public
|
|
791
791
|
*/
|
|
792
792
|
lastStatusUpdateTimestamp?: Date;
|
|
793
793
|
}
|
|
@@ -804,19 +804,18 @@ export declare const LambdaEventSourceType: {
|
|
|
804
804
|
*/
|
|
805
805
|
export type LambdaEventSourceType = (typeof LambdaEventSourceType)[keyof typeof LambdaEventSourceType];
|
|
806
806
|
/**
|
|
807
|
-
* @public
|
|
808
807
|
* <p>Contains information about an event source for an Lambda function. The event source
|
|
809
808
|
* defines the topics on which this Lambda function subscribes to receive messages that run the
|
|
810
809
|
* function.</p>
|
|
810
|
+
* @public
|
|
811
811
|
*/
|
|
812
812
|
export interface LambdaEventSource {
|
|
813
813
|
/**
|
|
814
|
-
* @public
|
|
815
814
|
* <p>The topic to which to subscribe to receive event messages.</p>
|
|
815
|
+
* @public
|
|
816
816
|
*/
|
|
817
817
|
topic: string | undefined;
|
|
818
818
|
/**
|
|
819
|
-
* @public
|
|
820
819
|
* <p>The type of event source. Choose from the following options:</p>
|
|
821
820
|
* <ul>
|
|
822
821
|
* <li>
|
|
@@ -832,6 +831,7 @@ export interface LambdaEventSource {
|
|
|
832
831
|
* topic.</p>
|
|
833
832
|
* </li>
|
|
834
833
|
* </ul>
|
|
834
|
+
* @public
|
|
835
835
|
*/
|
|
836
836
|
type: LambdaEventSourceType | undefined;
|
|
837
837
|
}
|
|
@@ -860,92 +860,92 @@ export declare const LambdaFilesystemPermission: {
|
|
|
860
860
|
*/
|
|
861
861
|
export type LambdaFilesystemPermission = (typeof LambdaFilesystemPermission)[keyof typeof LambdaFilesystemPermission];
|
|
862
862
|
/**
|
|
863
|
-
* @public
|
|
864
863
|
* <p>Contains information about a device that Linux processes in a container can access.</p>
|
|
864
|
+
* @public
|
|
865
865
|
*/
|
|
866
866
|
export interface LambdaDeviceMount {
|
|
867
867
|
/**
|
|
868
|
-
* @public
|
|
869
868
|
* <p>The mount path for the device in the file system.</p>
|
|
869
|
+
* @public
|
|
870
870
|
*/
|
|
871
871
|
path: string | undefined;
|
|
872
872
|
/**
|
|
873
|
-
* @public
|
|
874
873
|
* <p>The permission to access the device: read/only (<code>ro</code>) or read/write
|
|
875
874
|
* (<code>rw</code>).</p>
|
|
876
875
|
* <p>Default: <code>ro</code>
|
|
877
876
|
* </p>
|
|
877
|
+
* @public
|
|
878
878
|
*/
|
|
879
879
|
permission?: LambdaFilesystemPermission;
|
|
880
880
|
/**
|
|
881
|
-
* @public
|
|
882
881
|
* <p>Whether or not to add the component's system user as an owner of the device.</p>
|
|
883
882
|
* <p>Default: <code>false</code>
|
|
884
883
|
* </p>
|
|
884
|
+
* @public
|
|
885
885
|
*/
|
|
886
886
|
addGroupOwner?: boolean;
|
|
887
887
|
}
|
|
888
888
|
/**
|
|
889
|
-
* @public
|
|
890
889
|
* <p>Contains information about a volume that Linux processes in a container can access. When
|
|
891
890
|
* you define a volume, the IoT Greengrass Core software mounts the source files to the destination inside the
|
|
892
891
|
* container.</p>
|
|
892
|
+
* @public
|
|
893
893
|
*/
|
|
894
894
|
export interface LambdaVolumeMount {
|
|
895
895
|
/**
|
|
896
|
-
* @public
|
|
897
896
|
* <p>The path to the physical volume in the file system.</p>
|
|
897
|
+
* @public
|
|
898
898
|
*/
|
|
899
899
|
sourcePath: string | undefined;
|
|
900
900
|
/**
|
|
901
|
-
* @public
|
|
902
901
|
* <p>The path to the logical volume in the file system.</p>
|
|
902
|
+
* @public
|
|
903
903
|
*/
|
|
904
904
|
destinationPath: string | undefined;
|
|
905
905
|
/**
|
|
906
|
-
* @public
|
|
907
906
|
* <p>The permission to access the volume: read/only (<code>ro</code>) or read/write
|
|
908
907
|
* (<code>rw</code>).</p>
|
|
909
908
|
* <p>Default: <code>ro</code>
|
|
910
909
|
* </p>
|
|
910
|
+
* @public
|
|
911
911
|
*/
|
|
912
912
|
permission?: LambdaFilesystemPermission;
|
|
913
913
|
/**
|
|
914
|
-
* @public
|
|
915
914
|
* <p>Whether or not to add the IoT Greengrass user group as an owner of the volume.</p>
|
|
916
915
|
* <p>Default: <code>false</code>
|
|
917
916
|
* </p>
|
|
917
|
+
* @public
|
|
918
918
|
*/
|
|
919
919
|
addGroupOwner?: boolean;
|
|
920
920
|
}
|
|
921
921
|
/**
|
|
922
|
-
* @public
|
|
923
922
|
* <p>Contains information about a container in which Lambda functions run on Greengrass core
|
|
924
923
|
* devices.</p>
|
|
924
|
+
* @public
|
|
925
925
|
*/
|
|
926
926
|
export interface LambdaContainerParams {
|
|
927
927
|
/**
|
|
928
|
-
* @public
|
|
929
928
|
* <p>The memory size of the container, expressed in kilobytes.</p>
|
|
930
929
|
* <p>Default: <code>16384</code> (16 MB)</p>
|
|
930
|
+
* @public
|
|
931
931
|
*/
|
|
932
932
|
memorySizeInKB?: number;
|
|
933
933
|
/**
|
|
934
|
-
* @public
|
|
935
934
|
* <p>Whether or not the container can read information from the device's <code>/sys</code>
|
|
936
935
|
* folder.</p>
|
|
937
936
|
* <p>Default: <code>false</code>
|
|
938
937
|
* </p>
|
|
938
|
+
* @public
|
|
939
939
|
*/
|
|
940
940
|
mountROSysfs?: boolean;
|
|
941
941
|
/**
|
|
942
|
-
* @public
|
|
943
942
|
* <p>The list of volumes that the container can access.</p>
|
|
943
|
+
* @public
|
|
944
944
|
*/
|
|
945
945
|
volumes?: LambdaVolumeMount[];
|
|
946
946
|
/**
|
|
947
|
-
* @public
|
|
948
947
|
* <p>The list of system devices that the container can access.</p>
|
|
948
|
+
* @public
|
|
949
949
|
*/
|
|
950
950
|
devices?: LambdaDeviceMount[];
|
|
951
951
|
}
|
|
@@ -962,70 +962,69 @@ export declare const LambdaIsolationMode: {
|
|
|
962
962
|
*/
|
|
963
963
|
export type LambdaIsolationMode = (typeof LambdaIsolationMode)[keyof typeof LambdaIsolationMode];
|
|
964
964
|
/**
|
|
965
|
-
* @public
|
|
966
965
|
* <p>Contains parameters for a Linux process that contains an Lambda function.</p>
|
|
966
|
+
* @public
|
|
967
967
|
*/
|
|
968
968
|
export interface LambdaLinuxProcessParams {
|
|
969
969
|
/**
|
|
970
|
-
* @public
|
|
971
970
|
* <p>The isolation mode for the process that contains the Lambda function. The process can run
|
|
972
971
|
* in an isolated runtime environment inside the IoT Greengrass container, or as a regular process outside
|
|
973
972
|
* any container.</p>
|
|
974
973
|
* <p>Default: <code>GreengrassContainer</code>
|
|
975
974
|
* </p>
|
|
975
|
+
* @public
|
|
976
976
|
*/
|
|
977
977
|
isolationMode?: LambdaIsolationMode;
|
|
978
978
|
/**
|
|
979
|
-
* @public
|
|
980
979
|
* <p>The parameters for the container in which the Lambda function runs.</p>
|
|
980
|
+
* @public
|
|
981
981
|
*/
|
|
982
982
|
containerParams?: LambdaContainerParams;
|
|
983
983
|
}
|
|
984
984
|
/**
|
|
985
|
-
* @public
|
|
986
985
|
* <p>Contains parameters for a Lambda function that runs on IoT Greengrass.</p>
|
|
986
|
+
* @public
|
|
987
987
|
*/
|
|
988
988
|
export interface LambdaExecutionParameters {
|
|
989
989
|
/**
|
|
990
|
-
* @public
|
|
991
990
|
* <p>The list of event sources to which to subscribe to receive work messages. The Lambda
|
|
992
991
|
* function runs when it receives a message from an event source. You can subscribe this function
|
|
993
992
|
* to local publish/subscribe messages and Amazon Web Services IoT Core MQTT messages.</p>
|
|
993
|
+
* @public
|
|
994
994
|
*/
|
|
995
995
|
eventSources?: LambdaEventSource[];
|
|
996
996
|
/**
|
|
997
|
-
* @public
|
|
998
997
|
* <p>The maximum size of the message queue for the Lambda function component. The IoT Greengrass core
|
|
999
998
|
* stores messages in a FIFO (first-in-first-out) queue until it can run the Lambda function to
|
|
1000
999
|
* consume each message.</p>
|
|
1000
|
+
* @public
|
|
1001
1001
|
*/
|
|
1002
1002
|
maxQueueSize?: number;
|
|
1003
1003
|
/**
|
|
1004
|
-
* @public
|
|
1005
1004
|
* <p>The maximum number of instances that a non-pinned Lambda function can run at the same
|
|
1006
1005
|
* time.</p>
|
|
1006
|
+
* @public
|
|
1007
1007
|
*/
|
|
1008
1008
|
maxInstancesCount?: number;
|
|
1009
1009
|
/**
|
|
1010
|
-
* @public
|
|
1011
1010
|
* <p>The maximum amount of time in seconds that a non-pinned Lambda function can idle before the
|
|
1012
1011
|
* IoT Greengrass Core software stops its process.</p>
|
|
1012
|
+
* @public
|
|
1013
1013
|
*/
|
|
1014
1014
|
maxIdleTimeInSeconds?: number;
|
|
1015
1015
|
/**
|
|
1016
|
-
* @public
|
|
1017
1016
|
* <p>The maximum amount of time in seconds that the Lambda function can process a work
|
|
1018
1017
|
* item.</p>
|
|
1018
|
+
* @public
|
|
1019
1019
|
*/
|
|
1020
1020
|
timeoutInSeconds?: number;
|
|
1021
1021
|
/**
|
|
1022
|
-
* @public
|
|
1023
1022
|
* <p>The interval in seconds at which a pinned (also known as long-lived) Lambda function
|
|
1024
1023
|
* component sends status updates to the Lambda manager component.</p>
|
|
1024
|
+
* @public
|
|
1025
1025
|
*/
|
|
1026
1026
|
statusTimeoutInSeconds?: number;
|
|
1027
1027
|
/**
|
|
1028
|
-
* @public
|
|
1029
1028
|
* <p>Whether or not the Lambda function is pinned, or long-lived.</p>
|
|
1030
1029
|
* <ul>
|
|
1031
1030
|
* <li>
|
|
@@ -1040,70 +1039,71 @@ export interface LambdaExecutionParameters {
|
|
|
1040
1039
|
* </ul>
|
|
1041
1040
|
* <p>Default: <code>true</code>
|
|
1042
1041
|
* </p>
|
|
1042
|
+
* @public
|
|
1043
1043
|
*/
|
|
1044
1044
|
pinned?: boolean;
|
|
1045
1045
|
/**
|
|
1046
|
-
* @public
|
|
1047
1046
|
* <p>The encoding type that the Lambda function supports.</p>
|
|
1048
1047
|
* <p>Default: <code>json</code>
|
|
1049
1048
|
* </p>
|
|
1049
|
+
* @public
|
|
1050
1050
|
*/
|
|
1051
1051
|
inputPayloadEncodingType?: LambdaInputPayloadEncodingType;
|
|
1052
1052
|
/**
|
|
1053
|
-
* @public
|
|
1054
1053
|
* <p>The list of arguments to pass to the Lambda function when it runs.</p>
|
|
1054
|
+
* @public
|
|
1055
1055
|
*/
|
|
1056
1056
|
execArgs?: string[];
|
|
1057
1057
|
/**
|
|
1058
|
-
* @public
|
|
1059
1058
|
* <p>The map of environment variables that are available to the Lambda function when it
|
|
1060
1059
|
* runs.</p>
|
|
1060
|
+
* @public
|
|
1061
1061
|
*/
|
|
1062
1062
|
environmentVariables?: Record<string, string>;
|
|
1063
1063
|
/**
|
|
1064
|
-
* @public
|
|
1065
1064
|
* <p>The parameters for the Linux process that contains the Lambda function.</p>
|
|
1065
|
+
* @public
|
|
1066
1066
|
*/
|
|
1067
1067
|
linuxProcessParams?: LambdaLinuxProcessParams;
|
|
1068
1068
|
}
|
|
1069
1069
|
/**
|
|
1070
|
-
* @public
|
|
1071
1070
|
* <p>Contains information about an Lambda function to import to create a component.</p>
|
|
1071
|
+
* @public
|
|
1072
1072
|
*/
|
|
1073
1073
|
export interface LambdaFunctionRecipeSource {
|
|
1074
1074
|
/**
|
|
1075
|
-
* @public
|
|
1076
1075
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the Lambda function. The ARN must include the version of the function to
|
|
1077
1076
|
* import. You can't use version aliases like <code>$LATEST</code>.</p>
|
|
1077
|
+
* @public
|
|
1078
1078
|
*/
|
|
1079
1079
|
lambdaArn: string | undefined;
|
|
1080
1080
|
/**
|
|
1081
|
-
* @public
|
|
1082
1081
|
* <p>The name of the component.</p>
|
|
1083
1082
|
* <p>Defaults to the name of the Lambda function.</p>
|
|
1083
|
+
* @public
|
|
1084
1084
|
*/
|
|
1085
1085
|
componentName?: string;
|
|
1086
1086
|
/**
|
|
1087
|
-
* @public
|
|
1088
1087
|
* <p>The version of the component.</p>
|
|
1089
1088
|
* <p>Defaults to the version of the Lambda function as a semantic version. For example, if your
|
|
1090
1089
|
* function version is <code>3</code>, the component version becomes <code>3.0.0</code>.</p>
|
|
1090
|
+
* @public
|
|
1091
1091
|
*/
|
|
1092
1092
|
componentVersion?: string;
|
|
1093
1093
|
/**
|
|
1094
|
-
* @public
|
|
1095
1094
|
* <p>The platforms that the component version supports.</p>
|
|
1095
|
+
* @public
|
|
1096
1096
|
*/
|
|
1097
1097
|
componentPlatforms?: ComponentPlatform[];
|
|
1098
1098
|
/**
|
|
1099
|
-
* @public
|
|
1100
1099
|
* <p>The component versions on which this Lambda function component depends.</p>
|
|
1100
|
+
* @public
|
|
1101
1101
|
*/
|
|
1102
1102
|
componentDependencies?: Record<string, ComponentDependencyRequirement>;
|
|
1103
1103
|
/**
|
|
1104
|
-
* @public
|
|
1105
1104
|
* <p>The system and runtime parameters for the Lambda function as it runs on the Greengrass core
|
|
1106
1105
|
* device.</p>
|
|
1106
|
+
* @public
|
|
1107
1107
|
*/
|
|
1108
1108
|
componentLambdaParameters?: LambdaExecutionParameters;
|
|
1109
1109
|
}
|
|
@@ -1112,32 +1112,32 @@ export interface LambdaFunctionRecipeSource {
|
|
|
1112
1112
|
*/
|
|
1113
1113
|
export interface CreateComponentVersionRequest {
|
|
1114
1114
|
/**
|
|
1115
|
-
* @public
|
|
1116
1115
|
* <p>The recipe to use to create the component. The recipe defines the component's metadata,
|
|
1117
1116
|
* parameters, dependencies, lifecycle, artifacts, and platform compatibility.</p>
|
|
1118
1117
|
* <p>You must specify either <code>inlineRecipe</code> or <code>lambdaFunction</code>.</p>
|
|
1118
|
+
* @public
|
|
1119
1119
|
*/
|
|
1120
1120
|
inlineRecipe?: Uint8Array;
|
|
1121
1121
|
/**
|
|
1122
|
-
* @public
|
|
1123
1122
|
* <p>The parameters to create a component from a Lambda function.</p>
|
|
1124
1123
|
* <p>You must specify either <code>inlineRecipe</code> or <code>lambdaFunction</code>.</p>
|
|
1124
|
+
* @public
|
|
1125
1125
|
*/
|
|
1126
1126
|
lambdaFunction?: LambdaFunctionRecipeSource;
|
|
1127
1127
|
/**
|
|
1128
|
-
* @public
|
|
1129
1128
|
* <p>A list of key-value pairs that contain metadata for the resource. For more
|
|
1130
1129
|
* information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html">Tag your
|
|
1131
1130
|
* resources</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
|
|
1131
|
+
* @public
|
|
1132
1132
|
*/
|
|
1133
1133
|
tags?: Record<string, string>;
|
|
1134
1134
|
/**
|
|
1135
|
-
* @public
|
|
1136
1135
|
* <p>A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent.
|
|
1137
1136
|
* Idempotency means that the request is successfully processed only once, even if you send the request multiple times.
|
|
1138
1137
|
* When a request succeeds, and you specify the same client token for subsequent successful requests, the IoT Greengrass V2 service
|
|
1139
1138
|
* returns the successful response that it caches from the previous request. IoT Greengrass V2 caches successful responses for
|
|
1140
1139
|
* idempotent requests for up to 8 hours.</p>
|
|
1140
|
+
* @public
|
|
1141
1141
|
*/
|
|
1142
1142
|
clientToken?: string;
|
|
1143
1143
|
}
|
|
@@ -1146,37 +1146,37 @@ export interface CreateComponentVersionRequest {
|
|
|
1146
1146
|
*/
|
|
1147
1147
|
export interface CreateComponentVersionResponse {
|
|
1148
1148
|
/**
|
|
1149
|
-
* @public
|
|
1150
1149
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
|
|
1150
|
+
* @public
|
|
1151
1151
|
*/
|
|
1152
1152
|
arn?: string;
|
|
1153
1153
|
/**
|
|
1154
|
-
* @public
|
|
1155
1154
|
* <p>The name of the component.</p>
|
|
1155
|
+
* @public
|
|
1156
1156
|
*/
|
|
1157
1157
|
componentName: string | undefined;
|
|
1158
1158
|
/**
|
|
1159
|
-
* @public
|
|
1160
1159
|
* <p>The version of the component.</p>
|
|
1160
|
+
* @public
|
|
1161
1161
|
*/
|
|
1162
1162
|
componentVersion: string | undefined;
|
|
1163
1163
|
/**
|
|
1164
|
-
* @public
|
|
1165
1164
|
* <p>The time at which the component was created, expressed in ISO 8601 format.</p>
|
|
1165
|
+
* @public
|
|
1166
1166
|
*/
|
|
1167
1167
|
creationTimestamp: Date | undefined;
|
|
1168
1168
|
/**
|
|
1169
|
-
* @public
|
|
1170
1169
|
* <p>The status of the component version in IoT Greengrass V2. This status
|
|
1171
1170
|
* is different from the status of the component on a core device.</p>
|
|
1171
|
+
* @public
|
|
1172
1172
|
*/
|
|
1173
1173
|
status: CloudComponentStatus | undefined;
|
|
1174
1174
|
}
|
|
1175
1175
|
/**
|
|
1176
|
-
* @public
|
|
1177
1176
|
* <p>The request is already in progress. This exception occurs when you use a client token for
|
|
1178
1177
|
* multiple requests while IoT Greengrass is still processing an earlier request that uses the same client
|
|
1179
1178
|
* token.</p>
|
|
1179
|
+
* @public
|
|
1180
1180
|
*/
|
|
1181
1181
|
export declare class RequestAlreadyInProgressException extends __BaseException {
|
|
1182
1182
|
readonly name: "RequestAlreadyInProgressException";
|
|
@@ -1187,31 +1187,31 @@ export declare class RequestAlreadyInProgressException extends __BaseException {
|
|
|
1187
1187
|
constructor(opts: __ExceptionOptionType<RequestAlreadyInProgressException, __BaseException>);
|
|
1188
1188
|
}
|
|
1189
1189
|
/**
|
|
1190
|
-
* @public
|
|
1191
1190
|
* <p>Your request exceeds a service quota. For example, you might have the maximum number of
|
|
1192
1191
|
* components that you can create.</p>
|
|
1192
|
+
* @public
|
|
1193
1193
|
*/
|
|
1194
1194
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
1195
1195
|
readonly name: "ServiceQuotaExceededException";
|
|
1196
1196
|
readonly $fault: "client";
|
|
1197
1197
|
/**
|
|
1198
|
-
* @public
|
|
1199
1198
|
* <p>The ID of the resource that exceeds the service quota.</p>
|
|
1199
|
+
* @public
|
|
1200
1200
|
*/
|
|
1201
1201
|
resourceId?: string;
|
|
1202
1202
|
/**
|
|
1203
|
-
* @public
|
|
1204
1203
|
* <p>The type of the resource that exceeds the service quota.</p>
|
|
1204
|
+
* @public
|
|
1205
1205
|
*/
|
|
1206
1206
|
resourceType?: string;
|
|
1207
1207
|
/**
|
|
1208
|
-
* @public
|
|
1209
1208
|
* <p>The code for the quota in <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html">Service Quotas</a>.</p>
|
|
1209
|
+
* @public
|
|
1210
1210
|
*/
|
|
1211
1211
|
quotaCode: string | undefined;
|
|
1212
1212
|
/**
|
|
1213
|
-
* @public
|
|
1214
1213
|
* <p>The code for the service in <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html">Service Quotas</a>.</p>
|
|
1214
|
+
* @public
|
|
1215
1215
|
*/
|
|
1216
1216
|
serviceCode: string | undefined;
|
|
1217
1217
|
/**
|
|
@@ -1232,7 +1232,6 @@ export declare const DeploymentComponentUpdatePolicyAction: {
|
|
|
1232
1232
|
*/
|
|
1233
1233
|
export type DeploymentComponentUpdatePolicyAction = (typeof DeploymentComponentUpdatePolicyAction)[keyof typeof DeploymentComponentUpdatePolicyAction];
|
|
1234
1234
|
/**
|
|
1235
|
-
* @public
|
|
1236
1235
|
* <p>Contains information about a deployment's policy that defines when components are safe to
|
|
1237
1236
|
* update.</p>
|
|
1238
1237
|
* <p>Each component on a device can report whether or not it's ready to update. After a
|
|
@@ -1240,19 +1239,19 @@ export type DeploymentComponentUpdatePolicyAction = (typeof DeploymentComponentU
|
|
|
1240
1239
|
* configure whether or not the deployment notifies components of an update and waits for a
|
|
1241
1240
|
* response. You specify the amount of time each component has to respond to the update
|
|
1242
1241
|
* notification.</p>
|
|
1242
|
+
* @public
|
|
1243
1243
|
*/
|
|
1244
1244
|
export interface DeploymentComponentUpdatePolicy {
|
|
1245
1245
|
/**
|
|
1246
|
-
* @public
|
|
1247
1246
|
* <p>The amount of time in seconds that each component on a device has to report that it's safe
|
|
1248
1247
|
* to update. If the component waits for longer than this timeout, then the deployment proceeds
|
|
1249
1248
|
* on the device.</p>
|
|
1250
1249
|
* <p>Default: <code>60</code>
|
|
1251
1250
|
* </p>
|
|
1251
|
+
* @public
|
|
1252
1252
|
*/
|
|
1253
1253
|
timeoutInSeconds?: number;
|
|
1254
1254
|
/**
|
|
1255
|
-
* @public
|
|
1256
1255
|
* <p>Whether or not to notify components and wait for components to become safe to update.
|
|
1257
1256
|
* Choose from the following options:</p>
|
|
1258
1257
|
* <ul>
|
|
@@ -1271,23 +1270,24 @@ export interface DeploymentComponentUpdatePolicy {
|
|
|
1271
1270
|
* </ul>
|
|
1272
1271
|
* <p>Default: <code>NOTIFY_COMPONENTS</code>
|
|
1273
1272
|
* </p>
|
|
1273
|
+
* @public
|
|
1274
1274
|
*/
|
|
1275
1275
|
action?: DeploymentComponentUpdatePolicyAction;
|
|
1276
1276
|
}
|
|
1277
1277
|
/**
|
|
1278
|
-
* @public
|
|
1279
1278
|
* <p>Contains information about how long a component on a core device can validate its
|
|
1280
1279
|
* configuration updates before it times out. Components can use the <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-subscribetovalidateconfigurationupdates">SubscribeToValidateConfigurationUpdates</a> IPC operation to receive notifications when
|
|
1281
1280
|
* a deployment specifies a configuration update. Then, components can respond with the <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-sendconfigurationvalidityreport">SendConfigurationValidityReport</a> IPC operation. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html">Create
|
|
1282
1281
|
* deployments</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
|
|
1282
|
+
* @public
|
|
1283
1283
|
*/
|
|
1284
1284
|
export interface DeploymentConfigurationValidationPolicy {
|
|
1285
1285
|
/**
|
|
1286
|
-
* @public
|
|
1287
1286
|
* <p>The amount of time in seconds that a component can validate its configuration updates. If
|
|
1288
1287
|
* the validation time exceeds this timeout, then the deployment proceeds for the device.</p>
|
|
1289
1288
|
* <p>Default: <code>30</code>
|
|
1290
1289
|
* </p>
|
|
1290
|
+
* @public
|
|
1291
1291
|
*/
|
|
1292
1292
|
timeoutInSeconds?: number;
|
|
1293
1293
|
}
|
|
@@ -1304,29 +1304,29 @@ export declare const DeploymentFailureHandlingPolicy: {
|
|
|
1304
1304
|
*/
|
|
1305
1305
|
export type DeploymentFailureHandlingPolicy = (typeof DeploymentFailureHandlingPolicy)[keyof typeof DeploymentFailureHandlingPolicy];
|
|
1306
1306
|
/**
|
|
1307
|
-
* @public
|
|
1308
1307
|
* <p>Contains information about policies that define how a deployment updates components and
|
|
1309
1308
|
* handles failure.</p>
|
|
1309
|
+
* @public
|
|
1310
1310
|
*/
|
|
1311
1311
|
export interface DeploymentPolicies {
|
|
1312
1312
|
/**
|
|
1313
|
-
* @public
|
|
1314
1313
|
* <p>The failure handling policy for the configuration deployment. This policy defines what to
|
|
1315
1314
|
* do if the deployment fails.</p>
|
|
1316
1315
|
* <p>Default: <code>ROLLBACK</code>
|
|
1317
1316
|
* </p>
|
|
1317
|
+
* @public
|
|
1318
1318
|
*/
|
|
1319
1319
|
failureHandlingPolicy?: DeploymentFailureHandlingPolicy;
|
|
1320
1320
|
/**
|
|
1321
|
-
* @public
|
|
1322
1321
|
* <p>The component update policy for the configuration deployment. This policy defines when
|
|
1323
1322
|
* it's safe to deploy the configuration to devices.</p>
|
|
1323
|
+
* @public
|
|
1324
1324
|
*/
|
|
1325
1325
|
componentUpdatePolicy?: DeploymentComponentUpdatePolicy;
|
|
1326
1326
|
/**
|
|
1327
|
-
* @public
|
|
1328
1327
|
* <p>The configuration validation policy for the configuration deployment. This policy defines
|
|
1329
1328
|
* how long each component has to validate its configure updates.</p>
|
|
1329
|
+
* @public
|
|
1330
1330
|
*/
|
|
1331
1331
|
configurationValidationPolicy?: DeploymentConfigurationValidationPolicy;
|
|
1332
1332
|
}
|
|
@@ -1356,7 +1356,6 @@ export declare const IoTJobExecutionFailureType: {
|
|
|
1356
1356
|
*/
|
|
1357
1357
|
export type IoTJobExecutionFailureType = (typeof IoTJobExecutionFailureType)[keyof typeof IoTJobExecutionFailureType];
|
|
1358
1358
|
/**
|
|
1359
|
-
* @public
|
|
1360
1359
|
* <p>Contains criteria that define when and how to cancel a job.</p>
|
|
1361
1360
|
* <p>The deployment stops if the following conditions are true:</p>
|
|
1362
1361
|
* <ol>
|
|
@@ -1369,144 +1368,145 @@ export type IoTJobExecutionFailureType = (typeof IoTJobExecutionFailureType)[key
|
|
|
1369
1368
|
* <code>thresholdPercentage</code>.</p>
|
|
1370
1369
|
* </li>
|
|
1371
1370
|
* </ol>
|
|
1371
|
+
* @public
|
|
1372
1372
|
*/
|
|
1373
1373
|
export interface IoTJobAbortCriteria {
|
|
1374
1374
|
/**
|
|
1375
|
-
* @public
|
|
1376
1375
|
* <p>The type of job deployment failure that can cancel a job.</p>
|
|
1376
|
+
* @public
|
|
1377
1377
|
*/
|
|
1378
1378
|
failureType: IoTJobExecutionFailureType | undefined;
|
|
1379
1379
|
/**
|
|
1380
|
-
* @public
|
|
1381
1380
|
* <p>The action to perform when the criteria are met.</p>
|
|
1381
|
+
* @public
|
|
1382
1382
|
*/
|
|
1383
1383
|
action: IoTJobAbortAction | undefined;
|
|
1384
1384
|
/**
|
|
1385
|
-
* @public
|
|
1386
1385
|
* <p>The minimum percentage of <code>failureType</code> failures that occur before the job can
|
|
1387
1386
|
* cancel.</p>
|
|
1388
1387
|
* <p>This parameter supports up to two digits after the decimal (for example, you can specify
|
|
1389
1388
|
* <code>10.9</code> or <code>10.99</code>, but not <code>10.999</code>).</p>
|
|
1389
|
+
* @public
|
|
1390
1390
|
*/
|
|
1391
1391
|
thresholdPercentage: number | undefined;
|
|
1392
1392
|
/**
|
|
1393
|
-
* @public
|
|
1394
1393
|
* <p>The minimum number of things that receive the configuration before the job can
|
|
1395
1394
|
* cancel.</p>
|
|
1395
|
+
* @public
|
|
1396
1396
|
*/
|
|
1397
1397
|
minNumberOfExecutedThings: number | undefined;
|
|
1398
1398
|
}
|
|
1399
1399
|
/**
|
|
1400
|
-
* @public
|
|
1401
1400
|
* <p>Contains a list of criteria that define when and how to cancel a configuration
|
|
1402
1401
|
* deployment.</p>
|
|
1402
|
+
* @public
|
|
1403
1403
|
*/
|
|
1404
1404
|
export interface IoTJobAbortConfig {
|
|
1405
1405
|
/**
|
|
1406
|
-
* @public
|
|
1407
1406
|
* <p>The list of criteria that define when and how to cancel the configuration
|
|
1408
1407
|
* deployment.</p>
|
|
1408
|
+
* @public
|
|
1409
1409
|
*/
|
|
1410
1410
|
criteriaList: IoTJobAbortCriteria[] | undefined;
|
|
1411
1411
|
}
|
|
1412
1412
|
/**
|
|
1413
|
-
* @public
|
|
1414
1413
|
* <p>Contains information about criteria to meet before a job increases its rollout rate.
|
|
1415
1414
|
* Specify either <code>numberOfNotifiedThings</code> or
|
|
1416
1415
|
* <code>numberOfSucceededThings</code>.</p>
|
|
1416
|
+
* @public
|
|
1417
1417
|
*/
|
|
1418
1418
|
export interface IoTJobRateIncreaseCriteria {
|
|
1419
1419
|
/**
|
|
1420
|
-
* @public
|
|
1421
1420
|
* <p>The number of devices to receive the job notification before the rollout rate
|
|
1422
1421
|
* increases.</p>
|
|
1422
|
+
* @public
|
|
1423
1423
|
*/
|
|
1424
1424
|
numberOfNotifiedThings?: number;
|
|
1425
1425
|
/**
|
|
1426
|
-
* @public
|
|
1427
1426
|
* <p>The number of devices to successfully run the configuration job before the rollout rate
|
|
1428
1427
|
* increases.</p>
|
|
1428
|
+
* @public
|
|
1429
1429
|
*/
|
|
1430
1430
|
numberOfSucceededThings?: number;
|
|
1431
1431
|
}
|
|
1432
1432
|
/**
|
|
1433
|
-
* @public
|
|
1434
1433
|
* <p>Contains information about an exponential rollout rate for a configuration deployment
|
|
1435
1434
|
* job.</p>
|
|
1435
|
+
* @public
|
|
1436
1436
|
*/
|
|
1437
1437
|
export interface IoTJobExponentialRolloutRate {
|
|
1438
1438
|
/**
|
|
1439
|
-
* @public
|
|
1440
1439
|
* <p>The minimum number of devices that receive a pending job notification, per minute, when
|
|
1441
1440
|
* the job starts. This parameter defines the initial rollout rate of the job.</p>
|
|
1441
|
+
* @public
|
|
1442
1442
|
*/
|
|
1443
1443
|
baseRatePerMinute: number | undefined;
|
|
1444
1444
|
/**
|
|
1445
|
-
* @public
|
|
1446
1445
|
* <p>The exponential factor to increase the rollout rate for the job.</p>
|
|
1447
1446
|
* <p>This parameter supports up to one digit after the decimal (for example, you can specify
|
|
1448
1447
|
* <code>1.5</code>, but not <code>1.55</code>).</p>
|
|
1448
|
+
* @public
|
|
1449
1449
|
*/
|
|
1450
1450
|
incrementFactor: number | undefined;
|
|
1451
1451
|
/**
|
|
1452
|
-
* @public
|
|
1453
1452
|
* <p>The criteria to increase the rollout rate for the job.</p>
|
|
1453
|
+
* @public
|
|
1454
1454
|
*/
|
|
1455
1455
|
rateIncreaseCriteria: IoTJobRateIncreaseCriteria | undefined;
|
|
1456
1456
|
}
|
|
1457
1457
|
/**
|
|
1458
|
-
* @public
|
|
1459
1458
|
* <p>Contains information about the rollout configuration for a job. This configuration defines
|
|
1460
1459
|
* the rate at which the job deploys a configuration to a fleet of target devices.</p>
|
|
1460
|
+
* @public
|
|
1461
1461
|
*/
|
|
1462
1462
|
export interface IoTJobExecutionsRolloutConfig {
|
|
1463
1463
|
/**
|
|
1464
|
-
* @public
|
|
1465
1464
|
* <p>The exponential rate to increase the job rollout rate.</p>
|
|
1465
|
+
* @public
|
|
1466
1466
|
*/
|
|
1467
1467
|
exponentialRate?: IoTJobExponentialRolloutRate;
|
|
1468
1468
|
/**
|
|
1469
|
-
* @public
|
|
1470
1469
|
* <p>The maximum number of devices that receive a pending job notification, per minute.</p>
|
|
1470
|
+
* @public
|
|
1471
1471
|
*/
|
|
1472
1472
|
maximumPerMinute?: number;
|
|
1473
1473
|
}
|
|
1474
1474
|
/**
|
|
1475
|
-
* @public
|
|
1476
1475
|
* <p>Contains information about the timeout configuration for a job.</p>
|
|
1476
|
+
* @public
|
|
1477
1477
|
*/
|
|
1478
1478
|
export interface IoTJobTimeoutConfig {
|
|
1479
1479
|
/**
|
|
1480
|
-
* @public
|
|
1481
1480
|
* <p>The amount of time, in minutes, that devices have to complete the job. The timer starts
|
|
1482
1481
|
* when the job status is set to <code>IN_PROGRESS</code>. If the job status doesn't change to a
|
|
1483
1482
|
* terminal state before the time expires, then the job status is set to
|
|
1484
1483
|
* <code>TIMED_OUT</code>.</p>
|
|
1485
1484
|
* <p>The timeout interval must be between 1 minute and 7 days (10080 minutes).</p>
|
|
1485
|
+
* @public
|
|
1486
1486
|
*/
|
|
1487
1487
|
inProgressTimeoutInMinutes?: number;
|
|
1488
1488
|
}
|
|
1489
1489
|
/**
|
|
1490
|
-
* @public
|
|
1491
1490
|
* <p>Contains information about an IoT job configuration.</p>
|
|
1491
|
+
* @public
|
|
1492
1492
|
*/
|
|
1493
1493
|
export interface DeploymentIoTJobConfiguration {
|
|
1494
1494
|
/**
|
|
1495
|
-
* @public
|
|
1496
1495
|
* <p>The rollout configuration for the job. This configuration defines the rate at which the
|
|
1497
1496
|
* job rolls out to the fleet of target devices.</p>
|
|
1497
|
+
* @public
|
|
1498
1498
|
*/
|
|
1499
1499
|
jobExecutionsRolloutConfig?: IoTJobExecutionsRolloutConfig;
|
|
1500
1500
|
/**
|
|
1501
|
-
* @public
|
|
1502
1501
|
* <p>The stop configuration for the job. This configuration defines when and how to stop a job
|
|
1503
1502
|
* rollout.</p>
|
|
1503
|
+
* @public
|
|
1504
1504
|
*/
|
|
1505
1505
|
abortConfig?: IoTJobAbortConfig;
|
|
1506
1506
|
/**
|
|
1507
|
-
* @public
|
|
1508
1507
|
* <p>The timeout configuration for the job. This configuration defines the amount of time each
|
|
1509
1508
|
* device has to complete the job.</p>
|
|
1509
|
+
* @public
|
|
1510
1510
|
*/
|
|
1511
1511
|
timeoutConfig?: IoTJobTimeoutConfig;
|
|
1512
1512
|
}
|
|
@@ -1515,52 +1515,52 @@ export interface DeploymentIoTJobConfiguration {
|
|
|
1515
1515
|
*/
|
|
1516
1516
|
export interface CreateDeploymentRequest {
|
|
1517
1517
|
/**
|
|
1518
|
-
* @public
|
|
1519
1518
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the target IoT thing or thing group. When creating a subdeployment, the targetARN can only be a thing group.</p>
|
|
1519
|
+
* @public
|
|
1520
1520
|
*/
|
|
1521
1521
|
targetArn: string | undefined;
|
|
1522
1522
|
/**
|
|
1523
|
-
* @public
|
|
1524
1523
|
* <p>The name of the deployment.</p>
|
|
1524
|
+
* @public
|
|
1525
1525
|
*/
|
|
1526
1526
|
deploymentName?: string;
|
|
1527
1527
|
/**
|
|
1528
|
-
* @public
|
|
1529
1528
|
* <p>The components to deploy. This is a dictionary, where each key is the name of a component,
|
|
1530
1529
|
* and each key's value is the version and configuration to deploy for that component.</p>
|
|
1530
|
+
* @public
|
|
1531
1531
|
*/
|
|
1532
1532
|
components?: Record<string, ComponentDeploymentSpecification>;
|
|
1533
1533
|
/**
|
|
1534
|
-
* @public
|
|
1535
1534
|
* <p>The job configuration for the deployment configuration. The job configuration specifies
|
|
1536
1535
|
* the rollout, timeout, and stop configurations for the deployment configuration.</p>
|
|
1536
|
+
* @public
|
|
1537
1537
|
*/
|
|
1538
1538
|
iotJobConfiguration?: DeploymentIoTJobConfiguration;
|
|
1539
1539
|
/**
|
|
1540
|
-
* @public
|
|
1541
1540
|
* <p>The deployment policies for the deployment. These policies define how the deployment
|
|
1542
1541
|
* updates components and handles failure.</p>
|
|
1542
|
+
* @public
|
|
1543
1543
|
*/
|
|
1544
1544
|
deploymentPolicies?: DeploymentPolicies;
|
|
1545
1545
|
/**
|
|
1546
|
-
* @public
|
|
1547
1546
|
* <p>The parent deployment's target <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> within a subdeployment.</p>
|
|
1547
|
+
* @public
|
|
1548
1548
|
*/
|
|
1549
1549
|
parentTargetArn?: string;
|
|
1550
1550
|
/**
|
|
1551
|
-
* @public
|
|
1552
1551
|
* <p>A list of key-value pairs that contain metadata for the resource. For more
|
|
1553
1552
|
* information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html">Tag your
|
|
1554
1553
|
* resources</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
|
|
1554
|
+
* @public
|
|
1555
1555
|
*/
|
|
1556
1556
|
tags?: Record<string, string>;
|
|
1557
1557
|
/**
|
|
1558
|
-
* @public
|
|
1559
1558
|
* <p>A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent.
|
|
1560
1559
|
* Idempotency means that the request is successfully processed only once, even if you send the request multiple times.
|
|
1561
1560
|
* When a request succeeds, and you specify the same client token for subsequent successful requests, the IoT Greengrass V2 service
|
|
1562
1561
|
* returns the successful response that it caches from the previous request. IoT Greengrass V2 caches successful responses for
|
|
1563
1562
|
* idempotent requests for up to 8 hours.</p>
|
|
1563
|
+
* @public
|
|
1564
1564
|
*/
|
|
1565
1565
|
clientToken?: string;
|
|
1566
1566
|
}
|
|
@@ -1569,18 +1569,18 @@ export interface CreateDeploymentRequest {
|
|
|
1569
1569
|
*/
|
|
1570
1570
|
export interface CreateDeploymentResponse {
|
|
1571
1571
|
/**
|
|
1572
|
-
* @public
|
|
1573
1572
|
* <p>The ID of the deployment.</p>
|
|
1573
|
+
* @public
|
|
1574
1574
|
*/
|
|
1575
1575
|
deploymentId?: string;
|
|
1576
1576
|
/**
|
|
1577
|
-
* @public
|
|
1578
1577
|
* <p>The ID of the IoT job that applies the deployment to target devices.</p>
|
|
1578
|
+
* @public
|
|
1579
1579
|
*/
|
|
1580
1580
|
iotJobId?: string;
|
|
1581
1581
|
/**
|
|
1582
|
-
* @public
|
|
1583
1582
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the IoT job that applies the deployment to target devices.</p>
|
|
1583
|
+
* @public
|
|
1584
1584
|
*/
|
|
1585
1585
|
iotJobArn?: string;
|
|
1586
1586
|
}
|
|
@@ -1589,8 +1589,8 @@ export interface CreateDeploymentResponse {
|
|
|
1589
1589
|
*/
|
|
1590
1590
|
export interface DeleteComponentRequest {
|
|
1591
1591
|
/**
|
|
1592
|
-
* @public
|
|
1593
1592
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
|
|
1593
|
+
* @public
|
|
1594
1594
|
*/
|
|
1595
1595
|
arn: string | undefined;
|
|
1596
1596
|
}
|
|
@@ -1599,8 +1599,8 @@ export interface DeleteComponentRequest {
|
|
|
1599
1599
|
*/
|
|
1600
1600
|
export interface DeleteCoreDeviceRequest {
|
|
1601
1601
|
/**
|
|
1602
|
-
* @public
|
|
1603
1602
|
* <p>The name of the core device. This is also the name of the IoT thing.</p>
|
|
1603
|
+
* @public
|
|
1604
1604
|
*/
|
|
1605
1605
|
coreDeviceThingName: string | undefined;
|
|
1606
1606
|
}
|
|
@@ -1609,8 +1609,8 @@ export interface DeleteCoreDeviceRequest {
|
|
|
1609
1609
|
*/
|
|
1610
1610
|
export interface DeleteDeploymentRequest {
|
|
1611
1611
|
/**
|
|
1612
|
-
* @public
|
|
1613
1612
|
* <p>The ID of the deployment.</p>
|
|
1613
|
+
* @public
|
|
1614
1614
|
*/
|
|
1615
1615
|
deploymentId: string | undefined;
|
|
1616
1616
|
}
|
|
@@ -1630,48 +1630,48 @@ export declare const DeploymentStatus: {
|
|
|
1630
1630
|
*/
|
|
1631
1631
|
export type DeploymentStatus = (typeof DeploymentStatus)[keyof typeof DeploymentStatus];
|
|
1632
1632
|
/**
|
|
1633
|
-
* @public
|
|
1634
1633
|
* <p>Contains information about a deployment.</p>
|
|
1634
|
+
* @public
|
|
1635
1635
|
*/
|
|
1636
1636
|
export interface Deployment {
|
|
1637
1637
|
/**
|
|
1638
|
-
* @public
|
|
1639
1638
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the target IoT thing or thing group. When creating a subdeployment, the targetARN can only be a thing group.</p>
|
|
1639
|
+
* @public
|
|
1640
1640
|
*/
|
|
1641
1641
|
targetArn?: string;
|
|
1642
1642
|
/**
|
|
1643
|
-
* @public
|
|
1644
1643
|
* <p>The revision number of the deployment.</p>
|
|
1644
|
+
* @public
|
|
1645
1645
|
*/
|
|
1646
1646
|
revisionId?: string;
|
|
1647
1647
|
/**
|
|
1648
|
-
* @public
|
|
1649
1648
|
* <p>The ID of the deployment.</p>
|
|
1649
|
+
* @public
|
|
1650
1650
|
*/
|
|
1651
1651
|
deploymentId?: string;
|
|
1652
1652
|
/**
|
|
1653
|
-
* @public
|
|
1654
1653
|
* <p>The name of the deployment.</p>
|
|
1654
|
+
* @public
|
|
1655
1655
|
*/
|
|
1656
1656
|
deploymentName?: string;
|
|
1657
1657
|
/**
|
|
1658
|
-
* @public
|
|
1659
1658
|
* <p>The time at which the deployment was created, expressed in ISO 8601 format.</p>
|
|
1659
|
+
* @public
|
|
1660
1660
|
*/
|
|
1661
1661
|
creationTimestamp?: Date;
|
|
1662
1662
|
/**
|
|
1663
|
-
* @public
|
|
1664
1663
|
* <p>The status of the deployment.</p>
|
|
1664
|
+
* @public
|
|
1665
1665
|
*/
|
|
1666
1666
|
deploymentStatus?: DeploymentStatus;
|
|
1667
1667
|
/**
|
|
1668
|
-
* @public
|
|
1669
1668
|
* <p>Whether or not the deployment is the latest revision for its target.</p>
|
|
1669
|
+
* @public
|
|
1670
1670
|
*/
|
|
1671
1671
|
isLatestForTarget?: boolean;
|
|
1672
1672
|
/**
|
|
1673
|
-
* @public
|
|
1674
1673
|
* <p>The parent deployment's target <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> within a subdeployment.</p>
|
|
1674
|
+
* @public
|
|
1675
1675
|
*/
|
|
1676
1676
|
parentTargetArn?: string;
|
|
1677
1677
|
}
|
|
@@ -1692,8 +1692,8 @@ export type DeploymentHistoryFilter = (typeof DeploymentHistoryFilter)[keyof typ
|
|
|
1692
1692
|
*/
|
|
1693
1693
|
export interface DescribeComponentRequest {
|
|
1694
1694
|
/**
|
|
1695
|
-
* @public
|
|
1696
1695
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
|
|
1696
|
+
* @public
|
|
1697
1697
|
*/
|
|
1698
1698
|
arn: string | undefined;
|
|
1699
1699
|
}
|
|
@@ -1702,51 +1702,51 @@ export interface DescribeComponentRequest {
|
|
|
1702
1702
|
*/
|
|
1703
1703
|
export interface DescribeComponentResponse {
|
|
1704
1704
|
/**
|
|
1705
|
-
* @public
|
|
1706
1705
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
|
|
1706
|
+
* @public
|
|
1707
1707
|
*/
|
|
1708
1708
|
arn?: string;
|
|
1709
1709
|
/**
|
|
1710
|
-
* @public
|
|
1711
1710
|
* <p>The name of the component.</p>
|
|
1711
|
+
* @public
|
|
1712
1712
|
*/
|
|
1713
1713
|
componentName?: string;
|
|
1714
1714
|
/**
|
|
1715
|
-
* @public
|
|
1716
1715
|
* <p>The version of the component.</p>
|
|
1716
|
+
* @public
|
|
1717
1717
|
*/
|
|
1718
1718
|
componentVersion?: string;
|
|
1719
1719
|
/**
|
|
1720
|
-
* @public
|
|
1721
1720
|
* <p>The time at which the component was created, expressed in ISO 8601 format.</p>
|
|
1721
|
+
* @public
|
|
1722
1722
|
*/
|
|
1723
1723
|
creationTimestamp?: Date;
|
|
1724
1724
|
/**
|
|
1725
|
-
* @public
|
|
1726
1725
|
* <p>The publisher of the component version.</p>
|
|
1726
|
+
* @public
|
|
1727
1727
|
*/
|
|
1728
1728
|
publisher?: string;
|
|
1729
1729
|
/**
|
|
1730
|
-
* @public
|
|
1731
1730
|
* <p>The description of the component version.</p>
|
|
1731
|
+
* @public
|
|
1732
1732
|
*/
|
|
1733
1733
|
description?: string;
|
|
1734
1734
|
/**
|
|
1735
|
-
* @public
|
|
1736
1735
|
* <p>The status of the component version in IoT Greengrass V2. This status
|
|
1737
1736
|
* is different from the status of the component on a core device.</p>
|
|
1737
|
+
* @public
|
|
1738
1738
|
*/
|
|
1739
1739
|
status?: CloudComponentStatus;
|
|
1740
1740
|
/**
|
|
1741
|
-
* @public
|
|
1742
1741
|
* <p>The platforms that the component version supports.</p>
|
|
1742
|
+
* @public
|
|
1743
1743
|
*/
|
|
1744
1744
|
platforms?: ComponentPlatform[];
|
|
1745
1745
|
/**
|
|
1746
|
-
* @public
|
|
1747
1746
|
* <p>A list of key-value pairs that contain metadata for the resource. For more
|
|
1748
1747
|
* information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html">Tag your
|
|
1749
1748
|
* resources</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
|
|
1749
|
+
* @public
|
|
1750
1750
|
*/
|
|
1751
1751
|
tags?: Record<string, string>;
|
|
1752
1752
|
}
|
|
@@ -1760,9 +1760,9 @@ export interface DisassociateServiceRoleFromAccountRequest {
|
|
|
1760
1760
|
*/
|
|
1761
1761
|
export interface DisassociateServiceRoleFromAccountResponse {
|
|
1762
1762
|
/**
|
|
1763
|
-
* @public
|
|
1764
1763
|
* <p>The time when the service role was disassociated from IoT Greengrass for your Amazon Web Services account in this
|
|
1765
1764
|
* Amazon Web Services Region.</p>
|
|
1765
|
+
* @public
|
|
1766
1766
|
*/
|
|
1767
1767
|
disassociatedAt?: string;
|
|
1768
1768
|
}
|
|
@@ -1785,7 +1785,6 @@ export declare const EffectiveDeploymentExecutionStatus: {
|
|
|
1785
1785
|
*/
|
|
1786
1786
|
export type EffectiveDeploymentExecutionStatus = (typeof EffectiveDeploymentExecutionStatus)[keyof typeof EffectiveDeploymentExecutionStatus];
|
|
1787
1787
|
/**
|
|
1788
|
-
* @public
|
|
1789
1788
|
* <p>Contains all error-related information for the deployment record. The status details will
|
|
1790
1789
|
* be null if the deployment is in a success state.</p>
|
|
1791
1790
|
* <note>
|
|
@@ -1793,61 +1792,61 @@ export type EffectiveDeploymentExecutionStatus = (typeof EffectiveDeploymentExec
|
|
|
1793
1792
|
* <code>errorTypes</code> response. This field will not be returned for earlier Greengrass nucleus
|
|
1794
1793
|
* versions.</p>
|
|
1795
1794
|
* </note>
|
|
1795
|
+
* @public
|
|
1796
1796
|
*/
|
|
1797
1797
|
export interface EffectiveDeploymentStatusDetails {
|
|
1798
1798
|
/**
|
|
1799
|
-
* @public
|
|
1800
1799
|
* <p>Contains an ordered list of short error codes that range from the most generic error to
|
|
1801
1800
|
* the most specific one. The error codes describe the reason for failure whenever the
|
|
1802
1801
|
* <code>coreDeviceExecutionStatus</code> is in a failed state. The response will be an empty
|
|
1803
1802
|
* list if there is no error.</p>
|
|
1803
|
+
* @public
|
|
1804
1804
|
*/
|
|
1805
1805
|
errorStack?: string[];
|
|
1806
1806
|
/**
|
|
1807
|
-
* @public
|
|
1808
1807
|
* <p>Contains tags which describe the error. You can use the error types to classify errors to
|
|
1809
1808
|
* assist with remediating the failure. The response will be an empty list if there is no
|
|
1810
1809
|
* error.</p>
|
|
1810
|
+
* @public
|
|
1811
1811
|
*/
|
|
1812
1812
|
errorTypes?: string[];
|
|
1813
1813
|
}
|
|
1814
1814
|
/**
|
|
1815
|
-
* @public
|
|
1816
1815
|
* <p>Contains information about a deployment job that IoT Greengrass sends to a Greengrass core device.</p>
|
|
1816
|
+
* @public
|
|
1817
1817
|
*/
|
|
1818
1818
|
export interface EffectiveDeployment {
|
|
1819
1819
|
/**
|
|
1820
|
-
* @public
|
|
1821
1820
|
* <p>The ID of the deployment.</p>
|
|
1821
|
+
* @public
|
|
1822
1822
|
*/
|
|
1823
1823
|
deploymentId: string | undefined;
|
|
1824
1824
|
/**
|
|
1825
|
-
* @public
|
|
1826
1825
|
* <p>The name of the deployment.</p>
|
|
1826
|
+
* @public
|
|
1827
1827
|
*/
|
|
1828
1828
|
deploymentName: string | undefined;
|
|
1829
1829
|
/**
|
|
1830
|
-
* @public
|
|
1831
1830
|
* <p>The ID of the IoT job that applies the deployment to target devices.</p>
|
|
1831
|
+
* @public
|
|
1832
1832
|
*/
|
|
1833
1833
|
iotJobId?: string;
|
|
1834
1834
|
/**
|
|
1835
|
-
* @public
|
|
1836
1835
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the IoT job that applies the deployment to target devices.</p>
|
|
1836
|
+
* @public
|
|
1837
1837
|
*/
|
|
1838
1838
|
iotJobArn?: string;
|
|
1839
1839
|
/**
|
|
1840
|
-
* @public
|
|
1841
1840
|
* <p>The description of the deployment job.</p>
|
|
1841
|
+
* @public
|
|
1842
1842
|
*/
|
|
1843
1843
|
description?: string;
|
|
1844
1844
|
/**
|
|
1845
|
-
* @public
|
|
1846
1845
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the target IoT thing or thing group.</p>
|
|
1846
|
+
* @public
|
|
1847
1847
|
*/
|
|
1848
1848
|
targetArn: string | undefined;
|
|
1849
1849
|
/**
|
|
1850
|
-
* @public
|
|
1851
1850
|
* <p>The status of the deployment job on the Greengrass core device.</p>
|
|
1852
1851
|
* <ul>
|
|
1853
1852
|
* <li>
|
|
@@ -1889,28 +1888,29 @@ export interface EffectiveDeployment {
|
|
|
1889
1888
|
* successfully.</p>
|
|
1890
1889
|
* </li>
|
|
1891
1890
|
* </ul>
|
|
1891
|
+
* @public
|
|
1892
1892
|
*/
|
|
1893
1893
|
coreDeviceExecutionStatus: EffectiveDeploymentExecutionStatus | undefined;
|
|
1894
1894
|
/**
|
|
1895
|
-
* @public
|
|
1896
1895
|
* <p>The reason code for the update, if the job was updated.</p>
|
|
1896
|
+
* @public
|
|
1897
1897
|
*/
|
|
1898
1898
|
reason?: string;
|
|
1899
1899
|
/**
|
|
1900
|
-
* @public
|
|
1901
1900
|
* <p>The time at which the deployment was created, expressed in ISO 8601 format.</p>
|
|
1901
|
+
* @public
|
|
1902
1902
|
*/
|
|
1903
1903
|
creationTimestamp: Date | undefined;
|
|
1904
1904
|
/**
|
|
1905
|
-
* @public
|
|
1906
1905
|
* <p>The time at which the deployment job was last modified, expressed in ISO 8601
|
|
1907
1906
|
* format.</p>
|
|
1907
|
+
* @public
|
|
1908
1908
|
*/
|
|
1909
1909
|
modifiedTimestamp: Date | undefined;
|
|
1910
1910
|
/**
|
|
1911
|
-
* @public
|
|
1912
1911
|
* <p>The status details that explain why a deployment has an error. This response will be null
|
|
1913
1912
|
* if the deployment is in a success state.</p>
|
|
1913
|
+
* @public
|
|
1914
1914
|
*/
|
|
1915
1915
|
statusDetails?: EffectiveDeploymentStatusDetails;
|
|
1916
1916
|
}
|
|
@@ -1931,13 +1931,13 @@ export type RecipeOutputFormat = (typeof RecipeOutputFormat)[keyof typeof Recipe
|
|
|
1931
1931
|
*/
|
|
1932
1932
|
export interface GetComponentRequest {
|
|
1933
1933
|
/**
|
|
1934
|
-
* @public
|
|
1935
1934
|
* <p>The format of the recipe.</p>
|
|
1935
|
+
* @public
|
|
1936
1936
|
*/
|
|
1937
1937
|
recipeOutputFormat?: RecipeOutputFormat;
|
|
1938
1938
|
/**
|
|
1939
|
-
* @public
|
|
1940
1939
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
|
|
1940
|
+
* @public
|
|
1941
1941
|
*/
|
|
1942
1942
|
arn: string | undefined;
|
|
1943
1943
|
}
|
|
@@ -1946,20 +1946,20 @@ export interface GetComponentRequest {
|
|
|
1946
1946
|
*/
|
|
1947
1947
|
export interface GetComponentResponse {
|
|
1948
1948
|
/**
|
|
1949
|
-
* @public
|
|
1950
1949
|
* <p>The format of the recipe.</p>
|
|
1950
|
+
* @public
|
|
1951
1951
|
*/
|
|
1952
1952
|
recipeOutputFormat: RecipeOutputFormat | undefined;
|
|
1953
1953
|
/**
|
|
1954
|
-
* @public
|
|
1955
1954
|
* <p>The recipe of the component version.</p>
|
|
1955
|
+
* @public
|
|
1956
1956
|
*/
|
|
1957
1957
|
recipe: Uint8Array | undefined;
|
|
1958
1958
|
/**
|
|
1959
|
-
* @public
|
|
1960
1959
|
* <p>A list of key-value pairs that contain metadata for the resource. For more
|
|
1961
1960
|
* information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html">Tag your
|
|
1962
1961
|
* resources</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
|
|
1962
|
+
* @public
|
|
1963
1963
|
*/
|
|
1964
1964
|
tags?: Record<string, string>;
|
|
1965
1965
|
}
|
|
@@ -1968,18 +1968,18 @@ export interface GetComponentResponse {
|
|
|
1968
1968
|
*/
|
|
1969
1969
|
export interface GetComponentVersionArtifactRequest {
|
|
1970
1970
|
/**
|
|
1971
|
-
* @public
|
|
1972
1971
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version. Specify the ARN of a public or a Lambda component version.</p>
|
|
1972
|
+
* @public
|
|
1973
1973
|
*/
|
|
1974
1974
|
arn: string | undefined;
|
|
1975
1975
|
/**
|
|
1976
|
-
* @public
|
|
1977
1976
|
* <p>The name of the artifact.</p>
|
|
1978
1977
|
* <p>You can use the <a href="https://docs.aws.amazon.com/greengrass/v2/APIReference/API_GetComponent.html">GetComponent</a> operation to
|
|
1979
1978
|
* download the component recipe, which includes the URI of the artifact. The artifact name is
|
|
1980
1979
|
* the section of the URI after the scheme. For example, in the artifact URI
|
|
1981
1980
|
* <code>greengrass:SomeArtifact.zip</code>, the artifact name is
|
|
1982
1981
|
* <code>SomeArtifact.zip</code>.</p>
|
|
1982
|
+
* @public
|
|
1983
1983
|
*/
|
|
1984
1984
|
artifactName: string | undefined;
|
|
1985
1985
|
}
|
|
@@ -1988,8 +1988,8 @@ export interface GetComponentVersionArtifactRequest {
|
|
|
1988
1988
|
*/
|
|
1989
1989
|
export interface GetComponentVersionArtifactResponse {
|
|
1990
1990
|
/**
|
|
1991
|
-
* @public
|
|
1992
1991
|
* <p>The URL of the artifact.</p>
|
|
1992
|
+
* @public
|
|
1993
1993
|
*/
|
|
1994
1994
|
preSignedUrl: string | undefined;
|
|
1995
1995
|
}
|
|
@@ -1998,8 +1998,8 @@ export interface GetComponentVersionArtifactResponse {
|
|
|
1998
1998
|
*/
|
|
1999
1999
|
export interface GetConnectivityInfoRequest {
|
|
2000
2000
|
/**
|
|
2001
|
-
* @public
|
|
2002
2001
|
* <p>The name of the core device. This is also the name of the IoT thing.</p>
|
|
2002
|
+
* @public
|
|
2003
2003
|
*/
|
|
2004
2004
|
thingName: string | undefined;
|
|
2005
2005
|
}
|
|
@@ -2008,13 +2008,13 @@ export interface GetConnectivityInfoRequest {
|
|
|
2008
2008
|
*/
|
|
2009
2009
|
export interface GetConnectivityInfoResponse {
|
|
2010
2010
|
/**
|
|
2011
|
-
* @public
|
|
2012
2011
|
* <p>The connectivity information for the core device.</p>
|
|
2012
|
+
* @public
|
|
2013
2013
|
*/
|
|
2014
2014
|
connectivityInfo?: ConnectivityInfo[];
|
|
2015
2015
|
/**
|
|
2016
|
-
* @public
|
|
2017
2016
|
* <p>A message about the connectivity information request.</p>
|
|
2017
|
+
* @public
|
|
2018
2018
|
*/
|
|
2019
2019
|
message?: string;
|
|
2020
2020
|
}
|
|
@@ -2023,8 +2023,8 @@ export interface GetConnectivityInfoResponse {
|
|
|
2023
2023
|
*/
|
|
2024
2024
|
export interface GetCoreDeviceRequest {
|
|
2025
2025
|
/**
|
|
2026
|
-
* @public
|
|
2027
2026
|
* <p>The name of the core device. This is also the name of the IoT thing.</p>
|
|
2027
|
+
* @public
|
|
2028
2028
|
*/
|
|
2029
2029
|
coreDeviceThingName: string | undefined;
|
|
2030
2030
|
}
|
|
@@ -2033,30 +2033,29 @@ export interface GetCoreDeviceRequest {
|
|
|
2033
2033
|
*/
|
|
2034
2034
|
export interface GetCoreDeviceResponse {
|
|
2035
2035
|
/**
|
|
2036
|
-
* @public
|
|
2037
2036
|
* <p>The name of the core device. This is also the name of the IoT thing.</p>
|
|
2037
|
+
* @public
|
|
2038
2038
|
*/
|
|
2039
2039
|
coreDeviceThingName?: string;
|
|
2040
2040
|
/**
|
|
2041
|
-
* @public
|
|
2042
2041
|
* <p>The version of the IoT Greengrass Core software that the core device runs. This version is equivalent to
|
|
2043
2042
|
* the version of the Greengrass nucleus component that runs on the core device. For more information,
|
|
2044
2043
|
* see the <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html">Greengrass nucleus
|
|
2045
2044
|
* component</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
|
|
2045
|
+
* @public
|
|
2046
2046
|
*/
|
|
2047
2047
|
coreVersion?: string;
|
|
2048
2048
|
/**
|
|
2049
|
-
* @public
|
|
2050
2049
|
* <p>The operating system platform that the core device runs.</p>
|
|
2050
|
+
* @public
|
|
2051
2051
|
*/
|
|
2052
2052
|
platform?: string;
|
|
2053
2053
|
/**
|
|
2054
|
-
* @public
|
|
2055
2054
|
* <p>The computer architecture of the core device.</p>
|
|
2055
|
+
* @public
|
|
2056
2056
|
*/
|
|
2057
2057
|
architecture?: string;
|
|
2058
2058
|
/**
|
|
2059
|
-
* @public
|
|
2060
2059
|
* <p>The status of the core device. The core device status can be:</p>
|
|
2061
2060
|
* <ul>
|
|
2062
2061
|
* <li>
|
|
@@ -2069,19 +2068,20 @@ export interface GetCoreDeviceResponse {
|
|
|
2069
2068
|
* on the core device.</p>
|
|
2070
2069
|
* </li>
|
|
2071
2070
|
* </ul>
|
|
2071
|
+
* @public
|
|
2072
2072
|
*/
|
|
2073
2073
|
status?: CoreDeviceStatus;
|
|
2074
2074
|
/**
|
|
2075
|
-
* @public
|
|
2076
2075
|
* <p>The time at which the core device's status last updated, expressed in ISO 8601
|
|
2077
2076
|
* format.</p>
|
|
2077
|
+
* @public
|
|
2078
2078
|
*/
|
|
2079
2079
|
lastStatusUpdateTimestamp?: Date;
|
|
2080
2080
|
/**
|
|
2081
|
-
* @public
|
|
2082
2081
|
* <p>A list of key-value pairs that contain metadata for the resource. For more
|
|
2083
2082
|
* information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html">Tag your
|
|
2084
2083
|
* resources</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
|
|
2084
|
+
* @public
|
|
2085
2085
|
*/
|
|
2086
2086
|
tags?: Record<string, string>;
|
|
2087
2087
|
}
|
|
@@ -2090,8 +2090,8 @@ export interface GetCoreDeviceResponse {
|
|
|
2090
2090
|
*/
|
|
2091
2091
|
export interface GetDeploymentRequest {
|
|
2092
2092
|
/**
|
|
2093
|
-
* @public
|
|
2094
2093
|
* <p>The ID of the deployment.</p>
|
|
2094
|
+
* @public
|
|
2095
2095
|
*/
|
|
2096
2096
|
deploymentId: string | undefined;
|
|
2097
2097
|
}
|
|
@@ -2100,78 +2100,78 @@ export interface GetDeploymentRequest {
|
|
|
2100
2100
|
*/
|
|
2101
2101
|
export interface GetDeploymentResponse {
|
|
2102
2102
|
/**
|
|
2103
|
-
* @public
|
|
2104
2103
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the target IoT thing or thing group.</p>
|
|
2104
|
+
* @public
|
|
2105
2105
|
*/
|
|
2106
2106
|
targetArn?: string;
|
|
2107
2107
|
/**
|
|
2108
|
-
* @public
|
|
2109
2108
|
* <p>The revision number of the deployment.</p>
|
|
2109
|
+
* @public
|
|
2110
2110
|
*/
|
|
2111
2111
|
revisionId?: string;
|
|
2112
2112
|
/**
|
|
2113
|
-
* @public
|
|
2114
2113
|
* <p>The ID of the deployment.</p>
|
|
2114
|
+
* @public
|
|
2115
2115
|
*/
|
|
2116
2116
|
deploymentId?: string;
|
|
2117
2117
|
/**
|
|
2118
|
-
* @public
|
|
2119
2118
|
* <p>The name of the deployment.</p>
|
|
2119
|
+
* @public
|
|
2120
2120
|
*/
|
|
2121
2121
|
deploymentName?: string;
|
|
2122
2122
|
/**
|
|
2123
|
-
* @public
|
|
2124
2123
|
* <p>The status of the deployment.</p>
|
|
2124
|
+
* @public
|
|
2125
2125
|
*/
|
|
2126
2126
|
deploymentStatus?: DeploymentStatus;
|
|
2127
2127
|
/**
|
|
2128
|
-
* @public
|
|
2129
2128
|
* <p>The ID of the IoT job that applies the deployment to target devices.</p>
|
|
2129
|
+
* @public
|
|
2130
2130
|
*/
|
|
2131
2131
|
iotJobId?: string;
|
|
2132
2132
|
/**
|
|
2133
|
-
* @public
|
|
2134
2133
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the IoT job that applies the deployment to target devices.</p>
|
|
2134
|
+
* @public
|
|
2135
2135
|
*/
|
|
2136
2136
|
iotJobArn?: string;
|
|
2137
2137
|
/**
|
|
2138
|
-
* @public
|
|
2139
2138
|
* <p>The components to deploy. This is a dictionary, where each key is the name of a component,
|
|
2140
2139
|
* and each key's value is the version and configuration to deploy for that component.</p>
|
|
2140
|
+
* @public
|
|
2141
2141
|
*/
|
|
2142
2142
|
components?: Record<string, ComponentDeploymentSpecification>;
|
|
2143
2143
|
/**
|
|
2144
|
-
* @public
|
|
2145
2144
|
* <p>The deployment policies for the deployment. These policies define how the deployment
|
|
2146
2145
|
* updates components and handles failure.</p>
|
|
2146
|
+
* @public
|
|
2147
2147
|
*/
|
|
2148
2148
|
deploymentPolicies?: DeploymentPolicies;
|
|
2149
2149
|
/**
|
|
2150
|
-
* @public
|
|
2151
2150
|
* <p>The job configuration for the deployment configuration. The job configuration specifies
|
|
2152
2151
|
* the rollout, timeout, and stop configurations for the deployment configuration.</p>
|
|
2152
|
+
* @public
|
|
2153
2153
|
*/
|
|
2154
2154
|
iotJobConfiguration?: DeploymentIoTJobConfiguration;
|
|
2155
2155
|
/**
|
|
2156
|
-
* @public
|
|
2157
2156
|
* <p>The time at which the deployment was created, expressed in ISO 8601 format.</p>
|
|
2157
|
+
* @public
|
|
2158
2158
|
*/
|
|
2159
2159
|
creationTimestamp?: Date;
|
|
2160
2160
|
/**
|
|
2161
|
-
* @public
|
|
2162
2161
|
* <p>Whether or not the deployment is the latest revision for its target.</p>
|
|
2162
|
+
* @public
|
|
2163
2163
|
*/
|
|
2164
2164
|
isLatestForTarget?: boolean;
|
|
2165
2165
|
/**
|
|
2166
|
-
* @public
|
|
2167
2166
|
* <p>The parent deployment's target <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> within a subdeployment.</p>
|
|
2167
|
+
* @public
|
|
2168
2168
|
*/
|
|
2169
2169
|
parentTargetArn?: string;
|
|
2170
2170
|
/**
|
|
2171
|
-
* @public
|
|
2172
2171
|
* <p>A list of key-value pairs that contain metadata for the resource. For more
|
|
2173
2172
|
* information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html">Tag your
|
|
2174
2173
|
* resources</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
|
|
2174
|
+
* @public
|
|
2175
2175
|
*/
|
|
2176
2176
|
tags?: Record<string, string>;
|
|
2177
2177
|
}
|
|
@@ -2185,15 +2185,15 @@ export interface GetServiceRoleForAccountRequest {
|
|
|
2185
2185
|
*/
|
|
2186
2186
|
export interface GetServiceRoleForAccountResponse {
|
|
2187
2187
|
/**
|
|
2188
|
-
* @public
|
|
2189
2188
|
* <p>The time when the service role was associated with IoT Greengrass for your Amazon Web Services account in this
|
|
2190
2189
|
* Amazon Web Services Region.</p>
|
|
2190
|
+
* @public
|
|
2191
2191
|
*/
|
|
2192
2192
|
associatedAt?: string;
|
|
2193
2193
|
/**
|
|
2194
|
-
* @public
|
|
2195
2194
|
* <p>The ARN of the service role that is associated with IoT Greengrass for your Amazon Web Services account in this
|
|
2196
2195
|
* Amazon Web Services Region.</p>
|
|
2196
|
+
* @public
|
|
2197
2197
|
*/
|
|
2198
2198
|
roleArn?: string;
|
|
2199
2199
|
}
|
|
@@ -2202,18 +2202,18 @@ export interface GetServiceRoleForAccountResponse {
|
|
|
2202
2202
|
*/
|
|
2203
2203
|
export interface ListClientDevicesAssociatedWithCoreDeviceRequest {
|
|
2204
2204
|
/**
|
|
2205
|
-
* @public
|
|
2206
2205
|
* <p>The name of the core device. This is also the name of the IoT thing.</p>
|
|
2206
|
+
* @public
|
|
2207
2207
|
*/
|
|
2208
2208
|
coreDeviceThingName: string | undefined;
|
|
2209
2209
|
/**
|
|
2210
|
-
* @public
|
|
2211
2210
|
* <p>The maximum number of results to be returned per paginated request.</p>
|
|
2211
|
+
* @public
|
|
2212
2212
|
*/
|
|
2213
2213
|
maxResults?: number;
|
|
2214
2214
|
/**
|
|
2215
|
-
* @public
|
|
2216
2215
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
2216
|
+
* @public
|
|
2217
2217
|
*/
|
|
2218
2218
|
nextToken?: string;
|
|
2219
2219
|
}
|
|
@@ -2222,13 +2222,13 @@ export interface ListClientDevicesAssociatedWithCoreDeviceRequest {
|
|
|
2222
2222
|
*/
|
|
2223
2223
|
export interface ListClientDevicesAssociatedWithCoreDeviceResponse {
|
|
2224
2224
|
/**
|
|
2225
|
-
* @public
|
|
2226
2225
|
* <p>A list that describes the client devices that are associated with the core device.</p>
|
|
2226
|
+
* @public
|
|
2227
2227
|
*/
|
|
2228
2228
|
associatedClientDevices?: AssociatedClientDevice[];
|
|
2229
2229
|
/**
|
|
2230
|
-
* @public
|
|
2231
2230
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
2231
|
+
* @public
|
|
2232
2232
|
*/
|
|
2233
2233
|
nextToken?: string;
|
|
2234
2234
|
}
|
|
@@ -2237,20 +2237,20 @@ export interface ListClientDevicesAssociatedWithCoreDeviceResponse {
|
|
|
2237
2237
|
*/
|
|
2238
2238
|
export interface ListComponentsRequest {
|
|
2239
2239
|
/**
|
|
2240
|
-
* @public
|
|
2241
2240
|
* <p>The scope of the components to list.</p>
|
|
2242
2241
|
* <p>Default: <code>PRIVATE</code>
|
|
2243
2242
|
* </p>
|
|
2243
|
+
* @public
|
|
2244
2244
|
*/
|
|
2245
2245
|
scope?: ComponentVisibilityScope;
|
|
2246
2246
|
/**
|
|
2247
|
-
* @public
|
|
2248
2247
|
* <p>The maximum number of results to be returned per paginated request.</p>
|
|
2248
|
+
* @public
|
|
2249
2249
|
*/
|
|
2250
2250
|
maxResults?: number;
|
|
2251
2251
|
/**
|
|
2252
|
-
* @public
|
|
2253
2252
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
2253
|
+
* @public
|
|
2254
2254
|
*/
|
|
2255
2255
|
nextToken?: string;
|
|
2256
2256
|
}
|
|
@@ -2259,13 +2259,13 @@ export interface ListComponentsRequest {
|
|
|
2259
2259
|
*/
|
|
2260
2260
|
export interface ListComponentsResponse {
|
|
2261
2261
|
/**
|
|
2262
|
-
* @public
|
|
2263
2262
|
* <p>A list that summarizes each component.</p>
|
|
2263
|
+
* @public
|
|
2264
2264
|
*/
|
|
2265
2265
|
components?: Component[];
|
|
2266
2266
|
/**
|
|
2267
|
-
* @public
|
|
2268
2267
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
2268
|
+
* @public
|
|
2269
2269
|
*/
|
|
2270
2270
|
nextToken?: string;
|
|
2271
2271
|
}
|
|
@@ -2274,18 +2274,18 @@ export interface ListComponentsResponse {
|
|
|
2274
2274
|
*/
|
|
2275
2275
|
export interface ListComponentVersionsRequest {
|
|
2276
2276
|
/**
|
|
2277
|
-
* @public
|
|
2278
2277
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component.</p>
|
|
2278
|
+
* @public
|
|
2279
2279
|
*/
|
|
2280
2280
|
arn: string | undefined;
|
|
2281
2281
|
/**
|
|
2282
|
-
* @public
|
|
2283
2282
|
* <p>The maximum number of results to be returned per paginated request.</p>
|
|
2283
|
+
* @public
|
|
2284
2284
|
*/
|
|
2285
2285
|
maxResults?: number;
|
|
2286
2286
|
/**
|
|
2287
|
-
* @public
|
|
2288
2287
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
2288
|
+
* @public
|
|
2289
2289
|
*/
|
|
2290
2290
|
nextToken?: string;
|
|
2291
2291
|
}
|
|
@@ -2294,13 +2294,13 @@ export interface ListComponentVersionsRequest {
|
|
|
2294
2294
|
*/
|
|
2295
2295
|
export interface ListComponentVersionsResponse {
|
|
2296
2296
|
/**
|
|
2297
|
-
* @public
|
|
2298
2297
|
* <p>A list of versions that exist for the component.</p>
|
|
2298
|
+
* @public
|
|
2299
2299
|
*/
|
|
2300
2300
|
componentVersions?: ComponentVersionListItem[];
|
|
2301
2301
|
/**
|
|
2302
|
-
* @public
|
|
2303
2302
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
2303
|
+
* @public
|
|
2304
2304
|
*/
|
|
2305
2305
|
nextToken?: string;
|
|
2306
2306
|
}
|
|
@@ -2309,15 +2309,14 @@ export interface ListComponentVersionsResponse {
|
|
|
2309
2309
|
*/
|
|
2310
2310
|
export interface ListCoreDevicesRequest {
|
|
2311
2311
|
/**
|
|
2312
|
-
* @public
|
|
2313
2312
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the IoT thing group by which to filter. If you specify this parameter,
|
|
2314
2313
|
* the list includes only core devices that have successfully deployed a deployment that targets
|
|
2315
2314
|
* the thing group. When you remove a core device from a thing group, the list continues to
|
|
2316
2315
|
* include that core device.</p>
|
|
2316
|
+
* @public
|
|
2317
2317
|
*/
|
|
2318
2318
|
thingGroupArn?: string;
|
|
2319
2319
|
/**
|
|
2320
|
-
* @public
|
|
2321
2320
|
* <p>The core device status by which to filter. If you specify this parameter, the list
|
|
2322
2321
|
* includes only core devices that have this status. Choose one of the following options:</p>
|
|
2323
2322
|
* <ul>
|
|
@@ -2331,16 +2330,17 @@ export interface ListCoreDevicesRequest {
|
|
|
2331
2330
|
* on the core device.</p>
|
|
2332
2331
|
* </li>
|
|
2333
2332
|
* </ul>
|
|
2333
|
+
* @public
|
|
2334
2334
|
*/
|
|
2335
2335
|
status?: CoreDeviceStatus;
|
|
2336
2336
|
/**
|
|
2337
|
-
* @public
|
|
2338
2337
|
* <p>The maximum number of results to be returned per paginated request.</p>
|
|
2338
|
+
* @public
|
|
2339
2339
|
*/
|
|
2340
2340
|
maxResults?: number;
|
|
2341
2341
|
/**
|
|
2342
|
-
* @public
|
|
2343
2342
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
2343
|
+
* @public
|
|
2344
2344
|
*/
|
|
2345
2345
|
nextToken?: string;
|
|
2346
2346
|
}
|
|
@@ -2349,13 +2349,13 @@ export interface ListCoreDevicesRequest {
|
|
|
2349
2349
|
*/
|
|
2350
2350
|
export interface ListCoreDevicesResponse {
|
|
2351
2351
|
/**
|
|
2352
|
-
* @public
|
|
2353
2352
|
* <p>A list that summarizes each core device.</p>
|
|
2353
|
+
* @public
|
|
2354
2354
|
*/
|
|
2355
2355
|
coreDevices?: CoreDevice[];
|
|
2356
2356
|
/**
|
|
2357
|
-
* @public
|
|
2358
2357
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
2358
|
+
* @public
|
|
2359
2359
|
*/
|
|
2360
2360
|
nextToken?: string;
|
|
2361
2361
|
}
|
|
@@ -2364,12 +2364,11 @@ export interface ListCoreDevicesResponse {
|
|
|
2364
2364
|
*/
|
|
2365
2365
|
export interface ListDeploymentsRequest {
|
|
2366
2366
|
/**
|
|
2367
|
-
* @public
|
|
2368
2367
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the target IoT thing or thing group.</p>
|
|
2368
|
+
* @public
|
|
2369
2369
|
*/
|
|
2370
2370
|
targetArn?: string;
|
|
2371
2371
|
/**
|
|
2372
|
-
* @public
|
|
2373
2372
|
* <p>The filter for the list of deployments. Choose one of the following options:</p>
|
|
2374
2373
|
* <ul>
|
|
2375
2374
|
* <li>
|
|
@@ -2384,21 +2383,22 @@ export interface ListDeploymentsRequest {
|
|
|
2384
2383
|
* </ul>
|
|
2385
2384
|
* <p>Default: <code>LATEST_ONLY</code>
|
|
2386
2385
|
* </p>
|
|
2386
|
+
* @public
|
|
2387
2387
|
*/
|
|
2388
2388
|
historyFilter?: DeploymentHistoryFilter;
|
|
2389
2389
|
/**
|
|
2390
|
-
* @public
|
|
2391
2390
|
* <p>The parent deployment's target <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> within a subdeployment.</p>
|
|
2391
|
+
* @public
|
|
2392
2392
|
*/
|
|
2393
2393
|
parentTargetArn?: string;
|
|
2394
2394
|
/**
|
|
2395
|
-
* @public
|
|
2396
2395
|
* <p>The maximum number of results to be returned per paginated request.</p>
|
|
2396
|
+
* @public
|
|
2397
2397
|
*/
|
|
2398
2398
|
maxResults?: number;
|
|
2399
2399
|
/**
|
|
2400
|
-
* @public
|
|
2401
2400
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
2401
|
+
* @public
|
|
2402
2402
|
*/
|
|
2403
2403
|
nextToken?: string;
|
|
2404
2404
|
}
|
|
@@ -2407,13 +2407,13 @@ export interface ListDeploymentsRequest {
|
|
|
2407
2407
|
*/
|
|
2408
2408
|
export interface ListDeploymentsResponse {
|
|
2409
2409
|
/**
|
|
2410
|
-
* @public
|
|
2411
2410
|
* <p>A list that summarizes each deployment.</p>
|
|
2411
|
+
* @public
|
|
2412
2412
|
*/
|
|
2413
2413
|
deployments?: Deployment[];
|
|
2414
2414
|
/**
|
|
2415
|
-
* @public
|
|
2416
2415
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
2416
|
+
* @public
|
|
2417
2417
|
*/
|
|
2418
2418
|
nextToken?: string;
|
|
2419
2419
|
}
|
|
@@ -2422,18 +2422,18 @@ export interface ListDeploymentsResponse {
|
|
|
2422
2422
|
*/
|
|
2423
2423
|
export interface ListEffectiveDeploymentsRequest {
|
|
2424
2424
|
/**
|
|
2425
|
-
* @public
|
|
2426
2425
|
* <p>The name of the core device. This is also the name of the IoT thing.</p>
|
|
2426
|
+
* @public
|
|
2427
2427
|
*/
|
|
2428
2428
|
coreDeviceThingName: string | undefined;
|
|
2429
2429
|
/**
|
|
2430
|
-
* @public
|
|
2431
2430
|
* <p>The maximum number of results to be returned per paginated request.</p>
|
|
2431
|
+
* @public
|
|
2432
2432
|
*/
|
|
2433
2433
|
maxResults?: number;
|
|
2434
2434
|
/**
|
|
2435
|
-
* @public
|
|
2436
2435
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
2436
|
+
* @public
|
|
2437
2437
|
*/
|
|
2438
2438
|
nextToken?: string;
|
|
2439
2439
|
}
|
|
@@ -2442,13 +2442,13 @@ export interface ListEffectiveDeploymentsRequest {
|
|
|
2442
2442
|
*/
|
|
2443
2443
|
export interface ListEffectiveDeploymentsResponse {
|
|
2444
2444
|
/**
|
|
2445
|
-
* @public
|
|
2446
2445
|
* <p>A list that summarizes each deployment on the core device.</p>
|
|
2446
|
+
* @public
|
|
2447
2447
|
*/
|
|
2448
2448
|
effectiveDeployments?: EffectiveDeployment[];
|
|
2449
2449
|
/**
|
|
2450
|
-
* @public
|
|
2451
2450
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
2451
|
+
* @public
|
|
2452
2452
|
*/
|
|
2453
2453
|
nextToken?: string;
|
|
2454
2454
|
}
|
|
@@ -2469,22 +2469,21 @@ export type InstalledComponentTopologyFilter = (typeof InstalledComponentTopolog
|
|
|
2469
2469
|
*/
|
|
2470
2470
|
export interface ListInstalledComponentsRequest {
|
|
2471
2471
|
/**
|
|
2472
|
-
* @public
|
|
2473
2472
|
* <p>The name of the core device. This is also the name of the IoT thing.</p>
|
|
2473
|
+
* @public
|
|
2474
2474
|
*/
|
|
2475
2475
|
coreDeviceThingName: string | undefined;
|
|
2476
2476
|
/**
|
|
2477
|
-
* @public
|
|
2478
2477
|
* <p>The maximum number of results to be returned per paginated request.</p>
|
|
2478
|
+
* @public
|
|
2479
2479
|
*/
|
|
2480
2480
|
maxResults?: number;
|
|
2481
2481
|
/**
|
|
2482
|
-
* @public
|
|
2483
2482
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
2483
|
+
* @public
|
|
2484
2484
|
*/
|
|
2485
2485
|
nextToken?: string;
|
|
2486
2486
|
/**
|
|
2487
|
-
* @public
|
|
2488
2487
|
* <p>The filter for the list of components. Choose from the following options:</p>
|
|
2489
2488
|
* <ul>
|
|
2490
2489
|
* <li>
|
|
@@ -2502,6 +2501,7 @@ export interface ListInstalledComponentsRequest {
|
|
|
2502
2501
|
* </ul>
|
|
2503
2502
|
* <p>Default: <code>ROOT</code>
|
|
2504
2503
|
* </p>
|
|
2504
|
+
* @public
|
|
2505
2505
|
*/
|
|
2506
2506
|
topologyFilter?: InstalledComponentTopologyFilter;
|
|
2507
2507
|
}
|
|
@@ -2524,53 +2524,52 @@ export declare const InstalledComponentLifecycleState: {
|
|
|
2524
2524
|
*/
|
|
2525
2525
|
export type InstalledComponentLifecycleState = (typeof InstalledComponentLifecycleState)[keyof typeof InstalledComponentLifecycleState];
|
|
2526
2526
|
/**
|
|
2527
|
-
* @public
|
|
2528
2527
|
* <p>Contains information about a component on a Greengrass core device.</p>
|
|
2528
|
+
* @public
|
|
2529
2529
|
*/
|
|
2530
2530
|
export interface InstalledComponent {
|
|
2531
2531
|
/**
|
|
2532
|
-
* @public
|
|
2533
2532
|
* <p>The name of the component.</p>
|
|
2533
|
+
* @public
|
|
2534
2534
|
*/
|
|
2535
2535
|
componentName?: string;
|
|
2536
2536
|
/**
|
|
2537
|
-
* @public
|
|
2538
2537
|
* <p>The version of the component.</p>
|
|
2538
|
+
* @public
|
|
2539
2539
|
*/
|
|
2540
2540
|
componentVersion?: string;
|
|
2541
2541
|
/**
|
|
2542
|
-
* @public
|
|
2543
2542
|
* <p>The lifecycle state of the component.</p>
|
|
2543
|
+
* @public
|
|
2544
2544
|
*/
|
|
2545
2545
|
lifecycleState?: InstalledComponentLifecycleState;
|
|
2546
2546
|
/**
|
|
2547
|
-
* @public
|
|
2548
2547
|
* <p>A detailed response about the lifecycle state of the component that explains the reason
|
|
2549
2548
|
* why a component has an error or is broken.</p>
|
|
2549
|
+
* @public
|
|
2550
2550
|
*/
|
|
2551
2551
|
lifecycleStateDetails?: string;
|
|
2552
2552
|
/**
|
|
2553
|
-
* @public
|
|
2554
2553
|
* <p>Whether or not the component is a root component.</p>
|
|
2554
|
+
* @public
|
|
2555
2555
|
*/
|
|
2556
2556
|
isRoot?: boolean;
|
|
2557
2557
|
/**
|
|
2558
|
-
* @public
|
|
2559
2558
|
* <p>The status of how current the data is.</p>
|
|
2560
2559
|
* <p>This response is based off of component state changes. The status reflects component
|
|
2561
2560
|
* disruptions and deployments. If a component only sees a configuration update during a
|
|
2562
2561
|
* deployment, it might not undergo a state change and this status would not be updated.</p>
|
|
2562
|
+
* @public
|
|
2563
2563
|
*/
|
|
2564
2564
|
lastStatusChangeTimestamp?: Date;
|
|
2565
2565
|
/**
|
|
2566
|
-
* @public
|
|
2567
2566
|
* <p>The last time the Greengrass core device sent a message containing a component's state to the
|
|
2568
2567
|
* Amazon Web Services Cloud.</p>
|
|
2569
2568
|
* <p>A component does not need to see a state change for this field to update.</p>
|
|
2569
|
+
* @public
|
|
2570
2570
|
*/
|
|
2571
2571
|
lastReportedTimestamp?: Date;
|
|
2572
2572
|
/**
|
|
2573
|
-
* @public
|
|
2574
2573
|
* <p>The most recent deployment source that brought the component to the Greengrass core device. For
|
|
2575
2574
|
* a thing group deployment or thing deployment, the source will be the The ID of the deployment. and for
|
|
2576
2575
|
* local deployments it will be <code>LOCAL</code>.</p>
|
|
@@ -2578,10 +2577,10 @@ export interface InstalledComponent {
|
|
|
2578
2577
|
* <p>Any deployment will attempt to reinstall currently broken components on the device,
|
|
2579
2578
|
* which will update the last installation source.</p>
|
|
2580
2579
|
* </note>
|
|
2580
|
+
* @public
|
|
2581
2581
|
*/
|
|
2582
2582
|
lastInstallationSource?: string;
|
|
2583
2583
|
/**
|
|
2584
|
-
* @public
|
|
2585
2584
|
* <p>The status codes that indicate the reason for failure whenever the
|
|
2586
2585
|
* <code>lifecycleState</code> has an error or is in a broken state.</p>
|
|
2587
2586
|
* <note>
|
|
@@ -2589,6 +2588,7 @@ export interface InstalledComponent {
|
|
|
2589
2588
|
* <code>lifecycleStatusCodes</code> response. This response can be inaccurate in earlier
|
|
2590
2589
|
* Greengrass nucleus versions.</p>
|
|
2591
2590
|
* </note>
|
|
2591
|
+
* @public
|
|
2592
2592
|
*/
|
|
2593
2593
|
lifecycleStatusCodes?: string[];
|
|
2594
2594
|
}
|
|
@@ -2597,7 +2597,6 @@ export interface InstalledComponent {
|
|
|
2597
2597
|
*/
|
|
2598
2598
|
export interface ListInstalledComponentsResponse {
|
|
2599
2599
|
/**
|
|
2600
|
-
* @public
|
|
2601
2600
|
* <p>A list that summarizes each component on the core device.</p>
|
|
2602
2601
|
* <note>
|
|
2603
2602
|
* <p>Greengrass nucleus v2.7.0 or later is required to get an accurate
|
|
@@ -2609,11 +2608,12 @@ export interface ListInstalledComponentsResponse {
|
|
|
2609
2608
|
* <code>lastInstallationSource</code> and <code>lastReportedTimestamp</code> response. This
|
|
2610
2609
|
* response can be inaccurate or null in earlier Greengrass nucleus versions.</p>
|
|
2611
2610
|
* </note>
|
|
2611
|
+
* @public
|
|
2612
2612
|
*/
|
|
2613
2613
|
installedComponents?: InstalledComponent[];
|
|
2614
2614
|
/**
|
|
2615
|
-
* @public
|
|
2616
2615
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
2616
|
+
* @public
|
|
2617
2617
|
*/
|
|
2618
2618
|
nextToken?: string;
|
|
2619
2619
|
}
|
|
@@ -2622,8 +2622,8 @@ export interface ListInstalledComponentsResponse {
|
|
|
2622
2622
|
*/
|
|
2623
2623
|
export interface ListTagsForResourceRequest {
|
|
2624
2624
|
/**
|
|
2625
|
-
* @public
|
|
2626
2625
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the resource.</p>
|
|
2626
|
+
* @public
|
|
2627
2627
|
*/
|
|
2628
2628
|
resourceArn: string | undefined;
|
|
2629
2629
|
}
|
|
@@ -2632,10 +2632,10 @@ export interface ListTagsForResourceRequest {
|
|
|
2632
2632
|
*/
|
|
2633
2633
|
export interface ListTagsForResourceResponse {
|
|
2634
2634
|
/**
|
|
2635
|
-
* @public
|
|
2636
2635
|
* <p>A list of key-value pairs that contain metadata for the resource. For more
|
|
2637
2636
|
* information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html">Tag your
|
|
2638
2637
|
* resources</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
|
|
2638
|
+
* @public
|
|
2639
2639
|
*/
|
|
2640
2640
|
tags?: Record<string, string>;
|
|
2641
2641
|
}
|
|
@@ -2644,44 +2644,43 @@ export interface ListTagsForResourceResponse {
|
|
|
2644
2644
|
*/
|
|
2645
2645
|
export interface ResolveComponentCandidatesRequest {
|
|
2646
2646
|
/**
|
|
2647
|
-
* @public
|
|
2648
2647
|
* <p>The platform to use to resolve compatible components.</p>
|
|
2648
|
+
* @public
|
|
2649
2649
|
*/
|
|
2650
2650
|
platform?: ComponentPlatform;
|
|
2651
2651
|
/**
|
|
2652
|
-
* @public
|
|
2653
2652
|
* <p>The list of components to resolve.</p>
|
|
2653
|
+
* @public
|
|
2654
2654
|
*/
|
|
2655
2655
|
componentCandidates?: ComponentCandidate[];
|
|
2656
2656
|
}
|
|
2657
2657
|
/**
|
|
2658
|
-
* @public
|
|
2659
2658
|
* <p>Contains information about a component version that is compatible to run on a Greengrass core
|
|
2660
2659
|
* device.</p>
|
|
2660
|
+
* @public
|
|
2661
2661
|
*/
|
|
2662
2662
|
export interface ResolvedComponentVersion {
|
|
2663
2663
|
/**
|
|
2664
|
-
* @public
|
|
2665
2664
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
|
|
2665
|
+
* @public
|
|
2666
2666
|
*/
|
|
2667
2667
|
arn?: string;
|
|
2668
2668
|
/**
|
|
2669
|
-
* @public
|
|
2670
2669
|
* <p>The name of the component.</p>
|
|
2670
|
+
* @public
|
|
2671
2671
|
*/
|
|
2672
2672
|
componentName?: string;
|
|
2673
2673
|
/**
|
|
2674
|
-
* @public
|
|
2675
2674
|
* <p>The version of the component.</p>
|
|
2675
|
+
* @public
|
|
2676
2676
|
*/
|
|
2677
2677
|
componentVersion?: string;
|
|
2678
2678
|
/**
|
|
2679
|
-
* @public
|
|
2680
2679
|
* <p>The recipe of the component version.</p>
|
|
2680
|
+
* @public
|
|
2681
2681
|
*/
|
|
2682
2682
|
recipe?: Uint8Array;
|
|
2683
2683
|
/**
|
|
2684
|
-
* @public
|
|
2685
2684
|
* <p>The vendor guidance state for the component version. This state indicates whether
|
|
2686
2685
|
* the component version has any issues that you should consider before you deploy it. The vendor guidance state can be:</p>
|
|
2687
2686
|
* <ul>
|
|
@@ -2700,12 +2699,13 @@ export interface ResolvedComponentVersion {
|
|
|
2700
2699
|
* deploy it. If you have any existing deployments that specify this component version, those deployments will fail.</p>
|
|
2701
2700
|
* </li>
|
|
2702
2701
|
* </ul>
|
|
2702
|
+
* @public
|
|
2703
2703
|
*/
|
|
2704
2704
|
vendorGuidance?: VendorGuidance;
|
|
2705
2705
|
/**
|
|
2706
|
-
* @public
|
|
2707
2706
|
* <p>A message that communicates details about the vendor guidance state
|
|
2708
2707
|
* of the component version. This message communicates why a component version is discontinued or deleted.</p>
|
|
2708
|
+
* @public
|
|
2709
2709
|
*/
|
|
2710
2710
|
message?: string;
|
|
2711
2711
|
}
|
|
@@ -2714,9 +2714,9 @@ export interface ResolvedComponentVersion {
|
|
|
2714
2714
|
*/
|
|
2715
2715
|
export interface ResolveComponentCandidatesResponse {
|
|
2716
2716
|
/**
|
|
2717
|
-
* @public
|
|
2718
2717
|
* <p>A list of components that meet the requirements that you specify in the request. This list
|
|
2719
2718
|
* includes each component's recipe that you can use to install the component.</p>
|
|
2719
|
+
* @public
|
|
2720
2720
|
*/
|
|
2721
2721
|
resolvedComponentVersions?: ResolvedComponentVersion[];
|
|
2722
2722
|
}
|
|
@@ -2725,15 +2725,15 @@ export interface ResolveComponentCandidatesResponse {
|
|
|
2725
2725
|
*/
|
|
2726
2726
|
export interface TagResourceRequest {
|
|
2727
2727
|
/**
|
|
2728
|
-
* @public
|
|
2729
2728
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the resource to tag.</p>
|
|
2729
|
+
* @public
|
|
2730
2730
|
*/
|
|
2731
2731
|
resourceArn: string | undefined;
|
|
2732
2732
|
/**
|
|
2733
|
-
* @public
|
|
2734
2733
|
* <p>A list of key-value pairs that contain metadata for the resource. For more
|
|
2735
2734
|
* information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html">Tag your
|
|
2736
2735
|
* resources</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
|
|
2736
|
+
* @public
|
|
2737
2737
|
*/
|
|
2738
2738
|
tags: Record<string, string> | undefined;
|
|
2739
2739
|
}
|
|
@@ -2747,13 +2747,13 @@ export interface TagResourceResponse {
|
|
|
2747
2747
|
*/
|
|
2748
2748
|
export interface UntagResourceRequest {
|
|
2749
2749
|
/**
|
|
2750
|
-
* @public
|
|
2751
2750
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the resource to untag.</p>
|
|
2751
|
+
* @public
|
|
2752
2752
|
*/
|
|
2753
2753
|
resourceArn: string | undefined;
|
|
2754
2754
|
/**
|
|
2755
|
-
* @public
|
|
2756
2755
|
* <p>A list of keys for tags to remove from the resource.</p>
|
|
2756
|
+
* @public
|
|
2757
2757
|
*/
|
|
2758
2758
|
tagKeys: string[] | undefined;
|
|
2759
2759
|
}
|
|
@@ -2767,13 +2767,13 @@ export interface UntagResourceResponse {
|
|
|
2767
2767
|
*/
|
|
2768
2768
|
export interface UpdateConnectivityInfoRequest {
|
|
2769
2769
|
/**
|
|
2770
|
-
* @public
|
|
2771
2770
|
* <p>The name of the core device. This is also the name of the IoT thing.</p>
|
|
2771
|
+
* @public
|
|
2772
2772
|
*/
|
|
2773
2773
|
thingName: string | undefined;
|
|
2774
2774
|
/**
|
|
2775
|
-
* @public
|
|
2776
2775
|
* <p>The connectivity information for the core device.</p>
|
|
2776
|
+
* @public
|
|
2777
2777
|
*/
|
|
2778
2778
|
connectivityInfo: ConnectivityInfo[] | undefined;
|
|
2779
2779
|
}
|
|
@@ -2782,13 +2782,13 @@ export interface UpdateConnectivityInfoRequest {
|
|
|
2782
2782
|
*/
|
|
2783
2783
|
export interface UpdateConnectivityInfoResponse {
|
|
2784
2784
|
/**
|
|
2785
|
-
* @public
|
|
2786
2785
|
* <p>The new version of the connectivity information for the core device.</p>
|
|
2786
|
+
* @public
|
|
2787
2787
|
*/
|
|
2788
2788
|
version?: string;
|
|
2789
2789
|
/**
|
|
2790
|
-
* @public
|
|
2791
2790
|
* <p>A message about the connectivity information update request.</p>
|
|
2791
|
+
* @public
|
|
2792
2792
|
*/
|
|
2793
2793
|
message?: string;
|
|
2794
2794
|
}
|