@aws-sdk/client-greengrassv2 3.315.0 → 3.319.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.
@@ -29,454 +29,195 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/Ta
29
29
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
30
30
  import { UpdateConnectivityInfoCommandInput, UpdateConnectivityInfoCommandOutput } from "./commands/UpdateConnectivityInfoCommand";
31
31
  import { GreengrassV2Client } from "./GreengrassV2Client";
32
- /**
33
- * @public
34
- * <p>IoT Greengrass brings local compute, messaging, data management, sync, and ML inference capabilities
35
- * to edge devices. This enables devices to collect and analyze data closer to the source of
36
- * information, react autonomously to local events, and communicate securely with each other on
37
- * local networks. Local devices can also communicate securely with Amazon Web Services IoT Core and export IoT data
38
- * to the Amazon Web Services Cloud. IoT Greengrass developers can use Lambda functions and components to create and
39
- * deploy applications to fleets of edge devices for local operation.</p>
40
- * <p>IoT Greengrass Version 2 provides a new major version of the IoT Greengrass Core software, new APIs, and a new console.
41
- * Use this API reference to learn how to use the IoT Greengrass V2 API operations to manage components,
42
- * manage deployments, and core devices.</p>
43
- * <p>For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/what-is-iot-greengrass.html">What is IoT Greengrass?</a> in the
44
- * <i>IoT Greengrass V2 Developer Guide</i>.</p>
45
- */
46
- export declare class GreengrassV2 extends GreengrassV2Client {
32
+ export interface GreengrassV2 {
47
33
  /**
48
- * @public
49
- * <p>Associates a Greengrass service role with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. IoT Greengrass
50
- * uses this role to verify the identity of client devices and manage core device connectivity
51
- * information. The role must include the <a href="https://console.aws.amazon.com/iam/home#/policies/arn:awsiam::aws:policy/service-role/AWSGreengrassResourceAccessRolePolicy">AWSGreengrassResourceAccessRolePolicy</a> managed policy or a custom policy that
52
- * defines equivalent permissions for the IoT Greengrass features that you use. For more information, see
53
- * <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html">Greengrass service role</a> in the <i>IoT Greengrass Version 2 Developer Guide</i>.</p>
34
+ * @see {@link AssociateServiceRoleToAccountCommand}
54
35
  */
55
36
  associateServiceRoleToAccount(args: AssociateServiceRoleToAccountCommandInput, options?: __HttpHandlerOptions): Promise<AssociateServiceRoleToAccountCommandOutput>;
56
37
  associateServiceRoleToAccount(args: AssociateServiceRoleToAccountCommandInput, cb: (err: any, data?: AssociateServiceRoleToAccountCommandOutput) => void): void;
57
38
  associateServiceRoleToAccount(args: AssociateServiceRoleToAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateServiceRoleToAccountCommandOutput) => void): void;
58
39
  /**
59
- * @public
60
- * <p>Associates a list of client devices with a core device. Use this API operation to specify
61
- * which client devices can discover a core device through cloud discovery. With cloud discovery,
62
- * client devices connect to IoT Greengrass to retrieve associated core devices' connectivity information
63
- * and certificates. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-cloud-discovery.html">Configure cloud
64
- * discovery</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
65
- * <note>
66
- * <p>Client devices are local IoT devices that connect to and communicate with an IoT Greengrass core
67
- * device over MQTT. You can connect client devices to a core device to sync MQTT messages and
68
- * data to Amazon Web Services IoT Core and interact with client devices in Greengrass components. For more information,
69
- * see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/interact-with-local-iot-devices.html">Interact with
70
- * local IoT devices</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
71
- * </note>
40
+ * @see {@link BatchAssociateClientDeviceWithCoreDeviceCommand}
72
41
  */
73
42
  batchAssociateClientDeviceWithCoreDevice(args: BatchAssociateClientDeviceWithCoreDeviceCommandInput, options?: __HttpHandlerOptions): Promise<BatchAssociateClientDeviceWithCoreDeviceCommandOutput>;
74
43
  batchAssociateClientDeviceWithCoreDevice(args: BatchAssociateClientDeviceWithCoreDeviceCommandInput, cb: (err: any, data?: BatchAssociateClientDeviceWithCoreDeviceCommandOutput) => void): void;
75
44
  batchAssociateClientDeviceWithCoreDevice(args: BatchAssociateClientDeviceWithCoreDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchAssociateClientDeviceWithCoreDeviceCommandOutput) => void): void;
76
45
  /**
77
- * @public
78
- * <p>Disassociates a list of client devices from a core device. After you disassociate a client
79
- * device from a core device, the client device won't be able to use cloud discovery to retrieve
80
- * the core device's connectivity information and certificates.</p>
46
+ * @see {@link BatchDisassociateClientDeviceFromCoreDeviceCommand}
81
47
  */
82
48
  batchDisassociateClientDeviceFromCoreDevice(args: BatchDisassociateClientDeviceFromCoreDeviceCommandInput, options?: __HttpHandlerOptions): Promise<BatchDisassociateClientDeviceFromCoreDeviceCommandOutput>;
83
49
  batchDisassociateClientDeviceFromCoreDevice(args: BatchDisassociateClientDeviceFromCoreDeviceCommandInput, cb: (err: any, data?: BatchDisassociateClientDeviceFromCoreDeviceCommandOutput) => void): void;
84
50
  batchDisassociateClientDeviceFromCoreDevice(args: BatchDisassociateClientDeviceFromCoreDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDisassociateClientDeviceFromCoreDeviceCommandOutput) => void): void;
85
51
  /**
86
- * @public
87
- * <p>Cancels a deployment. This operation cancels the deployment for devices that haven't yet
88
- * received it. If a device already received the deployment, this operation doesn't change
89
- * anything for that device.</p>
52
+ * @see {@link CancelDeploymentCommand}
90
53
  */
91
54
  cancelDeployment(args: CancelDeploymentCommandInput, options?: __HttpHandlerOptions): Promise<CancelDeploymentCommandOutput>;
92
55
  cancelDeployment(args: CancelDeploymentCommandInput, cb: (err: any, data?: CancelDeploymentCommandOutput) => void): void;
93
56
  cancelDeployment(args: CancelDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelDeploymentCommandOutput) => void): void;
94
57
  /**
95
- * @public
96
- * <p>Creates a component. Components are software that run on Greengrass core devices. After you
97
- * develop and test a component on your core device, you can use this operation to upload your
98
- * component to IoT Greengrass. Then, you can deploy the component to other core devices.</p>
99
- * <p>You can use this operation to do the following:</p>
100
- * <ul>
101
- * <li>
102
- * <p>
103
- * <b>Create components from recipes</b>
104
- * </p>
105
- * <p>Create a component from a recipe, which is a file that defines the component's
106
- * metadata, parameters, dependencies, lifecycle, artifacts, and platform capability. For
107
- * more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/component-recipe-reference.html">IoT Greengrass component recipe
108
- * reference</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
109
- * <p>To create a component from a recipe, specify <code>inlineRecipe</code> when you call
110
- * this operation.</p>
111
- * </li>
112
- * <li>
113
- * <p>
114
- * <b>Create components from Lambda functions</b>
115
- * </p>
116
- * <p>Create a component from an Lambda function that runs on IoT Greengrass. This creates a recipe
117
- * and artifacts from the Lambda function's deployment package. You can use this operation to
118
- * migrate Lambda functions from IoT Greengrass V1 to IoT Greengrass V2.</p>
119
- * <p>This function only accepts Lambda functions that use the following runtimes:</p>
120
- * <ul>
121
- * <li>
122
- * <p>Python 2.7 – <code>python2.7</code>
123
- * </p>
124
- * </li>
125
- * <li>
126
- * <p>Python 3.7 – <code>python3.7</code>
127
- * </p>
128
- * </li>
129
- * <li>
130
- * <p>Python 3.8 – <code>python3.8</code>
131
- * </p>
132
- * </li>
133
- * <li>
134
- * <p>Python 3.9 – <code>python3.9</code>
135
- * </p>
136
- * </li>
137
- * <li>
138
- * <p>Java 8 – <code>java8</code>
139
- * </p>
140
- * </li>
141
- * <li>
142
- * <p>Java 11 – <code>java11</code>
143
- * </p>
144
- * </li>
145
- * <li>
146
- * <p>Node.js 10 – <code>nodejs10.x</code>
147
- * </p>
148
- * </li>
149
- * <li>
150
- * <p>Node.js 12 – <code>nodejs12.x</code>
151
- * </p>
152
- * </li>
153
- * <li>
154
- * <p>Node.js 14 – <code>nodejs14.x</code>
155
- * </p>
156
- * </li>
157
- * </ul>
158
- * <p>To create a component from a Lambda function, specify <code>lambdaFunction</code> when
159
- * you call this operation.</p>
160
- * <note>
161
- * <p>IoT Greengrass currently supports Lambda functions on only Linux core devices.</p>
162
- * </note>
163
- * </li>
164
- * </ul>
58
+ * @see {@link CreateComponentVersionCommand}
165
59
  */
166
60
  createComponentVersion(args: CreateComponentVersionCommandInput, options?: __HttpHandlerOptions): Promise<CreateComponentVersionCommandOutput>;
167
61
  createComponentVersion(args: CreateComponentVersionCommandInput, cb: (err: any, data?: CreateComponentVersionCommandOutput) => void): void;
168
62
  createComponentVersion(args: CreateComponentVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateComponentVersionCommandOutput) => void): void;
169
63
  /**
170
- * @public
171
- * <p>Creates a continuous deployment for a target, which is a Greengrass core device or group of core
172
- * devices. When you add a new core device to a group of core devices that has a deployment, IoT Greengrass
173
- * deploys that group's deployment to the new device.</p>
174
- * <p>You can define one deployment for each target. When you create a new deployment for a
175
- * target that has an existing deployment, you replace the previous deployment. IoT Greengrass applies the
176
- * new deployment to the target devices.</p>
177
- * <p>Every deployment has a revision number that indicates how many deployment revisions you
178
- * define for a target. Use this operation to create a new revision of an existing
179
- * deployment.</p>
180
- * <p>For more information, see the <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html">Create deployments</a> in the
181
- * <i>IoT Greengrass V2 Developer Guide</i>.</p>
64
+ * @see {@link CreateDeploymentCommand}
182
65
  */
183
66
  createDeployment(args: CreateDeploymentCommandInput, options?: __HttpHandlerOptions): Promise<CreateDeploymentCommandOutput>;
184
67
  createDeployment(args: CreateDeploymentCommandInput, cb: (err: any, data?: CreateDeploymentCommandOutput) => void): void;
185
68
  createDeployment(args: CreateDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDeploymentCommandOutput) => void): void;
186
69
  /**
187
- * @public
188
- * <p>Deletes a version of a component from IoT Greengrass.</p>
189
- * <note>
190
- * <p>This operation deletes the component's recipe and artifacts. As a result, deployments
191
- * that refer to this component version will fail. If you have deployments that use this
192
- * component version, you can remove the component from the deployment or update the deployment
193
- * to use a valid version.</p>
194
- * </note>
70
+ * @see {@link DeleteComponentCommand}
195
71
  */
196
72
  deleteComponent(args: DeleteComponentCommandInput, options?: __HttpHandlerOptions): Promise<DeleteComponentCommandOutput>;
197
73
  deleteComponent(args: DeleteComponentCommandInput, cb: (err: any, data?: DeleteComponentCommandOutput) => void): void;
198
74
  deleteComponent(args: DeleteComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteComponentCommandOutput) => void): void;
199
75
  /**
200
- * @public
201
- * <p>Deletes a Greengrass core device, which is an IoT thing. This operation removes the core
202
- * device from the list of core devices. This operation doesn't delete the IoT thing. For more
203
- * information about how to delete the IoT thing, see <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_DeleteThing.html">DeleteThing</a> in the
204
- * <i>IoT API Reference</i>.</p>
76
+ * @see {@link DeleteCoreDeviceCommand}
205
77
  */
206
78
  deleteCoreDevice(args: DeleteCoreDeviceCommandInput, options?: __HttpHandlerOptions): Promise<DeleteCoreDeviceCommandOutput>;
207
79
  deleteCoreDevice(args: DeleteCoreDeviceCommandInput, cb: (err: any, data?: DeleteCoreDeviceCommandOutput) => void): void;
208
80
  deleteCoreDevice(args: DeleteCoreDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCoreDeviceCommandOutput) => void): void;
209
81
  /**
210
- * @public
211
- * <p>Deletes a deployment. To delete an active deployment, you must first cancel it. For more
212
- * information, see <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_CancelDeployment.html">CancelDeployment</a>.</p>
213
- * <p>Deleting a deployment doesn't affect core devices that run that deployment, because core
214
- * devices store the deployment's configuration on the device. Additionally, core devices can
215
- * roll back to a previous deployment that has been deleted.</p>
82
+ * @see {@link DeleteDeploymentCommand}
216
83
  */
217
84
  deleteDeployment(args: DeleteDeploymentCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDeploymentCommandOutput>;
218
85
  deleteDeployment(args: DeleteDeploymentCommandInput, cb: (err: any, data?: DeleteDeploymentCommandOutput) => void): void;
219
86
  deleteDeployment(args: DeleteDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDeploymentCommandOutput) => void): void;
220
87
  /**
221
- * @public
222
- * <p>Retrieves metadata for a version of a component.</p>
88
+ * @see {@link DescribeComponentCommand}
223
89
  */
224
90
  describeComponent(args: DescribeComponentCommandInput, options?: __HttpHandlerOptions): Promise<DescribeComponentCommandOutput>;
225
91
  describeComponent(args: DescribeComponentCommandInput, cb: (err: any, data?: DescribeComponentCommandOutput) => void): void;
226
92
  describeComponent(args: DescribeComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeComponentCommandOutput) => void): void;
227
93
  /**
228
- * @public
229
- * <p>Disassociates the Greengrass service role from IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.
230
- * Without a service role, IoT Greengrass can't verify the identity of client devices or manage core device
231
- * connectivity information. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html">Greengrass service role</a> in
232
- * the <i>IoT Greengrass Version 2 Developer Guide</i>.</p>
94
+ * @see {@link DisassociateServiceRoleFromAccountCommand}
233
95
  */
234
96
  disassociateServiceRoleFromAccount(args: DisassociateServiceRoleFromAccountCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateServiceRoleFromAccountCommandOutput>;
235
97
  disassociateServiceRoleFromAccount(args: DisassociateServiceRoleFromAccountCommandInput, cb: (err: any, data?: DisassociateServiceRoleFromAccountCommandOutput) => void): void;
236
98
  disassociateServiceRoleFromAccount(args: DisassociateServiceRoleFromAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateServiceRoleFromAccountCommandOutput) => void): void;
237
99
  /**
238
- * @public
239
- * <p>Gets the recipe for a version of a component.</p>
100
+ * @see {@link GetComponentCommand}
240
101
  */
241
102
  getComponent(args: GetComponentCommandInput, options?: __HttpHandlerOptions): Promise<GetComponentCommandOutput>;
242
103
  getComponent(args: GetComponentCommandInput, cb: (err: any, data?: GetComponentCommandOutput) => void): void;
243
104
  getComponent(args: GetComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComponentCommandOutput) => void): void;
244
105
  /**
245
- * @public
246
- * <p>Gets the pre-signed URL to download a public or a Lambda component artifact. Core devices
247
- * call this operation to identify the URL that they can use to download an artifact to
248
- * install.</p>
106
+ * @see {@link GetComponentVersionArtifactCommand}
249
107
  */
250
108
  getComponentVersionArtifact(args: GetComponentVersionArtifactCommandInput, options?: __HttpHandlerOptions): Promise<GetComponentVersionArtifactCommandOutput>;
251
109
  getComponentVersionArtifact(args: GetComponentVersionArtifactCommandInput, cb: (err: any, data?: GetComponentVersionArtifactCommandOutput) => void): void;
252
110
  getComponentVersionArtifact(args: GetComponentVersionArtifactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComponentVersionArtifactCommandOutput) => void): void;
253
111
  /**
254
- * @public
255
- * <p>Retrieves connectivity information for a Greengrass core device.</p>
256
- * <p>Connectivity information includes endpoints and ports where client devices
257
- * can connect to an MQTT broker on the core device. When a client device
258
- * calls the <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-discover-api.html">IoT Greengrass discovery API</a>,
259
- * IoT Greengrass returns connectivity information for all of the core devices where the client device can
260
- * connect. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/connect-client-devices.html">Connect client devices to
261
- * core devices</a> in the <i>IoT Greengrass Version 2 Developer Guide</i>.</p>
112
+ * @see {@link GetConnectivityInfoCommand}
262
113
  */
263
114
  getConnectivityInfo(args: GetConnectivityInfoCommandInput, options?: __HttpHandlerOptions): Promise<GetConnectivityInfoCommandOutput>;
264
115
  getConnectivityInfo(args: GetConnectivityInfoCommandInput, cb: (err: any, data?: GetConnectivityInfoCommandOutput) => void): void;
265
116
  getConnectivityInfo(args: GetConnectivityInfoCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConnectivityInfoCommandOutput) => void): void;
266
117
  /**
267
- * @public
268
- * <p>Retrieves metadata for a Greengrass core device.</p>
269
- * <note>
270
- * <p>IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the
271
- * IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud,
272
- * then the reported status of that device might not reflect its current status. The status
273
- * timestamp indicates when the device status was last updated.</p>
274
- * <p>Core devices send status updates at the following times:</p>
275
- * <ul>
276
- * <li>
277
- * <p>When the IoT Greengrass Core software starts</p>
278
- * </li>
279
- * <li>
280
- * <p>When the core device receives a deployment from the Amazon Web Services Cloud</p>
281
- * </li>
282
- * <li>
283
- * <p>When the status of any component on the core device becomes
284
- * <code>BROKEN</code>
285
- * </p>
286
- * </li>
287
- * <li>
288
- * <p>At a <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html#greengrass-nucleus-component-configuration-fss">regular interval that you can configure</a>, which defaults to 24 hours</p>
289
- * </li>
290
- * <li>
291
- * <p>For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and
292
- * cloud deployment</p>
293
- * </li>
294
- * </ul>
295
- * </note>
118
+ * @see {@link GetCoreDeviceCommand}
296
119
  */
297
120
  getCoreDevice(args: GetCoreDeviceCommandInput, options?: __HttpHandlerOptions): Promise<GetCoreDeviceCommandOutput>;
298
121
  getCoreDevice(args: GetCoreDeviceCommandInput, cb: (err: any, data?: GetCoreDeviceCommandOutput) => void): void;
299
122
  getCoreDevice(args: GetCoreDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCoreDeviceCommandOutput) => void): void;
300
123
  /**
301
- * @public
302
- * <p>Gets a deployment. Deployments define the components that run on Greengrass core devices.</p>
124
+ * @see {@link GetDeploymentCommand}
303
125
  */
304
126
  getDeployment(args: GetDeploymentCommandInput, options?: __HttpHandlerOptions): Promise<GetDeploymentCommandOutput>;
305
127
  getDeployment(args: GetDeploymentCommandInput, cb: (err: any, data?: GetDeploymentCommandOutput) => void): void;
306
128
  getDeployment(args: GetDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeploymentCommandOutput) => void): void;
307
129
  /**
308
- * @public
309
- * <p>Gets the service role associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.
310
- * IoT Greengrass uses this role to verify the identity of client devices and manage core device
311
- * connectivity information. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html">Greengrass service role</a> in
312
- * the <i>IoT Greengrass Version 2 Developer Guide</i>.</p>
130
+ * @see {@link GetServiceRoleForAccountCommand}
313
131
  */
314
132
  getServiceRoleForAccount(args: GetServiceRoleForAccountCommandInput, options?: __HttpHandlerOptions): Promise<GetServiceRoleForAccountCommandOutput>;
315
133
  getServiceRoleForAccount(args: GetServiceRoleForAccountCommandInput, cb: (err: any, data?: GetServiceRoleForAccountCommandOutput) => void): void;
316
134
  getServiceRoleForAccount(args: GetServiceRoleForAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceRoleForAccountCommandOutput) => void): void;
317
135
  /**
318
- * @public
319
- * <p>Retrieves a paginated list of client devices that are associated with a core
320
- * device.</p>
136
+ * @see {@link ListClientDevicesAssociatedWithCoreDeviceCommand}
321
137
  */
322
138
  listClientDevicesAssociatedWithCoreDevice(args: ListClientDevicesAssociatedWithCoreDeviceCommandInput, options?: __HttpHandlerOptions): Promise<ListClientDevicesAssociatedWithCoreDeviceCommandOutput>;
323
139
  listClientDevicesAssociatedWithCoreDevice(args: ListClientDevicesAssociatedWithCoreDeviceCommandInput, cb: (err: any, data?: ListClientDevicesAssociatedWithCoreDeviceCommandOutput) => void): void;
324
140
  listClientDevicesAssociatedWithCoreDevice(args: ListClientDevicesAssociatedWithCoreDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListClientDevicesAssociatedWithCoreDeviceCommandOutput) => void): void;
325
141
  /**
326
- * @public
327
- * <p>Retrieves a paginated list of component summaries. This list includes components that you
328
- * have permission to view.</p>
142
+ * @see {@link ListComponentsCommand}
329
143
  */
330
144
  listComponents(args: ListComponentsCommandInput, options?: __HttpHandlerOptions): Promise<ListComponentsCommandOutput>;
331
145
  listComponents(args: ListComponentsCommandInput, cb: (err: any, data?: ListComponentsCommandOutput) => void): void;
332
146
  listComponents(args: ListComponentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListComponentsCommandOutput) => void): void;
333
147
  /**
334
- * @public
335
- * <p>Retrieves a paginated list of all versions for a component. Greater versions are listed
336
- * first.</p>
148
+ * @see {@link ListComponentVersionsCommand}
337
149
  */
338
150
  listComponentVersions(args: ListComponentVersionsCommandInput, options?: __HttpHandlerOptions): Promise<ListComponentVersionsCommandOutput>;
339
151
  listComponentVersions(args: ListComponentVersionsCommandInput, cb: (err: any, data?: ListComponentVersionsCommandOutput) => void): void;
340
152
  listComponentVersions(args: ListComponentVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListComponentVersionsCommandOutput) => void): void;
341
153
  /**
342
- * @public
343
- * <p>Retrieves a paginated list of Greengrass core devices.</p>
344
- * <note>
345
- * <p>IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the
346
- * IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud,
347
- * then the reported status of that device might not reflect its current status. The status
348
- * timestamp indicates when the device status was last updated.</p>
349
- * <p>Core devices send status updates at the following times:</p>
350
- * <ul>
351
- * <li>
352
- * <p>When the IoT Greengrass Core software starts</p>
353
- * </li>
354
- * <li>
355
- * <p>When the core device receives a deployment from the Amazon Web Services Cloud</p>
356
- * </li>
357
- * <li>
358
- * <p>When the status of any component on the core device becomes
359
- * <code>BROKEN</code>
360
- * </p>
361
- * </li>
362
- * <li>
363
- * <p>At a <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html#greengrass-nucleus-component-configuration-fss">regular interval that you can configure</a>, which defaults to 24 hours</p>
364
- * </li>
365
- * <li>
366
- * <p>For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and
367
- * cloud deployment</p>
368
- * </li>
369
- * </ul>
370
- * </note>
154
+ * @see {@link ListCoreDevicesCommand}
371
155
  */
372
156
  listCoreDevices(args: ListCoreDevicesCommandInput, options?: __HttpHandlerOptions): Promise<ListCoreDevicesCommandOutput>;
373
157
  listCoreDevices(args: ListCoreDevicesCommandInput, cb: (err: any, data?: ListCoreDevicesCommandOutput) => void): void;
374
158
  listCoreDevices(args: ListCoreDevicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCoreDevicesCommandOutput) => void): void;
375
159
  /**
376
- * @public
377
- * <p>Retrieves a paginated list of deployments.</p>
160
+ * @see {@link ListDeploymentsCommand}
378
161
  */
379
162
  listDeployments(args: ListDeploymentsCommandInput, options?: __HttpHandlerOptions): Promise<ListDeploymentsCommandOutput>;
380
163
  listDeployments(args: ListDeploymentsCommandInput, cb: (err: any, data?: ListDeploymentsCommandOutput) => void): void;
381
164
  listDeployments(args: ListDeploymentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeploymentsCommandOutput) => void): void;
382
165
  /**
383
- * @public
384
- * <p>Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.</p>
166
+ * @see {@link ListEffectiveDeploymentsCommand}
385
167
  */
386
168
  listEffectiveDeployments(args: ListEffectiveDeploymentsCommandInput, options?: __HttpHandlerOptions): Promise<ListEffectiveDeploymentsCommandOutput>;
387
169
  listEffectiveDeployments(args: ListEffectiveDeploymentsCommandInput, cb: (err: any, data?: ListEffectiveDeploymentsCommandOutput) => void): void;
388
170
  listEffectiveDeployments(args: ListEffectiveDeploymentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEffectiveDeploymentsCommandOutput) => void): void;
389
171
  /**
390
- * @public
391
- * <p>Retrieves a paginated list of the components that a Greengrass core device runs. By default,
392
- * this list doesn't include components that are deployed as dependencies of other components. To
393
- * include dependencies in the response, set the <code>topologyFilter</code> parameter to
394
- * <code>ALL</code>.</p>
395
- * <note>
396
- * <p>IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the
397
- * IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud,
398
- * then the reported status of that device might not reflect its current status. The status
399
- * timestamp indicates when the device status was last updated.</p>
400
- * <p>Core devices send status updates at the following times:</p>
401
- * <ul>
402
- * <li>
403
- * <p>When the IoT Greengrass Core software starts</p>
404
- * </li>
405
- * <li>
406
- * <p>When the core device receives a deployment from the Amazon Web Services Cloud</p>
407
- * </li>
408
- * <li>
409
- * <p>When the status of any component on the core device becomes
410
- * <code>BROKEN</code>
411
- * </p>
412
- * </li>
413
- * <li>
414
- * <p>At a <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html#greengrass-nucleus-component-configuration-fss">regular interval that you can configure</a>, which defaults to 24 hours</p>
415
- * </li>
416
- * <li>
417
- * <p>For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and
418
- * cloud deployment</p>
419
- * </li>
420
- * </ul>
421
- * </note>
172
+ * @see {@link ListInstalledComponentsCommand}
422
173
  */
423
174
  listInstalledComponents(args: ListInstalledComponentsCommandInput, options?: __HttpHandlerOptions): Promise<ListInstalledComponentsCommandOutput>;
424
175
  listInstalledComponents(args: ListInstalledComponentsCommandInput, cb: (err: any, data?: ListInstalledComponentsCommandOutput) => void): void;
425
176
  listInstalledComponents(args: ListInstalledComponentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInstalledComponentsCommandOutput) => void): void;
426
177
  /**
427
- * @public
428
- * <p>Retrieves the list of tags for an IoT Greengrass resource.</p>
178
+ * @see {@link ListTagsForResourceCommand}
429
179
  */
430
180
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
431
181
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
432
182
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
433
183
  /**
434
- * @public
435
- * <p>Retrieves a list of components that meet the component, version, and platform requirements
436
- * of a deployment. Greengrass core devices call this operation when they receive a deployment to
437
- * identify the components to install.</p>
438
- * <p>This operation identifies components that meet all dependency requirements for a
439
- * deployment. If the requirements conflict, then this operation returns an error and the
440
- * deployment fails. For example, this occurs if component <code>A</code> requires version
441
- * <code>>2.0.0</code> and component <code>B</code> requires version <code><2.0.0</code>
442
- * of a component dependency.</p>
443
- * <p>When you specify the component candidates to resolve, IoT Greengrass compares each component's
444
- * digest from the core device with the component's digest in the Amazon Web Services Cloud. If the digests
445
- * don't match, then IoT Greengrass specifies to use the version from the Amazon Web Services Cloud.</p>
446
- * <important>
447
- * <p>To use this operation, you must use the data plane API endpoint and authenticate with an
448
- * IoT device certificate. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/greengrass.html">IoT Greengrass endpoints and quotas</a>.</p>
449
- * </important>
184
+ * @see {@link ResolveComponentCandidatesCommand}
450
185
  */
451
186
  resolveComponentCandidates(args: ResolveComponentCandidatesCommandInput, options?: __HttpHandlerOptions): Promise<ResolveComponentCandidatesCommandOutput>;
452
187
  resolveComponentCandidates(args: ResolveComponentCandidatesCommandInput, cb: (err: any, data?: ResolveComponentCandidatesCommandOutput) => void): void;
453
188
  resolveComponentCandidates(args: ResolveComponentCandidatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResolveComponentCandidatesCommandOutput) => void): void;
454
189
  /**
455
- * @public
456
- * <p>Adds tags to an IoT Greengrass resource. If a tag already exists for the resource, this operation
457
- * updates the tag's value.</p>
190
+ * @see {@link TagResourceCommand}
458
191
  */
459
192
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
460
193
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
461
194
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
462
195
  /**
463
- * @public
464
- * <p>Removes a tag from an IoT Greengrass resource.</p>
196
+ * @see {@link UntagResourceCommand}
465
197
  */
466
198
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
467
199
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
468
200
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
469
201
  /**
470
- * @public
471
- * <p>Updates connectivity information for a Greengrass core device.</p>
472
- * <p>Connectivity information includes endpoints and ports where client devices
473
- * can connect to an MQTT broker on the core device. When a client device
474
- * calls the <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-discover-api.html">IoT Greengrass discovery API</a>,
475
- * IoT Greengrass returns connectivity information for all of the core devices where the client device can
476
- * connect. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/connect-client-devices.html">Connect client devices to
477
- * core devices</a> in the <i>IoT Greengrass Version 2 Developer Guide</i>.</p>
202
+ * @see {@link UpdateConnectivityInfoCommand}
478
203
  */
479
204
  updateConnectivityInfo(args: UpdateConnectivityInfoCommandInput, options?: __HttpHandlerOptions): Promise<UpdateConnectivityInfoCommandOutput>;
480
205
  updateConnectivityInfo(args: UpdateConnectivityInfoCommandInput, cb: (err: any, data?: UpdateConnectivityInfoCommandOutput) => void): void;
481
206
  updateConnectivityInfo(args: UpdateConnectivityInfoCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConnectivityInfoCommandOutput) => void): void;
482
207
  }
208
+ /**
209
+ * @public
210
+ * <p>IoT Greengrass brings local compute, messaging, data management, sync, and ML inference capabilities
211
+ * to edge devices. This enables devices to collect and analyze data closer to the source of
212
+ * information, react autonomously to local events, and communicate securely with each other on
213
+ * local networks. Local devices can also communicate securely with Amazon Web Services IoT Core and export IoT data
214
+ * to the Amazon Web Services Cloud. IoT Greengrass developers can use Lambda functions and components to create and
215
+ * deploy applications to fleets of edge devices for local operation.</p>
216
+ * <p>IoT Greengrass Version 2 provides a new major version of the IoT Greengrass Core software, new APIs, and a new console.
217
+ * Use this API reference to learn how to use the IoT Greengrass V2 API operations to manage components,
218
+ * manage deployments, and core devices.</p>
219
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/what-is-iot-greengrass.html">What is IoT Greengrass?</a> in the
220
+ * <i>IoT Greengrass V2 Developer Guide</i>.</p>
221
+ */
222
+ export declare class GreengrassV2 extends GreengrassV2Client implements GreengrassV2 {
223
+ }
@@ -116,7 +116,7 @@ import {
116
116
  UpdateConnectivityInfoCommandOutput,
117
117
  } from "./commands/UpdateConnectivityInfoCommand";
118
118
  import { GreengrassV2Client } from "./GreengrassV2Client";
119
- export declare class GreengrassV2 extends GreengrassV2Client {
119
+ export interface GreengrassV2 {
120
120
  associateServiceRoleToAccount(
121
121
  args: AssociateServiceRoleToAccountCommandInput,
122
122
  options?: __HttpHandlerOptions
@@ -519,3 +519,6 @@ export declare class GreengrassV2 extends GreengrassV2Client {
519
519
  cb: (err: any, data?: UpdateConnectivityInfoCommandOutput) => void
520
520
  ): void;
521
521
  }
522
+ export declare class GreengrassV2
523
+ extends GreengrassV2Client
524
+ implements GreengrassV2 {}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-greengrassv2",
3
3
  "description": "AWS SDK for JavaScript Greengrassv2 Client for Node.js, Browser and React Native",
4
- "version": "3.315.0",
4
+ "version": "3.319.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.315.0",
24
+ "@aws-sdk/client-sts": "3.319.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.315.0",
26
+ "@aws-sdk/credential-provider-node": "3.319.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
@@ -36,19 +36,19 @@
36
36
  "@aws-sdk/middleware-serde": "3.310.0",
37
37
  "@aws-sdk/middleware-signing": "3.310.0",
38
38
  "@aws-sdk/middleware-stack": "3.310.0",
39
- "@aws-sdk/middleware-user-agent": "3.310.0",
39
+ "@aws-sdk/middleware-user-agent": "3.319.0",
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.310.0",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
43
- "@aws-sdk/smithy-client": "3.315.0",
43
+ "@aws-sdk/smithy-client": "3.316.0",
44
44
  "@aws-sdk/types": "3.310.0",
45
45
  "@aws-sdk/url-parser": "3.310.0",
46
46
  "@aws-sdk/util-base64": "3.310.0",
47
47
  "@aws-sdk/util-body-length-browser": "3.310.0",
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
- "@aws-sdk/util-defaults-mode-browser": "3.315.0",
50
- "@aws-sdk/util-defaults-mode-node": "3.315.0",
51
- "@aws-sdk/util-endpoints": "3.310.0",
49
+ "@aws-sdk/util-defaults-mode-browser": "3.316.0",
50
+ "@aws-sdk/util-defaults-mode-node": "3.316.0",
51
+ "@aws-sdk/util-endpoints": "3.319.0",
52
52
  "@aws-sdk/util-retry": "3.310.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",
54
54
  "@aws-sdk/util-user-agent-node": "3.310.0",