aws-sdk-ssmincidents 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-ssmincidents.rb +54 -0
- data/lib/aws-sdk-ssmincidents/client.rb +1895 -0
- data/lib/aws-sdk-ssmincidents/client_api.rb +1080 -0
- data/lib/aws-sdk-ssmincidents/customizations.rb +0 -0
- data/lib/aws-sdk-ssmincidents/errors.rb +200 -0
- data/lib/aws-sdk-ssmincidents/resource.rb +26 -0
- data/lib/aws-sdk-ssmincidents/types.rb +2671 -0
- data/lib/aws-sdk-ssmincidents/waiters.rb +184 -0
- metadata +91 -0
File without changes
|
@@ -0,0 +1,200 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::SSMIncidents
|
11
|
+
|
12
|
+
# When SSMIncidents returns an error response, the Ruby SDK constructs and raises an error.
|
13
|
+
# These errors all extend Aws::SSMIncidents::Errors::ServiceError < {Aws::Errors::ServiceError}
|
14
|
+
#
|
15
|
+
# You can rescue all SSMIncidents errors using ServiceError:
|
16
|
+
#
|
17
|
+
# begin
|
18
|
+
# # do stuff
|
19
|
+
# rescue Aws::SSMIncidents::Errors::ServiceError
|
20
|
+
# # rescues all SSMIncidents API errors
|
21
|
+
# end
|
22
|
+
#
|
23
|
+
#
|
24
|
+
# ## Request Context
|
25
|
+
# ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
|
26
|
+
# information about the request that generated the error.
|
27
|
+
# See {Seahorse::Client::RequestContext} for more information.
|
28
|
+
#
|
29
|
+
# ## Error Classes
|
30
|
+
# * {AccessDeniedException}
|
31
|
+
# * {ConflictException}
|
32
|
+
# * {InternalServerException}
|
33
|
+
# * {ResourceNotFoundException}
|
34
|
+
# * {ServiceQuotaExceededException}
|
35
|
+
# * {ThrottlingException}
|
36
|
+
# * {ValidationException}
|
37
|
+
#
|
38
|
+
# Additionally, error classes are dynamically generated for service errors based on the error code
|
39
|
+
# if they are not defined above.
|
40
|
+
module Errors
|
41
|
+
|
42
|
+
extend Aws::Errors::DynamicErrors
|
43
|
+
|
44
|
+
class AccessDeniedException < ServiceError
|
45
|
+
|
46
|
+
# @param [Seahorse::Client::RequestContext] context
|
47
|
+
# @param [String] message
|
48
|
+
# @param [Aws::SSMIncidents::Types::AccessDeniedException] data
|
49
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
50
|
+
super(context, message, data)
|
51
|
+
end
|
52
|
+
|
53
|
+
# @return [String]
|
54
|
+
def message
|
55
|
+
@message || @data[:message]
|
56
|
+
end
|
57
|
+
end
|
58
|
+
|
59
|
+
class ConflictException < ServiceError
|
60
|
+
|
61
|
+
# @param [Seahorse::Client::RequestContext] context
|
62
|
+
# @param [String] message
|
63
|
+
# @param [Aws::SSMIncidents::Types::ConflictException] data
|
64
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
65
|
+
super(context, message, data)
|
66
|
+
end
|
67
|
+
|
68
|
+
# @return [String]
|
69
|
+
def message
|
70
|
+
@message || @data[:message]
|
71
|
+
end
|
72
|
+
|
73
|
+
# @return [String]
|
74
|
+
def resource_identifier
|
75
|
+
@data[:resource_identifier]
|
76
|
+
end
|
77
|
+
|
78
|
+
# @return [String]
|
79
|
+
def resource_type
|
80
|
+
@data[:resource_type]
|
81
|
+
end
|
82
|
+
end
|
83
|
+
|
84
|
+
class InternalServerException < ServiceError
|
85
|
+
|
86
|
+
# @param [Seahorse::Client::RequestContext] context
|
87
|
+
# @param [String] message
|
88
|
+
# @param [Aws::SSMIncidents::Types::InternalServerException] data
|
89
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
90
|
+
super(context, message, data)
|
91
|
+
end
|
92
|
+
|
93
|
+
# @return [String]
|
94
|
+
def message
|
95
|
+
@message || @data[:message]
|
96
|
+
end
|
97
|
+
end
|
98
|
+
|
99
|
+
class ResourceNotFoundException < ServiceError
|
100
|
+
|
101
|
+
# @param [Seahorse::Client::RequestContext] context
|
102
|
+
# @param [String] message
|
103
|
+
# @param [Aws::SSMIncidents::Types::ResourceNotFoundException] data
|
104
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
105
|
+
super(context, message, data)
|
106
|
+
end
|
107
|
+
|
108
|
+
# @return [String]
|
109
|
+
def message
|
110
|
+
@message || @data[:message]
|
111
|
+
end
|
112
|
+
|
113
|
+
# @return [String]
|
114
|
+
def resource_identifier
|
115
|
+
@data[:resource_identifier]
|
116
|
+
end
|
117
|
+
|
118
|
+
# @return [String]
|
119
|
+
def resource_type
|
120
|
+
@data[:resource_type]
|
121
|
+
end
|
122
|
+
end
|
123
|
+
|
124
|
+
class ServiceQuotaExceededException < ServiceError
|
125
|
+
|
126
|
+
# @param [Seahorse::Client::RequestContext] context
|
127
|
+
# @param [String] message
|
128
|
+
# @param [Aws::SSMIncidents::Types::ServiceQuotaExceededException] data
|
129
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
130
|
+
super(context, message, data)
|
131
|
+
end
|
132
|
+
|
133
|
+
# @return [String]
|
134
|
+
def message
|
135
|
+
@message || @data[:message]
|
136
|
+
end
|
137
|
+
|
138
|
+
# @return [String]
|
139
|
+
def quota_code
|
140
|
+
@data[:quota_code]
|
141
|
+
end
|
142
|
+
|
143
|
+
# @return [String]
|
144
|
+
def resource_identifier
|
145
|
+
@data[:resource_identifier]
|
146
|
+
end
|
147
|
+
|
148
|
+
# @return [String]
|
149
|
+
def resource_type
|
150
|
+
@data[:resource_type]
|
151
|
+
end
|
152
|
+
|
153
|
+
# @return [String]
|
154
|
+
def service_code
|
155
|
+
@data[:service_code]
|
156
|
+
end
|
157
|
+
end
|
158
|
+
|
159
|
+
class ThrottlingException < ServiceError
|
160
|
+
|
161
|
+
# @param [Seahorse::Client::RequestContext] context
|
162
|
+
# @param [String] message
|
163
|
+
# @param [Aws::SSMIncidents::Types::ThrottlingException] data
|
164
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
165
|
+
super(context, message, data)
|
166
|
+
end
|
167
|
+
|
168
|
+
# @return [String]
|
169
|
+
def message
|
170
|
+
@message || @data[:message]
|
171
|
+
end
|
172
|
+
|
173
|
+
# @return [String]
|
174
|
+
def quota_code
|
175
|
+
@data[:quota_code]
|
176
|
+
end
|
177
|
+
|
178
|
+
# @return [String]
|
179
|
+
def service_code
|
180
|
+
@data[:service_code]
|
181
|
+
end
|
182
|
+
end
|
183
|
+
|
184
|
+
class ValidationException < ServiceError
|
185
|
+
|
186
|
+
# @param [Seahorse::Client::RequestContext] context
|
187
|
+
# @param [String] message
|
188
|
+
# @param [Aws::SSMIncidents::Types::ValidationException] data
|
189
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
190
|
+
super(context, message, data)
|
191
|
+
end
|
192
|
+
|
193
|
+
# @return [String]
|
194
|
+
def message
|
195
|
+
@message || @data[:message]
|
196
|
+
end
|
197
|
+
end
|
198
|
+
|
199
|
+
end
|
200
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::SSMIncidents
|
11
|
+
|
12
|
+
class Resource
|
13
|
+
|
14
|
+
# @param options ({})
|
15
|
+
# @option options [Client] :client
|
16
|
+
def initialize(options = {})
|
17
|
+
@client = options[:client] || Client.new(options)
|
18
|
+
end
|
19
|
+
|
20
|
+
# @return [Client]
|
21
|
+
def client
|
22
|
+
@client
|
23
|
+
end
|
24
|
+
|
25
|
+
end
|
26
|
+
end
|
@@ -0,0 +1,2671 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::SSMIncidents
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# You don't have sufficient access to perform this action.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] message
|
16
|
+
# @return [String]
|
17
|
+
#
|
18
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/AccessDeniedException AWS API Documentation
|
19
|
+
#
|
20
|
+
class AccessDeniedException < Struct.new(
|
21
|
+
:message)
|
22
|
+
SENSITIVE = []
|
23
|
+
include Aws::Structure
|
24
|
+
end
|
25
|
+
|
26
|
+
# The action that starts at the beginning of an incident. The response
|
27
|
+
# plan defines the action.
|
28
|
+
#
|
29
|
+
# @note When making an API call, you may pass Action
|
30
|
+
# data as a hash:
|
31
|
+
#
|
32
|
+
# {
|
33
|
+
# ssm_automation: {
|
34
|
+
# document_name: "SsmAutomationDocumentNameString", # required
|
35
|
+
# document_version: "SsmAutomationDocumentVersionString",
|
36
|
+
# parameters: {
|
37
|
+
# "SsmParametersKeyString" => ["SsmParameterValuesMemberString"],
|
38
|
+
# },
|
39
|
+
# role_arn: "RoleArn", # required
|
40
|
+
# target_account: "RESPONSE_PLAN_OWNER_ACCOUNT", # accepts RESPONSE_PLAN_OWNER_ACCOUNT, IMPACTED_ACCOUNT
|
41
|
+
# },
|
42
|
+
# }
|
43
|
+
#
|
44
|
+
# @!attribute [rw] ssm_automation
|
45
|
+
# The Systems Manager automation document to start as the runbook at
|
46
|
+
# the beginning of the incident.
|
47
|
+
# @return [Types::SsmAutomation]
|
48
|
+
#
|
49
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/Action AWS API Documentation
|
50
|
+
#
|
51
|
+
class Action < Struct.new(
|
52
|
+
:ssm_automation)
|
53
|
+
SENSITIVE = []
|
54
|
+
include Aws::Structure
|
55
|
+
end
|
56
|
+
|
57
|
+
# Defines the Region and KMS key to add to the replication set.
|
58
|
+
#
|
59
|
+
# @note When making an API call, you may pass AddRegionAction
|
60
|
+
# data as a hash:
|
61
|
+
#
|
62
|
+
# {
|
63
|
+
# region_name: "RegionName", # required
|
64
|
+
# sse_kms_key_id: "SseKmsKey",
|
65
|
+
# }
|
66
|
+
#
|
67
|
+
# @!attribute [rw] region_name
|
68
|
+
# The Region name to add to the replication set.
|
69
|
+
# @return [String]
|
70
|
+
#
|
71
|
+
# @!attribute [rw] sse_kms_key_id
|
72
|
+
# The KMS key ID to use to encrypt your replication set.
|
73
|
+
# @return [String]
|
74
|
+
#
|
75
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/AddRegionAction AWS API Documentation
|
76
|
+
#
|
77
|
+
class AddRegionAction < Struct.new(
|
78
|
+
:region_name,
|
79
|
+
:sse_kms_key_id)
|
80
|
+
SENSITIVE = []
|
81
|
+
include Aws::Structure
|
82
|
+
end
|
83
|
+
|
84
|
+
# Use the AttributeValueList to filter by string or integer values.
|
85
|
+
#
|
86
|
+
# @note When making an API call, you may pass AttributeValueList
|
87
|
+
# data as a hash:
|
88
|
+
#
|
89
|
+
# {
|
90
|
+
# integer_values: [1],
|
91
|
+
# string_values: ["StringListMemberString"],
|
92
|
+
# }
|
93
|
+
#
|
94
|
+
# @!attribute [rw] integer_values
|
95
|
+
# The list of integer values that the filter matches.
|
96
|
+
# @return [Array<Integer>]
|
97
|
+
#
|
98
|
+
# @!attribute [rw] string_values
|
99
|
+
# The list of string values that the filter matches.
|
100
|
+
# @return [Array<String>]
|
101
|
+
#
|
102
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/AttributeValueList AWS API Documentation
|
103
|
+
#
|
104
|
+
class AttributeValueList < Struct.new(
|
105
|
+
:integer_values,
|
106
|
+
:string_values)
|
107
|
+
SENSITIVE = []
|
108
|
+
include Aws::Structure
|
109
|
+
end
|
110
|
+
|
111
|
+
# The Systems Manager automation document process to start as the
|
112
|
+
# runbook at the beginning of the incident.
|
113
|
+
#
|
114
|
+
# @!attribute [rw] ssm_execution_arn
|
115
|
+
# The Amazon Resource Name (ARN) of the automation process.
|
116
|
+
# @return [String]
|
117
|
+
#
|
118
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/AutomationExecution AWS API Documentation
|
119
|
+
#
|
120
|
+
class AutomationExecution < Struct.new(
|
121
|
+
:ssm_execution_arn)
|
122
|
+
SENSITIVE = []
|
123
|
+
include Aws::Structure
|
124
|
+
end
|
125
|
+
|
126
|
+
# The AWS Chatbot chat channel used for collaboration during an
|
127
|
+
# incident.
|
128
|
+
#
|
129
|
+
# @note When making an API call, you may pass ChatChannel
|
130
|
+
# data as a hash:
|
131
|
+
#
|
132
|
+
# {
|
133
|
+
# chatbot_sns: ["SnsArn"],
|
134
|
+
# empty: {
|
135
|
+
# },
|
136
|
+
# }
|
137
|
+
#
|
138
|
+
# @!attribute [rw] chatbot_sns
|
139
|
+
# The SNS targets that AWS Chatbot uses to notify the chat channel of
|
140
|
+
# updates to an incident. You can also make updates to the incident
|
141
|
+
# through the chat channel by using the SNS topics.
|
142
|
+
# @return [Array<String>]
|
143
|
+
#
|
144
|
+
# @!attribute [rw] empty
|
145
|
+
# Used to remove the chat channel from an incident record or response
|
146
|
+
# plan.
|
147
|
+
# @return [Types::EmptyChatChannel]
|
148
|
+
#
|
149
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ChatChannel AWS API Documentation
|
150
|
+
#
|
151
|
+
class ChatChannel < Struct.new(
|
152
|
+
:chatbot_sns,
|
153
|
+
:empty)
|
154
|
+
SENSITIVE = []
|
155
|
+
include Aws::Structure
|
156
|
+
end
|
157
|
+
|
158
|
+
# A conditional statement with which to compare a value, after a
|
159
|
+
# timestamp, before a timestamp, or equal to a string or integer. If
|
160
|
+
# multiple conditions are specified, the conditionals become an `AND`ed
|
161
|
+
# statement. If multiple values are specified for a conditional, the
|
162
|
+
# values are `OR`d.
|
163
|
+
#
|
164
|
+
# @note When making an API call, you may pass Condition
|
165
|
+
# data as a hash:
|
166
|
+
#
|
167
|
+
# {
|
168
|
+
# after: Time.now,
|
169
|
+
# before: Time.now,
|
170
|
+
# equals: {
|
171
|
+
# integer_values: [1],
|
172
|
+
# string_values: ["StringListMemberString"],
|
173
|
+
# },
|
174
|
+
# }
|
175
|
+
#
|
176
|
+
# @!attribute [rw] after
|
177
|
+
# After the specified timestamp.
|
178
|
+
# @return [Time]
|
179
|
+
#
|
180
|
+
# @!attribute [rw] before
|
181
|
+
# Before the specified timestamp
|
182
|
+
# @return [Time]
|
183
|
+
#
|
184
|
+
# @!attribute [rw] equals
|
185
|
+
# The value is equal to the provided string or integer.
|
186
|
+
# @return [Types::AttributeValueList]
|
187
|
+
#
|
188
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/Condition AWS API Documentation
|
189
|
+
#
|
190
|
+
class Condition < Struct.new(
|
191
|
+
:after,
|
192
|
+
:before,
|
193
|
+
:equals)
|
194
|
+
SENSITIVE = []
|
195
|
+
include Aws::Structure
|
196
|
+
end
|
197
|
+
|
198
|
+
# Updating or deleting a resource causes an inconsistent state.
|
199
|
+
#
|
200
|
+
# @!attribute [rw] message
|
201
|
+
# @return [String]
|
202
|
+
#
|
203
|
+
# @!attribute [rw] resource_identifier
|
204
|
+
# The identifier of the requested resource
|
205
|
+
# @return [String]
|
206
|
+
#
|
207
|
+
# @!attribute [rw] resource_type
|
208
|
+
# The resource type
|
209
|
+
# @return [String]
|
210
|
+
#
|
211
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ConflictException AWS API Documentation
|
212
|
+
#
|
213
|
+
class ConflictException < Struct.new(
|
214
|
+
:message,
|
215
|
+
:resource_identifier,
|
216
|
+
:resource_type)
|
217
|
+
SENSITIVE = []
|
218
|
+
include Aws::Structure
|
219
|
+
end
|
220
|
+
|
221
|
+
# @note When making an API call, you may pass CreateReplicationSetInput
|
222
|
+
# data as a hash:
|
223
|
+
#
|
224
|
+
# {
|
225
|
+
# client_token: "ClientToken",
|
226
|
+
# regions: { # required
|
227
|
+
# "RegionName" => {
|
228
|
+
# sse_kms_key_id: "SseKmsKey",
|
229
|
+
# },
|
230
|
+
# },
|
231
|
+
# }
|
232
|
+
#
|
233
|
+
# @!attribute [rw] client_token
|
234
|
+
# A token ensuring that the action is called only once with the
|
235
|
+
# specified details.
|
236
|
+
#
|
237
|
+
# **A suitable default value is auto-generated.** You should normally
|
238
|
+
# not need to pass this option.
|
239
|
+
# @return [String]
|
240
|
+
#
|
241
|
+
# @!attribute [rw] regions
|
242
|
+
# The Regions that Incident Manager replicates your data to. You can
|
243
|
+
# have up to three Regions in your replication set.
|
244
|
+
# @return [Hash<String,Types::RegionMapInputValue>]
|
245
|
+
#
|
246
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/CreateReplicationSetInput AWS API Documentation
|
247
|
+
#
|
248
|
+
class CreateReplicationSetInput < Struct.new(
|
249
|
+
:client_token,
|
250
|
+
:regions)
|
251
|
+
SENSITIVE = []
|
252
|
+
include Aws::Structure
|
253
|
+
end
|
254
|
+
|
255
|
+
# @!attribute [rw] arn
|
256
|
+
# The Amazon Resource Name (ARN) of the replication set.
|
257
|
+
# @return [String]
|
258
|
+
#
|
259
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/CreateReplicationSetOutput AWS API Documentation
|
260
|
+
#
|
261
|
+
class CreateReplicationSetOutput < Struct.new(
|
262
|
+
:arn)
|
263
|
+
SENSITIVE = []
|
264
|
+
include Aws::Structure
|
265
|
+
end
|
266
|
+
|
267
|
+
# @note When making an API call, you may pass CreateResponsePlanInput
|
268
|
+
# data as a hash:
|
269
|
+
#
|
270
|
+
# {
|
271
|
+
# actions: [
|
272
|
+
# {
|
273
|
+
# ssm_automation: {
|
274
|
+
# document_name: "SsmAutomationDocumentNameString", # required
|
275
|
+
# document_version: "SsmAutomationDocumentVersionString",
|
276
|
+
# parameters: {
|
277
|
+
# "SsmParametersKeyString" => ["SsmParameterValuesMemberString"],
|
278
|
+
# },
|
279
|
+
# role_arn: "RoleArn", # required
|
280
|
+
# target_account: "RESPONSE_PLAN_OWNER_ACCOUNT", # accepts RESPONSE_PLAN_OWNER_ACCOUNT, IMPACTED_ACCOUNT
|
281
|
+
# },
|
282
|
+
# },
|
283
|
+
# ],
|
284
|
+
# chat_channel: {
|
285
|
+
# chatbot_sns: ["SnsArn"],
|
286
|
+
# empty: {
|
287
|
+
# },
|
288
|
+
# },
|
289
|
+
# client_token: "ClientToken",
|
290
|
+
# display_name: "ResponsePlanDisplayName",
|
291
|
+
# engagements: ["SsmContactsArn"],
|
292
|
+
# incident_template: { # required
|
293
|
+
# dedupe_string: "DedupeString",
|
294
|
+
# impact: 1, # required
|
295
|
+
# notification_targets: [
|
296
|
+
# {
|
297
|
+
# sns_topic_arn: "Arn",
|
298
|
+
# },
|
299
|
+
# ],
|
300
|
+
# summary: "IncidentSummary",
|
301
|
+
# title: "IncidentTitle", # required
|
302
|
+
# },
|
303
|
+
# name: "ResponsePlanName", # required
|
304
|
+
# tags: {
|
305
|
+
# "TagKey" => "TagValue",
|
306
|
+
# },
|
307
|
+
# }
|
308
|
+
#
|
309
|
+
# @!attribute [rw] actions
|
310
|
+
# The actions that the response plan starts at the beginning of an
|
311
|
+
# incident.
|
312
|
+
# @return [Array<Types::Action>]
|
313
|
+
#
|
314
|
+
# @!attribute [rw] chat_channel
|
315
|
+
# The AWS Chatbot chat channel used for collaboration during an
|
316
|
+
# incident.
|
317
|
+
# @return [Types::ChatChannel]
|
318
|
+
#
|
319
|
+
# @!attribute [rw] client_token
|
320
|
+
# A token ensuring that the action is called only once with the
|
321
|
+
# specified details.
|
322
|
+
#
|
323
|
+
# **A suitable default value is auto-generated.** You should normally
|
324
|
+
# not need to pass this option.
|
325
|
+
# @return [String]
|
326
|
+
#
|
327
|
+
# @!attribute [rw] display_name
|
328
|
+
# The long format of the response plan name. This field can contain
|
329
|
+
# spaces.
|
330
|
+
# @return [String]
|
331
|
+
#
|
332
|
+
# @!attribute [rw] engagements
|
333
|
+
# The contacts and escalation plans that the response plan engages
|
334
|
+
# during an incident.
|
335
|
+
# @return [Array<String>]
|
336
|
+
#
|
337
|
+
# @!attribute [rw] incident_template
|
338
|
+
# Details used to create an incident when using this response plan.
|
339
|
+
# @return [Types::IncidentTemplate]
|
340
|
+
#
|
341
|
+
# @!attribute [rw] name
|
342
|
+
# The short format name of the response plan. Can't include spaces.
|
343
|
+
# @return [String]
|
344
|
+
#
|
345
|
+
# @!attribute [rw] tags
|
346
|
+
# A list of tags that you are adding to the response plan.
|
347
|
+
# @return [Hash<String,String>]
|
348
|
+
#
|
349
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/CreateResponsePlanInput AWS API Documentation
|
350
|
+
#
|
351
|
+
class CreateResponsePlanInput < Struct.new(
|
352
|
+
:actions,
|
353
|
+
:chat_channel,
|
354
|
+
:client_token,
|
355
|
+
:display_name,
|
356
|
+
:engagements,
|
357
|
+
:incident_template,
|
358
|
+
:name,
|
359
|
+
:tags)
|
360
|
+
SENSITIVE = []
|
361
|
+
include Aws::Structure
|
362
|
+
end
|
363
|
+
|
364
|
+
# @!attribute [rw] arn
|
365
|
+
# The Amazon Resource Name (ARN) of the response plan.
|
366
|
+
# @return [String]
|
367
|
+
#
|
368
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/CreateResponsePlanOutput AWS API Documentation
|
369
|
+
#
|
370
|
+
class CreateResponsePlanOutput < Struct.new(
|
371
|
+
:arn)
|
372
|
+
SENSITIVE = []
|
373
|
+
include Aws::Structure
|
374
|
+
end
|
375
|
+
|
376
|
+
# @note When making an API call, you may pass CreateTimelineEventInput
|
377
|
+
# data as a hash:
|
378
|
+
#
|
379
|
+
# {
|
380
|
+
# client_token: "ClientToken", # required
|
381
|
+
# event_data: "EventData", # required
|
382
|
+
# event_time: Time.now, # required
|
383
|
+
# event_type: "TimelineEventType", # required
|
384
|
+
# incident_record_arn: "Arn", # required
|
385
|
+
# }
|
386
|
+
#
|
387
|
+
# @!attribute [rw] client_token
|
388
|
+
# A token ensuring that the action is called only once with the
|
389
|
+
# specified details.
|
390
|
+
#
|
391
|
+
# **A suitable default value is auto-generated.** You should normally
|
392
|
+
# not need to pass this option.
|
393
|
+
# @return [String]
|
394
|
+
#
|
395
|
+
# @!attribute [rw] event_data
|
396
|
+
# A short description of the event.
|
397
|
+
# @return [String]
|
398
|
+
#
|
399
|
+
# @!attribute [rw] event_time
|
400
|
+
# The time that the event occurred.
|
401
|
+
# @return [Time]
|
402
|
+
#
|
403
|
+
# @!attribute [rw] event_type
|
404
|
+
# The type of the event. You can create timeline events of type
|
405
|
+
# `Custom Event`.
|
406
|
+
# @return [String]
|
407
|
+
#
|
408
|
+
# @!attribute [rw] incident_record_arn
|
409
|
+
# The Amazon Resource Name (ARN) of the incident record you are adding
|
410
|
+
# the event to.
|
411
|
+
# @return [String]
|
412
|
+
#
|
413
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/CreateTimelineEventInput AWS API Documentation
|
414
|
+
#
|
415
|
+
class CreateTimelineEventInput < Struct.new(
|
416
|
+
:client_token,
|
417
|
+
:event_data,
|
418
|
+
:event_time,
|
419
|
+
:event_type,
|
420
|
+
:incident_record_arn)
|
421
|
+
SENSITIVE = []
|
422
|
+
include Aws::Structure
|
423
|
+
end
|
424
|
+
|
425
|
+
# @!attribute [rw] event_id
|
426
|
+
# The ID of the event for easy reference later.
|
427
|
+
# @return [String]
|
428
|
+
#
|
429
|
+
# @!attribute [rw] incident_record_arn
|
430
|
+
# The ARN of the incident record that you added the event to.
|
431
|
+
# @return [String]
|
432
|
+
#
|
433
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/CreateTimelineEventOutput AWS API Documentation
|
434
|
+
#
|
435
|
+
class CreateTimelineEventOutput < Struct.new(
|
436
|
+
:event_id,
|
437
|
+
:incident_record_arn)
|
438
|
+
SENSITIVE = []
|
439
|
+
include Aws::Structure
|
440
|
+
end
|
441
|
+
|
442
|
+
# @note When making an API call, you may pass DeleteIncidentRecordInput
|
443
|
+
# data as a hash:
|
444
|
+
#
|
445
|
+
# {
|
446
|
+
# arn: "Arn", # required
|
447
|
+
# }
|
448
|
+
#
|
449
|
+
# @!attribute [rw] arn
|
450
|
+
# The Amazon Resource Name (ARN) of the incident record you are
|
451
|
+
# deleting.
|
452
|
+
# @return [String]
|
453
|
+
#
|
454
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/DeleteIncidentRecordInput AWS API Documentation
|
455
|
+
#
|
456
|
+
class DeleteIncidentRecordInput < Struct.new(
|
457
|
+
:arn)
|
458
|
+
SENSITIVE = []
|
459
|
+
include Aws::Structure
|
460
|
+
end
|
461
|
+
|
462
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/DeleteIncidentRecordOutput AWS API Documentation
|
463
|
+
#
|
464
|
+
class DeleteIncidentRecordOutput < Aws::EmptyStructure; end
|
465
|
+
|
466
|
+
# Defines the information about the Region you're deleting from your
|
467
|
+
# replication set.
|
468
|
+
#
|
469
|
+
# @note When making an API call, you may pass DeleteRegionAction
|
470
|
+
# data as a hash:
|
471
|
+
#
|
472
|
+
# {
|
473
|
+
# region_name: "RegionName", # required
|
474
|
+
# }
|
475
|
+
#
|
476
|
+
# @!attribute [rw] region_name
|
477
|
+
# The name of the Region you're deleting from the replication set.
|
478
|
+
# @return [String]
|
479
|
+
#
|
480
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/DeleteRegionAction AWS API Documentation
|
481
|
+
#
|
482
|
+
class DeleteRegionAction < Struct.new(
|
483
|
+
:region_name)
|
484
|
+
SENSITIVE = []
|
485
|
+
include Aws::Structure
|
486
|
+
end
|
487
|
+
|
488
|
+
# @note When making an API call, you may pass DeleteReplicationSetInput
|
489
|
+
# data as a hash:
|
490
|
+
#
|
491
|
+
# {
|
492
|
+
# arn: "Arn", # required
|
493
|
+
# }
|
494
|
+
#
|
495
|
+
# @!attribute [rw] arn
|
496
|
+
# The Amazon Resource Name (ARN) of the replication set you're
|
497
|
+
# deleting.
|
498
|
+
# @return [String]
|
499
|
+
#
|
500
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/DeleteReplicationSetInput AWS API Documentation
|
501
|
+
#
|
502
|
+
class DeleteReplicationSetInput < Struct.new(
|
503
|
+
:arn)
|
504
|
+
SENSITIVE = []
|
505
|
+
include Aws::Structure
|
506
|
+
end
|
507
|
+
|
508
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/DeleteReplicationSetOutput AWS API Documentation
|
509
|
+
#
|
510
|
+
class DeleteReplicationSetOutput < Aws::EmptyStructure; end
|
511
|
+
|
512
|
+
# @note When making an API call, you may pass DeleteResourcePolicyInput
|
513
|
+
# data as a hash:
|
514
|
+
#
|
515
|
+
# {
|
516
|
+
# policy_id: "PolicyId", # required
|
517
|
+
# resource_arn: "Arn", # required
|
518
|
+
# }
|
519
|
+
#
|
520
|
+
# @!attribute [rw] policy_id
|
521
|
+
# The ID of the resource policy you're deleting.
|
522
|
+
# @return [String]
|
523
|
+
#
|
524
|
+
# @!attribute [rw] resource_arn
|
525
|
+
# The Amazon Resource Name (ARN) of the resource you're deleting the
|
526
|
+
# policy from.
|
527
|
+
# @return [String]
|
528
|
+
#
|
529
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/DeleteResourcePolicyInput AWS API Documentation
|
530
|
+
#
|
531
|
+
class DeleteResourcePolicyInput < Struct.new(
|
532
|
+
:policy_id,
|
533
|
+
:resource_arn)
|
534
|
+
SENSITIVE = []
|
535
|
+
include Aws::Structure
|
536
|
+
end
|
537
|
+
|
538
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/DeleteResourcePolicyOutput AWS API Documentation
|
539
|
+
#
|
540
|
+
class DeleteResourcePolicyOutput < Aws::EmptyStructure; end
|
541
|
+
|
542
|
+
# @note When making an API call, you may pass DeleteResponsePlanInput
|
543
|
+
# data as a hash:
|
544
|
+
#
|
545
|
+
# {
|
546
|
+
# arn: "Arn", # required
|
547
|
+
# }
|
548
|
+
#
|
549
|
+
# @!attribute [rw] arn
|
550
|
+
# The Amazon Resource Name (ARN) of the response plan.
|
551
|
+
# @return [String]
|
552
|
+
#
|
553
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/DeleteResponsePlanInput AWS API Documentation
|
554
|
+
#
|
555
|
+
class DeleteResponsePlanInput < Struct.new(
|
556
|
+
:arn)
|
557
|
+
SENSITIVE = []
|
558
|
+
include Aws::Structure
|
559
|
+
end
|
560
|
+
|
561
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/DeleteResponsePlanOutput AWS API Documentation
|
562
|
+
#
|
563
|
+
class DeleteResponsePlanOutput < Aws::EmptyStructure; end
|
564
|
+
|
565
|
+
# @note When making an API call, you may pass DeleteTimelineEventInput
|
566
|
+
# data as a hash:
|
567
|
+
#
|
568
|
+
# {
|
569
|
+
# event_id: "UUID", # required
|
570
|
+
# incident_record_arn: "Arn", # required
|
571
|
+
# }
|
572
|
+
#
|
573
|
+
# @!attribute [rw] event_id
|
574
|
+
# The ID of the event you are updating. You can find this by using
|
575
|
+
# `ListTimelineEvents`.
|
576
|
+
# @return [String]
|
577
|
+
#
|
578
|
+
# @!attribute [rw] incident_record_arn
|
579
|
+
# The Amazon Resource Name (ARN) of the incident that the event is
|
580
|
+
# part of.
|
581
|
+
# @return [String]
|
582
|
+
#
|
583
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/DeleteTimelineEventInput AWS API Documentation
|
584
|
+
#
|
585
|
+
class DeleteTimelineEventInput < Struct.new(
|
586
|
+
:event_id,
|
587
|
+
:incident_record_arn)
|
588
|
+
SENSITIVE = []
|
589
|
+
include Aws::Structure
|
590
|
+
end
|
591
|
+
|
592
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/DeleteTimelineEventOutput AWS API Documentation
|
593
|
+
#
|
594
|
+
class DeleteTimelineEventOutput < Aws::EmptyStructure; end
|
595
|
+
|
596
|
+
# Used to remove the chat channel from an incident record or response
|
597
|
+
# plan.
|
598
|
+
#
|
599
|
+
# @api private
|
600
|
+
#
|
601
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/EmptyChatChannel AWS API Documentation
|
602
|
+
#
|
603
|
+
class EmptyChatChannel < Aws::EmptyStructure; end
|
604
|
+
|
605
|
+
# Details about a timeline event during an incident.
|
606
|
+
#
|
607
|
+
# @!attribute [rw] event_id
|
608
|
+
# The timeline event ID.
|
609
|
+
# @return [String]
|
610
|
+
#
|
611
|
+
# @!attribute [rw] event_time
|
612
|
+
# The time that the event occurred.
|
613
|
+
# @return [Time]
|
614
|
+
#
|
615
|
+
# @!attribute [rw] event_type
|
616
|
+
# The type of event. The timeline event must be `Custom Event`.
|
617
|
+
# @return [String]
|
618
|
+
#
|
619
|
+
# @!attribute [rw] event_updated_time
|
620
|
+
# The time that the timeline event was last updated.
|
621
|
+
# @return [Time]
|
622
|
+
#
|
623
|
+
# @!attribute [rw] incident_record_arn
|
624
|
+
# The Amazon Resource Name (ARN) of the incident that the event
|
625
|
+
# happened during.
|
626
|
+
# @return [String]
|
627
|
+
#
|
628
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/EventSummary AWS API Documentation
|
629
|
+
#
|
630
|
+
class EventSummary < Struct.new(
|
631
|
+
:event_id,
|
632
|
+
:event_time,
|
633
|
+
:event_type,
|
634
|
+
:event_updated_time,
|
635
|
+
:incident_record_arn)
|
636
|
+
SENSITIVE = []
|
637
|
+
include Aws::Structure
|
638
|
+
end
|
639
|
+
|
640
|
+
# Filter the selection by using a condition.
|
641
|
+
#
|
642
|
+
# @note When making an API call, you may pass Filter
|
643
|
+
# data as a hash:
|
644
|
+
#
|
645
|
+
# {
|
646
|
+
# condition: { # required
|
647
|
+
# after: Time.now,
|
648
|
+
# before: Time.now,
|
649
|
+
# equals: {
|
650
|
+
# integer_values: [1],
|
651
|
+
# string_values: ["StringListMemberString"],
|
652
|
+
# },
|
653
|
+
# },
|
654
|
+
# key: "FilterKeyString", # required
|
655
|
+
# }
|
656
|
+
#
|
657
|
+
# @!attribute [rw] condition
|
658
|
+
# The condition accepts before or after a specified time, equal to a
|
659
|
+
# string, or equal to an integer.
|
660
|
+
# @return [Types::Condition]
|
661
|
+
#
|
662
|
+
# @!attribute [rw] key
|
663
|
+
# The key that you're filtering on.
|
664
|
+
# @return [String]
|
665
|
+
#
|
666
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/Filter AWS API Documentation
|
667
|
+
#
|
668
|
+
class Filter < Struct.new(
|
669
|
+
:condition,
|
670
|
+
:key)
|
671
|
+
SENSITIVE = []
|
672
|
+
include Aws::Structure
|
673
|
+
end
|
674
|
+
|
675
|
+
# @note When making an API call, you may pass GetIncidentRecordInput
|
676
|
+
# data as a hash:
|
677
|
+
#
|
678
|
+
# {
|
679
|
+
# arn: "Arn", # required
|
680
|
+
# }
|
681
|
+
#
|
682
|
+
# @!attribute [rw] arn
|
683
|
+
# The Amazon Resource Name (ARN) of the incident record.
|
684
|
+
# @return [String]
|
685
|
+
#
|
686
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/GetIncidentRecordInput AWS API Documentation
|
687
|
+
#
|
688
|
+
class GetIncidentRecordInput < Struct.new(
|
689
|
+
:arn)
|
690
|
+
SENSITIVE = []
|
691
|
+
include Aws::Structure
|
692
|
+
end
|
693
|
+
|
694
|
+
# @!attribute [rw] incident_record
|
695
|
+
# Details structure of the incident record.
|
696
|
+
# @return [Types::IncidentRecord]
|
697
|
+
#
|
698
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/GetIncidentRecordOutput AWS API Documentation
|
699
|
+
#
|
700
|
+
class GetIncidentRecordOutput < Struct.new(
|
701
|
+
:incident_record)
|
702
|
+
SENSITIVE = []
|
703
|
+
include Aws::Structure
|
704
|
+
end
|
705
|
+
|
706
|
+
# @note When making an API call, you may pass GetReplicationSetInput
|
707
|
+
# data as a hash:
|
708
|
+
#
|
709
|
+
# {
|
710
|
+
# arn: "Arn", # required
|
711
|
+
# }
|
712
|
+
#
|
713
|
+
# @!attribute [rw] arn
|
714
|
+
# The Amazon Resource Name (ARN) of the replication set you want to
|
715
|
+
# retrieve.
|
716
|
+
# @return [String]
|
717
|
+
#
|
718
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/GetReplicationSetInput AWS API Documentation
|
719
|
+
#
|
720
|
+
class GetReplicationSetInput < Struct.new(
|
721
|
+
:arn)
|
722
|
+
SENSITIVE = []
|
723
|
+
include Aws::Structure
|
724
|
+
end
|
725
|
+
|
726
|
+
# @!attribute [rw] replication_set
|
727
|
+
# Details of the replication set.
|
728
|
+
# @return [Types::ReplicationSet]
|
729
|
+
#
|
730
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/GetReplicationSetOutput AWS API Documentation
|
731
|
+
#
|
732
|
+
class GetReplicationSetOutput < Struct.new(
|
733
|
+
:replication_set)
|
734
|
+
SENSITIVE = []
|
735
|
+
include Aws::Structure
|
736
|
+
end
|
737
|
+
|
738
|
+
# @note When making an API call, you may pass GetResourcePoliciesInput
|
739
|
+
# data as a hash:
|
740
|
+
#
|
741
|
+
# {
|
742
|
+
# max_results: 1,
|
743
|
+
# next_token: "NextToken",
|
744
|
+
# resource_arn: "Arn", # required
|
745
|
+
# }
|
746
|
+
#
|
747
|
+
# @!attribute [rw] max_results
|
748
|
+
# The maximum number of resource policies to display per page of
|
749
|
+
# results.
|
750
|
+
# @return [Integer]
|
751
|
+
#
|
752
|
+
# @!attribute [rw] next_token
|
753
|
+
# The pagination token to continue to the next page of results.
|
754
|
+
# @return [String]
|
755
|
+
#
|
756
|
+
# @!attribute [rw] resource_arn
|
757
|
+
# The Amazon Resource Name (ARN) of the response plan with the
|
758
|
+
# attached resource policy.
|
759
|
+
# @return [String]
|
760
|
+
#
|
761
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/GetResourcePoliciesInput AWS API Documentation
|
762
|
+
#
|
763
|
+
class GetResourcePoliciesInput < Struct.new(
|
764
|
+
:max_results,
|
765
|
+
:next_token,
|
766
|
+
:resource_arn)
|
767
|
+
SENSITIVE = []
|
768
|
+
include Aws::Structure
|
769
|
+
end
|
770
|
+
|
771
|
+
# @!attribute [rw] next_token
|
772
|
+
# The pagination token to continue to the next page of results.
|
773
|
+
# @return [String]
|
774
|
+
#
|
775
|
+
# @!attribute [rw] resource_policies
|
776
|
+
# Details about the resource policy attached to the response plan.
|
777
|
+
# @return [Array<Types::ResourcePolicy>]
|
778
|
+
#
|
779
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/GetResourcePoliciesOutput AWS API Documentation
|
780
|
+
#
|
781
|
+
class GetResourcePoliciesOutput < Struct.new(
|
782
|
+
:next_token,
|
783
|
+
:resource_policies)
|
784
|
+
SENSITIVE = []
|
785
|
+
include Aws::Structure
|
786
|
+
end
|
787
|
+
|
788
|
+
# @note When making an API call, you may pass GetResponsePlanInput
|
789
|
+
# data as a hash:
|
790
|
+
#
|
791
|
+
# {
|
792
|
+
# arn: "Arn", # required
|
793
|
+
# }
|
794
|
+
#
|
795
|
+
# @!attribute [rw] arn
|
796
|
+
# The Amazon Resource Name (ARN) of the response plan.
|
797
|
+
# @return [String]
|
798
|
+
#
|
799
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/GetResponsePlanInput AWS API Documentation
|
800
|
+
#
|
801
|
+
class GetResponsePlanInput < Struct.new(
|
802
|
+
:arn)
|
803
|
+
SENSITIVE = []
|
804
|
+
include Aws::Structure
|
805
|
+
end
|
806
|
+
|
807
|
+
# @!attribute [rw] actions
|
808
|
+
# The actions that this response plan takes at the beginning of the
|
809
|
+
# incident.
|
810
|
+
# @return [Array<Types::Action>]
|
811
|
+
#
|
812
|
+
# @!attribute [rw] arn
|
813
|
+
# The ARN of the response plan.
|
814
|
+
# @return [String]
|
815
|
+
#
|
816
|
+
# @!attribute [rw] chat_channel
|
817
|
+
# The AWS Chatbot chat channel used for collaboration during an
|
818
|
+
# incident.
|
819
|
+
# @return [Types::ChatChannel]
|
820
|
+
#
|
821
|
+
# @!attribute [rw] display_name
|
822
|
+
# The long format name of the response plan. Can contain spaces.
|
823
|
+
# @return [String]
|
824
|
+
#
|
825
|
+
# @!attribute [rw] engagements
|
826
|
+
# The contacts and escalation plans that the response plan engages
|
827
|
+
# during an incident.
|
828
|
+
# @return [Array<String>]
|
829
|
+
#
|
830
|
+
# @!attribute [rw] incident_template
|
831
|
+
# Details used to create the incident when using this response plan.
|
832
|
+
# @return [Types::IncidentTemplate]
|
833
|
+
#
|
834
|
+
# @!attribute [rw] name
|
835
|
+
# The short format name of the response plan. Can't contain spaces.
|
836
|
+
# @return [String]
|
837
|
+
#
|
838
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/GetResponsePlanOutput AWS API Documentation
|
839
|
+
#
|
840
|
+
class GetResponsePlanOutput < Struct.new(
|
841
|
+
:actions,
|
842
|
+
:arn,
|
843
|
+
:chat_channel,
|
844
|
+
:display_name,
|
845
|
+
:engagements,
|
846
|
+
:incident_template,
|
847
|
+
:name)
|
848
|
+
SENSITIVE = []
|
849
|
+
include Aws::Structure
|
850
|
+
end
|
851
|
+
|
852
|
+
# @note When making an API call, you may pass GetTimelineEventInput
|
853
|
+
# data as a hash:
|
854
|
+
#
|
855
|
+
# {
|
856
|
+
# event_id: "UUID", # required
|
857
|
+
# incident_record_arn: "Arn", # required
|
858
|
+
# }
|
859
|
+
#
|
860
|
+
# @!attribute [rw] event_id
|
861
|
+
# The ID of the event. You can get an event's ID when you create it
|
862
|
+
# or by using `ListTimelineEvents`.
|
863
|
+
# @return [String]
|
864
|
+
#
|
865
|
+
# @!attribute [rw] incident_record_arn
|
866
|
+
# The Amazon Resource Name (ARN) of the incident that the timeline
|
867
|
+
# event is part of.
|
868
|
+
# @return [String]
|
869
|
+
#
|
870
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/GetTimelineEventInput AWS API Documentation
|
871
|
+
#
|
872
|
+
class GetTimelineEventInput < Struct.new(
|
873
|
+
:event_id,
|
874
|
+
:incident_record_arn)
|
875
|
+
SENSITIVE = []
|
876
|
+
include Aws::Structure
|
877
|
+
end
|
878
|
+
|
879
|
+
# @!attribute [rw] event
|
880
|
+
# Details about the timeline event.
|
881
|
+
# @return [Types::TimelineEvent]
|
882
|
+
#
|
883
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/GetTimelineEventOutput AWS API Documentation
|
884
|
+
#
|
885
|
+
class GetTimelineEventOutput < Struct.new(
|
886
|
+
:event)
|
887
|
+
SENSITIVE = []
|
888
|
+
include Aws::Structure
|
889
|
+
end
|
890
|
+
|
891
|
+
# The record of the incident that's created when an incident occurs.
|
892
|
+
#
|
893
|
+
# @!attribute [rw] arn
|
894
|
+
# The Amazon Resource Name (ARN) of the incident record.
|
895
|
+
# @return [String]
|
896
|
+
#
|
897
|
+
# @!attribute [rw] automation_executions
|
898
|
+
# The runbook, or automation document, that's run at the beginning of
|
899
|
+
# the incident.
|
900
|
+
# @return [Array<Types::AutomationExecution>]
|
901
|
+
#
|
902
|
+
# @!attribute [rw] chat_channel
|
903
|
+
# The chat channel used for collaboration during an incident.
|
904
|
+
# @return [Types::ChatChannel]
|
905
|
+
#
|
906
|
+
# @!attribute [rw] creation_time
|
907
|
+
# The time that Incident Manager created the incident record.
|
908
|
+
# @return [Time]
|
909
|
+
#
|
910
|
+
# @!attribute [rw] dedupe_string
|
911
|
+
# The string Incident Manager uses to prevent duplicate incidents from
|
912
|
+
# being created by the same incident.
|
913
|
+
# @return [String]
|
914
|
+
#
|
915
|
+
# @!attribute [rw] impact
|
916
|
+
# The impact of the incident on customers and applications.
|
917
|
+
# @return [Integer]
|
918
|
+
#
|
919
|
+
# @!attribute [rw] incident_record_source
|
920
|
+
# Details about the action that started the incident.
|
921
|
+
# @return [Types::IncidentRecordSource]
|
922
|
+
#
|
923
|
+
# @!attribute [rw] last_modified_by
|
924
|
+
# Who modified the incident most recently.
|
925
|
+
# @return [String]
|
926
|
+
#
|
927
|
+
# @!attribute [rw] last_modified_time
|
928
|
+
# The time at which the incident was most recently modified.
|
929
|
+
# @return [Time]
|
930
|
+
#
|
931
|
+
# @!attribute [rw] notification_targets
|
932
|
+
# The SNS targets that AWS Chatbot uses to notify the chat channels
|
933
|
+
# and perform actions on the incident record.
|
934
|
+
# @return [Array<Types::NotificationTargetItem>]
|
935
|
+
#
|
936
|
+
# @!attribute [rw] resolved_time
|
937
|
+
# The time at which the incident was resolved. This appears as a
|
938
|
+
# timeline event.
|
939
|
+
# @return [Time]
|
940
|
+
#
|
941
|
+
# @!attribute [rw] status
|
942
|
+
# The current status of the incident.
|
943
|
+
# @return [String]
|
944
|
+
#
|
945
|
+
# @!attribute [rw] summary
|
946
|
+
# The summary of the incident. The summary is a brief synopsis of what
|
947
|
+
# occurred, what is currently happening, and context.
|
948
|
+
# @return [String]
|
949
|
+
#
|
950
|
+
# @!attribute [rw] title
|
951
|
+
# The title of the incident.
|
952
|
+
# @return [String]
|
953
|
+
#
|
954
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/IncidentRecord AWS API Documentation
|
955
|
+
#
|
956
|
+
class IncidentRecord < Struct.new(
|
957
|
+
:arn,
|
958
|
+
:automation_executions,
|
959
|
+
:chat_channel,
|
960
|
+
:creation_time,
|
961
|
+
:dedupe_string,
|
962
|
+
:impact,
|
963
|
+
:incident_record_source,
|
964
|
+
:last_modified_by,
|
965
|
+
:last_modified_time,
|
966
|
+
:notification_targets,
|
967
|
+
:resolved_time,
|
968
|
+
:status,
|
969
|
+
:summary,
|
970
|
+
:title)
|
971
|
+
SENSITIVE = []
|
972
|
+
include Aws::Structure
|
973
|
+
end
|
974
|
+
|
975
|
+
# Details about how the incident record was created and when.
|
976
|
+
#
|
977
|
+
# @!attribute [rw] created_by
|
978
|
+
# The principal that started the incident.
|
979
|
+
# @return [String]
|
980
|
+
#
|
981
|
+
# @!attribute [rw] invoked_by
|
982
|
+
# The principal the assumed the role specified of the `createdBy`.
|
983
|
+
# @return [String]
|
984
|
+
#
|
985
|
+
# @!attribute [rw] resource_arn
|
986
|
+
# The resource that caused the incident to be created.
|
987
|
+
# @return [String]
|
988
|
+
#
|
989
|
+
# @!attribute [rw] source
|
990
|
+
# The service that started the incident. This can be manually created
|
991
|
+
# from Incident Manager, automatically created using an AWS CloudWatch
|
992
|
+
# alarm, or Amazon EventBridge event.
|
993
|
+
# @return [String]
|
994
|
+
#
|
995
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/IncidentRecordSource AWS API Documentation
|
996
|
+
#
|
997
|
+
class IncidentRecordSource < Struct.new(
|
998
|
+
:created_by,
|
999
|
+
:invoked_by,
|
1000
|
+
:resource_arn,
|
1001
|
+
:source)
|
1002
|
+
SENSITIVE = []
|
1003
|
+
include Aws::Structure
|
1004
|
+
end
|
1005
|
+
|
1006
|
+
# Details describing an incident record.
|
1007
|
+
#
|
1008
|
+
# @!attribute [rw] arn
|
1009
|
+
# The Amazon Resource Name (ARN) of the incident.
|
1010
|
+
# @return [String]
|
1011
|
+
#
|
1012
|
+
# @!attribute [rw] creation_time
|
1013
|
+
# The time the incident was created.
|
1014
|
+
# @return [Time]
|
1015
|
+
#
|
1016
|
+
# @!attribute [rw] impact
|
1017
|
+
# Defines the impact to customers and applications.
|
1018
|
+
# @return [Integer]
|
1019
|
+
#
|
1020
|
+
# @!attribute [rw] incident_record_source
|
1021
|
+
# What caused Incident Manager to create the incident.
|
1022
|
+
# @return [Types::IncidentRecordSource]
|
1023
|
+
#
|
1024
|
+
# @!attribute [rw] resolved_time
|
1025
|
+
# The time the incident was resolved.
|
1026
|
+
# @return [Time]
|
1027
|
+
#
|
1028
|
+
# @!attribute [rw] status
|
1029
|
+
# The current status of the incident.
|
1030
|
+
# @return [String]
|
1031
|
+
#
|
1032
|
+
# @!attribute [rw] title
|
1033
|
+
# The title of the incident. This value is either provided by the
|
1034
|
+
# response plan or overwritten on creation.
|
1035
|
+
# @return [String]
|
1036
|
+
#
|
1037
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/IncidentRecordSummary AWS API Documentation
|
1038
|
+
#
|
1039
|
+
class IncidentRecordSummary < Struct.new(
|
1040
|
+
:arn,
|
1041
|
+
:creation_time,
|
1042
|
+
:impact,
|
1043
|
+
:incident_record_source,
|
1044
|
+
:resolved_time,
|
1045
|
+
:status,
|
1046
|
+
:title)
|
1047
|
+
SENSITIVE = []
|
1048
|
+
include Aws::Structure
|
1049
|
+
end
|
1050
|
+
|
1051
|
+
# Basic details used in creating a response plan. The response plan is
|
1052
|
+
# then used to create an incident record.
|
1053
|
+
#
|
1054
|
+
# @note When making an API call, you may pass IncidentTemplate
|
1055
|
+
# data as a hash:
|
1056
|
+
#
|
1057
|
+
# {
|
1058
|
+
# dedupe_string: "DedupeString",
|
1059
|
+
# impact: 1, # required
|
1060
|
+
# notification_targets: [
|
1061
|
+
# {
|
1062
|
+
# sns_topic_arn: "Arn",
|
1063
|
+
# },
|
1064
|
+
# ],
|
1065
|
+
# summary: "IncidentSummary",
|
1066
|
+
# title: "IncidentTitle", # required
|
1067
|
+
# }
|
1068
|
+
#
|
1069
|
+
# @!attribute [rw] dedupe_string
|
1070
|
+
# Used to stop Incident Manager from creating multiple incident
|
1071
|
+
# records for the same incident.
|
1072
|
+
# @return [String]
|
1073
|
+
#
|
1074
|
+
# @!attribute [rw] impact
|
1075
|
+
# The impact of the incident on your customers and applications.
|
1076
|
+
# @return [Integer]
|
1077
|
+
#
|
1078
|
+
# @!attribute [rw] notification_targets
|
1079
|
+
# The SNS targets that AWS Chatbot uses to notify the chat channel of
|
1080
|
+
# updates to an incident. You can also make updates to the incident
|
1081
|
+
# through the chat channel using the SNS topics.
|
1082
|
+
# @return [Array<Types::NotificationTargetItem>]
|
1083
|
+
#
|
1084
|
+
# @!attribute [rw] summary
|
1085
|
+
# The summary of the incident. The summary is a brief synopsis of what
|
1086
|
+
# occurred, what's currently happening, and context.
|
1087
|
+
# @return [String]
|
1088
|
+
#
|
1089
|
+
# @!attribute [rw] title
|
1090
|
+
# The title of the incident.
|
1091
|
+
# @return [String]
|
1092
|
+
#
|
1093
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/IncidentTemplate AWS API Documentation
|
1094
|
+
#
|
1095
|
+
class IncidentTemplate < Struct.new(
|
1096
|
+
:dedupe_string,
|
1097
|
+
:impact,
|
1098
|
+
:notification_targets,
|
1099
|
+
:summary,
|
1100
|
+
:title)
|
1101
|
+
SENSITIVE = []
|
1102
|
+
include Aws::Structure
|
1103
|
+
end
|
1104
|
+
|
1105
|
+
# The request processing has failed because of an unknown error,
|
1106
|
+
# exception or failure.
|
1107
|
+
#
|
1108
|
+
# @!attribute [rw] message
|
1109
|
+
# @return [String]
|
1110
|
+
#
|
1111
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/InternalServerException AWS API Documentation
|
1112
|
+
#
|
1113
|
+
class InternalServerException < Struct.new(
|
1114
|
+
:message)
|
1115
|
+
SENSITIVE = []
|
1116
|
+
include Aws::Structure
|
1117
|
+
end
|
1118
|
+
|
1119
|
+
# Details and type of a related item.
|
1120
|
+
#
|
1121
|
+
# @note When making an API call, you may pass ItemIdentifier
|
1122
|
+
# data as a hash:
|
1123
|
+
#
|
1124
|
+
# {
|
1125
|
+
# type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER
|
1126
|
+
# value: { # required
|
1127
|
+
# arn: "Arn",
|
1128
|
+
# metric_definition: "MetricDefinition",
|
1129
|
+
# url: "Url",
|
1130
|
+
# },
|
1131
|
+
# }
|
1132
|
+
#
|
1133
|
+
# @!attribute [rw] type
|
1134
|
+
# The type of related item. Incident Manager supports the following
|
1135
|
+
# types:
|
1136
|
+
#
|
1137
|
+
# * `ANALYSIS`
|
1138
|
+
#
|
1139
|
+
# * `INCIDENT`
|
1140
|
+
#
|
1141
|
+
# * `METRIC`
|
1142
|
+
#
|
1143
|
+
# * `PARENT`
|
1144
|
+
#
|
1145
|
+
# * `ATTACHMENT`
|
1146
|
+
#
|
1147
|
+
# * `OTHER`
|
1148
|
+
# @return [String]
|
1149
|
+
#
|
1150
|
+
# @!attribute [rw] value
|
1151
|
+
# Details about the related item.
|
1152
|
+
# @return [Types::ItemValue]
|
1153
|
+
#
|
1154
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ItemIdentifier AWS API Documentation
|
1155
|
+
#
|
1156
|
+
class ItemIdentifier < Struct.new(
|
1157
|
+
:type,
|
1158
|
+
:value)
|
1159
|
+
SENSITIVE = []
|
1160
|
+
include Aws::Structure
|
1161
|
+
end
|
1162
|
+
|
1163
|
+
# Describes a related item.
|
1164
|
+
#
|
1165
|
+
# @note When making an API call, you may pass ItemValue
|
1166
|
+
# data as a hash:
|
1167
|
+
#
|
1168
|
+
# {
|
1169
|
+
# arn: "Arn",
|
1170
|
+
# metric_definition: "MetricDefinition",
|
1171
|
+
# url: "Url",
|
1172
|
+
# }
|
1173
|
+
#
|
1174
|
+
# @!attribute [rw] arn
|
1175
|
+
# The Amazon Resource Name (ARN) of the related item, if the related
|
1176
|
+
# item is an Amazon resource.
|
1177
|
+
# @return [String]
|
1178
|
+
#
|
1179
|
+
# @!attribute [rw] metric_definition
|
1180
|
+
# The metric definition, if the related item is a metric in
|
1181
|
+
# CloudWatch.
|
1182
|
+
# @return [String]
|
1183
|
+
#
|
1184
|
+
# @!attribute [rw] url
|
1185
|
+
# The URL, if the related item is a non-AWS resource.
|
1186
|
+
# @return [String]
|
1187
|
+
#
|
1188
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ItemValue AWS API Documentation
|
1189
|
+
#
|
1190
|
+
class ItemValue < Struct.new(
|
1191
|
+
:arn,
|
1192
|
+
:metric_definition,
|
1193
|
+
:url)
|
1194
|
+
SENSITIVE = []
|
1195
|
+
include Aws::Structure
|
1196
|
+
end
|
1197
|
+
|
1198
|
+
# @note When making an API call, you may pass ListIncidentRecordsInput
|
1199
|
+
# data as a hash:
|
1200
|
+
#
|
1201
|
+
# {
|
1202
|
+
# filters: [
|
1203
|
+
# {
|
1204
|
+
# condition: { # required
|
1205
|
+
# after: Time.now,
|
1206
|
+
# before: Time.now,
|
1207
|
+
# equals: {
|
1208
|
+
# integer_values: [1],
|
1209
|
+
# string_values: ["StringListMemberString"],
|
1210
|
+
# },
|
1211
|
+
# },
|
1212
|
+
# key: "FilterKeyString", # required
|
1213
|
+
# },
|
1214
|
+
# ],
|
1215
|
+
# max_results: 1,
|
1216
|
+
# next_token: "NextToken",
|
1217
|
+
# }
|
1218
|
+
#
|
1219
|
+
# @!attribute [rw] filters
|
1220
|
+
# Filter the list of incident records you are searching through. You
|
1221
|
+
# can filter on the following keys:
|
1222
|
+
#
|
1223
|
+
# * `creationTime`
|
1224
|
+
#
|
1225
|
+
# * `impact`
|
1226
|
+
#
|
1227
|
+
# * `status`
|
1228
|
+
#
|
1229
|
+
# * `createdBy`
|
1230
|
+
# @return [Array<Types::Filter>]
|
1231
|
+
#
|
1232
|
+
# @!attribute [rw] max_results
|
1233
|
+
# The maximum number of results per page.
|
1234
|
+
# @return [Integer]
|
1235
|
+
#
|
1236
|
+
# @!attribute [rw] next_token
|
1237
|
+
# The pagination token to continue to the next page of results.
|
1238
|
+
# @return [String]
|
1239
|
+
#
|
1240
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ListIncidentRecordsInput AWS API Documentation
|
1241
|
+
#
|
1242
|
+
class ListIncidentRecordsInput < Struct.new(
|
1243
|
+
:filters,
|
1244
|
+
:max_results,
|
1245
|
+
:next_token)
|
1246
|
+
SENSITIVE = []
|
1247
|
+
include Aws::Structure
|
1248
|
+
end
|
1249
|
+
|
1250
|
+
# @!attribute [rw] incident_record_summaries
|
1251
|
+
# The details of each listed incident record.
|
1252
|
+
# @return [Array<Types::IncidentRecordSummary>]
|
1253
|
+
#
|
1254
|
+
# @!attribute [rw] next_token
|
1255
|
+
# The pagination token to continue to the next page of results.
|
1256
|
+
# @return [String]
|
1257
|
+
#
|
1258
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ListIncidentRecordsOutput AWS API Documentation
|
1259
|
+
#
|
1260
|
+
class ListIncidentRecordsOutput < Struct.new(
|
1261
|
+
:incident_record_summaries,
|
1262
|
+
:next_token)
|
1263
|
+
SENSITIVE = []
|
1264
|
+
include Aws::Structure
|
1265
|
+
end
|
1266
|
+
|
1267
|
+
# @note When making an API call, you may pass ListRelatedItemsInput
|
1268
|
+
# data as a hash:
|
1269
|
+
#
|
1270
|
+
# {
|
1271
|
+
# incident_record_arn: "Arn", # required
|
1272
|
+
# max_results: 1,
|
1273
|
+
# next_token: "NextToken",
|
1274
|
+
# }
|
1275
|
+
#
|
1276
|
+
# @!attribute [rw] incident_record_arn
|
1277
|
+
# The Amazon Resource Name (ARN) of the incident record that you are
|
1278
|
+
# listing related items for.
|
1279
|
+
# @return [String]
|
1280
|
+
#
|
1281
|
+
# @!attribute [rw] max_results
|
1282
|
+
# The maximum number of related items per page.
|
1283
|
+
# @return [Integer]
|
1284
|
+
#
|
1285
|
+
# @!attribute [rw] next_token
|
1286
|
+
# The pagination token to continue to the next page of results.
|
1287
|
+
# @return [String]
|
1288
|
+
#
|
1289
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ListRelatedItemsInput AWS API Documentation
|
1290
|
+
#
|
1291
|
+
class ListRelatedItemsInput < Struct.new(
|
1292
|
+
:incident_record_arn,
|
1293
|
+
:max_results,
|
1294
|
+
:next_token)
|
1295
|
+
SENSITIVE = []
|
1296
|
+
include Aws::Structure
|
1297
|
+
end
|
1298
|
+
|
1299
|
+
# @!attribute [rw] next_token
|
1300
|
+
# The pagination token to continue to the next page of results.
|
1301
|
+
# @return [String]
|
1302
|
+
#
|
1303
|
+
# @!attribute [rw] related_items
|
1304
|
+
# Details about each related item.
|
1305
|
+
# @return [Array<Types::RelatedItem>]
|
1306
|
+
#
|
1307
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ListRelatedItemsOutput AWS API Documentation
|
1308
|
+
#
|
1309
|
+
class ListRelatedItemsOutput < Struct.new(
|
1310
|
+
:next_token,
|
1311
|
+
:related_items)
|
1312
|
+
SENSITIVE = []
|
1313
|
+
include Aws::Structure
|
1314
|
+
end
|
1315
|
+
|
1316
|
+
# @note When making an API call, you may pass ListReplicationSetsInput
|
1317
|
+
# data as a hash:
|
1318
|
+
#
|
1319
|
+
# {
|
1320
|
+
# max_results: 1,
|
1321
|
+
# next_token: "NextToken",
|
1322
|
+
# }
|
1323
|
+
#
|
1324
|
+
# @!attribute [rw] max_results
|
1325
|
+
# The maximum number of results per page.
|
1326
|
+
# @return [Integer]
|
1327
|
+
#
|
1328
|
+
# @!attribute [rw] next_token
|
1329
|
+
# The pagination token to continue to the next page of results.
|
1330
|
+
# @return [String]
|
1331
|
+
#
|
1332
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ListReplicationSetsInput AWS API Documentation
|
1333
|
+
#
|
1334
|
+
class ListReplicationSetsInput < Struct.new(
|
1335
|
+
:max_results,
|
1336
|
+
:next_token)
|
1337
|
+
SENSITIVE = []
|
1338
|
+
include Aws::Structure
|
1339
|
+
end
|
1340
|
+
|
1341
|
+
# @!attribute [rw] next_token
|
1342
|
+
# The pagination token to continue to the next page of results.
|
1343
|
+
# @return [String]
|
1344
|
+
#
|
1345
|
+
# @!attribute [rw] replication_set_arns
|
1346
|
+
# The Amazon Resource Name (ARN) of the list replication set.
|
1347
|
+
# @return [Array<String>]
|
1348
|
+
#
|
1349
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ListReplicationSetsOutput AWS API Documentation
|
1350
|
+
#
|
1351
|
+
class ListReplicationSetsOutput < Struct.new(
|
1352
|
+
:next_token,
|
1353
|
+
:replication_set_arns)
|
1354
|
+
SENSITIVE = []
|
1355
|
+
include Aws::Structure
|
1356
|
+
end
|
1357
|
+
|
1358
|
+
# @note When making an API call, you may pass ListResponsePlansInput
|
1359
|
+
# data as a hash:
|
1360
|
+
#
|
1361
|
+
# {
|
1362
|
+
# max_results: 1,
|
1363
|
+
# next_token: "NextToken",
|
1364
|
+
# }
|
1365
|
+
#
|
1366
|
+
# @!attribute [rw] max_results
|
1367
|
+
# The maximum number of response plans per page.
|
1368
|
+
# @return [Integer]
|
1369
|
+
#
|
1370
|
+
# @!attribute [rw] next_token
|
1371
|
+
# The pagination token to continue to the next page of results.
|
1372
|
+
# @return [String]
|
1373
|
+
#
|
1374
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ListResponsePlansInput AWS API Documentation
|
1375
|
+
#
|
1376
|
+
class ListResponsePlansInput < Struct.new(
|
1377
|
+
:max_results,
|
1378
|
+
:next_token)
|
1379
|
+
SENSITIVE = []
|
1380
|
+
include Aws::Structure
|
1381
|
+
end
|
1382
|
+
|
1383
|
+
# @!attribute [rw] next_token
|
1384
|
+
# The pagination token to continue to the next page of results.
|
1385
|
+
# @return [String]
|
1386
|
+
#
|
1387
|
+
# @!attribute [rw] response_plan_summaries
|
1388
|
+
# Details of each response plan.
|
1389
|
+
# @return [Array<Types::ResponsePlanSummary>]
|
1390
|
+
#
|
1391
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ListResponsePlansOutput AWS API Documentation
|
1392
|
+
#
|
1393
|
+
class ListResponsePlansOutput < Struct.new(
|
1394
|
+
:next_token,
|
1395
|
+
:response_plan_summaries)
|
1396
|
+
SENSITIVE = []
|
1397
|
+
include Aws::Structure
|
1398
|
+
end
|
1399
|
+
|
1400
|
+
# @note When making an API call, you may pass ListTagsForResourceRequest
|
1401
|
+
# data as a hash:
|
1402
|
+
#
|
1403
|
+
# {
|
1404
|
+
# resource_arn: "String", # required
|
1405
|
+
# }
|
1406
|
+
#
|
1407
|
+
# @!attribute [rw] resource_arn
|
1408
|
+
# The Amazon Resource Name (ARN) of the response plan.
|
1409
|
+
# @return [String]
|
1410
|
+
#
|
1411
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ListTagsForResourceRequest AWS API Documentation
|
1412
|
+
#
|
1413
|
+
class ListTagsForResourceRequest < Struct.new(
|
1414
|
+
:resource_arn)
|
1415
|
+
SENSITIVE = []
|
1416
|
+
include Aws::Structure
|
1417
|
+
end
|
1418
|
+
|
1419
|
+
# @!attribute [rw] tags
|
1420
|
+
# A list of tags for the response plan.
|
1421
|
+
# @return [Hash<String,String>]
|
1422
|
+
#
|
1423
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ListTagsForResourceResponse AWS API Documentation
|
1424
|
+
#
|
1425
|
+
class ListTagsForResourceResponse < Struct.new(
|
1426
|
+
:tags)
|
1427
|
+
SENSITIVE = []
|
1428
|
+
include Aws::Structure
|
1429
|
+
end
|
1430
|
+
|
1431
|
+
# @note When making an API call, you may pass ListTimelineEventsInput
|
1432
|
+
# data as a hash:
|
1433
|
+
#
|
1434
|
+
# {
|
1435
|
+
# filters: [
|
1436
|
+
# {
|
1437
|
+
# condition: { # required
|
1438
|
+
# after: Time.now,
|
1439
|
+
# before: Time.now,
|
1440
|
+
# equals: {
|
1441
|
+
# integer_values: [1],
|
1442
|
+
# string_values: ["StringListMemberString"],
|
1443
|
+
# },
|
1444
|
+
# },
|
1445
|
+
# key: "FilterKeyString", # required
|
1446
|
+
# },
|
1447
|
+
# ],
|
1448
|
+
# incident_record_arn: "Arn", # required
|
1449
|
+
# max_results: 1,
|
1450
|
+
# next_token: "NextToken",
|
1451
|
+
# sort_by: "EVENT_TIME", # accepts EVENT_TIME
|
1452
|
+
# sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
1453
|
+
# }
|
1454
|
+
#
|
1455
|
+
# @!attribute [rw] filters
|
1456
|
+
# Filters the timeline events based on the provided conditional
|
1457
|
+
# values. You can filter timeline events using the following keys:
|
1458
|
+
#
|
1459
|
+
# * `eventTime`
|
1460
|
+
#
|
1461
|
+
# * `eventType`
|
1462
|
+
# @return [Array<Types::Filter>]
|
1463
|
+
#
|
1464
|
+
# @!attribute [rw] incident_record_arn
|
1465
|
+
# The Amazon Resource Name (ARN) of the incident that the event is
|
1466
|
+
# part of.
|
1467
|
+
# @return [String]
|
1468
|
+
#
|
1469
|
+
# @!attribute [rw] max_results
|
1470
|
+
# The maximum number of results per page.
|
1471
|
+
# @return [Integer]
|
1472
|
+
#
|
1473
|
+
# @!attribute [rw] next_token
|
1474
|
+
# The pagination token to continue to the next page of results.
|
1475
|
+
# @return [String]
|
1476
|
+
#
|
1477
|
+
# @!attribute [rw] sort_by
|
1478
|
+
# Sort by the specified key value pair.
|
1479
|
+
# @return [String]
|
1480
|
+
#
|
1481
|
+
# @!attribute [rw] sort_order
|
1482
|
+
# Sorts the order of timeline events by the value specified in the
|
1483
|
+
# `sortBy` field.
|
1484
|
+
# @return [String]
|
1485
|
+
#
|
1486
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ListTimelineEventsInput AWS API Documentation
|
1487
|
+
#
|
1488
|
+
class ListTimelineEventsInput < Struct.new(
|
1489
|
+
:filters,
|
1490
|
+
:incident_record_arn,
|
1491
|
+
:max_results,
|
1492
|
+
:next_token,
|
1493
|
+
:sort_by,
|
1494
|
+
:sort_order)
|
1495
|
+
SENSITIVE = []
|
1496
|
+
include Aws::Structure
|
1497
|
+
end
|
1498
|
+
|
1499
|
+
# @!attribute [rw] event_summaries
|
1500
|
+
# Details about each event that occurred during the incident.
|
1501
|
+
# @return [Array<Types::EventSummary>]
|
1502
|
+
#
|
1503
|
+
# @!attribute [rw] next_token
|
1504
|
+
# The pagination token to continue to the next page of results.
|
1505
|
+
# @return [String]
|
1506
|
+
#
|
1507
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ListTimelineEventsOutput AWS API Documentation
|
1508
|
+
#
|
1509
|
+
class ListTimelineEventsOutput < Struct.new(
|
1510
|
+
:event_summaries,
|
1511
|
+
:next_token)
|
1512
|
+
SENSITIVE = []
|
1513
|
+
include Aws::Structure
|
1514
|
+
end
|
1515
|
+
|
1516
|
+
# The SNS topic that's used by AWS Chatbot to notify the incidents chat
|
1517
|
+
# channel.
|
1518
|
+
#
|
1519
|
+
# @note When making an API call, you may pass NotificationTargetItem
|
1520
|
+
# data as a hash:
|
1521
|
+
#
|
1522
|
+
# {
|
1523
|
+
# sns_topic_arn: "Arn",
|
1524
|
+
# }
|
1525
|
+
#
|
1526
|
+
# @!attribute [rw] sns_topic_arn
|
1527
|
+
# The Amazon Resource Name (ARN) of the SNS topic.
|
1528
|
+
# @return [String]
|
1529
|
+
#
|
1530
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/NotificationTargetItem AWS API Documentation
|
1531
|
+
#
|
1532
|
+
class NotificationTargetItem < Struct.new(
|
1533
|
+
:sns_topic_arn)
|
1534
|
+
SENSITIVE = []
|
1535
|
+
include Aws::Structure
|
1536
|
+
end
|
1537
|
+
|
1538
|
+
# @note When making an API call, you may pass PutResourcePolicyInput
|
1539
|
+
# data as a hash:
|
1540
|
+
#
|
1541
|
+
# {
|
1542
|
+
# policy: "Policy", # required
|
1543
|
+
# resource_arn: "Arn", # required
|
1544
|
+
# }
|
1545
|
+
#
|
1546
|
+
# @!attribute [rw] policy
|
1547
|
+
# Details of the resource policy.
|
1548
|
+
# @return [String]
|
1549
|
+
#
|
1550
|
+
# @!attribute [rw] resource_arn
|
1551
|
+
# The Amazon Resource Name (ARN) of the response plan you're adding
|
1552
|
+
# the resource policy to.
|
1553
|
+
# @return [String]
|
1554
|
+
#
|
1555
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/PutResourcePolicyInput AWS API Documentation
|
1556
|
+
#
|
1557
|
+
class PutResourcePolicyInput < Struct.new(
|
1558
|
+
:policy,
|
1559
|
+
:resource_arn)
|
1560
|
+
SENSITIVE = []
|
1561
|
+
include Aws::Structure
|
1562
|
+
end
|
1563
|
+
|
1564
|
+
# @!attribute [rw] policy_id
|
1565
|
+
# The ID of the resource policy.
|
1566
|
+
# @return [String]
|
1567
|
+
#
|
1568
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/PutResourcePolicyOutput AWS API Documentation
|
1569
|
+
#
|
1570
|
+
class PutResourcePolicyOutput < Struct.new(
|
1571
|
+
:policy_id)
|
1572
|
+
SENSITIVE = []
|
1573
|
+
include Aws::Structure
|
1574
|
+
end
|
1575
|
+
|
1576
|
+
# Information about a Region in your replication set.
|
1577
|
+
#
|
1578
|
+
# @!attribute [rw] sse_kms_key_id
|
1579
|
+
# The ID of the KMS key used to encrypt the data in this Region.
|
1580
|
+
# @return [String]
|
1581
|
+
#
|
1582
|
+
# @!attribute [rw] status
|
1583
|
+
# The status of the Region in the replication set.
|
1584
|
+
# @return [String]
|
1585
|
+
#
|
1586
|
+
# @!attribute [rw] status_message
|
1587
|
+
# Information displayed about the status of the Region.
|
1588
|
+
# @return [String]
|
1589
|
+
#
|
1590
|
+
# @!attribute [rw] status_update_date_time
|
1591
|
+
# The most recent date and time that the Region's status was updated.
|
1592
|
+
# @return [Time]
|
1593
|
+
#
|
1594
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/RegionInfo AWS API Documentation
|
1595
|
+
#
|
1596
|
+
class RegionInfo < Struct.new(
|
1597
|
+
:sse_kms_key_id,
|
1598
|
+
:status,
|
1599
|
+
:status_message,
|
1600
|
+
:status_update_date_time)
|
1601
|
+
SENSITIVE = []
|
1602
|
+
include Aws::Structure
|
1603
|
+
end
|
1604
|
+
|
1605
|
+
# The mapping between a Region and the key that's used to encrypt the
|
1606
|
+
# data.
|
1607
|
+
#
|
1608
|
+
# @note When making an API call, you may pass RegionMapInputValue
|
1609
|
+
# data as a hash:
|
1610
|
+
#
|
1611
|
+
# {
|
1612
|
+
# sse_kms_key_id: "SseKmsKey",
|
1613
|
+
# }
|
1614
|
+
#
|
1615
|
+
# @!attribute [rw] sse_kms_key_id
|
1616
|
+
# The KMS key used to encrypt the data in your replication set.
|
1617
|
+
# @return [String]
|
1618
|
+
#
|
1619
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/RegionMapInputValue AWS API Documentation
|
1620
|
+
#
|
1621
|
+
class RegionMapInputValue < Struct.new(
|
1622
|
+
:sse_kms_key_id)
|
1623
|
+
SENSITIVE = []
|
1624
|
+
include Aws::Structure
|
1625
|
+
end
|
1626
|
+
|
1627
|
+
# Resources that responders use to triage and mitigate the incident.
|
1628
|
+
#
|
1629
|
+
# @note When making an API call, you may pass RelatedItem
|
1630
|
+
# data as a hash:
|
1631
|
+
#
|
1632
|
+
# {
|
1633
|
+
# identifier: { # required
|
1634
|
+
# type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER
|
1635
|
+
# value: { # required
|
1636
|
+
# arn: "Arn",
|
1637
|
+
# metric_definition: "MetricDefinition",
|
1638
|
+
# url: "Url",
|
1639
|
+
# },
|
1640
|
+
# },
|
1641
|
+
# title: "RelatedItemTitleString",
|
1642
|
+
# }
|
1643
|
+
#
|
1644
|
+
# @!attribute [rw] identifier
|
1645
|
+
# Details about the related item.
|
1646
|
+
# @return [Types::ItemIdentifier]
|
1647
|
+
#
|
1648
|
+
# @!attribute [rw] title
|
1649
|
+
# The title of the related item.
|
1650
|
+
# @return [String]
|
1651
|
+
#
|
1652
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/RelatedItem AWS API Documentation
|
1653
|
+
#
|
1654
|
+
class RelatedItem < Struct.new(
|
1655
|
+
:identifier,
|
1656
|
+
:title)
|
1657
|
+
SENSITIVE = []
|
1658
|
+
include Aws::Structure
|
1659
|
+
end
|
1660
|
+
|
1661
|
+
# Details about the related item you're adding.
|
1662
|
+
#
|
1663
|
+
# @note When making an API call, you may pass RelatedItemsUpdate
|
1664
|
+
# data as a hash:
|
1665
|
+
#
|
1666
|
+
# {
|
1667
|
+
# item_to_add: {
|
1668
|
+
# identifier: { # required
|
1669
|
+
# type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER
|
1670
|
+
# value: { # required
|
1671
|
+
# arn: "Arn",
|
1672
|
+
# metric_definition: "MetricDefinition",
|
1673
|
+
# url: "Url",
|
1674
|
+
# },
|
1675
|
+
# },
|
1676
|
+
# title: "RelatedItemTitleString",
|
1677
|
+
# },
|
1678
|
+
# item_to_remove: {
|
1679
|
+
# type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER
|
1680
|
+
# value: { # required
|
1681
|
+
# arn: "Arn",
|
1682
|
+
# metric_definition: "MetricDefinition",
|
1683
|
+
# url: "Url",
|
1684
|
+
# },
|
1685
|
+
# },
|
1686
|
+
# }
|
1687
|
+
#
|
1688
|
+
# @!attribute [rw] item_to_add
|
1689
|
+
# Details about the related item you're adding.
|
1690
|
+
# @return [Types::RelatedItem]
|
1691
|
+
#
|
1692
|
+
# @!attribute [rw] item_to_remove
|
1693
|
+
# Details about the related item you're deleting.
|
1694
|
+
# @return [Types::ItemIdentifier]
|
1695
|
+
#
|
1696
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/RelatedItemsUpdate AWS API Documentation
|
1697
|
+
#
|
1698
|
+
class RelatedItemsUpdate < Struct.new(
|
1699
|
+
:item_to_add,
|
1700
|
+
:item_to_remove)
|
1701
|
+
SENSITIVE = []
|
1702
|
+
include Aws::Structure
|
1703
|
+
end
|
1704
|
+
|
1705
|
+
# The set of Regions that your Incident Manager data will be replicated
|
1706
|
+
# to and the KMS key used to encrypt the data.
|
1707
|
+
#
|
1708
|
+
# @!attribute [rw] created_by
|
1709
|
+
# Details about who created the replication set.
|
1710
|
+
# @return [String]
|
1711
|
+
#
|
1712
|
+
# @!attribute [rw] created_time
|
1713
|
+
# When the replication set was created.
|
1714
|
+
# @return [Time]
|
1715
|
+
#
|
1716
|
+
# @!attribute [rw] deletion_protected
|
1717
|
+
# Determines if the replication set deletion protection is enabled or
|
1718
|
+
# not. If deletion protection is enabled, you can't delete the last
|
1719
|
+
# Region in the replication set.
|
1720
|
+
# @return [Boolean]
|
1721
|
+
#
|
1722
|
+
# @!attribute [rw] last_modified_by
|
1723
|
+
# Who last modified the replication set.
|
1724
|
+
# @return [String]
|
1725
|
+
#
|
1726
|
+
# @!attribute [rw] last_modified_time
|
1727
|
+
# When the replication set was last updated.
|
1728
|
+
# @return [Time]
|
1729
|
+
#
|
1730
|
+
# @!attribute [rw] region_map
|
1731
|
+
# The map between each Region in your replication set and the KMS key
|
1732
|
+
# that is used to encrypt the data in that Region.
|
1733
|
+
# @return [Hash<String,Types::RegionInfo>]
|
1734
|
+
#
|
1735
|
+
# @!attribute [rw] status
|
1736
|
+
# The status of the replication set. If the replication set is still
|
1737
|
+
# pending, you can't use Incident Manager functionality.
|
1738
|
+
# @return [String]
|
1739
|
+
#
|
1740
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ReplicationSet AWS API Documentation
|
1741
|
+
#
|
1742
|
+
class ReplicationSet < Struct.new(
|
1743
|
+
:created_by,
|
1744
|
+
:created_time,
|
1745
|
+
:deletion_protected,
|
1746
|
+
:last_modified_by,
|
1747
|
+
:last_modified_time,
|
1748
|
+
:region_map,
|
1749
|
+
:status)
|
1750
|
+
SENSITIVE = []
|
1751
|
+
include Aws::Structure
|
1752
|
+
end
|
1753
|
+
|
1754
|
+
# Request references a resource which does not exist.
|
1755
|
+
#
|
1756
|
+
# @!attribute [rw] message
|
1757
|
+
# @return [String]
|
1758
|
+
#
|
1759
|
+
# @!attribute [rw] resource_identifier
|
1760
|
+
# The identifier for the requested resource
|
1761
|
+
# @return [String]
|
1762
|
+
#
|
1763
|
+
# @!attribute [rw] resource_type
|
1764
|
+
# The resource type
|
1765
|
+
# @return [String]
|
1766
|
+
#
|
1767
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ResourceNotFoundException AWS API Documentation
|
1768
|
+
#
|
1769
|
+
class ResourceNotFoundException < Struct.new(
|
1770
|
+
:message,
|
1771
|
+
:resource_identifier,
|
1772
|
+
:resource_type)
|
1773
|
+
SENSITIVE = []
|
1774
|
+
include Aws::Structure
|
1775
|
+
end
|
1776
|
+
|
1777
|
+
# The resource policy that allows Incident Manager to perform actions on
|
1778
|
+
# resources on your behalf.
|
1779
|
+
#
|
1780
|
+
# @!attribute [rw] policy_document
|
1781
|
+
# The JSON blob that describes the policy.
|
1782
|
+
# @return [String]
|
1783
|
+
#
|
1784
|
+
# @!attribute [rw] policy_id
|
1785
|
+
# The ID of the resource policy.
|
1786
|
+
# @return [String]
|
1787
|
+
#
|
1788
|
+
# @!attribute [rw] ram_resource_share_region
|
1789
|
+
# The Region that policy allows resources to be used in.
|
1790
|
+
# @return [String]
|
1791
|
+
#
|
1792
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ResourcePolicy AWS API Documentation
|
1793
|
+
#
|
1794
|
+
class ResourcePolicy < Struct.new(
|
1795
|
+
:policy_document,
|
1796
|
+
:policy_id,
|
1797
|
+
:ram_resource_share_region)
|
1798
|
+
SENSITIVE = []
|
1799
|
+
include Aws::Structure
|
1800
|
+
end
|
1801
|
+
|
1802
|
+
# Details of the response plan that are used when creating an incident.
|
1803
|
+
#
|
1804
|
+
# @!attribute [rw] arn
|
1805
|
+
# The Amazon Resource Name (ARN) of the response plan.
|
1806
|
+
# @return [String]
|
1807
|
+
#
|
1808
|
+
# @!attribute [rw] display_name
|
1809
|
+
# The human readable name of the response plan. This can include
|
1810
|
+
# spaces.
|
1811
|
+
# @return [String]
|
1812
|
+
#
|
1813
|
+
# @!attribute [rw] name
|
1814
|
+
# The name of the response plan. This can't include spaces.
|
1815
|
+
# @return [String]
|
1816
|
+
#
|
1817
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ResponsePlanSummary AWS API Documentation
|
1818
|
+
#
|
1819
|
+
class ResponsePlanSummary < Struct.new(
|
1820
|
+
:arn,
|
1821
|
+
:display_name,
|
1822
|
+
:name)
|
1823
|
+
SENSITIVE = []
|
1824
|
+
include Aws::Structure
|
1825
|
+
end
|
1826
|
+
|
1827
|
+
# Request would cause a service quota to be exceeded.
|
1828
|
+
#
|
1829
|
+
# @!attribute [rw] message
|
1830
|
+
# @return [String]
|
1831
|
+
#
|
1832
|
+
# @!attribute [rw] quota_code
|
1833
|
+
# Originating quota code
|
1834
|
+
# @return [String]
|
1835
|
+
#
|
1836
|
+
# @!attribute [rw] resource_identifier
|
1837
|
+
# The identifier for the requested resource
|
1838
|
+
# @return [String]
|
1839
|
+
#
|
1840
|
+
# @!attribute [rw] resource_type
|
1841
|
+
# The resource type
|
1842
|
+
# @return [String]
|
1843
|
+
#
|
1844
|
+
# @!attribute [rw] service_code
|
1845
|
+
# Originating service code
|
1846
|
+
# @return [String]
|
1847
|
+
#
|
1848
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ServiceQuotaExceededException AWS API Documentation
|
1849
|
+
#
|
1850
|
+
class ServiceQuotaExceededException < Struct.new(
|
1851
|
+
:message,
|
1852
|
+
:quota_code,
|
1853
|
+
:resource_identifier,
|
1854
|
+
:resource_type,
|
1855
|
+
:service_code)
|
1856
|
+
SENSITIVE = []
|
1857
|
+
include Aws::Structure
|
1858
|
+
end
|
1859
|
+
|
1860
|
+
# Details about the Systems Manager automation document that will be
|
1861
|
+
# used as a runbook during an incident.
|
1862
|
+
#
|
1863
|
+
# @note When making an API call, you may pass SsmAutomation
|
1864
|
+
# data as a hash:
|
1865
|
+
#
|
1866
|
+
# {
|
1867
|
+
# document_name: "SsmAutomationDocumentNameString", # required
|
1868
|
+
# document_version: "SsmAutomationDocumentVersionString",
|
1869
|
+
# parameters: {
|
1870
|
+
# "SsmParametersKeyString" => ["SsmParameterValuesMemberString"],
|
1871
|
+
# },
|
1872
|
+
# role_arn: "RoleArn", # required
|
1873
|
+
# target_account: "RESPONSE_PLAN_OWNER_ACCOUNT", # accepts RESPONSE_PLAN_OWNER_ACCOUNT, IMPACTED_ACCOUNT
|
1874
|
+
# }
|
1875
|
+
#
|
1876
|
+
# @!attribute [rw] document_name
|
1877
|
+
# The automation document's name.
|
1878
|
+
# @return [String]
|
1879
|
+
#
|
1880
|
+
# @!attribute [rw] document_version
|
1881
|
+
# The automation document's version to use when running.
|
1882
|
+
# @return [String]
|
1883
|
+
#
|
1884
|
+
# @!attribute [rw] parameters
|
1885
|
+
# The key-value pair parameters to use when running the automation
|
1886
|
+
# document.
|
1887
|
+
# @return [Hash<String,Array<String>>]
|
1888
|
+
#
|
1889
|
+
# @!attribute [rw] role_arn
|
1890
|
+
# The Amazon Resource Name (ARN) of the role that the automation
|
1891
|
+
# document will assume when running commands.
|
1892
|
+
# @return [String]
|
1893
|
+
#
|
1894
|
+
# @!attribute [rw] target_account
|
1895
|
+
# The account that the automation document will be run in. This can be
|
1896
|
+
# in either the management account or an application account.
|
1897
|
+
# @return [String]
|
1898
|
+
#
|
1899
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/SsmAutomation AWS API Documentation
|
1900
|
+
#
|
1901
|
+
class SsmAutomation < Struct.new(
|
1902
|
+
:document_name,
|
1903
|
+
:document_version,
|
1904
|
+
:parameters,
|
1905
|
+
:role_arn,
|
1906
|
+
:target_account)
|
1907
|
+
SENSITIVE = []
|
1908
|
+
include Aws::Structure
|
1909
|
+
end
|
1910
|
+
|
1911
|
+
# @note When making an API call, you may pass StartIncidentInput
|
1912
|
+
# data as a hash:
|
1913
|
+
#
|
1914
|
+
# {
|
1915
|
+
# client_token: "ClientToken",
|
1916
|
+
# impact: 1,
|
1917
|
+
# related_items: [
|
1918
|
+
# {
|
1919
|
+
# identifier: { # required
|
1920
|
+
# type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER
|
1921
|
+
# value: { # required
|
1922
|
+
# arn: "Arn",
|
1923
|
+
# metric_definition: "MetricDefinition",
|
1924
|
+
# url: "Url",
|
1925
|
+
# },
|
1926
|
+
# },
|
1927
|
+
# title: "RelatedItemTitleString",
|
1928
|
+
# },
|
1929
|
+
# ],
|
1930
|
+
# response_plan_arn: "Arn", # required
|
1931
|
+
# title: "IncidentTitle",
|
1932
|
+
# trigger_details: {
|
1933
|
+
# raw_data: "RawData",
|
1934
|
+
# source: "IncidentSource", # required
|
1935
|
+
# timestamp: Time.now, # required
|
1936
|
+
# trigger_arn: "Arn",
|
1937
|
+
# },
|
1938
|
+
# }
|
1939
|
+
#
|
1940
|
+
# @!attribute [rw] client_token
|
1941
|
+
# A token ensuring that the action is called only once with the
|
1942
|
+
# specified details.
|
1943
|
+
#
|
1944
|
+
# **A suitable default value is auto-generated.** You should normally
|
1945
|
+
# not need to pass this option.
|
1946
|
+
# @return [String]
|
1947
|
+
#
|
1948
|
+
# @!attribute [rw] impact
|
1949
|
+
# Defines the impact to the customers. Providing an impact overwrites
|
1950
|
+
# the impact provided by a response plan.
|
1951
|
+
#
|
1952
|
+
# **Possible impacts:**
|
1953
|
+
#
|
1954
|
+
# * `1` - Critical impact, this typically relates to full application
|
1955
|
+
# failure that impacts many to all customers.
|
1956
|
+
#
|
1957
|
+
# * `2` - High impact, partial application failure with impact to many
|
1958
|
+
# customers.
|
1959
|
+
#
|
1960
|
+
# * `3` - Medium impact, the application is providing reduced service
|
1961
|
+
# to customers.
|
1962
|
+
#
|
1963
|
+
# * `4` - Low impact, customer might aren't impacted by the problem
|
1964
|
+
# yet.
|
1965
|
+
#
|
1966
|
+
# * `5` - No impact, customers aren't currently impacted but urgent
|
1967
|
+
# action is needed to avoid impact.
|
1968
|
+
# @return [Integer]
|
1969
|
+
#
|
1970
|
+
# @!attribute [rw] related_items
|
1971
|
+
# Add related items to the incident for other responders to use.
|
1972
|
+
# Related items are AWS resources, external links, or files uploaded
|
1973
|
+
# to an S3 bucket.
|
1974
|
+
# @return [Array<Types::RelatedItem>]
|
1975
|
+
#
|
1976
|
+
# @!attribute [rw] response_plan_arn
|
1977
|
+
# The Amazon Resource Name (ARN) of the response plan that pre-defines
|
1978
|
+
# summary, chat channels, SNS topics, runbooks, title, and impact of
|
1979
|
+
# the incident.
|
1980
|
+
# @return [String]
|
1981
|
+
#
|
1982
|
+
# @!attribute [rw] title
|
1983
|
+
# Provide a title for the incident. Providing a title overwrites the
|
1984
|
+
# title provided by the response plan.
|
1985
|
+
# @return [String]
|
1986
|
+
#
|
1987
|
+
# @!attribute [rw] trigger_details
|
1988
|
+
# Details of what created the incident record in Incident Manager.
|
1989
|
+
# @return [Types::TriggerDetails]
|
1990
|
+
#
|
1991
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/StartIncidentInput AWS API Documentation
|
1992
|
+
#
|
1993
|
+
class StartIncidentInput < Struct.new(
|
1994
|
+
:client_token,
|
1995
|
+
:impact,
|
1996
|
+
:related_items,
|
1997
|
+
:response_plan_arn,
|
1998
|
+
:title,
|
1999
|
+
:trigger_details)
|
2000
|
+
SENSITIVE = []
|
2001
|
+
include Aws::Structure
|
2002
|
+
end
|
2003
|
+
|
2004
|
+
# @!attribute [rw] incident_record_arn
|
2005
|
+
# The ARN of the newly created incident record.
|
2006
|
+
# @return [String]
|
2007
|
+
#
|
2008
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/StartIncidentOutput AWS API Documentation
|
2009
|
+
#
|
2010
|
+
class StartIncidentOutput < Struct.new(
|
2011
|
+
:incident_record_arn)
|
2012
|
+
SENSITIVE = []
|
2013
|
+
include Aws::Structure
|
2014
|
+
end
|
2015
|
+
|
2016
|
+
# @note When making an API call, you may pass TagResourceRequest
|
2017
|
+
# data as a hash:
|
2018
|
+
#
|
2019
|
+
# {
|
2020
|
+
# resource_arn: "String", # required
|
2021
|
+
# tags: { # required
|
2022
|
+
# "TagKey" => "TagValue",
|
2023
|
+
# },
|
2024
|
+
# }
|
2025
|
+
#
|
2026
|
+
# @!attribute [rw] resource_arn
|
2027
|
+
# The Amazon Resource Name (ARN) of the response plan you're adding
|
2028
|
+
# the tags to.
|
2029
|
+
# @return [String]
|
2030
|
+
#
|
2031
|
+
# @!attribute [rw] tags
|
2032
|
+
# A list of tags that you are adding to the response plan.
|
2033
|
+
# @return [Hash<String,String>]
|
2034
|
+
#
|
2035
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/TagResourceRequest AWS API Documentation
|
2036
|
+
#
|
2037
|
+
class TagResourceRequest < Struct.new(
|
2038
|
+
:resource_arn,
|
2039
|
+
:tags)
|
2040
|
+
SENSITIVE = []
|
2041
|
+
include Aws::Structure
|
2042
|
+
end
|
2043
|
+
|
2044
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/TagResourceResponse AWS API Documentation
|
2045
|
+
#
|
2046
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
2047
|
+
|
2048
|
+
# The request was denied due to request throttling.
|
2049
|
+
#
|
2050
|
+
# @!attribute [rw] message
|
2051
|
+
# @return [String]
|
2052
|
+
#
|
2053
|
+
# @!attribute [rw] quota_code
|
2054
|
+
# Originating quota code
|
2055
|
+
# @return [String]
|
2056
|
+
#
|
2057
|
+
# @!attribute [rw] service_code
|
2058
|
+
# Originating service code
|
2059
|
+
# @return [String]
|
2060
|
+
#
|
2061
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ThrottlingException AWS API Documentation
|
2062
|
+
#
|
2063
|
+
class ThrottlingException < Struct.new(
|
2064
|
+
:message,
|
2065
|
+
:quota_code,
|
2066
|
+
:service_code)
|
2067
|
+
SENSITIVE = []
|
2068
|
+
include Aws::Structure
|
2069
|
+
end
|
2070
|
+
|
2071
|
+
# A significant event that happened during the incident.
|
2072
|
+
#
|
2073
|
+
# @!attribute [rw] event_data
|
2074
|
+
# A short description of the event.
|
2075
|
+
# @return [String]
|
2076
|
+
#
|
2077
|
+
# @!attribute [rw] event_id
|
2078
|
+
# The ID of the timeline event.
|
2079
|
+
# @return [String]
|
2080
|
+
#
|
2081
|
+
# @!attribute [rw] event_time
|
2082
|
+
# The time that the event occurred.
|
2083
|
+
# @return [Time]
|
2084
|
+
#
|
2085
|
+
# @!attribute [rw] event_type
|
2086
|
+
# The type of event that occurred. Currently Incident Manager supports
|
2087
|
+
# only the `Custom Event` type.
|
2088
|
+
# @return [String]
|
2089
|
+
#
|
2090
|
+
# @!attribute [rw] event_updated_time
|
2091
|
+
# The time that the timeline event was last updated.
|
2092
|
+
# @return [Time]
|
2093
|
+
#
|
2094
|
+
# @!attribute [rw] incident_record_arn
|
2095
|
+
# The Amazon Resource Name (ARN) of the incident that the event
|
2096
|
+
# occurred during.
|
2097
|
+
# @return [String]
|
2098
|
+
#
|
2099
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/TimelineEvent AWS API Documentation
|
2100
|
+
#
|
2101
|
+
class TimelineEvent < Struct.new(
|
2102
|
+
:event_data,
|
2103
|
+
:event_id,
|
2104
|
+
:event_time,
|
2105
|
+
:event_type,
|
2106
|
+
:event_updated_time,
|
2107
|
+
:incident_record_arn)
|
2108
|
+
SENSITIVE = []
|
2109
|
+
include Aws::Structure
|
2110
|
+
end
|
2111
|
+
|
2112
|
+
# Details about what caused the incident to be created in Incident
|
2113
|
+
# Manager.
|
2114
|
+
#
|
2115
|
+
# @note When making an API call, you may pass TriggerDetails
|
2116
|
+
# data as a hash:
|
2117
|
+
#
|
2118
|
+
# {
|
2119
|
+
# raw_data: "RawData",
|
2120
|
+
# source: "IncidentSource", # required
|
2121
|
+
# timestamp: Time.now, # required
|
2122
|
+
# trigger_arn: "Arn",
|
2123
|
+
# }
|
2124
|
+
#
|
2125
|
+
# @!attribute [rw] raw_data
|
2126
|
+
# Raw data passed from either EventBridge, CloudWatch, or Incident
|
2127
|
+
# Manager when an incident is created.
|
2128
|
+
# @return [String]
|
2129
|
+
#
|
2130
|
+
# @!attribute [rw] source
|
2131
|
+
# Identifies the service that sourced the event. All events sourced
|
2132
|
+
# from within AWS begin with "aws." Customer-generated events can
|
2133
|
+
# have any value here, as long as it doesn't begin with "aws." We
|
2134
|
+
# recommend the use of Java package-name style reverse domain-name
|
2135
|
+
# strings.
|
2136
|
+
# @return [String]
|
2137
|
+
#
|
2138
|
+
# @!attribute [rw] timestamp
|
2139
|
+
# The time that the incident was detected.
|
2140
|
+
# @return [Time]
|
2141
|
+
#
|
2142
|
+
# @!attribute [rw] trigger_arn
|
2143
|
+
# The ARN of the source that detected the incident.
|
2144
|
+
# @return [String]
|
2145
|
+
#
|
2146
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/TriggerDetails AWS API Documentation
|
2147
|
+
#
|
2148
|
+
class TriggerDetails < Struct.new(
|
2149
|
+
:raw_data,
|
2150
|
+
:source,
|
2151
|
+
:timestamp,
|
2152
|
+
:trigger_arn)
|
2153
|
+
SENSITIVE = []
|
2154
|
+
include Aws::Structure
|
2155
|
+
end
|
2156
|
+
|
2157
|
+
# @note When making an API call, you may pass UntagResourceRequest
|
2158
|
+
# data as a hash:
|
2159
|
+
#
|
2160
|
+
# {
|
2161
|
+
# resource_arn: "String", # required
|
2162
|
+
# tag_keys: ["TagKey"], # required
|
2163
|
+
# }
|
2164
|
+
#
|
2165
|
+
# @!attribute [rw] resource_arn
|
2166
|
+
# The Amazon Resource Name (ARN) of the response plan you're removing
|
2167
|
+
# a tag from.
|
2168
|
+
# @return [String]
|
2169
|
+
#
|
2170
|
+
# @!attribute [rw] tag_keys
|
2171
|
+
# The name of the tag you're removing from the response plan.
|
2172
|
+
# @return [Array<String>]
|
2173
|
+
#
|
2174
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/UntagResourceRequest AWS API Documentation
|
2175
|
+
#
|
2176
|
+
class UntagResourceRequest < Struct.new(
|
2177
|
+
:resource_arn,
|
2178
|
+
:tag_keys)
|
2179
|
+
SENSITIVE = []
|
2180
|
+
include Aws::Structure
|
2181
|
+
end
|
2182
|
+
|
2183
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/UntagResourceResponse AWS API Documentation
|
2184
|
+
#
|
2185
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
2186
|
+
|
2187
|
+
# @note When making an API call, you may pass UpdateDeletionProtectionInput
|
2188
|
+
# data as a hash:
|
2189
|
+
#
|
2190
|
+
# {
|
2191
|
+
# arn: "Arn", # required
|
2192
|
+
# client_token: "ClientToken",
|
2193
|
+
# deletion_protected: false, # required
|
2194
|
+
# }
|
2195
|
+
#
|
2196
|
+
# @!attribute [rw] arn
|
2197
|
+
# The Amazon Resource Name (ARN) of the replication set you're
|
2198
|
+
# updating.
|
2199
|
+
# @return [String]
|
2200
|
+
#
|
2201
|
+
# @!attribute [rw] client_token
|
2202
|
+
# A token ensuring that the action is called only once with the
|
2203
|
+
# specified details.
|
2204
|
+
#
|
2205
|
+
# **A suitable default value is auto-generated.** You should normally
|
2206
|
+
# not need to pass this option.
|
2207
|
+
# @return [String]
|
2208
|
+
#
|
2209
|
+
# @!attribute [rw] deletion_protected
|
2210
|
+
# Details if deletion protection is enabled or disabled in your
|
2211
|
+
# account.
|
2212
|
+
# @return [Boolean]
|
2213
|
+
#
|
2214
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/UpdateDeletionProtectionInput AWS API Documentation
|
2215
|
+
#
|
2216
|
+
class UpdateDeletionProtectionInput < Struct.new(
|
2217
|
+
:arn,
|
2218
|
+
:client_token,
|
2219
|
+
:deletion_protected)
|
2220
|
+
SENSITIVE = []
|
2221
|
+
include Aws::Structure
|
2222
|
+
end
|
2223
|
+
|
2224
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/UpdateDeletionProtectionOutput AWS API Documentation
|
2225
|
+
#
|
2226
|
+
class UpdateDeletionProtectionOutput < Aws::EmptyStructure; end
|
2227
|
+
|
2228
|
+
# @note When making an API call, you may pass UpdateIncidentRecordInput
|
2229
|
+
# data as a hash:
|
2230
|
+
#
|
2231
|
+
# {
|
2232
|
+
# arn: "Arn", # required
|
2233
|
+
# chat_channel: {
|
2234
|
+
# chatbot_sns: ["SnsArn"],
|
2235
|
+
# empty: {
|
2236
|
+
# },
|
2237
|
+
# },
|
2238
|
+
# client_token: "ClientToken",
|
2239
|
+
# impact: 1,
|
2240
|
+
# notification_targets: [
|
2241
|
+
# {
|
2242
|
+
# sns_topic_arn: "Arn",
|
2243
|
+
# },
|
2244
|
+
# ],
|
2245
|
+
# status: "OPEN", # accepts OPEN, RESOLVED
|
2246
|
+
# summary: "IncidentSummary",
|
2247
|
+
# title: "IncidentTitle",
|
2248
|
+
# }
|
2249
|
+
#
|
2250
|
+
# @!attribute [rw] arn
|
2251
|
+
# The Amazon Resource Name (ARN) of the incident record you are
|
2252
|
+
# updating.
|
2253
|
+
# @return [String]
|
2254
|
+
#
|
2255
|
+
# @!attribute [rw] chat_channel
|
2256
|
+
# The AWS Chatbot chat channel for responders to collaborate in.
|
2257
|
+
# @return [Types::ChatChannel]
|
2258
|
+
#
|
2259
|
+
# @!attribute [rw] client_token
|
2260
|
+
# A token ensuring that the action is called only once with the
|
2261
|
+
# specified details.
|
2262
|
+
#
|
2263
|
+
# **A suitable default value is auto-generated.** You should normally
|
2264
|
+
# not need to pass this option.
|
2265
|
+
# @return [String]
|
2266
|
+
#
|
2267
|
+
# @!attribute [rw] impact
|
2268
|
+
# Defines the impact to customers and applications. Providing an
|
2269
|
+
# impact overwrites the impact provided by the response plan.
|
2270
|
+
#
|
2271
|
+
# **Possible impacts:**
|
2272
|
+
#
|
2273
|
+
# * `1` - Critical impact, this typically relates to full application
|
2274
|
+
# failure that impacts many to all customers.
|
2275
|
+
#
|
2276
|
+
# * `2` - High impact, partial application failure with impact to many
|
2277
|
+
# customers.
|
2278
|
+
#
|
2279
|
+
# * `3` - Medium impact, the application is providing reduced service
|
2280
|
+
# to customers.
|
2281
|
+
#
|
2282
|
+
# * `4` - Low impact, customer might aren't impacted by the problem
|
2283
|
+
# yet.
|
2284
|
+
#
|
2285
|
+
# * `5` - No impact, customers aren't currently impacted but urgent
|
2286
|
+
# action is needed to avoid impact.
|
2287
|
+
# @return [Integer]
|
2288
|
+
#
|
2289
|
+
# @!attribute [rw] notification_targets
|
2290
|
+
# The SNS targets that AWS Chatbot uses to notify the chat channel of
|
2291
|
+
# updates to an incident. You can also make updates to the incident
|
2292
|
+
# through the chat channel using the SNS topics.
|
2293
|
+
#
|
2294
|
+
# Using multiple SNS topics creates redundancy in the case that a
|
2295
|
+
# Region is down during the incident.
|
2296
|
+
# @return [Array<Types::NotificationTargetItem>]
|
2297
|
+
#
|
2298
|
+
# @!attribute [rw] status
|
2299
|
+
# The status of the incident. An incident can be `Open` or `Resolved`.
|
2300
|
+
# @return [String]
|
2301
|
+
#
|
2302
|
+
# @!attribute [rw] summary
|
2303
|
+
# The summary describes what has happened during the incident.
|
2304
|
+
# @return [String]
|
2305
|
+
#
|
2306
|
+
# @!attribute [rw] title
|
2307
|
+
# The title of the incident is a brief and easily recognizable.
|
2308
|
+
# @return [String]
|
2309
|
+
#
|
2310
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/UpdateIncidentRecordInput AWS API Documentation
|
2311
|
+
#
|
2312
|
+
class UpdateIncidentRecordInput < Struct.new(
|
2313
|
+
:arn,
|
2314
|
+
:chat_channel,
|
2315
|
+
:client_token,
|
2316
|
+
:impact,
|
2317
|
+
:notification_targets,
|
2318
|
+
:status,
|
2319
|
+
:summary,
|
2320
|
+
:title)
|
2321
|
+
SENSITIVE = []
|
2322
|
+
include Aws::Structure
|
2323
|
+
end
|
2324
|
+
|
2325
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/UpdateIncidentRecordOutput AWS API Documentation
|
2326
|
+
#
|
2327
|
+
class UpdateIncidentRecordOutput < Aws::EmptyStructure; end
|
2328
|
+
|
2329
|
+
# @note When making an API call, you may pass UpdateRelatedItemsInput
|
2330
|
+
# data as a hash:
|
2331
|
+
#
|
2332
|
+
# {
|
2333
|
+
# client_token: "ClientToken",
|
2334
|
+
# incident_record_arn: "Arn", # required
|
2335
|
+
# related_items_update: { # required
|
2336
|
+
# item_to_add: {
|
2337
|
+
# identifier: { # required
|
2338
|
+
# type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER
|
2339
|
+
# value: { # required
|
2340
|
+
# arn: "Arn",
|
2341
|
+
# metric_definition: "MetricDefinition",
|
2342
|
+
# url: "Url",
|
2343
|
+
# },
|
2344
|
+
# },
|
2345
|
+
# title: "RelatedItemTitleString",
|
2346
|
+
# },
|
2347
|
+
# item_to_remove: {
|
2348
|
+
# type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER
|
2349
|
+
# value: { # required
|
2350
|
+
# arn: "Arn",
|
2351
|
+
# metric_definition: "MetricDefinition",
|
2352
|
+
# url: "Url",
|
2353
|
+
# },
|
2354
|
+
# },
|
2355
|
+
# },
|
2356
|
+
# }
|
2357
|
+
#
|
2358
|
+
# @!attribute [rw] client_token
|
2359
|
+
# A token ensuring that the action is called only once with the
|
2360
|
+
# specified details.
|
2361
|
+
#
|
2362
|
+
# **A suitable default value is auto-generated.** You should normally
|
2363
|
+
# not need to pass this option.
|
2364
|
+
# @return [String]
|
2365
|
+
#
|
2366
|
+
# @!attribute [rw] incident_record_arn
|
2367
|
+
# The Amazon Resource Name (ARN) of the incident record you are
|
2368
|
+
# updating related items in.
|
2369
|
+
# @return [String]
|
2370
|
+
#
|
2371
|
+
# @!attribute [rw] related_items_update
|
2372
|
+
# Details about the item you are adding or deleting.
|
2373
|
+
# @return [Types::RelatedItemsUpdate]
|
2374
|
+
#
|
2375
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/UpdateRelatedItemsInput AWS API Documentation
|
2376
|
+
#
|
2377
|
+
class UpdateRelatedItemsInput < Struct.new(
|
2378
|
+
:client_token,
|
2379
|
+
:incident_record_arn,
|
2380
|
+
:related_items_update)
|
2381
|
+
SENSITIVE = []
|
2382
|
+
include Aws::Structure
|
2383
|
+
end
|
2384
|
+
|
2385
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/UpdateRelatedItemsOutput AWS API Documentation
|
2386
|
+
#
|
2387
|
+
class UpdateRelatedItemsOutput < Aws::EmptyStructure; end
|
2388
|
+
|
2389
|
+
# Details used when updating the replication set.
|
2390
|
+
#
|
2391
|
+
# @note When making an API call, you may pass UpdateReplicationSetAction
|
2392
|
+
# data as a hash:
|
2393
|
+
#
|
2394
|
+
# {
|
2395
|
+
# add_region_action: {
|
2396
|
+
# region_name: "RegionName", # required
|
2397
|
+
# sse_kms_key_id: "SseKmsKey",
|
2398
|
+
# },
|
2399
|
+
# delete_region_action: {
|
2400
|
+
# region_name: "RegionName", # required
|
2401
|
+
# },
|
2402
|
+
# }
|
2403
|
+
#
|
2404
|
+
# @!attribute [rw] add_region_action
|
2405
|
+
# Details about the Region that you're adding to the replication set.
|
2406
|
+
# @return [Types::AddRegionAction]
|
2407
|
+
#
|
2408
|
+
# @!attribute [rw] delete_region_action
|
2409
|
+
# Details about the Region that you're deleting to the replication
|
2410
|
+
# set.
|
2411
|
+
# @return [Types::DeleteRegionAction]
|
2412
|
+
#
|
2413
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/UpdateReplicationSetAction AWS API Documentation
|
2414
|
+
#
|
2415
|
+
class UpdateReplicationSetAction < Struct.new(
|
2416
|
+
:add_region_action,
|
2417
|
+
:delete_region_action)
|
2418
|
+
SENSITIVE = []
|
2419
|
+
include Aws::Structure
|
2420
|
+
end
|
2421
|
+
|
2422
|
+
# @note When making an API call, you may pass UpdateReplicationSetInput
|
2423
|
+
# data as a hash:
|
2424
|
+
#
|
2425
|
+
# {
|
2426
|
+
# actions: [ # required
|
2427
|
+
# {
|
2428
|
+
# add_region_action: {
|
2429
|
+
# region_name: "RegionName", # required
|
2430
|
+
# sse_kms_key_id: "SseKmsKey",
|
2431
|
+
# },
|
2432
|
+
# delete_region_action: {
|
2433
|
+
# region_name: "RegionName", # required
|
2434
|
+
# },
|
2435
|
+
# },
|
2436
|
+
# ],
|
2437
|
+
# arn: "Arn", # required
|
2438
|
+
# client_token: "ClientToken",
|
2439
|
+
# }
|
2440
|
+
#
|
2441
|
+
# @!attribute [rw] actions
|
2442
|
+
# An action to add or delete a Region.
|
2443
|
+
# @return [Array<Types::UpdateReplicationSetAction>]
|
2444
|
+
#
|
2445
|
+
# @!attribute [rw] arn
|
2446
|
+
# The Amazon Resource Name (ARN) of the replication set you're
|
2447
|
+
# updating.
|
2448
|
+
# @return [String]
|
2449
|
+
#
|
2450
|
+
# @!attribute [rw] client_token
|
2451
|
+
# A token ensuring that the action is called only once with the
|
2452
|
+
# specified details.
|
2453
|
+
#
|
2454
|
+
# **A suitable default value is auto-generated.** You should normally
|
2455
|
+
# not need to pass this option.
|
2456
|
+
# @return [String]
|
2457
|
+
#
|
2458
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/UpdateReplicationSetInput AWS API Documentation
|
2459
|
+
#
|
2460
|
+
class UpdateReplicationSetInput < Struct.new(
|
2461
|
+
:actions,
|
2462
|
+
:arn,
|
2463
|
+
:client_token)
|
2464
|
+
SENSITIVE = []
|
2465
|
+
include Aws::Structure
|
2466
|
+
end
|
2467
|
+
|
2468
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/UpdateReplicationSetOutput AWS API Documentation
|
2469
|
+
#
|
2470
|
+
class UpdateReplicationSetOutput < Aws::EmptyStructure; end
|
2471
|
+
|
2472
|
+
# @note When making an API call, you may pass UpdateResponsePlanInput
|
2473
|
+
# data as a hash:
|
2474
|
+
#
|
2475
|
+
# {
|
2476
|
+
# actions: [
|
2477
|
+
# {
|
2478
|
+
# ssm_automation: {
|
2479
|
+
# document_name: "SsmAutomationDocumentNameString", # required
|
2480
|
+
# document_version: "SsmAutomationDocumentVersionString",
|
2481
|
+
# parameters: {
|
2482
|
+
# "SsmParametersKeyString" => ["SsmParameterValuesMemberString"],
|
2483
|
+
# },
|
2484
|
+
# role_arn: "RoleArn", # required
|
2485
|
+
# target_account: "RESPONSE_PLAN_OWNER_ACCOUNT", # accepts RESPONSE_PLAN_OWNER_ACCOUNT, IMPACTED_ACCOUNT
|
2486
|
+
# },
|
2487
|
+
# },
|
2488
|
+
# ],
|
2489
|
+
# arn: "Arn", # required
|
2490
|
+
# chat_channel: {
|
2491
|
+
# chatbot_sns: ["SnsArn"],
|
2492
|
+
# empty: {
|
2493
|
+
# },
|
2494
|
+
# },
|
2495
|
+
# client_token: "ClientToken",
|
2496
|
+
# display_name: "ResponsePlanDisplayName",
|
2497
|
+
# engagements: ["SsmContactsArn"],
|
2498
|
+
# incident_template_dedupe_string: "DedupeString",
|
2499
|
+
# incident_template_impact: 1,
|
2500
|
+
# incident_template_notification_targets: [
|
2501
|
+
# {
|
2502
|
+
# sns_topic_arn: "Arn",
|
2503
|
+
# },
|
2504
|
+
# ],
|
2505
|
+
# incident_template_summary: "IncidentSummary",
|
2506
|
+
# incident_template_title: "IncidentTitle",
|
2507
|
+
# }
|
2508
|
+
#
|
2509
|
+
# @!attribute [rw] actions
|
2510
|
+
# The actions that this response plan takes at the beginning of an
|
2511
|
+
# incident.
|
2512
|
+
# @return [Array<Types::Action>]
|
2513
|
+
#
|
2514
|
+
# @!attribute [rw] arn
|
2515
|
+
# The Amazon Resource Name (ARN) of the response plan.
|
2516
|
+
# @return [String]
|
2517
|
+
#
|
2518
|
+
# @!attribute [rw] chat_channel
|
2519
|
+
# The AWS Chatbot chat channel used for collaboration during an
|
2520
|
+
# incident.
|
2521
|
+
# @return [Types::ChatChannel]
|
2522
|
+
#
|
2523
|
+
# @!attribute [rw] client_token
|
2524
|
+
# A token ensuring that the action is called only once with the
|
2525
|
+
# specified details.
|
2526
|
+
#
|
2527
|
+
# **A suitable default value is auto-generated.** You should normally
|
2528
|
+
# not need to pass this option.
|
2529
|
+
# @return [String]
|
2530
|
+
#
|
2531
|
+
# @!attribute [rw] display_name
|
2532
|
+
# The long format name of the response plan. Can't contain spaces.
|
2533
|
+
# @return [String]
|
2534
|
+
#
|
2535
|
+
# @!attribute [rw] engagements
|
2536
|
+
# The contacts and escalation plans that Incident Manager engages at
|
2537
|
+
# the start of the incident.
|
2538
|
+
# @return [Array<String>]
|
2539
|
+
#
|
2540
|
+
# @!attribute [rw] incident_template_dedupe_string
|
2541
|
+
# Used to create only one incident record for an incident.
|
2542
|
+
# @return [String]
|
2543
|
+
#
|
2544
|
+
# @!attribute [rw] incident_template_impact
|
2545
|
+
# Defines the impact to the customers. Providing an impact overwrites
|
2546
|
+
# the impact provided by a response plan.
|
2547
|
+
#
|
2548
|
+
# **Possible impacts:**
|
2549
|
+
#
|
2550
|
+
# * `5` - Severe impact
|
2551
|
+
#
|
2552
|
+
# * `4` - High impact
|
2553
|
+
#
|
2554
|
+
# * `3` - Medium impact
|
2555
|
+
#
|
2556
|
+
# * `2` - Low impact
|
2557
|
+
#
|
2558
|
+
# * `1` - No impact
|
2559
|
+
# @return [Integer]
|
2560
|
+
#
|
2561
|
+
# @!attribute [rw] incident_template_notification_targets
|
2562
|
+
# The SNS targets that AWS Chatbot uses to notify the chat channels
|
2563
|
+
# and perform actions on the incident record.
|
2564
|
+
# @return [Array<Types::NotificationTargetItem>]
|
2565
|
+
#
|
2566
|
+
# @!attribute [rw] incident_template_summary
|
2567
|
+
# A brief summary of the incident. This typically contains what has
|
2568
|
+
# happened, what's currently happening, and next steps.
|
2569
|
+
# @return [String]
|
2570
|
+
#
|
2571
|
+
# @!attribute [rw] incident_template_title
|
2572
|
+
# The short format name of the incident. Can't contain spaces.
|
2573
|
+
# @return [String]
|
2574
|
+
#
|
2575
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/UpdateResponsePlanInput AWS API Documentation
|
2576
|
+
#
|
2577
|
+
class UpdateResponsePlanInput < Struct.new(
|
2578
|
+
:actions,
|
2579
|
+
:arn,
|
2580
|
+
:chat_channel,
|
2581
|
+
:client_token,
|
2582
|
+
:display_name,
|
2583
|
+
:engagements,
|
2584
|
+
:incident_template_dedupe_string,
|
2585
|
+
:incident_template_impact,
|
2586
|
+
:incident_template_notification_targets,
|
2587
|
+
:incident_template_summary,
|
2588
|
+
:incident_template_title)
|
2589
|
+
SENSITIVE = []
|
2590
|
+
include Aws::Structure
|
2591
|
+
end
|
2592
|
+
|
2593
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/UpdateResponsePlanOutput AWS API Documentation
|
2594
|
+
#
|
2595
|
+
class UpdateResponsePlanOutput < Aws::EmptyStructure; end
|
2596
|
+
|
2597
|
+
# @note When making an API call, you may pass UpdateTimelineEventInput
|
2598
|
+
# data as a hash:
|
2599
|
+
#
|
2600
|
+
# {
|
2601
|
+
# client_token: "ClientToken", # required
|
2602
|
+
# event_data: "EventData",
|
2603
|
+
# event_id: "UUID", # required
|
2604
|
+
# event_time: Time.now,
|
2605
|
+
# event_type: "TimelineEventType",
|
2606
|
+
# incident_record_arn: "Arn", # required
|
2607
|
+
# }
|
2608
|
+
#
|
2609
|
+
# @!attribute [rw] client_token
|
2610
|
+
# A token ensuring that the action is called only once with the
|
2611
|
+
# specified details.
|
2612
|
+
#
|
2613
|
+
# **A suitable default value is auto-generated.** You should normally
|
2614
|
+
# not need to pass this option.
|
2615
|
+
# @return [String]
|
2616
|
+
#
|
2617
|
+
# @!attribute [rw] event_data
|
2618
|
+
# A short description of the event.
|
2619
|
+
# @return [String]
|
2620
|
+
#
|
2621
|
+
# @!attribute [rw] event_id
|
2622
|
+
# The ID of the event you are updating. You can find this by using
|
2623
|
+
# `ListTimelineEvents`.
|
2624
|
+
# @return [String]
|
2625
|
+
#
|
2626
|
+
# @!attribute [rw] event_time
|
2627
|
+
# The time that the event occurred.
|
2628
|
+
# @return [Time]
|
2629
|
+
#
|
2630
|
+
# @!attribute [rw] event_type
|
2631
|
+
# The type of the event. You can update events of type `Custom Event`.
|
2632
|
+
# @return [String]
|
2633
|
+
#
|
2634
|
+
# @!attribute [rw] incident_record_arn
|
2635
|
+
# The Amazon Resource Name (ARN) of the incident that the timeline
|
2636
|
+
# event is part of.
|
2637
|
+
# @return [String]
|
2638
|
+
#
|
2639
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/UpdateTimelineEventInput AWS API Documentation
|
2640
|
+
#
|
2641
|
+
class UpdateTimelineEventInput < Struct.new(
|
2642
|
+
:client_token,
|
2643
|
+
:event_data,
|
2644
|
+
:event_id,
|
2645
|
+
:event_time,
|
2646
|
+
:event_type,
|
2647
|
+
:incident_record_arn)
|
2648
|
+
SENSITIVE = []
|
2649
|
+
include Aws::Structure
|
2650
|
+
end
|
2651
|
+
|
2652
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/UpdateTimelineEventOutput AWS API Documentation
|
2653
|
+
#
|
2654
|
+
class UpdateTimelineEventOutput < Aws::EmptyStructure; end
|
2655
|
+
|
2656
|
+
# The input fails to satisfy the constraints specified by an AWS
|
2657
|
+
# service.
|
2658
|
+
#
|
2659
|
+
# @!attribute [rw] message
|
2660
|
+
# @return [String]
|
2661
|
+
#
|
2662
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ValidationException AWS API Documentation
|
2663
|
+
#
|
2664
|
+
class ValidationException < Struct.new(
|
2665
|
+
:message)
|
2666
|
+
SENSITIVE = []
|
2667
|
+
include Aws::Structure
|
2668
|
+
end
|
2669
|
+
|
2670
|
+
end
|
2671
|
+
end
|