NAME
Paws::StepFunctions - Perl Interface to AWS AWS Step Functions
SYNOPSIS
use Paws;
my $obj = Paws->service('StepFunctions');
my $res = $obj->Method(
Arg1 => $val1,
Arg2 => [ 'V1', 'V2' ],
# if Arg3 is an object, the HashRef will be used as arguments to the constructor
# of the arguments type
Arg3 => { Att1 => 'Val1' },
# if Arg4 is an array of objects, the HashRefs will be passed as arguments to
# the constructor of the arguments type
Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
);DESCRIPTION
AWS Step Functions
AWS Step Functions is a service that lets you coordinate the components of distributed applications and microservices using visual workflows.
You can use Step Functions to build applications from individual components, each of which performs a discrete function, or task, allowing you to scale and change applications quickly. Step Functions provides a console that helps visualize the components of your application as a series of steps. Step Functions automatically triggers and tracks each step, and retries steps when there are errors, so your application executes predictably and in the right order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any issues.
Step Functions manages operations and underlying infrastructure to ensure your application is available at any scale. You can run tasks on AWS, your own servers, or any system that has access to AWS. You can access and use Step Functions using the console, the AWS SDKs, or an HTTP API. For more information about Step Functions, see the AWS Step Functions Developer Guide (https://docs.aws.amazon.com/step-functions/latest/dg/welcome.html) .
For the AWS API documentation, see https://docs.aws.amazon.com/step-functions/
METHODS
CreateActivity
- Name => Str
- [Tags => ArrayRef[Paws::StepFunctions::Tag]]
Each argument is described in detail in: Paws::StepFunctions::CreateActivity
Returns: a Paws::StepFunctions::CreateActivityOutput instance
Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to AWS Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateActivity's idempotency check is based on the activity name. If a following request has different tags values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.
CreateStateMachine
- Definition => Str
- Name => Str
- RoleArn => Str
- [LoggingConfiguration => Paws::StepFunctions::LoggingConfiguration]
- [Tags => ArrayRef[Paws::StepFunctions::Tag]]
- [TracingConfiguration => Paws::StepFunctions::TracingConfiguration]
- [Type => Str]
Each argument is described in detail in: Paws::StepFunctions::CreateStateMachine
Returns: a Paws::StepFunctions::CreateStateMachineOutput instance
Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html) in the AWS Step Functions User Guide.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name, definition, type, LoggingConfiguration and TracingConfiguration. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.
DeleteActivity
Each argument is described in detail in: Paws::StepFunctions::DeleteActivity
Returns: a Paws::StepFunctions::DeleteActivityOutput instance
Deletes an activity.
DeleteStateMachine
Each argument is described in detail in: Paws::StepFunctions::DeleteStateMachine
Returns: a Paws::StepFunctions::DeleteStateMachineOutput instance
Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process.
For EXPRESSstate machines, the deletion will happen eventually (usually less than a minute). Running executions may emit logs after DeleteStateMachine API is called.
DescribeActivity
Each argument is described in detail in: Paws::StepFunctions::DescribeActivity
Returns: a Paws::StepFunctions::DescribeActivityOutput instance
Describes an activity.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
DescribeExecution
Each argument is described in detail in: Paws::StepFunctions::DescribeExecution
Returns: a Paws::StepFunctions::DescribeExecutionOutput instance
Describes an execution.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machines.
DescribeStateMachine
Each argument is described in detail in: Paws::StepFunctions::DescribeStateMachine
Returns: a Paws::StepFunctions::DescribeStateMachineOutput instance
Describes a state machine.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
DescribeStateMachineForExecution
Each argument is described in detail in: Paws::StepFunctions::DescribeStateMachineForExecution
Returns: a Paws::StepFunctions::DescribeStateMachineForExecutionOutput instance
Describes the state machine associated with a specific execution.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machines.
GetActivityTask
Each argument is described in detail in: Paws::StepFunctions::GetActivityTask
Returns: a Paws::StepFunctions::GetActivityTaskOutput instance
Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string.
Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request).
Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling for Activity Tasks (https://docs.aws.amazon.com/step-functions/latest/dg/bp-activity-pollers.html) in the Step Functions Developer Guide.
GetExecutionHistory
- ExecutionArn => Str
- [IncludeExecutionData => Bool]
- [MaxResults => Int]
- [NextToken => Str]
- [ReverseOrder => Bool]
Each argument is described in detail in: Paws::StepFunctions::GetExecutionHistory
Returns: a Paws::StepFunctions::GetExecutionHistoryOutput instance
Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first.
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.
This API action is not supported by EXPRESS state machines.
ListActivities
Each argument is described in detail in: Paws::StepFunctions::ListActivities
Returns: a Paws::StepFunctions::ListActivitiesOutput instance
Lists the existing activities.
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.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
ListExecutions
Each argument is described in detail in: Paws::StepFunctions::ListExecutions
Returns: a Paws::StepFunctions::ListExecutionsOutput instance
Lists the executions of a state machine that meet the filtering criteria. Results are sorted by time, with the most recent execution first.
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.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machines.
ListStateMachines
Each argument is described in detail in: Paws::StepFunctions::ListStateMachines
Returns: a Paws::StepFunctions::ListStateMachinesOutput instance
Lists the existing state machines.
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.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
ListTagsForResource
Each argument is described in detail in: Paws::StepFunctions::ListTagsForResource
Returns: a Paws::StepFunctions::ListTagsForResourceOutput instance
List tags for a given resource.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
SendTaskFailure
Each argument is described in detail in: Paws::StepFunctions::SendTaskFailure
Returns: a Paws::StepFunctions::SendTaskFailureOutput instance
Used by activity workers and task states using the callback (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token) pattern to report that the task identified by the taskToken failed.
SendTaskHeartbeat
Each argument is described in detail in: Paws::StepFunctions::SendTaskHeartbeat
Returns: a Paws::StepFunctions::SendTaskHeartbeatOutput instance
Used by activity workers and task states using the callback (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token) pattern to report to Step Functions that the task represented by the specified taskToken is still making progress. This action resets the Heartbeat clock. The Heartbeat threshold is specified in the state machine's Amazon States Language definition (HeartbeatSeconds). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut entry for activities, or a TaskTimedOut entry for for tasks using the job run (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync) or callback (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token) pattern.
The Timeout of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. Use HeartbeatSeconds to configure the timeout interval for heartbeats.
SendTaskSuccess
Each argument is described in detail in: Paws::StepFunctions::SendTaskSuccess
Returns: a Paws::StepFunctions::SendTaskSuccessOutput instance
Used by activity workers and task states using the callback (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token) pattern to report that the task identified by the taskToken completed successfully.
StartExecution
Each argument is described in detail in: Paws::StepFunctions::StartExecution
Returns: a Paws::StepFunctions::StartExecutionOutput instance
Starts a state machine execution.
StartExecution is idempotent. If StartExecution is called with the same name and input as a running execution, the call will succeed and return the same response as the original request. If the execution is closed or if the input is different, it will return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days.
StartSyncExecution
Each argument is described in detail in: Paws::StepFunctions::StartSyncExecution
Returns: a Paws::StepFunctions::StartSyncExecutionOutput instance
Starts a Synchronous Express state machine execution.
StopExecution
Each argument is described in detail in: Paws::StepFunctions::StopExecution
Returns: a Paws::StepFunctions::StopExecutionOutput instance
Stops an execution.
This API action is not supported by EXPRESS state machines.
TagResource
- ResourceArn => Str
- Tags => ArrayRef[Paws::StepFunctions::Tag]
Each argument is described in detail in: Paws::StepFunctions::TagResource
Returns: a Paws::StepFunctions::TagResourceOutput instance
Add a tag to a Step Functions resource.
An array of key-value pairs. For more information, see Using Cost Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html).
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
UntagResource
Each argument is described in detail in: Paws::StepFunctions::UntagResource
Returns: a Paws::StepFunctions::UntagResourceOutput instance
Remove a tag from a Step Functions resource
UpdateStateMachine
- StateMachineArn => Str
- [Definition => Str]
- [LoggingConfiguration => Paws::StepFunctions::LoggingConfiguration]
- [RoleArn => Str]
- [TracingConfiguration => Paws::StepFunctions::TracingConfiguration]
Each argument is described in detail in: Paws::StepFunctions::UpdateStateMachine
Returns: a Paws::StepFunctions::UpdateStateMachineOutput instance
Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error.
All StartExecution calls within a few seconds will use the updated definition and roleArn. Executions started immediately after calling UpdateStateMachine may use the previous state machine definition and roleArn.
PAGINATORS
Paginator methods are helpers that repetively call methods that return partial results
GetAllExecutionHistory(sub { },ExecutionArn => Str, [IncludeExecutionData => Bool, MaxResults => Int, NextToken => Str, ReverseOrder => Bool])
GetAllExecutionHistory(ExecutionArn => Str, [IncludeExecutionData => Bool, MaxResults => Int, NextToken => Str, ReverseOrder => Bool])
If passed a sub as first parameter, it will call the sub for each element found in :
- events, passing the object as the first parameter, and the string 'events' as the second parameter If not, it will return a a Paws::StepFunctions::GetExecutionHistoryOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllActivities(sub { },[MaxResults => Int, NextToken => Str])
ListAllActivities([MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- activities, passing the object as the first parameter, and the string 'activities' as the second parameter If not, it will return a a Paws::StepFunctions::ListActivitiesOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllExecutions(sub { },StateMachineArn => Str, [MaxResults => Int, NextToken => Str, StatusFilter => Str])
ListAllExecutions(StateMachineArn => Str, [MaxResults => Int, NextToken => Str, StatusFilter => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- executions, passing the object as the first parameter, and the string 'executions' as the second parameter If not, it will return a a Paws::StepFunctions::ListExecutionsOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllStateMachines(sub { },[MaxResults => Int, NextToken => Str])
ListAllStateMachines([MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- stateMachines, passing the object as the first parameter, and the string 'stateMachines' as the second parameter If not, it will return a a Paws::StepFunctions::ListStateMachinesOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
SEE ALSO
This service class forms part of Paws
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