| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::S3::Condition; | ||
| 3 | use Moose; | ||
| 4 | has HttpErrorCodeReturnedEquals => (is => 'ro', isa => 'Str'); | ||
| 5 | has KeyPrefixEquals => (is => 'ro', isa => 'Str'); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::S3::Condition | ||
| 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::S3::Condition object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { HttpErrorCodeReturnedEquals => $value, ..., KeyPrefixEquals => $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::S3::Condition object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->HttpErrorCodeReturnedEquals | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | A container for describing a condition that must be met for the | ||
| 38 | specified redirect to apply. For example, 1. If request is for pages in | ||
| 39 | the C</docs> folder, redirect to the C</documents> folder. 2. If | ||
| 40 | request results in HTTP error 4xx, redirect request to another host | ||
| 41 | where you might process the error. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 HttpErrorCodeReturnedEquals => Str | ||
| 47 | |||
| 48 | The HTTP error code when the redirect is applied. In the event of an | ||
| 49 | error, if the error code equals this value, then the specified redirect | ||
| 50 | is applied. Required when parent element C<Condition> is specified and | ||
| 51 | sibling C<KeyPrefixEquals> is not specified. If both are specified, | ||
| 52 | then both must be true for the redirect to be applied. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 KeyPrefixEquals => Str | ||
| 56 | |||
| 57 | The object key name prefix when the redirect is applied. For example, | ||
| 58 | to redirect requests for C<ExamplePage.html>, the key prefix will be | ||
| 59 | C<ExamplePage.html>. To redirect request for all pages with the prefix | ||
| 60 | C<docs/>, the key prefix will be C</docs>, which identifies all objects | ||
| 61 | in the C<docs/> folder. Required when the parent element C<Condition> | ||
| 62 | is specified and sibling C<HttpErrorCodeReturnedEquals> is not | ||
| 63 | specified. If both conditions are specified, both must be true for the | ||
| 64 | redirect to be applied. | ||
| 65 | |||
| 66 | Replacement must be made for object keys containing special characters | ||
| 67 | (such as carriage returns) when using XML requests. For more | ||
| 68 | information, see XML related object key constraints | ||
| 69 | (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints). | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head1 SEE ALSO | ||
| 74 | |||
| 75 | This class forms part of L<Paws>, describing an object used in L<Paws::S3> | ||
| 76 | |||
| 77 | =head1 BUGS and CONTRIBUTIONS | ||
| 78 | |||
| 79 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 80 | |||
| 81 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 82 | |||
| 83 | =cut | ||
| 84 |