/
docs-2.json
7108 lines (7108 loc) · 466 KB
/
docs-2.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version": "2.0",
"service": "<fullname>AWS Systems Manager</fullname> <p>AWS Systems Manager is a collection of capabilities that helps you automate management tasks such as collecting system inventory, applying operating system (OS) patches, automating the creation of Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale. Systems Manager lets you remotely and securely manage the configuration of your managed instances. A <i>managed instance</i> is any Amazon Elastic Compute Cloud instance (EC2 instance), or any on-premises server or virtual machine (VM) in your hybrid environment that has been configured for Systems Manager.</p> <p>This reference is intended to be used with the <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/\">AWS Systems Manager User Guide</a>.</p> <p>To get started, verify prerequisites and configure managed instances. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-setting-up.html\">Setting up AWS Systems Manager</a> in the <i>AWS Systems Manager User Guide</i>.</p> <p>For information about other API actions you can perform on EC2 instances, see the <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/\">Amazon EC2 API Reference</a>. For information about how to use a Query API, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/making-api-requests.html\">Making API requests</a>. </p>",
"operations": {
"AddTagsToResource": "<p>Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test.</p> <p>Each resource can have a maximum of 50 tags. </p> <p>We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to Amazon EC2 and are interpreted strictly as a string of characters. </p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html\">Tagging your Amazon EC2 resources</a> in the <i>Amazon EC2 User Guide</i>.</p>",
"CancelCommand": "<p>Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.</p>",
"CancelMaintenanceWindowExecution": "<p>Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have not already starting running. (Tasks already in progress will continue to completion.)</p>",
"CreateActivation": "<p>Generates an activation code and activation ID you can use to register your on-premises server or virtual machine (VM) with Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises instances and VMs using Systems Manager, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances.html\">Setting up AWS Systems Manager for hybrid environments</a> in the <i>AWS Systems Manager User Guide</i>. </p> <note> <p>On-premises servers or VMs that are registered with Systems Manager and EC2 instances that you manage with Systems Manager are all called <i>managed instances</i>.</p> </note>",
"CreateAssociation": "<p>Associates the specified Systems Manager document with the specified instances or targets.</p> <p>When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified.</p> <p>If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.</p>",
"CreateAssociationBatch": "<p>Associates the specified Systems Manager document with the specified instances or targets.</p> <p>When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified.</p> <p>If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.</p>",
"CreateDocument": "<p>Creates a Systems Manager (SSM) document. An SSM document defines the actions that Systems Manager performs on your managed instances. For more information about SSM documents, including information about supported schemas, features, and syntax, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-ssm-docs.html\">AWS Systems Manager Documents</a> in the <i>AWS Systems Manager User Guide</i>.</p>",
"CreateMaintenanceWindow": "<p>Creates a new maintenance window.</p> <note> <p>The value you specify for <code>Duration</code> determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for <code>Cutoff</code>. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for <code>Cutoff</code> is one hour, no maintenance window tasks can start after 5 PM.</p> </note>",
"CreateOpsItem": "<p>Creates a new OpsItem. You must have permission in AWS Identity and Access Management (IAM) to create a new OpsItem. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html\">Getting started with OpsCenter</a> in the <i>AWS Systems Manager User Guide</i>.</p> <p>Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html\">AWS Systems Manager OpsCenter</a> in the <i>AWS Systems Manager User Guide</i>. </p>",
"CreatePatchBaseline": "<p>Creates a patch baseline.</p> <note> <p>For information about valid key and value pairs in <code>PatchFilters</code> for each supported operating system type, see <a href=\"http://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html\">PatchFilter</a>.</p> </note>",
"CreateResourceDataSync": "<p>A resource data sync helps you view data from multiple sources in a single location. Systems Manager offers two types of resource data sync: <code>SyncToDestination</code> and <code>SyncFromSource</code>.</p> <p>You can configure Systems Manager Inventory to use the <code>SyncToDestination</code> type to synchronize Inventory data from multiple AWS Regions to a single S3 bucket. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-datasync.html\">Configuring Resource Data Sync for Inventory</a> in the <i>AWS Systems Manager User Guide</i>.</p> <p>You can configure Systems Manager Explorer to use the <code>SyncFromSource</code> type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple AWS Regions to a single S3 bucket. This type can synchronize OpsItems and OpsData from multiple AWS accounts and Regions or <code>EntireOrganization</code> by using AWS Organizations. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html\">Setting up Systems Manager Explorer to display data from multiple accounts and Regions</a> in the <i>AWS Systems Manager User Guide</i>.</p> <p>A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the <a>ListResourceDataSync</a>.</p> <note> <p>By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. </p> </note>",
"DeleteActivation": "<p>Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances.</p>",
"DeleteAssociation": "<p>Disassociates the specified Systems Manager document from the specified instance.</p> <p>When you disassociate a document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance.</p>",
"DeleteDocument": "<p>Deletes the Systems Manager document and all instance associations to the document.</p> <p>Before you delete the document, we recommend that you use <a>DeleteAssociation</a> to disassociate all instances that are associated with the document.</p>",
"DeleteInventory": "<p>Delete a custom inventory type, or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.</p>",
"DeleteMaintenanceWindow": "<p>Deletes a maintenance window.</p>",
"DeleteParameter": "<p>Delete a parameter from the system.</p>",
"DeleteParameters": "<p>Delete a list of parameters.</p>",
"DeletePatchBaseline": "<p>Deletes a patch baseline.</p>",
"DeleteResourceDataSync": "<p>Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to data on managed instances are no longer synced to or from the target. Deleting a sync configuration does not delete data.</p>",
"DeregisterManagedInstance": "<p>Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.</p>",
"DeregisterPatchBaselineForPatchGroup": "<p>Removes a patch group from a patch baseline.</p>",
"DeregisterTargetFromMaintenanceWindow": "<p>Removes a target from a maintenance window.</p>",
"DeregisterTaskFromMaintenanceWindow": "<p>Removes a task from a maintenance window.</p>",
"DescribeActivations": "<p>Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.</p>",
"DescribeAssociation": "<p>Describes the association for the specified target or instance. If you created the association by using the <code>Targets</code> parameter, then you must retrieve the association by using the association ID. If you created the association by specifying an instance ID and a Systems Manager document, then you retrieve the association by specifying the document name and the instance ID. </p>",
"DescribeAssociationExecutionTargets": "<p>Use this API action to view information about a specific execution of a specific association.</p>",
"DescribeAssociationExecutions": "<p>Use this API action to view all executions for a specific association ID. </p>",
"DescribeAutomationExecutions": "<p>Provides details about all active and terminated Automation executions.</p>",
"DescribeAutomationStepExecutions": "<p>Information about all active and terminated step executions in an Automation workflow.</p>",
"DescribeAvailablePatches": "<p>Lists all patches eligible to be included in a patch baseline.</p>",
"DescribeDocument": "<p>Describes the specified Systems Manager document.</p>",
"DescribeDocumentPermission": "<p>Describes the permissions for a Systems Manager document. If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's AWS account ID) or publicly (<i>All</i>). </p>",
"DescribeEffectiveInstanceAssociations": "<p>All associations for the instance(s).</p>",
"DescribeEffectivePatchesForPatchBaseline": "<p>Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines.</p>",
"DescribeInstanceAssociationsStatus": "<p>The status of the associations for the instance(s).</p>",
"DescribeInstanceInformation": "<p>Describes one or more of your instances, including information about the operating system platform, the version of SSM Agent installed on the instance, instance status, and so on.</p> <p>If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.</p> <note> <p>The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for EC2 instances.</p> </note>",
"DescribeInstancePatchStates": "<p>Retrieves the high-level patch state of one or more instances.</p>",
"DescribeInstancePatchStatesForPatchGroup": "<p>Retrieves the high-level patch state for the instances in the specified patch group.</p>",
"DescribeInstancePatches": "<p>Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.</p>",
"DescribeInventoryDeletions": "<p>Describes a specific delete inventory operation.</p>",
"DescribeMaintenanceWindowExecutionTaskInvocations": "<p>Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.</p>",
"DescribeMaintenanceWindowExecutionTasks": "<p>For a given maintenance window execution, lists the tasks that were run.</p>",
"DescribeMaintenanceWindowExecutions": "<p>Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.</p>",
"DescribeMaintenanceWindowSchedule": "<p>Retrieves information about upcoming executions of a maintenance window.</p>",
"DescribeMaintenanceWindowTargets": "<p>Lists the targets registered with the maintenance window.</p>",
"DescribeMaintenanceWindowTasks": "<p>Lists the tasks in a maintenance window.</p>",
"DescribeMaintenanceWindows": "<p>Retrieves the maintenance windows in an AWS account.</p>",
"DescribeMaintenanceWindowsForTarget": "<p>Retrieves information about the maintenance window targets or tasks that an instance is associated with.</p>",
"DescribeOpsItems": "<p>Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html\">Getting started with OpsCenter</a> in the <i>AWS Systems Manager User Guide</i>.</p> <p>Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html\">AWS Systems Manager OpsCenter</a> in the <i>AWS Systems Manager User Guide</i>. </p>",
"DescribeParameters": "<p>Get information about a parameter.</p> <note> <p>Request results are returned on a best-effort basis. If you specify <code>MaxResults</code> in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of <code>MaxResults</code>. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a <code>NextToken</code>. You can specify the <code>NextToken</code> in a subsequent call to get the next set of results.</p> </note>",
"DescribePatchBaselines": "<p>Lists the patch baselines in your AWS account.</p>",
"DescribePatchGroupState": "<p>Returns high-level aggregated patch compliance state for a patch group.</p>",
"DescribePatchGroups": "<p>Lists all patch groups that have been registered with patch baselines.</p>",
"DescribePatchProperties": "<p>Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as <a>CreatePatchBaseline</a>, <a>UpdatePatchBaseline</a>, <a>DescribeAvailablePatches</a>, and <a>DescribePatchBaselines</a>.</p> <p>The following section lists the properties that can be used in filters for each major operating system type:</p> <dl> <dt>WINDOWS</dt> <dd> <p>Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY</p> </dd> <dt>AMAZON_LINUX</dt> <dd> <p>Valid properties: PRODUCT, CLASSIFICATION, SEVERITY</p> </dd> <dt>AMAZON_LINUX_2</dt> <dd> <p>Valid properties: PRODUCT, CLASSIFICATION, SEVERITY</p> </dd> <dt>UBUNTU </dt> <dd> <p>Valid properties: PRODUCT, PRIORITY</p> </dd> <dt>REDHAT_ENTERPRISE_LINUX</dt> <dd> <p>Valid properties: PRODUCT, CLASSIFICATION, SEVERITY</p> </dd> <dt>SUSE</dt> <dd> <p>Valid properties: PRODUCT, CLASSIFICATION, SEVERITY</p> </dd> <dt>CENTOS</dt> <dd> <p>Valid properties: PRODUCT, CLASSIFICATION, SEVERITY</p> </dd> </dl>",
"DescribeSessions": "<p>Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.</p>",
"GetAutomationExecution": "<p>Get detailed information about a particular Automation execution.</p>",
"GetCalendarState": "<p>Gets the state of the AWS Systems Manager Change Calendar at an optional, specified time. If you specify a time, <code>GetCalendarState</code> returns the state of the calendar at a specific time, and returns the next time that the Change Calendar state will transition. If you do not specify a time, <code>GetCalendarState</code> assumes the current time. Change Calendar entries have two possible states: <code>OPEN</code> or <code>CLOSED</code>. For more information about Systems Manager Change Calendar, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar.html\">AWS Systems Manager Change Calendar</a> in the <i>AWS Systems Manager User Guide</i>.</p>",
"GetCommandInvocation": "<p>Returns detailed information about command execution for an invocation or plugin. </p>",
"GetConnectionStatus": "<p>Retrieves the Session Manager connection status for an instance to determine whether it is running and ready to receive Session Manager connections.</p>",
"GetDefaultPatchBaseline": "<p>Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.</p> <p>If you do not specify an operating system value, the default patch baseline for Windows is returned.</p>",
"GetDeployablePatchSnapshotForInstance": "<p>Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document. </p>",
"GetDocument": "<p>Gets the contents of the specified Systems Manager document.</p>",
"GetInventory": "<p>Query inventory information.</p>",
"GetInventorySchema": "<p>Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.</p>",
"GetMaintenanceWindow": "<p>Retrieves a maintenance window.</p>",
"GetMaintenanceWindowExecution": "<p>Retrieves details about a specific a maintenance window execution.</p>",
"GetMaintenanceWindowExecutionTask": "<p>Retrieves the details about a specific task run as part of a maintenance window execution.</p>",
"GetMaintenanceWindowExecutionTaskInvocation": "<p>Retrieves information about a specific task running on a specific target.</p>",
"GetMaintenanceWindowTask": "<p>Lists the tasks in a maintenance window.</p>",
"GetOpsItem": "<p>Get information about an OpsItem by using the ID. You must have permission in AWS Identity and Access Management (IAM) to view information about an OpsItem. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html\">Getting started with OpsCenter</a> in the <i>AWS Systems Manager User Guide</i>.</p> <p>Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html\">AWS Systems Manager OpsCenter</a> in the <i>AWS Systems Manager User Guide</i>. </p>",
"GetOpsSummary": "<p>View a summary of OpsItems based on specified filters and aggregators.</p>",
"GetParameter": "<p>Get information about a parameter by using the parameter name. Don't confuse this API action with the <a>GetParameters</a> API action.</p>",
"GetParameterHistory": "<p>Query a list of all parameters used by the AWS account.</p>",
"GetParameters": "<p>Get details of a parameter. Don't confuse this API action with the <a>GetParameter</a> API action.</p>",
"GetParametersByPath": "<p>Retrieve information about one or more parameters in a specific hierarchy. </p> <note> <p>Request results are returned on a best-effort basis. If you specify <code>MaxResults</code> in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of <code>MaxResults</code>. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a <code>NextToken</code>. You can specify the <code>NextToken</code> in a subsequent call to get the next set of results.</p> </note>",
"GetPatchBaseline": "<p>Retrieves information about a patch baseline.</p>",
"GetPatchBaselineForPatchGroup": "<p>Retrieves the patch baseline that should be used for the specified patch group.</p>",
"GetServiceSetting": "<p> <code>ServiceSetting</code> is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of \"false\". This means the user can't use this feature unless they change the setting to \"true\" and intentionally opt in for a paid feature.</p> <p>Services map a <code>SettingId</code> object to a setting value. AWS services teams define the default value for a <code>SettingId</code>. You can't create a new <code>SettingId</code>, but you can overwrite the default value if you have the <code>ssm:UpdateServiceSetting</code> permission for the setting. Use the <a>UpdateServiceSetting</a> API action to change the default setting. Or use the <a>ResetServiceSetting</a> to change the value back to the original value defined by the AWS service team.</p> <p>Query the current service setting for the account. </p>",
"LabelParameterVersion": "<p>A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions. </p> <p>Parameter labels have the following requirements and restrictions.</p> <ul> <li> <p>A version of a parameter can have a maximum of 10 labels.</p> </li> <li> <p>You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2.</p> </li> <li> <p>You can move a label from one version of a parameter to another.</p> </li> <li> <p>You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter.</p> </li> <li> <p>You can't delete a parameter label. If you no longer want to use a parameter label, then you must move it to a different version of a parameter.</p> </li> <li> <p>A label can have a maximum of 100 characters.</p> </li> <li> <p>Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).</p> </li> <li> <p>Labels can't begin with a number, \"aws,\" or \"ssm\" (not case sensitive). If a label fails to meet these requirements, then the label is not associated with a parameter and the system displays it in the list of InvalidLabels.</p> </li> </ul>",
"ListAssociationVersions": "<p>Retrieves all versions of an association for a specific association ID.</p>",
"ListAssociations": "<p>Returns all State Manager associations in the current AWS account and Region. You can limit the results to a specific State Manager association document or instance by specifying a filter.</p>",
"ListCommandInvocations": "<p>An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user runs SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.</p>",
"ListCommands": "<p>Lists the commands requested by users of the AWS account.</p>",
"ListComplianceItems": "<p>For a specified resource ID, this API action returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.</p>",
"ListComplianceSummaries": "<p>Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.</p>",
"ListDocumentVersions": "<p>List all versions for a document.</p>",
"ListDocuments": "<p>Returns all Systems Manager (SSM) documents in the current AWS account and Region. You can limit the results of this request by using a filter.</p>",
"ListInventoryEntries": "<p>A list of inventory items returned by the request.</p>",
"ListResourceComplianceSummaries": "<p>Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.</p>",
"ListResourceDataSync": "<p>Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.</p> <p>The number of sync configurations might be too large to return using a single call to <code>ListResourceDataSync</code>. You can limit the number of sync configurations returned by using the <code>MaxResults</code> parameter. To determine whether there are more sync configurations to list, check the value of <code>NextToken</code> in the output. If there are more sync configurations to list, you can request them by specifying the <code>NextToken</code> returned in the call to the parameter of a subsequent call. </p>",
"ListTagsForResource": "<p>Returns a list of the tags assigned to the specified resource.</p>",
"ModifyDocumentPermission": "<p>Shares a Systems Manager document publicly or privately. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify <i>All</i> as the account ID.</p>",
"PutComplianceItems": "<p>Registers a compliance type and other compliance details on a designated resource. This action lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.</p> <p>ComplianceType can be one of the following:</p> <ul> <li> <p>ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.</p> </li> <li> <p>ExecutionType: Specify patch, association, or Custom:<code>string</code>.</p> </li> <li> <p>ExecutionTime. The time the patch, association, or custom compliance item was applied to the instance.</p> </li> <li> <p>Id: The patch, association, or custom compliance ID.</p> </li> <li> <p>Title: A title.</p> </li> <li> <p>Status: The status of the compliance item. For example, <code>approved</code> for patches, or <code>Failed</code> for associations.</p> </li> <li> <p>Severity: A patch severity. For example, <code>critical</code>.</p> </li> <li> <p>DocumentName: A SSM document name. For example, AWS-RunPatchBaseline.</p> </li> <li> <p>DocumentVersion: An SSM document version number. For example, 4.</p> </li> <li> <p>Classification: A patch classification. For example, <code>security updates</code>.</p> </li> <li> <p>PatchBaselineId: A patch baseline ID.</p> </li> <li> <p>PatchSeverity: A patch severity. For example, <code>Critical</code>.</p> </li> <li> <p>PatchState: A patch state. For example, <code>InstancesWithFailedPatches</code>.</p> </li> <li> <p>PatchGroup: The name of a patch group.</p> </li> <li> <p>InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'</p> </li> </ul>",
"PutInventory": "<p>Bulk update custom inventory items on one more instance. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.</p>",
"PutParameter": "<p>Add a parameter to the system.</p>",
"RegisterDefaultPatchBaseline": "<p>Defines the default patch baseline for the relevant operating system.</p> <p>To reset the AWS predefined patch baseline as the default, specify the full patch baseline ARN as the baseline ID value. For example, for CentOS, specify <code>arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed</code> instead of <code>pb-0574b43a65ea646ed</code>.</p>",
"RegisterPatchBaselineForPatchGroup": "<p>Registers a patch baseline for a patch group.</p>",
"RegisterTargetWithMaintenanceWindow": "<p>Registers a target with a maintenance window.</p>",
"RegisterTaskWithMaintenanceWindow": "<p>Adds a new task to a maintenance window.</p>",
"RemoveTagsFromResource": "<p>Removes tag keys from the specified resource.</p>",
"ResetServiceSetting": "<p> <code>ServiceSetting</code> is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of \"false\". This means the user can't use this feature unless they change the setting to \"true\" and intentionally opt in for a paid feature.</p> <p>Services map a <code>SettingId</code> object to a setting value. AWS services teams define the default value for a <code>SettingId</code>. You can't create a new <code>SettingId</code>, but you can overwrite the default value if you have the <code>ssm:UpdateServiceSetting</code> permission for the setting. Use the <a>GetServiceSetting</a> API action to view the current value. Use the <a>UpdateServiceSetting</a> API action to change the default setting. </p> <p>Reset the service setting for the account to the default value as provisioned by the AWS service team. </p>",
"ResumeSession": "<p>Reconnects a session to an instance after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.</p> <note> <p>This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It is not intended for any other use.</p> </note>",
"SendAutomationSignal": "<p>Sends a signal to an Automation execution to change the current behavior or status of the execution. </p>",
"SendCommand": "<p>Runs commands on one or more managed instances.</p>",
"StartAssociationsOnce": "<p>Use this API action to run an association immediately and only one time. This action can be helpful when troubleshooting associations.</p>",
"StartAutomationExecution": "<p>Initiates execution of an Automation document.</p>",
"StartSession": "<p>Initiates a connection to a target (for example, an instance) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.</p> <note> <p>AWS CLI usage: <code>start-session</code> is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html\">Install the Session Manager plugin for the AWS CLI</a> in the <i>AWS Systems Manager User Guide</i>.</p> <p>AWS Tools for PowerShell usage: Start-SSMSession is not currently supported by AWS Tools for PowerShell on Windows local machines.</p> </note>",
"StopAutomationExecution": "<p>Stop an Automation that is currently running.</p>",
"TerminateSession": "<p>Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance. A terminated session cannot be resumed.</p>",
"UpdateAssociation": "<p>Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output. </p> <p>In order to call this API action, your IAM user account, group, or role must be configured with permission to call the <a>DescribeAssociation</a> API action. If you don't have permission to call DescribeAssociation, then you receive the following error: <code>An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> is not authorized to perform: ssm:DescribeAssociation on resource: <resource_arn></code> </p> <important> <p>When you update an association, the association immediately runs against the specified targets.</p> </important>",
"UpdateAssociationStatus": "<p>Updates the status of the Systems Manager document associated with the specified instance.</p>",
"UpdateDocument": "<p>Updates one or more values for an SSM document.</p>",
"UpdateDocumentDefaultVersion": "<p>Set the default version of a document. </p>",
"UpdateMaintenanceWindow": "<p>Updates an existing maintenance window. Only specified parameters are modified.</p> <note> <p>The value you specify for <code>Duration</code> determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for <code>Cutoff</code>. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for <code>Cutoff</code> is one hour, no maintenance window tasks can start after 5 PM.</p> </note>",
"UpdateMaintenanceWindowTarget": "<p>Modifies the target of an existing maintenance window. You can change the following:</p> <ul> <li> <p>Name</p> </li> <li> <p>Description</p> </li> <li> <p>Owner</p> </li> <li> <p>IDs for an ID target</p> </li> <li> <p>Tags for a Tag target</p> </li> <li> <p>From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see <a>Target</a>.</p> </li> </ul> <note> <p>If a parameter is null, then the corresponding field is not modified.</p> </note>",
"UpdateMaintenanceWindowTask": "<p>Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values:</p> <ul> <li> <p>TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript.</p> </li> <li> <p>ServiceRoleArn</p> </li> <li> <p>TaskInvocationParameters</p> </li> <li> <p>Priority</p> </li> <li> <p>MaxConcurrency</p> </li> <li> <p>MaxErrors</p> </li> </ul> <p>If a parameter is null, then the corresponding field is not modified. Also, if you set Replace to true, then all fields required by the <a>RegisterTaskWithMaintenanceWindow</a> action are required for this request. Optional fields that aren't specified are set to null.</p>",
"UpdateManagedInstanceRole": "<p>Changes the Amazon Identity and Access Management (IAM) role that is assigned to the on-premises instance or virtual machines (VM). IAM roles are first assigned to these hybrid instances during the activation process. For more information, see <a>CreateActivation</a>.</p>",
"UpdateOpsItem": "<p>Edit or change an OpsItem. You must have permission in AWS Identity and Access Management (IAM) to update an OpsItem. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html\">Getting started with OpsCenter</a> in the <i>AWS Systems Manager User Guide</i>.</p> <p>Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html\">AWS Systems Manager OpsCenter</a> in the <i>AWS Systems Manager User Guide</i>. </p>",
"UpdatePatchBaseline": "<p>Modifies an existing patch baseline. Fields not specified in the request are left unchanged.</p> <note> <p>For information about valid key and value pairs in <code>PatchFilters</code> for each supported operating system type, see <a href=\"http://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html\">PatchFilter</a>.</p> </note>",
"UpdateResourceDataSync": "<p>Update a resource data sync. After you create a resource data sync for a Region, you can't change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the Include only the current account option, you can't edit that sync later and choose the Include all accounts from my AWS Organizations configuration option. Instead, you must delete the first resource data sync, and create a new one.</p> <note> <p>This API action only supports a resource data sync that was created with a SyncFromSource <code>SyncType</code>.</p> </note>",
"UpdateServiceSetting": "<p> <code>ServiceSetting</code> is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of \"false\". This means the user can't use this feature unless they change the setting to \"true\" and intentionally opt in for a paid feature.</p> <p>Services map a <code>SettingId</code> object to a setting value. AWS services teams define the default value for a <code>SettingId</code>. You can't create a new <code>SettingId</code>, but you can overwrite the default value if you have the <code>ssm:UpdateServiceSetting</code> permission for the setting. Use the <a>GetServiceSetting</a> API action to view the current value. Or, use the <a>ResetServiceSetting</a> to change the value back to the original value defined by the AWS service team.</p> <p>Update the service setting for the account. </p>"
},
"shapes": {
"Account": {
"base": null,
"refs": {
"Accounts$member": null
}
},
"AccountId": {
"base": null,
"refs": {
"AccountIdList$member": null,
"AccountSharingInfo$AccountId": "<p>The AWS account ID where the current document is shared.</p>"
}
},
"AccountIdList": {
"base": null,
"refs": {
"DescribeDocumentPermissionResponse$AccountIds": "<p>The account IDs that have permission to use this document. The ID can be either an AWS account or <i>All</i>.</p>",
"ModifyDocumentPermissionRequest$AccountIdsToAdd": "<p>The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or <i>All</i>.</p>",
"ModifyDocumentPermissionRequest$AccountIdsToRemove": "<p>The AWS user accounts that should no longer have access to the document. The AWS user account can either be a group of account IDs or <i>All</i>. This action has a higher priority than <i>AccountIdsToAdd</i>. If you specify an account ID to add and the same ID to remove, the system removes access to the document.</p>"
}
},
"AccountSharingInfo": {
"base": "<p>Information includes the AWS account ID where the current document is shared and the version shared with that account.</p>",
"refs": {
"AccountSharingInfoList$member": null
}
},
"AccountSharingInfoList": {
"base": "<p>A list of of AWS accounts where the current document is shared and the version shared with each account.</p>",
"refs": {
"DescribeDocumentPermissionResponse$AccountSharingInfoList": "<p>A list of AWS accounts where the current document is shared and the version shared with each account.</p>"
}
},
"Accounts": {
"base": null,
"refs": {
"TargetLocation$Accounts": "<p>The AWS accounts targeted by the current Automation execution.</p>"
}
},
"Activation": {
"base": "<p>An activation registers one or more on-premises servers or virtual machines (VMs) with AWS so that you can configure those servers or VMs using Run Command. A server or VM that has been registered with AWS is called a managed instance.</p>",
"refs": {
"ActivationList$member": null
}
},
"ActivationCode": {
"base": null,
"refs": {
"CreateActivationResult$ActivationCode": "<p>The code the system generates when it processes the activation. The activation code functions like a password to validate the activation ID. </p>"
}
},
"ActivationDescription": {
"base": null,
"refs": {
"Activation$Description": "<p>A user defined description of the activation.</p>",
"CreateActivationRequest$Description": "<p>A user-defined description of the resource that you want to register with Systems Manager. </p> <important> <p>Do not enter personally identifiable information in this field.</p> </important>"
}
},
"ActivationId": {
"base": null,
"refs": {
"Activation$ActivationId": "<p>The ID created by Systems Manager when you submitted the activation.</p>",
"CreateActivationResult$ActivationId": "<p>The ID number generated by the system when it processed the activation. The activation ID functions like a user name.</p>",
"DeleteActivationRequest$ActivationId": "<p>The ID of the activation that you want to delete.</p>",
"InstanceInformation$ActivationId": "<p>The activation ID created by Systems Manager when the server or VM was registered.</p>"
}
},
"ActivationList": {
"base": null,
"refs": {
"DescribeActivationsResult$ActivationList": "<p>A list of activations for your AWS account.</p>"
}
},
"AddTagsToResourceRequest": {
"base": null,
"refs": {
}
},
"AddTagsToResourceResult": {
"base": null,
"refs": {
}
},
"AgentErrorCode": {
"base": null,
"refs": {
"InstanceAssociationStatusInfo$ErrorCode": "<p>An error code returned by the request to create the association.</p>"
}
},
"AggregatorSchemaOnly": {
"base": null,
"refs": {
"GetInventorySchemaRequest$Aggregator": "<p>Returns inventory schemas that support aggregation. For example, this call returns the <code>AWS:InstanceInformation</code> type, because it supports aggregation based on the <code>PlatformName</code>, <code>PlatformType</code>, and <code>PlatformVersion</code> attributes.</p>"
}
},
"AllowedPattern": {
"base": null,
"refs": {
"ParameterHistory$AllowedPattern": "<p>Parameter names can include the following letters and symbols.</p> <p>a-zA-Z0-9_.-</p>",
"ParameterMetadata$AllowedPattern": "<p>A parameter name can include only the following letters and symbols.</p> <p>a-zA-Z0-9_.-</p>",
"PutParameterRequest$AllowedPattern": "<p>A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\\d+$ </p>"
}
},
"AlreadyExistsException": {
"base": "<p>Error returned if an attempt is made to register a patch group with a patch baseline that is already registered with a different patch baseline.</p>",
"refs": {
}
},
"ApproveAfterDays": {
"base": null,
"refs": {
"PatchRule$ApproveAfterDays": "<p>The number of days after the release date of each patch matched by the rule that the patch is marked as approved in the patch baseline. For example, a value of <code>7</code> means that patches are approved seven days after they are released. Not supported on Ubuntu Server.</p>"
}
},
"AssociatedInstances": {
"base": "<p>You must disassociate a document from all instances before you can delete it.</p>",
"refs": {
}
},
"Association": {
"base": "<p>Describes an association of a Systems Manager document and an instance.</p>",
"refs": {
"AssociationList$member": null
}
},
"AssociationAlreadyExists": {
"base": "<p>The specified association already exists.</p>",
"refs": {
}
},
"AssociationComplianceSeverity": {
"base": null,
"refs": {
"AssociationDescription$ComplianceSeverity": "<p>The severity level that is assigned to the association.</p>",
"AssociationVersionInfo$ComplianceSeverity": "<p>The severity level that is assigned to the association.</p>",
"CreateAssociationBatchRequestEntry$ComplianceSeverity": "<p>The severity level to assign to the association.</p>",
"CreateAssociationRequest$ComplianceSeverity": "<p>The severity level to assign to the association.</p>",
"UpdateAssociationRequest$ComplianceSeverity": "<p>The severity level to assign to the association.</p>"
}
},
"AssociationDescription": {
"base": "<p>Describes the parameters for a document.</p>",
"refs": {
"AssociationDescriptionList$member": null,
"CreateAssociationResult$AssociationDescription": "<p>Information about the association.</p>",
"DescribeAssociationResult$AssociationDescription": "<p>Information about the association.</p>",
"UpdateAssociationResult$AssociationDescription": "<p>The description of the association that was updated.</p>",
"UpdateAssociationStatusResult$AssociationDescription": "<p>Information about the association.</p>"
}
},
"AssociationDescriptionList": {
"base": null,
"refs": {
"CreateAssociationBatchResult$Successful": "<p>Information about the associations that succeeded.</p>"
}
},
"AssociationDoesNotExist": {
"base": "<p>The specified association does not exist.</p>",
"refs": {
}
},
"AssociationExecution": {
"base": "<p>Includes information about the specified association.</p>",
"refs": {
"AssociationExecutionsList$member": null
}
},
"AssociationExecutionDoesNotExist": {
"base": "<p>The specified execution ID does not exist. Verify the ID number and try again.</p>",
"refs": {
}
},
"AssociationExecutionFilter": {
"base": "<p>Filters used in the request.</p>",
"refs": {
"AssociationExecutionFilterList$member": null
}
},
"AssociationExecutionFilterKey": {
"base": null,
"refs": {
"AssociationExecutionFilter$Key": "<p>The key value used in the request.</p>"
}
},
"AssociationExecutionFilterList": {
"base": null,
"refs": {
"DescribeAssociationExecutionsRequest$Filters": "<p>Filters for the request. You can specify the following filters and values.</p> <p>ExecutionId (EQUAL)</p> <p>Status (EQUAL)</p> <p>CreatedTime (EQUAL, GREATER_THAN, LESS_THAN)</p>"
}
},
"AssociationExecutionFilterValue": {
"base": null,
"refs": {
"AssociationExecutionFilter$Value": "<p>The value specified for the key.</p>"
}
},
"AssociationExecutionId": {
"base": null,
"refs": {
"AssociationExecution$ExecutionId": "<p>The execution ID for the association.</p>",
"AssociationExecutionTarget$ExecutionId": "<p>The execution ID.</p>",
"DescribeAssociationExecutionTargetsRequest$ExecutionId": "<p>The execution ID for which you want to view details.</p>"
}
},
"AssociationExecutionTarget": {
"base": "<p>Includes information about the specified association execution.</p>",
"refs": {
"AssociationExecutionTargetsList$member": null
}
},
"AssociationExecutionTargetsFilter": {
"base": "<p>Filters for the association execution.</p>",
"refs": {
"AssociationExecutionTargetsFilterList$member": null
}
},
"AssociationExecutionTargetsFilterKey": {
"base": null,
"refs": {
"AssociationExecutionTargetsFilter$Key": "<p>The key value used in the request.</p>"
}
},
"AssociationExecutionTargetsFilterList": {
"base": null,
"refs": {
"DescribeAssociationExecutionTargetsRequest$Filters": "<p>Filters for the request. You can specify the following filters and values.</p> <p>Status (EQUAL)</p> <p>ResourceId (EQUAL)</p> <p>ResourceType (EQUAL)</p>"
}
},
"AssociationExecutionTargetsFilterValue": {
"base": null,
"refs": {
"AssociationExecutionTargetsFilter$Value": "<p>The value specified for the key.</p>"
}
},
"AssociationExecutionTargetsList": {
"base": null,
"refs": {
"DescribeAssociationExecutionTargetsResult$AssociationExecutionTargets": "<p>Information about the execution.</p>"
}
},
"AssociationExecutionsList": {
"base": null,
"refs": {
"DescribeAssociationExecutionsResult$AssociationExecutions": "<p>A list of the executions for the specified association ID.</p>"
}
},
"AssociationFilter": {
"base": "<p>Describes a filter.</p>",
"refs": {
"AssociationFilterList$member": null
}
},
"AssociationFilterKey": {
"base": null,
"refs": {
"AssociationFilter$key": "<p>The name of the filter.</p>"
}
},
"AssociationFilterList": {
"base": null,
"refs": {
"ListAssociationsRequest$AssociationFilterList": "<p>One or more filters. Use a filter to return a more specific list of results.</p>"
}
},
"AssociationFilterOperatorType": {
"base": null,
"refs": {
"AssociationExecutionFilter$Type": "<p>The filter type specified in the request.</p>"
}
},
"AssociationFilterValue": {
"base": null,
"refs": {
"AssociationFilter$value": "<p>The filter value.</p>"
}
},
"AssociationId": {
"base": null,
"refs": {
"Association$AssociationId": "<p>The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.</p>",
"AssociationDescription$AssociationId": "<p>The association ID.</p>",
"AssociationExecution$AssociationId": "<p>The association ID.</p>",
"AssociationExecutionTarget$AssociationId": "<p>The association ID.</p>",
"AssociationIdList$member": null,
"AssociationVersionInfo$AssociationId": "<p>The ID created by the system when the association was created.</p>",
"DeleteAssociationRequest$AssociationId": "<p>The association ID that you want to delete.</p>",
"DescribeAssociationExecutionTargetsRequest$AssociationId": "<p>The association ID that includes the execution for which you want to view details.</p>",
"DescribeAssociationExecutionsRequest$AssociationId": "<p>The association ID for which you want to view execution history details.</p>",
"DescribeAssociationRequest$AssociationId": "<p>The association ID for which you want information.</p>",
"InstanceAssociation$AssociationId": "<p>The association ID.</p>",
"InstanceAssociationStatusInfo$AssociationId": "<p>The association ID.</p>",
"ListAssociationVersionsRequest$AssociationId": "<p>The association ID for which you want to view all versions.</p>",
"UpdateAssociationRequest$AssociationId": "<p>The ID of the association you want to update. </p>"
}
},
"AssociationIdList": {
"base": null,
"refs": {
"StartAssociationsOnceRequest$AssociationIds": "<p>The association IDs that you want to run immediately and only one time.</p>"
}
},
"AssociationLimitExceeded": {
"base": "<p>You can have at most 2,000 active associations.</p>",
"refs": {
}
},
"AssociationList": {
"base": null,
"refs": {
"ListAssociationsResult$Associations": "<p>The associations.</p>"
}
},
"AssociationName": {
"base": null,
"refs": {
"Association$AssociationName": "<p>The association name.</p>",
"AssociationDescription$AssociationName": "<p>The association name.</p>",
"AssociationVersionInfo$AssociationName": "<p>The name specified for the association version when the association version was created.</p>",
"CreateAssociationBatchRequestEntry$AssociationName": "<p>Specify a descriptive name for the association.</p>",
"CreateAssociationRequest$AssociationName": "<p>Specify a descriptive name for the association.</p>",
"InstanceAssociationStatusInfo$AssociationName": "<p>The name of the association applied to the instance.</p>",
"UpdateAssociationRequest$AssociationName": "<p>The name of the association that you want to update.</p>"
}
},
"AssociationOverview": {
"base": "<p>Information about the association.</p>",
"refs": {
"Association$Overview": "<p>Information about the association.</p>",
"AssociationDescription$Overview": "<p>Information about the association.</p>"
}
},
"AssociationResourceId": {
"base": null,
"refs": {
"AssociationExecutionTarget$ResourceId": "<p>The resource ID, for example, the instance ID where the association ran.</p>"
}
},
"AssociationResourceType": {
"base": null,
"refs": {
"AssociationExecutionTarget$ResourceType": "<p>The resource type, for example, instance.</p>"
}
},
"AssociationStatus": {
"base": "<p>Describes an association status.</p>",
"refs": {
"AssociationDescription$Status": "<p>The association status.</p>",
"UpdateAssociationStatusRequest$AssociationStatus": "<p>The association status.</p>"
}
},
"AssociationStatusAggregatedCount": {
"base": null,
"refs": {
"AssociationOverview$AssociationStatusAggregatedCount": "<p>Returns the number of targets for the association status. For example, if you created an association with two instances, and one of them was successful, this would return the count of instances by status.</p>"
}
},
"AssociationStatusName": {
"base": null,
"refs": {
"AssociationStatus$Name": "<p>The status.</p>"
}
},
"AssociationSyncCompliance": {
"base": null,
"refs": {
"AssociationDescription$SyncCompliance": "<p>The mode for generating association compliance. You can specify <code>AUTO</code> or <code>MANUAL</code>. In <code>AUTO</code> mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is <code>COMPLIANT</code>. If the association execution doesn't run successfully, the association is <code>NON-COMPLIANT</code>.</p> <p>In <code>MANUAL</code> mode, you must specify the <code>AssociationId</code> as a parameter for the <a>PutComplianceItems</a> API action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the <a>PutComplianceItems</a> API action.</p> <p>By default, all associations use <code>AUTO</code> mode.</p>",
"AssociationVersionInfo$SyncCompliance": "<p>The mode for generating association compliance. You can specify <code>AUTO</code> or <code>MANUAL</code>. In <code>AUTO</code> mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is <code>COMPLIANT</code>. If the association execution doesn't run successfully, the association is <code>NON-COMPLIANT</code>.</p> <p>In <code>MANUAL</code> mode, you must specify the <code>AssociationId</code> as a parameter for the <a>PutComplianceItems</a> API action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the <a>PutComplianceItems</a> API action.</p> <p>By default, all associations use <code>AUTO</code> mode.</p>",
"CreateAssociationBatchRequestEntry$SyncCompliance": "<p>The mode for generating association compliance. You can specify <code>AUTO</code> or <code>MANUAL</code>. In <code>AUTO</code> mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is <code>COMPLIANT</code>. If the association execution doesn't run successfully, the association is <code>NON-COMPLIANT</code>. </p> <p>In <code>MANUAL</code> mode, you must specify the <code>AssociationId</code> as a parameter for the <a>PutComplianceItems</a> API action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the <a>PutComplianceItems</a> API action.</p> <p>By default, all associations use <code>AUTO</code> mode.</p>",
"CreateAssociationRequest$SyncCompliance": "<p>The mode for generating association compliance. You can specify <code>AUTO</code> or <code>MANUAL</code>. In <code>AUTO</code> mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is <code>COMPLIANT</code>. If the association execution doesn't run successfully, the association is <code>NON-COMPLIANT</code>.</p> <p>In <code>MANUAL</code> mode, you must specify the <code>AssociationId</code> as a parameter for the <a>PutComplianceItems</a> API action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the <a>PutComplianceItems</a> API action.</p> <p>By default, all associations use <code>AUTO</code> mode.</p>",
"UpdateAssociationRequest$SyncCompliance": "<p>The mode for generating association compliance. You can specify <code>AUTO</code> or <code>MANUAL</code>. In <code>AUTO</code> mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is <code>COMPLIANT</code>. If the association execution doesn't run successfully, the association is <code>NON-COMPLIANT</code>.</p> <p>In <code>MANUAL</code> mode, you must specify the <code>AssociationId</code> as a parameter for the <a>PutComplianceItems</a> API action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the <a>PutComplianceItems</a> API action.</p> <p>By default, all associations use <code>AUTO</code> mode.</p>"
}
},
"AssociationVersion": {
"base": null,
"refs": {
"Association$AssociationVersion": "<p>The association version.</p>",
"AssociationDescription$AssociationVersion": "<p>The association version.</p>",
"AssociationExecution$AssociationVersion": "<p>The association version.</p>",
"AssociationExecutionTarget$AssociationVersion": "<p>The association version.</p>",
"AssociationVersionInfo$AssociationVersion": "<p>The association version.</p>",
"DescribeAssociationRequest$AssociationVersion": "<p>Specify the association version to retrieve. To view the latest version, either specify <code>$LATEST</code> for this parameter, or omit this parameter. To view a list of all associations for an instance, use <a>ListAssociations</a>. To get a list of versions for a specific association, use <a>ListAssociationVersions</a>. </p>",
"InstanceAssociation$AssociationVersion": "<p>Version information for the association on the instance.</p>",
"InstanceAssociationStatusInfo$AssociationVersion": "<p>The version of the association applied to the instance.</p>",
"UpdateAssociationRequest$AssociationVersion": "<p>This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify <code>$LATEST</code>, or omit this parameter.</p>"
}
},
"AssociationVersionInfo": {
"base": "<p>Information about the association version.</p>",
"refs": {
"AssociationVersionList$member": null
}
},
"AssociationVersionLimitExceeded": {
"base": "<p>You have reached the maximum number versions allowed for an association. Each association has a limit of 1,000 versions. </p>",
"refs": {
}
},
"AssociationVersionList": {
"base": null,
"refs": {
"ListAssociationVersionsResult$AssociationVersions": "<p>Information about all versions of the association for the specified association ID.</p>"
}
},
"AttachmentContent": {
"base": "<p>A structure that includes attributes that describe a document attachment.</p>",
"refs": {
"AttachmentContentList$member": null
}
},
"AttachmentContentList": {
"base": null,
"refs": {
"GetDocumentResult$AttachmentsContent": "<p>A description of the document attachments, including names, locations, sizes, and so on.</p>"
}
},
"AttachmentHash": {
"base": null,
"refs": {
"AttachmentContent$Hash": "<p>The cryptographic hash value of the document content.</p>"
}
},
"AttachmentHashType": {
"base": null,
"refs": {
"AttachmentContent$HashType": "<p>The hash algorithm used to calculate the hash value.</p>"
}
},
"AttachmentIdentifier": {
"base": null,
"refs": {
"AttachmentsSource$Name": "<p>The name of the document attachment file.</p>"
}
},
"AttachmentInformation": {
"base": "<p>An attribute of an attachment, such as the attachment name.</p>",
"refs": {
"AttachmentInformationList$member": null
}
},
"AttachmentInformationList": {
"base": null,
"refs": {
"DocumentDescription$AttachmentsInformation": "<p>Details about the document attachments, including names, locations, sizes, and so on.</p>"
}
},
"AttachmentName": {
"base": null,
"refs": {
"AttachmentContent$Name": "<p>The name of an attachment.</p>",
"AttachmentInformation$Name": "<p>The name of the attachment.</p>"
}
},
"AttachmentUrl": {
"base": null,
"refs": {
"AttachmentContent$Url": "<p>The URL location of the attachment content.</p>"
}
},
"AttachmentsSource": {
"base": "<p>Identifying information about a document attachment, including the file name and a key-value pair that identifies the location of an attachment to a document.</p>",
"refs": {
"AttachmentsSourceList$member": null
}
},
"AttachmentsSourceKey": {
"base": null,
"refs": {
"AttachmentsSource$Key": "<p>The key of a key-value pair that identifies the location of an attachment to a document.</p>"
}
},
"AttachmentsSourceList": {
"base": null,
"refs": {
"CreateDocumentRequest$Attachments": "<p>A list of key and value pairs that describe attachments to a version of a document.</p>",
"UpdateDocumentRequest$Attachments": "<p>A list of key and value pairs that describe attachments to a version of a document.</p>"
}
},
"AttachmentsSourceValue": {
"base": null,
"refs": {
"AttachmentsSourceValues$member": null
}
},
"AttachmentsSourceValues": {
"base": null,
"refs": {
"AttachmentsSource$Values": "<p>The value of a key-value pair that identifies the location of an attachment to a document. The format for <b>Value</b> depends on the type of key you specify.</p> <ul> <li> <p>For the key <i>SourceUrl</i>, the value is an S3 bucket location. For example:</p> <p> <code>\"Values\": [ \"s3://my-bucket/my-folder\" ]</code> </p> </li> <li> <p>For the key <i>S3FileUrl</i>, the value is a file in an S3 bucket. For example:</p> <p> <code>\"Values\": [ \"s3://my-bucket/my-folder/my-file.py\" ]</code> </p> </li> <li> <p>For the key <i>AttachmentReference</i>, the value is constructed from the name of another SSM document in your account, a version number of that document, and a file attached to that document version that you want to reuse. For example:</p> <p> <code>\"Values\": [ \"MyOtherDocument/3/my-other-file.py\" ]</code> </p> <p>However, if the SSM document is shared with you from another account, the full SSM document ARN must be specified instead of the document name only. For example:</p> <p> <code>\"Values\": [ \"arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py\" ]</code> </p> </li> </ul>"
}
},
"AttributeName": {
"base": null,
"refs": {
"ComplianceItemDetails$key": null,
"InventoryItemContentContext$key": null,
"InventoryItemEntry$key": null,
"OpsEntityItemEntry$key": null,
"PatchPropertyEntry$key": null
}
},
"AttributeValue": {
"base": null,
"refs": {
"ComplianceItemDetails$value": null,
"InventoryItemContentContext$value": null,
"InventoryItemEntry$value": null,
"OpsEntityItemEntry$value": null,
"PatchPropertyEntry$value": null
}
},
"AutomationActionName": {
"base": null,
"refs": {
"StepExecution$Action": "<p>The action this step performs. The action determines the behavior of the step.</p>"
}
},
"AutomationDefinitionNotFoundException": {
"base": "<p>An Automation document with the specified name could not be found.</p>",
"refs": {
}
},
"AutomationDefinitionVersionNotFoundException": {
"base": "<p>An Automation document with the specified name and version could not be found.</p>",
"refs": {
}
},
"AutomationExecution": {
"base": "<p>Detailed information about the current state of an individual Automation execution.</p>",
"refs": {
"GetAutomationExecutionResult$AutomationExecution": "<p>Detailed information about the current state of an automation execution.</p>"
}
},
"AutomationExecutionFilter": {
"base": "<p>A filter used to match specific automation executions. This is used to limit the scope of Automation execution information returned.</p>",
"refs": {
"AutomationExecutionFilterList$member": null
}
},
"AutomationExecutionFilterKey": {
"base": null,
"refs": {
"AutomationExecutionFilter$Key": "<p>One or more keys to limit the results. Valid filter keys include the following: DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter.</p>"
}
},
"AutomationExecutionFilterList": {
"base": null,
"refs": {
"DescribeAutomationExecutionsRequest$Filters": "<p>Filters used to limit the scope of executions that are requested.</p>"
}
},
"AutomationExecutionFilterValue": {
"base": null,
"refs": {
"AutomationExecutionFilterValueList$member": null
}
},
"AutomationExecutionFilterValueList": {
"base": null,
"refs": {
"AutomationExecutionFilter$Values": "<p>The values used to limit the execution information associated with the filter's key.</p>"
}
},
"AutomationExecutionId": {
"base": null,
"refs": {
"AutomationExecution$AutomationExecutionId": "<p>The execution ID.</p>",
"AutomationExecution$ParentAutomationExecutionId": "<p>The AutomationExecutionId of the parent automation.</p>",
"AutomationExecutionMetadata$AutomationExecutionId": "<p>The execution ID.</p>",
"AutomationExecutionMetadata$ParentAutomationExecutionId": "<p>The ExecutionId of the parent Automation.</p>",
"DescribeAutomationStepExecutionsRequest$AutomationExecutionId": "<p>The Automation execution ID for which you want step execution descriptions.</p>",
"GetAutomationExecutionRequest$AutomationExecutionId": "<p>The unique identifier for an existing automation execution to examine. The execution ID is returned by StartAutomationExecution when the execution of an Automation document is initiated.</p>",
"SendAutomationSignalRequest$AutomationExecutionId": "<p>The unique identifier for an existing Automation execution that you want to send the signal to.</p>",
"StartAutomationExecutionResult$AutomationExecutionId": "<p>The unique ID of a newly scheduled automation execution.</p>",
"StopAutomationExecutionRequest$AutomationExecutionId": "<p>The execution ID of the Automation to stop.</p>"
}
},
"AutomationExecutionLimitExceededException": {
"base": "<p>The number of simultaneously running Automation executions exceeded the allowable limit.</p>",
"refs": {
}
},
"AutomationExecutionMetadata": {
"base": "<p>Details about a specific Automation execution.</p>",
"refs": {
"AutomationExecutionMetadataList$member": null
}
},
"AutomationExecutionMetadataList": {
"base": null,
"refs": {
"DescribeAutomationExecutionsResult$AutomationExecutionMetadataList": "<p>The list of details about each automation execution which has occurred which matches the filter specification, if any.</p>"
}
},
"AutomationExecutionNotFoundException": {
"base": "<p>There is no automation execution information for the requested automation execution ID.</p>",
"refs": {
}
},
"AutomationExecutionStatus": {
"base": null,
"refs": {
"AutomationExecution$AutomationExecutionStatus": "<p>The execution status of the Automation.</p>",
"AutomationExecutionMetadata$AutomationExecutionStatus": "<p>The status of the execution.</p>",
"StepExecution$StepStatus": "<p>The execution status for this step.</p>"
}
},
"AutomationParameterKey": {
"base": null,
"refs": {
"AutomationExecution$TargetParameterName": "<p>The parameter name.</p>",
"AutomationExecutionMetadata$TargetParameterName": "<p>The list of execution outputs as defined in the Automation document.</p>",
"AutomationParameterMap$key": null,
"StartAutomationExecutionRequest$TargetParameterName": "<p>The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.</p>"
}
},
"AutomationParameterMap": {
"base": null,
"refs": {
"AutomationExecution$Parameters": "<p>The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.</p>",
"AutomationExecution$Outputs": "<p>The list of execution outputs as defined in the automation document.</p>",
"AutomationExecutionMetadata$Outputs": "<p>The list of execution outputs as defined in the Automation document.</p>",
"FailureDetails$Details": "<p>Detailed information about the Automation step failure.</p>",
"MaintenanceWindowAutomationParameters$Parameters": "<p>The parameters for the AUTOMATION task.</p> <p>For information about specifying and updating task parameters, see <a>RegisterTaskWithMaintenanceWindow</a> and <a>UpdateMaintenanceWindowTask</a>.</p> <note> <p> <code>LoggingInfo</code> has been deprecated. To specify an S3 bucket to contain logs, instead use the <code>OutputS3BucketName</code> and <code>OutputS3KeyPrefix</code> options in the <code>TaskInvocationParameters</code> structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p> <p> <code>TaskParameters</code> has been deprecated. To specify parameters to pass to a task when it runs, instead use the <code>Parameters</code> option in the <code>TaskInvocationParameters</code> structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p> <p>For AUTOMATION task types, Systems Manager ignores any values specified for these parameters.</p> </note>",
"SendAutomationSignalRequest$Payload": "<p>The data sent with the signal. The data schema depends on the type of signal used in the request.</p> <p>For <code>Approve</code> and <code>Reject</code> signal types, the payload is an optional comment that you can send with the signal type. For example:</p> <p> <code>Comment=\"Looks good\"</code> </p> <p>For <code>StartStep</code> and <code>Resume</code> signal types, you must send the name of the Automation step to start or resume as the payload. For example:</p> <p> <code>StepName=\"step1\"</code> </p> <p>For the <code>StopStep</code> signal type, you must send the step execution ID as the payload. For example:</p> <p> <code>StepExecutionId=\"97fff367-fc5a-4299-aed8-0123456789ab\"</code> </p>",
"StartAutomationExecutionRequest$Parameters": "<p>A key-value map of execution parameters, which match the declared parameters in the Automation document.</p>",
"StepExecution$Outputs": "<p>Returned values from the execution of the step.</p>",
"StepExecution$OverriddenParameters": "<p>A user-specified list of parameters to override when running a step.</p>"
}
},
"AutomationParameterValue": {
"base": null,
"refs": {
"AutomationParameterValueList$member": null
}
},
"AutomationParameterValueList": {
"base": null,
"refs": {
"AutomationParameterMap$value": null
}
},
"AutomationStepNotFoundException": {
"base": "<p>The specified step name and execution ID don't exist. Verify the information and try again.</p>",
"refs": {
}
},
"AutomationTargetParameterName": {
"base": null,
"refs": {
"AssociationDescription$AutomationTargetParameterName": "<p>Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.</p>",
"CreateAssociationBatchRequestEntry$AutomationTargetParameterName": "<p>Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.</p>",
"CreateAssociationRequest$AutomationTargetParameterName": "<p>Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.</p>",
"UpdateAssociationRequest$AutomationTargetParameterName": "<p>Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.</p>"
}
},
"AutomationType": {
"base": null,
"refs": {
"AutomationExecutionMetadata$AutomationType": "<p>Use this filter with <a>DescribeAutomationExecutions</a>. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple AWS Regions and 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 AWS Regions and accounts</a> in the <i>AWS Systems Manager User Guide</i>. </p>"
}
},
"BaselineDescription": {
"base": null,
"refs": {
"CreatePatchBaselineRequest$Description": "<p>A description of the patch baseline.</p>",
"GetPatchBaselineResult$Description": "<p>A description of the patch baseline.</p>",
"PatchBaselineIdentity$BaselineDescription": "<p>The description of the patch baseline.</p>",
"UpdatePatchBaselineRequest$Description": "<p>A description of the patch baseline.</p>",
"UpdatePatchBaselineResult$Description": "<p>A description of the Patch Baseline.</p>"
}
},
"BaselineId": {
"base": null,
"refs": {
"CreatePatchBaselineResult$BaselineId": "<p>The ID of the created patch baseline.</p>",
"DeletePatchBaselineRequest$BaselineId": "<p>The ID of the patch baseline to delete.</p>",
"DeletePatchBaselineResult$BaselineId": "<p>The ID of the deleted patch baseline.</p>",
"DeregisterPatchBaselineForPatchGroupRequest$BaselineId": "<p>The ID of the patch baseline to deregister the patch group from.</p>",
"DeregisterPatchBaselineForPatchGroupResult$BaselineId": "<p>The ID of the patch baseline the patch group was deregistered from.</p>",
"DescribeEffectivePatchesForPatchBaselineRequest$BaselineId": "<p>The ID of the patch baseline to retrieve the effective patches for.</p>",
"GetDefaultPatchBaselineResult$BaselineId": "<p>The ID of the default patch baseline.</p>",
"GetPatchBaselineForPatchGroupResult$BaselineId": "<p>The ID of the patch baseline that should be used for the patch group.</p>",
"GetPatchBaselineRequest$BaselineId": "<p>The ID of the patch baseline to retrieve.</p>",
"GetPatchBaselineResult$BaselineId": "<p>The ID of the retrieved patch baseline.</p>",
"InstancePatchState$BaselineId": "<p>The ID of the patch baseline used to patch the instance.</p>",
"PatchBaselineIdentity$BaselineId": "<p>The ID of the patch baseline.</p>",
"RegisterDefaultPatchBaselineRequest$BaselineId": "<p>The ID of the patch baseline that should be the default patch baseline.</p>",
"RegisterDefaultPatchBaselineResult$BaselineId": "<p>The ID of the default patch baseline.</p>",
"RegisterPatchBaselineForPatchGroupRequest$BaselineId": "<p>The ID of the patch baseline to register the patch group with.</p>",
"RegisterPatchBaselineForPatchGroupResult$BaselineId": "<p>The ID of the patch baseline the patch group was registered with.</p>",
"UpdatePatchBaselineRequest$BaselineId": "<p>The ID of the patch baseline to update.</p>",
"UpdatePatchBaselineResult$BaselineId": "<p>The ID of the deleted patch baseline.</p>"
}
},
"BaselineName": {
"base": null,
"refs": {
"CreatePatchBaselineRequest$Name": "<p>The name of the patch baseline.</p>",
"GetPatchBaselineResult$Name": "<p>The name of the patch baseline.</p>",
"PatchBaselineIdentity$BaselineName": "<p>The name of the patch baseline.</p>",
"UpdatePatchBaselineRequest$Name": "<p>The name of the patch baseline.</p>",
"UpdatePatchBaselineResult$Name": "<p>The name of the patch baseline.</p>"
}
},
"BatchErrorMessage": {
"base": null,
"refs": {
"FailedCreateAssociation$Message": "<p>A description of the failure.</p>"
}
},
"Boolean": {
"base": null,
"refs": {
"Activation$Expired": "<p>Whether or not the activation is expired.</p>",
"AutomationExecution$StepExecutionsTruncated": "<p>A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API action to get the full list of step executions.</p>",
"CreatePatchBaselineRequest$ApprovedPatchesEnableNonSecurity": "<p>Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.</p>",
"DeleteDocumentRequest$Force": "<p>Some SSM document types require that you specify a <code>Force</code> flag before you can delete the document. For example, you must specify a <code>Force</code> flag to delete a document of type <code>ApplicationConfigurationSchema</code>. You can restrict access to the <code>Force</code> flag in an AWS Identity and Access Management (IAM) policy.</p>",
"DeregisterTargetFromMaintenanceWindowRequest$Safe": "<p>The system checks if the target is being referenced by a task. If the target is being referenced, the system returns an error and does not deregister the target from the maintenance window.</p>",
"DescribeAutomationStepExecutionsRequest$ReverseOrder": "<p>A boolean that indicates whether to list step executions in reverse order by start time. The default value is false.</p>",
"DocumentVersionInfo$IsDefaultVersion": "<p>An identifier for the default version of the document.</p>",
"GetParameterHistoryRequest$WithDecryption": "<p>Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.</p>",
"GetParameterRequest$WithDecryption": "<p>Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.</p>",
"GetParametersByPathRequest$Recursive": "<p>Retrieve all parameters within a hierarchy.</p> <important> <p>If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path <code>/a</code>, then the user can also access <code>/a/b</code>. Even if a user has explicitly been denied access in IAM for parameter <code>/a/b</code>, they can still call the GetParametersByPath API action recursively for <code>/a</code> and view <code>/a/b</code>.</p> </important>",
"GetParametersByPathRequest$WithDecryption": "<p>Retrieve all parameters in a hierarchy with their value decrypted.</p>",
"GetParametersRequest$WithDecryption": "<p>Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.</p>",
"GetPatchBaselineResult$ApprovedPatchesEnableNonSecurity": "<p>Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.</p>",
"InstanceInformation$IsLatestVersion": "<p>Indicates whether the latest version of SSM Agent is running on your Linux Managed Instance. This field does not indicate whether or not the latest version is installed on Windows managed instances, because some older versions of Windows Server use the EC2Config service to process SSM requests.</p>",
"ListCommandInvocationsRequest$Details": "<p>(Optional) If set this returns the response of the command executions and any command output. By default this is set to False. </p>",
"PatchRule$EnableNonSecurity": "<p>For instances identified by the approval rule filters, enables a patch baseline to apply non-security updates available in the specified repository. The default value is 'false'. Applies to Linux instances only.</p>",
"PutParameterRequest$Overwrite": "<p>Overwrite an existing parameter. If not specified, will default to \"false\".</p>",
"ResolvedTargets$Truncated": "<p>A boolean value indicating whether the resolved target list is truncated.</p>",
"StepExecution$IsEnd": "<p>The flag which can be used to end automation no matter whether the step succeeds or fails.</p>",
"StepExecution$IsCritical": "<p>The flag which can be used to help decide whether the failure of current step leads to the Automation failure.</p>",
"UpdateMaintenanceWindowRequest$Replace": "<p>If True, then all fields that are required by the CreateMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null. </p>",
"UpdateMaintenanceWindowTargetRequest$Replace": "<p>If True, then all fields that are required by the RegisterTargetWithMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null.</p>",
"UpdateMaintenanceWindowTaskRequest$Replace": "<p>If True, then all fields that are required by the RegisterTaskWithMaintenanceWndow action are also required for this API request. Optional fields that are not specified are set to null.</p>",
"UpdatePatchBaselineRequest$ApprovedPatchesEnableNonSecurity": "<p>Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.</p>",
"UpdatePatchBaselineRequest$Replace": "<p>If True, then all fields that are required by the CreatePatchBaseline action are also required for this API request. Optional fields that are not specified are set to null.</p>",
"UpdatePatchBaselineResult$ApprovedPatchesEnableNonSecurity": "<p>Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.</p>"
}
},
"CalendarNameOrARN": {
"base": null,
"refs": {
"CalendarNameOrARNList$member": null
}
},
"CalendarNameOrARNList": {
"base": null,
"refs": {
"GetCalendarStateRequest$CalendarNames": "<p>The names or Amazon Resource Names (ARNs) of the Systems Manager documents that represent the calendar entries for which you want to get the state.</p>"
}
},
"CalendarState": {
"base": null,
"refs": {
"GetCalendarStateResponse$State": "<p>The state of the calendar. An <code>OPEN</code> calendar indicates that actions are allowed to proceed, and a <code>CLOSED</code> calendar indicates that actions are not allowed to proceed.</p>"
}
},
"CancelCommandRequest": {
"base": "<p/>",
"refs": {
}
},
"CancelCommandResult": {
"base": "<p>Whether or not the command was successfully canceled. There is no guarantee that a request can be canceled.</p>",
"refs": {
}
},
"CancelMaintenanceWindowExecutionRequest": {
"base": null,
"refs": {
}
},
"CancelMaintenanceWindowExecutionResult": {
"base": null,
"refs": {
}
},
"ClientToken": {
"base": null,
"refs": {
"CreateMaintenanceWindowRequest$ClientToken": "<p>User-provided idempotency token.</p>",
"CreatePatchBaselineRequest$ClientToken": "<p>User-provided idempotency token.</p>",
"DeleteInventoryRequest$ClientToken": "<p>User-provided idempotency token.</p>",
"RegisterTargetWithMaintenanceWindowRequest$ClientToken": "<p>User-provided idempotency token.</p>",
"RegisterTaskWithMaintenanceWindowRequest$ClientToken": "<p>User-provided idempotency token.</p>"
}
},
"CloudWatchLogGroupName": {
"base": null,
"refs": {
"CloudWatchOutputConfig$CloudWatchLogGroupName": "<p>The name of the CloudWatch log group where you want to send command output. If you don't specify a group name, Systems Manager automatically creates a log group for you. The log group uses the following naming format: aws/ssm/<i>SystemsManagerDocumentName</i>.</p>"
}
},
"CloudWatchOutputConfig": {
"base": "<p>Configuration options for sending command output to CloudWatch Logs.</p>",
"refs": {
"Command$CloudWatchOutputConfig": "<p>CloudWatch Logs information where you want Systems Manager to send the command output.</p>",
"CommandInvocation$CloudWatchOutputConfig": "<p>CloudWatch Logs information where you want Systems Manager to send the command output.</p>",
"GetCommandInvocationResult$CloudWatchOutputConfig": "<p>CloudWatch Logs information where Systems Manager sent the command output.</p>",
"MaintenanceWindowRunCommandParameters$CloudWatchOutputConfig": null,
"SendCommandRequest$CloudWatchOutputConfig": "<p>Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs. </p>"
}
},
"CloudWatchOutputEnabled": {
"base": null,
"refs": {
"CloudWatchOutputConfig$CloudWatchOutputEnabled": "<p>Enables Systems Manager to send command output to CloudWatch Logs.</p>"
}
},
"Command": {
"base": "<p>Describes a command request.</p>",
"refs": {
"CommandList$member": null,
"SendCommandResult$Command": "<p>The request as it was received by Systems Manager. Also provides the command ID which can be used future references to this request.</p>"
}
},
"CommandFilter": {
"base": "<p>Describes a command filter.</p>",
"refs": {
"CommandFilterList$member": null
}
},
"CommandFilterKey": {
"base": null,
"refs": {
"CommandFilter$key": "<p>The name of the filter.</p>"
}
},
"CommandFilterList": {
"base": null,
"refs": {
"ListCommandInvocationsRequest$Filters": "<p>(Optional) One or more filters. Use a filter to return a more specific list of results.</p>",
"ListCommandsRequest$Filters": "<p>(Optional) One or more filters. Use a filter to return a more specific list of results. </p>"
}
},
"CommandFilterValue": {
"base": null,
"refs": {
"CommandFilter$value": "<p>The filter value. Valid values for each filter key are as follows:</p> <ul> <li> <p> <b>InvokedAfter</b>: Specify a timestamp to limit your results. For example, specify <code>2018-07-07T00:00:00Z</code> to see a list of command executions occurring July 7, 2018, and later.</p> </li> <li> <p> <b>InvokedBefore</b>: Specify a timestamp to limit your results. For example, specify <code>2018-07-07T00:00:00Z</code> to see a list of command executions from before July 7, 2018.</p> </li> <li> <p> <b>Status</b>: Specify a valid command status to see a list of all command executions with that status. Status values you can specify include:</p> <ul> <li> <p> <code>Pending</code> </p> </li> <li> <p> <code>InProgress</code> </p> </li> <li> <p> <code>Success</code> </p> </li> <li> <p> <code>Cancelled</code> </p> </li> <li> <p> <code>Failed</code> </p> </li> <li> <p> <code>TimedOut</code> </p> </li> <li> <p> <code>Cancelling</code> </p> </li> </ul> </li> <li> <p> <b>DocumentName</b>: Specify name of the SSM document for which you want to see command execution results. For example, specify <code>AWS-RunPatchBaseline</code> to see command executions that used this SSM document to perform security patching operations on instances. </p> </li> <li> <p> <b>ExecutionStage</b>: Specify one of the following values:</p> <ul> <li> <p> <code>Executing</code>: Returns a list of command executions that are currently still running.</p> </li> <li> <p> <code>Complete</code>: Returns a list of command executions that have already completed. </p> </li> </ul> </li> </ul>"
}
},
"CommandId": {
"base": null,
"refs": {
"CancelCommandRequest$CommandId": "<p>The ID of the command you want to cancel.</p>",
"Command$CommandId": "<p>A unique identifier for this command.</p>",
"CommandInvocation$CommandId": "<p>The command against which this invocation was requested.</p>",
"GetCommandInvocationRequest$CommandId": "<p>(Required) The parent command ID of the invocation plugin.</p>",
"GetCommandInvocationResult$CommandId": "<p>The parent command ID of the invocation plugin.</p>",
"ListCommandInvocationsRequest$CommandId": "<p>(Optional) The invocations for a specific command ID.</p>",
"ListCommandsRequest$CommandId": "<p>(Optional) If provided, lists only the specified command.</p>"
}
},
"CommandInvocation": {
"base": "<p>An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user runs SendCommand against three instances, then a command invocation is created for each requested instance ID. A command invocation returns status and detail information about a command you ran. </p>",
"refs": {
"CommandInvocationList$member": null
}
},
"CommandInvocationList": {
"base": null,
"refs": {
"ListCommandInvocationsResult$CommandInvocations": "<p>(Optional) A list of all invocations. </p>"
}
},
"CommandInvocationStatus": {
"base": null,
"refs": {
"CommandInvocation$Status": "<p>Whether or not the invocation succeeded, failed, or is pending.</p>",
"GetCommandInvocationResult$Status": "<p>The status of this invocation plugin. This status can be different than StatusDetails.</p>"
}