@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.
|
@@ -7,10 +7,12 @@ import { SSMServiceException as __BaseException } from "./SSMServiceException";
|
|
|
7
7
|
*/
|
|
8
8
|
export interface AccountSharingInfo {
|
|
9
9
|
/**
|
|
10
|
+
* @public
|
|
10
11
|
* <p>The Amazon Web Services account ID where the current document is shared.</p>
|
|
11
12
|
*/
|
|
12
13
|
AccountId?: string;
|
|
13
14
|
/**
|
|
15
|
+
* @public
|
|
14
16
|
* <p>The version of the current document shared with the account.</p>
|
|
15
17
|
*/
|
|
16
18
|
SharedDocumentVersion?: string;
|
|
@@ -24,10 +26,12 @@ export interface AccountSharingInfo {
|
|
|
24
26
|
*/
|
|
25
27
|
export interface Tag {
|
|
26
28
|
/**
|
|
29
|
+
* @public
|
|
27
30
|
* <p>The name of the tag.</p>
|
|
28
31
|
*/
|
|
29
32
|
Key: string | undefined;
|
|
30
33
|
/**
|
|
34
|
+
* @public
|
|
31
35
|
* <p>The value of the tag.</p>
|
|
32
36
|
*/
|
|
33
37
|
Value: string | undefined;
|
|
@@ -40,42 +44,52 @@ export interface Tag {
|
|
|
40
44
|
*/
|
|
41
45
|
export interface Activation {
|
|
42
46
|
/**
|
|
47
|
+
* @public
|
|
43
48
|
* <p>The ID created by Systems Manager when you submitted the activation.</p>
|
|
44
49
|
*/
|
|
45
50
|
ActivationId?: string;
|
|
46
51
|
/**
|
|
52
|
+
* @public
|
|
47
53
|
* <p>A user defined description of the activation.</p>
|
|
48
54
|
*/
|
|
49
55
|
Description?: string;
|
|
50
56
|
/**
|
|
57
|
+
* @public
|
|
51
58
|
* <p>A name for the managed node when it is created.</p>
|
|
52
59
|
*/
|
|
53
60
|
DefaultInstanceName?: string;
|
|
54
61
|
/**
|
|
62
|
+
* @public
|
|
55
63
|
* <p>The Identity and Access Management (IAM) role to assign to the managed node.</p>
|
|
56
64
|
*/
|
|
57
65
|
IamRole?: string;
|
|
58
66
|
/**
|
|
67
|
+
* @public
|
|
59
68
|
* <p>The maximum number of managed nodes that can be registered using this activation.</p>
|
|
60
69
|
*/
|
|
61
70
|
RegistrationLimit?: number;
|
|
62
71
|
/**
|
|
72
|
+
* @public
|
|
63
73
|
* <p>The number of managed nodes already registered with this activation.</p>
|
|
64
74
|
*/
|
|
65
75
|
RegistrationsCount?: number;
|
|
66
76
|
/**
|
|
77
|
+
* @public
|
|
67
78
|
* <p>The date when this activation can no longer be used to register managed nodes.</p>
|
|
68
79
|
*/
|
|
69
80
|
ExpirationDate?: Date;
|
|
70
81
|
/**
|
|
82
|
+
* @public
|
|
71
83
|
* <p>Whether or not the activation is expired.</p>
|
|
72
84
|
*/
|
|
73
85
|
Expired?: boolean;
|
|
74
86
|
/**
|
|
87
|
+
* @public
|
|
75
88
|
* <p>The date the activation was created.</p>
|
|
76
89
|
*/
|
|
77
90
|
CreatedDate?: Date;
|
|
78
91
|
/**
|
|
92
|
+
* @public
|
|
79
93
|
* <p>Tags assigned to the activation.</p>
|
|
80
94
|
*/
|
|
81
95
|
Tags?: Tag[];
|
|
@@ -104,6 +118,7 @@ export type ResourceTypeForTagging = (typeof ResourceTypeForTagging)[keyof typeo
|
|
|
104
118
|
*/
|
|
105
119
|
export interface AddTagsToResourceRequest {
|
|
106
120
|
/**
|
|
121
|
+
* @public
|
|
107
122
|
* <p>Specifies the type of resource you are tagging.</p>
|
|
108
123
|
* <note>
|
|
109
124
|
* <p>The <code>ManagedInstance</code> type for this API operation is for on-premises managed
|
|
@@ -115,6 +130,7 @@ export interface AddTagsToResourceRequest {
|
|
|
115
130
|
*/
|
|
116
131
|
ResourceType: ResourceTypeForTagging | string | undefined;
|
|
117
132
|
/**
|
|
133
|
+
* @public
|
|
118
134
|
* <p>The resource ID you want to tag.</p>
|
|
119
135
|
* <p>Use the ID of the resource. Here are some examples:</p>
|
|
120
136
|
* <p>
|
|
@@ -149,6 +165,7 @@ export interface AddTagsToResourceRequest {
|
|
|
149
165
|
*/
|
|
150
166
|
ResourceId: string | undefined;
|
|
151
167
|
/**
|
|
168
|
+
* @public
|
|
152
169
|
* <p>One or more tags. The value parameter is required.</p>
|
|
153
170
|
* <important>
|
|
154
171
|
* <p>Don't enter personally identifiable information in this field.</p>
|
|
@@ -231,6 +248,7 @@ export declare class TooManyUpdates extends __BaseException {
|
|
|
231
248
|
*/
|
|
232
249
|
export interface Alarm {
|
|
233
250
|
/**
|
|
251
|
+
* @public
|
|
234
252
|
* <p>The name of your CloudWatch alarm.</p>
|
|
235
253
|
*/
|
|
236
254
|
Name: string | undefined;
|
|
@@ -242,6 +260,7 @@ export interface Alarm {
|
|
|
242
260
|
*/
|
|
243
261
|
export interface AlarmConfiguration {
|
|
244
262
|
/**
|
|
263
|
+
* @public
|
|
245
264
|
* <p>When this value is <i>true</i>, your automation or command continues to run in
|
|
246
265
|
* cases where we can’t retrieve alarm status information from CloudWatch. In cases
|
|
247
266
|
* where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or
|
|
@@ -249,6 +268,7 @@ export interface AlarmConfiguration {
|
|
|
249
268
|
*/
|
|
250
269
|
IgnorePollAlarmFailure?: boolean;
|
|
251
270
|
/**
|
|
271
|
+
* @public
|
|
252
272
|
* <p>The name of the CloudWatch alarm specified in the configuration.</p>
|
|
253
273
|
*/
|
|
254
274
|
Alarms: Alarm[] | undefined;
|
|
@@ -271,10 +291,12 @@ export type ExternalAlarmState = (typeof ExternalAlarmState)[keyof typeof Extern
|
|
|
271
291
|
*/
|
|
272
292
|
export interface AlarmStateInformation {
|
|
273
293
|
/**
|
|
294
|
+
* @public
|
|
274
295
|
* <p>The name of your CloudWatch alarm.</p>
|
|
275
296
|
*/
|
|
276
297
|
Name: string | undefined;
|
|
277
298
|
/**
|
|
299
|
+
* @public
|
|
278
300
|
* <p>The state of your CloudWatch alarm.</p>
|
|
279
301
|
*/
|
|
280
302
|
State: ExternalAlarmState | string | undefined;
|
|
@@ -298,15 +320,18 @@ export declare class AlreadyExistsException extends __BaseException {
|
|
|
298
320
|
*/
|
|
299
321
|
export interface AssociateOpsItemRelatedItemRequest {
|
|
300
322
|
/**
|
|
323
|
+
* @public
|
|
301
324
|
* <p>The ID of the OpsItem to which you want to associate a resource as a related item.</p>
|
|
302
325
|
*/
|
|
303
326
|
OpsItemId: string | undefined;
|
|
304
327
|
/**
|
|
328
|
+
* @public
|
|
305
329
|
* <p>The type of association that you want to create between an OpsItem and a resource. OpsCenter
|
|
306
330
|
* supports <code>IsParentOf</code> and <code>RelatesTo</code> association types.</p>
|
|
307
331
|
*/
|
|
308
332
|
AssociationType: string | undefined;
|
|
309
333
|
/**
|
|
334
|
+
* @public
|
|
310
335
|
* <p>The type of resource that you want to associate with an OpsItem. OpsCenter supports the
|
|
311
336
|
* following types:</p>
|
|
312
337
|
* <p>
|
|
@@ -316,6 +341,7 @@ export interface AssociateOpsItemRelatedItemRequest {
|
|
|
316
341
|
*/
|
|
317
342
|
ResourceType: string | undefined;
|
|
318
343
|
/**
|
|
344
|
+
* @public
|
|
319
345
|
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services resource that you want to associate with the
|
|
320
346
|
* OpsItem.</p>
|
|
321
347
|
*/
|
|
@@ -326,6 +352,7 @@ export interface AssociateOpsItemRelatedItemRequest {
|
|
|
326
352
|
*/
|
|
327
353
|
export interface AssociateOpsItemRelatedItemResponse {
|
|
328
354
|
/**
|
|
355
|
+
* @public
|
|
329
356
|
* <p>The association ID.</p>
|
|
330
357
|
*/
|
|
331
358
|
AssociationId?: string;
|
|
@@ -395,10 +422,12 @@ export declare class OpsItemRelatedItemAlreadyExistsException extends __BaseExce
|
|
|
395
422
|
*/
|
|
396
423
|
export interface CancelCommandRequest {
|
|
397
424
|
/**
|
|
425
|
+
* @public
|
|
398
426
|
* <p>The ID of the command you want to cancel.</p>
|
|
399
427
|
*/
|
|
400
428
|
CommandId: string | undefined;
|
|
401
429
|
/**
|
|
430
|
+
* @public
|
|
402
431
|
* <p>(Optional) A list of managed node IDs on which you want to cancel the command. If not
|
|
403
432
|
* provided, the command is canceled on every node on which it was requested.</p>
|
|
404
433
|
*/
|
|
@@ -470,6 +499,7 @@ export declare class InvalidInstanceId extends __BaseException {
|
|
|
470
499
|
*/
|
|
471
500
|
export interface CancelMaintenanceWindowExecutionRequest {
|
|
472
501
|
/**
|
|
502
|
+
* @public
|
|
473
503
|
* <p>The ID of the maintenance window execution to stop.</p>
|
|
474
504
|
*/
|
|
475
505
|
WindowExecutionId: string | undefined;
|
|
@@ -479,6 +509,7 @@ export interface CancelMaintenanceWindowExecutionRequest {
|
|
|
479
509
|
*/
|
|
480
510
|
export interface CancelMaintenanceWindowExecutionResult {
|
|
481
511
|
/**
|
|
512
|
+
* @public
|
|
482
513
|
* <p>The ID of the maintenance window execution that has been stopped.</p>
|
|
483
514
|
*/
|
|
484
515
|
WindowExecutionId?: string;
|
|
@@ -505,10 +536,12 @@ export declare class DoesNotExistException extends __BaseException {
|
|
|
505
536
|
*/
|
|
506
537
|
export interface RegistrationMetadataItem {
|
|
507
538
|
/**
|
|
539
|
+
* @public
|
|
508
540
|
* <p>Reserved for internal use.</p>
|
|
509
541
|
*/
|
|
510
542
|
Key: string | undefined;
|
|
511
543
|
/**
|
|
544
|
+
* @public
|
|
512
545
|
* <p>Reserved for internal use.</p>
|
|
513
546
|
*/
|
|
514
547
|
Value: string | undefined;
|
|
@@ -518,6 +551,7 @@ export interface RegistrationMetadataItem {
|
|
|
518
551
|
*/
|
|
519
552
|
export interface CreateActivationRequest {
|
|
520
553
|
/**
|
|
554
|
+
* @public
|
|
521
555
|
* <p>A user-defined description of the resource that you want to register with Systems Manager. </p>
|
|
522
556
|
* <important>
|
|
523
557
|
* <p>Don't enter personally identifiable information in this field.</p>
|
|
@@ -525,6 +559,7 @@ export interface CreateActivationRequest {
|
|
|
525
559
|
*/
|
|
526
560
|
Description?: string;
|
|
527
561
|
/**
|
|
562
|
+
* @public
|
|
528
563
|
* <p>The name of the registered, managed node as it will appear in the Amazon Web Services Systems Manager console or when
|
|
529
564
|
* you use the Amazon Web Services command line tools to list Systems Manager resources.</p>
|
|
530
565
|
* <important>
|
|
@@ -533,6 +568,7 @@ export interface CreateActivationRequest {
|
|
|
533
568
|
*/
|
|
534
569
|
DefaultInstanceName?: string;
|
|
535
570
|
/**
|
|
571
|
+
* @public
|
|
536
572
|
* <p>The name of the Identity and Access Management (IAM) role that you want to assign to
|
|
537
573
|
* the managed node. This IAM role must provide AssumeRole permissions for the
|
|
538
574
|
* 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
|
|
@@ -545,17 +581,20 @@ export interface CreateActivationRequest {
|
|
|
545
581
|
*/
|
|
546
582
|
IamRole: string | undefined;
|
|
547
583
|
/**
|
|
584
|
+
* @public
|
|
548
585
|
* <p>Specify the maximum number of managed nodes you want to register. The default value is
|
|
549
586
|
* <code>1</code>.</p>
|
|
550
587
|
*/
|
|
551
588
|
RegistrationLimit?: number;
|
|
552
589
|
/**
|
|
590
|
+
* @public
|
|
553
591
|
* <p>The date by which this activation request should expire, in timestamp format, such as
|
|
554
592
|
* "2021-07-07T00:00:00". You can specify a date up to 30 days in advance. If you don't provide an
|
|
555
593
|
* expiration date, the activation code expires in 24 hours.</p>
|
|
556
594
|
*/
|
|
557
595
|
ExpirationDate?: Date;
|
|
558
596
|
/**
|
|
597
|
+
* @public
|
|
559
598
|
* <p>Optional metadata that you assign to a resource. Tags enable you to categorize a resource in
|
|
560
599
|
* different ways, such as by purpose, owner, or environment. For example, you might want to tag an
|
|
561
600
|
* activation to identify which servers or virtual machines (VMs) in your on-premises environment
|
|
@@ -585,6 +624,7 @@ export interface CreateActivationRequest {
|
|
|
585
624
|
*/
|
|
586
625
|
Tags?: Tag[];
|
|
587
626
|
/**
|
|
627
|
+
* @public
|
|
588
628
|
* <p>Reserved for internal use.</p>
|
|
589
629
|
*/
|
|
590
630
|
RegistrationMetadata?: RegistrationMetadataItem[];
|
|
@@ -594,11 +634,13 @@ export interface CreateActivationRequest {
|
|
|
594
634
|
*/
|
|
595
635
|
export interface CreateActivationResult {
|
|
596
636
|
/**
|
|
637
|
+
* @public
|
|
597
638
|
* <p>The ID number generated by the system when it processed the activation. The activation ID
|
|
598
639
|
* functions like a user name.</p>
|
|
599
640
|
*/
|
|
600
641
|
ActivationId?: string;
|
|
601
642
|
/**
|
|
643
|
+
* @public
|
|
602
644
|
* <p>The code the system generates when it processes the activation. The activation code
|
|
603
645
|
* functions like a password to validate the activation ID. </p>
|
|
604
646
|
*/
|
|
@@ -663,14 +705,17 @@ export type AssociationComplianceSeverity = (typeof AssociationComplianceSeverit
|
|
|
663
705
|
*/
|
|
664
706
|
export interface S3OutputLocation {
|
|
665
707
|
/**
|
|
708
|
+
* @public
|
|
666
709
|
* <p>The Amazon Web Services Region of the S3 bucket.</p>
|
|
667
710
|
*/
|
|
668
711
|
OutputS3Region?: string;
|
|
669
712
|
/**
|
|
713
|
+
* @public
|
|
670
714
|
* <p>The name of the S3 bucket.</p>
|
|
671
715
|
*/
|
|
672
716
|
OutputS3BucketName?: string;
|
|
673
717
|
/**
|
|
718
|
+
* @public
|
|
674
719
|
* <p>The S3 bucket subfolder.</p>
|
|
675
720
|
*/
|
|
676
721
|
OutputS3KeyPrefix?: string;
|
|
@@ -683,6 +728,7 @@ export interface S3OutputLocation {
|
|
|
683
728
|
*/
|
|
684
729
|
export interface InstanceAssociationOutputLocation {
|
|
685
730
|
/**
|
|
731
|
+
* @public
|
|
686
732
|
* <p>An S3 bucket where you want to store the results of this request.</p>
|
|
687
733
|
*/
|
|
688
734
|
S3Location?: S3OutputLocation;
|
|
@@ -706,29 +752,35 @@ export type AssociationSyncCompliance = (typeof AssociationSyncCompliance)[keyof
|
|
|
706
752
|
*/
|
|
707
753
|
export interface TargetLocation {
|
|
708
754
|
/**
|
|
755
|
+
* @public
|
|
709
756
|
* <p>The Amazon Web Services accounts targeted by the current Automation execution.</p>
|
|
710
757
|
*/
|
|
711
758
|
Accounts?: string[];
|
|
712
759
|
/**
|
|
760
|
+
* @public
|
|
713
761
|
* <p>The Amazon Web Services Regions targeted by the current Automation execution.</p>
|
|
714
762
|
*/
|
|
715
763
|
Regions?: string[];
|
|
716
764
|
/**
|
|
765
|
+
* @public
|
|
717
766
|
* <p>The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation
|
|
718
767
|
* concurrently.</p>
|
|
719
768
|
*/
|
|
720
769
|
TargetLocationMaxConcurrency?: string;
|
|
721
770
|
/**
|
|
771
|
+
* @public
|
|
722
772
|
* <p>The maximum number of errors allowed before the system stops queueing additional Automation
|
|
723
773
|
* executions for the currently running Automation.</p>
|
|
724
774
|
*/
|
|
725
775
|
TargetLocationMaxErrors?: string;
|
|
726
776
|
/**
|
|
777
|
+
* @public
|
|
727
778
|
* <p>The Automation execution role used by the currently running Automation. If not specified,
|
|
728
779
|
* the default value is <code>AWS-SystemsManager-AutomationExecutionRole</code>.</p>
|
|
729
780
|
*/
|
|
730
781
|
ExecutionRoleName?: string;
|
|
731
782
|
/**
|
|
783
|
+
* @public
|
|
732
784
|
* <p>The details for the CloudWatch alarm you want to apply to an automation or
|
|
733
785
|
* command.</p>
|
|
734
786
|
*/
|
|
@@ -834,11 +886,13 @@ export interface TargetLocation {
|
|
|
834
886
|
*/
|
|
835
887
|
export interface Target {
|
|
836
888
|
/**
|
|
889
|
+
* @public
|
|
837
890
|
* <p>User-defined criteria for sending commands that target managed nodes that meet the
|
|
838
891
|
* criteria.</p>
|
|
839
892
|
*/
|
|
840
893
|
Key?: string;
|
|
841
894
|
/**
|
|
895
|
+
* @public
|
|
842
896
|
* <p>User-defined criteria that maps to <code>Key</code>. For example, if you specified
|
|
843
897
|
* <code>tag:ServerRole</code>, you could specify <code>value:WebServer</code> to run a command on
|
|
844
898
|
* instances that include EC2 tags of <code>ServerRole,WebServer</code>. </p>
|
|
@@ -852,6 +906,7 @@ export interface Target {
|
|
|
852
906
|
*/
|
|
853
907
|
export interface CreateAssociationRequest {
|
|
854
908
|
/**
|
|
909
|
+
* @public
|
|
855
910
|
* <p>The name of the SSM Command document or Automation runbook that contains the configuration
|
|
856
911
|
* information for the managed node.</p>
|
|
857
912
|
* <p>You can specify Amazon Web Services-predefined documents, documents you created, or a document that is
|
|
@@ -872,6 +927,7 @@ export interface CreateAssociationRequest {
|
|
|
872
927
|
*/
|
|
873
928
|
Name: string | undefined;
|
|
874
929
|
/**
|
|
930
|
+
* @public
|
|
875
931
|
* <p>The document version you want to associate with the target(s). Can be a specific version or
|
|
876
932
|
* the default version.</p>
|
|
877
933
|
* <important>
|
|
@@ -884,6 +940,7 @@ export interface CreateAssociationRequest {
|
|
|
884
940
|
*/
|
|
885
941
|
DocumentVersion?: string;
|
|
886
942
|
/**
|
|
943
|
+
* @public
|
|
887
944
|
* <p>The managed node ID.</p>
|
|
888
945
|
* <note>
|
|
889
946
|
* <p>
|
|
@@ -899,10 +956,12 @@ export interface CreateAssociationRequest {
|
|
|
899
956
|
*/
|
|
900
957
|
InstanceId?: string;
|
|
901
958
|
/**
|
|
959
|
+
* @public
|
|
902
960
|
* <p>The parameters for the runtime configuration of the document.</p>
|
|
903
961
|
*/
|
|
904
962
|
Parameters?: Record<string, string[]>;
|
|
905
963
|
/**
|
|
964
|
+
* @public
|
|
906
965
|
* <p>The targets for the association. You can target managed nodes by using tags, Amazon Web Services resource
|
|
907
966
|
* groups, all managed nodes in an Amazon Web Services account, or individual managed node IDs. You can target all
|
|
908
967
|
* managed nodes in an Amazon Web Services account by specifying the <code>InstanceIds</code> key with a value of
|
|
@@ -911,25 +970,30 @@ export interface CreateAssociationRequest {
|
|
|
911
970
|
*/
|
|
912
971
|
Targets?: Target[];
|
|
913
972
|
/**
|
|
973
|
+
* @public
|
|
914
974
|
* <p>A cron expression when the association will be applied to the target(s).</p>
|
|
915
975
|
*/
|
|
916
976
|
ScheduleExpression?: string;
|
|
917
977
|
/**
|
|
978
|
+
* @public
|
|
918
979
|
* <p>An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output
|
|
919
980
|
* details of the request.</p>
|
|
920
981
|
*/
|
|
921
982
|
OutputLocation?: InstanceAssociationOutputLocation;
|
|
922
983
|
/**
|
|
984
|
+
* @public
|
|
923
985
|
* <p>Specify a descriptive name for the association.</p>
|
|
924
986
|
*/
|
|
925
987
|
AssociationName?: string;
|
|
926
988
|
/**
|
|
989
|
+
* @public
|
|
927
990
|
* <p>Choose the parameter that will define how your automation will branch out. This target is
|
|
928
991
|
* required for associations that use an Automation runbook and target resources by using rate
|
|
929
992
|
* controls. Automation is a capability of Amazon Web Services Systems Manager.</p>
|
|
930
993
|
*/
|
|
931
994
|
AutomationTargetParameterName?: string;
|
|
932
995
|
/**
|
|
996
|
+
* @public
|
|
933
997
|
* <p>The number of errors that are allowed before the system stops sending requests to run the
|
|
934
998
|
* association on additional targets. You can specify either an absolute number of errors, for
|
|
935
999
|
* example 10, or a percentage of the target set, for example 10%. If you specify 3, for example,
|
|
@@ -944,6 +1008,7 @@ export interface CreateAssociationRequest {
|
|
|
944
1008
|
*/
|
|
945
1009
|
MaxErrors?: string;
|
|
946
1010
|
/**
|
|
1011
|
+
* @public
|
|
947
1012
|
* <p>The maximum number of targets allowed to run the association at the same time. You can
|
|
948
1013
|
* specify a number, for example 10, or a percentage of the target set, for example 10%. The default
|
|
949
1014
|
* value is 100%, which means all targets run the association at the same time.</p>
|
|
@@ -954,10 +1019,12 @@ export interface CreateAssociationRequest {
|
|
|
954
1019
|
*/
|
|
955
1020
|
MaxConcurrency?: string;
|
|
956
1021
|
/**
|
|
1022
|
+
* @public
|
|
957
1023
|
* <p>The severity level to assign to the association.</p>
|
|
958
1024
|
*/
|
|
959
1025
|
ComplianceSeverity?: AssociationComplianceSeverity | string;
|
|
960
1026
|
/**
|
|
1027
|
+
* @public
|
|
961
1028
|
* <p>The mode for generating association compliance. You can specify <code>AUTO</code> or
|
|
962
1029
|
* <code>MANUAL</code>. In <code>AUTO</code> mode, the system uses the status of the association
|
|
963
1030
|
* execution to determine the compliance status. If the association execution runs successfully,
|
|
@@ -970,6 +1037,7 @@ export interface CreateAssociationRequest {
|
|
|
970
1037
|
*/
|
|
971
1038
|
SyncCompliance?: AssociationSyncCompliance | string;
|
|
972
1039
|
/**
|
|
1040
|
+
* @public
|
|
973
1041
|
* <p>By default, when you create a new association, the system runs it immediately after it is
|
|
974
1042
|
* created and then according to the schedule you specified. Specify this option if you don't want
|
|
975
1043
|
* an association to run immediately after you create it. This parameter isn't supported for rate
|
|
@@ -977,6 +1045,7 @@ export interface CreateAssociationRequest {
|
|
|
977
1045
|
*/
|
|
978
1046
|
ApplyOnlyAtCronInterval?: boolean;
|
|
979
1047
|
/**
|
|
1048
|
+
* @public
|
|
980
1049
|
* <p>The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to
|
|
981
1050
|
* gate your associations under. The associations only run when that change calendar is open. For
|
|
982
1051
|
* more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar">Amazon Web Services Systems Manager Change
|
|
@@ -984,12 +1053,14 @@ export interface CreateAssociationRequest {
|
|
|
984
1053
|
*/
|
|
985
1054
|
CalendarNames?: string[];
|
|
986
1055
|
/**
|
|
1056
|
+
* @public
|
|
987
1057
|
* <p>A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the
|
|
988
1058
|
* association. Use this action to create an association in multiple Regions and multiple
|
|
989
1059
|
* accounts.</p>
|
|
990
1060
|
*/
|
|
991
1061
|
TargetLocations?: TargetLocation[];
|
|
992
1062
|
/**
|
|
1063
|
+
* @public
|
|
993
1064
|
* <p>Number of days to wait after the scheduled day to run an association. For example, if you
|
|
994
1065
|
* specified a cron schedule of <code>cron(0 0 ? * THU#2 *)</code>, you could specify an offset of 3
|
|
995
1066
|
* to run the association each Sunday after the second Thursday of the month. For more information
|
|
@@ -1002,11 +1073,13 @@ export interface CreateAssociationRequest {
|
|
|
1002
1073
|
*/
|
|
1003
1074
|
ScheduleOffset?: number;
|
|
1004
1075
|
/**
|
|
1076
|
+
* @public
|
|
1005
1077
|
* <p>A key-value mapping of document parameters to target resources. Both Targets and TargetMaps
|
|
1006
1078
|
* can't be specified together.</p>
|
|
1007
1079
|
*/
|
|
1008
1080
|
TargetMaps?: Record<string, string[]>[];
|
|
1009
1081
|
/**
|
|
1082
|
+
* @public
|
|
1010
1083
|
* <p>Adds or overwrites one or more tags for a State Manager association.
|
|
1011
1084
|
* <i>Tags</i> are metadata that you can assign to your Amazon Web Services resources. Tags enable
|
|
1012
1085
|
* you to categorize your resources in different ways, for example, by purpose, owner, or
|
|
@@ -1014,6 +1087,7 @@ export interface CreateAssociationRequest {
|
|
|
1014
1087
|
*/
|
|
1015
1088
|
Tags?: Tag[];
|
|
1016
1089
|
/**
|
|
1090
|
+
* @public
|
|
1017
1091
|
* <p>The details for the CloudWatch alarm you want to apply to an automation or
|
|
1018
1092
|
* command.</p>
|
|
1019
1093
|
*/
|
|
@@ -1025,14 +1099,17 @@ export interface CreateAssociationRequest {
|
|
|
1025
1099
|
*/
|
|
1026
1100
|
export interface AssociationOverview {
|
|
1027
1101
|
/**
|
|
1102
|
+
* @public
|
|
1028
1103
|
* <p>The status of the association. Status can be: Pending, Success, or Failed.</p>
|
|
1029
1104
|
*/
|
|
1030
1105
|
Status?: string;
|
|
1031
1106
|
/**
|
|
1107
|
+
* @public
|
|
1032
1108
|
* <p>A detailed status of the association.</p>
|
|
1033
1109
|
*/
|
|
1034
1110
|
DetailedStatus?: string;
|
|
1035
1111
|
/**
|
|
1112
|
+
* @public
|
|
1036
1113
|
* <p>Returns the number of targets for the association status. For example, if you created an
|
|
1037
1114
|
* association with two managed nodes, and one of them was successful, this would return the count
|
|
1038
1115
|
* of managed nodes by status.</p>
|
|
@@ -1058,18 +1135,22 @@ export type AssociationStatusName = (typeof AssociationStatusName)[keyof typeof
|
|
|
1058
1135
|
*/
|
|
1059
1136
|
export interface AssociationStatus {
|
|
1060
1137
|
/**
|
|
1138
|
+
* @public
|
|
1061
1139
|
* <p>The date when the status changed.</p>
|
|
1062
1140
|
*/
|
|
1063
1141
|
Date: Date | undefined;
|
|
1064
1142
|
/**
|
|
1143
|
+
* @public
|
|
1065
1144
|
* <p>The status.</p>
|
|
1066
1145
|
*/
|
|
1067
1146
|
Name: AssociationStatusName | string | undefined;
|
|
1068
1147
|
/**
|
|
1148
|
+
* @public
|
|
1069
1149
|
* <p>The reason for the status.</p>
|
|
1070
1150
|
*/
|
|
1071
1151
|
Message: string | undefined;
|
|
1072
1152
|
/**
|
|
1153
|
+
* @public
|
|
1073
1154
|
* <p>A user-defined string.</p>
|
|
1074
1155
|
*/
|
|
1075
1156
|
AdditionalInfo?: string;
|
|
@@ -1080,76 +1161,94 @@ export interface AssociationStatus {
|
|
|
1080
1161
|
*/
|
|
1081
1162
|
export interface AssociationDescription {
|
|
1082
1163
|
/**
|
|
1164
|
+
* @public
|
|
1083
1165
|
* <p>The name of the SSM document.</p>
|
|
1084
1166
|
*/
|
|
1085
1167
|
Name?: string;
|
|
1086
1168
|
/**
|
|
1169
|
+
* @public
|
|
1087
1170
|
* <p>The managed node ID.</p>
|
|
1088
1171
|
*/
|
|
1089
1172
|
InstanceId?: string;
|
|
1090
1173
|
/**
|
|
1174
|
+
* @public
|
|
1091
1175
|
* <p>The association version.</p>
|
|
1092
1176
|
*/
|
|
1093
1177
|
AssociationVersion?: string;
|
|
1094
1178
|
/**
|
|
1179
|
+
* @public
|
|
1095
1180
|
* <p>The date when the association was made.</p>
|
|
1096
1181
|
*/
|
|
1097
1182
|
Date?: Date;
|
|
1098
1183
|
/**
|
|
1184
|
+
* @public
|
|
1099
1185
|
* <p>The date when the association was last updated.</p>
|
|
1100
1186
|
*/
|
|
1101
1187
|
LastUpdateAssociationDate?: Date;
|
|
1102
1188
|
/**
|
|
1189
|
+
* @public
|
|
1103
1190
|
* <p>The association status.</p>
|
|
1104
1191
|
*/
|
|
1105
1192
|
Status?: AssociationStatus;
|
|
1106
1193
|
/**
|
|
1194
|
+
* @public
|
|
1107
1195
|
* <p>Information about the association.</p>
|
|
1108
1196
|
*/
|
|
1109
1197
|
Overview?: AssociationOverview;
|
|
1110
1198
|
/**
|
|
1199
|
+
* @public
|
|
1111
1200
|
* <p>The document version.</p>
|
|
1112
1201
|
*/
|
|
1113
1202
|
DocumentVersion?: string;
|
|
1114
1203
|
/**
|
|
1204
|
+
* @public
|
|
1115
1205
|
* <p>Choose the parameter that will define how your automation will branch out. This target is
|
|
1116
1206
|
* required for associations that use an Automation runbook and target resources by using rate
|
|
1117
1207
|
* controls. Automation is a capability of Amazon Web Services Systems Manager.</p>
|
|
1118
1208
|
*/
|
|
1119
1209
|
AutomationTargetParameterName?: string;
|
|
1120
1210
|
/**
|
|
1211
|
+
* @public
|
|
1121
1212
|
* <p>A description of the parameters for a document. </p>
|
|
1122
1213
|
*/
|
|
1123
1214
|
Parameters?: Record<string, string[]>;
|
|
1124
1215
|
/**
|
|
1216
|
+
* @public
|
|
1125
1217
|
* <p>The association ID.</p>
|
|
1126
1218
|
*/
|
|
1127
1219
|
AssociationId?: string;
|
|
1128
1220
|
/**
|
|
1221
|
+
* @public
|
|
1129
1222
|
* <p>The managed nodes targeted by the request. </p>
|
|
1130
1223
|
*/
|
|
1131
1224
|
Targets?: Target[];
|
|
1132
1225
|
/**
|
|
1226
|
+
* @public
|
|
1133
1227
|
* <p>A cron expression that specifies a schedule when the association runs.</p>
|
|
1134
1228
|
*/
|
|
1135
1229
|
ScheduleExpression?: string;
|
|
1136
1230
|
/**
|
|
1231
|
+
* @public
|
|
1137
1232
|
* <p>An S3 bucket where you want to store the output details of the request.</p>
|
|
1138
1233
|
*/
|
|
1139
1234
|
OutputLocation?: InstanceAssociationOutputLocation;
|
|
1140
1235
|
/**
|
|
1236
|
+
* @public
|
|
1141
1237
|
* <p>The date on which the association was last run.</p>
|
|
1142
1238
|
*/
|
|
1143
1239
|
LastExecutionDate?: Date;
|
|
1144
1240
|
/**
|
|
1241
|
+
* @public
|
|
1145
1242
|
* <p>The last date on which the association was successfully run.</p>
|
|
1146
1243
|
*/
|
|
1147
1244
|
LastSuccessfulExecutionDate?: Date;
|
|
1148
1245
|
/**
|
|
1246
|
+
* @public
|
|
1149
1247
|
* <p>The association name.</p>
|
|
1150
1248
|
*/
|
|
1151
1249
|
AssociationName?: string;
|
|
1152
1250
|
/**
|
|
1251
|
+
* @public
|
|
1153
1252
|
* <p>The number of errors that are allowed before the system stops sending requests to run the
|
|
1154
1253
|
* association on additional targets. You can specify either an absolute number of errors, for
|
|
1155
1254
|
* example 10, or a percentage of the target set, for example 10%. If you specify 3, for example,
|
|
@@ -1164,6 +1263,7 @@ export interface AssociationDescription {
|
|
|
1164
1263
|
*/
|
|
1165
1264
|
MaxErrors?: string;
|
|
1166
1265
|
/**
|
|
1266
|
+
* @public
|
|
1167
1267
|
* <p>The maximum number of targets allowed to run the association at the same time. You can
|
|
1168
1268
|
* specify a number, for example 10, or a percentage of the target set, for example 10%. The default
|
|
1169
1269
|
* value is 100%, which means all targets run the association at the same time.</p>
|
|
@@ -1174,10 +1274,12 @@ export interface AssociationDescription {
|
|
|
1174
1274
|
*/
|
|
1175
1275
|
MaxConcurrency?: string;
|
|
1176
1276
|
/**
|
|
1277
|
+
* @public
|
|
1177
1278
|
* <p>The severity level that is assigned to the association.</p>
|
|
1178
1279
|
*/
|
|
1179
1280
|
ComplianceSeverity?: AssociationComplianceSeverity | string;
|
|
1180
1281
|
/**
|
|
1282
|
+
* @public
|
|
1181
1283
|
* <p>The mode for generating association compliance. You can specify <code>AUTO</code> or
|
|
1182
1284
|
* <code>MANUAL</code>. In <code>AUTO</code> mode, the system uses the status of the association
|
|
1183
1285
|
* execution to determine the compliance status. If the association execution runs successfully,
|
|
@@ -1191,6 +1293,7 @@ export interface AssociationDescription {
|
|
|
1191
1293
|
*/
|
|
1192
1294
|
SyncCompliance?: AssociationSyncCompliance | string;
|
|
1193
1295
|
/**
|
|
1296
|
+
* @public
|
|
1194
1297
|
* <p>By default, when you create a new associations, the system runs it immediately after it is
|
|
1195
1298
|
* created and then according to the schedule you specified. Specify this option if you don't want
|
|
1196
1299
|
* an association to run immediately after you create it. This parameter isn't supported for rate
|
|
@@ -1198,6 +1301,7 @@ export interface AssociationDescription {
|
|
|
1198
1301
|
*/
|
|
1199
1302
|
ApplyOnlyAtCronInterval?: boolean;
|
|
1200
1303
|
/**
|
|
1304
|
+
* @public
|
|
1201
1305
|
* <p>The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your
|
|
1202
1306
|
* associations are gated under. The associations only run when that change calendar is open. For
|
|
1203
1307
|
* more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar">Amazon Web Services Systems Manager Change
|
|
@@ -1205,25 +1309,30 @@ export interface AssociationDescription {
|
|
|
1205
1309
|
*/
|
|
1206
1310
|
CalendarNames?: string[];
|
|
1207
1311
|
/**
|
|
1312
|
+
* @public
|
|
1208
1313
|
* <p>The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the
|
|
1209
1314
|
* association.</p>
|
|
1210
1315
|
*/
|
|
1211
1316
|
TargetLocations?: TargetLocation[];
|
|
1212
1317
|
/**
|
|
1318
|
+
* @public
|
|
1213
1319
|
* <p>Number of days to wait after the scheduled day to run an association.</p>
|
|
1214
1320
|
*/
|
|
1215
1321
|
ScheduleOffset?: number;
|
|
1216
1322
|
/**
|
|
1323
|
+
* @public
|
|
1217
1324
|
* <p>A key-value mapping of document parameters to target resources. Both Targets and TargetMaps
|
|
1218
1325
|
* can't be specified together.</p>
|
|
1219
1326
|
*/
|
|
1220
1327
|
TargetMaps?: Record<string, string[]>[];
|
|
1221
1328
|
/**
|
|
1329
|
+
* @public
|
|
1222
1330
|
* <p>The details for the CloudWatch alarm you want to apply to an automation or
|
|
1223
1331
|
* command.</p>
|
|
1224
1332
|
*/
|
|
1225
1333
|
AlarmConfiguration?: AlarmConfiguration;
|
|
1226
1334
|
/**
|
|
1335
|
+
* @public
|
|
1227
1336
|
* <p>The CloudWatch alarm that was invoked during the association.</p>
|
|
1228
1337
|
*/
|
|
1229
1338
|
TriggeredAlarms?: AlarmStateInformation[];
|
|
@@ -1233,6 +1342,7 @@ export interface AssociationDescription {
|
|
|
1233
1342
|
*/
|
|
1234
1343
|
export interface CreateAssociationResult {
|
|
1235
1344
|
/**
|
|
1345
|
+
* @public
|
|
1236
1346
|
* <p>Information about the association.</p>
|
|
1237
1347
|
*/
|
|
1238
1348
|
AssociationDescription?: AssociationDescription;
|
|
@@ -1245,6 +1355,7 @@ export declare class InvalidDocument extends __BaseException {
|
|
|
1245
1355
|
readonly name: "InvalidDocument";
|
|
1246
1356
|
readonly $fault: "client";
|
|
1247
1357
|
/**
|
|
1358
|
+
* @public
|
|
1248
1359
|
* <p>The SSM document doesn't exist or the document isn't available to the user. This exception
|
|
1249
1360
|
* can be issued by various API operations. </p>
|
|
1250
1361
|
*/
|
|
@@ -1352,6 +1463,7 @@ export declare class UnsupportedPlatformType extends __BaseException {
|
|
|
1352
1463
|
*/
|
|
1353
1464
|
export interface CreateAssociationBatchRequestEntry {
|
|
1354
1465
|
/**
|
|
1466
|
+
* @public
|
|
1355
1467
|
* <p>The name of the SSM document that contains the configuration information for the managed
|
|
1356
1468
|
* node. You can specify Command or Automation runbooks.</p>
|
|
1357
1469
|
* <p>You can specify Amazon Web Services-predefined documents, documents you created, or a document that is
|
|
@@ -1372,6 +1484,7 @@ export interface CreateAssociationBatchRequestEntry {
|
|
|
1372
1484
|
*/
|
|
1373
1485
|
Name: string | undefined;
|
|
1374
1486
|
/**
|
|
1487
|
+
* @public
|
|
1375
1488
|
* <p>The managed node ID.</p>
|
|
1376
1489
|
* <note>
|
|
1377
1490
|
* <p>
|
|
@@ -1387,36 +1500,44 @@ export interface CreateAssociationBatchRequestEntry {
|
|
|
1387
1500
|
*/
|
|
1388
1501
|
InstanceId?: string;
|
|
1389
1502
|
/**
|
|
1503
|
+
* @public
|
|
1390
1504
|
* <p>A description of the parameters for a document. </p>
|
|
1391
1505
|
*/
|
|
1392
1506
|
Parameters?: Record<string, string[]>;
|
|
1393
1507
|
/**
|
|
1508
|
+
* @public
|
|
1394
1509
|
* <p>Specify the target for the association. This target is required for associations that use an
|
|
1395
1510
|
* Automation runbook and target resources by using rate controls. Automation is a capability of
|
|
1396
1511
|
* Amazon Web Services Systems Manager.</p>
|
|
1397
1512
|
*/
|
|
1398
1513
|
AutomationTargetParameterName?: string;
|
|
1399
1514
|
/**
|
|
1515
|
+
* @public
|
|
1400
1516
|
* <p>The document version.</p>
|
|
1401
1517
|
*/
|
|
1402
1518
|
DocumentVersion?: string;
|
|
1403
1519
|
/**
|
|
1520
|
+
* @public
|
|
1404
1521
|
* <p>The managed nodes targeted by the request.</p>
|
|
1405
1522
|
*/
|
|
1406
1523
|
Targets?: Target[];
|
|
1407
1524
|
/**
|
|
1525
|
+
* @public
|
|
1408
1526
|
* <p>A cron expression that specifies a schedule when the association runs.</p>
|
|
1409
1527
|
*/
|
|
1410
1528
|
ScheduleExpression?: string;
|
|
1411
1529
|
/**
|
|
1530
|
+
* @public
|
|
1412
1531
|
* <p>An S3 bucket where you want to store the results of this request.</p>
|
|
1413
1532
|
*/
|
|
1414
1533
|
OutputLocation?: InstanceAssociationOutputLocation;
|
|
1415
1534
|
/**
|
|
1535
|
+
* @public
|
|
1416
1536
|
* <p>Specify a descriptive name for the association.</p>
|
|
1417
1537
|
*/
|
|
1418
1538
|
AssociationName?: string;
|
|
1419
1539
|
/**
|
|
1540
|
+
* @public
|
|
1420
1541
|
* <p>The number of errors that are allowed before the system stops sending requests to run the
|
|
1421
1542
|
* association on additional targets. You can specify either an absolute number of errors, for
|
|
1422
1543
|
* example 10, or a percentage of the target set, for example 10%. If you specify 3, for example,
|
|
@@ -1431,6 +1552,7 @@ export interface CreateAssociationBatchRequestEntry {
|
|
|
1431
1552
|
*/
|
|
1432
1553
|
MaxErrors?: string;
|
|
1433
1554
|
/**
|
|
1555
|
+
* @public
|
|
1434
1556
|
* <p>The maximum number of targets allowed to run the association at the same time. You can
|
|
1435
1557
|
* specify a number, for example 10, or a percentage of the target set, for example 10%. The default
|
|
1436
1558
|
* value is 100%, which means all targets run the association at the same time.</p>
|
|
@@ -1441,10 +1563,12 @@ export interface CreateAssociationBatchRequestEntry {
|
|
|
1441
1563
|
*/
|
|
1442
1564
|
MaxConcurrency?: string;
|
|
1443
1565
|
/**
|
|
1566
|
+
* @public
|
|
1444
1567
|
* <p>The severity level to assign to the association.</p>
|
|
1445
1568
|
*/
|
|
1446
1569
|
ComplianceSeverity?: AssociationComplianceSeverity | string;
|
|
1447
1570
|
/**
|
|
1571
|
+
* @public
|
|
1448
1572
|
* <p>The mode for generating association compliance. You can specify <code>AUTO</code> or
|
|
1449
1573
|
* <code>MANUAL</code>. In <code>AUTO</code> mode, the system uses the status of the association
|
|
1450
1574
|
* execution to determine the compliance status. If the association execution runs successfully,
|
|
@@ -1458,6 +1582,7 @@ export interface CreateAssociationBatchRequestEntry {
|
|
|
1458
1582
|
*/
|
|
1459
1583
|
SyncCompliance?: AssociationSyncCompliance | string;
|
|
1460
1584
|
/**
|
|
1585
|
+
* @public
|
|
1461
1586
|
* <p>By default, when you create a new associations, the system runs it immediately after it is
|
|
1462
1587
|
* created and then according to the schedule you specified. Specify this option if you don't want
|
|
1463
1588
|
* an association to run immediately after you create it. This parameter isn't supported for rate
|
|
@@ -1465,6 +1590,7 @@ export interface CreateAssociationBatchRequestEntry {
|
|
|
1465
1590
|
*/
|
|
1466
1591
|
ApplyOnlyAtCronInterval?: boolean;
|
|
1467
1592
|
/**
|
|
1593
|
+
* @public
|
|
1468
1594
|
* <p>The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your
|
|
1469
1595
|
* associations are gated under. The associations only run when that Change Calendar is open. For
|
|
1470
1596
|
* more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar">Amazon Web Services Systems Manager Change
|
|
@@ -1472,19 +1598,23 @@ export interface CreateAssociationBatchRequestEntry {
|
|
|
1472
1598
|
*/
|
|
1473
1599
|
CalendarNames?: string[];
|
|
1474
1600
|
/**
|
|
1601
|
+
* @public
|
|
1475
1602
|
* <p>Use this action to create an association in multiple Regions and multiple accounts.</p>
|
|
1476
1603
|
*/
|
|
1477
1604
|
TargetLocations?: TargetLocation[];
|
|
1478
1605
|
/**
|
|
1606
|
+
* @public
|
|
1479
1607
|
* <p>Number of days to wait after the scheduled day to run an association.</p>
|
|
1480
1608
|
*/
|
|
1481
1609
|
ScheduleOffset?: number;
|
|
1482
1610
|
/**
|
|
1611
|
+
* @public
|
|
1483
1612
|
* <p>A key-value mapping of document parameters to target resources. Both Targets and TargetMaps
|
|
1484
1613
|
* can't be specified together.</p>
|
|
1485
1614
|
*/
|
|
1486
1615
|
TargetMaps?: Record<string, string[]>[];
|
|
1487
1616
|
/**
|
|
1617
|
+
* @public
|
|
1488
1618
|
* <p>The details for the CloudWatch alarm you want to apply to an automation or
|
|
1489
1619
|
* command.</p>
|
|
1490
1620
|
*/
|
|
@@ -1495,6 +1625,7 @@ export interface CreateAssociationBatchRequestEntry {
|
|
|
1495
1625
|
*/
|
|
1496
1626
|
export interface CreateAssociationBatchRequest {
|
|
1497
1627
|
/**
|
|
1628
|
+
* @public
|
|
1498
1629
|
* <p>One or more associations.</p>
|
|
1499
1630
|
*/
|
|
1500
1631
|
Entries: CreateAssociationBatchRequestEntry[] | undefined;
|
|
@@ -1518,14 +1649,17 @@ export type Fault = (typeof Fault)[keyof typeof Fault];
|
|
|
1518
1649
|
*/
|
|
1519
1650
|
export interface FailedCreateAssociation {
|
|
1520
1651
|
/**
|
|
1652
|
+
* @public
|
|
1521
1653
|
* <p>The association.</p>
|
|
1522
1654
|
*/
|
|
1523
1655
|
Entry?: CreateAssociationBatchRequestEntry;
|
|
1524
1656
|
/**
|
|
1657
|
+
* @public
|
|
1525
1658
|
* <p>A description of the failure.</p>
|
|
1526
1659
|
*/
|
|
1527
1660
|
Message?: string;
|
|
1528
1661
|
/**
|
|
1662
|
+
* @public
|
|
1529
1663
|
* <p>The source of the failure.</p>
|
|
1530
1664
|
*/
|
|
1531
1665
|
Fault?: Fault | string;
|
|
@@ -1535,10 +1669,12 @@ export interface FailedCreateAssociation {
|
|
|
1535
1669
|
*/
|
|
1536
1670
|
export interface CreateAssociationBatchResult {
|
|
1537
1671
|
/**
|
|
1672
|
+
* @public
|
|
1538
1673
|
* <p>Information about the associations that succeeded.</p>
|
|
1539
1674
|
*/
|
|
1540
1675
|
Successful?: AssociationDescription[];
|
|
1541
1676
|
/**
|
|
1677
|
+
* @public
|
|
1542
1678
|
* <p>Information about the associations that failed.</p>
|
|
1543
1679
|
*/
|
|
1544
1680
|
Failed?: FailedCreateAssociation[];
|
|
@@ -1563,11 +1699,13 @@ export type AttachmentsSourceKey = (typeof AttachmentsSourceKey)[keyof typeof At
|
|
|
1563
1699
|
*/
|
|
1564
1700
|
export interface AttachmentsSource {
|
|
1565
1701
|
/**
|
|
1702
|
+
* @public
|
|
1566
1703
|
* <p>The key of a key-value pair that identifies the location of an attachment to a
|
|
1567
1704
|
* document.</p>
|
|
1568
1705
|
*/
|
|
1569
1706
|
Key?: AttachmentsSourceKey | string;
|
|
1570
1707
|
/**
|
|
1708
|
+
* @public
|
|
1571
1709
|
* <p>The value of a key-value pair that identifies the location of an attachment to a document.
|
|
1572
1710
|
* The format for <b>Value</b> depends on the type of key you
|
|
1573
1711
|
* specify.</p>
|
|
@@ -1605,6 +1743,7 @@ export interface AttachmentsSource {
|
|
|
1605
1743
|
*/
|
|
1606
1744
|
Values?: string[];
|
|
1607
1745
|
/**
|
|
1746
|
+
* @public
|
|
1608
1747
|
* <p>The name of the document attachment file.</p>
|
|
1609
1748
|
*/
|
|
1610
1749
|
Name?: string;
|
|
@@ -1653,18 +1792,22 @@ export type DocumentType = (typeof DocumentType)[keyof typeof DocumentType];
|
|
|
1653
1792
|
*/
|
|
1654
1793
|
export interface DocumentRequires {
|
|
1655
1794
|
/**
|
|
1795
|
+
* @public
|
|
1656
1796
|
* <p>The name of the required SSM document. The name can be an Amazon Resource Name (ARN).</p>
|
|
1657
1797
|
*/
|
|
1658
1798
|
Name: string | undefined;
|
|
1659
1799
|
/**
|
|
1800
|
+
* @public
|
|
1660
1801
|
* <p>The document version required by the current document.</p>
|
|
1661
1802
|
*/
|
|
1662
1803
|
Version?: string;
|
|
1663
1804
|
/**
|
|
1805
|
+
* @public
|
|
1664
1806
|
* <p>The document type of the required SSM document.</p>
|
|
1665
1807
|
*/
|
|
1666
1808
|
RequireType?: string;
|
|
1667
1809
|
/**
|
|
1810
|
+
* @public
|
|
1668
1811
|
* <p>An optional field specifying the version of the artifact associated with the document. For
|
|
1669
1812
|
* example, "Release 12, Update 6". This value is unique across all versions of a document, and
|
|
1670
1813
|
* can't be changed.</p>
|
|
@@ -1676,6 +1819,7 @@ export interface DocumentRequires {
|
|
|
1676
1819
|
*/
|
|
1677
1820
|
export interface CreateDocumentRequest {
|
|
1678
1821
|
/**
|
|
1822
|
+
* @public
|
|
1679
1823
|
* <p>The content for the new SSM document in JSON or YAML format. The content of the document
|
|
1680
1824
|
* must not exceed 64KB. This quota also includes the content specified for input parameters at
|
|
1681
1825
|
* runtime. We recommend storing the contents for your new document in an external JSON or YAML file
|
|
@@ -1701,6 +1845,7 @@ export interface CreateDocumentRequest {
|
|
|
1701
1845
|
*/
|
|
1702
1846
|
Content: string | undefined;
|
|
1703
1847
|
/**
|
|
1848
|
+
* @public
|
|
1704
1849
|
* <p>A list of SSM documents required by a document. This parameter is used exclusively by
|
|
1705
1850
|
* AppConfig. When a user creates an AppConfig configuration in an SSM document, the user must also
|
|
1706
1851
|
* specify a required document for validation purposes. In this case, an
|
|
@@ -1711,10 +1856,12 @@ export interface CreateDocumentRequest {
|
|
|
1711
1856
|
*/
|
|
1712
1857
|
Requires?: DocumentRequires[];
|
|
1713
1858
|
/**
|
|
1859
|
+
* @public
|
|
1714
1860
|
* <p>A list of key-value pairs that describe attachments to a version of a document.</p>
|
|
1715
1861
|
*/
|
|
1716
1862
|
Attachments?: AttachmentsSource[];
|
|
1717
1863
|
/**
|
|
1864
|
+
* @public
|
|
1718
1865
|
* <p>A name for the SSM document.</p>
|
|
1719
1866
|
* <important>
|
|
1720
1867
|
* <p>You can't use the following strings as document name prefixes. These are reserved by Amazon Web Services
|
|
@@ -1740,18 +1887,21 @@ export interface CreateDocumentRequest {
|
|
|
1740
1887
|
*/
|
|
1741
1888
|
Name: string | undefined;
|
|
1742
1889
|
/**
|
|
1890
|
+
* @public
|
|
1743
1891
|
* <p>An optional field where you can specify a friendly name for the SSM document. This value can
|
|
1744
1892
|
* differ for each version of the document. You can update this value at a later time using the
|
|
1745
1893
|
* <a>UpdateDocument</a> operation.</p>
|
|
1746
1894
|
*/
|
|
1747
1895
|
DisplayName?: string;
|
|
1748
1896
|
/**
|
|
1897
|
+
* @public
|
|
1749
1898
|
* <p>An optional field specifying the version of the artifact you are creating with the document.
|
|
1750
1899
|
* For example, <code>Release12.1</code>. This value is unique across all versions of a document,
|
|
1751
1900
|
* and can't be changed.</p>
|
|
1752
1901
|
*/
|
|
1753
1902
|
VersionName?: string;
|
|
1754
1903
|
/**
|
|
1904
|
+
* @public
|
|
1755
1905
|
* <p>The type of document to create.</p>
|
|
1756
1906
|
* <note>
|
|
1757
1907
|
* <p>The <code>DeploymentStrategy</code> document type is an internal-use-only document type
|
|
@@ -1760,11 +1910,13 @@ export interface CreateDocumentRequest {
|
|
|
1760
1910
|
*/
|
|
1761
1911
|
DocumentType?: DocumentType | string;
|
|
1762
1912
|
/**
|
|
1913
|
+
* @public
|
|
1763
1914
|
* <p>Specify the document format for the request. The document format can be JSON, YAML, or TEXT.
|
|
1764
1915
|
* JSON is the default format.</p>
|
|
1765
1916
|
*/
|
|
1766
1917
|
DocumentFormat?: DocumentFormat | string;
|
|
1767
1918
|
/**
|
|
1919
|
+
* @public
|
|
1768
1920
|
* <p>Specify a target type to define the kinds of resources the document can run on. For example,
|
|
1769
1921
|
* to run a document on EC2 instances, specify the following value:
|
|
1770
1922
|
* <code>/AWS::EC2::Instance</code>. If you specify a value of '/' the document can run on all types
|
|
@@ -1774,6 +1926,7 @@ export interface CreateDocumentRequest {
|
|
|
1774
1926
|
*/
|
|
1775
1927
|
TargetType?: string;
|
|
1776
1928
|
/**
|
|
1929
|
+
* @public
|
|
1777
1930
|
* <p>Optional metadata that you assign to a resource. Tags enable you to categorize a resource in
|
|
1778
1931
|
* different ways, such as by purpose, owner, or environment. For example, you might want to tag an
|
|
1779
1932
|
* SSM document to identify the types of targets or the environment where it will run. In this case,
|
|
@@ -1803,6 +1956,7 @@ export interface CreateDocumentRequest {
|
|
|
1803
1956
|
*/
|
|
1804
1957
|
export interface AttachmentInformation {
|
|
1805
1958
|
/**
|
|
1959
|
+
* @public
|
|
1806
1960
|
* <p>The name of the attachment.</p>
|
|
1807
1961
|
*/
|
|
1808
1962
|
Name?: string;
|
|
@@ -1838,19 +1992,23 @@ export type DocumentParameterType = (typeof DocumentParameterType)[keyof typeof
|
|
|
1838
1992
|
*/
|
|
1839
1993
|
export interface DocumentParameter {
|
|
1840
1994
|
/**
|
|
1995
|
+
* @public
|
|
1841
1996
|
* <p>The name of the parameter.</p>
|
|
1842
1997
|
*/
|
|
1843
1998
|
Name?: string;
|
|
1844
1999
|
/**
|
|
2000
|
+
* @public
|
|
1845
2001
|
* <p>The type of parameter. The type can be either String or StringList.</p>
|
|
1846
2002
|
*/
|
|
1847
2003
|
Type?: DocumentParameterType | string;
|
|
1848
2004
|
/**
|
|
2005
|
+
* @public
|
|
1849
2006
|
* <p>A description of what the parameter does, how to use it, the default value, and whether or
|
|
1850
2007
|
* not the parameter is optional.</p>
|
|
1851
2008
|
*/
|
|
1852
2009
|
Description?: string;
|
|
1853
2010
|
/**
|
|
2011
|
+
* @public
|
|
1854
2012
|
* <p>If specified, the default values for the parameters. Parameters without a default value are
|
|
1855
2013
|
* required. Parameters with a default value are optional.</p>
|
|
1856
2014
|
*/
|
|
@@ -1889,14 +2047,17 @@ export type ReviewStatus = (typeof ReviewStatus)[keyof typeof ReviewStatus];
|
|
|
1889
2047
|
*/
|
|
1890
2048
|
export interface ReviewInformation {
|
|
1891
2049
|
/**
|
|
2050
|
+
* @public
|
|
1892
2051
|
* <p>The time that the reviewer took action on the document review request.</p>
|
|
1893
2052
|
*/
|
|
1894
2053
|
ReviewedTime?: Date;
|
|
1895
2054
|
/**
|
|
2055
|
+
* @public
|
|
1896
2056
|
* <p>The current status of the document review request.</p>
|
|
1897
2057
|
*/
|
|
1898
2058
|
Status?: ReviewStatus | string;
|
|
1899
2059
|
/**
|
|
2060
|
+
* @public
|
|
1900
2061
|
* <p>The reviewer assigned to take action on the document review request.</p>
|
|
1901
2062
|
*/
|
|
1902
2063
|
Reviewer?: string;
|
|
@@ -1922,10 +2083,12 @@ export type DocumentStatus = (typeof DocumentStatus)[keyof typeof DocumentStatus
|
|
|
1922
2083
|
*/
|
|
1923
2084
|
export interface DocumentDescription {
|
|
1924
2085
|
/**
|
|
2086
|
+
* @public
|
|
1925
2087
|
* <p>The SHA1 hash of the document, which you can use for verification.</p>
|
|
1926
2088
|
*/
|
|
1927
2089
|
Sha1?: string;
|
|
1928
2090
|
/**
|
|
2091
|
+
* @public
|
|
1929
2092
|
* <p>The Sha256 or Sha1 hash created by the system when the document was created. </p>
|
|
1930
2093
|
* <note>
|
|
1931
2094
|
* <p>Sha1 hashes have been deprecated.</p>
|
|
@@ -1933,6 +2096,7 @@ export interface DocumentDescription {
|
|
|
1933
2096
|
*/
|
|
1934
2097
|
Hash?: string;
|
|
1935
2098
|
/**
|
|
2099
|
+
* @public
|
|
1936
2100
|
* <p>The hash type of the document. Valid values include <code>Sha256</code> or
|
|
1937
2101
|
* <code>Sha1</code>.</p>
|
|
1938
2102
|
* <note>
|
|
@@ -1941,117 +2105,144 @@ export interface DocumentDescription {
|
|
|
1941
2105
|
*/
|
|
1942
2106
|
HashType?: DocumentHashType | string;
|
|
1943
2107
|
/**
|
|
2108
|
+
* @public
|
|
1944
2109
|
* <p>The name of the SSM document.</p>
|
|
1945
2110
|
*/
|
|
1946
2111
|
Name?: string;
|
|
1947
2112
|
/**
|
|
2113
|
+
* @public
|
|
1948
2114
|
* <p>The friendly name of the SSM document. This value can differ for each version of the
|
|
1949
2115
|
* document. If you want to update this value, see <a>UpdateDocument</a>.</p>
|
|
1950
2116
|
*/
|
|
1951
2117
|
DisplayName?: string;
|
|
1952
2118
|
/**
|
|
2119
|
+
* @public
|
|
1953
2120
|
* <p>The version of the artifact associated with the document.</p>
|
|
1954
2121
|
*/
|
|
1955
2122
|
VersionName?: string;
|
|
1956
2123
|
/**
|
|
2124
|
+
* @public
|
|
1957
2125
|
* <p>The Amazon Web Services user that created the document.</p>
|
|
1958
2126
|
*/
|
|
1959
2127
|
Owner?: string;
|
|
1960
2128
|
/**
|
|
2129
|
+
* @public
|
|
1961
2130
|
* <p>The date when the document was created.</p>
|
|
1962
2131
|
*/
|
|
1963
2132
|
CreatedDate?: Date;
|
|
1964
2133
|
/**
|
|
2134
|
+
* @public
|
|
1965
2135
|
* <p>The status of the SSM document.</p>
|
|
1966
2136
|
*/
|
|
1967
2137
|
Status?: DocumentStatus | string;
|
|
1968
2138
|
/**
|
|
2139
|
+
* @public
|
|
1969
2140
|
* <p>A message returned by Amazon Web Services Systems Manager that explains the <code>Status</code> value. For example, a
|
|
1970
2141
|
* <code>Failed</code> status might be explained by the <code>StatusInformation</code> message,
|
|
1971
2142
|
* "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."</p>
|
|
1972
2143
|
*/
|
|
1973
2144
|
StatusInformation?: string;
|
|
1974
2145
|
/**
|
|
2146
|
+
* @public
|
|
1975
2147
|
* <p>The document version.</p>
|
|
1976
2148
|
*/
|
|
1977
2149
|
DocumentVersion?: string;
|
|
1978
2150
|
/**
|
|
2151
|
+
* @public
|
|
1979
2152
|
* <p>A description of the document. </p>
|
|
1980
2153
|
*/
|
|
1981
2154
|
Description?: string;
|
|
1982
2155
|
/**
|
|
2156
|
+
* @public
|
|
1983
2157
|
* <p>A description of the parameters for a document.</p>
|
|
1984
2158
|
*/
|
|
1985
2159
|
Parameters?: DocumentParameter[];
|
|
1986
2160
|
/**
|
|
2161
|
+
* @public
|
|
1987
2162
|
* <p>The list of operating system (OS) platforms compatible with this SSM document. </p>
|
|
1988
2163
|
*/
|
|
1989
2164
|
PlatformTypes?: (PlatformType | string)[];
|
|
1990
2165
|
/**
|
|
2166
|
+
* @public
|
|
1991
2167
|
* <p>The type of document.</p>
|
|
1992
2168
|
*/
|
|
1993
2169
|
DocumentType?: DocumentType | string;
|
|
1994
2170
|
/**
|
|
2171
|
+
* @public
|
|
1995
2172
|
* <p>The schema version.</p>
|
|
1996
2173
|
*/
|
|
1997
2174
|
SchemaVersion?: string;
|
|
1998
2175
|
/**
|
|
2176
|
+
* @public
|
|
1999
2177
|
* <p>The latest version of the document.</p>
|
|
2000
2178
|
*/
|
|
2001
2179
|
LatestVersion?: string;
|
|
2002
2180
|
/**
|
|
2181
|
+
* @public
|
|
2003
2182
|
* <p>The default version.</p>
|
|
2004
2183
|
*/
|
|
2005
2184
|
DefaultVersion?: string;
|
|
2006
2185
|
/**
|
|
2186
|
+
* @public
|
|
2007
2187
|
* <p>The document format, either JSON or YAML.</p>
|
|
2008
2188
|
*/
|
|
2009
2189
|
DocumentFormat?: DocumentFormat | string;
|
|
2010
2190
|
/**
|
|
2191
|
+
* @public
|
|
2011
2192
|
* <p>The target type which defines the kinds of resources the document can run on. For example,
|
|
2012
2193
|
* <code>/AWS::EC2::Instance</code>. For a list of valid resource types, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services resource and
|
|
2013
2194
|
* property types reference</a> in the <i>CloudFormation User Guide</i>. </p>
|
|
2014
2195
|
*/
|
|
2015
2196
|
TargetType?: string;
|
|
2016
2197
|
/**
|
|
2198
|
+
* @public
|
|
2017
2199
|
* <p>The tags, or metadata, that have been applied to the document.</p>
|
|
2018
2200
|
*/
|
|
2019
2201
|
Tags?: Tag[];
|
|
2020
2202
|
/**
|
|
2203
|
+
* @public
|
|
2021
2204
|
* <p>Details about the document attachments, including names, locations, sizes, and so on.</p>
|
|
2022
2205
|
*/
|
|
2023
2206
|
AttachmentsInformation?: AttachmentInformation[];
|
|
2024
2207
|
/**
|
|
2208
|
+
* @public
|
|
2025
2209
|
* <p>A list of SSM documents required by a document. For example, an
|
|
2026
2210
|
* <code>ApplicationConfiguration</code> document requires an
|
|
2027
2211
|
* <code>ApplicationConfigurationSchema</code> document.</p>
|
|
2028
2212
|
*/
|
|
2029
2213
|
Requires?: DocumentRequires[];
|
|
2030
2214
|
/**
|
|
2215
|
+
* @public
|
|
2031
2216
|
* <p>The user in your organization who created the document.</p>
|
|
2032
2217
|
*/
|
|
2033
2218
|
Author?: string;
|
|
2034
2219
|
/**
|
|
2220
|
+
* @public
|
|
2035
2221
|
* <p>Details about the review of a document.</p>
|
|
2036
2222
|
*/
|
|
2037
2223
|
ReviewInformation?: ReviewInformation[];
|
|
2038
2224
|
/**
|
|
2225
|
+
* @public
|
|
2039
2226
|
* <p>The version of the document currently approved for use in the organization.</p>
|
|
2040
2227
|
*/
|
|
2041
2228
|
ApprovedVersion?: string;
|
|
2042
2229
|
/**
|
|
2230
|
+
* @public
|
|
2043
2231
|
* <p>The version of the document that is currently under review.</p>
|
|
2044
2232
|
*/
|
|
2045
2233
|
PendingReviewVersion?: string;
|
|
2046
2234
|
/**
|
|
2235
|
+
* @public
|
|
2047
2236
|
* <p>The current status of the review.</p>
|
|
2048
2237
|
*/
|
|
2049
2238
|
ReviewStatus?: ReviewStatus | string;
|
|
2050
2239
|
/**
|
|
2240
|
+
* @public
|
|
2051
2241
|
* <p>The classification of a document to help you identify and categorize its use.</p>
|
|
2052
2242
|
*/
|
|
2053
2243
|
Category?: string[];
|
|
2054
2244
|
/**
|
|
2245
|
+
* @public
|
|
2055
2246
|
* <p>The value that identifies a document's category.</p>
|
|
2056
2247
|
*/
|
|
2057
2248
|
CategoryEnum?: string[];
|
|
@@ -2061,6 +2252,7 @@ export interface DocumentDescription {
|
|
|
2061
2252
|
*/
|
|
2062
2253
|
export interface CreateDocumentResult {
|
|
2063
2254
|
/**
|
|
2255
|
+
* @public
|
|
2064
2256
|
* <p>Information about the SSM document.</p>
|
|
2065
2257
|
*/
|
|
2066
2258
|
DocumentDescription?: DocumentDescription;
|
|
@@ -2099,6 +2291,7 @@ export declare class InvalidDocumentContent extends __BaseException {
|
|
|
2099
2291
|
readonly name: "InvalidDocumentContent";
|
|
2100
2292
|
readonly $fault: "client";
|
|
2101
2293
|
/**
|
|
2294
|
+
* @public
|
|
2102
2295
|
* <p>A description of the validation error.</p>
|
|
2103
2296
|
*/
|
|
2104
2297
|
Message?: string;
|
|
@@ -2138,31 +2331,37 @@ export declare class MaxDocumentSizeExceeded extends __BaseException {
|
|
|
2138
2331
|
*/
|
|
2139
2332
|
export interface CreateMaintenanceWindowRequest {
|
|
2140
2333
|
/**
|
|
2334
|
+
* @public
|
|
2141
2335
|
* <p>The name of the maintenance window.</p>
|
|
2142
2336
|
*/
|
|
2143
2337
|
Name: string | undefined;
|
|
2144
2338
|
/**
|
|
2339
|
+
* @public
|
|
2145
2340
|
* <p>An optional description for the maintenance window. We recommend specifying a description to
|
|
2146
2341
|
* help you organize your maintenance windows. </p>
|
|
2147
2342
|
*/
|
|
2148
2343
|
Description?: string;
|
|
2149
2344
|
/**
|
|
2345
|
+
* @public
|
|
2150
2346
|
* <p>The date and time, in ISO-8601 Extended format, for when you want the maintenance window to
|
|
2151
2347
|
* become active. <code>StartDate</code> allows you to delay activation of the maintenance window
|
|
2152
2348
|
* until the specified future date.</p>
|
|
2153
2349
|
*/
|
|
2154
2350
|
StartDate?: string;
|
|
2155
2351
|
/**
|
|
2352
|
+
* @public
|
|
2156
2353
|
* <p>The date and time, in ISO-8601 Extended format, for when you want the maintenance window to
|
|
2157
2354
|
* become inactive. <code>EndDate</code> allows you to set a date and time in the future when the
|
|
2158
2355
|
* maintenance window will no longer run.</p>
|
|
2159
2356
|
*/
|
|
2160
2357
|
EndDate?: string;
|
|
2161
2358
|
/**
|
|
2359
|
+
* @public
|
|
2162
2360
|
* <p>The schedule of the maintenance window in the form of a cron or rate expression.</p>
|
|
2163
2361
|
*/
|
|
2164
2362
|
Schedule: string | undefined;
|
|
2165
2363
|
/**
|
|
2364
|
+
* @public
|
|
2166
2365
|
* <p>The time zone that the scheduled maintenance window executions are based on, in Internet
|
|
2167
2366
|
* Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or
|
|
2168
2367
|
* "Asia/Seoul". For more information, see the <a href="https://www.iana.org/time-zones">Time
|
|
@@ -2170,6 +2369,7 @@ export interface CreateMaintenanceWindowRequest {
|
|
|
2170
2369
|
*/
|
|
2171
2370
|
ScheduleTimezone?: string;
|
|
2172
2371
|
/**
|
|
2372
|
+
* @public
|
|
2173
2373
|
* <p>The number of days to wait after the date and time specified by a cron expression before
|
|
2174
2374
|
* running the maintenance window.</p>
|
|
2175
2375
|
* <p>For example, the following cron expression schedules a maintenance window to run on the
|
|
@@ -2182,15 +2382,18 @@ export interface CreateMaintenanceWindowRequest {
|
|
|
2182
2382
|
*/
|
|
2183
2383
|
ScheduleOffset?: number;
|
|
2184
2384
|
/**
|
|
2385
|
+
* @public
|
|
2185
2386
|
* <p>The duration of the maintenance window in hours.</p>
|
|
2186
2387
|
*/
|
|
2187
2388
|
Duration: number | undefined;
|
|
2188
2389
|
/**
|
|
2390
|
+
* @public
|
|
2189
2391
|
* <p>The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling
|
|
2190
2392
|
* new tasks for execution.</p>
|
|
2191
2393
|
*/
|
|
2192
2394
|
Cutoff: number | undefined;
|
|
2193
2395
|
/**
|
|
2396
|
+
* @public
|
|
2194
2397
|
* <p>Enables a maintenance window task to run on managed nodes, even if you haven't registered
|
|
2195
2398
|
* those nodes as targets. If enabled, then you must specify the unregistered managed nodes (by node
|
|
2196
2399
|
* ID) when you register a task with the maintenance window.</p>
|
|
@@ -2199,10 +2402,12 @@ export interface CreateMaintenanceWindowRequest {
|
|
|
2199
2402
|
*/
|
|
2200
2403
|
AllowUnassociatedTargets: boolean | undefined;
|
|
2201
2404
|
/**
|
|
2405
|
+
* @public
|
|
2202
2406
|
* <p>User-provided idempotency token.</p>
|
|
2203
2407
|
*/
|
|
2204
2408
|
ClientToken?: string;
|
|
2205
2409
|
/**
|
|
2410
|
+
* @public
|
|
2206
2411
|
* <p>Optional metadata that you assign to a resource. Tags enable you to categorize a resource in
|
|
2207
2412
|
* different ways, such as by purpose, owner, or environment. For example, you might want to tag a
|
|
2208
2413
|
* maintenance window to identify the type of tasks it will run, the types of targets, and the
|
|
@@ -2236,6 +2441,7 @@ export interface CreateMaintenanceWindowRequest {
|
|
|
2236
2441
|
*/
|
|
2237
2442
|
export interface CreateMaintenanceWindowResult {
|
|
2238
2443
|
/**
|
|
2444
|
+
* @public
|
|
2239
2445
|
* <p>The ID of the created maintenance window.</p>
|
|
2240
2446
|
*/
|
|
2241
2447
|
WindowId?: string;
|
|
@@ -2276,6 +2482,7 @@ export declare class ResourceLimitExceededException extends __BaseException {
|
|
|
2276
2482
|
*/
|
|
2277
2483
|
export interface OpsItemNotification {
|
|
2278
2484
|
/**
|
|
2485
|
+
* @public
|
|
2279
2486
|
* <p>The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon SNS) topic where
|
|
2280
2487
|
* notifications are sent when this OpsItem is edited or changed.</p>
|
|
2281
2488
|
*/
|
|
@@ -2299,10 +2506,12 @@ export type OpsItemDataType = (typeof OpsItemDataType)[keyof typeof OpsItemDataT
|
|
|
2299
2506
|
*/
|
|
2300
2507
|
export interface OpsItemDataValue {
|
|
2301
2508
|
/**
|
|
2509
|
+
* @public
|
|
2302
2510
|
* <p>The value of the OperationalData key.</p>
|
|
2303
2511
|
*/
|
|
2304
2512
|
Value?: string;
|
|
2305
2513
|
/**
|
|
2514
|
+
* @public
|
|
2306
2515
|
* <p>The type of key-value pair. Valid types include <code>SearchableString</code> and
|
|
2307
2516
|
* <code>String</code>.</p>
|
|
2308
2517
|
*/
|
|
@@ -2316,6 +2525,7 @@ export interface OpsItemDataValue {
|
|
|
2316
2525
|
*/
|
|
2317
2526
|
export interface RelatedOpsItem {
|
|
2318
2527
|
/**
|
|
2528
|
+
* @public
|
|
2319
2529
|
* <p>The ID of an OpsItem related to the current OpsItem.</p>
|
|
2320
2530
|
*/
|
|
2321
2531
|
OpsItemId: string | undefined;
|
|
@@ -2325,10 +2535,12 @@ export interface RelatedOpsItem {
|
|
|
2325
2535
|
*/
|
|
2326
2536
|
export interface CreateOpsItemRequest {
|
|
2327
2537
|
/**
|
|
2538
|
+
* @public
|
|
2328
2539
|
* <p>Information about the OpsItem. </p>
|
|
2329
2540
|
*/
|
|
2330
2541
|
Description: string | undefined;
|
|
2331
2542
|
/**
|
|
2543
|
+
* @public
|
|
2332
2544
|
* <p>The type of OpsItem to create. Systems Manager supports the following types of OpsItems:</p>
|
|
2333
2545
|
* <ul>
|
|
2334
2546
|
* <li>
|
|
@@ -2355,6 +2567,7 @@ export interface CreateOpsItemRequest {
|
|
|
2355
2567
|
*/
|
|
2356
2568
|
OpsItemType?: string;
|
|
2357
2569
|
/**
|
|
2570
|
+
* @public
|
|
2358
2571
|
* <p>Operational data is custom data that provides useful reference details about the OpsItem.
|
|
2359
2572
|
* For example, you can specify log files, error strings, license keys, troubleshooting tips, or
|
|
2360
2573
|
* other relevant data. You enter operational data as key-value pairs. The key has a maximum length
|
|
@@ -2377,21 +2590,25 @@ export interface CreateOpsItemRequest {
|
|
|
2377
2590
|
*/
|
|
2378
2591
|
OperationalData?: Record<string, OpsItemDataValue>;
|
|
2379
2592
|
/**
|
|
2593
|
+
* @public
|
|
2380
2594
|
* <p>The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this
|
|
2381
2595
|
* OpsItem is edited or changed.</p>
|
|
2382
2596
|
*/
|
|
2383
2597
|
Notifications?: OpsItemNotification[];
|
|
2384
2598
|
/**
|
|
2599
|
+
* @public
|
|
2385
2600
|
* <p>The importance of this OpsItem in relation to other OpsItems in the system.</p>
|
|
2386
2601
|
*/
|
|
2387
2602
|
Priority?: number;
|
|
2388
2603
|
/**
|
|
2604
|
+
* @public
|
|
2389
2605
|
* <p>One or more OpsItems that share something in common with the current OpsItems. For example,
|
|
2390
2606
|
* related OpsItems can include OpsItems with similar error messages, impacted resources, or
|
|
2391
2607
|
* statuses for the impacted resource.</p>
|
|
2392
2608
|
*/
|
|
2393
2609
|
RelatedOpsItems?: RelatedOpsItem[];
|
|
2394
2610
|
/**
|
|
2611
|
+
* @public
|
|
2395
2612
|
* <p>The origin of the OpsItem, such as Amazon EC2 or Systems Manager.</p>
|
|
2396
2613
|
* <note>
|
|
2397
2614
|
* <p>The source name can't contain the following strings: <code>aws</code>, <code>amazon</code>,
|
|
@@ -2400,10 +2617,12 @@ export interface CreateOpsItemRequest {
|
|
|
2400
2617
|
*/
|
|
2401
2618
|
Source: string | undefined;
|
|
2402
2619
|
/**
|
|
2620
|
+
* @public
|
|
2403
2621
|
* <p>A short heading that describes the nature of the OpsItem and the impacted resource.</p>
|
|
2404
2622
|
*/
|
|
2405
2623
|
Title: string | undefined;
|
|
2406
2624
|
/**
|
|
2625
|
+
* @public
|
|
2407
2626
|
* <p>Optional metadata that you assign to a resource.</p>
|
|
2408
2627
|
* <p>Tags use a key-value pair. For example:</p>
|
|
2409
2628
|
* <p>
|
|
@@ -2418,34 +2637,41 @@ export interface CreateOpsItemRequest {
|
|
|
2418
2637
|
*/
|
|
2419
2638
|
Tags?: Tag[];
|
|
2420
2639
|
/**
|
|
2640
|
+
* @public
|
|
2421
2641
|
* <p>Specify a category to assign to an OpsItem. </p>
|
|
2422
2642
|
*/
|
|
2423
2643
|
Category?: string;
|
|
2424
2644
|
/**
|
|
2645
|
+
* @public
|
|
2425
2646
|
* <p>Specify a severity to assign to an OpsItem.</p>
|
|
2426
2647
|
*/
|
|
2427
2648
|
Severity?: string;
|
|
2428
2649
|
/**
|
|
2650
|
+
* @public
|
|
2429
2651
|
* <p>The time a runbook workflow started. Currently reported only for the OpsItem type
|
|
2430
2652
|
* <code>/aws/changerequest</code>.</p>
|
|
2431
2653
|
*/
|
|
2432
2654
|
ActualStartTime?: Date;
|
|
2433
2655
|
/**
|
|
2656
|
+
* @public
|
|
2434
2657
|
* <p>The time a runbook workflow ended. Currently reported only for the OpsItem type
|
|
2435
2658
|
* <code>/aws/changerequest</code>.</p>
|
|
2436
2659
|
*/
|
|
2437
2660
|
ActualEndTime?: Date;
|
|
2438
2661
|
/**
|
|
2662
|
+
* @public
|
|
2439
2663
|
* <p>The time specified in a change request for a runbook workflow to start. Currently supported
|
|
2440
2664
|
* only for the OpsItem type <code>/aws/changerequest</code>.</p>
|
|
2441
2665
|
*/
|
|
2442
2666
|
PlannedStartTime?: Date;
|
|
2443
2667
|
/**
|
|
2668
|
+
* @public
|
|
2444
2669
|
* <p>The time specified in a change request for a runbook workflow to end. Currently supported
|
|
2445
2670
|
* only for the OpsItem type <code>/aws/changerequest</code>.</p>
|
|
2446
2671
|
*/
|
|
2447
2672
|
PlannedEndTime?: Date;
|
|
2448
2673
|
/**
|
|
2674
|
+
* @public
|
|
2449
2675
|
* <p>The target Amazon Web Services account where you want to create an OpsItem. To make this call, your account
|
|
2450
2676
|
* must be configured to work with OpsItems across accounts. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html">Set up
|
|
2451
2677
|
* OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
@@ -2457,10 +2683,12 @@ export interface CreateOpsItemRequest {
|
|
|
2457
2683
|
*/
|
|
2458
2684
|
export interface CreateOpsItemResponse {
|
|
2459
2685
|
/**
|
|
2686
|
+
* @public
|
|
2460
2687
|
* <p>The ID of the OpsItem.</p>
|
|
2461
2688
|
*/
|
|
2462
2689
|
OpsItemId?: string;
|
|
2463
2690
|
/**
|
|
2691
|
+
* @public
|
|
2464
2692
|
* <p>The OpsItem Amazon Resource Name (ARN).</p>
|
|
2465
2693
|
*/
|
|
2466
2694
|
OpsItemArn?: string;
|
|
@@ -2500,6 +2728,7 @@ export declare class OpsItemAlreadyExistsException extends __BaseException {
|
|
|
2500
2728
|
*/
|
|
2501
2729
|
export interface MetadataValue {
|
|
2502
2730
|
/**
|
|
2731
|
+
* @public
|
|
2503
2732
|
* <p>Metadata value to assign to an Application Manager application.</p>
|
|
2504
2733
|
*/
|
|
2505
2734
|
Value?: string;
|
|
@@ -2509,14 +2738,17 @@ export interface MetadataValue {
|
|
|
2509
2738
|
*/
|
|
2510
2739
|
export interface CreateOpsMetadataRequest {
|
|
2511
2740
|
/**
|
|
2741
|
+
* @public
|
|
2512
2742
|
* <p>A resource ID for a new Application Manager application.</p>
|
|
2513
2743
|
*/
|
|
2514
2744
|
ResourceId: string | undefined;
|
|
2515
2745
|
/**
|
|
2746
|
+
* @public
|
|
2516
2747
|
* <p>Metadata for a new Application Manager application. </p>
|
|
2517
2748
|
*/
|
|
2518
2749
|
Metadata?: Record<string, MetadataValue>;
|
|
2519
2750
|
/**
|
|
2751
|
+
* @public
|
|
2520
2752
|
* <p>Optional metadata that you assign to a resource. You can specify a maximum of five tags for
|
|
2521
2753
|
* an OpsMetadata object. Tags enable you to categorize a resource in different ways, such as by
|
|
2522
2754
|
* purpose, owner, or environment. For example, you might want to tag an OpsMetadata object to
|
|
@@ -2542,6 +2774,7 @@ export interface CreateOpsMetadataRequest {
|
|
|
2542
2774
|
*/
|
|
2543
2775
|
export interface CreateOpsMetadataResult {
|
|
2544
2776
|
/**
|
|
2777
|
+
* @public
|
|
2545
2778
|
* <p>The Amazon Resource Name (ARN) of the OpsMetadata Object or blob created by the call.</p>
|
|
2546
2779
|
*/
|
|
2547
2780
|
OpsMetadataArn?: string;
|
|
@@ -2659,12 +2892,14 @@ export type PatchFilterKey = (typeof PatchFilterKey)[keyof typeof PatchFilterKey
|
|
|
2659
2892
|
*/
|
|
2660
2893
|
export interface PatchFilter {
|
|
2661
2894
|
/**
|
|
2895
|
+
* @public
|
|
2662
2896
|
* <p>The key for the filter.</p>
|
|
2663
2897
|
* <p>Run the <a>DescribePatchProperties</a> command to view lists of valid keys for
|
|
2664
2898
|
* each operating system type.</p>
|
|
2665
2899
|
*/
|
|
2666
2900
|
Key: PatchFilterKey | string | undefined;
|
|
2667
2901
|
/**
|
|
2902
|
+
* @public
|
|
2668
2903
|
* <p>The value for the filter key.</p>
|
|
2669
2904
|
* <p>Run the <a>DescribePatchProperties</a> command to view lists of valid values for
|
|
2670
2905
|
* each key based on operating system type.</p>
|
|
@@ -2677,6 +2912,7 @@ export interface PatchFilter {
|
|
|
2677
2912
|
*/
|
|
2678
2913
|
export interface PatchFilterGroup {
|
|
2679
2914
|
/**
|
|
2915
|
+
* @public
|
|
2680
2916
|
* <p>The set of patch filters that make up the group.</p>
|
|
2681
2917
|
*/
|
|
2682
2918
|
PatchFilters: PatchFilter[] | undefined;
|
|
@@ -2687,14 +2923,17 @@ export interface PatchFilterGroup {
|
|
|
2687
2923
|
*/
|
|
2688
2924
|
export interface PatchRule {
|
|
2689
2925
|
/**
|
|
2926
|
+
* @public
|
|
2690
2927
|
* <p>The patch filter group that defines the criteria for the rule.</p>
|
|
2691
2928
|
*/
|
|
2692
2929
|
PatchFilterGroup: PatchFilterGroup | undefined;
|
|
2693
2930
|
/**
|
|
2931
|
+
* @public
|
|
2694
2932
|
* <p>A compliance severity level for all approved patches in a patch baseline.</p>
|
|
2695
2933
|
*/
|
|
2696
2934
|
ComplianceLevel?: PatchComplianceLevel | string;
|
|
2697
2935
|
/**
|
|
2936
|
+
* @public
|
|
2698
2937
|
* <p>The number of days after the release date of each patch matched by the rule that the patch
|
|
2699
2938
|
* is marked as approved in the patch baseline. For example, a value of <code>7</code> means that
|
|
2700
2939
|
* patches are approved seven days after they are released. Not supported on Debian Server or Ubuntu
|
|
@@ -2702,6 +2941,7 @@ export interface PatchRule {
|
|
|
2702
2941
|
*/
|
|
2703
2942
|
ApproveAfterDays?: number;
|
|
2704
2943
|
/**
|
|
2944
|
+
* @public
|
|
2705
2945
|
* <p>The cutoff date for auto approval of released patches. Any patches released on or before
|
|
2706
2946
|
* this date are installed automatically. Not supported on Debian Server or Ubuntu Server.</p>
|
|
2707
2947
|
* <p>Enter dates in the format <code>YYYY-MM-DD</code>. For example,
|
|
@@ -2709,6 +2949,7 @@ export interface PatchRule {
|
|
|
2709
2949
|
*/
|
|
2710
2950
|
ApproveUntilDate?: string;
|
|
2711
2951
|
/**
|
|
2952
|
+
* @public
|
|
2712
2953
|
* <p>For managed nodes identified by the approval rule filters, enables a patch baseline to apply
|
|
2713
2954
|
* non-security updates available in the specified repository. The default value is
|
|
2714
2955
|
* <code>false</code>. Applies to Linux managed nodes only.</p>
|
|
@@ -2721,6 +2962,7 @@ export interface PatchRule {
|
|
|
2721
2962
|
*/
|
|
2722
2963
|
export interface PatchRuleGroup {
|
|
2723
2964
|
/**
|
|
2965
|
+
* @public
|
|
2724
2966
|
* <p>The rules that make up the rule group.</p>
|
|
2725
2967
|
*/
|
|
2726
2968
|
PatchRules: PatchRule[] | undefined;
|
|
@@ -2769,16 +3011,19 @@ export type PatchAction = (typeof PatchAction)[keyof typeof PatchAction];
|
|
|
2769
3011
|
*/
|
|
2770
3012
|
export interface PatchSource {
|
|
2771
3013
|
/**
|
|
3014
|
+
* @public
|
|
2772
3015
|
* <p>The name specified to identify the patch source.</p>
|
|
2773
3016
|
*/
|
|
2774
3017
|
Name: string | undefined;
|
|
2775
3018
|
/**
|
|
3019
|
+
* @public
|
|
2776
3020
|
* <p>The specific operating system versions a patch repository applies to, such as "Ubuntu16.04",
|
|
2777
3021
|
* "AmazonLinux2016.09", "RedhatEnterpriseLinux7.2" or "Suse12.7". For lists of supported product
|
|
2778
3022
|
* values, see <a>PatchFilter</a>.</p>
|
|
2779
3023
|
*/
|
|
2780
3024
|
Products: string[] | undefined;
|
|
2781
3025
|
/**
|
|
3026
|
+
* @public
|
|
2782
3027
|
* <p>The value of the yum repo configuration. For example:</p>
|
|
2783
3028
|
* <p>
|
|
2784
3029
|
* <code>[main]</code>
|
|
@@ -2804,23 +3049,28 @@ export interface PatchSource {
|
|
|
2804
3049
|
*/
|
|
2805
3050
|
export interface CreatePatchBaselineRequest {
|
|
2806
3051
|
/**
|
|
3052
|
+
* @public
|
|
2807
3053
|
* <p>Defines the operating system the patch baseline applies to. The default value is
|
|
2808
3054
|
* <code>WINDOWS</code>.</p>
|
|
2809
3055
|
*/
|
|
2810
3056
|
OperatingSystem?: OperatingSystem | string;
|
|
2811
3057
|
/**
|
|
3058
|
+
* @public
|
|
2812
3059
|
* <p>The name of the patch baseline.</p>
|
|
2813
3060
|
*/
|
|
2814
3061
|
Name: string | undefined;
|
|
2815
3062
|
/**
|
|
3063
|
+
* @public
|
|
2816
3064
|
* <p>A set of global filters used to include patches in the baseline.</p>
|
|
2817
3065
|
*/
|
|
2818
3066
|
GlobalFilters?: PatchFilterGroup;
|
|
2819
3067
|
/**
|
|
3068
|
+
* @public
|
|
2820
3069
|
* <p>A set of rules used to include patches in the baseline.</p>
|
|
2821
3070
|
*/
|
|
2822
3071
|
ApprovalRules?: PatchRuleGroup;
|
|
2823
3072
|
/**
|
|
3073
|
+
* @public
|
|
2824
3074
|
* <p>A list of explicitly approved patches for the baseline.</p>
|
|
2825
3075
|
* <p>For information about accepted formats for lists of approved patches and rejected patches,
|
|
2826
3076
|
* see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html">About
|
|
@@ -2828,18 +3078,21 @@ export interface CreatePatchBaselineRequest {
|
|
|
2828
3078
|
*/
|
|
2829
3079
|
ApprovedPatches?: string[];
|
|
2830
3080
|
/**
|
|
3081
|
+
* @public
|
|
2831
3082
|
* <p>Defines the compliance level for approved patches. When an approved patch is reported as
|
|
2832
3083
|
* missing, this value describes the severity of the compliance violation. The default value is
|
|
2833
3084
|
* <code>UNSPECIFIED</code>.</p>
|
|
2834
3085
|
*/
|
|
2835
3086
|
ApprovedPatchesComplianceLevel?: PatchComplianceLevel | string;
|
|
2836
3087
|
/**
|
|
3088
|
+
* @public
|
|
2837
3089
|
* <p>Indicates whether the list of approved patches includes non-security updates that should be
|
|
2838
3090
|
* applied to the managed nodes. The default value is <code>false</code>. Applies to Linux managed
|
|
2839
3091
|
* nodes only.</p>
|
|
2840
3092
|
*/
|
|
2841
3093
|
ApprovedPatchesEnableNonSecurity?: boolean;
|
|
2842
3094
|
/**
|
|
3095
|
+
* @public
|
|
2843
3096
|
* <p>A list of explicitly rejected patches for the baseline.</p>
|
|
2844
3097
|
* <p>For information about accepted formats for lists of approved patches and rejected patches,
|
|
2845
3098
|
* see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html">About
|
|
@@ -2847,6 +3100,7 @@ export interface CreatePatchBaselineRequest {
|
|
|
2847
3100
|
*/
|
|
2848
3101
|
RejectedPatches?: string[];
|
|
2849
3102
|
/**
|
|
3103
|
+
* @public
|
|
2850
3104
|
* <p>The action for Patch Manager to take on patches included in the
|
|
2851
3105
|
* <code>RejectedPackages</code> list.</p>
|
|
2852
3106
|
* <ul>
|
|
@@ -2873,19 +3127,23 @@ export interface CreatePatchBaselineRequest {
|
|
|
2873
3127
|
*/
|
|
2874
3128
|
RejectedPatchesAction?: PatchAction | string;
|
|
2875
3129
|
/**
|
|
3130
|
+
* @public
|
|
2876
3131
|
* <p>A description of the patch baseline.</p>
|
|
2877
3132
|
*/
|
|
2878
3133
|
Description?: string;
|
|
2879
3134
|
/**
|
|
3135
|
+
* @public
|
|
2880
3136
|
* <p>Information about the patches to use to update the managed nodes, including target operating
|
|
2881
3137
|
* systems and source repositories. Applies to Linux managed nodes only.</p>
|
|
2882
3138
|
*/
|
|
2883
3139
|
Sources?: PatchSource[];
|
|
2884
3140
|
/**
|
|
3141
|
+
* @public
|
|
2885
3142
|
* <p>User-provided idempotency token.</p>
|
|
2886
3143
|
*/
|
|
2887
3144
|
ClientToken?: string;
|
|
2888
3145
|
/**
|
|
3146
|
+
* @public
|
|
2889
3147
|
* <p>Optional metadata that you assign to a resource. Tags enable you to categorize a resource in
|
|
2890
3148
|
* different ways, such as by purpose, owner, or environment. For example, you might want to tag a
|
|
2891
3149
|
* patch baseline to identify the severity level of patches it specifies and the operating system
|
|
@@ -2914,6 +3172,7 @@ export interface CreatePatchBaselineRequest {
|
|
|
2914
3172
|
*/
|
|
2915
3173
|
export interface CreatePatchBaselineResult {
|
|
2916
3174
|
/**
|
|
3175
|
+
* @public
|
|
2917
3176
|
* <p>The ID of the created patch baseline.</p>
|
|
2918
3177
|
*/
|
|
2919
3178
|
BaselineId?: string;
|
|
@@ -2926,6 +3185,7 @@ export interface CreatePatchBaselineResult {
|
|
|
2926
3185
|
*/
|
|
2927
3186
|
export interface ResourceDataSyncDestinationDataSharing {
|
|
2928
3187
|
/**
|
|
3188
|
+
* @public
|
|
2929
3189
|
* <p>The sharing data type. Only <code>Organization</code> is supported.</p>
|
|
2930
3190
|
*/
|
|
2931
3191
|
DestinationDataSharingType?: string;
|
|
@@ -2947,27 +3207,33 @@ export type ResourceDataSyncS3Format = (typeof ResourceDataSyncS3Format)[keyof t
|
|
|
2947
3207
|
*/
|
|
2948
3208
|
export interface ResourceDataSyncS3Destination {
|
|
2949
3209
|
/**
|
|
3210
|
+
* @public
|
|
2950
3211
|
* <p>The name of the S3 bucket where the aggregated data is stored.</p>
|
|
2951
3212
|
*/
|
|
2952
3213
|
BucketName: string | undefined;
|
|
2953
3214
|
/**
|
|
3215
|
+
* @public
|
|
2954
3216
|
* <p>An Amazon S3 prefix for the bucket.</p>
|
|
2955
3217
|
*/
|
|
2956
3218
|
Prefix?: string;
|
|
2957
3219
|
/**
|
|
3220
|
+
* @public
|
|
2958
3221
|
* <p>A supported sync format. The following format is currently supported: JsonSerDe</p>
|
|
2959
3222
|
*/
|
|
2960
3223
|
SyncFormat: ResourceDataSyncS3Format | string | undefined;
|
|
2961
3224
|
/**
|
|
3225
|
+
* @public
|
|
2962
3226
|
* <p>The Amazon Web Services Region with the S3 bucket targeted by the resource data sync.</p>
|
|
2963
3227
|
*/
|
|
2964
3228
|
Region: string | undefined;
|
|
2965
3229
|
/**
|
|
3230
|
+
* @public
|
|
2966
3231
|
* <p>The ARN of an encryption key for a destination in Amazon S3. Must belong to the same
|
|
2967
3232
|
* Region as the destination S3 bucket.</p>
|
|
2968
3233
|
*/
|
|
2969
3234
|
AWSKMSKeyARN?: string;
|
|
2970
3235
|
/**
|
|
3236
|
+
* @public
|
|
2971
3237
|
* <p>Enables destination data sharing. By default, this field is <code>null</code>.</p>
|
|
2972
3238
|
*/
|
|
2973
3239
|
DestinationDataSharing?: ResourceDataSyncDestinationDataSharing;
|
|
@@ -2978,6 +3244,7 @@ export interface ResourceDataSyncS3Destination {
|
|
|
2978
3244
|
*/
|
|
2979
3245
|
export interface ResourceDataSyncOrganizationalUnit {
|
|
2980
3246
|
/**
|
|
3247
|
+
* @public
|
|
2981
3248
|
* <p>The Organizations unit ID data source for the sync.</p>
|
|
2982
3249
|
*/
|
|
2983
3250
|
OrganizationalUnitId?: string;
|
|
@@ -2990,6 +3257,7 @@ export interface ResourceDataSyncOrganizationalUnit {
|
|
|
2990
3257
|
*/
|
|
2991
3258
|
export interface ResourceDataSyncAwsOrganizationsSource {
|
|
2992
3259
|
/**
|
|
3260
|
+
* @public
|
|
2993
3261
|
* <p>If an Amazon Web Services organization is present, this is either <code>OrganizationalUnits</code> or
|
|
2994
3262
|
* <code>EntireOrganization</code>. For <code>OrganizationalUnits</code>, the data is aggregated
|
|
2995
3263
|
* from a set of organization units. For <code>EntireOrganization</code>, the data is aggregated
|
|
@@ -2997,6 +3265,7 @@ export interface ResourceDataSyncAwsOrganizationsSource {
|
|
|
2997
3265
|
*/
|
|
2998
3266
|
OrganizationSourceType: string | undefined;
|
|
2999
3267
|
/**
|
|
3268
|
+
* @public
|
|
3000
3269
|
* <p>The Organizations organization units included in the sync.</p>
|
|
3001
3270
|
*/
|
|
3002
3271
|
OrganizationalUnits?: ResourceDataSyncOrganizationalUnit[];
|
|
@@ -3007,26 +3276,31 @@ export interface ResourceDataSyncAwsOrganizationsSource {
|
|
|
3007
3276
|
*/
|
|
3008
3277
|
export interface ResourceDataSyncSource {
|
|
3009
3278
|
/**
|
|
3279
|
+
* @public
|
|
3010
3280
|
* <p>The type of data source for the resource data sync. <code>SourceType</code> is either
|
|
3011
3281
|
* <code>AwsOrganizations</code> (if an organization is present in Organizations) or
|
|
3012
3282
|
* <code>SingleAccountMultiRegions</code>.</p>
|
|
3013
3283
|
*/
|
|
3014
3284
|
SourceType: string | undefined;
|
|
3015
3285
|
/**
|
|
3286
|
+
* @public
|
|
3016
3287
|
* <p>Information about the <code>AwsOrganizationsSource</code> resource data sync source. A sync
|
|
3017
3288
|
* source of this type can synchronize data from Organizations.</p>
|
|
3018
3289
|
*/
|
|
3019
3290
|
AwsOrganizationsSource?: ResourceDataSyncAwsOrganizationsSource;
|
|
3020
3291
|
/**
|
|
3292
|
+
* @public
|
|
3021
3293
|
* <p>The <code>SyncSource</code> Amazon Web Services Regions included in the resource data sync.</p>
|
|
3022
3294
|
*/
|
|
3023
3295
|
SourceRegions: string[] | undefined;
|
|
3024
3296
|
/**
|
|
3297
|
+
* @public
|
|
3025
3298
|
* <p>Whether to automatically synchronize and aggregate data from new Amazon Web Services Regions when those
|
|
3026
3299
|
* Regions come online.</p>
|
|
3027
3300
|
*/
|
|
3028
3301
|
IncludeFutureRegions?: boolean;
|
|
3029
3302
|
/**
|
|
3303
|
+
* @public
|
|
3030
3304
|
* <p>When you create a resource data sync, if you choose one of the Organizations options, then Systems Manager
|
|
3031
3305
|
* automatically enables all OpsData sources in the selected Amazon Web Services Regions for all Amazon Web Services accounts in
|
|
3032
3306
|
* your organization (or in the selected organization units). For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resouce-data-sync-multiple-accounts-and-regions.html">About multiple account and Region resource data syncs</a> in the
|
|
@@ -3039,15 +3313,18 @@ export interface ResourceDataSyncSource {
|
|
|
3039
3313
|
*/
|
|
3040
3314
|
export interface CreateResourceDataSyncRequest {
|
|
3041
3315
|
/**
|
|
3316
|
+
* @public
|
|
3042
3317
|
* <p>A name for the configuration.</p>
|
|
3043
3318
|
*/
|
|
3044
3319
|
SyncName: string | undefined;
|
|
3045
3320
|
/**
|
|
3321
|
+
* @public
|
|
3046
3322
|
* <p>Amazon S3 configuration details for the sync. This parameter is required if the
|
|
3047
3323
|
* <code>SyncType</code> value is SyncToDestination.</p>
|
|
3048
3324
|
*/
|
|
3049
3325
|
S3Destination?: ResourceDataSyncS3Destination;
|
|
3050
3326
|
/**
|
|
3327
|
+
* @public
|
|
3051
3328
|
* <p>Specify <code>SyncToDestination</code> to create a resource data sync that synchronizes data
|
|
3052
3329
|
* to an S3 bucket for Inventory. If you specify <code>SyncToDestination</code>, you must provide a
|
|
3053
3330
|
* value for <code>S3Destination</code>. Specify <code>SyncFromSource</code> to synchronize data
|
|
@@ -3057,6 +3334,7 @@ export interface CreateResourceDataSyncRequest {
|
|
|
3057
3334
|
*/
|
|
3058
3335
|
SyncType?: string;
|
|
3059
3336
|
/**
|
|
3337
|
+
* @public
|
|
3060
3338
|
* <p>Specify information about the data sources to synchronize. This parameter is required if the
|
|
3061
3339
|
* <code>SyncType</code> value is SyncFromSource.</p>
|
|
3062
3340
|
*/
|
|
@@ -3111,6 +3389,7 @@ export declare class ResourceDataSyncInvalidConfigurationException extends __Bas
|
|
|
3111
3389
|
*/
|
|
3112
3390
|
export interface DeleteActivationRequest {
|
|
3113
3391
|
/**
|
|
3392
|
+
* @public
|
|
3114
3393
|
* <p>The ID of the activation that you want to delete.</p>
|
|
3115
3394
|
*/
|
|
3116
3395
|
ActivationId: string | undefined;
|
|
@@ -3166,10 +3445,12 @@ export declare class AssociationDoesNotExist extends __BaseException {
|
|
|
3166
3445
|
*/
|
|
3167
3446
|
export interface DeleteAssociationRequest {
|
|
3168
3447
|
/**
|
|
3448
|
+
* @public
|
|
3169
3449
|
* <p>The name of the SSM document.</p>
|
|
3170
3450
|
*/
|
|
3171
3451
|
Name?: string;
|
|
3172
3452
|
/**
|
|
3453
|
+
* @public
|
|
3173
3454
|
* <p>The managed node ID.</p>
|
|
3174
3455
|
* <note>
|
|
3175
3456
|
* <p>
|
|
@@ -3185,6 +3466,7 @@ export interface DeleteAssociationRequest {
|
|
|
3185
3466
|
*/
|
|
3186
3467
|
InstanceId?: string;
|
|
3187
3468
|
/**
|
|
3469
|
+
* @public
|
|
3188
3470
|
* <p>The association ID that you want to delete.</p>
|
|
3189
3471
|
*/
|
|
3190
3472
|
AssociationId?: string;
|
|
@@ -3211,20 +3493,24 @@ export declare class AssociatedInstances extends __BaseException {
|
|
|
3211
3493
|
*/
|
|
3212
3494
|
export interface DeleteDocumentRequest {
|
|
3213
3495
|
/**
|
|
3496
|
+
* @public
|
|
3214
3497
|
* <p>The name of the document.</p>
|
|
3215
3498
|
*/
|
|
3216
3499
|
Name: string | undefined;
|
|
3217
3500
|
/**
|
|
3501
|
+
* @public
|
|
3218
3502
|
* <p>The version of the document that you want to delete. If not provided, all versions of the
|
|
3219
3503
|
* document are deleted.</p>
|
|
3220
3504
|
*/
|
|
3221
3505
|
DocumentVersion?: string;
|
|
3222
3506
|
/**
|
|
3507
|
+
* @public
|
|
3223
3508
|
* <p>The version name of the document that you want to delete. If not provided, all versions of
|
|
3224
3509
|
* the document are deleted.</p>
|
|
3225
3510
|
*/
|
|
3226
3511
|
VersionName?: string;
|
|
3227
3512
|
/**
|
|
3513
|
+
* @public
|
|
3228
3514
|
* <p>Some SSM document types require that you specify a <code>Force</code> flag before you can
|
|
3229
3515
|
* delete the document. For example, you must specify a <code>Force</code> flag to delete a document
|
|
3230
3516
|
* of type <code>ApplicationConfigurationSchema</code>. You can restrict access to the
|
|
@@ -3268,11 +3554,13 @@ export type InventorySchemaDeleteOption = (typeof InventorySchemaDeleteOption)[k
|
|
|
3268
3554
|
*/
|
|
3269
3555
|
export interface DeleteInventoryRequest {
|
|
3270
3556
|
/**
|
|
3557
|
+
* @public
|
|
3271
3558
|
* <p>The name of the custom inventory type for which you want to delete either all previously
|
|
3272
3559
|
* collected data or the inventory type itself. </p>
|
|
3273
3560
|
*/
|
|
3274
3561
|
TypeName: string | undefined;
|
|
3275
3562
|
/**
|
|
3563
|
+
* @public
|
|
3276
3564
|
* <p>Use the <code>SchemaDeleteOption</code> to delete a custom inventory type (schema). If you
|
|
3277
3565
|
* don't choose this option, the system only deletes existing inventory data associated with the
|
|
3278
3566
|
* custom inventory type. Choose one of the following options:</p>
|
|
@@ -3284,6 +3572,7 @@ export interface DeleteInventoryRequest {
|
|
|
3284
3572
|
*/
|
|
3285
3573
|
SchemaDeleteOption?: InventorySchemaDeleteOption | string;
|
|
3286
3574
|
/**
|
|
3575
|
+
* @public
|
|
3287
3576
|
* <p>Use this option to view a summary of the deletion request without deleting any data or the
|
|
3288
3577
|
* data type. This option is useful when you only want to understand what will be deleted. Once you
|
|
3289
3578
|
* validate that the data to be deleted is what you intend to delete, you can run the same command
|
|
@@ -3291,6 +3580,7 @@ export interface DeleteInventoryRequest {
|
|
|
3291
3580
|
*/
|
|
3292
3581
|
DryRun?: boolean;
|
|
3293
3582
|
/**
|
|
3583
|
+
* @public
|
|
3294
3584
|
* <p>User-provided idempotency token.</p>
|
|
3295
3585
|
*/
|
|
3296
3586
|
ClientToken?: string;
|
|
@@ -3301,14 +3591,17 @@ export interface DeleteInventoryRequest {
|
|
|
3301
3591
|
*/
|
|
3302
3592
|
export interface InventoryDeletionSummaryItem {
|
|
3303
3593
|
/**
|
|
3594
|
+
* @public
|
|
3304
3595
|
* <p>The inventory type version.</p>
|
|
3305
3596
|
*/
|
|
3306
3597
|
Version?: string;
|
|
3307
3598
|
/**
|
|
3599
|
+
* @public
|
|
3308
3600
|
* <p>A count of the number of deleted items.</p>
|
|
3309
3601
|
*/
|
|
3310
3602
|
Count?: number;
|
|
3311
3603
|
/**
|
|
3604
|
+
* @public
|
|
3312
3605
|
* <p>The remaining number of items to delete.</p>
|
|
3313
3606
|
*/
|
|
3314
3607
|
RemainingCount?: number;
|
|
@@ -3319,15 +3612,18 @@ export interface InventoryDeletionSummaryItem {
|
|
|
3319
3612
|
*/
|
|
3320
3613
|
export interface InventoryDeletionSummary {
|
|
3321
3614
|
/**
|
|
3615
|
+
* @public
|
|
3322
3616
|
* <p>The total number of items to delete. This count doesn't change during the delete
|
|
3323
3617
|
* operation.</p>
|
|
3324
3618
|
*/
|
|
3325
3619
|
TotalCount?: number;
|
|
3326
3620
|
/**
|
|
3621
|
+
* @public
|
|
3327
3622
|
* <p>Remaining number of items to delete.</p>
|
|
3328
3623
|
*/
|
|
3329
3624
|
RemainingCount?: number;
|
|
3330
3625
|
/**
|
|
3626
|
+
* @public
|
|
3331
3627
|
* <p>A list of counts and versions for deleted items.</p>
|
|
3332
3628
|
*/
|
|
3333
3629
|
SummaryItems?: InventoryDeletionSummaryItem[];
|
|
@@ -3337,16 +3633,19 @@ export interface InventoryDeletionSummary {
|
|
|
3337
3633
|
*/
|
|
3338
3634
|
export interface DeleteInventoryResult {
|
|
3339
3635
|
/**
|
|
3636
|
+
* @public
|
|
3340
3637
|
* <p>Every <code>DeleteInventory</code> operation is assigned a unique ID. This option returns a
|
|
3341
3638
|
* unique ID. You can use this ID to query the status of a delete operation. This option is useful
|
|
3342
3639
|
* for ensuring that a delete operation has completed before you begin other operations. </p>
|
|
3343
3640
|
*/
|
|
3344
3641
|
DeletionId?: string;
|
|
3345
3642
|
/**
|
|
3643
|
+
* @public
|
|
3346
3644
|
* <p>The name of the inventory data type specified in the request.</p>
|
|
3347
3645
|
*/
|
|
3348
3646
|
TypeName?: string;
|
|
3349
3647
|
/**
|
|
3648
|
+
* @public
|
|
3350
3649
|
* <p>A summary of the delete operation. For more information about this summary, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-custom.html#sysman-inventory-delete-summary">Deleting custom inventory</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
3351
3650
|
*/
|
|
3352
3651
|
DeletionSummary?: InventoryDeletionSummary;
|
|
@@ -3409,6 +3708,7 @@ export declare class InvalidTypeNameException extends __BaseException {
|
|
|
3409
3708
|
*/
|
|
3410
3709
|
export interface DeleteMaintenanceWindowRequest {
|
|
3411
3710
|
/**
|
|
3711
|
+
* @public
|
|
3412
3712
|
* <p>The ID of the maintenance window to delete.</p>
|
|
3413
3713
|
*/
|
|
3414
3714
|
WindowId: string | undefined;
|
|
@@ -3418,6 +3718,7 @@ export interface DeleteMaintenanceWindowRequest {
|
|
|
3418
3718
|
*/
|
|
3419
3719
|
export interface DeleteMaintenanceWindowResult {
|
|
3420
3720
|
/**
|
|
3721
|
+
* @public
|
|
3421
3722
|
* <p>The ID of the deleted maintenance window.</p>
|
|
3422
3723
|
*/
|
|
3423
3724
|
WindowId?: string;
|
|
@@ -3427,6 +3728,7 @@ export interface DeleteMaintenanceWindowResult {
|
|
|
3427
3728
|
*/
|
|
3428
3729
|
export interface DeleteOpsMetadataRequest {
|
|
3429
3730
|
/**
|
|
3731
|
+
* @public
|
|
3430
3732
|
* <p>The Amazon Resource Name (ARN) of an OpsMetadata Object to delete.</p>
|
|
3431
3733
|
*/
|
|
3432
3734
|
OpsMetadataArn: string | undefined;
|
|
@@ -3453,6 +3755,7 @@ export declare class OpsMetadataNotFoundException extends __BaseException {
|
|
|
3453
3755
|
*/
|
|
3454
3756
|
export interface DeleteParameterRequest {
|
|
3455
3757
|
/**
|
|
3758
|
+
* @public
|
|
3456
3759
|
* <p>The name of the parameter to delete.</p>
|
|
3457
3760
|
*/
|
|
3458
3761
|
Name: string | undefined;
|
|
@@ -3479,6 +3782,7 @@ export declare class ParameterNotFound extends __BaseException {
|
|
|
3479
3782
|
*/
|
|
3480
3783
|
export interface DeleteParametersRequest {
|
|
3481
3784
|
/**
|
|
3785
|
+
* @public
|
|
3482
3786
|
* <p>The names of the parameters to delete. After deleting a parameter, wait for at least 30
|
|
3483
3787
|
* seconds to create a parameter with the same name.</p>
|
|
3484
3788
|
*/
|
|
@@ -3489,10 +3793,12 @@ export interface DeleteParametersRequest {
|
|
|
3489
3793
|
*/
|
|
3490
3794
|
export interface DeleteParametersResult {
|
|
3491
3795
|
/**
|
|
3796
|
+
* @public
|
|
3492
3797
|
* <p>The names of the deleted parameters.</p>
|
|
3493
3798
|
*/
|
|
3494
3799
|
DeletedParameters?: string[];
|
|
3495
3800
|
/**
|
|
3801
|
+
* @public
|
|
3496
3802
|
* <p>The names of parameters that weren't deleted because the parameters aren't valid.</p>
|
|
3497
3803
|
*/
|
|
3498
3804
|
InvalidParameters?: string[];
|
|
@@ -3502,6 +3808,7 @@ export interface DeleteParametersResult {
|
|
|
3502
3808
|
*/
|
|
3503
3809
|
export interface DeletePatchBaselineRequest {
|
|
3504
3810
|
/**
|
|
3811
|
+
* @public
|
|
3505
3812
|
* <p>The ID of the patch baseline to delete.</p>
|
|
3506
3813
|
*/
|
|
3507
3814
|
BaselineId: string | undefined;
|
|
@@ -3511,6 +3818,7 @@ export interface DeletePatchBaselineRequest {
|
|
|
3511
3818
|
*/
|
|
3512
3819
|
export interface DeletePatchBaselineResult {
|
|
3513
3820
|
/**
|
|
3821
|
+
* @public
|
|
3514
3822
|
* <p>The ID of the deleted patch baseline.</p>
|
|
3515
3823
|
*/
|
|
3516
3824
|
BaselineId?: string;
|
|
@@ -3534,10 +3842,12 @@ export declare class ResourceInUseException extends __BaseException {
|
|
|
3534
3842
|
*/
|
|
3535
3843
|
export interface DeleteResourceDataSyncRequest {
|
|
3536
3844
|
/**
|
|
3845
|
+
* @public
|
|
3537
3846
|
* <p>The name of the configuration to delete.</p>
|
|
3538
3847
|
*/
|
|
3539
3848
|
SyncName: string | undefined;
|
|
3540
3849
|
/**
|
|
3850
|
+
* @public
|
|
3541
3851
|
* <p>Specify the type of resource data sync to delete.</p>
|
|
3542
3852
|
*/
|
|
3543
3853
|
SyncType?: string;
|
|
@@ -3567,14 +3877,17 @@ export declare class ResourceDataSyncNotFoundException extends __BaseException {
|
|
|
3567
3877
|
*/
|
|
3568
3878
|
export interface DeleteResourcePolicyRequest {
|
|
3569
3879
|
/**
|
|
3880
|
+
* @public
|
|
3570
3881
|
* <p>Amazon Resource Name (ARN) of the resource to which the policies are attached.</p>
|
|
3571
3882
|
*/
|
|
3572
3883
|
ResourceArn: string | undefined;
|
|
3573
3884
|
/**
|
|
3885
|
+
* @public
|
|
3574
3886
|
* <p>The policy ID.</p>
|
|
3575
3887
|
*/
|
|
3576
3888
|
PolicyId: string | undefined;
|
|
3577
3889
|
/**
|
|
3890
|
+
* @public
|
|
3578
3891
|
* <p>ID of the current policy version. The hash helps to prevent multiple calls from attempting
|
|
3579
3892
|
* to overwrite a policy.</p>
|
|
3580
3893
|
*/
|
|
@@ -3620,6 +3933,7 @@ export declare class ResourcePolicyInvalidParameterException extends __BaseExcep
|
|
|
3620
3933
|
*/
|
|
3621
3934
|
export interface DeregisterManagedInstanceRequest {
|
|
3622
3935
|
/**
|
|
3936
|
+
* @public
|
|
3623
3937
|
* <p>The ID assigned to the managed node when you registered it using the activation process.
|
|
3624
3938
|
* </p>
|
|
3625
3939
|
*/
|
|
@@ -3635,10 +3949,12 @@ export interface DeregisterManagedInstanceResult {
|
|
|
3635
3949
|
*/
|
|
3636
3950
|
export interface DeregisterPatchBaselineForPatchGroupRequest {
|
|
3637
3951
|
/**
|
|
3952
|
+
* @public
|
|
3638
3953
|
* <p>The ID of the patch baseline to deregister the patch group from.</p>
|
|
3639
3954
|
*/
|
|
3640
3955
|
BaselineId: string | undefined;
|
|
3641
3956
|
/**
|
|
3957
|
+
* @public
|
|
3642
3958
|
* <p>The name of the patch group that should be deregistered from the patch baseline.</p>
|
|
3643
3959
|
*/
|
|
3644
3960
|
PatchGroup: string | undefined;
|
|
@@ -3648,10 +3964,12 @@ export interface DeregisterPatchBaselineForPatchGroupRequest {
|
|
|
3648
3964
|
*/
|
|
3649
3965
|
export interface DeregisterPatchBaselineForPatchGroupResult {
|
|
3650
3966
|
/**
|
|
3967
|
+
* @public
|
|
3651
3968
|
* <p>The ID of the patch baseline the patch group was deregistered from.</p>
|
|
3652
3969
|
*/
|
|
3653
3970
|
BaselineId?: string;
|
|
3654
3971
|
/**
|
|
3972
|
+
* @public
|
|
3655
3973
|
* <p>The name of the patch group deregistered from the patch baseline.</p>
|
|
3656
3974
|
*/
|
|
3657
3975
|
PatchGroup?: string;
|
|
@@ -3661,14 +3979,17 @@ export interface DeregisterPatchBaselineForPatchGroupResult {
|
|
|
3661
3979
|
*/
|
|
3662
3980
|
export interface DeregisterTargetFromMaintenanceWindowRequest {
|
|
3663
3981
|
/**
|
|
3982
|
+
* @public
|
|
3664
3983
|
* <p>The ID of the maintenance window the target should be removed from.</p>
|
|
3665
3984
|
*/
|
|
3666
3985
|
WindowId: string | undefined;
|
|
3667
3986
|
/**
|
|
3987
|
+
* @public
|
|
3668
3988
|
* <p>The ID of the target definition to remove.</p>
|
|
3669
3989
|
*/
|
|
3670
3990
|
WindowTargetId: string | undefined;
|
|
3671
3991
|
/**
|
|
3992
|
+
* @public
|
|
3672
3993
|
* <p>The system checks if the target is being referenced by a task. If the target is being
|
|
3673
3994
|
* referenced, the system returns an error and doesn't deregister the target from the maintenance
|
|
3674
3995
|
* window.</p>
|
|
@@ -3680,10 +4001,12 @@ export interface DeregisterTargetFromMaintenanceWindowRequest {
|
|
|
3680
4001
|
*/
|
|
3681
4002
|
export interface DeregisterTargetFromMaintenanceWindowResult {
|
|
3682
4003
|
/**
|
|
4004
|
+
* @public
|
|
3683
4005
|
* <p>The ID of the maintenance window the target was removed from.</p>
|
|
3684
4006
|
*/
|
|
3685
4007
|
WindowId?: string;
|
|
3686
4008
|
/**
|
|
4009
|
+
* @public
|
|
3687
4010
|
* <p>The ID of the removed target definition.</p>
|
|
3688
4011
|
*/
|
|
3689
4012
|
WindowTargetId?: string;
|
|
@@ -3707,10 +4030,12 @@ export declare class TargetInUseException extends __BaseException {
|
|
|
3707
4030
|
*/
|
|
3708
4031
|
export interface DeregisterTaskFromMaintenanceWindowRequest {
|
|
3709
4032
|
/**
|
|
4033
|
+
* @public
|
|
3710
4034
|
* <p>The ID of the maintenance window the task should be removed from.</p>
|
|
3711
4035
|
*/
|
|
3712
4036
|
WindowId: string | undefined;
|
|
3713
4037
|
/**
|
|
4038
|
+
* @public
|
|
3714
4039
|
* <p>The ID of the task to remove from the maintenance window.</p>
|
|
3715
4040
|
*/
|
|
3716
4041
|
WindowTaskId: string | undefined;
|
|
@@ -3720,10 +4045,12 @@ export interface DeregisterTaskFromMaintenanceWindowRequest {
|
|
|
3720
4045
|
*/
|
|
3721
4046
|
export interface DeregisterTaskFromMaintenanceWindowResult {
|
|
3722
4047
|
/**
|
|
4048
|
+
* @public
|
|
3723
4049
|
* <p>The ID of the maintenance window the task was removed from.</p>
|
|
3724
4050
|
*/
|
|
3725
4051
|
WindowId?: string;
|
|
3726
4052
|
/**
|
|
4053
|
+
* @public
|
|
3727
4054
|
* <p>The ID of the task removed from the maintenance window.</p>
|
|
3728
4055
|
*/
|
|
3729
4056
|
WindowTaskId?: string;
|
|
@@ -3747,10 +4074,12 @@ export type DescribeActivationsFilterKeys = (typeof DescribeActivationsFilterKey
|
|
|
3747
4074
|
*/
|
|
3748
4075
|
export interface DescribeActivationsFilter {
|
|
3749
4076
|
/**
|
|
4077
|
+
* @public
|
|
3750
4078
|
* <p>The name of the filter.</p>
|
|
3751
4079
|
*/
|
|
3752
4080
|
FilterKey?: DescribeActivationsFilterKeys | string;
|
|
3753
4081
|
/**
|
|
4082
|
+
* @public
|
|
3754
4083
|
* <p>The filter values.</p>
|
|
3755
4084
|
*/
|
|
3756
4085
|
FilterValues?: string[];
|
|
@@ -3760,15 +4089,18 @@ export interface DescribeActivationsFilter {
|
|
|
3760
4089
|
*/
|
|
3761
4090
|
export interface DescribeActivationsRequest {
|
|
3762
4091
|
/**
|
|
4092
|
+
* @public
|
|
3763
4093
|
* <p>A filter to view information about your activations.</p>
|
|
3764
4094
|
*/
|
|
3765
4095
|
Filters?: DescribeActivationsFilter[];
|
|
3766
4096
|
/**
|
|
4097
|
+
* @public
|
|
3767
4098
|
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
3768
4099
|
* can specify in a subsequent call to get the next set of results.</p>
|
|
3769
4100
|
*/
|
|
3770
4101
|
MaxResults?: number;
|
|
3771
4102
|
/**
|
|
4103
|
+
* @public
|
|
3772
4104
|
* <p>A token to start the list. Use this token to get the next set of results. </p>
|
|
3773
4105
|
*/
|
|
3774
4106
|
NextToken?: string;
|
|
@@ -3778,10 +4110,12 @@ export interface DescribeActivationsRequest {
|
|
|
3778
4110
|
*/
|
|
3779
4111
|
export interface DescribeActivationsResult {
|
|
3780
4112
|
/**
|
|
4113
|
+
* @public
|
|
3781
4114
|
* <p>A list of activations for your Amazon Web Services account.</p>
|
|
3782
4115
|
*/
|
|
3783
4116
|
ActivationList?: Activation[];
|
|
3784
4117
|
/**
|
|
4118
|
+
* @public
|
|
3785
4119
|
* <p>The token for the next set of items to return. Use this token to get the next set of
|
|
3786
4120
|
* results. </p>
|
|
3787
4121
|
*/
|
|
@@ -3818,18 +4152,22 @@ export declare class InvalidNextToken extends __BaseException {
|
|
|
3818
4152
|
*/
|
|
3819
4153
|
export interface DescribeAssociationRequest {
|
|
3820
4154
|
/**
|
|
4155
|
+
* @public
|
|
3821
4156
|
* <p>The name of the SSM document.</p>
|
|
3822
4157
|
*/
|
|
3823
4158
|
Name?: string;
|
|
3824
4159
|
/**
|
|
4160
|
+
* @public
|
|
3825
4161
|
* <p>The managed node ID.</p>
|
|
3826
4162
|
*/
|
|
3827
4163
|
InstanceId?: string;
|
|
3828
4164
|
/**
|
|
4165
|
+
* @public
|
|
3829
4166
|
* <p>The association ID for which you want information.</p>
|
|
3830
4167
|
*/
|
|
3831
4168
|
AssociationId?: string;
|
|
3832
4169
|
/**
|
|
4170
|
+
* @public
|
|
3833
4171
|
* <p>Specify the association version to retrieve. To view the latest version, either specify
|
|
3834
4172
|
* <code>$LATEST</code> for this parameter, or omit this parameter. To view a list of all
|
|
3835
4173
|
* associations for a managed node, use <a>ListAssociations</a>. To get a list of
|
|
@@ -3842,6 +4180,7 @@ export interface DescribeAssociationRequest {
|
|
|
3842
4180
|
*/
|
|
3843
4181
|
export interface DescribeAssociationResult {
|
|
3844
4182
|
/**
|
|
4183
|
+
* @public
|
|
3845
4184
|
* <p>Information about the association.</p>
|
|
3846
4185
|
*/
|
|
3847
4186
|
AssociationDescription?: AssociationDescription;
|
|
@@ -3893,14 +4232,17 @@ export type AssociationFilterOperatorType = (typeof AssociationFilterOperatorTyp
|
|
|
3893
4232
|
*/
|
|
3894
4233
|
export interface AssociationExecutionFilter {
|
|
3895
4234
|
/**
|
|
4235
|
+
* @public
|
|
3896
4236
|
* <p>The key value used in the request.</p>
|
|
3897
4237
|
*/
|
|
3898
4238
|
Key: AssociationExecutionFilterKey | string | undefined;
|
|
3899
4239
|
/**
|
|
4240
|
+
* @public
|
|
3900
4241
|
* <p>The value specified for the key.</p>
|
|
3901
4242
|
*/
|
|
3902
4243
|
Value: string | undefined;
|
|
3903
4244
|
/**
|
|
4245
|
+
* @public
|
|
3904
4246
|
* <p>The filter type specified in the request.</p>
|
|
3905
4247
|
*/
|
|
3906
4248
|
Type: AssociationFilterOperatorType | string | undefined;
|
|
@@ -3910,10 +4252,12 @@ export interface AssociationExecutionFilter {
|
|
|
3910
4252
|
*/
|
|
3911
4253
|
export interface DescribeAssociationExecutionsRequest {
|
|
3912
4254
|
/**
|
|
4255
|
+
* @public
|
|
3913
4256
|
* <p>The association ID for which you want to view execution history details.</p>
|
|
3914
4257
|
*/
|
|
3915
4258
|
AssociationId: string | undefined;
|
|
3916
4259
|
/**
|
|
4260
|
+
* @public
|
|
3917
4261
|
* <p>Filters for the request. You can specify the following filters and values.</p>
|
|
3918
4262
|
* <p>ExecutionId (EQUAL)</p>
|
|
3919
4263
|
* <p>Status (EQUAL)</p>
|
|
@@ -3921,11 +4265,13 @@ export interface DescribeAssociationExecutionsRequest {
|
|
|
3921
4265
|
*/
|
|
3922
4266
|
Filters?: AssociationExecutionFilter[];
|
|
3923
4267
|
/**
|
|
4268
|
+
* @public
|
|
3924
4269
|
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
3925
4270
|
* can specify in a subsequent call to get the next set of results.</p>
|
|
3926
4271
|
*/
|
|
3927
4272
|
MaxResults?: number;
|
|
3928
4273
|
/**
|
|
4274
|
+
* @public
|
|
3929
4275
|
* <p>A token to start the list. Use this token to get the next set of results. </p>
|
|
3930
4276
|
*/
|
|
3931
4277
|
NextToken?: string;
|
|
@@ -3936,43 +4282,53 @@ export interface DescribeAssociationExecutionsRequest {
|
|
|
3936
4282
|
*/
|
|
3937
4283
|
export interface AssociationExecution {
|
|
3938
4284
|
/**
|
|
4285
|
+
* @public
|
|
3939
4286
|
* <p>The association ID.</p>
|
|
3940
4287
|
*/
|
|
3941
4288
|
AssociationId?: string;
|
|
3942
4289
|
/**
|
|
4290
|
+
* @public
|
|
3943
4291
|
* <p>The association version.</p>
|
|
3944
4292
|
*/
|
|
3945
4293
|
AssociationVersion?: string;
|
|
3946
4294
|
/**
|
|
4295
|
+
* @public
|
|
3947
4296
|
* <p>The execution ID for the association.</p>
|
|
3948
4297
|
*/
|
|
3949
4298
|
ExecutionId?: string;
|
|
3950
4299
|
/**
|
|
4300
|
+
* @public
|
|
3951
4301
|
* <p>The status of the association execution.</p>
|
|
3952
4302
|
*/
|
|
3953
4303
|
Status?: string;
|
|
3954
4304
|
/**
|
|
4305
|
+
* @public
|
|
3955
4306
|
* <p>Detailed status information about the execution.</p>
|
|
3956
4307
|
*/
|
|
3957
4308
|
DetailedStatus?: string;
|
|
3958
4309
|
/**
|
|
4310
|
+
* @public
|
|
3959
4311
|
* <p>The time the execution started.</p>
|
|
3960
4312
|
*/
|
|
3961
4313
|
CreatedTime?: Date;
|
|
3962
4314
|
/**
|
|
4315
|
+
* @public
|
|
3963
4316
|
* <p>The date of the last execution.</p>
|
|
3964
4317
|
*/
|
|
3965
4318
|
LastExecutionDate?: Date;
|
|
3966
4319
|
/**
|
|
4320
|
+
* @public
|
|
3967
4321
|
* <p>An aggregate status of the resources in the execution based on the status type.</p>
|
|
3968
4322
|
*/
|
|
3969
4323
|
ResourceCountByStatus?: string;
|
|
3970
4324
|
/**
|
|
4325
|
+
* @public
|
|
3971
4326
|
* <p>The details for the CloudWatch alarm you want to apply to an automation or
|
|
3972
4327
|
* command.</p>
|
|
3973
4328
|
*/
|
|
3974
4329
|
AlarmConfiguration?: AlarmConfiguration;
|
|
3975
4330
|
/**
|
|
4331
|
+
* @public
|
|
3976
4332
|
* <p>The CloudWatch alarms that were invoked by the association.</p>
|
|
3977
4333
|
*/
|
|
3978
4334
|
TriggeredAlarms?: AlarmStateInformation[];
|
|
@@ -3982,10 +4338,12 @@ export interface AssociationExecution {
|
|
|
3982
4338
|
*/
|
|
3983
4339
|
export interface DescribeAssociationExecutionsResult {
|
|
3984
4340
|
/**
|
|
4341
|
+
* @public
|
|
3985
4342
|
* <p>A list of the executions for the specified association ID.</p>
|
|
3986
4343
|
*/
|
|
3987
4344
|
AssociationExecutions?: AssociationExecution[];
|
|
3988
4345
|
/**
|
|
4346
|
+
* @public
|
|
3989
4347
|
* <p>The token for the next set of items to return. Use this token to get the next set of
|
|
3990
4348
|
* results.</p>
|
|
3991
4349
|
*/
|
|
@@ -4023,10 +4381,12 @@ export type AssociationExecutionTargetsFilterKey = (typeof AssociationExecutionT
|
|
|
4023
4381
|
*/
|
|
4024
4382
|
export interface AssociationExecutionTargetsFilter {
|
|
4025
4383
|
/**
|
|
4384
|
+
* @public
|
|
4026
4385
|
* <p>The key value used in the request.</p>
|
|
4027
4386
|
*/
|
|
4028
4387
|
Key: AssociationExecutionTargetsFilterKey | string | undefined;
|
|
4029
4388
|
/**
|
|
4389
|
+
* @public
|
|
4030
4390
|
* <p>The value specified for the key.</p>
|
|
4031
4391
|
*/
|
|
4032
4392
|
Value: string | undefined;
|
|
@@ -4036,14 +4396,17 @@ export interface AssociationExecutionTargetsFilter {
|
|
|
4036
4396
|
*/
|
|
4037
4397
|
export interface DescribeAssociationExecutionTargetsRequest {
|
|
4038
4398
|
/**
|
|
4399
|
+
* @public
|
|
4039
4400
|
* <p>The association ID that includes the execution for which you want to view details.</p>
|
|
4040
4401
|
*/
|
|
4041
4402
|
AssociationId: string | undefined;
|
|
4042
4403
|
/**
|
|
4404
|
+
* @public
|
|
4043
4405
|
* <p>The execution ID for which you want to view details.</p>
|
|
4044
4406
|
*/
|
|
4045
4407
|
ExecutionId: string | undefined;
|
|
4046
4408
|
/**
|
|
4409
|
+
* @public
|
|
4047
4410
|
* <p>Filters for the request. You can specify the following filters and values.</p>
|
|
4048
4411
|
* <p>Status (EQUAL)</p>
|
|
4049
4412
|
* <p>ResourceId (EQUAL)</p>
|
|
@@ -4051,11 +4414,13 @@ export interface DescribeAssociationExecutionTargetsRequest {
|
|
|
4051
4414
|
*/
|
|
4052
4415
|
Filters?: AssociationExecutionTargetsFilter[];
|
|
4053
4416
|
/**
|
|
4417
|
+
* @public
|
|
4054
4418
|
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
4055
4419
|
* can specify in a subsequent call to get the next set of results.</p>
|
|
4056
4420
|
*/
|
|
4057
4421
|
MaxResults?: number;
|
|
4058
4422
|
/**
|
|
4423
|
+
* @public
|
|
4059
4424
|
* <p>A token to start the list. Use this token to get the next set of results. </p>
|
|
4060
4425
|
*/
|
|
4061
4426
|
NextToken?: string;
|
|
@@ -4066,10 +4431,12 @@ export interface DescribeAssociationExecutionTargetsRequest {
|
|
|
4066
4431
|
*/
|
|
4067
4432
|
export interface OutputSource {
|
|
4068
4433
|
/**
|
|
4434
|
+
* @public
|
|
4069
4435
|
* <p>The ID of the output source, for example the URL of an S3 bucket.</p>
|
|
4070
4436
|
*/
|
|
4071
4437
|
OutputSourceId?: string;
|
|
4072
4438
|
/**
|
|
4439
|
+
* @public
|
|
4073
4440
|
* <p>The type of source where the association execution details are stored, for example, Amazon S3.</p>
|
|
4074
4441
|
*/
|
|
4075
4442
|
OutputSourceType?: string;
|
|
@@ -4080,38 +4447,47 @@ export interface OutputSource {
|
|
|
4080
4447
|
*/
|
|
4081
4448
|
export interface AssociationExecutionTarget {
|
|
4082
4449
|
/**
|
|
4450
|
+
* @public
|
|
4083
4451
|
* <p>The association ID.</p>
|
|
4084
4452
|
*/
|
|
4085
4453
|
AssociationId?: string;
|
|
4086
4454
|
/**
|
|
4455
|
+
* @public
|
|
4087
4456
|
* <p>The association version.</p>
|
|
4088
4457
|
*/
|
|
4089
4458
|
AssociationVersion?: string;
|
|
4090
4459
|
/**
|
|
4460
|
+
* @public
|
|
4091
4461
|
* <p>The execution ID.</p>
|
|
4092
4462
|
*/
|
|
4093
4463
|
ExecutionId?: string;
|
|
4094
4464
|
/**
|
|
4465
|
+
* @public
|
|
4095
4466
|
* <p>The resource ID, for example, the managed node ID where the association ran.</p>
|
|
4096
4467
|
*/
|
|
4097
4468
|
ResourceId?: string;
|
|
4098
4469
|
/**
|
|
4470
|
+
* @public
|
|
4099
4471
|
* <p>The resource type, for example, EC2.</p>
|
|
4100
4472
|
*/
|
|
4101
4473
|
ResourceType?: string;
|
|
4102
4474
|
/**
|
|
4475
|
+
* @public
|
|
4103
4476
|
* <p>The association execution status.</p>
|
|
4104
4477
|
*/
|
|
4105
4478
|
Status?: string;
|
|
4106
4479
|
/**
|
|
4480
|
+
* @public
|
|
4107
4481
|
* <p>Detailed information about the execution status.</p>
|
|
4108
4482
|
*/
|
|
4109
4483
|
DetailedStatus?: string;
|
|
4110
4484
|
/**
|
|
4485
|
+
* @public
|
|
4111
4486
|
* <p>The date of the last execution.</p>
|
|
4112
4487
|
*/
|
|
4113
4488
|
LastExecutionDate?: Date;
|
|
4114
4489
|
/**
|
|
4490
|
+
* @public
|
|
4115
4491
|
* <p>The location where the association details are saved.</p>
|
|
4116
4492
|
*/
|
|
4117
4493
|
OutputSource?: OutputSource;
|
|
@@ -4121,10 +4497,12 @@ export interface AssociationExecutionTarget {
|
|
|
4121
4497
|
*/
|
|
4122
4498
|
export interface DescribeAssociationExecutionTargetsResult {
|
|
4123
4499
|
/**
|
|
4500
|
+
* @public
|
|
4124
4501
|
* <p>Information about the execution.</p>
|
|
4125
4502
|
*/
|
|
4126
4503
|
AssociationExecutionTargets?: AssociationExecutionTarget[];
|
|
4127
4504
|
/**
|
|
4505
|
+
* @public
|
|
4128
4506
|
* <p>The token for the next set of items to return. Use this token to get the next set of
|
|
4129
4507
|
* results.</p>
|
|
4130
4508
|
*/
|
|
@@ -4159,10 +4537,12 @@ export type AutomationExecutionFilterKey = (typeof AutomationExecutionFilterKey)
|
|
|
4159
4537
|
*/
|
|
4160
4538
|
export interface AutomationExecutionFilter {
|
|
4161
4539
|
/**
|
|
4540
|
+
* @public
|
|
4162
4541
|
* <p>One or more keys to limit the results.</p>
|
|
4163
4542
|
*/
|
|
4164
4543
|
Key: AutomationExecutionFilterKey | string | undefined;
|
|
4165
4544
|
/**
|
|
4545
|
+
* @public
|
|
4166
4546
|
* <p>The values used to limit the execution information associated with the filter's key.</p>
|
|
4167
4547
|
*/
|
|
4168
4548
|
Values: string[] | undefined;
|
|
@@ -4172,15 +4552,18 @@ export interface AutomationExecutionFilter {
|
|
|
4172
4552
|
*/
|
|
4173
4553
|
export interface DescribeAutomationExecutionsRequest {
|
|
4174
4554
|
/**
|
|
4555
|
+
* @public
|
|
4175
4556
|
* <p>Filters used to limit the scope of executions that are requested.</p>
|
|
4176
4557
|
*/
|
|
4177
4558
|
Filters?: AutomationExecutionFilter[];
|
|
4178
4559
|
/**
|
|
4560
|
+
* @public
|
|
4179
4561
|
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
4180
4562
|
* can specify in a subsequent call to get the next set of results.</p>
|
|
4181
4563
|
*/
|
|
4182
4564
|
MaxResults?: number;
|
|
4183
4565
|
/**
|
|
4566
|
+
* @public
|
|
4184
4567
|
* <p>The token for the next set of items to return. (You received this token from a previous
|
|
4185
4568
|
* call.)</p>
|
|
4186
4569
|
*/
|
|
@@ -4255,11 +4638,13 @@ export type ExecutionMode = (typeof ExecutionMode)[keyof typeof ExecutionMode];
|
|
|
4255
4638
|
*/
|
|
4256
4639
|
export interface ResolvedTargets {
|
|
4257
4640
|
/**
|
|
4641
|
+
* @public
|
|
4258
4642
|
* <p>A list of parameter values sent to targets that resolved during the Automation
|
|
4259
4643
|
* execution.</p>
|
|
4260
4644
|
*/
|
|
4261
4645
|
ParameterValues?: string[];
|
|
4262
4646
|
/**
|
|
4647
|
+
* @public
|
|
4263
4648
|
* <p>A boolean value indicating whether the resolved target list is truncated.</p>
|
|
4264
4649
|
*/
|
|
4265
4650
|
Truncated?: boolean;
|
|
@@ -4274,46 +4659,55 @@ export interface ResolvedTargets {
|
|
|
4274
4659
|
*/
|
|
4275
4660
|
export interface Runbook {
|
|
4276
4661
|
/**
|
|
4662
|
+
* @public
|
|
4277
4663
|
* <p>The name of the Automation runbook used in a runbook workflow.</p>
|
|
4278
4664
|
*/
|
|
4279
4665
|
DocumentName: string | undefined;
|
|
4280
4666
|
/**
|
|
4667
|
+
* @public
|
|
4281
4668
|
* <p>The version of the Automation runbook used in a runbook workflow.</p>
|
|
4282
4669
|
*/
|
|
4283
4670
|
DocumentVersion?: string;
|
|
4284
4671
|
/**
|
|
4672
|
+
* @public
|
|
4285
4673
|
* <p>The key-value map of execution parameters, which were supplied when calling
|
|
4286
4674
|
* <code>StartChangeRequestExecution</code>.</p>
|
|
4287
4675
|
*/
|
|
4288
4676
|
Parameters?: Record<string, string[]>;
|
|
4289
4677
|
/**
|
|
4678
|
+
* @public
|
|
4290
4679
|
* <p>The name of the parameter used as the target resource for the rate-controlled
|
|
4291
4680
|
* runbook workflow. Required if you specify <code>Targets</code>. </p>
|
|
4292
4681
|
*/
|
|
4293
4682
|
TargetParameterName?: string;
|
|
4294
4683
|
/**
|
|
4684
|
+
* @public
|
|
4295
4685
|
* <p>A key-value mapping to target resources that the runbook operation performs tasks on.
|
|
4296
4686
|
* Required if you specify <code>TargetParameterName</code>.</p>
|
|
4297
4687
|
*/
|
|
4298
4688
|
Targets?: Target[];
|
|
4299
4689
|
/**
|
|
4690
|
+
* @public
|
|
4300
4691
|
* <p>A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps
|
|
4301
4692
|
* can't be specified together.</p>
|
|
4302
4693
|
*/
|
|
4303
4694
|
TargetMaps?: Record<string, string[]>[];
|
|
4304
4695
|
/**
|
|
4696
|
+
* @public
|
|
4305
4697
|
* <p>The <code>MaxConcurrency</code> value specified by the user when the operation started,
|
|
4306
4698
|
* indicating the maximum number of resources that the runbook operation can run on at the same
|
|
4307
4699
|
* time.</p>
|
|
4308
4700
|
*/
|
|
4309
4701
|
MaxConcurrency?: string;
|
|
4310
4702
|
/**
|
|
4703
|
+
* @public
|
|
4311
4704
|
* <p>The <code>MaxErrors</code> value specified by the user when the execution started,
|
|
4312
4705
|
* indicating the maximum number of errors that can occur during the operation before the updates
|
|
4313
4706
|
* are stopped or rolled back.</p>
|
|
4314
4707
|
*/
|
|
4315
4708
|
MaxErrors?: string;
|
|
4316
4709
|
/**
|
|
4710
|
+
* @public
|
|
4317
4711
|
* <p>Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook
|
|
4318
4712
|
* operation.</p>
|
|
4319
4713
|
*/
|
|
@@ -4325,92 +4719,114 @@ export interface Runbook {
|
|
|
4325
4719
|
*/
|
|
4326
4720
|
export interface AutomationExecutionMetadata {
|
|
4327
4721
|
/**
|
|
4722
|
+
* @public
|
|
4328
4723
|
* <p>The execution ID.</p>
|
|
4329
4724
|
*/
|
|
4330
4725
|
AutomationExecutionId?: string;
|
|
4331
4726
|
/**
|
|
4727
|
+
* @public
|
|
4332
4728
|
* <p>The name of the Automation runbook used during execution.</p>
|
|
4333
4729
|
*/
|
|
4334
4730
|
DocumentName?: string;
|
|
4335
4731
|
/**
|
|
4732
|
+
* @public
|
|
4336
4733
|
* <p>The document version used during the execution.</p>
|
|
4337
4734
|
*/
|
|
4338
4735
|
DocumentVersion?: string;
|
|
4339
4736
|
/**
|
|
4737
|
+
* @public
|
|
4340
4738
|
* <p>The status of the execution.</p>
|
|
4341
4739
|
*/
|
|
4342
4740
|
AutomationExecutionStatus?: AutomationExecutionStatus | string;
|
|
4343
4741
|
/**
|
|
4742
|
+
* @public
|
|
4344
4743
|
* <p>The time the execution started.</p>
|
|
4345
4744
|
*/
|
|
4346
4745
|
ExecutionStartTime?: Date;
|
|
4347
4746
|
/**
|
|
4747
|
+
* @public
|
|
4348
4748
|
* <p>The time the execution finished. This isn't populated if the execution is still in
|
|
4349
4749
|
* progress.</p>
|
|
4350
4750
|
*/
|
|
4351
4751
|
ExecutionEndTime?: Date;
|
|
4352
4752
|
/**
|
|
4753
|
+
* @public
|
|
4353
4754
|
* <p>The IAM role ARN of the user who ran the automation.</p>
|
|
4354
4755
|
*/
|
|
4355
4756
|
ExecutedBy?: string;
|
|
4356
4757
|
/**
|
|
4758
|
+
* @public
|
|
4357
4759
|
* <p>An S3 bucket where execution information is stored.</p>
|
|
4358
4760
|
*/
|
|
4359
4761
|
LogFile?: string;
|
|
4360
4762
|
/**
|
|
4763
|
+
* @public
|
|
4361
4764
|
* <p>The list of execution outputs as defined in the Automation runbook.</p>
|
|
4362
4765
|
*/
|
|
4363
4766
|
Outputs?: Record<string, string[]>;
|
|
4364
4767
|
/**
|
|
4768
|
+
* @public
|
|
4365
4769
|
* <p>The Automation execution mode.</p>
|
|
4366
4770
|
*/
|
|
4367
4771
|
Mode?: ExecutionMode | string;
|
|
4368
4772
|
/**
|
|
4773
|
+
* @public
|
|
4369
4774
|
* <p>The execution ID of the parent automation.</p>
|
|
4370
4775
|
*/
|
|
4371
4776
|
ParentAutomationExecutionId?: string;
|
|
4372
4777
|
/**
|
|
4778
|
+
* @public
|
|
4373
4779
|
* <p>The name of the step that is currently running.</p>
|
|
4374
4780
|
*/
|
|
4375
4781
|
CurrentStepName?: string;
|
|
4376
4782
|
/**
|
|
4783
|
+
* @public
|
|
4377
4784
|
* <p>The action of the step that is currently running.</p>
|
|
4378
4785
|
*/
|
|
4379
4786
|
CurrentAction?: string;
|
|
4380
4787
|
/**
|
|
4788
|
+
* @public
|
|
4381
4789
|
* <p>The list of execution outputs as defined in the Automation runbook.</p>
|
|
4382
4790
|
*/
|
|
4383
4791
|
FailureMessage?: string;
|
|
4384
4792
|
/**
|
|
4793
|
+
* @public
|
|
4385
4794
|
* <p>The list of execution outputs as defined in the Automation runbook.</p>
|
|
4386
4795
|
*/
|
|
4387
4796
|
TargetParameterName?: string;
|
|
4388
4797
|
/**
|
|
4798
|
+
* @public
|
|
4389
4799
|
* <p>The targets defined by the user when starting the automation.</p>
|
|
4390
4800
|
*/
|
|
4391
4801
|
Targets?: Target[];
|
|
4392
4802
|
/**
|
|
4803
|
+
* @public
|
|
4393
4804
|
* <p>The specified key-value mapping of document parameters to target resources.</p>
|
|
4394
4805
|
*/
|
|
4395
4806
|
TargetMaps?: Record<string, string[]>[];
|
|
4396
4807
|
/**
|
|
4808
|
+
* @public
|
|
4397
4809
|
* <p>A list of targets that resolved during the execution.</p>
|
|
4398
4810
|
*/
|
|
4399
4811
|
ResolvedTargets?: ResolvedTargets;
|
|
4400
4812
|
/**
|
|
4813
|
+
* @public
|
|
4401
4814
|
* <p>The <code>MaxConcurrency</code> value specified by the user when starting the
|
|
4402
4815
|
* automation.</p>
|
|
4403
4816
|
*/
|
|
4404
4817
|
MaxConcurrency?: string;
|
|
4405
4818
|
/**
|
|
4819
|
+
* @public
|
|
4406
4820
|
* <p>The <code>MaxErrors</code> value specified by the user when starting the automation.</p>
|
|
4407
4821
|
*/
|
|
4408
4822
|
MaxErrors?: string;
|
|
4409
4823
|
/**
|
|
4824
|
+
* @public
|
|
4410
4825
|
* <p>The list of execution outputs as defined in the Automation runbook.</p>
|
|
4411
4826
|
*/
|
|
4412
4827
|
Target?: string;
|
|
4413
4828
|
/**
|
|
4829
|
+
* @public
|
|
4414
4830
|
* <p>Use this filter with <a>DescribeAutomationExecutions</a>. Specify either Local or
|
|
4415
4831
|
* CrossAccount. CrossAccount is an Automation that runs in multiple Amazon Web Services Regions and
|
|
4416
4832
|
* Amazon Web Services accounts. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html">Running Automation workflows in multiple Amazon Web Services Regions and accounts</a> in the
|
|
@@ -4418,23 +4834,28 @@ export interface AutomationExecutionMetadata {
|
|
|
4418
4834
|
*/
|
|
4419
4835
|
AutomationType?: AutomationType | string;
|
|
4420
4836
|
/**
|
|
4837
|
+
* @public
|
|
4421
4838
|
* <p>The details for the CloudWatch alarm applied to your automation.</p>
|
|
4422
4839
|
*/
|
|
4423
4840
|
AlarmConfiguration?: AlarmConfiguration;
|
|
4424
4841
|
/**
|
|
4842
|
+
* @public
|
|
4425
4843
|
* <p>The CloudWatch alarm that was invoked by the automation.</p>
|
|
4426
4844
|
*/
|
|
4427
4845
|
TriggeredAlarms?: AlarmStateInformation[];
|
|
4428
4846
|
/**
|
|
4847
|
+
* @public
|
|
4429
4848
|
* <p>The subtype of the Automation operation. Currently, the only supported value is
|
|
4430
4849
|
* <code>ChangeRequest</code>.</p>
|
|
4431
4850
|
*/
|
|
4432
4851
|
AutomationSubtype?: AutomationSubtype | string;
|
|
4433
4852
|
/**
|
|
4853
|
+
* @public
|
|
4434
4854
|
* <p>The date and time the Automation operation is scheduled to start.</p>
|
|
4435
4855
|
*/
|
|
4436
4856
|
ScheduledTime?: Date;
|
|
4437
4857
|
/**
|
|
4858
|
+
* @public
|
|
4438
4859
|
* <p>Information about the Automation runbooks that are run during a runbook workflow in
|
|
4439
4860
|
* Change Manager.</p>
|
|
4440
4861
|
* <note>
|
|
@@ -4444,14 +4865,17 @@ export interface AutomationExecutionMetadata {
|
|
|
4444
4865
|
*/
|
|
4445
4866
|
Runbooks?: Runbook[];
|
|
4446
4867
|
/**
|
|
4868
|
+
* @public
|
|
4447
4869
|
* <p>The ID of an OpsItem that is created to represent a Change Manager change request.</p>
|
|
4448
4870
|
*/
|
|
4449
4871
|
OpsItemId?: string;
|
|
4450
4872
|
/**
|
|
4873
|
+
* @public
|
|
4451
4874
|
* <p>The ID of a State Manager association used in the Automation operation.</p>
|
|
4452
4875
|
*/
|
|
4453
4876
|
AssociationId?: string;
|
|
4454
4877
|
/**
|
|
4878
|
+
* @public
|
|
4455
4879
|
* <p>The name of the Change Manager change request.</p>
|
|
4456
4880
|
*/
|
|
4457
4881
|
ChangeRequestName?: string;
|
|
@@ -4461,11 +4885,13 @@ export interface AutomationExecutionMetadata {
|
|
|
4461
4885
|
*/
|
|
4462
4886
|
export interface DescribeAutomationExecutionsResult {
|
|
4463
4887
|
/**
|
|
4888
|
+
* @public
|
|
4464
4889
|
* <p>The list of details about each automation execution which has occurred which matches the
|
|
4465
4890
|
* filter specification, if any.</p>
|
|
4466
4891
|
*/
|
|
4467
4892
|
AutomationExecutionMetadataList?: AutomationExecutionMetadata[];
|
|
4468
4893
|
/**
|
|
4894
|
+
* @public
|
|
4469
4895
|
* <p>The token to use when requesting the next set of items. If there are no additional items to
|
|
4470
4896
|
* return, the string is empty.</p>
|
|
4471
4897
|
*/
|
|
@@ -4532,11 +4958,13 @@ export type StepExecutionFilterKey = (typeof StepExecutionFilterKey)[keyof typeo
|
|
|
4532
4958
|
*/
|
|
4533
4959
|
export interface StepExecutionFilter {
|
|
4534
4960
|
/**
|
|
4961
|
+
* @public
|
|
4535
4962
|
* <p>One or more keys to limit the results. Valid filter keys include the following: StepName,
|
|
4536
4963
|
* Action, StepExecutionId, StepExecutionStatus, StartTimeBefore, StartTimeAfter.</p>
|
|
4537
4964
|
*/
|
|
4538
4965
|
Key: StepExecutionFilterKey | string | undefined;
|
|
4539
4966
|
/**
|
|
4967
|
+
* @public
|
|
4540
4968
|
* <p>The values of the filter key.</p>
|
|
4541
4969
|
*/
|
|
4542
4970
|
Values: string[] | undefined;
|
|
@@ -4546,24 +4974,29 @@ export interface StepExecutionFilter {
|
|
|
4546
4974
|
*/
|
|
4547
4975
|
export interface DescribeAutomationStepExecutionsRequest {
|
|
4548
4976
|
/**
|
|
4977
|
+
* @public
|
|
4549
4978
|
* <p>The Automation execution ID for which you want step execution descriptions.</p>
|
|
4550
4979
|
*/
|
|
4551
4980
|
AutomationExecutionId: string | undefined;
|
|
4552
4981
|
/**
|
|
4982
|
+
* @public
|
|
4553
4983
|
* <p>One or more filters to limit the number of step executions returned by the request.</p>
|
|
4554
4984
|
*/
|
|
4555
4985
|
Filters?: StepExecutionFilter[];
|
|
4556
4986
|
/**
|
|
4987
|
+
* @public
|
|
4557
4988
|
* <p>The token for the next set of items to return. (You received this token from a previous
|
|
4558
4989
|
* call.)</p>
|
|
4559
4990
|
*/
|
|
4560
4991
|
NextToken?: string;
|
|
4561
4992
|
/**
|
|
4993
|
+
* @public
|
|
4562
4994
|
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
4563
4995
|
* can specify in a subsequent call to get the next set of results.</p>
|
|
4564
4996
|
*/
|
|
4565
4997
|
MaxResults?: number;
|
|
4566
4998
|
/**
|
|
4999
|
+
* @public
|
|
4567
5000
|
* <p>Indicates whether to list step executions in reverse order by start time. The default value
|
|
4568
5001
|
* is 'false'.</p>
|
|
4569
5002
|
*/
|
|
@@ -4575,16 +5008,19 @@ export interface DescribeAutomationStepExecutionsRequest {
|
|
|
4575
5008
|
*/
|
|
4576
5009
|
export interface FailureDetails {
|
|
4577
5010
|
/**
|
|
5011
|
+
* @public
|
|
4578
5012
|
* <p>The stage of the Automation execution when the failure occurred. The stages include the
|
|
4579
5013
|
* following: InputValidation, PreVerification, Invocation, PostVerification.</p>
|
|
4580
5014
|
*/
|
|
4581
5015
|
FailureStage?: string;
|
|
4582
5016
|
/**
|
|
5017
|
+
* @public
|
|
4583
5018
|
* <p>The type of Automation failure. Failure types include the following: Action, Permission,
|
|
4584
5019
|
* Throttling, Verification, Internal.</p>
|
|
4585
5020
|
*/
|
|
4586
5021
|
FailureType?: string;
|
|
4587
5022
|
/**
|
|
5023
|
+
* @public
|
|
4588
5024
|
* <p>Detailed information about the Automation step failure.</p>
|
|
4589
5025
|
*/
|
|
4590
5026
|
Details?: Record<string, string[]>;
|
|
@@ -4595,87 +5031,107 @@ export interface FailureDetails {
|
|
|
4595
5031
|
*/
|
|
4596
5032
|
export interface StepExecution {
|
|
4597
5033
|
/**
|
|
5034
|
+
* @public
|
|
4598
5035
|
* <p>The name of this execution step.</p>
|
|
4599
5036
|
*/
|
|
4600
5037
|
StepName?: string;
|
|
4601
5038
|
/**
|
|
5039
|
+
* @public
|
|
4602
5040
|
* <p>The action this step performs. The action determines the behavior of the step.</p>
|
|
4603
5041
|
*/
|
|
4604
5042
|
Action?: string;
|
|
4605
5043
|
/**
|
|
5044
|
+
* @public
|
|
4606
5045
|
* <p>The timeout seconds of the step.</p>
|
|
4607
5046
|
*/
|
|
4608
5047
|
TimeoutSeconds?: number;
|
|
4609
5048
|
/**
|
|
5049
|
+
* @public
|
|
4610
5050
|
* <p>The action to take if the step fails. The default value is <code>Abort</code>.</p>
|
|
4611
5051
|
*/
|
|
4612
5052
|
OnFailure?: string;
|
|
4613
5053
|
/**
|
|
5054
|
+
* @public
|
|
4614
5055
|
* <p>The maximum number of tries to run the action of the step. The default value is
|
|
4615
5056
|
* <code>1</code>.</p>
|
|
4616
5057
|
*/
|
|
4617
5058
|
MaxAttempts?: number;
|
|
4618
5059
|
/**
|
|
5060
|
+
* @public
|
|
4619
5061
|
* <p>If a step has begun execution, this contains the time the step started. If the step is in
|
|
4620
5062
|
* Pending status, this field isn't populated.</p>
|
|
4621
5063
|
*/
|
|
4622
5064
|
ExecutionStartTime?: Date;
|
|
4623
5065
|
/**
|
|
5066
|
+
* @public
|
|
4624
5067
|
* <p>If a step has finished execution, this contains the time the execution ended. If the step
|
|
4625
5068
|
* hasn't yet concluded, this field isn't populated.</p>
|
|
4626
5069
|
*/
|
|
4627
5070
|
ExecutionEndTime?: Date;
|
|
4628
5071
|
/**
|
|
5072
|
+
* @public
|
|
4629
5073
|
* <p>The execution status for this step.</p>
|
|
4630
5074
|
*/
|
|
4631
5075
|
StepStatus?: AutomationExecutionStatus | string;
|
|
4632
5076
|
/**
|
|
5077
|
+
* @public
|
|
4633
5078
|
* <p>The response code returned by the execution of the step.</p>
|
|
4634
5079
|
*/
|
|
4635
5080
|
ResponseCode?: string;
|
|
4636
5081
|
/**
|
|
5082
|
+
* @public
|
|
4637
5083
|
* <p>Fully-resolved values passed into the step before execution.</p>
|
|
4638
5084
|
*/
|
|
4639
5085
|
Inputs?: Record<string, string>;
|
|
4640
5086
|
/**
|
|
5087
|
+
* @public
|
|
4641
5088
|
* <p>Returned values from the execution of the step.</p>
|
|
4642
5089
|
*/
|
|
4643
5090
|
Outputs?: Record<string, string[]>;
|
|
4644
5091
|
/**
|
|
5092
|
+
* @public
|
|
4645
5093
|
* <p>A message associated with the response code for an execution.</p>
|
|
4646
5094
|
*/
|
|
4647
5095
|
Response?: string;
|
|
4648
5096
|
/**
|
|
5097
|
+
* @public
|
|
4649
5098
|
* <p>If a step failed, this message explains why the execution failed.</p>
|
|
4650
5099
|
*/
|
|
4651
5100
|
FailureMessage?: string;
|
|
4652
5101
|
/**
|
|
5102
|
+
* @public
|
|
4653
5103
|
* <p>Information about the Automation failure.</p>
|
|
4654
5104
|
*/
|
|
4655
5105
|
FailureDetails?: FailureDetails;
|
|
4656
5106
|
/**
|
|
5107
|
+
* @public
|
|
4657
5108
|
* <p>The unique ID of a step execution.</p>
|
|
4658
5109
|
*/
|
|
4659
5110
|
StepExecutionId?: string;
|
|
4660
5111
|
/**
|
|
5112
|
+
* @public
|
|
4661
5113
|
* <p>A user-specified list of parameters to override when running a step.</p>
|
|
4662
5114
|
*/
|
|
4663
5115
|
OverriddenParameters?: Record<string, string[]>;
|
|
4664
5116
|
/**
|
|
5117
|
+
* @public
|
|
4665
5118
|
* <p>The flag which can be used to end automation no matter whether the step succeeds or
|
|
4666
5119
|
* fails.</p>
|
|
4667
5120
|
*/
|
|
4668
5121
|
IsEnd?: boolean;
|
|
4669
5122
|
/**
|
|
5123
|
+
* @public
|
|
4670
5124
|
* <p>The next step after the step succeeds.</p>
|
|
4671
5125
|
*/
|
|
4672
5126
|
NextStep?: string;
|
|
4673
5127
|
/**
|
|
5128
|
+
* @public
|
|
4674
5129
|
* <p>The flag which can be used to help decide whether the failure of current step leads to the
|
|
4675
5130
|
* Automation failure.</p>
|
|
4676
5131
|
*/
|
|
4677
5132
|
IsCritical?: boolean;
|
|
4678
5133
|
/**
|
|
5134
|
+
* @public
|
|
4679
5135
|
* <p>Strategies used when step fails, we support Continue and Abort. Abort will fail the
|
|
4680
5136
|
* automation when the step fails. Continue will ignore the failure of current step and allow
|
|
4681
5137
|
* automation to run the next step. With conditional branching, we add step:stepName to support the
|
|
@@ -4683,15 +5139,18 @@ export interface StepExecution {
|
|
|
4683
5139
|
*/
|
|
4684
5140
|
ValidNextSteps?: string[];
|
|
4685
5141
|
/**
|
|
5142
|
+
* @public
|
|
4686
5143
|
* <p>The targets for the step execution.</p>
|
|
4687
5144
|
*/
|
|
4688
5145
|
Targets?: Target[];
|
|
4689
5146
|
/**
|
|
5147
|
+
* @public
|
|
4690
5148
|
* <p>The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation
|
|
4691
5149
|
* execution.</p>
|
|
4692
5150
|
*/
|
|
4693
5151
|
TargetLocation?: TargetLocation;
|
|
4694
5152
|
/**
|
|
5153
|
+
* @public
|
|
4695
5154
|
* <p>The CloudWatch alarms that were invoked by the automation.</p>
|
|
4696
5155
|
*/
|
|
4697
5156
|
TriggeredAlarms?: AlarmStateInformation[];
|
|
@@ -4701,10 +5160,12 @@ export interface StepExecution {
|
|
|
4701
5160
|
*/
|
|
4702
5161
|
export interface DescribeAutomationStepExecutionsResult {
|
|
4703
5162
|
/**
|
|
5163
|
+
* @public
|
|
4704
5164
|
* <p>A list of details about the current state of all steps that make up an execution.</p>
|
|
4705
5165
|
*/
|
|
4706
5166
|
StepExecutions?: StepExecution[];
|
|
4707
5167
|
/**
|
|
5168
|
+
* @public
|
|
4708
5169
|
* <p>The token to use when requesting the next set of items. If there are no additional items to
|
|
4709
5170
|
* return, the string is empty.</p>
|
|
4710
5171
|
*/
|
|
@@ -4740,10 +5201,12 @@ export interface DescribeAutomationStepExecutionsResult {
|
|
|
4740
5201
|
*/
|
|
4741
5202
|
export interface PatchOrchestratorFilter {
|
|
4742
5203
|
/**
|
|
5204
|
+
* @public
|
|
4743
5205
|
* <p>The key for the filter.</p>
|
|
4744
5206
|
*/
|
|
4745
5207
|
Key?: string;
|
|
4746
5208
|
/**
|
|
5209
|
+
* @public
|
|
4747
5210
|
* <p>The value for the filter.</p>
|
|
4748
5211
|
*/
|
|
4749
5212
|
Values?: string[];
|
|
@@ -4753,6 +5216,7 @@ export interface PatchOrchestratorFilter {
|
|
|
4753
5216
|
*/
|
|
4754
5217
|
export interface DescribeAvailablePatchesRequest {
|
|
4755
5218
|
/**
|
|
5219
|
+
* @public
|
|
4756
5220
|
* <p>Each element in the array is a structure containing a key-value pair.</p>
|
|
4757
5221
|
* <p>
|
|
4758
5222
|
* <b>Windows Server</b>
|
|
@@ -4938,10 +5402,12 @@ export interface DescribeAvailablePatchesRequest {
|
|
|
4938
5402
|
*/
|
|
4939
5403
|
Filters?: PatchOrchestratorFilter[];
|
|
4940
5404
|
/**
|
|
5405
|
+
* @public
|
|
4941
5406
|
* <p>The maximum number of patches to return (per page).</p>
|
|
4942
5407
|
*/
|
|
4943
5408
|
MaxResults?: number;
|
|
4944
5409
|
/**
|
|
5410
|
+
* @public
|
|
4945
5411
|
* <p>The token for the next set of items to return. (You received this token from a previous
|
|
4946
5412
|
* call.)</p>
|
|
4947
5413
|
*/
|
|
@@ -4953,6 +5419,7 @@ export interface DescribeAvailablePatchesRequest {
|
|
|
4953
5419
|
*/
|
|
4954
5420
|
export interface Patch {
|
|
4955
5421
|
/**
|
|
5422
|
+
* @public
|
|
4956
5423
|
* <p>The ID of the patch. Applies to Windows patches only.</p>
|
|
4957
5424
|
* <note>
|
|
4958
5425
|
* <p>This ID isn't the same as the Microsoft Knowledge Base ID.</p>
|
|
@@ -4960,107 +5427,129 @@ export interface Patch {
|
|
|
4960
5427
|
*/
|
|
4961
5428
|
Id?: string;
|
|
4962
5429
|
/**
|
|
5430
|
+
* @public
|
|
4963
5431
|
* <p>The date the patch was released.</p>
|
|
4964
5432
|
*/
|
|
4965
5433
|
ReleaseDate?: Date;
|
|
4966
5434
|
/**
|
|
5435
|
+
* @public
|
|
4967
5436
|
* <p>The title of the patch.</p>
|
|
4968
5437
|
*/
|
|
4969
5438
|
Title?: string;
|
|
4970
5439
|
/**
|
|
5440
|
+
* @public
|
|
4971
5441
|
* <p>The description of the patch.</p>
|
|
4972
5442
|
*/
|
|
4973
5443
|
Description?: string;
|
|
4974
5444
|
/**
|
|
5445
|
+
* @public
|
|
4975
5446
|
* <p>The URL where more information can be obtained about the patch.</p>
|
|
4976
5447
|
*/
|
|
4977
5448
|
ContentUrl?: string;
|
|
4978
5449
|
/**
|
|
5450
|
+
* @public
|
|
4979
5451
|
* <p>The name of the vendor providing the patch.</p>
|
|
4980
5452
|
*/
|
|
4981
5453
|
Vendor?: string;
|
|
4982
5454
|
/**
|
|
5455
|
+
* @public
|
|
4983
5456
|
* <p>The product family the patch is applicable for. For example, <code>Windows</code> or
|
|
4984
5457
|
* <code>Amazon Linux 2</code>.</p>
|
|
4985
5458
|
*/
|
|
4986
5459
|
ProductFamily?: string;
|
|
4987
5460
|
/**
|
|
5461
|
+
* @public
|
|
4988
5462
|
* <p>The specific product the patch is applicable for. For example,
|
|
4989
5463
|
* <code>WindowsServer2016</code> or <code>AmazonLinux2018.03</code>.</p>
|
|
4990
5464
|
*/
|
|
4991
5465
|
Product?: string;
|
|
4992
5466
|
/**
|
|
5467
|
+
* @public
|
|
4993
5468
|
* <p>The classification of the patch. For example, <code>SecurityUpdates</code>,
|
|
4994
5469
|
* <code>Updates</code>, or <code>CriticalUpdates</code>.</p>
|
|
4995
5470
|
*/
|
|
4996
5471
|
Classification?: string;
|
|
4997
5472
|
/**
|
|
5473
|
+
* @public
|
|
4998
5474
|
* <p>The severity of the patch, such as <code>Critical</code>, <code>Important</code>, or
|
|
4999
5475
|
* <code>Moderate</code>. Applies to Windows patches only.</p>
|
|
5000
5476
|
*/
|
|
5001
5477
|
MsrcSeverity?: string;
|
|
5002
5478
|
/**
|
|
5479
|
+
* @public
|
|
5003
5480
|
* <p>The Microsoft Knowledge Base ID of the patch. Applies to Windows patches only.</p>
|
|
5004
5481
|
*/
|
|
5005
5482
|
KbNumber?: string;
|
|
5006
5483
|
/**
|
|
5484
|
+
* @public
|
|
5007
5485
|
* <p>The ID of the Microsoft Security Response Center (MSRC) bulletin the patch is related to.
|
|
5008
5486
|
* For example, <code>MS14-045</code>. Applies to Windows patches only.</p>
|
|
5009
5487
|
*/
|
|
5010
5488
|
MsrcNumber?: string;
|
|
5011
5489
|
/**
|
|
5490
|
+
* @public
|
|
5012
5491
|
* <p>The language of the patch if it's language-specific.</p>
|
|
5013
5492
|
*/
|
|
5014
5493
|
Language?: string;
|
|
5015
5494
|
/**
|
|
5495
|
+
* @public
|
|
5016
5496
|
* <p>The Advisory ID of the patch. For example, <code>RHSA-2020:3779</code>. Applies to
|
|
5017
5497
|
* Linux-based managed nodes only.</p>
|
|
5018
5498
|
*/
|
|
5019
5499
|
AdvisoryIds?: string[];
|
|
5020
5500
|
/**
|
|
5501
|
+
* @public
|
|
5021
5502
|
* <p>The Bugzilla ID of the patch. For example, <code>1600646</code>. Applies to Linux-based
|
|
5022
5503
|
* managed nodes only.</p>
|
|
5023
5504
|
*/
|
|
5024
5505
|
BugzillaIds?: string[];
|
|
5025
5506
|
/**
|
|
5507
|
+
* @public
|
|
5026
5508
|
* <p>The Common Vulnerabilities and Exposures (CVE) ID of the patch. For example,
|
|
5027
5509
|
* <code>CVE-2011-3192</code>. Applies to Linux-based managed nodes only.</p>
|
|
5028
5510
|
*/
|
|
5029
5511
|
CVEIds?: string[];
|
|
5030
5512
|
/**
|
|
5513
|
+
* @public
|
|
5031
5514
|
* <p>The name of the patch. Applies to Linux-based managed nodes only.</p>
|
|
5032
5515
|
*/
|
|
5033
5516
|
Name?: string;
|
|
5034
5517
|
/**
|
|
5518
|
+
* @public
|
|
5035
5519
|
* <p>The epoch of the patch. For example in
|
|
5036
5520
|
* <code>pkg-example-EE-20180914-2.2.amzn1.noarch</code>, the epoch value is
|
|
5037
5521
|
* <code>20180914-2</code>. Applies to Linux-based managed nodes only.</p>
|
|
5038
5522
|
*/
|
|
5039
5523
|
Epoch?: number;
|
|
5040
5524
|
/**
|
|
5525
|
+
* @public
|
|
5041
5526
|
* <p>The version number of the patch. For example, in
|
|
5042
5527
|
* <code>example-pkg-1.710.10-2.7.abcd.x86_64</code>, the version number is indicated by
|
|
5043
5528
|
* <code>-1</code>. Applies to Linux-based managed nodes only.</p>
|
|
5044
5529
|
*/
|
|
5045
5530
|
Version?: string;
|
|
5046
5531
|
/**
|
|
5532
|
+
* @public
|
|
5047
5533
|
* <p>The particular release of a patch. For example, in
|
|
5048
5534
|
* <code>pkg-example-EE-20180914-2.2.amzn1.noarch</code>, the release is <code>2.amaz1</code>.
|
|
5049
5535
|
* Applies to Linux-based managed nodes only.</p>
|
|
5050
5536
|
*/
|
|
5051
5537
|
Release?: string;
|
|
5052
5538
|
/**
|
|
5539
|
+
* @public
|
|
5053
5540
|
* <p>The architecture of the patch. For example, in
|
|
5054
5541
|
* <code>example-pkg-0.710.10-2.7.abcd.x86_64</code>, the architecture is indicated by
|
|
5055
5542
|
* <code>x86_64</code>. Applies to Linux-based managed nodes only.</p>
|
|
5056
5543
|
*/
|
|
5057
5544
|
Arch?: string;
|
|
5058
5545
|
/**
|
|
5546
|
+
* @public
|
|
5059
5547
|
* <p>The severity level of the patch. For example, <code>CRITICAL</code> or
|
|
5060
5548
|
* <code>MODERATE</code>.</p>
|
|
5061
5549
|
*/
|
|
5062
5550
|
Severity?: string;
|
|
5063
5551
|
/**
|
|
5552
|
+
* @public
|
|
5064
5553
|
* <p>The source patch repository for the operating system and version, such as
|
|
5065
5554
|
* <code>trusty-security</code> for Ubuntu Server 14.04 LTE and <code>focal-security</code> for
|
|
5066
5555
|
* Ubuntu Server 20.04 LTE. Applies to Linux-based managed nodes only.</p>
|
|
@@ -5072,10 +5561,12 @@ export interface Patch {
|
|
|
5072
5561
|
*/
|
|
5073
5562
|
export interface DescribeAvailablePatchesResult {
|
|
5074
5563
|
/**
|
|
5564
|
+
* @public
|
|
5075
5565
|
* <p>An array of patches. Each entry in the array is a patch structure.</p>
|
|
5076
5566
|
*/
|
|
5077
5567
|
Patches?: Patch[];
|
|
5078
5568
|
/**
|
|
5569
|
+
* @public
|
|
5079
5570
|
* <p>The token to use when requesting the next set of items. If there are no additional items to
|
|
5080
5571
|
* return, the string is empty.</p>
|
|
5081
5572
|
*/
|
|
@@ -5086,15 +5577,18 @@ export interface DescribeAvailablePatchesResult {
|
|
|
5086
5577
|
*/
|
|
5087
5578
|
export interface DescribeDocumentRequest {
|
|
5088
5579
|
/**
|
|
5580
|
+
* @public
|
|
5089
5581
|
* <p>The name of the SSM document.</p>
|
|
5090
5582
|
*/
|
|
5091
5583
|
Name: string | undefined;
|
|
5092
5584
|
/**
|
|
5585
|
+
* @public
|
|
5093
5586
|
* <p>The document version for which you want information. Can be a specific version or the
|
|
5094
5587
|
* default version.</p>
|
|
5095
5588
|
*/
|
|
5096
5589
|
DocumentVersion?: string;
|
|
5097
5590
|
/**
|
|
5591
|
+
* @public
|
|
5098
5592
|
* <p>An optional field specifying the version of the artifact associated with the document. For
|
|
5099
5593
|
* example, "Release 12, Update 6". This value is unique across all versions of a document, and
|
|
5100
5594
|
* can't be changed.</p>
|
|
@@ -5106,6 +5600,7 @@ export interface DescribeDocumentRequest {
|
|
|
5106
5600
|
*/
|
|
5107
5601
|
export interface DescribeDocumentResult {
|
|
5108
5602
|
/**
|
|
5603
|
+
* @public
|
|
5109
5604
|
* <p>Information about the SSM document.</p>
|
|
5110
5605
|
*/
|
|
5111
5606
|
Document?: DocumentDescription;
|
|
@@ -5126,20 +5621,24 @@ export type DocumentPermissionType = (typeof DocumentPermissionType)[keyof typeo
|
|
|
5126
5621
|
*/
|
|
5127
5622
|
export interface DescribeDocumentPermissionRequest {
|
|
5128
5623
|
/**
|
|
5624
|
+
* @public
|
|
5129
5625
|
* <p>The name of the document for which you are the owner.</p>
|
|
5130
5626
|
*/
|
|
5131
5627
|
Name: string | undefined;
|
|
5132
5628
|
/**
|
|
5629
|
+
* @public
|
|
5133
5630
|
* <p>The permission type for the document. The permission type can be
|
|
5134
5631
|
* <i>Share</i>.</p>
|
|
5135
5632
|
*/
|
|
5136
5633
|
PermissionType: DocumentPermissionType | string | undefined;
|
|
5137
5634
|
/**
|
|
5635
|
+
* @public
|
|
5138
5636
|
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
5139
5637
|
* can specify in a subsequent call to get the next set of results.</p>
|
|
5140
5638
|
*/
|
|
5141
5639
|
MaxResults?: number;
|
|
5142
5640
|
/**
|
|
5641
|
+
* @public
|
|
5143
5642
|
* <p>The token for the next set of items to return. (You received this token from a previous
|
|
5144
5643
|
* call.)</p>
|
|
5145
5644
|
*/
|
|
@@ -5150,16 +5649,19 @@ export interface DescribeDocumentPermissionRequest {
|
|
|
5150
5649
|
*/
|
|
5151
5650
|
export interface DescribeDocumentPermissionResponse {
|
|
5152
5651
|
/**
|
|
5652
|
+
* @public
|
|
5153
5653
|
* <p>The account IDs that have permission to use this document. The ID can be either an
|
|
5154
5654
|
* Amazon Web Services account or <i>All</i>.</p>
|
|
5155
5655
|
*/
|
|
5156
5656
|
AccountIds?: string[];
|
|
5157
5657
|
/**
|
|
5658
|
+
* @public
|
|
5158
5659
|
* <p>A list of Amazon Web Services accounts where the current document is shared and the version shared with
|
|
5159
5660
|
* each account.</p>
|
|
5160
5661
|
*/
|
|
5161
5662
|
AccountSharingInfoList?: AccountSharingInfo[];
|
|
5162
5663
|
/**
|
|
5664
|
+
* @public
|
|
5163
5665
|
* <p>The token for the next set of items to return. Use this token to get the next set of
|
|
5164
5666
|
* results.</p>
|
|
5165
5667
|
*/
|
|
@@ -5184,15 +5686,18 @@ export declare class InvalidPermissionType extends __BaseException {
|
|
|
5184
5686
|
*/
|
|
5185
5687
|
export interface DescribeEffectiveInstanceAssociationsRequest {
|
|
5186
5688
|
/**
|
|
5689
|
+
* @public
|
|
5187
5690
|
* <p>The managed node ID for which you want to view all associations.</p>
|
|
5188
5691
|
*/
|
|
5189
5692
|
InstanceId: string | undefined;
|
|
5190
5693
|
/**
|
|
5694
|
+
* @public
|
|
5191
5695
|
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
5192
5696
|
* can specify in a subsequent call to get the next set of results.</p>
|
|
5193
5697
|
*/
|
|
5194
5698
|
MaxResults?: number;
|
|
5195
5699
|
/**
|
|
5700
|
+
* @public
|
|
5196
5701
|
* <p>The token for the next set of items to return. (You received this token from a previous
|
|
5197
5702
|
* call.)</p>
|
|
5198
5703
|
*/
|
|
@@ -5204,18 +5709,22 @@ export interface DescribeEffectiveInstanceAssociationsRequest {
|
|
|
5204
5709
|
*/
|
|
5205
5710
|
export interface InstanceAssociation {
|
|
5206
5711
|
/**
|
|
5712
|
+
* @public
|
|
5207
5713
|
* <p>The association ID.</p>
|
|
5208
5714
|
*/
|
|
5209
5715
|
AssociationId?: string;
|
|
5210
5716
|
/**
|
|
5717
|
+
* @public
|
|
5211
5718
|
* <p>The managed node ID.</p>
|
|
5212
5719
|
*/
|
|
5213
5720
|
InstanceId?: string;
|
|
5214
5721
|
/**
|
|
5722
|
+
* @public
|
|
5215
5723
|
* <p>The content of the association document for the managed node(s).</p>
|
|
5216
5724
|
*/
|
|
5217
5725
|
Content?: string;
|
|
5218
5726
|
/**
|
|
5727
|
+
* @public
|
|
5219
5728
|
* <p>Version information for the association on the managed node.</p>
|
|
5220
5729
|
*/
|
|
5221
5730
|
AssociationVersion?: string;
|
|
@@ -5225,10 +5734,12 @@ export interface InstanceAssociation {
|
|
|
5225
5734
|
*/
|
|
5226
5735
|
export interface DescribeEffectiveInstanceAssociationsResult {
|
|
5227
5736
|
/**
|
|
5737
|
+
* @public
|
|
5228
5738
|
* <p>The associations for the requested managed node.</p>
|
|
5229
5739
|
*/
|
|
5230
5740
|
Associations?: InstanceAssociation[];
|
|
5231
5741
|
/**
|
|
5742
|
+
* @public
|
|
5232
5743
|
* <p>The token to use when requesting the next set of items. If there are no additional items to
|
|
5233
5744
|
* return, the string is empty.</p>
|
|
5234
5745
|
*/
|
|
@@ -5239,14 +5750,17 @@ export interface DescribeEffectiveInstanceAssociationsResult {
|
|
|
5239
5750
|
*/
|
|
5240
5751
|
export interface DescribeEffectivePatchesForPatchBaselineRequest {
|
|
5241
5752
|
/**
|
|
5753
|
+
* @public
|
|
5242
5754
|
* <p>The ID of the patch baseline to retrieve the effective patches for.</p>
|
|
5243
5755
|
*/
|
|
5244
5756
|
BaselineId: string | undefined;
|
|
5245
5757
|
/**
|
|
5758
|
+
* @public
|
|
5246
5759
|
* <p>The maximum number of patches to return (per page).</p>
|
|
5247
5760
|
*/
|
|
5248
5761
|
MaxResults?: number;
|
|
5249
5762
|
/**
|
|
5763
|
+
* @public
|
|
5250
5764
|
* <p>The token for the next set of items to return. (You received this token from a previous
|
|
5251
5765
|
* call.)</p>
|
|
5252
5766
|
*/
|
|
@@ -5272,14 +5786,17 @@ export type PatchDeploymentStatus = (typeof PatchDeploymentStatus)[keyof typeof
|
|
|
5272
5786
|
*/
|
|
5273
5787
|
export interface PatchStatus {
|
|
5274
5788
|
/**
|
|
5789
|
+
* @public
|
|
5275
5790
|
* <p>The approval status of a patch.</p>
|
|
5276
5791
|
*/
|
|
5277
5792
|
DeploymentStatus?: PatchDeploymentStatus | string;
|
|
5278
5793
|
/**
|
|
5794
|
+
* @public
|
|
5279
5795
|
* <p>The compliance severity level for a patch.</p>
|
|
5280
5796
|
*/
|
|
5281
5797
|
ComplianceLevel?: PatchComplianceLevel | string;
|
|
5282
5798
|
/**
|
|
5799
|
+
* @public
|
|
5283
5800
|
* <p>The date the patch was approved (or will be approved if the status is
|
|
5284
5801
|
* <code>PENDING_APPROVAL</code>).</p>
|
|
5285
5802
|
*/
|
|
@@ -5295,11 +5812,13 @@ export interface PatchStatus {
|
|
|
5295
5812
|
*/
|
|
5296
5813
|
export interface EffectivePatch {
|
|
5297
5814
|
/**
|
|
5815
|
+
* @public
|
|
5298
5816
|
* <p>Provides metadata for a patch, including information such as the KB ID, severity,
|
|
5299
5817
|
* classification and a URL for where more information can be obtained about the patch.</p>
|
|
5300
5818
|
*/
|
|
5301
5819
|
Patch?: Patch;
|
|
5302
5820
|
/**
|
|
5821
|
+
* @public
|
|
5303
5822
|
* <p>The status of the patch in a patch baseline. This includes information about whether the
|
|
5304
5823
|
* patch is currently approved, due to be approved by a rule, explicitly approved, or explicitly
|
|
5305
5824
|
* rejected and the date the patch was or will be approved.</p>
|
|
@@ -5311,10 +5830,12 @@ export interface EffectivePatch {
|
|
|
5311
5830
|
*/
|
|
5312
5831
|
export interface DescribeEffectivePatchesForPatchBaselineResult {
|
|
5313
5832
|
/**
|
|
5833
|
+
* @public
|
|
5314
5834
|
* <p>An array of patches and patch status.</p>
|
|
5315
5835
|
*/
|
|
5316
5836
|
EffectivePatches?: EffectivePatch[];
|
|
5317
5837
|
/**
|
|
5838
|
+
* @public
|
|
5318
5839
|
* <p>The token to use when requesting the next set of items. If there are no additional items to
|
|
5319
5840
|
* return, the string is empty.</p>
|
|
5320
5841
|
*/
|
|
@@ -5339,15 +5860,18 @@ export declare class UnsupportedOperatingSystem extends __BaseException {
|
|
|
5339
5860
|
*/
|
|
5340
5861
|
export interface DescribeInstanceAssociationsStatusRequest {
|
|
5341
5862
|
/**
|
|
5863
|
+
* @public
|
|
5342
5864
|
* <p>The managed node IDs for which you want association status information.</p>
|
|
5343
5865
|
*/
|
|
5344
5866
|
InstanceId: string | undefined;
|
|
5345
5867
|
/**
|
|
5868
|
+
* @public
|
|
5346
5869
|
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
5347
5870
|
* can specify in a subsequent call to get the next set of results.</p>
|
|
5348
5871
|
*/
|
|
5349
5872
|
MaxResults?: number;
|
|
5350
5873
|
/**
|
|
5874
|
+
* @public
|
|
5351
5875
|
* <p>The token for the next set of items to return. (You received this token from a previous
|
|
5352
5876
|
* call.)</p>
|
|
5353
5877
|
*/
|
|
@@ -5360,6 +5884,7 @@ export interface DescribeInstanceAssociationsStatusRequest {
|
|
|
5360
5884
|
*/
|
|
5361
5885
|
export interface S3OutputUrl {
|
|
5362
5886
|
/**
|
|
5887
|
+
* @public
|
|
5363
5888
|
* <p>A URL for an S3 bucket where you want to store the results of this request.</p>
|
|
5364
5889
|
*/
|
|
5365
5890
|
OutputUrl?: string;
|
|
@@ -5370,6 +5895,7 @@ export interface S3OutputUrl {
|
|
|
5370
5895
|
*/
|
|
5371
5896
|
export interface InstanceAssociationOutputUrl {
|
|
5372
5897
|
/**
|
|
5898
|
+
* @public
|
|
5373
5899
|
* <p>The URL of S3 bucket where you want to store the results of this request.</p>
|
|
5374
5900
|
*/
|
|
5375
5901
|
S3OutputUrl?: S3OutputUrl;
|
|
@@ -5380,50 +5906,62 @@ export interface InstanceAssociationOutputUrl {
|
|
|
5380
5906
|
*/
|
|
5381
5907
|
export interface InstanceAssociationStatusInfo {
|
|
5382
5908
|
/**
|
|
5909
|
+
* @public
|
|
5383
5910
|
* <p>The association ID.</p>
|
|
5384
5911
|
*/
|
|
5385
5912
|
AssociationId?: string;
|
|
5386
5913
|
/**
|
|
5914
|
+
* @public
|
|
5387
5915
|
* <p>The name of the association.</p>
|
|
5388
5916
|
*/
|
|
5389
5917
|
Name?: string;
|
|
5390
5918
|
/**
|
|
5919
|
+
* @public
|
|
5391
5920
|
* <p>The association document versions.</p>
|
|
5392
5921
|
*/
|
|
5393
5922
|
DocumentVersion?: string;
|
|
5394
5923
|
/**
|
|
5924
|
+
* @public
|
|
5395
5925
|
* <p>The version of the association applied to the managed node.</p>
|
|
5396
5926
|
*/
|
|
5397
5927
|
AssociationVersion?: string;
|
|
5398
5928
|
/**
|
|
5929
|
+
* @public
|
|
5399
5930
|
* <p>The managed node ID where the association was created.</p>
|
|
5400
5931
|
*/
|
|
5401
5932
|
InstanceId?: string;
|
|
5402
5933
|
/**
|
|
5934
|
+
* @public
|
|
5403
5935
|
* <p>The date the association ran. </p>
|
|
5404
5936
|
*/
|
|
5405
5937
|
ExecutionDate?: Date;
|
|
5406
5938
|
/**
|
|
5939
|
+
* @public
|
|
5407
5940
|
* <p>Status information about the association.</p>
|
|
5408
5941
|
*/
|
|
5409
5942
|
Status?: string;
|
|
5410
5943
|
/**
|
|
5944
|
+
* @public
|
|
5411
5945
|
* <p>Detailed status information about the association.</p>
|
|
5412
5946
|
*/
|
|
5413
5947
|
DetailedStatus?: string;
|
|
5414
5948
|
/**
|
|
5949
|
+
* @public
|
|
5415
5950
|
* <p>Summary information about association execution.</p>
|
|
5416
5951
|
*/
|
|
5417
5952
|
ExecutionSummary?: string;
|
|
5418
5953
|
/**
|
|
5954
|
+
* @public
|
|
5419
5955
|
* <p>An error code returned by the request to create the association.</p>
|
|
5420
5956
|
*/
|
|
5421
5957
|
ErrorCode?: string;
|
|
5422
5958
|
/**
|
|
5959
|
+
* @public
|
|
5423
5960
|
* <p>A URL for an S3 bucket where you want to store the results of this request.</p>
|
|
5424
5961
|
*/
|
|
5425
5962
|
OutputUrl?: InstanceAssociationOutputUrl;
|
|
5426
5963
|
/**
|
|
5964
|
+
* @public
|
|
5427
5965
|
* <p>The name of the association applied to the managed node.</p>
|
|
5428
5966
|
*/
|
|
5429
5967
|
AssociationName?: string;
|
|
@@ -5433,10 +5971,12 @@ export interface InstanceAssociationStatusInfo {
|
|
|
5433
5971
|
*/
|
|
5434
5972
|
export interface DescribeInstanceAssociationsStatusResult {
|
|
5435
5973
|
/**
|
|
5974
|
+
* @public
|
|
5436
5975
|
* <p>Status information about the association.</p>
|
|
5437
5976
|
*/
|
|
5438
5977
|
InstanceAssociationStatusInfos?: InstanceAssociationStatusInfo[];
|
|
5439
5978
|
/**
|
|
5979
|
+
* @public
|
|
5440
5980
|
* <p>The token to use when requesting the next set of items. If there are no additional items to
|
|
5441
5981
|
* return, the string is empty.</p>
|
|
5442
5982
|
*/
|
|
@@ -5448,6 +5988,7 @@ export interface DescribeInstanceAssociationsStatusResult {
|
|
|
5448
5988
|
*/
|
|
5449
5989
|
export interface InstanceInformationStringFilter {
|
|
5450
5990
|
/**
|
|
5991
|
+
* @public
|
|
5451
5992
|
* <p>The filter key name to describe your managed nodes.</p>
|
|
5452
5993
|
* <p>Valid filter key values: ActivationIds | AgentVersion | AssociationStatus | IamRole |
|
|
5453
5994
|
* InstanceIds | PingStatus | PlatformTypes | ResourceType | SourceIds | SourceTypes | "tag-key" |
|
|
@@ -5481,6 +6022,7 @@ export interface InstanceInformationStringFilter {
|
|
|
5481
6022
|
*/
|
|
5482
6023
|
Key: string | undefined;
|
|
5483
6024
|
/**
|
|
6025
|
+
* @public
|
|
5484
6026
|
* <p>The filter values.</p>
|
|
5485
6027
|
*/
|
|
5486
6028
|
Values: string[] | undefined;
|
|
@@ -5513,10 +6055,12 @@ export type InstanceInformationFilterKey = (typeof InstanceInformationFilterKey)
|
|
|
5513
6055
|
*/
|
|
5514
6056
|
export interface InstanceInformationFilter {
|
|
5515
6057
|
/**
|
|
6058
|
+
* @public
|
|
5516
6059
|
* <p>The name of the filter. </p>
|
|
5517
6060
|
*/
|
|
5518
6061
|
key: InstanceInformationFilterKey | string | undefined;
|
|
5519
6062
|
/**
|
|
6063
|
+
* @public
|
|
5520
6064
|
* <p>The filter values.</p>
|
|
5521
6065
|
*/
|
|
5522
6066
|
valueSet: string[] | undefined;
|
|
@@ -5526,6 +6070,7 @@ export interface InstanceInformationFilter {
|
|
|
5526
6070
|
*/
|
|
5527
6071
|
export interface DescribeInstanceInformationRequest {
|
|
5528
6072
|
/**
|
|
6073
|
+
* @public
|
|
5529
6074
|
* <p>This is a legacy method. We recommend that you don't use this method. Instead, use the
|
|
5530
6075
|
* <code>Filters</code> data type. <code>Filters</code> enables you to return node information by
|
|
5531
6076
|
* filtering based on tags applied to managed nodes.</p>
|
|
@@ -5536,6 +6081,7 @@ export interface DescribeInstanceInformationRequest {
|
|
|
5536
6081
|
*/
|
|
5537
6082
|
InstanceInformationFilterList?: InstanceInformationFilter[];
|
|
5538
6083
|
/**
|
|
6084
|
+
* @public
|
|
5539
6085
|
* <p>One or more filters. Use a filter to return a more specific list of managed nodes. You can
|
|
5540
6086
|
* filter based on tags applied to your managed nodes. Tag filters can't be combined with other
|
|
5541
6087
|
* filter types. Use this <code>Filters</code> data type instead of
|
|
@@ -5543,12 +6089,14 @@ export interface DescribeInstanceInformationRequest {
|
|
|
5543
6089
|
*/
|
|
5544
6090
|
Filters?: InstanceInformationStringFilter[];
|
|
5545
6091
|
/**
|
|
6092
|
+
* @public
|
|
5546
6093
|
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
5547
6094
|
* can specify in a subsequent call to get the next set of results. The default value is 10 items.
|
|
5548
6095
|
* </p>
|
|
5549
6096
|
*/
|
|
5550
6097
|
MaxResults?: number;
|
|
5551
6098
|
/**
|
|
6099
|
+
* @public
|
|
5552
6100
|
* <p>The token for the next set of items to return. (You received this token from a previous
|
|
5553
6101
|
* call.)</p>
|
|
5554
6102
|
*/
|
|
@@ -5560,10 +6108,12 @@ export interface DescribeInstanceInformationRequest {
|
|
|
5560
6108
|
*/
|
|
5561
6109
|
export interface InstanceAggregatedAssociationOverview {
|
|
5562
6110
|
/**
|
|
6111
|
+
* @public
|
|
5563
6112
|
* <p>Detailed status information about the aggregated associations.</p>
|
|
5564
6113
|
*/
|
|
5565
6114
|
DetailedStatus?: string;
|
|
5566
6115
|
/**
|
|
6116
|
+
* @public
|
|
5567
6117
|
* <p>The number of associations for the managed node(s).</p>
|
|
5568
6118
|
*/
|
|
5569
6119
|
InstanceAssociationStatusAggregatedCount?: Record<string, number>;
|
|
@@ -5613,10 +6163,12 @@ export type SourceType = (typeof SourceType)[keyof typeof SourceType];
|
|
|
5613
6163
|
*/
|
|
5614
6164
|
export interface InstanceInformation {
|
|
5615
6165
|
/**
|
|
6166
|
+
* @public
|
|
5616
6167
|
* <p>The managed node ID. </p>
|
|
5617
6168
|
*/
|
|
5618
6169
|
InstanceId?: string;
|
|
5619
6170
|
/**
|
|
6171
|
+
* @public
|
|
5620
6172
|
* <p>Connection status of SSM Agent. </p>
|
|
5621
6173
|
* <note>
|
|
5622
6174
|
* <p>The status <code>Inactive</code> has been deprecated and is no longer in use.</p>
|
|
@@ -5624,14 +6176,17 @@ export interface InstanceInformation {
|
|
|
5624
6176
|
*/
|
|
5625
6177
|
PingStatus?: PingStatus | string;
|
|
5626
6178
|
/**
|
|
6179
|
+
* @public
|
|
5627
6180
|
* <p>The date and time when the agent last pinged the Systems Manager service. </p>
|
|
5628
6181
|
*/
|
|
5629
6182
|
LastPingDateTime?: Date;
|
|
5630
6183
|
/**
|
|
6184
|
+
* @public
|
|
5631
6185
|
* <p>The version of SSM Agent running on your Linux managed node. </p>
|
|
5632
6186
|
*/
|
|
5633
6187
|
AgentVersion?: string;
|
|
5634
6188
|
/**
|
|
6189
|
+
* @public
|
|
5635
6190
|
* <p>Indicates whether the latest version of SSM Agent is running on your Linux managed node. This
|
|
5636
6191
|
* field doesn't indicate whether or not the latest version is installed on Windows managed nodes,
|
|
5637
6192
|
* because some older versions of Windows Server use the EC2Config service to process Systems Manager
|
|
@@ -5639,23 +6194,28 @@ export interface InstanceInformation {
|
|
|
5639
6194
|
*/
|
|
5640
6195
|
IsLatestVersion?: boolean;
|
|
5641
6196
|
/**
|
|
6197
|
+
* @public
|
|
5642
6198
|
* <p>The operating system platform type. </p>
|
|
5643
6199
|
*/
|
|
5644
6200
|
PlatformType?: PlatformType | string;
|
|
5645
6201
|
/**
|
|
6202
|
+
* @public
|
|
5646
6203
|
* <p>The name of the operating system platform running on your managed node. </p>
|
|
5647
6204
|
*/
|
|
5648
6205
|
PlatformName?: string;
|
|
5649
6206
|
/**
|
|
6207
|
+
* @public
|
|
5650
6208
|
* <p>The version of the OS platform running on your managed node. </p>
|
|
5651
6209
|
*/
|
|
5652
6210
|
PlatformVersion?: string;
|
|
5653
6211
|
/**
|
|
6212
|
+
* @public
|
|
5654
6213
|
* <p>The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was
|
|
5655
6214
|
* registered.</p>
|
|
5656
6215
|
*/
|
|
5657
6216
|
ActivationId?: string;
|
|
5658
6217
|
/**
|
|
6218
|
+
* @public
|
|
5659
6219
|
* <p>The Identity and Access Management (IAM) role assigned to the on-premises Systems Manager
|
|
5660
6220
|
* managed node. This call doesn't return the IAM role for Amazon Elastic Compute Cloud
|
|
5661
6221
|
* (Amazon EC2) instances. To retrieve the IAM role for an EC2 instance, use
|
|
@@ -5663,14 +6223,17 @@ export interface InstanceInformation {
|
|
|
5663
6223
|
*/
|
|
5664
6224
|
IamRole?: string;
|
|
5665
6225
|
/**
|
|
6226
|
+
* @public
|
|
5666
6227
|
* <p>The date the server or VM was registered with Amazon Web Services as a managed node.</p>
|
|
5667
6228
|
*/
|
|
5668
6229
|
RegistrationDate?: Date;
|
|
5669
6230
|
/**
|
|
6231
|
+
* @public
|
|
5670
6232
|
* <p>The type of instance. Instances are either EC2 instances or managed instances. </p>
|
|
5671
6233
|
*/
|
|
5672
6234
|
ResourceType?: ResourceType | string;
|
|
5673
6235
|
/**
|
|
6236
|
+
* @public
|
|
5674
6237
|
* <p>The name assigned to an on-premises server, edge device, or virtual machine (VM) when it is
|
|
5675
6238
|
* activated as a Systems Manager managed node. The name is specified as the <code>DefaultInstanceName</code>
|
|
5676
6239
|
* property using the <a>CreateActivation</a> command. It is applied to the managed node
|
|
@@ -5682,35 +6245,43 @@ export interface InstanceInformation {
|
|
|
5682
6245
|
*/
|
|
5683
6246
|
Name?: string;
|
|
5684
6247
|
/**
|
|
6248
|
+
* @public
|
|
5685
6249
|
* <p>The IP address of the managed node.</p>
|
|
5686
6250
|
*/
|
|
5687
6251
|
IPAddress?: string;
|
|
5688
6252
|
/**
|
|
6253
|
+
* @public
|
|
5689
6254
|
* <p>The fully qualified host name of the managed node.</p>
|
|
5690
6255
|
*/
|
|
5691
6256
|
ComputerName?: string;
|
|
5692
6257
|
/**
|
|
6258
|
+
* @public
|
|
5693
6259
|
* <p>The status of the association.</p>
|
|
5694
6260
|
*/
|
|
5695
6261
|
AssociationStatus?: string;
|
|
5696
6262
|
/**
|
|
6263
|
+
* @public
|
|
5697
6264
|
* <p>The date the association was last run.</p>
|
|
5698
6265
|
*/
|
|
5699
6266
|
LastAssociationExecutionDate?: Date;
|
|
5700
6267
|
/**
|
|
6268
|
+
* @public
|
|
5701
6269
|
* <p>The last date the association was successfully run.</p>
|
|
5702
6270
|
*/
|
|
5703
6271
|
LastSuccessfulAssociationExecutionDate?: Date;
|
|
5704
6272
|
/**
|
|
6273
|
+
* @public
|
|
5705
6274
|
* <p>Information about the association.</p>
|
|
5706
6275
|
*/
|
|
5707
6276
|
AssociationOverview?: InstanceAggregatedAssociationOverview;
|
|
5708
6277
|
/**
|
|
6278
|
+
* @public
|
|
5709
6279
|
* <p>The ID of the source resource. For IoT Greengrass devices, <code>SourceId</code> is
|
|
5710
6280
|
* the Thing name. </p>
|
|
5711
6281
|
*/
|
|
5712
6282
|
SourceId?: string;
|
|
5713
6283
|
/**
|
|
6284
|
+
* @public
|
|
5714
6285
|
* <p>The type of the source resource. For IoT Greengrass devices, <code>SourceType</code>
|
|
5715
6286
|
* is <code>AWS::IoT::Thing</code>. </p>
|
|
5716
6287
|
*/
|
|
@@ -5721,10 +6292,12 @@ export interface InstanceInformation {
|
|
|
5721
6292
|
*/
|
|
5722
6293
|
export interface DescribeInstanceInformationResult {
|
|
5723
6294
|
/**
|
|
6295
|
+
* @public
|
|
5724
6296
|
* <p>The managed node information list.</p>
|
|
5725
6297
|
*/
|
|
5726
6298
|
InstanceInformationList?: InstanceInformation[];
|
|
5727
6299
|
/**
|
|
6300
|
+
* @public
|
|
5728
6301
|
* <p>The token to use when requesting the next set of items. If there are no additional items to
|
|
5729
6302
|
* return, the string is empty. </p>
|
|
5730
6303
|
*/
|
|
@@ -5747,10 +6320,12 @@ export declare class InvalidInstanceInformationFilterValue extends __BaseExcepti
|
|
|
5747
6320
|
*/
|
|
5748
6321
|
export interface DescribeInstancePatchesRequest {
|
|
5749
6322
|
/**
|
|
6323
|
+
* @public
|
|
5750
6324
|
* <p>The ID of the managed node whose patch state information should be retrieved.</p>
|
|
5751
6325
|
*/
|
|
5752
6326
|
InstanceId: string | undefined;
|
|
5753
6327
|
/**
|
|
6328
|
+
* @public
|
|
5754
6329
|
* <p>Each element in the array is a structure containing a key-value pair.</p>
|
|
5755
6330
|
* <p>Supported keys for <code>DescribeInstancePatches</code>include the following:</p>
|
|
5756
6331
|
* <ul>
|
|
@@ -5795,11 +6370,13 @@ export interface DescribeInstancePatchesRequest {
|
|
|
5795
6370
|
*/
|
|
5796
6371
|
Filters?: PatchOrchestratorFilter[];
|
|
5797
6372
|
/**
|
|
6373
|
+
* @public
|
|
5798
6374
|
* <p>The token for the next set of items to return. (You received this token from a previous
|
|
5799
6375
|
* call.)</p>
|
|
5800
6376
|
*/
|
|
5801
6377
|
NextToken?: string;
|
|
5802
6378
|
/**
|
|
6379
|
+
* @public
|
|
5803
6380
|
* <p>The maximum number of patches to return (per page).</p>
|
|
5804
6381
|
*/
|
|
5805
6382
|
MaxResults?: number;
|
|
@@ -5828,34 +6405,41 @@ export type PatchComplianceDataState = (typeof PatchComplianceDataState)[keyof t
|
|
|
5828
6405
|
*/
|
|
5829
6406
|
export interface PatchComplianceData {
|
|
5830
6407
|
/**
|
|
6408
|
+
* @public
|
|
5831
6409
|
* <p>The title of the patch.</p>
|
|
5832
6410
|
*/
|
|
5833
6411
|
Title: string | undefined;
|
|
5834
6412
|
/**
|
|
6413
|
+
* @public
|
|
5835
6414
|
* <p>The operating system-specific ID of the patch.</p>
|
|
5836
6415
|
*/
|
|
5837
6416
|
KBId: string | undefined;
|
|
5838
6417
|
/**
|
|
6418
|
+
* @public
|
|
5839
6419
|
* <p>The classification of the patch, such as <code>SecurityUpdates</code>, <code>Updates</code>,
|
|
5840
6420
|
* and <code>CriticalUpdates</code>.</p>
|
|
5841
6421
|
*/
|
|
5842
6422
|
Classification: string | undefined;
|
|
5843
6423
|
/**
|
|
6424
|
+
* @public
|
|
5844
6425
|
* <p>The severity of the patch such as <code>Critical</code>, <code>Important</code>, and
|
|
5845
6426
|
* <code>Moderate</code>.</p>
|
|
5846
6427
|
*/
|
|
5847
6428
|
Severity: string | undefined;
|
|
5848
6429
|
/**
|
|
6430
|
+
* @public
|
|
5849
6431
|
* <p>The state of the patch on the managed node, such as INSTALLED or FAILED.</p>
|
|
5850
6432
|
* <p>For descriptions of each patch state, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-compliance-about.html#sysman-compliance-monitor-patch">About patch compliance</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
5851
6433
|
*/
|
|
5852
6434
|
State: PatchComplianceDataState | string | undefined;
|
|
5853
6435
|
/**
|
|
6436
|
+
* @public
|
|
5854
6437
|
* <p>The date/time the patch was installed on the managed node. Not all operating systems provide
|
|
5855
6438
|
* this level of information.</p>
|
|
5856
6439
|
*/
|
|
5857
6440
|
InstalledTime: Date | undefined;
|
|
5858
6441
|
/**
|
|
6442
|
+
* @public
|
|
5859
6443
|
* <p>The IDs of one or more Common Vulnerabilities and Exposure (CVE) issues that are resolved by
|
|
5860
6444
|
* the patch.</p>
|
|
5861
6445
|
*/
|
|
@@ -5866,6 +6450,7 @@ export interface PatchComplianceData {
|
|
|
5866
6450
|
*/
|
|
5867
6451
|
export interface DescribeInstancePatchesResult {
|
|
5868
6452
|
/**
|
|
6453
|
+
* @public
|
|
5869
6454
|
* <p>Each entry in the array is a structure containing:</p>
|
|
5870
6455
|
* <ul>
|
|
5871
6456
|
* <li>
|
|
@@ -5893,6 +6478,7 @@ export interface DescribeInstancePatchesResult {
|
|
|
5893
6478
|
*/
|
|
5894
6479
|
Patches?: PatchComplianceData[];
|
|
5895
6480
|
/**
|
|
6481
|
+
* @public
|
|
5896
6482
|
* <p>The token to use when requesting the next set of items. If there are no additional items to
|
|
5897
6483
|
* return, the string is empty.</p>
|
|
5898
6484
|
*/
|
|
@@ -5903,15 +6489,18 @@ export interface DescribeInstancePatchesResult {
|
|
|
5903
6489
|
*/
|
|
5904
6490
|
export interface DescribeInstancePatchStatesRequest {
|
|
5905
6491
|
/**
|
|
6492
|
+
* @public
|
|
5906
6493
|
* <p>The ID of the managed node for which patch state information should be retrieved.</p>
|
|
5907
6494
|
*/
|
|
5908
6495
|
InstanceIds: string[] | undefined;
|
|
5909
6496
|
/**
|
|
6497
|
+
* @public
|
|
5910
6498
|
* <p>The token for the next set of items to return. (You received this token from a previous
|
|
5911
6499
|
* call.)</p>
|
|
5912
6500
|
*/
|
|
5913
6501
|
NextToken?: string;
|
|
5914
6502
|
/**
|
|
6503
|
+
* @public
|
|
5915
6504
|
* <p>The maximum number of managed nodes to return (per page).</p>
|
|
5916
6505
|
*/
|
|
5917
6506
|
MaxResults?: number;
|
|
@@ -5948,24 +6537,29 @@ export type RebootOption = (typeof RebootOption)[keyof typeof RebootOption];
|
|
|
5948
6537
|
*/
|
|
5949
6538
|
export interface InstancePatchState {
|
|
5950
6539
|
/**
|
|
6540
|
+
* @public
|
|
5951
6541
|
* <p>The ID of the managed node the high-level patch compliance information was collected
|
|
5952
6542
|
* for.</p>
|
|
5953
6543
|
*/
|
|
5954
6544
|
InstanceId: string | undefined;
|
|
5955
6545
|
/**
|
|
6546
|
+
* @public
|
|
5956
6547
|
* <p>The name of the patch group the managed node belongs to.</p>
|
|
5957
6548
|
*/
|
|
5958
6549
|
PatchGroup: string | undefined;
|
|
5959
6550
|
/**
|
|
6551
|
+
* @public
|
|
5960
6552
|
* <p>The ID of the patch baseline used to patch the managed node.</p>
|
|
5961
6553
|
*/
|
|
5962
6554
|
BaselineId: string | undefined;
|
|
5963
6555
|
/**
|
|
6556
|
+
* @public
|
|
5964
6557
|
* <p>The ID of the patch baseline snapshot used during the patching operation when this
|
|
5965
6558
|
* compliance data was collected.</p>
|
|
5966
6559
|
*/
|
|
5967
6560
|
SnapshotId?: string;
|
|
5968
6561
|
/**
|
|
6562
|
+
* @public
|
|
5969
6563
|
* <p>An https URL or an Amazon Simple Storage Service (Amazon S3) path-style URL to a list of
|
|
5970
6564
|
* patches to be installed. This patch installation list, which you maintain in an S3 bucket in YAML
|
|
5971
6565
|
* format and specify in the SSM document <code>AWS-RunPatchBaseline</code>, overrides the patches
|
|
@@ -5977,25 +6571,30 @@ export interface InstancePatchState {
|
|
|
5977
6571
|
*/
|
|
5978
6572
|
InstallOverrideList?: string;
|
|
5979
6573
|
/**
|
|
6574
|
+
* @public
|
|
5980
6575
|
* <p>Placeholder information. This field will always be empty in the current release of the
|
|
5981
6576
|
* service.</p>
|
|
5982
6577
|
*/
|
|
5983
6578
|
OwnerInformation?: string;
|
|
5984
6579
|
/**
|
|
6580
|
+
* @public
|
|
5985
6581
|
* <p>The number of patches from the patch baseline that are installed on the managed node.</p>
|
|
5986
6582
|
*/
|
|
5987
6583
|
InstalledCount?: number;
|
|
5988
6584
|
/**
|
|
6585
|
+
* @public
|
|
5989
6586
|
* <p>The number of patches not specified in the patch baseline that are installed on the managed
|
|
5990
6587
|
* node.</p>
|
|
5991
6588
|
*/
|
|
5992
6589
|
InstalledOtherCount?: number;
|
|
5993
6590
|
/**
|
|
6591
|
+
* @public
|
|
5994
6592
|
* <p>The number of patches installed by Patch Manager since the last time the managed node was
|
|
5995
6593
|
* rebooted.</p>
|
|
5996
6594
|
*/
|
|
5997
6595
|
InstalledPendingRebootCount?: number;
|
|
5998
6596
|
/**
|
|
6597
|
+
* @public
|
|
5999
6598
|
* <p>The number of patches installed on a managed node that are specified in a
|
|
6000
6599
|
* <code>RejectedPatches</code> list. Patches with a status of <code>InstalledRejected</code> were
|
|
6001
6600
|
* typically installed before they were added to a <code>RejectedPatches</code> list.</p>
|
|
@@ -6007,21 +6606,25 @@ export interface InstancePatchState {
|
|
|
6007
6606
|
*/
|
|
6008
6607
|
InstalledRejectedCount?: number;
|
|
6009
6608
|
/**
|
|
6609
|
+
* @public
|
|
6010
6610
|
* <p>The number of patches from the patch baseline that are applicable for the managed node but
|
|
6011
6611
|
* aren't currently installed.</p>
|
|
6012
6612
|
*/
|
|
6013
6613
|
MissingCount?: number;
|
|
6014
6614
|
/**
|
|
6615
|
+
* @public
|
|
6015
6616
|
* <p>The number of patches from the patch baseline that were attempted to be installed during the
|
|
6016
6617
|
* last patching operation, but failed to install.</p>
|
|
6017
6618
|
*/
|
|
6018
6619
|
FailedCount?: number;
|
|
6019
6620
|
/**
|
|
6621
|
+
* @public
|
|
6020
6622
|
* <p>The number of patches beyond the supported limit of <code>NotApplicableCount</code> that
|
|
6021
6623
|
* aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.</p>
|
|
6022
6624
|
*/
|
|
6023
6625
|
UnreportedNotApplicableCount?: number;
|
|
6024
6626
|
/**
|
|
6627
|
+
* @public
|
|
6025
6628
|
* <p>The number of patches from the patch baseline that aren't applicable for the managed node
|
|
6026
6629
|
* and therefore aren't installed on the node. This number may be truncated if the list of patch
|
|
6027
6630
|
* names is very large. The number of patches beyond this limit are reported in
|
|
@@ -6029,14 +6632,17 @@ export interface InstancePatchState {
|
|
|
6029
6632
|
*/
|
|
6030
6633
|
NotApplicableCount?: number;
|
|
6031
6634
|
/**
|
|
6635
|
+
* @public
|
|
6032
6636
|
* <p>The time the most recent patching operation was started on the managed node.</p>
|
|
6033
6637
|
*/
|
|
6034
6638
|
OperationStartTime: Date | undefined;
|
|
6035
6639
|
/**
|
|
6640
|
+
* @public
|
|
6036
6641
|
* <p>The time the most recent patching operation completed on the managed node.</p>
|
|
6037
6642
|
*/
|
|
6038
6643
|
OperationEndTime: Date | undefined;
|
|
6039
6644
|
/**
|
|
6645
|
+
* @public
|
|
6040
6646
|
* <p>The type of patching operation that was performed: or </p>
|
|
6041
6647
|
* <ul>
|
|
6042
6648
|
* <li>
|
|
@@ -6051,11 +6657,13 @@ export interface InstancePatchState {
|
|
|
6051
6657
|
*/
|
|
6052
6658
|
Operation: PatchOperationType | string | undefined;
|
|
6053
6659
|
/**
|
|
6660
|
+
* @public
|
|
6054
6661
|
* <p>The time of the last attempt to patch the managed node with <code>NoReboot</code> specified
|
|
6055
6662
|
* as the reboot option.</p>
|
|
6056
6663
|
*/
|
|
6057
6664
|
LastNoRebootInstallOperationTime?: Date;
|
|
6058
6665
|
/**
|
|
6666
|
+
* @public
|
|
6059
6667
|
* <p>Indicates the reboot option specified in the patch baseline.</p>
|
|
6060
6668
|
* <note>
|
|
6061
6669
|
* <p>Reboot options apply to <code>Install</code> operations only. Reboots aren't attempted for
|
|
@@ -6079,6 +6687,7 @@ export interface InstancePatchState {
|
|
|
6079
6687
|
*/
|
|
6080
6688
|
RebootOption?: RebootOption | string;
|
|
6081
6689
|
/**
|
|
6690
|
+
* @public
|
|
6082
6691
|
* <p>The number of patches per node that are specified as <code>Critical</code> for compliance
|
|
6083
6692
|
* reporting in the patch baseline aren't installed. These patches might be missing, have failed
|
|
6084
6693
|
* installation, were rejected, or were installed but awaiting a required managed node reboot. The
|
|
@@ -6086,6 +6695,7 @@ export interface InstancePatchState {
|
|
|
6086
6695
|
*/
|
|
6087
6696
|
CriticalNonCompliantCount?: number;
|
|
6088
6697
|
/**
|
|
6698
|
+
* @public
|
|
6089
6699
|
* <p>The number of patches per node that are specified as <code>Security</code> in a patch
|
|
6090
6700
|
* advisory aren't installed. These patches might be missing, have failed installation, were
|
|
6091
6701
|
* rejected, or were installed but awaiting a required managed node reboot. The status of these
|
|
@@ -6093,6 +6703,7 @@ export interface InstancePatchState {
|
|
|
6093
6703
|
*/
|
|
6094
6704
|
SecurityNonCompliantCount?: number;
|
|
6095
6705
|
/**
|
|
6706
|
+
* @public
|
|
6096
6707
|
* <p>The number of patches per node that are specified as other than <code>Critical</code> or
|
|
6097
6708
|
* <code>Security</code> but aren't compliant with the patch baseline. The status of these managed
|
|
6098
6709
|
* nodes is <code>NON_COMPLIANT</code>.</p>
|
|
@@ -6104,10 +6715,12 @@ export interface InstancePatchState {
|
|
|
6104
6715
|
*/
|
|
6105
6716
|
export interface DescribeInstancePatchStatesResult {
|
|
6106
6717
|
/**
|
|
6718
|
+
* @public
|
|
6107
6719
|
* <p>The high-level patch state for the requested managed nodes.</p>
|
|
6108
6720
|
*/
|
|
6109
6721
|
InstancePatchStates?: InstancePatchState[];
|
|
6110
6722
|
/**
|
|
6723
|
+
* @public
|
|
6111
6724
|
* <p>The token to use when requesting the next set of items. If there are no additional items to
|
|
6112
6725
|
* return, the string is empty.</p>
|
|
6113
6726
|
*/
|
|
@@ -6152,6 +6765,7 @@ export type InstancePatchStateOperatorType = (typeof InstancePatchStateOperatorT
|
|
|
6152
6765
|
*/
|
|
6153
6766
|
export interface InstancePatchStateFilter {
|
|
6154
6767
|
/**
|
|
6768
|
+
* @public
|
|
6155
6769
|
* <p>The key for the filter. Supported values include the following:</p>
|
|
6156
6770
|
* <ul>
|
|
6157
6771
|
* <li>
|
|
@@ -6198,10 +6812,12 @@ export interface InstancePatchStateFilter {
|
|
|
6198
6812
|
*/
|
|
6199
6813
|
Key: string | undefined;
|
|
6200
6814
|
/**
|
|
6815
|
+
* @public
|
|
6201
6816
|
* <p>The value for the filter. Must be an integer greater than or equal to 0.</p>
|
|
6202
6817
|
*/
|
|
6203
6818
|
Values: string[] | undefined;
|
|
6204
6819
|
/**
|
|
6820
|
+
* @public
|
|
6205
6821
|
* <p>The type of comparison that should be performed for the value.</p>
|
|
6206
6822
|
*/
|
|
6207
6823
|
Type: InstancePatchStateOperatorType | string | undefined;
|
|
@@ -6211,11 +6827,13 @@ export interface InstancePatchStateFilter {
|
|
|
6211
6827
|
*/
|
|
6212
6828
|
export interface DescribeInstancePatchStatesForPatchGroupRequest {
|
|
6213
6829
|
/**
|
|
6830
|
+
* @public
|
|
6214
6831
|
* <p>The name of the patch group for which the patch state information should be
|
|
6215
6832
|
* retrieved.</p>
|
|
6216
6833
|
*/
|
|
6217
6834
|
PatchGroup: string | undefined;
|
|
6218
6835
|
/**
|
|
6836
|
+
* @public
|
|
6219
6837
|
* <p>Each entry in the array is a structure containing:</p>
|
|
6220
6838
|
* <ul>
|
|
6221
6839
|
* <li>
|
|
@@ -6231,11 +6849,13 @@ export interface DescribeInstancePatchStatesForPatchGroupRequest {
|
|
|
6231
6849
|
*/
|
|
6232
6850
|
Filters?: InstancePatchStateFilter[];
|
|
6233
6851
|
/**
|
|
6852
|
+
* @public
|
|
6234
6853
|
* <p>The token for the next set of items to return. (You received this token from a previous
|
|
6235
6854
|
* call.)</p>
|
|
6236
6855
|
*/
|
|
6237
6856
|
NextToken?: string;
|
|
6238
6857
|
/**
|
|
6858
|
+
* @public
|
|
6239
6859
|
* <p>The maximum number of patches to return (per page).</p>
|
|
6240
6860
|
*/
|
|
6241
6861
|
MaxResults?: number;
|
|
@@ -6245,10 +6865,12 @@ export interface DescribeInstancePatchStatesForPatchGroupRequest {
|
|
|
6245
6865
|
*/
|
|
6246
6866
|
export interface DescribeInstancePatchStatesForPatchGroupResult {
|
|
6247
6867
|
/**
|
|
6868
|
+
* @public
|
|
6248
6869
|
* <p>The high-level patch state for the requested managed nodes. </p>
|
|
6249
6870
|
*/
|
|
6250
6871
|
InstancePatchStates?: InstancePatchState[];
|
|
6251
6872
|
/**
|
|
6873
|
+
* @public
|
|
6252
6874
|
* <p>The token to use when requesting the next set of items. If there are no additional items to
|
|
6253
6875
|
* return, the string is empty.</p>
|
|
6254
6876
|
*/
|
|
@@ -6259,15 +6881,18 @@ export interface DescribeInstancePatchStatesForPatchGroupResult {
|
|
|
6259
6881
|
*/
|
|
6260
6882
|
export interface DescribeInventoryDeletionsRequest {
|
|
6261
6883
|
/**
|
|
6884
|
+
* @public
|
|
6262
6885
|
* <p>Specify the delete inventory ID for which you want information. This ID was returned by the
|
|
6263
6886
|
* <code>DeleteInventory</code> operation.</p>
|
|
6264
6887
|
*/
|
|
6265
6888
|
DeletionId?: string;
|
|
6266
6889
|
/**
|
|
6890
|
+
* @public
|
|
6267
6891
|
* <p>A token to start the list. Use this token to get the next set of results. </p>
|
|
6268
6892
|
*/
|
|
6269
6893
|
NextToken?: string;
|
|
6270
6894
|
/**
|
|
6895
|
+
* @public
|
|
6271
6896
|
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
6272
6897
|
* can specify in a subsequent call to get the next set of results.</p>
|
|
6273
6898
|
*/
|
|
@@ -6291,31 +6916,38 @@ export type InventoryDeletionStatus = (typeof InventoryDeletionStatus)[keyof typ
|
|
|
6291
6916
|
*/
|
|
6292
6917
|
export interface InventoryDeletionStatusItem {
|
|
6293
6918
|
/**
|
|
6919
|
+
* @public
|
|
6294
6920
|
* <p>The deletion ID returned by the <code>DeleteInventory</code> operation.</p>
|
|
6295
6921
|
*/
|
|
6296
6922
|
DeletionId?: string;
|
|
6297
6923
|
/**
|
|
6924
|
+
* @public
|
|
6298
6925
|
* <p>The name of the inventory data type.</p>
|
|
6299
6926
|
*/
|
|
6300
6927
|
TypeName?: string;
|
|
6301
6928
|
/**
|
|
6929
|
+
* @public
|
|
6302
6930
|
* <p>The UTC timestamp when the delete operation started.</p>
|
|
6303
6931
|
*/
|
|
6304
6932
|
DeletionStartTime?: Date;
|
|
6305
6933
|
/**
|
|
6934
|
+
* @public
|
|
6306
6935
|
* <p>The status of the operation. Possible values are InProgress and Complete.</p>
|
|
6307
6936
|
*/
|
|
6308
6937
|
LastStatus?: InventoryDeletionStatus | string;
|
|
6309
6938
|
/**
|
|
6939
|
+
* @public
|
|
6310
6940
|
* <p>Information about the status.</p>
|
|
6311
6941
|
*/
|
|
6312
6942
|
LastStatusMessage?: string;
|
|
6313
6943
|
/**
|
|
6944
|
+
* @public
|
|
6314
6945
|
* <p>Information about the delete operation. For more information about this summary, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-custom.html#sysman-inventory-delete">Understanding the delete inventory summary</a> in the
|
|
6315
6946
|
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
6316
6947
|
*/
|
|
6317
6948
|
DeletionSummary?: InventoryDeletionSummary;
|
|
6318
6949
|
/**
|
|
6950
|
+
* @public
|
|
6319
6951
|
* <p>The UTC timestamp of when the last status report.</p>
|
|
6320
6952
|
*/
|
|
6321
6953
|
LastStatusUpdateTime?: Date;
|
|
@@ -6325,10 +6957,12 @@ export interface InventoryDeletionStatusItem {
|
|
|
6325
6957
|
*/
|
|
6326
6958
|
export interface DescribeInventoryDeletionsResult {
|
|
6327
6959
|
/**
|
|
6960
|
+
* @public
|
|
6328
6961
|
* <p>A list of status items for deleted inventory.</p>
|
|
6329
6962
|
*/
|
|
6330
6963
|
InventoryDeletions?: InventoryDeletionStatusItem[];
|
|
6331
6964
|
/**
|
|
6965
|
+
* @public
|
|
6332
6966
|
* <p>The token for the next set of items to return. Use this token to get the next set of
|
|
6333
6967
|
* results.</p>
|
|
6334
6968
|
*/
|
|
@@ -6388,10 +7022,12 @@ export declare class InvalidDeletionIdException extends __BaseException {
|
|
|
6388
7022
|
*/
|
|
6389
7023
|
export interface MaintenanceWindowFilter {
|
|
6390
7024
|
/**
|
|
7025
|
+
* @public
|
|
6391
7026
|
* <p>The name of the filter.</p>
|
|
6392
7027
|
*/
|
|
6393
7028
|
Key?: string;
|
|
6394
7029
|
/**
|
|
7030
|
+
* @public
|
|
6395
7031
|
* <p>The filter values.</p>
|
|
6396
7032
|
*/
|
|
6397
7033
|
Values?: string[];
|
|
@@ -6401,10 +7037,12 @@ export interface MaintenanceWindowFilter {
|
|
|
6401
7037
|
*/
|
|
6402
7038
|
export interface DescribeMaintenanceWindowExecutionsRequest {
|
|
6403
7039
|
/**
|
|
7040
|
+
* @public
|
|
6404
7041
|
* <p>The ID of the maintenance window whose executions should be retrieved.</p>
|
|
6405
7042
|
*/
|
|
6406
7043
|
WindowId: string | undefined;
|
|
6407
7044
|
/**
|
|
7045
|
+
* @public
|
|
6408
7046
|
* <p>Each entry in the array is a structure containing:</p>
|
|
6409
7047
|
* <ul>
|
|
6410
7048
|
* <li>
|
|
@@ -6420,11 +7058,13 @@ export interface DescribeMaintenanceWindowExecutionsRequest {
|
|
|
6420
7058
|
*/
|
|
6421
7059
|
Filters?: MaintenanceWindowFilter[];
|
|
6422
7060
|
/**
|
|
7061
|
+
* @public
|
|
6423
7062
|
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
6424
7063
|
* can specify in a subsequent call to get the next set of results.</p>
|
|
6425
7064
|
*/
|
|
6426
7065
|
MaxResults?: number;
|
|
6427
7066
|
/**
|
|
7067
|
+
* @public
|
|
6428
7068
|
* <p>The token for the next set of items to return. (You received this token from a previous
|
|
6429
7069
|
* call.)</p>
|
|
6430
7070
|
*/
|
|
@@ -6454,26 +7094,32 @@ export type MaintenanceWindowExecutionStatus = (typeof MaintenanceWindowExecutio
|
|
|
6454
7094
|
*/
|
|
6455
7095
|
export interface MaintenanceWindowExecution {
|
|
6456
7096
|
/**
|
|
7097
|
+
* @public
|
|
6457
7098
|
* <p>The ID of the maintenance window.</p>
|
|
6458
7099
|
*/
|
|
6459
7100
|
WindowId?: string;
|
|
6460
7101
|
/**
|
|
7102
|
+
* @public
|
|
6461
7103
|
* <p>The ID of the maintenance window execution.</p>
|
|
6462
7104
|
*/
|
|
6463
7105
|
WindowExecutionId?: string;
|
|
6464
7106
|
/**
|
|
7107
|
+
* @public
|
|
6465
7108
|
* <p>The status of the execution.</p>
|
|
6466
7109
|
*/
|
|
6467
7110
|
Status?: MaintenanceWindowExecutionStatus | string;
|
|
6468
7111
|
/**
|
|
7112
|
+
* @public
|
|
6469
7113
|
* <p>The details explaining the status. Not available for all status values.</p>
|
|
6470
7114
|
*/
|
|
6471
7115
|
StatusDetails?: string;
|
|
6472
7116
|
/**
|
|
7117
|
+
* @public
|
|
6473
7118
|
* <p>The time the execution started.</p>
|
|
6474
7119
|
*/
|
|
6475
7120
|
StartTime?: Date;
|
|
6476
7121
|
/**
|
|
7122
|
+
* @public
|
|
6477
7123
|
* <p>The time the execution finished.</p>
|
|
6478
7124
|
*/
|
|
6479
7125
|
EndTime?: Date;
|
|
@@ -6483,10 +7129,12 @@ export interface MaintenanceWindowExecution {
|
|
|
6483
7129
|
*/
|
|
6484
7130
|
export interface DescribeMaintenanceWindowExecutionsResult {
|
|
6485
7131
|
/**
|
|
7132
|
+
* @public
|
|
6486
7133
|
* <p>Information about the maintenance window executions.</p>
|
|
6487
7134
|
*/
|
|
6488
7135
|
WindowExecutions?: MaintenanceWindowExecution[];
|
|
6489
7136
|
/**
|
|
7137
|
+
* @public
|
|
6490
7138
|
* <p>The token to use when requesting the next set of items. If there are no additional items to
|
|
6491
7139
|
* return, the string is empty.</p>
|
|
6492
7140
|
*/
|
|
@@ -6497,14 +7145,17 @@ export interface DescribeMaintenanceWindowExecutionsResult {
|
|
|
6497
7145
|
*/
|
|
6498
7146
|
export interface DescribeMaintenanceWindowExecutionTaskInvocationsRequest {
|
|
6499
7147
|
/**
|
|
7148
|
+
* @public
|
|
6500
7149
|
* <p>The ID of the maintenance window execution the task is part of.</p>
|
|
6501
7150
|
*/
|
|
6502
7151
|
WindowExecutionId: string | undefined;
|
|
6503
7152
|
/**
|
|
7153
|
+
* @public
|
|
6504
7154
|
* <p>The ID of the specific task in the maintenance window task that should be retrieved.</p>
|
|
6505
7155
|
*/
|
|
6506
7156
|
TaskId: string | undefined;
|
|
6507
7157
|
/**
|
|
7158
|
+
* @public
|
|
6508
7159
|
* <p>Optional filters used to scope down the returned task invocations. The supported filter key
|
|
6509
7160
|
* is <code>STATUS</code> with the corresponding values <code>PENDING</code>,
|
|
6510
7161
|
* <code>IN_PROGRESS</code>, <code>SUCCESS</code>, <code>FAILED</code>, <code>TIMED_OUT</code>,
|
|
@@ -6512,11 +7163,13 @@ export interface DescribeMaintenanceWindowExecutionTaskInvocationsRequest {
|
|
|
6512
7163
|
*/
|
|
6513
7164
|
Filters?: MaintenanceWindowFilter[];
|
|
6514
7165
|
/**
|
|
7166
|
+
* @public
|
|
6515
7167
|
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
6516
7168
|
* can specify in a subsequent call to get the next set of results.</p>
|
|
6517
7169
|
*/
|
|
6518
7170
|
MaxResults?: number;
|
|
6519
7171
|
/**
|
|
7172
|
+
* @public
|
|
6520
7173
|
* <p>The token for the next set of items to return. (You received this token from a previous
|
|
6521
7174
|
* call.)</p>
|
|
6522
7175
|
*/
|
|
@@ -6543,54 +7196,66 @@ export type MaintenanceWindowTaskType = (typeof MaintenanceWindowTaskType)[keyof
|
|
|
6543
7196
|
*/
|
|
6544
7197
|
export interface MaintenanceWindowExecutionTaskInvocationIdentity {
|
|
6545
7198
|
/**
|
|
7199
|
+
* @public
|
|
6546
7200
|
* <p>The ID of the maintenance window execution that ran the task.</p>
|
|
6547
7201
|
*/
|
|
6548
7202
|
WindowExecutionId?: string;
|
|
6549
7203
|
/**
|
|
7204
|
+
* @public
|
|
6550
7205
|
* <p>The ID of the specific task execution in the maintenance window execution.</p>
|
|
6551
7206
|
*/
|
|
6552
7207
|
TaskExecutionId?: string;
|
|
6553
7208
|
/**
|
|
7209
|
+
* @public
|
|
6554
7210
|
* <p>The ID of the task invocation.</p>
|
|
6555
7211
|
*/
|
|
6556
7212
|
InvocationId?: string;
|
|
6557
7213
|
/**
|
|
7214
|
+
* @public
|
|
6558
7215
|
* <p>The ID of the action performed in the service that actually handled the task invocation. If
|
|
6559
7216
|
* the task type is <code>RUN_COMMAND</code>, this value is the command ID.</p>
|
|
6560
7217
|
*/
|
|
6561
7218
|
ExecutionId?: string;
|
|
6562
7219
|
/**
|
|
7220
|
+
* @public
|
|
6563
7221
|
* <p>The task type.</p>
|
|
6564
7222
|
*/
|
|
6565
7223
|
TaskType?: MaintenanceWindowTaskType | string;
|
|
6566
7224
|
/**
|
|
7225
|
+
* @public
|
|
6567
7226
|
* <p>The parameters that were provided for the invocation when it was run.</p>
|
|
6568
7227
|
*/
|
|
6569
7228
|
Parameters?: string;
|
|
6570
7229
|
/**
|
|
7230
|
+
* @public
|
|
6571
7231
|
* <p>The status of the task invocation.</p>
|
|
6572
7232
|
*/
|
|
6573
7233
|
Status?: MaintenanceWindowExecutionStatus | string;
|
|
6574
7234
|
/**
|
|
7235
|
+
* @public
|
|
6575
7236
|
* <p>The details explaining the status of the task invocation. Not available for all status
|
|
6576
7237
|
* values. </p>
|
|
6577
7238
|
*/
|
|
6578
7239
|
StatusDetails?: string;
|
|
6579
7240
|
/**
|
|
7241
|
+
* @public
|
|
6580
7242
|
* <p>The time the invocation started.</p>
|
|
6581
7243
|
*/
|
|
6582
7244
|
StartTime?: Date;
|
|
6583
7245
|
/**
|
|
7246
|
+
* @public
|
|
6584
7247
|
* <p>The time the invocation finished.</p>
|
|
6585
7248
|
*/
|
|
6586
7249
|
EndTime?: Date;
|
|
6587
7250
|
/**
|
|
7251
|
+
* @public
|
|
6588
7252
|
* <p>User-provided value that was specified when the target was registered with the maintenance
|
|
6589
7253
|
* window. This was also included in any Amazon CloudWatch Events events raised during the task
|
|
6590
7254
|
* invocation.</p>
|
|
6591
7255
|
*/
|
|
6592
7256
|
OwnerInformation?: string;
|
|
6593
7257
|
/**
|
|
7258
|
+
* @public
|
|
6594
7259
|
* <p>The ID of the target definition in this maintenance window the invocation was performed
|
|
6595
7260
|
* for.</p>
|
|
6596
7261
|
*/
|
|
@@ -6601,10 +7266,12 @@ export interface MaintenanceWindowExecutionTaskInvocationIdentity {
|
|
|
6601
7266
|
*/
|
|
6602
7267
|
export interface DescribeMaintenanceWindowExecutionTaskInvocationsResult {
|
|
6603
7268
|
/**
|
|
7269
|
+
* @public
|
|
6604
7270
|
* <p>Information about the task invocation results per invocation.</p>
|
|
6605
7271
|
*/
|
|
6606
7272
|
WindowExecutionTaskInvocationIdentities?: MaintenanceWindowExecutionTaskInvocationIdentity[];
|
|
6607
7273
|
/**
|
|
7274
|
+
* @public
|
|
6608
7275
|
* <p>The token to use when requesting the next set of items. If there are no additional items to
|
|
6609
7276
|
* return, the string is empty.</p>
|
|
6610
7277
|
*/
|
|
@@ -6615,10 +7282,12 @@ export interface DescribeMaintenanceWindowExecutionTaskInvocationsResult {
|
|
|
6615
7282
|
*/
|
|
6616
7283
|
export interface DescribeMaintenanceWindowExecutionTasksRequest {
|
|
6617
7284
|
/**
|
|
7285
|
+
* @public
|
|
6618
7286
|
* <p>The ID of the maintenance window execution whose task executions should be retrieved.</p>
|
|
6619
7287
|
*/
|
|
6620
7288
|
WindowExecutionId: string | undefined;
|
|
6621
7289
|
/**
|
|
7290
|
+
* @public
|
|
6622
7291
|
* <p>Optional filters used to scope down the returned tasks. The supported filter key is
|
|
6623
7292
|
* <code>STATUS</code> with the corresponding values <code>PENDING</code>,
|
|
6624
7293
|
* <code>IN_PROGRESS</code>, <code>SUCCESS</code>, <code>FAILED</code>, <code>TIMED_OUT</code>,
|
|
@@ -6626,11 +7295,13 @@ export interface DescribeMaintenanceWindowExecutionTasksRequest {
|
|
|
6626
7295
|
*/
|
|
6627
7296
|
Filters?: MaintenanceWindowFilter[];
|
|
6628
7297
|
/**
|
|
7298
|
+
* @public
|
|
6629
7299
|
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
6630
7300
|
* can specify in a subsequent call to get the next set of results.</p>
|
|
6631
7301
|
*/
|
|
6632
7302
|
MaxResults?: number;
|
|
6633
7303
|
/**
|
|
7304
|
+
* @public
|
|
6634
7305
|
* <p>The token for the next set of items to return. (You received this token from a previous
|
|
6635
7306
|
* call.)</p>
|
|
6636
7307
|
*/
|
|
@@ -6643,43 +7314,53 @@ export interface DescribeMaintenanceWindowExecutionTasksRequest {
|
|
|
6643
7314
|
*/
|
|
6644
7315
|
export interface MaintenanceWindowExecutionTaskIdentity {
|
|
6645
7316
|
/**
|
|
7317
|
+
* @public
|
|
6646
7318
|
* <p>The ID of the maintenance window execution that ran the task.</p>
|
|
6647
7319
|
*/
|
|
6648
7320
|
WindowExecutionId?: string;
|
|
6649
7321
|
/**
|
|
7322
|
+
* @public
|
|
6650
7323
|
* <p>The ID of the specific task execution in the maintenance window execution.</p>
|
|
6651
7324
|
*/
|
|
6652
7325
|
TaskExecutionId?: string;
|
|
6653
7326
|
/**
|
|
7327
|
+
* @public
|
|
6654
7328
|
* <p>The status of the task execution.</p>
|
|
6655
7329
|
*/
|
|
6656
7330
|
Status?: MaintenanceWindowExecutionStatus | string;
|
|
6657
7331
|
/**
|
|
7332
|
+
* @public
|
|
6658
7333
|
* <p>The details explaining the status of the task execution. Not available for all status
|
|
6659
7334
|
* values.</p>
|
|
6660
7335
|
*/
|
|
6661
7336
|
StatusDetails?: string;
|
|
6662
7337
|
/**
|
|
7338
|
+
* @public
|
|
6663
7339
|
* <p>The time the task execution started.</p>
|
|
6664
7340
|
*/
|
|
6665
7341
|
StartTime?: Date;
|
|
6666
7342
|
/**
|
|
7343
|
+
* @public
|
|
6667
7344
|
* <p>The time the task execution finished.</p>
|
|
6668
7345
|
*/
|
|
6669
7346
|
EndTime?: Date;
|
|
6670
7347
|
/**
|
|
7348
|
+
* @public
|
|
6671
7349
|
* <p>The Amazon Resource Name (ARN) of the task that ran.</p>
|
|
6672
7350
|
*/
|
|
6673
7351
|
TaskArn?: string;
|
|
6674
7352
|
/**
|
|
7353
|
+
* @public
|
|
6675
7354
|
* <p>The type of task that ran.</p>
|
|
6676
7355
|
*/
|
|
6677
7356
|
TaskType?: MaintenanceWindowTaskType | string;
|
|
6678
7357
|
/**
|
|
7358
|
+
* @public
|
|
6679
7359
|
* <p>The details for the CloudWatch alarm applied to your maintenance window task.</p>
|
|
6680
7360
|
*/
|
|
6681
7361
|
AlarmConfiguration?: AlarmConfiguration;
|
|
6682
7362
|
/**
|
|
7363
|
+
* @public
|
|
6683
7364
|
* <p>The CloudWatch alarm that was invoked by the maintenance window task.</p>
|
|
6684
7365
|
*/
|
|
6685
7366
|
TriggeredAlarms?: AlarmStateInformation[];
|
|
@@ -6689,10 +7370,12 @@ export interface MaintenanceWindowExecutionTaskIdentity {
|
|
|
6689
7370
|
*/
|
|
6690
7371
|
export interface DescribeMaintenanceWindowExecutionTasksResult {
|
|
6691
7372
|
/**
|
|
7373
|
+
* @public
|
|
6692
7374
|
* <p>Information about the task executions.</p>
|
|
6693
7375
|
*/
|
|
6694
7376
|
WindowExecutionTaskIdentities?: MaintenanceWindowExecutionTaskIdentity[];
|
|
6695
7377
|
/**
|
|
7378
|
+
* @public
|
|
6696
7379
|
* <p>The token to use when requesting the next set of items. If there are no additional items to
|
|
6697
7380
|
* return, the string is empty.</p>
|
|
6698
7381
|
*/
|
|
@@ -6703,17 +7386,20 @@ export interface DescribeMaintenanceWindowExecutionTasksResult {
|
|
|
6703
7386
|
*/
|
|
6704
7387
|
export interface DescribeMaintenanceWindowsRequest {
|
|
6705
7388
|
/**
|
|
7389
|
+
* @public
|
|
6706
7390
|
* <p>Optional filters used to narrow down the scope of the returned maintenance windows.
|
|
6707
7391
|
* Supported filter keys are <code>Name</code> and <code>Enabled</code>. For example,
|
|
6708
7392
|
* <code>Name=MyMaintenanceWindow</code> and <code>Enabled=True</code>.</p>
|
|
6709
7393
|
*/
|
|
6710
7394
|
Filters?: MaintenanceWindowFilter[];
|
|
6711
7395
|
/**
|
|
7396
|
+
* @public
|
|
6712
7397
|
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
6713
7398
|
* can specify in a subsequent call to get the next set of results.</p>
|
|
6714
7399
|
*/
|
|
6715
7400
|
MaxResults?: number;
|
|
6716
7401
|
/**
|
|
7402
|
+
* @public
|
|
6717
7403
|
* <p>The token for the next set of items to return. (You received this token from a previous
|
|
6718
7404
|
* call.)</p>
|
|
6719
7405
|
*/
|
|
@@ -6725,55 +7411,67 @@ export interface DescribeMaintenanceWindowsRequest {
|
|
|
6725
7411
|
*/
|
|
6726
7412
|
export interface MaintenanceWindowIdentity {
|
|
6727
7413
|
/**
|
|
7414
|
+
* @public
|
|
6728
7415
|
* <p>The ID of the maintenance window.</p>
|
|
6729
7416
|
*/
|
|
6730
7417
|
WindowId?: string;
|
|
6731
7418
|
/**
|
|
7419
|
+
* @public
|
|
6732
7420
|
* <p>The name of the maintenance window.</p>
|
|
6733
7421
|
*/
|
|
6734
7422
|
Name?: string;
|
|
6735
7423
|
/**
|
|
7424
|
+
* @public
|
|
6736
7425
|
* <p>A description of the maintenance window.</p>
|
|
6737
7426
|
*/
|
|
6738
7427
|
Description?: string;
|
|
6739
7428
|
/**
|
|
7429
|
+
* @public
|
|
6740
7430
|
* <p>Indicates whether the maintenance window is enabled.</p>
|
|
6741
7431
|
*/
|
|
6742
7432
|
Enabled?: boolean;
|
|
6743
7433
|
/**
|
|
7434
|
+
* @public
|
|
6744
7435
|
* <p>The duration of the maintenance window in hours.</p>
|
|
6745
7436
|
*/
|
|
6746
7437
|
Duration?: number;
|
|
6747
7438
|
/**
|
|
7439
|
+
* @public
|
|
6748
7440
|
* <p>The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling
|
|
6749
7441
|
* new tasks for execution.</p>
|
|
6750
7442
|
*/
|
|
6751
7443
|
Cutoff?: number;
|
|
6752
7444
|
/**
|
|
7445
|
+
* @public
|
|
6753
7446
|
* <p>The schedule of the maintenance window in the form of a cron or rate expression.</p>
|
|
6754
7447
|
*/
|
|
6755
7448
|
Schedule?: string;
|
|
6756
7449
|
/**
|
|
7450
|
+
* @public
|
|
6757
7451
|
* <p>The time zone that the scheduled maintenance window executions are based on, in Internet
|
|
6758
7452
|
* Assigned Numbers Authority (IANA) format.</p>
|
|
6759
7453
|
*/
|
|
6760
7454
|
ScheduleTimezone?: string;
|
|
6761
7455
|
/**
|
|
7456
|
+
* @public
|
|
6762
7457
|
* <p>The number of days to wait to run a maintenance window after the scheduled cron expression
|
|
6763
7458
|
* date and time.</p>
|
|
6764
7459
|
*/
|
|
6765
7460
|
ScheduleOffset?: number;
|
|
6766
7461
|
/**
|
|
7462
|
+
* @public
|
|
6767
7463
|
* <p>The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled
|
|
6768
7464
|
* to become inactive.</p>
|
|
6769
7465
|
*/
|
|
6770
7466
|
EndDate?: string;
|
|
6771
7467
|
/**
|
|
7468
|
+
* @public
|
|
6772
7469
|
* <p>The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled
|
|
6773
7470
|
* to become active.</p>
|
|
6774
7471
|
*/
|
|
6775
7472
|
StartDate?: string;
|
|
6776
7473
|
/**
|
|
7474
|
+
* @public
|
|
6777
7475
|
* <p>The next time the maintenance window will actually run, taking into account any specified
|
|
6778
7476
|
* times for the maintenance window to become active or inactive.</p>
|
|
6779
7477
|
*/
|
|
@@ -6784,10 +7482,12 @@ export interface MaintenanceWindowIdentity {
|
|
|
6784
7482
|
*/
|
|
6785
7483
|
export interface DescribeMaintenanceWindowsResult {
|
|
6786
7484
|
/**
|
|
7485
|
+
* @public
|
|
6787
7486
|
* <p>Information about the maintenance windows.</p>
|
|
6788
7487
|
*/
|
|
6789
7488
|
WindowIdentities?: MaintenanceWindowIdentity[];
|
|
6790
7489
|
/**
|
|
7490
|
+
* @public
|
|
6791
7491
|
* <p>The token to use when requesting the next set of items. If there are no additional items to
|
|
6792
7492
|
* return, the string is empty.</p>
|
|
6793
7493
|
*/
|
|
@@ -6810,29 +7510,35 @@ export type MaintenanceWindowResourceType = (typeof MaintenanceWindowResourceTyp
|
|
|
6810
7510
|
*/
|
|
6811
7511
|
export interface DescribeMaintenanceWindowScheduleRequest {
|
|
6812
7512
|
/**
|
|
7513
|
+
* @public
|
|
6813
7514
|
* <p>The ID of the maintenance window to retrieve information about.</p>
|
|
6814
7515
|
*/
|
|
6815
7516
|
WindowId?: string;
|
|
6816
7517
|
/**
|
|
7518
|
+
* @public
|
|
6817
7519
|
* <p>The managed node ID or key-value pair to retrieve information about.</p>
|
|
6818
7520
|
*/
|
|
6819
7521
|
Targets?: Target[];
|
|
6820
7522
|
/**
|
|
7523
|
+
* @public
|
|
6821
7524
|
* <p>The type of resource you want to retrieve information about. For example,
|
|
6822
7525
|
* <code>INSTANCE</code>.</p>
|
|
6823
7526
|
*/
|
|
6824
7527
|
ResourceType?: MaintenanceWindowResourceType | string;
|
|
6825
7528
|
/**
|
|
7529
|
+
* @public
|
|
6826
7530
|
* <p>Filters used to limit the range of results. For example, you can limit maintenance window
|
|
6827
7531
|
* executions to only those scheduled before or after a certain date and time.</p>
|
|
6828
7532
|
*/
|
|
6829
7533
|
Filters?: PatchOrchestratorFilter[];
|
|
6830
7534
|
/**
|
|
7535
|
+
* @public
|
|
6831
7536
|
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
6832
7537
|
* can specify in a subsequent call to get the next set of results.</p>
|
|
6833
7538
|
*/
|
|
6834
7539
|
MaxResults?: number;
|
|
6835
7540
|
/**
|
|
7541
|
+
* @public
|
|
6836
7542
|
* <p>The token for the next set of items to return. (You received this token from a previous
|
|
6837
7543
|
* call.)</p>
|
|
6838
7544
|
*/
|
|
@@ -6844,14 +7550,17 @@ export interface DescribeMaintenanceWindowScheduleRequest {
|
|
|
6844
7550
|
*/
|
|
6845
7551
|
export interface ScheduledWindowExecution {
|
|
6846
7552
|
/**
|
|
7553
|
+
* @public
|
|
6847
7554
|
* <p>The ID of the maintenance window to be run.</p>
|
|
6848
7555
|
*/
|
|
6849
7556
|
WindowId?: string;
|
|
6850
7557
|
/**
|
|
7558
|
+
* @public
|
|
6851
7559
|
* <p>The name of the maintenance window to be run.</p>
|
|
6852
7560
|
*/
|
|
6853
7561
|
Name?: string;
|
|
6854
7562
|
/**
|
|
7563
|
+
* @public
|
|
6855
7564
|
* <p>The time, in ISO-8601 Extended format, that the maintenance window is scheduled to be
|
|
6856
7565
|
* run.</p>
|
|
6857
7566
|
*/
|
|
@@ -6862,11 +7571,13 @@ export interface ScheduledWindowExecution {
|
|
|
6862
7571
|
*/
|
|
6863
7572
|
export interface DescribeMaintenanceWindowScheduleResult {
|
|
6864
7573
|
/**
|
|
7574
|
+
* @public
|
|
6865
7575
|
* <p>Information about maintenance window executions scheduled for the specified time
|
|
6866
7576
|
* range.</p>
|
|
6867
7577
|
*/
|
|
6868
7578
|
ScheduledWindowExecutions?: ScheduledWindowExecution[];
|
|
6869
7579
|
/**
|
|
7580
|
+
* @public
|
|
6870
7581
|
* <p>The token for the next set of items to return. (You use this token in the next call.)</p>
|
|
6871
7582
|
*/
|
|
6872
7583
|
NextToken?: string;
|
|
@@ -6876,20 +7587,24 @@ export interface DescribeMaintenanceWindowScheduleResult {
|
|
|
6876
7587
|
*/
|
|
6877
7588
|
export interface DescribeMaintenanceWindowsForTargetRequest {
|
|
6878
7589
|
/**
|
|
7590
|
+
* @public
|
|
6879
7591
|
* <p>The managed node ID or key-value pair to retrieve information about.</p>
|
|
6880
7592
|
*/
|
|
6881
7593
|
Targets: Target[] | undefined;
|
|
6882
7594
|
/**
|
|
7595
|
+
* @public
|
|
6883
7596
|
* <p>The type of resource you want to retrieve information about. For example,
|
|
6884
7597
|
* <code>INSTANCE</code>.</p>
|
|
6885
7598
|
*/
|
|
6886
7599
|
ResourceType: MaintenanceWindowResourceType | string | undefined;
|
|
6887
7600
|
/**
|
|
7601
|
+
* @public
|
|
6888
7602
|
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
6889
7603
|
* can specify in a subsequent call to get the next set of results.</p>
|
|
6890
7604
|
*/
|
|
6891
7605
|
MaxResults?: number;
|
|
6892
7606
|
/**
|
|
7607
|
+
* @public
|
|
6893
7608
|
* <p>The token for the next set of items to return. (You received this token from a previous
|
|
6894
7609
|
* call.)</p>
|
|
6895
7610
|
*/
|
|
@@ -6901,10 +7616,12 @@ export interface DescribeMaintenanceWindowsForTargetRequest {
|
|
|
6901
7616
|
*/
|
|
6902
7617
|
export interface MaintenanceWindowIdentityForTarget {
|
|
6903
7618
|
/**
|
|
7619
|
+
* @public
|
|
6904
7620
|
* <p>The ID of the maintenance window.</p>
|
|
6905
7621
|
*/
|
|
6906
7622
|
WindowId?: string;
|
|
6907
7623
|
/**
|
|
7624
|
+
* @public
|
|
6908
7625
|
* <p>The name of the maintenance window.</p>
|
|
6909
7626
|
*/
|
|
6910
7627
|
Name?: string;
|
|
@@ -6914,11 +7631,13 @@ export interface MaintenanceWindowIdentityForTarget {
|
|
|
6914
7631
|
*/
|
|
6915
7632
|
export interface DescribeMaintenanceWindowsForTargetResult {
|
|
6916
7633
|
/**
|
|
7634
|
+
* @public
|
|
6917
7635
|
* <p>Information about the maintenance window targets and tasks a managed node is associated
|
|
6918
7636
|
* with.</p>
|
|
6919
7637
|
*/
|
|
6920
7638
|
WindowIdentities?: MaintenanceWindowIdentityForTarget[];
|
|
6921
7639
|
/**
|
|
7640
|
+
* @public
|
|
6922
7641
|
* <p>The token for the next set of items to return. (You use this token in the next call.)</p>
|
|
6923
7642
|
*/
|
|
6924
7643
|
NextToken?: string;
|
|
@@ -6928,21 +7647,25 @@ export interface DescribeMaintenanceWindowsForTargetResult {
|
|
|
6928
7647
|
*/
|
|
6929
7648
|
export interface DescribeMaintenanceWindowTargetsRequest {
|
|
6930
7649
|
/**
|
|
7650
|
+
* @public
|
|
6931
7651
|
* <p>The ID of the maintenance window whose targets should be retrieved.</p>
|
|
6932
7652
|
*/
|
|
6933
7653
|
WindowId: string | undefined;
|
|
6934
7654
|
/**
|
|
7655
|
+
* @public
|
|
6935
7656
|
* <p>Optional filters that can be used to narrow down the scope of the returned window targets.
|
|
6936
7657
|
* The supported filter keys are <code>Type</code>, <code>WindowTargetId</code>, and
|
|
6937
7658
|
* <code>OwnerInformation</code>.</p>
|
|
6938
7659
|
*/
|
|
6939
7660
|
Filters?: MaintenanceWindowFilter[];
|
|
6940
7661
|
/**
|
|
7662
|
+
* @public
|
|
6941
7663
|
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
6942
7664
|
* can specify in a subsequent call to get the next set of results.</p>
|
|
6943
7665
|
*/
|
|
6944
7666
|
MaxResults?: number;
|
|
6945
7667
|
/**
|
|
7668
|
+
* @public
|
|
6946
7669
|
* <p>The token for the next set of items to return. (You received this token from a previous
|
|
6947
7670
|
* call.)</p>
|
|
6948
7671
|
*/
|
|
@@ -6954,18 +7677,22 @@ export interface DescribeMaintenanceWindowTargetsRequest {
|
|
|
6954
7677
|
*/
|
|
6955
7678
|
export interface MaintenanceWindowTarget {
|
|
6956
7679
|
/**
|
|
7680
|
+
* @public
|
|
6957
7681
|
* <p>The ID of the maintenance window to register the target with.</p>
|
|
6958
7682
|
*/
|
|
6959
7683
|
WindowId?: string;
|
|
6960
7684
|
/**
|
|
7685
|
+
* @public
|
|
6961
7686
|
* <p>The ID of the target.</p>
|
|
6962
7687
|
*/
|
|
6963
7688
|
WindowTargetId?: string;
|
|
6964
7689
|
/**
|
|
7690
|
+
* @public
|
|
6965
7691
|
* <p>The type of target that is being registered with the maintenance window.</p>
|
|
6966
7692
|
*/
|
|
6967
7693
|
ResourceType?: MaintenanceWindowResourceType | string;
|
|
6968
7694
|
/**
|
|
7695
|
+
* @public
|
|
6969
7696
|
* <p>The targets, either managed nodes or tags.</p>
|
|
6970
7697
|
* <p>Specify managed nodes using the following format:</p>
|
|
6971
7698
|
* <p>
|
|
@@ -6977,15 +7704,18 @@ export interface MaintenanceWindowTarget {
|
|
|
6977
7704
|
*/
|
|
6978
7705
|
Targets?: Target[];
|
|
6979
7706
|
/**
|
|
7707
|
+
* @public
|
|
6980
7708
|
* <p>A user-provided value that will be included in any Amazon CloudWatch Events events that are
|
|
6981
7709
|
* raised while running tasks for these targets in this maintenance window.</p>
|
|
6982
7710
|
*/
|
|
6983
7711
|
OwnerInformation?: string;
|
|
6984
7712
|
/**
|
|
7713
|
+
* @public
|
|
6985
7714
|
* <p>The name for the maintenance window target.</p>
|
|
6986
7715
|
*/
|
|
6987
7716
|
Name?: string;
|
|
6988
7717
|
/**
|
|
7718
|
+
* @public
|
|
6989
7719
|
* <p>A description for the target.</p>
|
|
6990
7720
|
*/
|
|
6991
7721
|
Description?: string;
|
|
@@ -6995,10 +7725,12 @@ export interface MaintenanceWindowTarget {
|
|
|
6995
7725
|
*/
|
|
6996
7726
|
export interface DescribeMaintenanceWindowTargetsResult {
|
|
6997
7727
|
/**
|
|
7728
|
+
* @public
|
|
6998
7729
|
* <p>Information about the targets in the maintenance window.</p>
|
|
6999
7730
|
*/
|
|
7000
7731
|
Targets?: MaintenanceWindowTarget[];
|
|
7001
7732
|
/**
|
|
7733
|
+
* @public
|
|
7002
7734
|
* <p>The token to use when requesting the next set of items. If there are no additional items to
|
|
7003
7735
|
* return, the string is empty.</p>
|
|
7004
7736
|
*/
|
|
@@ -7009,21 +7741,25 @@ export interface DescribeMaintenanceWindowTargetsResult {
|
|
|
7009
7741
|
*/
|
|
7010
7742
|
export interface DescribeMaintenanceWindowTasksRequest {
|
|
7011
7743
|
/**
|
|
7744
|
+
* @public
|
|
7012
7745
|
* <p>The ID of the maintenance window whose tasks should be retrieved.</p>
|
|
7013
7746
|
*/
|
|
7014
7747
|
WindowId: string | undefined;
|
|
7015
7748
|
/**
|
|
7749
|
+
* @public
|
|
7016
7750
|
* <p>Optional filters used to narrow down the scope of the returned tasks. The supported filter
|
|
7017
7751
|
* keys are <code>WindowTaskId</code>, <code>TaskArn</code>, <code>Priority</code>, and
|
|
7018
7752
|
* <code>TaskType</code>.</p>
|
|
7019
7753
|
*/
|
|
7020
7754
|
Filters?: MaintenanceWindowFilter[];
|
|
7021
7755
|
/**
|
|
7756
|
+
* @public
|
|
7022
7757
|
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
7023
7758
|
* can specify in a subsequent call to get the next set of results.</p>
|
|
7024
7759
|
*/
|
|
7025
7760
|
MaxResults?: number;
|
|
7026
7761
|
/**
|
|
7762
|
+
* @public
|
|
7027
7763
|
* <p>The token for the next set of items to return. (You received this token from a previous
|
|
7028
7764
|
* call.)</p>
|
|
7029
7765
|
*/
|
|
@@ -7055,14 +7791,17 @@ export type MaintenanceWindowTaskCutoffBehavior = (typeof MaintenanceWindowTaskC
|
|
|
7055
7791
|
*/
|
|
7056
7792
|
export interface LoggingInfo {
|
|
7057
7793
|
/**
|
|
7794
|
+
* @public
|
|
7058
7795
|
* <p>The name of an S3 bucket where execution logs are stored.</p>
|
|
7059
7796
|
*/
|
|
7060
7797
|
S3BucketName: string | undefined;
|
|
7061
7798
|
/**
|
|
7799
|
+
* @public
|
|
7062
7800
|
* <p>(Optional) The S3 bucket subfolder. </p>
|
|
7063
7801
|
*/
|
|
7064
7802
|
S3KeyPrefix?: string;
|
|
7065
7803
|
/**
|
|
7804
|
+
* @public
|
|
7066
7805
|
* <p>The Amazon Web Services Region where the S3 bucket is located.</p>
|
|
7067
7806
|
*/
|
|
7068
7807
|
S3Region: string | undefined;
|
|
@@ -7073,6 +7812,7 @@ export interface LoggingInfo {
|
|
|
7073
7812
|
*/
|
|
7074
7813
|
export interface MaintenanceWindowTaskParameterValueExpression {
|
|
7075
7814
|
/**
|
|
7815
|
+
* @public
|
|
7076
7816
|
* <p>This field contains an array of 0 or more strings, each 1 to 255 characters in
|
|
7077
7817
|
* length.</p>
|
|
7078
7818
|
*/
|
|
@@ -7084,14 +7824,17 @@ export interface MaintenanceWindowTaskParameterValueExpression {
|
|
|
7084
7824
|
*/
|
|
7085
7825
|
export interface MaintenanceWindowTask {
|
|
7086
7826
|
/**
|
|
7827
|
+
* @public
|
|
7087
7828
|
* <p>The ID of the maintenance window where the task is registered.</p>
|
|
7088
7829
|
*/
|
|
7089
7830
|
WindowId?: string;
|
|
7090
7831
|
/**
|
|
7832
|
+
* @public
|
|
7091
7833
|
* <p>The task ID.</p>
|
|
7092
7834
|
*/
|
|
7093
7835
|
WindowTaskId?: string;
|
|
7094
7836
|
/**
|
|
7837
|
+
* @public
|
|
7095
7838
|
* <p>The resource that the task uses during execution. For <code>RUN_COMMAND</code> and
|
|
7096
7839
|
* <code>AUTOMATION</code> task types, <code>TaskArn</code> is the Amazon Web Services Systems Manager (SSM document) name or
|
|
7097
7840
|
* ARN. For <code>LAMBDA</code> tasks, it's the function name or ARN. For
|
|
@@ -7099,16 +7842,19 @@ export interface MaintenanceWindowTask {
|
|
|
7099
7842
|
*/
|
|
7100
7843
|
TaskArn?: string;
|
|
7101
7844
|
/**
|
|
7845
|
+
* @public
|
|
7102
7846
|
* <p>The type of task.</p>
|
|
7103
7847
|
*/
|
|
7104
7848
|
Type?: MaintenanceWindowTaskType | string;
|
|
7105
7849
|
/**
|
|
7850
|
+
* @public
|
|
7106
7851
|
* <p>The targets (either managed nodes or tags). Managed nodes are specified using
|
|
7107
7852
|
* <code>Key=instanceids,Values=<instanceid1>,<instanceid2></code>. Tags are specified
|
|
7108
7853
|
* using <code>Key=<tag name>,Values=<tag value></code>.</p>
|
|
7109
7854
|
*/
|
|
7110
7855
|
Targets?: Target[];
|
|
7111
7856
|
/**
|
|
7857
|
+
* @public
|
|
7112
7858
|
* <p>The parameters that should be passed to the task when it is run.</p>
|
|
7113
7859
|
* <note>
|
|
7114
7860
|
* <p>
|
|
@@ -7120,11 +7866,13 @@ export interface MaintenanceWindowTask {
|
|
|
7120
7866
|
*/
|
|
7121
7867
|
TaskParameters?: Record<string, MaintenanceWindowTaskParameterValueExpression>;
|
|
7122
7868
|
/**
|
|
7869
|
+
* @public
|
|
7123
7870
|
* <p>The priority of the task in the maintenance window. The lower the number, the higher the
|
|
7124
7871
|
* priority. Tasks that have the same priority are scheduled in parallel.</p>
|
|
7125
7872
|
*/
|
|
7126
7873
|
Priority?: number;
|
|
7127
7874
|
/**
|
|
7875
|
+
* @public
|
|
7128
7876
|
* <p>Information about an S3 bucket to write task-level logs to.</p>
|
|
7129
7877
|
* <note>
|
|
7130
7878
|
* <p>
|
|
@@ -7136,11 +7884,13 @@ export interface MaintenanceWindowTask {
|
|
|
7136
7884
|
*/
|
|
7137
7885
|
LoggingInfo?: LoggingInfo;
|
|
7138
7886
|
/**
|
|
7887
|
+
* @public
|
|
7139
7888
|
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service
|
|
7140
7889
|
* (Amazon SNS) notifications for maintenance window Run Command tasks.</p>
|
|
7141
7890
|
*/
|
|
7142
7891
|
ServiceRoleArn?: string;
|
|
7143
7892
|
/**
|
|
7893
|
+
* @public
|
|
7144
7894
|
* <p>The maximum number of targets this task can be run for, in parallel.</p>
|
|
7145
7895
|
* <note>
|
|
7146
7896
|
* <p>Although this element is listed as "Required: No", a value can be omitted only when you are
|
|
@@ -7153,6 +7903,7 @@ export interface MaintenanceWindowTask {
|
|
|
7153
7903
|
*/
|
|
7154
7904
|
MaxConcurrency?: string;
|
|
7155
7905
|
/**
|
|
7906
|
+
* @public
|
|
7156
7907
|
* <p>The maximum number of errors allowed before this task stops being scheduled.</p>
|
|
7157
7908
|
* <note>
|
|
7158
7909
|
* <p>Although this element is listed as "Required: No", a value can be omitted only when you are
|
|
@@ -7165,19 +7916,23 @@ export interface MaintenanceWindowTask {
|
|
|
7165
7916
|
*/
|
|
7166
7917
|
MaxErrors?: string;
|
|
7167
7918
|
/**
|
|
7919
|
+
* @public
|
|
7168
7920
|
* <p>The task name.</p>
|
|
7169
7921
|
*/
|
|
7170
7922
|
Name?: string;
|
|
7171
7923
|
/**
|
|
7924
|
+
* @public
|
|
7172
7925
|
* <p>A description of the task.</p>
|
|
7173
7926
|
*/
|
|
7174
7927
|
Description?: string;
|
|
7175
7928
|
/**
|
|
7929
|
+
* @public
|
|
7176
7930
|
* <p>The specification for whether tasks should continue to run after the cutoff time specified
|
|
7177
7931
|
* in the maintenance windows is reached. </p>
|
|
7178
7932
|
*/
|
|
7179
7933
|
CutoffBehavior?: MaintenanceWindowTaskCutoffBehavior | string;
|
|
7180
7934
|
/**
|
|
7935
|
+
* @public
|
|
7181
7936
|
* <p>The details for the CloudWatch alarm applied to your maintenance window task.</p>
|
|
7182
7937
|
*/
|
|
7183
7938
|
AlarmConfiguration?: AlarmConfiguration;
|
|
@@ -7187,10 +7942,12 @@ export interface MaintenanceWindowTask {
|
|
|
7187
7942
|
*/
|
|
7188
7943
|
export interface DescribeMaintenanceWindowTasksResult {
|
|
7189
7944
|
/**
|
|
7945
|
+
* @public
|
|
7190
7946
|
* <p>Information about the tasks in the maintenance window.</p>
|
|
7191
7947
|
*/
|
|
7192
7948
|
Tasks?: MaintenanceWindowTask[];
|
|
7193
7949
|
/**
|
|
7950
|
+
* @public
|
|
7194
7951
|
* <p>The token to use when requesting the next set of items. If there are no additional items to
|
|
7195
7952
|
* return, the string is empty.</p>
|
|
7196
7953
|
*/
|