| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::FSX::CompletionReport; | ||
| 3 | use Moose; | ||
| 4 | has Enabled => (is => 'ro', isa => 'Bool', required => 1); | ||
| 5 | has Format => (is => 'ro', isa => 'Str'); | ||
| 6 | has Path => (is => 'ro', isa => 'Str'); | ||
| 7 | has Scope => (is => 'ro', isa => 'Str'); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::FSX::CompletionReport | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::FSX::CompletionReport object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { Enabled => $value, ..., Scope => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::FSX::CompletionReport object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->Enabled | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | Provides a report detailing the data repository task results of the | ||
| 40 | files processed that match the criteria specified in the report | ||
| 41 | C<Scope> parameter. FSx delivers the report to the file system's linked | ||
| 42 | data repository in Amazon S3, using the path specified in the report | ||
| 43 | C<Path> parameter. You can specify whether or not a report gets | ||
| 44 | generated for a task using the C<Enabled> parameter. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 B<REQUIRED> Enabled => Bool | ||
| 50 | |||
| 51 | Set C<Enabled> to C<True> to generate a C<CompletionReport> when the | ||
| 52 | task completes. If set to C<true>, then you need to provide a report | ||
| 53 | C<Scope>, C<Path>, and C<Format>. Set C<Enabled> to C<False> if you do | ||
| 54 | not want a C<CompletionReport> generated when the task completes. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 Format => Str | ||
| 58 | |||
| 59 | Required if C<Enabled> is set to C<true>. Specifies the format of the | ||
| 60 | C<CompletionReport>. C<REPORT_CSV_20191124> is the only format | ||
| 61 | currently supported. When C<Format> is set to C<REPORT_CSV_20191124>, | ||
| 62 | the C<CompletionReport> is provided in CSV format, and is delivered to | ||
| 63 | C<{path}/task-{id}/failures.csv>. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 Path => Str | ||
| 67 | |||
| 68 | Required if C<Enabled> is set to C<true>. Specifies the location of the | ||
| 69 | report on the file system's linked S3 data repository. An absolute path | ||
| 70 | that defines where the completion report will be stored in the | ||
| 71 | destination location. The C<Path> you provide must be located within | ||
| 72 | the file systemE<rsquo>s ExportPath. An example C<Path> value is | ||
| 73 | "s3://myBucket/myExportPath/optionalPrefix". The report provides the | ||
| 74 | following information for each file in the report: FilePath, | ||
| 75 | FileStatus, and ErrorCode. To learn more about a file system's | ||
| 76 | C<ExportPath>, see . | ||
| 77 | |||
| 78 | |||
| 79 | =head2 Scope => Str | ||
| 80 | |||
| 81 | Required if C<Enabled> is set to C<true>. Specifies the scope of the | ||
| 82 | C<CompletionReport>; C<FAILED_FILES_ONLY> is the only scope currently | ||
| 83 | supported. When C<Scope> is set to C<FAILED_FILES_ONLY>, the | ||
| 84 | C<CompletionReport> only contains information about files that the data | ||
| 85 | repository task failed to process. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head1 SEE ALSO | ||
| 90 | |||
| 91 | This class forms part of L<Paws>, describing an object used in L<Paws::FSX> | ||
| 92 | |||
| 93 | =head1 BUGS and CONTRIBUTIONS | ||
| 94 | |||
| 95 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 96 | |||
| 97 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 98 | |||
| 99 | =cut | ||
| 100 |