| 1 | |||
| 2 | package Paws::IoT::ListJobs; | ||
| 3 | use Moose; | ||
| 4 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'maxResults'); | ||
| 5 | has NamespaceId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'namespaceId'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'nextToken'); | ||
| 7 | has Status => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'status'); | ||
| 8 | has TargetSelection => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'targetSelection'); | ||
| 9 | has ThingGroupId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'thingGroupId'); | ||
| 10 | has ThingGroupName => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'thingGroupName'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListJobs'); | ||
| 15 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/jobs'); | ||
| 16 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoT::ListJobsResponse'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::IoT::ListJobs - Arguments for method ListJobs on L<Paws::IoT> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method ListJobs on the | ||
| 29 | L<AWS IoT|Paws::IoT> service. Use the attributes of this class | ||
| 30 | as arguments to method ListJobs. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListJobs. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $iot = Paws->service('IoT'); | ||
| 37 | my $ListJobsResponse = $iot->ListJobs( | ||
| 38 | MaxResults => 1, # OPTIONAL | ||
| 39 | NamespaceId => 'MyNamespaceId', # OPTIONAL | ||
| 40 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 41 | Status => 'IN_PROGRESS', # OPTIONAL | ||
| 42 | TargetSelection => 'CONTINUOUS', # OPTIONAL | ||
| 43 | ThingGroupId => 'MyThingGroupId', # OPTIONAL | ||
| 44 | ThingGroupName => 'MyThingGroupName', # OPTIONAL | ||
| 45 | ); | ||
| 46 | |||
| 47 | # Results: | ||
| 48 | my $Jobs = $ListJobsResponse->Jobs; | ||
| 49 | my $NextToken = $ListJobsResponse->NextToken; | ||
| 50 | |||
| 51 | # Returns a L<Paws::IoT::ListJobsResponse> object. | ||
| 52 | |||
| 53 | 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. | ||
| 54 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iot/ListJobs> | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 MaxResults => Int | ||
| 60 | |||
| 61 | The maximum number of results to return per request. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 NamespaceId => Str | ||
| 66 | |||
| 67 | The namespace used to indicate that a job is a customer-managed job. | ||
| 68 | |||
| 69 | When you specify a value for this parameter, AWS IoT Core sends jobs | ||
| 70 | notifications to MQTT topics that contain the value in the following | ||
| 71 | format. | ||
| 72 | |||
| 73 | C<$aws/things/I<THING_NAME>/jobs/I<JOB_ID>/notify-namespace-I<NAMESPACE_ID>/> | ||
| 74 | |||
| 75 | The C<namespaceId> feature is in public preview. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 NextToken => Str | ||
| 80 | |||
| 81 | The token to retrieve the next set of results. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 Status => Str | ||
| 86 | |||
| 87 | An optional filter that lets you search for jobs that have the | ||
| 88 | specified status. | ||
| 89 | |||
| 90 | Valid values are: C<"IN_PROGRESS">, C<"CANCELED">, C<"COMPLETED">, C<"DELETION_IN_PROGRESS"> | ||
| 91 | |||
| 92 | =head2 TargetSelection => Str | ||
| 93 | |||
| 94 | Specifies whether the job will continue to run (CONTINUOUS), or will be | ||
| 95 | complete after all those things specified as targets have completed the | ||
| 96 | job (SNAPSHOT). If continuous, the job may also be run on a thing when | ||
| 97 | a change is detected in a target. For example, a job will run on a | ||
| 98 | thing when the thing is added to a target group, even after the job was | ||
| 99 | completed by all things originally in the group. | ||
| 100 | |||
| 101 | Valid values are: C<"CONTINUOUS">, C<"SNAPSHOT"> | ||
| 102 | |||
| 103 | =head2 ThingGroupId => Str | ||
| 104 | |||
| 105 | A filter that limits the returned jobs to those for the specified | ||
| 106 | group. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 ThingGroupName => Str | ||
| 111 | |||
| 112 | A filter that limits the returned jobs to those for the specified | ||
| 113 | group. | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head1 SEE ALSO | ||
| 119 | |||
| 120 | This class forms part of L<Paws>, documenting arguments for method ListJobs in L<Paws::IoT> | ||
| 121 | |||
| 122 | =head1 BUGS and CONTRIBUTIONS | ||
| 123 | |||
| 124 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 125 | |||
| 126 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 127 | |||
| 128 | =cut | ||
| 129 |