@aws-sdk/client-ssm 3.379.1 → 3.385.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.
@@ -20,16 +20,19 @@ export declare class InvalidUpdate extends __BaseException {
20
20
  */
21
21
  export interface UpdateAssociationRequest {
22
22
  /**
23
+ * @public
23
24
  * <p>The ID of the association you want to update. </p>
24
25
  */
25
26
  AssociationId: string | undefined;
26
27
  /**
28
+ * @public
27
29
  * <p>The parameters you want to update for the association. If you create a parameter using
28
30
  * Parameter Store, a capability of Amazon Web Services Systems Manager, you can reference the parameter using
29
31
  * <code>\{\{ssm:parameter-name\}\}</code>.</p>
30
32
  */
31
33
  Parameters?: Record<string, string[]>;
32
34
  /**
35
+ * @public
33
36
  * <p>The document version you want update for the association. </p>
34
37
  * <important>
35
38
  * <p>State Manager doesn't support running associations that use a new version of a document if
@@ -41,14 +44,17 @@ export interface UpdateAssociationRequest {
41
44
  */
42
45
  DocumentVersion?: string;
43
46
  /**
47
+ * @public
44
48
  * <p>The cron expression used to schedule the association that you want to update.</p>
45
49
  */
46
50
  ScheduleExpression?: string;
47
51
  /**
52
+ * @public
48
53
  * <p>An S3 bucket where you want to store the results of this request.</p>
49
54
  */
50
55
  OutputLocation?: InstanceAssociationOutputLocation;
51
56
  /**
57
+ * @public
52
58
  * <p>The name of the SSM Command document or Automation runbook that contains the configuration
53
59
  * information for the managed node.</p>
54
60
  * <p>You can specify Amazon Web Services-predefined documents, documents you created, or a document that is
@@ -69,26 +75,31 @@ export interface UpdateAssociationRequest {
69
75
  */
70
76
  Name?: string;
71
77
  /**
78
+ * @public
72
79
  * <p>The targets of the association.</p>
73
80
  */
74
81
  Targets?: Target[];
75
82
  /**
83
+ * @public
76
84
  * <p>The name of the association that you want to update.</p>
77
85
  */
78
86
  AssociationName?: string;
79
87
  /**
88
+ * @public
80
89
  * <p>This parameter is provided for concurrency control purposes. You must specify the latest
81
90
  * association version in the service. If you want to ensure that this request succeeds, either
82
91
  * specify <code>$LATEST</code>, or omit this parameter.</p>
83
92
  */
84
93
  AssociationVersion?: string;
85
94
  /**
95
+ * @public
86
96
  * <p>Choose the parameter that will define how your automation will branch out. This target is
87
97
  * required for associations that use an Automation runbook and target resources by using rate
88
98
  * controls. Automation is a capability of Amazon Web Services Systems Manager.</p>
89
99
  */
90
100
  AutomationTargetParameterName?: string;
91
101
  /**
102
+ * @public
92
103
  * <p>The number of errors that are allowed before the system stops sending requests to run the
93
104
  * association on additional targets. You can specify either an absolute number of errors, for
94
105
  * example 10, or a percentage of the target set, for example 10%. If you specify 3, for example,
@@ -103,6 +114,7 @@ export interface UpdateAssociationRequest {
103
114
  */
104
115
  MaxErrors?: string;
105
116
  /**
117
+ * @public
106
118
  * <p>The maximum number of targets allowed to run the association at the same time. You can
107
119
  * specify a number, for example 10, or a percentage of the target set, for example 10%. The default
108
120
  * value is 100%, which means all targets run the association at the same time.</p>
@@ -113,10 +125,12 @@ export interface UpdateAssociationRequest {
113
125
  */
114
126
  MaxConcurrency?: string;
115
127
  /**
128
+ * @public
116
129
  * <p>The severity level to assign to the association.</p>
117
130
  */
118
131
  ComplianceSeverity?: AssociationComplianceSeverity | string;
119
132
  /**
133
+ * @public
120
134
  * <p>The mode for generating association compliance. You can specify <code>AUTO</code> or
121
135
  * <code>MANUAL</code>. In <code>AUTO</code> mode, the system uses the status of the association
122
136
  * execution to determine the compliance status. If the association execution runs successfully,
@@ -130,6 +144,7 @@ export interface UpdateAssociationRequest {
130
144
  */
131
145
  SyncCompliance?: AssociationSyncCompliance | string;
132
146
  /**
147
+ * @public
133
148
  * <p>By default, when you update an association, the system runs it immediately after it is
134
149
  * updated and then according to the schedule you specified. Specify this option if you don't want
135
150
  * an association to run immediately after you update it. This parameter isn't supported for rate
@@ -148,6 +163,7 @@ export interface UpdateAssociationRequest {
148
163
  */
149
164
  ApplyOnlyAtCronInterval?: boolean;
150
165
  /**
166
+ * @public
151
167
  * <p>The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to
152
168
  * gate your associations under. The associations only run when that change calendar is open. For
153
169
  * more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar">Amazon Web Services Systems Manager Change
@@ -155,12 +171,14 @@ export interface UpdateAssociationRequest {
155
171
  */
156
172
  CalendarNames?: string[];
157
173
  /**
174
+ * @public
158
175
  * <p>A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the
159
176
  * association. Use this action to update an association in multiple Regions and multiple
160
177
  * accounts.</p>
161
178
  */
162
179
  TargetLocations?: TargetLocation[];
163
180
  /**
181
+ * @public
164
182
  * <p>Number of days to wait after the scheduled day to run an association. For example, if you
165
183
  * specified a cron schedule of <code>cron(0 0 ? * THU#2 *)</code>, you could specify an offset of 3
166
184
  * to run the association each Sunday after the second Thursday of the month. For more information
@@ -173,11 +191,13 @@ export interface UpdateAssociationRequest {
173
191
  */
174
192
  ScheduleOffset?: number;
175
193
  /**
194
+ * @public
176
195
  * <p>A key-value mapping of document parameters to target resources. Both Targets and TargetMaps
177
196
  * can't be specified together.</p>
178
197
  */
179
198
  TargetMaps?: Record<string, string[]>[];
180
199
  /**
200
+ * @public
181
201
  * <p>The details for the CloudWatch alarm you want to apply to an automation or
182
202
  * command.</p>
183
203
  */
@@ -188,6 +208,7 @@ export interface UpdateAssociationRequest {
188
208
  */
189
209
  export interface UpdateAssociationResult {
190
210
  /**
211
+ * @public
191
212
  * <p>The description of the association that was updated.</p>
192
213
  */
193
214
  AssociationDescription?: AssociationDescription;
@@ -209,14 +230,17 @@ export declare class StatusUnchanged extends __BaseException {
209
230
  */
210
231
  export interface UpdateAssociationStatusRequest {
211
232
  /**
233
+ * @public
212
234
  * <p>The name of the SSM document.</p>
213
235
  */
214
236
  Name: string | undefined;
215
237
  /**
238
+ * @public
216
239
  * <p>The managed node ID.</p>
217
240
  */
218
241
  InstanceId: string | undefined;
219
242
  /**
243
+ * @public
220
244
  * <p>The association status.</p>
221
245
  */
222
246
  AssociationStatus: AssociationStatus | undefined;
@@ -226,6 +250,7 @@ export interface UpdateAssociationStatusRequest {
226
250
  */
227
251
  export interface UpdateAssociationStatusResult {
228
252
  /**
253
+ * @public
229
254
  * <p>Information about the association.</p>
230
255
  */
231
256
  AssociationDescription?: AssociationDescription;
@@ -277,30 +302,36 @@ export declare class DuplicateDocumentVersionName extends __BaseException {
277
302
  */
278
303
  export interface UpdateDocumentRequest {
279
304
  /**
305
+ * @public
280
306
  * <p>A valid JSON or YAML string.</p>
281
307
  */
282
308
  Content: string | undefined;
283
309
  /**
310
+ * @public
284
311
  * <p>A list of key-value pairs that describe attachments to a version of a document.</p>
285
312
  */
286
313
  Attachments?: AttachmentsSource[];
287
314
  /**
315
+ * @public
288
316
  * <p>The name of the SSM document that you want to update.</p>
289
317
  */
290
318
  Name: string | undefined;
291
319
  /**
320
+ * @public
292
321
  * <p>The friendly name of the SSM document that you want to update. This value can differ for
293
322
  * each version of the document. If you don't specify a value for this parameter in your request,
294
323
  * the existing value is applied to the new document version.</p>
295
324
  */
296
325
  DisplayName?: string;
297
326
  /**
327
+ * @public
298
328
  * <p>An optional field specifying the version of the artifact you are updating with the document.
299
329
  * For example, "Release 12, Update 6". This value is unique across all versions of a document, and
300
330
  * can't be changed.</p>
301
331
  */
302
332
  VersionName?: string;
303
333
  /**
334
+ * @public
304
335
  * <p>The version of the document that you want to update. Currently, Systems Manager supports updating only
305
336
  * the latest version of the document. You can specify the version number of the latest version or
306
337
  * use the <code>$LATEST</code> variable.</p>
@@ -312,11 +343,13 @@ export interface UpdateDocumentRequest {
312
343
  */
313
344
  DocumentVersion?: string;
314
345
  /**
346
+ * @public
315
347
  * <p>Specify the document format for the new document version. Systems Manager supports JSON and YAML
316
348
  * documents. JSON is the default format.</p>
317
349
  */
318
350
  DocumentFormat?: DocumentFormat | string;
319
351
  /**
352
+ * @public
320
353
  * <p>Specify a new target type for the document.</p>
321
354
  */
322
355
  TargetType?: string;
@@ -326,6 +359,7 @@ export interface UpdateDocumentRequest {
326
359
  */
327
360
  export interface UpdateDocumentResult {
328
361
  /**
362
+ * @public
329
363
  * <p>A description of the document that was updated.</p>
330
364
  */
331
365
  DocumentDescription?: DocumentDescription;
@@ -335,10 +369,12 @@ export interface UpdateDocumentResult {
335
369
  */
336
370
  export interface UpdateDocumentDefaultVersionRequest {
337
371
  /**
372
+ * @public
338
373
  * <p>The name of a custom document that you want to set as the default version.</p>
339
374
  */
340
375
  Name: string | undefined;
341
376
  /**
377
+ * @public
342
378
  * <p>The version of a custom document that you want to set as the default version.</p>
343
379
  */
344
380
  DocumentVersion: string | undefined;
@@ -349,14 +385,17 @@ export interface UpdateDocumentDefaultVersionRequest {
349
385
  */
350
386
  export interface DocumentDefaultVersionDescription {
351
387
  /**
388
+ * @public
352
389
  * <p>The name of the document.</p>
353
390
  */
354
391
  Name?: string;
355
392
  /**
393
+ * @public
356
394
  * <p>The default version of the document.</p>
357
395
  */
358
396
  DefaultVersion?: string;
359
397
  /**
398
+ * @public
360
399
  * <p>The default version of the artifact associated with the document.</p>
361
400
  */
362
401
  DefaultVersionName?: string;
@@ -366,6 +405,7 @@ export interface DocumentDefaultVersionDescription {
366
405
  */
367
406
  export interface UpdateDocumentDefaultVersionResult {
368
407
  /**
408
+ * @public
369
409
  * <p>The description of a custom document that you want to set as the default version.</p>
370
410
  */
371
411
  Description?: DocumentDefaultVersionDescription;
@@ -390,10 +430,12 @@ export type DocumentReviewAction = (typeof DocumentReviewAction)[keyof typeof Do
390
430
  */
391
431
  export interface DocumentReviews {
392
432
  /**
433
+ * @public
393
434
  * <p>The action to take on a document approval review request.</p>
394
435
  */
395
436
  Action: DocumentReviewAction | string | undefined;
396
437
  /**
438
+ * @public
397
439
  * <p>A comment entered by a user in your organization about the document review request.</p>
398
440
  */
399
441
  Comment?: DocumentReviewCommentSource[];
@@ -403,14 +445,17 @@ export interface DocumentReviews {
403
445
  */
404
446
  export interface UpdateDocumentMetadataRequest {
405
447
  /**
448
+ * @public
406
449
  * <p>The name of the change template for which a version's metadata is to be updated.</p>
407
450
  */
408
451
  Name: string | undefined;
409
452
  /**
453
+ * @public
410
454
  * <p>The version of a change template in which to update approval metadata.</p>
411
455
  */
412
456
  DocumentVersion?: string;
413
457
  /**
458
+ * @public
414
459
  * <p>The change template review details to update.</p>
415
460
  */
416
461
  DocumentReviews: DocumentReviews | undefined;
@@ -425,34 +470,41 @@ export interface UpdateDocumentMetadataResponse {
425
470
  */
426
471
  export interface UpdateMaintenanceWindowRequest {
427
472
  /**
473
+ * @public
428
474
  * <p>The ID of the maintenance window to update.</p>
429
475
  */
430
476
  WindowId: string | undefined;
431
477
  /**
478
+ * @public
432
479
  * <p>The name of the maintenance window.</p>
433
480
  */
434
481
  Name?: string;
435
482
  /**
483
+ * @public
436
484
  * <p>An optional description for the update request.</p>
437
485
  */
438
486
  Description?: string;
439
487
  /**
488
+ * @public
440
489
  * <p>The date and time, in ISO-8601 Extended format, for when you want the maintenance window to
441
490
  * become active. <code>StartDate</code> allows you to delay activation of the maintenance window
442
491
  * until the specified future date.</p>
443
492
  */
444
493
  StartDate?: string;
445
494
  /**
495
+ * @public
446
496
  * <p>The date and time, in ISO-8601 Extended format, for when you want the maintenance window to
447
497
  * become inactive. <code>EndDate</code> allows you to set a date and time in the future when the
448
498
  * maintenance window will no longer run.</p>
449
499
  */
450
500
  EndDate?: string;
451
501
  /**
502
+ * @public
452
503
  * <p>The schedule of the maintenance window in the form of a cron or rate expression.</p>
453
504
  */
454
505
  Schedule?: string;
455
506
  /**
507
+ * @public
456
508
  * <p>The time zone that the scheduled maintenance window executions are based on, in Internet
457
509
  * Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or
458
510
  * "Asia/Seoul". For more information, see the <a href="https://www.iana.org/time-zones">Time
@@ -460,6 +512,7 @@ export interface UpdateMaintenanceWindowRequest {
460
512
  */
461
513
  ScheduleTimezone?: string;
462
514
  /**
515
+ * @public
463
516
  * <p>The number of days to wait after the date and time specified by a cron expression before
464
517
  * running the maintenance window.</p>
465
518
  * <p>For example, the following cron expression schedules a maintenance window to run the third
@@ -472,24 +525,29 @@ export interface UpdateMaintenanceWindowRequest {
472
525
  */
473
526
  ScheduleOffset?: number;
474
527
  /**
528
+ * @public
475
529
  * <p>The duration of the maintenance window in hours.</p>
476
530
  */
477
531
  Duration?: number;
478
532
  /**
533
+ * @public
479
534
  * <p>The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling
480
535
  * new tasks for execution.</p>
481
536
  */
482
537
  Cutoff?: number;
483
538
  /**
539
+ * @public
484
540
  * <p>Whether targets must be registered with the maintenance window before tasks can be defined
485
541
  * for those targets.</p>
486
542
  */
487
543
  AllowUnassociatedTargets?: boolean;
488
544
  /**
545
+ * @public
489
546
  * <p>Whether the maintenance window is enabled.</p>
490
547
  */
491
548
  Enabled?: boolean;
492
549
  /**
550
+ * @public
493
551
  * <p>If <code>True</code>, then all fields that are required by the <a>CreateMaintenanceWindow</a> operation are also required for this API request. Optional
494
552
  * fields that aren't specified are set to null. </p>
495
553
  */
@@ -500,32 +558,39 @@ export interface UpdateMaintenanceWindowRequest {
500
558
  */
501
559
  export interface UpdateMaintenanceWindowResult {
502
560
  /**
561
+ * @public
503
562
  * <p>The ID of the created maintenance window.</p>
504
563
  */
505
564
  WindowId?: string;
506
565
  /**
566
+ * @public
507
567
  * <p>The name of the maintenance window.</p>
508
568
  */
509
569
  Name?: string;
510
570
  /**
571
+ * @public
511
572
  * <p>An optional description of the update.</p>
512
573
  */
513
574
  Description?: string;
514
575
  /**
576
+ * @public
515
577
  * <p>The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled
516
578
  * to become active. The maintenance window won't run before this specified time.</p>
517
579
  */
518
580
  StartDate?: string;
519
581
  /**
582
+ * @public
520
583
  * <p>The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled
521
584
  * to become inactive. The maintenance window won't run after this specified time.</p>
522
585
  */
523
586
  EndDate?: string;
524
587
  /**
588
+ * @public
525
589
  * <p>The schedule of the maintenance window in the form of a cron or rate expression.</p>
526
590
  */
527
591
  Schedule?: string;
528
592
  /**
593
+ * @public
529
594
  * <p>The time zone that the scheduled maintenance window executions are based on, in Internet
530
595
  * Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or
531
596
  * "Asia/Seoul". For more information, see the <a href="https://www.iana.org/time-zones">Time
@@ -533,25 +598,30 @@ export interface UpdateMaintenanceWindowResult {
533
598
  */
534
599
  ScheduleTimezone?: string;
535
600
  /**
601
+ * @public
536
602
  * <p>The number of days to wait to run a maintenance window after the scheduled cron expression
537
603
  * date and time.</p>
538
604
  */
539
605
  ScheduleOffset?: number;
540
606
  /**
607
+ * @public
541
608
  * <p>The duration of the maintenance window in hours.</p>
542
609
  */
543
610
  Duration?: number;
544
611
  /**
612
+ * @public
545
613
  * <p>The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling
546
614
  * new tasks for execution.</p>
547
615
  */
548
616
  Cutoff?: number;
549
617
  /**
618
+ * @public
550
619
  * <p>Whether targets must be registered with the maintenance window before tasks can be defined
551
620
  * for those targets.</p>
552
621
  */
553
622
  AllowUnassociatedTargets?: boolean;
554
623
  /**
624
+ * @public
555
625
  * <p>Whether the maintenance window is enabled.</p>
556
626
  */
557
627
  Enabled?: boolean;
@@ -561,31 +631,38 @@ export interface UpdateMaintenanceWindowResult {
561
631
  */
562
632
  export interface UpdateMaintenanceWindowTargetRequest {
563
633
  /**
634
+ * @public
564
635
  * <p>The maintenance window ID with which to modify the target.</p>
565
636
  */
566
637
  WindowId: string | undefined;
567
638
  /**
639
+ * @public
568
640
  * <p>The target ID to modify.</p>
569
641
  */
570
642
  WindowTargetId: string | undefined;
571
643
  /**
644
+ * @public
572
645
  * <p>The targets to add or replace.</p>
573
646
  */
574
647
  Targets?: Target[];
575
648
  /**
649
+ * @public
576
650
  * <p>User-provided value that will be included in any Amazon CloudWatch Events events raised while
577
651
  * running tasks for these targets in this maintenance window.</p>
578
652
  */
579
653
  OwnerInformation?: string;
580
654
  /**
655
+ * @public
581
656
  * <p>A name for the update.</p>
582
657
  */
583
658
  Name?: string;
584
659
  /**
660
+ * @public
585
661
  * <p>An optional description for the update.</p>
586
662
  */
587
663
  Description?: string;
588
664
  /**
665
+ * @public
589
666
  * <p>If <code>True</code>, then all fields that are required by the <a>RegisterTargetWithMaintenanceWindow</a> operation are also required for this API
590
667
  * request. Optional fields that aren't specified are set to null.</p>
591
668
  */
@@ -596,26 +673,32 @@ export interface UpdateMaintenanceWindowTargetRequest {
596
673
  */
597
674
  export interface UpdateMaintenanceWindowTargetResult {
598
675
  /**
676
+ * @public
599
677
  * <p>The maintenance window ID specified in the update request.</p>
600
678
  */
601
679
  WindowId?: string;
602
680
  /**
681
+ * @public
603
682
  * <p>The target ID specified in the update request.</p>
604
683
  */
605
684
  WindowTargetId?: string;
606
685
  /**
686
+ * @public
607
687
  * <p>The updated targets.</p>
608
688
  */
609
689
  Targets?: Target[];
610
690
  /**
691
+ * @public
611
692
  * <p>The updated owner.</p>
612
693
  */
613
694
  OwnerInformation?: string;
614
695
  /**
696
+ * @public
615
697
  * <p>The updated name.</p>
616
698
  */
617
699
  Name?: string;
618
700
  /**
701
+ * @public
619
702
  * <p>The updated description.</p>
620
703
  */
621
704
  Description?: string;
@@ -625,14 +708,17 @@ export interface UpdateMaintenanceWindowTargetResult {
625
708
  */
626
709
  export interface UpdateMaintenanceWindowTaskRequest {
627
710
  /**
711
+ * @public
628
712
  * <p>The maintenance window ID that contains the task to modify.</p>
629
713
  */
630
714
  WindowId: string | undefined;
631
715
  /**
716
+ * @public
632
717
  * <p>The task ID to modify.</p>
633
718
  */
634
719
  WindowTaskId: string | undefined;
635
720
  /**
721
+ * @public
636
722
  * <p>The targets (either managed nodes or tags) to modify. Managed nodes are specified using the
637
723
  * format <code>Key=instanceids,Values=instanceID_1,instanceID_2</code>. Tags are specified using
638
724
  * the format <code> Key=tag_name,Values=tag_value</code>. </p>
@@ -647,10 +733,12 @@ export interface UpdateMaintenanceWindowTaskRequest {
647
733
  */
648
734
  Targets?: Target[];
649
735
  /**
736
+ * @public
650
737
  * <p>The task ARN to modify.</p>
651
738
  */
652
739
  TaskArn?: string;
653
740
  /**
741
+ * @public
654
742
  * <p>The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a
655
743
  * maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's
656
744
  * service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run
@@ -673,6 +761,7 @@ export interface UpdateMaintenanceWindowTaskRequest {
673
761
  */
674
762
  ServiceRoleArn?: string;
675
763
  /**
764
+ * @public
676
765
  * <p>The parameters to modify.</p>
677
766
  * <note>
678
767
  * <p>
@@ -687,6 +776,7 @@ export interface UpdateMaintenanceWindowTaskRequest {
687
776
  */
688
777
  TaskParameters?: Record<string, MaintenanceWindowTaskParameterValueExpression>;
689
778
  /**
779
+ * @public
690
780
  * <p>The parameters that the task should use during execution. Populate only the fields that
691
781
  * match the task type. All other fields should be empty.</p>
692
782
  * <important>
@@ -702,11 +792,13 @@ export interface UpdateMaintenanceWindowTaskRequest {
702
792
  */
703
793
  TaskInvocationParameters?: MaintenanceWindowTaskInvocationParameters;
704
794
  /**
795
+ * @public
705
796
  * <p>The new task priority to specify. The lower the number, the higher the priority. Tasks that
706
797
  * have the same priority are scheduled in parallel.</p>
707
798
  */
708
799
  Priority?: number;
709
800
  /**
801
+ * @public
710
802
  * <p>The new <code>MaxConcurrency</code> value you want to specify. <code>MaxConcurrency</code>
711
803
  * is the number of targets that are allowed to run this task, in parallel.</p>
712
804
  * <note>
@@ -720,6 +812,7 @@ export interface UpdateMaintenanceWindowTaskRequest {
720
812
  */
721
813
  MaxConcurrency?: string;
722
814
  /**
815
+ * @public
723
816
  * <p>The new <code>MaxErrors</code> value to specify. <code>MaxErrors</code> is the maximum
724
817
  * number of errors that are allowed before the task stops being scheduled.</p>
725
818
  * <note>
@@ -733,6 +826,7 @@ export interface UpdateMaintenanceWindowTaskRequest {
733
826
  */
734
827
  MaxErrors?: string;
735
828
  /**
829
+ * @public
736
830
  * <p>The new logging location in Amazon S3 to specify.</p>
737
831
  * <note>
738
832
  * <p>
@@ -744,19 +838,23 @@ export interface UpdateMaintenanceWindowTaskRequest {
744
838
  */
745
839
  LoggingInfo?: LoggingInfo;
746
840
  /**
841
+ * @public
747
842
  * <p>The new task name to specify.</p>
748
843
  */
749
844
  Name?: string;
750
845
  /**
846
+ * @public
751
847
  * <p>The new task description to specify.</p>
752
848
  */
753
849
  Description?: string;
754
850
  /**
851
+ * @public
755
852
  * <p>If True, then all fields that are required by the <a>RegisterTaskWithMaintenanceWindow</a> operation are also required for this API request.
756
853
  * Optional fields that aren't specified are set to null.</p>
757
854
  */
758
855
  Replace?: boolean;
759
856
  /**
857
+ * @public
760
858
  * <p>Indicates whether tasks should continue to run after the cutoff time specified in the
761
859
  * maintenance windows is reached. </p>
762
860
  * <ul>
@@ -786,6 +884,7 @@ export interface UpdateMaintenanceWindowTaskRequest {
786
884
  */
787
885
  CutoffBehavior?: MaintenanceWindowTaskCutoffBehavior | string;
788
886
  /**
887
+ * @public
789
888
  * <p>The CloudWatch alarm you want to apply to your maintenance window task.</p>
790
889
  */
791
890
  AlarmConfiguration?: AlarmConfiguration;
@@ -795,27 +894,33 @@ export interface UpdateMaintenanceWindowTaskRequest {
795
894
  */
796
895
  export interface UpdateMaintenanceWindowTaskResult {
797
896
  /**
897
+ * @public
798
898
  * <p>The ID of the maintenance window that was updated.</p>
799
899
  */
800
900
  WindowId?: string;
801
901
  /**
902
+ * @public
802
903
  * <p>The task ID of the maintenance window that was updated.</p>
803
904
  */
804
905
  WindowTaskId?: string;
805
906
  /**
907
+ * @public
806
908
  * <p>The updated target values.</p>
807
909
  */
808
910
  Targets?: Target[];
809
911
  /**
912
+ * @public
810
913
  * <p>The updated task ARN value.</p>
811
914
  */
812
915
  TaskArn?: string;
813
916
  /**
917
+ * @public
814
918
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service
815
919
  * (Amazon SNS) notifications for maintenance window Run Command tasks.</p>
816
920
  */
817
921
  ServiceRoleArn?: string;
818
922
  /**
923
+ * @public
819
924
  * <p>The updated parameter values.</p>
820
925
  * <note>
821
926
  * <p>
@@ -827,22 +932,27 @@ export interface UpdateMaintenanceWindowTaskResult {
827
932
  */
828
933
  TaskParameters?: Record<string, MaintenanceWindowTaskParameterValueExpression>;
829
934
  /**
935
+ * @public
830
936
  * <p>The updated parameter values.</p>
831
937
  */
832
938
  TaskInvocationParameters?: MaintenanceWindowTaskInvocationParameters;
833
939
  /**
940
+ * @public
834
941
  * <p>The updated priority value.</p>
835
942
  */
836
943
  Priority?: number;
837
944
  /**
945
+ * @public
838
946
  * <p>The updated <code>MaxConcurrency</code> value.</p>
839
947
  */
840
948
  MaxConcurrency?: string;
841
949
  /**
950
+ * @public
842
951
  * <p>The updated <code>MaxErrors</code> value.</p>
843
952
  */
844
953
  MaxErrors?: string;
845
954
  /**
955
+ * @public
846
956
  * <p>The updated logging information in Amazon S3.</p>
847
957
  * <note>
848
958
  * <p>
@@ -854,19 +964,23 @@ export interface UpdateMaintenanceWindowTaskResult {
854
964
  */
855
965
  LoggingInfo?: LoggingInfo;
856
966
  /**
967
+ * @public
857
968
  * <p>The updated task name.</p>
858
969
  */
859
970
  Name?: string;
860
971
  /**
972
+ * @public
861
973
  * <p>The updated task description.</p>
862
974
  */
863
975
  Description?: string;
864
976
  /**
977
+ * @public
865
978
  * <p>The specification for whether tasks should continue to run after the cutoff time specified
866
979
  * in the maintenance windows is reached. </p>
867
980
  */
868
981
  CutoffBehavior?: MaintenanceWindowTaskCutoffBehavior | string;
869
982
  /**
983
+ * @public
870
984
  * <p>The details for the CloudWatch alarm you applied to your maintenance window
871
985
  * task.</p>
872
986
  */
@@ -877,10 +991,12 @@ export interface UpdateMaintenanceWindowTaskResult {
877
991
  */
878
992
  export interface UpdateManagedInstanceRoleRequest {
879
993
  /**
994
+ * @public
880
995
  * <p>The ID of the managed node where you want to update the role.</p>
881
996
  */
882
997
  InstanceId: string | undefined;
883
998
  /**
999
+ * @public
884
1000
  * <p>The name of the Identity and Access Management (IAM) role that you want to assign to
885
1001
  * the managed node. This IAM role must provide AssumeRole permissions for the
886
1002
  * Amazon Web Services Systems Manager service principal <code>ssm.amazonaws.com</code>. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html">Create an
@@ -903,11 +1019,13 @@ export interface UpdateManagedInstanceRoleResult {
903
1019
  */
904
1020
  export interface UpdateOpsItemRequest {
905
1021
  /**
1022
+ * @public
906
1023
  * <p>Update the information about the OpsItem. Provide enough information so that users reading
907
1024
  * this OpsItem for the first time understand the issue. </p>
908
1025
  */
909
1026
  Description?: string;
910
1027
  /**
1028
+ * @public
911
1029
  * <p>Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem
912
1030
  * object.</p>
913
1031
  * <p>Operational data is custom data that provides useful reference details about the OpsItem.
@@ -932,66 +1050,80 @@ export interface UpdateOpsItemRequest {
932
1050
  */
933
1051
  OperationalData?: Record<string, OpsItemDataValue>;
934
1052
  /**
1053
+ * @public
935
1054
  * <p>Keys that you want to remove from the OperationalData map.</p>
936
1055
  */
937
1056
  OperationalDataToDelete?: string[];
938
1057
  /**
1058
+ * @public
939
1059
  * <p>The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this
940
1060
  * OpsItem is edited or changed.</p>
941
1061
  */
942
1062
  Notifications?: OpsItemNotification[];
943
1063
  /**
1064
+ * @public
944
1065
  * <p>The importance of this OpsItem in relation to other OpsItems in the system.</p>
945
1066
  */
946
1067
  Priority?: number;
947
1068
  /**
1069
+ * @public
948
1070
  * <p>One or more OpsItems that share something in common with the current OpsItems. For example,
949
1071
  * related OpsItems can include OpsItems with similar error messages, impacted resources, or
950
1072
  * statuses for the impacted resource.</p>
951
1073
  */
952
1074
  RelatedOpsItems?: RelatedOpsItem[];
953
1075
  /**
1076
+ * @public
954
1077
  * <p>The OpsItem status. Status can be <code>Open</code>, <code>In Progress</code>, or
955
1078
  * <code>Resolved</code>. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems-editing-details.html">Editing OpsItem details</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
956
1079
  */
957
1080
  Status?: OpsItemStatus | string;
958
1081
  /**
1082
+ * @public
959
1083
  * <p>The ID of the OpsItem.</p>
960
1084
  */
961
1085
  OpsItemId: string | undefined;
962
1086
  /**
1087
+ * @public
963
1088
  * <p>A short heading that describes the nature of the OpsItem and the impacted resource.</p>
964
1089
  */
965
1090
  Title?: string;
966
1091
  /**
1092
+ * @public
967
1093
  * <p>Specify a new category for an OpsItem.</p>
968
1094
  */
969
1095
  Category?: string;
970
1096
  /**
1097
+ * @public
971
1098
  * <p>Specify a new severity for an OpsItem.</p>
972
1099
  */
973
1100
  Severity?: string;
974
1101
  /**
1102
+ * @public
975
1103
  * <p>The time a runbook workflow started. Currently reported only for the OpsItem type
976
1104
  * <code>/aws/changerequest</code>.</p>
977
1105
  */
978
1106
  ActualStartTime?: Date;
979
1107
  /**
1108
+ * @public
980
1109
  * <p>The time a runbook workflow ended. Currently reported only for the OpsItem type
981
1110
  * <code>/aws/changerequest</code>.</p>
982
1111
  */
983
1112
  ActualEndTime?: Date;
984
1113
  /**
1114
+ * @public
985
1115
  * <p>The time specified in a change request for a runbook workflow to start. Currently supported
986
1116
  * only for the OpsItem type <code>/aws/changerequest</code>.</p>
987
1117
  */
988
1118
  PlannedStartTime?: Date;
989
1119
  /**
1120
+ * @public
990
1121
  * <p>The time specified in a change request for a runbook workflow to end. Currently supported
991
1122
  * only for the OpsItem type <code>/aws/changerequest</code>.</p>
992
1123
  */
993
1124
  PlannedEndTime?: Date;
994
1125
  /**
1126
+ * @public
995
1127
  * <p>The OpsItem Amazon Resource Name (ARN).</p>
996
1128
  */
997
1129
  OpsItemArn?: string;
@@ -1019,14 +1151,17 @@ export declare class OpsMetadataKeyLimitExceededException extends __BaseExceptio
1019
1151
  */
1020
1152
  export interface UpdateOpsMetadataRequest {
1021
1153
  /**
1154
+ * @public
1022
1155
  * <p>The Amazon Resource Name (ARN) of the OpsMetadata Object to update.</p>
1023
1156
  */
1024
1157
  OpsMetadataArn: string | undefined;
1025
1158
  /**
1159
+ * @public
1026
1160
  * <p>Metadata to add to an OpsMetadata object.</p>
1027
1161
  */
1028
1162
  MetadataToUpdate?: Record<string, MetadataValue>;
1029
1163
  /**
1164
+ * @public
1030
1165
  * <p>The metadata keys to delete from the OpsMetadata object. </p>
1031
1166
  */
1032
1167
  KeysToDelete?: string[];
@@ -1036,6 +1171,7 @@ export interface UpdateOpsMetadataRequest {
1036
1171
  */
1037
1172
  export interface UpdateOpsMetadataResult {
1038
1173
  /**
1174
+ * @public
1039
1175
  * <p>The Amazon Resource Name (ARN) of the OpsMetadata Object that was updated.</p>
1040
1176
  */
1041
1177
  OpsMetadataArn?: string;
@@ -1045,22 +1181,27 @@ export interface UpdateOpsMetadataResult {
1045
1181
  */
1046
1182
  export interface UpdatePatchBaselineRequest {
1047
1183
  /**
1184
+ * @public
1048
1185
  * <p>The ID of the patch baseline to update.</p>
1049
1186
  */
1050
1187
  BaselineId: string | undefined;
1051
1188
  /**
1189
+ * @public
1052
1190
  * <p>The name of the patch baseline.</p>
1053
1191
  */
1054
1192
  Name?: string;
1055
1193
  /**
1194
+ * @public
1056
1195
  * <p>A set of global filters used to include patches in the baseline.</p>
1057
1196
  */
1058
1197
  GlobalFilters?: PatchFilterGroup;
1059
1198
  /**
1199
+ * @public
1060
1200
  * <p>A set of rules used to include patches in the baseline.</p>
1061
1201
  */
1062
1202
  ApprovalRules?: PatchRuleGroup;
1063
1203
  /**
1204
+ * @public
1064
1205
  * <p>A list of explicitly approved patches for the baseline.</p>
1065
1206
  * <p>For information about accepted formats for lists of approved patches and rejected patches,
1066
1207
  * see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html">About
@@ -1068,16 +1209,19 @@ export interface UpdatePatchBaselineRequest {
1068
1209
  */
1069
1210
  ApprovedPatches?: string[];
1070
1211
  /**
1212
+ * @public
1071
1213
  * <p>Assigns a new compliance severity level to an existing patch baseline.</p>
1072
1214
  */
1073
1215
  ApprovedPatchesComplianceLevel?: PatchComplianceLevel | string;
1074
1216
  /**
1217
+ * @public
1075
1218
  * <p>Indicates whether the list of approved patches includes non-security updates that should be
1076
1219
  * applied to the managed nodes. The default value is <code>false</code>. Applies to Linux managed
1077
1220
  * nodes only.</p>
1078
1221
  */
1079
1222
  ApprovedPatchesEnableNonSecurity?: boolean;
1080
1223
  /**
1224
+ * @public
1081
1225
  * <p>A list of explicitly rejected patches for the baseline.</p>
1082
1226
  * <p>For information about accepted formats for lists of approved patches and rejected patches,
1083
1227
  * see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html">About
@@ -1085,6 +1229,7 @@ export interface UpdatePatchBaselineRequest {
1085
1229
  */
1086
1230
  RejectedPatches?: string[];
1087
1231
  /**
1232
+ * @public
1088
1233
  * <p>The action for Patch Manager to take on patches included in the
1089
1234
  * <code>RejectedPackages</code> list.</p>
1090
1235
  * <ul>
@@ -1111,15 +1256,18 @@ export interface UpdatePatchBaselineRequest {
1111
1256
  */
1112
1257
  RejectedPatchesAction?: PatchAction | string;
1113
1258
  /**
1259
+ * @public
1114
1260
  * <p>A description of the patch baseline.</p>
1115
1261
  */
1116
1262
  Description?: string;
1117
1263
  /**
1264
+ * @public
1118
1265
  * <p>Information about the patches to use to update the managed nodes, including target operating
1119
1266
  * systems and source repositories. Applies to Linux managed nodes only.</p>
1120
1267
  */
1121
1268
  Sources?: PatchSource[];
1122
1269
  /**
1270
+ * @public
1123
1271
  * <p>If True, then all fields that are required by the <a>CreatePatchBaseline</a>
1124
1272
  * operation are also required for this API request. Optional fields that aren't specified are set
1125
1273
  * to null.</p>
@@ -1131,63 +1279,77 @@ export interface UpdatePatchBaselineRequest {
1131
1279
  */
1132
1280
  export interface UpdatePatchBaselineResult {
1133
1281
  /**
1282
+ * @public
1134
1283
  * <p>The ID of the deleted patch baseline.</p>
1135
1284
  */
1136
1285
  BaselineId?: string;
1137
1286
  /**
1287
+ * @public
1138
1288
  * <p>The name of the patch baseline.</p>
1139
1289
  */
1140
1290
  Name?: string;
1141
1291
  /**
1292
+ * @public
1142
1293
  * <p>The operating system rule used by the updated patch baseline.</p>
1143
1294
  */
1144
1295
  OperatingSystem?: OperatingSystem | string;
1145
1296
  /**
1297
+ * @public
1146
1298
  * <p>A set of global filters used to exclude patches from the baseline.</p>
1147
1299
  */
1148
1300
  GlobalFilters?: PatchFilterGroup;
1149
1301
  /**
1302
+ * @public
1150
1303
  * <p>A set of rules used to include patches in the baseline.</p>
1151
1304
  */
1152
1305
  ApprovalRules?: PatchRuleGroup;
1153
1306
  /**
1307
+ * @public
1154
1308
  * <p>A list of explicitly approved patches for the baseline.</p>
1155
1309
  */
1156
1310
  ApprovedPatches?: string[];
1157
1311
  /**
1312
+ * @public
1158
1313
  * <p>The compliance severity level assigned to the patch baseline after the update
1159
1314
  * completed.</p>
1160
1315
  */
1161
1316
  ApprovedPatchesComplianceLevel?: PatchComplianceLevel | string;
1162
1317
  /**
1318
+ * @public
1163
1319
  * <p>Indicates whether the list of approved patches includes non-security updates that should be
1164
1320
  * applied to the managed nodes. The default value is <code>false</code>. Applies to Linux managed
1165
1321
  * nodes only.</p>
1166
1322
  */
1167
1323
  ApprovedPatchesEnableNonSecurity?: boolean;
1168
1324
  /**
1325
+ * @public
1169
1326
  * <p>A list of explicitly rejected patches for the baseline.</p>
1170
1327
  */
1171
1328
  RejectedPatches?: string[];
1172
1329
  /**
1330
+ * @public
1173
1331
  * <p>The action specified to take on patches included in the <code>RejectedPatches</code> list. A
1174
1332
  * patch can be allowed only if it is a dependency of another package, or blocked entirely along
1175
1333
  * with packages that include it as a dependency.</p>
1176
1334
  */
1177
1335
  RejectedPatchesAction?: PatchAction | string;
1178
1336
  /**
1337
+ * @public
1179
1338
  * <p>The date when the patch baseline was created.</p>
1180
1339
  */
1181
1340
  CreatedDate?: Date;
1182
1341
  /**
1342
+ * @public
1183
1343
  * <p>The date when the patch baseline was last modified.</p>
1184
1344
  */
1185
1345
  ModifiedDate?: Date;
1186
1346
  /**
1347
+ * @public
1187
1348
  * <p>A description of the patch baseline.</p>
1188
1349
  */
1189
1350
  Description?: string;
1190
1351
  /**
1352
+ * @public
1191
1353
  * <p>Information about the patches to use to update the managed nodes, including target operating
1192
1354
  * systems and source repositories. Applies to Linux managed nodes only.</p>
1193
1355
  */
@@ -1212,15 +1374,18 @@ export declare class ResourceDataSyncConflictException extends __BaseException {
1212
1374
  */
1213
1375
  export interface UpdateResourceDataSyncRequest {
1214
1376
  /**
1377
+ * @public
1215
1378
  * <p>The name of the resource data sync you want to update.</p>
1216
1379
  */
1217
1380
  SyncName: string | undefined;
1218
1381
  /**
1382
+ * @public
1219
1383
  * <p>The type of resource data sync. The supported <code>SyncType</code> is
1220
1384
  * SyncFromSource.</p>
1221
1385
  */
1222
1386
  SyncType: string | undefined;
1223
1387
  /**
1388
+ * @public
1224
1389
  * <p>Specify information about the data sources to synchronize.</p>
1225
1390
  */
1226
1391
  SyncSource: ResourceDataSyncSource | undefined;
@@ -1236,6 +1401,7 @@ export interface UpdateResourceDataSyncResult {
1236
1401
  */
1237
1402
  export interface UpdateServiceSettingRequest {
1238
1403
  /**
1404
+ * @public
1239
1405
  * <p>The Amazon Resource Name (ARN) of the service setting to update. For example,
1240
1406
  * <code>arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled</code>.
1241
1407
  * The setting ID can be one of the following.</p>
@@ -1290,6 +1456,7 @@ export interface UpdateServiceSettingRequest {
1290
1456
  */
1291
1457
  SettingId: string | undefined;
1292
1458
  /**
1459
+ * @public
1293
1460
  * <p>The new value to specify for the service setting. The following list specifies the available
1294
1461
  * values for each setting.</p>
1295
1462
  * <ul>
@@ -1352,14 +1519,17 @@ export interface UpdateServiceSettingResult {
1352
1519
  */
1353
1520
  export interface InventoryAggregator {
1354
1521
  /**
1522
+ * @public
1355
1523
  * <p>The inventory type and attribute name for aggregation.</p>
1356
1524
  */
1357
1525
  Expression?: string;
1358
1526
  /**
1527
+ * @public
1359
1528
  * <p>Nested aggregators to further refine aggregation for an inventory type.</p>
1360
1529
  */
1361
1530
  Aggregators?: InventoryAggregator[];
1362
1531
  /**
1532
+ * @public
1363
1533
  * <p>A user-defined set of one or more filters on which to aggregate inventory data. Groups
1364
1534
  * return a count of resources that match and don't match the specified criteria.</p>
1365
1535
  */
@@ -1373,27 +1543,33 @@ export interface InventoryAggregator {
1373
1543
  */
1374
1544
  export interface OpsAggregator {
1375
1545
  /**
1546
+ * @public
1376
1547
  * <p>Either a <code>Range</code> or <code>Count</code> aggregator for limiting an OpsData
1377
1548
  * summary.</p>
1378
1549
  */
1379
1550
  AggregatorType?: string;
1380
1551
  /**
1552
+ * @public
1381
1553
  * <p>The data type name to use for viewing counts of OpsData.</p>
1382
1554
  */
1383
1555
  TypeName?: string;
1384
1556
  /**
1557
+ * @public
1385
1558
  * <p>The name of an OpsData attribute on which to limit the count of OpsData.</p>
1386
1559
  */
1387
1560
  AttributeName?: string;
1388
1561
  /**
1562
+ * @public
1389
1563
  * <p>The aggregator value.</p>
1390
1564
  */
1391
1565
  Values?: Record<string, string>;
1392
1566
  /**
1567
+ * @public
1393
1568
  * <p>The aggregator filters.</p>
1394
1569
  */
1395
1570
  Filters?: OpsFilter[];
1396
1571
  /**
1572
+ * @public
1397
1573
  * <p>A nested aggregator for viewing counts of OpsData.</p>
1398
1574
  */
1399
1575
  Aggregators?: OpsAggregator[];
@@ -1403,10 +1579,12 @@ export interface OpsAggregator {
1403
1579
  */
1404
1580
  export interface GetInventoryRequest {
1405
1581
  /**
1582
+ * @public
1406
1583
  * <p>One or more filters. Use a filter to return a more specific list of results.</p>
1407
1584
  */
1408
1585
  Filters?: InventoryFilter[];
1409
1586
  /**
1587
+ * @public
1410
1588
  * <p>Returns counts of inventory types based on one or more expressions. For example, if you
1411
1589
  * aggregate by using an expression that uses the <code>AWS:InstanceInformation.PlatformType</code>
1412
1590
  * type, you can see a count of how many Windows and Linux managed nodes exist in your inventoried
@@ -1414,15 +1592,18 @@ export interface GetInventoryRequest {
1414
1592
  */
1415
1593
  Aggregators?: InventoryAggregator[];
1416
1594
  /**
1595
+ * @public
1417
1596
  * <p>The list of inventory item types to return.</p>
1418
1597
  */
1419
1598
  ResultAttributes?: ResultAttribute[];
1420
1599
  /**
1600
+ * @public
1421
1601
  * <p>The token for the next set of items to return. (You received this token from a previous
1422
1602
  * call.)</p>
1423
1603
  */
1424
1604
  NextToken?: string;
1425
1605
  /**
1606
+ * @public
1426
1607
  * <p>The maximum number of items to return for this call. The call also returns a token that you
1427
1608
  * can specify in a subsequent call to get the next set of results.</p>
1428
1609
  */
@@ -1433,26 +1614,32 @@ export interface GetInventoryRequest {
1433
1614
  */
1434
1615
  export interface GetOpsSummaryRequest {
1435
1616
  /**
1617
+ * @public
1436
1618
  * <p>Specify the name of a resource data sync to get.</p>
1437
1619
  */
1438
1620
  SyncName?: string;
1439
1621
  /**
1622
+ * @public
1440
1623
  * <p>Optional filters used to scope down the returned OpsData. </p>
1441
1624
  */
1442
1625
  Filters?: OpsFilter[];
1443
1626
  /**
1627
+ * @public
1444
1628
  * <p>Optional aggregators that return counts of OpsData based on one or more expressions.</p>
1445
1629
  */
1446
1630
  Aggregators?: OpsAggregator[];
1447
1631
  /**
1632
+ * @public
1448
1633
  * <p>The OpsData data type to return.</p>
1449
1634
  */
1450
1635
  ResultAttributes?: OpsResultAttribute[];
1451
1636
  /**
1637
+ * @public
1452
1638
  * <p>A token to start the list. Use this token to get the next set of results. </p>
1453
1639
  */
1454
1640
  NextToken?: string;
1455
1641
  /**
1642
+ * @public
1456
1643
  * <p>The maximum number of items to return for this call. The call also returns a token that you
1457
1644
  * can specify in a subsequent call to get the next set of results.</p>
1458
1645
  */