NAME

Paws::SimpleWorkflow - Perl Interface to AWS Amazon Simple Workflow Service

SYNOPSIS

use Paws;

my $obj = Paws->service('SimpleWorkflow');
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

Amazon Simple Workflow Service

The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to coordinate work across distributed components. In Amazon SWF, a task represents a logical unit of work that is performed by a component of your workflow. Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and concurrency in accordance with the logical flow of the application.

Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about underlying complexities such as tracking their progress and maintaining their state.

This documentation serves as reference only. For a broader overview of the Amazon SWF programming model, see the Amazon SWF Developer Guide (https://docs.aws.amazon.com/amazonswf/latest/developerguide/) .

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/swf-2012-01-25

METHODS

CountClosedWorkflowExecutions

Domain => Str
[CloseStatusFilter => Paws::SimpleWorkflow::CloseStatusFilter]
[CloseTimeFilter => Paws::SimpleWorkflow::ExecutionTimeFilter]
[ExecutionFilter => Paws::SimpleWorkflow::WorkflowExecutionFilter]
[StartTimeFilter => Paws::SimpleWorkflow::ExecutionTimeFilter]
[TagFilter => Paws::SimpleWorkflow::TagFilter]
[TypeFilter => Paws::SimpleWorkflow::WorkflowTypeFilter]

Each argument is described in detail in: Paws::SimpleWorkflow::CountClosedWorkflowExecutions

Returns: a Paws::SimpleWorkflow::WorkflowExecutionCount instance

Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
- tagFilter.tag: String constraint. The key is swf:tagFilter.tag.
- typeFilter.name: String constraint. The key is swf:typeFilter.name.
- typeFilter.version: String constraint. The key is swf:typeFilter.version.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

CountOpenWorkflowExecutions

Domain => Str
StartTimeFilter => Paws::SimpleWorkflow::ExecutionTimeFilter
[ExecutionFilter => Paws::SimpleWorkflow::WorkflowExecutionFilter]
[TagFilter => Paws::SimpleWorkflow::TagFilter]
[TypeFilter => Paws::SimpleWorkflow::WorkflowTypeFilter]

Each argument is described in detail in: Paws::SimpleWorkflow::CountOpenWorkflowExecutions

Returns: a Paws::SimpleWorkflow::WorkflowExecutionCount instance

Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
- tagFilter.tag: String constraint. The key is swf:tagFilter.tag.
- typeFilter.name: String constraint. The key is swf:typeFilter.name.
- typeFilter.version: String constraint. The key is swf:typeFilter.version.

CountPendingActivityTasks

Domain => Str
TaskList => Paws::SimpleWorkflow::TaskList

Each argument is described in detail in: Paws::SimpleWorkflow::CountPendingActivityTasks

Returns: a Paws::SimpleWorkflow::PendingTaskCount instance

Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 is returned.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

CountPendingDecisionTasks

Domain => Str
TaskList => Paws::SimpleWorkflow::TaskList

Each argument is described in detail in: Paws::SimpleWorkflow::CountPendingDecisionTasks

Returns: a Paws::SimpleWorkflow::PendingTaskCount instance

Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 is returned.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

DeprecateActivityType

ActivityType => Paws::SimpleWorkflow::ActivityType
Domain => Str

Each argument is described in detail in: Paws::SimpleWorkflow::DeprecateActivityType

Returns: nothing

Deprecates the specified activity type. After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated continue to run.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
- activityType.name: String constraint. The key is swf:activityType.name.
- activityType.version: String constraint. The key is swf:activityType.version.

DeprecateDomain

Name => Str

Each argument is described in detail in: Paws::SimpleWorkflow::DeprecateDomain

Returns: nothing

Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated continues to run.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

DeprecateWorkflowType

Domain => Str
WorkflowType => Paws::SimpleWorkflow::WorkflowType

Each argument is described in detail in: Paws::SimpleWorkflow::DeprecateWorkflowType

Returns: nothing

Deprecates the specified workflow type. After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated continues to run. A deprecated workflow type may still be used when calling visibility actions.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
- workflowType.name: String constraint. The key is swf:workflowType.name.
- workflowType.version: String constraint. The key is swf:workflowType.version.

DescribeActivityType

ActivityType => Paws::SimpleWorkflow::ActivityType
Domain => Str

Each argument is described in detail in: Paws::SimpleWorkflow::DescribeActivityType

Returns: a Paws::SimpleWorkflow::ActivityTypeDetail instance

Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
- activityType.name: String constraint. The key is swf:activityType.name.
- activityType.version: String constraint. The key is swf:activityType.version.

DescribeDomain

Name => Str

Each argument is described in detail in: Paws::SimpleWorkflow::DescribeDomain

Returns: a Paws::SimpleWorkflow::DomainDetail instance

Returns information about the specified domain, including description and status.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

DescribeWorkflowExecution

Domain => Str
Execution => Paws::SimpleWorkflow::WorkflowExecution

Each argument is described in detail in: Paws::SimpleWorkflow::DescribeWorkflowExecution

Returns: a Paws::SimpleWorkflow::WorkflowExecutionDetail instance

Returns information about the specified workflow execution including its type and some statistics.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

DescribeWorkflowType

Domain => Str
WorkflowType => Paws::SimpleWorkflow::WorkflowType

Each argument is described in detail in: Paws::SimpleWorkflow::DescribeWorkflowType

Returns: a Paws::SimpleWorkflow::WorkflowTypeDetail instance

Returns information about the specified workflow type. This includes configuration settings specified when the type was registered and other information such as creation date, current status, etc.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
- workflowType.name: String constraint. The key is swf:workflowType.name.
- workflowType.version: String constraint. The key is swf:workflowType.version.

GetWorkflowExecutionHistory

Domain => Str
Execution => Paws::SimpleWorkflow::WorkflowExecution
[MaximumPageSize => Int]
[NextPageToken => Str]
[ReverseOrder => Bool]

Each argument is described in detail in: Paws::SimpleWorkflow::GetWorkflowExecutionHistory

Returns: a Paws::SimpleWorkflow::History instance

Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

ListActivityTypes

Domain => Str
RegistrationStatus => Str
[MaximumPageSize => Int]
[Name => Str]
[NextPageToken => Str]
[ReverseOrder => Bool]

Each argument is described in detail in: Paws::SimpleWorkflow::ListActivityTypes

Returns: a Paws::SimpleWorkflow::ActivityTypeInfos instance

Returns information about all activities registered in the specified domain that match the specified name and registration status. The result includes information like creation date, current status of the activity, etc. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

ListClosedWorkflowExecutions

Domain => Str
[CloseStatusFilter => Paws::SimpleWorkflow::CloseStatusFilter]
[CloseTimeFilter => Paws::SimpleWorkflow::ExecutionTimeFilter]
[ExecutionFilter => Paws::SimpleWorkflow::WorkflowExecutionFilter]
[MaximumPageSize => Int]
[NextPageToken => Str]
[ReverseOrder => Bool]
[StartTimeFilter => Paws::SimpleWorkflow::ExecutionTimeFilter]
[TagFilter => Paws::SimpleWorkflow::TagFilter]
[TypeFilter => Paws::SimpleWorkflow::WorkflowTypeFilter]

Each argument is described in detail in: Paws::SimpleWorkflow::ListClosedWorkflowExecutions

Returns: a Paws::SimpleWorkflow::WorkflowExecutionInfos instance

Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
- tagFilter.tag: String constraint. The key is swf:tagFilter.tag.
- typeFilter.name: String constraint. The key is swf:typeFilter.name.
- typeFilter.version: String constraint. The key is swf:typeFilter.version.

ListDomains

RegistrationStatus => Str
[MaximumPageSize => Int]
[NextPageToken => Str]
[ReverseOrder => Bool]

Each argument is described in detail in: Paws::SimpleWorkflow::ListDomains

Returns: a Paws::SimpleWorkflow::DomainInfos instance

Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains. The element must be set to arn:aws:swf::AccountID:domain/*, where AccountID is the account ID, with no dashes.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

ListOpenWorkflowExecutions

Domain => Str
StartTimeFilter => Paws::SimpleWorkflow::ExecutionTimeFilter
[ExecutionFilter => Paws::SimpleWorkflow::WorkflowExecutionFilter]
[MaximumPageSize => Int]
[NextPageToken => Str]
[ReverseOrder => Bool]
[TagFilter => Paws::SimpleWorkflow::TagFilter]
[TypeFilter => Paws::SimpleWorkflow::WorkflowTypeFilter]

Each argument is described in detail in: Paws::SimpleWorkflow::ListOpenWorkflowExecutions

Returns: a Paws::SimpleWorkflow::WorkflowExecutionInfos instance

Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
- tagFilter.tag: String constraint. The key is swf:tagFilter.tag.
- typeFilter.name: String constraint. The key is swf:typeFilter.name.
- typeFilter.version: String constraint. The key is swf:typeFilter.version.

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::SimpleWorkflow::ListTagsForResource

Returns: a Paws::SimpleWorkflow::ListTagsForResourceOutput instance

List tags for a given domain.

ListWorkflowTypes

Domain => Str
RegistrationStatus => Str
[MaximumPageSize => Int]
[Name => Str]
[NextPageToken => Str]
[ReverseOrder => Bool]

Each argument is described in detail in: Paws::SimpleWorkflow::ListWorkflowTypes

Returns: a Paws::SimpleWorkflow::WorkflowTypeInfos instance

Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

PollForActivityTask

Domain => Str
TaskList => Paws::SimpleWorkflow::TaskList
[Identity => Str]

Each argument is described in detail in: Paws::SimpleWorkflow::PollForActivityTask

Returns: a Paws::SimpleWorkflow::ActivityTask instance

Used by workers to get an ActivityTask from the specified activity taskList. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. 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 an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly.

Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request).

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

PollForDecisionTask

Domain => Str
TaskList => Paws::SimpleWorkflow::TaskList
[Identity => Str]
[MaximumPageSize => Int]
[NextPageToken => Str]
[ReverseOrder => Bool]

Each argument is described in detail in: Paws::SimpleWorkflow::PollForDecisionTask

Returns: a Paws::SimpleWorkflow::DecisionTask instance

Used by deciders to get a DecisionTask from the specified decision taskList. A decision task may be returned for any open workflow execution that is using the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task.

This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string.

Deciders should set their client side socket timeout to at least 70 seconds (10 seconds higher than the timeout).

Because the number of workflow history events for a single workflow execution might be very large, the result returned might be split up across a number of pages. To retrieve subsequent pages, make additional calls to PollForDecisionTask using the nextPageToken returned by the initial call. Note that you do not call GetWorkflowExecutionHistory with this nextPageToken. Instead, call PollForDecisionTask again.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

RecordActivityTaskHeartbeat

TaskToken => Str
[Details => Str]

Each argument is described in detail in: Paws::SimpleWorkflow::RecordActivityTaskHeartbeat

Returns: a Paws::SimpleWorkflow::ActivityTaskStatus instance

Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress. The worker can also specify details of the progress, for example percent complete, using the details parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean cancelRequested flag returned by the service is set to true.

This action resets the taskHeartbeatTimeout clock. The taskHeartbeatTimeout is specified in RegisterActivityType.

This action doesn't in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history contains a ActivityTaskTimedOut event that contains the information from the last heartbeat generated by the activity worker.

The taskStartToCloseTimeout of an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout is also specified in RegisterActivityType.

This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted.

If the cancelRequested flag returns true, a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

RegisterActivityType

Domain => Str
Name => Str
Version => Str
[DefaultTaskHeartbeatTimeout => Str]
[DefaultTaskList => Paws::SimpleWorkflow::TaskList]
[DefaultTaskPriority => Str]
[DefaultTaskScheduleToCloseTimeout => Str]
[DefaultTaskScheduleToStartTimeout => Str]
[DefaultTaskStartToCloseTimeout => Str]
[Description => Str]

Each argument is described in detail in: Paws::SimpleWorkflow::RegisterActivityType

Returns: nothing

Registers a new activity type along with its configuration settings in the specified domain.

A TypeAlreadyExists fault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
- defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.
- name: String constraint. The key is swf:name.
- version: String constraint. The key is swf:version.

RegisterDomain

Name => Str
WorkflowExecutionRetentionPeriodInDays => Str
[Description => Str]
[Tags => ArrayRef[Paws::SimpleWorkflow::ResourceTag]]

Each argument is described in detail in: Paws::SimpleWorkflow::RegisterDomain

Returns: nothing

Registers a new domain.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

You cannot use an IAM policy to control domain access for this action. The name of the domain being registered is available as the resource of this action.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

RegisterWorkflowType

Domain => Str
Name => Str
Version => Str
[DefaultChildPolicy => Str]
[DefaultExecutionStartToCloseTimeout => Str]
[DefaultLambdaRole => Str]
[DefaultTaskList => Paws::SimpleWorkflow::TaskList]
[DefaultTaskPriority => Str]
[DefaultTaskStartToCloseTimeout => Str]
[Description => Str]

Each argument is described in detail in: Paws::SimpleWorkflow::RegisterWorkflowType

Returns: nothing

Registers a new workflow type and its configuration settings in the specified domain.

The retention period for the workflow history is set by the RegisterDomain action.

If the type already exists, then a TypeAlreadyExists fault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
- defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.
- name: String constraint. The key is swf:name.
- version: String constraint. The key is swf:version.

RequestCancelWorkflowExecution

Domain => Str
WorkflowId => Str
[RunId => Str]

Each argument is described in detail in: Paws::SimpleWorkflow::RequestCancelWorkflowExecution

Returns: nothing

Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event.

If the runId isn't specified, the WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain.

Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

RespondActivityTaskCanceled

TaskToken => Str
[Details => Str]

Each argument is described in detail in: Paws::SimpleWorkflow::RespondActivityTaskCanceled

Returns: nothing

Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled. Additional details can be provided using the details argument.

These details (if provided) appear in the ActivityTaskCanceled event added to the workflow history.

Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns true and if the activity can be safely undone or abandoned.

A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types).

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

RespondActivityTaskCompleted

TaskToken => Str
[Result => Str]

Each argument is described in detail in: Paws::SimpleWorkflow::RespondActivityTaskCompleted

Returns: nothing

Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided). The result appears in the ActivityTaskCompleted event in the workflow history.

If the requested task doesn't complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the task is canceled through the canceled flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call RespondActivityTaskCanceled.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

RespondActivityTaskFailed

TaskToken => Str
[Details => Str]
[Reason => Str]

Each argument is described in detail in: Paws::SimpleWorkflow::RespondActivityTaskFailed

Returns: nothing

Used by workers to tell the service that the ActivityTask identified by the taskToken has failed with reason (if specified). The reason and details appear in the ActivityTaskFailed event added to the workflow history.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

RespondDecisionTaskCompleted

TaskToken => Str
[Decisions => ArrayRef[Paws::SimpleWorkflow::Decision]]
[ExecutionContext => Str]

Each argument is described in detail in: Paws::SimpleWorkflow::RespondDecisionTaskCompleted

Returns: nothing

Used by deciders to tell the service that the DecisionTask identified by the taskToken has successfully completed. The decisions argument specifies the list of decisions made while processing the task.

A DecisionTaskCompleted event is added to the workflow history. The executionContext specified is attached to the event in the workflow execution history.

Access Control

If an IAM policy grants permission to use RespondDecisionTaskCompleted, it can express permissions for the list of decisions in the decisions parameter. Each of the decisions has one or more parameters, much like a regular API call. To allow for policies to be as readable as possible, you can express permissions on decisions as if they were actual API calls, including applying conditions to some parameters. For more information, see Using IAM to Manage Access to Amazon SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

SignalWorkflowExecution

Domain => Str
SignalName => Str
WorkflowId => Str
[Input => Str]
[RunId => Str]

Each argument is described in detail in: Paws::SimpleWorkflow::SignalWorkflowExecution

Returns: nothing

Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided).

If a runId isn't specified, then the WorkflowExecutionSignaled event is recorded in the history of the current open workflow with the matching workflowId in the domain.

If the specified workflow execution isn't open, this method fails with UnknownResource.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

StartWorkflowExecution

Domain => Str
WorkflowId => Str
WorkflowType => Paws::SimpleWorkflow::WorkflowType
[ChildPolicy => Str]
[ExecutionStartToCloseTimeout => Str]
[Input => Str]
[LambdaRole => Str]
[TagList => ArrayRef[Str|Undef]]
[TaskList => Paws::SimpleWorkflow::TaskList]
[TaskPriority => Str]
[TaskStartToCloseTimeout => Str]

Each argument is described in detail in: Paws::SimpleWorkflow::StartWorkflowExecution

Returns: a Paws::SimpleWorkflow::Run instance

Starts an execution of the workflow type in the specified domain using the provided workflowId and input data.

This action returns the newly started workflow execution.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
- tagList.member.0: The key is swf:tagList.member.0.
- tagList.member.1: The key is swf:tagList.member.1.
- tagList.member.2: The key is swf:tagList.member.2.
- tagList.member.3: The key is swf:tagList.member.3.
- tagList.member.4: The key is swf:tagList.member.4.
- taskList: String constraint. The key is swf:taskList.name.
- workflowType.name: String constraint. The key is swf:workflowType.name.
- workflowType.version: String constraint. The key is swf:workflowType.version.

TagResource

ResourceArn => Str
Tags => ArrayRef[Paws::SimpleWorkflow::ResourceTag]

Each argument is described in detail in: Paws::SimpleWorkflow::TagResource

Returns: nothing

Add a tag to a Amazon SWF domain.

Amazon SWF supports a maximum of 50 tags per resource.

TerminateWorkflowExecution

Domain => Str
WorkflowId => Str
[ChildPolicy => Str]
[Details => Str]
[Reason => Str]
[RunId => Str]

Each argument is described in detail in: Paws::SimpleWorkflow::TerminateWorkflowExecution

Returns: nothing

Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution.

If the identified workflow execution was in progress, it is terminated immediately.

If a runId isn't specified, then the WorkflowExecutionTerminated event is recorded in the history of the current open workflow with the matching workflowId in the domain.

You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution doesn't.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

UndeprecateActivityType

ActivityType => Paws::SimpleWorkflow::ActivityType
Domain => Str

Each argument is described in detail in: Paws::SimpleWorkflow::UndeprecateActivityType

Returns: nothing

Undeprecates a previously deprecated activity type. After an activity type has been undeprecated, you can create new tasks of that activity type.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
- activityType.name: String constraint. The key is swf:activityType.name.
- activityType.version: String constraint. The key is swf:activityType.version.

UndeprecateDomain

Name => Str

Each argument is described in detail in: Paws::SimpleWorkflow::UndeprecateDomain

Returns: nothing

Undeprecates a previously deprecated domain. After a domain has been undeprecated it can be used to create new workflow executions or register new types.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

UndeprecateWorkflowType

Domain => Str
WorkflowType => Paws::SimpleWorkflow::WorkflowType

Each argument is described in detail in: Paws::SimpleWorkflow::UndeprecateWorkflowType

Returns: nothing

Undeprecates a previously deprecated workflow type. After a workflow type has been undeprecated, you can create new executions of that type.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
- workflowType.name: String constraint. The key is swf:workflowType.name.
- workflowType.version: String constraint. The key is swf:workflowType.version.

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::SimpleWorkflow::UntagResource

Returns: nothing

Remove a tag from a Amazon SWF domain.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

GetAllWorkflowExecutionHistory(sub { },Domain => Str, Execution => Paws::SimpleWorkflow::WorkflowExecution, [MaximumPageSize => Int, NextPageToken => Str, ReverseOrder => Bool])

GetAllWorkflowExecutionHistory(Domain => Str, Execution => Paws::SimpleWorkflow::WorkflowExecution, [MaximumPageSize => Int, NextPageToken => 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::SimpleWorkflow::History instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllActivityTypes(sub { },Domain => Str, RegistrationStatus => Str, [MaximumPageSize => Int, Name => Str, NextPageToken => Str, ReverseOrder => Bool])

ListAllActivityTypes(Domain => Str, RegistrationStatus => Str, [MaximumPageSize => Int, Name => Str, NextPageToken => Str, ReverseOrder => Bool])

If passed a sub as first parameter, it will call the sub for each element found in :

- typeInfos, passing the object as the first parameter, and the string 'typeInfos' as the second parameter

If not, it will return a a Paws::SimpleWorkflow::ActivityTypeInfos instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllClosedWorkflowExecutions(sub { },Domain => Str, [CloseStatusFilter => Paws::SimpleWorkflow::CloseStatusFilter, CloseTimeFilter => Paws::SimpleWorkflow::ExecutionTimeFilter, ExecutionFilter => Paws::SimpleWorkflow::WorkflowExecutionFilter, MaximumPageSize => Int, NextPageToken => Str, ReverseOrder => Bool, StartTimeFilter => Paws::SimpleWorkflow::ExecutionTimeFilter, TagFilter => Paws::SimpleWorkflow::TagFilter, TypeFilter => Paws::SimpleWorkflow::WorkflowTypeFilter])

ListAllClosedWorkflowExecutions(Domain => Str, [CloseStatusFilter => Paws::SimpleWorkflow::CloseStatusFilter, CloseTimeFilter => Paws::SimpleWorkflow::ExecutionTimeFilter, ExecutionFilter => Paws::SimpleWorkflow::WorkflowExecutionFilter, MaximumPageSize => Int, NextPageToken => Str, ReverseOrder => Bool, StartTimeFilter => Paws::SimpleWorkflow::ExecutionTimeFilter, TagFilter => Paws::SimpleWorkflow::TagFilter, TypeFilter => Paws::SimpleWorkflow::WorkflowTypeFilter])

If passed a sub as first parameter, it will call the sub for each element found in :

- executionInfos, passing the object as the first parameter, and the string 'executionInfos' as the second parameter

If not, it will return a a Paws::SimpleWorkflow::WorkflowExecutionInfos instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllDomains(sub { },RegistrationStatus => Str, [MaximumPageSize => Int, NextPageToken => Str, ReverseOrder => Bool])

ListAllDomains(RegistrationStatus => Str, [MaximumPageSize => Int, NextPageToken => Str, ReverseOrder => Bool])

If passed a sub as first parameter, it will call the sub for each element found in :

- domainInfos, passing the object as the first parameter, and the string 'domainInfos' as the second parameter

If not, it will return a a Paws::SimpleWorkflow::DomainInfos instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllOpenWorkflowExecutions(sub { },Domain => Str, StartTimeFilter => Paws::SimpleWorkflow::ExecutionTimeFilter, [ExecutionFilter => Paws::SimpleWorkflow::WorkflowExecutionFilter, MaximumPageSize => Int, NextPageToken => Str, ReverseOrder => Bool, TagFilter => Paws::SimpleWorkflow::TagFilter, TypeFilter => Paws::SimpleWorkflow::WorkflowTypeFilter])

ListAllOpenWorkflowExecutions(Domain => Str, StartTimeFilter => Paws::SimpleWorkflow::ExecutionTimeFilter, [ExecutionFilter => Paws::SimpleWorkflow::WorkflowExecutionFilter, MaximumPageSize => Int, NextPageToken => Str, ReverseOrder => Bool, TagFilter => Paws::SimpleWorkflow::TagFilter, TypeFilter => Paws::SimpleWorkflow::WorkflowTypeFilter])

If passed a sub as first parameter, it will call the sub for each element found in :

- executionInfos, passing the object as the first parameter, and the string 'executionInfos' as the second parameter

ListAllWorkflowTypes(sub { },Domain => Str, RegistrationStatus => Str, [MaximumPageSize => Int, Name => Str, NextPageToken => Str, ReverseOrder => Bool])

ListAllWorkflowTypes(Domain => Str, RegistrationStatus => Str, [MaximumPageSize => Int, Name => Str, NextPageToken => Str, ReverseOrder => Bool])

If passed a sub as first parameter, it will call the sub for each element found in :

- typeInfos, passing the object as the first parameter, and the string 'typeInfos' as the second parameter

If not, it will return a a Paws::SimpleWorkflow::WorkflowTypeInfos instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

PollForAllDecisionTasks(sub { },Domain => Str, TaskList => Paws::SimpleWorkflow::TaskList, [Identity => Str, MaximumPageSize => Int, NextPageToken => Str, ReverseOrder => Bool])

PollForAllDecisionTasks(Domain => Str, TaskList => Paws::SimpleWorkflow::TaskList, [Identity => Str, MaximumPageSize => Int, NextPageToken => 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::SimpleWorkflow::DecisionTask instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

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

To install Paws, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Paws

CPAN shell

perl -MCPAN -e shell
install Paws

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

SYNOPSIS

DESCRIPTION

METHODS

CountClosedWorkflowExecutions

CountOpenWorkflowExecutions

CountPendingActivityTasks

CountPendingDecisionTasks

DeprecateActivityType

DeprecateDomain

DeprecateWorkflowType

DescribeActivityType

DescribeDomain

DescribeWorkflowExecution

DescribeWorkflowType

GetWorkflowExecutionHistory

ListActivityTypes

ListClosedWorkflowExecutions

ListDomains

ListOpenWorkflowExecutions

ListTagsForResource

ListWorkflowTypes

PollForActivityTask

PollForDecisionTask

RecordActivityTaskHeartbeat

RegisterActivityType

RegisterDomain

RegisterWorkflowType

RequestCancelWorkflowExecution

RespondActivityTaskCanceled

RespondActivityTaskCompleted

RespondActivityTaskFailed

RespondDecisionTaskCompleted

SignalWorkflowExecution

StartWorkflowExecution

TagResource

TerminateWorkflowExecution

UndeprecateActivityType

UndeprecateDomain

UndeprecateWorkflowType

UntagResource

PAGINATORS

GetAllWorkflowExecutionHistory(sub { },Domain => Str, Execution => Paws::SimpleWorkflow::WorkflowExecution, [MaximumPageSize => Int, NextPageToken => Str, ReverseOrder => Bool])

GetAllWorkflowExecutionHistory(Domain => Str, Execution => Paws::SimpleWorkflow::WorkflowExecution, [MaximumPageSize => Int, NextPageToken => Str, ReverseOrder => Bool])

ListAllActivityTypes(sub { },Domain => Str, RegistrationStatus => Str, [MaximumPageSize => Int, Name => Str, NextPageToken => Str, ReverseOrder => Bool])

ListAllActivityTypes(Domain => Str, RegistrationStatus => Str, [MaximumPageSize => Int, Name => Str, NextPageToken => Str, ReverseOrder => Bool])

ListAllDomains(sub { },RegistrationStatus => Str, [MaximumPageSize => Int, NextPageToken => Str, ReverseOrder => Bool])

ListAllDomains(RegistrationStatus => Str, [MaximumPageSize => Int, NextPageToken => Str, ReverseOrder => Bool])

ListAllWorkflowTypes(sub { },Domain => Str, RegistrationStatus => Str, [MaximumPageSize => Int, Name => Str, NextPageToken => Str, ReverseOrder => Bool])

ListAllWorkflowTypes(Domain => Str, RegistrationStatus => Str, [MaximumPageSize => Int, Name => Str, NextPageToken => Str, ReverseOrder => Bool])

PollForAllDecisionTasks(sub { },Domain => Str, TaskList => Paws::SimpleWorkflow::TaskList, [Identity => Str, MaximumPageSize => Int, NextPageToken => Str, ReverseOrder => Bool])

PollForAllDecisionTasks(Domain => Str, TaskList => Paws::SimpleWorkflow::TaskList, [Identity => Str, MaximumPageSize => Int, NextPageToken => Str, ReverseOrder => Bool])

SEE ALSO

BUGS and CONTRIBUTIONS

Module Install Instructions