forked from aws/aws-sdk-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathAWSSupport.java
More file actions
759 lines (735 loc) · 37.1 KB
/
AWSSupport.java
File metadata and controls
759 lines (735 loc) · 37.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
/*
* Copyright 2010-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.support;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.support.model.*;
/**
* Interface for accessing AWSSupport.
* AWS Support <p>
* The AWS Support API reference is intended for programmers who need detailed information about the AWS Support actions and data types. This service
* enables you to manage your AWS Support cases programmatically. It uses HTTP methods that return results in JSON format.
* </p>
* <p>
* The AWS Support service also exposes a set of <a href="https://aws.amazon.com/support/trustedadvisor"> Trusted Advisor </a> features. You can
* retrieve a list of checks you can run on your resources, specify checks to run and refresh, and check the status of checks you have submitted.
* </p>
* <p>
* The following list describes the AWS Support case management actions:
* </p>
*
* <ul>
* <li> <b>Service names, issue categories, and available severity levels. </b> The actions <a
* href="http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeServices.html"> DescribeServices </a> and <a
* href="http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeSeverityLevels.html"> DescribeSeverityLevels </a> enable you to obtain
* AWS service names, service codes, service categories, and problem severity levels. You use these values when you call the <a
* href="http://docs.aws.amazon.com/awssupport/latest/APIReference/API_CreateCase.html"> CreateCase </a> action. </li>
* <li> <b>Case Creation, case details, and case resolution</b> . The actions <a
* href="http://docs.aws.amazon.com/awssupport/latest/APIReference/API_CreateCase.html"> CreateCase </a> , <a
* href="http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeCases.html"> DescribeCases </a> , and <a
* href="http://docs.aws.amazon.com/awssupport/latest/APIReference/API_ResolveCase.html"> ResolveCase </a> enable you to create AWS Support cases,
* retrieve them, and resolve them.</li>
* <li> <b>Case communication</b> . The actions <a href="http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeCommunications.html">
* DescribeCommunications </a> and <a href="http://docs.aws.amazon.com/awssupport/latest/APIReference/API_AddCommunicationToCase.html">
* AddCommunicationToCase </a> enable you to retrieve and add communication to AWS Support cases. </li>
*
* </ul>
* <p>
* The following list describes the actions available from the AWS Support service for Trusted Advisor:
* </p>
*
* <ul>
* <li> <a href="http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeTrustedAdvisorChecks.html"> DescribeTrustedAdvisorChecks </a>
* returns the list of checks that you can run against your AWS resources.</li>
* <li>Using the CheckId for a specific check returned by DescribeTrustedAdvisorChecks, you can call <a
* href="http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeTrustedAdvisorCheckResult.html"> DescribeTrustedAdvisorCheckResult </a>
* </li>
* and obtain a new result for the check you specified. <li> Using <a
* href="http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeTrustedAdvisorCheckSummaries.html"> DescribeTrustedAdvisorCheckSummaries
* </a> , you can get summaries for a set of Trusted Advisor checks.</li>
* <li> <a href="http://docs.aws.amazon.com/awssupport/latest/APIReference/API_RefreshTrustedAdvisorCheck.html"> RefreshTrustedAdvisorCheck </a>
* enables you to request that Trusted Advisor run the check again. </li>
* <li> <a href="http://docs.aws.amazon.com/awssupport/latest/APIReference/API_DescribeTrustedAdvisorCheckRefreshStatuses.html">
* DescribeTrustedAdvisorCheckRefreshStatuses </a> gets statuses on the checks you are running. </li>
*
* </ul>
* <p>
* For authentication of requests, the AWS Support uses <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html"> Signature
* Version 4 Signing Process </a> .
* </p>
* <p>
* See the AWS Support <a href="http://docs.aws.amazon.com/awssupport/latest/developerguide/Welcome.html"> Developer Guide </a> for information about
* how to use this service to manage create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources.
* </p>
*/
public interface AWSSupport {
/**
* Overrides the default endpoint for this client ("support.us-east-1.amazonaws.com").
* Callers can use this method to control which AWS region they want to work with.
* <p>
* Callers can pass in just the endpoint (ex: "support.us-east-1.amazonaws.com") or a full
* URL, including the protocol (ex: "support.us-east-1.amazonaws.com"). If the
* protocol is not specified here, the default protocol from this client's
* {@link ClientConfiguration} will be used, which by default is HTTPS.
* <p>
* For more information on using AWS regions with the AWS SDK for Java, and
* a complete list of all available endpoints for all AWS services, see:
* <a href="http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912">
* http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912</a>
* <p>
* <b>This method is not threadsafe. An endpoint should be configured when the
* client is created and before any service requests are made. Changing it
* afterwards creates inevitable race conditions for any service requests in
* transit or retrying.</b>
*
* @param endpoint
* The endpoint (ex: "support.us-east-1.amazonaws.com") or a full URL,
* including the protocol (ex: "support.us-east-1.amazonaws.com") of
* the region specific AWS endpoint this client will communicate
* with.
*
* @throws IllegalArgumentException
* If any problems are detected with the specified endpoint.
*/
public void setEndpoint(String endpoint) throws java.lang.IllegalArgumentException;
/**
* An alternative to {@link AWSSupport#setEndpoint(String)}, sets the
* regional endpoint for this client's service calls. Callers can use this
* method to control which AWS region they want to work with.
* <p>
* By default, all service endpoints in all regions use the https protocol.
* To use http instead, specify it in the {@link ClientConfiguration}
* supplied at construction.
* <p>
* <b>This method is not threadsafe. A region should be configured when the
* client is created and before any service requests are made. Changing it
* afterwards creates inevitable race conditions for any service requests in
* transit or retrying.</b>
*
* @param region
* The region this client will communicate with. See
* {@link Region#getRegion(com.amazonaws.regions.Regions)} for
* accessing a given region.
* @throws java.lang.IllegalArgumentException
* If the given region is null, or if this service isn't
* available in the given region. See
* {@link Region#isServiceSupported(String)}
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
*/
public void setRegion(Region region) throws java.lang.IllegalArgumentException;
/**
* <p>
* This action returns a list of cases that you specify by passing one or
* more CaseIds. In addition, you can filter the cases by date by setting
* values for the AfterTime and BeforeTime request parameters.
* </p>
* <p>
* The response returns the following in JSON format:
* </p>
* <ol> <li>One or more <a
* s.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html">
* CaseDetails </a> data types. </li>
* <li>One or more <i>NextToken</i> objects, strings that specifies
* where to paginate the returned records represented by
* <i>CaseDetails</i> .</li>
* </ol>
*
* @param describeCasesRequest Container for the necessary parameters to
* execute the DescribeCases service method on AWSSupport.
*
* @return The response from the DescribeCases service method, as
* returned by AWSSupport.
*
* @throws InternalServerErrorException
* @throws CaseIdNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeCasesResult describeCases(DescribeCasesRequest describeCasesRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Returns the status of all refresh requests Trusted Advisor checks
* called using <a
* m/awssupport/latest/APIReference/API_RefreshTrustedAdvisorCheck.html">
* RefreshTrustedAdvisorCheck </a> .
* </p>
*
* @param describeTrustedAdvisorCheckRefreshStatusesRequest Container for
* the necessary parameters to execute the
* DescribeTrustedAdvisorCheckRefreshStatuses service method on
* AWSSupport.
*
* @return The response from the
* DescribeTrustedAdvisorCheckRefreshStatuses service method, as returned
* by AWSSupport.
*
* @throws InternalServerErrorException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeTrustedAdvisorCheckRefreshStatusesResult describeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest describeTrustedAdvisorCheckRefreshStatusesRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* This action returns the list of severity levels that you can assign to
* an AWS Support case. The severity level for a case is also a field in
* the <a
* s.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html">
* CaseDetails </a> data type included in any <a
* cs.aws.amazon.com/awssupport/latest/APIReference/API_CreateCase.html">
* CreateCase </a> request.
* </p>
*
* @param describeSeverityLevelsRequest Container for the necessary
* parameters to execute the DescribeSeverityLevels service method on
* AWSSupport.
*
* @return The response from the DescribeSeverityLevels service method,
* as returned by AWSSupport.
*
* @throws InternalServerErrorException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeSeverityLevelsResult describeSeverityLevels(DescribeSeverityLevelsRequest describeSeverityLevelsRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* This action returns communications regarding the support case. You can
* use the <i>AfterTime</i> and <i>BeforeTime</i> parameters to filter by
* date. The <i>CaseId</i> parameter enables you to identify a specific
* case by its <i>CaseId</i> number.
* </p>
* <p>
* The <i>MaxResults</i> and <i>NextToken</i> parameters enable you to
* control the pagination of the result set. Set <i>MaxResults</i> to the
* number of cases you want displayed on each page, and use
* <i>NextToken</i> to specify the resumption of pagination.
* </p>
*
* @param describeCommunicationsRequest Container for the necessary
* parameters to execute the DescribeCommunications service method on
* AWSSupport.
*
* @return The response from the DescribeCommunications service method,
* as returned by AWSSupport.
*
* @throws InternalServerErrorException
* @throws CaseIdNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeCommunicationsResult describeCommunications(DescribeCommunicationsRequest describeCommunicationsRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* This action adds additional customer communication to an AWS Support
* case. You use the <i>CaseId</i> value to identify the case to which
* you want to add communication. You can list a set of email addresses
* to copy on the communication using the <i>CcEmailAddresses</i> value.
* The <i>CommunicationBody</i> value contains the text of the
* communication.
* </p>
* <p>
* This action's response indicates the success or failure of the
* request.
* </p>
* <p>
* This action implements a subset of the behavior on the AWS Support <a
* href="https://aws.amazon.com/support"> Your Support Cases </a> web
* form.
* </p>
*
* @param addCommunicationToCaseRequest Container for the necessary
* parameters to execute the AddCommunicationToCase service method on
* AWSSupport.
*
* @return The response from the AddCommunicationToCase service method,
* as returned by AWSSupport.
*
* @throws InternalServerErrorException
* @throws CaseIdNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public AddCommunicationToCaseResult addCommunicationToCase(AddCommunicationToCaseRequest addCommunicationToCaseRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Creates a new case in the AWS Support Center. This action is modeled
* on the behavior of the AWS Support Center <a
* href="https://aws.amazon.com/support/createCase"> Open a new case </a>
* page. Its parameters require you to specify the following
* information:
* </p>
* <ol> <li> <b>ServiceCode.</b> Represents a code for an AWS service.
* You obtain the <i>ServiceCode</i> by calling <a
* .amazon.com/awssupport/latest/APIReference/API_DescribeServices.html">
* DescribeServices </a> . </li>
* <li> <b>CategoryCode</b> . Represents a category for the service
* defined for the ServiceCode value. You also obtain the cateogory code
* for a service by calling <a
* .amazon.com/awssupport/latest/APIReference/API_DescribeServices.html">
* DescribeServices </a> . Each AWS service defines its own set of
* category codes. </li>
* <li> <b>SeverityCode</b> . Represents a value that specifies the
* urgency of the case, and the time interval in which your service level
* agreement specifies a response from AWS Support. You obtain the
* SeverityCode by calling <a
* n.com/awssupport/latest/APIReference/API_DescribeSeverityLevels.html">
* DescribeSeverityLevels </a> .</li>
* <li> <b>Subject</b> . Represents the <b>Subject</b> field on the AWS
* Support Center <a href="https://aws.amazon.com/support/createCase">
* Open a new case </a> page.</li>
* <li> <b>CommunicationBody</b> . Represents the <b>Description</b>
* field on the AWS Support Center <a
* href="https://aws.amazon.com/support/createCase"> Open a new case </a>
* page.</li>
* <li> <b>Language</b> . Specifies the human language in which AWS
* Support handles the case. The API currently supports English and
* Japanese.</li>
* <li> <b>CcEmailAddresses</b> . Represents the AWS Support Center
* <b>CC</b> field on the <a
* href="https://aws.amazon.com/support/createCase"> Open a new case </a>
* page. You can list email addresses to be copied on any correspondence
* about the case. The account that opens the case is already identified
* by passing the AWS Credentials in the HTTP POST method or in a method
* or function call from one of the programming languages supported by an
* <a href="http://aws.amazon.com/tools/"> AWS SDK </a> . </li>
* <li> <b>IssueType</b> . Indicates the type of issue for the case. You
* can specify either "customer-service" or "technical." If you do not
* indicate a value, this parameter defaults to "technical." </li>
* </ol> <p>
* <b>NOTE:</b>The AWS Support API does not currently support the ability
* to add attachments to cases. You can, however, call
* AddCommunicationToCase to add information to an open case.
* </p>
* <p>
* A successful <a
* cs.aws.amazon.com/awssupport/latest/APIReference/API_CreateCase.html">
* CreateCase </a> request returns an AWS Support case number. Case
* numbers are used by <a
* aws.amazon.com/awssupport/latest/APIReference/API_DescribeCases.html">
* DescribeCases </a> request to retrieve existing AWS Support support
* cases.
* </p>
*
* @param createCaseRequest Container for the necessary parameters to
* execute the CreateCase service method on AWSSupport.
*
* @return The response from the CreateCase service method, as returned
* by AWSSupport.
*
* @throws InternalServerErrorException
* @throws CaseCreationLimitExceededException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public CreateCaseResult createCase(CreateCaseRequest createCaseRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* This action enables you to get a list of the available Trusted Advisor
* checks. You must specify a language code. English ("en") and Japanese
* ("jp") are currently supported. The response contains a list of <a
* ssupport/latest/APIReference/API_TrustedAdvisorCheckDescription.html">
* TrustedAdvisorCheckDescription </a> objects.
* </p>
*
* @param describeTrustedAdvisorChecksRequest Container for the necessary
* parameters to execute the DescribeTrustedAdvisorChecks service method
* on AWSSupport.
*
* @return The response from the DescribeTrustedAdvisorChecks service
* method, as returned by AWSSupport.
*
* @throws InternalServerErrorException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeTrustedAdvisorChecksResult describeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest describeTrustedAdvisorChecksRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* This action responds with the results of a Trusted Advisor check. Once
* you have obtained the list of available Trusted Advisor checks by
* calling <a
* awssupport/latest/APIReference/API_DescribeTrustedAdvisorChecks.html">
* DescribeTrustedAdvisorChecks </a> , you specify the <i>CheckId</i> for
* the check you want to retrieve from AWS Support.
* </p>
* <p>
* The response for this action contains a JSON-formatted <a
* latest/APIReference/API_DescribeTrustedAdvisorCheckResultResult.html">
* TrustedAdvisorCheckResult </a> object
* </p>
* <p>
* , which is a container for the following three objects:
* </p>
* <p>
* </p>
* <ol> <li> <a
* t/latest/APIReference/API_TrustedAdvisorCategorySpecificSummary.html">
* TrustedAdvisorCategorySpecificSummary </a> </li>
* <li> <a
* awssupport/latest/APIReference/API_TrustedAdvisorResourceDetail.html">
* TrustedAdvisorResourceDetail </a> </li>
* <li> <a
* ssupport/latest/APIReference/API_TrustedAdvisorResourcesSummary.html">
* TrustedAdvisorResourcesSummary </a> </li>
* </ol> <p>
* In addition, the response contains the following fields:
* </p>
* <ol> <li> <b>Status</b> . Overall status of the check.</li>
* <li> <b>Timestamp</b> . Time at which Trusted Advisor last ran the
* check. </li>
* <li> <b>CheckId</b> . Unique identifier for the specific check
* returned by the request.</li>
* </ol>
*
* @param describeTrustedAdvisorCheckResultRequest Container for the
* necessary parameters to execute the DescribeTrustedAdvisorCheckResult
* service method on AWSSupport.
*
* @return The response from the DescribeTrustedAdvisorCheckResult
* service method, as returned by AWSSupport.
*
* @throws InternalServerErrorException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeTrustedAdvisorCheckResultResult describeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest describeTrustedAdvisorCheckResultRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Takes a <i>CaseId</i> and returns the initial state of the case along
* with the state of the case after the call to <a
* s.aws.amazon.com/awssupport/latest/APIReference/API_ResolveCase.html">
* ResolveCase </a> completed.
* </p>
*
* @param resolveCaseRequest Container for the necessary parameters to
* execute the ResolveCase service method on AWSSupport.
*
* @return The response from the ResolveCase service method, as returned
* by AWSSupport.
*
* @throws InternalServerErrorException
* @throws CaseIdNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public ResolveCaseResult resolveCase(ResolveCaseRequest resolveCaseRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* This action enables you to query the service to request a refresh for
* a specific Trusted Advisor check. Your request body contains a
* <i>CheckId</i> for which you are querying. The response body contains
* a <a
* upport/latest/APIReference/API_RefreshTrustedAdvisorCheckResult.html">
* RefreshTrustedAdvisorCheckResult </a> object containing <i>Status</i>
* and <i>TimeUntilNextRefresh</i> fields.
* </p>
*
* @param refreshTrustedAdvisorCheckRequest Container for the necessary
* parameters to execute the RefreshTrustedAdvisorCheck service method on
* AWSSupport.
*
* @return The response from the RefreshTrustedAdvisorCheck service
* method, as returned by AWSSupport.
*
* @throws InternalServerErrorException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public RefreshTrustedAdvisorCheckResult refreshTrustedAdvisorCheck(RefreshTrustedAdvisorCheckRequest refreshTrustedAdvisorCheckRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Returns the current list of AWS services and a list of service
* categories that applies to each one. You then use service names and
* categories in your <a
* cs.aws.amazon.com/awssupport/latest/APIReference/API_CreateCase.html">
* CreateCase </a> requests. Each AWS service has its own set of
* categories.
* </p>
* <p>
* The service codes and category codes correspond to the values that are
* displayed in the <b>Service</b> and <b>Category</b> drop-down lists on
* the AWS Support Center <a
* href="https://aws.amazon.com/support/createCase"> Open a new case </a>
* page. The values in those fields, however, do not necessarily match
* the service codes and categories returned by the
* <code>DescribeServices</code> request. Always use the service codes
* and categories obtained programmatically. This practice ensures that
* you always have the most recent set of service and category codes.
* </p>
*
* @param describeServicesRequest Container for the necessary parameters
* to execute the DescribeServices service method on AWSSupport.
*
* @return The response from the DescribeServices service method, as
* returned by AWSSupport.
*
* @throws InternalServerErrorException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeServicesResult describeServices(DescribeServicesRequest describeServicesRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* This action enables you to get the latest summaries for Trusted
* Advisor checks that you specify in your request. You submit the list
* of Trusted Advisor checks for which you want summaries. You obtain
* these <i>CheckIds</i> by submitting a <a
* awssupport/latest/APIReference/API_DescribeTrustedAdvisorChecks.html">
* DescribeTrustedAdvisorChecks </a> request.
* </p>
* <p>
* The response body contains an array of <a
* m/awssupport/latest/APIReference/API_TrustedAdvisorCheckSummary.html">
* TrustedAdvisorCheckSummary </a> objects.
* </p>
*
* @param describeTrustedAdvisorCheckSummariesRequest Container for the
* necessary parameters to execute the
* DescribeTrustedAdvisorCheckSummaries service method on AWSSupport.
*
* @return The response from the DescribeTrustedAdvisorCheckSummaries
* service method, as returned by AWSSupport.
*
* @throws InternalServerErrorException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeTrustedAdvisorCheckSummariesResult describeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* This action returns a list of cases that you specify by passing one or
* more CaseIds. In addition, you can filter the cases by date by setting
* values for the AfterTime and BeforeTime request parameters.
* </p>
* <p>
* The response returns the following in JSON format:
* </p>
* <ol> <li>One or more <a
* s.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html">
* CaseDetails </a> data types. </li>
* <li>One or more <i>NextToken</i> objects, strings that specifies
* where to paginate the returned records represented by
* <i>CaseDetails</i> .</li>
* </ol>
*
* @return The response from the DescribeCases service method, as
* returned by AWSSupport.
*
* @throws InternalServerErrorException
* @throws CaseIdNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeCasesResult describeCases() throws AmazonServiceException, AmazonClientException;
/**
* <p>
* This action returns the list of severity levels that you can assign to
* an AWS Support case. The severity level for a case is also a field in
* the <a
* s.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html">
* CaseDetails </a> data type included in any <a
* cs.aws.amazon.com/awssupport/latest/APIReference/API_CreateCase.html">
* CreateCase </a> request.
* </p>
*
* @return The response from the DescribeSeverityLevels service method,
* as returned by AWSSupport.
*
* @throws InternalServerErrorException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeSeverityLevelsResult describeSeverityLevels() throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Takes a <i>CaseId</i> and returns the initial state of the case along
* with the state of the case after the call to <a
* s.aws.amazon.com/awssupport/latest/APIReference/API_ResolveCase.html">
* ResolveCase </a> completed.
* </p>
*
* @return The response from the ResolveCase service method, as returned
* by AWSSupport.
*
* @throws InternalServerErrorException
* @throws CaseIdNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public ResolveCaseResult resolveCase() throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Returns the current list of AWS services and a list of service
* categories that applies to each one. You then use service names and
* categories in your <a
* cs.aws.amazon.com/awssupport/latest/APIReference/API_CreateCase.html">
* CreateCase </a> requests. Each AWS service has its own set of
* categories.
* </p>
* <p>
* The service codes and category codes correspond to the values that are
* displayed in the <b>Service</b> and <b>Category</b> drop-down lists on
* the AWS Support Center <a
* href="https://aws.amazon.com/support/createCase"> Open a new case </a>
* page. The values in those fields, however, do not necessarily match
* the service codes and categories returned by the
* <code>DescribeServices</code> request. Always use the service codes
* and categories obtained programmatically. This practice ensures that
* you always have the most recent set of service and category codes.
* </p>
*
* @return The response from the DescribeServices service method, as
* returned by AWSSupport.
*
* @throws InternalServerErrorException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeServicesResult describeServices() throws AmazonServiceException, AmazonClientException;
/**
* Shuts down this client object, releasing any resources that might be held
* open. This is an optional method, and callers are not expected to call
* it, but can if they want to explicitly release any open resources. Once a
* client has been shutdown, it should not be used to make any more
* requests.
*/
public void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for
* debugging issues where a service isn't acting as expected. This data isn't considered part
* of the result data returned by an operation, so it's available through this separate,
* diagnostic interface.
* <p>
* Response metadata is only cached for a limited period of time, so if you need to access
* this extra diagnostic information for an executed request, you should use this method
* to retrieve it as soon as possible after executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none
* is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}