NAME
Paws::SimpleWorkflow::ListOpenWorkflowExecutions - Arguments for method ListOpenWorkflowExecutions on Paws::SimpleWorkflow
DESCRIPTION
This class represents the parameters used for calling the method ListOpenWorkflowExecutions on the Amazon Simple Workflow Service service. Use the attributes of this class as arguments to method ListOpenWorkflowExecutions.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListOpenWorkflowExecutions.
SYNOPSIS
my $swf = Paws->service('SimpleWorkflow');
my $WorkflowExecutionInfos = $swf->ListOpenWorkflowExecutions(
Domain => 'MyDomainName',
StartTimeFilter => {
OldestDate => '1970-01-01T01:00:00',
LatestDate => '1970-01-01T01:00:00',
},
ExecutionFilter => {
WorkflowId => 'MyWorkflowId', # min: 1, max: 256
}, # OPTIONAL
MaximumPageSize => 1, # OPTIONAL
NextPageToken => 'MyPageToken', # OPTIONAL
ReverseOrder => 1, # OPTIONAL
TagFilter => {
Tag => 'MyTag', # max: 256
}, # OPTIONAL
TypeFilter => {
Name => 'MyName', # min: 1, max: 256
Version => 'MyVersionOptional', # max: 64; OPTIONAL
}, # OPTIONAL
);
# Results:
my $ExecutionInfos = $WorkflowExecutionInfos->ExecutionInfos;
my $NextPageToken = $WorkflowExecutionInfos->NextPageToken;
# Returns a L<Paws::SimpleWorkflow::WorkflowExecutionInfos> object.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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/swf/ListOpenWorkflowExecutions
ATTRIBUTES
REQUIRED Domain => Str
The name of the domain that contains the workflow executions to list.
ExecutionFilter => Paws::SimpleWorkflow::WorkflowExecutionFilter
If specified, only workflow executions matching the workflow ID specified in the filter are returned.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
MaximumPageSize => Int
The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.
NextPageToken => Str
If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".
The configured maximumPageSize determines how many results can be returned in a single call.
ReverseOrder => Bool
When set to true, returns the results in reverse order. By default the results are returned in descending order of the start time of the executions.
REQUIRED StartTimeFilter => Paws::SimpleWorkflow::ExecutionTimeFilter
Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
TagFilter => Paws::SimpleWorkflow::TagFilter
If specified, only executions that have the matching tag are listed.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
TypeFilter => Paws::SimpleWorkflow::WorkflowTypeFilter
If specified, only executions of the type specified in the filter are returned.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
SEE ALSO
This class forms part of Paws, documenting arguments for method ListOpenWorkflowExecutions in Paws::SimpleWorkflow
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues