« blib/lib/Paws/Pinpoint/ExportJobResource.pm
↑ Summary
blib/lib/Paws/Pinpoint/ExportJobsResponse.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::ExportJobResponse; | ||
| 3 | use Moose; | ||
| 4 | has ApplicationId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has CompletedPieces => (is => 'ro', isa => 'Int'); | ||
| 6 | has CompletionDate => (is => 'ro', isa => 'Str'); | ||
| 7 | has CreationDate => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has Definition => (is => 'ro', isa => 'Paws::Pinpoint::ExportJobResource', required => 1); | ||
| 9 | has FailedPieces => (is => 'ro', isa => 'Int'); | ||
| 10 | has Failures => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 11 | has Id => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | has JobStatus => (is => 'ro', isa => 'Str', required => 1); | ||
| 13 | has TotalFailures => (is => 'ro', isa => 'Int'); | ||
| 14 | has TotalPieces => (is => 'ro', isa => 'Int'); | ||
| 15 | has TotalProcessed => (is => 'ro', isa => 'Int'); | ||
| 16 | has Type => (is => 'ro', isa => 'Str', required => 1); | ||
| 17 | |||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::Pinpoint::ExportJobResponse | ||
| 25 | |||
| 26 | =head1 USAGE | ||
| 27 | |||
| 28 | This class represents one of two things: | ||
| 29 | |||
| 30 | =head3 Arguments in a call to a service | ||
| 31 | |||
| 32 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 33 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 34 | |||
| 35 | As an example, if Att1 is expected to be a Paws::Pinpoint::ExportJobResponse object: | ||
| 36 | |||
| 37 | $service_obj->Method(Att1 => { ApplicationId => $value, ..., Type => $value }); | ||
| 38 | |||
| 39 | =head3 Results returned from an API call | ||
| 40 | |||
| 41 | Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::ExportJobResponse object: | ||
| 42 | |||
| 43 | $result = $service_obj->Method(...); | ||
| 44 | $result->Att1->ApplicationId | ||
| 45 | |||
| 46 | =head1 DESCRIPTION | ||
| 47 | |||
| 48 | Provides information about the status and settings of a job that | ||
| 49 | exports endpoint definitions to a file. The file can be added directly | ||
| 50 | to an Amazon Simple Storage Service (Amazon S3) bucket by using the | ||
| 51 | Amazon Pinpoint API or downloaded directly to a computer by using the | ||
| 52 | Amazon Pinpoint console. | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> ApplicationId => Str | ||
| 58 | |||
| 59 | The unique identifier for the application that's associated with the | ||
| 60 | export job. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 CompletedPieces => Int | ||
| 64 | |||
| 65 | The number of pieces that were processed successfully (completed) by | ||
| 66 | the export job, as of the time of the request. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 CompletionDate => Str | ||
| 70 | |||
| 71 | The date, in ISO 8601 format, when the export job was completed. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 B<REQUIRED> CreationDate => Str | ||
| 75 | |||
| 76 | The date, in ISO 8601 format, when the export job was created. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 B<REQUIRED> Definition => L<Paws::Pinpoint::ExportJobResource> | ||
| 80 | |||
| 81 | The resource settings that apply to the export job. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 FailedPieces => Int | ||
| 85 | |||
| 86 | The number of pieces that weren't processed successfully (failed) by | ||
| 87 | the export job, as of the time of the request. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 Failures => ArrayRef[Str|Undef] | ||
| 91 | |||
| 92 | An array of entries, one for each of the first 100 entries that weren't | ||
| 93 | processed successfully (failed) by the export job, if any. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 B<REQUIRED> Id => Str | ||
| 97 | |||
| 98 | The unique identifier for the export job. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 B<REQUIRED> JobStatus => Str | ||
| 102 | |||
| 103 | The status of the export job. The job status is FAILED if Amazon | ||
| 104 | Pinpoint wasn't able to process one or more pieces in the job. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 TotalFailures => Int | ||
| 108 | |||
| 109 | The total number of endpoint definitions that weren't processed | ||
| 110 | successfully (failed) by the export job, typically because an error, | ||
| 111 | such as a syntax error, occurred. | ||
| 112 | |||
| 113 | |||
| 114 | =head2 TotalPieces => Int | ||
| 115 | |||
| 116 | The total number of pieces that must be processed to complete the | ||
| 117 | export job. Each piece consists of an approximately equal portion of | ||
| 118 | the endpoint definitions that are part of the export job. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 TotalProcessed => Int | ||
| 122 | |||
| 123 | The total number of endpoint definitions that were processed by the | ||
| 124 | export job. | ||
| 125 | |||
| 126 | |||
| 127 | =head2 B<REQUIRED> Type => Str | ||
| 128 | |||
| 129 | The job type. This value is EXPORT for export jobs. | ||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head1 SEE ALSO | ||
| 134 | |||
| 135 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 136 | |||
| 137 | =head1 BUGS and CONTRIBUTIONS | ||
| 138 | |||
| 139 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 140 | |||
| 141 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 142 | |||
| 143 | =cut | ||
| 144 |