@aws-sdk/client-snow-device-management 3.533.0 → 3.540.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.
Files changed (37) hide show
  1. package/dist-cjs/endpoint/endpointResolver.js +4 -2
  2. package/dist-cjs/index.js +0 -3
  3. package/dist-es/endpoint/endpointResolver.js +3 -1
  4. package/dist-es/index.js +0 -1
  5. package/dist-types/SnowDeviceManagement.d.ts +3 -1
  6. package/dist-types/SnowDeviceManagementClient.d.ts +1 -1
  7. package/dist-types/commands/CancelTaskCommand.d.ts +2 -1
  8. package/dist-types/commands/CreateTaskCommand.d.ts +2 -1
  9. package/dist-types/commands/DescribeDeviceCommand.d.ts +2 -1
  10. package/dist-types/commands/DescribeDeviceEc2InstancesCommand.d.ts +2 -1
  11. package/dist-types/commands/DescribeExecutionCommand.d.ts +2 -1
  12. package/dist-types/commands/DescribeTaskCommand.d.ts +2 -1
  13. package/dist-types/commands/ListDeviceResourcesCommand.d.ts +2 -1
  14. package/dist-types/commands/ListDevicesCommand.d.ts +2 -1
  15. package/dist-types/commands/ListExecutionsCommand.d.ts +2 -1
  16. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  17. package/dist-types/commands/ListTasksCommand.d.ts +2 -1
  18. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  19. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  20. package/dist-types/index.d.ts +0 -1
  21. package/dist-types/models/models_0.d.ts +152 -152
  22. package/dist-types/ts3.4/SnowDeviceManagement.d.ts +2 -0
  23. package/dist-types/ts3.4/commands/CancelTaskCommand.d.ts +9 -0
  24. package/dist-types/ts3.4/commands/CreateTaskCommand.d.ts +9 -0
  25. package/dist-types/ts3.4/commands/DescribeDeviceCommand.d.ts +9 -0
  26. package/dist-types/ts3.4/commands/DescribeDeviceEc2InstancesCommand.d.ts +9 -0
  27. package/dist-types/ts3.4/commands/DescribeExecutionCommand.d.ts +9 -0
  28. package/dist-types/ts3.4/commands/DescribeTaskCommand.d.ts +9 -0
  29. package/dist-types/ts3.4/commands/ListDeviceResourcesCommand.d.ts +9 -0
  30. package/dist-types/ts3.4/commands/ListDevicesCommand.d.ts +9 -0
  31. package/dist-types/ts3.4/commands/ListExecutionsCommand.d.ts +9 -0
  32. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  33. package/dist-types/ts3.4/commands/ListTasksCommand.d.ts +9 -0
  34. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  35. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  36. package/dist-types/ts3.4/index.d.ts +0 -1
  37. package/package.json +40 -40
@@ -1,8 +1,8 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { SnowDeviceManagementServiceException as __BaseException } from "./SnowDeviceManagementServiceException";
3
3
  /**
4
- * @public
5
4
  * <p>You don't have sufficient access to perform this action.</p>
5
+ * @public
6
6
  */
7
7
  export declare class AccessDeniedException extends __BaseException {
8
8
  readonly name: "AccessDeniedException";
@@ -31,9 +31,9 @@ export type AttachmentStatus = (typeof AttachmentStatus)[keyof typeof Attachment
31
31
  */
32
32
  export interface CancelTaskInput {
33
33
  /**
34
- * @public
35
34
  * <p>The ID of the task that you are attempting to cancel. You can retrieve a task ID by using
36
35
  * the <code>ListTasks</code> operation.</p>
36
+ * @public
37
37
  */
38
38
  taskId: string | undefined;
39
39
  }
@@ -42,14 +42,14 @@ export interface CancelTaskInput {
42
42
  */
43
43
  export interface CancelTaskOutput {
44
44
  /**
45
- * @public
46
45
  * <p>The ID of the task that you are attempting to cancel.</p>
46
+ * @public
47
47
  */
48
48
  taskId?: string;
49
49
  }
50
50
  /**
51
- * @public
52
51
  * <p>An unexpected error occurred while processing the request.</p>
52
+ * @public
53
53
  */
54
54
  export declare class InternalServerException extends __BaseException {
55
55
  readonly name: "InternalServerException";
@@ -61,8 +61,8 @@ export declare class InternalServerException extends __BaseException {
61
61
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
62
62
  }
63
63
  /**
64
- * @public
65
64
  * <p>The request references a resource that doesn't exist.</p>
65
+ * @public
66
66
  */
67
67
  export declare class ResourceNotFoundException extends __BaseException {
68
68
  readonly name: "ResourceNotFoundException";
@@ -73,8 +73,8 @@ export declare class ResourceNotFoundException extends __BaseException {
73
73
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
74
74
  }
75
75
  /**
76
- * @public
77
76
  * <p>The request was denied due to request throttling.</p>
77
+ * @public
78
78
  */
79
79
  export declare class ThrottlingException extends __BaseException {
80
80
  readonly name: "ThrottlingException";
@@ -88,8 +88,8 @@ export declare class ThrottlingException extends __BaseException {
88
88
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
89
89
  }
90
90
  /**
91
- * @public
92
91
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
92
+ * @public
93
93
  */
94
94
  export declare class ValidationException extends __BaseException {
95
95
  readonly name: "ValidationException";
@@ -100,51 +100,51 @@ export declare class ValidationException extends __BaseException {
100
100
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
101
101
  }
102
102
  /**
103
- * @public
104
103
  * <p>The physical capacity of the Amazon Web Services Snow Family device. </p>
104
+ * @public
105
105
  */
106
106
  export interface Capacity {
107
107
  /**
108
- * @public
109
108
  * <p>The name of the type of capacity, such as memory.</p>
109
+ * @public
110
110
  */
111
111
  name?: string;
112
112
  /**
113
- * @public
114
113
  * <p>The unit of measure for the type of capacity.</p>
114
+ * @public
115
115
  */
116
116
  unit?: string;
117
117
  /**
118
- * @public
119
118
  * <p>The total capacity on the device.</p>
119
+ * @public
120
120
  */
121
121
  total?: number;
122
122
  /**
123
- * @public
124
123
  * <p>The amount of capacity used on the device.</p>
124
+ * @public
125
125
  */
126
126
  used?: number;
127
127
  /**
128
- * @public
129
128
  * <p>The amount of capacity available for use on the device.</p>
129
+ * @public
130
130
  */
131
131
  available?: number;
132
132
  }
133
133
  /**
134
- * @public
135
134
  * <p>A structure used to reboot the device.</p>
135
+ * @public
136
136
  */
137
137
  export interface Reboot {
138
138
  }
139
139
  /**
140
- * @public
141
140
  * <p>A structure used to unlock a device.</p>
141
+ * @public
142
142
  */
143
143
  export interface Unlock {
144
144
  }
145
145
  /**
146
- * @public
147
146
  * <p>The command given to the device to execute.</p>
147
+ * @public
148
148
  */
149
149
  export type Command = Command.RebootMember | Command.UnlockMember | Command.$UnknownMember;
150
150
  /**
@@ -152,8 +152,8 @@ export type Command = Command.RebootMember | Command.UnlockMember | Command.$Unk
152
152
  */
153
153
  export declare namespace Command {
154
154
  /**
155
- * @public
156
155
  * <p>Unlocks the device.</p>
156
+ * @public
157
157
  */
158
158
  interface UnlockMember {
159
159
  unlock: Unlock;
@@ -161,8 +161,8 @@ export declare namespace Command {
161
161
  $unknown?: never;
162
162
  }
163
163
  /**
164
- * @public
165
164
  * <p>Reboots the device.</p>
165
+ * @public
166
166
  */
167
167
  interface RebootMember {
168
168
  unlock?: never;
@@ -185,18 +185,18 @@ export declare namespace Command {
185
185
  const visit: <T>(value: Command, visitor: Visitor<T>) => T;
186
186
  }
187
187
  /**
188
- * @public
189
188
  * <p>The options for how a device's CPU is configured.</p>
189
+ * @public
190
190
  */
191
191
  export interface CpuOptions {
192
192
  /**
193
- * @public
194
193
  * <p>The number of cores that the CPU can use.</p>
194
+ * @public
195
195
  */
196
196
  coreCount?: number;
197
197
  /**
198
- * @public
199
198
  * <p>The number of threads per core in the CPU.</p>
199
+ * @public
200
200
  */
201
201
  threadsPerCore?: number;
202
202
  }
@@ -205,29 +205,29 @@ export interface CpuOptions {
205
205
  */
206
206
  export interface CreateTaskInput {
207
207
  /**
208
- * @public
209
208
  * <p>A list of managed device IDs.</p>
209
+ * @public
210
210
  */
211
211
  targets: string[] | undefined;
212
212
  /**
213
- * @public
214
213
  * <p>The task to be performed. Only one task is executed on a device at a time.</p>
214
+ * @public
215
215
  */
216
216
  command: Command | undefined;
217
217
  /**
218
- * @public
219
218
  * <p>A description of the task and its targets.</p>
219
+ * @public
220
220
  */
221
221
  description?: string;
222
222
  /**
223
- * @public
224
223
  * <p>Optional metadata that you assign to a resource. You can use tags to categorize a resource
225
224
  * in different ways, such as by purpose, owner, or environment. </p>
225
+ * @public
226
226
  */
227
227
  tags?: Record<string, string>;
228
228
  /**
229
- * @public
230
229
  * <p>A token ensuring that the action is called only once with the specified details.</p>
230
+ * @public
231
231
  */
232
232
  clientToken?: string;
233
233
  }
@@ -236,19 +236,19 @@ export interface CreateTaskInput {
236
236
  */
237
237
  export interface CreateTaskOutput {
238
238
  /**
239
- * @public
240
239
  * <p>The ID of the task that you created.</p>
240
+ * @public
241
241
  */
242
242
  taskId?: string;
243
243
  /**
244
- * @public
245
244
  * <p>The Amazon Resource Name (ARN) of the task that you created.</p>
245
+ * @public
246
246
  */
247
247
  taskArn?: string;
248
248
  }
249
249
  /**
250
- * @public
251
250
  * <p>The request would cause a service quota to be exceeded.</p>
251
+ * @public
252
252
  */
253
253
  export declare class ServiceQuotaExceededException extends __BaseException {
254
254
  readonly name: "ServiceQuotaExceededException";
@@ -263,8 +263,8 @@ export declare class ServiceQuotaExceededException extends __BaseException {
263
263
  */
264
264
  export interface DescribeDeviceInput {
265
265
  /**
266
- * @public
267
266
  * <p>The ID of the device that you are checking the information of.</p>
267
+ * @public
268
268
  */
269
269
  managedDeviceId: string | undefined;
270
270
  }
@@ -309,67 +309,67 @@ export declare const PhysicalConnectorType: {
309
309
  */
310
310
  export type PhysicalConnectorType = (typeof PhysicalConnectorType)[keyof typeof PhysicalConnectorType];
311
311
  /**
312
- * @public
313
312
  * <p>The details about the physical network interface for the device.</p>
313
+ * @public
314
314
  */
315
315
  export interface PhysicalNetworkInterface {
316
316
  /**
317
- * @public
318
317
  * <p>The physical network interface ID.</p>
318
+ * @public
319
319
  */
320
320
  physicalNetworkInterfaceId?: string;
321
321
  /**
322
- * @public
323
322
  * <p>The
324
323
  * physical
325
324
  * connector type.</p>
325
+ * @public
326
326
  */
327
327
  physicalConnectorType?: PhysicalConnectorType;
328
328
  /**
329
- * @public
330
329
  * <p>A value that describes whether the IP address is dynamic or persistent.</p>
330
+ * @public
331
331
  */
332
332
  ipAddressAssignment?: IpAddressAssignment;
333
333
  /**
334
- * @public
335
334
  * <p>The IP address of the device.</p>
335
+ * @public
336
336
  */
337
337
  ipAddress?: string;
338
338
  /**
339
- * @public
340
339
  * <p>The netmask used to divide the IP address into subnets.</p>
340
+ * @public
341
341
  */
342
342
  netmask?: string;
343
343
  /**
344
- * @public
345
344
  * <p>The default gateway of the device.</p>
345
+ * @public
346
346
  */
347
347
  defaultGateway?: string;
348
348
  /**
349
- * @public
350
349
  * <p>The MAC address of the device.</p>
350
+ * @public
351
351
  */
352
352
  macAddress?: string;
353
353
  }
354
354
  /**
355
- * @public
356
355
  * <p>Information about the software on the device.</p>
356
+ * @public
357
357
  */
358
358
  export interface SoftwareInformation {
359
359
  /**
360
- * @public
361
360
  * <p>The version of the software currently installed on the device.</p>
361
+ * @public
362
362
  */
363
363
  installedVersion?: string;
364
364
  /**
365
- * @public
366
365
  * <p>The version of the software being installed on the device.</p>
366
+ * @public
367
367
  */
368
368
  installingVersion?: string;
369
369
  /**
370
- * @public
371
370
  * <p>The state of the software that is installed or that is being installed on the
372
371
  * device.</p>
372
+ * @public
373
373
  */
374
374
  installState?: string;
375
375
  }
@@ -378,61 +378,61 @@ export interface SoftwareInformation {
378
378
  */
379
379
  export interface DescribeDeviceOutput {
380
380
  /**
381
- * @public
382
381
  * <p>When the device last contacted the Amazon Web Services Cloud. Indicates that the device is
383
382
  * online.</p>
383
+ * @public
384
384
  */
385
385
  lastReachedOutAt?: Date;
386
386
  /**
387
- * @public
388
387
  * <p>When the device last pushed an update to the Amazon Web Services Cloud. Indicates when the device cache
389
388
  * was refreshed.</p>
389
+ * @public
390
390
  */
391
391
  lastUpdatedAt?: Date;
392
392
  /**
393
- * @public
394
393
  * <p>Optional metadata that you assign to a resource. You can use tags to categorize a resource
395
394
  * in different ways, such as by purpose, owner, or environment. </p>
395
+ * @public
396
396
  */
397
397
  tags?: Record<string, string>;
398
398
  /**
399
- * @public
400
399
  * <p>The ID of the device that you checked the information for.</p>
400
+ * @public
401
401
  */
402
402
  managedDeviceId?: string;
403
403
  /**
404
- * @public
405
404
  * <p>The Amazon Resource Name (ARN) of the device.</p>
405
+ * @public
406
406
  */
407
407
  managedDeviceArn?: string;
408
408
  /**
409
- * @public
410
409
  * <p>The type of Amazon Web Services Snow Family device.</p>
410
+ * @public
411
411
  */
412
412
  deviceType?: string;
413
413
  /**
414
- * @public
415
414
  * <p>The ID of the job used when ordering the device.</p>
415
+ * @public
416
416
  */
417
417
  associatedWithJob?: string;
418
418
  /**
419
- * @public
420
419
  * <p>The current state of the device.</p>
420
+ * @public
421
421
  */
422
422
  deviceState?: UnlockState;
423
423
  /**
424
- * @public
425
424
  * <p>The network interfaces available on the device.</p>
425
+ * @public
426
426
  */
427
427
  physicalNetworkInterfaces?: PhysicalNetworkInterface[];
428
428
  /**
429
- * @public
430
429
  * <p>The hardware specifications of the device. </p>
430
+ * @public
431
431
  */
432
432
  deviceCapacities?: Capacity[];
433
433
  /**
434
- * @public
435
434
  * <p>The software installed on the device.</p>
435
+ * @public
436
436
  */
437
437
  software?: SoftwareInformation;
438
438
  }
@@ -441,73 +441,73 @@ export interface DescribeDeviceOutput {
441
441
  */
442
442
  export interface DescribeDeviceEc2Input {
443
443
  /**
444
- * @public
445
444
  * <p>The ID of the managed device.</p>
445
+ * @public
446
446
  */
447
447
  managedDeviceId: string | undefined;
448
448
  /**
449
- * @public
450
449
  * <p>A list of instance IDs associated with the managed device.</p>
450
+ * @public
451
451
  */
452
452
  instanceIds: string[] | undefined;
453
453
  }
454
454
  /**
455
- * @public
456
455
  * <p>Describes a parameter used to set up an Amazon Elastic Block Store (Amazon EBS) volume
457
456
  * in a block device mapping.</p>
457
+ * @public
458
458
  */
459
459
  export interface EbsInstanceBlockDevice {
460
460
  /**
461
- * @public
462
461
  * <p>When the attachment was initiated.</p>
462
+ * @public
463
463
  */
464
464
  attachTime?: Date;
465
465
  /**
466
- * @public
467
466
  * <p>A value that indicates whether the volume is deleted on instance termination.</p>
467
+ * @public
468
468
  */
469
469
  deleteOnTermination?: boolean;
470
470
  /**
471
- * @public
472
471
  * <p>The attachment state.</p>
472
+ * @public
473
473
  */
474
474
  status?: AttachmentStatus;
475
475
  /**
476
- * @public
477
476
  * <p>The ID of the Amazon EBS volume.</p>
477
+ * @public
478
478
  */
479
479
  volumeId?: string;
480
480
  }
481
481
  /**
482
- * @public
483
482
  * <p>The description of a block device mapping.</p>
483
+ * @public
484
484
  */
485
485
  export interface InstanceBlockDeviceMapping {
486
486
  /**
487
- * @public
488
487
  * <p>The block device name.</p>
488
+ * @public
489
489
  */
490
490
  deviceName?: string;
491
491
  /**
492
- * @public
493
492
  * <p>The parameters used to automatically set up Amazon Elastic Block Store (Amazon EBS)
494
493
  * volumes when the instance is launched. </p>
494
+ * @public
495
495
  */
496
496
  ebs?: EbsInstanceBlockDevice;
497
497
  }
498
498
  /**
499
- * @public
500
499
  * <p>Information about the device's security group.</p>
500
+ * @public
501
501
  */
502
502
  export interface SecurityGroupIdentifier {
503
503
  /**
504
- * @public
505
504
  * <p>The security group ID.</p>
505
+ * @public
506
506
  */
507
507
  groupId?: string;
508
508
  /**
509
- * @public
510
509
  * <p>The security group name.</p>
510
+ * @public
511
511
  */
512
512
  groupName?: string;
513
513
  }
@@ -528,12 +528,11 @@ export declare const InstanceStateName: {
528
528
  */
529
529
  export type InstanceStateName = (typeof InstanceStateName)[keyof typeof InstanceStateName];
530
530
  /**
531
- * @public
532
531
  * <p>The description of the current state of an instance.</p>
532
+ * @public
533
533
  */
534
534
  export interface InstanceState {
535
535
  /**
536
- * @public
537
536
  * <p>The state of the instance as a 16-bit unsigned integer. </p>
538
537
  * <p>The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values
539
538
  * between 256 and 65,535. These numerical values are used for internal purposes and should be
@@ -576,103 +575,104 @@ export interface InstanceState {
576
575
  * </ul>
577
576
  * <p>You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in
578
577
  * decimal. </p>
578
+ * @public
579
579
  */
580
580
  code?: number;
581
581
  /**
582
- * @public
583
582
  * <p>The current
584
583
  * state
585
584
  * of the instance.</p>
585
+ * @public
586
586
  */
587
587
  name?: InstanceStateName;
588
588
  }
589
589
  /**
590
- * @public
591
590
  * <p>The description of an
592
591
  * instance.
593
592
  * Currently, Amazon EC2 instances are the only supported instance type.</p>
593
+ * @public
594
594
  */
595
595
  export interface Instance {
596
596
  /**
597
- * @public
598
597
  * <p>The ID of the AMI used to launch the instance.</p>
598
+ * @public
599
599
  */
600
600
  imageId?: string;
601
601
  /**
602
- * @public
603
602
  * <p>The Amazon Machine Image (AMI) launch index, which you can use to find this instance in
604
603
  * the launch group. </p>
604
+ * @public
605
605
  */
606
606
  amiLaunchIndex?: number;
607
607
  /**
608
- * @public
609
608
  * <p>The ID of the instance.</p>
609
+ * @public
610
610
  */
611
611
  instanceId?: string;
612
612
  /**
613
- * @public
614
613
  * <p>The description of the current state of an instance.</p>
614
+ * @public
615
615
  */
616
616
  state?: InstanceState;
617
617
  /**
618
- * @public
619
618
  * <p>The instance type.</p>
619
+ * @public
620
620
  */
621
621
  instanceType?: string;
622
622
  /**
623
- * @public
624
623
  * <p>The private IPv4 address assigned to the instance.</p>
624
+ * @public
625
625
  */
626
626
  privateIpAddress?: string;
627
627
  /**
628
- * @public
629
628
  * <p>The public IPv4 address assigned to the instance.</p>
629
+ * @public
630
630
  */
631
631
  publicIpAddress?: string;
632
632
  /**
633
- * @public
634
633
  * <p>When the instance was created.</p>
634
+ * @public
635
635
  */
636
636
  createdAt?: Date;
637
637
  /**
638
- * @public
639
638
  * <p>When the instance was last updated.</p>
639
+ * @public
640
640
  */
641
641
  updatedAt?: Date;
642
642
  /**
643
- * @public
644
643
  * <p>Any block device mapping entries for the instance.</p>
644
+ * @public
645
645
  */
646
646
  blockDeviceMappings?: InstanceBlockDeviceMapping[];
647
647
  /**
648
- * @public
649
648
  * <p>The security groups for the instance.</p>
649
+ * @public
650
650
  */
651
651
  securityGroups?: SecurityGroupIdentifier[];
652
652
  /**
653
- * @public
654
653
  * <p>The CPU options for the instance.</p>
654
+ * @public
655
655
  */
656
656
  cpuOptions?: CpuOptions;
657
657
  /**
658
- * @public
659
658
  * <p>The device name of the root device volume (for example, <code>/dev/sda1</code>). </p>
659
+ * @public
660
660
  */
661
661
  rootDeviceName?: string;
662
662
  }
663
663
  /**
664
- * @public
665
664
  * <p>The details about the instance.</p>
665
+ * @public
666
666
  */
667
667
  export interface InstanceSummary {
668
668
  /**
669
- * @public
670
669
  * <p>A structure containing details about the instance.</p>
670
+ * @public
671
671
  */
672
672
  instance?: Instance;
673
673
  /**
674
- * @public
675
674
  * <p>When the instance summary was last updated.</p>
675
+ * @public
676
676
  */
677
677
  lastUpdatedAt?: Date;
678
678
  }
@@ -681,8 +681,8 @@ export interface InstanceSummary {
681
681
  */
682
682
  export interface DescribeDeviceEc2Output {
683
683
  /**
684
- * @public
685
684
  * <p>A list of structures containing information about each instance. </p>
685
+ * @public
686
686
  */
687
687
  instances?: InstanceSummary[];
688
688
  }
@@ -691,13 +691,13 @@ export interface DescribeDeviceEc2Output {
691
691
  */
692
692
  export interface DescribeExecutionInput {
693
693
  /**
694
- * @public
695
694
  * <p>The ID of the task that the action is describing.</p>
695
+ * @public
696
696
  */
697
697
  taskId: string | undefined;
698
698
  /**
699
- * @public
700
699
  * <p>The ID of the managed device.</p>
700
+ * @public
701
701
  */
702
702
  managedDeviceId: string | undefined;
703
703
  }
@@ -723,33 +723,33 @@ export type ExecutionState = (typeof ExecutionState)[keyof typeof ExecutionState
723
723
  */
724
724
  export interface DescribeExecutionOutput {
725
725
  /**
726
- * @public
727
726
  * <p>The ID of the task being executed on the device.</p>
727
+ * @public
728
728
  */
729
729
  taskId?: string;
730
730
  /**
731
- * @public
732
731
  * <p>The ID of the execution.</p>
732
+ * @public
733
733
  */
734
734
  executionId?: string;
735
735
  /**
736
- * @public
737
736
  * <p>The ID of the managed device that the task is being executed on.</p>
737
+ * @public
738
738
  */
739
739
  managedDeviceId?: string;
740
740
  /**
741
- * @public
742
741
  * <p>The current state of the execution.</p>
742
+ * @public
743
743
  */
744
744
  state?: ExecutionState;
745
745
  /**
746
- * @public
747
746
  * <p>When the execution began.</p>
747
+ * @public
748
748
  */
749
749
  startedAt?: Date;
750
750
  /**
751
- * @public
752
751
  * <p>When the status of the execution was last updated.</p>
752
+ * @public
753
753
  */
754
754
  lastUpdatedAt?: Date;
755
755
  }
@@ -758,8 +758,8 @@ export interface DescribeExecutionOutput {
758
758
  */
759
759
  export interface DescribeTaskInput {
760
760
  /**
761
- * @public
762
761
  * <p>The ID of the task to be described.</p>
762
+ * @public
763
763
  */
764
764
  taskId: string | undefined;
765
765
  }
@@ -781,76 +781,76 @@ export type TaskState = (typeof TaskState)[keyof typeof TaskState];
781
781
  */
782
782
  export interface DescribeTaskOutput {
783
783
  /**
784
- * @public
785
784
  * <p>The ID of the task.</p>
785
+ * @public
786
786
  */
787
787
  taskId?: string;
788
788
  /**
789
- * @public
790
789
  * <p>The Amazon Resource Name (ARN) of the task.</p>
790
+ * @public
791
791
  */
792
792
  taskArn?: string;
793
793
  /**
794
- * @public
795
794
  * <p>The managed devices that the task was sent to.</p>
795
+ * @public
796
796
  */
797
797
  targets?: string[];
798
798
  /**
799
- * @public
800
799
  * <p>The current state of the task.</p>
800
+ * @public
801
801
  */
802
802
  state?: TaskState;
803
803
  /**
804
- * @public
805
804
  * <p>When the <code>CreateTask</code> operation was called.</p>
805
+ * @public
806
806
  */
807
807
  createdAt?: Date;
808
808
  /**
809
- * @public
810
809
  * <p>When the state of the task was last updated.</p>
810
+ * @public
811
811
  */
812
812
  lastUpdatedAt?: Date;
813
813
  /**
814
- * @public
815
814
  * <p>When the task was completed.</p>
815
+ * @public
816
816
  */
817
817
  completedAt?: Date;
818
818
  /**
819
- * @public
820
819
  * <p>The description provided of the task and managed devices.</p>
820
+ * @public
821
821
  */
822
822
  description?: string;
823
823
  /**
824
- * @public
825
824
  * <p>Optional metadata that you assign to a resource. You can use tags to categorize a resource
826
825
  * in different ways, such as by purpose, owner, or environment.</p>
826
+ * @public
827
827
  */
828
828
  tags?: Record<string, string>;
829
829
  }
830
830
  /**
831
- * @public
832
831
  * <p>Identifying information about the device.</p>
832
+ * @public
833
833
  */
834
834
  export interface DeviceSummary {
835
835
  /**
836
- * @public
837
836
  * <p>The ID of the device.</p>
837
+ * @public
838
838
  */
839
839
  managedDeviceId?: string;
840
840
  /**
841
- * @public
842
841
  * <p>The Amazon Resource Name (ARN) of the device.</p>
842
+ * @public
843
843
  */
844
844
  managedDeviceArn?: string;
845
845
  /**
846
- * @public
847
846
  * <p>The ID of the job used to order the device.</p>
847
+ * @public
848
848
  */
849
849
  associatedWithJob?: string;
850
850
  /**
851
- * @public
852
851
  * <p>Optional metadata that you assign to a resource. You can use tags to categorize a resource
853
852
  * in different ways, such as by purpose, owner, or environment.</p>
853
+ * @public
854
854
  */
855
855
  tags?: Record<string, string>;
856
856
  }
@@ -859,49 +859,49 @@ export interface DeviceSummary {
859
859
  */
860
860
  export interface ListExecutionsInput {
861
861
  /**
862
- * @public
863
862
  * <p>The ID of the task.</p>
863
+ * @public
864
864
  */
865
865
  taskId: string | undefined;
866
866
  /**
867
- * @public
868
867
  * <p>A structure used to filter the tasks by their current state.</p>
868
+ * @public
869
869
  */
870
870
  state?: ExecutionState;
871
871
  /**
872
- * @public
873
872
  * <p>The maximum number of tasks to list per page.</p>
873
+ * @public
874
874
  */
875
875
  maxResults?: number;
876
876
  /**
877
- * @public
878
877
  * <p>A pagination token to continue to the next page of tasks.</p>
878
+ * @public
879
879
  */
880
880
  nextToken?: string;
881
881
  }
882
882
  /**
883
- * @public
884
883
  * <p>The summary of a task execution on a specified device.</p>
884
+ * @public
885
885
  */
886
886
  export interface ExecutionSummary {
887
887
  /**
888
- * @public
889
888
  * <p>The ID of the task.</p>
889
+ * @public
890
890
  */
891
891
  taskId?: string;
892
892
  /**
893
- * @public
894
893
  * <p>The ID of the execution.</p>
894
+ * @public
895
895
  */
896
896
  executionId?: string;
897
897
  /**
898
- * @public
899
898
  * <p>The ID of the managed device that the task is being executed on.</p>
899
+ * @public
900
900
  */
901
901
  managedDeviceId?: string;
902
902
  /**
903
- * @public
904
903
  * <p>The state of the execution.</p>
904
+ * @public
905
905
  */
906
906
  state?: ExecutionState;
907
907
  }
@@ -910,14 +910,14 @@ export interface ExecutionSummary {
910
910
  */
911
911
  export interface ListExecutionsOutput {
912
912
  /**
913
- * @public
914
913
  * <p>A list of executions. Each execution contains the task ID, the device that the task is
915
914
  * executing on, the execution ID, and the status of the execution.</p>
915
+ * @public
916
916
  */
917
917
  executions?: ExecutionSummary[];
918
918
  /**
919
- * @public
920
919
  * <p>A pagination token to continue to the next page of executions.</p>
920
+ * @public
921
921
  */
922
922
  nextToken?: string;
923
923
  }
@@ -926,44 +926,44 @@ export interface ListExecutionsOutput {
926
926
  */
927
927
  export interface ListDeviceResourcesInput {
928
928
  /**
929
- * @public
930
929
  * <p>The ID of the managed device that you are listing the resources of.</p>
930
+ * @public
931
931
  */
932
932
  managedDeviceId: string | undefined;
933
933
  /**
934
- * @public
935
934
  * <p>A structure used to filter the results by type of resource.</p>
935
+ * @public
936
936
  */
937
937
  type?: string;
938
938
  /**
939
- * @public
940
939
  * <p>The maximum number of resources per page.</p>
940
+ * @public
941
941
  */
942
942
  maxResults?: number;
943
943
  /**
944
- * @public
945
944
  * <p>A pagination token to continue to the next page of results.</p>
945
+ * @public
946
946
  */
947
947
  nextToken?: string;
948
948
  }
949
949
  /**
950
- * @public
951
950
  * <p>A summary of a resource available on the device.</p>
951
+ * @public
952
952
  */
953
953
  export interface ResourceSummary {
954
954
  /**
955
- * @public
956
955
  * <p>The resource type.</p>
956
+ * @public
957
957
  */
958
958
  resourceType: string | undefined;
959
959
  /**
960
- * @public
961
960
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
961
+ * @public
962
962
  */
963
963
  arn?: string;
964
964
  /**
965
- * @public
966
965
  * <p>The ID of the resource.</p>
966
+ * @public
967
967
  */
968
968
  id?: string;
969
969
  }
@@ -972,13 +972,13 @@ export interface ResourceSummary {
972
972
  */
973
973
  export interface ListDeviceResourcesOutput {
974
974
  /**
975
- * @public
976
975
  * <p>A structure defining the resource's type, Amazon Resource Name (ARN), and ID.</p>
976
+ * @public
977
977
  */
978
978
  resources?: ResourceSummary[];
979
979
  /**
980
- * @public
981
980
  * <p>A pagination token to continue to the next page of results.</p>
981
+ * @public
982
982
  */
983
983
  nextToken?: string;
984
984
  }
@@ -987,18 +987,18 @@ export interface ListDeviceResourcesOutput {
987
987
  */
988
988
  export interface ListDevicesInput {
989
989
  /**
990
- * @public
991
990
  * <p>The ID of the job used to order the device.</p>
991
+ * @public
992
992
  */
993
993
  jobId?: string;
994
994
  /**
995
- * @public
996
995
  * <p>The maximum number of devices to list per page.</p>
996
+ * @public
997
997
  */
998
998
  maxResults?: number;
999
999
  /**
1000
- * @public
1001
1000
  * <p>A pagination token to continue to the next page of results.</p>
1001
+ * @public
1002
1002
  */
1003
1003
  nextToken?: string;
1004
1004
  }
@@ -1007,13 +1007,13 @@ export interface ListDevicesInput {
1007
1007
  */
1008
1008
  export interface ListDevicesOutput {
1009
1009
  /**
1010
- * @public
1011
1010
  * <p>A list of device structures that contain information about the device.</p>
1011
+ * @public
1012
1012
  */
1013
1013
  devices?: DeviceSummary[];
1014
1014
  /**
1015
- * @public
1016
1015
  * <p>A pagination token to continue to the next page of devices.</p>
1016
+ * @public
1017
1017
  */
1018
1018
  nextToken?: string;
1019
1019
  }
@@ -1022,8 +1022,8 @@ export interface ListDevicesOutput {
1022
1022
  */
1023
1023
  export interface ListTagsForResourceInput {
1024
1024
  /**
1025
- * @public
1026
1025
  * <p>The Amazon Resource Name (ARN) of the device or task.</p>
1026
+ * @public
1027
1027
  */
1028
1028
  resourceArn: string | undefined;
1029
1029
  }
@@ -1032,8 +1032,8 @@ export interface ListTagsForResourceInput {
1032
1032
  */
1033
1033
  export interface ListTagsForResourceOutput {
1034
1034
  /**
1035
- * @public
1036
1035
  * <p>The list of tags for the device or task.</p>
1036
+ * @public
1037
1037
  */
1038
1038
  tags?: Record<string, string>;
1039
1039
  }
@@ -1042,45 +1042,45 @@ export interface ListTagsForResourceOutput {
1042
1042
  */
1043
1043
  export interface ListTasksInput {
1044
1044
  /**
1045
- * @public
1046
1045
  * <p>A structure used to filter the list of tasks.</p>
1046
+ * @public
1047
1047
  */
1048
1048
  state?: TaskState;
1049
1049
  /**
1050
- * @public
1051
1050
  * <p>The maximum number of tasks per page.</p>
1051
+ * @public
1052
1052
  */
1053
1053
  maxResults?: number;
1054
1054
  /**
1055
- * @public
1056
1055
  * <p>A pagination token to continue to the next page of tasks.</p>
1056
+ * @public
1057
1057
  */
1058
1058
  nextToken?: string;
1059
1059
  }
1060
1060
  /**
1061
- * @public
1062
1061
  * <p>Information about the task assigned to one or many devices.</p>
1062
+ * @public
1063
1063
  */
1064
1064
  export interface TaskSummary {
1065
1065
  /**
1066
- * @public
1067
1066
  * <p>The task ID.</p>
1067
+ * @public
1068
1068
  */
1069
1069
  taskId: string | undefined;
1070
1070
  /**
1071
- * @public
1072
1071
  * <p>The Amazon Resource Name (ARN) of the task.</p>
1072
+ * @public
1073
1073
  */
1074
1074
  taskArn?: string;
1075
1075
  /**
1076
- * @public
1077
1076
  * <p>The state of the task assigned to one or many devices.</p>
1077
+ * @public
1078
1078
  */
1079
1079
  state?: TaskState;
1080
1080
  /**
1081
- * @public
1082
1081
  * <p>Optional metadata that you assign to a resource. You can use tags to categorize a resource
1083
1082
  * in different ways, such as by purpose, owner, or environment.</p>
1083
+ * @public
1084
1084
  */
1085
1085
  tags?: Record<string, string>;
1086
1086
  }
@@ -1089,13 +1089,13 @@ export interface TaskSummary {
1089
1089
  */
1090
1090
  export interface ListTasksOutput {
1091
1091
  /**
1092
- * @public
1093
1092
  * <p>A list of task structures containing details about each task.</p>
1093
+ * @public
1094
1094
  */
1095
1095
  tasks?: TaskSummary[];
1096
1096
  /**
1097
- * @public
1098
1097
  * <p>A pagination token to continue to the next page of tasks.</p>
1098
+ * @public
1099
1099
  */
1100
1100
  nextToken?: string;
1101
1101
  }
@@ -1104,14 +1104,14 @@ export interface ListTasksOutput {
1104
1104
  */
1105
1105
  export interface TagResourceInput {
1106
1106
  /**
1107
- * @public
1108
1107
  * <p>The Amazon Resource Name (ARN) of the device or task.</p>
1108
+ * @public
1109
1109
  */
1110
1110
  resourceArn: string | undefined;
1111
1111
  /**
1112
- * @public
1113
1112
  * <p>Optional metadata that you assign to a resource. You can use tags to categorize a resource
1114
1113
  * in different ways, such as by purpose, owner, or environment.</p>
1114
+ * @public
1115
1115
  */
1116
1116
  tags: Record<string, string> | undefined;
1117
1117
  }
@@ -1120,14 +1120,14 @@ export interface TagResourceInput {
1120
1120
  */
1121
1121
  export interface UntagResourceInput {
1122
1122
  /**
1123
- * @public
1124
1123
  * <p>The Amazon Resource Name (ARN) of the device or task.</p>
1124
+ * @public
1125
1125
  */
1126
1126
  resourceArn: string | undefined;
1127
1127
  /**
1128
- * @public
1129
1128
  * <p>Optional metadata that you assign to a resource. You can use tags to categorize a resource
1130
1129
  * in different ways, such as by purpose, owner, or environment.</p>
1130
+ * @public
1131
1131
  */
1132
1132
  tagKeys: string[] | undefined;
1133
1133
  }