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