blib/lib/Paws/IoT/UpdateJob.pm untested

filter: Statementstmt 0.0% 0 / 24 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 26 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::IoT::UpdateJob;
3 use Moose;
4 has AbortConfig => (is => 'ro', isa => 'Paws::IoT::AbortConfig', traits => ['NameInRequest'], request_name => 'abortConfig');
5 has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description');
6 has JobExecutionsRolloutConfig => (is => 'ro', isa => 'Paws::IoT::JobExecutionsRolloutConfig', traits => ['NameInRequest'], request_name => 'jobExecutionsRolloutConfig');
7 has JobId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'jobId', required => 1);
8 has NamespaceId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'namespaceId');
9 has PresignedUrlConfig => (is => 'ro', isa => 'Paws::IoT::PresignedUrlConfig', traits => ['NameInRequest'], request_name => 'presignedUrlConfig');
10 has TimeoutConfig => (is => 'ro', isa => 'Paws::IoT::TimeoutConfig', traits => ['NameInRequest'], request_name => 'timeoutConfig');
11  
12 use MooseX::ClassAttribute;
13  
14 class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateJob');
15 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/jobs/{jobId}');
16 class_has _api_method => (isa => 'Str', is => 'ro', default => 'PATCH');
17 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response');
18 1;
19  
20 ### main pod documentation begin ###
21  
22 =head1 NAME
23  
24 Paws::IoT::UpdateJob - Arguments for method UpdateJob on L<Paws::IoT>
25  
26 =head1 DESCRIPTION
27  
28 This class represents the parameters used for calling the method UpdateJob on the
29 L<AWS IoT|Paws::IoT> service. Use the attributes of this class
30 as arguments to method UpdateJob.
31  
32 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateJob.
33  
34 =head1 SYNOPSIS
35  
36 my $iot = Paws->service('IoT');
37 $iot->UpdateJob(
38 JobId => 'MyJobId',
39 AbortConfig => {
40 CriteriaList => [
41 {
42 Action => 'CANCEL', # values: CANCEL
43 FailureType => 'FAILED', # values: FAILED, REJECTED, TIMED_OUT, ALL
44 MinNumberOfExecutedThings => 1, # min: 1
45 ThresholdPercentage => 1, # max: 100
46  
47 },
48 ...
49 ], # min: 1
50  
51 }, # OPTIONAL
52 Description => 'MyJobDescription', # OPTIONAL
53 JobExecutionsRolloutConfig => {
54 ExponentialRate => {
55 BaseRatePerMinute => 1, # min: 1, max: 1000
56 IncrementFactor => 1, # min: 1, max: 5
57 RateIncreaseCriteria => {
58 NumberOfNotifiedThings => 1, # min: 1; OPTIONAL
59 NumberOfSucceededThings => 1, # min: 1; OPTIONAL
60 },
61  
62 }, # OPTIONAL
63 MaximumPerMinute => 1, # min: 1; OPTIONAL
64 }, # OPTIONAL
65 NamespaceId => 'MyNamespaceId', # OPTIONAL
66 PresignedUrlConfig => {
67 ExpiresInSec => 1, # min: 60, max: 3600; OPTIONAL
68 RoleArn => 'MyRoleArn', # min: 20, max: 2048; OPTIONAL
69 }, # OPTIONAL
70 TimeoutConfig => {
71 InProgressTimeoutInMinutes => 1, # OPTIONAL
72 }, # OPTIONAL
73 );
74  
75 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
76 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iot/UpdateJob>
77  
78 =head1 ATTRIBUTES
79  
80  
81 =head2 AbortConfig => L<Paws::IoT::AbortConfig>
82  
83 Allows you to create criteria to abort a job.
84  
85  
86  
87 =head2 Description => Str
88  
89 A short text description of the job.
90  
91  
92  
93 =head2 JobExecutionsRolloutConfig => L<Paws::IoT::JobExecutionsRolloutConfig>
94  
95 Allows you to create a staged rollout of the job.
96  
97  
98  
99 =head2 B<REQUIRED> JobId => Str
100  
101 The ID of the job to be updated.
102  
103  
104  
105 =head2 NamespaceId => Str
106  
107 The namespace used to indicate that a job is a customer-managed job.
108  
109 When you specify a value for this parameter, AWS IoT Core sends jobs
110 notifications to MQTT topics that contain the value in the following
111 format.
112  
113 C<$aws/things/I<THING_NAME>/jobs/I<JOB_ID>/notify-namespace-I<NAMESPACE_ID>/>
114  
115 The C<namespaceId> feature is in public preview.
116  
117  
118  
119 =head2 PresignedUrlConfig => L<Paws::IoT::PresignedUrlConfig>
120  
121 Configuration information for pre-signed S3 URLs.
122  
123  
124  
125 =head2 TimeoutConfig => L<Paws::IoT::TimeoutConfig>
126  
127 Specifies the amount of time each device has to finish its execution of
128 the job. The timer is started when the job execution status is set to
129 C<IN_PROGRESS>. If the job execution status is not set to another
130 terminal state before the time expires, it will be automatically set to
131 C<TIMED_OUT>.
132  
133  
134  
135  
136 =head1 SEE ALSO
137  
138 This class forms part of L<Paws>, documenting arguments for method UpdateJob in L<Paws::IoT>
139  
140 =head1 BUGS and CONTRIBUTIONS
141  
142 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
143  
144 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
145  
146 =cut
147