« blib/lib/Paws/CloudFront/CustomErrorResponse.pm
↑ Summary
blib/lib/Paws/CloudFront/CustomHeaders.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudFront::CustomErrorResponses; | ||
| 3 | use Moose; | ||
| 4 | has Items => (is => 'ro', isa => 'ArrayRef[Paws::CloudFront::CustomErrorResponse]', request_name => 'CustomErrorResponse', traits => ['NameInRequest']); | ||
| 5 | has Quantity => (is => 'ro', isa => 'Int', required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::CloudFront::CustomErrorResponses | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::CloudFront::CustomErrorResponses object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { Items => $value, ..., Quantity => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFront::CustomErrorResponses object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->Items | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | A complex type that controls: | ||
| 38 | |||
| 39 | =over | ||
| 40 | |||
| 41 | =item * | ||
| 42 | |||
| 43 | Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range | ||
| 44 | with custom error messages before returning the response to the viewer. | ||
| 45 | |||
| 46 | =item * | ||
| 47 | |||
| 48 | How long CloudFront caches HTTP status codes in the 4xx and 5xx range. | ||
| 49 | |||
| 50 | =back | ||
| 51 | |||
| 52 | For more information about custom error pages, see Customizing Error | ||
| 53 | Responses | ||
| 54 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) | ||
| 55 | in the I<Amazon CloudFront Developer Guide>. | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 Items => ArrayRef[L<Paws::CloudFront::CustomErrorResponse>] | ||
| 61 | |||
| 62 | A complex type that contains a C<CustomErrorResponse> element for each | ||
| 63 | HTTP status code for which you want to specify a custom error page | ||
| 64 | and/or a caching duration. | ||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> Quantity => Int | ||
| 68 | |||
| 69 | The number of HTTP status codes for which you want to specify a custom | ||
| 70 | error page and/or a caching duration. If C<Quantity> is C<0>, you can | ||
| 71 | omit C<Items>. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head1 SEE ALSO | ||
| 76 | |||
| 77 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudFront> | ||
| 78 | |||
| 79 | =head1 BUGS and CONTRIBUTIONS | ||
| 80 | |||
| 81 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 82 | |||
| 83 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 84 | |||
| 85 | =cut | ||
| 86 |