aws-sdk-ssm 1.114.0 → 1.118.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/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ssm/client.rb +256 -136
- data/lib/aws-sdk-ssm/client_api.rb +6 -0
- data/lib/aws-sdk-ssm/types.rb +386 -191
- data/lib/aws-sdk-ssm/waiters.rb +5 -0
- data/lib/aws-sdk-ssm.rb +1 -1
- metadata +5 -5
data/lib/aws-sdk-ssm/types.rb
CHANGED
@@ -10,11 +10,12 @@
|
|
10
10
|
module Aws::SSM
|
11
11
|
module Types
|
12
12
|
|
13
|
-
# Information includes the account ID where the
|
14
|
-
# shared and the version shared with that account.
|
13
|
+
# Information includes the Amazon Web Services account ID where the
|
14
|
+
# current document is shared and the version shared with that account.
|
15
15
|
#
|
16
16
|
# @!attribute [rw] account_id
|
17
|
-
# The account ID where the current document is
|
17
|
+
# The Amazon Web Services account ID where the current document is
|
18
|
+
# shared.
|
18
19
|
# @return [String]
|
19
20
|
#
|
20
21
|
# @!attribute [rw] shared_document_version
|
@@ -214,8 +215,6 @@ module Aws::SSM
|
|
214
215
|
# OpsCenter supports the following types:
|
215
216
|
#
|
216
217
|
# `AWS::SSMIncidents::IncidentRecord`\: an Incident Manager incident.
|
217
|
-
# Incident Manager is a capability of Amazon Web Services Systems
|
218
|
-
# Manager.
|
219
218
|
#
|
220
219
|
# `AWS::SSM::Document`\: a Systems Manager (SSM) document.
|
221
220
|
# @return [String]
|
@@ -263,7 +262,7 @@ module Aws::SSM
|
|
263
262
|
# @return [String]
|
264
263
|
#
|
265
264
|
# @!attribute [rw] instance_id
|
266
|
-
# The ID
|
265
|
+
# The instance ID.
|
267
266
|
# @return [String]
|
268
267
|
#
|
269
268
|
# @!attribute [rw] association_id
|
@@ -331,7 +330,7 @@ module Aws::SSM
|
|
331
330
|
# @return [String]
|
332
331
|
#
|
333
332
|
# @!attribute [rw] instance_id
|
334
|
-
# The ID
|
333
|
+
# The instance ID.
|
335
334
|
# @return [String]
|
336
335
|
#
|
337
336
|
# @!attribute [rw] association_version
|
@@ -471,8 +470,8 @@ module Aws::SSM
|
|
471
470
|
# @return [Array<String>]
|
472
471
|
#
|
473
472
|
# @!attribute [rw] target_locations
|
474
|
-
# The combination of
|
475
|
-
# association.
|
473
|
+
# The combination of Amazon Web Services Regions and Amazon Web
|
474
|
+
# Services accounts where you want to run the association.
|
476
475
|
# @return [Array<Types::TargetLocation>]
|
477
476
|
#
|
478
477
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/AssociationDescription AWS API Documentation
|
@@ -922,8 +921,9 @@ module Aws::SSM
|
|
922
921
|
# @return [Array<String>]
|
923
922
|
#
|
924
923
|
# @!attribute [rw] target_locations
|
925
|
-
# The combination of
|
926
|
-
#
|
924
|
+
# The combination of Amazon Web Services Regions and Amazon Web
|
925
|
+
# Services accounts where you wanted to run the association when this
|
926
|
+
# association version was created.
|
927
927
|
# @return [Array<Types::TargetLocation>]
|
928
928
|
#
|
929
929
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/AssociationVersionInfo AWS API Documentation
|
@@ -1223,8 +1223,8 @@ module Aws::SSM
|
|
1223
1223
|
# @return [String]
|
1224
1224
|
#
|
1225
1225
|
# @!attribute [rw] target_locations
|
1226
|
-
# The combination of Regions and/or
|
1227
|
-
# Automation.
|
1226
|
+
# The combination of Amazon Web Services Regions and/or Amazon Web
|
1227
|
+
# Services accounts where you want to run the Automation.
|
1228
1228
|
# @return [Array<Types::TargetLocation>]
|
1229
1229
|
#
|
1230
1230
|
# @!attribute [rw] progress_counters
|
@@ -1441,9 +1441,10 @@ module Aws::SSM
|
|
1441
1441
|
# @!attribute [rw] automation_type
|
1442
1442
|
# Use this filter with DescribeAutomationExecutions. Specify either
|
1443
1443
|
# Local or CrossAccount. CrossAccount is an Automation that runs in
|
1444
|
-
# multiple
|
1445
|
-
#
|
1446
|
-
#
|
1444
|
+
# multiple Amazon Web Services Regions and Amazon Web Services
|
1445
|
+
# accounts. For more information, see [Running Automation workflows in
|
1446
|
+
# multiple Amazon Web Services Regions and accounts][1] in the *Amazon
|
1447
|
+
# Web Services Systems Manager User Guide*.
|
1447
1448
|
#
|
1448
1449
|
#
|
1449
1450
|
#
|
@@ -1868,7 +1869,7 @@ module Aws::SSM
|
|
1868
1869
|
# @!attribute [rw] output_s3_region
|
1869
1870
|
# (Deprecated) You can no longer specify this parameter. The system
|
1870
1871
|
# ignores it. Instead, Systems Manager automatically determines the
|
1871
|
-
# Region of the S3 bucket.
|
1872
|
+
# Amazon Web Services Region of the S3 bucket.
|
1872
1873
|
# @return [String]
|
1873
1874
|
#
|
1874
1875
|
# @!attribute [rw] output_s3_bucket_name
|
@@ -2011,22 +2012,63 @@ module Aws::SSM
|
|
2011
2012
|
# executions from before July 7, 2021.
|
2012
2013
|
#
|
2013
2014
|
# * **Status**\: Specify a valid command status to see a list of all
|
2014
|
-
# command executions with that status.
|
2015
|
-
#
|
2015
|
+
# command executions with that status. The status choices depend on
|
2016
|
+
# the API you call.
|
2017
|
+
#
|
2018
|
+
# The status values you can specify for `ListCommands` are:
|
2019
|
+
#
|
2020
|
+
# * `Pending`
|
2021
|
+
#
|
2022
|
+
# * `InProgress`
|
2023
|
+
#
|
2024
|
+
# * `Success`
|
2025
|
+
#
|
2026
|
+
# * `Cancelled`
|
2027
|
+
#
|
2028
|
+
# * `Failed`
|
2029
|
+
#
|
2030
|
+
# * `TimedOut` (this includes both Delivery and Execution time outs)
|
2031
|
+
#
|
2032
|
+
# * `AccessDenied`
|
2033
|
+
#
|
2034
|
+
# * `DeliveryTimedOut`
|
2035
|
+
#
|
2036
|
+
# * `ExecutionTimedOut`
|
2037
|
+
#
|
2038
|
+
# * `Incomplete`
|
2039
|
+
#
|
2040
|
+
# * `NoInstancesInTag`
|
2041
|
+
#
|
2042
|
+
# * `LimitExceeded`
|
2043
|
+
#
|
2044
|
+
# The status values you can specify for `ListCommandInvocations`
|
2045
|
+
# are:
|
2016
2046
|
#
|
2017
2047
|
# * `Pending`
|
2018
2048
|
#
|
2019
2049
|
# * `InProgress`
|
2020
2050
|
#
|
2051
|
+
# * `Delayed`
|
2052
|
+
#
|
2021
2053
|
# * `Success`
|
2022
2054
|
#
|
2023
2055
|
# * `Cancelled`
|
2024
2056
|
#
|
2025
2057
|
# * `Failed`
|
2026
2058
|
#
|
2027
|
-
# * `TimedOut`
|
2059
|
+
# * `TimedOut` (this includes both Delivery and Execution time outs)
|
2028
2060
|
#
|
2029
|
-
# * `
|
2061
|
+
# * `AccessDenied`
|
2062
|
+
#
|
2063
|
+
# * `DeliveryTimedOut`
|
2064
|
+
#
|
2065
|
+
# * `ExecutionTimedOut`
|
2066
|
+
#
|
2067
|
+
# * `Undeliverable`
|
2068
|
+
#
|
2069
|
+
# * `InvalidPlatform`
|
2070
|
+
#
|
2071
|
+
# * `Terminated`
|
2030
2072
|
#
|
2031
2073
|
# * **DocumentName**\: Specify name of the Amazon Web Services Systems
|
2032
2074
|
# Manager document (SSM document) for which you want to see command
|
@@ -2068,9 +2110,7 @@ module Aws::SSM
|
|
2068
2110
|
# @return [String]
|
2069
2111
|
#
|
2070
2112
|
# @!attribute [rw] instance_name
|
2071
|
-
# The name of the
|
2072
|
-
# value for the `aws:Name` tag. For on-premises instances, this is the
|
2073
|
-
# name of the instance.
|
2113
|
+
# The fully qualified host name of the managed instance.
|
2074
2114
|
# @return [String]
|
2075
2115
|
#
|
2076
2116
|
# @!attribute [rw] comment
|
@@ -2657,12 +2697,12 @@ module Aws::SSM
|
|
2657
2697
|
# @return [String]
|
2658
2698
|
#
|
2659
2699
|
# @!attribute [rw] iam_role
|
2660
|
-
# The Identity and Access Management (IAM) role that you
|
2661
|
-
# assign to the managed instance. This
|
2662
|
-
# permissions for the Amazon Web Services Systems Manager
|
2663
|
-
# principal `ssm.amazonaws.com`. For more information, see
|
2664
|
-
# IAM service role for a hybrid environment][1] in the
|
2665
|
-
# Services Systems Manager User Guide*.
|
2700
|
+
# The name of the Identity and Access Management (IAM) role that you
|
2701
|
+
# want to assign to the managed instance. This IAM role must provide
|
2702
|
+
# AssumeRole permissions for the Amazon Web Services Systems Manager
|
2703
|
+
# service principal `ssm.amazonaws.com`. For more information, see
|
2704
|
+
# [Create an IAM service role for a hybrid environment][1] in the
|
2705
|
+
# *Amazon Web Services Systems Manager User Guide*.
|
2666
2706
|
#
|
2667
2707
|
#
|
2668
2708
|
#
|
@@ -2855,8 +2895,9 @@ module Aws::SSM
|
|
2855
2895
|
# you created, or a document that is shared with you from another
|
2856
2896
|
# account.
|
2857
2897
|
#
|
2858
|
-
# For SSM documents that are shared with you from other
|
2859
|
-
# must specify the complete SSM document ARN,
|
2898
|
+
# For SSM documents that are shared with you from other Amazon Web
|
2899
|
+
# Services accounts, you must specify the complete SSM document ARN,
|
2900
|
+
# in the following format:
|
2860
2901
|
#
|
2861
2902
|
# `arn:aws:ssm:region:account-id:document/document-name `
|
2862
2903
|
#
|
@@ -2870,7 +2911,18 @@ module Aws::SSM
|
|
2870
2911
|
# @return [String]
|
2871
2912
|
#
|
2872
2913
|
# @!attribute [rw] instance_id
|
2873
|
-
# The ID
|
2914
|
+
# The instance ID.
|
2915
|
+
#
|
2916
|
+
# <note markdown="1"> `InstanceId` has been deprecated. To specify an instance ID for an
|
2917
|
+
# association, use the `Targets` parameter. Requests that include the
|
2918
|
+
# parameter `InstanceID` with Systems Manager documents (SSM
|
2919
|
+
# documents) that use schema version 2.0 or later will fail. In
|
2920
|
+
# addition, if you use the parameter `InstanceId`, you can't use the
|
2921
|
+
# parameters `AssociationName`, `DocumentVersion`, `MaxErrors`,
|
2922
|
+
# `MaxConcurrency`, `OutputLocation`, or `ScheduleExpression`. To use
|
2923
|
+
# these parameters, you must use the `Targets` parameter.
|
2924
|
+
#
|
2925
|
+
# </note>
|
2874
2926
|
# @return [String]
|
2875
2927
|
#
|
2876
2928
|
# @!attribute [rw] parameters
|
@@ -3073,8 +3125,8 @@ module Aws::SSM
|
|
3073
3125
|
# account.
|
3074
3126
|
#
|
3075
3127
|
# For Systems Manager documents (SSM documents) that are shared with
|
3076
|
-
# you from other accounts, you must specify the
|
3077
|
-
# ARN, in the following format:
|
3128
|
+
# you from other Amazon Web Services accounts, you must specify the
|
3129
|
+
# complete SSM document ARN, in the following format:
|
3078
3130
|
#
|
3079
3131
|
# `arn:partition:ssm:region:account-id:document/document-name `
|
3080
3132
|
#
|
@@ -3114,10 +3166,10 @@ module Aws::SSM
|
|
3114
3166
|
# @!attribute [rw] targets
|
3115
3167
|
# The targets for the association. You can target instances by using
|
3116
3168
|
# tags, Amazon Web Services resource groups, all instances in an
|
3117
|
-
# account, or individual instance IDs. For more
|
3118
|
-
# choosing targets for an association, see [Using
|
3119
|
-
# controls with State Manager associations][1] in the
|
3120
|
-
# Services Systems Manager User Guide*.
|
3169
|
+
# Amazon Web Services account, or individual instance IDs. For more
|
3170
|
+
# information about choosing targets for an association, see [Using
|
3171
|
+
# targets and rate controls with State Manager associations][1] in the
|
3172
|
+
# *Amazon Web Services Systems Manager User Guide*.
|
3121
3173
|
#
|
3122
3174
|
#
|
3123
3175
|
#
|
@@ -3217,9 +3269,10 @@ module Aws::SSM
|
|
3217
3269
|
# @return [Array<String>]
|
3218
3270
|
#
|
3219
3271
|
# @!attribute [rw] target_locations
|
3220
|
-
# A location is a combination of
|
3221
|
-
#
|
3222
|
-
# multiple Regions and
|
3272
|
+
# A location is a combination of Amazon Web Services Regions and
|
3273
|
+
# Amazon Web Services accounts where you want to run the association.
|
3274
|
+
# Use this action to create an association in multiple Regions and
|
3275
|
+
# multiple accounts.
|
3223
3276
|
# @return [Array<Types::TargetLocation>]
|
3224
3277
|
#
|
3225
3278
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateAssociationRequest AWS API Documentation
|
@@ -3808,8 +3861,9 @@ module Aws::SSM
|
|
3808
3861
|
# maximum of five tags for an OpsMetadata object. Tags enable you to
|
3809
3862
|
# categorize a resource in different ways, such as by purpose, owner,
|
3810
3863
|
# or environment. For example, you might want to tag an OpsMetadata
|
3811
|
-
# object to identify an environment or target
|
3812
|
-
# you could specify the following key-value
|
3864
|
+
# object to identify an environment or target Amazon Web Services
|
3865
|
+
# Region. In this case, you could specify the following key-value
|
3866
|
+
# pairs:
|
3813
3867
|
#
|
3814
3868
|
# * `Key=Environment,Value=Production`
|
3815
3869
|
#
|
@@ -4079,10 +4133,10 @@ module Aws::SSM
|
|
4079
4133
|
# synchronizes data to an S3 bucket for Inventory. If you specify
|
4080
4134
|
# `SyncToDestination`, you must provide a value for `S3Destination`.
|
4081
4135
|
# Specify `SyncFromSource` to synchronize data from a single account
|
4082
|
-
# and multiple Regions, or multiple
|
4083
|
-
#
|
4084
|
-
#
|
4085
|
-
# `SyncToDestination`.
|
4136
|
+
# and multiple Regions, or multiple Amazon Web Services accounts and
|
4137
|
+
# Amazon Web Services Regions, as listed in Organizations for
|
4138
|
+
# Explorer. If you specify `SyncFromSource`, you must provide a value
|
4139
|
+
# for `SyncSource`. The default value is `SyncToDestination`.
|
4086
4140
|
# @return [String]
|
4087
4141
|
#
|
4088
4142
|
# @!attribute [rw] sync_source
|
@@ -4156,7 +4210,18 @@ module Aws::SSM
|
|
4156
4210
|
# @return [String]
|
4157
4211
|
#
|
4158
4212
|
# @!attribute [rw] instance_id
|
4159
|
-
# The ID
|
4213
|
+
# The instance ID.
|
4214
|
+
#
|
4215
|
+
# <note markdown="1"> `InstanceId` has been deprecated. To specify an instance ID for an
|
4216
|
+
# association, use the `Targets` parameter. Requests that include the
|
4217
|
+
# parameter `InstanceID` with Systems Manager documents (SSM
|
4218
|
+
# documents) that use schema version 2.0 or later will fail. In
|
4219
|
+
# addition, if you use the parameter `InstanceId`, you can't use the
|
4220
|
+
# parameters `AssociationName`, `DocumentVersion`, `MaxErrors`,
|
4221
|
+
# `MaxConcurrency`, `OutputLocation`, or `ScheduleExpression`. To use
|
4222
|
+
# these parameters, you must use the `Targets` parameter.
|
4223
|
+
#
|
4224
|
+
# </note>
|
4160
4225
|
# @return [String]
|
4161
4226
|
#
|
4162
4227
|
# @!attribute [rw] association_id
|
@@ -4396,7 +4461,9 @@ module Aws::SSM
|
|
4396
4461
|
# }
|
4397
4462
|
#
|
4398
4463
|
# @!attribute [rw] names
|
4399
|
-
# The names of the parameters to delete.
|
4464
|
+
# The names of the parameters to delete. After deleting a parameter,
|
4465
|
+
# wait for at least 30 seconds to create a parameter with the same
|
4466
|
+
# name.
|
4400
4467
|
# @return [Array<String>]
|
4401
4468
|
#
|
4402
4469
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeleteParametersRequest AWS API Documentation
|
@@ -4711,7 +4778,7 @@ module Aws::SSM
|
|
4711
4778
|
end
|
4712
4779
|
|
4713
4780
|
# @!attribute [rw] activation_list
|
4714
|
-
# A list of activations for your account.
|
4781
|
+
# A list of activations for your Amazon Web Services account.
|
4715
4782
|
# @return [Array<Types::Activation>]
|
4716
4783
|
#
|
4717
4784
|
# @!attribute [rw] next_token
|
@@ -5252,12 +5319,12 @@ module Aws::SSM
|
|
5252
5319
|
|
5253
5320
|
# @!attribute [rw] account_ids
|
5254
5321
|
# The account IDs that have permission to use this document. The ID
|
5255
|
-
# can be either an account or *All*.
|
5322
|
+
# can be either an Amazon Web Services account or *All*.
|
5256
5323
|
# @return [Array<String>]
|
5257
5324
|
#
|
5258
5325
|
# @!attribute [rw] account_sharing_info_list
|
5259
|
-
# A list of accounts where the current document is
|
5260
|
-
# version shared with each account.
|
5326
|
+
# A list of Amazon Web Services accounts where the current document is
|
5327
|
+
# shared and the version shared with each account.
|
5261
5328
|
# @return [Array<Types::AccountSharingInfo>]
|
5262
5329
|
#
|
5263
5330
|
# @!attribute [rw] next_token
|
@@ -6955,12 +7022,12 @@ module Aws::SSM
|
|
6955
7022
|
#
|
6956
7023
|
# @!attribute [rw] ops_item_id
|
6957
7024
|
# The ID of the OpsItem for which you want to delete an association
|
6958
|
-
# between the OpsItem and a related
|
7025
|
+
# between the OpsItem and a related item.
|
6959
7026
|
# @return [String]
|
6960
7027
|
#
|
6961
7028
|
# @!attribute [rw] association_id
|
6962
7029
|
# The ID of the association for which you want to delete an
|
6963
|
-
# association between the OpsItem and a related
|
7030
|
+
# association between the OpsItem and a related item.
|
6964
7031
|
# @return [String]
|
6965
7032
|
#
|
6966
7033
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DisassociateOpsItemRelatedItemRequest AWS API Documentation
|
@@ -8201,7 +8268,7 @@ module Aws::SSM
|
|
8201
8268
|
# }
|
8202
8269
|
#
|
8203
8270
|
# @!attribute [rw] target
|
8204
|
-
# The ID
|
8271
|
+
# The instance ID.
|
8205
8272
|
# @return [String]
|
8206
8273
|
#
|
8207
8274
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetConnectionStatusRequest AWS API Documentation
|
@@ -8341,7 +8408,7 @@ module Aws::SSM
|
|
8341
8408
|
end
|
8342
8409
|
|
8343
8410
|
# @!attribute [rw] instance_id
|
8344
|
-
# The ID
|
8411
|
+
# The instance ID.
|
8345
8412
|
# @return [String]
|
8346
8413
|
#
|
8347
8414
|
# @!attribute [rw] snapshot_id
|
@@ -9192,6 +9259,16 @@ module Aws::SSM
|
|
9192
9259
|
# The retrieved task description.
|
9193
9260
|
# @return [String]
|
9194
9261
|
#
|
9262
|
+
# @!attribute [rw] cutoff_behavior
|
9263
|
+
# The action to take on tasks when the maintenance window cutoff time
|
9264
|
+
# is reached. `CONTINUE_TASK` means that tasks continue to run. For
|
9265
|
+
# Automation, Lambda, Step Functions tasks, `CANCEL_TASK` means that
|
9266
|
+
# currently running task invocations continue, but no new task
|
9267
|
+
# invocations are started. For Run Command tasks, `CANCEL_TASK` means
|
9268
|
+
# the system attempts to stop the task by sending a `CancelCommand`
|
9269
|
+
# operation.
|
9270
|
+
# @return [String]
|
9271
|
+
#
|
9195
9272
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetMaintenanceWindowTaskResult AWS API Documentation
|
9196
9273
|
#
|
9197
9274
|
class GetMaintenanceWindowTaskResult < Struct.new(
|
@@ -9208,7 +9285,8 @@ module Aws::SSM
|
|
9208
9285
|
:max_errors,
|
9209
9286
|
:logging_info,
|
9210
9287
|
:name,
|
9211
|
-
:description
|
9288
|
+
:description,
|
9289
|
+
:cutoff_behavior)
|
9212
9290
|
SENSITIVE = [:task_parameters, :description]
|
9213
9291
|
include Aws::Structure
|
9214
9292
|
end
|
@@ -9384,7 +9462,7 @@ module Aws::SSM
|
|
9384
9462
|
end
|
9385
9463
|
|
9386
9464
|
# @!attribute [rw] entities
|
9387
|
-
# The list of aggregated and filtered OpsData.
|
9465
|
+
# The list of aggregated details and filtered OpsData.
|
9388
9466
|
# @return [Array<Types::OpsEntity>]
|
9389
9467
|
#
|
9390
9468
|
# @!attribute [rw] next_token
|
@@ -9470,6 +9548,9 @@ module Aws::SSM
|
|
9470
9548
|
#
|
9471
9549
|
# @!attribute [rw] name
|
9472
9550
|
# The name of the parameter you want to query.
|
9551
|
+
#
|
9552
|
+
# To query by parameter label, use `"Name": "name:label"`. To query by
|
9553
|
+
# parameter version, use `"Name": "name:version"`.
|
9473
9554
|
# @return [String]
|
9474
9555
|
#
|
9475
9556
|
# @!attribute [rw] with_decryption
|
@@ -9539,11 +9620,12 @@ module Aws::SSM
|
|
9539
9620
|
# @!attribute [rw] parameter_filters
|
9540
9621
|
# Filters to limit the request results.
|
9541
9622
|
#
|
9542
|
-
# <note markdown="1">
|
9543
|
-
#
|
9623
|
+
# <note markdown="1"> The following `Key` values are supported for `GetParametersByPath`\:
|
9624
|
+
# `Type`, `KeyId`, and `Label`.
|
9544
9625
|
#
|
9545
|
-
# The following `Key` values
|
9546
|
-
# `GetParametersByPath`\: `tag`, `Name`, `Path`, and
|
9626
|
+
# The following `Key` values aren't supported for
|
9627
|
+
# `GetParametersByPath`\: `tag`, `DataType`, `Name`, `Path`, and
|
9628
|
+
# `Tier`.
|
9547
9629
|
#
|
9548
9630
|
# </note>
|
9549
9631
|
# @return [Array<Types::ParameterStringFilter>]
|
@@ -9604,6 +9686,9 @@ module Aws::SSM
|
|
9604
9686
|
#
|
9605
9687
|
# @!attribute [rw] names
|
9606
9688
|
# Names of the parameters for which you want to query information.
|
9689
|
+
#
|
9690
|
+
# To query by parameter label, use `"Name": "name:label"`. To query by
|
9691
|
+
# parameter version, use `"Name": "name:version"`.
|
9607
9692
|
# @return [Array<String>]
|
9608
9693
|
#
|
9609
9694
|
# @!attribute [rw] with_decryption
|
@@ -9699,6 +9784,15 @@ module Aws::SSM
|
|
9699
9784
|
#
|
9700
9785
|
# @!attribute [rw] baseline_id
|
9701
9786
|
# The ID of the patch baseline to retrieve.
|
9787
|
+
#
|
9788
|
+
# <note markdown="1"> To retrieve information about an Amazon Web Services managed patch
|
9789
|
+
# baseline, specify the full Amazon Resource Name (ARN) of the
|
9790
|
+
# baseline. For example, for the baseline
|
9791
|
+
# `AWS-AmazonLinuxDefaultPatchBaseline`, specify
|
9792
|
+
# `arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0e392de35e7c563b7`
|
9793
|
+
# instead of `pb-0e392de35e7c563b7`.
|
9794
|
+
#
|
9795
|
+
# </note>
|
9702
9796
|
# @return [String]
|
9703
9797
|
#
|
9704
9798
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetPatchBaselineRequest AWS API Documentation
|
@@ -12143,11 +12237,11 @@ module Aws::SSM
|
|
12143
12237
|
# }
|
12144
12238
|
#
|
12145
12239
|
# @!attribute [rw] name
|
12146
|
-
# The name of the
|
12240
|
+
# The name of the change template.
|
12147
12241
|
# @return [String]
|
12148
12242
|
#
|
12149
12243
|
# @!attribute [rw] document_version
|
12150
|
-
# The version of the
|
12244
|
+
# The version of the change template.
|
12151
12245
|
# @return [String]
|
12152
12246
|
#
|
12153
12247
|
# @!attribute [rw] metadata
|
@@ -12179,20 +12273,21 @@ module Aws::SSM
|
|
12179
12273
|
end
|
12180
12274
|
|
12181
12275
|
# @!attribute [rw] name
|
12182
|
-
# The name of the
|
12276
|
+
# The name of the change template.
|
12183
12277
|
# @return [String]
|
12184
12278
|
#
|
12185
12279
|
# @!attribute [rw] document_version
|
12186
|
-
# The version of the
|
12280
|
+
# The version of the change template.
|
12187
12281
|
# @return [String]
|
12188
12282
|
#
|
12189
12283
|
# @!attribute [rw] author
|
12190
12284
|
# The user ID of the person in the organization who requested the
|
12191
|
-
#
|
12285
|
+
# review of the change template.
|
12192
12286
|
# @return [String]
|
12193
12287
|
#
|
12194
12288
|
# @!attribute [rw] metadata
|
12195
|
-
# Information about the response to the
|
12289
|
+
# Information about the response to the change template approval
|
12290
|
+
# request.
|
12196
12291
|
# @return [Types::DocumentMetadataResponseInfo]
|
12197
12292
|
#
|
12198
12293
|
# @!attribute [rw] next_token
|
@@ -12697,8 +12792,8 @@ module Aws::SSM
|
|
12697
12792
|
# View a list of resource data syncs according to the sync type.
|
12698
12793
|
# Specify `SyncToDestination` to view resource data syncs that
|
12699
12794
|
# synchronize data to an Amazon S3 bucket. Specify `SyncFromSource` to
|
12700
|
-
# view resource data syncs from Organizations or from multiple
|
12701
|
-
# Regions.
|
12795
|
+
# view resource data syncs from Organizations or from multiple Amazon
|
12796
|
+
# Web Services Regions.
|
12702
12797
|
# @return [String]
|
12703
12798
|
#
|
12704
12799
|
# @!attribute [rw] next_token
|
@@ -12809,7 +12904,7 @@ module Aws::SSM
|
|
12809
12904
|
# @return [String]
|
12810
12905
|
#
|
12811
12906
|
# @!attribute [rw] s3_region
|
12812
|
-
# The Region where the S3 bucket is located.
|
12907
|
+
# The Amazon Web Services Region where the S3 bucket is located.
|
12813
12908
|
# @return [String]
|
12814
12909
|
#
|
12815
12910
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/LoggingInfo AWS API Documentation
|
@@ -13563,6 +13658,11 @@ module Aws::SSM
|
|
13563
13658
|
# A description of the task.
|
13564
13659
|
# @return [String]
|
13565
13660
|
#
|
13661
|
+
# @!attribute [rw] cutoff_behavior
|
13662
|
+
# The specification for whether tasks should continue to run after the
|
13663
|
+
# cutoff time specified in the maintenance windows is reached.
|
13664
|
+
# @return [String]
|
13665
|
+
#
|
13566
13666
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/MaintenanceWindowTask AWS API Documentation
|
13567
13667
|
#
|
13568
13668
|
class MaintenanceWindowTask < Struct.new(
|
@@ -13578,7 +13678,8 @@ module Aws::SSM
|
|
13578
13678
|
:max_concurrency,
|
13579
13679
|
:max_errors,
|
13580
13680
|
:name,
|
13581
|
-
:description
|
13681
|
+
:description,
|
13682
|
+
:cutoff_behavior)
|
13582
13683
|
SENSITIVE = [:task_parameters, :description]
|
13583
13684
|
include Aws::Structure
|
13584
13685
|
end
|
@@ -13991,17 +14092,33 @@ module Aws::SSM
|
|
13991
14092
|
|
13992
14093
|
# Operations engineers and IT professionals use Amazon Web Services
|
13993
14094
|
# Systems Manager OpsCenter to view, investigate, and remediate
|
13994
|
-
# operational
|
13995
|
-
# Amazon Web Services resources.
|
13996
|
-
#
|
13997
|
-
#
|
14095
|
+
# operational work items (OpsItems) impacting the performance and health
|
14096
|
+
# of their Amazon Web Services resources. OpsCenter is integrated with
|
14097
|
+
# Amazon EventBridge and Amazon CloudWatch. This means you can configure
|
14098
|
+
# these services to automatically create an OpsItem in OpsCenter when a
|
14099
|
+
# CloudWatch alarm enters the ALARM state or when EventBridge processes
|
14100
|
+
# an event from any Amazon Web Services service that publishes events.
|
14101
|
+
# Configuring Amazon CloudWatch alarms and EventBridge events to
|
14102
|
+
# automatically create OpsItems allows you to quickly diagnose and
|
14103
|
+
# remediate issues with Amazon Web Services resources from a single
|
14104
|
+
# console.
|
14105
|
+
#
|
14106
|
+
# To help you diagnose issues, each OpsItem includes contextually
|
14107
|
+
# relevant information such as the name and ID of the Amazon Web
|
14108
|
+
# Services resource that generated the OpsItem, alarm or event details,
|
14109
|
+
# alarm history, and an alarm timeline graph. For the Amazon Web
|
14110
|
+
# Services resource, OpsCenter aggregates information from Config,
|
14111
|
+
# CloudTrail logs, and EventBridge, so you don't have to navigate
|
14112
|
+
# across multiple console pages during your investigation. For more
|
14113
|
+
# information, see [OpsCenter][1] in the *Amazon Web Services Systems
|
14114
|
+
# Manager User Guide*.
|
13998
14115
|
#
|
13999
14116
|
#
|
14000
14117
|
#
|
14001
14118
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html
|
14002
14119
|
#
|
14003
14120
|
# @!attribute [rw] created_by
|
14004
|
-
# The ARN of the account that created the OpsItem.
|
14121
|
+
# The ARN of the Amazon Web Services account that created the OpsItem.
|
14005
14122
|
# @return [String]
|
14006
14123
|
#
|
14007
14124
|
# @!attribute [rw] ops_item_type
|
@@ -14018,7 +14135,8 @@ module Aws::SSM
|
|
14018
14135
|
# @return [String]
|
14019
14136
|
#
|
14020
14137
|
# @!attribute [rw] last_modified_by
|
14021
|
-
# The ARN of the account that last updated the
|
14138
|
+
# The ARN of the Amazon Web Services account that last updated the
|
14139
|
+
# OpsItem.
|
14022
14140
|
# @return [String]
|
14023
14141
|
#
|
14024
14142
|
# @!attribute [rw] last_modified_time
|
@@ -14905,7 +15023,7 @@ module Aws::SSM
|
|
14905
15023
|
:last_modified_date,
|
14906
15024
|
:arn,
|
14907
15025
|
:data_type)
|
14908
|
-
SENSITIVE = []
|
15026
|
+
SENSITIVE = [:value]
|
14909
15027
|
include Aws::Structure
|
14910
15028
|
end
|
14911
15029
|
|
@@ -15003,7 +15121,7 @@ module Aws::SSM
|
|
15003
15121
|
:tier,
|
15004
15122
|
:policies,
|
15005
15123
|
:data_type)
|
15006
|
-
SENSITIVE = []
|
15124
|
+
SENSITIVE = [:value]
|
15007
15125
|
include Aws::Structure
|
15008
15126
|
end
|
15009
15127
|
|
@@ -15036,8 +15154,8 @@ module Aws::SSM
|
|
15036
15154
|
include Aws::Structure
|
15037
15155
|
end
|
15038
15156
|
|
15039
|
-
# You have exceeded the number of parameters for this
|
15040
|
-
# one or more parameters and try again.
|
15157
|
+
# You have exceeded the number of parameters for this Amazon Web
|
15158
|
+
# Services account. Delete one or more parameters and try again.
|
15041
15159
|
#
|
15042
15160
|
# @!attribute [rw] message
|
15043
15161
|
# @return [String]
|
@@ -15203,11 +15321,11 @@ module Aws::SSM
|
|
15203
15321
|
# and GetParametersByPath API operations. However, not all of the
|
15204
15322
|
# pattern values listed for `Key` can be used with both operations.
|
15205
15323
|
#
|
15206
|
-
# For `DescribeActions`, all of the listed patterns are valid
|
15207
|
-
#
|
15324
|
+
# For `DescribeActions`, all of the listed patterns are valid except
|
15325
|
+
# `Label`.
|
15208
15326
|
#
|
15209
15327
|
# For `GetParametersByPath`, the following patterns listed for `Key`
|
15210
|
-
# aren't valid: `tag`, `Name`, `Path`, and `Tier`.
|
15328
|
+
# aren't valid: `tag`, `DataType`, `Name`, `Path`, and `Tier`.
|
15211
15329
|
#
|
15212
15330
|
# For examples of Amazon Web Services CLI commands demonstrating valid
|
15213
15331
|
# parameter filter constructions, see [Searching for Systems Manager
|
@@ -15877,28 +15995,33 @@ module Aws::SSM
|
|
15877
15995
|
# Automation execution.
|
15878
15996
|
#
|
15879
15997
|
# @!attribute [rw] total_steps
|
15880
|
-
# The total number of steps run in all specified
|
15881
|
-
# for the current Automation
|
15998
|
+
# The total number of steps run in all specified Amazon Web Services
|
15999
|
+
# Regions and Amazon Web Services accounts for the current Automation
|
16000
|
+
# execution.
|
15882
16001
|
# @return [Integer]
|
15883
16002
|
#
|
15884
16003
|
# @!attribute [rw] success_steps
|
15885
16004
|
# The total number of steps that successfully completed in all
|
15886
|
-
# specified
|
16005
|
+
# specified Amazon Web Services Regions and Amazon Web Services
|
16006
|
+
# accounts for the current Automation execution.
|
15887
16007
|
# @return [Integer]
|
15888
16008
|
#
|
15889
16009
|
# @!attribute [rw] failed_steps
|
15890
|
-
# The total number of steps that failed to run in all specified
|
15891
|
-
# Regions and accounts for the
|
16010
|
+
# The total number of steps that failed to run in all specified Amazon
|
16011
|
+
# Web Services Regions and Amazon Web Services accounts for the
|
16012
|
+
# current Automation execution.
|
15892
16013
|
# @return [Integer]
|
15893
16014
|
#
|
15894
16015
|
# @!attribute [rw] cancelled_steps
|
15895
16016
|
# The total number of steps that the system cancelled in all specified
|
15896
|
-
# Regions and accounts for the
|
16017
|
+
# Amazon Web Services Regions and Amazon Web Services accounts for the
|
16018
|
+
# current Automation execution.
|
15897
16019
|
# @return [Integer]
|
15898
16020
|
#
|
15899
16021
|
# @!attribute [rw] timed_out_steps
|
15900
|
-
# The total number of steps that timed out in all specified
|
15901
|
-
# and accounts for the current
|
16022
|
+
# The total number of steps that timed out in all specified Amazon Web
|
16023
|
+
# Services Regions and Amazon Web Services accounts for the current
|
16024
|
+
# Automation execution.
|
15902
16025
|
# @return [Integer]
|
15903
16026
|
#
|
15904
16027
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ProgressCounters AWS API Documentation
|
@@ -16095,7 +16218,8 @@ module Aws::SSM
|
|
16095
16218
|
#
|
16096
16219
|
# * Parameter names are case sensitive.
|
16097
16220
|
#
|
16098
|
-
# * A parameter name must be unique within an
|
16221
|
+
# * A parameter name must be unique within an Amazon Web Services
|
16222
|
+
# Region
|
16099
16223
|
#
|
16100
16224
|
# * A parameter name can't be prefixed with "`aws`" or "`ssm`"
|
16101
16225
|
# (case-insensitive).
|
@@ -16171,11 +16295,11 @@ module Aws::SSM
|
|
16171
16295
|
# @!attribute [rw] key_id
|
16172
16296
|
# The Key Management Service (KMS) ID that you want to use to encrypt
|
16173
16297
|
# a parameter. Either the default KMS key automatically assigned to
|
16174
|
-
# your account or a custom key. Required for
|
16175
|
-
# `SecureString` data type.
|
16298
|
+
# your Amazon Web Services account or a custom key. Required for
|
16299
|
+
# parameters that use the `SecureString` data type.
|
16176
16300
|
#
|
16177
16301
|
# If you don't specify a key ID, the system uses the default key
|
16178
|
-
# associated with your account.
|
16302
|
+
# associated with your Amazon Web Services account.
|
16179
16303
|
#
|
16180
16304
|
# * To use your default KMS key, choose the `SecureString` data type,
|
16181
16305
|
# and do *not* specify the `Key ID` when you create the parameter.
|
@@ -16223,15 +16347,16 @@ module Aws::SSM
|
|
16223
16347
|
# Parameter Store offers a standard tier and an advanced tier for
|
16224
16348
|
# parameters. Standard parameters have a content size limit of 4 KB
|
16225
16349
|
# and can't be configured to use parameter policies. You can create a
|
16226
|
-
# maximum of 10,000 standard parameters for each Region in an
|
16227
|
-
# Standard parameters are offered at no
|
16350
|
+
# maximum of 10,000 standard parameters for each Region in an Amazon
|
16351
|
+
# Web Services account. Standard parameters are offered at no
|
16352
|
+
# additional cost.
|
16228
16353
|
#
|
16229
16354
|
# Advanced parameters have a content size limit of 8 KB and can be
|
16230
16355
|
# configured to use parameter policies. You can create a maximum of
|
16231
|
-
# 100,000 advanced parameters for each Region in an
|
16232
|
-
# parameters incur a charge. For more
|
16233
|
-
# advanced parameter tiers][1] in the
|
16234
|
-
# Manager User Guide*.
|
16356
|
+
# 100,000 advanced parameters for each Region in an Amazon Web
|
16357
|
+
# Services account. Advanced parameters incur a charge. For more
|
16358
|
+
# information, see [Standard and advanced parameter tiers][1] in the
|
16359
|
+
# *Amazon Web Services Systems Manager User Guide*.
|
16235
16360
|
#
|
16236
16361
|
# You can change a standard parameter to an advanced parameter any
|
16237
16362
|
# time. But you can't revert an advanced parameter to a standard
|
@@ -16281,8 +16406,8 @@ module Aws::SSM
|
|
16281
16406
|
#
|
16282
16407
|
# * The parameter uses a parameter policy.
|
16283
16408
|
#
|
16284
|
-
# * More than 10,000 parameters already exist in your
|
16285
|
-
# current Region.
|
16409
|
+
# * More than 10,000 parameters already exist in your Amazon Web
|
16410
|
+
# Services account in the current Amazon Web Services Region.
|
16286
16411
|
#
|
16287
16412
|
# For more information about configuring the default tier option, see
|
16288
16413
|
# [Specifying a default parameter tier][2] in the *Amazon Web Services
|
@@ -16338,10 +16463,10 @@ module Aws::SSM
|
|
16338
16463
|
# When you create a `String` parameter and specify `aws:ec2:image`,
|
16339
16464
|
# Amazon Web Services Systems Manager validates the parameter value is
|
16340
16465
|
# in the required format, such as `ami-12345abcdeEXAMPLE`, and that
|
16341
|
-
# the specified AMI is available in your account.
|
16342
|
-
# information, see [Native parameter support for Amazon
|
16343
|
-
# (AMI) IDs][1] in the *Amazon Web Services Systems
|
16344
|
-
# Guide*.
|
16466
|
+
# the specified AMI is available in your Amazon Web Services account.
|
16467
|
+
# For more information, see [Native parameter support for Amazon
|
16468
|
+
# Machine Image (AMI) IDs][1] in the *Amazon Web Services Systems
|
16469
|
+
# Manager User Guide*.
|
16345
16470
|
#
|
16346
16471
|
#
|
16347
16472
|
#
|
@@ -16362,7 +16487,7 @@ module Aws::SSM
|
|
16362
16487
|
:tier,
|
16363
16488
|
:policies,
|
16364
16489
|
:data_type)
|
16365
|
-
SENSITIVE = []
|
16490
|
+
SENSITIVE = [:value]
|
16366
16491
|
include Aws::Structure
|
16367
16492
|
end
|
16368
16493
|
|
@@ -16661,6 +16786,7 @@ module Aws::SSM
|
|
16661
16786
|
# name: "MaintenanceWindowName",
|
16662
16787
|
# description: "MaintenanceWindowDescription",
|
16663
16788
|
# client_token: "ClientToken",
|
16789
|
+
# cutoff_behavior: "CONTINUE_TASK", # accepts CONTINUE_TASK, CANCEL_TASK
|
16664
16790
|
# }
|
16665
16791
|
#
|
16666
16792
|
# @!attribute [rw] window_id
|
@@ -16800,6 +16926,28 @@ module Aws::SSM
|
|
16800
16926
|
# not need to pass this option.
|
16801
16927
|
# @return [String]
|
16802
16928
|
#
|
16929
|
+
# @!attribute [rw] cutoff_behavior
|
16930
|
+
# Indicates whether tasks should continue to run after the cutoff time
|
16931
|
+
# specified in the maintenance windows is reached.
|
16932
|
+
#
|
16933
|
+
# * `CONTINUE_TASK`\: When the cutoff time is reached, any tasks that
|
16934
|
+
# are running continue. The default value.
|
16935
|
+
#
|
16936
|
+
# * `CANCEL_TASK`\:
|
16937
|
+
#
|
16938
|
+
# * For Automation, Lambda, Step Functions tasks: When the cutoff
|
16939
|
+
# time is reached, any task invocations that are already running
|
16940
|
+
# continue, but no new task invocations are started.
|
16941
|
+
#
|
16942
|
+
# * For Run Command tasks: When the cutoff time is reached, the
|
16943
|
+
# system sends a CancelCommand operation that attempts to cancel
|
16944
|
+
# the command associated with the task. However, there is no
|
16945
|
+
# guarantee that the command will be terminated and the underlying
|
16946
|
+
# process stopped.
|
16947
|
+
#
|
16948
|
+
# The status for tasks that are not completed is `TIMED_OUT`.
|
16949
|
+
# @return [String]
|
16950
|
+
#
|
16803
16951
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/RegisterTaskWithMaintenanceWindowRequest AWS API Documentation
|
16804
16952
|
#
|
16805
16953
|
class RegisterTaskWithMaintenanceWindowRequest < Struct.new(
|
@@ -16816,7 +16964,8 @@ module Aws::SSM
|
|
16816
16964
|
:logging_info,
|
16817
16965
|
:name,
|
16818
16966
|
:description,
|
16819
|
-
:client_token
|
16967
|
+
:client_token,
|
16968
|
+
:cutoff_behavior)
|
16820
16969
|
SENSITIVE = [:task_parameters, :description]
|
16821
16970
|
include Aws::Structure
|
16822
16971
|
end
|
@@ -17060,7 +17209,7 @@ module Aws::SSM
|
|
17060
17209
|
# Information about the `AwsOrganizationsSource` resource data sync
|
17061
17210
|
# source. A sync source of this type can synchronize data from
|
17062
17211
|
# Organizations or, if an Amazon Web Services organization isn't
|
17063
|
-
# present, from multiple Regions.
|
17212
|
+
# present, from multiple Amazon Web Services Regions.
|
17064
17213
|
#
|
17065
17214
|
# @note When making an API call, you may pass ResourceDataSyncAwsOrganizationsSource
|
17066
17215
|
# data as a hash:
|
@@ -17123,9 +17272,10 @@ module Aws::SSM
|
|
17123
17272
|
end
|
17124
17273
|
|
17125
17274
|
# Synchronize Amazon Web Services Systems Manager Inventory data from
|
17126
|
-
# multiple accounts defined in Organizations to a
|
17127
|
-
# bucket. Data is synchronized to individual key
|
17128
|
-
# bucket. Each key prefix represents a different
|
17275
|
+
# multiple Amazon Web Services accounts defined in Organizations to a
|
17276
|
+
# centralized Amazon S3 bucket. Data is synchronized to individual key
|
17277
|
+
# prefixes in the central bucket. Each key prefix represents a different
|
17278
|
+
# Amazon Web Services account ID.
|
17129
17279
|
#
|
17130
17280
|
# @note When making an API call, you may pass ResourceDataSyncDestinationDataSharing
|
17131
17281
|
# data as a hash:
|
@@ -17171,7 +17321,7 @@ module Aws::SSM
|
|
17171
17321
|
# `SyncToDestination`, then the resource data sync synchronizes data
|
17172
17322
|
# to an S3 bucket. If the `SyncType` is `SyncFromSource` then the
|
17173
17323
|
# resource data sync synchronizes data from Organizations or from
|
17174
|
-
# multiple Regions.
|
17324
|
+
# multiple Amazon Web Services Regions.
|
17175
17325
|
# @return [String]
|
17176
17326
|
#
|
17177
17327
|
# @!attribute [rw] sync_source
|
@@ -17296,7 +17446,8 @@ module Aws::SSM
|
|
17296
17446
|
# @return [String]
|
17297
17447
|
#
|
17298
17448
|
# @!attribute [rw] region
|
17299
|
-
# The Region with the S3 bucket targeted by the
|
17449
|
+
# The Amazon Web Services Region with the S3 bucket targeted by the
|
17450
|
+
# resource data sync.
|
17300
17451
|
# @return [String]
|
17301
17452
|
#
|
17302
17453
|
# @!attribute [rw] awskms_key_arn
|
@@ -17355,21 +17506,23 @@ module Aws::SSM
|
|
17355
17506
|
# @return [Types::ResourceDataSyncAwsOrganizationsSource]
|
17356
17507
|
#
|
17357
17508
|
# @!attribute [rw] source_regions
|
17358
|
-
# The `SyncSource` Regions included in the
|
17509
|
+
# The `SyncSource` Amazon Web Services Regions included in the
|
17510
|
+
# resource data sync.
|
17359
17511
|
# @return [Array<String>]
|
17360
17512
|
#
|
17361
17513
|
# @!attribute [rw] include_future_regions
|
17362
17514
|
# Whether to automatically synchronize and aggregate data from new
|
17363
|
-
# Regions when those Regions come online.
|
17515
|
+
# Amazon Web Services Regions when those Regions come online.
|
17364
17516
|
# @return [Boolean]
|
17365
17517
|
#
|
17366
17518
|
# @!attribute [rw] enable_all_ops_data_sources
|
17367
17519
|
# When you create a resource data sync, if you choose one of the
|
17368
17520
|
# Organizations options, then Systems Manager automatically enables
|
17369
|
-
# all OpsData sources in the selected
|
17370
|
-
#
|
17371
|
-
# information, see [About
|
17372
|
-
# syncs][1] in the *Amazon
|
17521
|
+
# all OpsData sources in the selected Amazon Web Services Regions for
|
17522
|
+
# all Amazon Web Services accounts in your organization (or in the
|
17523
|
+
# selected organization units). For more information, see [About
|
17524
|
+
# multiple account and Region resource data syncs][1] in the *Amazon
|
17525
|
+
# Web Services Systems Manager User Guide*.
|
17373
17526
|
#
|
17374
17527
|
#
|
17375
17528
|
#
|
@@ -17415,12 +17568,13 @@ module Aws::SSM
|
|
17415
17568
|
# @return [Types::ResourceDataSyncAwsOrganizationsSource]
|
17416
17569
|
#
|
17417
17570
|
# @!attribute [rw] source_regions
|
17418
|
-
# The `SyncSource` Regions included in the
|
17571
|
+
# The `SyncSource` Amazon Web Services Regions included in the
|
17572
|
+
# resource data sync.
|
17419
17573
|
# @return [Array<String>]
|
17420
17574
|
#
|
17421
17575
|
# @!attribute [rw] include_future_regions
|
17422
17576
|
# Whether to automatically synchronize and aggregate data from new
|
17423
|
-
# Regions when those Regions come online.
|
17577
|
+
# Amazon Web Services Regions when those Regions come online.
|
17424
17578
|
# @return [Boolean]
|
17425
17579
|
#
|
17426
17580
|
# @!attribute [rw] state
|
@@ -17443,10 +17597,11 @@ module Aws::SSM
|
|
17443
17597
|
# @!attribute [rw] enable_all_ops_data_sources
|
17444
17598
|
# When you create a resource data sync, if you choose one of the
|
17445
17599
|
# Organizations options, then Systems Manager automatically enables
|
17446
|
-
# all OpsData sources in the selected
|
17447
|
-
#
|
17448
|
-
# information, see [About
|
17449
|
-
# syncs][1] in the *Amazon
|
17600
|
+
# all OpsData sources in the selected Amazon Web Services Regions for
|
17601
|
+
# all Amazon Web Services accounts in your organization (or in the
|
17602
|
+
# selected organization units). For more information, see [About
|
17603
|
+
# multiple account and Region resource data syncs][1] in the *Amazon
|
17604
|
+
# Web Services Systems Manager User Guide*.
|
17450
17605
|
#
|
17451
17606
|
#
|
17452
17607
|
#
|
@@ -17559,11 +17714,12 @@ module Aws::SSM
|
|
17559
17714
|
# Format:
|
17560
17715
|
# `wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)`.
|
17561
17716
|
#
|
17562
|
-
# **region** represents the Region identifier for an
|
17563
|
-
# by Amazon Web Services Systems Manager,
|
17564
|
-
# US East (Ohio) Region. For a list of
|
17565
|
-
# see the **Region** column in [Systems
|
17566
|
-
# in the *Amazon Web Services General
|
17717
|
+
# **region** represents the Region identifier for an Amazon Web
|
17718
|
+
# Services Region supported by Amazon Web Services Systems Manager,
|
17719
|
+
# such as `us-east-2` for the US East (Ohio) Region. For a list of
|
17720
|
+
# supported **region** values, see the **Region** column in [Systems
|
17721
|
+
# Manager service endpoints][1] in the *Amazon Web Services General
|
17722
|
+
# Reference*.
|
17567
17723
|
#
|
17568
17724
|
# **session-id** represents the ID of a Session Manager session, such
|
17569
17725
|
# as `1a2b3c4dEXAMPLE`.
|
@@ -17682,8 +17838,8 @@ module Aws::SSM
|
|
17682
17838
|
# @return [String]
|
17683
17839
|
#
|
17684
17840
|
# @!attribute [rw] target_locations
|
17685
|
-
# Information about the
|
17686
|
-
# Runbook operation.
|
17841
|
+
# Information about the Amazon Web Services Regions and Amazon Web
|
17842
|
+
# Services accounts targeted by the current Runbook operation.
|
17687
17843
|
# @return [Array<Types::TargetLocation>]
|
17688
17844
|
#
|
17689
17845
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/Runbook AWS API Documentation
|
@@ -17912,9 +18068,15 @@ module Aws::SSM
|
|
17912
18068
|
# The name of the Amazon Web Services Systems Manager document (SSM
|
17913
18069
|
# document) to run. This can be a public document or a custom
|
17914
18070
|
# document. To run a shared document belonging to another account,
|
17915
|
-
# specify the document ARN. For more
|
17916
|
-
# shared documents, see [Using shared SSM
|
17917
|
-
# Web Services Systems Manager User
|
18071
|
+
# specify the document Amazon Resource Name (ARN). For more
|
18072
|
+
# information about how to use shared documents, see [Using shared SSM
|
18073
|
+
# documents][1] in the *Amazon Web Services Systems Manager User
|
18074
|
+
# Guide*.
|
18075
|
+
#
|
18076
|
+
# <note markdown="1"> If you specify a document name or ARN that hasn't been shared with
|
18077
|
+
# your account, you receive an `InvalidDocument` error.
|
18078
|
+
#
|
18079
|
+
# </note>
|
17918
18080
|
#
|
17919
18081
|
#
|
17920
18082
|
#
|
@@ -17971,7 +18133,7 @@ module Aws::SSM
|
|
17971
18133
|
# @!attribute [rw] output_s3_region
|
17972
18134
|
# (Deprecated) You can no longer specify this parameter. The system
|
17973
18135
|
# ignores it. Instead, Systems Manager automatically determines the
|
17974
|
-
# Region of the S3 bucket.
|
18136
|
+
# Amazon Web Services Region of the S3 bucket.
|
17975
18137
|
# @return [String]
|
17976
18138
|
#
|
17977
18139
|
# @!attribute [rw] output_s3_bucket_name
|
@@ -18475,12 +18637,13 @@ module Aws::SSM
|
|
18475
18637
|
# @return [String]
|
18476
18638
|
#
|
18477
18639
|
# @!attribute [rw] target_locations
|
18478
|
-
# A location is a combination of Regions and/or
|
18479
|
-
# want to run the automation.
|
18480
|
-
#
|
18481
|
-
#
|
18482
|
-
#
|
18483
|
-
#
|
18640
|
+
# A location is a combination of Amazon Web Services Regions and/or
|
18641
|
+
# Amazon Web Services accounts where you want to run the automation.
|
18642
|
+
# Use this operation to start an automation in multiple Amazon Web
|
18643
|
+
# Services Regions and multiple Amazon Web Services accounts. For more
|
18644
|
+
# information, see [Running Automation workflows in multiple Amazon
|
18645
|
+
# Web Services Regions and Amazon Web Services accounts][1] in the
|
18646
|
+
# *Amazon Web Services Systems Manager User Guide*.
|
18484
18647
|
#
|
18485
18648
|
#
|
18486
18649
|
#
|
@@ -18637,8 +18800,8 @@ module Aws::SSM
|
|
18637
18800
|
# maximum of five tags for a change request. Tags enable you to
|
18638
18801
|
# categorize a resource in different ways, such as by purpose, owner,
|
18639
18802
|
# or environment. For example, you might want to tag a change request
|
18640
|
-
# to identify an environment or target Region. In
|
18641
|
-
# specify the following key-value pairs:
|
18803
|
+
# to identify an environment or target Amazon Web Services Region. In
|
18804
|
+
# this case, you could specify the following key-value pairs:
|
18642
18805
|
#
|
18643
18806
|
# * `Key=Environment,Value=Production`
|
18644
18807
|
#
|
@@ -18739,11 +18902,12 @@ module Aws::SSM
|
|
18739
18902
|
# Format:
|
18740
18903
|
# `wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)`
|
18741
18904
|
#
|
18742
|
-
# **region** represents the Region identifier for an
|
18743
|
-
# by Amazon Web Services Systems Manager,
|
18744
|
-
# US East (Ohio) Region. For a list of
|
18745
|
-
# see the **Region** column in [Systems
|
18746
|
-
# in the *Amazon Web Services General
|
18905
|
+
# **region** represents the Region identifier for an Amazon Web
|
18906
|
+
# Services Region supported by Amazon Web Services Systems Manager,
|
18907
|
+
# such as `us-east-2` for the US East (Ohio) Region. For a list of
|
18908
|
+
# supported **region** values, see the **Region** column in [Systems
|
18909
|
+
# Manager service endpoints][1] in the *Amazon Web Services General
|
18910
|
+
# Reference*.
|
18747
18911
|
#
|
18748
18912
|
# **session-id** represents the ID of a Session Manager session, such
|
18749
18913
|
# as `1a2b3c4dEXAMPLE`.
|
@@ -18869,8 +19033,8 @@ module Aws::SSM
|
|
18869
19033
|
# @return [Array<Types::Target>]
|
18870
19034
|
#
|
18871
19035
|
# @!attribute [rw] target_location
|
18872
|
-
# The combination of
|
18873
|
-
# Automation execution.
|
19036
|
+
# The combination of Amazon Web Services Regions and Amazon Web
|
19037
|
+
# Services accounts targeted by the current Automation execution.
|
18874
19038
|
# @return [Types::TargetLocation]
|
18875
19039
|
#
|
18876
19040
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/StepExecution AWS API Documentation
|
@@ -19066,7 +19230,7 @@ module Aws::SSM
|
|
19066
19230
|
# `Key=InstanceIds,Values=* `
|
19067
19231
|
#
|
19068
19232
|
# This example demonstrates how to target all managed instances in the
|
19069
|
-
# Region where the association was created.
|
19233
|
+
# Amazon Web Services Region where the association was created.
|
19070
19234
|
#
|
19071
19235
|
# For more information about how to send commands that target instances
|
19072
19236
|
# using `Key,Value` parameters, see [Targeting multiple instances][2] in
|
@@ -19124,8 +19288,8 @@ module Aws::SSM
|
|
19124
19288
|
include Aws::Structure
|
19125
19289
|
end
|
19126
19290
|
|
19127
|
-
# The combination of Regions and
|
19128
|
-
# Automation execution.
|
19291
|
+
# The combination of Amazon Web Services Regions and Amazon Web Services
|
19292
|
+
# accounts targeted by the current Automation execution.
|
19129
19293
|
#
|
19130
19294
|
# @note When making an API call, you may pass TargetLocation
|
19131
19295
|
# data as a hash:
|
@@ -19139,16 +19303,18 @@ module Aws::SSM
|
|
19139
19303
|
# }
|
19140
19304
|
#
|
19141
19305
|
# @!attribute [rw] accounts
|
19142
|
-
# The accounts targeted by the current Automation
|
19306
|
+
# The Amazon Web Services accounts targeted by the current Automation
|
19307
|
+
# execution.
|
19143
19308
|
# @return [Array<String>]
|
19144
19309
|
#
|
19145
19310
|
# @!attribute [rw] regions
|
19146
|
-
# The Regions targeted by the current Automation
|
19311
|
+
# The Amazon Web Services Regions targeted by the current Automation
|
19312
|
+
# execution.
|
19147
19313
|
# @return [Array<String>]
|
19148
19314
|
#
|
19149
19315
|
# @!attribute [rw] target_location_max_concurrency
|
19150
|
-
# The maximum number of
|
19151
|
-
# Automation concurrently.
|
19316
|
+
# The maximum number of Amazon Web Services Regions and Amazon Web
|
19317
|
+
# Services accounts allowed to run the Automation concurrently.
|
19152
19318
|
# @return [String]
|
19153
19319
|
#
|
19154
19320
|
# @!attribute [rw] target_location_max_errors
|
@@ -19501,8 +19667,8 @@ module Aws::SSM
|
|
19501
19667
|
# account.
|
19502
19668
|
#
|
19503
19669
|
# For Systems Manager document (SSM document) that are shared with you
|
19504
|
-
# from other accounts, you must specify the
|
19505
|
-
# in the following format:
|
19670
|
+
# from other Amazon Web Services accounts, you must specify the
|
19671
|
+
# complete SSM document ARN, in the following format:
|
19506
19672
|
#
|
19507
19673
|
# `arn:aws:ssm:region:account-id:document/document-name `
|
19508
19674
|
#
|
@@ -19617,9 +19783,10 @@ module Aws::SSM
|
|
19617
19783
|
# @return [Array<String>]
|
19618
19784
|
#
|
19619
19785
|
# @!attribute [rw] target_locations
|
19620
|
-
# A location is a combination of
|
19621
|
-
#
|
19622
|
-
# multiple Regions and
|
19786
|
+
# A location is a combination of Amazon Web Services Regions and
|
19787
|
+
# Amazon Web Services accounts where you want to run the association.
|
19788
|
+
# Use this action to update an association in multiple Regions and
|
19789
|
+
# multiple accounts.
|
19623
19790
|
# @return [Array<Types::TargetLocation>]
|
19624
19791
|
#
|
19625
19792
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateAssociationRequest AWS API Documentation
|
@@ -19677,7 +19844,7 @@ module Aws::SSM
|
|
19677
19844
|
# @return [String]
|
19678
19845
|
#
|
19679
19846
|
# @!attribute [rw] instance_id
|
19680
|
-
# The ID
|
19847
|
+
# The instance ID.
|
19681
19848
|
# @return [String]
|
19682
19849
|
#
|
19683
19850
|
# @!attribute [rw] association_status
|
@@ -19764,15 +19931,17 @@ module Aws::SSM
|
|
19764
19931
|
# }
|
19765
19932
|
#
|
19766
19933
|
# @!attribute [rw] name
|
19767
|
-
# The name of the
|
19934
|
+
# The name of the change template for which a version's metadata is
|
19935
|
+
# to be updated.
|
19768
19936
|
# @return [String]
|
19769
19937
|
#
|
19770
19938
|
# @!attribute [rw] document_version
|
19771
|
-
# The version of a
|
19939
|
+
# The version of a change template in which to update approval
|
19940
|
+
# metadata.
|
19772
19941
|
# @return [String]
|
19773
19942
|
#
|
19774
19943
|
# @!attribute [rw] document_reviews
|
19775
|
-
# The
|
19944
|
+
# The change template review details to update.
|
19776
19945
|
# @return [Types::DocumentReviews]
|
19777
19946
|
#
|
19778
19947
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateDocumentMetadataRequest AWS API Documentation
|
@@ -20260,6 +20429,7 @@ module Aws::SSM
|
|
20260
20429
|
# name: "MaintenanceWindowName",
|
20261
20430
|
# description: "MaintenanceWindowDescription",
|
20262
20431
|
# replace: false,
|
20432
|
+
# cutoff_behavior: "CONTINUE_TASK", # accepts CONTINUE_TASK, CANCEL_TASK
|
20263
20433
|
# }
|
20264
20434
|
#
|
20265
20435
|
# @!attribute [rw] window_id
|
@@ -20415,6 +20585,28 @@ module Aws::SSM
|
|
20415
20585
|
# null.
|
20416
20586
|
# @return [Boolean]
|
20417
20587
|
#
|
20588
|
+
# @!attribute [rw] cutoff_behavior
|
20589
|
+
# Indicates whether tasks should continue to run after the cutoff time
|
20590
|
+
# specified in the maintenance windows is reached.
|
20591
|
+
#
|
20592
|
+
# * `CONTINUE_TASK`\: When the cutoff time is reached, any tasks that
|
20593
|
+
# are running continue. The default value.
|
20594
|
+
#
|
20595
|
+
# * `CANCEL_TASK`\:
|
20596
|
+
#
|
20597
|
+
# * For Automation, Lambda, Step Functions tasks: When the cutoff
|
20598
|
+
# time is reached, any task invocations that are already running
|
20599
|
+
# continue, but no new task invocations are started.
|
20600
|
+
#
|
20601
|
+
# * For Run Command tasks: When the cutoff time is reached, the
|
20602
|
+
# system sends a CancelCommand operation that attempts to cancel
|
20603
|
+
# the command associated with the task. However, there is no
|
20604
|
+
# guarantee that the command will be terminated and the underlying
|
20605
|
+
# process stopped.
|
20606
|
+
#
|
20607
|
+
# The status for tasks that are not completed is `TIMED_OUT`.
|
20608
|
+
# @return [String]
|
20609
|
+
#
|
20418
20610
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateMaintenanceWindowTaskRequest AWS API Documentation
|
20419
20611
|
#
|
20420
20612
|
class UpdateMaintenanceWindowTaskRequest < Struct.new(
|
@@ -20431,7 +20623,8 @@ module Aws::SSM
|
|
20431
20623
|
:logging_info,
|
20432
20624
|
:name,
|
20433
20625
|
:description,
|
20434
|
-
:replace
|
20626
|
+
:replace,
|
20627
|
+
:cutoff_behavior)
|
20435
20628
|
SENSITIVE = [:task_parameters, :description]
|
20436
20629
|
include Aws::Structure
|
20437
20630
|
end
|
@@ -20509,6 +20702,11 @@ module Aws::SSM
|
|
20509
20702
|
# The updated task description.
|
20510
20703
|
# @return [String]
|
20511
20704
|
#
|
20705
|
+
# @!attribute [rw] cutoff_behavior
|
20706
|
+
# The specification for whether tasks should continue to run after the
|
20707
|
+
# cutoff time specified in the maintenance windows is reached.
|
20708
|
+
# @return [String]
|
20709
|
+
#
|
20512
20710
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateMaintenanceWindowTaskResult AWS API Documentation
|
20513
20711
|
#
|
20514
20712
|
class UpdateMaintenanceWindowTaskResult < Struct.new(
|
@@ -20524,7 +20722,8 @@ module Aws::SSM
|
|
20524
20722
|
:max_errors,
|
20525
20723
|
:logging_info,
|
20526
20724
|
:name,
|
20527
|
-
:description
|
20725
|
+
:description,
|
20726
|
+
:cutoff_behavior)
|
20528
20727
|
SENSITIVE = [:task_parameters, :description]
|
20529
20728
|
include Aws::Structure
|
20530
20729
|
end
|
@@ -21094,29 +21293,25 @@ module Aws::SSM
|
|
21094
21293
|
# @return [String]
|
21095
21294
|
#
|
21096
21295
|
# @!attribute [rw] setting_value
|
21097
|
-
# The new value to specify for the service setting.
|
21098
|
-
#
|
21099
|
-
# setting value can be one of the following.
|
21296
|
+
# The new value to specify for the service setting. The following list
|
21297
|
+
# specifies the available values for each setting.
|
21100
21298
|
#
|
21101
|
-
# * Standard
|
21299
|
+
# * `/ssm/parameter-store/default-parameter-tier`\: `Standard`,
|
21300
|
+
# `Advanced`, `Intelligent-Tiering`
|
21102
21301
|
#
|
21103
|
-
# *
|
21302
|
+
# * `/ssm/parameter-store/high-throughput-enabled`\: `true` or `false`
|
21104
21303
|
#
|
21105
|
-
# *
|
21304
|
+
# * `/ssm/managed-instance/activation-tier`\: `true` or `false`
|
21106
21305
|
#
|
21107
|
-
#
|
21108
|
-
# `/ssm/managed-instance/activation-tier` setting IDs, the setting
|
21109
|
-
# value can be true or false.
|
21306
|
+
# * `/ssm/automation/customer-script-log-destination`\: `CloudWatch`
|
21110
21307
|
#
|
21111
|
-
#
|
21112
|
-
#
|
21308
|
+
# * `/ssm/automation/customer-script-log-group-name`\: the name of an
|
21309
|
+
# Amazon CloudWatch Logs log group
|
21113
21310
|
#
|
21114
|
-
#
|
21115
|
-
#
|
21116
|
-
# group.
|
21311
|
+
# * `/ssm/documents/console/public-sharing-permission`\: `Enable` or
|
21312
|
+
# `Disable`
|
21117
21313
|
#
|
21118
|
-
#
|
21119
|
-
# ID, the setting value can be `Enable` or `Disable`.
|
21314
|
+
# * `/ssm/managed-instance/activation-tier`\: `standard` or `advanced`
|
21120
21315
|
# @return [String]
|
21121
21316
|
#
|
21122
21317
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateServiceSettingRequest AWS API Documentation
|