File Coverage

blib/lib/Paws/Support/CaseDetails.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::Support::CaseDetails;
2 1     1   557 use Moose;
  1         2  
  1         10  
3             has CaseId => (is => 'ro', isa => 'Str', request_name => 'caseId', traits => ['NameInRequest']);
4             has CategoryCode => (is => 'ro', isa => 'Str', request_name => 'categoryCode', traits => ['NameInRequest']);
5             has CcEmailAddresses => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'ccEmailAddresses', traits => ['NameInRequest']);
6             has DisplayId => (is => 'ro', isa => 'Str', request_name => 'displayId', traits => ['NameInRequest']);
7             has Language => (is => 'ro', isa => 'Str', request_name => 'language', traits => ['NameInRequest']);
8             has RecentCommunications => (is => 'ro', isa => 'Paws::Support::RecentCaseCommunications', request_name => 'recentCommunications', traits => ['NameInRequest']);
9             has ServiceCode => (is => 'ro', isa => 'Str', request_name => 'serviceCode', traits => ['NameInRequest']);
10             has SeverityCode => (is => 'ro', isa => 'Str', request_name => 'severityCode', traits => ['NameInRequest']);
11             has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']);
12             has Subject => (is => 'ro', isa => 'Str', request_name => 'subject', traits => ['NameInRequest']);
13             has SubmittedBy => (is => 'ro', isa => 'Str', request_name => 'submittedBy', traits => ['NameInRequest']);
14             has TimeCreated => (is => 'ro', isa => 'Str', request_name => 'timeCreated', traits => ['NameInRequest']);
15             1;
16              
17             ### main pod documentation begin ###
18              
19             =head1 NAME
20              
21             Paws::Support::CaseDetails
22              
23             =head1 USAGE
24              
25             This class represents one of two things:
26              
27             =head3 Arguments in a call to a service
28              
29             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
30             Each attribute should be used as a named argument in the calls that expect this type of object.
31              
32             As an example, if Att1 is expected to be a Paws::Support::CaseDetails object:
33              
34             $service_obj->Method(Att1 => { CaseId => $value, ..., TimeCreated => $value });
35              
36             =head3 Results returned from an API call
37              
38             Use accessors for each attribute. If Att1 is expected to be an Paws::Support::CaseDetails object:
39              
40             $result = $service_obj->Method(...);
41             $result->Att1->CaseId
42              
43             =head1 DESCRIPTION
44              
45             A JSON-formatted object that contains the metadata for a support case.
46             It is contained the response from a DescribeCases request.
47             B<CaseDetails> contains the following fields:
48              
49             =over
50              
51             =item *
52              
53             B<caseId.> The AWS Support case ID requested or returned in the call.
54             The case ID is an alphanumeric string formatted as shown in this
55             example: case-I<12345678910-2013-c4c1d2bf33c5cf47>.
56              
57             =item *
58              
59             B<categoryCode.> The category of problem for the AWS Support case.
60             Corresponds to the CategoryCode values returned by a call to
61             DescribeServices.
62              
63             =item *
64              
65             B<displayId.> The identifier for the case on pages in the AWS Support
66             Center.
67              
68             =item *
69              
70             B<language.> The ISO 639-1 code for the language in which AWS provides
71             support. AWS Support currently supports English ("en") and Japanese
72             ("ja"). Language parameters must be passed explicitly for operations
73             that take them.
74              
75             =item *
76              
77             B<recentCommunications.> One or more Communication objects. Fields of
78             these objects are C<attachments>, C<body>, C<caseId>, C<submittedBy>,
79             and C<timeCreated>.
80              
81             =item *
82              
83             B<nextToken.> A resumption point for pagination.
84              
85             =item *
86              
87             B<serviceCode.> The identifier for the AWS service that corresponds to
88             the service code defined in the call to DescribeServices.
89              
90             =item *
91              
92             B<severityCode. >The severity code assigned to the case. Contains one
93             of the values returned by the call to DescribeSeverityLevels.
94              
95             =item *
96              
97             B<status.> The status of the case in the AWS Support Center.
98              
99             =item *
100              
101             B<subject.> The subject line of the case.
102              
103             =item *
104              
105             B<submittedBy.> The email address of the account that submitted the
106             case.
107              
108             =item *
109              
110             B<timeCreated.> The time the case was created, in ISO-8601 format.
111              
112             =back
113              
114              
115             =head1 ATTRIBUTES
116              
117              
118             =head2 CaseId => Str
119              
120             The AWS Support case ID requested or returned in the call. The case ID
121             is an alphanumeric string formatted as shown in this example:
122             case-I<12345678910-2013-c4c1d2bf33c5cf47>
123              
124              
125             =head2 CategoryCode => Str
126              
127             The category of problem for the AWS Support case.
128              
129              
130             =head2 CcEmailAddresses => ArrayRef[Str|Undef]
131              
132             The email addresses that receive copies of communication about the
133             case.
134              
135              
136             =head2 DisplayId => Str
137              
138             The ID displayed for the case in the AWS Support Center. This is a
139             numeric string.
140              
141              
142             =head2 Language => Str
143              
144             The ISO 639-1 code for the language in which AWS provides support. AWS
145             Support currently supports English ("en") and Japanese ("ja"). Language
146             parameters must be passed explicitly for operations that take them.
147              
148              
149             =head2 RecentCommunications => L<Paws::Support::RecentCaseCommunications>
150              
151             The five most recent communications between you and AWS Support Center,
152             including the IDs of any attachments to the communications. Also
153             includes a C<nextToken> that you can use to retrieve earlier
154             communications.
155              
156              
157             =head2 ServiceCode => Str
158              
159             The code for the AWS service returned by the call to DescribeServices.
160              
161              
162             =head2 SeverityCode => Str
163              
164             The code for the severity level returned by the call to
165             DescribeSeverityLevels.
166              
167              
168             =head2 Status => Str
169              
170             The status of the case.
171              
172              
173             =head2 Subject => Str
174              
175             The subject line for the case in the AWS Support Center.
176              
177              
178             =head2 SubmittedBy => Str
179              
180             The email address of the account that submitted the case.
181              
182              
183             =head2 TimeCreated => Str
184              
185             The time that the case was case created in the AWS Support Center.
186              
187              
188              
189             =head1 SEE ALSO
190              
191             This class forms part of L<Paws>, describing an object used in L<Paws::Support>
192              
193             =head1 BUGS and CONTRIBUTIONS
194              
195             The source code is located here: https://github.com/pplu/aws-sdk-perl
196              
197             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
198              
199             =cut
200