« blib/lib/Paws/IoTJobsData/GetPendingJobExecutionsResponse.pm
↑ Summary
blib/lib/Paws/IoTJobsData/JobExecutionState.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::IoTJobsData::JobExecution; | ||
| 3 | use Moose; | ||
| 4 | has ApproximateSecondsBeforeTimedOut => (is => 'ro', isa => 'Int', request_name => 'approximateSecondsBeforeTimedOut', traits => ['NameInRequest']); | ||
| 5 | has ExecutionNumber => (is => 'ro', isa => 'Int', request_name => 'executionNumber', traits => ['NameInRequest']); | ||
| 6 | has JobDocument => (is => 'ro', isa => 'Str', request_name => 'jobDocument', traits => ['NameInRequest']); | ||
| 7 | has JobId => (is => 'ro', isa => 'Str', request_name => 'jobId', traits => ['NameInRequest']); | ||
| 8 | has LastUpdatedAt => (is => 'ro', isa => 'Int', request_name => 'lastUpdatedAt', traits => ['NameInRequest']); | ||
| 9 | has QueuedAt => (is => 'ro', isa => 'Int', request_name => 'queuedAt', traits => ['NameInRequest']); | ||
| 10 | has StartedAt => (is => 'ro', isa => 'Int', request_name => 'startedAt', traits => ['NameInRequest']); | ||
| 11 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']); | ||
| 12 | has StatusDetails => (is => 'ro', isa => 'Paws::IoTJobsData::DetailsMap', request_name => 'statusDetails', traits => ['NameInRequest']); | ||
| 13 | has ThingName => (is => 'ro', isa => 'Str', request_name => 'thingName', traits => ['NameInRequest']); | ||
| 14 | has VersionNumber => (is => 'ro', isa => 'Int', request_name => 'versionNumber', traits => ['NameInRequest']); | ||
| 15 | |||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::IoTJobsData::JobExecution | ||
| 23 | |||
| 24 | =head1 USAGE | ||
| 25 | |||
| 26 | This class represents one of two things: | ||
| 27 | |||
| 28 | =head3 Arguments in a call to a service | ||
| 29 | |||
| 30 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 31 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 32 | |||
| 33 | As an example, if Att1 is expected to be a Paws::IoTJobsData::JobExecution object: | ||
| 34 | |||
| 35 | $service_obj->Method(Att1 => { ApproximateSecondsBeforeTimedOut => $value, ..., VersionNumber => $value }); | ||
| 36 | |||
| 37 | =head3 Results returned from an API call | ||
| 38 | |||
| 39 | Use accessors for each attribute. If Att1 is expected to be an Paws::IoTJobsData::JobExecution object: | ||
| 40 | |||
| 41 | $result = $service_obj->Method(...); | ||
| 42 | $result->Att1->ApproximateSecondsBeforeTimedOut | ||
| 43 | |||
| 44 | =head1 DESCRIPTION | ||
| 45 | |||
| 46 | Contains data about a job execution. | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 ApproximateSecondsBeforeTimedOut => Int | ||
| 52 | |||
| 53 | The estimated number of seconds that remain before the job execution | ||
| 54 | status will be changed to C<TIMED_OUT>. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 ExecutionNumber => Int | ||
| 58 | |||
| 59 | A number that identifies a particular job execution on a particular | ||
| 60 | device. It can be used later in commands that return or update job | ||
| 61 | execution information. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 JobDocument => Str | ||
| 65 | |||
| 66 | The content of the job document. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 JobId => Str | ||
| 70 | |||
| 71 | The unique identifier you assigned to this job when it was created. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 LastUpdatedAt => Int | ||
| 75 | |||
| 76 | The time, in milliseconds since the epoch, when the job execution was | ||
| 77 | last updated. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 QueuedAt => Int | ||
| 81 | |||
| 82 | The time, in milliseconds since the epoch, when the job execution was | ||
| 83 | enqueued. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 StartedAt => Int | ||
| 87 | |||
| 88 | The time, in milliseconds since the epoch, when the job execution was | ||
| 89 | started. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 Status => Str | ||
| 93 | |||
| 94 | The status of the job execution. Can be one of: "QUEUED", | ||
| 95 | "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or | ||
| 96 | "REMOVED". | ||
| 97 | |||
| 98 | |||
| 99 | =head2 StatusDetails => L<Paws::IoTJobsData::DetailsMap> | ||
| 100 | |||
| 101 | A collection of name/value pairs that describe the status of the job | ||
| 102 | execution. | ||
| 103 | |||
| 104 | |||
| 105 | =head2 ThingName => Str | ||
| 106 | |||
| 107 | The name of the thing that is executing the job. | ||
| 108 | |||
| 109 | |||
| 110 | =head2 VersionNumber => Int | ||
| 111 | |||
| 112 | The version of the job execution. Job execution versions are | ||
| 113 | incremented each time they are updated by a device. | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | =head1 SEE ALSO | ||
| 118 | |||
| 119 | This class forms part of L<Paws>, describing an object used in L<Paws::IoTJobsData> | ||
| 120 | |||
| 121 | =head1 BUGS and CONTRIBUTIONS | ||
| 122 | |||
| 123 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 124 | |||
| 125 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 126 | |||
| 127 | =cut | ||
| 128 |