aws-sdk-ssm 1.105.0 → 1.110.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 +638 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-ssm.rb +2 -2
- data/lib/aws-sdk-ssm/client.rb +358 -37
- data/lib/aws-sdk-ssm/client_api.rb +171 -1
- data/lib/aws-sdk-ssm/customizations.rb +1 -1
- data/lib/aws-sdk-ssm/errors.rb +43 -1
- data/lib/aws-sdk-ssm/resource.rb +1 -1
- data/lib/aws-sdk-ssm/types.rb +669 -62
- data/lib/aws-sdk-ssm/waiters.rb +1 -1
- metadata +9 -7
data/lib/aws-sdk-ssm/resource.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
data/lib/aws-sdk-ssm/types.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -100,7 +100,7 @@ module Aws::SSM
|
|
100
100
|
# data as a hash:
|
101
101
|
#
|
102
102
|
# {
|
103
|
-
# resource_type: "Document", # required, accepts Document, ManagedInstance, MaintenanceWindow, Parameter, PatchBaseline, OpsItem
|
103
|
+
# resource_type: "Document", # required, accepts Document, ManagedInstance, MaintenanceWindow, Parameter, PatchBaseline, OpsItem, OpsMetadata
|
104
104
|
# resource_id: "ResourceId", # required
|
105
105
|
# tags: [ # required
|
106
106
|
# {
|
@@ -132,6 +132,15 @@ module Aws::SSM
|
|
132
132
|
#
|
133
133
|
# PatchBaseline: pb-012345abcde
|
134
134
|
#
|
135
|
+
# OpsMetadata object: `ResourceID` for tagging is created from the
|
136
|
+
# Amazon Resource Name (ARN) for the object. Specifically,
|
137
|
+
# `ResourceID` is created from the strings that come after the word
|
138
|
+
# `opsmetadata` in the ARN. For example, an OpsMetadata object with an
|
139
|
+
# ARN of
|
140
|
+
# `arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager`
|
141
|
+
# has a `ResourceID` of either `aws/ssm/MyGroup/appmanager` or
|
142
|
+
# `/aws/ssm/MyGroup/appmanager`.
|
143
|
+
#
|
135
144
|
# For the Document and Parameter values, use the name of the resource.
|
136
145
|
#
|
137
146
|
# <note markdown="1"> The ManagedInstance type for this API action is only for on-premises
|
@@ -143,9 +152,7 @@ module Aws::SSM
|
|
143
152
|
# @return [String]
|
144
153
|
#
|
145
154
|
# @!attribute [rw] tags
|
146
|
-
# One or more tags. The value parameter is required
|
147
|
-
# want the tag to have a value, specify the parameter with no value,
|
148
|
-
# and we set the value to an empty string.
|
155
|
+
# One or more tags. The value parameter is required.
|
149
156
|
#
|
150
157
|
# Do not enter personally identifiable information in this field.
|
151
158
|
# @return [Array<Types::Tag>]
|
@@ -179,6 +186,65 @@ module Aws::SSM
|
|
179
186
|
include Aws::Structure
|
180
187
|
end
|
181
188
|
|
189
|
+
# @note When making an API call, you may pass AssociateOpsItemRelatedItemRequest
|
190
|
+
# data as a hash:
|
191
|
+
#
|
192
|
+
# {
|
193
|
+
# ops_item_id: "OpsItemId", # required
|
194
|
+
# association_type: "OpsItemRelatedItemAssociationType", # required
|
195
|
+
# resource_type: "OpsItemRelatedItemAssociationResourceType", # required
|
196
|
+
# resource_uri: "OpsItemRelatedItemAssociationResourceUri", # required
|
197
|
+
# }
|
198
|
+
#
|
199
|
+
# @!attribute [rw] ops_item_id
|
200
|
+
# The ID of the OpsItem to which you want to associate a resource as a
|
201
|
+
# related item.
|
202
|
+
# @return [String]
|
203
|
+
#
|
204
|
+
# @!attribute [rw] association_type
|
205
|
+
# The type of association that you want to create between an OpsItem
|
206
|
+
# and a resource. OpsCenter supports `IsParentOf` and `RelatesTo`
|
207
|
+
# association types.
|
208
|
+
# @return [String]
|
209
|
+
#
|
210
|
+
# @!attribute [rw] resource_type
|
211
|
+
# The type of resource that you want to associate with an OpsItem.
|
212
|
+
# OpsCenter supports the following types:
|
213
|
+
#
|
214
|
+
# `AWS::SSMIncidents::IncidentRecord`\: an Incident Manager incident.
|
215
|
+
# Incident Manager is a capability of AWS Systems Manager.
|
216
|
+
#
|
217
|
+
# `AWS::SSM::Document`\: a Systems Manager (SSM) document.
|
218
|
+
# @return [String]
|
219
|
+
#
|
220
|
+
# @!attribute [rw] resource_uri
|
221
|
+
# The Amazon Resource Name (ARN) of the AWS resource that you want to
|
222
|
+
# associate with the OpsItem.
|
223
|
+
# @return [String]
|
224
|
+
#
|
225
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/AssociateOpsItemRelatedItemRequest AWS API Documentation
|
226
|
+
#
|
227
|
+
class AssociateOpsItemRelatedItemRequest < Struct.new(
|
228
|
+
:ops_item_id,
|
229
|
+
:association_type,
|
230
|
+
:resource_type,
|
231
|
+
:resource_uri)
|
232
|
+
SENSITIVE = []
|
233
|
+
include Aws::Structure
|
234
|
+
end
|
235
|
+
|
236
|
+
# @!attribute [rw] association_id
|
237
|
+
# The association ID.
|
238
|
+
# @return [String]
|
239
|
+
#
|
240
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/AssociateOpsItemRelatedItemResponse AWS API Documentation
|
241
|
+
#
|
242
|
+
class AssociateOpsItemRelatedItemResponse < Struct.new(
|
243
|
+
:association_id)
|
244
|
+
SENSITIVE = []
|
245
|
+
include Aws::Structure
|
246
|
+
end
|
247
|
+
|
182
248
|
# You must disassociate a document from all instances before you can
|
183
249
|
# delete it.
|
184
250
|
#
|
@@ -225,7 +291,7 @@ module Aws::SSM
|
|
225
291
|
#
|
226
292
|
# @!attribute [rw] schedule_expression
|
227
293
|
# A cron expression that specifies a schedule when the association
|
228
|
-
# runs.
|
294
|
+
# runs. The schedule runs in Coordinated Universal Time (UTC).
|
229
295
|
# @return [String]
|
230
296
|
#
|
231
297
|
# @!attribute [rw] association_name
|
@@ -388,6 +454,17 @@ module Aws::SSM
|
|
388
454
|
# supported for rate expressions.
|
389
455
|
# @return [Boolean]
|
390
456
|
#
|
457
|
+
# @!attribute [rw] calendar_names
|
458
|
+
# The names or Amazon Resource Names (ARNs) of the Systems Manager
|
459
|
+
# Change Calendar type documents your associations are gated under.
|
460
|
+
# The associations only run when that Change Calendar is open. For
|
461
|
+
# more information, see [AWS Systems Manager Change Calendar][1].
|
462
|
+
#
|
463
|
+
#
|
464
|
+
#
|
465
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar
|
466
|
+
# @return [Array<String>]
|
467
|
+
#
|
391
468
|
# @!attribute [rw] target_locations
|
392
469
|
# The combination of AWS Regions and AWS accounts where you want to
|
393
470
|
# run the association.
|
@@ -418,6 +495,7 @@ module Aws::SSM
|
|
418
495
|
:compliance_severity,
|
419
496
|
:sync_compliance,
|
420
497
|
:apply_only_at_cron_interval,
|
498
|
+
:calendar_names,
|
421
499
|
:target_locations)
|
422
500
|
SENSITIVE = []
|
423
501
|
include Aws::Structure
|
@@ -825,6 +903,18 @@ module Aws::SSM
|
|
825
903
|
# supported for rate expressions.
|
826
904
|
# @return [Boolean]
|
827
905
|
#
|
906
|
+
# @!attribute [rw] calendar_names
|
907
|
+
# The names or Amazon Resource Names (ARNs) of the Systems Manager
|
908
|
+
# Change Calendar type documents your associations are gated under.
|
909
|
+
# The associations for this version only run when that Change Calendar
|
910
|
+
# is open. For more information, see [AWS Systems Manager Change
|
911
|
+
# Calendar][1].
|
912
|
+
#
|
913
|
+
#
|
914
|
+
#
|
915
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar
|
916
|
+
# @return [Array<String>]
|
917
|
+
#
|
828
918
|
# @!attribute [rw] target_locations
|
829
919
|
# The combination of AWS Regions and AWS accounts where you wanted to
|
830
920
|
# run the association when this association version was created.
|
@@ -848,6 +938,7 @@ module Aws::SSM
|
|
848
938
|
:compliance_severity,
|
849
939
|
:sync_compliance,
|
850
940
|
:apply_only_at_cron_interval,
|
941
|
+
:calendar_names,
|
851
942
|
:target_locations)
|
852
943
|
SENSITIVE = []
|
853
944
|
include Aws::Structure
|
@@ -2566,8 +2657,10 @@ module Aws::SSM
|
|
2566
2657
|
# @return [Integer]
|
2567
2658
|
#
|
2568
2659
|
# @!attribute [rw] expiration_date
|
2569
|
-
# The date by which this activation request should expire
|
2570
|
-
#
|
2660
|
+
# The date by which this activation request should expire, in
|
2661
|
+
# timestamp format, such as "2021-07-07T00:00:00". You can specify a
|
2662
|
+
# date up to 30 days in advance. If you don't provide an expiration
|
2663
|
+
# date, the activation code expires in 24 hours.
|
2571
2664
|
# @return [Time]
|
2572
2665
|
#
|
2573
2666
|
# @!attribute [rw] tags
|
@@ -2663,6 +2756,7 @@ module Aws::SSM
|
|
2663
2756
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
2664
2757
|
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
2665
2758
|
# apply_only_at_cron_interval: false,
|
2759
|
+
# calendar_names: ["CalendarNameOrARN"],
|
2666
2760
|
# target_locations: [
|
2667
2761
|
# {
|
2668
2762
|
# accounts: ["Account"],
|
@@ -2722,6 +2816,7 @@ module Aws::SSM
|
|
2722
2816
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
2723
2817
|
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
2724
2818
|
# apply_only_at_cron_interval: false,
|
2819
|
+
# calendar_names: ["CalendarNameOrARN"],
|
2725
2820
|
# target_locations: [
|
2726
2821
|
# {
|
2727
2822
|
# accounts: ["Account"],
|
@@ -2850,6 +2945,17 @@ module Aws::SSM
|
|
2850
2945
|
# supported for rate expressions.
|
2851
2946
|
# @return [Boolean]
|
2852
2947
|
#
|
2948
|
+
# @!attribute [rw] calendar_names
|
2949
|
+
# The names or Amazon Resource Names (ARNs) of the Systems Manager
|
2950
|
+
# Change Calendar type documents your associations are gated under.
|
2951
|
+
# The associations only run when that Change Calendar is open. For
|
2952
|
+
# more information, see [AWS Systems Manager Change Calendar][1].
|
2953
|
+
#
|
2954
|
+
#
|
2955
|
+
#
|
2956
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar
|
2957
|
+
# @return [Array<String>]
|
2958
|
+
#
|
2853
2959
|
# @!attribute [rw] target_locations
|
2854
2960
|
# Use this action to create an association in multiple Regions and
|
2855
2961
|
# multiple accounts.
|
@@ -2872,6 +2978,7 @@ module Aws::SSM
|
|
2872
2978
|
:compliance_severity,
|
2873
2979
|
:sync_compliance,
|
2874
2980
|
:apply_only_at_cron_interval,
|
2981
|
+
:calendar_names,
|
2875
2982
|
:target_locations)
|
2876
2983
|
SENSITIVE = []
|
2877
2984
|
include Aws::Structure
|
@@ -2925,6 +3032,7 @@ module Aws::SSM
|
|
2925
3032
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
2926
3033
|
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
2927
3034
|
# apply_only_at_cron_interval: false,
|
3035
|
+
# calendar_names: ["CalendarNameOrARN"],
|
2928
3036
|
# target_locations: [
|
2929
3037
|
# {
|
2930
3038
|
# accounts: ["Account"],
|
@@ -3067,13 +3175,24 @@ module Aws::SSM
|
|
3067
3175
|
# @return [String]
|
3068
3176
|
#
|
3069
3177
|
# @!attribute [rw] apply_only_at_cron_interval
|
3070
|
-
# By default, when you create a new
|
3178
|
+
# By default, when you create a new association, the system runs it
|
3071
3179
|
# immediately after it is created and then according to the schedule
|
3072
3180
|
# you specified. Specify this option if you don't want an association
|
3073
3181
|
# to run immediately after you create it. This parameter is not
|
3074
3182
|
# supported for rate expressions.
|
3075
3183
|
# @return [Boolean]
|
3076
3184
|
#
|
3185
|
+
# @!attribute [rw] calendar_names
|
3186
|
+
# The names or Amazon Resource Names (ARNs) of the Systems Manager
|
3187
|
+
# Change Calendar type documents you want to gate your associations
|
3188
|
+
# under. The associations only run when that Change Calendar is open.
|
3189
|
+
# For more information, see [AWS Systems Manager Change Calendar][1].
|
3190
|
+
#
|
3191
|
+
#
|
3192
|
+
#
|
3193
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar
|
3194
|
+
# @return [Array<String>]
|
3195
|
+
#
|
3077
3196
|
# @!attribute [rw] target_locations
|
3078
3197
|
# A location is a combination of AWS Regions and AWS accounts where
|
3079
3198
|
# you want to run the association. Use this action to create an
|
@@ -3097,6 +3216,7 @@ module Aws::SSM
|
|
3097
3216
|
:compliance_severity,
|
3098
3217
|
:sync_compliance,
|
3099
3218
|
:apply_only_at_cron_interval,
|
3219
|
+
:calendar_names,
|
3100
3220
|
:target_locations)
|
3101
3221
|
SENSITIVE = []
|
3102
3222
|
include Aws::Structure
|
@@ -3133,8 +3253,9 @@ module Aws::SSM
|
|
3133
3253
|
# },
|
3134
3254
|
# ],
|
3135
3255
|
# name: "DocumentName", # required
|
3256
|
+
# display_name: "DocumentDisplayName",
|
3136
3257
|
# version_name: "DocumentVersionName",
|
3137
|
-
# document_type: "Command", # accepts Command, Policy, Automation, Session, Package, ApplicationConfiguration, ApplicationConfigurationSchema, DeploymentStrategy, ChangeCalendar, Automation.ChangeTemplate
|
3258
|
+
# document_type: "Command", # accepts Command, Policy, Automation, Session, Package, ApplicationConfiguration, ApplicationConfigurationSchema, DeploymentStrategy, ChangeCalendar, Automation.ChangeTemplate, ProblemAnalysis, ProblemAnalysisTemplate
|
3138
3259
|
# document_format: "YAML", # accepts YAML, JSON, TEXT
|
3139
3260
|
# target_type: "TargetType",
|
3140
3261
|
# tags: [
|
@@ -3198,6 +3319,13 @@ module Aws::SSM
|
|
3198
3319
|
# * `amzn`
|
3199
3320
|
# @return [String]
|
3200
3321
|
#
|
3322
|
+
# @!attribute [rw] display_name
|
3323
|
+
# An optional field where you can specify a friendly name for the
|
3324
|
+
# Systems Manager document. This value can differ for each version of
|
3325
|
+
# the document. You can update this value at a later time using the
|
3326
|
+
# UpdateDocument action.
|
3327
|
+
# @return [String]
|
3328
|
+
#
|
3201
3329
|
# @!attribute [rw] version_name
|
3202
3330
|
# An optional field specifying the version of the artifact you are
|
3203
3331
|
# creating with the document. For example, "Release 12, Update 6".
|
@@ -3253,6 +3381,7 @@ module Aws::SSM
|
|
3253
3381
|
:requires,
|
3254
3382
|
:attachments,
|
3255
3383
|
:name,
|
3384
|
+
:display_name,
|
3256
3385
|
:version_name,
|
3257
3386
|
:document_type,
|
3258
3387
|
:document_format,
|
@@ -3632,6 +3761,12 @@ module Aws::SSM
|
|
3632
3761
|
# value: "MetadataValueString",
|
3633
3762
|
# },
|
3634
3763
|
# },
|
3764
|
+
# tags: [
|
3765
|
+
# {
|
3766
|
+
# key: "TagKey", # required
|
3767
|
+
# value: "TagValue", # required
|
3768
|
+
# },
|
3769
|
+
# ],
|
3635
3770
|
# }
|
3636
3771
|
#
|
3637
3772
|
# @!attribute [rw] resource_id
|
@@ -3642,11 +3777,25 @@ module Aws::SSM
|
|
3642
3777
|
# Metadata for a new Application Manager application.
|
3643
3778
|
# @return [Hash<String,Types::MetadataValue>]
|
3644
3779
|
#
|
3780
|
+
# @!attribute [rw] tags
|
3781
|
+
# Optional metadata that you assign to a resource. You can specify a
|
3782
|
+
# maximum of five tags for an OpsMetadata object. Tags enable you to
|
3783
|
+
# categorize a resource in different ways, such as by purpose, owner,
|
3784
|
+
# or environment. For example, you might want to tag an OpsMetadata
|
3785
|
+
# object to identify an environment or target AWS Region. In this
|
3786
|
+
# case, you could specify the following key-value pairs:
|
3787
|
+
#
|
3788
|
+
# * `Key=Environment,Value=Production`
|
3789
|
+
#
|
3790
|
+
# * `Key=Region,Value=us-east-2`
|
3791
|
+
# @return [Array<Types::Tag>]
|
3792
|
+
#
|
3645
3793
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateOpsMetadataRequest AWS API Documentation
|
3646
3794
|
#
|
3647
3795
|
class CreateOpsMetadataRequest < Struct.new(
|
3648
3796
|
:resource_id,
|
3649
|
-
:metadata
|
3797
|
+
:metadata,
|
3798
|
+
:tags)
|
3650
3799
|
SENSITIVE = []
|
3651
3800
|
include Aws::Structure
|
3652
3801
|
end
|
@@ -3885,6 +4034,7 @@ module Aws::SSM
|
|
3885
4034
|
# },
|
3886
4035
|
# source_regions: ["ResourceDataSyncSourceRegion"], # required
|
3887
4036
|
# include_future_regions: false,
|
4037
|
+
# enable_all_ops_data_sources: false,
|
3888
4038
|
# },
|
3889
4039
|
# }
|
3890
4040
|
#
|
@@ -4849,8 +4999,8 @@ module Aws::SSM
|
|
4849
4999
|
# @return [Integer]
|
4850
5000
|
#
|
4851
5001
|
# @!attribute [rw] reverse_order
|
4852
|
-
#
|
4853
|
-
#
|
5002
|
+
# Indicates whether to list step executions in reverse order by start
|
5003
|
+
# time. The default value is 'false'.
|
4854
5004
|
# @return [Boolean]
|
4855
5005
|
#
|
4856
5006
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeAutomationStepExecutionsRequest AWS API Documentation
|
@@ -6399,6 +6549,28 @@ module Aws::SSM
|
|
6399
6549
|
# Inventory.
|
6400
6550
|
# @return [Integer]
|
6401
6551
|
#
|
6552
|
+
# @!attribute [rw] instances_with_critical_non_compliant_patches
|
6553
|
+
# The number of instances where patches that are specified as
|
6554
|
+
# "Critical" for compliance reporting in the patch baseline are not
|
6555
|
+
# installed. These patches might be missing, have failed installation,
|
6556
|
+
# were rejected, or were installed but awaiting a required instance
|
6557
|
+
# reboot. The status of these instances is `NON_COMPLIANT`.
|
6558
|
+
# @return [Integer]
|
6559
|
+
#
|
6560
|
+
# @!attribute [rw] instances_with_security_non_compliant_patches
|
6561
|
+
# The number of instances where patches that are specified as
|
6562
|
+
# "Security" in a patch advisory are not installed. These patches
|
6563
|
+
# might be missing, have failed installation, were rejected, or were
|
6564
|
+
# installed but awaiting a required instance reboot. The status of
|
6565
|
+
# these instances is `NON_COMPLIANT`.
|
6566
|
+
# @return [Integer]
|
6567
|
+
#
|
6568
|
+
# @!attribute [rw] instances_with_other_non_compliant_patches
|
6569
|
+
# The number of instances with patches installed that are specified as
|
6570
|
+
# other than "Critical" or "Security" but are not compliant with
|
6571
|
+
# the patch baseline. The status of these instances is NON\_COMPLIANT.
|
6572
|
+
# @return [Integer]
|
6573
|
+
#
|
6402
6574
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribePatchGroupStateResult AWS API Documentation
|
6403
6575
|
#
|
6404
6576
|
class DescribePatchGroupStateResult < Struct.new(
|
@@ -6410,7 +6582,10 @@ module Aws::SSM
|
|
6410
6582
|
:instances_with_missing_patches,
|
6411
6583
|
:instances_with_failed_patches,
|
6412
6584
|
:instances_with_not_applicable_patches,
|
6413
|
-
:instances_with_unreported_not_applicable_patches
|
6585
|
+
:instances_with_unreported_not_applicable_patches,
|
6586
|
+
:instances_with_critical_non_compliant_patches,
|
6587
|
+
:instances_with_security_non_compliant_patches,
|
6588
|
+
:instances_with_other_non_compliant_patches)
|
6414
6589
|
SENSITIVE = []
|
6415
6590
|
include Aws::Structure
|
6416
6591
|
end
|
@@ -6624,6 +6799,37 @@ module Aws::SSM
|
|
6624
6799
|
include Aws::Structure
|
6625
6800
|
end
|
6626
6801
|
|
6802
|
+
# @note When making an API call, you may pass DisassociateOpsItemRelatedItemRequest
|
6803
|
+
# data as a hash:
|
6804
|
+
#
|
6805
|
+
# {
|
6806
|
+
# ops_item_id: "OpsItemId", # required
|
6807
|
+
# association_id: "OpsItemRelatedItemAssociationId", # required
|
6808
|
+
# }
|
6809
|
+
#
|
6810
|
+
# @!attribute [rw] ops_item_id
|
6811
|
+
# The ID of the OpsItem for which you want to delete an association
|
6812
|
+
# between the OpsItem and a related resource.
|
6813
|
+
# @return [String]
|
6814
|
+
#
|
6815
|
+
# @!attribute [rw] association_id
|
6816
|
+
# The ID of the association for which you want to delete an
|
6817
|
+
# association between the OpsItem and a related resource.
|
6818
|
+
# @return [String]
|
6819
|
+
#
|
6820
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DisassociateOpsItemRelatedItemRequest AWS API Documentation
|
6821
|
+
#
|
6822
|
+
class DisassociateOpsItemRelatedItemRequest < Struct.new(
|
6823
|
+
:ops_item_id,
|
6824
|
+
:association_id)
|
6825
|
+
SENSITIVE = []
|
6826
|
+
include Aws::Structure
|
6827
|
+
end
|
6828
|
+
|
6829
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DisassociateOpsItemRelatedItemResponse AWS API Documentation
|
6830
|
+
#
|
6831
|
+
class DisassociateOpsItemRelatedItemResponse < Aws::EmptyStructure; end
|
6832
|
+
|
6627
6833
|
# The specified document already exists.
|
6628
6834
|
#
|
6629
6835
|
# @!attribute [rw] message
|
@@ -6689,6 +6895,12 @@ module Aws::SSM
|
|
6689
6895
|
# The name of the Systems Manager document.
|
6690
6896
|
# @return [String]
|
6691
6897
|
#
|
6898
|
+
# @!attribute [rw] display_name
|
6899
|
+
# The friendly name of the Systems Manager document. This value can
|
6900
|
+
# differ for each version of the document. If you want to update this
|
6901
|
+
# value, see UpdateDocument.
|
6902
|
+
# @return [String]
|
6903
|
+
#
|
6692
6904
|
# @!attribute [rw] version_name
|
6693
6905
|
# The version of the artifact associated with the document.
|
6694
6906
|
# @return [String]
|
@@ -6803,6 +7015,7 @@ module Aws::SSM
|
|
6803
7015
|
:hash,
|
6804
7016
|
:hash_type,
|
6805
7017
|
:name,
|
7018
|
+
:display_name,
|
6806
7019
|
:version_name,
|
6807
7020
|
:owner,
|
6808
7021
|
:created_date,
|
@@ -6863,6 +7076,16 @@ module Aws::SSM
|
|
6863
7076
|
# The name of the Systems Manager document.
|
6864
7077
|
# @return [String]
|
6865
7078
|
#
|
7079
|
+
# @!attribute [rw] created_date
|
7080
|
+
# The date the Systems Manager document was created.
|
7081
|
+
# @return [Time]
|
7082
|
+
#
|
7083
|
+
# @!attribute [rw] display_name
|
7084
|
+
# An optional field where you can specify a friendly name for the
|
7085
|
+
# Systems Manager document. This value can differ for each version of
|
7086
|
+
# the document. If you want to update this value, see UpdateDocument.
|
7087
|
+
# @return [String]
|
7088
|
+
#
|
6866
7089
|
# @!attribute [rw] owner
|
6867
7090
|
# The AWS user account that created the document.
|
6868
7091
|
# @return [String]
|
@@ -6926,6 +7149,8 @@ module Aws::SSM
|
|
6926
7149
|
#
|
6927
7150
|
class DocumentIdentifier < Struct.new(
|
6928
7151
|
:name,
|
7152
|
+
:created_date,
|
7153
|
+
:display_name,
|
6929
7154
|
:owner,
|
6930
7155
|
:version_name,
|
6931
7156
|
:platform_types,
|
@@ -7263,6 +7488,12 @@ module Aws::SSM
|
|
7263
7488
|
# The document name.
|
7264
7489
|
# @return [String]
|
7265
7490
|
#
|
7491
|
+
# @!attribute [rw] display_name
|
7492
|
+
# The friendly name of the Systems Manager document. This value can
|
7493
|
+
# differ for each version of the document. If you want to update this
|
7494
|
+
# value, see UpdateDocument.
|
7495
|
+
# @return [String]
|
7496
|
+
#
|
7266
7497
|
# @!attribute [rw] document_version
|
7267
7498
|
# The document version.
|
7268
7499
|
# @return [String]
|
@@ -7306,6 +7537,7 @@ module Aws::SSM
|
|
7306
7537
|
#
|
7307
7538
|
class DocumentVersionInfo < Struct.new(
|
7308
7539
|
:name,
|
7540
|
+
:display_name,
|
7309
7541
|
:document_version,
|
7310
7542
|
:version_name,
|
7311
7543
|
:created_date,
|
@@ -7599,17 +7831,26 @@ module Aws::SSM
|
|
7599
7831
|
#
|
7600
7832
|
# @!attribute [rw] instance_id
|
7601
7833
|
# (Required) The ID of the managed instance targeted by the command. A
|
7602
|
-
# managed instance can be an
|
7603
|
-
# hybrid environment that is
|
7834
|
+
# managed instance can be an Amazon Elastic Compute Cloud (Amazon EC2)
|
7835
|
+
# instance or an instance in your hybrid environment that is
|
7836
|
+
# configured for AWS Systems Manager.
|
7604
7837
|
# @return [String]
|
7605
7838
|
#
|
7606
7839
|
# @!attribute [rw] plugin_name
|
7607
|
-
#
|
7608
|
-
#
|
7609
|
-
#
|
7840
|
+
# The name of the plugin for which you want detailed results. If the
|
7841
|
+
# document contains only one plugin, you can omit the name and details
|
7842
|
+
# for that plugin. If the document contains more than one plugin, you
|
7843
|
+
# must specify the name of the plugin for which you want to view
|
7844
|
+
# details.
|
7610
7845
|
#
|
7611
|
-
# Plugin names are also referred to as step names in Systems Manager
|
7612
|
-
# documents.
|
7846
|
+
# Plugin names are also referred to as *step names* in Systems Manager
|
7847
|
+
# documents. For example, `aws:RunShellScript` is a plugin.
|
7848
|
+
#
|
7849
|
+
# To find the `PluginName`, check the document content and find the
|
7850
|
+
# name of the plugin. Alternatively, use ListCommandInvocations with
|
7851
|
+
# the `CommandId` and `Details` parameters. The `PluginName` is the
|
7852
|
+
# `Name` attribute of the `CommandPlugin` object in the
|
7853
|
+
# `CommandPlugins` list.
|
7613
7854
|
# @return [String]
|
7614
7855
|
#
|
7615
7856
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetCommandInvocationRequest AWS API Documentation
|
@@ -7638,7 +7879,7 @@ module Aws::SSM
|
|
7638
7879
|
#
|
7639
7880
|
# @!attribute [rw] document_name
|
7640
7881
|
# The name of the document that was run. For example,
|
7641
|
-
# AWS-RunShellScript
|
7882
|
+
# `AWS-RunShellScript`.
|
7642
7883
|
# @return [String]
|
7643
7884
|
#
|
7644
7885
|
# @!attribute [rw] document_version
|
@@ -7646,13 +7887,13 @@ module Aws::SSM
|
|
7646
7887
|
# @return [String]
|
7647
7888
|
#
|
7648
7889
|
# @!attribute [rw] plugin_name
|
7649
|
-
# The name of the plugin
|
7650
|
-
# example, aws:RunShellScript is a plugin.
|
7890
|
+
# The name of the plugin, or *step name*, for which details are
|
7891
|
+
# reported. For example, `aws:RunShellScript` is a plugin.
|
7651
7892
|
# @return [String]
|
7652
7893
|
#
|
7653
7894
|
# @!attribute [rw] response_code
|
7654
7895
|
# The error level response code for the plugin script. If the response
|
7655
|
-
# code is
|
7896
|
+
# code is `-1`, then the command has not started running on the
|
7656
7897
|
# instance, or it was not received by the instance.
|
7657
7898
|
# @return [Integer]
|
7658
7899
|
#
|
@@ -7669,11 +7910,11 @@ module Aws::SSM
|
|
7669
7910
|
# @return [String]
|
7670
7911
|
#
|
7671
7912
|
# @!attribute [rw] execution_elapsed_time
|
7672
|
-
# Duration since ExecutionStartDateTime
|
7913
|
+
# Duration since `ExecutionStartDateTime`.
|
7673
7914
|
# @return [String]
|
7674
7915
|
#
|
7675
7916
|
# @!attribute [rw] execution_end_date_time
|
7676
|
-
# The date and time the plugin
|
7917
|
+
# The date and time the plugin finished running. Date and time are
|
7677
7918
|
# written in ISO 8601 format. For example, June 7, 2017 is represented
|
7678
7919
|
# as 2017-06-7. The following sample AWS CLI command uses the
|
7679
7920
|
# `InvokedAfter` filter.
|
@@ -7686,17 +7927,17 @@ module Aws::SSM
|
|
7686
7927
|
#
|
7687
7928
|
# @!attribute [rw] status
|
7688
7929
|
# The status of this invocation plugin. This status can be different
|
7689
|
-
# than StatusDetails
|
7930
|
+
# than `StatusDetails`.
|
7690
7931
|
# @return [String]
|
7691
7932
|
#
|
7692
7933
|
# @!attribute [rw] status_details
|
7693
7934
|
# A detailed status of the command execution for an invocation.
|
7694
|
-
# StatusDetails includes more information than Status because it
|
7935
|
+
# `StatusDetails` includes more information than `Status` because it
|
7695
7936
|
# includes states resulting from error and concurrency control
|
7696
|
-
# parameters. StatusDetails can show different results than
|
7697
|
-
# For more information about these statuses, see
|
7698
|
-
# command statuses][1] in the *AWS Systems Manager User
|
7699
|
-
# StatusDetails can be one of the following values:
|
7937
|
+
# parameters. `StatusDetails` can show different results than
|
7938
|
+
# `Status`. For more information about these statuses, see
|
7939
|
+
# [Understanding command statuses][1] in the *AWS Systems Manager User
|
7940
|
+
# Guide*. `StatusDetails` can be one of the following values:
|
7700
7941
|
#
|
7701
7942
|
# * Pending: The command has not been sent to the instance.
|
7702
7943
|
#
|
@@ -7714,20 +7955,20 @@ module Aws::SSM
|
|
7714
7955
|
#
|
7715
7956
|
# * Delivery Timed Out: The command was not delivered to the instance
|
7716
7957
|
# before the delivery timeout expired. Delivery timeouts do not
|
7717
|
-
# count against the parent command's MaxErrors limit, but they do
|
7958
|
+
# count against the parent command's `MaxErrors` limit, but they do
|
7718
7959
|
# contribute to whether the parent command status is Success or
|
7719
7960
|
# Incomplete. This is a terminal state.
|
7720
7961
|
#
|
7721
7962
|
# * Execution Timed Out: The command started to run on the instance,
|
7722
7963
|
# but the execution was not complete before the timeout expired.
|
7723
|
-
# Execution timeouts count against the MaxErrors limit of the
|
7724
|
-
# command. This is a terminal state.
|
7964
|
+
# Execution timeouts count against the `MaxErrors` limit of the
|
7965
|
+
# parent command. This is a terminal state.
|
7725
7966
|
#
|
7726
7967
|
# * Failed: The command wasn't run successfully on the instance. For
|
7727
7968
|
# a plugin, this indicates that the result code was not zero. For a
|
7728
7969
|
# command invocation, this indicates that the result code for one or
|
7729
7970
|
# more plugins was not zero. Invocation failures count against the
|
7730
|
-
# MaxErrors limit of the parent command. This is a terminal state.
|
7971
|
+
# `MaxErrors` limit of the parent command. This is a terminal state.
|
7731
7972
|
#
|
7732
7973
|
# * Canceled: The command was terminated before it was completed. This
|
7733
7974
|
# is a terminal state.
|
@@ -7735,11 +7976,11 @@ module Aws::SSM
|
|
7735
7976
|
# * Undeliverable: The command can't be delivered to the instance.
|
7736
7977
|
# The instance might not exist or might not be responding.
|
7737
7978
|
# Undeliverable invocations don't count against the parent
|
7738
|
-
# command's MaxErrors limit and don't contribute to whether the
|
7979
|
+
# command's `MaxErrors` limit and don't contribute to whether the
|
7739
7980
|
# parent command status is Success or Incomplete. This is a terminal
|
7740
7981
|
# state.
|
7741
7982
|
#
|
7742
|
-
# * Terminated: The parent command exceeded its MaxErrors limit and
|
7983
|
+
# * Terminated: The parent command exceeded its `MaxErrors` limit and
|
7743
7984
|
# subsequent command invocations were canceled by the system. This
|
7744
7985
|
# is a terminal state.
|
7745
7986
|
#
|
@@ -7749,24 +7990,24 @@ module Aws::SSM
|
|
7749
7990
|
# @return [String]
|
7750
7991
|
#
|
7751
7992
|
# @!attribute [rw] standard_output_content
|
7752
|
-
# The first 24,000 characters written by the plugin to stdout
|
7753
|
-
# command has not finished running, if ExecutionStatus is
|
7754
|
-
# Succeeded nor Failed, then this string is empty.
|
7993
|
+
# The first 24,000 characters written by the plugin to `stdout`. If
|
7994
|
+
# the command has not finished running, if `ExecutionStatus` is
|
7995
|
+
# neither Succeeded nor Failed, then this string is empty.
|
7755
7996
|
# @return [String]
|
7756
7997
|
#
|
7757
7998
|
# @!attribute [rw] standard_output_url
|
7758
|
-
# The URL for the complete text written by the plugin to stdout in
|
7759
|
-
# Amazon S3. If an S3 bucket was not
|
7760
|
-
# empty.
|
7999
|
+
# The URL for the complete text written by the plugin to `stdout` in
|
8000
|
+
# Amazon Simple Storage Service (Amazon S3). If an S3 bucket was not
|
8001
|
+
# specified, then this string is empty.
|
7761
8002
|
# @return [String]
|
7762
8003
|
#
|
7763
8004
|
# @!attribute [rw] standard_error_content
|
7764
|
-
# The first 8,000 characters written by the plugin to stderr
|
8005
|
+
# The first 8,000 characters written by the plugin to `stderr`. If the
|
7765
8006
|
# command has not finished running, then this string is empty.
|
7766
8007
|
# @return [String]
|
7767
8008
|
#
|
7768
8009
|
# @!attribute [rw] standard_error_url
|
7769
|
-
# The URL for the complete text written by the plugin to stderr
|
8010
|
+
# The URL for the complete text written by the plugin to `stderr`. If
|
7770
8011
|
# the command has not finished running, then this string is empty.
|
7771
8012
|
# @return [String]
|
7772
8013
|
#
|
@@ -8019,6 +8260,16 @@ module Aws::SSM
|
|
8019
8260
|
# The name of the Systems Manager document.
|
8020
8261
|
# @return [String]
|
8021
8262
|
#
|
8263
|
+
# @!attribute [rw] created_date
|
8264
|
+
# The date the Systems Manager document was created.
|
8265
|
+
# @return [Time]
|
8266
|
+
#
|
8267
|
+
# @!attribute [rw] display_name
|
8268
|
+
# The friendly name of the Systems Manager document. This value can
|
8269
|
+
# differ for each version of the document. If you want to update this
|
8270
|
+
# value, see UpdateDocument.
|
8271
|
+
# @return [String]
|
8272
|
+
#
|
8022
8273
|
# @!attribute [rw] version_name
|
8023
8274
|
# The version of the artifact associated with the document. For
|
8024
8275
|
# example, "Release 12, Update 6". This value is unique across all
|
@@ -8081,6 +8332,8 @@ module Aws::SSM
|
|
8081
8332
|
#
|
8082
8333
|
class GetDocumentResult < Struct.new(
|
8083
8334
|
:name,
|
8335
|
+
:created_date,
|
8336
|
+
:display_name,
|
8084
8337
|
:version_name,
|
8085
8338
|
:document_version,
|
8086
8339
|
:status,
|
@@ -9554,6 +9807,14 @@ module Aws::SSM
|
|
9554
9807
|
|
9555
9808
|
# An S3 bucket where you want to store the results of this request.
|
9556
9809
|
#
|
9810
|
+
# For the minimal permissions required to enable Amazon S3 output for an
|
9811
|
+
# association, see [Creating associations][1] in the *Systems Manager
|
9812
|
+
# User Guide*.
|
9813
|
+
#
|
9814
|
+
#
|
9815
|
+
#
|
9816
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-state-assoc.html
|
9817
|
+
#
|
9557
9818
|
# @note When making an API call, you may pass InstanceAssociationOutputLocation
|
9558
9819
|
# data as a hash:
|
9559
9820
|
#
|
@@ -10013,6 +10274,28 @@ module Aws::SSM
|
|
10013
10274
|
# patches might not be in effect until a reboot is performed.
|
10014
10275
|
# @return [String]
|
10015
10276
|
#
|
10277
|
+
# @!attribute [rw] critical_non_compliant_count
|
10278
|
+
# The number of instances where patches that are specified as
|
10279
|
+
# "Critical" for compliance reporting in the patch baseline are not
|
10280
|
+
# installed. These patches might be missing, have failed installation,
|
10281
|
+
# were rejected, or were installed but awaiting a required instance
|
10282
|
+
# reboot. The status of these instances is `NON_COMPLIANT`.
|
10283
|
+
# @return [Integer]
|
10284
|
+
#
|
10285
|
+
# @!attribute [rw] security_non_compliant_count
|
10286
|
+
# The number of instances where patches that are specified as
|
10287
|
+
# "Security" in a patch advisory are not installed. These patches
|
10288
|
+
# might be missing, have failed installation, were rejected, or were
|
10289
|
+
# installed but awaiting a required instance reboot. The status of
|
10290
|
+
# these instances is `NON_COMPLIANT`.
|
10291
|
+
# @return [Integer]
|
10292
|
+
#
|
10293
|
+
# @!attribute [rw] other_non_compliant_count
|
10294
|
+
# The number of instances with patches installed that are specified as
|
10295
|
+
# other than "Critical" or "Security" but are not compliant with
|
10296
|
+
# the patch baseline. The status of these instances is NON\_COMPLIANT.
|
10297
|
+
# @return [Integer]
|
10298
|
+
#
|
10016
10299
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/InstancePatchState AWS API Documentation
|
10017
10300
|
#
|
10018
10301
|
class InstancePatchState < Struct.new(
|
@@ -10034,7 +10317,10 @@ module Aws::SSM
|
|
10034
10317
|
:operation_end_time,
|
10035
10318
|
:operation,
|
10036
10319
|
:last_no_reboot_install_operation_time,
|
10037
|
-
:reboot_option
|
10320
|
+
:reboot_option,
|
10321
|
+
:critical_non_compliant_count,
|
10322
|
+
:security_non_compliant_count,
|
10323
|
+
:other_non_compliant_count)
|
10038
10324
|
SENSITIVE = [:owner_information]
|
10039
10325
|
include Aws::Structure
|
10040
10326
|
end
|
@@ -11405,7 +11691,7 @@ module Aws::SSM
|
|
11405
11691
|
#
|
11406
11692
|
# @!attribute [rw] details
|
11407
11693
|
# (Optional) If set this returns the response of the command
|
11408
|
-
# executions and any command output.
|
11694
|
+
# executions and any command output. The default value is 'false'.
|
11409
11695
|
# @return [Boolean]
|
11410
11696
|
#
|
11411
11697
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListCommandInvocationsRequest AWS API Documentation
|
@@ -12017,6 +12303,72 @@ module Aws::SSM
|
|
12017
12303
|
include Aws::Structure
|
12018
12304
|
end
|
12019
12305
|
|
12306
|
+
# @note When making an API call, you may pass ListOpsItemRelatedItemsRequest
|
12307
|
+
# data as a hash:
|
12308
|
+
#
|
12309
|
+
# {
|
12310
|
+
# ops_item_id: "OpsItemId",
|
12311
|
+
# filters: [
|
12312
|
+
# {
|
12313
|
+
# key: "ResourceType", # required, accepts ResourceType, AssociationId, ResourceUri
|
12314
|
+
# values: ["OpsItemRelatedItemsFilterValue"], # required
|
12315
|
+
# operator: "Equal", # required, accepts Equal
|
12316
|
+
# },
|
12317
|
+
# ],
|
12318
|
+
# max_results: 1,
|
12319
|
+
# next_token: "String",
|
12320
|
+
# }
|
12321
|
+
#
|
12322
|
+
# @!attribute [rw] ops_item_id
|
12323
|
+
# The ID of the OpsItem for which you want to list all related-item
|
12324
|
+
# resources.
|
12325
|
+
# @return [String]
|
12326
|
+
#
|
12327
|
+
# @!attribute [rw] filters
|
12328
|
+
# One or more OpsItem filters. Use a filter to return a more specific
|
12329
|
+
# list of results.
|
12330
|
+
# @return [Array<Types::OpsItemRelatedItemsFilter>]
|
12331
|
+
#
|
12332
|
+
# @!attribute [rw] max_results
|
12333
|
+
# The maximum number of items to return for this call. The call also
|
12334
|
+
# returns a token that you can specify in a subsequent call to get the
|
12335
|
+
# next set of results.
|
12336
|
+
# @return [Integer]
|
12337
|
+
#
|
12338
|
+
# @!attribute [rw] next_token
|
12339
|
+
# The token for the next set of items to return. (You received this
|
12340
|
+
# token from a previous call.)
|
12341
|
+
# @return [String]
|
12342
|
+
#
|
12343
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListOpsItemRelatedItemsRequest AWS API Documentation
|
12344
|
+
#
|
12345
|
+
class ListOpsItemRelatedItemsRequest < Struct.new(
|
12346
|
+
:ops_item_id,
|
12347
|
+
:filters,
|
12348
|
+
:max_results,
|
12349
|
+
:next_token)
|
12350
|
+
SENSITIVE = []
|
12351
|
+
include Aws::Structure
|
12352
|
+
end
|
12353
|
+
|
12354
|
+
# @!attribute [rw] next_token
|
12355
|
+
# The token for the next set of items to return. Use this token to get
|
12356
|
+
# the next set of results.
|
12357
|
+
# @return [String]
|
12358
|
+
#
|
12359
|
+
# @!attribute [rw] summaries
|
12360
|
+
# A list of related-item resources for the specified OpsItem.
|
12361
|
+
# @return [Array<Types::OpsItemRelatedItemSummary>]
|
12362
|
+
#
|
12363
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListOpsItemRelatedItemsResponse AWS API Documentation
|
12364
|
+
#
|
12365
|
+
class ListOpsItemRelatedItemsResponse < Struct.new(
|
12366
|
+
:next_token,
|
12367
|
+
:summaries)
|
12368
|
+
SENSITIVE = []
|
12369
|
+
include Aws::Structure
|
12370
|
+
end
|
12371
|
+
|
12020
12372
|
# @note When making an API call, you may pass ListOpsMetadataRequest
|
12021
12373
|
# data as a hash:
|
12022
12374
|
#
|
@@ -12198,7 +12550,7 @@ module Aws::SSM
|
|
12198
12550
|
# data as a hash:
|
12199
12551
|
#
|
12200
12552
|
# {
|
12201
|
-
# resource_type: "Document", # required, accepts Document, ManagedInstance, MaintenanceWindow, Parameter, PatchBaseline, OpsItem
|
12553
|
+
# resource_type: "Document", # required, accepts Document, ManagedInstance, MaintenanceWindow, Parameter, PatchBaseline, OpsItem, OpsMetadata
|
12202
12554
|
# resource_id: "ResourceId", # required
|
12203
12555
|
# }
|
12204
12556
|
#
|
@@ -13664,7 +14016,8 @@ module Aws::SSM
|
|
13664
14016
|
include Aws::Structure
|
13665
14017
|
end
|
13666
14018
|
|
13667
|
-
# Summary information about an OpsItem event
|
14019
|
+
# Summary information about an OpsItem event or that associated an
|
14020
|
+
# OpsItem with a related item.
|
13668
14021
|
#
|
13669
14022
|
# @!attribute [rw] ops_item_id
|
13670
14023
|
# The ID of the OpsItem.
|
@@ -13841,6 +14194,132 @@ module Aws::SSM
|
|
13841
14194
|
include Aws::Structure
|
13842
14195
|
end
|
13843
14196
|
|
14197
|
+
# The Amazon Resource Name (ARN) is already associated with the OpsItem.
|
14198
|
+
#
|
14199
|
+
# @!attribute [rw] message
|
14200
|
+
# @return [String]
|
14201
|
+
#
|
14202
|
+
# @!attribute [rw] resource_uri
|
14203
|
+
# @return [String]
|
14204
|
+
#
|
14205
|
+
# @!attribute [rw] ops_item_id
|
14206
|
+
# @return [String]
|
14207
|
+
#
|
14208
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItemRelatedItemAlreadyExistsException AWS API Documentation
|
14209
|
+
#
|
14210
|
+
class OpsItemRelatedItemAlreadyExistsException < Struct.new(
|
14211
|
+
:message,
|
14212
|
+
:resource_uri,
|
14213
|
+
:ops_item_id)
|
14214
|
+
SENSITIVE = []
|
14215
|
+
include Aws::Structure
|
14216
|
+
end
|
14217
|
+
|
14218
|
+
# The association was not found using the parameters you specified in
|
14219
|
+
# the call. Verify the information and try again.
|
14220
|
+
#
|
14221
|
+
# @!attribute [rw] message
|
14222
|
+
# @return [String]
|
14223
|
+
#
|
14224
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItemRelatedItemAssociationNotFoundException AWS API Documentation
|
14225
|
+
#
|
14226
|
+
class OpsItemRelatedItemAssociationNotFoundException < Struct.new(
|
14227
|
+
:message)
|
14228
|
+
SENSITIVE = []
|
14229
|
+
include Aws::Structure
|
14230
|
+
end
|
14231
|
+
|
14232
|
+
# Summary information about related-item resources for an OpsItem.
|
14233
|
+
#
|
14234
|
+
# @!attribute [rw] ops_item_id
|
14235
|
+
# The OpsItem ID.
|
14236
|
+
# @return [String]
|
14237
|
+
#
|
14238
|
+
# @!attribute [rw] association_id
|
14239
|
+
# The association ID.
|
14240
|
+
# @return [String]
|
14241
|
+
#
|
14242
|
+
# @!attribute [rw] resource_type
|
14243
|
+
# The resource type.
|
14244
|
+
# @return [String]
|
14245
|
+
#
|
14246
|
+
# @!attribute [rw] association_type
|
14247
|
+
# The association type.
|
14248
|
+
# @return [String]
|
14249
|
+
#
|
14250
|
+
# @!attribute [rw] resource_uri
|
14251
|
+
# The Amazon Resource Name (ARN) of the related-item resource.
|
14252
|
+
# @return [String]
|
14253
|
+
#
|
14254
|
+
# @!attribute [rw] created_by
|
14255
|
+
# Information about the user or resource that created an OpsItem
|
14256
|
+
# event.
|
14257
|
+
# @return [Types::OpsItemIdentity]
|
14258
|
+
#
|
14259
|
+
# @!attribute [rw] created_time
|
14260
|
+
# The time the related-item association was created.
|
14261
|
+
# @return [Time]
|
14262
|
+
#
|
14263
|
+
# @!attribute [rw] last_modified_by
|
14264
|
+
# Information about the user or resource that created an OpsItem
|
14265
|
+
# event.
|
14266
|
+
# @return [Types::OpsItemIdentity]
|
14267
|
+
#
|
14268
|
+
# @!attribute [rw] last_modified_time
|
14269
|
+
# The time the related-item association was last updated.
|
14270
|
+
# @return [Time]
|
14271
|
+
#
|
14272
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItemRelatedItemSummary AWS API Documentation
|
14273
|
+
#
|
14274
|
+
class OpsItemRelatedItemSummary < Struct.new(
|
14275
|
+
:ops_item_id,
|
14276
|
+
:association_id,
|
14277
|
+
:resource_type,
|
14278
|
+
:association_type,
|
14279
|
+
:resource_uri,
|
14280
|
+
:created_by,
|
14281
|
+
:created_time,
|
14282
|
+
:last_modified_by,
|
14283
|
+
:last_modified_time)
|
14284
|
+
SENSITIVE = []
|
14285
|
+
include Aws::Structure
|
14286
|
+
end
|
14287
|
+
|
14288
|
+
# Describes a filter for a specific list of related-item resources.
|
14289
|
+
#
|
14290
|
+
# @note When making an API call, you may pass OpsItemRelatedItemsFilter
|
14291
|
+
# data as a hash:
|
14292
|
+
#
|
14293
|
+
# {
|
14294
|
+
# key: "ResourceType", # required, accepts ResourceType, AssociationId, ResourceUri
|
14295
|
+
# values: ["OpsItemRelatedItemsFilterValue"], # required
|
14296
|
+
# operator: "Equal", # required, accepts Equal
|
14297
|
+
# }
|
14298
|
+
#
|
14299
|
+
# @!attribute [rw] key
|
14300
|
+
# The name of the filter key. Supported values include `ResourceUri`,
|
14301
|
+
# `ResourceType`, or `AssociationId`.
|
14302
|
+
# @return [String]
|
14303
|
+
#
|
14304
|
+
# @!attribute [rw] values
|
14305
|
+
# The values for the filter.
|
14306
|
+
# @return [Array<String>]
|
14307
|
+
#
|
14308
|
+
# @!attribute [rw] operator
|
14309
|
+
# The operator used by the filter call. The only supported operator is
|
14310
|
+
# `EQUAL`.
|
14311
|
+
# @return [String]
|
14312
|
+
#
|
14313
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItemRelatedItemsFilter AWS API Documentation
|
14314
|
+
#
|
14315
|
+
class OpsItemRelatedItemsFilter < Struct.new(
|
14316
|
+
:key,
|
14317
|
+
:values,
|
14318
|
+
:operator)
|
14319
|
+
SENSITIVE = []
|
14320
|
+
include Aws::Structure
|
14321
|
+
end
|
14322
|
+
|
13844
14323
|
# A count of OpsItems.
|
13845
14324
|
#
|
13846
14325
|
# @!attribute [rw] created_by
|
@@ -15464,8 +15943,7 @@ module Aws::SSM
|
|
15464
15943
|
# @return [String]
|
15465
15944
|
#
|
15466
15945
|
# @!attribute [rw] overwrite
|
15467
|
-
# Overwrite an existing parameter.
|
15468
|
-
# "false".
|
15946
|
+
# Overwrite an existing parameter. The default value is 'false'.
|
15469
15947
|
# @return [Boolean]
|
15470
15948
|
#
|
15471
15949
|
# @!attribute [rw] allowed_pattern
|
@@ -16134,7 +16612,7 @@ module Aws::SSM
|
|
16134
16612
|
# data as a hash:
|
16135
16613
|
#
|
16136
16614
|
# {
|
16137
|
-
# resource_type: "Document", # required, accepts Document, ManagedInstance, MaintenanceWindow, Parameter, PatchBaseline, OpsItem
|
16615
|
+
# resource_type: "Document", # required, accepts Document, ManagedInstance, MaintenanceWindow, Parameter, PatchBaseline, OpsItem, OpsMetadata
|
16138
16616
|
# resource_id: "ResourceId", # required
|
16139
16617
|
# tag_keys: ["TagKey"], # required
|
16140
16618
|
# }
|
@@ -16159,6 +16637,15 @@ module Aws::SSM
|
|
16159
16637
|
#
|
16160
16638
|
# PatchBaseline: pb-012345abcde
|
16161
16639
|
#
|
16640
|
+
# OpsMetadata object: `ResourceID` for tagging is created from the
|
16641
|
+
# Amazon Resource Name (ARN) for the object. Specifically,
|
16642
|
+
# `ResourceID` is created from the strings that come after the word
|
16643
|
+
# `opsmetadata` in the ARN. For example, an OpsMetadata object with an
|
16644
|
+
# ARN of
|
16645
|
+
# `arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager`
|
16646
|
+
# has a `ResourceID` of either `aws/ssm/MyGroup/appmanager` or
|
16647
|
+
# `/aws/ssm/MyGroup/appmanager`.
|
16648
|
+
#
|
16162
16649
|
# For the Document and Parameter values, use the name of the resource.
|
16163
16650
|
#
|
16164
16651
|
# <note markdown="1"> The ManagedInstance type for this API action is only for on-premises
|
@@ -16596,6 +17083,7 @@ module Aws::SSM
|
|
16596
17083
|
# },
|
16597
17084
|
# source_regions: ["ResourceDataSyncSourceRegion"], # required
|
16598
17085
|
# include_future_regions: false,
|
17086
|
+
# enable_all_ops_data_sources: false,
|
16599
17087
|
# }
|
16600
17088
|
#
|
16601
17089
|
# @!attribute [rw] source_type
|
@@ -16619,13 +17107,27 @@ module Aws::SSM
|
|
16619
17107
|
# Regions when those Regions come online.
|
16620
17108
|
# @return [Boolean]
|
16621
17109
|
#
|
17110
|
+
# @!attribute [rw] enable_all_ops_data_sources
|
17111
|
+
# When you create a resource data sync, if you choose one of the AWS
|
17112
|
+
# Organizations options, then Systems Manager automatically enables
|
17113
|
+
# all OpsData sources in the selected AWS Regions for all AWS accounts
|
17114
|
+
# in your organization (or in the selected organization units). For
|
17115
|
+
# more information, see [About multiple account and Region resource
|
17116
|
+
# data syncs][1] in the *AWS Systems Manager User Guide*.
|
17117
|
+
#
|
17118
|
+
#
|
17119
|
+
#
|
17120
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resouce-data-sync-multiple-accounts-and-regions.html
|
17121
|
+
# @return [Boolean]
|
17122
|
+
#
|
16622
17123
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ResourceDataSyncSource AWS API Documentation
|
16623
17124
|
#
|
16624
17125
|
class ResourceDataSyncSource < Struct.new(
|
16625
17126
|
:source_type,
|
16626
17127
|
:aws_organizations_source,
|
16627
17128
|
:source_regions,
|
16628
|
-
:include_future_regions
|
17129
|
+
:include_future_regions,
|
17130
|
+
:enable_all_ops_data_sources)
|
16629
17131
|
SENSITIVE = []
|
16630
17132
|
include Aws::Structure
|
16631
17133
|
end
|
@@ -16682,6 +17184,19 @@ module Aws::SSM
|
|
16682
17184
|
# organization in AWS Organizations.
|
16683
17185
|
# @return [String]
|
16684
17186
|
#
|
17187
|
+
# @!attribute [rw] enable_all_ops_data_sources
|
17188
|
+
# When you create a resource data sync, if you choose one of the AWS
|
17189
|
+
# Organizations options, then Systems Manager automatically enables
|
17190
|
+
# all OpsData sources in the selected AWS Regions for all AWS accounts
|
17191
|
+
# in your organization (or in the selected organization units). For
|
17192
|
+
# more information, see [About multiple account and Region resource
|
17193
|
+
# data syncs][1] in the *AWS Systems Manager User Guide*.
|
17194
|
+
#
|
17195
|
+
#
|
17196
|
+
#
|
17197
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resouce-data-sync-multiple-accounts-and-regions.html
|
17198
|
+
# @return [Boolean]
|
17199
|
+
#
|
16685
17200
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ResourceDataSyncSourceWithState AWS API Documentation
|
16686
17201
|
#
|
16687
17202
|
class ResourceDataSyncSourceWithState < Struct.new(
|
@@ -16689,7 +17204,8 @@ module Aws::SSM
|
|
16689
17204
|
:aws_organizations_source,
|
16690
17205
|
:source_regions,
|
16691
17206
|
:include_future_regions,
|
16692
|
-
:state
|
17207
|
+
:state,
|
17208
|
+
:enable_all_ops_data_sources)
|
16693
17209
|
SENSITIVE = []
|
16694
17210
|
include Aws::Structure
|
16695
17211
|
end
|
@@ -17799,6 +18315,8 @@ module Aws::SSM
|
|
17799
18315
|
# value: "TagValue", # required
|
17800
18316
|
# },
|
17801
18317
|
# ],
|
18318
|
+
# scheduled_end_time: Time.now,
|
18319
|
+
# change_details: "ChangeDetailsValue",
|
17802
18320
|
# }
|
17803
18321
|
#
|
17804
18322
|
# @!attribute [rw] scheduled_time
|
@@ -17861,6 +18379,18 @@ module Aws::SSM
|
|
17861
18379
|
# * `Key=Region,Value=us-east-2`
|
17862
18380
|
# @return [Array<Types::Tag>]
|
17863
18381
|
#
|
18382
|
+
# @!attribute [rw] scheduled_end_time
|
18383
|
+
# The time that the requester expects the runbook workflow related to
|
18384
|
+
# the change request to complete. The time is an estimate only that
|
18385
|
+
# the requester provides for reviewers.
|
18386
|
+
# @return [Time]
|
18387
|
+
#
|
18388
|
+
# @!attribute [rw] change_details
|
18389
|
+
# User-provided details about the change. If no details are provided,
|
18390
|
+
# content specified in the **Template information** section of the
|
18391
|
+
# associated change template is added.
|
18392
|
+
# @return [String]
|
18393
|
+
#
|
17864
18394
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/StartChangeRequestExecutionRequest AWS API Documentation
|
17865
18395
|
#
|
17866
18396
|
class StartChangeRequestExecutionRequest < Struct.new(
|
@@ -17871,7 +18401,9 @@ module Aws::SSM
|
|
17871
18401
|
:change_request_name,
|
17872
18402
|
:client_token,
|
17873
18403
|
:runbooks,
|
17874
|
-
:tags
|
18404
|
+
:tags,
|
18405
|
+
:scheduled_end_time,
|
18406
|
+
:change_details)
|
17875
18407
|
SENSITIVE = []
|
17876
18408
|
include Aws::Structure
|
17877
18409
|
end
|
@@ -18296,6 +18828,9 @@ module Aws::SSM
|
|
18296
18828
|
# specified `tag:ServerRole`, you could specify `value:WebServer` to
|
18297
18829
|
# run a command on instances that include EC2 tags of
|
18298
18830
|
# `ServerRole,WebServer`.
|
18831
|
+
#
|
18832
|
+
# Depending on the type of `Target`, the maximum number of values for
|
18833
|
+
# a `Key` might be lower than the global maximum of 50.
|
18299
18834
|
# @return [Array<String>]
|
18300
18835
|
#
|
18301
18836
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/Target AWS API Documentation
|
@@ -18460,6 +18995,55 @@ module Aws::SSM
|
|
18460
18995
|
include Aws::Structure
|
18461
18996
|
end
|
18462
18997
|
|
18998
|
+
# @note When making an API call, you may pass UnlabelParameterVersionRequest
|
18999
|
+
# data as a hash:
|
19000
|
+
#
|
19001
|
+
# {
|
19002
|
+
# name: "PSParameterName", # required
|
19003
|
+
# parameter_version: 1, # required
|
19004
|
+
# labels: ["ParameterLabel"], # required
|
19005
|
+
# }
|
19006
|
+
#
|
19007
|
+
# @!attribute [rw] name
|
19008
|
+
# The parameter name of which you want to delete one or more labels.
|
19009
|
+
# @return [String]
|
19010
|
+
#
|
19011
|
+
# @!attribute [rw] parameter_version
|
19012
|
+
# The specific version of the parameter which you want to delete one
|
19013
|
+
# or more labels from. If it is not present, the call will fail.
|
19014
|
+
# @return [Integer]
|
19015
|
+
#
|
19016
|
+
# @!attribute [rw] labels
|
19017
|
+
# One or more labels to delete from the specified parameter version.
|
19018
|
+
# @return [Array<String>]
|
19019
|
+
#
|
19020
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UnlabelParameterVersionRequest AWS API Documentation
|
19021
|
+
#
|
19022
|
+
class UnlabelParameterVersionRequest < Struct.new(
|
19023
|
+
:name,
|
19024
|
+
:parameter_version,
|
19025
|
+
:labels)
|
19026
|
+
SENSITIVE = []
|
19027
|
+
include Aws::Structure
|
19028
|
+
end
|
19029
|
+
|
19030
|
+
# @!attribute [rw] removed_labels
|
19031
|
+
# A list of all labels deleted from the parameter.
|
19032
|
+
# @return [Array<String>]
|
19033
|
+
#
|
19034
|
+
# @!attribute [rw] invalid_labels
|
19035
|
+
# The labels that are not attached to the given parameter version.
|
19036
|
+
# @return [Array<String>]
|
19037
|
+
#
|
19038
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UnlabelParameterVersionResult AWS API Documentation
|
19039
|
+
#
|
19040
|
+
class UnlabelParameterVersionResult < Struct.new(
|
19041
|
+
:removed_labels,
|
19042
|
+
:invalid_labels)
|
19043
|
+
SENSITIVE = []
|
19044
|
+
include Aws::Structure
|
19045
|
+
end
|
19046
|
+
|
18463
19047
|
# The calendar entry contained in the specified Systems Manager document
|
18464
19048
|
# is not supported.
|
18465
19049
|
#
|
@@ -18603,6 +19187,7 @@ module Aws::SSM
|
|
18603
19187
|
# compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
|
18604
19188
|
# sync_compliance: "AUTO", # accepts AUTO, MANUAL
|
18605
19189
|
# apply_only_at_cron_interval: false,
|
19190
|
+
# calendar_names: ["CalendarNameOrARN"],
|
18606
19191
|
# target_locations: [
|
18607
19192
|
# {
|
18608
19193
|
# accounts: ["Account"],
|
@@ -18747,6 +19332,17 @@ module Aws::SSM
|
|
18747
19332
|
# the interval specified.
|
18748
19333
|
# @return [Boolean]
|
18749
19334
|
#
|
19335
|
+
# @!attribute [rw] calendar_names
|
19336
|
+
# The names or Amazon Resource Names (ARNs) of the Systems Manager
|
19337
|
+
# Change Calendar type documents you want to gate your associations
|
19338
|
+
# under. The associations only run when that Change Calendar is open.
|
19339
|
+
# For more information, see [AWS Systems Manager Change Calendar][1].
|
19340
|
+
#
|
19341
|
+
#
|
19342
|
+
#
|
19343
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar
|
19344
|
+
# @return [Array<String>]
|
19345
|
+
#
|
18750
19346
|
# @!attribute [rw] target_locations
|
18751
19347
|
# A location is a combination of AWS Regions and AWS accounts where
|
18752
19348
|
# you want to run the association. Use this action to update an
|
@@ -18771,6 +19367,7 @@ module Aws::SSM
|
|
18771
19367
|
:compliance_severity,
|
18772
19368
|
:sync_compliance,
|
18773
19369
|
:apply_only_at_cron_interval,
|
19370
|
+
:calendar_names,
|
18774
19371
|
:target_locations)
|
18775
19372
|
SENSITIVE = []
|
18776
19373
|
include Aws::Structure
|
@@ -18932,6 +19529,7 @@ module Aws::SSM
|
|
18932
19529
|
# },
|
18933
19530
|
# ],
|
18934
19531
|
# name: "DocumentName", # required
|
19532
|
+
# display_name: "DocumentDisplayName",
|
18935
19533
|
# version_name: "DocumentVersionName",
|
18936
19534
|
# document_version: "DocumentVersion",
|
18937
19535
|
# document_format: "YAML", # accepts YAML, JSON, TEXT
|
@@ -18948,7 +19546,14 @@ module Aws::SSM
|
|
18948
19546
|
# @return [Array<Types::AttachmentsSource>]
|
18949
19547
|
#
|
18950
19548
|
# @!attribute [rw] name
|
18951
|
-
# The name of the document that you want to update.
|
19549
|
+
# The name of the Systems Manager document that you want to update.
|
19550
|
+
# @return [String]
|
19551
|
+
#
|
19552
|
+
# @!attribute [rw] display_name
|
19553
|
+
# The friendly name of the Systems Manager document that you want to
|
19554
|
+
# update. This value can differ for each version of the document. If
|
19555
|
+
# you do not specify a value for this parameter in your request, the
|
19556
|
+
# existing value is applied to the new document version.
|
18952
19557
|
# @return [String]
|
18953
19558
|
#
|
18954
19559
|
# @!attribute [rw] version_name
|
@@ -18959,10 +19564,10 @@ module Aws::SSM
|
|
18959
19564
|
# @return [String]
|
18960
19565
|
#
|
18961
19566
|
# @!attribute [rw] document_version
|
18962
|
-
#
|
18963
|
-
#
|
18964
|
-
#
|
18965
|
-
#
|
19567
|
+
# The version of the document that you want to update. Currently,
|
19568
|
+
# Systems Manager supports updating only the latest version of the
|
19569
|
+
# document. You can specify the version number of the latest version
|
19570
|
+
# or use the `$LATEST` variable.
|
18966
19571
|
# @return [String]
|
18967
19572
|
#
|
18968
19573
|
# @!attribute [rw] document_format
|
@@ -18981,6 +19586,7 @@ module Aws::SSM
|
|
18981
19586
|
:content,
|
18982
19587
|
:attachments,
|
18983
19588
|
:name,
|
19589
|
+
:display_name,
|
18984
19590
|
:version_name,
|
18985
19591
|
:document_version,
|
18986
19592
|
:document_format,
|
@@ -20145,6 +20751,7 @@ module Aws::SSM
|
|
20145
20751
|
# },
|
20146
20752
|
# source_regions: ["ResourceDataSyncSourceRegion"], # required
|
20147
20753
|
# include_future_regions: false,
|
20754
|
+
# enable_all_ops_data_sources: false,
|
20148
20755
|
# },
|
20149
20756
|
# }
|
20150
20757
|
#
|