File Coverage

blib/lib/Paws/StepFunctions/ListExecutions.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::StepFunctions::ListExecutions;
3 1     1   285 use Moose;
  1         2  
  1         6  
4             has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults' );
5             has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' );
6             has StateMachineArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'stateMachineArn' , required => 1);
7             has StatusFilter => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'statusFilter' );
8              
9 1     1   5431 use MooseX::ClassAttribute;
  1         3  
  1         6  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListExecutions');
12             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::StepFunctions::ListExecutionsOutput');
13             class_has _result_key => (isa => 'Str', is => 'ro');
14             1;
15              
16             ### main pod documentation begin ###
17              
18             =head1 NAME
19              
20             Paws::StepFunctions::ListExecutions - Arguments for method ListExecutions on Paws::StepFunctions
21              
22             =head1 DESCRIPTION
23              
24             This class represents the parameters used for calling the method ListExecutions on the
25             AWS Step Functions service. Use the attributes of this class
26             as arguments to method ListExecutions.
27              
28             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListExecutions.
29              
30             As an example:
31              
32             $service_obj->ListExecutions(Att1 => $value1, Att2 => $value2, ...);
33              
34             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.
35              
36             =head1 ATTRIBUTES
37              
38              
39             =head2 MaxResults => Int
40              
41             The maximum number of results that will be returned per call.
42             C<nextToken> can be used to obtain further pages of results. The
43             default is 100 and the maximum allowed page size is 1000.
44              
45             This is an upper limit only; the actual number of results returned per
46             call may be fewer than the specified maximum.
47              
48              
49              
50             =head2 NextToken => Str
51              
52             If a C<nextToken> was returned by a previous call, there are more
53             results available. To retrieve the next page of results, make the call
54             again using the returned token in C<nextToken>. Keep all other
55             arguments unchanged.
56              
57             The configured C<maxResults> determines how many results can be
58             returned in a single call.
59              
60              
61              
62             =head2 B<REQUIRED> StateMachineArn => Str
63              
64             The Amazon Resource Name (ARN) of the state machine whose executions
65             will be listed.
66              
67              
68              
69             =head2 StatusFilter => Str
70              
71             If specified, only list the executions whose current execution status
72             matches the given filter.
73              
74             Valid values are: C<"RUNNING">, C<"SUCCEEDED">, C<"FAILED">, C<"TIMED_OUT">, C<"ABORTED">
75              
76              
77             =head1 SEE ALSO
78              
79             This class forms part of L<Paws>, documenting arguments for method ListExecutions in L<Paws::StepFunctions>
80              
81             =head1 BUGS and CONTRIBUTIONS
82              
83             The source code is located here: https://github.com/pplu/aws-sdk-perl
84              
85             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
86              
87             =cut
88