« blib/lib/Paws/Kendra/DataSourceSummary.pm
↑ Summary
blib/lib/Paws/Kendra/DataSourceSyncJobMetricTarget.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Kendra::DataSourceSyncJob; | ||
| 3 | use Moose; | ||
| 4 | has DataSourceErrorCode => (is => 'ro', isa => 'Str'); | ||
| 5 | has EndTime => (is => 'ro', isa => 'Str'); | ||
| 6 | has ErrorCode => (is => 'ro', isa => 'Str'); | ||
| 7 | has ErrorMessage => (is => 'ro', isa => 'Str'); | ||
| 8 | has ExecutionId => (is => 'ro', isa => 'Str'); | ||
| 9 | has Metrics => (is => 'ro', isa => 'Paws::Kendra::DataSourceSyncJobMetrics'); | ||
| 10 | has StartTime => (is => 'ro', isa => 'Str'); | ||
| 11 | has Status => (is => 'ro', isa => 'Str'); | ||
| 12 | |||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::Kendra::DataSourceSyncJob | ||
| 20 | |||
| 21 | =head1 USAGE | ||
| 22 | |||
| 23 | This class represents one of two things: | ||
| 24 | |||
| 25 | =head3 Arguments in a call to a service | ||
| 26 | |||
| 27 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 28 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 29 | |||
| 30 | As an example, if Att1 is expected to be a Paws::Kendra::DataSourceSyncJob object: | ||
| 31 | |||
| 32 | $service_obj->Method(Att1 => { DataSourceErrorCode => $value, ..., Status => $value }); | ||
| 33 | |||
| 34 | =head3 Results returned from an API call | ||
| 35 | |||
| 36 | Use accessors for each attribute. If Att1 is expected to be an Paws::Kendra::DataSourceSyncJob object: | ||
| 37 | |||
| 38 | $result = $service_obj->Method(...); | ||
| 39 | $result->Att1->DataSourceErrorCode | ||
| 40 | |||
| 41 | =head1 DESCRIPTION | ||
| 42 | |||
| 43 | Provides information about a synchronization job. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 DataSourceErrorCode => Str | ||
| 49 | |||
| 50 | If the reason that the synchronization failed is due to an error with | ||
| 51 | the underlying data source, this field contains a code that identifies | ||
| 52 | the error. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 EndTime => Str | ||
| 56 | |||
| 57 | The UNIX datetime that the synchronization job was completed. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 ErrorCode => Str | ||
| 61 | |||
| 62 | If the C<Status> field is set to C<FAILED>, the C<ErrorCode> field | ||
| 63 | contains a the reason that the synchronization failed. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 ErrorMessage => Str | ||
| 67 | |||
| 68 | If the C<Status> field is set to C<ERROR>, the C<ErrorMessage> field | ||
| 69 | contains a description of the error that caused the synchronization to | ||
| 70 | fail. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 ExecutionId => Str | ||
| 74 | |||
| 75 | A unique identifier for the synchronization job. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 Metrics => L<Paws::Kendra::DataSourceSyncJobMetrics> | ||
| 79 | |||
| 80 | Maps a batch delete document request to a specific data source sync | ||
| 81 | job. This is optional and should only be supplied when documents are | ||
| 82 | deleted by a data source connector. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 StartTime => Str | ||
| 86 | |||
| 87 | The UNIX datetime that the synchronization job was started. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 Status => Str | ||
| 91 | |||
| 92 | The execution status of the synchronization job. When the C<Status> | ||
| 93 | field is set to C<SUCCEEDED>, the synchronization job is done. If the | ||
| 94 | status code is set to C<FAILED>, the C<ErrorCode> and C<ErrorMessage> | ||
| 95 | fields give you the reason for the failure. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head1 SEE ALSO | ||
| 100 | |||
| 101 | This class forms part of L<Paws>, describing an object used in L<Paws::Kendra> | ||
| 102 | |||
| 103 | =head1 BUGS and CONTRIBUTIONS | ||
| 104 | |||
| 105 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 106 | |||
| 107 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 108 | |||
| 109 | =cut | ||
| 110 |