aws-sdk-ssm 1.99.0 → 1.104.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-ssm.rb +1 -1
- data/lib/aws-sdk-ssm/client.rb +680 -45
- data/lib/aws-sdk-ssm/client_api.rb +266 -3
- data/lib/aws-sdk-ssm/errors.rb +16 -0
- data/lib/aws-sdk-ssm/types.rb +1241 -100
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: '0813c0b30e0c5a98b02822c0c7a9fc9816ad3a8e33df106b8fa7681eb1c42ee6'
|
4
|
+
data.tar.gz: dd81e09f4c6a719827a5abb6a36ecb0be98c7030581ea2f8e725d13764829531
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 101f8efbfa360d1e4a252a6bb98283dd73e7b4b5d40c98ed4ece161ea65d54bbdb214b919da7dc636ec4761575fe4713bc2c09a8ac00bfa738071f02c30a5d0a
|
7
|
+
data.tar.gz: 1b2d389c45a6f1a7c608cff7915b5da751eb1d6b04ff905baa514aaa8061e042ad9c2af123332015aefdaa19e1c74f9b50c4b8328bc57626435b9e37f3dd865c
|
data/lib/aws-sdk-ssm.rb
CHANGED
data/lib/aws-sdk-ssm/client.rb
CHANGED
@@ -734,6 +734,11 @@ module Aws::SSM
|
|
734
734
|
# run immediately after you create it. This parameter is not supported
|
735
735
|
# for rate expressions.
|
736
736
|
#
|
737
|
+
# @option params [Array<Types::TargetLocation>] :target_locations
|
738
|
+
# A location is a combination of AWS Regions and AWS accounts where you
|
739
|
+
# want to run the association. Use this action to create an association
|
740
|
+
# in multiple Regions and multiple accounts.
|
741
|
+
#
|
737
742
|
# @return [Types::CreateAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
738
743
|
#
|
739
744
|
# * {Types::CreateAssociationResult#association_description #association_description} => Types::AssociationDescription
|
@@ -768,6 +773,15 @@ module Aws::SSM
|
|
768
773
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
769
774
|
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
770
775
|
# apply_only_at_cron_interval: false,
|
776
|
+
# target_locations: [
|
777
|
+
# {
|
778
|
+
# accounts: ["Account"],
|
779
|
+
# regions: ["Region"],
|
780
|
+
# target_location_max_concurrency: "MaxConcurrency",
|
781
|
+
# target_location_max_errors: "MaxErrors",
|
782
|
+
# execution_role_name: "ExecutionRoleName",
|
783
|
+
# },
|
784
|
+
# ],
|
771
785
|
# })
|
772
786
|
#
|
773
787
|
# @example Response structure
|
@@ -807,6 +821,14 @@ module Aws::SSM
|
|
807
821
|
# resp.association_description.compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
808
822
|
# resp.association_description.sync_compliance #=> String, one of "AUTO", "MANUAL"
|
809
823
|
# resp.association_description.apply_only_at_cron_interval #=> Boolean
|
824
|
+
# resp.association_description.target_locations #=> Array
|
825
|
+
# resp.association_description.target_locations[0].accounts #=> Array
|
826
|
+
# resp.association_description.target_locations[0].accounts[0] #=> String
|
827
|
+
# resp.association_description.target_locations[0].regions #=> Array
|
828
|
+
# resp.association_description.target_locations[0].regions[0] #=> String
|
829
|
+
# resp.association_description.target_locations[0].target_location_max_concurrency #=> String
|
830
|
+
# resp.association_description.target_locations[0].target_location_max_errors #=> String
|
831
|
+
# resp.association_description.target_locations[0].execution_role_name #=> String
|
810
832
|
#
|
811
833
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateAssociation AWS API Documentation
|
812
834
|
#
|
@@ -868,6 +890,15 @@ module Aws::SSM
|
|
868
890
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
869
891
|
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
870
892
|
# apply_only_at_cron_interval: false,
|
893
|
+
# target_locations: [
|
894
|
+
# {
|
895
|
+
# accounts: ["Account"],
|
896
|
+
# regions: ["Region"],
|
897
|
+
# target_location_max_concurrency: "MaxConcurrency",
|
898
|
+
# target_location_max_errors: "MaxErrors",
|
899
|
+
# execution_role_name: "ExecutionRoleName",
|
900
|
+
# },
|
901
|
+
# ],
|
871
902
|
# },
|
872
903
|
# ],
|
873
904
|
# })
|
@@ -910,6 +941,14 @@ module Aws::SSM
|
|
910
941
|
# resp.successful[0].compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
911
942
|
# resp.successful[0].sync_compliance #=> String, one of "AUTO", "MANUAL"
|
912
943
|
# resp.successful[0].apply_only_at_cron_interval #=> Boolean
|
944
|
+
# resp.successful[0].target_locations #=> Array
|
945
|
+
# resp.successful[0].target_locations[0].accounts #=> Array
|
946
|
+
# resp.successful[0].target_locations[0].accounts[0] #=> String
|
947
|
+
# resp.successful[0].target_locations[0].regions #=> Array
|
948
|
+
# resp.successful[0].target_locations[0].regions[0] #=> String
|
949
|
+
# resp.successful[0].target_locations[0].target_location_max_concurrency #=> String
|
950
|
+
# resp.successful[0].target_locations[0].target_location_max_errors #=> String
|
951
|
+
# resp.successful[0].target_locations[0].execution_role_name #=> String
|
913
952
|
# resp.failed #=> Array
|
914
953
|
# resp.failed[0].entry.name #=> String
|
915
954
|
# resp.failed[0].entry.instance_id #=> String
|
@@ -932,6 +971,14 @@ module Aws::SSM
|
|
932
971
|
# resp.failed[0].entry.compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
933
972
|
# resp.failed[0].entry.sync_compliance #=> String, one of "AUTO", "MANUAL"
|
934
973
|
# resp.failed[0].entry.apply_only_at_cron_interval #=> Boolean
|
974
|
+
# resp.failed[0].entry.target_locations #=> Array
|
975
|
+
# resp.failed[0].entry.target_locations[0].accounts #=> Array
|
976
|
+
# resp.failed[0].entry.target_locations[0].accounts[0] #=> String
|
977
|
+
# resp.failed[0].entry.target_locations[0].regions #=> Array
|
978
|
+
# resp.failed[0].entry.target_locations[0].regions[0] #=> String
|
979
|
+
# resp.failed[0].entry.target_locations[0].target_location_max_concurrency #=> String
|
980
|
+
# resp.failed[0].entry.target_locations[0].target_location_max_errors #=> String
|
981
|
+
# resp.failed[0].entry.target_locations[0].execution_role_name #=> String
|
935
982
|
# resp.failed[0].message #=> String
|
936
983
|
# resp.failed[0].fault #=> String, one of "Client", "Server", "Unknown"
|
937
984
|
#
|
@@ -1068,7 +1115,7 @@ module Aws::SSM
|
|
1068
1115
|
# ],
|
1069
1116
|
# name: "DocumentName", # required
|
1070
1117
|
# version_name: "DocumentVersionName",
|
1071
|
-
# document_type: "Command", # accepts Command, Policy, Automation, Session, Package, ApplicationConfiguration, ApplicationConfigurationSchema, DeploymentStrategy, ChangeCalendar
|
1118
|
+
# document_type: "Command", # accepts Command, Policy, Automation, Session, Package, ApplicationConfiguration, ApplicationConfigurationSchema, DeploymentStrategy, ChangeCalendar, Automation.ChangeTemplate
|
1072
1119
|
# document_format: "YAML", # accepts YAML, JSON, TEXT
|
1073
1120
|
# target_type: "TargetType",
|
1074
1121
|
# tags: [
|
@@ -1099,7 +1146,7 @@ module Aws::SSM
|
|
1099
1146
|
# resp.document_description.parameters[0].default_value #=> String
|
1100
1147
|
# resp.document_description.platform_types #=> Array
|
1101
1148
|
# resp.document_description.platform_types[0] #=> String, one of "Windows", "Linux"
|
1102
|
-
# resp.document_description.document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar"
|
1149
|
+
# resp.document_description.document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar", "Automation.ChangeTemplate"
|
1103
1150
|
# resp.document_description.schema_version #=> String
|
1104
1151
|
# resp.document_description.latest_version #=> String
|
1105
1152
|
# resp.document_description.default_version #=> String
|
@@ -1113,6 +1160,14 @@ module Aws::SSM
|
|
1113
1160
|
# resp.document_description.requires #=> Array
|
1114
1161
|
# resp.document_description.requires[0].name #=> String
|
1115
1162
|
# resp.document_description.requires[0].version #=> String
|
1163
|
+
# resp.document_description.author #=> String
|
1164
|
+
# resp.document_description.review_information #=> Array
|
1165
|
+
# resp.document_description.review_information[0].reviewed_time #=> Time
|
1166
|
+
# resp.document_description.review_information[0].status #=> String, one of "APPROVED", "NOT_REVIEWED", "PENDING", "REJECTED"
|
1167
|
+
# resp.document_description.review_information[0].reviewer #=> String
|
1168
|
+
# resp.document_description.approved_version #=> String
|
1169
|
+
# resp.document_description.pending_review_version #=> String
|
1170
|
+
# resp.document_description.review_status #=> String, one of "APPROVED", "NOT_REVIEWED", "PENDING", "REJECTED"
|
1116
1171
|
#
|
1117
1172
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateDocument AWS API Documentation
|
1118
1173
|
#
|
@@ -1161,7 +1216,7 @@ module Aws::SSM
|
|
1161
1216
|
# @option params [String] :schedule_timezone
|
1162
1217
|
# The time zone that the scheduled maintenance window executions are
|
1163
1218
|
# based on, in Internet Assigned Numbers Authority (IANA) format. For
|
1164
|
-
# example: "America/Los\_Angeles", "
|
1219
|
+
# example: "America/Los\_Angeles", "UTC", or "Asia/Seoul". For
|
1165
1220
|
# more information, see the [Time Zone Database][1] on the IANA website.
|
1166
1221
|
#
|
1167
1222
|
#
|
@@ -1175,7 +1230,7 @@ module Aws::SSM
|
|
1175
1230
|
# For example, the following cron expression schedules a maintenance
|
1176
1231
|
# window to run on the third Tuesday of every month at 11:30 PM.
|
1177
1232
|
#
|
1178
|
-
# `cron(
|
1233
|
+
# `cron(30 23 ? * TUE#3 *)`
|
1179
1234
|
#
|
1180
1235
|
# If the schedule offset is `2`, the maintenance window won't run until
|
1181
1236
|
# two days later.
|
@@ -1280,6 +1335,10 @@ module Aws::SSM
|
|
1280
1335
|
# @option params [required, String] :description
|
1281
1336
|
# Information about the OpsItem.
|
1282
1337
|
#
|
1338
|
+
# @option params [String] :ops_item_type
|
1339
|
+
# The type of OpsItem to create. Currently, the only valid values are
|
1340
|
+
# `/aws/changerequest` and `/aws/issue`.
|
1341
|
+
#
|
1283
1342
|
# @option params [Hash<String,Types::OpsItemDataValue>] :operational_data
|
1284
1343
|
# Operational data is custom data that provides useful reference details
|
1285
1344
|
# about the OpsItem. For example, you can specify log files, error
|
@@ -1358,6 +1417,23 @@ module Aws::SSM
|
|
1358
1417
|
# @option params [String] :severity
|
1359
1418
|
# Specify a severity to assign to an OpsItem.
|
1360
1419
|
#
|
1420
|
+
# @option params [Time,DateTime,Date,Integer,String] :actual_start_time
|
1421
|
+
# The time a runbook workflow started. Currently reported only for the
|
1422
|
+
# OpsItem type `/aws/changerequest`.
|
1423
|
+
#
|
1424
|
+
# @option params [Time,DateTime,Date,Integer,String] :actual_end_time
|
1425
|
+
# The time a runbook workflow ended. Currently reported only for the
|
1426
|
+
# OpsItem type `/aws/changerequest`.
|
1427
|
+
#
|
1428
|
+
# @option params [Time,DateTime,Date,Integer,String] :planned_start_time
|
1429
|
+
# The time specified in a change request for a runbook workflow to
|
1430
|
+
# start. Currently supported only for the OpsItem type
|
1431
|
+
# `/aws/changerequest`.
|
1432
|
+
#
|
1433
|
+
# @option params [Time,DateTime,Date,Integer,String] :planned_end_time
|
1434
|
+
# The time specified in a change request for a runbook workflow to end.
|
1435
|
+
# Currently supported only for the OpsItem type `/aws/changerequest`.
|
1436
|
+
#
|
1361
1437
|
# @return [Types::CreateOpsItemResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1362
1438
|
#
|
1363
1439
|
# * {Types::CreateOpsItemResponse#ops_item_id #ops_item_id} => String
|
@@ -1366,6 +1442,7 @@ module Aws::SSM
|
|
1366
1442
|
#
|
1367
1443
|
# resp = client.create_ops_item({
|
1368
1444
|
# description: "OpsItemDescription", # required
|
1445
|
+
# ops_item_type: "OpsItemType",
|
1369
1446
|
# operational_data: {
|
1370
1447
|
# "OpsItemDataKey" => {
|
1371
1448
|
# value: "OpsItemDataValueString",
|
@@ -1393,6 +1470,10 @@ module Aws::SSM
|
|
1393
1470
|
# ],
|
1394
1471
|
# category: "OpsItemCategory",
|
1395
1472
|
# severity: "OpsItemSeverity",
|
1473
|
+
# actual_start_time: Time.now,
|
1474
|
+
# actual_end_time: Time.now,
|
1475
|
+
# planned_start_time: Time.now,
|
1476
|
+
# planned_end_time: Time.now,
|
1396
1477
|
# })
|
1397
1478
|
#
|
1398
1479
|
# @example Response structure
|
@@ -1408,15 +1489,15 @@ module Aws::SSM
|
|
1408
1489
|
req.send_request(options)
|
1409
1490
|
end
|
1410
1491
|
|
1411
|
-
# If you create a new application in
|
1412
|
-
# this API action to specify information about the new
|
1413
|
-
# including the application type.
|
1492
|
+
# If you create a new application in Application Manager, Systems
|
1493
|
+
# Manager calls this API action to specify information about the new
|
1494
|
+
# application, including the application type.
|
1414
1495
|
#
|
1415
1496
|
# @option params [required, String] :resource_id
|
1416
|
-
# A resource ID for a new
|
1497
|
+
# A resource ID for a new Application Manager application.
|
1417
1498
|
#
|
1418
1499
|
# @option params [Hash<String,Types::MetadataValue>] :metadata
|
1419
|
-
# Metadata for a new
|
1500
|
+
# Metadata for a new Application Manager application.
|
1420
1501
|
#
|
1421
1502
|
# @return [Types::CreateOpsMetadataResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1422
1503
|
#
|
@@ -2327,6 +2408,14 @@ module Aws::SSM
|
|
2327
2408
|
# resp.association_description.compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
2328
2409
|
# resp.association_description.sync_compliance #=> String, one of "AUTO", "MANUAL"
|
2329
2410
|
# resp.association_description.apply_only_at_cron_interval #=> Boolean
|
2411
|
+
# resp.association_description.target_locations #=> Array
|
2412
|
+
# resp.association_description.target_locations[0].accounts #=> Array
|
2413
|
+
# resp.association_description.target_locations[0].accounts[0] #=> String
|
2414
|
+
# resp.association_description.target_locations[0].regions #=> Array
|
2415
|
+
# resp.association_description.target_locations[0].regions[0] #=> String
|
2416
|
+
# resp.association_description.target_locations[0].target_location_max_concurrency #=> String
|
2417
|
+
# resp.association_description.target_locations[0].target_location_max_errors #=> String
|
2418
|
+
# resp.association_description.target_locations[0].execution_role_name #=> String
|
2330
2419
|
#
|
2331
2420
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeAssociation AWS API Documentation
|
2332
2421
|
#
|
@@ -2509,7 +2598,7 @@ module Aws::SSM
|
|
2509
2598
|
# resp = client.describe_automation_executions({
|
2510
2599
|
# filters: [
|
2511
2600
|
# {
|
2512
|
-
# key: "DocumentNamePrefix", # required, accepts DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter, AutomationType, TagKey, TargetResourceGroup
|
2601
|
+
# key: "DocumentNamePrefix", # required, accepts DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter, AutomationType, TagKey, TargetResourceGroup, AutomationSubtype, OpsItemId
|
2513
2602
|
# values: ["AutomationExecutionFilterValue"], # required
|
2514
2603
|
# },
|
2515
2604
|
# ],
|
@@ -2523,7 +2612,7 @@ module Aws::SSM
|
|
2523
2612
|
# resp.automation_execution_metadata_list[0].automation_execution_id #=> String
|
2524
2613
|
# resp.automation_execution_metadata_list[0].document_name #=> String
|
2525
2614
|
# resp.automation_execution_metadata_list[0].document_version #=> String
|
2526
|
-
# resp.automation_execution_metadata_list[0].automation_execution_status #=> String, one of "Pending", "InProgress", "Waiting", "Success", "TimedOut", "Cancelling", "Cancelled", "Failed"
|
2615
|
+
# resp.automation_execution_metadata_list[0].automation_execution_status #=> String, one of "Pending", "InProgress", "Waiting", "Success", "TimedOut", "Cancelling", "Cancelled", "Failed", "PendingApproval", "Approved", "Rejected", "Scheduled", "RunbookInProgress", "PendingChangeCalendarOverride", "ChangeCalendarOverrideApproved", "ChangeCalendarOverrideRejected", "CompletedWithSuccess", "CompletedWithFailure"
|
2527
2616
|
# resp.automation_execution_metadata_list[0].execution_start_time #=> Time
|
2528
2617
|
# resp.automation_execution_metadata_list[0].execution_end_time #=> Time
|
2529
2618
|
# resp.automation_execution_metadata_list[0].executed_by #=> String
|
@@ -2552,6 +2641,32 @@ module Aws::SSM
|
|
2552
2641
|
# resp.automation_execution_metadata_list[0].max_errors #=> String
|
2553
2642
|
# resp.automation_execution_metadata_list[0].target #=> String
|
2554
2643
|
# resp.automation_execution_metadata_list[0].automation_type #=> String, one of "CrossAccount", "Local"
|
2644
|
+
# resp.automation_execution_metadata_list[0].automation_subtype #=> String, one of "ChangeRequest"
|
2645
|
+
# resp.automation_execution_metadata_list[0].scheduled_time #=> Time
|
2646
|
+
# resp.automation_execution_metadata_list[0].runbooks #=> Array
|
2647
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].document_name #=> String
|
2648
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].document_version #=> String
|
2649
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].parameters #=> Hash
|
2650
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].parameters["AutomationParameterKey"] #=> Array
|
2651
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].parameters["AutomationParameterKey"][0] #=> String
|
2652
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].target_parameter_name #=> String
|
2653
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].targets #=> Array
|
2654
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].targets[0].key #=> String
|
2655
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].targets[0].values #=> Array
|
2656
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].targets[0].values[0] #=> String
|
2657
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].max_concurrency #=> String
|
2658
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].max_errors #=> String
|
2659
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].target_locations #=> Array
|
2660
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].target_locations[0].accounts #=> Array
|
2661
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].target_locations[0].accounts[0] #=> String
|
2662
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].target_locations[0].regions #=> Array
|
2663
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].target_locations[0].regions[0] #=> String
|
2664
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].target_locations[0].target_location_max_concurrency #=> String
|
2665
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].target_locations[0].target_location_max_errors #=> String
|
2666
|
+
# resp.automation_execution_metadata_list[0].runbooks[0].target_locations[0].execution_role_name #=> String
|
2667
|
+
# resp.automation_execution_metadata_list[0].ops_item_id #=> String
|
2668
|
+
# resp.automation_execution_metadata_list[0].association_id #=> String
|
2669
|
+
# resp.automation_execution_metadata_list[0].change_request_name #=> String
|
2555
2670
|
# resp.next_token #=> String
|
2556
2671
|
#
|
2557
2672
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeAutomationExecutions AWS API Documentation
|
@@ -2619,7 +2734,7 @@ module Aws::SSM
|
|
2619
2734
|
# resp.step_executions[0].max_attempts #=> Integer
|
2620
2735
|
# resp.step_executions[0].execution_start_time #=> Time
|
2621
2736
|
# resp.step_executions[0].execution_end_time #=> Time
|
2622
|
-
# resp.step_executions[0].step_status #=> String, one of "Pending", "InProgress", "Waiting", "Success", "TimedOut", "Cancelling", "Cancelled", "Failed"
|
2737
|
+
# resp.step_executions[0].step_status #=> String, one of "Pending", "InProgress", "Waiting", "Success", "TimedOut", "Cancelling", "Cancelled", "Failed", "PendingApproval", "Approved", "Rejected", "Scheduled", "RunbookInProgress", "PendingChangeCalendarOverride", "ChangeCalendarOverrideApproved", "ChangeCalendarOverrideRejected", "CompletedWithSuccess", "CompletedWithFailure"
|
2623
2738
|
# resp.step_executions[0].response_code #=> String
|
2624
2739
|
# resp.step_executions[0].inputs #=> Hash
|
2625
2740
|
# resp.step_executions[0].inputs["String"] #=> String
|
@@ -2782,7 +2897,7 @@ module Aws::SSM
|
|
2782
2897
|
# resp.document.parameters[0].default_value #=> String
|
2783
2898
|
# resp.document.platform_types #=> Array
|
2784
2899
|
# resp.document.platform_types[0] #=> String, one of "Windows", "Linux"
|
2785
|
-
# resp.document.document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar"
|
2900
|
+
# resp.document.document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar", "Automation.ChangeTemplate"
|
2786
2901
|
# resp.document.schema_version #=> String
|
2787
2902
|
# resp.document.latest_version #=> String
|
2788
2903
|
# resp.document.default_version #=> String
|
@@ -2796,6 +2911,14 @@ module Aws::SSM
|
|
2796
2911
|
# resp.document.requires #=> Array
|
2797
2912
|
# resp.document.requires[0].name #=> String
|
2798
2913
|
# resp.document.requires[0].version #=> String
|
2914
|
+
# resp.document.author #=> String
|
2915
|
+
# resp.document.review_information #=> Array
|
2916
|
+
# resp.document.review_information[0].reviewed_time #=> Time
|
2917
|
+
# resp.document.review_information[0].status #=> String, one of "APPROVED", "NOT_REVIEWED", "PENDING", "REJECTED"
|
2918
|
+
# resp.document.review_information[0].reviewer #=> String
|
2919
|
+
# resp.document.approved_version #=> String
|
2920
|
+
# resp.document.pending_review_version #=> String
|
2921
|
+
# resp.document.review_status #=> String, one of "APPROVED", "NOT_REVIEWED", "PENDING", "REJECTED"
|
2799
2922
|
#
|
2800
2923
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeDocument AWS API Documentation
|
2801
2924
|
#
|
@@ -2818,16 +2941,28 @@ module Aws::SSM
|
|
2818
2941
|
# The permission type for the document. The permission type can be
|
2819
2942
|
# *Share*.
|
2820
2943
|
#
|
2944
|
+
# @option params [Integer] :max_results
|
2945
|
+
# The maximum number of items to return for this call. The call also
|
2946
|
+
# returns a token that you can specify in a subsequent call to get the
|
2947
|
+
# next set of results.
|
2948
|
+
#
|
2949
|
+
# @option params [String] :next_token
|
2950
|
+
# The token for the next set of items to return. (You received this
|
2951
|
+
# token from a previous call.)
|
2952
|
+
#
|
2821
2953
|
# @return [Types::DescribeDocumentPermissionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2822
2954
|
#
|
2823
2955
|
# * {Types::DescribeDocumentPermissionResponse#account_ids #account_ids} => Array<String>
|
2824
2956
|
# * {Types::DescribeDocumentPermissionResponse#account_sharing_info_list #account_sharing_info_list} => Array<Types::AccountSharingInfo>
|
2957
|
+
# * {Types::DescribeDocumentPermissionResponse#next_token #next_token} => String
|
2825
2958
|
#
|
2826
2959
|
# @example Request syntax with placeholder values
|
2827
2960
|
#
|
2828
2961
|
# resp = client.describe_document_permission({
|
2829
2962
|
# name: "DocumentName", # required
|
2830
2963
|
# permission_type: "Share", # required, accepts Share
|
2964
|
+
# max_results: 1,
|
2965
|
+
# next_token: "NextToken",
|
2831
2966
|
# })
|
2832
2967
|
#
|
2833
2968
|
# @example Response structure
|
@@ -2837,6 +2972,7 @@ module Aws::SSM
|
|
2837
2972
|
# resp.account_sharing_info_list #=> Array
|
2838
2973
|
# resp.account_sharing_info_list[0].account_id #=> String
|
2839
2974
|
# resp.account_sharing_info_list[0].shared_document_version #=> String
|
2975
|
+
# resp.next_token #=> String
|
2840
2976
|
#
|
2841
2977
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeDocumentPermission AWS API Documentation
|
2842
2978
|
#
|
@@ -3722,6 +3858,14 @@ module Aws::SSM
|
|
3722
3858
|
|
3723
3859
|
# Lists the tasks in a maintenance window.
|
3724
3860
|
#
|
3861
|
+
# <note markdown="1"> For maintenance window tasks without a specified target, you cannot
|
3862
|
+
# supply values for `--max-errors` and `--max-concurrency`. Instead, the
|
3863
|
+
# system inserts a placeholder value of `1`, which may be reported in
|
3864
|
+
# the response to this command. These values do not affect the running
|
3865
|
+
# of your task and can be ignored.
|
3866
|
+
#
|
3867
|
+
# </note>
|
3868
|
+
#
|
3725
3869
|
# @option params [required, String] :window_id
|
3726
3870
|
# The ID of the maintenance window whose tasks should be retrieved.
|
3727
3871
|
#
|
@@ -4008,7 +4152,7 @@ module Aws::SSM
|
|
4008
4152
|
# resp = client.describe_ops_items({
|
4009
4153
|
# ops_item_filters: [
|
4010
4154
|
# {
|
4011
|
-
# key: "Status", # required, accepts Status, CreatedBy, Source, Priority, Title, OpsItemId, CreatedTime, LastModifiedTime, OperationalData, OperationalDataKey, OperationalDataValue, ResourceId, AutomationId, Category, Severity
|
4155
|
+
# key: "Status", # required, accepts Status, CreatedBy, Source, Priority, Title, OpsItemId, CreatedTime, LastModifiedTime, ActualStartTime, ActualEndTime, PlannedStartTime, PlannedEndTime, OperationalData, OperationalDataKey, OperationalDataValue, ResourceId, AutomationId, Category, Severity, OpsItemType, ChangeRequestByRequesterArn, ChangeRequestByRequesterName, ChangeRequestByApproverArn, ChangeRequestByApproverName, ChangeRequestByTemplate, ChangeRequestByTargetsResourceGroup
|
4012
4156
|
# values: ["OpsItemFilterValue"], # required
|
4013
4157
|
# operator: "Equal", # required, accepts Equal, Contains, GreaterThan, LessThan
|
4014
4158
|
# },
|
@@ -4027,7 +4171,7 @@ module Aws::SSM
|
|
4027
4171
|
# resp.ops_item_summaries[0].last_modified_time #=> Time
|
4028
4172
|
# resp.ops_item_summaries[0].priority #=> Integer
|
4029
4173
|
# resp.ops_item_summaries[0].source #=> String
|
4030
|
-
# resp.ops_item_summaries[0].status #=> String, one of "Open", "InProgress", "Resolved"
|
4174
|
+
# resp.ops_item_summaries[0].status #=> String, one of "Open", "InProgress", "Resolved", "Pending", "TimedOut", "Cancelling", "Cancelled", "Failed", "CompletedWithSuccess", "CompletedWithFailure", "Scheduled", "RunbookInProgress", "PendingChangeCalendarOverride", "ChangeCalendarOverrideApproved", "ChangeCalendarOverrideRejected", "PendingApproval", "Approved", "Rejected"
|
4031
4175
|
# resp.ops_item_summaries[0].ops_item_id #=> String
|
4032
4176
|
# resp.ops_item_summaries[0].title #=> String
|
4033
4177
|
# resp.ops_item_summaries[0].operational_data #=> Hash
|
@@ -4035,6 +4179,11 @@ module Aws::SSM
|
|
4035
4179
|
# resp.ops_item_summaries[0].operational_data["OpsItemDataKey"].type #=> String, one of "SearchableString", "String"
|
4036
4180
|
# resp.ops_item_summaries[0].category #=> String
|
4037
4181
|
# resp.ops_item_summaries[0].severity #=> String
|
4182
|
+
# resp.ops_item_summaries[0].ops_item_type #=> String
|
4183
|
+
# resp.ops_item_summaries[0].actual_start_time #=> Time
|
4184
|
+
# resp.ops_item_summaries[0].actual_end_time #=> Time
|
4185
|
+
# resp.ops_item_summaries[0].planned_start_time #=> Time
|
4186
|
+
# resp.ops_item_summaries[0].planned_end_time #=> Time
|
4038
4187
|
#
|
4039
4188
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeOpsItems AWS API Documentation
|
4040
4189
|
#
|
@@ -4491,7 +4640,7 @@ module Aws::SSM
|
|
4491
4640
|
# resp.automation_execution.document_version #=> String
|
4492
4641
|
# resp.automation_execution.execution_start_time #=> Time
|
4493
4642
|
# resp.automation_execution.execution_end_time #=> Time
|
4494
|
-
# resp.automation_execution.automation_execution_status #=> String, one of "Pending", "InProgress", "Waiting", "Success", "TimedOut", "Cancelling", "Cancelled", "Failed"
|
4643
|
+
# resp.automation_execution.automation_execution_status #=> String, one of "Pending", "InProgress", "Waiting", "Success", "TimedOut", "Cancelling", "Cancelled", "Failed", "PendingApproval", "Approved", "Rejected", "Scheduled", "RunbookInProgress", "PendingChangeCalendarOverride", "ChangeCalendarOverrideApproved", "ChangeCalendarOverrideRejected", "CompletedWithSuccess", "CompletedWithFailure"
|
4495
4644
|
# resp.automation_execution.step_executions #=> Array
|
4496
4645
|
# resp.automation_execution.step_executions[0].step_name #=> String
|
4497
4646
|
# resp.automation_execution.step_executions[0].action #=> String
|
@@ -4500,7 +4649,7 @@ module Aws::SSM
|
|
4500
4649
|
# resp.automation_execution.step_executions[0].max_attempts #=> Integer
|
4501
4650
|
# resp.automation_execution.step_executions[0].execution_start_time #=> Time
|
4502
4651
|
# resp.automation_execution.step_executions[0].execution_end_time #=> Time
|
4503
|
-
# resp.automation_execution.step_executions[0].step_status #=> String, one of "Pending", "InProgress", "Waiting", "Success", "TimedOut", "Cancelling", "Cancelled", "Failed"
|
4652
|
+
# resp.automation_execution.step_executions[0].step_status #=> String, one of "Pending", "InProgress", "Waiting", "Success", "TimedOut", "Cancelling", "Cancelled", "Failed", "PendingApproval", "Approved", "Rejected", "Scheduled", "RunbookInProgress", "PendingChangeCalendarOverride", "ChangeCalendarOverrideApproved", "ChangeCalendarOverrideRejected", "CompletedWithSuccess", "CompletedWithFailure"
|
4504
4653
|
# resp.automation_execution.step_executions[0].response_code #=> String
|
4505
4654
|
# resp.automation_execution.step_executions[0].inputs #=> Hash
|
4506
4655
|
# resp.automation_execution.step_executions[0].inputs["String"] #=> String
|
@@ -4575,6 +4724,32 @@ module Aws::SSM
|
|
4575
4724
|
# resp.automation_execution.progress_counters.failed_steps #=> Integer
|
4576
4725
|
# resp.automation_execution.progress_counters.cancelled_steps #=> Integer
|
4577
4726
|
# resp.automation_execution.progress_counters.timed_out_steps #=> Integer
|
4727
|
+
# resp.automation_execution.automation_subtype #=> String, one of "ChangeRequest"
|
4728
|
+
# resp.automation_execution.scheduled_time #=> Time
|
4729
|
+
# resp.automation_execution.runbooks #=> Array
|
4730
|
+
# resp.automation_execution.runbooks[0].document_name #=> String
|
4731
|
+
# resp.automation_execution.runbooks[0].document_version #=> String
|
4732
|
+
# resp.automation_execution.runbooks[0].parameters #=> Hash
|
4733
|
+
# resp.automation_execution.runbooks[0].parameters["AutomationParameterKey"] #=> Array
|
4734
|
+
# resp.automation_execution.runbooks[0].parameters["AutomationParameterKey"][0] #=> String
|
4735
|
+
# resp.automation_execution.runbooks[0].target_parameter_name #=> String
|
4736
|
+
# resp.automation_execution.runbooks[0].targets #=> Array
|
4737
|
+
# resp.automation_execution.runbooks[0].targets[0].key #=> String
|
4738
|
+
# resp.automation_execution.runbooks[0].targets[0].values #=> Array
|
4739
|
+
# resp.automation_execution.runbooks[0].targets[0].values[0] #=> String
|
4740
|
+
# resp.automation_execution.runbooks[0].max_concurrency #=> String
|
4741
|
+
# resp.automation_execution.runbooks[0].max_errors #=> String
|
4742
|
+
# resp.automation_execution.runbooks[0].target_locations #=> Array
|
4743
|
+
# resp.automation_execution.runbooks[0].target_locations[0].accounts #=> Array
|
4744
|
+
# resp.automation_execution.runbooks[0].target_locations[0].accounts[0] #=> String
|
4745
|
+
# resp.automation_execution.runbooks[0].target_locations[0].regions #=> Array
|
4746
|
+
# resp.automation_execution.runbooks[0].target_locations[0].regions[0] #=> String
|
4747
|
+
# resp.automation_execution.runbooks[0].target_locations[0].target_location_max_concurrency #=> String
|
4748
|
+
# resp.automation_execution.runbooks[0].target_locations[0].target_location_max_errors #=> String
|
4749
|
+
# resp.automation_execution.runbooks[0].target_locations[0].execution_role_name #=> String
|
4750
|
+
# resp.automation_execution.ops_item_id #=> String
|
4751
|
+
# resp.automation_execution.association_id #=> String
|
4752
|
+
# resp.automation_execution.change_request_name #=> String
|
4578
4753
|
#
|
4579
4754
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetAutomationExecution AWS API Documentation
|
4580
4755
|
#
|
@@ -4866,6 +5041,7 @@ module Aws::SSM
|
|
4866
5041
|
# * {Types::GetDocumentResult#document_format #document_format} => String
|
4867
5042
|
# * {Types::GetDocumentResult#requires #requires} => Array<Types::DocumentRequires>
|
4868
5043
|
# * {Types::GetDocumentResult#attachments_content #attachments_content} => Array<Types::AttachmentContent>
|
5044
|
+
# * {Types::GetDocumentResult#review_status #review_status} => String
|
4869
5045
|
#
|
4870
5046
|
# @example Request syntax with placeholder values
|
4871
5047
|
#
|
@@ -4884,7 +5060,7 @@ module Aws::SSM
|
|
4884
5060
|
# resp.status #=> String, one of "Creating", "Active", "Updating", "Deleting", "Failed"
|
4885
5061
|
# resp.status_information #=> String
|
4886
5062
|
# resp.content #=> String
|
4887
|
-
# resp.document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar"
|
5063
|
+
# resp.document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar", "Automation.ChangeTemplate"
|
4888
5064
|
# resp.document_format #=> String, one of "YAML", "JSON", "TEXT"
|
4889
5065
|
# resp.requires #=> Array
|
4890
5066
|
# resp.requires[0].name #=> String
|
@@ -4895,6 +5071,7 @@ module Aws::SSM
|
|
4895
5071
|
# resp.attachments_content[0].hash #=> String
|
4896
5072
|
# resp.attachments_content[0].hash_type #=> String, one of "Sha256"
|
4897
5073
|
# resp.attachments_content[0].url #=> String
|
5074
|
+
# resp.review_status #=> String, one of "APPROVED", "NOT_REVIEWED", "PENDING", "REJECTED"
|
4898
5075
|
#
|
4899
5076
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetDocument AWS API Documentation
|
4900
5077
|
#
|
@@ -5279,6 +5456,14 @@ module Aws::SSM
|
|
5279
5456
|
|
5280
5457
|
# Lists the tasks in a maintenance window.
|
5281
5458
|
#
|
5459
|
+
# <note markdown="1"> For maintenance window tasks without a specified target, you cannot
|
5460
|
+
# supply values for `--max-errors` and `--max-concurrency`. Instead, the
|
5461
|
+
# system inserts a placeholder value of `1`, which may be reported in
|
5462
|
+
# the response to this command. These values do not affect the running
|
5463
|
+
# of your task and can be ignored.
|
5464
|
+
#
|
5465
|
+
# </note>
|
5466
|
+
#
|
5282
5467
|
# @option params [required, String] :window_id
|
5283
5468
|
# The maintenance window ID that includes the task to retrieve.
|
5284
5469
|
#
|
@@ -5399,6 +5584,7 @@ module Aws::SSM
|
|
5399
5584
|
# @example Response structure
|
5400
5585
|
#
|
5401
5586
|
# resp.ops_item.created_by #=> String
|
5587
|
+
# resp.ops_item.ops_item_type #=> String
|
5402
5588
|
# resp.ops_item.created_time #=> Time
|
5403
5589
|
# resp.ops_item.description #=> String
|
5404
5590
|
# resp.ops_item.last_modified_by #=> String
|
@@ -5408,7 +5594,7 @@ module Aws::SSM
|
|
5408
5594
|
# resp.ops_item.priority #=> Integer
|
5409
5595
|
# resp.ops_item.related_ops_items #=> Array
|
5410
5596
|
# resp.ops_item.related_ops_items[0].ops_item_id #=> String
|
5411
|
-
# resp.ops_item.status #=> String, one of "Open", "InProgress", "Resolved"
|
5597
|
+
# resp.ops_item.status #=> String, one of "Open", "InProgress", "Resolved", "Pending", "TimedOut", "Cancelling", "Cancelled", "Failed", "CompletedWithSuccess", "CompletedWithFailure", "Scheduled", "RunbookInProgress", "PendingChangeCalendarOverride", "ChangeCalendarOverrideApproved", "ChangeCalendarOverrideRejected", "PendingApproval", "Approved", "Rejected"
|
5412
5598
|
# resp.ops_item.ops_item_id #=> String
|
5413
5599
|
# resp.ops_item.version #=> String
|
5414
5600
|
# resp.ops_item.title #=> String
|
@@ -5418,6 +5604,10 @@ module Aws::SSM
|
|
5418
5604
|
# resp.ops_item.operational_data["OpsItemDataKey"].type #=> String, one of "SearchableString", "String"
|
5419
5605
|
# resp.ops_item.category #=> String
|
5420
5606
|
# resp.ops_item.severity #=> String
|
5607
|
+
# resp.ops_item.actual_start_time #=> Time
|
5608
|
+
# resp.ops_item.actual_end_time #=> Time
|
5609
|
+
# resp.ops_item.planned_start_time #=> Time
|
5610
|
+
# resp.ops_item.planned_end_time #=> Time
|
5421
5611
|
#
|
5422
5612
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetOpsItem AWS API Documentation
|
5423
5613
|
#
|
@@ -5428,7 +5618,8 @@ module Aws::SSM
|
|
5428
5618
|
req.send_request(options)
|
5429
5619
|
end
|
5430
5620
|
|
5431
|
-
# View operational metadata related to an application in
|
5621
|
+
# View operational metadata related to an application in Application
|
5622
|
+
# Manager.
|
5432
5623
|
#
|
5433
5624
|
# @option params [required, String] :ops_metadata_arn
|
5434
5625
|
# The Amazon Resource Name (ARN) of an OpsMetadata Object to view.
|
@@ -5733,9 +5924,11 @@ module Aws::SSM
|
|
5733
5924
|
#
|
5734
5925
|
# @option params [required, String] :path
|
5735
5926
|
# The hierarchy for the parameter. Hierarchies start with a forward
|
5736
|
-
# slash (/)
|
5737
|
-
#
|
5738
|
-
#
|
5927
|
+
# slash (/). The hierachy is the parameter name except the last part of
|
5928
|
+
# the parameter. For the API call to succeeed, the last part of the
|
5929
|
+
# parameter name cannot be in the path. A parameter name hierarchy can
|
5930
|
+
# have a maximum of 15 levels. Here is an example of a hierarchy:
|
5931
|
+
# `/Finance/Prod/IAD/WinServ2016/license33 `
|
5739
5932
|
#
|
5740
5933
|
# @option params [Boolean] :recursive
|
5741
5934
|
# Retrieve all parameters within a hierarchy.
|
@@ -6108,6 +6301,14 @@ module Aws::SSM
|
|
6108
6301
|
# resp.association_versions[0].compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
6109
6302
|
# resp.association_versions[0].sync_compliance #=> String, one of "AUTO", "MANUAL"
|
6110
6303
|
# resp.association_versions[0].apply_only_at_cron_interval #=> Boolean
|
6304
|
+
# resp.association_versions[0].target_locations #=> Array
|
6305
|
+
# resp.association_versions[0].target_locations[0].accounts #=> Array
|
6306
|
+
# resp.association_versions[0].target_locations[0].accounts[0] #=> String
|
6307
|
+
# resp.association_versions[0].target_locations[0].regions #=> Array
|
6308
|
+
# resp.association_versions[0].target_locations[0].regions[0] #=> String
|
6309
|
+
# resp.association_versions[0].target_locations[0].target_location_max_concurrency #=> String
|
6310
|
+
# resp.association_versions[0].target_locations[0].target_location_max_errors #=> String
|
6311
|
+
# resp.association_versions[0].target_locations[0].execution_role_name #=> String
|
6111
6312
|
# resp.next_token #=> String
|
6112
6313
|
#
|
6113
6314
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListAssociationVersions AWS API Documentation
|
@@ -6532,6 +6733,69 @@ module Aws::SSM
|
|
6532
6733
|
req.send_request(options)
|
6533
6734
|
end
|
6534
6735
|
|
6736
|
+
# Information about approval reviews for a version of an SSM document.
|
6737
|
+
#
|
6738
|
+
# @option params [required, String] :name
|
6739
|
+
# The name of the document.
|
6740
|
+
#
|
6741
|
+
# @option params [String] :document_version
|
6742
|
+
# The version of the document.
|
6743
|
+
#
|
6744
|
+
# @option params [required, String] :metadata
|
6745
|
+
# The type of data for which details are being requested. Currently, the
|
6746
|
+
# only supported value is `DocumentReviews`.
|
6747
|
+
#
|
6748
|
+
# @option params [String] :next_token
|
6749
|
+
# The token for the next set of items to return. (You received this
|
6750
|
+
# token from a previous call.)
|
6751
|
+
#
|
6752
|
+
# @option params [Integer] :max_results
|
6753
|
+
# The maximum number of items to return for this call. The call also
|
6754
|
+
# returns a token that you can specify in a subsequent call to get the
|
6755
|
+
# next set of results.
|
6756
|
+
#
|
6757
|
+
# @return [Types::ListDocumentMetadataHistoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6758
|
+
#
|
6759
|
+
# * {Types::ListDocumentMetadataHistoryResponse#name #name} => String
|
6760
|
+
# * {Types::ListDocumentMetadataHistoryResponse#document_version #document_version} => String
|
6761
|
+
# * {Types::ListDocumentMetadataHistoryResponse#author #author} => String
|
6762
|
+
# * {Types::ListDocumentMetadataHistoryResponse#metadata #metadata} => Types::DocumentMetadataResponseInfo
|
6763
|
+
# * {Types::ListDocumentMetadataHistoryResponse#next_token #next_token} => String
|
6764
|
+
#
|
6765
|
+
# @example Request syntax with placeholder values
|
6766
|
+
#
|
6767
|
+
# resp = client.list_document_metadata_history({
|
6768
|
+
# name: "DocumentName", # required
|
6769
|
+
# document_version: "DocumentVersion",
|
6770
|
+
# metadata: "DocumentReviews", # required, accepts DocumentReviews
|
6771
|
+
# next_token: "NextToken",
|
6772
|
+
# max_results: 1,
|
6773
|
+
# })
|
6774
|
+
#
|
6775
|
+
# @example Response structure
|
6776
|
+
#
|
6777
|
+
# resp.name #=> String
|
6778
|
+
# resp.document_version #=> String
|
6779
|
+
# resp.author #=> String
|
6780
|
+
# resp.metadata.reviewer_response #=> Array
|
6781
|
+
# resp.metadata.reviewer_response[0].create_time #=> Time
|
6782
|
+
# resp.metadata.reviewer_response[0].updated_time #=> Time
|
6783
|
+
# resp.metadata.reviewer_response[0].review_status #=> String, one of "APPROVED", "NOT_REVIEWED", "PENDING", "REJECTED"
|
6784
|
+
# resp.metadata.reviewer_response[0].comment #=> Array
|
6785
|
+
# resp.metadata.reviewer_response[0].comment[0].type #=> String, one of "Comment"
|
6786
|
+
# resp.metadata.reviewer_response[0].comment[0].content #=> String
|
6787
|
+
# resp.metadata.reviewer_response[0].reviewer #=> String
|
6788
|
+
# resp.next_token #=> String
|
6789
|
+
#
|
6790
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListDocumentMetadataHistory AWS API Documentation
|
6791
|
+
#
|
6792
|
+
# @overload list_document_metadata_history(params = {})
|
6793
|
+
# @param [Hash] params ({})
|
6794
|
+
def list_document_metadata_history(params = {}, options = {})
|
6795
|
+
req = build_request(:list_document_metadata_history, params)
|
6796
|
+
req.send_request(options)
|
6797
|
+
end
|
6798
|
+
|
6535
6799
|
# List all versions for a document.
|
6536
6800
|
#
|
6537
6801
|
# @option params [required, String] :name
|
@@ -6573,6 +6837,7 @@ module Aws::SSM
|
|
6573
6837
|
# resp.document_versions[0].document_format #=> String, one of "YAML", "JSON", "TEXT"
|
6574
6838
|
# resp.document_versions[0].status #=> String, one of "Creating", "Active", "Updating", "Deleting", "Failed"
|
6575
6839
|
# resp.document_versions[0].status_information #=> String
|
6840
|
+
# resp.document_versions[0].review_status #=> String, one of "APPROVED", "NOT_REVIEWED", "PENDING", "REJECTED"
|
6576
6841
|
# resp.next_token #=> String
|
6577
6842
|
#
|
6578
6843
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListDocumentVersions AWS API Documentation
|
@@ -6592,14 +6857,20 @@ module Aws::SSM
|
|
6592
6857
|
# This data type is deprecated. Instead, use `Filters`.
|
6593
6858
|
#
|
6594
6859
|
# @option params [Array<Types::DocumentKeyValuesFilter>] :filters
|
6595
|
-
# One or more DocumentKeyValuesFilter objects. Use a filter to return
|
6596
|
-
# more specific list of results. For keys, you can specify one or more
|
6860
|
+
# One or more `DocumentKeyValuesFilter` objects. Use a filter to return
|
6861
|
+
# a more specific list of results. For keys, you can specify one or more
|
6597
6862
|
# key-value pair tags that have been applied to a document. Other valid
|
6598
6863
|
# keys include `Owner`, `Name`, `PlatformTypes`, `DocumentType`, and
|
6599
6864
|
# `TargetType`. For example, to return documents you own use
|
6600
6865
|
# `Key=Owner,Values=Self`. To specify a custom key-value pair, use the
|
6601
6866
|
# format `Key=tag:tagName,Values=valueName`.
|
6602
6867
|
#
|
6868
|
+
# <note markdown="1"> This API action only supports filtering documents by using a single
|
6869
|
+
# tag key and one or more tag values. For example:
|
6870
|
+
# `Key=tag:tagName,Values=valueName1,valueName2`
|
6871
|
+
#
|
6872
|
+
# </note>
|
6873
|
+
#
|
6603
6874
|
# @option params [Integer] :max_results
|
6604
6875
|
# The maximum number of items to return for this call. The call also
|
6605
6876
|
# returns a token that you can specify in a subsequent call to get the
|
@@ -6644,7 +6915,7 @@ module Aws::SSM
|
|
6644
6915
|
# resp.document_identifiers[0].platform_types #=> Array
|
6645
6916
|
# resp.document_identifiers[0].platform_types[0] #=> String, one of "Windows", "Linux"
|
6646
6917
|
# resp.document_identifiers[0].document_version #=> String
|
6647
|
-
# resp.document_identifiers[0].document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar"
|
6918
|
+
# resp.document_identifiers[0].document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar", "Automation.ChangeTemplate"
|
6648
6919
|
# resp.document_identifiers[0].schema_version #=> String
|
6649
6920
|
# resp.document_identifiers[0].document_format #=> String, one of "YAML", "JSON", "TEXT"
|
6650
6921
|
# resp.document_identifiers[0].target_type #=> String
|
@@ -6654,6 +6925,8 @@ module Aws::SSM
|
|
6654
6925
|
# resp.document_identifiers[0].requires #=> Array
|
6655
6926
|
# resp.document_identifiers[0].requires[0].name #=> String
|
6656
6927
|
# resp.document_identifiers[0].requires[0].version #=> String
|
6928
|
+
# resp.document_identifiers[0].review_status #=> String, one of "APPROVED", "NOT_REVIEWED", "PENDING", "REJECTED"
|
6929
|
+
# resp.document_identifiers[0].author #=> String
|
6657
6930
|
# resp.next_token #=> String
|
6658
6931
|
#
|
6659
6932
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListDocuments AWS API Documentation
|
@@ -6731,8 +7004,67 @@ module Aws::SSM
|
|
6731
7004
|
req.send_request(options)
|
6732
7005
|
end
|
6733
7006
|
|
6734
|
-
#
|
6735
|
-
#
|
7007
|
+
# Returns a list of all OpsItem events in the current AWS account and
|
7008
|
+
# Region. You can limit the results to events associated with specific
|
7009
|
+
# OpsItems by specifying a filter.
|
7010
|
+
#
|
7011
|
+
# @option params [Array<Types::OpsItemEventFilter>] :filters
|
7012
|
+
# One or more OpsItem filters. Use a filter to return a more specific
|
7013
|
+
# list of results.
|
7014
|
+
#
|
7015
|
+
# @option params [Integer] :max_results
|
7016
|
+
# The maximum number of items to return for this call. The call also
|
7017
|
+
# returns a token that you can specify in a subsequent call to get the
|
7018
|
+
# next set of results.
|
7019
|
+
#
|
7020
|
+
# @option params [String] :next_token
|
7021
|
+
# A token to start the list. Use this token to get the next set of
|
7022
|
+
# results.
|
7023
|
+
#
|
7024
|
+
# @return [Types::ListOpsItemEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7025
|
+
#
|
7026
|
+
# * {Types::ListOpsItemEventsResponse#next_token #next_token} => String
|
7027
|
+
# * {Types::ListOpsItemEventsResponse#summaries #summaries} => Array<Types::OpsItemEventSummary>
|
7028
|
+
#
|
7029
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
7030
|
+
#
|
7031
|
+
# @example Request syntax with placeholder values
|
7032
|
+
#
|
7033
|
+
# resp = client.list_ops_item_events({
|
7034
|
+
# filters: [
|
7035
|
+
# {
|
7036
|
+
# key: "OpsItemId", # required, accepts OpsItemId
|
7037
|
+
# values: ["OpsItemEventFilterValue"], # required
|
7038
|
+
# operator: "Equal", # required, accepts Equal
|
7039
|
+
# },
|
7040
|
+
# ],
|
7041
|
+
# max_results: 1,
|
7042
|
+
# next_token: "String",
|
7043
|
+
# })
|
7044
|
+
#
|
7045
|
+
# @example Response structure
|
7046
|
+
#
|
7047
|
+
# resp.next_token #=> String
|
7048
|
+
# resp.summaries #=> Array
|
7049
|
+
# resp.summaries[0].ops_item_id #=> String
|
7050
|
+
# resp.summaries[0].event_id #=> String
|
7051
|
+
# resp.summaries[0].source #=> String
|
7052
|
+
# resp.summaries[0].detail_type #=> String
|
7053
|
+
# resp.summaries[0].detail #=> String
|
7054
|
+
# resp.summaries[0].created_by.arn #=> String
|
7055
|
+
# resp.summaries[0].created_time #=> Time
|
7056
|
+
#
|
7057
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListOpsItemEvents AWS API Documentation
|
7058
|
+
#
|
7059
|
+
# @overload list_ops_item_events(params = {})
|
7060
|
+
# @param [Hash] params ({})
|
7061
|
+
def list_ops_item_events(params = {}, options = {})
|
7062
|
+
req = build_request(:list_ops_item_events, params)
|
7063
|
+
req.send_request(options)
|
7064
|
+
end
|
7065
|
+
|
7066
|
+
# Systems Manager calls this API action when displaying all Application
|
7067
|
+
# Manager OpsMetadata objects or blobs.
|
6736
7068
|
#
|
6737
7069
|
# @option params [Array<Types::OpsMetadataFilter>] :filters
|
6738
7070
|
# One or more filters to limit the number of OpsMetadata objects
|
@@ -6752,6 +7084,8 @@ module Aws::SSM
|
|
6752
7084
|
# * {Types::ListOpsMetadataResult#ops_metadata_list #ops_metadata_list} => Array<Types::OpsMetadata>
|
6753
7085
|
# * {Types::ListOpsMetadataResult#next_token #next_token} => String
|
6754
7086
|
#
|
7087
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
7088
|
+
#
|
6755
7089
|
# @example Request syntax with placeholder values
|
6756
7090
|
#
|
6757
7091
|
# resp = client.list_ops_metadata({
|
@@ -7661,16 +7995,29 @@ module Aws::SSM
|
|
7661
7995
|
# @option params [required, String] :window_id
|
7662
7996
|
# The ID of the maintenance window the task should be added to.
|
7663
7997
|
#
|
7664
|
-
# @option params [
|
7998
|
+
# @option params [Array<Types::Target>] :targets
|
7665
7999
|
# The targets (either instances or maintenance window targets).
|
7666
8000
|
#
|
8001
|
+
# <note markdown="1"> One or more targets must be specified for maintenance window Run
|
8002
|
+
# Command-type tasks. Depending on the task, targets are optional for
|
8003
|
+
# other maintenance window task types (Automation, AWS Lambda, and AWS
|
8004
|
+
# Step Functions). For more information about running tasks that do not
|
8005
|
+
# specify targets, see [Registering maintenance window tasks without
|
8006
|
+
# targets][1] in the *AWS Systems Manager User Guide*.
|
8007
|
+
#
|
8008
|
+
# </note>
|
8009
|
+
#
|
7667
8010
|
# Specify instances using the following format:
|
7668
8011
|
#
|
7669
8012
|
# `Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>`
|
7670
8013
|
#
|
7671
8014
|
# Specify maintenance window targets using the following format:
|
7672
8015
|
#
|
7673
|
-
# `Key=WindowTargetIds
|
8016
|
+
# `Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>`
|
8017
|
+
#
|
8018
|
+
#
|
8019
|
+
#
|
8020
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html
|
7674
8021
|
#
|
7675
8022
|
# @option params [required, String] :task_arn
|
7676
8023
|
# The ARN of the task to run.
|
@@ -7720,13 +8067,27 @@ module Aws::SSM
|
|
7720
8067
|
# scheduled in priority order with tasks that have the same priority
|
7721
8068
|
# scheduled in parallel.
|
7722
8069
|
#
|
7723
|
-
# @option params [
|
8070
|
+
# @option params [String] :max_concurrency
|
7724
8071
|
# The maximum number of targets this task can be run for in parallel.
|
7725
8072
|
#
|
7726
|
-
#
|
8073
|
+
# <note markdown="1"> For maintenance window tasks without a target specified, you cannot
|
8074
|
+
# supply a value for this option. Instead, the system inserts a
|
8075
|
+
# placeholder value of `1`. This value does not affect the running of
|
8076
|
+
# your task.
|
8077
|
+
#
|
8078
|
+
# </note>
|
8079
|
+
#
|
8080
|
+
# @option params [String] :max_errors
|
7727
8081
|
# The maximum number of errors allowed before this task stops being
|
7728
8082
|
# scheduled.
|
7729
8083
|
#
|
8084
|
+
# <note markdown="1"> For maintenance window tasks without a target specified, you cannot
|
8085
|
+
# supply a value for this option. Instead, the system inserts a
|
8086
|
+
# placeholder value of `1`. This value does not affect the running of
|
8087
|
+
# your task.
|
8088
|
+
#
|
8089
|
+
# </note>
|
8090
|
+
#
|
7730
8091
|
# @option params [Types::LoggingInfo] :logging_info
|
7731
8092
|
# A structure containing information about an S3 bucket to write
|
7732
8093
|
# instance-level logs to.
|
@@ -7760,7 +8121,7 @@ module Aws::SSM
|
|
7760
8121
|
#
|
7761
8122
|
# resp = client.register_task_with_maintenance_window({
|
7762
8123
|
# window_id: "MaintenanceWindowId", # required
|
7763
|
-
# targets: [
|
8124
|
+
# targets: [
|
7764
8125
|
# {
|
7765
8126
|
# key: "TargetKey",
|
7766
8127
|
# values: ["TargetValue"],
|
@@ -7814,8 +8175,8 @@ module Aws::SSM
|
|
7814
8175
|
# },
|
7815
8176
|
# },
|
7816
8177
|
# priority: 1,
|
7817
|
-
# max_concurrency: "MaxConcurrency",
|
7818
|
-
# max_errors: "MaxErrors",
|
8178
|
+
# max_concurrency: "MaxConcurrency",
|
8179
|
+
# max_errors: "MaxErrors",
|
7819
8180
|
# logging_info: {
|
7820
8181
|
# s3_bucket_name: "S3BucketName", # required
|
7821
8182
|
# s3_key_prefix: "S3KeyPrefix",
|
@@ -8073,8 +8434,15 @@ module Aws::SSM
|
|
8073
8434
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html
|
8074
8435
|
#
|
8075
8436
|
# @option params [required, String] :document_name
|
8076
|
-
#
|
8077
|
-
# a
|
8437
|
+
# The name of the Systems Manager document to run. This can be a public
|
8438
|
+
# document or a custom document. To run a shared document belonging to
|
8439
|
+
# another account, specify the document ARN. For more information about
|
8440
|
+
# how to use shared documents, see [Using shared SSM documents][1] in
|
8441
|
+
# the *AWS Systems Manager User Guide*.
|
8442
|
+
#
|
8443
|
+
#
|
8444
|
+
#
|
8445
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html
|
8078
8446
|
#
|
8079
8447
|
# @option params [String] :document_version
|
8080
8448
|
# The SSM document version to use in the request. You can specify
|
@@ -8277,7 +8645,15 @@ module Aws::SSM
|
|
8277
8645
|
# Initiates execution of an Automation document.
|
8278
8646
|
#
|
8279
8647
|
# @option params [required, String] :document_name
|
8280
|
-
# The name of the
|
8648
|
+
# The name of the Systems Manager document to run. This can be a public
|
8649
|
+
# document or a custom document. To run a shared document belonging to
|
8650
|
+
# another account, specify the document ARN. For more information about
|
8651
|
+
# how to use shared documents, see [Using shared SSM documents][1] in
|
8652
|
+
# the *AWS Systems Manager User Guide*.
|
8653
|
+
#
|
8654
|
+
#
|
8655
|
+
#
|
8656
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html
|
8281
8657
|
#
|
8282
8658
|
# @option params [String] :document_version
|
8283
8659
|
# The version of the Automation document to use for this execution.
|
@@ -8415,6 +8791,125 @@ module Aws::SSM
|
|
8415
8791
|
req.send_request(options)
|
8416
8792
|
end
|
8417
8793
|
|
8794
|
+
# Creates a change request for Change Manager. The runbooks (Automation
|
8795
|
+
# documents) specified in the change request run only after all required
|
8796
|
+
# approvals for the change request have been received.
|
8797
|
+
#
|
8798
|
+
# @option params [Time,DateTime,Date,Integer,String] :scheduled_time
|
8799
|
+
# The date and time specified in the change request to run the
|
8800
|
+
# Automation runbooks.
|
8801
|
+
#
|
8802
|
+
# <note markdown="1"> The Automation runbooks specified for the runbook workflow can't run
|
8803
|
+
# until all required approvals for the change request have been
|
8804
|
+
# received.
|
8805
|
+
#
|
8806
|
+
# </note>
|
8807
|
+
#
|
8808
|
+
# @option params [required, String] :document_name
|
8809
|
+
# The name of the change template document to run during the runbook
|
8810
|
+
# workflow.
|
8811
|
+
#
|
8812
|
+
# @option params [String] :document_version
|
8813
|
+
# The version of the change template document to run during the runbook
|
8814
|
+
# workflow.
|
8815
|
+
#
|
8816
|
+
# @option params [Hash<String,Array>] :parameters
|
8817
|
+
# A key-value map of parameters that match the declared parameters in
|
8818
|
+
# the change template document.
|
8819
|
+
#
|
8820
|
+
# @option params [String] :change_request_name
|
8821
|
+
# The name of the change request associated with the runbook workflow to
|
8822
|
+
# be run.
|
8823
|
+
#
|
8824
|
+
# @option params [String] :client_token
|
8825
|
+
# The user-provided idempotency token. The token must be unique, is case
|
8826
|
+
# insensitive, enforces the UUID format, and can't be reused.
|
8827
|
+
#
|
8828
|
+
# @option params [required, Array<Types::Runbook>] :runbooks
|
8829
|
+
# Information about the Automation runbooks (Automation documents) that
|
8830
|
+
# are run during the runbook workflow.
|
8831
|
+
#
|
8832
|
+
# <note markdown="1"> The Automation runbooks specified for the runbook workflow can't run
|
8833
|
+
# until all required approvals for the change request have been
|
8834
|
+
# received.
|
8835
|
+
#
|
8836
|
+
# </note>
|
8837
|
+
#
|
8838
|
+
# @option params [Array<Types::Tag>] :tags
|
8839
|
+
# Optional metadata that you assign to a resource. You can specify a
|
8840
|
+
# maximum of five tags for a change request. Tags enable you to
|
8841
|
+
# categorize a resource in different ways, such as by purpose, owner, or
|
8842
|
+
# environment. For example, you might want to tag a change request to
|
8843
|
+
# identify an environment or target AWS Region. In this case, you could
|
8844
|
+
# specify the following key-value pairs:
|
8845
|
+
#
|
8846
|
+
# * `Key=Environment,Value=Production`
|
8847
|
+
#
|
8848
|
+
# * `Key=Region,Value=us-east-2`
|
8849
|
+
#
|
8850
|
+
# @return [Types::StartChangeRequestExecutionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8851
|
+
#
|
8852
|
+
# * {Types::StartChangeRequestExecutionResult#automation_execution_id #automation_execution_id} => String
|
8853
|
+
#
|
8854
|
+
# @example Request syntax with placeholder values
|
8855
|
+
#
|
8856
|
+
# resp = client.start_change_request_execution({
|
8857
|
+
# scheduled_time: Time.now,
|
8858
|
+
# document_name: "DocumentARN", # required
|
8859
|
+
# document_version: "DocumentVersion",
|
8860
|
+
# parameters: {
|
8861
|
+
# "AutomationParameterKey" => ["AutomationParameterValue"],
|
8862
|
+
# },
|
8863
|
+
# change_request_name: "ChangeRequestName",
|
8864
|
+
# client_token: "IdempotencyToken",
|
8865
|
+
# runbooks: [ # required
|
8866
|
+
# {
|
8867
|
+
# document_name: "DocumentARN", # required
|
8868
|
+
# document_version: "DocumentVersion",
|
8869
|
+
# parameters: {
|
8870
|
+
# "AutomationParameterKey" => ["AutomationParameterValue"],
|
8871
|
+
# },
|
8872
|
+
# target_parameter_name: "AutomationParameterKey",
|
8873
|
+
# targets: [
|
8874
|
+
# {
|
8875
|
+
# key: "TargetKey",
|
8876
|
+
# values: ["TargetValue"],
|
8877
|
+
# },
|
8878
|
+
# ],
|
8879
|
+
# max_concurrency: "MaxConcurrency",
|
8880
|
+
# max_errors: "MaxErrors",
|
8881
|
+
# target_locations: [
|
8882
|
+
# {
|
8883
|
+
# accounts: ["Account"],
|
8884
|
+
# regions: ["Region"],
|
8885
|
+
# target_location_max_concurrency: "MaxConcurrency",
|
8886
|
+
# target_location_max_errors: "MaxErrors",
|
8887
|
+
# execution_role_name: "ExecutionRoleName",
|
8888
|
+
# },
|
8889
|
+
# ],
|
8890
|
+
# },
|
8891
|
+
# ],
|
8892
|
+
# tags: [
|
8893
|
+
# {
|
8894
|
+
# key: "TagKey", # required
|
8895
|
+
# value: "TagValue", # required
|
8896
|
+
# },
|
8897
|
+
# ],
|
8898
|
+
# })
|
8899
|
+
#
|
8900
|
+
# @example Response structure
|
8901
|
+
#
|
8902
|
+
# resp.automation_execution_id #=> String
|
8903
|
+
#
|
8904
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/StartChangeRequestExecution AWS API Documentation
|
8905
|
+
#
|
8906
|
+
# @overload start_change_request_execution(params = {})
|
8907
|
+
# @param [Hash] params ({})
|
8908
|
+
def start_change_request_execution(params = {}, options = {})
|
8909
|
+
req = build_request(:start_change_request_execution, params)
|
8910
|
+
req.send_request(options)
|
8911
|
+
end
|
8912
|
+
|
8418
8913
|
# Initiates a connection to a target (for example, an instance) for a
|
8419
8914
|
# Session Manager session. Returns a URL and token that can be used to
|
8420
8915
|
# open a WebSocket connection for sending input and receiving outputs.
|
@@ -8667,6 +9162,11 @@ module Aws::SSM
|
|
8667
9162
|
# association to run immediately after updating it and according to the
|
8668
9163
|
# interval specified.
|
8669
9164
|
#
|
9165
|
+
# @option params [Array<Types::TargetLocation>] :target_locations
|
9166
|
+
# A location is a combination of AWS Regions and AWS accounts where you
|
9167
|
+
# want to run the association. Use this action to update an association
|
9168
|
+
# in multiple Regions and multiple accounts.
|
9169
|
+
#
|
8670
9170
|
# @return [Types::UpdateAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8671
9171
|
#
|
8672
9172
|
# * {Types::UpdateAssociationResult#association_description #association_description} => Types::AssociationDescription
|
@@ -8702,6 +9202,15 @@ module Aws::SSM
|
|
8702
9202
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
8703
9203
|
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
8704
9204
|
# apply_only_at_cron_interval: false,
|
9205
|
+
# target_locations: [
|
9206
|
+
# {
|
9207
|
+
# accounts: ["Account"],
|
9208
|
+
# regions: ["Region"],
|
9209
|
+
# target_location_max_concurrency: "MaxConcurrency",
|
9210
|
+
# target_location_max_errors: "MaxErrors",
|
9211
|
+
# execution_role_name: "ExecutionRoleName",
|
9212
|
+
# },
|
9213
|
+
# ],
|
8705
9214
|
# })
|
8706
9215
|
#
|
8707
9216
|
# @example Response structure
|
@@ -8741,6 +9250,14 @@ module Aws::SSM
|
|
8741
9250
|
# resp.association_description.compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
8742
9251
|
# resp.association_description.sync_compliance #=> String, one of "AUTO", "MANUAL"
|
8743
9252
|
# resp.association_description.apply_only_at_cron_interval #=> Boolean
|
9253
|
+
# resp.association_description.target_locations #=> Array
|
9254
|
+
# resp.association_description.target_locations[0].accounts #=> Array
|
9255
|
+
# resp.association_description.target_locations[0].accounts[0] #=> String
|
9256
|
+
# resp.association_description.target_locations[0].regions #=> Array
|
9257
|
+
# resp.association_description.target_locations[0].regions[0] #=> String
|
9258
|
+
# resp.association_description.target_locations[0].target_location_max_concurrency #=> String
|
9259
|
+
# resp.association_description.target_locations[0].target_location_max_errors #=> String
|
9260
|
+
# resp.association_description.target_locations[0].execution_role_name #=> String
|
8744
9261
|
#
|
8745
9262
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateAssociation AWS API Documentation
|
8746
9263
|
#
|
@@ -8817,6 +9334,14 @@ module Aws::SSM
|
|
8817
9334
|
# resp.association_description.compliance_severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED"
|
8818
9335
|
# resp.association_description.sync_compliance #=> String, one of "AUTO", "MANUAL"
|
8819
9336
|
# resp.association_description.apply_only_at_cron_interval #=> Boolean
|
9337
|
+
# resp.association_description.target_locations #=> Array
|
9338
|
+
# resp.association_description.target_locations[0].accounts #=> Array
|
9339
|
+
# resp.association_description.target_locations[0].accounts[0] #=> String
|
9340
|
+
# resp.association_description.target_locations[0].regions #=> Array
|
9341
|
+
# resp.association_description.target_locations[0].regions[0] #=> String
|
9342
|
+
# resp.association_description.target_locations[0].target_location_max_concurrency #=> String
|
9343
|
+
# resp.association_description.target_locations[0].target_location_max_errors #=> String
|
9344
|
+
# resp.association_description.target_locations[0].execution_role_name #=> String
|
8820
9345
|
#
|
8821
9346
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateAssociationStatus AWS API Documentation
|
8822
9347
|
#
|
@@ -8900,7 +9425,7 @@ module Aws::SSM
|
|
8900
9425
|
# resp.document_description.parameters[0].default_value #=> String
|
8901
9426
|
# resp.document_description.platform_types #=> Array
|
8902
9427
|
# resp.document_description.platform_types[0] #=> String, one of "Windows", "Linux"
|
8903
|
-
# resp.document_description.document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar"
|
9428
|
+
# resp.document_description.document_type #=> String, one of "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar", "Automation.ChangeTemplate"
|
8904
9429
|
# resp.document_description.schema_version #=> String
|
8905
9430
|
# resp.document_description.latest_version #=> String
|
8906
9431
|
# resp.document_description.default_version #=> String
|
@@ -8914,6 +9439,14 @@ module Aws::SSM
|
|
8914
9439
|
# resp.document_description.requires #=> Array
|
8915
9440
|
# resp.document_description.requires[0].name #=> String
|
8916
9441
|
# resp.document_description.requires[0].version #=> String
|
9442
|
+
# resp.document_description.author #=> String
|
9443
|
+
# resp.document_description.review_information #=> Array
|
9444
|
+
# resp.document_description.review_information[0].reviewed_time #=> Time
|
9445
|
+
# resp.document_description.review_information[0].status #=> String, one of "APPROVED", "NOT_REVIEWED", "PENDING", "REJECTED"
|
9446
|
+
# resp.document_description.review_information[0].reviewer #=> String
|
9447
|
+
# resp.document_description.approved_version #=> String
|
9448
|
+
# resp.document_description.pending_review_version #=> String
|
9449
|
+
# resp.document_description.review_status #=> String, one of "APPROVED", "NOT_REVIEWED", "PENDING", "REJECTED"
|
8917
9450
|
#
|
8918
9451
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateDocument AWS API Documentation
|
8919
9452
|
#
|
@@ -8960,6 +9493,45 @@ module Aws::SSM
|
|
8960
9493
|
req.send_request(options)
|
8961
9494
|
end
|
8962
9495
|
|
9496
|
+
# Updates information related to approval reviews for a specific version
|
9497
|
+
# of a document.
|
9498
|
+
#
|
9499
|
+
# @option params [required, String] :name
|
9500
|
+
# The name of the document for which a version is to be updated.
|
9501
|
+
#
|
9502
|
+
# @option params [String] :document_version
|
9503
|
+
# The version of a document to update.
|
9504
|
+
#
|
9505
|
+
# @option params [required, Types::DocumentReviews] :document_reviews
|
9506
|
+
# The document review details to update.
|
9507
|
+
#
|
9508
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
9509
|
+
#
|
9510
|
+
# @example Request syntax with placeholder values
|
9511
|
+
#
|
9512
|
+
# resp = client.update_document_metadata({
|
9513
|
+
# name: "DocumentName", # required
|
9514
|
+
# document_version: "DocumentVersion",
|
9515
|
+
# document_reviews: { # required
|
9516
|
+
# action: "SendForReview", # required, accepts SendForReview, UpdateReview, Approve, Reject
|
9517
|
+
# comment: [
|
9518
|
+
# {
|
9519
|
+
# type: "Comment", # accepts Comment
|
9520
|
+
# content: "DocumentReviewComment",
|
9521
|
+
# },
|
9522
|
+
# ],
|
9523
|
+
# },
|
9524
|
+
# })
|
9525
|
+
#
|
9526
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateDocumentMetadata AWS API Documentation
|
9527
|
+
#
|
9528
|
+
# @overload update_document_metadata(params = {})
|
9529
|
+
# @param [Hash] params ({})
|
9530
|
+
def update_document_metadata(params = {}, options = {})
|
9531
|
+
req = build_request(:update_document_metadata, params)
|
9532
|
+
req.send_request(options)
|
9533
|
+
end
|
9534
|
+
|
8963
9535
|
# Updates an existing maintenance window. Only specified parameters are
|
8964
9536
|
# modified.
|
8965
9537
|
#
|
@@ -8985,7 +9557,7 @@ module Aws::SSM
|
|
8985
9557
|
# @option params [String] :start_date
|
8986
9558
|
# The time zone that the scheduled maintenance window executions are
|
8987
9559
|
# based on, in Internet Assigned Numbers Authority (IANA) format. For
|
8988
|
-
# example: "America/Los\_Angeles", "
|
9560
|
+
# example: "America/Los\_Angeles", "UTC", or "Asia/Seoul". For
|
8989
9561
|
# more information, see the [Time Zone Database][1] on the IANA website.
|
8990
9562
|
#
|
8991
9563
|
#
|
@@ -9005,7 +9577,7 @@ module Aws::SSM
|
|
9005
9577
|
# @option params [String] :schedule_timezone
|
9006
9578
|
# The time zone that the scheduled maintenance window executions are
|
9007
9579
|
# based on, in Internet Assigned Numbers Authority (IANA) format. For
|
9008
|
-
# example: "America/Los\_Angeles", "
|
9580
|
+
# example: "America/Los\_Angeles", "UTC", or "Asia/Seoul". For
|
9009
9581
|
# more information, see the [Time Zone Database][1] on the IANA website.
|
9010
9582
|
#
|
9011
9583
|
#
|
@@ -9019,7 +9591,7 @@ module Aws::SSM
|
|
9019
9591
|
# For example, the following cron expression schedules a maintenance
|
9020
9592
|
# window to run the third Tuesday of every month at 11:30 PM.
|
9021
9593
|
#
|
9022
|
-
# `cron(
|
9594
|
+
# `cron(30 23 ? * TUE#3 *)`
|
9023
9595
|
#
|
9024
9596
|
# If the schedule offset is `2`, the maintenance window won't run until
|
9025
9597
|
# two days later.
|
@@ -9209,6 +9781,15 @@ module Aws::SSM
|
|
9209
9781
|
#
|
9210
9782
|
# * MaxErrors
|
9211
9783
|
#
|
9784
|
+
# <note markdown="1"> One or more targets must be specified for maintenance window Run
|
9785
|
+
# Command-type tasks. Depending on the task, targets are optional for
|
9786
|
+
# other maintenance window task types (Automation, AWS Lambda, and AWS
|
9787
|
+
# Step Functions). For more information about running tasks that do not
|
9788
|
+
# specify targets, see [Registering maintenance window tasks without
|
9789
|
+
# targets][1] in the *AWS Systems Manager User Guide*.
|
9790
|
+
#
|
9791
|
+
# </note>
|
9792
|
+
#
|
9212
9793
|
# If the value for a parameter in `UpdateMaintenanceWindowTask` is null,
|
9213
9794
|
# then the corresponding field is not modified. If you set `Replace` to
|
9214
9795
|
# true, then all fields required by the
|
@@ -9225,6 +9806,10 @@ module Aws::SSM
|
|
9225
9806
|
# and specify only a different `OutputS3BucketName` value, the values
|
9226
9807
|
# for `Comment` and `NotificationConfig` are removed.
|
9227
9808
|
#
|
9809
|
+
#
|
9810
|
+
#
|
9811
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html
|
9812
|
+
#
|
9228
9813
|
# @option params [required, String] :window_id
|
9229
9814
|
# The maintenance window ID that contains the task to modify.
|
9230
9815
|
#
|
@@ -9236,6 +9821,19 @@ module Aws::SSM
|
|
9236
9821
|
# specified using Key=instanceids,Values=instanceID\_1,instanceID\_2.
|
9237
9822
|
# Tags are specified using Key=tag\_name,Values=tag\_value.
|
9238
9823
|
#
|
9824
|
+
# <note markdown="1"> One or more targets must be specified for maintenance window Run
|
9825
|
+
# Command-type tasks. Depending on the task, targets are optional for
|
9826
|
+
# other maintenance window task types (Automation, AWS Lambda, and AWS
|
9827
|
+
# Step Functions). For more information about running tasks that do not
|
9828
|
+
# specify targets, see [Registering maintenance window tasks without
|
9829
|
+
# targets][1] in the *AWS Systems Manager User Guide*.
|
9830
|
+
#
|
9831
|
+
# </note>
|
9832
|
+
#
|
9833
|
+
#
|
9834
|
+
#
|
9835
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html
|
9836
|
+
#
|
9239
9837
|
# @option params [String] :task_arn
|
9240
9838
|
# The task ARN to modify.
|
9241
9839
|
#
|
@@ -9301,11 +9899,27 @@ module Aws::SSM
|
|
9301
9899
|
# is the number of targets that are allowed to run this task in
|
9302
9900
|
# parallel.
|
9303
9901
|
#
|
9902
|
+
# <note markdown="1"> For maintenance window tasks without a target specified, you cannot
|
9903
|
+
# supply a value for this option. Instead, the system inserts a
|
9904
|
+
# placeholder value of `1`, which may be reported in the response to
|
9905
|
+
# this command. This value does not affect the running of your task and
|
9906
|
+
# can be ignored.
|
9907
|
+
#
|
9908
|
+
# </note>
|
9909
|
+
#
|
9304
9910
|
# @option params [String] :max_errors
|
9305
9911
|
# The new `MaxErrors` value to specify. `MaxErrors` is the maximum
|
9306
9912
|
# number of errors that are allowed before the task stops being
|
9307
9913
|
# scheduled.
|
9308
9914
|
#
|
9915
|
+
# <note markdown="1"> For maintenance window tasks without a target specified, you cannot
|
9916
|
+
# supply a value for this option. Instead, the system inserts a
|
9917
|
+
# placeholder value of `1`, which may be reported in the response to
|
9918
|
+
# this command. This value does not affect the running of your task and
|
9919
|
+
# can be ignored.
|
9920
|
+
#
|
9921
|
+
# </note>
|
9922
|
+
#
|
9309
9923
|
# @option params [Types::LoggingInfo] :logging_info
|
9310
9924
|
# The new logging location in Amazon S3 to specify.
|
9311
9925
|
#
|
@@ -9592,6 +10206,23 @@ module Aws::SSM
|
|
9592
10206
|
# @option params [String] :severity
|
9593
10207
|
# Specify a new severity for an OpsItem.
|
9594
10208
|
#
|
10209
|
+
# @option params [Time,DateTime,Date,Integer,String] :actual_start_time
|
10210
|
+
# The time a runbook workflow started. Currently reported only for the
|
10211
|
+
# OpsItem type `/aws/changerequest`.
|
10212
|
+
#
|
10213
|
+
# @option params [Time,DateTime,Date,Integer,String] :actual_end_time
|
10214
|
+
# The time a runbook workflow ended. Currently reported only for the
|
10215
|
+
# OpsItem type `/aws/changerequest`.
|
10216
|
+
#
|
10217
|
+
# @option params [Time,DateTime,Date,Integer,String] :planned_start_time
|
10218
|
+
# The time specified in a change request for a runbook workflow to
|
10219
|
+
# start. Currently supported only for the OpsItem type
|
10220
|
+
# `/aws/changerequest`.
|
10221
|
+
#
|
10222
|
+
# @option params [Time,DateTime,Date,Integer,String] :planned_end_time
|
10223
|
+
# The time specified in a change request for a runbook workflow to end.
|
10224
|
+
# Currently supported only for the OpsItem type `/aws/changerequest`.
|
10225
|
+
#
|
9595
10226
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
9596
10227
|
#
|
9597
10228
|
# @example Request syntax with placeholder values
|
@@ -9616,11 +10247,15 @@ module Aws::SSM
|
|
9616
10247
|
# ops_item_id: "String", # required
|
9617
10248
|
# },
|
9618
10249
|
# ],
|
9619
|
-
# status: "Open", # accepts Open, InProgress, Resolved
|
10250
|
+
# status: "Open", # accepts Open, InProgress, Resolved, Pending, TimedOut, Cancelling, Cancelled, Failed, CompletedWithSuccess, CompletedWithFailure, Scheduled, RunbookInProgress, PendingChangeCalendarOverride, ChangeCalendarOverrideApproved, ChangeCalendarOverrideRejected, PendingApproval, Approved, Rejected
|
9620
10251
|
# ops_item_id: "OpsItemId", # required
|
9621
10252
|
# title: "OpsItemTitle",
|
9622
10253
|
# category: "OpsItemCategory",
|
9623
10254
|
# severity: "OpsItemSeverity",
|
10255
|
+
# actual_start_time: Time.now,
|
10256
|
+
# actual_end_time: Time.now,
|
10257
|
+
# planned_start_time: Time.now,
|
10258
|
+
# planned_end_time: Time.now,
|
9624
10259
|
# })
|
9625
10260
|
#
|
9626
10261
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateOpsItem AWS API Documentation
|
@@ -9633,7 +10268,7 @@ module Aws::SSM
|
|
9633
10268
|
end
|
9634
10269
|
|
9635
10270
|
# Systems Manager calls this API action when you edit OpsMetadata in
|
9636
|
-
#
|
10271
|
+
# Application Manager.
|
9637
10272
|
#
|
9638
10273
|
# @option params [required, String] :ops_metadata_arn
|
9639
10274
|
# The Amazon Resoure Name (ARN) of the OpsMetadata Object to update.
|
@@ -9993,7 +10628,7 @@ module Aws::SSM
|
|
9993
10628
|
params: params,
|
9994
10629
|
config: config)
|
9995
10630
|
context[:gem_name] = 'aws-sdk-ssm'
|
9996
|
-
context[:gem_version] = '1.
|
10631
|
+
context[:gem_version] = '1.104.0'
|
9997
10632
|
Seahorse::Client::Request.new(handlers, context)
|
9998
10633
|
end
|
9999
10634
|
|