blib/lib/Paws/IoTJobsData.pm untested

filter: Statementstmt 0.0% 0 / 25 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 10 Podpod 0.0% 0 / 9 totaltotal 0.0% 0 / 44 CC 1 SCAR 6.9
CC
1
Cov
0%
service
2.0
signing_name
2.0
version
2.0
CRAP 2.0
1 package Paws::IoTJobsData;
2 use Moose;
3 sub service { 'data.jobs.iot' }
4 sub signing_name { 'iot-jobs-data' }
5 sub version { '2017-09-29' }
6 sub flattened_arrays { 0 }
7 has max_attempts => (is => 'ro', isa => 'Int', default => 5);
8 has retry => (is => 'ro', isa => 'HashRef', default => sub {
9 { base => 'rand', type => 'exponential', growth_factor => 2 }
10 });
11 has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
12 ] });
13  
14 with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::RestJsonCaller';
15  
16
17 sub DescribeJobExecution {
18 my $self = shift;
19 my $call_object = $self->new_with_coercions('Paws::IoTJobsData::DescribeJobExecution', @_);
20 return $self->caller->do_call($self, $call_object);
21 }
22 sub GetPendingJobExecutions {
23 my $self = shift;
24 my $call_object = $self->new_with_coercions('Paws::IoTJobsData::GetPendingJobExecutions', @_);
25 return $self->caller->do_call($self, $call_object);
26 }
27 sub StartNextPendingJobExecution {
28 my $self = shift;
29 my $call_object = $self->new_with_coercions('Paws::IoTJobsData::StartNextPendingJobExecution', @_);
30 return $self->caller->do_call($self, $call_object);
31 }
32 sub UpdateJobExecution {
33 my $self = shift;
34 my $call_object = $self->new_with_coercions('Paws::IoTJobsData::UpdateJobExecution', @_);
35 return $self->caller->do_call($self, $call_object);
36 }
37
38  
39  
40 sub operations { qw/DescribeJobExecution GetPendingJobExecutions StartNextPendingJobExecution UpdateJobExecution / }
41  
42 1;
43  
44 ### main pod documentation begin ###
45  
46 =head1 NAME
47  
48 Paws::IoTJobsData - Perl Interface to AWS AWS IoT Jobs Data Plane
49  
50 =head1 SYNOPSIS
51  
52 use Paws;
53  
54 my $obj = Paws->service('IoTJobsData');
55 my $res = $obj->Method(
56 Arg1 => $val1,
57 Arg2 => [ 'V1', 'V2' ],
58 # if Arg3 is an object, the HashRef will be used as arguments to the constructor
59 # of the arguments type
60 Arg3 => { Att1 => 'Val1' },
61 # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
62 # the constructor of the arguments type
63 Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
64 );
65  
66 =head1 DESCRIPTION
67  
68 AWS IoT Jobs is a service that allows you to define a set of jobs
69 E<mdash> remote operations that are sent to and executed on one or more
70 devices connected to AWS IoT. For example, you can define a job that
71 instructs a set of devices to download and install application or
72 firmware updates, reboot, rotate certificates, or perform remote
73 troubleshooting operations.
74  
75 To create a job, you make a job document which is a description of the
76 remote operations to be performed, and you specify a list of targets
77 that should perform the operations. The targets can be individual
78 things, thing groups or both.
79  
80 AWS IoT Jobs sends a message to inform the targets that a job is
81 available. The target starts the execution of the job by downloading
82 the job document, performing the operations it specifies, and reporting
83 its progress to AWS IoT. The Jobs service provides commands to track
84 the progress of a job on a specific target and for all the targets of
85 the job
86  
87 For the AWS API documentation, see L<https://docs.aws.amazon.com/iot/>
88  
89  
90 =head1 METHODS
91  
92 =head2 DescribeJobExecution
93  
94 =over
95  
96 =item JobId => Str
97  
98 =item ThingName => Str
99  
100 =item [ExecutionNumber => Int]
101  
102 =item [IncludeJobDocument => Bool]
103  
104  
105 =back
106  
107 Each argument is described in detail in: L<Paws::IoTJobsData::DescribeJobExecution>
108  
109 Returns: a L<Paws::IoTJobsData::DescribeJobExecutionResponse> instance
110  
111 Gets details of a job execution.
112  
113  
114 =head2 GetPendingJobExecutions
115  
116 =over
117  
118 =item ThingName => Str
119  
120  
121 =back
122  
123 Each argument is described in detail in: L<Paws::IoTJobsData::GetPendingJobExecutions>
124  
125 Returns: a L<Paws::IoTJobsData::GetPendingJobExecutionsResponse> instance
126  
127 Gets the list of all jobs for a thing that are not in a terminal
128 status.
129  
130  
131 =head2 StartNextPendingJobExecution
132  
133 =over
134  
135 =item ThingName => Str
136  
137 =item [StatusDetails => L<Paws::IoTJobsData::DetailsMap>]
138  
139 =item [StepTimeoutInMinutes => Int]
140  
141  
142 =back
143  
144 Each argument is described in detail in: L<Paws::IoTJobsData::StartNextPendingJobExecution>
145  
146 Returns: a L<Paws::IoTJobsData::StartNextPendingJobExecutionResponse> instance
147  
148 Gets and starts the next pending (status IN_PROGRESS or QUEUED) job
149 execution for a thing.
150  
151  
152 =head2 UpdateJobExecution
153  
154 =over
155  
156 =item JobId => Str
157  
158 =item Status => Str
159  
160 =item ThingName => Str
161  
162 =item [ExecutionNumber => Int]
163  
164 =item [ExpectedVersion => Int]
165  
166 =item [IncludeJobDocument => Bool]
167  
168 =item [IncludeJobExecutionState => Bool]
169  
170 =item [StatusDetails => L<Paws::IoTJobsData::DetailsMap>]
171  
172 =item [StepTimeoutInMinutes => Int]
173  
174  
175 =back
176  
177 Each argument is described in detail in: L<Paws::IoTJobsData::UpdateJobExecution>
178  
179 Returns: a L<Paws::IoTJobsData::UpdateJobExecutionResponse> instance
180  
181 Updates the status of a job execution.
182  
183  
184  
185  
186 =head1 PAGINATORS
187  
188 Paginator methods are helpers that repetively call methods that return partial results
189  
190  
191  
192  
193 =head1 SEE ALSO
194  
195 This service class forms part of L<Paws>
196  
197 =head1 BUGS and CONTRIBUTIONS
198  
199 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
200  
201 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
202  
203 =cut
204