GSP
Quick Navigator
Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::SimpleWorkflow::ListClosedWorkflowExecutions(3) User Contributed Perl Documentation Paws::SimpleWorkflow::ListClosedWorkflowExecutions(3)

Paws::SimpleWorkflow::ListClosedWorkflowExecutions - Arguments for method ListClosedWorkflowExecutions on Paws::SimpleWorkflow

This class represents the parameters used for calling the method ListClosedWorkflowExecutions on the Amazon Simple Workflow Service service. Use the attributes of this class as arguments to method ListClosedWorkflowExecutions.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListClosedWorkflowExecutions.

    my $swf = Paws->service('SimpleWorkflow');
    my $WorkflowExecutionInfos = $swf->ListClosedWorkflowExecutions(
      Domain            => 'MyDomainName',
      CloseStatusFilter => {
        Status => 'COMPLETED'
        , # values: COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, TIMED_OUT
      },    # OPTIONAL
      CloseTimeFilter => {
        OldestDate => '1970-01-01T01:00:00',
        LatestDate => '1970-01-01T01:00:00',
      },    # OPTIONAL
      ExecutionFilter => {
        WorkflowId => 'MyWorkflowId',    # min: 1, max: 256
      },    # OPTIONAL
      MaximumPageSize => 1,                # OPTIONAL
      NextPageToken   => 'MyPageToken',    # OPTIONAL
      ReverseOrder    => 1,                # OPTIONAL
      StartTimeFilter => {
        OldestDate => '1970-01-01T01:00:00',
        LatestDate => '1970-01-01T01:00:00',
      },                                   # 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/ListClosedWorkflowExecutions>

If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.

"closeStatusFilter", "executionFilter", "typeFilter" and "tagFilter" are mutually exclusive. You can specify at most one of these in a request.

If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.

"startTimeFilter" and "closeTimeFilter" are mutually exclusive. You must specify one of these in a request but not both.

REQUIRED Domain => Str

The name of the domain that contains the workflow executions to list.

If specified, only workflow executions matching the workflow ID specified in the filter are returned.

"closeStatusFilter", "executionFilter", "typeFilter" and "tagFilter" are mutually exclusive. You can specify at most one of these in a request.

The maximum number of results that are returned per call. Use "nextPageToken" to obtain further pages of results.

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.

When set to "true", returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.

"startTimeFilter" and "closeTimeFilter" are mutually exclusive. You must specify one of these in a request but not both.

If specified, only executions that have the matching tag are listed.

"closeStatusFilter", "executionFilter", "typeFilter" and "tagFilter" are mutually exclusive. You can specify at most one of these in a request.

If specified, only executions of the type specified in the filter are returned.

"closeStatusFilter", "executionFilter", "typeFilter" and "tagFilter" are mutually exclusive. You can specify at most one of these in a request.

This class forms part of Paws, documenting arguments for method ListClosedWorkflowExecutions in Paws::SimpleWorkflow

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>

2022-06-01 perl v5.40.2
Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.