File Coverage

blib/lib/Paws/Snowball/JobLogs.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::Snowball::JobLogs;
2 1     1   341 use Moose;
  1         3  
  1         5  
3             has JobCompletionReportURI => (is => 'ro', isa => 'Str');
4             has JobFailureLogURI => (is => 'ro', isa => 'Str');
5             has JobSuccessLogURI => (is => 'ro', isa => 'Str');
6             1;
7              
8             ### main pod documentation begin ###
9              
10             =head1 NAME
11              
12             Paws::Snowball::JobLogs
13              
14             =head1 USAGE
15              
16             This class represents one of two things:
17              
18             =head3 Arguments in a call to a service
19              
20             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
21             Each attribute should be used as a named argument in the calls that expect this type of object.
22              
23             As an example, if Att1 is expected to be a Paws::Snowball::JobLogs object:
24              
25             $service_obj->Method(Att1 => { JobCompletionReportURI => $value, ..., JobSuccessLogURI => $value });
26              
27             =head3 Results returned from an API call
28              
29             Use accessors for each attribute. If Att1 is expected to be an Paws::Snowball::JobLogs object:
30              
31             $result = $service_obj->Method(...);
32             $result->Att1->JobCompletionReportURI
33              
34             =head1 DESCRIPTION
35              
36             Contains job logs. Whenever Snowball is used to import data into or
37             export data out of Amazon S3, you'll have the option of downloading a
38             PDF job report. Job logs are returned as a part of the response syntax
39             of the C<DescribeJob> action in the C<JobMetadata> data type. The job
40             logs can be accessed for up to 60 minutes after this request has been
41             made. To access any of the job logs after 60 minutes have passed,
42             you'll have to make another call to the C<DescribeJob> action.
43              
44             For import jobs, the PDF job report becomes available at the end of the
45             import process. For export jobs, your job report typically becomes
46             available while the Snowball for your job part is being delivered to
47             you.
48              
49             The job report provides you insight into the state of your Amazon S3
50             data transfer. The report includes details about your job or job part
51             for your records.
52              
53             For deeper visibility into the status of your transferred objects, you
54             can look at the two associated logs: a success log and a failure log.
55             The logs are saved in comma-separated value (CSV) format, and the name
56             of each log includes the ID of the job or job part that the log
57             describes.
58              
59             =head1 ATTRIBUTES
60              
61              
62             =head2 JobCompletionReportURI => Str
63              
64             A link to an Amazon S3 presigned URL where the job completion report is
65             located.
66              
67              
68             =head2 JobFailureLogURI => Str
69              
70             A link to an Amazon S3 presigned URL where the job failure log is
71             located.
72              
73              
74             =head2 JobSuccessLogURI => Str
75              
76             A link to an Amazon S3 presigned URL where the job success log is
77             located.
78              
79              
80              
81             =head1 SEE ALSO
82              
83             This class forms part of L<Paws>, describing an object used in L<Paws::Snowball>
84              
85             =head1 BUGS and CONTRIBUTIONS
86              
87             The source code is located here: https://github.com/pplu/aws-sdk-perl
88              
89             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
90              
91             =cut
92