« blib/lib/Paws/IoTJobsData/JobExecutionSummary.pm
↑ Summary
blib/lib/Paws/IoTJobsData/StartNextPendingJobExecutionResponse.pm »
| 1 | |||
| 2 | package Paws::IoTJobsData::StartNextPendingJobExecution; | ||
| 3 | use Moose; | ||
| 4 | has StatusDetails => (is => 'ro', isa => 'Paws::IoTJobsData::DetailsMap', traits => ['NameInRequest'], request_name => 'statusDetails'); | ||
| 5 | has StepTimeoutInMinutes => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'stepTimeoutInMinutes'); | ||
| 6 | has ThingName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'thingName', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartNextPendingJobExecution'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/things/{thingName}/jobs/$next'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTJobsData::StartNextPendingJobExecutionResponse'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::IoTJobsData::StartNextPendingJobExecution - Arguments for method StartNextPendingJobExecution on L<Paws::IoTJobsData> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method StartNextPendingJobExecution on the | ||
| 25 | L<AWS IoT Jobs Data Plane|Paws::IoTJobsData> service. Use the attributes of this class | ||
| 26 | as arguments to method StartNextPendingJobExecution. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartNextPendingJobExecution. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $data.jobs.iot = Paws->service('IoTJobsData'); | ||
| 33 | my $StartNextPendingJobExecutionResponse = | ||
| 34 | $data . jobs . iot->StartNextPendingJobExecution( | ||
| 35 | ThingName => 'MyThingName', | ||
| 36 | StatusDetails => { | ||
| 37 | 'MyDetailsKey' => | ||
| 38 | 'MyDetailsValue', # key: min: 1, max: 128, value: min: 1, max: 1024 | ||
| 39 | }, # OPTIONAL | ||
| 40 | StepTimeoutInMinutes => 1, # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $Execution = $StartNextPendingJobExecutionResponse->Execution; | ||
| 45 | |||
| 46 | # Returns a L<Paws::IoTJobsData::StartNextPendingJobExecutionResponse> object. | ||
| 47 | |||
| 48 | 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. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/data.jobs.iot/StartNextPendingJobExecution> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 StatusDetails => L<Paws::IoTJobsData::DetailsMap> | ||
| 55 | |||
| 56 | A collection of name/value pairs that describe the status of the job | ||
| 57 | execution. If not specified, the statusDetails are unchanged. | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head2 StepTimeoutInMinutes => Int | ||
| 62 | |||
| 63 | Specifies the amount of time this device has to finish execution of | ||
| 64 | this job. If the job execution status is not set to a terminal state | ||
| 65 | before this timer expires, or before the timer is reset (by calling | ||
| 66 | C<UpdateJobExecution>, setting the status to C<IN_PROGRESS> and | ||
| 67 | specifying a new timeout value in field C<stepTimeoutInMinutes>) the | ||
| 68 | job execution status will be automatically set to C<TIMED_OUT>. Note | ||
| 69 | that setting this timeout has no effect on that job execution timeout | ||
| 70 | which may have been specified when the job was created (C<CreateJob> | ||
| 71 | using field C<timeoutConfig>). | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 B<REQUIRED> ThingName => Str | ||
| 76 | |||
| 77 | The name of the thing associated with the device. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head1 SEE ALSO | ||
| 83 | |||
| 84 | This class forms part of L<Paws>, documenting arguments for method StartNextPendingJobExecution in L<Paws::IoTJobsData> | ||
| 85 | |||
| 86 | =head1 BUGS and CONTRIBUTIONS | ||
| 87 | |||
| 88 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 89 | |||
| 90 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 91 | |||
| 92 | =cut | ||
| 93 |