aws-sdk-ssmcontacts 1.26.0 → 1.27.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ssmcontacts/client.rb +1 -1
- data/lib/aws-sdk-ssmcontacts/plugins/endpoints.rb +1 -0
- data/lib/aws-sdk-ssmcontacts.rb +1 -1
- data/sig/client.rbs +767 -0
- data/sig/errors.rbs +55 -0
- data/sig/resource.rbs +80 -0
- data/sig/types.rbs +745 -0
- data/sig/waiters.rbs +13 -0
- metadata +13 -8
data/sig/client.rbs
ADDED
@@ -0,0 +1,767 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module SSMContacts
|
10
|
+
class Client < ::Seahorse::Client::Base
|
11
|
+
include ::Aws::ClientStubs
|
12
|
+
|
13
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#initialize-instance_method
|
14
|
+
def self.new: (
|
15
|
+
?credentials: untyped,
|
16
|
+
?region: String,
|
17
|
+
?access_key_id: String,
|
18
|
+
?active_endpoint_cache: bool,
|
19
|
+
?adaptive_retry_wait_to_fill: bool,
|
20
|
+
?client_side_monitoring: bool,
|
21
|
+
?client_side_monitoring_client_id: String,
|
22
|
+
?client_side_monitoring_host: String,
|
23
|
+
?client_side_monitoring_port: Integer,
|
24
|
+
?client_side_monitoring_publisher: untyped,
|
25
|
+
?convert_params: bool,
|
26
|
+
?correct_clock_skew: bool,
|
27
|
+
?defaults_mode: String,
|
28
|
+
?disable_host_prefix_injection: bool,
|
29
|
+
?disable_request_compression: bool,
|
30
|
+
?endpoint: String,
|
31
|
+
?endpoint_cache_max_entries: Integer,
|
32
|
+
?endpoint_cache_max_threads: Integer,
|
33
|
+
?endpoint_cache_poll_interval: Integer,
|
34
|
+
?endpoint_discovery: bool,
|
35
|
+
?ignore_configured_endpoint_urls: bool,
|
36
|
+
?log_formatter: untyped,
|
37
|
+
?log_level: Symbol,
|
38
|
+
?logger: untyped,
|
39
|
+
?max_attempts: Integer,
|
40
|
+
?profile: String,
|
41
|
+
?request_min_compression_size_bytes: Integer,
|
42
|
+
?retry_backoff: Proc,
|
43
|
+
?retry_base_delay: Float,
|
44
|
+
?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
|
45
|
+
?retry_limit: Integer,
|
46
|
+
?retry_max_delay: Integer,
|
47
|
+
?retry_mode: ("legacy" | "standard" | "adaptive"),
|
48
|
+
?sdk_ua_app_id: String,
|
49
|
+
?secret_access_key: String,
|
50
|
+
?session_token: String,
|
51
|
+
?simple_json: bool,
|
52
|
+
?stub_responses: untyped,
|
53
|
+
?token_provider: untyped,
|
54
|
+
?use_dualstack_endpoint: bool,
|
55
|
+
?use_fips_endpoint: bool,
|
56
|
+
?validate_params: bool,
|
57
|
+
?endpoint_provider: untyped,
|
58
|
+
?http_proxy: String,
|
59
|
+
?http_open_timeout: (Float | Integer),
|
60
|
+
?http_read_timeout: (Float | Integer),
|
61
|
+
?http_idle_timeout: (Float | Integer),
|
62
|
+
?http_continue_timeout: (Float | Integer),
|
63
|
+
?ssl_timeout: (Float | Integer | nil),
|
64
|
+
?http_wire_trace: bool,
|
65
|
+
?ssl_verify_peer: bool,
|
66
|
+
?ssl_ca_bundle: String,
|
67
|
+
?ssl_ca_directory: String,
|
68
|
+
?ssl_ca_store: String,
|
69
|
+
?on_chunk_received: Proc,
|
70
|
+
?on_chunk_sent: Proc,
|
71
|
+
?raise_response_errors: bool
|
72
|
+
) -> instance
|
73
|
+
| (?Hash[Symbol, untyped]) -> instance
|
74
|
+
|
75
|
+
|
76
|
+
interface _AcceptPageResponseSuccess
|
77
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AcceptPageResult]
|
78
|
+
end
|
79
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#accept_page-instance_method
|
80
|
+
def accept_page: (
|
81
|
+
page_id: ::String,
|
82
|
+
?contact_channel_id: ::String,
|
83
|
+
accept_type: ("DELIVERED" | "READ"),
|
84
|
+
?note: ::String,
|
85
|
+
accept_code: ::String,
|
86
|
+
?accept_code_validation: ("IGNORE" | "ENFORCE")
|
87
|
+
) -> _AcceptPageResponseSuccess
|
88
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AcceptPageResponseSuccess
|
89
|
+
|
90
|
+
interface _ActivateContactChannelResponseSuccess
|
91
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ActivateContactChannelResult]
|
92
|
+
end
|
93
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#activate_contact_channel-instance_method
|
94
|
+
def activate_contact_channel: (
|
95
|
+
contact_channel_id: ::String,
|
96
|
+
activation_code: ::String
|
97
|
+
) -> _ActivateContactChannelResponseSuccess
|
98
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ActivateContactChannelResponseSuccess
|
99
|
+
|
100
|
+
interface _CreateContactResponseSuccess
|
101
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateContactResult]
|
102
|
+
def contact_arn: () -> ::String
|
103
|
+
end
|
104
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#create_contact-instance_method
|
105
|
+
def create_contact: (
|
106
|
+
alias: ::String,
|
107
|
+
?display_name: ::String,
|
108
|
+
type: ("PERSONAL" | "ESCALATION" | "ONCALL_SCHEDULE"),
|
109
|
+
plan: {
|
110
|
+
stages: Array[
|
111
|
+
{
|
112
|
+
duration_in_minutes: ::Integer,
|
113
|
+
targets: Array[
|
114
|
+
{
|
115
|
+
channel_target_info: {
|
116
|
+
contact_channel_id: ::String,
|
117
|
+
retry_interval_in_minutes: ::Integer?
|
118
|
+
}?,
|
119
|
+
contact_target_info: {
|
120
|
+
contact_id: ::String?,
|
121
|
+
is_essential: bool
|
122
|
+
}?
|
123
|
+
},
|
124
|
+
]
|
125
|
+
},
|
126
|
+
]?,
|
127
|
+
rotation_ids: Array[::String]?
|
128
|
+
},
|
129
|
+
?tags: Array[
|
130
|
+
{
|
131
|
+
key: ::String?,
|
132
|
+
value: ::String?
|
133
|
+
},
|
134
|
+
],
|
135
|
+
?idempotency_token: ::String
|
136
|
+
) -> _CreateContactResponseSuccess
|
137
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateContactResponseSuccess
|
138
|
+
|
139
|
+
interface _CreateContactChannelResponseSuccess
|
140
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateContactChannelResult]
|
141
|
+
def contact_channel_arn: () -> ::String
|
142
|
+
end
|
143
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#create_contact_channel-instance_method
|
144
|
+
def create_contact_channel: (
|
145
|
+
contact_id: ::String,
|
146
|
+
name: ::String,
|
147
|
+
type: ("SMS" | "VOICE" | "EMAIL"),
|
148
|
+
delivery_address: {
|
149
|
+
simple_address: ::String?
|
150
|
+
},
|
151
|
+
?defer_activation: bool,
|
152
|
+
?idempotency_token: ::String
|
153
|
+
) -> _CreateContactChannelResponseSuccess
|
154
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateContactChannelResponseSuccess
|
155
|
+
|
156
|
+
interface _CreateRotationResponseSuccess
|
157
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateRotationResult]
|
158
|
+
def rotation_arn: () -> ::String
|
159
|
+
end
|
160
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#create_rotation-instance_method
|
161
|
+
def create_rotation: (
|
162
|
+
name: ::String,
|
163
|
+
contact_ids: Array[::String],
|
164
|
+
?start_time: ::Time,
|
165
|
+
time_zone_id: ::String,
|
166
|
+
recurrence: {
|
167
|
+
monthly_settings: Array[
|
168
|
+
{
|
169
|
+
day_of_month: ::Integer,
|
170
|
+
hand_off_time: {
|
171
|
+
hour_of_day: ::Integer,
|
172
|
+
minute_of_hour: ::Integer
|
173
|
+
}
|
174
|
+
},
|
175
|
+
]?,
|
176
|
+
weekly_settings: Array[
|
177
|
+
{
|
178
|
+
day_of_week: ("MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "SUN"),
|
179
|
+
hand_off_time: {
|
180
|
+
hour_of_day: ::Integer,
|
181
|
+
minute_of_hour: ::Integer
|
182
|
+
}
|
183
|
+
},
|
184
|
+
]?,
|
185
|
+
daily_settings: Array[
|
186
|
+
{
|
187
|
+
hour_of_day: ::Integer,
|
188
|
+
minute_of_hour: ::Integer
|
189
|
+
},
|
190
|
+
]?,
|
191
|
+
number_of_on_calls: ::Integer,
|
192
|
+
shift_coverages: Hash[("MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "SUN"), Array[
|
193
|
+
{
|
194
|
+
start: {
|
195
|
+
hour_of_day: ::Integer,
|
196
|
+
minute_of_hour: ::Integer
|
197
|
+
}?,
|
198
|
+
end: {
|
199
|
+
hour_of_day: ::Integer,
|
200
|
+
minute_of_hour: ::Integer
|
201
|
+
}?
|
202
|
+
},
|
203
|
+
]]?,
|
204
|
+
recurrence_multiplier: ::Integer
|
205
|
+
},
|
206
|
+
?tags: Array[
|
207
|
+
{
|
208
|
+
key: ::String?,
|
209
|
+
value: ::String?
|
210
|
+
},
|
211
|
+
],
|
212
|
+
?idempotency_token: ::String
|
213
|
+
) -> _CreateRotationResponseSuccess
|
214
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateRotationResponseSuccess
|
215
|
+
|
216
|
+
interface _CreateRotationOverrideResponseSuccess
|
217
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateRotationOverrideResult]
|
218
|
+
def rotation_override_id: () -> ::String
|
219
|
+
end
|
220
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#create_rotation_override-instance_method
|
221
|
+
def create_rotation_override: (
|
222
|
+
rotation_id: ::String,
|
223
|
+
new_contact_ids: Array[::String],
|
224
|
+
start_time: ::Time,
|
225
|
+
end_time: ::Time,
|
226
|
+
?idempotency_token: ::String
|
227
|
+
) -> _CreateRotationOverrideResponseSuccess
|
228
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateRotationOverrideResponseSuccess
|
229
|
+
|
230
|
+
interface _DeactivateContactChannelResponseSuccess
|
231
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeactivateContactChannelResult]
|
232
|
+
end
|
233
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#deactivate_contact_channel-instance_method
|
234
|
+
def deactivate_contact_channel: (
|
235
|
+
contact_channel_id: ::String
|
236
|
+
) -> _DeactivateContactChannelResponseSuccess
|
237
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeactivateContactChannelResponseSuccess
|
238
|
+
|
239
|
+
interface _DeleteContactResponseSuccess
|
240
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteContactResult]
|
241
|
+
end
|
242
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#delete_contact-instance_method
|
243
|
+
def delete_contact: (
|
244
|
+
contact_id: ::String
|
245
|
+
) -> _DeleteContactResponseSuccess
|
246
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteContactResponseSuccess
|
247
|
+
|
248
|
+
interface _DeleteContactChannelResponseSuccess
|
249
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteContactChannelResult]
|
250
|
+
end
|
251
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#delete_contact_channel-instance_method
|
252
|
+
def delete_contact_channel: (
|
253
|
+
contact_channel_id: ::String
|
254
|
+
) -> _DeleteContactChannelResponseSuccess
|
255
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteContactChannelResponseSuccess
|
256
|
+
|
257
|
+
interface _DeleteRotationResponseSuccess
|
258
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteRotationResult]
|
259
|
+
end
|
260
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#delete_rotation-instance_method
|
261
|
+
def delete_rotation: (
|
262
|
+
rotation_id: ::String
|
263
|
+
) -> _DeleteRotationResponseSuccess
|
264
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteRotationResponseSuccess
|
265
|
+
|
266
|
+
interface _DeleteRotationOverrideResponseSuccess
|
267
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteRotationOverrideResult]
|
268
|
+
end
|
269
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#delete_rotation_override-instance_method
|
270
|
+
def delete_rotation_override: (
|
271
|
+
rotation_id: ::String,
|
272
|
+
rotation_override_id: ::String
|
273
|
+
) -> _DeleteRotationOverrideResponseSuccess
|
274
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteRotationOverrideResponseSuccess
|
275
|
+
|
276
|
+
interface _DescribeEngagementResponseSuccess
|
277
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeEngagementResult]
|
278
|
+
def contact_arn: () -> ::String
|
279
|
+
def engagement_arn: () -> ::String
|
280
|
+
def sender: () -> ::String
|
281
|
+
def subject: () -> ::String
|
282
|
+
def content: () -> ::String
|
283
|
+
def public_subject: () -> ::String
|
284
|
+
def public_content: () -> ::String
|
285
|
+
def incident_id: () -> ::String
|
286
|
+
def start_time: () -> ::Time
|
287
|
+
def stop_time: () -> ::Time
|
288
|
+
end
|
289
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#describe_engagement-instance_method
|
290
|
+
def describe_engagement: (
|
291
|
+
engagement_id: ::String
|
292
|
+
) -> _DescribeEngagementResponseSuccess
|
293
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeEngagementResponseSuccess
|
294
|
+
|
295
|
+
interface _DescribePageResponseSuccess
|
296
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribePageResult]
|
297
|
+
def page_arn: () -> ::String
|
298
|
+
def engagement_arn: () -> ::String
|
299
|
+
def contact_arn: () -> ::String
|
300
|
+
def sender: () -> ::String
|
301
|
+
def subject: () -> ::String
|
302
|
+
def content: () -> ::String
|
303
|
+
def public_subject: () -> ::String
|
304
|
+
def public_content: () -> ::String
|
305
|
+
def incident_id: () -> ::String
|
306
|
+
def sent_time: () -> ::Time
|
307
|
+
def read_time: () -> ::Time
|
308
|
+
def delivery_time: () -> ::Time
|
309
|
+
end
|
310
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#describe_page-instance_method
|
311
|
+
def describe_page: (
|
312
|
+
page_id: ::String
|
313
|
+
) -> _DescribePageResponseSuccess
|
314
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribePageResponseSuccess
|
315
|
+
|
316
|
+
interface _GetContactResponseSuccess
|
317
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetContactResult]
|
318
|
+
def contact_arn: () -> ::String
|
319
|
+
def alias: () -> ::String
|
320
|
+
def display_name: () -> ::String
|
321
|
+
def type: () -> ("PERSONAL" | "ESCALATION" | "ONCALL_SCHEDULE")
|
322
|
+
def plan: () -> Types::Plan
|
323
|
+
end
|
324
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#get_contact-instance_method
|
325
|
+
def get_contact: (
|
326
|
+
contact_id: ::String
|
327
|
+
) -> _GetContactResponseSuccess
|
328
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetContactResponseSuccess
|
329
|
+
|
330
|
+
interface _GetContactChannelResponseSuccess
|
331
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetContactChannelResult]
|
332
|
+
def contact_arn: () -> ::String
|
333
|
+
def contact_channel_arn: () -> ::String
|
334
|
+
def name: () -> ::String
|
335
|
+
def type: () -> ("SMS" | "VOICE" | "EMAIL")
|
336
|
+
def delivery_address: () -> Types::ContactChannelAddress
|
337
|
+
def activation_status: () -> ("ACTIVATED" | "NOT_ACTIVATED")
|
338
|
+
end
|
339
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#get_contact_channel-instance_method
|
340
|
+
def get_contact_channel: (
|
341
|
+
contact_channel_id: ::String
|
342
|
+
) -> _GetContactChannelResponseSuccess
|
343
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetContactChannelResponseSuccess
|
344
|
+
|
345
|
+
interface _GetContactPolicyResponseSuccess
|
346
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetContactPolicyResult]
|
347
|
+
def contact_arn: () -> ::String
|
348
|
+
def policy: () -> ::String
|
349
|
+
end
|
350
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#get_contact_policy-instance_method
|
351
|
+
def get_contact_policy: (
|
352
|
+
contact_arn: ::String
|
353
|
+
) -> _GetContactPolicyResponseSuccess
|
354
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetContactPolicyResponseSuccess
|
355
|
+
|
356
|
+
interface _GetRotationResponseSuccess
|
357
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetRotationResult]
|
358
|
+
def rotation_arn: () -> ::String
|
359
|
+
def name: () -> ::String
|
360
|
+
def contact_ids: () -> ::Array[::String]
|
361
|
+
def start_time: () -> ::Time
|
362
|
+
def time_zone_id: () -> ::String
|
363
|
+
def recurrence: () -> Types::RecurrenceSettings
|
364
|
+
end
|
365
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#get_rotation-instance_method
|
366
|
+
def get_rotation: (
|
367
|
+
rotation_id: ::String
|
368
|
+
) -> _GetRotationResponseSuccess
|
369
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetRotationResponseSuccess
|
370
|
+
|
371
|
+
interface _GetRotationOverrideResponseSuccess
|
372
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetRotationOverrideResult]
|
373
|
+
def rotation_override_id: () -> ::String
|
374
|
+
def rotation_arn: () -> ::String
|
375
|
+
def new_contact_ids: () -> ::Array[::String]
|
376
|
+
def start_time: () -> ::Time
|
377
|
+
def end_time: () -> ::Time
|
378
|
+
def create_time: () -> ::Time
|
379
|
+
end
|
380
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#get_rotation_override-instance_method
|
381
|
+
def get_rotation_override: (
|
382
|
+
rotation_id: ::String,
|
383
|
+
rotation_override_id: ::String
|
384
|
+
) -> _GetRotationOverrideResponseSuccess
|
385
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetRotationOverrideResponseSuccess
|
386
|
+
|
387
|
+
interface _ListContactChannelsResponseSuccess
|
388
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListContactChannelsResult]
|
389
|
+
def next_token: () -> ::String
|
390
|
+
def contact_channels: () -> ::Array[Types::ContactChannel]
|
391
|
+
end
|
392
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#list_contact_channels-instance_method
|
393
|
+
def list_contact_channels: (
|
394
|
+
contact_id: ::String,
|
395
|
+
?next_token: ::String,
|
396
|
+
?max_results: ::Integer
|
397
|
+
) -> _ListContactChannelsResponseSuccess
|
398
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListContactChannelsResponseSuccess
|
399
|
+
|
400
|
+
interface _ListContactsResponseSuccess
|
401
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListContactsResult]
|
402
|
+
def next_token: () -> ::String
|
403
|
+
def contacts: () -> ::Array[Types::Contact]
|
404
|
+
end
|
405
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#list_contacts-instance_method
|
406
|
+
def list_contacts: (
|
407
|
+
?next_token: ::String,
|
408
|
+
?max_results: ::Integer,
|
409
|
+
?alias_prefix: ::String,
|
410
|
+
?type: ("PERSONAL" | "ESCALATION" | "ONCALL_SCHEDULE")
|
411
|
+
) -> _ListContactsResponseSuccess
|
412
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListContactsResponseSuccess
|
413
|
+
|
414
|
+
interface _ListEngagementsResponseSuccess
|
415
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListEngagementsResult]
|
416
|
+
def next_token: () -> ::String
|
417
|
+
def engagements: () -> ::Array[Types::Engagement]
|
418
|
+
end
|
419
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#list_engagements-instance_method
|
420
|
+
def list_engagements: (
|
421
|
+
?next_token: ::String,
|
422
|
+
?max_results: ::Integer,
|
423
|
+
?incident_id: ::String,
|
424
|
+
?time_range_value: {
|
425
|
+
start_time: ::Time?,
|
426
|
+
end_time: ::Time?
|
427
|
+
}
|
428
|
+
) -> _ListEngagementsResponseSuccess
|
429
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListEngagementsResponseSuccess
|
430
|
+
|
431
|
+
interface _ListPageReceiptsResponseSuccess
|
432
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListPageReceiptsResult]
|
433
|
+
def next_token: () -> ::String
|
434
|
+
def receipts: () -> ::Array[Types::Receipt]
|
435
|
+
end
|
436
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#list_page_receipts-instance_method
|
437
|
+
def list_page_receipts: (
|
438
|
+
page_id: ::String,
|
439
|
+
?next_token: ::String,
|
440
|
+
?max_results: ::Integer
|
441
|
+
) -> _ListPageReceiptsResponseSuccess
|
442
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListPageReceiptsResponseSuccess
|
443
|
+
|
444
|
+
interface _ListPageResolutionsResponseSuccess
|
445
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListPageResolutionsResult]
|
446
|
+
def next_token: () -> ::String
|
447
|
+
def page_resolutions: () -> ::Array[Types::ResolutionContact]
|
448
|
+
end
|
449
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#list_page_resolutions-instance_method
|
450
|
+
def list_page_resolutions: (
|
451
|
+
?next_token: ::String,
|
452
|
+
page_id: ::String
|
453
|
+
) -> _ListPageResolutionsResponseSuccess
|
454
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListPageResolutionsResponseSuccess
|
455
|
+
|
456
|
+
interface _ListPagesByContactResponseSuccess
|
457
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListPagesByContactResult]
|
458
|
+
def next_token: () -> ::String
|
459
|
+
def pages: () -> ::Array[Types::Page]
|
460
|
+
end
|
461
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#list_pages_by_contact-instance_method
|
462
|
+
def list_pages_by_contact: (
|
463
|
+
contact_id: ::String,
|
464
|
+
?next_token: ::String,
|
465
|
+
?max_results: ::Integer
|
466
|
+
) -> _ListPagesByContactResponseSuccess
|
467
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListPagesByContactResponseSuccess
|
468
|
+
|
469
|
+
interface _ListPagesByEngagementResponseSuccess
|
470
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListPagesByEngagementResult]
|
471
|
+
def next_token: () -> ::String
|
472
|
+
def pages: () -> ::Array[Types::Page]
|
473
|
+
end
|
474
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#list_pages_by_engagement-instance_method
|
475
|
+
def list_pages_by_engagement: (
|
476
|
+
engagement_id: ::String,
|
477
|
+
?next_token: ::String,
|
478
|
+
?max_results: ::Integer
|
479
|
+
) -> _ListPagesByEngagementResponseSuccess
|
480
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListPagesByEngagementResponseSuccess
|
481
|
+
|
482
|
+
interface _ListPreviewRotationShiftsResponseSuccess
|
483
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListPreviewRotationShiftsResult]
|
484
|
+
def rotation_shifts: () -> ::Array[Types::RotationShift]
|
485
|
+
def next_token: () -> ::String
|
486
|
+
end
|
487
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#list_preview_rotation_shifts-instance_method
|
488
|
+
def list_preview_rotation_shifts: (
|
489
|
+
?rotation_start_time: ::Time,
|
490
|
+
?start_time: ::Time,
|
491
|
+
end_time: ::Time,
|
492
|
+
members: Array[::String],
|
493
|
+
time_zone_id: ::String,
|
494
|
+
recurrence: {
|
495
|
+
monthly_settings: Array[
|
496
|
+
{
|
497
|
+
day_of_month: ::Integer,
|
498
|
+
hand_off_time: {
|
499
|
+
hour_of_day: ::Integer,
|
500
|
+
minute_of_hour: ::Integer
|
501
|
+
}
|
502
|
+
},
|
503
|
+
]?,
|
504
|
+
weekly_settings: Array[
|
505
|
+
{
|
506
|
+
day_of_week: ("MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "SUN"),
|
507
|
+
hand_off_time: {
|
508
|
+
hour_of_day: ::Integer,
|
509
|
+
minute_of_hour: ::Integer
|
510
|
+
}
|
511
|
+
},
|
512
|
+
]?,
|
513
|
+
daily_settings: Array[
|
514
|
+
{
|
515
|
+
hour_of_day: ::Integer,
|
516
|
+
minute_of_hour: ::Integer
|
517
|
+
},
|
518
|
+
]?,
|
519
|
+
number_of_on_calls: ::Integer,
|
520
|
+
shift_coverages: Hash[("MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "SUN"), Array[
|
521
|
+
{
|
522
|
+
start: {
|
523
|
+
hour_of_day: ::Integer,
|
524
|
+
minute_of_hour: ::Integer
|
525
|
+
}?,
|
526
|
+
end: {
|
527
|
+
hour_of_day: ::Integer,
|
528
|
+
minute_of_hour: ::Integer
|
529
|
+
}?
|
530
|
+
},
|
531
|
+
]]?,
|
532
|
+
recurrence_multiplier: ::Integer
|
533
|
+
},
|
534
|
+
?overrides: Array[
|
535
|
+
{
|
536
|
+
new_members: Array[::String]?,
|
537
|
+
start_time: ::Time?,
|
538
|
+
end_time: ::Time?
|
539
|
+
},
|
540
|
+
],
|
541
|
+
?next_token: ::String,
|
542
|
+
?max_results: ::Integer
|
543
|
+
) -> _ListPreviewRotationShiftsResponseSuccess
|
544
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListPreviewRotationShiftsResponseSuccess
|
545
|
+
|
546
|
+
interface _ListRotationOverridesResponseSuccess
|
547
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListRotationOverridesResult]
|
548
|
+
def rotation_overrides: () -> ::Array[Types::RotationOverride]
|
549
|
+
def next_token: () -> ::String
|
550
|
+
end
|
551
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#list_rotation_overrides-instance_method
|
552
|
+
def list_rotation_overrides: (
|
553
|
+
rotation_id: ::String,
|
554
|
+
start_time: ::Time,
|
555
|
+
end_time: ::Time,
|
556
|
+
?next_token: ::String,
|
557
|
+
?max_results: ::Integer
|
558
|
+
) -> _ListRotationOverridesResponseSuccess
|
559
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListRotationOverridesResponseSuccess
|
560
|
+
|
561
|
+
interface _ListRotationShiftsResponseSuccess
|
562
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListRotationShiftsResult]
|
563
|
+
def rotation_shifts: () -> ::Array[Types::RotationShift]
|
564
|
+
def next_token: () -> ::String
|
565
|
+
end
|
566
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#list_rotation_shifts-instance_method
|
567
|
+
def list_rotation_shifts: (
|
568
|
+
rotation_id: ::String,
|
569
|
+
?start_time: ::Time,
|
570
|
+
end_time: ::Time,
|
571
|
+
?next_token: ::String,
|
572
|
+
?max_results: ::Integer
|
573
|
+
) -> _ListRotationShiftsResponseSuccess
|
574
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListRotationShiftsResponseSuccess
|
575
|
+
|
576
|
+
interface _ListRotationsResponseSuccess
|
577
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListRotationsResult]
|
578
|
+
def next_token: () -> ::String
|
579
|
+
def rotations: () -> ::Array[Types::Rotation]
|
580
|
+
end
|
581
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#list_rotations-instance_method
|
582
|
+
def list_rotations: (
|
583
|
+
?rotation_name_prefix: ::String,
|
584
|
+
?next_token: ::String,
|
585
|
+
?max_results: ::Integer
|
586
|
+
) -> _ListRotationsResponseSuccess
|
587
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListRotationsResponseSuccess
|
588
|
+
|
589
|
+
interface _ListTagsForResourceResponseSuccess
|
590
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceResult]
|
591
|
+
def tags: () -> ::Array[Types::Tag]
|
592
|
+
end
|
593
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#list_tags_for_resource-instance_method
|
594
|
+
def list_tags_for_resource: (
|
595
|
+
resource_arn: ::String
|
596
|
+
) -> _ListTagsForResourceResponseSuccess
|
597
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTagsForResourceResponseSuccess
|
598
|
+
|
599
|
+
interface _PutContactPolicyResponseSuccess
|
600
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::PutContactPolicyResult]
|
601
|
+
end
|
602
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#put_contact_policy-instance_method
|
603
|
+
def put_contact_policy: (
|
604
|
+
contact_arn: ::String,
|
605
|
+
policy: ::String
|
606
|
+
) -> _PutContactPolicyResponseSuccess
|
607
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutContactPolicyResponseSuccess
|
608
|
+
|
609
|
+
interface _SendActivationCodeResponseSuccess
|
610
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SendActivationCodeResult]
|
611
|
+
end
|
612
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#send_activation_code-instance_method
|
613
|
+
def send_activation_code: (
|
614
|
+
contact_channel_id: ::String
|
615
|
+
) -> _SendActivationCodeResponseSuccess
|
616
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SendActivationCodeResponseSuccess
|
617
|
+
|
618
|
+
interface _StartEngagementResponseSuccess
|
619
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StartEngagementResult]
|
620
|
+
def engagement_arn: () -> ::String
|
621
|
+
end
|
622
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#start_engagement-instance_method
|
623
|
+
def start_engagement: (
|
624
|
+
contact_id: ::String,
|
625
|
+
sender: ::String,
|
626
|
+
subject: ::String,
|
627
|
+
content: ::String,
|
628
|
+
?public_subject: ::String,
|
629
|
+
?public_content: ::String,
|
630
|
+
?incident_id: ::String,
|
631
|
+
?idempotency_token: ::String
|
632
|
+
) -> _StartEngagementResponseSuccess
|
633
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartEngagementResponseSuccess
|
634
|
+
|
635
|
+
interface _StopEngagementResponseSuccess
|
636
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StopEngagementResult]
|
637
|
+
end
|
638
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#stop_engagement-instance_method
|
639
|
+
def stop_engagement: (
|
640
|
+
engagement_id: ::String,
|
641
|
+
?reason: ::String
|
642
|
+
) -> _StopEngagementResponseSuccess
|
643
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StopEngagementResponseSuccess
|
644
|
+
|
645
|
+
interface _TagResourceResponseSuccess
|
646
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::TagResourceResult]
|
647
|
+
end
|
648
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#tag_resource-instance_method
|
649
|
+
def tag_resource: (
|
650
|
+
resource_arn: ::String,
|
651
|
+
tags: Array[
|
652
|
+
{
|
653
|
+
key: ::String?,
|
654
|
+
value: ::String?
|
655
|
+
},
|
656
|
+
]
|
657
|
+
) -> _TagResourceResponseSuccess
|
658
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _TagResourceResponseSuccess
|
659
|
+
|
660
|
+
interface _UntagResourceResponseSuccess
|
661
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UntagResourceResult]
|
662
|
+
end
|
663
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#untag_resource-instance_method
|
664
|
+
def untag_resource: (
|
665
|
+
resource_arn: ::String,
|
666
|
+
tag_keys: Array[::String]
|
667
|
+
) -> _UntagResourceResponseSuccess
|
668
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UntagResourceResponseSuccess
|
669
|
+
|
670
|
+
interface _UpdateContactResponseSuccess
|
671
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateContactResult]
|
672
|
+
end
|
673
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#update_contact-instance_method
|
674
|
+
def update_contact: (
|
675
|
+
contact_id: ::String,
|
676
|
+
?display_name: ::String,
|
677
|
+
?plan: {
|
678
|
+
stages: Array[
|
679
|
+
{
|
680
|
+
duration_in_minutes: ::Integer,
|
681
|
+
targets: Array[
|
682
|
+
{
|
683
|
+
channel_target_info: {
|
684
|
+
contact_channel_id: ::String,
|
685
|
+
retry_interval_in_minutes: ::Integer?
|
686
|
+
}?,
|
687
|
+
contact_target_info: {
|
688
|
+
contact_id: ::String?,
|
689
|
+
is_essential: bool
|
690
|
+
}?
|
691
|
+
},
|
692
|
+
]
|
693
|
+
},
|
694
|
+
]?,
|
695
|
+
rotation_ids: Array[::String]?
|
696
|
+
}
|
697
|
+
) -> _UpdateContactResponseSuccess
|
698
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateContactResponseSuccess
|
699
|
+
|
700
|
+
interface _UpdateContactChannelResponseSuccess
|
701
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateContactChannelResult]
|
702
|
+
end
|
703
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#update_contact_channel-instance_method
|
704
|
+
def update_contact_channel: (
|
705
|
+
contact_channel_id: ::String,
|
706
|
+
?name: ::String,
|
707
|
+
?delivery_address: {
|
708
|
+
simple_address: ::String?
|
709
|
+
}
|
710
|
+
) -> _UpdateContactChannelResponseSuccess
|
711
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateContactChannelResponseSuccess
|
712
|
+
|
713
|
+
interface _UpdateRotationResponseSuccess
|
714
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateRotationResult]
|
715
|
+
end
|
716
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSMContacts/Client.html#update_rotation-instance_method
|
717
|
+
def update_rotation: (
|
718
|
+
rotation_id: ::String,
|
719
|
+
?contact_ids: Array[::String],
|
720
|
+
?start_time: ::Time,
|
721
|
+
?time_zone_id: ::String,
|
722
|
+
recurrence: {
|
723
|
+
monthly_settings: Array[
|
724
|
+
{
|
725
|
+
day_of_month: ::Integer,
|
726
|
+
hand_off_time: {
|
727
|
+
hour_of_day: ::Integer,
|
728
|
+
minute_of_hour: ::Integer
|
729
|
+
}
|
730
|
+
},
|
731
|
+
]?,
|
732
|
+
weekly_settings: Array[
|
733
|
+
{
|
734
|
+
day_of_week: ("MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "SUN"),
|
735
|
+
hand_off_time: {
|
736
|
+
hour_of_day: ::Integer,
|
737
|
+
minute_of_hour: ::Integer
|
738
|
+
}
|
739
|
+
},
|
740
|
+
]?,
|
741
|
+
daily_settings: Array[
|
742
|
+
{
|
743
|
+
hour_of_day: ::Integer,
|
744
|
+
minute_of_hour: ::Integer
|
745
|
+
},
|
746
|
+
]?,
|
747
|
+
number_of_on_calls: ::Integer,
|
748
|
+
shift_coverages: Hash[("MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "SUN"), Array[
|
749
|
+
{
|
750
|
+
start: {
|
751
|
+
hour_of_day: ::Integer,
|
752
|
+
minute_of_hour: ::Integer
|
753
|
+
}?,
|
754
|
+
end: {
|
755
|
+
hour_of_day: ::Integer,
|
756
|
+
minute_of_hour: ::Integer
|
757
|
+
}?
|
758
|
+
},
|
759
|
+
]]?,
|
760
|
+
recurrence_multiplier: ::Integer
|
761
|
+
}
|
762
|
+
) -> _UpdateRotationResponseSuccess
|
763
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateRotationResponseSuccess
|
764
|
+
end
|
765
|
+
end
|
766
|
+
end
|
767
|
+
|