aws-sdk-ssm 1.47.0 → 1.48.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 +171 -143
- data/lib/aws-sdk-ssm/types.rb +318 -261
- metadata +2 -2
data/lib/aws-sdk-ssm/types.rb
CHANGED
@@ -91,8 +91,8 @@ module Aws::SSM
|
|
91
91
|
# Specifies the type of resource you are tagging.
|
92
92
|
#
|
93
93
|
# <note markdown="1"> The ManagedInstance type for this API action is for on-premises
|
94
|
-
# managed instances. You must specify the
|
95
|
-
#
|
94
|
+
# managed instances. You must specify the name of the managed instance
|
95
|
+
# in the following format: mi-ID\_number. For example,
|
96
96
|
# mi-1a2b3c4d5e6f.
|
97
97
|
#
|
98
98
|
# </note>
|
@@ -112,8 +112,8 @@ module Aws::SSM
|
|
112
112
|
# For the Document and Parameter values, use the name of the resource.
|
113
113
|
#
|
114
114
|
# <note markdown="1"> The ManagedInstance type for this API action is only for on-premises
|
115
|
-
# managed instances. You must specify the
|
116
|
-
#
|
115
|
+
# managed instances. You must specify the name of the managed instance
|
116
|
+
# in the following format: mi-ID\_number. For example,
|
117
117
|
# mi-1a2b3c4d5e6f.
|
118
118
|
#
|
119
119
|
# </note>
|
@@ -1230,7 +1230,7 @@ module Aws::SSM
|
|
1230
1230
|
# }
|
1231
1231
|
#
|
1232
1232
|
# @!attribute [rw] window_execution_id
|
1233
|
-
# The ID of the
|
1233
|
+
# The ID of the maintenance window execution to stop.
|
1234
1234
|
# @return [String]
|
1235
1235
|
#
|
1236
1236
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CancelMaintenanceWindowExecutionRequest AWS API Documentation
|
@@ -1241,7 +1241,7 @@ module Aws::SSM
|
|
1241
1241
|
end
|
1242
1242
|
|
1243
1243
|
# @!attribute [rw] window_execution_id
|
1244
|
-
# The ID of the
|
1244
|
+
# The ID of the maintenance window execution that has been stopped.
|
1245
1245
|
# @return [String]
|
1246
1246
|
#
|
1247
1247
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CancelMaintenanceWindowExecutionResult AWS API Documentation
|
@@ -2716,36 +2716,36 @@ module Aws::SSM
|
|
2716
2716
|
# }
|
2717
2717
|
#
|
2718
2718
|
# @!attribute [rw] name
|
2719
|
-
# The name of the
|
2719
|
+
# The name of the maintenance window.
|
2720
2720
|
# @return [String]
|
2721
2721
|
#
|
2722
2722
|
# @!attribute [rw] description
|
2723
|
-
# An optional description for the
|
2724
|
-
# specifying a description to help you organize your
|
2725
|
-
#
|
2723
|
+
# An optional description for the maintenance window. We recommend
|
2724
|
+
# specifying a description to help you organize your maintenance
|
2725
|
+
# windows.
|
2726
2726
|
# @return [String]
|
2727
2727
|
#
|
2728
2728
|
# @!attribute [rw] start_date
|
2729
2729
|
# The date and time, in ISO-8601 Extended format, for when you want
|
2730
|
-
# the
|
2731
|
-
# delay activation of the
|
2730
|
+
# the maintenance window to become active. StartDate allows you to
|
2731
|
+
# delay activation of the maintenance window until the specified
|
2732
2732
|
# future date.
|
2733
2733
|
# @return [String]
|
2734
2734
|
#
|
2735
2735
|
# @!attribute [rw] end_date
|
2736
2736
|
# The date and time, in ISO-8601 Extended format, for when you want
|
2737
|
-
# the
|
2738
|
-
# a date and time in the future when the
|
2737
|
+
# the maintenance window to become inactive. EndDate allows you to set
|
2738
|
+
# a date and time in the future when the maintenance window will no
|
2739
2739
|
# longer run.
|
2740
2740
|
# @return [String]
|
2741
2741
|
#
|
2742
2742
|
# @!attribute [rw] schedule
|
2743
|
-
# The schedule of the
|
2743
|
+
# The schedule of the maintenance window in the form of a cron or rate
|
2744
2744
|
# expression.
|
2745
2745
|
# @return [String]
|
2746
2746
|
#
|
2747
2747
|
# @!attribute [rw] schedule_timezone
|
2748
|
-
# The time zone that the scheduled
|
2748
|
+
# The time zone that the scheduled maintenance window executions are
|
2749
2749
|
# based on, in Internet Assigned Numbers Authority (IANA) format. For
|
2750
2750
|
# example: "America/Los\_Angeles", "etc/UTC", or "Asia/Seoul".
|
2751
2751
|
# For more information, see the [Time Zone Database][1] on the IANA
|
@@ -2757,23 +2757,23 @@ module Aws::SSM
|
|
2757
2757
|
# @return [String]
|
2758
2758
|
#
|
2759
2759
|
# @!attribute [rw] duration
|
2760
|
-
# The duration of the
|
2760
|
+
# The duration of the maintenance window in hours.
|
2761
2761
|
# @return [Integer]
|
2762
2762
|
#
|
2763
2763
|
# @!attribute [rw] cutoff
|
2764
|
-
# The number of hours before the end of the
|
2764
|
+
# The number of hours before the end of the maintenance window that
|
2765
2765
|
# Systems Manager stops scheduling new tasks for execution.
|
2766
2766
|
# @return [Integer]
|
2767
2767
|
#
|
2768
2768
|
# @!attribute [rw] allow_unassociated_targets
|
2769
|
-
# Enables a
|
2769
|
+
# Enables a maintenance window task to run on managed instances, even
|
2770
2770
|
# if you have not registered those instances as targets. If enabled,
|
2771
2771
|
# then you must specify the unregistered instances (by instance ID)
|
2772
|
-
# when you register a task with the
|
2772
|
+
# when you register a task with the maintenance window.
|
2773
2773
|
#
|
2774
2774
|
# If you don't enable this option, then you must specify
|
2775
2775
|
# previously-registered targets when you register a task with the
|
2776
|
-
#
|
2776
|
+
# maintenance window.
|
2777
2777
|
# @return [Boolean]
|
2778
2778
|
#
|
2779
2779
|
# @!attribute [rw] client_token
|
@@ -2786,8 +2786,8 @@ module Aws::SSM
|
|
2786
2786
|
# @!attribute [rw] tags
|
2787
2787
|
# Optional metadata that you assign to a resource. Tags enable you to
|
2788
2788
|
# categorize a resource in different ways, such as by purpose, owner,
|
2789
|
-
# or environment. For example, you might want to tag a
|
2790
|
-
#
|
2789
|
+
# or environment. For example, you might want to tag a maintenance
|
2790
|
+
# window to identify the type of tasks it will run, the types of
|
2791
2791
|
# targets, and the environment it will run in. In this case, you could
|
2792
2792
|
# specify the following key name/value pairs:
|
2793
2793
|
#
|
@@ -2797,7 +2797,7 @@ module Aws::SSM
|
|
2797
2797
|
#
|
2798
2798
|
# * `Key=Environment,Value=Production`
|
2799
2799
|
#
|
2800
|
-
# <note markdown="1"> To add tags to an existing
|
2800
|
+
# <note markdown="1"> To add tags to an existing maintenance window, use the
|
2801
2801
|
# AddTagsToResource action.
|
2802
2802
|
#
|
2803
2803
|
# </note>
|
@@ -2821,7 +2821,7 @@ module Aws::SSM
|
|
2821
2821
|
end
|
2822
2822
|
|
2823
2823
|
# @!attribute [rw] window_id
|
2824
|
-
# The ID of the created
|
2824
|
+
# The ID of the created maintenance window.
|
2825
2825
|
# @return [String]
|
2826
2826
|
#
|
2827
2827
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateMaintenanceWindowResult AWS API Documentation
|
@@ -3168,7 +3168,7 @@ module Aws::SSM
|
|
3168
3168
|
# DisableSchema: If you choose this option, the system ignores all
|
3169
3169
|
# inventory data for the specified version, and any earlier versions.
|
3170
3170
|
# To enable this schema again, you must call the `PutInventory` action
|
3171
|
-
# for a version greater than the
|
3171
|
+
# for a version greater than the disabled version.
|
3172
3172
|
#
|
3173
3173
|
# DeleteSchema: This option deletes the specified custom type from the
|
3174
3174
|
# Inventory service. You can recreate the schema later, if you want.
|
@@ -3237,7 +3237,7 @@ module Aws::SSM
|
|
3237
3237
|
# }
|
3238
3238
|
#
|
3239
3239
|
# @!attribute [rw] window_id
|
3240
|
-
# The ID of the
|
3240
|
+
# The ID of the maintenance window to delete.
|
3241
3241
|
# @return [String]
|
3242
3242
|
#
|
3243
3243
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeleteMaintenanceWindowRequest AWS API Documentation
|
@@ -3248,7 +3248,7 @@ module Aws::SSM
|
|
3248
3248
|
end
|
3249
3249
|
|
3250
3250
|
# @!attribute [rw] window_id
|
3251
|
-
# The ID of the deleted
|
3251
|
+
# The ID of the deleted maintenance window.
|
3252
3252
|
# @return [String]
|
3253
3253
|
#
|
3254
3254
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeleteMaintenanceWindowResult AWS API Documentation
|
@@ -3440,7 +3440,7 @@ module Aws::SSM
|
|
3440
3440
|
# }
|
3441
3441
|
#
|
3442
3442
|
# @!attribute [rw] window_id
|
3443
|
-
# The ID of the
|
3443
|
+
# The ID of the maintenance window the target should be removed from.
|
3444
3444
|
# @return [String]
|
3445
3445
|
#
|
3446
3446
|
# @!attribute [rw] window_target_id
|
@@ -3450,7 +3450,7 @@ module Aws::SSM
|
|
3450
3450
|
# @!attribute [rw] safe
|
3451
3451
|
# The system checks if the target is being referenced by a task. If
|
3452
3452
|
# the target is being referenced, the system returns an error and does
|
3453
|
-
# not deregister the target from the
|
3453
|
+
# not deregister the target from the maintenance window.
|
3454
3454
|
# @return [Boolean]
|
3455
3455
|
#
|
3456
3456
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeregisterTargetFromMaintenanceWindowRequest AWS API Documentation
|
@@ -3463,7 +3463,7 @@ module Aws::SSM
|
|
3463
3463
|
end
|
3464
3464
|
|
3465
3465
|
# @!attribute [rw] window_id
|
3466
|
-
# The ID of the
|
3466
|
+
# The ID of the maintenance window the target was removed from.
|
3467
3467
|
# @return [String]
|
3468
3468
|
#
|
3469
3469
|
# @!attribute [rw] window_target_id
|
@@ -3487,11 +3487,11 @@ module Aws::SSM
|
|
3487
3487
|
# }
|
3488
3488
|
#
|
3489
3489
|
# @!attribute [rw] window_id
|
3490
|
-
# The ID of the
|
3490
|
+
# The ID of the maintenance window the task should be removed from.
|
3491
3491
|
# @return [String]
|
3492
3492
|
#
|
3493
3493
|
# @!attribute [rw] window_task_id
|
3494
|
-
# The ID of the task to remove from the
|
3494
|
+
# The ID of the task to remove from the maintenance window.
|
3495
3495
|
# @return [String]
|
3496
3496
|
#
|
3497
3497
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeregisterTaskFromMaintenanceWindowRequest AWS API Documentation
|
@@ -3503,11 +3503,11 @@ module Aws::SSM
|
|
3503
3503
|
end
|
3504
3504
|
|
3505
3505
|
# @!attribute [rw] window_id
|
3506
|
-
# The ID of the
|
3506
|
+
# The ID of the maintenance window the task was removed from.
|
3507
3507
|
# @return [String]
|
3508
3508
|
#
|
3509
3509
|
# @!attribute [rw] window_task_id
|
3510
|
-
# The ID of the task removed from the
|
3510
|
+
# The ID of the task removed from the maintenance window.
|
3511
3511
|
# @return [String]
|
3512
3512
|
#
|
3513
3513
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeregisterTaskFromMaintenanceWindowResult AWS API Documentation
|
@@ -4541,11 +4541,11 @@ module Aws::SSM
|
|
4541
4541
|
# }
|
4542
4542
|
#
|
4543
4543
|
# @!attribute [rw] window_execution_id
|
4544
|
-
# The ID of the
|
4544
|
+
# The ID of the maintenance window execution the task is part of.
|
4545
4545
|
# @return [String]
|
4546
4546
|
#
|
4547
4547
|
# @!attribute [rw] task_id
|
4548
|
-
# The ID of the specific task in the
|
4548
|
+
# The ID of the specific task in the maintenance window task that
|
4549
4549
|
# should be retrieved.
|
4550
4550
|
# @return [String]
|
4551
4551
|
#
|
@@ -4611,7 +4611,7 @@ module Aws::SSM
|
|
4611
4611
|
# }
|
4612
4612
|
#
|
4613
4613
|
# @!attribute [rw] window_execution_id
|
4614
|
-
# The ID of the
|
4614
|
+
# The ID of the maintenance window execution whose task executions
|
4615
4615
|
# should be retrieved.
|
4616
4616
|
# @return [String]
|
4617
4617
|
#
|
@@ -4676,7 +4676,7 @@ module Aws::SSM
|
|
4676
4676
|
# }
|
4677
4677
|
#
|
4678
4678
|
# @!attribute [rw] window_id
|
4679
|
-
# The ID of the
|
4679
|
+
# The ID of the maintenance window whose executions should be
|
4680
4680
|
# retrieved.
|
4681
4681
|
# @return [String]
|
4682
4682
|
#
|
@@ -4714,7 +4714,7 @@ module Aws::SSM
|
|
4714
4714
|
end
|
4715
4715
|
|
4716
4716
|
# @!attribute [rw] window_executions
|
4717
|
-
# Information about the
|
4717
|
+
# Information about the maintenance window executions.
|
4718
4718
|
# @return [Array<Types::MaintenanceWindowExecution>]
|
4719
4719
|
#
|
4720
4720
|
# @!attribute [rw] next_token
|
@@ -4753,7 +4753,7 @@ module Aws::SSM
|
|
4753
4753
|
# }
|
4754
4754
|
#
|
4755
4755
|
# @!attribute [rw] window_id
|
4756
|
-
# The ID of the
|
4756
|
+
# The ID of the maintenance window to retrieve information about.
|
4757
4757
|
# @return [String]
|
4758
4758
|
#
|
4759
4759
|
# @!attribute [rw] targets
|
@@ -4767,7 +4767,7 @@ module Aws::SSM
|
|
4767
4767
|
#
|
4768
4768
|
# @!attribute [rw] filters
|
4769
4769
|
# Filters used to limit the range of results. For example, you can
|
4770
|
-
# limit
|
4770
|
+
# limit maintenance window executions to only those scheduled before
|
4771
4771
|
# or after a certain date and time.
|
4772
4772
|
# @return [Array<Types::PatchOrchestratorFilter>]
|
4773
4773
|
#
|
@@ -4795,7 +4795,7 @@ module Aws::SSM
|
|
4795
4795
|
end
|
4796
4796
|
|
4797
4797
|
# @!attribute [rw] scheduled_window_executions
|
4798
|
-
# Information about
|
4798
|
+
# Information about maintenance window executions scheduled for the
|
4799
4799
|
# specified time range.
|
4800
4800
|
# @return [Array<Types::ScheduledWindowExecution>]
|
4801
4801
|
#
|
@@ -4828,7 +4828,7 @@ module Aws::SSM
|
|
4828
4828
|
# }
|
4829
4829
|
#
|
4830
4830
|
# @!attribute [rw] window_id
|
4831
|
-
# The ID of the
|
4831
|
+
# The ID of the maintenance window whose targets should be retrieved.
|
4832
4832
|
# @return [String]
|
4833
4833
|
#
|
4834
4834
|
# @!attribute [rw] filters
|
@@ -4859,7 +4859,7 @@ module Aws::SSM
|
|
4859
4859
|
end
|
4860
4860
|
|
4861
4861
|
# @!attribute [rw] targets
|
4862
|
-
# Information about the targets in the
|
4862
|
+
# Information about the targets in the maintenance window.
|
4863
4863
|
# @return [Array<Types::MaintenanceWindowTarget>]
|
4864
4864
|
#
|
4865
4865
|
# @!attribute [rw] next_token
|
@@ -4891,7 +4891,7 @@ module Aws::SSM
|
|
4891
4891
|
# }
|
4892
4892
|
#
|
4893
4893
|
# @!attribute [rw] window_id
|
4894
|
-
# The ID of the
|
4894
|
+
# The ID of the maintenance window whose tasks should be retrieved.
|
4895
4895
|
# @return [String]
|
4896
4896
|
#
|
4897
4897
|
# @!attribute [rw] filters
|
@@ -4922,7 +4922,7 @@ module Aws::SSM
|
|
4922
4922
|
end
|
4923
4923
|
|
4924
4924
|
# @!attribute [rw] tasks
|
4925
|
-
# Information about the tasks in the
|
4925
|
+
# Information about the tasks in the maintenance window.
|
4926
4926
|
# @return [Array<Types::MaintenanceWindowTask>]
|
4927
4927
|
#
|
4928
4928
|
# @!attribute [rw] next_token
|
@@ -4984,7 +4984,7 @@ module Aws::SSM
|
|
4984
4984
|
end
|
4985
4985
|
|
4986
4986
|
# @!attribute [rw] window_identities
|
4987
|
-
# Information about the
|
4987
|
+
# Information about the maintenance window targets and tasks an
|
4988
4988
|
# instance is associated with.
|
4989
4989
|
# @return [Array<Types::MaintenanceWindowIdentityForTarget>]
|
4990
4990
|
#
|
@@ -5017,7 +5017,7 @@ module Aws::SSM
|
|
5017
5017
|
#
|
5018
5018
|
# @!attribute [rw] filters
|
5019
5019
|
# Optional filters used to narrow down the scope of the returned
|
5020
|
-
#
|
5020
|
+
# maintenance windows. Supported filter keys are **Name** and
|
5021
5021
|
# **Enabled**.
|
5022
5022
|
# @return [Array<Types::MaintenanceWindowFilter>]
|
5023
5023
|
#
|
@@ -5042,7 +5042,7 @@ module Aws::SSM
|
|
5042
5042
|
end
|
5043
5043
|
|
5044
5044
|
# @!attribute [rw] window_identities
|
5045
|
-
# Information about the
|
5045
|
+
# Information about the maintenance windows.
|
5046
5046
|
# @return [Array<Types::MaintenanceWindowIdentity>]
|
5047
5047
|
#
|
5048
5048
|
# @!attribute [rw] next_token
|
@@ -5896,7 +5896,7 @@ module Aws::SSM
|
|
5896
5896
|
end
|
5897
5897
|
|
5898
5898
|
# Error returned when the ID specified for a resource, such as a
|
5899
|
-
#
|
5899
|
+
# maintenance window or Patch baseline, doesn't exist.
|
5900
5900
|
#
|
5901
5901
|
# For information about resource limits in Systems Manager, see [AWS
|
5902
5902
|
# Systems Manager Limits][1].
|
@@ -6662,7 +6662,7 @@ module Aws::SSM
|
|
6662
6662
|
# }
|
6663
6663
|
#
|
6664
6664
|
# @!attribute [rw] window_execution_id
|
6665
|
-
# The ID of the
|
6665
|
+
# The ID of the maintenance window execution that includes the task.
|
6666
6666
|
# @return [String]
|
6667
6667
|
#
|
6668
6668
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetMaintenanceWindowExecutionRequest AWS API Documentation
|
@@ -6673,15 +6673,15 @@ module Aws::SSM
|
|
6673
6673
|
end
|
6674
6674
|
|
6675
6675
|
# @!attribute [rw] window_execution_id
|
6676
|
-
# The ID of the
|
6676
|
+
# The ID of the maintenance window execution.
|
6677
6677
|
# @return [String]
|
6678
6678
|
#
|
6679
6679
|
# @!attribute [rw] task_ids
|
6680
|
-
# The ID of the task executions from the
|
6680
|
+
# The ID of the task executions from the maintenance window execution.
|
6681
6681
|
# @return [Array<String>]
|
6682
6682
|
#
|
6683
6683
|
# @!attribute [rw] status
|
6684
|
-
# The status of the
|
6684
|
+
# The status of the maintenance window execution.
|
6685
6685
|
# @return [String]
|
6686
6686
|
#
|
6687
6687
|
# @!attribute [rw] status_details
|
@@ -6690,11 +6690,11 @@ module Aws::SSM
|
|
6690
6690
|
# @return [String]
|
6691
6691
|
#
|
6692
6692
|
# @!attribute [rw] start_time
|
6693
|
-
# The time the
|
6693
|
+
# The time the maintenance window started running.
|
6694
6694
|
# @return [Time]
|
6695
6695
|
#
|
6696
6696
|
# @!attribute [rw] end_time
|
6697
|
-
# The time the
|
6697
|
+
# The time the maintenance window finished running.
|
6698
6698
|
# @return [Time]
|
6699
6699
|
#
|
6700
6700
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetMaintenanceWindowExecutionResult AWS API Documentation
|
@@ -6719,12 +6719,12 @@ module Aws::SSM
|
|
6719
6719
|
# }
|
6720
6720
|
#
|
6721
6721
|
# @!attribute [rw] window_execution_id
|
6722
|
-
# The ID of the
|
6722
|
+
# The ID of the maintenance window execution for which the task is a
|
6723
6723
|
# part.
|
6724
6724
|
# @return [String]
|
6725
6725
|
#
|
6726
6726
|
# @!attribute [rw] task_id
|
6727
|
-
# The ID of the specific task in the
|
6727
|
+
# The ID of the specific task in the maintenance window task that
|
6728
6728
|
# should be retrieved.
|
6729
6729
|
# @return [String]
|
6730
6730
|
#
|
@@ -6742,7 +6742,7 @@ module Aws::SSM
|
|
6742
6742
|
end
|
6743
6743
|
|
6744
6744
|
# @!attribute [rw] window_execution_id
|
6745
|
-
# The
|
6745
|
+
# The maintenance window execution ID.
|
6746
6746
|
# @return [String]
|
6747
6747
|
#
|
6748
6748
|
# @!attribute [rw] task_execution_id
|
@@ -6758,7 +6758,7 @@ module Aws::SSM
|
|
6758
6758
|
# @return [String]
|
6759
6759
|
#
|
6760
6760
|
# @!attribute [rw] task_type
|
6761
|
-
# Retrieves the task type for a
|
6761
|
+
# Retrieves the task type for a maintenance window. Task types include
|
6762
6762
|
# the following: LAMBDA, STEP\_FUNCTION, AUTOMATION, RUN\_COMMAND.
|
6763
6763
|
# @return [String]
|
6764
6764
|
#
|
@@ -6785,11 +6785,11 @@ module Aws::SSM
|
|
6785
6785
|
#
|
6786
6786
|
# @!attribute [rw] owner_information
|
6787
6787
|
# User-provided value to be included in any CloudWatch events raised
|
6788
|
-
# while running tasks for these targets in this
|
6788
|
+
# while running tasks for these targets in this maintenance window.
|
6789
6789
|
# @return [String]
|
6790
6790
|
#
|
6791
6791
|
# @!attribute [rw] window_target_id
|
6792
|
-
# The
|
6792
|
+
# The maintenance window target ID.
|
6793
6793
|
# @return [String]
|
6794
6794
|
#
|
6795
6795
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetMaintenanceWindowExecutionTaskInvocationResult AWS API Documentation
|
@@ -6819,11 +6819,11 @@ module Aws::SSM
|
|
6819
6819
|
# }
|
6820
6820
|
#
|
6821
6821
|
# @!attribute [rw] window_execution_id
|
6822
|
-
# The ID of the
|
6822
|
+
# The ID of the maintenance window execution that includes the task.
|
6823
6823
|
# @return [String]
|
6824
6824
|
#
|
6825
6825
|
# @!attribute [rw] task_id
|
6826
|
-
# The ID of the specific task execution in the
|
6826
|
+
# The ID of the specific task execution in the maintenance window task
|
6827
6827
|
# that should be retrieved.
|
6828
6828
|
# @return [String]
|
6829
6829
|
#
|
@@ -6836,11 +6836,11 @@ module Aws::SSM
|
|
6836
6836
|
end
|
6837
6837
|
|
6838
6838
|
# @!attribute [rw] window_execution_id
|
6839
|
-
# The ID of the
|
6839
|
+
# The ID of the maintenance window execution that includes the task.
|
6840
6840
|
# @return [String]
|
6841
6841
|
#
|
6842
6842
|
# @!attribute [rw] task_execution_id
|
6843
|
-
# The ID of the specific task execution in the
|
6843
|
+
# The ID of the specific task execution in the maintenance window task
|
6844
6844
|
# that was retrieved.
|
6845
6845
|
# @return [String]
|
6846
6846
|
#
|
@@ -6862,8 +6862,8 @@ module Aws::SSM
|
|
6862
6862
|
# <note markdown="1"> `TaskParameters` has been deprecated. To specify parameters to pass
|
6863
6863
|
# to a task when it runs, instead use the `Parameters` option in the
|
6864
6864
|
# `TaskInvocationParameters` structure. For information about how
|
6865
|
-
# Systems Manager handles these options for the supported
|
6866
|
-
#
|
6865
|
+
# Systems Manager handles these options for the supported maintenance
|
6866
|
+
# window task types, see MaintenanceWindowTaskInvocationParameters.
|
6867
6867
|
#
|
6868
6868
|
# </note>
|
6869
6869
|
#
|
@@ -6933,7 +6933,8 @@ module Aws::SSM
|
|
6933
6933
|
# }
|
6934
6934
|
#
|
6935
6935
|
# @!attribute [rw] window_id
|
6936
|
-
# The ID of the
|
6936
|
+
# The ID of the maintenance window for which you want to retrieve
|
6937
|
+
# information.
|
6937
6938
|
# @return [String]
|
6938
6939
|
#
|
6939
6940
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetMaintenanceWindowRequest AWS API Documentation
|
@@ -6944,36 +6945,36 @@ module Aws::SSM
|
|
6944
6945
|
end
|
6945
6946
|
|
6946
6947
|
# @!attribute [rw] window_id
|
6947
|
-
# The ID of the created
|
6948
|
+
# The ID of the created maintenance window.
|
6948
6949
|
# @return [String]
|
6949
6950
|
#
|
6950
6951
|
# @!attribute [rw] name
|
6951
|
-
# The name of the
|
6952
|
+
# The name of the maintenance window.
|
6952
6953
|
# @return [String]
|
6953
6954
|
#
|
6954
6955
|
# @!attribute [rw] description
|
6955
|
-
# The description of the
|
6956
|
+
# The description of the maintenance window.
|
6956
6957
|
# @return [String]
|
6957
6958
|
#
|
6958
6959
|
# @!attribute [rw] start_date
|
6959
6960
|
# The date and time, in ISO-8601 Extended format, for when the
|
6960
|
-
#
|
6961
|
-
#
|
6961
|
+
# maintenance window is scheduled to become active. The maintenance
|
6962
|
+
# window will not run before this specified time.
|
6962
6963
|
# @return [String]
|
6963
6964
|
#
|
6964
6965
|
# @!attribute [rw] end_date
|
6965
6966
|
# The date and time, in ISO-8601 Extended format, for when the
|
6966
|
-
#
|
6967
|
-
#
|
6967
|
+
# maintenance window is scheduled to become inactive. The maintenance
|
6968
|
+
# window will not run after this specified time.
|
6968
6969
|
# @return [String]
|
6969
6970
|
#
|
6970
6971
|
# @!attribute [rw] schedule
|
6971
|
-
# The schedule of the
|
6972
|
+
# The schedule of the maintenance window in the form of a cron or rate
|
6972
6973
|
# expression.
|
6973
6974
|
# @return [String]
|
6974
6975
|
#
|
6975
6976
|
# @!attribute [rw] schedule_timezone
|
6976
|
-
# The time zone that the scheduled
|
6977
|
+
# The time zone that the scheduled maintenance window executions are
|
6977
6978
|
# based on, in Internet Assigned Numbers Authority (IANA) format. For
|
6978
6979
|
# example: "America/Los\_Angeles", "etc/UTC", or "Asia/Seoul".
|
6979
6980
|
# For more information, see the [Time Zone Database][1] on the IANA
|
@@ -6985,35 +6986,35 @@ module Aws::SSM
|
|
6985
6986
|
# @return [String]
|
6986
6987
|
#
|
6987
6988
|
# @!attribute [rw] next_execution_time
|
6988
|
-
# The next time the
|
6989
|
-
# account any specified times for the
|
6989
|
+
# The next time the maintenance window will actually run, taking into
|
6990
|
+
# account any specified times for the maintenance window to become
|
6990
6991
|
# active or inactive.
|
6991
6992
|
# @return [String]
|
6992
6993
|
#
|
6993
6994
|
# @!attribute [rw] duration
|
6994
|
-
# The duration of the
|
6995
|
+
# The duration of the maintenance window in hours.
|
6995
6996
|
# @return [Integer]
|
6996
6997
|
#
|
6997
6998
|
# @!attribute [rw] cutoff
|
6998
|
-
# The number of hours before the end of the
|
6999
|
+
# The number of hours before the end of the maintenance window that
|
6999
7000
|
# Systems Manager stops scheduling new tasks for execution.
|
7000
7001
|
# @return [Integer]
|
7001
7002
|
#
|
7002
7003
|
# @!attribute [rw] allow_unassociated_targets
|
7003
|
-
# Whether targets must be registered with the
|
7004
|
+
# Whether targets must be registered with the maintenance window
|
7004
7005
|
# before tasks can be defined for those targets.
|
7005
7006
|
# @return [Boolean]
|
7006
7007
|
#
|
7007
7008
|
# @!attribute [rw] enabled
|
7008
|
-
#
|
7009
|
+
# Indicates whether the maintenance window is enabled.
|
7009
7010
|
# @return [Boolean]
|
7010
7011
|
#
|
7011
7012
|
# @!attribute [rw] created_date
|
7012
|
-
# The date the
|
7013
|
+
# The date the maintenance window was created.
|
7013
7014
|
# @return [Time]
|
7014
7015
|
#
|
7015
7016
|
# @!attribute [rw] modified_date
|
7016
|
-
# The date the
|
7017
|
+
# The date the maintenance window was last modified.
|
7017
7018
|
# @return [Time]
|
7018
7019
|
#
|
7019
7020
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetMaintenanceWindowResult AWS API Documentation
|
@@ -7045,11 +7046,11 @@ module Aws::SSM
|
|
7045
7046
|
# }
|
7046
7047
|
#
|
7047
7048
|
# @!attribute [rw] window_id
|
7048
|
-
# The
|
7049
|
+
# The maintenance window ID that includes the task to retrieve.
|
7049
7050
|
# @return [String]
|
7050
7051
|
#
|
7051
7052
|
# @!attribute [rw] window_task_id
|
7052
|
-
# The
|
7053
|
+
# The maintenance window task ID to retrieve.
|
7053
7054
|
# @return [String]
|
7054
7055
|
#
|
7055
7056
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetMaintenanceWindowTaskRequest AWS API Documentation
|
@@ -7061,11 +7062,11 @@ module Aws::SSM
|
|
7061
7062
|
end
|
7062
7063
|
|
7063
7064
|
# @!attribute [rw] window_id
|
7064
|
-
# The retrieved
|
7065
|
+
# The retrieved maintenance window ID.
|
7065
7066
|
# @return [String]
|
7066
7067
|
#
|
7067
7068
|
# @!attribute [rw] window_task_id
|
7068
|
-
# The retrieved
|
7069
|
+
# The retrieved maintenance window task ID.
|
7069
7070
|
# @return [String]
|
7070
7071
|
#
|
7071
7072
|
# @!attribute [rw] targets
|
@@ -7081,7 +7082,9 @@ module Aws::SSM
|
|
7081
7082
|
# @return [String]
|
7082
7083
|
#
|
7083
7084
|
# @!attribute [rw] service_role_arn
|
7084
|
-
# The IAM service role to
|
7085
|
+
# The ARN of the IAM service role to use to publish Amazon Simple
|
7086
|
+
# Notification Service (Amazon SNS) notifications for maintenance
|
7087
|
+
# window Run Command tasks.
|
7085
7088
|
# @return [String]
|
7086
7089
|
#
|
7087
7090
|
# @!attribute [rw] task_type
|
@@ -7094,8 +7097,8 @@ module Aws::SSM
|
|
7094
7097
|
# <note markdown="1"> `TaskParameters` has been deprecated. To specify parameters to pass
|
7095
7098
|
# to a task when it runs, instead use the `Parameters` option in the
|
7096
7099
|
# `TaskInvocationParameters` structure. For information about how
|
7097
|
-
# Systems Manager handles these options for the supported
|
7098
|
-
#
|
7100
|
+
# Systems Manager handles these options for the supported maintenance
|
7101
|
+
# window task types, see MaintenanceWindowTaskInvocationParameters.
|
7099
7102
|
#
|
7100
7103
|
# </note>
|
7101
7104
|
# @return [Hash<String,Types::MaintenanceWindowTaskParameterValueExpression>]
|
@@ -7126,7 +7129,7 @@ module Aws::SSM
|
|
7126
7129
|
# contain logs, instead use the `OutputS3BucketName` and
|
7127
7130
|
# `OutputS3KeyPrefix` options in the `TaskInvocationParameters`
|
7128
7131
|
# structure. For information about how Systems Manager handles these
|
7129
|
-
# options for the supported
|
7132
|
+
# options for the supported maintenance window task types, see
|
7130
7133
|
# MaintenanceWindowTaskInvocationParameters.
|
7131
7134
|
#
|
7132
7135
|
# </note>
|
@@ -7373,7 +7376,7 @@ module Aws::SSM
|
|
7373
7376
|
#
|
7374
7377
|
# @!attribute [rw] invalid_parameters
|
7375
7378
|
# A list of parameters that are not formatted correctly or do not run
|
7376
|
-
#
|
7379
|
+
# during an execution.
|
7377
7380
|
# @return [Array<String>]
|
7378
7381
|
#
|
7379
7382
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetParametersResult AWS API Documentation
|
@@ -7742,7 +7745,7 @@ module Aws::SSM
|
|
7742
7745
|
# @return [String]
|
7743
7746
|
#
|
7744
7747
|
# @!attribute [rw] document_version
|
7745
|
-
# The association document
|
7748
|
+
# The association document versions.
|
7746
7749
|
# @return [String]
|
7747
7750
|
#
|
7748
7751
|
# @!attribute [rw] association_version
|
@@ -8285,7 +8288,7 @@ module Aws::SSM
|
|
8285
8288
|
end
|
8286
8289
|
|
8287
8290
|
# The ID specified for the delete operation does not exist or is not
|
8288
|
-
#
|
8291
|
+
# valid. Verify the ID and try again.
|
8289
8292
|
#
|
8290
8293
|
# @!attribute [rw] message
|
8291
8294
|
# @return [String]
|
@@ -8777,7 +8780,7 @@ module Aws::SSM
|
|
8777
8780
|
#
|
8778
8781
|
#
|
8779
8782
|
#
|
8780
|
-
# [1]: http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-
|
8783
|
+
# [1]: http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-custom.html#sysman-inventory-delete
|
8781
8784
|
# @return [Types::InventoryDeletionSummary]
|
8782
8785
|
#
|
8783
8786
|
# @!attribute [rw] last_status_update_time
|
@@ -9914,7 +9917,7 @@ module Aws::SSM
|
|
9914
9917
|
# logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix`
|
9915
9918
|
# options in the `TaskInvocationParameters` structure. For information
|
9916
9919
|
# about how Systems Manager handles these options for the supported
|
9917
|
-
#
|
9920
|
+
# maintenance window task types, see
|
9918
9921
|
# MaintenanceWindowTaskInvocationParameters.
|
9919
9922
|
#
|
9920
9923
|
# </note>
|
@@ -9975,14 +9978,14 @@ module Aws::SSM
|
|
9975
9978
|
# contain logs, instead use the `OutputS3BucketName` and
|
9976
9979
|
# `OutputS3KeyPrefix` options in the `TaskInvocationParameters`
|
9977
9980
|
# structure. For information about how Systems Manager handles these
|
9978
|
-
# options for the supported
|
9981
|
+
# options for the supported maintenance window task types, see
|
9979
9982
|
# MaintenanceWindowTaskInvocationParameters.
|
9980
9983
|
#
|
9981
9984
|
# `TaskParameters` has been deprecated. To specify parameters to pass
|
9982
9985
|
# to a task when it runs, instead use the `Parameters` option in the
|
9983
9986
|
# `TaskInvocationParameters` structure. For information about how
|
9984
|
-
# Systems Manager handles these options for the supported
|
9985
|
-
#
|
9987
|
+
# Systems Manager handles these options for the supported maintenance
|
9988
|
+
# window task types, see MaintenanceWindowTaskInvocationParameters.
|
9986
9989
|
#
|
9987
9990
|
# For AUTOMATION task types, Systems Manager ignores any values
|
9988
9991
|
# specified for these parameters.
|
@@ -9998,14 +10001,14 @@ module Aws::SSM
|
|
9998
10001
|
include Aws::Structure
|
9999
10002
|
end
|
10000
10003
|
|
10001
|
-
# Describes the information about an execution of a
|
10004
|
+
# Describes the information about an execution of a maintenance window.
|
10002
10005
|
#
|
10003
10006
|
# @!attribute [rw] window_id
|
10004
|
-
# The ID of the
|
10007
|
+
# The ID of the maintenance window.
|
10005
10008
|
# @return [String]
|
10006
10009
|
#
|
10007
10010
|
# @!attribute [rw] window_execution_id
|
10008
|
-
# The ID of the
|
10011
|
+
# The ID of the maintenance window execution.
|
10009
10012
|
# @return [String]
|
10010
10013
|
#
|
10011
10014
|
# @!attribute [rw] status
|
@@ -10037,15 +10040,15 @@ module Aws::SSM
|
|
10037
10040
|
include Aws::Structure
|
10038
10041
|
end
|
10039
10042
|
|
10040
|
-
# Information about a task execution performed as part of a
|
10041
|
-
#
|
10043
|
+
# Information about a task execution performed as part of a maintenance
|
10044
|
+
# window execution.
|
10042
10045
|
#
|
10043
10046
|
# @!attribute [rw] window_execution_id
|
10044
|
-
# The ID of the
|
10047
|
+
# The ID of the maintenance window execution that ran the task.
|
10045
10048
|
# @return [String]
|
10046
10049
|
#
|
10047
10050
|
# @!attribute [rw] task_execution_id
|
10048
|
-
# The ID of the specific task execution in the
|
10051
|
+
# The ID of the specific task execution in the maintenance window
|
10049
10052
|
# execution.
|
10050
10053
|
# @return [String]
|
10051
10054
|
#
|
@@ -10089,15 +10092,15 @@ module Aws::SSM
|
|
10089
10092
|
end
|
10090
10093
|
|
10091
10094
|
# Describes the information about a task invocation for a particular
|
10092
|
-
# target as part of a task execution performed as part of a
|
10093
|
-
#
|
10095
|
+
# target as part of a task execution performed as part of a maintenance
|
10096
|
+
# window execution.
|
10094
10097
|
#
|
10095
10098
|
# @!attribute [rw] window_execution_id
|
10096
|
-
# The ID of the
|
10099
|
+
# The ID of the maintenance window execution that ran the task.
|
10097
10100
|
# @return [String]
|
10098
10101
|
#
|
10099
10102
|
# @!attribute [rw] task_execution_id
|
10100
|
-
# The ID of the specific task execution in the
|
10103
|
+
# The ID of the specific task execution in the maintenance window
|
10101
10104
|
# execution.
|
10102
10105
|
# @return [String]
|
10103
10106
|
#
|
@@ -10139,12 +10142,12 @@ module Aws::SSM
|
|
10139
10142
|
#
|
10140
10143
|
# @!attribute [rw] owner_information
|
10141
10144
|
# User-provided value that was specified when the target was
|
10142
|
-
# registered with the
|
10145
|
+
# registered with the maintenance window. This was also included in
|
10143
10146
|
# any CloudWatch events raised during the task invocation.
|
10144
10147
|
# @return [String]
|
10145
10148
|
#
|
10146
10149
|
# @!attribute [rw] window_target_id
|
10147
|
-
# The ID of the target definition in this
|
10150
|
+
# The ID of the target definition in this maintenance window the
|
10148
10151
|
# invocation was performed for.
|
10149
10152
|
# @return [String]
|
10150
10153
|
#
|
@@ -10193,56 +10196,56 @@ module Aws::SSM
|
|
10193
10196
|
include Aws::Structure
|
10194
10197
|
end
|
10195
10198
|
|
10196
|
-
# Information about the
|
10199
|
+
# Information about the maintenance window.
|
10197
10200
|
#
|
10198
10201
|
# @!attribute [rw] window_id
|
10199
|
-
# The ID of the
|
10202
|
+
# The ID of the maintenance window.
|
10200
10203
|
# @return [String]
|
10201
10204
|
#
|
10202
10205
|
# @!attribute [rw] name
|
10203
|
-
# The name of the
|
10206
|
+
# The name of the maintenance window.
|
10204
10207
|
# @return [String]
|
10205
10208
|
#
|
10206
10209
|
# @!attribute [rw] description
|
10207
|
-
# A description of the
|
10210
|
+
# A description of the maintenance window.
|
10208
10211
|
# @return [String]
|
10209
10212
|
#
|
10210
10213
|
# @!attribute [rw] enabled
|
10211
|
-
#
|
10214
|
+
# Indicates whether the maintenance window is enabled.
|
10212
10215
|
# @return [Boolean]
|
10213
10216
|
#
|
10214
10217
|
# @!attribute [rw] duration
|
10215
|
-
# The duration of the
|
10218
|
+
# The duration of the maintenance window in hours.
|
10216
10219
|
# @return [Integer]
|
10217
10220
|
#
|
10218
10221
|
# @!attribute [rw] cutoff
|
10219
|
-
# The number of hours before the end of the
|
10222
|
+
# The number of hours before the end of the maintenance window that
|
10220
10223
|
# Systems Manager stops scheduling new tasks for execution.
|
10221
10224
|
# @return [Integer]
|
10222
10225
|
#
|
10223
10226
|
# @!attribute [rw] schedule
|
10224
|
-
# The schedule of the
|
10227
|
+
# The schedule of the maintenance window in the form of a cron or rate
|
10225
10228
|
# expression.
|
10226
10229
|
# @return [String]
|
10227
10230
|
#
|
10228
10231
|
# @!attribute [rw] schedule_timezone
|
10229
|
-
# The time zone that the scheduled
|
10232
|
+
# The time zone that the scheduled maintenance window executions are
|
10230
10233
|
# based on, in Internet Assigned Numbers Authority (IANA) format.
|
10231
10234
|
# @return [String]
|
10232
10235
|
#
|
10233
10236
|
# @!attribute [rw] end_date
|
10234
10237
|
# The date and time, in ISO-8601 Extended format, for when the
|
10235
|
-
#
|
10238
|
+
# maintenance window is scheduled to become inactive.
|
10236
10239
|
# @return [String]
|
10237
10240
|
#
|
10238
10241
|
# @!attribute [rw] start_date
|
10239
10242
|
# The date and time, in ISO-8601 Extended format, for when the
|
10240
|
-
#
|
10243
|
+
# maintenance window is scheduled to become active.
|
10241
10244
|
# @return [String]
|
10242
10245
|
#
|
10243
10246
|
# @!attribute [rw] next_execution_time
|
10244
|
-
# The next time the
|
10245
|
-
# account any specified times for the
|
10247
|
+
# The next time the maintenance window will actually run, taking into
|
10248
|
+
# account any specified times for the maintenance window to become
|
10246
10249
|
# active or inactive.
|
10247
10250
|
# @return [String]
|
10248
10251
|
#
|
@@ -10263,14 +10266,14 @@ module Aws::SSM
|
|
10263
10266
|
include Aws::Structure
|
10264
10267
|
end
|
10265
10268
|
|
10266
|
-
# The
|
10269
|
+
# The maintenance window to which the specified target belongs.
|
10267
10270
|
#
|
10268
10271
|
# @!attribute [rw] window_id
|
10269
|
-
# The ID of the
|
10272
|
+
# The ID of the maintenance window.
|
10270
10273
|
# @return [String]
|
10271
10274
|
#
|
10272
10275
|
# @!attribute [rw] name
|
10273
|
-
# The name of the
|
10276
|
+
# The name of the maintenance window.
|
10274
10277
|
# @return [String]
|
10275
10278
|
#
|
10276
10279
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/MaintenanceWindowIdentityForTarget AWS API Documentation
|
@@ -10290,14 +10293,14 @@ module Aws::SSM
|
|
10290
10293
|
# logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix`
|
10291
10294
|
# options in the `TaskInvocationParameters` structure. For information
|
10292
10295
|
# about how Systems Manager handles these options for the supported
|
10293
|
-
#
|
10296
|
+
# maintenance window task types, see
|
10294
10297
|
# MaintenanceWindowTaskInvocationParameters.
|
10295
10298
|
#
|
10296
10299
|
# `TaskParameters` has been deprecated. To specify parameters to pass to
|
10297
10300
|
# a task when it runs, instead use the `Parameters` option in the
|
10298
10301
|
# `TaskInvocationParameters` structure. For information about how
|
10299
|
-
# Systems Manager handles these options for the supported
|
10300
|
-
#
|
10302
|
+
# Systems Manager handles these options for the supported maintenance
|
10303
|
+
# window task types, see MaintenanceWindowTaskInvocationParameters.
|
10301
10304
|
#
|
10302
10305
|
# For Lambda tasks, Systems Manager ignores any values specified for
|
10303
10306
|
# TaskParameters and LoggingInfo.
|
@@ -10349,14 +10352,14 @@ module Aws::SSM
|
|
10349
10352
|
# logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix`
|
10350
10353
|
# options in the `TaskInvocationParameters` structure. For information
|
10351
10354
|
# about how Systems Manager handles these options for the supported
|
10352
|
-
#
|
10355
|
+
# maintenance window task types, see
|
10353
10356
|
# MaintenanceWindowTaskInvocationParameters.
|
10354
10357
|
#
|
10355
10358
|
# `TaskParameters` has been deprecated. To specify parameters to pass to
|
10356
10359
|
# a task when it runs, instead use the `Parameters` option in the
|
10357
10360
|
# `TaskInvocationParameters` structure. For information about how
|
10358
|
-
# Systems Manager handles these options for the supported
|
10359
|
-
#
|
10361
|
+
# Systems Manager handles these options for the supported maintenance
|
10362
|
+
# window task types, see MaintenanceWindowTaskInvocationParameters.
|
10360
10363
|
#
|
10361
10364
|
# For Run Command tasks, Systems Manager uses specified values for
|
10362
10365
|
# `TaskParameters` and `LoggingInfo` only if no values are specified for
|
@@ -10386,7 +10389,7 @@ module Aws::SSM
|
|
10386
10389
|
# }
|
10387
10390
|
#
|
10388
10391
|
# @!attribute [rw] comment
|
10389
|
-
# Information about the
|
10392
|
+
# Information about the commands to run.
|
10390
10393
|
# @return [String]
|
10391
10394
|
#
|
10392
10395
|
# @!attribute [rw] document_hash
|
@@ -10416,7 +10419,9 @@ module Aws::SSM
|
|
10416
10419
|
# @return [Hash<String,Array<String>>]
|
10417
10420
|
#
|
10418
10421
|
# @!attribute [rw] service_role_arn
|
10419
|
-
# The IAM service role to
|
10422
|
+
# The ARN of the IAM service role to use to publish Amazon Simple
|
10423
|
+
# Notification Service (Amazon SNS) notifications for maintenance
|
10424
|
+
# window Run Command tasks.
|
10420
10425
|
# @return [String]
|
10421
10426
|
#
|
10422
10427
|
# @!attribute [rw] timeout_seconds
|
@@ -10448,14 +10453,14 @@ module Aws::SSM
|
|
10448
10453
|
# logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix`
|
10449
10454
|
# options in the `TaskInvocationParameters` structure. For information
|
10450
10455
|
# about how Systems Manager handles these options for the supported
|
10451
|
-
#
|
10456
|
+
# maintenance window task types, see
|
10452
10457
|
# MaintenanceWindowTaskInvocationParameters.
|
10453
10458
|
#
|
10454
10459
|
# `TaskParameters` has been deprecated. To specify parameters to pass to
|
10455
10460
|
# a task when it runs, instead use the `Parameters` option in the
|
10456
10461
|
# `TaskInvocationParameters` structure. For information about how
|
10457
|
-
# Systems Manager handles these options for the supported
|
10458
|
-
#
|
10462
|
+
# Systems Manager handles these options for the supported maintenance
|
10463
|
+
# window task types, see MaintenanceWindowTaskInvocationParameters.
|
10459
10464
|
#
|
10460
10465
|
# For Step Functions tasks, Systems Manager ignores any values specified
|
10461
10466
|
# for `TaskParameters` and `LoggingInfo`.
|
@@ -10486,10 +10491,10 @@ module Aws::SSM
|
|
10486
10491
|
include Aws::Structure
|
10487
10492
|
end
|
10488
10493
|
|
10489
|
-
# The target registered with the
|
10494
|
+
# The target registered with the maintenance window.
|
10490
10495
|
#
|
10491
10496
|
# @!attribute [rw] window_id
|
10492
|
-
# The ID of the
|
10497
|
+
# The ID of the maintenance window to register the target with.
|
10493
10498
|
# @return [String]
|
10494
10499
|
#
|
10495
10500
|
# @!attribute [rw] window_target_id
|
@@ -10497,8 +10502,8 @@ module Aws::SSM
|
|
10497
10502
|
# @return [String]
|
10498
10503
|
#
|
10499
10504
|
# @!attribute [rw] resource_type
|
10500
|
-
# The type of target that is being registered with the
|
10501
|
-
#
|
10505
|
+
# The type of target that is being registered with the maintenance
|
10506
|
+
# window.
|
10502
10507
|
# @return [String]
|
10503
10508
|
#
|
10504
10509
|
# @!attribute [rw] targets
|
@@ -10516,11 +10521,11 @@ module Aws::SSM
|
|
10516
10521
|
# @!attribute [rw] owner_information
|
10517
10522
|
# A user-provided value that will be included in any CloudWatch events
|
10518
10523
|
# that are raised while running tasks for these targets in this
|
10519
|
-
#
|
10524
|
+
# maintenance window.
|
10520
10525
|
# @return [String]
|
10521
10526
|
#
|
10522
10527
|
# @!attribute [rw] name
|
10523
|
-
# The target
|
10528
|
+
# The name for the maintenance window target.
|
10524
10529
|
# @return [String]
|
10525
10530
|
#
|
10526
10531
|
# @!attribute [rw] description
|
@@ -10540,10 +10545,10 @@ module Aws::SSM
|
|
10540
10545
|
include Aws::Structure
|
10541
10546
|
end
|
10542
10547
|
|
10543
|
-
# Information about a task defined for a
|
10548
|
+
# Information about a task defined for a maintenance window.
|
10544
10549
|
#
|
10545
10550
|
# @!attribute [rw] window_id
|
10546
|
-
# The ID of the
|
10551
|
+
# The ID of the maintenance window where the task is registered.
|
10547
10552
|
# @return [String]
|
10548
10553
|
#
|
10549
10554
|
# @!attribute [rw] window_task_id
|
@@ -10575,14 +10580,14 @@ module Aws::SSM
|
|
10575
10580
|
# <note markdown="1"> `TaskParameters` has been deprecated. To specify parameters to pass
|
10576
10581
|
# to a task when it runs, instead use the `Parameters` option in the
|
10577
10582
|
# `TaskInvocationParameters` structure. For information about how
|
10578
|
-
# Systems Manager handles these options for the supported
|
10579
|
-
#
|
10583
|
+
# Systems Manager handles these options for the supported maintenance
|
10584
|
+
# window task types, see MaintenanceWindowTaskInvocationParameters.
|
10580
10585
|
#
|
10581
10586
|
# </note>
|
10582
10587
|
# @return [Hash<String,Types::MaintenanceWindowTaskParameterValueExpression>]
|
10583
10588
|
#
|
10584
10589
|
# @!attribute [rw] priority
|
10585
|
-
# The priority of the task in the
|
10590
|
+
# The priority of the task in the maintenance window. The lower the
|
10586
10591
|
# number, the higher the priority. Tasks that have the same priority
|
10587
10592
|
# are scheduled in parallel.
|
10588
10593
|
# @return [Integer]
|
@@ -10594,14 +10599,16 @@ module Aws::SSM
|
|
10594
10599
|
# contain logs, instead use the `OutputS3BucketName` and
|
10595
10600
|
# `OutputS3KeyPrefix` options in the `TaskInvocationParameters`
|
10596
10601
|
# structure. For information about how Systems Manager handles these
|
10597
|
-
# options for the supported
|
10602
|
+
# options for the supported maintenance window task types, see
|
10598
10603
|
# MaintenanceWindowTaskInvocationParameters.
|
10599
10604
|
#
|
10600
10605
|
# </note>
|
10601
10606
|
# @return [Types::LoggingInfo]
|
10602
10607
|
#
|
10603
10608
|
# @!attribute [rw] service_role_arn
|
10604
|
-
# The
|
10609
|
+
# The ARN of the IAM service role to use to publish Amazon Simple
|
10610
|
+
# Notification Service (Amazon SNS) notifications for maintenance
|
10611
|
+
# window Run Command tasks.
|
10605
10612
|
# @return [String]
|
10606
10613
|
#
|
10607
10614
|
# @!attribute [rw] max_concurrency
|
@@ -10816,21 +10823,21 @@ module Aws::SSM
|
|
10816
10823
|
# }
|
10817
10824
|
#
|
10818
10825
|
# @!attribute [rw] notification_arn
|
10819
|
-
# An Amazon Resource Name (ARN) for
|
10820
|
-
# (SNS) topic. Run Command pushes notifications about
|
10821
|
-
# changes to this topic.
|
10826
|
+
# An Amazon Resource Name (ARN) for an Amazon Simple Notification
|
10827
|
+
# Service (Amazon SNS) topic. Run Command pushes notifications about
|
10828
|
+
# command status changes to this topic.
|
10822
10829
|
# @return [String]
|
10823
10830
|
#
|
10824
10831
|
# @!attribute [rw] notification_events
|
10825
10832
|
# The different events for which you can receive notifications. These
|
10826
10833
|
# events include the following: All (events), InProgress, Success,
|
10827
10834
|
# TimedOut, Cancelled, Failed. To learn more about these events, see
|
10828
|
-
# [Configuring Amazon SNS Notifications for
|
10829
|
-
# *AWS Systems Manager User Guide*.
|
10835
|
+
# [Configuring Amazon SNS Notifications for AWS Systems Manager][1] in
|
10836
|
+
# the *AWS Systems Manager User Guide*.
|
10830
10837
|
#
|
10831
10838
|
#
|
10832
10839
|
#
|
10833
|
-
# [1]: http://docs.aws.amazon.com/systems-manager/latest/userguide/
|
10840
|
+
# [1]: http://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html
|
10834
10841
|
# @return [Array<String>]
|
10835
10842
|
#
|
10836
10843
|
# @!attribute [rw] notification_type
|
@@ -10991,6 +10998,13 @@ module Aws::SSM
|
|
10991
10998
|
#
|
10992
10999
|
# @!attribute [rw] policies
|
10993
11000
|
# Information about the policies assigned to a parameter.
|
11001
|
+
#
|
11002
|
+
# [Working with Parameter Policies][1] in the *AWS Systems Manager
|
11003
|
+
# User Guide*.
|
11004
|
+
#
|
11005
|
+
#
|
11006
|
+
#
|
11007
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html
|
10994
11008
|
# @return [Array<Types::ParameterInlinePolicy>]
|
10995
11009
|
#
|
10996
11010
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ParameterHistory AWS API Documentation
|
@@ -11063,7 +11077,7 @@ module Aws::SSM
|
|
11063
11077
|
include Aws::Structure
|
11064
11078
|
end
|
11065
11079
|
|
11066
|
-
#
|
11080
|
+
# Metadata includes information like the ARN of the last user and the
|
11067
11081
|
# date/time the parameter was last used.
|
11068
11082
|
#
|
11069
11083
|
# @!attribute [rw] name
|
@@ -12184,32 +12198,46 @@ module Aws::SSM
|
|
12184
12198
|
# }
|
12185
12199
|
#
|
12186
12200
|
# @!attribute [rw] window_id
|
12187
|
-
# The ID of the
|
12201
|
+
# The ID of the maintenance window the target should be registered
|
12188
12202
|
# with.
|
12189
12203
|
# @return [String]
|
12190
12204
|
#
|
12191
12205
|
# @!attribute [rw] resource_type
|
12192
|
-
# The type of target being registered with the
|
12206
|
+
# The type of target being registered with the maintenance window.
|
12193
12207
|
# @return [String]
|
12194
12208
|
#
|
12195
12209
|
# @!attribute [rw] targets
|
12196
|
-
# The targets
|
12210
|
+
# The targets to register with the maintenance window. In other words,
|
12211
|
+
# the instances to run commands on when the maintenance window runs.
|
12197
12212
|
#
|
12198
|
-
#
|
12213
|
+
# You can specify targets using either instance IDs or tags that have
|
12214
|
+
# been applied to instances.
|
12199
12215
|
#
|
12200
|
-
#
|
12216
|
+
# **Example 1**\: Specify instance IDs
|
12217
|
+
#
|
12218
|
+
# `Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3 `
|
12219
|
+
#
|
12220
|
+
# **Example 2**\: Use tag key-pairs applied to instances
|
12221
|
+
#
|
12222
|
+
# `Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2 `
|
12223
|
+
#
|
12224
|
+
# **Example 3**\: Use tag-keys applied to instances
|
12201
12225
|
#
|
12202
|
-
#
|
12226
|
+
# `Key=tag-key,Values=my-tag-key-1,my-tag-key-2 `
|
12203
12227
|
#
|
12204
|
-
#
|
12228
|
+
# For more information about these examples formats, including the
|
12229
|
+
# best use case for each one, see [Examples: Register Targets with a
|
12230
|
+
# Maintenance Window][1] in the *AWS Systems Manager User Guide*.
|
12205
12231
|
#
|
12206
|
-
#
|
12232
|
+
#
|
12233
|
+
#
|
12234
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html
|
12207
12235
|
# @return [Array<Types::Target>]
|
12208
12236
|
#
|
12209
12237
|
# @!attribute [rw] owner_information
|
12210
12238
|
# User-provided value that will be included in any CloudWatch events
|
12211
|
-
# raised while running tasks for these targets in this
|
12212
|
-
#
|
12239
|
+
# raised while running tasks for these targets in this maintenance
|
12240
|
+
# window.
|
12213
12241
|
# @return [String]
|
12214
12242
|
#
|
12215
12243
|
# @!attribute [rw] name
|
@@ -12241,7 +12269,7 @@ module Aws::SSM
|
|
12241
12269
|
end
|
12242
12270
|
|
12243
12271
|
# @!attribute [rw] window_target_id
|
12244
|
-
# The ID of the target definition in this
|
12272
|
+
# The ID of the target definition in this maintenance window.
|
12245
12273
|
# @return [String]
|
12246
12274
|
#
|
12247
12275
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/RegisterTargetWithMaintenanceWindowResult AWS API Documentation
|
@@ -12318,17 +12346,17 @@ module Aws::SSM
|
|
12318
12346
|
# }
|
12319
12347
|
#
|
12320
12348
|
# @!attribute [rw] window_id
|
12321
|
-
# The ID of the
|
12349
|
+
# The ID of the maintenance window the task should be added to.
|
12322
12350
|
# @return [String]
|
12323
12351
|
#
|
12324
12352
|
# @!attribute [rw] targets
|
12325
|
-
# The targets (either instances or
|
12353
|
+
# The targets (either instances or maintenance window targets).
|
12326
12354
|
#
|
12327
12355
|
# Specify instances using the following format:
|
12328
12356
|
#
|
12329
12357
|
# `Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>`
|
12330
12358
|
#
|
12331
|
-
# Specify
|
12359
|
+
# Specify maintenance window targets using the following format:
|
12332
12360
|
#
|
12333
12361
|
# `Key=<WindowTargetIds>,Values=<window-target-id-1>,<window-target-id-2>`
|
12334
12362
|
# @return [Array<Types::Target>]
|
@@ -12338,19 +12366,20 @@ module Aws::SSM
|
|
12338
12366
|
# @return [String]
|
12339
12367
|
#
|
12340
12368
|
# @!attribute [rw] service_role_arn
|
12341
|
-
# The
|
12342
|
-
#
|
12343
|
-
#
|
12344
|
-
# your account's service-linked role for Systems Manager by default.
|
12369
|
+
# The ARN of the IAM service role for Systems Manager to assume when
|
12370
|
+
# running a maintenance window task. If you do not specify a service
|
12371
|
+
# role ARN, Systems Manager uses your account's service-linked role.
|
12345
12372
|
# If no service-linked role for Systems Manager exists in your
|
12346
|
-
# account, it
|
12347
|
-
# `RegisterTaskWithMaintenanceWindow
|
12348
|
-
# role ARN.
|
12373
|
+
# account, it is created when you run
|
12374
|
+
# `RegisterTaskWithMaintenanceWindow`.
|
12349
12375
|
#
|
12350
|
-
# For more information, see
|
12351
|
-
# Systems Manager
|
12352
|
-
#
|
12353
|
-
# *
|
12376
|
+
# For more information, see the following topics in the in the *AWS
|
12377
|
+
# Systems Manager User Guide*\:
|
12378
|
+
#
|
12379
|
+
# * [Service-Linked Role Permissions for Systems Manager][1]
|
12380
|
+
#
|
12381
|
+
# * [Should I Use a Service-Linked Role or a Custom Service Role to
|
12382
|
+
# Run Maintenance Window Tasks? ][2]
|
12354
12383
|
#
|
12355
12384
|
#
|
12356
12385
|
#
|
@@ -12368,8 +12397,8 @@ module Aws::SSM
|
|
12368
12397
|
# <note markdown="1"> `TaskParameters` has been deprecated. To specify parameters to pass
|
12369
12398
|
# to a task when it runs, instead use the `Parameters` option in the
|
12370
12399
|
# `TaskInvocationParameters` structure. For information about how
|
12371
|
-
# Systems Manager handles these options for the supported
|
12372
|
-
#
|
12400
|
+
# Systems Manager handles these options for the supported maintenance
|
12401
|
+
# window task types, see MaintenanceWindowTaskInvocationParameters.
|
12373
12402
|
#
|
12374
12403
|
# </note>
|
12375
12404
|
# @return [Hash<String,Types::MaintenanceWindowTaskParameterValueExpression>]
|
@@ -12381,8 +12410,8 @@ module Aws::SSM
|
|
12381
12410
|
# @return [Types::MaintenanceWindowTaskInvocationParameters]
|
12382
12411
|
#
|
12383
12412
|
# @!attribute [rw] priority
|
12384
|
-
# The priority of the task in the
|
12385
|
-
# number the higher the priority. Tasks in a
|
12413
|
+
# The priority of the task in the maintenance window, the lower the
|
12414
|
+
# number the higher the priority. Tasks in a maintenance window are
|
12386
12415
|
# scheduled in priority order with tasks that have the same priority
|
12387
12416
|
# scheduled in parallel.
|
12388
12417
|
# @return [Integer]
|
@@ -12404,7 +12433,7 @@ module Aws::SSM
|
|
12404
12433
|
# contain logs, instead use the `OutputS3BucketName` and
|
12405
12434
|
# `OutputS3KeyPrefix` options in the `TaskInvocationParameters`
|
12406
12435
|
# structure. For information about how Systems Manager handles these
|
12407
|
-
# options for the supported
|
12436
|
+
# options for the supported maintenance window task types, see
|
12408
12437
|
# MaintenanceWindowTaskInvocationParameters.
|
12409
12438
|
#
|
12410
12439
|
# </note>
|
@@ -12446,7 +12475,7 @@ module Aws::SSM
|
|
12446
12475
|
end
|
12447
12476
|
|
12448
12477
|
# @!attribute [rw] window_task_id
|
12449
|
-
# The ID of the task in the
|
12478
|
+
# The ID of the task in the maintenance window.
|
12450
12479
|
# @return [String]
|
12451
12480
|
#
|
12452
12481
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/RegisterTaskWithMaintenanceWindowResult AWS API Documentation
|
@@ -12469,8 +12498,8 @@ module Aws::SSM
|
|
12469
12498
|
# The type of resource of which you want to remove a tag.
|
12470
12499
|
#
|
12471
12500
|
# <note markdown="1"> The ManagedInstance type for this API action is only for on-premises
|
12472
|
-
# managed instances. You must specify the
|
12473
|
-
#
|
12501
|
+
# managed instances. You must specify the name of the managed instance
|
12502
|
+
# in the following format: mi-ID\_number. For example,
|
12474
12503
|
# mi-1a2b3c4d5e6f.
|
12475
12504
|
#
|
12476
12505
|
# </note>
|
@@ -12489,8 +12518,8 @@ module Aws::SSM
|
|
12489
12518
|
# For the Document and Parameter values, use the name of the resource.
|
12490
12519
|
#
|
12491
12520
|
# <note markdown="1"> The ManagedInstance type for this API action is only for on-premises
|
12492
|
-
# managed instances. You must specify the
|
12493
|
-
#
|
12521
|
+
# managed instances. You must specify the name of the managed instance
|
12522
|
+
# in the following format: mi-ID\_number. For example,
|
12494
12523
|
# mi-1a2b3c4d5e6f.
|
12495
12524
|
#
|
12496
12525
|
# </note>
|
@@ -12745,7 +12774,7 @@ module Aws::SSM
|
|
12745
12774
|
#
|
12746
12775
|
# @!attribute [rw] awskms_key_arn
|
12747
12776
|
# The ARN of an encryption key for a destination in Amazon S3. Must
|
12748
|
-
# belong to the same
|
12777
|
+
# belong to the same Region as the destination Amazon S3 bucket.
|
12749
12778
|
# @return [String]
|
12750
12779
|
#
|
12751
12780
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ResourceDataSyncS3Destination AWS API Documentation
|
@@ -12773,7 +12802,7 @@ module Aws::SSM
|
|
12773
12802
|
end
|
12774
12803
|
|
12775
12804
|
# Error returned when the caller has exceeded the default resource
|
12776
|
-
# limits. For example, too many
|
12805
|
+
# limits. For example, too many maintenance windows or patch baselines
|
12777
12806
|
# have been created.
|
12778
12807
|
#
|
12779
12808
|
# For information about resource limits in Systems Manager, see [AWS
|
@@ -12920,18 +12949,18 @@ module Aws::SSM
|
|
12920
12949
|
include Aws::Structure
|
12921
12950
|
end
|
12922
12951
|
|
12923
|
-
# Information about a scheduled execution for a
|
12952
|
+
# Information about a scheduled execution for a maintenance window.
|
12924
12953
|
#
|
12925
12954
|
# @!attribute [rw] window_id
|
12926
|
-
# The ID of the
|
12955
|
+
# The ID of the maintenance window to be run.
|
12927
12956
|
# @return [String]
|
12928
12957
|
#
|
12929
12958
|
# @!attribute [rw] name
|
12930
|
-
# The name of the
|
12959
|
+
# The name of the maintenance window to be run.
|
12931
12960
|
# @return [String]
|
12932
12961
|
#
|
12933
12962
|
# @!attribute [rw] execution_time
|
12934
|
-
# The time, in ISO-8601 Extended format, that the
|
12963
|
+
# The time, in ISO-8601 Extended format, that the maintenance window
|
12935
12964
|
# is scheduled to be run.
|
12936
12965
|
# @return [String]
|
12937
12966
|
#
|
@@ -12961,13 +12990,27 @@ module Aws::SSM
|
|
12961
12990
|
# @return [String]
|
12962
12991
|
#
|
12963
12992
|
# @!attribute [rw] signal_type
|
12964
|
-
# The type of signal
|
12965
|
-
# Approve and Reject
|
12993
|
+
# The type of signal to send to an Automation execution.
|
12966
12994
|
# @return [String]
|
12967
12995
|
#
|
12968
12996
|
# @!attribute [rw] payload
|
12969
12997
|
# The data sent with the signal. The data schema depends on the type
|
12970
12998
|
# of signal used in the request.
|
12999
|
+
#
|
13000
|
+
# For `Approve` and `Reject` signal types, the payload is an optional
|
13001
|
+
# comment that you can send with the signal type. For example:
|
13002
|
+
#
|
13003
|
+
# `Comment="Looks good"`
|
13004
|
+
#
|
13005
|
+
# For `StartStep` and `Resume` signal types, you must send the name of
|
13006
|
+
# the Automation step to start or resume as the payload. For example:
|
13007
|
+
#
|
13008
|
+
# `StepName="step1"`
|
13009
|
+
#
|
13010
|
+
# For the `StopStep` signal type, you must send the step execution ID
|
13011
|
+
# as the payload. For example:
|
13012
|
+
#
|
13013
|
+
# `StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"`
|
12971
13014
|
# @return [Hash<String,Array<String>>]
|
12972
13015
|
#
|
12973
13016
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/SendAutomationSignalRequest AWS API Documentation
|
@@ -13138,7 +13181,9 @@ module Aws::SSM
|
|
13138
13181
|
# @return [String]
|
13139
13182
|
#
|
13140
13183
|
# @!attribute [rw] service_role_arn
|
13141
|
-
# The IAM role
|
13184
|
+
# The ARN of the IAM service role to use to publish Amazon Simple
|
13185
|
+
# Notification Service (Amazon SNS) notifications for Run Command
|
13186
|
+
# commands.
|
13142
13187
|
# @return [String]
|
13143
13188
|
#
|
13144
13189
|
# @!attribute [rw] notification_config
|
@@ -13886,7 +13931,7 @@ module Aws::SSM
|
|
13886
13931
|
# Metadata that you assign to your AWS resources. Tags enable you to
|
13887
13932
|
# categorize your resources in different ways, for example, by purpose,
|
13888
13933
|
# owner, or environment. In Systems Manager, you can apply tags to
|
13889
|
-
# documents, managed instances,
|
13934
|
+
# documents, managed instances, maintenance windows, Parameter Store
|
13890
13935
|
# parameters, and patch baselines.
|
13891
13936
|
#
|
13892
13937
|
# @note When making an API call, you may pass Tag
|
@@ -13997,13 +14042,13 @@ module Aws::SSM
|
|
13997
14042
|
# @return [Array<String>]
|
13998
14043
|
#
|
13999
14044
|
# @!attribute [rw] target_location_max_concurrency
|
14000
|
-
# The
|
14001
|
-
# Automation concurrently
|
14045
|
+
# The maximum number of AWS accounts and AWS regions allowed to run
|
14046
|
+
# the Automation concurrently
|
14002
14047
|
# @return [String]
|
14003
14048
|
#
|
14004
14049
|
# @!attribute [rw] target_location_max_errors
|
14005
|
-
# The
|
14006
|
-
# additional Automation executions for the currently running
|
14050
|
+
# The maximum number of errors allowed before the system stops
|
14051
|
+
# queueing additional Automation executions for the currently running
|
14007
14052
|
# Automation.
|
14008
14053
|
# @return [String]
|
14009
14054
|
#
|
@@ -14097,6 +14142,16 @@ module Aws::SSM
|
|
14097
14142
|
include Aws::Structure
|
14098
14143
|
end
|
14099
14144
|
|
14145
|
+
# Microsoft application patching is only available on EC2 instances and
|
14146
|
+
# Advanced Instances. To patch Microsoft applications on on-premises
|
14147
|
+
# servers and VMs, you must enable Advanced Instances. For more
|
14148
|
+
# information, see [Using the Advanced-Instances Tier][1] in the *AWS
|
14149
|
+
# Systems Manager User Guide*.
|
14150
|
+
#
|
14151
|
+
#
|
14152
|
+
#
|
14153
|
+
# [1]: http://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances-advanced.html
|
14154
|
+
#
|
14100
14155
|
# @!attribute [rw] message
|
14101
14156
|
# @return [String]
|
14102
14157
|
#
|
@@ -14523,11 +14578,11 @@ module Aws::SSM
|
|
14523
14578
|
# }
|
14524
14579
|
#
|
14525
14580
|
# @!attribute [rw] window_id
|
14526
|
-
# The ID of the
|
14581
|
+
# The ID of the maintenance window to update.
|
14527
14582
|
# @return [String]
|
14528
14583
|
#
|
14529
14584
|
# @!attribute [rw] name
|
14530
|
-
# The name of the
|
14585
|
+
# The name of the maintenance window.
|
14531
14586
|
# @return [String]
|
14532
14587
|
#
|
14533
14588
|
# @!attribute [rw] description
|
@@ -14535,7 +14590,7 @@ module Aws::SSM
|
|
14535
14590
|
# @return [String]
|
14536
14591
|
#
|
14537
14592
|
# @!attribute [rw] start_date
|
14538
|
-
# The time zone that the scheduled
|
14593
|
+
# The time zone that the scheduled maintenance window executions are
|
14539
14594
|
# based on, in Internet Assigned Numbers Authority (IANA) format. For
|
14540
14595
|
# example: "America/Los\_Angeles", "etc/UTC", or "Asia/Seoul".
|
14541
14596
|
# For more information, see the [Time Zone Database][1] on the IANA
|
@@ -14548,18 +14603,18 @@ module Aws::SSM
|
|
14548
14603
|
#
|
14549
14604
|
# @!attribute [rw] end_date
|
14550
14605
|
# The date and time, in ISO-8601 Extended format, for when you want
|
14551
|
-
# the
|
14552
|
-
# a date and time in the future when the
|
14606
|
+
# the maintenance window to become inactive. EndDate allows you to set
|
14607
|
+
# a date and time in the future when the maintenance window will no
|
14553
14608
|
# longer run.
|
14554
14609
|
# @return [String]
|
14555
14610
|
#
|
14556
14611
|
# @!attribute [rw] schedule
|
14557
|
-
# The schedule of the
|
14612
|
+
# The schedule of the maintenance window in the form of a cron or rate
|
14558
14613
|
# expression.
|
14559
14614
|
# @return [String]
|
14560
14615
|
#
|
14561
14616
|
# @!attribute [rw] schedule_timezone
|
14562
|
-
# The time zone that the scheduled
|
14617
|
+
# The time zone that the scheduled maintenance window executions are
|
14563
14618
|
# based on, in Internet Assigned Numbers Authority (IANA) format. For
|
14564
14619
|
# example: "America/Los\_Angeles", "etc/UTC", or "Asia/Seoul".
|
14565
14620
|
# For more information, see the [Time Zone Database][1] on the IANA
|
@@ -14571,21 +14626,21 @@ module Aws::SSM
|
|
14571
14626
|
# @return [String]
|
14572
14627
|
#
|
14573
14628
|
# @!attribute [rw] duration
|
14574
|
-
# The duration of the
|
14629
|
+
# The duration of the maintenance window in hours.
|
14575
14630
|
# @return [Integer]
|
14576
14631
|
#
|
14577
14632
|
# @!attribute [rw] cutoff
|
14578
|
-
# The number of hours before the end of the
|
14633
|
+
# The number of hours before the end of the maintenance window that
|
14579
14634
|
# Systems Manager stops scheduling new tasks for execution.
|
14580
14635
|
# @return [Integer]
|
14581
14636
|
#
|
14582
14637
|
# @!attribute [rw] allow_unassociated_targets
|
14583
|
-
# Whether targets must be registered with the
|
14638
|
+
# Whether targets must be registered with the maintenance window
|
14584
14639
|
# before tasks can be defined for those targets.
|
14585
14640
|
# @return [Boolean]
|
14586
14641
|
#
|
14587
14642
|
# @!attribute [rw] enabled
|
14588
|
-
# Whether the
|
14643
|
+
# Whether the maintenance window is enabled.
|
14589
14644
|
# @return [Boolean]
|
14590
14645
|
#
|
14591
14646
|
# @!attribute [rw] replace
|
@@ -14613,11 +14668,11 @@ module Aws::SSM
|
|
14613
14668
|
end
|
14614
14669
|
|
14615
14670
|
# @!attribute [rw] window_id
|
14616
|
-
# The ID of the created
|
14671
|
+
# The ID of the created maintenance window.
|
14617
14672
|
# @return [String]
|
14618
14673
|
#
|
14619
14674
|
# @!attribute [rw] name
|
14620
|
-
# The name of the
|
14675
|
+
# The name of the maintenance window.
|
14621
14676
|
# @return [String]
|
14622
14677
|
#
|
14623
14678
|
# @!attribute [rw] description
|
@@ -14626,23 +14681,23 @@ module Aws::SSM
|
|
14626
14681
|
#
|
14627
14682
|
# @!attribute [rw] start_date
|
14628
14683
|
# The date and time, in ISO-8601 Extended format, for when the
|
14629
|
-
#
|
14630
|
-
#
|
14684
|
+
# maintenance window is scheduled to become active. The maintenance
|
14685
|
+
# window will not run before this specified time.
|
14631
14686
|
# @return [String]
|
14632
14687
|
#
|
14633
14688
|
# @!attribute [rw] end_date
|
14634
14689
|
# The date and time, in ISO-8601 Extended format, for when the
|
14635
|
-
#
|
14636
|
-
#
|
14690
|
+
# maintenance window is scheduled to become inactive. The maintenance
|
14691
|
+
# window will not run after this specified time.
|
14637
14692
|
# @return [String]
|
14638
14693
|
#
|
14639
14694
|
# @!attribute [rw] schedule
|
14640
|
-
# The schedule of the
|
14695
|
+
# The schedule of the maintenance window in the form of a cron or rate
|
14641
14696
|
# expression.
|
14642
14697
|
# @return [String]
|
14643
14698
|
#
|
14644
14699
|
# @!attribute [rw] schedule_timezone
|
14645
|
-
# The time zone that the scheduled
|
14700
|
+
# The time zone that the scheduled maintenance window executions are
|
14646
14701
|
# based on, in Internet Assigned Numbers Authority (IANA) format. For
|
14647
14702
|
# example: "America/Los\_Angeles", "etc/UTC", or "Asia/Seoul".
|
14648
14703
|
# For more information, see the [Time Zone Database][1] on the IANA
|
@@ -14654,21 +14709,21 @@ module Aws::SSM
|
|
14654
14709
|
# @return [String]
|
14655
14710
|
#
|
14656
14711
|
# @!attribute [rw] duration
|
14657
|
-
# The duration of the
|
14712
|
+
# The duration of the maintenance window in hours.
|
14658
14713
|
# @return [Integer]
|
14659
14714
|
#
|
14660
14715
|
# @!attribute [rw] cutoff
|
14661
|
-
# The number of hours before the end of the
|
14716
|
+
# The number of hours before the end of the maintenance window that
|
14662
14717
|
# Systems Manager stops scheduling new tasks for execution.
|
14663
14718
|
# @return [Integer]
|
14664
14719
|
#
|
14665
14720
|
# @!attribute [rw] allow_unassociated_targets
|
14666
|
-
# Whether targets must be registered with the
|
14721
|
+
# Whether targets must be registered with the maintenance window
|
14667
14722
|
# before tasks can be defined for those targets.
|
14668
14723
|
# @return [Boolean]
|
14669
14724
|
#
|
14670
14725
|
# @!attribute [rw] enabled
|
14671
|
-
# Whether the
|
14726
|
+
# Whether the maintenance window is enabled.
|
14672
14727
|
# @return [Boolean]
|
14673
14728
|
#
|
14674
14729
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateMaintenanceWindowResult AWS API Documentation
|
@@ -14707,7 +14762,7 @@ module Aws::SSM
|
|
14707
14762
|
# }
|
14708
14763
|
#
|
14709
14764
|
# @!attribute [rw] window_id
|
14710
|
-
# The
|
14765
|
+
# The maintenance window ID with which to modify the target.
|
14711
14766
|
# @return [String]
|
14712
14767
|
#
|
14713
14768
|
# @!attribute [rw] window_target_id
|
@@ -14720,8 +14775,8 @@ module Aws::SSM
|
|
14720
14775
|
#
|
14721
14776
|
# @!attribute [rw] owner_information
|
14722
14777
|
# User-provided value that will be included in any CloudWatch events
|
14723
|
-
# raised while running tasks for these targets in this
|
14724
|
-
#
|
14778
|
+
# raised while running tasks for these targets in this maintenance
|
14779
|
+
# window.
|
14725
14780
|
# @return [String]
|
14726
14781
|
#
|
14727
14782
|
# @!attribute [rw] name
|
@@ -14753,7 +14808,7 @@ module Aws::SSM
|
|
14753
14808
|
end
|
14754
14809
|
|
14755
14810
|
# @!attribute [rw] window_id
|
14756
|
-
# The
|
14811
|
+
# The maintenance window ID specified in the update request.
|
14757
14812
|
# @return [String]
|
14758
14813
|
#
|
14759
14814
|
# @!attribute [rw] window_target_id
|
@@ -14855,7 +14910,7 @@ module Aws::SSM
|
|
14855
14910
|
# }
|
14856
14911
|
#
|
14857
14912
|
# @!attribute [rw] window_id
|
14858
|
-
# The
|
14913
|
+
# The maintenance window ID that contains the task to modify.
|
14859
14914
|
# @return [String]
|
14860
14915
|
#
|
14861
14916
|
# @!attribute [rw] window_task_id
|
@@ -14873,20 +14928,20 @@ module Aws::SSM
|
|
14873
14928
|
# @return [String]
|
14874
14929
|
#
|
14875
14930
|
# @!attribute [rw] service_role_arn
|
14876
|
-
# The IAM service role
|
14877
|
-
#
|
14878
|
-
#
|
14879
|
-
# If you do not specify a service role ARN, Systems Manager will use
|
14880
|
-
# your account's service-linked role for Systems Manager by default.
|
14931
|
+
# The ARN of the IAM service role for Systems Manager to assume when
|
14932
|
+
# running a maintenance window task. If you do not specify a service
|
14933
|
+
# role ARN, Systems Manager uses your account's service-linked role.
|
14881
14934
|
# If no service-linked role for Systems Manager exists in your
|
14882
|
-
# account, it
|
14883
|
-
# `RegisterTaskWithMaintenanceWindow
|
14884
|
-
# role ARN.
|
14935
|
+
# account, it is created when you run
|
14936
|
+
# `RegisterTaskWithMaintenanceWindow`.
|
14885
14937
|
#
|
14886
|
-
# For more information, see
|
14887
|
-
# Systems Manager
|
14888
|
-
#
|
14889
|
-
# *
|
14938
|
+
# For more information, see the following topics in the in the *AWS
|
14939
|
+
# Systems Manager User Guide*\:
|
14940
|
+
#
|
14941
|
+
# * [Service-Linked Role Permissions for Systems Manager][1]
|
14942
|
+
#
|
14943
|
+
# * [Should I Use a Service-Linked Role or a Custom Service Role to
|
14944
|
+
# Run Maintenance Window Tasks? ][2]
|
14890
14945
|
#
|
14891
14946
|
#
|
14892
14947
|
#
|
@@ -14900,8 +14955,8 @@ module Aws::SSM
|
|
14900
14955
|
# <note markdown="1"> `TaskParameters` has been deprecated. To specify parameters to pass
|
14901
14956
|
# to a task when it runs, instead use the `Parameters` option in the
|
14902
14957
|
# `TaskInvocationParameters` structure. For information about how
|
14903
|
-
# Systems Manager handles these options for the supported
|
14904
|
-
#
|
14958
|
+
# Systems Manager handles these options for the supported maintenance
|
14959
|
+
# window task types, see MaintenanceWindowTaskInvocationParameters.
|
14905
14960
|
#
|
14906
14961
|
# </note>
|
14907
14962
|
#
|
@@ -14944,7 +14999,7 @@ module Aws::SSM
|
|
14944
14999
|
# contain logs, instead use the `OutputS3BucketName` and
|
14945
15000
|
# `OutputS3KeyPrefix` options in the `TaskInvocationParameters`
|
14946
15001
|
# structure. For information about how Systems Manager handles these
|
14947
|
-
# options for the supported
|
15002
|
+
# options for the supported maintenance window task types, see
|
14948
15003
|
# MaintenanceWindowTaskInvocationParameters.
|
14949
15004
|
#
|
14950
15005
|
# </note>
|
@@ -14985,11 +15040,11 @@ module Aws::SSM
|
|
14985
15040
|
end
|
14986
15041
|
|
14987
15042
|
# @!attribute [rw] window_id
|
14988
|
-
# The ID of the
|
15043
|
+
# The ID of the maintenance window that was updated.
|
14989
15044
|
# @return [String]
|
14990
15045
|
#
|
14991
15046
|
# @!attribute [rw] window_task_id
|
14992
|
-
# The task ID of the
|
15047
|
+
# The task ID of the maintenance window that was updated.
|
14993
15048
|
# @return [String]
|
14994
15049
|
#
|
14995
15050
|
# @!attribute [rw] targets
|
@@ -15001,7 +15056,9 @@ module Aws::SSM
|
|
15001
15056
|
# @return [String]
|
15002
15057
|
#
|
15003
15058
|
# @!attribute [rw] service_role_arn
|
15004
|
-
# The
|
15059
|
+
# The ARN of the IAM service role to use to publish Amazon Simple
|
15060
|
+
# Notification Service (Amazon SNS) notifications for maintenance
|
15061
|
+
# window Run Command tasks.
|
15005
15062
|
# @return [String]
|
15006
15063
|
#
|
15007
15064
|
# @!attribute [rw] task_parameters
|
@@ -15010,8 +15067,8 @@ module Aws::SSM
|
|
15010
15067
|
# <note markdown="1"> `TaskParameters` has been deprecated. To specify parameters to pass
|
15011
15068
|
# to a task when it runs, instead use the `Parameters` option in the
|
15012
15069
|
# `TaskInvocationParameters` structure. For information about how
|
15013
|
-
# Systems Manager handles these options for the supported
|
15014
|
-
#
|
15070
|
+
# Systems Manager handles these options for the supported maintenance
|
15071
|
+
# window task types, see MaintenanceWindowTaskInvocationParameters.
|
15015
15072
|
#
|
15016
15073
|
# </note>
|
15017
15074
|
# @return [Hash<String,Types::MaintenanceWindowTaskParameterValueExpression>]
|
@@ -15039,7 +15096,7 @@ module Aws::SSM
|
|
15039
15096
|
# contain logs, instead use the `OutputS3BucketName` and
|
15040
15097
|
# `OutputS3KeyPrefix` options in the `TaskInvocationParameters`
|
15041
15098
|
# structure. For information about how Systems Manager handles these
|
15042
|
-
# options for the supported
|
15099
|
+
# options for the supported maintenance window task types, see
|
15043
15100
|
# MaintenanceWindowTaskInvocationParameters.
|
15044
15101
|
#
|
15045
15102
|
# </note>
|