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.
@@ -442,10 +442,10 @@ module Aws::SSM
442
442
  req.send_request(options)
443
443
  end
444
444
 
445
- # Associates a related resource to a Systems Manager OpsCenter OpsItem.
446
- # For example, you can associate an Incident Manager incident or
447
- # analysis with an OpsItem. Incident Manager is a capability of Amazon
448
- # Web Services Systems Manager.
445
+ # Associates a related item to a Systems Manager OpsCenter OpsItem. For
446
+ # example, you can associate an Incident Manager incident or analysis
447
+ # with an OpsItem. Incident Manager and OpsCenter are capabilities of
448
+ # Amazon Web Services Systems Manager.
449
449
  #
450
450
  # @option params [required, String] :ops_item_id
451
451
  # The ID of the OpsItem to which you want to associate a resource as a
@@ -461,8 +461,6 @@ module Aws::SSM
461
461
  # OpsCenter supports the following types:
462
462
  #
463
463
  # `AWS::SSMIncidents::IncidentRecord`\: an Incident Manager incident.
464
- # Incident Manager is a capability of Amazon Web Services Systems
465
- # Manager.
466
464
  #
467
465
  # `AWS::SSM::Document`\: a Systems Manager (SSM) document.
468
466
  #
@@ -591,12 +589,12 @@ module Aws::SSM
591
589
  # Don't enter personally identifiable information in this field.
592
590
  #
593
591
  # @option params [required, String] :iam_role
594
- # The Identity and Access Management (IAM) role that you want to assign
595
- # to the managed instance. This IAMrole must provide AssumeRole
596
- # permissions for the Amazon Web Services Systems Manager service
597
- # principal `ssm.amazonaws.com`. For more information, see [Create an
598
- # IAM service role for a hybrid environment][1] in the *Amazon Web
599
- # Services Systems Manager User Guide*.
592
+ # The name of the Identity and Access Management (IAM) role that you
593
+ # want to assign to the managed instance. This IAM role must provide
594
+ # AssumeRole permissions for the Amazon Web Services Systems Manager
595
+ # service principal `ssm.amazonaws.com`. For more information, see
596
+ # [Create an IAM service role for a hybrid environment][1] in the
597
+ # *Amazon Web Services Systems Manager User Guide*.
600
598
  #
601
599
  #
602
600
  #
@@ -698,8 +696,8 @@ module Aws::SSM
698
696
  # account.
699
697
  #
700
698
  # For Systems Manager documents (SSM documents) that are shared with you
701
- # from other accounts, you must specify the complete SSM document ARN,
702
- # in the following format:
699
+ # from other Amazon Web Services accounts, you must specify the complete
700
+ # SSM document ARN, in the following format:
703
701
  #
704
702
  # `arn:partition:ssm:region:account-id:document/document-name `
705
703
  #
@@ -734,9 +732,9 @@ module Aws::SSM
734
732
  #
735
733
  # @option params [Array<Types::Target>] :targets
736
734
  # The targets for the association. You can target instances by using
737
- # tags, Amazon Web Services resource groups, all instances in an
738
- # account, or individual instance IDs. For more information about
739
- # choosing targets for an association, see [Using targets and rate
735
+ # tags, Amazon Web Services resource groups, all instances in an Amazon
736
+ # Web Services account, or individual instance IDs. For more information
737
+ # about choosing targets for an association, see [Using targets and rate
740
738
  # controls with State Manager associations][1] in the *Amazon Web
741
739
  # Services Systems Manager User Guide*.
742
740
  #
@@ -826,9 +824,10 @@ module Aws::SSM
826
824
  # [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar
827
825
  #
828
826
  # @option params [Array<Types::TargetLocation>] :target_locations
829
- # A location is a combination of Regions and accounts where you want to
830
- # run the association. Use this action to create an association in
831
- # multiple Regions and multiple accounts.
827
+ # A location is a combination of Amazon Web Services Regions and Amazon
828
+ # Web Services accounts where you want to run the association. Use this
829
+ # action to create an association in multiple Regions and multiple
830
+ # accounts.
832
831
  #
833
832
  # @return [Types::CreateAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
834
833
  #
@@ -1617,8 +1616,8 @@ module Aws::SSM
1617
1616
  # maximum of five tags for an OpsMetadata object. Tags enable you to
1618
1617
  # categorize a resource in different ways, such as by purpose, owner, or
1619
1618
  # environment. For example, you might want to tag an OpsMetadata object
1620
- # to identify an environment or target Region. In this case, you could
1621
- # specify the following key-value pairs:
1619
+ # to identify an environment or target Amazon Web Services Region. In
1620
+ # this case, you could specify the following key-value pairs:
1622
1621
  #
1623
1622
  # * `Key=Environment,Value=Production`
1624
1623
  #
@@ -1836,18 +1835,20 @@ module Aws::SSM
1836
1835
  #
1837
1836
  # You can configure Systems Manager Inventory to use the
1838
1837
  # `SyncToDestination` type to synchronize Inventory data from multiple
1839
- # Regions to a single Amazon Simple Storage Service (Amazon S3) bucket.
1840
- # For more information, see [Configuring resource data sync for
1841
- # Inventory][1] in the *Amazon Web Services Systems Manager User Guide*.
1838
+ # Amazon Web Services Regions to a single Amazon Simple Storage Service
1839
+ # (Amazon S3) bucket. For more information, see [Configuring resource
1840
+ # data sync for Inventory][1] in the *Amazon Web Services Systems
1841
+ # Manager User Guide*.
1842
1842
  #
1843
1843
  # You can configure Systems Manager Explorer to use the `SyncFromSource`
1844
1844
  # type to synchronize operational work items (OpsItems) and operational
1845
- # data (OpsData) from multiple Regions to a single Amazon S3 bucket.
1846
- # This type can synchronize OpsItems and OpsData from multiple accounts
1847
- # and Regions or `EntireOrganization` by using Organizations. For more
1848
- # information, see [Setting up Systems Manager Explorer to display data
1849
- # from multiple accounts and Regions][2] in the *Amazon Web Services
1850
- # Systems Manager User Guide*.
1845
+ # data (OpsData) from multiple Amazon Web Services Regions to a single
1846
+ # Amazon S3 bucket. This type can synchronize OpsItems and OpsData from
1847
+ # multiple Amazon Web Services accounts and Amazon Web Services Regions
1848
+ # or `EntireOrganization` by using Organizations. For more information,
1849
+ # see [Setting up Systems Manager Explorer to display data from multiple
1850
+ # accounts and Regions][2] in the *Amazon Web Services Systems Manager
1851
+ # User Guide*.
1851
1852
  #
1852
1853
  # A resource data sync is an asynchronous operation that returns
1853
1854
  # immediately. After a successful initial sync is completed, the system
@@ -1878,10 +1879,10 @@ module Aws::SSM
1878
1879
  # synchronizes data to an S3 bucket for Inventory. If you specify
1879
1880
  # `SyncToDestination`, you must provide a value for `S3Destination`.
1880
1881
  # Specify `SyncFromSource` to synchronize data from a single account and
1881
- # multiple Regions, or multiple accounts and Regions, as listed in
1882
- # Organizations for Explorer. If you specify `SyncFromSource`, you must
1883
- # provide a value for `SyncSource`. The default value is
1884
- # `SyncToDestination`.
1882
+ # multiple Regions, or multiple Amazon Web Services accounts and Amazon
1883
+ # Web Services Regions, as listed in Organizations for Explorer. If you
1884
+ # specify `SyncFromSource`, you must provide a value for `SyncSource`.
1885
+ # The default value is `SyncToDestination`.
1885
1886
  #
1886
1887
  # @option params [Types::ResourceDataSyncSource] :sync_source
1887
1888
  # Specify information about the data sources to synchronize. This
@@ -1956,7 +1957,9 @@ module Aws::SSM
1956
1957
  end
1957
1958
 
1958
1959
  # Disassociates the specified Amazon Web Services Systems Manager
1959
- # document (SSM document) from the specified instance.
1960
+ # document (SSM document) from the specified instance. If you created
1961
+ # the association by using the `Targets` parameter, then you must delete
1962
+ # the association by using the association ID.
1960
1963
  #
1961
1964
  # When you disassociate a document from an instance, it doesn't change
1962
1965
  # the configuration of the instance. To change the configuration state
@@ -1968,7 +1971,18 @@ module Aws::SSM
1968
1971
  # The name of the SSM document.
1969
1972
  #
1970
1973
  # @option params [String] :instance_id
1971
- # The ID of the instance.
1974
+ # The instance ID.
1975
+ #
1976
+ # <note markdown="1"> `InstanceId` has been deprecated. To specify an instance ID for an
1977
+ # association, use the `Targets` parameter. Requests that include the
1978
+ # parameter `InstanceID` with Systems Manager documents (SSM documents)
1979
+ # that use schema version 2.0 or later will fail. In addition, if you
1980
+ # use the parameter `InstanceId`, you can't use the parameters
1981
+ # `AssociationName`, `DocumentVersion`, `MaxErrors`, `MaxConcurrency`,
1982
+ # `OutputLocation`, or `ScheduleExpression`. To use these parameters,
1983
+ # you must use the `Targets` parameter.
1984
+ #
1985
+ # </note>
1972
1986
  #
1973
1987
  # @option params [String] :association_id
1974
1988
  # The association ID that you want to delete.
@@ -2157,7 +2171,8 @@ module Aws::SSM
2157
2171
  req.send_request(options)
2158
2172
  end
2159
2173
 
2160
- # Delete a parameter from the system.
2174
+ # Delete a parameter from the system. After deleting a parameter, wait
2175
+ # for at least 30 seconds to create a parameter with the same name.
2161
2176
  #
2162
2177
  # @option params [required, String] :name
2163
2178
  # The name of the parameter to delete.
@@ -2179,10 +2194,12 @@ module Aws::SSM
2179
2194
  req.send_request(options)
2180
2195
  end
2181
2196
 
2182
- # Delete a list of parameters.
2197
+ # Delete a list of parameters. After deleting a parameter, wait for at
2198
+ # least 30 seconds to create a parameter with the same name.
2183
2199
  #
2184
2200
  # @option params [required, Array<String>] :names
2185
- # The names of the parameters to delete.
2201
+ # The names of the parameters to delete. After deleting a parameter,
2202
+ # wait for at least 30 seconds to create a parameter with the same name.
2186
2203
  #
2187
2204
  # @return [Types::DeleteParametersResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2188
2205
  #
@@ -2468,10 +2485,7 @@ module Aws::SSM
2468
2485
 
2469
2486
  # Describes the association for the specified target or instance. If you
2470
2487
  # created the association by using the `Targets` parameter, then you
2471
- # must retrieve the association by using the association ID. If you
2472
- # created the association by specifying an instance ID and an Amazon Web
2473
- # Services Systems Manager document (SSM document), then you retrieve
2474
- # the association by specifying the document name and the instance ID.
2488
+ # must retrieve the association by using the association ID.
2475
2489
  #
2476
2490
  # @option params [String] :name
2477
2491
  # The name of the SSM document.
@@ -3157,7 +3171,8 @@ module Aws::SSM
3157
3171
  # Describes the permissions for a Amazon Web Services Systems Manager
3158
3172
  # document (SSM document). If you created the document, you are the
3159
3173
  # owner. If a document is shared, it can either be shared privately (by
3160
- # specifying a user's account ID) or publicly (*All*).
3174
+ # specifying a user's Amazon Web Services account ID) or publicly
3175
+ # (*All*).
3161
3176
  #
3162
3177
  # @option params [required, String] :name
3163
3178
  # The name of the document for which you are the owner.
@@ -4177,6 +4192,7 @@ module Aws::SSM
4177
4192
  # resp.tasks[0].max_errors #=> String
4178
4193
  # resp.tasks[0].name #=> String
4179
4194
  # resp.tasks[0].description #=> String
4195
+ # resp.tasks[0].cutoff_behavior #=> String, one of "CONTINUE_TASK", "CANCEL_TASK"
4180
4196
  # resp.next_token #=> String
4181
4197
  #
4182
4198
  # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeMaintenanceWindowTasks AWS API Documentation
@@ -4188,7 +4204,7 @@ module Aws::SSM
4188
4204
  req.send_request(options)
4189
4205
  end
4190
4206
 
4191
- # Retrieves the maintenance windows in an account.
4207
+ # Retrieves the maintenance windows in an Amazon Web Services account.
4192
4208
  #
4193
4209
  # @option params [Array<Types::MaintenanceWindowFilter>] :filters
4194
4210
  # Optional filters used to narrow down the scope of the returned
@@ -4460,6 +4476,11 @@ module Aws::SSM
4460
4476
  # You can specify the `NextToken` in a subsequent call to get the next
4461
4477
  # set of results.
4462
4478
  #
4479
+ # If you change the KMS key alias for the KMS key used to encrypt a
4480
+ # parameter, then you must also update the key alias the parameter uses
4481
+ # to reference KMS. Otherwise, `DescribeParameters` retrieves whatever
4482
+ # the original key alias was referencing.
4483
+ #
4463
4484
  # @option params [Array<Types::ParametersFilter>] :filters
4464
4485
  # This data type is deprecated. Instead, use `ParameterFilters`.
4465
4486
  #
@@ -4530,7 +4551,7 @@ module Aws::SSM
4530
4551
  req.send_request(options)
4531
4552
  end
4532
4553
 
4533
- # Lists the patch baselines in your account.
4554
+ # Lists the patch baselines in your Amazon Web Services account.
4534
4555
  #
4535
4556
  # @option params [Array<Types::PatchOrchestratorFilter>] :filters
4536
4557
  # Each element in the array is a structure containing a key-value pair.
@@ -4877,18 +4898,18 @@ module Aws::SSM
4877
4898
  req.send_request(options)
4878
4899
  end
4879
4900
 
4880
- # Deletes the association between an OpsItem and a related resource. For
4901
+ # Deletes the association between an OpsItem and a related item. For
4881
4902
  # example, this API operation can delete an Incident Manager incident
4882
4903
  # from an OpsItem. Incident Manager is a capability of Amazon Web
4883
4904
  # Services Systems Manager.
4884
4905
  #
4885
4906
  # @option params [required, String] :ops_item_id
4886
4907
  # The ID of the OpsItem for which you want to delete an association
4887
- # between the OpsItem and a related resource.
4908
+ # between the OpsItem and a related item.
4888
4909
  #
4889
4910
  # @option params [required, String] :association_id
4890
4911
  # The ID of the association for which you want to delete an association
4891
- # between the OpsItem and a related resource.
4912
+ # between the OpsItem and a related item.
4892
4913
  #
4893
4914
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
4894
4915
  #
@@ -5217,7 +5238,7 @@ module Aws::SSM
5217
5238
  # connections.
5218
5239
  #
5219
5240
  # @option params [required, String] :target
5220
- # The ID of the instance.
5241
+ # The instance ID.
5221
5242
  #
5222
5243
  # @return [Types::GetConnectionStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5223
5244
  #
@@ -5285,13 +5306,14 @@ module Aws::SSM
5285
5306
  # Manager document (SSM document).
5286
5307
  #
5287
5308
  # <note markdown="1"> If you run the command locally, such as with the Command Line
5288
- # Interface (CLI), the system attempts to use your local AWS credentials
5289
- # and the operation fails. To avoid this, you can run the command in the
5290
- # Amazon Web Services Systems Manager console. Use Run Command, a
5291
- # capability of Amazon Web Services Systems Manager, with an SSM
5292
- # document that enables you to target an instance with a script or
5293
- # command. For example, run the command using the `AWS-RunShellScript`
5294
- # document or the `AWS-RunPowerShellScript` document.
5309
+ # Interface (CLI), the system attempts to use your local Amazon Web
5310
+ # Services credentials and the operation fails. To avoid this, you can
5311
+ # run the command in the Amazon Web Services Systems Manager console.
5312
+ # Use Run Command, a capability of Amazon Web Services Systems Manager,
5313
+ # with an SSM document that enables you to target an instance with a
5314
+ # script or command. For example, run the command using the
5315
+ # `AWS-RunShellScript` document or the `AWS-RunPowerShellScript`
5316
+ # document.
5295
5317
  #
5296
5318
  # </note>
5297
5319
  #
@@ -5452,7 +5474,8 @@ module Aws::SSM
5452
5474
  req.send_request(options)
5453
5475
  end
5454
5476
 
5455
- # Query inventory information.
5477
+ # Query inventory information. This includes instance status, such as
5478
+ # `Stopped` or `Terminated`.
5456
5479
  #
5457
5480
  # @option params [Array<Types::InventoryFilter>] :filters
5458
5481
  # One or more filters. Use a filter to return a more specific list of
@@ -5856,6 +5879,7 @@ module Aws::SSM
5856
5879
  # * {Types::GetMaintenanceWindowTaskResult#logging_info #logging_info} => Types::LoggingInfo
5857
5880
  # * {Types::GetMaintenanceWindowTaskResult#name #name} => String
5858
5881
  # * {Types::GetMaintenanceWindowTaskResult#description #description} => String
5882
+ # * {Types::GetMaintenanceWindowTaskResult#cutoff_behavior #cutoff_behavior} => String
5859
5883
  #
5860
5884
  # @example Request syntax with placeholder values
5861
5885
  #
@@ -5912,6 +5936,7 @@ module Aws::SSM
5912
5936
  # resp.logging_info.s3_region #=> String
5913
5937
  # resp.name #=> String
5914
5938
  # resp.description #=> String
5939
+ # resp.cutoff_behavior #=> String, one of "CONTINUE_TASK", "CANCEL_TASK"
5915
5940
  #
5916
5941
  # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetMaintenanceWindowTask AWS API Documentation
5917
5942
  #
@@ -6130,12 +6155,20 @@ module Aws::SSM
6130
6155
  req.send_request(options)
6131
6156
  end
6132
6157
 
6133
- # Get information about a parameter by using the parameter name. Don't
6134
- # confuse this API operation with the GetParameters API operation.
6158
+ # Get information about a single parameter by specifying the parameter
6159
+ # name.
6160
+ #
6161
+ # <note markdown="1"> To get information about more than one parameter at a time, use the
6162
+ # GetParameters operation.
6163
+ #
6164
+ # </note>
6135
6165
  #
6136
6166
  # @option params [required, String] :name
6137
6167
  # The name of the parameter you want to query.
6138
6168
  #
6169
+ # To query by parameter label, use `"Name": "name:label"`. To query by
6170
+ # parameter version, use `"Name": "name:version"`.
6171
+ #
6139
6172
  # @option params [Boolean] :with_decryption
6140
6173
  # Return decrypted values for secure string parameters. This flag is
6141
6174
  # ignored for `String` and `StringList` parameter types.
@@ -6174,6 +6207,11 @@ module Aws::SSM
6174
6207
 
6175
6208
  # Retrieves the history of all changes to a parameter.
6176
6209
  #
6210
+ # If you change the KMS key alias for the KMS key used to encrypt a
6211
+ # parameter, then you must also update the key alias the parameter uses
6212
+ # to reference KMS. Otherwise, `GetParameterHistory` retrieves whatever
6213
+ # the original key alias was referencing.
6214
+ #
6177
6215
  # @option params [required, String] :name
6178
6216
  # The name of the parameter for which you want to review history.
6179
6217
  #
@@ -6237,12 +6275,20 @@ module Aws::SSM
6237
6275
  req.send_request(options)
6238
6276
  end
6239
6277
 
6240
- # Get details of a parameter. Don't confuse this API operation with the
6241
- # GetParameter API operation.
6278
+ # Get information about one or more parameters by specifying multiple
6279
+ # parameter names.
6280
+ #
6281
+ # <note markdown="1"> To get information about a single parameter, you can use the
6282
+ # GetParameter operation instead.
6283
+ #
6284
+ # </note>
6242
6285
  #
6243
6286
  # @option params [required, Array<String>] :names
6244
6287
  # Names of the parameters for which you want to query information.
6245
6288
  #
6289
+ # To query by parameter label, use `"Name": "name:label"`. To query by
6290
+ # parameter version, use `"Name": "name:version"`.
6291
+ #
6246
6292
  # @option params [Boolean] :with_decryption
6247
6293
  # Return decrypted secure string value. Return decrypted values for
6248
6294
  # secure string parameters. This flag is ignored for `String` and
@@ -6317,11 +6363,11 @@ module Aws::SSM
6317
6363
  # @option params [Array<Types::ParameterStringFilter>] :parameter_filters
6318
6364
  # Filters to limit the request results.
6319
6365
  #
6320
- # <note markdown="1"> For `GetParametersByPath`, the following filter `Key` names are
6321
- # supported: `Type`, `KeyId`, `Label`, and `DataType`.
6366
+ # <note markdown="1"> The following `Key` values are supported for `GetParametersByPath`\:
6367
+ # `Type`, `KeyId`, and `Label`.
6322
6368
  #
6323
- # The following `Key` values are not supported for
6324
- # `GetParametersByPath`\: `tag`, `Name`, `Path`, and `Tier`.
6369
+ # The following `Key` values aren't supported for
6370
+ # `GetParametersByPath`\: `tag`, `DataType`, `Name`, `Path`, and `Tier`.
6325
6371
  #
6326
6372
  # </note>
6327
6373
  #
@@ -6389,6 +6435,15 @@ module Aws::SSM
6389
6435
  # @option params [required, String] :baseline_id
6390
6436
  # The ID of the patch baseline to retrieve.
6391
6437
  #
6438
+ # <note markdown="1"> To retrieve information about an Amazon Web Services managed patch
6439
+ # baseline, specify the full Amazon Resource Name (ARN) of the baseline.
6440
+ # For example, for the baseline `AWS-AmazonLinuxDefaultPatchBaseline`,
6441
+ # specify
6442
+ # `arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0e392de35e7c563b7`
6443
+ # instead of `pb-0e392de35e7c563b7`.
6444
+ #
6445
+ # </note>
6446
+ #
6392
6447
  # @return [Types::GetPatchBaselineResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6393
6448
  #
6394
6449
  # * {Types::GetPatchBaselineResult#baseline_id #baseline_id} => String
@@ -6514,7 +6569,7 @@ module Aws::SSM
6514
6569
  # back to the original value defined by the Amazon Web Services service
6515
6570
  # team.
6516
6571
  #
6517
- # Query the current service setting for the account.
6572
+ # Query the current service setting for the Amazon Web Services account.
6518
6573
  #
6519
6574
  # @option params [required, String] :setting_id
6520
6575
  # The ID of the service setting to get. The setting ID can be one of the
@@ -6707,10 +6762,11 @@ module Aws::SSM
6707
6762
  req.send_request(options)
6708
6763
  end
6709
6764
 
6710
- # Returns all State Manager associations in the current account and
6711
- # Region. You can limit the results to a specific State Manager
6712
- # association document or instance by specifying a filter. State Manager
6713
- # is a capability of Amazon Web Services Systems Manager.
6765
+ # Returns all State Manager associations in the current Amazon Web
6766
+ # Services account and Amazon Web Services Region. You can limit the
6767
+ # results to a specific State Manager association document or instance
6768
+ # by specifying a filter. State Manager is a capability of Amazon Web
6769
+ # Services Systems Manager.
6714
6770
  #
6715
6771
  # @option params [Array<Types::AssociationFilter>] :association_filter_list
6716
6772
  # One or more filters. Use a filter to return a more specific list of
@@ -6881,7 +6937,8 @@ module Aws::SSM
6881
6937
  req.send_request(options)
6882
6938
  end
6883
6939
 
6884
- # Lists the commands requested by users of the account.
6940
+ # Lists the commands requested by users of the Amazon Web Services
6941
+ # account.
6885
6942
  #
6886
6943
  # @option params [String] :command_id
6887
6944
  # (Optional) If provided, lists only the specified command.
@@ -7121,13 +7178,14 @@ module Aws::SSM
7121
7178
  req.send_request(options)
7122
7179
  end
7123
7180
 
7124
- # Information about approval reviews for a version of an SSM document.
7181
+ # Information about approval reviews for a version of a change template
7182
+ # in Change Manager.
7125
7183
  #
7126
7184
  # @option params [required, String] :name
7127
- # The name of the document.
7185
+ # The name of the change template.
7128
7186
  #
7129
7187
  # @option params [String] :document_version
7130
- # The version of the document.
7188
+ # The version of the change template.
7131
7189
  #
7132
7190
  # @option params [required, String] :metadata
7133
7191
  # The type of data for which details are being requested. Currently, the
@@ -7238,8 +7296,9 @@ module Aws::SSM
7238
7296
  req.send_request(options)
7239
7297
  end
7240
7298
 
7241
- # Returns all Systems Manager (SSM) documents in the current account and
7242
- # Region. You can limit the results of this request by using a filter.
7299
+ # Returns all Systems Manager (SSM) documents in the current Amazon Web
7300
+ # Services account and Amazon Web Services Region. You can limit the
7301
+ # results of this request by using a filter.
7243
7302
  #
7244
7303
  # @option params [Array<Types::DocumentFilter>] :document_filter_list
7245
7304
  # This data type is deprecated. Instead, use `Filters`.
@@ -7394,9 +7453,10 @@ module Aws::SSM
7394
7453
  req.send_request(options)
7395
7454
  end
7396
7455
 
7397
- # Returns a list of all OpsItem events in the current Region and
7398
- # account. You can limit the results to events associated with specific
7399
- # OpsItems by specifying a filter.
7456
+ # Returns a list of all OpsItem events in the current Amazon Web
7457
+ # Services Region and Amazon Web Services account. You can limit the
7458
+ # results to events associated with specific OpsItems by specifying a
7459
+ # filter.
7400
7460
  #
7401
7461
  # @option params [Array<Types::OpsItemEventFilter>] :filters
7402
7462
  # One or more OpsItem filters. Use a filter to return a more specific
@@ -7453,7 +7513,9 @@ module Aws::SSM
7453
7513
  req.send_request(options)
7454
7514
  end
7455
7515
 
7456
- # Lists all related-item resources associated with an OpsItem.
7516
+ # Lists all related-item resources associated with a Systems Manager
7517
+ # OpsCenter OpsItem. OpsCenter is a capability of Amazon Web Services
7518
+ # Systems Manager.
7457
7519
  #
7458
7520
  # @option params [String] :ops_item_id
7459
7521
  # The ID of the OpsItem for which you want to list all related-item
@@ -7664,7 +7726,7 @@ module Aws::SSM
7664
7726
  # View a list of resource data syncs according to the sync type. Specify
7665
7727
  # `SyncToDestination` to view resource data syncs that synchronize data
7666
7728
  # to an Amazon S3 bucket. Specify `SyncFromSource` to view resource data
7667
- # syncs from Organizations or from multiple Regions.
7729
+ # syncs from Organizations or from multiple Amazon Web Services Regions.
7668
7730
  #
7669
7731
  # @option params [String] :next_token
7670
7732
  # A token to start the list. Use this token to get the next set of
@@ -8002,7 +8064,7 @@ module Aws::SSM
8002
8064
  #
8003
8065
  # * Parameter names are case sensitive.
8004
8066
  #
8005
- # * A parameter name must be unique within an Region
8067
+ # * A parameter name must be unique within an Amazon Web Services Region
8006
8068
  #
8007
8069
  # * A parameter name can't be prefixed with "`aws`" or "`ssm`"
8008
8070
  # (case-insensitive).
@@ -8073,11 +8135,11 @@ module Aws::SSM
8073
8135
  # @option params [String] :key_id
8074
8136
  # The Key Management Service (KMS) ID that you want to use to encrypt a
8075
8137
  # parameter. Either the default KMS key automatically assigned to your
8076
- # account or a custom key. Required for parameters that use the
8077
- # `SecureString` data type.
8138
+ # Amazon Web Services account or a custom key. Required for parameters
8139
+ # that use the `SecureString` data type.
8078
8140
  #
8079
8141
  # If you don't specify a key ID, the system uses the default key
8080
- # associated with your account.
8142
+ # associated with your Amazon Web Services account.
8081
8143
  #
8082
8144
  # * To use your default KMS key, choose the `SecureString` data type,
8083
8145
  # and do *not* specify the `Key ID` when you create the parameter. The
@@ -8120,15 +8182,16 @@ module Aws::SSM
8120
8182
  # Parameter Store offers a standard tier and an advanced tier for
8121
8183
  # parameters. Standard parameters have a content size limit of 4 KB and
8122
8184
  # can't be configured to use parameter policies. You can create a
8123
- # maximum of 10,000 standard parameters for each Region in an account.
8124
- # Standard parameters are offered at no additional cost.
8185
+ # maximum of 10,000 standard parameters for each Region in an Amazon Web
8186
+ # Services account. Standard parameters are offered at no additional
8187
+ # cost.
8125
8188
  #
8126
8189
  # Advanced parameters have a content size limit of 8 KB and can be
8127
8190
  # configured to use parameter policies. You can create a maximum of
8128
- # 100,000 advanced parameters for each Region in an account. Advanced
8129
- # parameters incur a charge. For more information, see [Standard and
8130
- # advanced parameter tiers][1] in the *Amazon Web Services Systems
8131
- # Manager User Guide*.
8191
+ # 100,000 advanced parameters for each Region in an Amazon Web Services
8192
+ # account. Advanced parameters incur a charge. For more information, see
8193
+ # [Standard and advanced parameter tiers][1] in the *Amazon Web Services
8194
+ # Systems Manager User Guide*.
8132
8195
  #
8133
8196
  # You can change a standard parameter to an advanced parameter any time.
8134
8197
  # But you can't revert an advanced parameter to a standard parameter.
@@ -8178,8 +8241,8 @@ module Aws::SSM
8178
8241
  #
8179
8242
  # * The parameter uses a parameter policy.
8180
8243
  #
8181
- # * More than 10,000 parameters already exist in your account in the
8182
- # current Region.
8244
+ # * More than 10,000 parameters already exist in your Amazon Web
8245
+ # Services account in the current Amazon Web Services Region.
8183
8246
  #
8184
8247
  # For more information about configuring the default tier option, see
8185
8248
  # [Specifying a default parameter tier][2] in the *Amazon Web Services
@@ -8232,9 +8295,10 @@ module Aws::SSM
8232
8295
  # When you create a `String` parameter and specify `aws:ec2:image`,
8233
8296
  # Amazon Web Services Systems Manager validates the parameter value is
8234
8297
  # in the required format, such as `ami-12345abcdeEXAMPLE`, and that the
8235
- # specified AMI is available in your account. For more information, see
8236
- # [Native parameter support for Amazon Machine Image (AMI) IDs][1] in
8237
- # the *Amazon Web Services Systems Manager User Guide*.
8298
+ # specified AMI is available in your Amazon Web Services account. For
8299
+ # more information, see [Native parameter support for Amazon Machine
8300
+ # Image (AMI) IDs][1] in the *Amazon Web Services Systems Manager User
8301
+ # Guide*.
8238
8302
  #
8239
8303
  #
8240
8304
  #
@@ -8586,6 +8650,27 @@ module Aws::SSM
8586
8650
  # **A suitable default value is auto-generated.** You should normally
8587
8651
  # not need to pass this option.**
8588
8652
  #
8653
+ # @option params [String] :cutoff_behavior
8654
+ # Indicates whether tasks should continue to run after the cutoff time
8655
+ # specified in the maintenance windows is reached.
8656
+ #
8657
+ # * `CONTINUE_TASK`\: When the cutoff time is reached, any tasks that
8658
+ # are running continue. The default value.
8659
+ #
8660
+ # * `CANCEL_TASK`\:
8661
+ #
8662
+ # * For Automation, Lambda, Step Functions tasks: When the cutoff time
8663
+ # is reached, any task invocations that are already running
8664
+ # continue, but no new task invocations are started.
8665
+ #
8666
+ # * For Run Command tasks: When the cutoff time is reached, the system
8667
+ # sends a CancelCommand operation that attempts to cancel the
8668
+ # command associated with the task. However, there is no guarantee
8669
+ # that the command will be terminated and the underlying process
8670
+ # stopped.
8671
+ #
8672
+ # The status for tasks that are not completed is `TIMED_OUT`.
8673
+ #
8589
8674
  # @return [Types::RegisterTaskWithMaintenanceWindowResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
8590
8675
  #
8591
8676
  # * {Types::RegisterTaskWithMaintenanceWindowResult#window_task_id #window_task_id} => String
@@ -8658,6 +8743,7 @@ module Aws::SSM
8658
8743
  # name: "MaintenanceWindowName",
8659
8744
  # description: "MaintenanceWindowDescription",
8660
8745
  # client_token: "ClientToken",
8746
+ # cutoff_behavior: "CONTINUE_TASK", # accepts CONTINUE_TASK, CANCEL_TASK
8661
8747
  # })
8662
8748
  #
8663
8749
  # @example Response structure
@@ -8932,9 +9018,14 @@ module Aws::SSM
8932
9018
  # The name of the Amazon Web Services Systems Manager document (SSM
8933
9019
  # document) to run. This can be a public document or a custom document.
8934
9020
  # To run a shared document belonging to another account, specify the
8935
- # document ARN. For more information about how to use shared documents,
8936
- # see [Using shared SSM documents][1] in the *Amazon Web Services
8937
- # Systems Manager User Guide*.
9021
+ # document Amazon Resource Name (ARN). For more information about how to
9022
+ # use shared documents, see [Using shared SSM documents][1] in the
9023
+ # *Amazon Web Services Systems Manager User Guide*.
9024
+ #
9025
+ # <note markdown="1"> If you specify a document name or ARN that hasn't been shared with
9026
+ # your account, you receive an `InvalidDocument` error.
9027
+ #
9028
+ # </note>
8938
9029
  #
8939
9030
  #
8940
9031
  #
@@ -8984,7 +9075,7 @@ module Aws::SSM
8984
9075
  # @option params [String] :output_s3_region
8985
9076
  # (Deprecated) You can no longer specify this parameter. The system
8986
9077
  # ignores it. Instead, Systems Manager automatically determines the
8987
- # Region of the S3 bucket.
9078
+ # Amazon Web Services Region of the S3 bucket.
8988
9079
  #
8989
9080
  # @option params [String] :output_s3_bucket_name
8990
9081
  # The name of the S3 bucket where command execution responses should be
@@ -9205,11 +9296,13 @@ module Aws::SSM
9205
9296
  # executions proceed one at a time.
9206
9297
  #
9207
9298
  # @option params [Array<Types::TargetLocation>] :target_locations
9208
- # A location is a combination of Regions and/or accounts where you want
9209
- # to run the automation. Use this operation to start an automation in
9210
- # multiple Regions and multiple accounts. For more information, see
9211
- # [Running Automation workflows in multiple Regions and accounts][1] in
9212
- # the *Amazon Web Services Systems Manager User Guide*.
9299
+ # A location is a combination of Amazon Web Services Regions and/or
9300
+ # Amazon Web Services accounts where you want to run the automation. Use
9301
+ # this operation to start an automation in multiple Amazon Web Services
9302
+ # Regions and multiple Amazon Web Services accounts. For more
9303
+ # information, see [Running Automation workflows in multiple Amazon Web
9304
+ # Services Regions and Amazon Web Services accounts][1] in the *Amazon
9305
+ # Web Services Systems Manager User Guide*.
9213
9306
  #
9214
9307
  #
9215
9308
  #
@@ -9339,8 +9432,8 @@ module Aws::SSM
9339
9432
  # maximum of five tags for a change request. Tags enable you to
9340
9433
  # categorize a resource in different ways, such as by purpose, owner, or
9341
9434
  # environment. For example, you might want to tag a change request to
9342
- # identify an environment or target Region. In this case, you could
9343
- # specify the following key-value pairs:
9435
+ # identify an environment or target Amazon Web Services Region. In this
9436
+ # case, you could specify the following key-value pairs:
9344
9437
  #
9345
9438
  # * `Key=Environment,Value=Production`
9346
9439
  #
@@ -9628,8 +9721,8 @@ module Aws::SSM
9628
9721
  # account.
9629
9722
  #
9630
9723
  # For Systems Manager document (SSM document) that are shared with you
9631
- # from other accounts, you must specify the complete SSM document ARN,
9632
- # in the following format:
9724
+ # from other Amazon Web Services accounts, you must specify the complete
9725
+ # SSM document ARN, in the following format:
9633
9726
  #
9634
9727
  # `arn:aws:ssm:region:account-id:document/document-name `
9635
9728
  #
@@ -9732,9 +9825,10 @@ module Aws::SSM
9732
9825
  # [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar
9733
9826
  #
9734
9827
  # @option params [Array<Types::TargetLocation>] :target_locations
9735
- # A location is a combination of Regions and accounts where you want to
9736
- # run the association. Use this action to update an association in
9737
- # multiple Regions and multiple accounts.
9828
+ # A location is a combination of Amazon Web Services Regions and Amazon
9829
+ # Web Services accounts where you want to run the association. Use this
9830
+ # action to update an association in multiple Regions and multiple
9831
+ # accounts.
9738
9832
  #
9739
9833
  # @return [Types::UpdateAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
9740
9834
  #
@@ -9843,11 +9937,16 @@ module Aws::SSM
9843
9937
  # Updates the status of the Amazon Web Services Systems Manager document
9844
9938
  # (SSM document) associated with the specified instance.
9845
9939
  #
9940
+ # `UpdateAssociationStatus` is primarily used by the Amazon Web Services
9941
+ # Systems Manager Agent (SSM Agent) to report status updates about your
9942
+ # associations and is only used for associations created with the
9943
+ # `InstanceId` legacy parameter.
9944
+ #
9846
9945
  # @option params [required, String] :name
9847
9946
  # The name of the SSM document.
9848
9947
  #
9849
9948
  # @option params [required, String] :instance_id
9850
- # The ID of the instance.
9949
+ # The instance ID.
9851
9950
  #
9852
9951
  # @option params [required, Types::AssociationStatus] :association_status
9853
9952
  # The association status.
@@ -10076,16 +10175,17 @@ module Aws::SSM
10076
10175
  end
10077
10176
 
10078
10177
  # Updates information related to approval reviews for a specific version
10079
- # of a document.
10178
+ # of a change template in Change Manager.
10080
10179
  #
10081
10180
  # @option params [required, String] :name
10082
- # The name of the document for which a version is to be updated.
10181
+ # The name of the change template for which a version's metadata is to
10182
+ # be updated.
10083
10183
  #
10084
10184
  # @option params [String] :document_version
10085
- # The version of a document to update.
10185
+ # The version of a change template in which to update approval metadata.
10086
10186
  #
10087
10187
  # @option params [required, Types::DocumentReviews] :document_reviews
10088
- # The document review details to update.
10188
+ # The change template review details to update.
10089
10189
  #
10090
10190
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
10091
10191
  #
@@ -10530,6 +10630,27 @@ module Aws::SSM
10530
10630
  # RegisterTaskWithMaintenanceWindow operation are also required for this
10531
10631
  # API request. Optional fields that aren't specified are set to null.
10532
10632
  #
10633
+ # @option params [String] :cutoff_behavior
10634
+ # Indicates whether tasks should continue to run after the cutoff time
10635
+ # specified in the maintenance windows is reached.
10636
+ #
10637
+ # * `CONTINUE_TASK`\: When the cutoff time is reached, any tasks that
10638
+ # are running continue. The default value.
10639
+ #
10640
+ # * `CANCEL_TASK`\:
10641
+ #
10642
+ # * For Automation, Lambda, Step Functions tasks: When the cutoff time
10643
+ # is reached, any task invocations that are already running
10644
+ # continue, but no new task invocations are started.
10645
+ #
10646
+ # * For Run Command tasks: When the cutoff time is reached, the system
10647
+ # sends a CancelCommand operation that attempts to cancel the
10648
+ # command associated with the task. However, there is no guarantee
10649
+ # that the command will be terminated and the underlying process
10650
+ # stopped.
10651
+ #
10652
+ # The status for tasks that are not completed is `TIMED_OUT`.
10653
+ #
10533
10654
  # @return [Types::UpdateMaintenanceWindowTaskResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
10534
10655
  #
10535
10656
  # * {Types::UpdateMaintenanceWindowTaskResult#window_id #window_id} => String
@@ -10545,6 +10666,7 @@ module Aws::SSM
10545
10666
  # * {Types::UpdateMaintenanceWindowTaskResult#logging_info #logging_info} => Types::LoggingInfo
10546
10667
  # * {Types::UpdateMaintenanceWindowTaskResult#name #name} => String
10547
10668
  # * {Types::UpdateMaintenanceWindowTaskResult#description #description} => String
10669
+ # * {Types::UpdateMaintenanceWindowTaskResult#cutoff_behavior #cutoff_behavior} => String
10548
10670
  #
10549
10671
  # @example Request syntax with placeholder values
10550
10672
  #
@@ -10614,6 +10736,7 @@ module Aws::SSM
10614
10736
  # name: "MaintenanceWindowName",
10615
10737
  # description: "MaintenanceWindowDescription",
10616
10738
  # replace: false,
10739
+ # cutoff_behavior: "CONTINUE_TASK", # accepts CONTINUE_TASK, CANCEL_TASK
10617
10740
  # })
10618
10741
  #
10619
10742
  # @example Response structure
@@ -10663,6 +10786,7 @@ module Aws::SSM
10663
10786
  # resp.logging_info.s3_region #=> String
10664
10787
  # resp.name #=> String
10665
10788
  # resp.description #=> String
10789
+ # resp.cutoff_behavior #=> String, one of "CONTINUE_TASK", "CANCEL_TASK"
10666
10790
  #
10667
10791
  # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateMaintenanceWindowTask AWS API Documentation
10668
10792
  #
@@ -11179,29 +11303,25 @@ module Aws::SSM
11179
11303
  # * `/ssm/managed-instance/activation-tier`
11180
11304
  #
11181
11305
  # @option params [required, String] :setting_value
11182
- # The new value to specify for the service setting. For the
11183
- # `/ssm/parameter-store/default-parameter-tier` setting ID, the setting
11184
- # value can be one of the following.
11306
+ # The new value to specify for the service setting. The following list
11307
+ # specifies the available values for each setting.
11185
11308
  #
11186
- # * Standard
11309
+ # * `/ssm/parameter-store/default-parameter-tier`\: `Standard`,
11310
+ # `Advanced`, `Intelligent-Tiering`
11187
11311
  #
11188
- # * Advanced
11312
+ # * `/ssm/parameter-store/high-throughput-enabled`\: `true` or `false`
11189
11313
  #
11190
- # * Intelligent-Tiering
11314
+ # * `/ssm/managed-instance/activation-tier`\: `true` or `false`
11191
11315
  #
11192
- # For the `/ssm/parameter-store/high-throughput-enabled`, and
11193
- # `/ssm/managed-instance/activation-tier` setting IDs, the setting value
11194
- # can be true or false.
11316
+ # * `/ssm/automation/customer-script-log-destination`\: `CloudWatch`
11195
11317
  #
11196
- # For the `/ssm/automation/customer-script-log-destination` setting ID,
11197
- # the setting value can be `CloudWatch`.
11318
+ # * `/ssm/automation/customer-script-log-group-name`\: the name of an
11319
+ # Amazon CloudWatch Logs log group
11198
11320
  #
11199
- # For the `/ssm/automation/customer-script-log-group-name` setting ID,
11200
- # the setting value can be the name of an Amazon CloudWatch Logs log
11201
- # group.
11321
+ # * `/ssm/documents/console/public-sharing-permission`\: `Enable` or
11322
+ # `Disable`
11202
11323
  #
11203
- # For the `/ssm/documents/console/public-sharing-permission` setting ID,
11204
- # the setting value can be `Enable` or `Disable`.
11324
+ # * `/ssm/managed-instance/activation-tier`\: `standard` or `advanced`
11205
11325
  #
11206
11326
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
11207
11327
  #
@@ -11234,7 +11354,7 @@ module Aws::SSM
11234
11354
  params: params,
11235
11355
  config: config)
11236
11356
  context[:gem_name] = 'aws-sdk-ssm'
11237
- context[:gem_version] = '1.114.0'
11357
+ context[:gem_version] = '1.118.0'
11238
11358
  Seahorse::Client::Request.new(handlers, context)
11239
11359
  end
11240
11360