| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::S3Control::S3InitiateRestoreObjectOperation; | ||
| 3 | use Moose; | ||
| 4 | has ExpirationInDays => (is => 'ro', isa => 'Int'); | ||
| 5 | has GlacierJobTier => (is => 'ro', isa => 'Str'); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::S3Control::S3InitiateRestoreObjectOperation | ||
| 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::S3Control::S3InitiateRestoreObjectOperation object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { ExpirationInDays => $value, ..., GlacierJobTier => $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::S3Control::S3InitiateRestoreObjectOperation object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->ExpirationInDays | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Contains the configuration parameters for an S3 Initiate Restore Object | ||
| 38 | job. S3 Batch Operations passes every object to the underlying POST | ||
| 39 | Object restore API. For more information about the parameters for this | ||
| 40 | operation, see RestoreObject | ||
| 41 | (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOSTrestore.html#RESTObjectPOSTrestore-restore-request). | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 ExpirationInDays => Int | ||
| 47 | |||
| 48 | This argument specifies how long the S3 Glacier or S3 Glacier Deep | ||
| 49 | Archive object remains available in Amazon S3. S3 Initiate Restore | ||
| 50 | Object jobs that target S3 Glacier and S3 Glacier Deep Archive objects | ||
| 51 | require C<ExpirationInDays> set to 1 or greater. | ||
| 52 | |||
| 53 | Conversely, do I<not> set C<ExpirationInDays> when creating S3 Initiate | ||
| 54 | Restore Object jobs that target S3 Intelligent-Tiering Archive Access | ||
| 55 | and Deep Archive Access tier objects. Objects in S3 Intelligent-Tiering | ||
| 56 | archive access tiers are not subject to restore expiry, so specifying | ||
| 57 | C<ExpirationInDays> results in restore request failure. | ||
| 58 | |||
| 59 | S3 Batch Operations jobs can operate either on S3 Glacier and S3 | ||
| 60 | Glacier Deep Archive storage class objects or on S3 Intelligent-Tiering | ||
| 61 | Archive Access and Deep Archive Access storage tier objects, but not | ||
| 62 | both types in the same job. If you need to restore objects of both | ||
| 63 | types you I<must> create separate Batch Operations jobs. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 GlacierJobTier => Str | ||
| 67 | |||
| 68 | S3 Batch Operations supports C<STANDARD> and C<BULK> retrieval tiers, | ||
| 69 | but not the C<EXPEDITED> retrieval tier. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head1 SEE ALSO | ||
| 74 | |||
| 75 | This class forms part of L<Paws>, describing an object used in L<Paws::S3Control> | ||
| 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 |