aws-sdk-support 1.0.0.rc1

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.
File without changes
@@ -0,0 +1,23 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing for info on making contributions:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws
9
+ module Support
10
+ module Errors
11
+
12
+ extend Aws::Errors::DynamicErrors
13
+
14
+ # Raised when calling #load or #data on a resource class that can not be
15
+ # loaded. This can happen when:
16
+ #
17
+ # * A resource class has identifiers, but no data attributes.
18
+ # * Resource data is only available when making an API call that
19
+ # enumerates all resources of that type.
20
+ class ResourceNotLoadable < RuntimeError; end
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,25 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing for info on making contributions:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws
9
+ module Support
10
+ class Resource
11
+
12
+ # @param options ({})
13
+ # @option options [Client] :client
14
+ def initialize(options = {})
15
+ @client = options[:client] || Client.new(options)
16
+ end
17
+
18
+ # @return [Client]
19
+ def client
20
+ @client
21
+ end
22
+
23
+ end
24
+ end
25
+ end
@@ -0,0 +1,1085 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing for info on making contributions:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws
9
+ module Support
10
+ module Types
11
+
12
+ # @note When making an API call, pass AddAttachmentsToSetRequest
13
+ # data as a hash:
14
+ #
15
+ # {
16
+ # attachment_set_id: "AttachmentSetId",
17
+ # attachments: [ # required
18
+ # {
19
+ # file_name: "FileName",
20
+ # data: "data",
21
+ # },
22
+ # ],
23
+ # }
24
+ # @!attribute [rw] attachment_set_id
25
+ # The ID of the attachment set. If an `attachmentSetId` is not
26
+ # specified, a new attachment set is created, and the ID of the set is
27
+ # returned in the response. If an `attachmentSetId` is specified, the
28
+ # attachments are added to the specified set, if it exists.
29
+ # @return [String]
30
+ #
31
+ # @!attribute [rw] attachments
32
+ # One or more attachments to add to the set. The limit is 3
33
+ # attachments per set, and the size limit is 5 MB per attachment.
34
+ # @return [Array<Types::Attachment>]
35
+ class AddAttachmentsToSetRequest < Struct.new(
36
+ :attachment_set_id,
37
+ :attachments)
38
+ include Aws::Structure
39
+ end
40
+
41
+ # The ID and expiry time of the attachment set returned by the
42
+ # AddAttachmentsToSet operation.
43
+ # @!attribute [rw] attachment_set_id
44
+ # The ID of the attachment set. If an `attachmentSetId` was not
45
+ # specified, a new attachment set is created, and the ID of the set is
46
+ # returned in the response. If an `attachmentSetId` was specified, the
47
+ # attachments are added to the specified set, if it exists.
48
+ # @return [String]
49
+ #
50
+ # @!attribute [rw] expiry_time
51
+ # The time and date when the attachment set expires.
52
+ # @return [String]
53
+ class AddAttachmentsToSetResponse < Struct.new(
54
+ :attachment_set_id,
55
+ :expiry_time)
56
+ include Aws::Structure
57
+ end
58
+
59
+ # To be written.
60
+ # @note When making an API call, pass AddCommunicationToCaseRequest
61
+ # data as a hash:
62
+ #
63
+ # {
64
+ # case_id: "CaseId",
65
+ # communication_body: "CommunicationBody", # required
66
+ # cc_email_addresses: ["CcEmailAddress"],
67
+ # attachment_set_id: "AttachmentSetId",
68
+ # }
69
+ # @!attribute [rw] case_id
70
+ # The AWS Support case ID requested or returned in the call. The case
71
+ # ID is an alphanumeric string formatted as shown in this example:
72
+ # case-*12345678910-2013-c4c1d2bf33c5cf47*
73
+ # @return [String]
74
+ #
75
+ # @!attribute [rw] communication_body
76
+ # The body of an email communication to add to the support case.
77
+ # @return [String]
78
+ #
79
+ # @!attribute [rw] cc_email_addresses
80
+ # The email addresses in the CC line of an email to be added to the
81
+ # support case.
82
+ # @return [Array<String>]
83
+ #
84
+ # @!attribute [rw] attachment_set_id
85
+ # The ID of a set of one or more attachments for the communication to
86
+ # add to the case. Create the set by calling AddAttachmentsToSet
87
+ # @return [String]
88
+ class AddCommunicationToCaseRequest < Struct.new(
89
+ :case_id,
90
+ :communication_body,
91
+ :cc_email_addresses,
92
+ :attachment_set_id)
93
+ include Aws::Structure
94
+ end
95
+
96
+ # The result of the AddCommunicationToCase operation.
97
+ # @!attribute [rw] result
98
+ # True if AddCommunicationToCase succeeds. Otherwise, returns an
99
+ # error.
100
+ # @return [Boolean]
101
+ class AddCommunicationToCaseResponse < Struct.new(
102
+ :result)
103
+ include Aws::Structure
104
+ end
105
+
106
+ # An attachment to a case communication. The attachment consists of the
107
+ # file name and the content of the file.
108
+ # @note When making an API call, pass Attachment
109
+ # data as a hash:
110
+ #
111
+ # {
112
+ # file_name: "FileName",
113
+ # data: "data",
114
+ # }
115
+ # @!attribute [rw] file_name
116
+ # The name of the attachment file.
117
+ # @return [String]
118
+ #
119
+ # @!attribute [rw] data
120
+ # The content of the attachment file.
121
+ # @return [String]
122
+ class Attachment < Struct.new(
123
+ :file_name,
124
+ :data)
125
+ include Aws::Structure
126
+ end
127
+
128
+ # The file name and ID of an attachment to a case communication. You can
129
+ # use the ID to retrieve the attachment with the DescribeAttachment
130
+ # operation.
131
+ # @!attribute [rw] attachment_id
132
+ # The ID of the attachment.
133
+ # @return [String]
134
+ #
135
+ # @!attribute [rw] file_name
136
+ # The file name of the attachment.
137
+ # @return [String]
138
+ class AttachmentDetails < Struct.new(
139
+ :attachment_id,
140
+ :file_name)
141
+ include Aws::Structure
142
+ end
143
+
144
+ # A JSON-formatted object that contains the metadata for a support case.
145
+ # It is contained the response from a DescribeCases request.
146
+ # **CaseDetails** contains the following fields:
147
+ #
148
+ # * **caseId.** The AWS Support case ID requested or returned in the
149
+ # call. The case ID is an alphanumeric string formatted as shown in
150
+ # this example: case-*12345678910-2013-c4c1d2bf33c5cf47*.
151
+ #
152
+ # * **categoryCode.** The category of problem for the AWS Support case.
153
+ # Corresponds to the CategoryCode values returned by a call to
154
+ # DescribeServices.
155
+ #
156
+ # * **displayId.** The identifier for the case on pages in the AWS
157
+ # Support Center.
158
+ #
159
+ # * **language.** The ISO 639-1 code for the language in which AWS
160
+ # provides support. AWS Support currently supports English ("en")
161
+ # and Japanese ("ja"). Language parameters must be passed explicitly
162
+ # for operations that take them.
163
+ #
164
+ # * **recentCommunications.** One or more Communication objects. Fields
165
+ # of these objects are `attachments`, `body`, `caseId`, `submittedBy`,
166
+ # and `timeCreated`.
167
+ #
168
+ # * **nextToken.** A resumption point for pagination.
169
+ #
170
+ # * **serviceCode.** The identifier for the AWS service that corresponds
171
+ # to the service code defined in the call to DescribeServices.
172
+ #
173
+ # * <b>severityCode. </b>The severity code assigned to the case.
174
+ # Contains one of the values returned by the call to
175
+ # DescribeSeverityLevels.
176
+ #
177
+ # * **status.** The status of the case in the AWS Support Center.
178
+ #
179
+ # * **subject.** The subject line of the case.
180
+ #
181
+ # * **submittedBy.** The email address of the account that submitted the
182
+ # case.
183
+ #
184
+ # * **timeCreated.** The time the case was created, in ISO-8601 format.
185
+ # @!attribute [rw] case_id
186
+ # The AWS Support case ID requested or returned in the call. The case
187
+ # ID is an alphanumeric string formatted as shown in this example:
188
+ # case-*12345678910-2013-c4c1d2bf33c5cf47*
189
+ # @return [String]
190
+ #
191
+ # @!attribute [rw] display_id
192
+ # The ID displayed for the case in the AWS Support Center. This is a
193
+ # numeric string.
194
+ # @return [String]
195
+ #
196
+ # @!attribute [rw] subject
197
+ # The subject line for the case in the AWS Support Center.
198
+ # @return [String]
199
+ #
200
+ # @!attribute [rw] status
201
+ # The status of the case.
202
+ # @return [String]
203
+ #
204
+ # @!attribute [rw] service_code
205
+ # The code for the AWS service returned by the call to
206
+ # DescribeServices.
207
+ # @return [String]
208
+ #
209
+ # @!attribute [rw] category_code
210
+ # The category of problem for the AWS Support case.
211
+ # @return [String]
212
+ #
213
+ # @!attribute [rw] severity_code
214
+ # The code for the severity level returned by the call to
215
+ # DescribeSeverityLevels.
216
+ # @return [String]
217
+ #
218
+ # @!attribute [rw] submitted_by
219
+ # The email address of the account that submitted the case.
220
+ # @return [String]
221
+ #
222
+ # @!attribute [rw] time_created
223
+ # The time that the case was case created in the AWS Support Center.
224
+ # @return [String]
225
+ #
226
+ # @!attribute [rw] recent_communications
227
+ # The five most recent communications between you and AWS Support
228
+ # Center, including the IDs of any attachments to the communications.
229
+ # Also includes a `nextToken` that you can use to retrieve earlier
230
+ # communications.
231
+ # @return [Types::RecentCaseCommunications]
232
+ #
233
+ # @!attribute [rw] cc_email_addresses
234
+ # The email addresses that receive copies of communication about the
235
+ # case.
236
+ # @return [Array<String>]
237
+ #
238
+ # @!attribute [rw] language
239
+ # The ISO 639-1 code for the language in which AWS provides support.
240
+ # AWS Support currently supports English ("en") and Japanese
241
+ # ("ja"). Language parameters must be passed explicitly for
242
+ # operations that take them.
243
+ # @return [String]
244
+ class CaseDetails < Struct.new(
245
+ :case_id,
246
+ :display_id,
247
+ :subject,
248
+ :status,
249
+ :service_code,
250
+ :category_code,
251
+ :severity_code,
252
+ :submitted_by,
253
+ :time_created,
254
+ :recent_communications,
255
+ :cc_email_addresses,
256
+ :language)
257
+ include Aws::Structure
258
+ end
259
+
260
+ # A JSON-formatted name/value pair that represents the category name and
261
+ # category code of the problem, selected from the DescribeServices
262
+ # response for each AWS service.
263
+ # @!attribute [rw] code
264
+ # The category code for the support case.
265
+ # @return [String]
266
+ #
267
+ # @!attribute [rw] name
268
+ # The category name for the support case.
269
+ # @return [String]
270
+ class Category < Struct.new(
271
+ :code,
272
+ :name)
273
+ include Aws::Structure
274
+ end
275
+
276
+ # A communication associated with an AWS Support case. The communication
277
+ # consists of the case ID, the message body, attachment information, the
278
+ # account email address, and the date and time of the communication.
279
+ # @!attribute [rw] case_id
280
+ # The AWS Support case ID requested or returned in the call. The case
281
+ # ID is an alphanumeric string formatted as shown in this example:
282
+ # case-*12345678910-2013-c4c1d2bf33c5cf47*
283
+ # @return [String]
284
+ #
285
+ # @!attribute [rw] body
286
+ # The text of the communication between the customer and AWS Support.
287
+ # @return [String]
288
+ #
289
+ # @!attribute [rw] submitted_by
290
+ # The email address of the account that submitted the AWS Support
291
+ # case.
292
+ # @return [String]
293
+ #
294
+ # @!attribute [rw] time_created
295
+ # The time the communication was created.
296
+ # @return [String]
297
+ #
298
+ # @!attribute [rw] attachment_set
299
+ # Information about the attachments to the case communication.
300
+ # @return [Array<Types::AttachmentDetails>]
301
+ class Communication < Struct.new(
302
+ :case_id,
303
+ :body,
304
+ :submitted_by,
305
+ :time_created,
306
+ :attachment_set)
307
+ include Aws::Structure
308
+ end
309
+
310
+ # @note When making an API call, pass CreateCaseRequest
311
+ # data as a hash:
312
+ #
313
+ # {
314
+ # subject: "Subject", # required
315
+ # service_code: "ServiceCode",
316
+ # severity_code: "SeverityCode",
317
+ # category_code: "CategoryCode",
318
+ # communication_body: "CommunicationBody", # required
319
+ # cc_email_addresses: ["CcEmailAddress"],
320
+ # language: "Language",
321
+ # issue_type: "IssueType",
322
+ # attachment_set_id: "AttachmentSetId",
323
+ # }
324
+ # @!attribute [rw] subject
325
+ # The title of the AWS Support case.
326
+ # @return [String]
327
+ #
328
+ # @!attribute [rw] service_code
329
+ # The code for the AWS service returned by the call to
330
+ # DescribeServices.
331
+ # @return [String]
332
+ #
333
+ # @!attribute [rw] severity_code
334
+ # The code for the severity level returned by the call to
335
+ # DescribeSeverityLevels.
336
+ #
337
+ # <note markdown="1"> The availability of severity levels depends on each customer's
338
+ # support subscription. In other words, your subscription may not
339
+ # necessarily require the urgent level of response time.
340
+ #
341
+ # </note>
342
+ # @return [String]
343
+ #
344
+ # @!attribute [rw] category_code
345
+ # The category of problem for the AWS Support case.
346
+ # @return [String]
347
+ #
348
+ # @!attribute [rw] communication_body
349
+ # The communication body text when you create an AWS Support case by
350
+ # calling CreateCase.
351
+ # @return [String]
352
+ #
353
+ # @!attribute [rw] cc_email_addresses
354
+ # A list of email addresses that AWS Support copies on case
355
+ # correspondence.
356
+ # @return [Array<String>]
357
+ #
358
+ # @!attribute [rw] language
359
+ # The ISO 639-1 code for the language in which AWS provides support.
360
+ # AWS Support currently supports English ("en") and Japanese
361
+ # ("ja"). Language parameters must be passed explicitly for
362
+ # operations that take them.
363
+ # @return [String]
364
+ #
365
+ # @!attribute [rw] issue_type
366
+ # The type of issue for the case. You can specify either
367
+ # "customer-service" or "technical." If you do not indicate a
368
+ # value, the default is "technical."
369
+ # @return [String]
370
+ #
371
+ # @!attribute [rw] attachment_set_id
372
+ # The ID of a set of one or more attachments for the case. Create the
373
+ # set by using AddAttachmentsToSet.
374
+ # @return [String]
375
+ class CreateCaseRequest < Struct.new(
376
+ :subject,
377
+ :service_code,
378
+ :severity_code,
379
+ :category_code,
380
+ :communication_body,
381
+ :cc_email_addresses,
382
+ :language,
383
+ :issue_type,
384
+ :attachment_set_id)
385
+ include Aws::Structure
386
+ end
387
+
388
+ # The AWS Support case ID returned by a successful completion of the
389
+ # CreateCase operation.
390
+ # @!attribute [rw] case_id
391
+ # The AWS Support case ID requested or returned in the call. The case
392
+ # ID is an alphanumeric string formatted as shown in this example:
393
+ # case-*12345678910-2013-c4c1d2bf33c5cf47*
394
+ # @return [String]
395
+ class CreateCaseResponse < Struct.new(
396
+ :case_id)
397
+ include Aws::Structure
398
+ end
399
+
400
+ # @note When making an API call, pass DescribeAttachmentRequest
401
+ # data as a hash:
402
+ #
403
+ # {
404
+ # attachment_id: "AttachmentId", # required
405
+ # }
406
+ # @!attribute [rw] attachment_id
407
+ # The ID of the attachment to return. Attachment IDs are returned by
408
+ # the DescribeCommunications operation.
409
+ # @return [String]
410
+ class DescribeAttachmentRequest < Struct.new(
411
+ :attachment_id)
412
+ include Aws::Structure
413
+ end
414
+
415
+ # The content and file name of the attachment returned by the
416
+ # DescribeAttachment operation.
417
+ # @!attribute [rw] attachment
418
+ # The attachment content and file name.
419
+ # @return [Types::Attachment]
420
+ class DescribeAttachmentResponse < Struct.new(
421
+ :attachment)
422
+ include Aws::Structure
423
+ end
424
+
425
+ # @note When making an API call, pass DescribeCasesRequest
426
+ # data as a hash:
427
+ #
428
+ # {
429
+ # case_id_list: ["CaseId"],
430
+ # display_id: "DisplayId",
431
+ # after_time: "AfterTime",
432
+ # before_time: "BeforeTime",
433
+ # include_resolved_cases: false,
434
+ # next_token: "NextToken",
435
+ # max_results: 1,
436
+ # language: "Language",
437
+ # include_communications: false,
438
+ # }
439
+ # @!attribute [rw] case_id_list
440
+ # A list of ID numbers of the support cases you want returned. The
441
+ # maximum number of cases is 100.
442
+ # @return [Array<String>]
443
+ #
444
+ # @!attribute [rw] display_id
445
+ # The ID displayed for a case in the AWS Support Center user
446
+ # interface.
447
+ # @return [String]
448
+ #
449
+ # @!attribute [rw] after_time
450
+ # The start date for a filtered date search on support case
451
+ # communications. Case communications are available for 12 months
452
+ # after creation.
453
+ # @return [String]
454
+ #
455
+ # @!attribute [rw] before_time
456
+ # The end date for a filtered date search on support case
457
+ # communications. Case communications are available for 12 months
458
+ # after creation.
459
+ # @return [String]
460
+ #
461
+ # @!attribute [rw] include_resolved_cases
462
+ # Specifies whether resolved support cases should be included in the
463
+ # DescribeCases results. The default is *false*.
464
+ # @return [Boolean]
465
+ #
466
+ # @!attribute [rw] next_token
467
+ # A resumption point for pagination.
468
+ # @return [String]
469
+ #
470
+ # @!attribute [rw] max_results
471
+ # The maximum number of results to return before paginating.
472
+ # @return [Integer]
473
+ #
474
+ # @!attribute [rw] language
475
+ # The ISO 639-1 code for the language in which AWS provides support.
476
+ # AWS Support currently supports English ("en") and Japanese
477
+ # ("ja"). Language parameters must be passed explicitly for
478
+ # operations that take them.
479
+ # @return [String]
480
+ #
481
+ # @!attribute [rw] include_communications
482
+ # Specifies whether communications should be included in the
483
+ # DescribeCases results. The default is *true*.
484
+ # @return [Boolean]
485
+ class DescribeCasesRequest < Struct.new(
486
+ :case_id_list,
487
+ :display_id,
488
+ :after_time,
489
+ :before_time,
490
+ :include_resolved_cases,
491
+ :next_token,
492
+ :max_results,
493
+ :language,
494
+ :include_communications)
495
+ include Aws::Structure
496
+ end
497
+
498
+ # Returns an array of CaseDetails objects and a `nextToken` that defines
499
+ # a point for pagination in the result set.
500
+ # @!attribute [rw] cases
501
+ # The details for the cases that match the request.
502
+ # @return [Array<Types::CaseDetails>]
503
+ #
504
+ # @!attribute [rw] next_token
505
+ # A resumption point for pagination.
506
+ # @return [String]
507
+ class DescribeCasesResponse < Struct.new(
508
+ :cases,
509
+ :next_token)
510
+ include Aws::Structure
511
+ end
512
+
513
+ # @note When making an API call, pass DescribeCommunicationsRequest
514
+ # data as a hash:
515
+ #
516
+ # {
517
+ # case_id: "CaseId", # required
518
+ # before_time: "BeforeTime",
519
+ # after_time: "AfterTime",
520
+ # next_token: "NextToken",
521
+ # max_results: 1,
522
+ # }
523
+ # @!attribute [rw] case_id
524
+ # The AWS Support case ID requested or returned in the call. The case
525
+ # ID is an alphanumeric string formatted as shown in this example:
526
+ # case-*12345678910-2013-c4c1d2bf33c5cf47*
527
+ # @return [String]
528
+ #
529
+ # @!attribute [rw] before_time
530
+ # The end date for a filtered date search on support case
531
+ # communications. Case communications are available for 12 months
532
+ # after creation.
533
+ # @return [String]
534
+ #
535
+ # @!attribute [rw] after_time
536
+ # The start date for a filtered date search on support case
537
+ # communications. Case communications are available for 12 months
538
+ # after creation.
539
+ # @return [String]
540
+ #
541
+ # @!attribute [rw] next_token
542
+ # A resumption point for pagination.
543
+ # @return [String]
544
+ #
545
+ # @!attribute [rw] max_results
546
+ # The maximum number of results to return before paginating.
547
+ # @return [Integer]
548
+ class DescribeCommunicationsRequest < Struct.new(
549
+ :case_id,
550
+ :before_time,
551
+ :after_time,
552
+ :next_token,
553
+ :max_results)
554
+ include Aws::Structure
555
+ end
556
+
557
+ # The communications returned by the DescribeCommunications operation.
558
+ # @!attribute [rw] communications
559
+ # The communications for the case.
560
+ # @return [Array<Types::Communication>]
561
+ #
562
+ # @!attribute [rw] next_token
563
+ # A resumption point for pagination.
564
+ # @return [String]
565
+ class DescribeCommunicationsResponse < Struct.new(
566
+ :communications,
567
+ :next_token)
568
+ include Aws::Structure
569
+ end
570
+
571
+ # @note When making an API call, pass DescribeServicesRequest
572
+ # data as a hash:
573
+ #
574
+ # {
575
+ # service_code_list: ["ServiceCode"],
576
+ # language: "Language",
577
+ # }
578
+ # @!attribute [rw] service_code_list
579
+ # A JSON-formatted list of service codes available for AWS services.
580
+ # @return [Array<String>]
581
+ #
582
+ # @!attribute [rw] language
583
+ # The ISO 639-1 code for the language in which AWS provides support.
584
+ # AWS Support currently supports English ("en") and Japanese
585
+ # ("ja"). Language parameters must be passed explicitly for
586
+ # operations that take them.
587
+ # @return [String]
588
+ class DescribeServicesRequest < Struct.new(
589
+ :service_code_list,
590
+ :language)
591
+ include Aws::Structure
592
+ end
593
+
594
+ # The list of AWS services returned by the DescribeServices operation.
595
+ # @!attribute [rw] services
596
+ # A JSON-formatted list of AWS services.
597
+ # @return [Array<Types::Service>]
598
+ class DescribeServicesResponse < Struct.new(
599
+ :services)
600
+ include Aws::Structure
601
+ end
602
+
603
+ # @note When making an API call, pass DescribeSeverityLevelsRequest
604
+ # data as a hash:
605
+ #
606
+ # {
607
+ # language: "Language",
608
+ # }
609
+ # @!attribute [rw] language
610
+ # The ISO 639-1 code for the language in which AWS provides support.
611
+ # AWS Support currently supports English ("en") and Japanese
612
+ # ("ja"). Language parameters must be passed explicitly for
613
+ # operations that take them.
614
+ # @return [String]
615
+ class DescribeSeverityLevelsRequest < Struct.new(
616
+ :language)
617
+ include Aws::Structure
618
+ end
619
+
620
+ # The list of severity levels returned by the DescribeSeverityLevels
621
+ # operation.
622
+ # @!attribute [rw] severity_levels
623
+ # The available severity levels for the support case. Available
624
+ # severity levels are defined by your service level agreement with
625
+ # AWS.
626
+ # @return [Array<Types::SeverityLevel>]
627
+ class DescribeSeverityLevelsResponse < Struct.new(
628
+ :severity_levels)
629
+ include Aws::Structure
630
+ end
631
+
632
+ # @note When making an API call, pass DescribeTrustedAdvisorCheckRefreshStatusesRequest
633
+ # data as a hash:
634
+ #
635
+ # {
636
+ # check_ids: ["String"], # required
637
+ # }
638
+ # @!attribute [rw] check_ids
639
+ # The IDs of the Trusted Advisor checks to get the status of.
640
+ # **Note:** Specifying the check ID of a check that is automatically
641
+ # refreshed causes an `InvalidParameterValue` error.
642
+ # @return [Array<String>]
643
+ class DescribeTrustedAdvisorCheckRefreshStatusesRequest < Struct.new(
644
+ :check_ids)
645
+ include Aws::Structure
646
+ end
647
+
648
+ # The statuses of the Trusted Advisor checks returned by the
649
+ # DescribeTrustedAdvisorCheckRefreshStatuses operation.
650
+ # @!attribute [rw] statuses
651
+ # The refresh status of the specified Trusted Advisor checks.
652
+ # @return [Array<Types::TrustedAdvisorCheckRefreshStatus>]
653
+ class DescribeTrustedAdvisorCheckRefreshStatusesResponse < Struct.new(
654
+ :statuses)
655
+ include Aws::Structure
656
+ end
657
+
658
+ # @note When making an API call, pass DescribeTrustedAdvisorCheckResultRequest
659
+ # data as a hash:
660
+ #
661
+ # {
662
+ # check_id: "String", # required
663
+ # language: "String",
664
+ # }
665
+ # @!attribute [rw] check_id
666
+ # The unique identifier for the Trusted Advisor check.
667
+ # @return [String]
668
+ #
669
+ # @!attribute [rw] language
670
+ # The ISO 639-1 code for the language in which AWS provides support.
671
+ # AWS Support currently supports English ("en") and Japanese
672
+ # ("ja"). Language parameters must be passed explicitly for
673
+ # operations that take them.
674
+ # @return [String]
675
+ class DescribeTrustedAdvisorCheckResultRequest < Struct.new(
676
+ :check_id,
677
+ :language)
678
+ include Aws::Structure
679
+ end
680
+
681
+ # The result of the Trusted Advisor check returned by the
682
+ # DescribeTrustedAdvisorCheckResult operation.
683
+ # @!attribute [rw] result
684
+ # The detailed results of the Trusted Advisor check.
685
+ # @return [Types::TrustedAdvisorCheckResult]
686
+ class DescribeTrustedAdvisorCheckResultResponse < Struct.new(
687
+ :result)
688
+ include Aws::Structure
689
+ end
690
+
691
+ # @note When making an API call, pass DescribeTrustedAdvisorCheckSummariesRequest
692
+ # data as a hash:
693
+ #
694
+ # {
695
+ # check_ids: ["String"], # required
696
+ # }
697
+ # @!attribute [rw] check_ids
698
+ # The IDs of the Trusted Advisor checks.
699
+ # @return [Array<String>]
700
+ class DescribeTrustedAdvisorCheckSummariesRequest < Struct.new(
701
+ :check_ids)
702
+ include Aws::Structure
703
+ end
704
+
705
+ # The summaries of the Trusted Advisor checks returned by the
706
+ # DescribeTrustedAdvisorCheckSummaries operation.
707
+ # @!attribute [rw] summaries
708
+ # The summary information for the requested Trusted Advisor checks.
709
+ # @return [Array<Types::TrustedAdvisorCheckSummary>]
710
+ class DescribeTrustedAdvisorCheckSummariesResponse < Struct.new(
711
+ :summaries)
712
+ include Aws::Structure
713
+ end
714
+
715
+ # @note When making an API call, pass DescribeTrustedAdvisorChecksRequest
716
+ # data as a hash:
717
+ #
718
+ # {
719
+ # language: "String", # required
720
+ # }
721
+ # @!attribute [rw] language
722
+ # The ISO 639-1 code for the language in which AWS provides support.
723
+ # AWS Support currently supports English ("en") and Japanese
724
+ # ("ja"). Language parameters must be passed explicitly for
725
+ # operations that take them.
726
+ # @return [String]
727
+ class DescribeTrustedAdvisorChecksRequest < Struct.new(
728
+ :language)
729
+ include Aws::Structure
730
+ end
731
+
732
+ # Information about the Trusted Advisor checks returned by the
733
+ # DescribeTrustedAdvisorChecks operation.
734
+ # @!attribute [rw] checks
735
+ # Information about all available Trusted Advisor checks.
736
+ # @return [Array<Types::TrustedAdvisorCheckDescription>]
737
+ class DescribeTrustedAdvisorChecksResponse < Struct.new(
738
+ :checks)
739
+ include Aws::Structure
740
+ end
741
+
742
+ # The five most recent communications associated with the case.
743
+ # @!attribute [rw] communications
744
+ # The five most recent communications associated with the case.
745
+ # @return [Array<Types::Communication>]
746
+ #
747
+ # @!attribute [rw] next_token
748
+ # A resumption point for pagination.
749
+ # @return [String]
750
+ class RecentCaseCommunications < Struct.new(
751
+ :communications,
752
+ :next_token)
753
+ include Aws::Structure
754
+ end
755
+
756
+ # @note When making an API call, pass RefreshTrustedAdvisorCheckRequest
757
+ # data as a hash:
758
+ #
759
+ # {
760
+ # check_id: "String", # required
761
+ # }
762
+ # @!attribute [rw] check_id
763
+ # The unique identifier for the Trusted Advisor check to refresh.
764
+ # **Note:** Specifying the check ID of a check that is automatically
765
+ # refreshed causes an `InvalidParameterValue` error.
766
+ # @return [String]
767
+ class RefreshTrustedAdvisorCheckRequest < Struct.new(
768
+ :check_id)
769
+ include Aws::Structure
770
+ end
771
+
772
+ # The current refresh status of a Trusted Advisor check.
773
+ # @!attribute [rw] status
774
+ # The current refresh status for a check, including the amount of time
775
+ # until the check is eligible for refresh.
776
+ # @return [Types::TrustedAdvisorCheckRefreshStatus]
777
+ class RefreshTrustedAdvisorCheckResponse < Struct.new(
778
+ :status)
779
+ include Aws::Structure
780
+ end
781
+
782
+ # @note When making an API call, pass ResolveCaseRequest
783
+ # data as a hash:
784
+ #
785
+ # {
786
+ # case_id: "CaseId",
787
+ # }
788
+ # @!attribute [rw] case_id
789
+ # The AWS Support case ID requested or returned in the call. The case
790
+ # ID is an alphanumeric string formatted as shown in this example:
791
+ # case-*12345678910-2013-c4c1d2bf33c5cf47*
792
+ # @return [String]
793
+ class ResolveCaseRequest < Struct.new(
794
+ :case_id)
795
+ include Aws::Structure
796
+ end
797
+
798
+ # The status of the case returned by the ResolveCase operation.
799
+ # @!attribute [rw] initial_case_status
800
+ # The status of the case when the ResolveCase request was sent.
801
+ # @return [String]
802
+ #
803
+ # @!attribute [rw] final_case_status
804
+ # The status of the case after the ResolveCase request was processed.
805
+ # @return [String]
806
+ class ResolveCaseResponse < Struct.new(
807
+ :initial_case_status,
808
+ :final_case_status)
809
+ include Aws::Structure
810
+ end
811
+
812
+ # Information about an AWS service returned by the DescribeServices
813
+ # operation.
814
+ # @!attribute [rw] code
815
+ # The code for an AWS service returned by the DescribeServices
816
+ # response. The `name` element contains the corresponding friendly
817
+ # name.
818
+ # @return [String]
819
+ #
820
+ # @!attribute [rw] name
821
+ # The friendly name for an AWS service. The `code` element contains
822
+ # the corresponding code.
823
+ # @return [String]
824
+ #
825
+ # @!attribute [rw] categories
826
+ # A list of categories that describe the type of support issue a case
827
+ # describes. Categories consist of a category name and a category
828
+ # code. Category names and codes are passed to AWS Support when you
829
+ # call CreateCase.
830
+ # @return [Array<Types::Category>]
831
+ class Service < Struct.new(
832
+ :code,
833
+ :name,
834
+ :categories)
835
+ include Aws::Structure
836
+ end
837
+
838
+ # A code and name pair that represent a severity level that can be
839
+ # applied to a support case.
840
+ # @!attribute [rw] code
841
+ # One of four values: "low," "medium," "high," and "urgent".
842
+ # These values correspond to response times returned to the caller in
843
+ # `severityLevel.name`.
844
+ # @return [String]
845
+ #
846
+ # @!attribute [rw] name
847
+ # The name of the severity level that corresponds to the severity
848
+ # level code.
849
+ # @return [String]
850
+ class SeverityLevel < Struct.new(
851
+ :code,
852
+ :name)
853
+ include Aws::Structure
854
+ end
855
+
856
+ # The container for summary information that relates to the category of
857
+ # the Trusted Advisor check.
858
+ # @!attribute [rw] cost_optimizing
859
+ # The summary information about cost savings for a Trusted Advisor
860
+ # check that is in the Cost Optimizing category.
861
+ # @return [Types::TrustedAdvisorCostOptimizingSummary]
862
+ class TrustedAdvisorCategorySpecificSummary < Struct.new(
863
+ :cost_optimizing)
864
+ include Aws::Structure
865
+ end
866
+
867
+ # The description and metadata for a Trusted Advisor check.
868
+ # @!attribute [rw] id
869
+ # The unique identifier for the Trusted Advisor check.
870
+ # @return [String]
871
+ #
872
+ # @!attribute [rw] name
873
+ # The display name for the Trusted Advisor check.
874
+ # @return [String]
875
+ #
876
+ # @!attribute [rw] description
877
+ # The description of the Trusted Advisor check, which includes the
878
+ # alert criteria and recommended actions (contains HTML markup).
879
+ # @return [String]
880
+ #
881
+ # @!attribute [rw] category
882
+ # The category of the Trusted Advisor check.
883
+ # @return [String]
884
+ #
885
+ # @!attribute [rw] metadata
886
+ # The column headings for the data returned by the Trusted Advisor
887
+ # check. The order of the headings corresponds to the order of the
888
+ # data in the **Metadata** element of the TrustedAdvisorResourceDetail
889
+ # for the check. **Metadata** contains all the data that is shown in
890
+ # the Excel download, even in those cases where the UI shows just
891
+ # summary data.
892
+ # @return [Array<String>]
893
+ class TrustedAdvisorCheckDescription < Struct.new(
894
+ :id,
895
+ :name,
896
+ :description,
897
+ :category,
898
+ :metadata)
899
+ include Aws::Structure
900
+ end
901
+
902
+ # The refresh status of a Trusted Advisor check.
903
+ # @!attribute [rw] check_id
904
+ # The unique identifier for the Trusted Advisor check.
905
+ # @return [String]
906
+ #
907
+ # @!attribute [rw] status
908
+ # The status of the Trusted Advisor check for which a refresh has been
909
+ # requested: "none", "enqueued", "processing", "success", or
910
+ # "abandoned".
911
+ # @return [String]
912
+ #
913
+ # @!attribute [rw] millis_until_next_refreshable
914
+ # The amount of time, in milliseconds, until the Trusted Advisor check
915
+ # is eligible for refresh.
916
+ # @return [Integer]
917
+ class TrustedAdvisorCheckRefreshStatus < Struct.new(
918
+ :check_id,
919
+ :status,
920
+ :millis_until_next_refreshable)
921
+ include Aws::Structure
922
+ end
923
+
924
+ # The results of a Trusted Advisor check returned by
925
+ # DescribeTrustedAdvisorCheckResult.
926
+ # @!attribute [rw] check_id
927
+ # The unique identifier for the Trusted Advisor check.
928
+ # @return [String]
929
+ #
930
+ # @!attribute [rw] timestamp
931
+ # The time of the last refresh of the check.
932
+ # @return [String]
933
+ #
934
+ # @!attribute [rw] status
935
+ # The alert status of the check: "ok" (green), "warning" (yellow),
936
+ # "error" (red), or "not\_available".
937
+ # @return [String]
938
+ #
939
+ # @!attribute [rw] resources_summary
940
+ # Details about AWS resources that were analyzed in a call to Trusted
941
+ # Advisor DescribeTrustedAdvisorCheckSummaries.
942
+ # @return [Types::TrustedAdvisorResourcesSummary]
943
+ #
944
+ # @!attribute [rw] category_specific_summary
945
+ # Summary information that relates to the category of the check. Cost
946
+ # Optimizing is the only category that is currently supported.
947
+ # @return [Types::TrustedAdvisorCategorySpecificSummary]
948
+ #
949
+ # @!attribute [rw] flagged_resources
950
+ # The details about each resource listed in the check result.
951
+ # @return [Array<Types::TrustedAdvisorResourceDetail>]
952
+ class TrustedAdvisorCheckResult < Struct.new(
953
+ :check_id,
954
+ :timestamp,
955
+ :status,
956
+ :resources_summary,
957
+ :category_specific_summary,
958
+ :flagged_resources)
959
+ include Aws::Structure
960
+ end
961
+
962
+ # A summary of a Trusted Advisor check result, including the alert
963
+ # status, last refresh, and number of resources examined.
964
+ # @!attribute [rw] check_id
965
+ # The unique identifier for the Trusted Advisor check.
966
+ # @return [String]
967
+ #
968
+ # @!attribute [rw] timestamp
969
+ # The time of the last refresh of the check.
970
+ # @return [String]
971
+ #
972
+ # @!attribute [rw] status
973
+ # The alert status of the check: "ok" (green), "warning" (yellow),
974
+ # "error" (red), or "not\_available".
975
+ # @return [String]
976
+ #
977
+ # @!attribute [rw] has_flagged_resources
978
+ # Specifies whether the Trusted Advisor check has flagged resources.
979
+ # @return [Boolean]
980
+ #
981
+ # @!attribute [rw] resources_summary
982
+ # Details about AWS resources that were analyzed in a call to Trusted
983
+ # Advisor DescribeTrustedAdvisorCheckSummaries.
984
+ # @return [Types::TrustedAdvisorResourcesSummary]
985
+ #
986
+ # @!attribute [rw] category_specific_summary
987
+ # Summary information that relates to the category of the check. Cost
988
+ # Optimizing is the only category that is currently supported.
989
+ # @return [Types::TrustedAdvisorCategorySpecificSummary]
990
+ class TrustedAdvisorCheckSummary < Struct.new(
991
+ :check_id,
992
+ :timestamp,
993
+ :status,
994
+ :has_flagged_resources,
995
+ :resources_summary,
996
+ :category_specific_summary)
997
+ include Aws::Structure
998
+ end
999
+
1000
+ # The estimated cost savings that might be realized if the recommended
1001
+ # actions are taken.
1002
+ # @!attribute [rw] estimated_monthly_savings
1003
+ # The estimated monthly savings that might be realized if the
1004
+ # recommended actions are taken.
1005
+ # @return [Float]
1006
+ #
1007
+ # @!attribute [rw] estimated_percent_monthly_savings
1008
+ # The estimated percentage of savings that might be realized if the
1009
+ # recommended actions are taken.
1010
+ # @return [Float]
1011
+ class TrustedAdvisorCostOptimizingSummary < Struct.new(
1012
+ :estimated_monthly_savings,
1013
+ :estimated_percent_monthly_savings)
1014
+ include Aws::Structure
1015
+ end
1016
+
1017
+ # Contains information about a resource identified by a Trusted Advisor
1018
+ # check.
1019
+ # @!attribute [rw] status
1020
+ # The status code for the resource identified in the Trusted Advisor
1021
+ # check.
1022
+ # @return [String]
1023
+ #
1024
+ # @!attribute [rw] region
1025
+ # The AWS region in which the identified resource is located.
1026
+ # @return [String]
1027
+ #
1028
+ # @!attribute [rw] resource_id
1029
+ # The unique identifier for the identified resource.
1030
+ # @return [String]
1031
+ #
1032
+ # @!attribute [rw] is_suppressed
1033
+ # Specifies whether the AWS resource was ignored by Trusted Advisor
1034
+ # because it was marked as suppressed by the user.
1035
+ # @return [Boolean]
1036
+ #
1037
+ # @!attribute [rw] metadata
1038
+ # Additional information about the identified resource. The exact
1039
+ # metadata and its order can be obtained by inspecting the
1040
+ # TrustedAdvisorCheckDescription object returned by the call to
1041
+ # DescribeTrustedAdvisorChecks. **Metadata** contains all the data
1042
+ # that is shown in the Excel download, even in those cases where the
1043
+ # UI shows just summary data.
1044
+ # @return [Array<String>]
1045
+ class TrustedAdvisorResourceDetail < Struct.new(
1046
+ :status,
1047
+ :region,
1048
+ :resource_id,
1049
+ :is_suppressed,
1050
+ :metadata)
1051
+ include Aws::Structure
1052
+ end
1053
+
1054
+ # Details about AWS resources that were analyzed in a call to Trusted
1055
+ # Advisor DescribeTrustedAdvisorCheckSummaries.
1056
+ # @!attribute [rw] resources_processed
1057
+ # The number of AWS resources that were analyzed by the Trusted
1058
+ # Advisor check.
1059
+ # @return [Integer]
1060
+ #
1061
+ # @!attribute [rw] resources_flagged
1062
+ # The number of AWS resources that were flagged (listed) by the
1063
+ # Trusted Advisor check.
1064
+ # @return [Integer]
1065
+ #
1066
+ # @!attribute [rw] resources_ignored
1067
+ # The number of AWS resources ignored by Trusted Advisor because
1068
+ # information was unavailable.
1069
+ # @return [Integer]
1070
+ #
1071
+ # @!attribute [rw] resources_suppressed
1072
+ # The number of AWS resources ignored by Trusted Advisor because they
1073
+ # were marked as suppressed by the user.
1074
+ # @return [Integer]
1075
+ class TrustedAdvisorResourcesSummary < Struct.new(
1076
+ :resources_processed,
1077
+ :resources_flagged,
1078
+ :resources_ignored,
1079
+ :resources_suppressed)
1080
+ include Aws::Structure
1081
+ end
1082
+
1083
+ end
1084
+ end
1085
+ end