blib/lib/Paws/Support.pm

filter: Statementstmt 14.8% 14 / 94 Branchbran 0.0% 0 / 16 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 20.0% 5 / 25 Podpod 72.7% 16 / 22 totaltotal 22.2% 35 / 157 CC 13 SCAR 31.0
CC
13
Cov
13%
DescribeAllCases
56.0
DescribeAllCommunications
56.0
signing_name
2.0
CRAP 22.3
« blib/lib/Paws/Glacier.pm ↑ Summary blib/lib/Paws/EFS.pm »
1 package Paws::Support;
2 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
3 1 ▶ sub service { 'support' }
Subroutine service: called CC=1 SCAR=0.0
Pod undocumented
4 0 ▶ sub signing_name { 'support' }
Subroutine signing_name: not called CC=1 SCAR=6.9
Pod undocumented
5 0 ▶ sub version { '2013-04-15' }
Subroutine version: not called CC=1 SCAR=6.9
Pod undocumented
6 0 ▶ sub target_prefix { 'AWSSupport_20130415' }
Subroutine target_prefix: not called CC=1 SCAR=6.9
Pod undocumented
7 0 ▶ sub json_version { "1.1" }
Subroutine json_version: not called CC=1 SCAR=6.9
Pod undocumented
8 1 has max_attempts => (is => 'ro', isa => 'Int', default => 5);
9 1 ▶ has retry => (is => 'ro', isa => 'HashRef', default => sub {
Subroutine __ANON__: called CC=1 SCAR=0.0
10 1 { base => 'rand', type => 'exponential', growth_factor => 2 }
11 1 });
12 1 ▶ has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
Subroutine __ANON__: called CC=1 SCAR=0.0
13 1 ] });
14  
15 1 with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::JsonCaller';
16  
17
18 0 ▶ sub AddAttachmentsToSet {
Subroutine AddAttachmentsToSet: not called CC=1 SCAR=6.9
Pod documented
19 0 my $self = shift;
20 0 my $call_object = $self->new_with_coercions('Paws::Support::AddAttachmentsToSet', @_);
21 0 return $self->caller->do_call($self, $call_object);
22 }
23 0 ▶ sub AddCommunicationToCase {
Subroutine AddCommunicationToCase: not called CC=1 SCAR=6.9
Pod documented
24 0 my $self = shift;
25 0 my $call_object = $self->new_with_coercions('Paws::Support::AddCommunicationToCase', @_);
26 0 return $self->caller->do_call($self, $call_object);
27 }
28 0 ▶ sub CreateCase {
Subroutine CreateCase: not called CC=1 SCAR=6.9
Pod documented
29 0 my $self = shift;
30 0 my $call_object = $self->new_with_coercions('Paws::Support::CreateCase', @_);
31 0 return $self->caller->do_call($self, $call_object);
32 }
33 0 ▶ sub DescribeAttachment {
Subroutine DescribeAttachment: not called CC=1 SCAR=6.9
Pod documented
34 0 my $self = shift;
35 0 my $call_object = $self->new_with_coercions('Paws::Support::DescribeAttachment', @_);
36 0 return $self->caller->do_call($self, $call_object);
37 }
38 0 ▶ sub DescribeCases {
Subroutine DescribeCases: not called CC=1 SCAR=6.9
Pod documented
39 0 my $self = shift;
40 0 my $call_object = $self->new_with_coercions('Paws::Support::DescribeCases', @_);
41 0 return $self->caller->do_call($self, $call_object);
42 }
43 0 ▶ sub DescribeCommunications {
Subroutine DescribeCommunications: not called CC=1 SCAR=6.9
Pod documented
44 0 my $self = shift;
45 0 my $call_object = $self->new_with_coercions('Paws::Support::DescribeCommunications', @_);
46 0 return $self->caller->do_call($self, $call_object);
47 }
48 0 ▶ sub DescribeServices {
Subroutine DescribeServices: not called CC=1 SCAR=6.9
Pod documented
49 0 my $self = shift;
50 0 my $call_object = $self->new_with_coercions('Paws::Support::DescribeServices', @_);
51 0 return $self->caller->do_call($self, $call_object);
52 }
53 0 ▶ sub DescribeSeverityLevels {
Subroutine DescribeSeverityLevels: not called CC=1 SCAR=6.9
Pod documented
54 0 my $self = shift;
55 0 my $call_object = $self->new_with_coercions('Paws::Support::DescribeSeverityLevels', @_);
56 0 return $self->caller->do_call($self, $call_object);
57 }
58 0 ▶ sub DescribeTrustedAdvisorCheckRefreshStatuses {
Subroutine DescribeTrustedAdvisorCheckRefreshStatuses: not called CC=1 SCAR=6.9
Pod documented
59 0 my $self = shift;
60 0 my $call_object = $self->new_with_coercions('Paws::Support::DescribeTrustedAdvisorCheckRefreshStatuses', @_);
61 0 return $self->caller->do_call($self, $call_object);
62 }
63 0 ▶ sub DescribeTrustedAdvisorCheckResult {
Subroutine DescribeTrustedAdvisorCheckResult: not called CC=1 SCAR=6.9
Pod documented
64 0 my $self = shift;
65 0 my $call_object = $self->new_with_coercions('Paws::Support::DescribeTrustedAdvisorCheckResult', @_);
66 0 return $self->caller->do_call($self, $call_object);
67 }
68 0 ▶ sub DescribeTrustedAdvisorChecks {
Subroutine DescribeTrustedAdvisorChecks: not called CC=1 SCAR=6.9
Pod documented
69 0 my $self = shift;
70 0 my $call_object = $self->new_with_coercions('Paws::Support::DescribeTrustedAdvisorChecks', @_);
71 0 return $self->caller->do_call($self, $call_object);
72 }
73 1 ▶ sub DescribeTrustedAdvisorCheckSummaries {
Subroutine DescribeTrustedAdvisorCheckSummaries: called CC=1 SCAR=0.0
Pod documented
74 1 my $self = shift;
75 1 my $call_object = $self->new_with_coercions('Paws::Support::DescribeTrustedAdvisorCheckSummaries', @_);
76 1 return $self->caller->do_call($self, $call_object);
77 }
78 0 ▶ sub RefreshTrustedAdvisorCheck {
Subroutine RefreshTrustedAdvisorCheck: not called CC=1 SCAR=6.9
Pod documented
79 0 my $self = shift;
80 0 my $call_object = $self->new_with_coercions('Paws::Support::RefreshTrustedAdvisorCheck', @_);
81 0 return $self->caller->do_call($self, $call_object);
82 }
83 0 ▶ sub ResolveCase {
Subroutine ResolveCase: not called CC=1 SCAR=6.9
Pod documented
84 0 my $self = shift;
85 0 my $call_object = $self->new_with_coercions('Paws::Support::ResolveCase', @_);
86 0 return $self->caller->do_call($self, $call_object);
87 }
88
89 0 ▶ sub DescribeAllCases {
Subroutine DescribeAllCases: not called CC=7 SCAR=40.3
Pod documented
90 0 my $self = shift;
91  
92 0 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 0 0 0
93 0 my $result = $self->DescribeCases(@_);
94 0 my $next_result = $result;
95  
96 0 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 0 0 0
97 0 ▶ while ($next_result->nextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->nextToken) 0 0 0
98 0 $next_result = $self->DescribeCases(@_, nextToken => $next_result->nextToken);
99 0 push @{ $result->cases }, @{ $next_result->cases };
100 }
101 0 return $result;
102 } else {
103 0 ▶ while ($result->nextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->nextToken) 0 0 0
104 0 $callback->($_ => 'cases') foreach (@{ $result->cases });
105 0 $result = $self->DescribeCases(@_, nextToken => $result->nextToken);
106 }
107 0 $callback->($_ => 'cases') foreach (@{ $result->cases });
108 }
109  
110 return undef
111 0 }
112 0 ▶ sub DescribeAllCommunications {
Subroutine DescribeAllCommunications: not called CC=7 SCAR=40.3
Pod documented
113 0 my $self = shift;
114  
115 0 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 0 0 0
116 0 my $result = $self->DescribeCommunications(@_);
117 0 my $next_result = $result;
118  
119 0 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 0 0 0
120 0 ▶ while ($next_result->nextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->nextToken) 0 0 0
121 0 $next_result = $self->DescribeCommunications(@_, nextToken => $next_result->nextToken);
122 0 push @{ $result->communications }, @{ $next_result->communications };
123 }
124 0 return $result;
125 } else {
126 0 ▶ while ($result->nextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->nextToken) 0 0 0
127 0 $callback->($_ => 'communications') foreach (@{ $result->communications });
128 0 $result = $self->DescribeCommunications(@_, nextToken => $result->nextToken);
129 }
130 0 $callback->($_ => 'communications') foreach (@{ $result->communications });
131 }
132  
133 return undef
134 0 }
135  
136  
137 0 ▶ sub operations { qw/AddAttachmentsToSet AddCommunicationToCase CreateCase DescribeAttachment DescribeCases DescribeCommunications DescribeServices DescribeSeverityLevels DescribeTrustedAdvisorCheckRefreshStatuses DescribeTrustedAdvisorCheckResult DescribeTrustedAdvisorChecks DescribeTrustedAdvisorCheckSummaries RefreshTrustedAdvisorCheck ResolveCase / }
Subroutine operations: not called CC=1 SCAR=6.9
Pod undocumented
138  
139 1 1;
140  
141 ### main pod documentation begin ###
142  
143 =head1 NAME
144  
145 Paws::Support - Perl Interface to AWS AWS Support
146  
147 =head1 SYNOPSIS
148  
149 use Paws;
150  
151 my $obj = Paws->service('Support');
152 my $res = $obj->Method(
153 Arg1 => $val1,
154 Arg2 => [ 'V1', 'V2' ],
155 # if Arg3 is an object, the HashRef will be used as arguments to the constructor
156 # of the arguments type
157 Arg3 => { Att1 => 'Val1' },
158 # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
159 # the constructor of the arguments type
160 Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
161 );
162  
163 =head1 DESCRIPTION
164  
165 AWS Support
166  
167 The I<AWS Support API Reference> is intended for programmers who need
168 detailed information about the AWS Support operations and data types.
169 You can use the API to manage your support cases programmatically. The
170 AWS Support API uses HTTP methods that return results in JSON format.
171  
172 =over
173  
174 =item *
175  
176 You must have a Business or Enterprise Support plan to use the AWS
177 Support API.
178  
179 =item *
180  
181 If you call the AWS Support API from an account that does not have a
182 Business or Enterprise Support plan, the
183 C<SubscriptionRequiredException> error message appears. For information
184 about changing your support plan, see AWS Support
185 (http://aws.amazon.com/premiumsupport/).
186  
187 =back
188  
189 The AWS Support service also exposes a set of AWS Trusted Advisor
190 (http://aws.amazon.com/premiumsupport/trustedadvisor/) features. You
191 can retrieve a list of checks and their descriptions, get check
192 results, specify checks to refresh, and get the refresh status of
193 checks.
194  
195 The following list describes the AWS Support case management
196 operations:
197  
198 =over
199  
200 =item *
201  
202 Service names, issue categories, and available severity levels - The
203 DescribeServices and DescribeSeverityLevels operations return AWS
204 service names, service codes, service categories, and problem severity
205 levels. You use these values when you call the CreateCase operation.
206  
207 =item *
208  
209 Case creation, case details, and case resolution - The CreateCase,
210 DescribeCases, DescribeAttachment, and ResolveCase operations create
211 AWS Support cases, retrieve information about cases, and resolve cases.
212  
213 =item *
214  
215 Case communication - The DescribeCommunications,
216 AddCommunicationToCase, and AddAttachmentsToSet operations retrieve and
217 add communications and attachments to AWS Support cases.
218  
219 =back
220  
221 The following list describes the operations available from the AWS
222 Support service for Trusted Advisor:
223  
224 =over
225  
226 =item *
227  
228 DescribeTrustedAdvisorChecks returns the list of checks that run
229 against your AWS resources.
230  
231 =item *
232  
233 Using the C<checkId> for a specific check returned by
234 DescribeTrustedAdvisorChecks, you can call
235 DescribeTrustedAdvisorCheckResult to obtain the results for the check
236 that you specified.
237  
238 =item *
239  
240 DescribeTrustedAdvisorCheckSummaries returns summarized results for one
241 or more Trusted Advisor checks.
242  
243 =item *
244  
245 RefreshTrustedAdvisorCheck requests that Trusted Advisor rerun a
246 specified check.
247  
248 =item *
249  
250 DescribeTrustedAdvisorCheckRefreshStatuses reports the refresh status
251 of one or more checks.
252  
253 =back
254  
255 For authentication of requests, AWS Support uses Signature Version 4
256 Signing Process
257 (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).
258  
259 See About the AWS Support API
260 (https://docs.aws.amazon.com/awssupport/latest/user/Welcome.html) in
261 the I<AWS Support User Guide> for information about how to use this
262 service to create and manage your support cases, and how to call
263 Trusted Advisor for results of checks on your resources.
264  
265 For the AWS API documentation, see L<https://docs.aws.amazon.com/aws-support/>
266  
267  
268 =head1 METHODS
269  
270 =head2 AddAttachmentsToSet
271  
272 =over
273  
274 =item Attachments => ArrayRef[L<Paws::Support::Attachment>]
275  
276 =item [AttachmentSetId => Str]
277  
278  
279 =back
280  
281 Each argument is described in detail in: L<Paws::Support::AddAttachmentsToSet>
282  
283 Returns: a L<Paws::Support::AddAttachmentsToSetResponse> instance
284  
285 Adds one or more attachments to an attachment set.
286  
287 An attachment set is a temporary container for attachments that you add
288 to a case or case communication. The set is available for 1 hour after
289 it's created. The C<expiryTime> returned in the response is when the
290 set expires.
291  
292 =over
293  
294 =item *
295  
296 You must have a Business or Enterprise Support plan to use the AWS
297 Support API.
298  
299 =item *
300  
301 If you call the AWS Support API from an account that does not have a
302 Business or Enterprise Support plan, the
303 C<SubscriptionRequiredException> error message appears. For information
304 about changing your support plan, see AWS Support
305 (http://aws.amazon.com/premiumsupport/).
306  
307 =back
308  
309  
310  
311 =head2 AddCommunicationToCase
312  
313 =over
314  
315 =item CommunicationBody => Str
316  
317 =item [AttachmentSetId => Str]
318  
319 =item [CaseId => Str]
320  
321 =item [CcEmailAddresses => ArrayRef[Str|Undef]]
322  
323  
324 =back
325  
326 Each argument is described in detail in: L<Paws::Support::AddCommunicationToCase>
327  
328 Returns: a L<Paws::Support::AddCommunicationToCaseResponse> instance
329  
330 Adds additional customer communication to an AWS Support case. Use the
331 C<caseId> parameter to identify the case to which to add communication.
332 You can list a set of email addresses to copy on the communication by
333 using the C<ccEmailAddresses> parameter. The C<communicationBody> value
334 contains the text of the communication.
335  
336 =over
337  
338 =item *
339  
340 You must have a Business or Enterprise Support plan to use the AWS
341 Support API.
342  
343 =item *
344  
345 If you call the AWS Support API from an account that does not have a
346 Business or Enterprise Support plan, the
347 C<SubscriptionRequiredException> error message appears. For information
348 about changing your support plan, see AWS Support
349 (http://aws.amazon.com/premiumsupport/).
350  
351 =back
352  
353  
354  
355 =head2 CreateCase
356  
357 =over
358  
359 =item CommunicationBody => Str
360  
361 =item Subject => Str
362  
363 =item [AttachmentSetId => Str]
364  
365 =item [CategoryCode => Str]
366  
367 =item [CcEmailAddresses => ArrayRef[Str|Undef]]
368  
369 =item [IssueType => Str]
370  
371 =item [Language => Str]
372  
373 =item [ServiceCode => Str]
374  
375 =item [SeverityCode => Str]
376  
377  
378 =back
379  
380 Each argument is described in detail in: L<Paws::Support::CreateCase>
381  
382 Returns: a L<Paws::Support::CreateCaseResponse> instance
383  
384 Creates a case in the AWS Support Center. This operation is similar to
385 how you create a case in the AWS Support Center Create Case
386 (https://console.aws.amazon.com/support/home#/case/create) page.
387  
388 The AWS Support API doesn't support requesting service limit increases.
389 You can submit a service limit increase in the following ways:
390  
391 =over
392  
393 =item *
394  
395 Submit a request from the AWS Support Center Create Case
396 (https://console.aws.amazon.com/support/home#/case/create) page.
397  
398 =item *
399  
400 Use the Service Quotas RequestServiceQuotaIncrease
401 (https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_RequestServiceQuotaIncrease.html)
402 operation.
403  
404 =back
405  
406 A successful C<CreateCase> request returns an AWS Support case number.
407 You can use the DescribeCases operation and specify the case number to
408 get existing AWS Support cases. After you create a case, use the
409 AddCommunicationToCase operation to add additional communication or
410 attachments to an existing case.
411  
412 The C<caseId> is separate from the C<displayId> that appears in the AWS
413 Support Center (https://console.aws.amazon.com/support). Use the
414 DescribeCases operation to get the C<displayId>.
415  
416 =over
417  
418 =item *
419  
420 You must have a Business or Enterprise Support plan to use the AWS
421 Support API.
422  
423 =item *
424  
425 If you call the AWS Support API from an account that does not have a
426 Business or Enterprise Support plan, the
427 C<SubscriptionRequiredException> error message appears. For information
428 about changing your support plan, see AWS Support
429 (http://aws.amazon.com/premiumsupport/).
430  
431 =back
432  
433  
434  
435 =head2 DescribeAttachment
436  
437 =over
438  
439 =item AttachmentId => Str
440  
441  
442 =back
443  
444 Each argument is described in detail in: L<Paws::Support::DescribeAttachment>
445  
446 Returns: a L<Paws::Support::DescribeAttachmentResponse> instance
447  
448 Returns the attachment that has the specified ID. Attachments can
449 include screenshots, error logs, or other files that describe your
450 issue. Attachment IDs are generated by the case management system when
451 you add an attachment to a case or case communication. Attachment IDs
452 are returned in the AttachmentDetails objects that are returned by the
453 DescribeCommunications operation.
454  
455 =over
456  
457 =item *
458  
459 You must have a Business or Enterprise Support plan to use the AWS
460 Support API.
461  
462 =item *
463  
464 If you call the AWS Support API from an account that does not have a
465 Business or Enterprise Support plan, the
466 C<SubscriptionRequiredException> error message appears. For information
467 about changing your support plan, see AWS Support
468 (http://aws.amazon.com/premiumsupport/).
469  
470 =back
471  
472  
473  
474 =head2 DescribeCases
475  
476 =over
477  
478 =item [AfterTime => Str]
479  
480 =item [BeforeTime => Str]
481  
482 =item [CaseIdList => ArrayRef[Str|Undef]]
483  
484 =item [DisplayId => Str]
485  
486 =item [IncludeCommunications => Bool]
487  
488 =item [IncludeResolvedCases => Bool]
489  
490 =item [Language => Str]
491  
492 =item [MaxResults => Int]
493  
494 =item [NextToken => Str]
495  
496  
497 =back
498  
499 Each argument is described in detail in: L<Paws::Support::DescribeCases>
500  
501 Returns: a L<Paws::Support::DescribeCasesResponse> instance
502  
503 Returns a list of cases that you specify by passing one or more case
504 IDs. You can use the C<afterTime> and C<beforeTime> parameters to
505 filter the cases by date. You can set values for the
506 C<includeResolvedCases> and C<includeCommunications> parameters to
507 specify how much information to return.
508  
509 The response returns the following in JSON format:
510  
511 =over
512  
513 =item *
514  
515 One or more CaseDetails
516 (https://docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html)
517 data types.
518  
519 =item *
520  
521 One or more C<nextToken> values, which specify where to paginate the
522 returned records represented by the C<CaseDetails> objects.
523  
524 =back
525  
526 Case data is available for 12 months after creation. If a case was
527 created more than 12 months ago, a request might return an error.
528  
529 =over
530  
531 =item *
532  
533 You must have a Business or Enterprise Support plan to use the AWS
534 Support API.
535  
536 =item *
537  
538 If you call the AWS Support API from an account that does not have a
539 Business or Enterprise Support plan, the
540 C<SubscriptionRequiredException> error message appears. For information
541 about changing your support plan, see AWS Support
542 (http://aws.amazon.com/premiumsupport/).
543  
544 =back
545  
546  
547  
548 =head2 DescribeCommunications
549  
550 =over
551  
552 =item CaseId => Str
553  
554 =item [AfterTime => Str]
555  
556 =item [BeforeTime => Str]
557  
558 =item [MaxResults => Int]
559  
560 =item [NextToken => Str]
561  
562  
563 =back
564  
565 Each argument is described in detail in: L<Paws::Support::DescribeCommunications>
566  
567 Returns: a L<Paws::Support::DescribeCommunicationsResponse> instance
568  
569 Returns communications and attachments for one or more support cases.
570 Use the C<afterTime> and C<beforeTime> parameters to filter by date.
571 You can use the C<caseId> parameter to restrict the results to a
572 specific case.
573  
574 Case data is available for 12 months after creation. If a case was
575 created more than 12 months ago, a request for data might cause an
576 error.
577  
578 You can use the C<maxResults> and C<nextToken> parameters to control
579 the pagination of the results. Set C<maxResults> to the number of cases
580 that you want to display on each page, and use C<nextToken> to specify
581 the resumption of pagination.
582  
583 =over
584  
585 =item *
586  
587 You must have a Business or Enterprise Support plan to use the AWS
588 Support API.
589  
590 =item *
591  
592 If you call the AWS Support API from an account that does not have a
593 Business or Enterprise Support plan, the
594 C<SubscriptionRequiredException> error message appears. For information
595 about changing your support plan, see AWS Support
596 (http://aws.amazon.com/premiumsupport/).
597  
598 =back
599  
600  
601  
602 =head2 DescribeServices
603  
604 =over
605  
606 =item [Language => Str]
607  
608 =item [ServiceCodeList => ArrayRef[Str|Undef]]
609  
610  
611 =back
612  
613 Each argument is described in detail in: L<Paws::Support::DescribeServices>
614  
615 Returns: a L<Paws::Support::DescribeServicesResponse> instance
616  
617 Returns the current list of AWS services and a list of service
618 categories for each service. You then use service names and categories
619 in your CreateCase requests. Each AWS service has its own set of
620 categories.
621  
622 The service codes and category codes correspond to the values that
623 appear in the B<Service> and B<Category> lists on the AWS Support
624 Center Create Case
625 (https://console.aws.amazon.com/support/home#/case/create) page. The
626 values in those fields don't necessarily match the service codes and
627 categories returned by the C<DescribeServices> operation. Always use
628 the service codes and categories that the C<DescribeServices> operation
629 returns, so that you have the most recent set of service and category
630 codes.
631  
632 =over
633  
634 =item *
635  
636 You must have a Business or Enterprise Support plan to use the AWS
637 Support API.
638  
639 =item *
640  
641 If you call the AWS Support API from an account that does not have a
642 Business or Enterprise Support plan, the
643 C<SubscriptionRequiredException> error message appears. For information
644 about changing your support plan, see AWS Support
645 (http://aws.amazon.com/premiumsupport/).
646  
647 =back
648  
649  
650  
651 =head2 DescribeSeverityLevels
652  
653 =over
654  
655 =item [Language => Str]
656  
657  
658 =back
659  
660 Each argument is described in detail in: L<Paws::Support::DescribeSeverityLevels>
661  
662 Returns: a L<Paws::Support::DescribeSeverityLevelsResponse> instance
663  
664 Returns the list of severity levels that you can assign to a support
665 case. The severity level for a case is also a field in the CaseDetails
666 data type that you include for a CreateCase request.
667  
668 =over
669  
670 =item *
671  
672 You must have a Business or Enterprise Support plan to use the AWS
673 Support API.
674  
675 =item *
676  
677 If you call the AWS Support API from an account that does not have a
678 Business or Enterprise Support plan, the
679 C<SubscriptionRequiredException> error message appears. For information
680 about changing your support plan, see AWS Support
681 (http://aws.amazon.com/premiumsupport/).
682  
683 =back
684  
685  
686  
687 =head2 DescribeTrustedAdvisorCheckRefreshStatuses
688  
689 =over
690  
691 =item CheckIds => ArrayRef[Str|Undef]
692  
693  
694 =back
695  
696 Each argument is described in detail in: L<Paws::Support::DescribeTrustedAdvisorCheckRefreshStatuses>
697  
698 Returns: a L<Paws::Support::DescribeTrustedAdvisorCheckRefreshStatusesResponse> instance
699  
700 Returns the refresh status of the AWS Trusted Advisor checks that have
701 the specified check IDs. You can get the check IDs by calling the
702 DescribeTrustedAdvisorChecks operation.
703  
704 Some checks are refreshed automatically, and you can't return their
705 refresh statuses by using the
706 C<DescribeTrustedAdvisorCheckRefreshStatuses> operation. If you call
707 this operation for these checks, you might see an
708 C<InvalidParameterValue> error.
709  
710 =over
711  
712 =item *
713  
714 You must have a Business or Enterprise Support plan to use the AWS
715 Support API.
716  
717 =item *
718  
719 If you call the AWS Support API from an account that does not have a
720 Business or Enterprise Support plan, the
721 C<SubscriptionRequiredException> error message appears. For information
722 about changing your support plan, see AWS Support
723 (http://aws.amazon.com/premiumsupport/).
724  
725 =back
726  
727  
728  
729 =head2 DescribeTrustedAdvisorCheckResult
730  
731 =over
732  
733 =item CheckId => Str
734  
735 =item [Language => Str]
736  
737  
738 =back
739  
740 Each argument is described in detail in: L<Paws::Support::DescribeTrustedAdvisorCheckResult>
741  
742 Returns: a L<Paws::Support::DescribeTrustedAdvisorCheckResultResponse> instance
743  
744 Returns the results of the AWS Trusted Advisor check that has the
745 specified check ID. You can get the check IDs by calling the
746 DescribeTrustedAdvisorChecks operation.
747  
748 The response contains a TrustedAdvisorCheckResult object, which
749 contains these three objects:
750  
751 =over
752  
753 =item *
754  
755 TrustedAdvisorCategorySpecificSummary
756  
757 =item *
758  
759 TrustedAdvisorResourceDetail
760  
761 =item *
762  
763 TrustedAdvisorResourcesSummary
764  
765 =back
766  
767 In addition, the response contains these fields:
768  
769 =over
770  
771 =item *
772  
773 B<status> - The alert status of the check can be C<ok> (green),
774 C<warning> (yellow), C<error> (red), or C<not_available>.
775  
776 =item *
777  
778 B<timestamp> - The time of the last refresh of the check.
779  
780 =item *
781  
782 B<checkId> - The unique identifier for the check.
783  
784 =back
785  
786 =over
787  
788 =item *
789  
790 You must have a Business or Enterprise Support plan to use the AWS
791 Support API.
792  
793 =item *
794  
795 If you call the AWS Support API from an account that does not have a
796 Business or Enterprise Support plan, the
797 C<SubscriptionRequiredException> error message appears. For information
798 about changing your support plan, see AWS Support
799 (http://aws.amazon.com/premiumsupport/).
800  
801 =back
802  
803  
804  
805 =head2 DescribeTrustedAdvisorChecks
806  
807 =over
808  
809 =item Language => Str
810  
811  
812 =back
813  
814 Each argument is described in detail in: L<Paws::Support::DescribeTrustedAdvisorChecks>
815  
816 Returns: a L<Paws::Support::DescribeTrustedAdvisorChecksResponse> instance
817  
818 Returns information about all available AWS Trusted Advisor checks,
819 including the name, ID, category, description, and metadata. You must
820 specify a language code. The AWS Support API currently supports English
821 ("en") and Japanese ("ja"). The response contains a
822 TrustedAdvisorCheckDescription object for each check. You must set the
823 AWS Region to us-east-1.
824  
825 =over
826  
827 =item *
828  
829 You must have a Business or Enterprise Support plan to use the AWS
830 Support API.
831  
832 =item *
833  
834 If you call the AWS Support API from an account that does not have a
835 Business or Enterprise Support plan, the
836 C<SubscriptionRequiredException> error message appears. For information
837 about changing your support plan, see AWS Support
838 (http://aws.amazon.com/premiumsupport/).
839  
840 =item *
841  
842 The names and descriptions for Trusted Advisor checks are subject to
843 change. We recommend that you specify the check ID in your code to
844 uniquely identify a check.
845  
846 =back
847  
848  
849  
850 =head2 DescribeTrustedAdvisorCheckSummaries
851  
852 =over
853  
854 =item CheckIds => ArrayRef[Str|Undef]
855  
856  
857 =back
858  
859 Each argument is described in detail in: L<Paws::Support::DescribeTrustedAdvisorCheckSummaries>
860  
861 Returns: a L<Paws::Support::DescribeTrustedAdvisorCheckSummariesResponse> instance
862  
863 Returns the results for the AWS Trusted Advisor check summaries for the
864 check IDs that you specified. You can get the check IDs by calling the
865 DescribeTrustedAdvisorChecks operation.
866  
867 The response contains an array of TrustedAdvisorCheckSummary objects.
868  
869 =over
870  
871 =item *
872  
873 You must have a Business or Enterprise Support plan to use the AWS
874 Support API.
875  
876 =item *
877  
878 If you call the AWS Support API from an account that does not have a
879 Business or Enterprise Support plan, the
880 C<SubscriptionRequiredException> error message appears. For information
881 about changing your support plan, see AWS Support
882 (http://aws.amazon.com/premiumsupport/).
883  
884 =back
885  
886  
887  
888 =head2 RefreshTrustedAdvisorCheck
889  
890 =over
891  
892 =item CheckId => Str
893  
894  
895 =back
896  
897 Each argument is described in detail in: L<Paws::Support::RefreshTrustedAdvisorCheck>
898  
899 Returns: a L<Paws::Support::RefreshTrustedAdvisorCheckResponse> instance
900  
901 Refreshes the AWS Trusted Advisor check that you specify using the
902 check ID. You can get the check IDs by calling the
903 DescribeTrustedAdvisorChecks operation.
904  
905 Some checks are refreshed automatically. If you call the
906 C<RefreshTrustedAdvisorCheck> operation to refresh them, you might see
907 the C<InvalidParameterValue> error.
908  
909 The response contains a TrustedAdvisorCheckRefreshStatus object.
910  
911 =over
912  
913 =item *
914  
915 You must have a Business or Enterprise Support plan to use the AWS
916 Support API.
917  
918 =item *
919  
920 If you call the AWS Support API from an account that does not have a
921 Business or Enterprise Support plan, the
922 C<SubscriptionRequiredException> error message appears. For information
923 about changing your support plan, see AWS Support
924 (http://aws.amazon.com/premiumsupport/).
925  
926 =back
927  
928  
929  
930 =head2 ResolveCase
931  
932 =over
933  
934 =item [CaseId => Str]
935  
936  
937 =back
938  
939 Each argument is described in detail in: L<Paws::Support::ResolveCase>
940  
941 Returns: a L<Paws::Support::ResolveCaseResponse> instance
942  
943 Resolves a support case. This operation takes a C<caseId> and returns
944 the initial and final state of the case.
945  
946 =over
947  
948 =item *
949  
950 You must have a Business or Enterprise Support plan to use the AWS
951 Support API.
952  
953 =item *
954  
955 If you call the AWS Support API from an account that does not have a
956 Business or Enterprise Support plan, the
957 C<SubscriptionRequiredException> error message appears. For information
958 about changing your support plan, see AWS Support
959 (http://aws.amazon.com/premiumsupport/).
960  
961 =back
962  
963  
964  
965  
966  
967 =head1 PAGINATORS
968  
969 Paginator methods are helpers that repetively call methods that return partial results
970  
971 =head2 DescribeAllCases(sub { },[AfterTime => Str, BeforeTime => Str, CaseIdList => ArrayRef[Str|Undef], DisplayId => Str, IncludeCommunications => Bool, IncludeResolvedCases => Bool, Language => Str, MaxResults => Int, NextToken => Str])
972  
973 =head2 DescribeAllCases([AfterTime => Str, BeforeTime => Str, CaseIdList => ArrayRef[Str|Undef], DisplayId => Str, IncludeCommunications => Bool, IncludeResolvedCases => Bool, Language => Str, MaxResults => Int, NextToken => Str])
974  
975  
976 If passed a sub as first parameter, it will call the sub for each element found in :
977  
978 - cases, passing the object as the first parameter, and the string 'cases' as the second parameter
979  
980 If not, it will return a a L<Paws::Support::DescribeCasesResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
981  
982  
983 =head2 DescribeAllCommunications(sub { },CaseId => Str, [AfterTime => Str, BeforeTime => Str, MaxResults => Int, NextToken => Str])
984  
985 =head2 DescribeAllCommunications(CaseId => Str, [AfterTime => Str, BeforeTime => Str, MaxResults => Int, NextToken => Str])
986  
987  
988 If passed a sub as first parameter, it will call the sub for each element found in :
989  
990 - communications, passing the object as the first parameter, and the string 'communications' as the second parameter
991  
992 If not, it will return a a L<Paws::Support::DescribeCommunicationsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
993  
994  
995  
996  
997  
998 =head1 SEE ALSO
999  
1000 This service class forms part of L<Paws>
1001  
1002 =head1 BUGS and CONTRIBUTIONS
1003  
1004 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
1005  
1006 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
1007  
1008 =cut
1009  
« blib/lib/Paws/Glacier.pm ↑ Summary blib/lib/Paws/EFS.pm »