aws-sdk-ssm 1.48.0 → 1.49.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-ssm.rb +1 -1
- data/lib/aws-sdk-ssm/client.rb +490 -4
- data/lib/aws-sdk-ssm/client_api.rb +287 -0
- data/lib/aws-sdk-ssm/errors.rb +89 -0
- data/lib/aws-sdk-ssm/types.rb +991 -27
- metadata +2 -2
data/lib/aws-sdk-ssm/types.rb
CHANGED
@@ -77,7 +77,7 @@ module Aws::SSM
|
|
77
77
|
# data as a hash:
|
78
78
|
#
|
79
79
|
# {
|
80
|
-
# resource_type: "Document", # required, accepts Document, ManagedInstance, MaintenanceWindow, Parameter, PatchBaseline
|
80
|
+
# resource_type: "Document", # required, accepts Document, ManagedInstance, MaintenanceWindow, Parameter, PatchBaseline, OpsItem
|
81
81
|
# resource_id: "ResourceId", # required
|
82
82
|
# tags: [ # required
|
83
83
|
# {
|
@@ -2831,6 +2831,128 @@ module Aws::SSM
|
|
2831
2831
|
include Aws::Structure
|
2832
2832
|
end
|
2833
2833
|
|
2834
|
+
# @note When making an API call, you may pass CreateOpsItemRequest
|
2835
|
+
# data as a hash:
|
2836
|
+
#
|
2837
|
+
# {
|
2838
|
+
# description: "OpsItemDescription", # required
|
2839
|
+
# operational_data: {
|
2840
|
+
# "OpsItemDataKey" => {
|
2841
|
+
# value: "OpsItemDataValueString",
|
2842
|
+
# type: "SearchableString", # accepts SearchableString, String
|
2843
|
+
# },
|
2844
|
+
# },
|
2845
|
+
# notifications: [
|
2846
|
+
# {
|
2847
|
+
# arn: "String",
|
2848
|
+
# },
|
2849
|
+
# ],
|
2850
|
+
# priority: 1,
|
2851
|
+
# related_ops_items: [
|
2852
|
+
# {
|
2853
|
+
# ops_item_id: "String", # required
|
2854
|
+
# },
|
2855
|
+
# ],
|
2856
|
+
# source: "OpsItemSource", # required
|
2857
|
+
# title: "OpsItemTitle", # required
|
2858
|
+
# tags: [
|
2859
|
+
# {
|
2860
|
+
# key: "TagKey", # required
|
2861
|
+
# value: "TagValue", # required
|
2862
|
+
# },
|
2863
|
+
# ],
|
2864
|
+
# }
|
2865
|
+
#
|
2866
|
+
# @!attribute [rw] description
|
2867
|
+
# Information about the OpsItem.
|
2868
|
+
# @return [String]
|
2869
|
+
#
|
2870
|
+
# @!attribute [rw] operational_data
|
2871
|
+
# Operational data is custom data that provides useful reference
|
2872
|
+
# details about the OpsItem. For example, you can specify log files,
|
2873
|
+
# error strings, license keys, troubleshooting tips, or other relevant
|
2874
|
+
# data. You enter operational data as key-value pairs. The key has a
|
2875
|
+
# maximum length of 128 characters. The value has a maximum size of 20
|
2876
|
+
# KB.
|
2877
|
+
#
|
2878
|
+
# This custom data is searchable, but with restrictions. For the
|
2879
|
+
# `Searchable operational data` feature, all users with access to the
|
2880
|
+
# OpsItem Overview page (as provided by the DescribeOpsItems API
|
2881
|
+
# action) can view and search on the specified data. For the `Private
|
2882
|
+
# operational data` feature, the data is only viewable by users who
|
2883
|
+
# have access to the OpsItem (as provided by the GetOpsItem API
|
2884
|
+
# action).
|
2885
|
+
# @return [Hash<String,Types::OpsItemDataValue>]
|
2886
|
+
#
|
2887
|
+
# @!attribute [rw] notifications
|
2888
|
+
# The Amazon Resource Name (ARN) of an SNS topic where notifications
|
2889
|
+
# are sent when this OpsItem is edited or changed.
|
2890
|
+
# @return [Array<Types::OpsItemNotification>]
|
2891
|
+
#
|
2892
|
+
# @!attribute [rw] priority
|
2893
|
+
# The importance of this OpsItem in relation to other OpsItems in the
|
2894
|
+
# system.
|
2895
|
+
# @return [Integer]
|
2896
|
+
#
|
2897
|
+
# @!attribute [rw] related_ops_items
|
2898
|
+
# One or more OpsItems that share something in common with the current
|
2899
|
+
# OpsItems. For example, related OpsItems can include OpsItems with
|
2900
|
+
# similar error messages, impacted resources, or statuses for the
|
2901
|
+
# impacted resource.
|
2902
|
+
# @return [Array<Types::RelatedOpsItem>]
|
2903
|
+
#
|
2904
|
+
# @!attribute [rw] source
|
2905
|
+
# The origin of the OpsItem, such as Amazon EC2 or AWS Systems
|
2906
|
+
# Manager.
|
2907
|
+
# @return [String]
|
2908
|
+
#
|
2909
|
+
# @!attribute [rw] title
|
2910
|
+
# A short heading that describes the nature of the OpsItem and the
|
2911
|
+
# impacted resource.
|
2912
|
+
# @return [String]
|
2913
|
+
#
|
2914
|
+
# @!attribute [rw] tags
|
2915
|
+
# Optional metadata that you assign to a resource. Tags enable you to
|
2916
|
+
# categorize a resource in different ways, such as by purpose, owner,
|
2917
|
+
# or environment. For example, you might want to tag an OpsItem to
|
2918
|
+
# identify the AWS resource or the type of issue. In this case, you
|
2919
|
+
# could specify the following key name/value pairs:
|
2920
|
+
#
|
2921
|
+
# * `Key=source,Value=EC2-instance`
|
2922
|
+
#
|
2923
|
+
# * `Key=status,Value=stopped`
|
2924
|
+
#
|
2925
|
+
# <note markdown="1"> To add tags to an existing OpsItem, use the AddTagsToResource
|
2926
|
+
# action.
|
2927
|
+
#
|
2928
|
+
# </note>
|
2929
|
+
# @return [Array<Types::Tag>]
|
2930
|
+
#
|
2931
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateOpsItemRequest AWS API Documentation
|
2932
|
+
#
|
2933
|
+
class CreateOpsItemRequest < Struct.new(
|
2934
|
+
:description,
|
2935
|
+
:operational_data,
|
2936
|
+
:notifications,
|
2937
|
+
:priority,
|
2938
|
+
:related_ops_items,
|
2939
|
+
:source,
|
2940
|
+
:title,
|
2941
|
+
:tags)
|
2942
|
+
include Aws::Structure
|
2943
|
+
end
|
2944
|
+
|
2945
|
+
# @!attribute [rw] ops_item_id
|
2946
|
+
# The ID of the OpsItem.
|
2947
|
+
# @return [String]
|
2948
|
+
#
|
2949
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateOpsItemResponse AWS API Documentation
|
2950
|
+
#
|
2951
|
+
class CreateOpsItemResponse < Struct.new(
|
2952
|
+
:ops_item_id)
|
2953
|
+
include Aws::Structure
|
2954
|
+
end
|
2955
|
+
|
2834
2956
|
# @note When making an API call, you may pass CreatePatchBaselineRequest
|
2835
2957
|
# data as a hash:
|
2836
2958
|
#
|
@@ -5058,6 +5180,114 @@ module Aws::SSM
|
|
5058
5180
|
include Aws::Structure
|
5059
5181
|
end
|
5060
5182
|
|
5183
|
+
# @note When making an API call, you may pass DescribeOpsItemsRequest
|
5184
|
+
# data as a hash:
|
5185
|
+
#
|
5186
|
+
# {
|
5187
|
+
# ops_item_filters: [
|
5188
|
+
# {
|
5189
|
+
# key: "Status", # required, accepts Status, CreatedBy, Source, Priority, Title, OpsItemId, CreatedTime, LastModifiedTime, OperationalData, OperationalDataKey, OperationalDataValue, ResourceId, AutomationId
|
5190
|
+
# values: ["OpsItemFilterValue"], # required
|
5191
|
+
# operator: "Equal", # required, accepts Equal, Contains, GreaterThan, LessThan
|
5192
|
+
# },
|
5193
|
+
# ],
|
5194
|
+
# max_results: 1,
|
5195
|
+
# next_token: "String",
|
5196
|
+
# }
|
5197
|
+
#
|
5198
|
+
# @!attribute [rw] ops_item_filters
|
5199
|
+
# One or more filters to limit the reponse.
|
5200
|
+
#
|
5201
|
+
# * Key: CreatedTime
|
5202
|
+
#
|
5203
|
+
# Operations: GreaterThan, LessThan
|
5204
|
+
#
|
5205
|
+
# * Key: LastModifiedBy
|
5206
|
+
#
|
5207
|
+
# Operations: Contains, Equals
|
5208
|
+
#
|
5209
|
+
# * Key: LastModifiedTime
|
5210
|
+
#
|
5211
|
+
# Operations: GreaterThan, LessThan
|
5212
|
+
#
|
5213
|
+
# * Key: Priority
|
5214
|
+
#
|
5215
|
+
# Operations: Equals
|
5216
|
+
#
|
5217
|
+
# * Key: Source
|
5218
|
+
#
|
5219
|
+
# Operations: Contains, Equals
|
5220
|
+
#
|
5221
|
+
# * Key: Status
|
5222
|
+
#
|
5223
|
+
# Operations: Equals
|
5224
|
+
#
|
5225
|
+
# * Key: Title
|
5226
|
+
#
|
5227
|
+
# Operations: Contains
|
5228
|
+
#
|
5229
|
+
# * Key: OperationalData
|
5230
|
+
#
|
5231
|
+
# Operations: Equals
|
5232
|
+
#
|
5233
|
+
# * Key: OperationalDataKey
|
5234
|
+
#
|
5235
|
+
# Operations: Equals
|
5236
|
+
#
|
5237
|
+
# * Key: OperationalDataValue
|
5238
|
+
#
|
5239
|
+
# Operations: Equals, Contains
|
5240
|
+
#
|
5241
|
+
# * Key: OpsItemId
|
5242
|
+
#
|
5243
|
+
# Operations: Equals
|
5244
|
+
#
|
5245
|
+
# * Key: ResourceId
|
5246
|
+
#
|
5247
|
+
# Operations: Contains
|
5248
|
+
#
|
5249
|
+
# * Key: AutomationId
|
5250
|
+
#
|
5251
|
+
# Operations: Equals
|
5252
|
+
# @return [Array<Types::OpsItemFilter>]
|
5253
|
+
#
|
5254
|
+
# @!attribute [rw] max_results
|
5255
|
+
# The maximum number of items to return for this call. The call also
|
5256
|
+
# returns a token that you can specify in a subsequent call to get the
|
5257
|
+
# next set of results.
|
5258
|
+
# @return [Integer]
|
5259
|
+
#
|
5260
|
+
# @!attribute [rw] next_token
|
5261
|
+
# A token to start the list. Use this token to get the next set of
|
5262
|
+
# results.
|
5263
|
+
# @return [String]
|
5264
|
+
#
|
5265
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeOpsItemsRequest AWS API Documentation
|
5266
|
+
#
|
5267
|
+
class DescribeOpsItemsRequest < Struct.new(
|
5268
|
+
:ops_item_filters,
|
5269
|
+
:max_results,
|
5270
|
+
:next_token)
|
5271
|
+
include Aws::Structure
|
5272
|
+
end
|
5273
|
+
|
5274
|
+
# @!attribute [rw] next_token
|
5275
|
+
# The token for the next set of items to return. Use this token to get
|
5276
|
+
# the next set of results.
|
5277
|
+
# @return [String]
|
5278
|
+
#
|
5279
|
+
# @!attribute [rw] ops_item_summaries
|
5280
|
+
# A list of OpsItems.
|
5281
|
+
# @return [Array<Types::OpsItemSummary>]
|
5282
|
+
#
|
5283
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeOpsItemsResponse AWS API Documentation
|
5284
|
+
#
|
5285
|
+
class DescribeOpsItemsResponse < Struct.new(
|
5286
|
+
:next_token,
|
5287
|
+
:ops_item_summaries)
|
5288
|
+
include Aws::Structure
|
5289
|
+
end
|
5290
|
+
|
5061
5291
|
# @note When making an API call, you may pass DescribeParametersRequest
|
5062
5292
|
# data as a hash:
|
5063
5293
|
#
|
@@ -7163,6 +7393,117 @@ module Aws::SSM
|
|
7163
7393
|
include Aws::Structure
|
7164
7394
|
end
|
7165
7395
|
|
7396
|
+
# @note When making an API call, you may pass GetOpsItemRequest
|
7397
|
+
# data as a hash:
|
7398
|
+
#
|
7399
|
+
# {
|
7400
|
+
# ops_item_id: "OpsItemId", # required
|
7401
|
+
# }
|
7402
|
+
#
|
7403
|
+
# @!attribute [rw] ops_item_id
|
7404
|
+
# The ID of the OpsItem that you want to get.
|
7405
|
+
# @return [String]
|
7406
|
+
#
|
7407
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetOpsItemRequest AWS API Documentation
|
7408
|
+
#
|
7409
|
+
class GetOpsItemRequest < Struct.new(
|
7410
|
+
:ops_item_id)
|
7411
|
+
include Aws::Structure
|
7412
|
+
end
|
7413
|
+
|
7414
|
+
# @!attribute [rw] ops_item
|
7415
|
+
# The OpsItem.
|
7416
|
+
# @return [Types::OpsItem]
|
7417
|
+
#
|
7418
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetOpsItemResponse AWS API Documentation
|
7419
|
+
#
|
7420
|
+
class GetOpsItemResponse < Struct.new(
|
7421
|
+
:ops_item)
|
7422
|
+
include Aws::Structure
|
7423
|
+
end
|
7424
|
+
|
7425
|
+
# @note When making an API call, you may pass GetOpsSummaryRequest
|
7426
|
+
# data as a hash:
|
7427
|
+
#
|
7428
|
+
# {
|
7429
|
+
# filters: [
|
7430
|
+
# {
|
7431
|
+
# key: "OpsFilterKey", # required
|
7432
|
+
# values: ["OpsFilterValue"], # required
|
7433
|
+
# type: "Equal", # accepts Equal, NotEqual, BeginWith, LessThan, GreaterThan, Exists
|
7434
|
+
# },
|
7435
|
+
# ],
|
7436
|
+
# aggregators: [ # required
|
7437
|
+
# {
|
7438
|
+
# aggregator_type: "OpsAggregatorType",
|
7439
|
+
# type_name: "OpsDataTypeName",
|
7440
|
+
# attribute_name: "OpsDataAttributeName",
|
7441
|
+
# values: {
|
7442
|
+
# "OpsAggregatorValueKey" => "OpsAggregatorValue",
|
7443
|
+
# },
|
7444
|
+
# filters: [
|
7445
|
+
# {
|
7446
|
+
# key: "OpsFilterKey", # required
|
7447
|
+
# values: ["OpsFilterValue"], # required
|
7448
|
+
# type: "Equal", # accepts Equal, NotEqual, BeginWith, LessThan, GreaterThan, Exists
|
7449
|
+
# },
|
7450
|
+
# ],
|
7451
|
+
# aggregators: {
|
7452
|
+
# # recursive OpsAggregatorList
|
7453
|
+
# },
|
7454
|
+
# },
|
7455
|
+
# ],
|
7456
|
+
# next_token: "NextToken",
|
7457
|
+
# max_results: 1,
|
7458
|
+
# }
|
7459
|
+
#
|
7460
|
+
# @!attribute [rw] filters
|
7461
|
+
# Optional filters used to scope down the returned OpsItems.
|
7462
|
+
# @return [Array<Types::OpsFilter>]
|
7463
|
+
#
|
7464
|
+
# @!attribute [rw] aggregators
|
7465
|
+
# Optional aggregators that return counts of OpsItems based on one or
|
7466
|
+
# more expressions.
|
7467
|
+
# @return [Array<Types::OpsAggregator>]
|
7468
|
+
#
|
7469
|
+
# @!attribute [rw] next_token
|
7470
|
+
# A token to start the list. Use this token to get the next set of
|
7471
|
+
# results.
|
7472
|
+
# @return [String]
|
7473
|
+
#
|
7474
|
+
# @!attribute [rw] max_results
|
7475
|
+
# The maximum number of items to return for this call. The call also
|
7476
|
+
# returns a token that you can specify in a subsequent call to get the
|
7477
|
+
# next set of results.
|
7478
|
+
# @return [Integer]
|
7479
|
+
#
|
7480
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetOpsSummaryRequest AWS API Documentation
|
7481
|
+
#
|
7482
|
+
class GetOpsSummaryRequest < Struct.new(
|
7483
|
+
:filters,
|
7484
|
+
:aggregators,
|
7485
|
+
:next_token,
|
7486
|
+
:max_results)
|
7487
|
+
include Aws::Structure
|
7488
|
+
end
|
7489
|
+
|
7490
|
+
# @!attribute [rw] entities
|
7491
|
+
# The list of aggregated and filtered OpsItems.
|
7492
|
+
# @return [Array<Types::OpsEntity>]
|
7493
|
+
#
|
7494
|
+
# @!attribute [rw] next_token
|
7495
|
+
# The token for the next set of items to return. Use this token to get
|
7496
|
+
# the next set of results.
|
7497
|
+
# @return [String]
|
7498
|
+
#
|
7499
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetOpsSummaryResult AWS API Documentation
|
7500
|
+
#
|
7501
|
+
class GetOpsSummaryResult < Struct.new(
|
7502
|
+
:entities,
|
7503
|
+
:next_token)
|
7504
|
+
include Aws::Structure
|
7505
|
+
end
|
7506
|
+
|
7166
7507
|
# @note When making an API call, you may pass GetParameterHistoryRequest
|
7167
7508
|
# data as a hash:
|
7168
7509
|
#
|
@@ -9880,7 +10221,7 @@ module Aws::SSM
|
|
9880
10221
|
# data as a hash:
|
9881
10222
|
#
|
9882
10223
|
# {
|
9883
|
-
# resource_type: "Document", # required, accepts Document, ManagedInstance, MaintenanceWindow, Parameter, PatchBaseline
|
10224
|
+
# resource_type: "Document", # required, accepts Document, ManagedInstance, MaintenanceWindow, Parameter, PatchBaseline, OpsItem
|
9884
10225
|
# resource_id: "ResourceId", # required
|
9885
10226
|
# }
|
9886
10227
|
#
|
@@ -10856,44 +11197,532 @@ module Aws::SSM
|
|
10856
11197
|
include Aws::Structure
|
10857
11198
|
end
|
10858
11199
|
|
10859
|
-
#
|
10860
|
-
#
|
11200
|
+
# One or more aggregators for viewing counts of OpsItems using different
|
11201
|
+
# dimensions such as `Source`, `CreatedTime`, or `Source and
|
11202
|
+
# CreatedTime`, to name a few.
|
10861
11203
|
#
|
10862
|
-
#
|
10863
|
-
#
|
10864
|
-
#
|
11204
|
+
# @note When making an API call, you may pass OpsAggregator
|
11205
|
+
# data as a hash:
|
11206
|
+
#
|
11207
|
+
# {
|
11208
|
+
# aggregator_type: "OpsAggregatorType",
|
11209
|
+
# type_name: "OpsDataTypeName",
|
11210
|
+
# attribute_name: "OpsDataAttributeName",
|
11211
|
+
# values: {
|
11212
|
+
# "OpsAggregatorValueKey" => "OpsAggregatorValue",
|
11213
|
+
# },
|
11214
|
+
# filters: [
|
11215
|
+
# {
|
11216
|
+
# key: "OpsFilterKey", # required
|
11217
|
+
# values: ["OpsFilterValue"], # required
|
11218
|
+
# type: "Equal", # accepts Equal, NotEqual, BeginWith, LessThan, GreaterThan, Exists
|
11219
|
+
# },
|
11220
|
+
# ],
|
11221
|
+
# aggregators: [
|
11222
|
+
# {
|
11223
|
+
# aggregator_type: "OpsAggregatorType",
|
11224
|
+
# type_name: "OpsDataTypeName",
|
11225
|
+
# attribute_name: "OpsDataAttributeName",
|
11226
|
+
# values: {
|
11227
|
+
# "OpsAggregatorValueKey" => "OpsAggregatorValue",
|
11228
|
+
# },
|
11229
|
+
# filters: [
|
11230
|
+
# {
|
11231
|
+
# key: "OpsFilterKey", # required
|
11232
|
+
# values: ["OpsFilterValue"], # required
|
11233
|
+
# type: "Equal", # accepts Equal, NotEqual, BeginWith, LessThan, GreaterThan, Exists
|
11234
|
+
# },
|
11235
|
+
# ],
|
11236
|
+
# aggregators: {
|
11237
|
+
# # recursive OpsAggregatorList
|
11238
|
+
# },
|
11239
|
+
# },
|
11240
|
+
# ],
|
11241
|
+
# }
|
11242
|
+
#
|
11243
|
+
# @!attribute [rw] aggregator_type
|
11244
|
+
# Either a Range or Count aggregator for limiting an OpsItem summary.
|
10865
11245
|
# @return [String]
|
10866
11246
|
#
|
10867
|
-
# @!attribute [rw]
|
10868
|
-
# The type
|
10869
|
-
# stored, for example, Amazon S3.
|
11247
|
+
# @!attribute [rw] type_name
|
11248
|
+
# The data type name to use for viewing counts of OpsItems.
|
10870
11249
|
# @return [String]
|
10871
11250
|
#
|
10872
|
-
#
|
11251
|
+
# @!attribute [rw] attribute_name
|
11252
|
+
# The name of an OpsItem attribute on which to limit the count of
|
11253
|
+
# OpsItems.
|
11254
|
+
# @return [String]
|
10873
11255
|
#
|
10874
|
-
|
10875
|
-
|
10876
|
-
|
11256
|
+
# @!attribute [rw] values
|
11257
|
+
# The aggregator value.
|
11258
|
+
# @return [Hash<String,String>]
|
11259
|
+
#
|
11260
|
+
# @!attribute [rw] filters
|
11261
|
+
# The aggregator filters.
|
11262
|
+
# @return [Array<Types::OpsFilter>]
|
11263
|
+
#
|
11264
|
+
# @!attribute [rw] aggregators
|
11265
|
+
# A nested aggregator for viewing counts of OpsItems.
|
11266
|
+
# @return [Array<Types::OpsAggregator>]
|
11267
|
+
#
|
11268
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsAggregator AWS API Documentation
|
11269
|
+
#
|
11270
|
+
class OpsAggregator < Struct.new(
|
11271
|
+
:aggregator_type,
|
11272
|
+
:type_name,
|
11273
|
+
:attribute_name,
|
11274
|
+
:values,
|
11275
|
+
:filters,
|
11276
|
+
:aggregators)
|
10877
11277
|
include Aws::Structure
|
10878
11278
|
end
|
10879
11279
|
|
10880
|
-
#
|
11280
|
+
# The result of the query.
|
10881
11281
|
#
|
10882
|
-
# @!attribute [rw]
|
10883
|
-
# The
|
11282
|
+
# @!attribute [rw] id
|
11283
|
+
# The query ID.
|
10884
11284
|
# @return [String]
|
10885
11285
|
#
|
10886
|
-
# @!attribute [rw]
|
10887
|
-
# The
|
10888
|
-
# String
|
10889
|
-
# @return [String]
|
11286
|
+
# @!attribute [rw] data
|
11287
|
+
# The data returned by the query.
|
11288
|
+
# @return [Hash<String,Types::OpsEntityItem>]
|
10890
11289
|
#
|
10891
|
-
#
|
10892
|
-
# The parameter value.
|
10893
|
-
# @return [String]
|
11290
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsEntity AWS API Documentation
|
10894
11291
|
#
|
10895
|
-
|
10896
|
-
|
11292
|
+
class OpsEntity < Struct.new(
|
11293
|
+
:id,
|
11294
|
+
:data)
|
11295
|
+
include Aws::Structure
|
11296
|
+
end
|
11297
|
+
|
11298
|
+
# The OpsItem summaries result item.
|
11299
|
+
#
|
11300
|
+
# @!attribute [rw] content
|
11301
|
+
# The detailed data content for an OpsItem summaries result item.
|
11302
|
+
# @return [Array<Hash<String,String>>]
|
11303
|
+
#
|
11304
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsEntityItem AWS API Documentation
|
11305
|
+
#
|
11306
|
+
class OpsEntityItem < Struct.new(
|
11307
|
+
:content)
|
11308
|
+
include Aws::Structure
|
11309
|
+
end
|
11310
|
+
|
11311
|
+
# A filter for viewing OpsItem summaries.
|
11312
|
+
#
|
11313
|
+
# @note When making an API call, you may pass OpsFilter
|
11314
|
+
# data as a hash:
|
11315
|
+
#
|
11316
|
+
# {
|
11317
|
+
# key: "OpsFilterKey", # required
|
11318
|
+
# values: ["OpsFilterValue"], # required
|
11319
|
+
# type: "Equal", # accepts Equal, NotEqual, BeginWith, LessThan, GreaterThan, Exists
|
11320
|
+
# }
|
11321
|
+
#
|
11322
|
+
# @!attribute [rw] key
|
11323
|
+
# The name of the filter.
|
11324
|
+
# @return [String]
|
11325
|
+
#
|
11326
|
+
# @!attribute [rw] values
|
11327
|
+
# The filter value.
|
11328
|
+
# @return [Array<String>]
|
11329
|
+
#
|
11330
|
+
# @!attribute [rw] type
|
11331
|
+
# The type of filter.
|
11332
|
+
# @return [String]
|
11333
|
+
#
|
11334
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsFilter AWS API Documentation
|
11335
|
+
#
|
11336
|
+
class OpsFilter < Struct.new(
|
11337
|
+
:key,
|
11338
|
+
:values,
|
11339
|
+
:type)
|
11340
|
+
include Aws::Structure
|
11341
|
+
end
|
11342
|
+
|
11343
|
+
# Operations engineers and IT professionals use the Systems Manager
|
11344
|
+
# OpsItems capability to view, investigate, and remediate operational
|
11345
|
+
# issues impacting the performance and health of their AWS resources.
|
11346
|
+
# For more information, see [AWS Systems Manager OpsItems][1] in the
|
11347
|
+
# *AWS Systems Manager User Guide*.
|
11348
|
+
#
|
11349
|
+
#
|
11350
|
+
#
|
11351
|
+
# [1]: http://docs.aws.amazon.com/systems-manager/latest/userguide/OpsItems.html
|
11352
|
+
#
|
11353
|
+
# @!attribute [rw] created_by
|
11354
|
+
# The ARN of the AWS account that created the OpsItem.
|
11355
|
+
# @return [String]
|
11356
|
+
#
|
11357
|
+
# @!attribute [rw] created_time
|
11358
|
+
# The date and time the OpsItem was created.
|
11359
|
+
# @return [Time]
|
11360
|
+
#
|
11361
|
+
# @!attribute [rw] description
|
11362
|
+
# The OpsItem description.
|
11363
|
+
# @return [String]
|
11364
|
+
#
|
11365
|
+
# @!attribute [rw] last_modified_by
|
11366
|
+
# The ARN of the AWS account that last updated the OpsItem.
|
11367
|
+
# @return [String]
|
11368
|
+
#
|
11369
|
+
# @!attribute [rw] last_modified_time
|
11370
|
+
# The date and time the OpsItem was last updated.
|
11371
|
+
# @return [Time]
|
11372
|
+
#
|
11373
|
+
# @!attribute [rw] notifications
|
11374
|
+
# The Amazon Resource Name (ARN) of an SNS topic where notifications
|
11375
|
+
# are sent when this OpsItem is edited or changed.
|
11376
|
+
# @return [Array<Types::OpsItemNotification>]
|
11377
|
+
#
|
11378
|
+
# @!attribute [rw] priority
|
11379
|
+
# The importance of this OpsItem in relation to other OpsItems in the
|
11380
|
+
# system.
|
11381
|
+
# @return [Integer]
|
11382
|
+
#
|
11383
|
+
# @!attribute [rw] related_ops_items
|
11384
|
+
# One or more OpsItems that share something in common with the current
|
11385
|
+
# OpsItems. For example, related OpsItems can include OpsItems with
|
11386
|
+
# similar error messages, impacted resources, or statuses for the
|
11387
|
+
# impacted resource.
|
11388
|
+
# @return [Array<Types::RelatedOpsItem>]
|
11389
|
+
#
|
11390
|
+
# @!attribute [rw] status
|
11391
|
+
# The OpsItem status. Status can be `Open`, `In Progress`, or
|
11392
|
+
# `Resolved`. For more information, see [Editing OpsItem Details][1]
|
11393
|
+
# in the *AWS Systems Manager User Guide*.
|
11394
|
+
#
|
11395
|
+
#
|
11396
|
+
#
|
11397
|
+
# [1]: http://docs.aws.amazon.com/systems-manager/latest/userguide/OpsItems-working-with-OpsItems-editing-details.html
|
11398
|
+
# @return [String]
|
11399
|
+
#
|
11400
|
+
# @!attribute [rw] ops_item_id
|
11401
|
+
# The ID of the OpsItem.
|
11402
|
+
# @return [String]
|
11403
|
+
#
|
11404
|
+
# @!attribute [rw] version
|
11405
|
+
# The version of this OpsItem. Each time the OpsItem is edited the
|
11406
|
+
# version number increments by one.
|
11407
|
+
# @return [String]
|
11408
|
+
#
|
11409
|
+
# @!attribute [rw] title
|
11410
|
+
# A short heading that describes the nature of the OpsItem and the
|
11411
|
+
# impacted resource.
|
11412
|
+
# @return [String]
|
11413
|
+
#
|
11414
|
+
# @!attribute [rw] source
|
11415
|
+
# The origin of the OpsItem, such as Amazon EC2 or AWS Systems
|
11416
|
+
# Manager. The impacted resource is a subset of source.
|
11417
|
+
# @return [String]
|
11418
|
+
#
|
11419
|
+
# @!attribute [rw] operational_data
|
11420
|
+
# Operational data is custom data that provides useful reference
|
11421
|
+
# details about the OpsItem. For example, you can specify log files,
|
11422
|
+
# error strings, license keys, troubleshooting tips, or other relevant
|
11423
|
+
# data. You enter operational data as key-value pairs. The key has a
|
11424
|
+
# maximum length of 128 characters. The value has a maximum size of 20
|
11425
|
+
# KB.
|
11426
|
+
#
|
11427
|
+
# This custom data is searchable, but with restrictions. For the
|
11428
|
+
# `Searchable operational data` feature, all users with access to the
|
11429
|
+
# OpsItem Overview page (as provided by the DescribeOpsItems API
|
11430
|
+
# action) can view and search on the specified data. For the `Private
|
11431
|
+
# operational data` feature, the data is only viewable by users who
|
11432
|
+
# have access to the OpsItem (as provided by the GetOpsItem API
|
11433
|
+
# action).
|
11434
|
+
# @return [Hash<String,Types::OpsItemDataValue>]
|
11435
|
+
#
|
11436
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItem AWS API Documentation
|
11437
|
+
#
|
11438
|
+
class OpsItem < Struct.new(
|
11439
|
+
:created_by,
|
11440
|
+
:created_time,
|
11441
|
+
:description,
|
11442
|
+
:last_modified_by,
|
11443
|
+
:last_modified_time,
|
11444
|
+
:notifications,
|
11445
|
+
:priority,
|
11446
|
+
:related_ops_items,
|
11447
|
+
:status,
|
11448
|
+
:ops_item_id,
|
11449
|
+
:version,
|
11450
|
+
:title,
|
11451
|
+
:source,
|
11452
|
+
:operational_data)
|
11453
|
+
include Aws::Structure
|
11454
|
+
end
|
11455
|
+
|
11456
|
+
# The OpsItem already exists.
|
11457
|
+
#
|
11458
|
+
# @!attribute [rw] message
|
11459
|
+
# @return [String]
|
11460
|
+
#
|
11461
|
+
# @!attribute [rw] ops_item_id
|
11462
|
+
# @return [String]
|
11463
|
+
#
|
11464
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItemAlreadyExistsException AWS API Documentation
|
11465
|
+
#
|
11466
|
+
class OpsItemAlreadyExistsException < Struct.new(
|
11467
|
+
:message,
|
11468
|
+
:ops_item_id)
|
11469
|
+
include Aws::Structure
|
11470
|
+
end
|
11471
|
+
|
11472
|
+
# An object that defines the value of the key and its type in the
|
11473
|
+
# OperationalData map.
|
11474
|
+
#
|
11475
|
+
# @note When making an API call, you may pass OpsItemDataValue
|
11476
|
+
# data as a hash:
|
11477
|
+
#
|
11478
|
+
# {
|
11479
|
+
# value: "OpsItemDataValueString",
|
11480
|
+
# type: "SearchableString", # accepts SearchableString, String
|
11481
|
+
# }
|
11482
|
+
#
|
11483
|
+
# @!attribute [rw] value
|
11484
|
+
# The value of the OperationalData key.
|
11485
|
+
# @return [String]
|
11486
|
+
#
|
11487
|
+
# @!attribute [rw] type
|
11488
|
+
# The type of key-value pair. Valid types include `SearchableString`
|
11489
|
+
# and `String`.
|
11490
|
+
# @return [String]
|
11491
|
+
#
|
11492
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItemDataValue AWS API Documentation
|
11493
|
+
#
|
11494
|
+
class OpsItemDataValue < Struct.new(
|
11495
|
+
:value,
|
11496
|
+
:type)
|
11497
|
+
include Aws::Structure
|
11498
|
+
end
|
11499
|
+
|
11500
|
+
# Describes an OpsCenter filter.
|
11501
|
+
#
|
11502
|
+
# @note When making an API call, you may pass OpsItemFilter
|
11503
|
+
# data as a hash:
|
11504
|
+
#
|
11505
|
+
# {
|
11506
|
+
# key: "Status", # required, accepts Status, CreatedBy, Source, Priority, Title, OpsItemId, CreatedTime, LastModifiedTime, OperationalData, OperationalDataKey, OperationalDataValue, ResourceId, AutomationId
|
11507
|
+
# values: ["OpsItemFilterValue"], # required
|
11508
|
+
# operator: "Equal", # required, accepts Equal, Contains, GreaterThan, LessThan
|
11509
|
+
# }
|
11510
|
+
#
|
11511
|
+
# @!attribute [rw] key
|
11512
|
+
# The name of the filter.
|
11513
|
+
# @return [String]
|
11514
|
+
#
|
11515
|
+
# @!attribute [rw] values
|
11516
|
+
# The filter value.
|
11517
|
+
# @return [Array<String>]
|
11518
|
+
#
|
11519
|
+
# @!attribute [rw] operator
|
11520
|
+
# The operator used by the filter call.
|
11521
|
+
# @return [String]
|
11522
|
+
#
|
11523
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItemFilter AWS API Documentation
|
11524
|
+
#
|
11525
|
+
class OpsItemFilter < Struct.new(
|
11526
|
+
:key,
|
11527
|
+
:values,
|
11528
|
+
:operator)
|
11529
|
+
include Aws::Structure
|
11530
|
+
end
|
11531
|
+
|
11532
|
+
# A specified parameter argument isn't valid. Verify the available
|
11533
|
+
# arguments and try again.
|
11534
|
+
#
|
11535
|
+
# @!attribute [rw] parameter_names
|
11536
|
+
# @return [Array<String>]
|
11537
|
+
#
|
11538
|
+
# @!attribute [rw] message
|
11539
|
+
# @return [String]
|
11540
|
+
#
|
11541
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItemInvalidParameterException AWS API Documentation
|
11542
|
+
#
|
11543
|
+
class OpsItemInvalidParameterException < Struct.new(
|
11544
|
+
:parameter_names,
|
11545
|
+
:message)
|
11546
|
+
include Aws::Structure
|
11547
|
+
end
|
11548
|
+
|
11549
|
+
# The request caused OpsItems to exceed one or more limits. For
|
11550
|
+
# information about OpsItem limits, see [What are the resource limits
|
11551
|
+
# for OpsItems?][1].
|
11552
|
+
#
|
11553
|
+
#
|
11554
|
+
#
|
11555
|
+
# [1]: http://docs.aws.amazon.com/systems-manager/latest/userguide/OpsItems-learn-more.html#OpsItems-learn-more-limits
|
11556
|
+
#
|
11557
|
+
# @!attribute [rw] resource_types
|
11558
|
+
# @return [Array<String>]
|
11559
|
+
#
|
11560
|
+
# @!attribute [rw] limit
|
11561
|
+
# @return [Integer]
|
11562
|
+
#
|
11563
|
+
# @!attribute [rw] limit_type
|
11564
|
+
# @return [String]
|
11565
|
+
#
|
11566
|
+
# @!attribute [rw] message
|
11567
|
+
# @return [String]
|
11568
|
+
#
|
11569
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItemLimitExceededException AWS API Documentation
|
11570
|
+
#
|
11571
|
+
class OpsItemLimitExceededException < Struct.new(
|
11572
|
+
:resource_types,
|
11573
|
+
:limit,
|
11574
|
+
:limit_type,
|
11575
|
+
:message)
|
11576
|
+
include Aws::Structure
|
11577
|
+
end
|
11578
|
+
|
11579
|
+
# The specified OpsItem ID doesn't exist. Verify the ID and try again.
|
11580
|
+
#
|
11581
|
+
# @!attribute [rw] message
|
11582
|
+
# @return [String]
|
11583
|
+
#
|
11584
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItemNotFoundException AWS API Documentation
|
11585
|
+
#
|
11586
|
+
class OpsItemNotFoundException < Struct.new(
|
11587
|
+
:message)
|
11588
|
+
include Aws::Structure
|
11589
|
+
end
|
11590
|
+
|
11591
|
+
# A notification about the OpsItem.
|
11592
|
+
#
|
11593
|
+
# @note When making an API call, you may pass OpsItemNotification
|
11594
|
+
# data as a hash:
|
11595
|
+
#
|
11596
|
+
# {
|
11597
|
+
# arn: "String",
|
11598
|
+
# }
|
11599
|
+
#
|
11600
|
+
# @!attribute [rw] arn
|
11601
|
+
# The Amazon Resource Name (ARN) of an SNS topic where notifications
|
11602
|
+
# are sent when this OpsItem is edited or changed.
|
11603
|
+
# @return [String]
|
11604
|
+
#
|
11605
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItemNotification AWS API Documentation
|
11606
|
+
#
|
11607
|
+
class OpsItemNotification < Struct.new(
|
11608
|
+
:arn)
|
11609
|
+
include Aws::Structure
|
11610
|
+
end
|
11611
|
+
|
11612
|
+
# A count of OpsItems.
|
11613
|
+
#
|
11614
|
+
# @!attribute [rw] created_by
|
11615
|
+
# The Amazon Resource Name (ARN) of the IAM entity that created the
|
11616
|
+
# OpsItem.
|
11617
|
+
# @return [String]
|
11618
|
+
#
|
11619
|
+
# @!attribute [rw] created_time
|
11620
|
+
# The date and time the OpsItem was created.
|
11621
|
+
# @return [Time]
|
11622
|
+
#
|
11623
|
+
# @!attribute [rw] last_modified_by
|
11624
|
+
# The Amazon Resource Name (ARN) of the IAM entity that created the
|
11625
|
+
# OpsItem.
|
11626
|
+
# @return [String]
|
11627
|
+
#
|
11628
|
+
# @!attribute [rw] last_modified_time
|
11629
|
+
# The date and time the OpsItem was last updated.
|
11630
|
+
# @return [Time]
|
11631
|
+
#
|
11632
|
+
# @!attribute [rw] priority
|
11633
|
+
# The importance of this OpsItem in relation to other OpsItems in the
|
11634
|
+
# system.
|
11635
|
+
# @return [Integer]
|
11636
|
+
#
|
11637
|
+
# @!attribute [rw] source
|
11638
|
+
# The impacted AWS resource.
|
11639
|
+
# @return [String]
|
11640
|
+
#
|
11641
|
+
# @!attribute [rw] status
|
11642
|
+
# The OpsItem status. Status can be `Open`, `In Progress`, or
|
11643
|
+
# `Resolved`.
|
11644
|
+
# @return [String]
|
11645
|
+
#
|
11646
|
+
# @!attribute [rw] ops_item_id
|
11647
|
+
# The ID of the OpsItem.
|
11648
|
+
# @return [String]
|
11649
|
+
#
|
11650
|
+
# @!attribute [rw] title
|
11651
|
+
# A short heading that describes the nature of the OpsItem and the
|
11652
|
+
# impacted resource.
|
11653
|
+
# @return [String]
|
11654
|
+
#
|
11655
|
+
# @!attribute [rw] operational_data
|
11656
|
+
# Operational data is custom data that provides useful reference
|
11657
|
+
# details about the OpsItem. For example, you can specify log files,
|
11658
|
+
# error strings, license keys, troubleshooting tips, or other relevant
|
11659
|
+
# data. You enter operational data as key-value pairs. The key has a
|
11660
|
+
# maximum length of 128 characters. The value has a maximum size of 20
|
11661
|
+
# KB.
|
11662
|
+
#
|
11663
|
+
# This custom data is searchable, but with restrictions. For the
|
11664
|
+
# `Searchable operational data` feature, all users with access to the
|
11665
|
+
# OpsItem Overview page (as provided by the DescribeOpsItems API
|
11666
|
+
# action) can view and search on the specified data. For the `Private
|
11667
|
+
# operational data` feature, the data is only viewable by users who
|
11668
|
+
# have access to the OpsItem (as provided by the GetOpsItem API
|
11669
|
+
# action).
|
11670
|
+
# @return [Hash<String,Types::OpsItemDataValue>]
|
11671
|
+
#
|
11672
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OpsItemSummary AWS API Documentation
|
11673
|
+
#
|
11674
|
+
class OpsItemSummary < Struct.new(
|
11675
|
+
:created_by,
|
11676
|
+
:created_time,
|
11677
|
+
:last_modified_by,
|
11678
|
+
:last_modified_time,
|
11679
|
+
:priority,
|
11680
|
+
:source,
|
11681
|
+
:status,
|
11682
|
+
:ops_item_id,
|
11683
|
+
:title,
|
11684
|
+
:operational_data)
|
11685
|
+
include Aws::Structure
|
11686
|
+
end
|
11687
|
+
|
11688
|
+
# Information about the source where the association execution details
|
11689
|
+
# are stored.
|
11690
|
+
#
|
11691
|
+
# @!attribute [rw] output_source_id
|
11692
|
+
# The ID of the output source, for example the URL of an Amazon S3
|
11693
|
+
# bucket.
|
11694
|
+
# @return [String]
|
11695
|
+
#
|
11696
|
+
# @!attribute [rw] output_source_type
|
11697
|
+
# The type of source where the association execution details are
|
11698
|
+
# stored, for example, Amazon S3.
|
11699
|
+
# @return [String]
|
11700
|
+
#
|
11701
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/OutputSource AWS API Documentation
|
11702
|
+
#
|
11703
|
+
class OutputSource < Struct.new(
|
11704
|
+
:output_source_id,
|
11705
|
+
:output_source_type)
|
11706
|
+
include Aws::Structure
|
11707
|
+
end
|
11708
|
+
|
11709
|
+
# An Amazon EC2 Systems Manager parameter in Parameter Store.
|
11710
|
+
#
|
11711
|
+
# @!attribute [rw] name
|
11712
|
+
# The name of the parameter.
|
11713
|
+
# @return [String]
|
11714
|
+
#
|
11715
|
+
# @!attribute [rw] type
|
11716
|
+
# The type of parameter. Valid values include the following: String,
|
11717
|
+
# String list, Secure string.
|
11718
|
+
# @return [String]
|
11719
|
+
#
|
11720
|
+
# @!attribute [rw] value
|
11721
|
+
# The parameter value.
|
11722
|
+
# @return [String]
|
11723
|
+
#
|
11724
|
+
# @!attribute [rw] version
|
11725
|
+
# The parameter version.
|
10897
11726
|
# @return [Integer]
|
10898
11727
|
#
|
10899
11728
|
# @!attribute [rw] selector
|
@@ -12485,11 +13314,33 @@ module Aws::SSM
|
|
12485
13314
|
include Aws::Structure
|
12486
13315
|
end
|
12487
13316
|
|
13317
|
+
# An OpsItems that shares something in common with the current OpsItems.
|
13318
|
+
# For example, related OpsItems can include OpsItems with similar error
|
13319
|
+
# messages, impacted resources, or statuses for the impacted resource.
|
13320
|
+
#
|
13321
|
+
# @note When making an API call, you may pass RelatedOpsItem
|
13322
|
+
# data as a hash:
|
13323
|
+
#
|
13324
|
+
# {
|
13325
|
+
# ops_item_id: "String", # required
|
13326
|
+
# }
|
13327
|
+
#
|
13328
|
+
# @!attribute [rw] ops_item_id
|
13329
|
+
# The ID of an OpsItem related to the current OpsItem.
|
13330
|
+
# @return [String]
|
13331
|
+
#
|
13332
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/RelatedOpsItem AWS API Documentation
|
13333
|
+
#
|
13334
|
+
class RelatedOpsItem < Struct.new(
|
13335
|
+
:ops_item_id)
|
13336
|
+
include Aws::Structure
|
13337
|
+
end
|
13338
|
+
|
12488
13339
|
# @note When making an API call, you may pass RemoveTagsFromResourceRequest
|
12489
13340
|
# data as a hash:
|
12490
13341
|
#
|
12491
13342
|
# {
|
12492
|
-
# resource_type: "Document", # required, accepts Document, ManagedInstance, MaintenanceWindow, Parameter, PatchBaseline
|
13343
|
+
# resource_type: "Document", # required, accepts Document, ManagedInstance, MaintenanceWindow, Parameter, PatchBaseline, OpsItem
|
12493
13344
|
# resource_id: "ResourceId", # required
|
12494
13345
|
# tag_keys: ["TagKey"], # required
|
12495
13346
|
# }
|
@@ -15157,6 +16008,119 @@ module Aws::SSM
|
|
15157
16008
|
#
|
15158
16009
|
class UpdateManagedInstanceRoleResult < Aws::EmptyStructure; end
|
15159
16010
|
|
16011
|
+
# @note When making an API call, you may pass UpdateOpsItemRequest
|
16012
|
+
# data as a hash:
|
16013
|
+
#
|
16014
|
+
# {
|
16015
|
+
# description: "OpsItemDescription",
|
16016
|
+
# operational_data: {
|
16017
|
+
# "OpsItemDataKey" => {
|
16018
|
+
# value: "OpsItemDataValueString",
|
16019
|
+
# type: "SearchableString", # accepts SearchableString, String
|
16020
|
+
# },
|
16021
|
+
# },
|
16022
|
+
# operational_data_to_delete: ["String"],
|
16023
|
+
# notifications: [
|
16024
|
+
# {
|
16025
|
+
# arn: "String",
|
16026
|
+
# },
|
16027
|
+
# ],
|
16028
|
+
# priority: 1,
|
16029
|
+
# related_ops_items: [
|
16030
|
+
# {
|
16031
|
+
# ops_item_id: "String", # required
|
16032
|
+
# },
|
16033
|
+
# ],
|
16034
|
+
# status: "Open", # accepts Open, InProgress, Resolved
|
16035
|
+
# ops_item_id: "OpsItemId", # required
|
16036
|
+
# title: "OpsItemTitle",
|
16037
|
+
# }
|
16038
|
+
#
|
16039
|
+
# @!attribute [rw] description
|
16040
|
+
# Update the information about the OpsItem. Provide enough information
|
16041
|
+
# so that users reading this OpsItem for the first time understand the
|
16042
|
+
# issue.
|
16043
|
+
# @return [String]
|
16044
|
+
#
|
16045
|
+
# @!attribute [rw] operational_data
|
16046
|
+
# Add new keys or edit existing key-value pairs of the OperationalData
|
16047
|
+
# map in the OpsItem object.
|
16048
|
+
#
|
16049
|
+
# Operational data is custom data that provides useful reference
|
16050
|
+
# details about the OpsItem. For example, you can specify log files,
|
16051
|
+
# error strings, license keys, troubleshooting tips, or other relevant
|
16052
|
+
# data. You enter operational data as key-value pairs. The key has a
|
16053
|
+
# maximum length of 128 characters. The value has a maximum size of 20
|
16054
|
+
# KB.
|
16055
|
+
#
|
16056
|
+
# This custom data is searchable, but with restrictions. For the
|
16057
|
+
# `Searchable operational data` feature, all users with access to the
|
16058
|
+
# OpsItem Overview page (as provided by the DescribeOpsItems API
|
16059
|
+
# action) can view and search on the specified data. For the `Private
|
16060
|
+
# operational data` feature, the data is only viewable by users who
|
16061
|
+
# have access to the OpsItem (as provided by the GetOpsItem API
|
16062
|
+
# action).
|
16063
|
+
# @return [Hash<String,Types::OpsItemDataValue>]
|
16064
|
+
#
|
16065
|
+
# @!attribute [rw] operational_data_to_delete
|
16066
|
+
# Keys that you want to remove from the OperationalData map.
|
16067
|
+
# @return [Array<String>]
|
16068
|
+
#
|
16069
|
+
# @!attribute [rw] notifications
|
16070
|
+
# The Amazon Resource Name (ARN) of an SNS topic where notifications
|
16071
|
+
# are sent when this OpsItem is edited or changed.
|
16072
|
+
# @return [Array<Types::OpsItemNotification>]
|
16073
|
+
#
|
16074
|
+
# @!attribute [rw] priority
|
16075
|
+
# The importance of this OpsItem in relation to other OpsItems in the
|
16076
|
+
# system.
|
16077
|
+
# @return [Integer]
|
16078
|
+
#
|
16079
|
+
# @!attribute [rw] related_ops_items
|
16080
|
+
# One or more OpsItems that share something in common with the current
|
16081
|
+
# OpsItems. For example, related OpsItems can include OpsItems with
|
16082
|
+
# similar error messages, impacted resources, or statuses for the
|
16083
|
+
# impacted resource.
|
16084
|
+
# @return [Array<Types::RelatedOpsItem>]
|
16085
|
+
#
|
16086
|
+
# @!attribute [rw] status
|
16087
|
+
# The OpsItem status. Status can be `Open`, `In Progress`, or
|
16088
|
+
# `Resolved`. For more information, see [Editing OpsItem Details][1]
|
16089
|
+
# in the *AWS Systems Manager User Guide*.
|
16090
|
+
#
|
16091
|
+
#
|
16092
|
+
#
|
16093
|
+
# [1]: http://docs.aws.amazon.com/systems-manager/latest/userguide/OpsItems-working-with-OpsItems-editing-details.html
|
16094
|
+
# @return [String]
|
16095
|
+
#
|
16096
|
+
# @!attribute [rw] ops_item_id
|
16097
|
+
# The ID of the OpsItem.
|
16098
|
+
# @return [String]
|
16099
|
+
#
|
16100
|
+
# @!attribute [rw] title
|
16101
|
+
# A short heading that describes the nature of the OpsItem and the
|
16102
|
+
# impacted resource.
|
16103
|
+
# @return [String]
|
16104
|
+
#
|
16105
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateOpsItemRequest AWS API Documentation
|
16106
|
+
#
|
16107
|
+
class UpdateOpsItemRequest < Struct.new(
|
16108
|
+
:description,
|
16109
|
+
:operational_data,
|
16110
|
+
:operational_data_to_delete,
|
16111
|
+
:notifications,
|
16112
|
+
:priority,
|
16113
|
+
:related_ops_items,
|
16114
|
+
:status,
|
16115
|
+
:ops_item_id,
|
16116
|
+
:title)
|
16117
|
+
include Aws::Structure
|
16118
|
+
end
|
16119
|
+
|
16120
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateOpsItemResponse AWS API Documentation
|
16121
|
+
#
|
16122
|
+
class UpdateOpsItemResponse < Aws::EmptyStructure; end
|
16123
|
+
|
15160
16124
|
# @note When making an API call, you may pass UpdatePatchBaselineRequest
|
15161
16125
|
# data as a hash:
|
15162
16126
|
#
|