aws-sdk-ssmcontacts 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-ssmcontacts.rb +53 -0
- data/lib/aws-sdk-ssmcontacts/client.rb +1495 -0
- data/lib/aws-sdk-ssmcontacts/client_api.rb +919 -0
- data/lib/aws-sdk-ssmcontacts/customizations.rb +0 -0
- data/lib/aws-sdk-ssmcontacts/errors.rb +236 -0
- data/lib/aws-sdk-ssmcontacts/resource.rb +26 -0
- data/lib/aws-sdk-ssmcontacts/types.rb +1974 -0
- metadata +90 -0
File without changes
|
@@ -0,0 +1,236 @@
|
|
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::SSMContacts
|
11
|
+
|
12
|
+
# When SSMContacts returns an error response, the Ruby SDK constructs and raises an error.
|
13
|
+
# These errors all extend Aws::SSMContacts::Errors::ServiceError < {Aws::Errors::ServiceError}
|
14
|
+
#
|
15
|
+
# You can rescue all SSMContacts errors using ServiceError:
|
16
|
+
#
|
17
|
+
# begin
|
18
|
+
# # do stuff
|
19
|
+
# rescue Aws::SSMContacts::Errors::ServiceError
|
20
|
+
# # rescues all SSMContacts 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
|
+
# * {DataEncryptionException}
|
33
|
+
# * {InternalServerException}
|
34
|
+
# * {ResourceNotFoundException}
|
35
|
+
# * {ServiceQuotaExceededException}
|
36
|
+
# * {ThrottlingException}
|
37
|
+
# * {ValidationException}
|
38
|
+
#
|
39
|
+
# Additionally, error classes are dynamically generated for service errors based on the error code
|
40
|
+
# if they are not defined above.
|
41
|
+
module Errors
|
42
|
+
|
43
|
+
extend Aws::Errors::DynamicErrors
|
44
|
+
|
45
|
+
class AccessDeniedException < ServiceError
|
46
|
+
|
47
|
+
# @param [Seahorse::Client::RequestContext] context
|
48
|
+
# @param [String] message
|
49
|
+
# @param [Aws::SSMContacts::Types::AccessDeniedException] data
|
50
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
51
|
+
super(context, message, data)
|
52
|
+
end
|
53
|
+
|
54
|
+
# @return [String]
|
55
|
+
def message
|
56
|
+
@message || @data[:message]
|
57
|
+
end
|
58
|
+
end
|
59
|
+
|
60
|
+
class ConflictException < ServiceError
|
61
|
+
|
62
|
+
# @param [Seahorse::Client::RequestContext] context
|
63
|
+
# @param [String] message
|
64
|
+
# @param [Aws::SSMContacts::Types::ConflictException] data
|
65
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
66
|
+
super(context, message, data)
|
67
|
+
end
|
68
|
+
|
69
|
+
# @return [String]
|
70
|
+
def message
|
71
|
+
@message || @data[:message]
|
72
|
+
end
|
73
|
+
|
74
|
+
# @return [String]
|
75
|
+
def resource_id
|
76
|
+
@data[:resource_id]
|
77
|
+
end
|
78
|
+
|
79
|
+
# @return [String]
|
80
|
+
def resource_type
|
81
|
+
@data[:resource_type]
|
82
|
+
end
|
83
|
+
end
|
84
|
+
|
85
|
+
class DataEncryptionException < ServiceError
|
86
|
+
|
87
|
+
# @param [Seahorse::Client::RequestContext] context
|
88
|
+
# @param [String] message
|
89
|
+
# @param [Aws::SSMContacts::Types::DataEncryptionException] data
|
90
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
91
|
+
super(context, message, data)
|
92
|
+
end
|
93
|
+
|
94
|
+
# @return [String]
|
95
|
+
def message
|
96
|
+
@message || @data[:message]
|
97
|
+
end
|
98
|
+
end
|
99
|
+
|
100
|
+
class InternalServerException < ServiceError
|
101
|
+
|
102
|
+
# @param [Seahorse::Client::RequestContext] context
|
103
|
+
# @param [String] message
|
104
|
+
# @param [Aws::SSMContacts::Types::InternalServerException] data
|
105
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
106
|
+
super(context, message, data)
|
107
|
+
end
|
108
|
+
|
109
|
+
# @return [String]
|
110
|
+
def message
|
111
|
+
@message || @data[:message]
|
112
|
+
end
|
113
|
+
|
114
|
+
# @return [String]
|
115
|
+
def retry_after_seconds
|
116
|
+
@data[:retry_after_seconds]
|
117
|
+
end
|
118
|
+
end
|
119
|
+
|
120
|
+
class ResourceNotFoundException < ServiceError
|
121
|
+
|
122
|
+
# @param [Seahorse::Client::RequestContext] context
|
123
|
+
# @param [String] message
|
124
|
+
# @param [Aws::SSMContacts::Types::ResourceNotFoundException] data
|
125
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
126
|
+
super(context, message, data)
|
127
|
+
end
|
128
|
+
|
129
|
+
# @return [String]
|
130
|
+
def message
|
131
|
+
@message || @data[:message]
|
132
|
+
end
|
133
|
+
|
134
|
+
# @return [String]
|
135
|
+
def resource_id
|
136
|
+
@data[:resource_id]
|
137
|
+
end
|
138
|
+
|
139
|
+
# @return [String]
|
140
|
+
def resource_type
|
141
|
+
@data[:resource_type]
|
142
|
+
end
|
143
|
+
end
|
144
|
+
|
145
|
+
class ServiceQuotaExceededException < ServiceError
|
146
|
+
|
147
|
+
# @param [Seahorse::Client::RequestContext] context
|
148
|
+
# @param [String] message
|
149
|
+
# @param [Aws::SSMContacts::Types::ServiceQuotaExceededException] data
|
150
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
151
|
+
super(context, message, data)
|
152
|
+
end
|
153
|
+
|
154
|
+
# @return [String]
|
155
|
+
def message
|
156
|
+
@message || @data[:message]
|
157
|
+
end
|
158
|
+
|
159
|
+
# @return [String]
|
160
|
+
def resource_id
|
161
|
+
@data[:resource_id]
|
162
|
+
end
|
163
|
+
|
164
|
+
# @return [String]
|
165
|
+
def resource_type
|
166
|
+
@data[:resource_type]
|
167
|
+
end
|
168
|
+
|
169
|
+
# @return [String]
|
170
|
+
def quota_code
|
171
|
+
@data[:quota_code]
|
172
|
+
end
|
173
|
+
|
174
|
+
# @return [String]
|
175
|
+
def service_code
|
176
|
+
@data[:service_code]
|
177
|
+
end
|
178
|
+
end
|
179
|
+
|
180
|
+
class ThrottlingException < ServiceError
|
181
|
+
|
182
|
+
# @param [Seahorse::Client::RequestContext] context
|
183
|
+
# @param [String] message
|
184
|
+
# @param [Aws::SSMContacts::Types::ThrottlingException] data
|
185
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
186
|
+
super(context, message, data)
|
187
|
+
end
|
188
|
+
|
189
|
+
# @return [String]
|
190
|
+
def message
|
191
|
+
@message || @data[:message]
|
192
|
+
end
|
193
|
+
|
194
|
+
# @return [String]
|
195
|
+
def quota_code
|
196
|
+
@data[:quota_code]
|
197
|
+
end
|
198
|
+
|
199
|
+
# @return [String]
|
200
|
+
def service_code
|
201
|
+
@data[:service_code]
|
202
|
+
end
|
203
|
+
|
204
|
+
# @return [String]
|
205
|
+
def retry_after_seconds
|
206
|
+
@data[:retry_after_seconds]
|
207
|
+
end
|
208
|
+
end
|
209
|
+
|
210
|
+
class ValidationException < ServiceError
|
211
|
+
|
212
|
+
# @param [Seahorse::Client::RequestContext] context
|
213
|
+
# @param [String] message
|
214
|
+
# @param [Aws::SSMContacts::Types::ValidationException] data
|
215
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
216
|
+
super(context, message, data)
|
217
|
+
end
|
218
|
+
|
219
|
+
# @return [String]
|
220
|
+
def message
|
221
|
+
@message || @data[:message]
|
222
|
+
end
|
223
|
+
|
224
|
+
# @return [String]
|
225
|
+
def reason
|
226
|
+
@data[:reason]
|
227
|
+
end
|
228
|
+
|
229
|
+
# @return [String]
|
230
|
+
def fields
|
231
|
+
@data[:fields]
|
232
|
+
end
|
233
|
+
end
|
234
|
+
|
235
|
+
end
|
236
|
+
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::SSMContacts
|
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,1974 @@
|
|
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::SSMContacts
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# @note When making an API call, you may pass AcceptPageRequest
|
14
|
+
# data as a hash:
|
15
|
+
#
|
16
|
+
# {
|
17
|
+
# page_id: "SsmContactsArn", # required
|
18
|
+
# contact_channel_id: "SsmContactsArn",
|
19
|
+
# accept_type: "DELIVERED", # required, accepts DELIVERED, READ
|
20
|
+
# note: "ReceiptInfo",
|
21
|
+
# accept_code: "AcceptCode", # required
|
22
|
+
# }
|
23
|
+
#
|
24
|
+
# @!attribute [rw] page_id
|
25
|
+
# The Amazon Resource Name (ARN) of the engagement to a contact
|
26
|
+
# channel.
|
27
|
+
# @return [String]
|
28
|
+
#
|
29
|
+
# @!attribute [rw] contact_channel_id
|
30
|
+
# The ARN of the contact channel.
|
31
|
+
# @return [String]
|
32
|
+
#
|
33
|
+
# @!attribute [rw] accept_type
|
34
|
+
# The type indicates if the page was `DELIVERED` or `READ`.
|
35
|
+
# @return [String]
|
36
|
+
#
|
37
|
+
# @!attribute [rw] note
|
38
|
+
# Information provided by the user when the user acknowledges the
|
39
|
+
# page.
|
40
|
+
# @return [String]
|
41
|
+
#
|
42
|
+
# @!attribute [rw] accept_code
|
43
|
+
# The accept code is a 6-digit code used to acknowledge the page.
|
44
|
+
# @return [String]
|
45
|
+
#
|
46
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/AcceptPageRequest AWS API Documentation
|
47
|
+
#
|
48
|
+
class AcceptPageRequest < Struct.new(
|
49
|
+
:page_id,
|
50
|
+
:contact_channel_id,
|
51
|
+
:accept_type,
|
52
|
+
:note,
|
53
|
+
:accept_code)
|
54
|
+
SENSITIVE = []
|
55
|
+
include Aws::Structure
|
56
|
+
end
|
57
|
+
|
58
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/AcceptPageResult AWS API Documentation
|
59
|
+
#
|
60
|
+
class AcceptPageResult < Aws::EmptyStructure; end
|
61
|
+
|
62
|
+
# You don't have sufficient access to perform this action.
|
63
|
+
#
|
64
|
+
# @!attribute [rw] message
|
65
|
+
# @return [String]
|
66
|
+
#
|
67
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/AccessDeniedException AWS API Documentation
|
68
|
+
#
|
69
|
+
class AccessDeniedException < Struct.new(
|
70
|
+
:message)
|
71
|
+
SENSITIVE = []
|
72
|
+
include Aws::Structure
|
73
|
+
end
|
74
|
+
|
75
|
+
# @note When making an API call, you may pass ActivateContactChannelRequest
|
76
|
+
# data as a hash:
|
77
|
+
#
|
78
|
+
# {
|
79
|
+
# contact_channel_id: "SsmContactsArn", # required
|
80
|
+
# activation_code: "ActivationCode", # required
|
81
|
+
# }
|
82
|
+
#
|
83
|
+
# @!attribute [rw] contact_channel_id
|
84
|
+
# The Amazon Resource Name (ARN) of the contact channel.
|
85
|
+
# @return [String]
|
86
|
+
#
|
87
|
+
# @!attribute [rw] activation_code
|
88
|
+
# The code sent to the contact channel when it was created in the
|
89
|
+
# contact.
|
90
|
+
# @return [String]
|
91
|
+
#
|
92
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ActivateContactChannelRequest AWS API Documentation
|
93
|
+
#
|
94
|
+
class ActivateContactChannelRequest < Struct.new(
|
95
|
+
:contact_channel_id,
|
96
|
+
:activation_code)
|
97
|
+
SENSITIVE = []
|
98
|
+
include Aws::Structure
|
99
|
+
end
|
100
|
+
|
101
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ActivateContactChannelResult AWS API Documentation
|
102
|
+
#
|
103
|
+
class ActivateContactChannelResult < Aws::EmptyStructure; end
|
104
|
+
|
105
|
+
# Information about the contact channel that Incident Manager uses to
|
106
|
+
# engage the contact.
|
107
|
+
#
|
108
|
+
# @note When making an API call, you may pass ChannelTargetInfo
|
109
|
+
# data as a hash:
|
110
|
+
#
|
111
|
+
# {
|
112
|
+
# contact_channel_id: "SsmContactsArn", # required
|
113
|
+
# retry_interval_in_minutes: 1,
|
114
|
+
# }
|
115
|
+
#
|
116
|
+
# @!attribute [rw] contact_channel_id
|
117
|
+
# The Amazon Resource Name (ARN) of the contact channel.
|
118
|
+
# @return [String]
|
119
|
+
#
|
120
|
+
# @!attribute [rw] retry_interval_in_minutes
|
121
|
+
# The number of minutes to wait to retry sending engagement in the
|
122
|
+
# case the engagement initially fails.
|
123
|
+
# @return [Integer]
|
124
|
+
#
|
125
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ChannelTargetInfo AWS API Documentation
|
126
|
+
#
|
127
|
+
class ChannelTargetInfo < Struct.new(
|
128
|
+
:contact_channel_id,
|
129
|
+
:retry_interval_in_minutes)
|
130
|
+
SENSITIVE = []
|
131
|
+
include Aws::Structure
|
132
|
+
end
|
133
|
+
|
134
|
+
# Updating or deleting a resource causes an inconsistent state.
|
135
|
+
#
|
136
|
+
# @!attribute [rw] message
|
137
|
+
# @return [String]
|
138
|
+
#
|
139
|
+
# @!attribute [rw] resource_id
|
140
|
+
# Identifier of the resource in use
|
141
|
+
# @return [String]
|
142
|
+
#
|
143
|
+
# @!attribute [rw] resource_type
|
144
|
+
# ype of the resource in use
|
145
|
+
# @return [String]
|
146
|
+
#
|
147
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ConflictException AWS API Documentation
|
148
|
+
#
|
149
|
+
class ConflictException < Struct.new(
|
150
|
+
:message,
|
151
|
+
:resource_id,
|
152
|
+
:resource_type)
|
153
|
+
SENSITIVE = []
|
154
|
+
include Aws::Structure
|
155
|
+
end
|
156
|
+
|
157
|
+
# A personal contact or escalation plan that Incident Manager engages
|
158
|
+
# during an incident.
|
159
|
+
#
|
160
|
+
# @!attribute [rw] contact_arn
|
161
|
+
# The Amazon Resource Name (ARN) of the contact or escalation plan.
|
162
|
+
# @return [String]
|
163
|
+
#
|
164
|
+
# @!attribute [rw] alias
|
165
|
+
# The unique and identifiable alias of the contact or escalation plan.
|
166
|
+
# @return [String]
|
167
|
+
#
|
168
|
+
# @!attribute [rw] display_name
|
169
|
+
# The full name of the contact or escalation plan.
|
170
|
+
# @return [String]
|
171
|
+
#
|
172
|
+
# @!attribute [rw] type
|
173
|
+
# Refers to the type of contact. A single contact is type `PERSONAL`
|
174
|
+
# and an escalation plan is type `ESCALATION`.
|
175
|
+
# @return [String]
|
176
|
+
#
|
177
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/Contact AWS API Documentation
|
178
|
+
#
|
179
|
+
class Contact < Struct.new(
|
180
|
+
:contact_arn,
|
181
|
+
:alias,
|
182
|
+
:display_name,
|
183
|
+
:type)
|
184
|
+
SENSITIVE = []
|
185
|
+
include Aws::Structure
|
186
|
+
end
|
187
|
+
|
188
|
+
# The method that Incident Manager uses to engage a contact.
|
189
|
+
#
|
190
|
+
# @!attribute [rw] contact_channel_arn
|
191
|
+
# The Amazon Resource Name (ARN) of the contact channel.
|
192
|
+
# @return [String]
|
193
|
+
#
|
194
|
+
# @!attribute [rw] contact_arn
|
195
|
+
# The ARN of the contact that contains the contact channel.
|
196
|
+
# @return [String]
|
197
|
+
#
|
198
|
+
# @!attribute [rw] name
|
199
|
+
# The name of the contact channel.
|
200
|
+
# @return [String]
|
201
|
+
#
|
202
|
+
# @!attribute [rw] type
|
203
|
+
# The type of the contact channel. Incident Manager supports three
|
204
|
+
# contact methods:
|
205
|
+
#
|
206
|
+
# * SMS
|
207
|
+
#
|
208
|
+
# * VOICE
|
209
|
+
#
|
210
|
+
# * EMAIL
|
211
|
+
# @return [String]
|
212
|
+
#
|
213
|
+
# @!attribute [rw] delivery_address
|
214
|
+
# The details that Incident Manager uses when trying to engage the
|
215
|
+
# contact channel.
|
216
|
+
# @return [Types::ContactChannelAddress]
|
217
|
+
#
|
218
|
+
# @!attribute [rw] activation_status
|
219
|
+
# A Boolean value describing if the contact channel has been activated
|
220
|
+
# or not. If the contact channel isn't activated, Incident Manager
|
221
|
+
# can't engage the contact through it.
|
222
|
+
# @return [String]
|
223
|
+
#
|
224
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ContactChannel AWS API Documentation
|
225
|
+
#
|
226
|
+
class ContactChannel < Struct.new(
|
227
|
+
:contact_channel_arn,
|
228
|
+
:contact_arn,
|
229
|
+
:name,
|
230
|
+
:type,
|
231
|
+
:delivery_address,
|
232
|
+
:activation_status)
|
233
|
+
SENSITIVE = []
|
234
|
+
include Aws::Structure
|
235
|
+
end
|
236
|
+
|
237
|
+
# The details that Incident Manager uses when trying to engage the
|
238
|
+
# contact channel.
|
239
|
+
#
|
240
|
+
# @note When making an API call, you may pass ContactChannelAddress
|
241
|
+
# data as a hash:
|
242
|
+
#
|
243
|
+
# {
|
244
|
+
# simple_address: "SimpleAddress",
|
245
|
+
# }
|
246
|
+
#
|
247
|
+
# @!attribute [rw] simple_address
|
248
|
+
# The format is dependent on the type of the contact channel. The
|
249
|
+
# following are the expected formats:
|
250
|
+
#
|
251
|
+
# * SMS - '+' followed by the country code and phone number
|
252
|
+
#
|
253
|
+
# * VOICE - '+' followed by the country code and phone number
|
254
|
+
#
|
255
|
+
# * EMAIL - any standard email format
|
256
|
+
# @return [String]
|
257
|
+
#
|
258
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ContactChannelAddress AWS API Documentation
|
259
|
+
#
|
260
|
+
class ContactChannelAddress < Struct.new(
|
261
|
+
:simple_address)
|
262
|
+
SENSITIVE = []
|
263
|
+
include Aws::Structure
|
264
|
+
end
|
265
|
+
|
266
|
+
# The contact that Incident Manager is engaging during an incident.
|
267
|
+
#
|
268
|
+
# @note When making an API call, you may pass ContactTargetInfo
|
269
|
+
# data as a hash:
|
270
|
+
#
|
271
|
+
# {
|
272
|
+
# contact_id: "SsmContactsArn",
|
273
|
+
# is_essential: false, # required
|
274
|
+
# }
|
275
|
+
#
|
276
|
+
# @!attribute [rw] contact_id
|
277
|
+
# The Amazon Resource Name (ARN) of the contact.
|
278
|
+
# @return [String]
|
279
|
+
#
|
280
|
+
# @!attribute [rw] is_essential
|
281
|
+
# A Boolean value determining if the contact's acknowledgement stops
|
282
|
+
# the progress of stages in the plan.
|
283
|
+
# @return [Boolean]
|
284
|
+
#
|
285
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ContactTargetInfo AWS API Documentation
|
286
|
+
#
|
287
|
+
class ContactTargetInfo < Struct.new(
|
288
|
+
:contact_id,
|
289
|
+
:is_essential)
|
290
|
+
SENSITIVE = []
|
291
|
+
include Aws::Structure
|
292
|
+
end
|
293
|
+
|
294
|
+
# @note When making an API call, you may pass CreateContactChannelRequest
|
295
|
+
# data as a hash:
|
296
|
+
#
|
297
|
+
# {
|
298
|
+
# contact_id: "SsmContactsArn", # required
|
299
|
+
# name: "ChannelName", # required
|
300
|
+
# type: "SMS", # required, accepts SMS, VOICE, EMAIL
|
301
|
+
# delivery_address: { # required
|
302
|
+
# simple_address: "SimpleAddress",
|
303
|
+
# },
|
304
|
+
# defer_activation: false,
|
305
|
+
# idempotency_token: "IdempotencyToken",
|
306
|
+
# }
|
307
|
+
#
|
308
|
+
# @!attribute [rw] contact_id
|
309
|
+
# The Amazon Resource Name (ARN) of the contact channel.
|
310
|
+
# @return [String]
|
311
|
+
#
|
312
|
+
# @!attribute [rw] name
|
313
|
+
# The name of the contact channel.
|
314
|
+
# @return [String]
|
315
|
+
#
|
316
|
+
# @!attribute [rw] type
|
317
|
+
# Incident Manager supports three types of contact channels:
|
318
|
+
#
|
319
|
+
# * `SMS`
|
320
|
+
#
|
321
|
+
# * `VOICE`
|
322
|
+
#
|
323
|
+
# * `EMAIL`
|
324
|
+
# @return [String]
|
325
|
+
#
|
326
|
+
# @!attribute [rw] delivery_address
|
327
|
+
# The details that Incident Manager uses when trying to engage the
|
328
|
+
# contact channel. The format is dependent on the type of the contact
|
329
|
+
# channel. The following are the expected formats:
|
330
|
+
#
|
331
|
+
# * SMS - '+' followed by the country code and phone number
|
332
|
+
#
|
333
|
+
# * VOICE - '+' followed by the country code and phone number
|
334
|
+
#
|
335
|
+
# * EMAIL - any standard email format
|
336
|
+
# @return [Types::ContactChannelAddress]
|
337
|
+
#
|
338
|
+
# @!attribute [rw] defer_activation
|
339
|
+
# If you want to activate the channel at a later time, you can choose
|
340
|
+
# to defer activation. Incident Manager can't engage your contact
|
341
|
+
# channel until it has been activated.
|
342
|
+
# @return [Boolean]
|
343
|
+
#
|
344
|
+
# @!attribute [rw] idempotency_token
|
345
|
+
# A token ensuring that the action is called only once with the
|
346
|
+
# specified details.
|
347
|
+
#
|
348
|
+
# **A suitable default value is auto-generated.** You should normally
|
349
|
+
# not need to pass this option.
|
350
|
+
# @return [String]
|
351
|
+
#
|
352
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/CreateContactChannelRequest AWS API Documentation
|
353
|
+
#
|
354
|
+
class CreateContactChannelRequest < Struct.new(
|
355
|
+
:contact_id,
|
356
|
+
:name,
|
357
|
+
:type,
|
358
|
+
:delivery_address,
|
359
|
+
:defer_activation,
|
360
|
+
:idempotency_token)
|
361
|
+
SENSITIVE = []
|
362
|
+
include Aws::Structure
|
363
|
+
end
|
364
|
+
|
365
|
+
# @!attribute [rw] contact_channel_arn
|
366
|
+
# The ARN of the contact channel.
|
367
|
+
# @return [String]
|
368
|
+
#
|
369
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/CreateContactChannelResult AWS API Documentation
|
370
|
+
#
|
371
|
+
class CreateContactChannelResult < Struct.new(
|
372
|
+
:contact_channel_arn)
|
373
|
+
SENSITIVE = []
|
374
|
+
include Aws::Structure
|
375
|
+
end
|
376
|
+
|
377
|
+
# @note When making an API call, you may pass CreateContactRequest
|
378
|
+
# data as a hash:
|
379
|
+
#
|
380
|
+
# {
|
381
|
+
# alias: "ContactAlias", # required
|
382
|
+
# display_name: "ContactName",
|
383
|
+
# type: "PERSONAL", # required, accepts PERSONAL, ESCALATION
|
384
|
+
# plan: { # required
|
385
|
+
# stages: [ # required
|
386
|
+
# {
|
387
|
+
# duration_in_minutes: 1, # required
|
388
|
+
# targets: [ # required
|
389
|
+
# {
|
390
|
+
# channel_target_info: {
|
391
|
+
# contact_channel_id: "SsmContactsArn", # required
|
392
|
+
# retry_interval_in_minutes: 1,
|
393
|
+
# },
|
394
|
+
# contact_target_info: {
|
395
|
+
# contact_id: "SsmContactsArn",
|
396
|
+
# is_essential: false, # required
|
397
|
+
# },
|
398
|
+
# },
|
399
|
+
# ],
|
400
|
+
# },
|
401
|
+
# ],
|
402
|
+
# },
|
403
|
+
# tags: [
|
404
|
+
# {
|
405
|
+
# key: "TagKey",
|
406
|
+
# value: "TagValue",
|
407
|
+
# },
|
408
|
+
# ],
|
409
|
+
# idempotency_token: "IdempotencyToken",
|
410
|
+
# }
|
411
|
+
#
|
412
|
+
# @!attribute [rw] alias
|
413
|
+
# The short name to quickly identify a contact or escalation plan. The
|
414
|
+
# contact alias must be unique and identifiable.
|
415
|
+
# @return [String]
|
416
|
+
#
|
417
|
+
# @!attribute [rw] display_name
|
418
|
+
# The full name of the contact or escalation plan.
|
419
|
+
# @return [String]
|
420
|
+
#
|
421
|
+
# @!attribute [rw] type
|
422
|
+
# To create an escalation plan use `ESCALATION`. To create a contact
|
423
|
+
# use `PERSONAL`.
|
424
|
+
# @return [String]
|
425
|
+
#
|
426
|
+
# @!attribute [rw] plan
|
427
|
+
# A list of stages. A contact has an engagement plan with stages that
|
428
|
+
# contact specified contact channels. An escalation plan uses stages
|
429
|
+
# that contact specified contacts.
|
430
|
+
# @return [Types::Plan]
|
431
|
+
#
|
432
|
+
# @!attribute [rw] tags
|
433
|
+
# Adds a tag to the target. You can only tag resources created in the
|
434
|
+
# first Region of your replication set.
|
435
|
+
# @return [Array<Types::Tag>]
|
436
|
+
#
|
437
|
+
# @!attribute [rw] idempotency_token
|
438
|
+
# A token ensuring that the action is called only once with the
|
439
|
+
# specified details.
|
440
|
+
#
|
441
|
+
# **A suitable default value is auto-generated.** You should normally
|
442
|
+
# not need to pass this option.
|
443
|
+
# @return [String]
|
444
|
+
#
|
445
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/CreateContactRequest AWS API Documentation
|
446
|
+
#
|
447
|
+
class CreateContactRequest < Struct.new(
|
448
|
+
:alias,
|
449
|
+
:display_name,
|
450
|
+
:type,
|
451
|
+
:plan,
|
452
|
+
:tags,
|
453
|
+
:idempotency_token)
|
454
|
+
SENSITIVE = []
|
455
|
+
include Aws::Structure
|
456
|
+
end
|
457
|
+
|
458
|
+
# @!attribute [rw] contact_arn
|
459
|
+
# The Amazon Resource Name (ARN) of the created contact or escalation
|
460
|
+
# plan.
|
461
|
+
# @return [String]
|
462
|
+
#
|
463
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/CreateContactResult AWS API Documentation
|
464
|
+
#
|
465
|
+
class CreateContactResult < Struct.new(
|
466
|
+
:contact_arn)
|
467
|
+
SENSITIVE = []
|
468
|
+
include Aws::Structure
|
469
|
+
end
|
470
|
+
|
471
|
+
# The action failed to due an encryption key error.
|
472
|
+
#
|
473
|
+
# @!attribute [rw] message
|
474
|
+
# @return [String]
|
475
|
+
#
|
476
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DataEncryptionException AWS API Documentation
|
477
|
+
#
|
478
|
+
class DataEncryptionException < Struct.new(
|
479
|
+
:message)
|
480
|
+
SENSITIVE = []
|
481
|
+
include Aws::Structure
|
482
|
+
end
|
483
|
+
|
484
|
+
# @note When making an API call, you may pass DeactivateContactChannelRequest
|
485
|
+
# data as a hash:
|
486
|
+
#
|
487
|
+
# {
|
488
|
+
# contact_channel_id: "SsmContactsArn", # required
|
489
|
+
# }
|
490
|
+
#
|
491
|
+
# @!attribute [rw] contact_channel_id
|
492
|
+
# The Amazon Resource Name (ARN) of the contact channel you're
|
493
|
+
# deactivating.
|
494
|
+
# @return [String]
|
495
|
+
#
|
496
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DeactivateContactChannelRequest AWS API Documentation
|
497
|
+
#
|
498
|
+
class DeactivateContactChannelRequest < Struct.new(
|
499
|
+
:contact_channel_id)
|
500
|
+
SENSITIVE = []
|
501
|
+
include Aws::Structure
|
502
|
+
end
|
503
|
+
|
504
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DeactivateContactChannelResult AWS API Documentation
|
505
|
+
#
|
506
|
+
class DeactivateContactChannelResult < Aws::EmptyStructure; end
|
507
|
+
|
508
|
+
# @note When making an API call, you may pass DeleteContactChannelRequest
|
509
|
+
# data as a hash:
|
510
|
+
#
|
511
|
+
# {
|
512
|
+
# contact_channel_id: "SsmContactsArn", # required
|
513
|
+
# }
|
514
|
+
#
|
515
|
+
# @!attribute [rw] contact_channel_id
|
516
|
+
# The Amazon Resource Name (ARN) of the contact channel.
|
517
|
+
# @return [String]
|
518
|
+
#
|
519
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DeleteContactChannelRequest AWS API Documentation
|
520
|
+
#
|
521
|
+
class DeleteContactChannelRequest < Struct.new(
|
522
|
+
:contact_channel_id)
|
523
|
+
SENSITIVE = []
|
524
|
+
include Aws::Structure
|
525
|
+
end
|
526
|
+
|
527
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DeleteContactChannelResult AWS API Documentation
|
528
|
+
#
|
529
|
+
class DeleteContactChannelResult < Aws::EmptyStructure; end
|
530
|
+
|
531
|
+
# @note When making an API call, you may pass DeleteContactRequest
|
532
|
+
# data as a hash:
|
533
|
+
#
|
534
|
+
# {
|
535
|
+
# contact_id: "SsmContactsArn", # required
|
536
|
+
# }
|
537
|
+
#
|
538
|
+
# @!attribute [rw] contact_id
|
539
|
+
# The Amazon Resource Name (ARN) of the contact that you're deleting.
|
540
|
+
# @return [String]
|
541
|
+
#
|
542
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DeleteContactRequest AWS API Documentation
|
543
|
+
#
|
544
|
+
class DeleteContactRequest < Struct.new(
|
545
|
+
:contact_id)
|
546
|
+
SENSITIVE = []
|
547
|
+
include Aws::Structure
|
548
|
+
end
|
549
|
+
|
550
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DeleteContactResult AWS API Documentation
|
551
|
+
#
|
552
|
+
class DeleteContactResult < Aws::EmptyStructure; end
|
553
|
+
|
554
|
+
# @note When making an API call, you may pass DescribeEngagementRequest
|
555
|
+
# data as a hash:
|
556
|
+
#
|
557
|
+
# {
|
558
|
+
# engagement_id: "SsmContactsArn", # required
|
559
|
+
# }
|
560
|
+
#
|
561
|
+
# @!attribute [rw] engagement_id
|
562
|
+
# The Amazon Resource Name (ARN) of the engagement you want the
|
563
|
+
# details of.
|
564
|
+
# @return [String]
|
565
|
+
#
|
566
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DescribeEngagementRequest AWS API Documentation
|
567
|
+
#
|
568
|
+
class DescribeEngagementRequest < Struct.new(
|
569
|
+
:engagement_id)
|
570
|
+
SENSITIVE = []
|
571
|
+
include Aws::Structure
|
572
|
+
end
|
573
|
+
|
574
|
+
# @!attribute [rw] contact_arn
|
575
|
+
# The ARN of the escalation plan or contacts involved in the
|
576
|
+
# engagement.
|
577
|
+
# @return [String]
|
578
|
+
#
|
579
|
+
# @!attribute [rw] engagement_arn
|
580
|
+
# The ARN of the engagement.
|
581
|
+
# @return [String]
|
582
|
+
#
|
583
|
+
# @!attribute [rw] sender
|
584
|
+
# The user that started the engagement.
|
585
|
+
# @return [String]
|
586
|
+
#
|
587
|
+
# @!attribute [rw] subject
|
588
|
+
# The secure subject of the message that was sent to the contact. Use
|
589
|
+
# this field for engagements to `VOICE` and `EMAIL`.
|
590
|
+
# @return [String]
|
591
|
+
#
|
592
|
+
# @!attribute [rw] content
|
593
|
+
# The secure content of the message that was sent to the contact. Use
|
594
|
+
# this field for engagements to `VOICE` and `EMAIL`.
|
595
|
+
# @return [String]
|
596
|
+
#
|
597
|
+
# @!attribute [rw] public_subject
|
598
|
+
# The insecure subject of the message that was sent to the contact.
|
599
|
+
# Use this field for engagements to `SMS`.
|
600
|
+
# @return [String]
|
601
|
+
#
|
602
|
+
# @!attribute [rw] public_content
|
603
|
+
# The insecure content of the message that was sent to the contact.
|
604
|
+
# Use this field for engagements to `SMS`.
|
605
|
+
# @return [String]
|
606
|
+
#
|
607
|
+
# @!attribute [rw] incident_id
|
608
|
+
# The ARN of the incident in which the engagement occurred.
|
609
|
+
# @return [String]
|
610
|
+
#
|
611
|
+
# @!attribute [rw] start_time
|
612
|
+
# The time that the engagement started.
|
613
|
+
# @return [Time]
|
614
|
+
#
|
615
|
+
# @!attribute [rw] stop_time
|
616
|
+
# The time that the engagement ended.
|
617
|
+
# @return [Time]
|
618
|
+
#
|
619
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DescribeEngagementResult AWS API Documentation
|
620
|
+
#
|
621
|
+
class DescribeEngagementResult < Struct.new(
|
622
|
+
:contact_arn,
|
623
|
+
:engagement_arn,
|
624
|
+
:sender,
|
625
|
+
:subject,
|
626
|
+
:content,
|
627
|
+
:public_subject,
|
628
|
+
:public_content,
|
629
|
+
:incident_id,
|
630
|
+
:start_time,
|
631
|
+
:stop_time)
|
632
|
+
SENSITIVE = []
|
633
|
+
include Aws::Structure
|
634
|
+
end
|
635
|
+
|
636
|
+
# @note When making an API call, you may pass DescribePageRequest
|
637
|
+
# data as a hash:
|
638
|
+
#
|
639
|
+
# {
|
640
|
+
# page_id: "SsmContactsArn", # required
|
641
|
+
# }
|
642
|
+
#
|
643
|
+
# @!attribute [rw] page_id
|
644
|
+
# The ID of the engagement to a contact channel.
|
645
|
+
# @return [String]
|
646
|
+
#
|
647
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DescribePageRequest AWS API Documentation
|
648
|
+
#
|
649
|
+
class DescribePageRequest < Struct.new(
|
650
|
+
:page_id)
|
651
|
+
SENSITIVE = []
|
652
|
+
include Aws::Structure
|
653
|
+
end
|
654
|
+
|
655
|
+
# @!attribute [rw] page_arn
|
656
|
+
# The Amazon Resource Name (ARN) of the engagement to a contact
|
657
|
+
# channel.
|
658
|
+
# @return [String]
|
659
|
+
#
|
660
|
+
# @!attribute [rw] engagement_arn
|
661
|
+
# The ARN of the engagement that engaged the contact channel.
|
662
|
+
# @return [String]
|
663
|
+
#
|
664
|
+
# @!attribute [rw] contact_arn
|
665
|
+
# The ARN of the contact that was engaged.
|
666
|
+
# @return [String]
|
667
|
+
#
|
668
|
+
# @!attribute [rw] sender
|
669
|
+
# The user that started the engagement.
|
670
|
+
# @return [String]
|
671
|
+
#
|
672
|
+
# @!attribute [rw] subject
|
673
|
+
# The secure subject of the message that was sent to the contact. Use
|
674
|
+
# this field for engagements to `VOICE` and `EMAIL`.
|
675
|
+
# @return [String]
|
676
|
+
#
|
677
|
+
# @!attribute [rw] content
|
678
|
+
# The secure content of the message that was sent to the contact. Use
|
679
|
+
# this field for engagements to `VOICE` and `EMAIL`.
|
680
|
+
# @return [String]
|
681
|
+
#
|
682
|
+
# @!attribute [rw] public_subject
|
683
|
+
# The insecure subject of the message that was sent to the contact.
|
684
|
+
# Use this field for engagements to `SMS`.
|
685
|
+
# @return [String]
|
686
|
+
#
|
687
|
+
# @!attribute [rw] public_content
|
688
|
+
# The insecure content of the message that was sent to the contact.
|
689
|
+
# Use this field for engagements to `SMS`.
|
690
|
+
# @return [String]
|
691
|
+
#
|
692
|
+
# @!attribute [rw] incident_id
|
693
|
+
# The ARN of the incident that engaged the contact channel.
|
694
|
+
# @return [String]
|
695
|
+
#
|
696
|
+
# @!attribute [rw] sent_time
|
697
|
+
# The time the engagement was sent to the contact channel.
|
698
|
+
# @return [Time]
|
699
|
+
#
|
700
|
+
# @!attribute [rw] read_time
|
701
|
+
# The time that the contact channel acknowledged the engagement.
|
702
|
+
# @return [Time]
|
703
|
+
#
|
704
|
+
# @!attribute [rw] delivery_time
|
705
|
+
# The time that the contact channel received the engagement.
|
706
|
+
# @return [Time]
|
707
|
+
#
|
708
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DescribePageResult AWS API Documentation
|
709
|
+
#
|
710
|
+
class DescribePageResult < Struct.new(
|
711
|
+
:page_arn,
|
712
|
+
:engagement_arn,
|
713
|
+
:contact_arn,
|
714
|
+
:sender,
|
715
|
+
:subject,
|
716
|
+
:content,
|
717
|
+
:public_subject,
|
718
|
+
:public_content,
|
719
|
+
:incident_id,
|
720
|
+
:sent_time,
|
721
|
+
:read_time,
|
722
|
+
:delivery_time)
|
723
|
+
SENSITIVE = []
|
724
|
+
include Aws::Structure
|
725
|
+
end
|
726
|
+
|
727
|
+
# Incident Manager reaching out to a contact or escalation plan to
|
728
|
+
# engage contact during an incident.
|
729
|
+
#
|
730
|
+
# @!attribute [rw] engagement_arn
|
731
|
+
# The Amazon Resource Name (ARN) of the engagement.
|
732
|
+
# @return [String]
|
733
|
+
#
|
734
|
+
# @!attribute [rw] contact_arn
|
735
|
+
# The ARN of the escalation plan or contact that Incident Manager is
|
736
|
+
# engaging.
|
737
|
+
# @return [String]
|
738
|
+
#
|
739
|
+
# @!attribute [rw] sender
|
740
|
+
# The user that started the engagement.
|
741
|
+
# @return [String]
|
742
|
+
#
|
743
|
+
# @!attribute [rw] incident_id
|
744
|
+
# The ARN of the incident that's engaging the contact.
|
745
|
+
# @return [String]
|
746
|
+
#
|
747
|
+
# @!attribute [rw] start_time
|
748
|
+
# The time that the engagement began.
|
749
|
+
# @return [Time]
|
750
|
+
#
|
751
|
+
# @!attribute [rw] stop_time
|
752
|
+
# The time that the engagement ended.
|
753
|
+
# @return [Time]
|
754
|
+
#
|
755
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/Engagement AWS API Documentation
|
756
|
+
#
|
757
|
+
class Engagement < Struct.new(
|
758
|
+
:engagement_arn,
|
759
|
+
:contact_arn,
|
760
|
+
:sender,
|
761
|
+
:incident_id,
|
762
|
+
:start_time,
|
763
|
+
:stop_time)
|
764
|
+
SENSITIVE = []
|
765
|
+
include Aws::Structure
|
766
|
+
end
|
767
|
+
|
768
|
+
# @note When making an API call, you may pass GetContactChannelRequest
|
769
|
+
# data as a hash:
|
770
|
+
#
|
771
|
+
# {
|
772
|
+
# contact_channel_id: "SsmContactsArn", # required
|
773
|
+
# }
|
774
|
+
#
|
775
|
+
# @!attribute [rw] contact_channel_id
|
776
|
+
# The Amazon Resource Name (ARN) of the contact channel you want
|
777
|
+
# information about.
|
778
|
+
# @return [String]
|
779
|
+
#
|
780
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/GetContactChannelRequest AWS API Documentation
|
781
|
+
#
|
782
|
+
class GetContactChannelRequest < Struct.new(
|
783
|
+
:contact_channel_id)
|
784
|
+
SENSITIVE = []
|
785
|
+
include Aws::Structure
|
786
|
+
end
|
787
|
+
|
788
|
+
# @!attribute [rw] contact_arn
|
789
|
+
# The ARN of the contact that the channel belongs to.
|
790
|
+
# @return [String]
|
791
|
+
#
|
792
|
+
# @!attribute [rw] contact_channel_arn
|
793
|
+
# The ARN of the contact channel.
|
794
|
+
# @return [String]
|
795
|
+
#
|
796
|
+
# @!attribute [rw] name
|
797
|
+
# The name of the contact channel
|
798
|
+
# @return [String]
|
799
|
+
#
|
800
|
+
# @!attribute [rw] type
|
801
|
+
# The type of contact channel. The type is `SMS`, `VOICE`, or `EMAIL`.
|
802
|
+
# @return [String]
|
803
|
+
#
|
804
|
+
# @!attribute [rw] delivery_address
|
805
|
+
# The details that Incident Manager uses when trying to engage the
|
806
|
+
# contact channel.
|
807
|
+
# @return [Types::ContactChannelAddress]
|
808
|
+
#
|
809
|
+
# @!attribute [rw] activation_status
|
810
|
+
# A Boolean value indicating if the contact channel has been activated
|
811
|
+
# or not.
|
812
|
+
# @return [String]
|
813
|
+
#
|
814
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/GetContactChannelResult AWS API Documentation
|
815
|
+
#
|
816
|
+
class GetContactChannelResult < Struct.new(
|
817
|
+
:contact_arn,
|
818
|
+
:contact_channel_arn,
|
819
|
+
:name,
|
820
|
+
:type,
|
821
|
+
:delivery_address,
|
822
|
+
:activation_status)
|
823
|
+
SENSITIVE = []
|
824
|
+
include Aws::Structure
|
825
|
+
end
|
826
|
+
|
827
|
+
# @note When making an API call, you may pass GetContactPolicyRequest
|
828
|
+
# data as a hash:
|
829
|
+
#
|
830
|
+
# {
|
831
|
+
# contact_arn: "SsmContactsArn", # required
|
832
|
+
# }
|
833
|
+
#
|
834
|
+
# @!attribute [rw] contact_arn
|
835
|
+
# The Amazon Resource Name (ARN) of the contact or escalation plan.
|
836
|
+
# @return [String]
|
837
|
+
#
|
838
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/GetContactPolicyRequest AWS API Documentation
|
839
|
+
#
|
840
|
+
class GetContactPolicyRequest < Struct.new(
|
841
|
+
:contact_arn)
|
842
|
+
SENSITIVE = []
|
843
|
+
include Aws::Structure
|
844
|
+
end
|
845
|
+
|
846
|
+
# @!attribute [rw] contact_arn
|
847
|
+
# The ARN of the contact or escalation plan.
|
848
|
+
# @return [String]
|
849
|
+
#
|
850
|
+
# @!attribute [rw] policy
|
851
|
+
# Details about the resource policy attached to the contact or
|
852
|
+
# escalation plan.
|
853
|
+
# @return [String]
|
854
|
+
#
|
855
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/GetContactPolicyResult AWS API Documentation
|
856
|
+
#
|
857
|
+
class GetContactPolicyResult < Struct.new(
|
858
|
+
:contact_arn,
|
859
|
+
:policy)
|
860
|
+
SENSITIVE = []
|
861
|
+
include Aws::Structure
|
862
|
+
end
|
863
|
+
|
864
|
+
# @note When making an API call, you may pass GetContactRequest
|
865
|
+
# data as a hash:
|
866
|
+
#
|
867
|
+
# {
|
868
|
+
# contact_id: "SsmContactsArn", # required
|
869
|
+
# }
|
870
|
+
#
|
871
|
+
# @!attribute [rw] contact_id
|
872
|
+
# The Amazon Resource Name (ARN) of the contact or escalation plan.
|
873
|
+
# @return [String]
|
874
|
+
#
|
875
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/GetContactRequest AWS API Documentation
|
876
|
+
#
|
877
|
+
class GetContactRequest < Struct.new(
|
878
|
+
:contact_id)
|
879
|
+
SENSITIVE = []
|
880
|
+
include Aws::Structure
|
881
|
+
end
|
882
|
+
|
883
|
+
# @!attribute [rw] contact_arn
|
884
|
+
# The ARN of the contact or escalation plan.
|
885
|
+
# @return [String]
|
886
|
+
#
|
887
|
+
# @!attribute [rw] alias
|
888
|
+
# The alias of the contact or escalation plan. The alias is unique and
|
889
|
+
# identifiable.
|
890
|
+
# @return [String]
|
891
|
+
#
|
892
|
+
# @!attribute [rw] display_name
|
893
|
+
# The full name of the contact or escalation plan.
|
894
|
+
# @return [String]
|
895
|
+
#
|
896
|
+
# @!attribute [rw] type
|
897
|
+
# The type of contact, either `PERSONAL` or `ESCALATION`.
|
898
|
+
# @return [String]
|
899
|
+
#
|
900
|
+
# @!attribute [rw] plan
|
901
|
+
# Details about the specific timing or stages and targets of the
|
902
|
+
# escalation plan or engagement plan.
|
903
|
+
# @return [Types::Plan]
|
904
|
+
#
|
905
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/GetContactResult AWS API Documentation
|
906
|
+
#
|
907
|
+
class GetContactResult < Struct.new(
|
908
|
+
:contact_arn,
|
909
|
+
:alias,
|
910
|
+
:display_name,
|
911
|
+
:type,
|
912
|
+
:plan)
|
913
|
+
SENSITIVE = []
|
914
|
+
include Aws::Structure
|
915
|
+
end
|
916
|
+
|
917
|
+
# Unexpected error occurred while processing the request.
|
918
|
+
#
|
919
|
+
# @!attribute [rw] message
|
920
|
+
# @return [String]
|
921
|
+
#
|
922
|
+
# @!attribute [rw] retry_after_seconds
|
923
|
+
# Advice to clients on when the call can be safely retried
|
924
|
+
# @return [Integer]
|
925
|
+
#
|
926
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/InternalServerException AWS API Documentation
|
927
|
+
#
|
928
|
+
class InternalServerException < Struct.new(
|
929
|
+
:message,
|
930
|
+
:retry_after_seconds)
|
931
|
+
SENSITIVE = []
|
932
|
+
include Aws::Structure
|
933
|
+
end
|
934
|
+
|
935
|
+
# @note When making an API call, you may pass ListContactChannelsRequest
|
936
|
+
# data as a hash:
|
937
|
+
#
|
938
|
+
# {
|
939
|
+
# contact_id: "SsmContactsArn", # required
|
940
|
+
# next_token: "PaginationToken",
|
941
|
+
# max_results: 1,
|
942
|
+
# }
|
943
|
+
#
|
944
|
+
# @!attribute [rw] contact_id
|
945
|
+
# The Amazon Resource Name (ARN) of the contact.
|
946
|
+
# @return [String]
|
947
|
+
#
|
948
|
+
# @!attribute [rw] next_token
|
949
|
+
# The pagination token to continue to the next page of results.
|
950
|
+
# @return [String]
|
951
|
+
#
|
952
|
+
# @!attribute [rw] max_results
|
953
|
+
# The maximum number of contact channels per page.
|
954
|
+
# @return [Integer]
|
955
|
+
#
|
956
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListContactChannelsRequest AWS API Documentation
|
957
|
+
#
|
958
|
+
class ListContactChannelsRequest < Struct.new(
|
959
|
+
:contact_id,
|
960
|
+
:next_token,
|
961
|
+
:max_results)
|
962
|
+
SENSITIVE = []
|
963
|
+
include Aws::Structure
|
964
|
+
end
|
965
|
+
|
966
|
+
# @!attribute [rw] next_token
|
967
|
+
# The pagination token to continue to the next page of results.
|
968
|
+
# @return [String]
|
969
|
+
#
|
970
|
+
# @!attribute [rw] contact_channels
|
971
|
+
# A list of contact channels related to the specified contact.
|
972
|
+
# @return [Array<Types::ContactChannel>]
|
973
|
+
#
|
974
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListContactChannelsResult AWS API Documentation
|
975
|
+
#
|
976
|
+
class ListContactChannelsResult < Struct.new(
|
977
|
+
:next_token,
|
978
|
+
:contact_channels)
|
979
|
+
SENSITIVE = []
|
980
|
+
include Aws::Structure
|
981
|
+
end
|
982
|
+
|
983
|
+
# @note When making an API call, you may pass ListContactsRequest
|
984
|
+
# data as a hash:
|
985
|
+
#
|
986
|
+
# {
|
987
|
+
# next_token: "PaginationToken",
|
988
|
+
# max_results: 1,
|
989
|
+
# alias_prefix: "ContactAlias",
|
990
|
+
# type: "PERSONAL", # accepts PERSONAL, ESCALATION
|
991
|
+
# }
|
992
|
+
#
|
993
|
+
# @!attribute [rw] next_token
|
994
|
+
# The pagination token to continue to the next page of results.
|
995
|
+
# @return [String]
|
996
|
+
#
|
997
|
+
# @!attribute [rw] max_results
|
998
|
+
# The maximum number of contacts and escalation plans per page of
|
999
|
+
# results.
|
1000
|
+
# @return [Integer]
|
1001
|
+
#
|
1002
|
+
# @!attribute [rw] alias_prefix
|
1003
|
+
# Used to list only contacts who's aliases start with the specified
|
1004
|
+
# prefix.
|
1005
|
+
# @return [String]
|
1006
|
+
#
|
1007
|
+
# @!attribute [rw] type
|
1008
|
+
# The type of contact. A contact is type `PERSONAL` and an escalation
|
1009
|
+
# plan is type `ESCALATION`.
|
1010
|
+
# @return [String]
|
1011
|
+
#
|
1012
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListContactsRequest AWS API Documentation
|
1013
|
+
#
|
1014
|
+
class ListContactsRequest < Struct.new(
|
1015
|
+
:next_token,
|
1016
|
+
:max_results,
|
1017
|
+
:alias_prefix,
|
1018
|
+
:type)
|
1019
|
+
SENSITIVE = []
|
1020
|
+
include Aws::Structure
|
1021
|
+
end
|
1022
|
+
|
1023
|
+
# @!attribute [rw] next_token
|
1024
|
+
# The pagination token to continue to the next page of results.
|
1025
|
+
# @return [String]
|
1026
|
+
#
|
1027
|
+
# @!attribute [rw] contacts
|
1028
|
+
# A list of the contacts and escalation plans in your Incident Manager
|
1029
|
+
# account.
|
1030
|
+
# @return [Array<Types::Contact>]
|
1031
|
+
#
|
1032
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListContactsResult AWS API Documentation
|
1033
|
+
#
|
1034
|
+
class ListContactsResult < Struct.new(
|
1035
|
+
:next_token,
|
1036
|
+
:contacts)
|
1037
|
+
SENSITIVE = []
|
1038
|
+
include Aws::Structure
|
1039
|
+
end
|
1040
|
+
|
1041
|
+
# @note When making an API call, you may pass ListEngagementsRequest
|
1042
|
+
# data as a hash:
|
1043
|
+
#
|
1044
|
+
# {
|
1045
|
+
# next_token: "PaginationToken",
|
1046
|
+
# max_results: 1,
|
1047
|
+
# incident_id: "IncidentId",
|
1048
|
+
# time_range_value: {
|
1049
|
+
# start_time: Time.now,
|
1050
|
+
# end_time: Time.now,
|
1051
|
+
# },
|
1052
|
+
# }
|
1053
|
+
#
|
1054
|
+
# @!attribute [rw] next_token
|
1055
|
+
# The pagination token to continue to the next page of results.
|
1056
|
+
# @return [String]
|
1057
|
+
#
|
1058
|
+
# @!attribute [rw] max_results
|
1059
|
+
# The maximum number of engagements per page of results.
|
1060
|
+
# @return [Integer]
|
1061
|
+
#
|
1062
|
+
# @!attribute [rw] incident_id
|
1063
|
+
# The Amazon Resource Name (ARN) of the incident you're listing
|
1064
|
+
# engagements for.
|
1065
|
+
# @return [String]
|
1066
|
+
#
|
1067
|
+
# @!attribute [rw] time_range_value
|
1068
|
+
# The time range to lists engagements for an incident.
|
1069
|
+
# @return [Types::TimeRange]
|
1070
|
+
#
|
1071
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListEngagementsRequest AWS API Documentation
|
1072
|
+
#
|
1073
|
+
class ListEngagementsRequest < Struct.new(
|
1074
|
+
:next_token,
|
1075
|
+
:max_results,
|
1076
|
+
:incident_id,
|
1077
|
+
:time_range_value)
|
1078
|
+
SENSITIVE = []
|
1079
|
+
include Aws::Structure
|
1080
|
+
end
|
1081
|
+
|
1082
|
+
# @!attribute [rw] next_token
|
1083
|
+
# The pagination token to continue to the next page of results.
|
1084
|
+
# @return [String]
|
1085
|
+
#
|
1086
|
+
# @!attribute [rw] engagements
|
1087
|
+
# A list of each engagement that occurred during the specified time
|
1088
|
+
# range of an incident.
|
1089
|
+
# @return [Array<Types::Engagement>]
|
1090
|
+
#
|
1091
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListEngagementsResult AWS API Documentation
|
1092
|
+
#
|
1093
|
+
class ListEngagementsResult < Struct.new(
|
1094
|
+
:next_token,
|
1095
|
+
:engagements)
|
1096
|
+
SENSITIVE = []
|
1097
|
+
include Aws::Structure
|
1098
|
+
end
|
1099
|
+
|
1100
|
+
# @note When making an API call, you may pass ListPageReceiptsRequest
|
1101
|
+
# data as a hash:
|
1102
|
+
#
|
1103
|
+
# {
|
1104
|
+
# page_id: "SsmContactsArn", # required
|
1105
|
+
# next_token: "PaginationToken",
|
1106
|
+
# max_results: 1,
|
1107
|
+
# }
|
1108
|
+
#
|
1109
|
+
# @!attribute [rw] page_id
|
1110
|
+
# The Amazon Resource Name (ARN) of the engagement to a specific
|
1111
|
+
# contact channel.
|
1112
|
+
# @return [String]
|
1113
|
+
#
|
1114
|
+
# @!attribute [rw] next_token
|
1115
|
+
# The pagination token to continue to the next page of results.
|
1116
|
+
# @return [String]
|
1117
|
+
#
|
1118
|
+
# @!attribute [rw] max_results
|
1119
|
+
# The maximum number of acknowledgements per page of results.
|
1120
|
+
# @return [Integer]
|
1121
|
+
#
|
1122
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListPageReceiptsRequest AWS API Documentation
|
1123
|
+
#
|
1124
|
+
class ListPageReceiptsRequest < Struct.new(
|
1125
|
+
:page_id,
|
1126
|
+
:next_token,
|
1127
|
+
:max_results)
|
1128
|
+
SENSITIVE = []
|
1129
|
+
include Aws::Structure
|
1130
|
+
end
|
1131
|
+
|
1132
|
+
# @!attribute [rw] next_token
|
1133
|
+
# The pagination token to continue to the next page of results.
|
1134
|
+
# @return [String]
|
1135
|
+
#
|
1136
|
+
# @!attribute [rw] receipts
|
1137
|
+
# A list of each acknowledgement.
|
1138
|
+
# @return [Array<Types::Receipt>]
|
1139
|
+
#
|
1140
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListPageReceiptsResult AWS API Documentation
|
1141
|
+
#
|
1142
|
+
class ListPageReceiptsResult < Struct.new(
|
1143
|
+
:next_token,
|
1144
|
+
:receipts)
|
1145
|
+
SENSITIVE = []
|
1146
|
+
include Aws::Structure
|
1147
|
+
end
|
1148
|
+
|
1149
|
+
# @note When making an API call, you may pass ListPagesByContactRequest
|
1150
|
+
# data as a hash:
|
1151
|
+
#
|
1152
|
+
# {
|
1153
|
+
# contact_id: "SsmContactsArn", # required
|
1154
|
+
# next_token: "PaginationToken",
|
1155
|
+
# max_results: 1,
|
1156
|
+
# }
|
1157
|
+
#
|
1158
|
+
# @!attribute [rw] contact_id
|
1159
|
+
# The Amazon Resource Name (ARN) of the contact you are retrieving
|
1160
|
+
# engagements for.
|
1161
|
+
# @return [String]
|
1162
|
+
#
|
1163
|
+
# @!attribute [rw] next_token
|
1164
|
+
# The pagination token to continue to the next page of results.
|
1165
|
+
# @return [String]
|
1166
|
+
#
|
1167
|
+
# @!attribute [rw] max_results
|
1168
|
+
# The maximum number of engagements to contact channels to list per
|
1169
|
+
# page of results.
|
1170
|
+
# @return [Integer]
|
1171
|
+
#
|
1172
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListPagesByContactRequest AWS API Documentation
|
1173
|
+
#
|
1174
|
+
class ListPagesByContactRequest < Struct.new(
|
1175
|
+
:contact_id,
|
1176
|
+
:next_token,
|
1177
|
+
:max_results)
|
1178
|
+
SENSITIVE = []
|
1179
|
+
include Aws::Structure
|
1180
|
+
end
|
1181
|
+
|
1182
|
+
# @!attribute [rw] next_token
|
1183
|
+
# The pagination token to continue to the next page of results.
|
1184
|
+
# @return [String]
|
1185
|
+
#
|
1186
|
+
# @!attribute [rw] pages
|
1187
|
+
# The list of engagements to a contact's contact channel.
|
1188
|
+
# @return [Array<Types::Page>]
|
1189
|
+
#
|
1190
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListPagesByContactResult AWS API Documentation
|
1191
|
+
#
|
1192
|
+
class ListPagesByContactResult < Struct.new(
|
1193
|
+
:next_token,
|
1194
|
+
:pages)
|
1195
|
+
SENSITIVE = []
|
1196
|
+
include Aws::Structure
|
1197
|
+
end
|
1198
|
+
|
1199
|
+
# @note When making an API call, you may pass ListPagesByEngagementRequest
|
1200
|
+
# data as a hash:
|
1201
|
+
#
|
1202
|
+
# {
|
1203
|
+
# engagement_id: "SsmContactsArn", # required
|
1204
|
+
# next_token: "PaginationToken",
|
1205
|
+
# max_results: 1,
|
1206
|
+
# }
|
1207
|
+
#
|
1208
|
+
# @!attribute [rw] engagement_id
|
1209
|
+
# The Amazon Resource Name (ARN) of the engagement.
|
1210
|
+
# @return [String]
|
1211
|
+
#
|
1212
|
+
# @!attribute [rw] next_token
|
1213
|
+
# The pagination token to continue to the next page of results.
|
1214
|
+
# @return [String]
|
1215
|
+
#
|
1216
|
+
# @!attribute [rw] max_results
|
1217
|
+
# The maximum number of engagements to contact channels to list per
|
1218
|
+
# page of results.
|
1219
|
+
# @return [Integer]
|
1220
|
+
#
|
1221
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListPagesByEngagementRequest AWS API Documentation
|
1222
|
+
#
|
1223
|
+
class ListPagesByEngagementRequest < Struct.new(
|
1224
|
+
:engagement_id,
|
1225
|
+
:next_token,
|
1226
|
+
:max_results)
|
1227
|
+
SENSITIVE = []
|
1228
|
+
include Aws::Structure
|
1229
|
+
end
|
1230
|
+
|
1231
|
+
# @!attribute [rw] next_token
|
1232
|
+
# The pagination token to continue to the next page of results.
|
1233
|
+
# @return [String]
|
1234
|
+
#
|
1235
|
+
# @!attribute [rw] pages
|
1236
|
+
# The list of engagements to contact channels.
|
1237
|
+
# @return [Array<Types::Page>]
|
1238
|
+
#
|
1239
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListPagesByEngagementResult AWS API Documentation
|
1240
|
+
#
|
1241
|
+
class ListPagesByEngagementResult < Struct.new(
|
1242
|
+
:next_token,
|
1243
|
+
:pages)
|
1244
|
+
SENSITIVE = []
|
1245
|
+
include Aws::Structure
|
1246
|
+
end
|
1247
|
+
|
1248
|
+
# @note When making an API call, you may pass ListTagsForResourceRequest
|
1249
|
+
# data as a hash:
|
1250
|
+
#
|
1251
|
+
# {
|
1252
|
+
# resource_arn: "AmazonResourceName", # required
|
1253
|
+
# }
|
1254
|
+
#
|
1255
|
+
# @!attribute [rw] resource_arn
|
1256
|
+
# The Amazon Resource Name (ARN) of the contact or escalation plan.
|
1257
|
+
# @return [String]
|
1258
|
+
#
|
1259
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListTagsForResourceRequest AWS API Documentation
|
1260
|
+
#
|
1261
|
+
class ListTagsForResourceRequest < Struct.new(
|
1262
|
+
:resource_arn)
|
1263
|
+
SENSITIVE = []
|
1264
|
+
include Aws::Structure
|
1265
|
+
end
|
1266
|
+
|
1267
|
+
# @!attribute [rw] tags
|
1268
|
+
# The tags related to the contact or escalation plan.
|
1269
|
+
# @return [Array<Types::Tag>]
|
1270
|
+
#
|
1271
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListTagsForResourceResult AWS API Documentation
|
1272
|
+
#
|
1273
|
+
class ListTagsForResourceResult < Struct.new(
|
1274
|
+
:tags)
|
1275
|
+
SENSITIVE = []
|
1276
|
+
include Aws::Structure
|
1277
|
+
end
|
1278
|
+
|
1279
|
+
# Incident Manager engaging a contact's contact channel.
|
1280
|
+
#
|
1281
|
+
# @!attribute [rw] page_arn
|
1282
|
+
# The Amazon Resource Name (ARN) of the page to the contact channel.
|
1283
|
+
# @return [String]
|
1284
|
+
#
|
1285
|
+
# @!attribute [rw] engagement_arn
|
1286
|
+
# The ARN of the engagement that this page is part of.
|
1287
|
+
# @return [String]
|
1288
|
+
#
|
1289
|
+
# @!attribute [rw] contact_arn
|
1290
|
+
# The ARN of the contact that Incident Manager is engaging.
|
1291
|
+
# @return [String]
|
1292
|
+
#
|
1293
|
+
# @!attribute [rw] sender
|
1294
|
+
# The user that started the engagement.
|
1295
|
+
# @return [String]
|
1296
|
+
#
|
1297
|
+
# @!attribute [rw] incident_id
|
1298
|
+
# The ARN of the incident that's engaging the contact channel.
|
1299
|
+
# @return [String]
|
1300
|
+
#
|
1301
|
+
# @!attribute [rw] sent_time
|
1302
|
+
# The time that Incident Manager engaged the contact channel.
|
1303
|
+
# @return [Time]
|
1304
|
+
#
|
1305
|
+
# @!attribute [rw] delivery_time
|
1306
|
+
# The time the message was delivered to the contact channel.
|
1307
|
+
# @return [Time]
|
1308
|
+
#
|
1309
|
+
# @!attribute [rw] read_time
|
1310
|
+
# The time that the contact channel acknowledged engagement.
|
1311
|
+
# @return [Time]
|
1312
|
+
#
|
1313
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/Page AWS API Documentation
|
1314
|
+
#
|
1315
|
+
class Page < Struct.new(
|
1316
|
+
:page_arn,
|
1317
|
+
:engagement_arn,
|
1318
|
+
:contact_arn,
|
1319
|
+
:sender,
|
1320
|
+
:incident_id,
|
1321
|
+
:sent_time,
|
1322
|
+
:delivery_time,
|
1323
|
+
:read_time)
|
1324
|
+
SENSITIVE = []
|
1325
|
+
include Aws::Structure
|
1326
|
+
end
|
1327
|
+
|
1328
|
+
# The stages that an escalation plan or engagement plan engages contacts
|
1329
|
+
# and contact methods in.
|
1330
|
+
#
|
1331
|
+
# @note When making an API call, you may pass Plan
|
1332
|
+
# data as a hash:
|
1333
|
+
#
|
1334
|
+
# {
|
1335
|
+
# stages: [ # required
|
1336
|
+
# {
|
1337
|
+
# duration_in_minutes: 1, # required
|
1338
|
+
# targets: [ # required
|
1339
|
+
# {
|
1340
|
+
# channel_target_info: {
|
1341
|
+
# contact_channel_id: "SsmContactsArn", # required
|
1342
|
+
# retry_interval_in_minutes: 1,
|
1343
|
+
# },
|
1344
|
+
# contact_target_info: {
|
1345
|
+
# contact_id: "SsmContactsArn",
|
1346
|
+
# is_essential: false, # required
|
1347
|
+
# },
|
1348
|
+
# },
|
1349
|
+
# ],
|
1350
|
+
# },
|
1351
|
+
# ],
|
1352
|
+
# }
|
1353
|
+
#
|
1354
|
+
# @!attribute [rw] stages
|
1355
|
+
# A list of stages that the escalation plan or engagement plan uses to
|
1356
|
+
# engage contacts and contact methods.
|
1357
|
+
# @return [Array<Types::Stage>]
|
1358
|
+
#
|
1359
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/Plan AWS API Documentation
|
1360
|
+
#
|
1361
|
+
class Plan < Struct.new(
|
1362
|
+
:stages)
|
1363
|
+
SENSITIVE = []
|
1364
|
+
include Aws::Structure
|
1365
|
+
end
|
1366
|
+
|
1367
|
+
# @note When making an API call, you may pass PutContactPolicyRequest
|
1368
|
+
# data as a hash:
|
1369
|
+
#
|
1370
|
+
# {
|
1371
|
+
# contact_arn: "SsmContactsArn", # required
|
1372
|
+
# policy: "Policy", # required
|
1373
|
+
# }
|
1374
|
+
#
|
1375
|
+
# @!attribute [rw] contact_arn
|
1376
|
+
# The Amazon Resource Name (ARN) of the contact or escalation plan.
|
1377
|
+
# @return [String]
|
1378
|
+
#
|
1379
|
+
# @!attribute [rw] policy
|
1380
|
+
# Details of the resource policy.
|
1381
|
+
# @return [String]
|
1382
|
+
#
|
1383
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/PutContactPolicyRequest AWS API Documentation
|
1384
|
+
#
|
1385
|
+
class PutContactPolicyRequest < Struct.new(
|
1386
|
+
:contact_arn,
|
1387
|
+
:policy)
|
1388
|
+
SENSITIVE = []
|
1389
|
+
include Aws::Structure
|
1390
|
+
end
|
1391
|
+
|
1392
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/PutContactPolicyResult AWS API Documentation
|
1393
|
+
#
|
1394
|
+
class PutContactPolicyResult < Aws::EmptyStructure; end
|
1395
|
+
|
1396
|
+
# Records events during an engagement.
|
1397
|
+
#
|
1398
|
+
# @!attribute [rw] contact_channel_arn
|
1399
|
+
# The Amazon Resource Name (ARN) of the contact channel Incident
|
1400
|
+
# Manager engaged.
|
1401
|
+
# @return [String]
|
1402
|
+
#
|
1403
|
+
# @!attribute [rw] receipt_type
|
1404
|
+
# The type follows the engagement cycle, `SENT`, `DELIVERED`, and
|
1405
|
+
# `READ`.
|
1406
|
+
# @return [String]
|
1407
|
+
#
|
1408
|
+
# @!attribute [rw] receipt_info
|
1409
|
+
# Information provided during the page acknowledgement.
|
1410
|
+
# @return [String]
|
1411
|
+
#
|
1412
|
+
# @!attribute [rw] receipt_time
|
1413
|
+
# The time receipt was `SENT`, `DELIVERED`, or `READ`.
|
1414
|
+
# @return [Time]
|
1415
|
+
#
|
1416
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/Receipt AWS API Documentation
|
1417
|
+
#
|
1418
|
+
class Receipt < Struct.new(
|
1419
|
+
:contact_channel_arn,
|
1420
|
+
:receipt_type,
|
1421
|
+
:receipt_info,
|
1422
|
+
:receipt_time)
|
1423
|
+
SENSITIVE = []
|
1424
|
+
include Aws::Structure
|
1425
|
+
end
|
1426
|
+
|
1427
|
+
# Request references a resource that doesn't exist.
|
1428
|
+
#
|
1429
|
+
# @!attribute [rw] message
|
1430
|
+
# @return [String]
|
1431
|
+
#
|
1432
|
+
# @!attribute [rw] resource_id
|
1433
|
+
# Hypothetical resource identifier that was not found
|
1434
|
+
# @return [String]
|
1435
|
+
#
|
1436
|
+
# @!attribute [rw] resource_type
|
1437
|
+
# Hypothetical resource type that was not found
|
1438
|
+
# @return [String]
|
1439
|
+
#
|
1440
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ResourceNotFoundException AWS API Documentation
|
1441
|
+
#
|
1442
|
+
class ResourceNotFoundException < Struct.new(
|
1443
|
+
:message,
|
1444
|
+
:resource_id,
|
1445
|
+
:resource_type)
|
1446
|
+
SENSITIVE = []
|
1447
|
+
include Aws::Structure
|
1448
|
+
end
|
1449
|
+
|
1450
|
+
# @note When making an API call, you may pass SendActivationCodeRequest
|
1451
|
+
# data as a hash:
|
1452
|
+
#
|
1453
|
+
# {
|
1454
|
+
# contact_channel_id: "SsmContactsArn", # required
|
1455
|
+
# }
|
1456
|
+
#
|
1457
|
+
# @!attribute [rw] contact_channel_id
|
1458
|
+
# The Amazon Resource Name (ARN) of the contact channel.
|
1459
|
+
# @return [String]
|
1460
|
+
#
|
1461
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/SendActivationCodeRequest AWS API Documentation
|
1462
|
+
#
|
1463
|
+
class SendActivationCodeRequest < Struct.new(
|
1464
|
+
:contact_channel_id)
|
1465
|
+
SENSITIVE = []
|
1466
|
+
include Aws::Structure
|
1467
|
+
end
|
1468
|
+
|
1469
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/SendActivationCodeResult AWS API Documentation
|
1470
|
+
#
|
1471
|
+
class SendActivationCodeResult < Aws::EmptyStructure; end
|
1472
|
+
|
1473
|
+
# Request would cause a service quota to be exceeded.
|
1474
|
+
#
|
1475
|
+
# @!attribute [rw] message
|
1476
|
+
# @return [String]
|
1477
|
+
#
|
1478
|
+
# @!attribute [rw] resource_id
|
1479
|
+
# Identifier of the resource affected
|
1480
|
+
# @return [String]
|
1481
|
+
#
|
1482
|
+
# @!attribute [rw] resource_type
|
1483
|
+
# Type of the resource affected
|
1484
|
+
# @return [String]
|
1485
|
+
#
|
1486
|
+
# @!attribute [rw] quota_code
|
1487
|
+
# Service Quotas requirement to identify originating service
|
1488
|
+
# @return [String]
|
1489
|
+
#
|
1490
|
+
# @!attribute [rw] service_code
|
1491
|
+
# Service Quotas requirement to identify originating quota
|
1492
|
+
# @return [String]
|
1493
|
+
#
|
1494
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ServiceQuotaExceededException AWS API Documentation
|
1495
|
+
#
|
1496
|
+
class ServiceQuotaExceededException < Struct.new(
|
1497
|
+
:message,
|
1498
|
+
:resource_id,
|
1499
|
+
:resource_type,
|
1500
|
+
:quota_code,
|
1501
|
+
:service_code)
|
1502
|
+
SENSITIVE = []
|
1503
|
+
include Aws::Structure
|
1504
|
+
end
|
1505
|
+
|
1506
|
+
# A set amount of time that an escalation plan or engagement plan
|
1507
|
+
# engages the specified contacts or contact methods.
|
1508
|
+
#
|
1509
|
+
# @note When making an API call, you may pass Stage
|
1510
|
+
# data as a hash:
|
1511
|
+
#
|
1512
|
+
# {
|
1513
|
+
# duration_in_minutes: 1, # required
|
1514
|
+
# targets: [ # required
|
1515
|
+
# {
|
1516
|
+
# channel_target_info: {
|
1517
|
+
# contact_channel_id: "SsmContactsArn", # required
|
1518
|
+
# retry_interval_in_minutes: 1,
|
1519
|
+
# },
|
1520
|
+
# contact_target_info: {
|
1521
|
+
# contact_id: "SsmContactsArn",
|
1522
|
+
# is_essential: false, # required
|
1523
|
+
# },
|
1524
|
+
# },
|
1525
|
+
# ],
|
1526
|
+
# }
|
1527
|
+
#
|
1528
|
+
# @!attribute [rw] duration_in_minutes
|
1529
|
+
# The time to wait until beginning the next stage.
|
1530
|
+
# @return [Integer]
|
1531
|
+
#
|
1532
|
+
# @!attribute [rw] targets
|
1533
|
+
# The contacts or contact methods that the escalation plan or
|
1534
|
+
# engagement plan is engaging.
|
1535
|
+
# @return [Array<Types::Target>]
|
1536
|
+
#
|
1537
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/Stage AWS API Documentation
|
1538
|
+
#
|
1539
|
+
class Stage < Struct.new(
|
1540
|
+
:duration_in_minutes,
|
1541
|
+
:targets)
|
1542
|
+
SENSITIVE = []
|
1543
|
+
include Aws::Structure
|
1544
|
+
end
|
1545
|
+
|
1546
|
+
# @note When making an API call, you may pass StartEngagementRequest
|
1547
|
+
# data as a hash:
|
1548
|
+
#
|
1549
|
+
# {
|
1550
|
+
# contact_id: "SsmContactsArn", # required
|
1551
|
+
# sender: "Sender", # required
|
1552
|
+
# subject: "Subject", # required
|
1553
|
+
# content: "Content", # required
|
1554
|
+
# public_subject: "PublicSubject",
|
1555
|
+
# public_content: "PublicContent",
|
1556
|
+
# incident_id: "IncidentId",
|
1557
|
+
# idempotency_token: "IdempotencyToken",
|
1558
|
+
# }
|
1559
|
+
#
|
1560
|
+
# @!attribute [rw] contact_id
|
1561
|
+
# The Amazon Resource Name (ARN) of the contact being engaged.
|
1562
|
+
# @return [String]
|
1563
|
+
#
|
1564
|
+
# @!attribute [rw] sender
|
1565
|
+
# The user that started the engagement.
|
1566
|
+
# @return [String]
|
1567
|
+
#
|
1568
|
+
# @!attribute [rw] subject
|
1569
|
+
# The secure subject of the message that was sent to the contact. Use
|
1570
|
+
# this field for engagements to `VOICE` or `EMAIL`.
|
1571
|
+
# @return [String]
|
1572
|
+
#
|
1573
|
+
# @!attribute [rw] content
|
1574
|
+
# The secure content of the message that was sent to the contact. Use
|
1575
|
+
# this field for engagements to `VOICE` or `EMAIL`.
|
1576
|
+
# @return [String]
|
1577
|
+
#
|
1578
|
+
# @!attribute [rw] public_subject
|
1579
|
+
# The insecure subject of the message that was sent to the contact.
|
1580
|
+
# Use this field for engagements to `SMS`.
|
1581
|
+
# @return [String]
|
1582
|
+
#
|
1583
|
+
# @!attribute [rw] public_content
|
1584
|
+
# The insecure content of the message that was sent to the contact.
|
1585
|
+
# Use this field for engagements to `SMS`.
|
1586
|
+
# @return [String]
|
1587
|
+
#
|
1588
|
+
# @!attribute [rw] incident_id
|
1589
|
+
# The ARN of the incident that the engagement is part of.
|
1590
|
+
# @return [String]
|
1591
|
+
#
|
1592
|
+
# @!attribute [rw] idempotency_token
|
1593
|
+
# A token ensuring that the action is called only once with the
|
1594
|
+
# specified details.
|
1595
|
+
#
|
1596
|
+
# **A suitable default value is auto-generated.** You should normally
|
1597
|
+
# not need to pass this option.
|
1598
|
+
# @return [String]
|
1599
|
+
#
|
1600
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/StartEngagementRequest AWS API Documentation
|
1601
|
+
#
|
1602
|
+
class StartEngagementRequest < Struct.new(
|
1603
|
+
:contact_id,
|
1604
|
+
:sender,
|
1605
|
+
:subject,
|
1606
|
+
:content,
|
1607
|
+
:public_subject,
|
1608
|
+
:public_content,
|
1609
|
+
:incident_id,
|
1610
|
+
:idempotency_token)
|
1611
|
+
SENSITIVE = []
|
1612
|
+
include Aws::Structure
|
1613
|
+
end
|
1614
|
+
|
1615
|
+
# @!attribute [rw] engagement_arn
|
1616
|
+
# The ARN of the engagement.
|
1617
|
+
# @return [String]
|
1618
|
+
#
|
1619
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/StartEngagementResult AWS API Documentation
|
1620
|
+
#
|
1621
|
+
class StartEngagementResult < Struct.new(
|
1622
|
+
:engagement_arn)
|
1623
|
+
SENSITIVE = []
|
1624
|
+
include Aws::Structure
|
1625
|
+
end
|
1626
|
+
|
1627
|
+
# @note When making an API call, you may pass StopEngagementRequest
|
1628
|
+
# data as a hash:
|
1629
|
+
#
|
1630
|
+
# {
|
1631
|
+
# engagement_id: "SsmContactsArn", # required
|
1632
|
+
# reason: "StopReason",
|
1633
|
+
# }
|
1634
|
+
#
|
1635
|
+
# @!attribute [rw] engagement_id
|
1636
|
+
# The Amazon Resource Name (ARN) of the engagement.
|
1637
|
+
# @return [String]
|
1638
|
+
#
|
1639
|
+
# @!attribute [rw] reason
|
1640
|
+
# The reason that you're stopping the engagement.
|
1641
|
+
# @return [String]
|
1642
|
+
#
|
1643
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/StopEngagementRequest AWS API Documentation
|
1644
|
+
#
|
1645
|
+
class StopEngagementRequest < Struct.new(
|
1646
|
+
:engagement_id,
|
1647
|
+
:reason)
|
1648
|
+
SENSITIVE = []
|
1649
|
+
include Aws::Structure
|
1650
|
+
end
|
1651
|
+
|
1652
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/StopEngagementResult AWS API Documentation
|
1653
|
+
#
|
1654
|
+
class StopEngagementResult < Aws::EmptyStructure; end
|
1655
|
+
|
1656
|
+
# A container of a key-value name pair.
|
1657
|
+
#
|
1658
|
+
# @note When making an API call, you may pass Tag
|
1659
|
+
# data as a hash:
|
1660
|
+
#
|
1661
|
+
# {
|
1662
|
+
# key: "TagKey",
|
1663
|
+
# value: "TagValue",
|
1664
|
+
# }
|
1665
|
+
#
|
1666
|
+
# @!attribute [rw] key
|
1667
|
+
# Name of the object key.
|
1668
|
+
# @return [String]
|
1669
|
+
#
|
1670
|
+
# @!attribute [rw] value
|
1671
|
+
# Value of the tag.
|
1672
|
+
# @return [String]
|
1673
|
+
#
|
1674
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/Tag AWS API Documentation
|
1675
|
+
#
|
1676
|
+
class Tag < Struct.new(
|
1677
|
+
:key,
|
1678
|
+
:value)
|
1679
|
+
SENSITIVE = []
|
1680
|
+
include Aws::Structure
|
1681
|
+
end
|
1682
|
+
|
1683
|
+
# @note When making an API call, you may pass TagResourceRequest
|
1684
|
+
# data as a hash:
|
1685
|
+
#
|
1686
|
+
# {
|
1687
|
+
# resource_arn: "AmazonResourceName", # required
|
1688
|
+
# tags: [ # required
|
1689
|
+
# {
|
1690
|
+
# key: "TagKey",
|
1691
|
+
# value: "TagValue",
|
1692
|
+
# },
|
1693
|
+
# ],
|
1694
|
+
# }
|
1695
|
+
#
|
1696
|
+
# @!attribute [rw] resource_arn
|
1697
|
+
# The Amazon Resource Name (ARN) of the contact or escalation plan.
|
1698
|
+
# @return [String]
|
1699
|
+
#
|
1700
|
+
# @!attribute [rw] tags
|
1701
|
+
# A list of tags that you are adding to the contact or escalation
|
1702
|
+
# plan.
|
1703
|
+
# @return [Array<Types::Tag>]
|
1704
|
+
#
|
1705
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/TagResourceRequest AWS API Documentation
|
1706
|
+
#
|
1707
|
+
class TagResourceRequest < Struct.new(
|
1708
|
+
:resource_arn,
|
1709
|
+
:tags)
|
1710
|
+
SENSITIVE = []
|
1711
|
+
include Aws::Structure
|
1712
|
+
end
|
1713
|
+
|
1714
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/TagResourceResult AWS API Documentation
|
1715
|
+
#
|
1716
|
+
class TagResourceResult < Aws::EmptyStructure; end
|
1717
|
+
|
1718
|
+
# The contact or contact channel that is being engaged.
|
1719
|
+
#
|
1720
|
+
# @note When making an API call, you may pass Target
|
1721
|
+
# data as a hash:
|
1722
|
+
#
|
1723
|
+
# {
|
1724
|
+
# channel_target_info: {
|
1725
|
+
# contact_channel_id: "SsmContactsArn", # required
|
1726
|
+
# retry_interval_in_minutes: 1,
|
1727
|
+
# },
|
1728
|
+
# contact_target_info: {
|
1729
|
+
# contact_id: "SsmContactsArn",
|
1730
|
+
# is_essential: false, # required
|
1731
|
+
# },
|
1732
|
+
# }
|
1733
|
+
#
|
1734
|
+
# @!attribute [rw] channel_target_info
|
1735
|
+
# Information about the contact channel Incident Manager is engaging.
|
1736
|
+
# @return [Types::ChannelTargetInfo]
|
1737
|
+
#
|
1738
|
+
# @!attribute [rw] contact_target_info
|
1739
|
+
# Information about the contact that Incident Manager is engaging.
|
1740
|
+
# @return [Types::ContactTargetInfo]
|
1741
|
+
#
|
1742
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/Target AWS API Documentation
|
1743
|
+
#
|
1744
|
+
class Target < Struct.new(
|
1745
|
+
:channel_target_info,
|
1746
|
+
:contact_target_info)
|
1747
|
+
SENSITIVE = []
|
1748
|
+
include Aws::Structure
|
1749
|
+
end
|
1750
|
+
|
1751
|
+
# The request was denied due to request throttling.
|
1752
|
+
#
|
1753
|
+
# @!attribute [rw] message
|
1754
|
+
# @return [String]
|
1755
|
+
#
|
1756
|
+
# @!attribute [rw] quota_code
|
1757
|
+
# Service Quotas requirement to identify originating service
|
1758
|
+
# @return [String]
|
1759
|
+
#
|
1760
|
+
# @!attribute [rw] service_code
|
1761
|
+
# Service Quotas requirement to identify originating quota
|
1762
|
+
# @return [String]
|
1763
|
+
#
|
1764
|
+
# @!attribute [rw] retry_after_seconds
|
1765
|
+
# Advice to clients on when the call can be safely retried
|
1766
|
+
# @return [Integer]
|
1767
|
+
#
|
1768
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ThrottlingException AWS API Documentation
|
1769
|
+
#
|
1770
|
+
class ThrottlingException < Struct.new(
|
1771
|
+
:message,
|
1772
|
+
:quota_code,
|
1773
|
+
:service_code,
|
1774
|
+
:retry_after_seconds)
|
1775
|
+
SENSITIVE = []
|
1776
|
+
include Aws::Structure
|
1777
|
+
end
|
1778
|
+
|
1779
|
+
# A range of between two set times
|
1780
|
+
#
|
1781
|
+
# @note When making an API call, you may pass TimeRange
|
1782
|
+
# data as a hash:
|
1783
|
+
#
|
1784
|
+
# {
|
1785
|
+
# start_time: Time.now,
|
1786
|
+
# end_time: Time.now,
|
1787
|
+
# }
|
1788
|
+
#
|
1789
|
+
# @!attribute [rw] start_time
|
1790
|
+
# The start of the time range.
|
1791
|
+
# @return [Time]
|
1792
|
+
#
|
1793
|
+
# @!attribute [rw] end_time
|
1794
|
+
# The end of the time range.
|
1795
|
+
# @return [Time]
|
1796
|
+
#
|
1797
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/TimeRange AWS API Documentation
|
1798
|
+
#
|
1799
|
+
class TimeRange < Struct.new(
|
1800
|
+
:start_time,
|
1801
|
+
:end_time)
|
1802
|
+
SENSITIVE = []
|
1803
|
+
include Aws::Structure
|
1804
|
+
end
|
1805
|
+
|
1806
|
+
# @note When making an API call, you may pass UntagResourceRequest
|
1807
|
+
# data as a hash:
|
1808
|
+
#
|
1809
|
+
# {
|
1810
|
+
# resource_arn: "AmazonResourceName", # required
|
1811
|
+
# tag_keys: ["TagKey"], # required
|
1812
|
+
# }
|
1813
|
+
#
|
1814
|
+
# @!attribute [rw] resource_arn
|
1815
|
+
# The Amazon Resource Name (ARN) of the contact or escalation plan.
|
1816
|
+
# @return [String]
|
1817
|
+
#
|
1818
|
+
# @!attribute [rw] tag_keys
|
1819
|
+
# The key of the tag that you want to remove.
|
1820
|
+
# @return [Array<String>]
|
1821
|
+
#
|
1822
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/UntagResourceRequest AWS API Documentation
|
1823
|
+
#
|
1824
|
+
class UntagResourceRequest < Struct.new(
|
1825
|
+
:resource_arn,
|
1826
|
+
:tag_keys)
|
1827
|
+
SENSITIVE = []
|
1828
|
+
include Aws::Structure
|
1829
|
+
end
|
1830
|
+
|
1831
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/UntagResourceResult AWS API Documentation
|
1832
|
+
#
|
1833
|
+
class UntagResourceResult < Aws::EmptyStructure; end
|
1834
|
+
|
1835
|
+
# @note When making an API call, you may pass UpdateContactChannelRequest
|
1836
|
+
# data as a hash:
|
1837
|
+
#
|
1838
|
+
# {
|
1839
|
+
# contact_channel_id: "SsmContactsArn", # required
|
1840
|
+
# name: "ChannelName",
|
1841
|
+
# delivery_address: {
|
1842
|
+
# simple_address: "SimpleAddress",
|
1843
|
+
# },
|
1844
|
+
# }
|
1845
|
+
#
|
1846
|
+
# @!attribute [rw] contact_channel_id
|
1847
|
+
# The Amazon Resource Name (ARN) of the contact channel you want to
|
1848
|
+
# update.
|
1849
|
+
# @return [String]
|
1850
|
+
#
|
1851
|
+
# @!attribute [rw] name
|
1852
|
+
# The name of the contact channel
|
1853
|
+
# @return [String]
|
1854
|
+
#
|
1855
|
+
# @!attribute [rw] delivery_address
|
1856
|
+
# The details that Incident Manager uses when trying to engage the
|
1857
|
+
# contact channel.
|
1858
|
+
# @return [Types::ContactChannelAddress]
|
1859
|
+
#
|
1860
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/UpdateContactChannelRequest AWS API Documentation
|
1861
|
+
#
|
1862
|
+
class UpdateContactChannelRequest < Struct.new(
|
1863
|
+
:contact_channel_id,
|
1864
|
+
:name,
|
1865
|
+
:delivery_address)
|
1866
|
+
SENSITIVE = []
|
1867
|
+
include Aws::Structure
|
1868
|
+
end
|
1869
|
+
|
1870
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/UpdateContactChannelResult AWS API Documentation
|
1871
|
+
#
|
1872
|
+
class UpdateContactChannelResult < Aws::EmptyStructure; end
|
1873
|
+
|
1874
|
+
# @note When making an API call, you may pass UpdateContactRequest
|
1875
|
+
# data as a hash:
|
1876
|
+
#
|
1877
|
+
# {
|
1878
|
+
# contact_id: "SsmContactsArn", # required
|
1879
|
+
# display_name: "ContactName",
|
1880
|
+
# plan: {
|
1881
|
+
# stages: [ # required
|
1882
|
+
# {
|
1883
|
+
# duration_in_minutes: 1, # required
|
1884
|
+
# targets: [ # required
|
1885
|
+
# {
|
1886
|
+
# channel_target_info: {
|
1887
|
+
# contact_channel_id: "SsmContactsArn", # required
|
1888
|
+
# retry_interval_in_minutes: 1,
|
1889
|
+
# },
|
1890
|
+
# contact_target_info: {
|
1891
|
+
# contact_id: "SsmContactsArn",
|
1892
|
+
# is_essential: false, # required
|
1893
|
+
# },
|
1894
|
+
# },
|
1895
|
+
# ],
|
1896
|
+
# },
|
1897
|
+
# ],
|
1898
|
+
# },
|
1899
|
+
# }
|
1900
|
+
#
|
1901
|
+
# @!attribute [rw] contact_id
|
1902
|
+
# The Amazon Resource Name (ARN) of the contact or escalation plan
|
1903
|
+
# you're updating.
|
1904
|
+
# @return [String]
|
1905
|
+
#
|
1906
|
+
# @!attribute [rw] display_name
|
1907
|
+
# The full name of the contact or escalation plan.
|
1908
|
+
# @return [String]
|
1909
|
+
#
|
1910
|
+
# @!attribute [rw] plan
|
1911
|
+
# A list of stages. A contact has an engagement plan with stages for
|
1912
|
+
# specified contact channels. An escalation plan uses these stages to
|
1913
|
+
# contact specified contacts.
|
1914
|
+
# @return [Types::Plan]
|
1915
|
+
#
|
1916
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/UpdateContactRequest AWS API Documentation
|
1917
|
+
#
|
1918
|
+
class UpdateContactRequest < Struct.new(
|
1919
|
+
:contact_id,
|
1920
|
+
:display_name,
|
1921
|
+
:plan)
|
1922
|
+
SENSITIVE = []
|
1923
|
+
include Aws::Structure
|
1924
|
+
end
|
1925
|
+
|
1926
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/UpdateContactResult AWS API Documentation
|
1927
|
+
#
|
1928
|
+
class UpdateContactResult < Aws::EmptyStructure; end
|
1929
|
+
|
1930
|
+
# The input fails to satisfy the constraints specified by an AWS
|
1931
|
+
# service.
|
1932
|
+
#
|
1933
|
+
# @!attribute [rw] message
|
1934
|
+
# @return [String]
|
1935
|
+
#
|
1936
|
+
# @!attribute [rw] reason
|
1937
|
+
# Reason the request failed validation
|
1938
|
+
# @return [String]
|
1939
|
+
#
|
1940
|
+
# @!attribute [rw] fields
|
1941
|
+
# The fields that caused the error
|
1942
|
+
# @return [Array<Types::ValidationExceptionField>]
|
1943
|
+
#
|
1944
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ValidationException AWS API Documentation
|
1945
|
+
#
|
1946
|
+
class ValidationException < Struct.new(
|
1947
|
+
:message,
|
1948
|
+
:reason,
|
1949
|
+
:fields)
|
1950
|
+
SENSITIVE = []
|
1951
|
+
include Aws::Structure
|
1952
|
+
end
|
1953
|
+
|
1954
|
+
# Provides information about which field caused the exception.
|
1955
|
+
#
|
1956
|
+
# @!attribute [rw] name
|
1957
|
+
# The name of the field that caused the exception.
|
1958
|
+
# @return [String]
|
1959
|
+
#
|
1960
|
+
# @!attribute [rw] message
|
1961
|
+
# Information about what caused the field to cause an exception.
|
1962
|
+
# @return [String]
|
1963
|
+
#
|
1964
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ValidationExceptionField AWS API Documentation
|
1965
|
+
#
|
1966
|
+
class ValidationExceptionField < Struct.new(
|
1967
|
+
:name,
|
1968
|
+
:message)
|
1969
|
+
SENSITIVE = []
|
1970
|
+
include Aws::Structure
|
1971
|
+
end
|
1972
|
+
|
1973
|
+
end
|
1974
|
+
end
|