File Coverage

blib/lib/Paws/Glacier/JobParameters.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::Glacier::JobParameters;
2 1     1   524 use Moose;
  1         4  
  1         8  
3             has ArchiveId => (is => 'ro', isa => 'Str');
4             has Description => (is => 'ro', isa => 'Str');
5             has Format => (is => 'ro', isa => 'Str');
6             has InventoryRetrievalParameters => (is => 'ro', isa => 'Paws::Glacier::InventoryRetrievalJobInput');
7             has RetrievalByteRange => (is => 'ro', isa => 'Str');
8             has SNSTopic => (is => 'ro', isa => 'Str');
9             has Tier => (is => 'ro', isa => 'Str');
10             has Type => (is => 'ro', isa => 'Str');
11             1;
12              
13             ### main pod documentation begin ###
14              
15             =head1 NAME
16              
17             Paws::Glacier::JobParameters
18              
19             =head1 USAGE
20              
21             This class represents one of two things:
22              
23             =head3 Arguments in a call to a service
24              
25             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
26             Each attribute should be used as a named argument in the calls that expect this type of object.
27              
28             As an example, if Att1 is expected to be a Paws::Glacier::JobParameters object:
29              
30             $service_obj->Method(Att1 => { ArchiveId => $value, ..., Type => $value });
31              
32             =head3 Results returned from an API call
33              
34             Use accessors for each attribute. If Att1 is expected to be an Paws::Glacier::JobParameters object:
35              
36             $result = $service_obj->Method(...);
37             $result->Att1->ArchiveId
38              
39             =head1 DESCRIPTION
40              
41             Provides options for defining a job.
42              
43             =head1 ATTRIBUTES
44              
45              
46             =head2 ArchiveId => Str
47              
48             The ID of the archive that you want to retrieve. This field is required
49             only if C<Type> is set to archive-retrieval. An error occurs if you
50             specify this request parameter for an inventory retrieval job request.
51              
52              
53             =head2 Description => Str
54              
55             The optional description for the job. The description must be less than
56             or equal to 1,024 bytes. The allowable characters are 7-bit ASCII
57             without control codes-specifically, ASCII values 32-126 decimal or
58             0x20-0x7E hexadecimal.
59              
60              
61             =head2 Format => Str
62              
63             When initiating a job to retrieve a vault inventory, you can optionally
64             add this parameter to your request to specify the output format. If you
65             are initiating an inventory job and do not specify a Format field, JSON
66             is the default format. Valid values are "CSV" and "JSON".
67              
68              
69             =head2 InventoryRetrievalParameters => L<Paws::Glacier::InventoryRetrievalJobInput>
70              
71             Input parameters used for range inventory retrieval.
72              
73              
74             =head2 RetrievalByteRange => Str
75              
76             The byte range to retrieve for an archive retrieval. in the form
77             "I<StartByteValue>-I<EndByteValue>" If not specified, the whole archive
78             is retrieved. If specified, the byte range must be megabyte (1024*1024)
79             aligned which means that I<StartByteValue> must be divisible by 1 MB
80             and I<EndByteValue> plus 1 must be divisible by 1 MB or be the end of
81             the archive specified as the archive byte size value minus 1. If
82             RetrievalByteRange is not megabyte aligned, this operation returns a
83             400 response.
84              
85             An error occurs if you specify this field for an inventory retrieval
86             job request.
87              
88              
89             =head2 SNSTopic => Str
90              
91             The Amazon SNS topic ARN to which Amazon Glacier sends a notification
92             when the job is completed and the output is ready for you to download.
93             The specified topic publishes the notification to its subscribers. The
94             SNS topic must exist.
95              
96              
97             =head2 Tier => Str
98              
99             The retrieval option to use for the archive retrieval. Valid values are
100             C<Expedited>, C<Standard>, or C<Bulk>. C<Standard> is the default.
101              
102              
103             =head2 Type => Str
104              
105             The job type. You can initiate a job to retrieve an archive or get an
106             inventory of a vault. Valid values are "archive-retrieval" and
107             "inventory-retrieval".
108              
109              
110              
111             =head1 SEE ALSO
112              
113             This class forms part of L<Paws>, describing an object used in L<Paws::Glacier>
114              
115             =head1 BUGS and CONTRIBUTIONS
116              
117             The source code is located here: https://github.com/pplu/aws-sdk-perl
118              
119             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
120              
121             =cut
122