File Coverage

blib/lib/Paws/SimpleWorkflow/ListOpenWorkflowExecutions.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::SimpleWorkflow::ListOpenWorkflowExecutions;
3 1     1   527 use Moose;
  1         2  
  1         7  
4             has Domain => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'domain' , required => 1);
5             has ExecutionFilter => (is => 'ro', isa => 'Paws::SimpleWorkflow::WorkflowExecutionFilter', traits => ['NameInRequest'], request_name => 'executionFilter' );
6             has MaximumPageSize => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maximumPageSize' );
7             has NextPageToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextPageToken' );
8             has ReverseOrder => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'reverseOrder' );
9             has StartTimeFilter => (is => 'ro', isa => 'Paws::SimpleWorkflow::ExecutionTimeFilter', traits => ['NameInRequest'], request_name => 'startTimeFilter' , required => 1);
10             has TagFilter => (is => 'ro', isa => 'Paws::SimpleWorkflow::TagFilter', traits => ['NameInRequest'], request_name => 'tagFilter' );
11             has TypeFilter => (is => 'ro', isa => 'Paws::SimpleWorkflow::WorkflowTypeFilter', traits => ['NameInRequest'], request_name => 'typeFilter' );
12              
13 1     1   6595 use MooseX::ClassAttribute;
  1         3  
  1         9  
14              
15             class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListOpenWorkflowExecutions');
16             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SimpleWorkflow::WorkflowExecutionInfos');
17             class_has _result_key => (isa => 'Str', is => 'ro');
18             1;
19              
20             ### main pod documentation begin ###
21              
22             =head1 NAME
23              
24             Paws::SimpleWorkflow::ListOpenWorkflowExecutions - Arguments for method ListOpenWorkflowExecutions on Paws::SimpleWorkflow
25              
26             =head1 DESCRIPTION
27              
28             This class represents the parameters used for calling the method ListOpenWorkflowExecutions on the
29             Amazon Simple Workflow Service service. Use the attributes of this class
30             as arguments to method ListOpenWorkflowExecutions.
31              
32             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListOpenWorkflowExecutions.
33              
34             As an example:
35              
36             $service_obj->ListOpenWorkflowExecutions(Att1 => $value1, Att2 => $value2, ...);
37              
38             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.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 B<REQUIRED> Domain => Str
44              
45             The name of the domain that contains the workflow executions to list.
46              
47              
48              
49             =head2 ExecutionFilter => L<Paws::SimpleWorkflow::WorkflowExecutionFilter>
50              
51             If specified, only workflow executions matching the workflow ID
52             specified in the filter are returned.
53              
54             C<executionFilter>, C<typeFilter> and C<tagFilter> are mutually
55             exclusive. You can specify at most one of these in a request.
56              
57              
58              
59             =head2 MaximumPageSize => Int
60              
61             The maximum number of results that are returned per call.
62             C<nextPageToken> can be used to obtain futher pages of results. The
63             default is 1000, which is the maximum allowed page size. You can,
64             however, specify a page size I<smaller> than the maximum.
65              
66             This is an upper limit only; the actual number of results returned per
67             call may be fewer than the specified maximum.
68              
69              
70              
71             =head2 NextPageToken => Str
72              
73             If a C<NextPageToken> was returned by a previous call, there are more
74             results available. To retrieve the next page of results, make the call
75             again using the returned token in C<nextPageToken>. Keep all other
76             arguments unchanged.
77              
78             The configured C<maximumPageSize> determines how many results can be
79             returned in a single call.
80              
81              
82              
83             =head2 ReverseOrder => Bool
84              
85             When set to C<true>, returns the results in reverse order. By default
86             the results are returned in descending order of the start time of the
87             executions.
88              
89              
90              
91             =head2 B<REQUIRED> StartTimeFilter => L<Paws::SimpleWorkflow::ExecutionTimeFilter>
92              
93             Workflow executions are included in the returned results based on
94             whether their start times are within the range specified by this
95             filter.
96              
97              
98              
99             =head2 TagFilter => L<Paws::SimpleWorkflow::TagFilter>
100              
101             If specified, only executions that have the matching tag are listed.
102              
103             C<executionFilter>, C<typeFilter> and C<tagFilter> are mutually
104             exclusive. You can specify at most one of these in a request.
105              
106              
107              
108             =head2 TypeFilter => L<Paws::SimpleWorkflow::WorkflowTypeFilter>
109              
110             If specified, only executions of the type specified in the filter are
111             returned.
112              
113             C<executionFilter>, C<typeFilter> and C<tagFilter> are mutually
114             exclusive. You can specify at most one of these in a request.
115              
116              
117              
118              
119             =head1 SEE ALSO
120              
121             This class forms part of L<Paws>, documenting arguments for method ListOpenWorkflowExecutions in L<Paws::SimpleWorkflow>
122              
123             =head1 BUGS and CONTRIBUTIONS
124              
125             The source code is located here: https://github.com/pplu/aws-sdk-perl
126              
127             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
128              
129             =cut
130