/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::StepFunctions::ListExecutions

NAME

Paws::StepFunctions::ListExecutions - Arguments for method ListExecutions on Paws::StepFunctions

DESCRIPTION

This class represents the parameters used for calling the method ListExecutions on the AWS Step Functions service. Use the attributes of this class as arguments to method ListExecutions.

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

SYNOPSIS

my $states = Paws->service('StepFunctions');
my $ListExecutionsOutput = $states->ListExecutions(
  StateMachineArn => 'MyArn',
  MaxResults      => 1,                              # OPTIONAL
  NextToken       => 'MyListExecutionsPageToken',    # OPTIONAL
  StatusFilter    => 'RUNNING',                      # OPTIONAL
);

# Results:
my $Executions = $ListExecutionsOutput->Executions;
my $NextToken  = $ListExecutionsOutput->NextToken;

# Returns a L<Paws::StepFunctions::ListExecutionsOutput> 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/states/ListExecutions

ATTRIBUTES

MaxResults => Int

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

NextToken => Str

If nextToken is returned, there are more results available. The value of nextToken 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 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

REQUIRED StateMachineArn => Str

The Amazon Resource Name (ARN) of the state machine whose executions is listed.

StatusFilter => Str

If specified, only list the executions whose current execution status matches the given filter.

Valid values are: "RUNNING", "SUCCEEDED", "FAILED", "TIMED_OUT", "ABORTED"

SEE ALSO

This class forms part of Paws, documenting arguments for method ListExecutions in Paws::StepFunctions

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