« blib/lib/Paws/Pinpoint/ImportJobResource.pm
↑ Summary
blib/lib/Paws/Pinpoint/ImportJobsResponse.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::ImportJobResponse; | ||
| 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::ImportJobResource', 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::ImportJobResponse | ||
| 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::ImportJobResponse 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::ImportJobResponse 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 | imports endpoint definitions from one or more files. The files can be | ||
| 50 | stored in an Amazon Simple Storage Service (Amazon S3) bucket or | ||
| 51 | uploaded directly from a computer by using the Amazon Pinpoint console. | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> ApplicationId => Str | ||
| 57 | |||
| 58 | The unique identifier for the application that's associated with the | ||
| 59 | import job. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 CompletedPieces => Int | ||
| 63 | |||
| 64 | The number of pieces that were processed successfully (completed) by | ||
| 65 | the import job, as of the time of the request. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 CompletionDate => Str | ||
| 69 | |||
| 70 | The date, in ISO 8601 format, when the import job was completed. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 B<REQUIRED> CreationDate => Str | ||
| 74 | |||
| 75 | The date, in ISO 8601 format, when the import job was created. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 B<REQUIRED> Definition => L<Paws::Pinpoint::ImportJobResource> | ||
| 79 | |||
| 80 | The resource settings that apply to the import job. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 FailedPieces => Int | ||
| 84 | |||
| 85 | The number of pieces that weren't processed successfully (failed) by | ||
| 86 | the import job, as of the time of the request. | ||
| 87 | |||
| 88 | |||
| 89 | =head2 Failures => ArrayRef[Str|Undef] | ||
| 90 | |||
| 91 | An array of entries, one for each of the first 100 entries that weren't | ||
| 92 | processed successfully (failed) by the import job, if any. | ||
| 93 | |||
| 94 | |||
| 95 | =head2 B<REQUIRED> Id => Str | ||
| 96 | |||
| 97 | The unique identifier for the import job. | ||
| 98 | |||
| 99 | |||
| 100 | =head2 B<REQUIRED> JobStatus => Str | ||
| 101 | |||
| 102 | The status of the import job. The job status is FAILED if Amazon | ||
| 103 | Pinpoint wasn't able to process one or more pieces in the job. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 TotalFailures => Int | ||
| 107 | |||
| 108 | The total number of endpoint definitions that weren't processed | ||
| 109 | successfully (failed) by the import job, typically because an error, | ||
| 110 | such as a syntax error, occurred. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 TotalPieces => Int | ||
| 114 | |||
| 115 | The total number of pieces that must be processed to complete the | ||
| 116 | import job. Each piece consists of an approximately equal portion of | ||
| 117 | the endpoint definitions that are part of the import job. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 TotalProcessed => Int | ||
| 121 | |||
| 122 | The total number of endpoint definitions that were processed by the | ||
| 123 | import job. | ||
| 124 | |||
| 125 | |||
| 126 | =head2 B<REQUIRED> Type => Str | ||
| 127 | |||
| 128 | The job type. This value is IMPORT for import jobs. | ||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | =head1 SEE ALSO | ||
| 133 | |||
| 134 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 135 | |||
| 136 | =head1 BUGS and CONTRIBUTIONS | ||
| 137 | |||
| 138 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 139 | |||
| 140 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 141 | |||
| 142 | =cut | ||
| 143 |