aws-sdk-supportapp 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-supportapp/client.rb +758 -0
- data/lib/aws-sdk-supportapp/client_api.rb +294 -0
- data/lib/aws-sdk-supportapp/customizations.rb +0 -0
- data/lib/aws-sdk-supportapp/errors.rb +134 -0
- data/lib/aws-sdk-supportapp/resource.rb +26 -0
- data/lib/aws-sdk-supportapp/types.rb +587 -0
- data/lib/aws-sdk-supportapp.rb +53 -0
- metadata +90 -0
@@ -0,0 +1,587 @@
|
|
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::SupportApp
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# You don't have sufficient permission to perform this action.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] message
|
16
|
+
# @return [String]
|
17
|
+
#
|
18
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/AccessDeniedException AWS API Documentation
|
19
|
+
#
|
20
|
+
class AccessDeniedException < Struct.new(
|
21
|
+
:message)
|
22
|
+
SENSITIVE = []
|
23
|
+
include Aws::Structure
|
24
|
+
end
|
25
|
+
|
26
|
+
# Your request has a conflict. For example, you might receive this error
|
27
|
+
# if you try the following:
|
28
|
+
#
|
29
|
+
# * Add, update, or delete a Slack channel configuration before you add
|
30
|
+
# a Slack workspace to your Amazon Web Services account.
|
31
|
+
#
|
32
|
+
# * Add a Slack channel configuration that already exists in your Amazon
|
33
|
+
# Web Services account.
|
34
|
+
#
|
35
|
+
# * Delete a Slack channel configuration for a live chat channel.
|
36
|
+
#
|
37
|
+
# * Delete a Slack workspace from your Amazon Web Services account that
|
38
|
+
# has an active live chat channel.
|
39
|
+
#
|
40
|
+
# @!attribute [rw] message
|
41
|
+
# @return [String]
|
42
|
+
#
|
43
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/ConflictException AWS API Documentation
|
44
|
+
#
|
45
|
+
class ConflictException < Struct.new(
|
46
|
+
:message)
|
47
|
+
SENSITIVE = []
|
48
|
+
include Aws::Structure
|
49
|
+
end
|
50
|
+
|
51
|
+
# @note When making an API call, you may pass CreateSlackChannelConfigurationRequest
|
52
|
+
# data as a hash:
|
53
|
+
#
|
54
|
+
# {
|
55
|
+
# channel_id: "channelId", # required
|
56
|
+
# channel_name: "channelName",
|
57
|
+
# channel_role_arn: "roleArn", # required
|
58
|
+
# notify_on_add_correspondence_to_case: false,
|
59
|
+
# notify_on_case_severity: "none", # required, accepts none, all, high
|
60
|
+
# notify_on_create_or_reopen_case: false,
|
61
|
+
# notify_on_resolve_case: false,
|
62
|
+
# team_id: "teamId", # required
|
63
|
+
# }
|
64
|
+
#
|
65
|
+
# @!attribute [rw] channel_id
|
66
|
+
# The channel ID in Slack. This ID identifies a channel within a Slack
|
67
|
+
# workspace.
|
68
|
+
# @return [String]
|
69
|
+
#
|
70
|
+
# @!attribute [rw] channel_name
|
71
|
+
# The name of the Slack channel that you configure for the Amazon Web
|
72
|
+
# Services Support App.
|
73
|
+
# @return [String]
|
74
|
+
#
|
75
|
+
# @!attribute [rw] channel_role_arn
|
76
|
+
# The Amazon Resource Name (ARN) of an IAM role that you want to use
|
77
|
+
# to perform operations on Amazon Web Services. For more information,
|
78
|
+
# see [Managing access to the Amazon Web Services Support App][1] in
|
79
|
+
# the *Amazon Web Services Support User Guide*.
|
80
|
+
#
|
81
|
+
#
|
82
|
+
#
|
83
|
+
# [1]: https://docs.aws.amazon.com/awssupport/latest/user/support-app-permissions.html
|
84
|
+
# @return [String]
|
85
|
+
#
|
86
|
+
# @!attribute [rw] notify_on_add_correspondence_to_case
|
87
|
+
# Whether you want to get notified when a support case has a new
|
88
|
+
# correspondence.
|
89
|
+
# @return [Boolean]
|
90
|
+
#
|
91
|
+
# @!attribute [rw] notify_on_case_severity
|
92
|
+
# The case severity for a support case that you want to receive
|
93
|
+
# notifications.
|
94
|
+
#
|
95
|
+
# <p>If you specify <code>high</code> or <code>all</code>, you must specify <code>true</code> for at least one of the following parameters:</p> <ul> <li> <p> <code>notifyOnAddCorrespondenceToCase</code> </p> </li> <li> <p> <code>notifyOnCreateOrReopenCase</code> </p> </li> <li> <p> <code>notifyOnResolveCase</code> </p> </li> </ul> <p>If you specify <code>none</code>, the following parameters must be null or <code>false</code>:</p> <ul> <li> <p> <code>notifyOnAddCorrespondenceToCase</code> </p> </li> <li> <p> <code>notifyOnCreateOrReopenCase</code> </p> </li> <li> <p> <code>notifyOnResolveCase</code> </p> </li> </ul> <note> <p>If you don't specify these parameters in your request, they default to <code>false</code>.</p> </note>
|
96
|
+
# @return [String]
|
97
|
+
#
|
98
|
+
# @!attribute [rw] notify_on_create_or_reopen_case
|
99
|
+
# Whether you want to get notified when a support case is created or
|
100
|
+
# reopened.
|
101
|
+
# @return [Boolean]
|
102
|
+
#
|
103
|
+
# @!attribute [rw] notify_on_resolve_case
|
104
|
+
# Whether you want to get notified when a support case is resolved.
|
105
|
+
# @return [Boolean]
|
106
|
+
#
|
107
|
+
# @!attribute [rw] team_id
|
108
|
+
# The team ID in Slack. This ID uniquely identifies a Slack workspace.
|
109
|
+
# @return [String]
|
110
|
+
#
|
111
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/CreateSlackChannelConfigurationRequest AWS API Documentation
|
112
|
+
#
|
113
|
+
class CreateSlackChannelConfigurationRequest < Struct.new(
|
114
|
+
:channel_id,
|
115
|
+
:channel_name,
|
116
|
+
:channel_role_arn,
|
117
|
+
:notify_on_add_correspondence_to_case,
|
118
|
+
:notify_on_case_severity,
|
119
|
+
:notify_on_create_or_reopen_case,
|
120
|
+
:notify_on_resolve_case,
|
121
|
+
:team_id)
|
122
|
+
SENSITIVE = []
|
123
|
+
include Aws::Structure
|
124
|
+
end
|
125
|
+
|
126
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/CreateSlackChannelConfigurationResult AWS API Documentation
|
127
|
+
#
|
128
|
+
class CreateSlackChannelConfigurationResult < Aws::EmptyStructure; end
|
129
|
+
|
130
|
+
# @api private
|
131
|
+
#
|
132
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/DeleteAccountAliasRequest AWS API Documentation
|
133
|
+
#
|
134
|
+
class DeleteAccountAliasRequest < Aws::EmptyStructure; end
|
135
|
+
|
136
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/DeleteAccountAliasResult AWS API Documentation
|
137
|
+
#
|
138
|
+
class DeleteAccountAliasResult < Aws::EmptyStructure; end
|
139
|
+
|
140
|
+
# @note When making an API call, you may pass DeleteSlackChannelConfigurationRequest
|
141
|
+
# data as a hash:
|
142
|
+
#
|
143
|
+
# {
|
144
|
+
# channel_id: "channelId", # required
|
145
|
+
# team_id: "teamId", # required
|
146
|
+
# }
|
147
|
+
#
|
148
|
+
# @!attribute [rw] channel_id
|
149
|
+
# The channel ID in Slack. This ID identifies a channel within a Slack
|
150
|
+
# workspace.
|
151
|
+
# @return [String]
|
152
|
+
#
|
153
|
+
# @!attribute [rw] team_id
|
154
|
+
# The team ID in Slack. This ID uniquely identifies a Slack workspace.
|
155
|
+
# @return [String]
|
156
|
+
#
|
157
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/DeleteSlackChannelConfigurationRequest AWS API Documentation
|
158
|
+
#
|
159
|
+
class DeleteSlackChannelConfigurationRequest < Struct.new(
|
160
|
+
:channel_id,
|
161
|
+
:team_id)
|
162
|
+
SENSITIVE = []
|
163
|
+
include Aws::Structure
|
164
|
+
end
|
165
|
+
|
166
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/DeleteSlackChannelConfigurationResult AWS API Documentation
|
167
|
+
#
|
168
|
+
class DeleteSlackChannelConfigurationResult < Aws::EmptyStructure; end
|
169
|
+
|
170
|
+
# @note When making an API call, you may pass DeleteSlackWorkspaceConfigurationRequest
|
171
|
+
# data as a hash:
|
172
|
+
#
|
173
|
+
# {
|
174
|
+
# team_id: "teamId", # required
|
175
|
+
# }
|
176
|
+
#
|
177
|
+
# @!attribute [rw] team_id
|
178
|
+
# The team ID in Slack. This ID uniquely identifies a Slack workspace.
|
179
|
+
# @return [String]
|
180
|
+
#
|
181
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/DeleteSlackWorkspaceConfigurationRequest AWS API Documentation
|
182
|
+
#
|
183
|
+
class DeleteSlackWorkspaceConfigurationRequest < Struct.new(
|
184
|
+
:team_id)
|
185
|
+
SENSITIVE = []
|
186
|
+
include Aws::Structure
|
187
|
+
end
|
188
|
+
|
189
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/DeleteSlackWorkspaceConfigurationResult AWS API Documentation
|
190
|
+
#
|
191
|
+
class DeleteSlackWorkspaceConfigurationResult < Aws::EmptyStructure; end
|
192
|
+
|
193
|
+
# @api private
|
194
|
+
#
|
195
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/GetAccountAliasRequest AWS API Documentation
|
196
|
+
#
|
197
|
+
class GetAccountAliasRequest < Aws::EmptyStructure; end
|
198
|
+
|
199
|
+
# @!attribute [rw] account_alias
|
200
|
+
# An alias or short name for an Amazon Web Services account.
|
201
|
+
# @return [String]
|
202
|
+
#
|
203
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/GetAccountAliasResult AWS API Documentation
|
204
|
+
#
|
205
|
+
class GetAccountAliasResult < Struct.new(
|
206
|
+
:account_alias)
|
207
|
+
SENSITIVE = []
|
208
|
+
include Aws::Structure
|
209
|
+
end
|
210
|
+
|
211
|
+
# We can’t process your request right now because of a server issue. Try
|
212
|
+
# again later.
|
213
|
+
#
|
214
|
+
# @!attribute [rw] message
|
215
|
+
# @return [String]
|
216
|
+
#
|
217
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/InternalServerException AWS API Documentation
|
218
|
+
#
|
219
|
+
class InternalServerException < Struct.new(
|
220
|
+
:message)
|
221
|
+
SENSITIVE = []
|
222
|
+
include Aws::Structure
|
223
|
+
end
|
224
|
+
|
225
|
+
# @note When making an API call, you may pass ListSlackChannelConfigurationsRequest
|
226
|
+
# data as a hash:
|
227
|
+
#
|
228
|
+
# {
|
229
|
+
# next_token: "paginationToken",
|
230
|
+
# }
|
231
|
+
#
|
232
|
+
# @!attribute [rw] next_token
|
233
|
+
# If the results of a search are large, the API only returns a portion
|
234
|
+
# of the results and includes a `nextToken` pagination token in the
|
235
|
+
# response. To retrieve the next batch of results, reissue the search
|
236
|
+
# request and include the returned token. When the API returns the
|
237
|
+
# last set of results, the response doesn't include a pagination
|
238
|
+
# token value.
|
239
|
+
# @return [String]
|
240
|
+
#
|
241
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/ListSlackChannelConfigurationsRequest AWS API Documentation
|
242
|
+
#
|
243
|
+
class ListSlackChannelConfigurationsRequest < Struct.new(
|
244
|
+
:next_token)
|
245
|
+
SENSITIVE = []
|
246
|
+
include Aws::Structure
|
247
|
+
end
|
248
|
+
|
249
|
+
# @!attribute [rw] next_token
|
250
|
+
# The point where pagination should resume when the response returns
|
251
|
+
# only partial results.
|
252
|
+
# @return [String]
|
253
|
+
#
|
254
|
+
# @!attribute [rw] slack_channel_configurations
|
255
|
+
# The configurations for a Slack channel.
|
256
|
+
# @return [Array<Types::SlackChannelConfiguration>]
|
257
|
+
#
|
258
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/ListSlackChannelConfigurationsResult AWS API Documentation
|
259
|
+
#
|
260
|
+
class ListSlackChannelConfigurationsResult < Struct.new(
|
261
|
+
:next_token,
|
262
|
+
:slack_channel_configurations)
|
263
|
+
SENSITIVE = []
|
264
|
+
include Aws::Structure
|
265
|
+
end
|
266
|
+
|
267
|
+
# @note When making an API call, you may pass ListSlackWorkspaceConfigurationsRequest
|
268
|
+
# data as a hash:
|
269
|
+
#
|
270
|
+
# {
|
271
|
+
# next_token: "paginationToken",
|
272
|
+
# }
|
273
|
+
#
|
274
|
+
# @!attribute [rw] next_token
|
275
|
+
# If the results of a search are large, the API only returns a portion
|
276
|
+
# of the results and includes a `nextToken` pagination token in the
|
277
|
+
# response. To retrieve the next batch of results, reissue the search
|
278
|
+
# request and include the returned token. When the API returns the
|
279
|
+
# last set of results, the response doesn't include a pagination
|
280
|
+
# token value.
|
281
|
+
# @return [String]
|
282
|
+
#
|
283
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/ListSlackWorkspaceConfigurationsRequest AWS API Documentation
|
284
|
+
#
|
285
|
+
class ListSlackWorkspaceConfigurationsRequest < Struct.new(
|
286
|
+
:next_token)
|
287
|
+
SENSITIVE = []
|
288
|
+
include Aws::Structure
|
289
|
+
end
|
290
|
+
|
291
|
+
# @!attribute [rw] next_token
|
292
|
+
# The point where pagination should resume when the response returns
|
293
|
+
# only partial results.
|
294
|
+
# @return [String]
|
295
|
+
#
|
296
|
+
# @!attribute [rw] slack_workspace_configurations
|
297
|
+
# The configurations for a Slack workspace.
|
298
|
+
# @return [Array<Types::SlackWorkspaceConfiguration>]
|
299
|
+
#
|
300
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/ListSlackWorkspaceConfigurationsResult AWS API Documentation
|
301
|
+
#
|
302
|
+
class ListSlackWorkspaceConfigurationsResult < Struct.new(
|
303
|
+
:next_token,
|
304
|
+
:slack_workspace_configurations)
|
305
|
+
SENSITIVE = []
|
306
|
+
include Aws::Structure
|
307
|
+
end
|
308
|
+
|
309
|
+
# @note When making an API call, you may pass PutAccountAliasRequest
|
310
|
+
# data as a hash:
|
311
|
+
#
|
312
|
+
# {
|
313
|
+
# account_alias: "awsAccountAlias", # required
|
314
|
+
# }
|
315
|
+
#
|
316
|
+
# @!attribute [rw] account_alias
|
317
|
+
# An alias or short name for an Amazon Web Services account.
|
318
|
+
# @return [String]
|
319
|
+
#
|
320
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/PutAccountAliasRequest AWS API Documentation
|
321
|
+
#
|
322
|
+
class PutAccountAliasRequest < Struct.new(
|
323
|
+
:account_alias)
|
324
|
+
SENSITIVE = []
|
325
|
+
include Aws::Structure
|
326
|
+
end
|
327
|
+
|
328
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/PutAccountAliasResult AWS API Documentation
|
329
|
+
#
|
330
|
+
class PutAccountAliasResult < Aws::EmptyStructure; end
|
331
|
+
|
332
|
+
# The specified resource is missing or doesn't exist, such as an
|
333
|
+
# account alias or Slack channel configuration.
|
334
|
+
#
|
335
|
+
# @!attribute [rw] message
|
336
|
+
# @return [String]
|
337
|
+
#
|
338
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/ResourceNotFoundException AWS API Documentation
|
339
|
+
#
|
340
|
+
class ResourceNotFoundException < Struct.new(
|
341
|
+
:message)
|
342
|
+
SENSITIVE = []
|
343
|
+
include Aws::Structure
|
344
|
+
end
|
345
|
+
|
346
|
+
# Your Service Quotas request exceeds the quota for the service. For
|
347
|
+
# example, your Service Quotas request to Amazon Web Services Support
|
348
|
+
# App might exceed the maximum number of workspaces or channels per
|
349
|
+
# account, or the maximum number of accounts per Slack channel.
|
350
|
+
#
|
351
|
+
# @!attribute [rw] message
|
352
|
+
# @return [String]
|
353
|
+
#
|
354
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/ServiceQuotaExceededException AWS API Documentation
|
355
|
+
#
|
356
|
+
class ServiceQuotaExceededException < Struct.new(
|
357
|
+
:message)
|
358
|
+
SENSITIVE = []
|
359
|
+
include Aws::Structure
|
360
|
+
end
|
361
|
+
|
362
|
+
# The configuration for a Slack channel that you added to an Amazon Web
|
363
|
+
# Services account.
|
364
|
+
#
|
365
|
+
# @!attribute [rw] channel_id
|
366
|
+
# The channel ID in Slack. This ID identifies a channel within a Slack
|
367
|
+
# workspace.
|
368
|
+
# @return [String]
|
369
|
+
#
|
370
|
+
# @!attribute [rw] channel_name
|
371
|
+
# The name of the Slack channel that you configured with the Amazon
|
372
|
+
# Web Services Support App.
|
373
|
+
# @return [String]
|
374
|
+
#
|
375
|
+
# @!attribute [rw] channel_role_arn
|
376
|
+
# The Amazon Resource Name (ARN) of an IAM role that you want to use
|
377
|
+
# to perform operations on Amazon Web Services. For more information,
|
378
|
+
# see [Managing access to the Amazon Web Services Support App][1] in
|
379
|
+
# the *Amazon Web Services Support User Guide*.
|
380
|
+
#
|
381
|
+
#
|
382
|
+
#
|
383
|
+
# [1]: https://docs.aws.amazon.com/awssupport/latest/user/support-app-permissions.html
|
384
|
+
# @return [String]
|
385
|
+
#
|
386
|
+
# @!attribute [rw] notify_on_add_correspondence_to_case
|
387
|
+
# Whether you want to get notified when a support case has a new
|
388
|
+
# correspondence.
|
389
|
+
# @return [Boolean]
|
390
|
+
#
|
391
|
+
# @!attribute [rw] notify_on_case_severity
|
392
|
+
# The case severity for a support case that you want to receive
|
393
|
+
# notifications.
|
394
|
+
# @return [String]
|
395
|
+
#
|
396
|
+
# @!attribute [rw] notify_on_create_or_reopen_case
|
397
|
+
# Whether you want to get notified when a support case is created or
|
398
|
+
# reopened.
|
399
|
+
# @return [Boolean]
|
400
|
+
#
|
401
|
+
# @!attribute [rw] notify_on_resolve_case
|
402
|
+
# Whether you want to get notified when a support case is resolved.
|
403
|
+
# @return [Boolean]
|
404
|
+
#
|
405
|
+
# @!attribute [rw] team_id
|
406
|
+
# The team ID in Slack. This ID uniquely identifies a Slack workspace.
|
407
|
+
# @return [String]
|
408
|
+
#
|
409
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/SlackChannelConfiguration AWS API Documentation
|
410
|
+
#
|
411
|
+
class SlackChannelConfiguration < Struct.new(
|
412
|
+
:channel_id,
|
413
|
+
:channel_name,
|
414
|
+
:channel_role_arn,
|
415
|
+
:notify_on_add_correspondence_to_case,
|
416
|
+
:notify_on_case_severity,
|
417
|
+
:notify_on_create_or_reopen_case,
|
418
|
+
:notify_on_resolve_case,
|
419
|
+
:team_id)
|
420
|
+
SENSITIVE = []
|
421
|
+
include Aws::Structure
|
422
|
+
end
|
423
|
+
|
424
|
+
# The configuration for a Slack workspace that you added to an Amazon
|
425
|
+
# Web Services account.
|
426
|
+
#
|
427
|
+
# @!attribute [rw] team_id
|
428
|
+
# The team ID in Slack. This ID uniquely identifies a Slack workspace.
|
429
|
+
# @return [String]
|
430
|
+
#
|
431
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/SlackWorkspaceConfiguration AWS API Documentation
|
432
|
+
#
|
433
|
+
class SlackWorkspaceConfiguration < Struct.new(
|
434
|
+
:team_id)
|
435
|
+
SENSITIVE = []
|
436
|
+
include Aws::Structure
|
437
|
+
end
|
438
|
+
|
439
|
+
# @note When making an API call, you may pass UpdateSlackChannelConfigurationRequest
|
440
|
+
# data as a hash:
|
441
|
+
#
|
442
|
+
# {
|
443
|
+
# channel_id: "channelId", # required
|
444
|
+
# channel_name: "channelName",
|
445
|
+
# channel_role_arn: "roleArn",
|
446
|
+
# notify_on_add_correspondence_to_case: false,
|
447
|
+
# notify_on_case_severity: "none", # accepts none, all, high
|
448
|
+
# notify_on_create_or_reopen_case: false,
|
449
|
+
# notify_on_resolve_case: false,
|
450
|
+
# team_id: "teamId", # required
|
451
|
+
# }
|
452
|
+
#
|
453
|
+
# @!attribute [rw] channel_id
|
454
|
+
# The channel ID in Slack. This ID identifies a channel within a Slack
|
455
|
+
# workspace.
|
456
|
+
# @return [String]
|
457
|
+
#
|
458
|
+
# @!attribute [rw] channel_name
|
459
|
+
# The Slack channel name that you want to update.
|
460
|
+
# @return [String]
|
461
|
+
#
|
462
|
+
# @!attribute [rw] channel_role_arn
|
463
|
+
# The Amazon Resource Name (ARN) of an IAM role that you want to use
|
464
|
+
# to perform operations on Amazon Web Services. For more information,
|
465
|
+
# see [Managing access to the Amazon Web Services Support App][1] in
|
466
|
+
# the *Amazon Web Services Support User Guide*.
|
467
|
+
#
|
468
|
+
#
|
469
|
+
#
|
470
|
+
# [1]: https://docs.aws.amazon.com/awssupport/latest/user/support-app-permissions.html
|
471
|
+
# @return [String]
|
472
|
+
#
|
473
|
+
# @!attribute [rw] notify_on_add_correspondence_to_case
|
474
|
+
# Whether you want to get notified when a support case has a new
|
475
|
+
# correspondence.
|
476
|
+
# @return [Boolean]
|
477
|
+
#
|
478
|
+
# @!attribute [rw] notify_on_case_severity
|
479
|
+
# The case severity for a support case that you want to receive
|
480
|
+
# notifications.
|
481
|
+
#
|
482
|
+
# <p>If you specify <code>high</code> or <code>all</code>, at least one of the following parameters must be <code>true</code>:</p> <ul> <li> <p> <code>notifyOnAddCorrespondenceToCase</code> </p> </li> <li> <p> <code>notifyOnCreateOrReopenCase</code> </p> </li> <li> <p> <code>notifyOnResolveCase</code> </p> </li> </ul> <p>If you specify <code>none</code>, any of the following parameters that you specify in your request must be <code>false</code>:</p> <ul> <li> <p> <code>notifyOnAddCorrespondenceToCase</code> </p> </li> <li> <p> <code>notifyOnCreateOrReopenCase</code> </p> </li> <li> <p> <code>notifyOnResolveCase</code> </p> </li> </ul> <note> <p>If you don't specify these parameters in your request, the Amazon Web Services Support App uses the current values by default.</p> </note>
|
483
|
+
# @return [String]
|
484
|
+
#
|
485
|
+
# @!attribute [rw] notify_on_create_or_reopen_case
|
486
|
+
# Whether you want to get notified when a support case is created or
|
487
|
+
# reopened.
|
488
|
+
# @return [Boolean]
|
489
|
+
#
|
490
|
+
# @!attribute [rw] notify_on_resolve_case
|
491
|
+
# Whether you want to get notified when a support case is resolved.
|
492
|
+
# @return [Boolean]
|
493
|
+
#
|
494
|
+
# @!attribute [rw] team_id
|
495
|
+
# The team ID in Slack. This ID uniquely identifies a Slack workspace.
|
496
|
+
# @return [String]
|
497
|
+
#
|
498
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/UpdateSlackChannelConfigurationRequest AWS API Documentation
|
499
|
+
#
|
500
|
+
class UpdateSlackChannelConfigurationRequest < Struct.new(
|
501
|
+
:channel_id,
|
502
|
+
:channel_name,
|
503
|
+
:channel_role_arn,
|
504
|
+
:notify_on_add_correspondence_to_case,
|
505
|
+
:notify_on_case_severity,
|
506
|
+
:notify_on_create_or_reopen_case,
|
507
|
+
:notify_on_resolve_case,
|
508
|
+
:team_id)
|
509
|
+
SENSITIVE = []
|
510
|
+
include Aws::Structure
|
511
|
+
end
|
512
|
+
|
513
|
+
# @!attribute [rw] channel_id
|
514
|
+
# The channel ID in Slack. This ID identifies a channel within a Slack
|
515
|
+
# workspace.
|
516
|
+
# @return [String]
|
517
|
+
#
|
518
|
+
# @!attribute [rw] channel_name
|
519
|
+
# The name of the Slack channel that you configure for the Amazon Web
|
520
|
+
# Services Support App.
|
521
|
+
# @return [String]
|
522
|
+
#
|
523
|
+
# @!attribute [rw] channel_role_arn
|
524
|
+
# The Amazon Resource Name (ARN) of an IAM role that you want to use
|
525
|
+
# to perform operations on Amazon Web Services. For more information,
|
526
|
+
# see [Managing access to the Amazon Web Services Support App][1] in
|
527
|
+
# the *Amazon Web Services Support User Guide*.
|
528
|
+
#
|
529
|
+
#
|
530
|
+
#
|
531
|
+
# [1]: https://docs.aws.amazon.com/awssupport/latest/user/support-app-permissions.html
|
532
|
+
# @return [String]
|
533
|
+
#
|
534
|
+
# @!attribute [rw] notify_on_add_correspondence_to_case
|
535
|
+
# Whether you want to get notified when a support case has a new
|
536
|
+
# correspondence.
|
537
|
+
# @return [Boolean]
|
538
|
+
#
|
539
|
+
# @!attribute [rw] notify_on_case_severity
|
540
|
+
# The case severity for a support case that you want to receive
|
541
|
+
# notifications.
|
542
|
+
# @return [String]
|
543
|
+
#
|
544
|
+
# @!attribute [rw] notify_on_create_or_reopen_case
|
545
|
+
# Whether you want to get notified when a support case is created or
|
546
|
+
# reopened.
|
547
|
+
# @return [Boolean]
|
548
|
+
#
|
549
|
+
# @!attribute [rw] notify_on_resolve_case
|
550
|
+
# Whether you want to get notified when a support case is resolved.
|
551
|
+
# @return [Boolean]
|
552
|
+
#
|
553
|
+
# @!attribute [rw] team_id
|
554
|
+
# The team ID in Slack. This ID uniquely identifies a Slack workspace.
|
555
|
+
# @return [String]
|
556
|
+
#
|
557
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/UpdateSlackChannelConfigurationResult AWS API Documentation
|
558
|
+
#
|
559
|
+
class UpdateSlackChannelConfigurationResult < Struct.new(
|
560
|
+
:channel_id,
|
561
|
+
:channel_name,
|
562
|
+
:channel_role_arn,
|
563
|
+
:notify_on_add_correspondence_to_case,
|
564
|
+
:notify_on_case_severity,
|
565
|
+
:notify_on_create_or_reopen_case,
|
566
|
+
:notify_on_resolve_case,
|
567
|
+
:team_id)
|
568
|
+
SENSITIVE = []
|
569
|
+
include Aws::Structure
|
570
|
+
end
|
571
|
+
|
572
|
+
# Your request input doesn't meet the constraints that the Amazon Web
|
573
|
+
# Services Support App specifies.
|
574
|
+
#
|
575
|
+
# @!attribute [rw] message
|
576
|
+
# @return [String]
|
577
|
+
#
|
578
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/ValidationException AWS API Documentation
|
579
|
+
#
|
580
|
+
class ValidationException < Struct.new(
|
581
|
+
:message)
|
582
|
+
SENSITIVE = []
|
583
|
+
include Aws::Structure
|
584
|
+
end
|
585
|
+
|
586
|
+
end
|
587
|
+
end
|
@@ -0,0 +1,53 @@
|
|
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
|
+
|
11
|
+
require 'aws-sdk-core'
|
12
|
+
require 'aws-sigv4'
|
13
|
+
|
14
|
+
require_relative 'aws-sdk-supportapp/types'
|
15
|
+
require_relative 'aws-sdk-supportapp/client_api'
|
16
|
+
require_relative 'aws-sdk-supportapp/client'
|
17
|
+
require_relative 'aws-sdk-supportapp/errors'
|
18
|
+
require_relative 'aws-sdk-supportapp/resource'
|
19
|
+
require_relative 'aws-sdk-supportapp/customizations'
|
20
|
+
|
21
|
+
# This module provides support for AWS Support App. This module is available in the
|
22
|
+
# `aws-sdk-supportapp` gem.
|
23
|
+
#
|
24
|
+
# # Client
|
25
|
+
#
|
26
|
+
# The {Client} class provides one method for each API operation. Operation
|
27
|
+
# methods each accept a hash of request parameters and return a response
|
28
|
+
# structure.
|
29
|
+
#
|
30
|
+
# support_app = Aws::SupportApp::Client.new
|
31
|
+
# resp = support_app.create_slack_channel_configuration(params)
|
32
|
+
#
|
33
|
+
# See {Client} for more information.
|
34
|
+
#
|
35
|
+
# # Errors
|
36
|
+
#
|
37
|
+
# Errors returned from AWS Support App are defined in the
|
38
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
39
|
+
#
|
40
|
+
# begin
|
41
|
+
# # do stuff
|
42
|
+
# rescue Aws::SupportApp::Errors::ServiceError
|
43
|
+
# # rescues all AWS Support App API errors
|
44
|
+
# end
|
45
|
+
#
|
46
|
+
# See {Errors} for more information.
|
47
|
+
#
|
48
|
+
# @!group service
|
49
|
+
module Aws::SupportApp
|
50
|
+
|
51
|
+
GEM_VERSION = '1.0.0'
|
52
|
+
|
53
|
+
end
|