CountClosedWorkflowExecutions

$result = $client->countClosedWorkflowExecutions([/* ... */]);
$promise = $client->countClosedWorkflowExecutionsAsync([/* ... */]);

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

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->countClosedWorkflowExecutions([
    'closeStatusFilter' => [
        'status' => 'COMPLETED|FAILED|CANCELED|TERMINATED|CONTINUED_AS_NEW|TIMED_OUT', // REQUIRED
    ],
    'closeTimeFilter' => [
        'latestDate' => <integer || string || DateTime>,
        'oldestDate' => <integer || string || DateTime>, // REQUIRED
    ],
    'domain' => '<string>', // REQUIRED
    'executionFilter' => [
        'workflowId' => '<string>', // REQUIRED
    ],
    'startTimeFilter' => [
        'latestDate' => <integer || string || DateTime>,
        'oldestDate' => <integer || string || DateTime>, // REQUIRED
    ],
    'tagFilter' => [
        'tag' => '<string>', // REQUIRED
    ],
    'typeFilter' => [
        'name' => '<string>', // REQUIRED
        'version' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'count' => <integer>,
    'truncated' => true || false,
]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

CountOpenWorkflowExecutions

$result = $client->countOpenWorkflowExecutions([/* ... */]);
$promise = $client->countOpenWorkflowExecutionsAsync([/* ... */]);

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

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->countOpenWorkflowExecutions([
    'domain' => '<string>', // REQUIRED
    'executionFilter' => [
        'workflowId' => '<string>', // REQUIRED
    ],
    'startTimeFilter' => [ // REQUIRED
        'latestDate' => <integer || string || DateTime>,
        'oldestDate' => <integer || string || DateTime>, // REQUIRED
    ],
    'tagFilter' => [
        'tag' => '<string>', // REQUIRED
    ],
    'typeFilter' => [
        'name' => '<string>', // REQUIRED
        'version' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'count' => <integer>,
    'truncated' => true || false,
]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

CountPendingActivityTasks

$result = $client->countPendingActivityTasks([/* ... */]);
$promise = $client->countPendingActivityTasksAsync([/* ... */]);

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->countPendingActivityTasks([
    'domain' => '<string>', // REQUIRED
    'taskList' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'count' => <integer>,
    'truncated' => true || false,
]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

CountPendingDecisionTasks

$result = $client->countPendingDecisionTasks([/* ... */]);
$promise = $client->countPendingDecisionTasksAsync([/* ... */]);

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->countPendingDecisionTasks([
    'domain' => '<string>', // REQUIRED
    'taskList' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'count' => <integer>,
    'truncated' => true || false,
]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

DeleteActivityType

$result = $client->deleteActivityType([/* ... */]);
$promise = $client->deleteActivityTypeAsync([/* ... */]);

Deletes the specified activity type.

Note: Prior to deletion, activity types must first be deprecated.

After an activity type has been deleted, you cannot schedule new activities of that type. Activities that started before the type was deleted will continue to run.

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->deleteActivityType([
    'activityType' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
        'version' => '<string>', // REQUIRED
    ],
    'domain' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

TypeNotDeprecatedFault:

Returned when the resource type has not been deprecated.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

DeleteWorkflowType

$result = $client->deleteWorkflowType([/* ... */]);
$promise = $client->deleteWorkflowTypeAsync([/* ... */]);

Deletes the specified workflow type.

Note: Prior to deletion, workflow types must first be deprecated.

After a workflow type has been deleted, you cannot create new executions of that type. Executions that started before the type was deleted will continue to run.

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->deleteWorkflowType([
    'domain' => '<string>', // REQUIRED
    'workflowType' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
        'version' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

TypeNotDeprecatedFault:

Returned when the resource type has not been deprecated.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

DeprecateActivityType

$result = $client->deprecateActivityType([/* ... */]);
$promise = $client->deprecateActivityTypeAsync([/* ... */]);

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.

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->deprecateActivityType([
    'activityType' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
        'version' => '<string>', // REQUIRED
    ],
    'domain' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

TypeDeprecatedFault:

Returned when the specified activity or workflow type was already deprecated.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

DeprecateDomain

$result = $client->deprecateDomain([/* ... */]);
$promise = $client->deprecateDomainAsync([/* ... */]);

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.

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->deprecateDomain([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

DomainDeprecatedFault:

Returned when the specified domain has been deprecated.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

DeprecateWorkflowType

$result = $client->deprecateWorkflowType([/* ... */]);
$promise = $client->deprecateWorkflowTypeAsync([/* ... */]);

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.

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->deprecateWorkflowType([
    'domain' => '<string>', // REQUIRED
    'workflowType' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
        'version' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

TypeDeprecatedFault:

Returned when the specified activity or workflow type was already deprecated.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

DescribeActivityType

$result = $client->describeActivityType([/* ... */]);
$promise = $client->describeActivityTypeAsync([/* ... */]);

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->describeActivityType([
    'activityType' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
        'version' => '<string>', // REQUIRED
    ],
    'domain' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'configuration' => [
        'defaultTaskHeartbeatTimeout' => '<string>',
        'defaultTaskList' => [
            'name' => '<string>',
        ],
        'defaultTaskPriority' => '<string>',
        'defaultTaskScheduleToCloseTimeout' => '<string>',
        'defaultTaskScheduleToStartTimeout' => '<string>',
        'defaultTaskStartToCloseTimeout' => '<string>',
    ],
    'typeInfo' => [
        'activityType' => [
            'name' => '<string>',
            'version' => '<string>',
        ],
        'creationDate' => <DateTime>,
        'deprecationDate' => <DateTime>,
        'description' => '<string>',
        'status' => 'REGISTERED|DEPRECATED',
    ],
]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

DescribeDomain

$result = $client->describeDomain([/* ... */]);
$promise = $client->describeDomainAsync([/* ... */]);

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->describeDomain([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'configuration' => [
        'workflowExecutionRetentionPeriodInDays' => '<string>',
    ],
    'domainInfo' => [
        'arn' => '<string>',
        'description' => '<string>',
        'name' => '<string>',
        'status' => 'REGISTERED|DEPRECATED',
    ],
]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

DescribeWorkflowExecution

$result = $client->describeWorkflowExecution([/* ... */]);
$promise = $client->describeWorkflowExecutionAsync([/* ... */]);

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

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->describeWorkflowExecution([
    'domain' => '<string>', // REQUIRED
    'execution' => [ // REQUIRED
        'runId' => '<string>', // REQUIRED
        'workflowId' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'executionConfiguration' => [
        'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
        'executionStartToCloseTimeout' => '<string>',
        'lambdaRole' => '<string>',
        'taskList' => [
            'name' => '<string>',
        ],
        'taskPriority' => '<string>',
        'taskStartToCloseTimeout' => '<string>',
    ],
    'executionInfo' => [
        'cancelRequested' => true || false,
        'closeStatus' => 'COMPLETED|FAILED|CANCELED|TERMINATED|CONTINUED_AS_NEW|TIMED_OUT',
        'closeTimestamp' => <DateTime>,
        'execution' => [
            'runId' => '<string>',
            'workflowId' => '<string>',
        ],
        'executionStatus' => 'OPEN|CLOSED',
        'parent' => [
            'runId' => '<string>',
            'workflowId' => '<string>',
        ],
        'startTimestamp' => <DateTime>,
        'tagList' => ['<string>', ...],
        'workflowType' => [
            'name' => '<string>',
            'version' => '<string>',
        ],
    ],
    'latestActivityTaskTimestamp' => <DateTime>,
    'latestExecutionContext' => '<string>',
    'openCounts' => [
        'openActivityTasks' => <integer>,
        'openChildWorkflowExecutions' => <integer>,
        'openDecisionTasks' => <integer>,
        'openLambdaFunctions' => <integer>,
        'openTimers' => <integer>,
    ],
]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

DescribeWorkflowType

$result = $client->describeWorkflowType([/* ... */]);
$promise = $client->describeWorkflowTypeAsync([/* ... */]);

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->describeWorkflowType([
    'domain' => '<string>', // REQUIRED
    'workflowType' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
        'version' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'configuration' => [
        'defaultChildPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
        'defaultExecutionStartToCloseTimeout' => '<string>',
        'defaultLambdaRole' => '<string>',
        'defaultTaskList' => [
            'name' => '<string>',
        ],
        'defaultTaskPriority' => '<string>',
        'defaultTaskStartToCloseTimeout' => '<string>',
    ],
    'typeInfo' => [
        'creationDate' => <DateTime>,
        'deprecationDate' => <DateTime>,
        'description' => '<string>',
        'status' => 'REGISTERED|DEPRECATED',
        'workflowType' => [
            'name' => '<string>',
            'version' => '<string>',
        ],
    ],
]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

GetWorkflowExecutionHistory

$result = $client->getWorkflowExecutionHistory([/* ... */]);
$promise = $client->getWorkflowExecutionHistoryAsync([/* ... */]);

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.

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->getWorkflowExecutionHistory([
    'domain' => '<string>', // REQUIRED
    'execution' => [ // REQUIRED
        'runId' => '<string>', // REQUIRED
        'workflowId' => '<string>', // REQUIRED
    ],
    'maximumPageSize' => <integer>,
    'nextPageToken' => '<string>',
    'reverseOrder' => true || false,
]);

Parameter Details

Result Syntax

[
    'events' => [
        [
            'activityTaskCancelRequestedEventAttributes' => [
                'activityId' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'activityTaskCanceledEventAttributes' => [
                'details' => '<string>',
                'latestCancelRequestedEventId' => <integer>,
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
            ],
            'activityTaskCompletedEventAttributes' => [
                'result' => '<string>',
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
            ],
            'activityTaskFailedEventAttributes' => [
                'details' => '<string>',
                'reason' => '<string>',
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
            ],
            'activityTaskScheduledEventAttributes' => [
                'activityId' => '<string>',
                'activityType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'heartbeatTimeout' => '<string>',
                'input' => '<string>',
                'scheduleToCloseTimeout' => '<string>',
                'scheduleToStartTimeout' => '<string>',
                'startToCloseTimeout' => '<string>',
                'taskList' => [
                    'name' => '<string>',
                ],
                'taskPriority' => '<string>',
            ],
            'activityTaskStartedEventAttributes' => [
                'identity' => '<string>',
                'scheduledEventId' => <integer>,
            ],
            'activityTaskTimedOutEventAttributes' => [
                'details' => '<string>',
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
                'timeoutType' => 'START_TO_CLOSE|SCHEDULE_TO_START|SCHEDULE_TO_CLOSE|HEARTBEAT',
            ],
            'cancelTimerFailedEventAttributes' => [
                'cause' => 'TIMER_ID_UNKNOWN|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
                'timerId' => '<string>',
            ],
            'cancelWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'UNHANDLED_DECISION|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'childWorkflowExecutionCanceledEventAttributes' => [
                'details' => '<string>',
                'initiatedEventId' => <integer>,
                'startedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'childWorkflowExecutionCompletedEventAttributes' => [
                'initiatedEventId' => <integer>,
                'result' => '<string>',
                'startedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'childWorkflowExecutionFailedEventAttributes' => [
                'details' => '<string>',
                'initiatedEventId' => <integer>,
                'reason' => '<string>',
                'startedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'childWorkflowExecutionStartedEventAttributes' => [
                'initiatedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'childWorkflowExecutionTerminatedEventAttributes' => [
                'initiatedEventId' => <integer>,
                'startedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'childWorkflowExecutionTimedOutEventAttributes' => [
                'initiatedEventId' => <integer>,
                'startedEventId' => <integer>,
                'timeoutType' => 'START_TO_CLOSE',
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'completeWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'UNHANDLED_DECISION|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'continueAsNewWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'UNHANDLED_DECISION|WORKFLOW_TYPE_DEPRECATED|WORKFLOW_TYPE_DOES_NOT_EXIST|DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED|DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED|DEFAULT_TASK_LIST_UNDEFINED|DEFAULT_CHILD_POLICY_UNDEFINED|CONTINUE_AS_NEW_WORKFLOW_EXECUTION_RATE_EXCEEDED|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'decisionTaskCompletedEventAttributes' => [
                'executionContext' => '<string>',
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
                'taskList' => [
                    'name' => '<string>',
                ],
                'taskListScheduleToStartTimeout' => '<string>',
            ],
            'decisionTaskScheduledEventAttributes' => [
                'scheduleToStartTimeout' => '<string>',
                'startToCloseTimeout' => '<string>',
                'taskList' => [
                    'name' => '<string>',
                ],
                'taskPriority' => '<string>',
            ],
            'decisionTaskStartedEventAttributes' => [
                'identity' => '<string>',
                'scheduledEventId' => <integer>,
            ],
            'decisionTaskTimedOutEventAttributes' => [
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
                'timeoutType' => 'START_TO_CLOSE|SCHEDULE_TO_START',
            ],
            'eventId' => <integer>,
            'eventTimestamp' => <DateTime>,
            'eventType' => 'WorkflowExecutionStarted|WorkflowExecutionCancelRequested|WorkflowExecutionCompleted|CompleteWorkflowExecutionFailed|WorkflowExecutionFailed|FailWorkflowExecutionFailed|WorkflowExecutionTimedOut|WorkflowExecutionCanceled|CancelWorkflowExecutionFailed|WorkflowExecutionContinuedAsNew|ContinueAsNewWorkflowExecutionFailed|WorkflowExecutionTerminated|DecisionTaskScheduled|DecisionTaskStarted|DecisionTaskCompleted|DecisionTaskTimedOut|ActivityTaskScheduled|ScheduleActivityTaskFailed|ActivityTaskStarted|ActivityTaskCompleted|ActivityTaskFailed|ActivityTaskTimedOut|ActivityTaskCanceled|ActivityTaskCancelRequested|RequestCancelActivityTaskFailed|WorkflowExecutionSignaled|MarkerRecorded|RecordMarkerFailed|TimerStarted|StartTimerFailed|TimerFired|TimerCanceled|CancelTimerFailed|StartChildWorkflowExecutionInitiated|StartChildWorkflowExecutionFailed|ChildWorkflowExecutionStarted|ChildWorkflowExecutionCompleted|ChildWorkflowExecutionFailed|ChildWorkflowExecutionTimedOut|ChildWorkflowExecutionCanceled|ChildWorkflowExecutionTerminated|SignalExternalWorkflowExecutionInitiated|SignalExternalWorkflowExecutionFailed|ExternalWorkflowExecutionSignaled|RequestCancelExternalWorkflowExecutionInitiated|RequestCancelExternalWorkflowExecutionFailed|ExternalWorkflowExecutionCancelRequested|LambdaFunctionScheduled|LambdaFunctionStarted|LambdaFunctionCompleted|LambdaFunctionFailed|LambdaFunctionTimedOut|ScheduleLambdaFunctionFailed|StartLambdaFunctionFailed',
            'externalWorkflowExecutionCancelRequestedEventAttributes' => [
                'initiatedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
            ],
            'externalWorkflowExecutionSignaledEventAttributes' => [
                'initiatedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
            ],
            'failWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'UNHANDLED_DECISION|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'lambdaFunctionCompletedEventAttributes' => [
                'result' => '<string>',
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
            ],
            'lambdaFunctionFailedEventAttributes' => [
                'details' => '<string>',
                'reason' => '<string>',
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
            ],
            'lambdaFunctionScheduledEventAttributes' => [
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'id' => '<string>',
                'input' => '<string>',
                'name' => '<string>',
                'startToCloseTimeout' => '<string>',
            ],
            'lambdaFunctionStartedEventAttributes' => [
                'scheduledEventId' => <integer>,
            ],
            'lambdaFunctionTimedOutEventAttributes' => [
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
                'timeoutType' => 'START_TO_CLOSE',
            ],
            'markerRecordedEventAttributes' => [
                'decisionTaskCompletedEventId' => <integer>,
                'details' => '<string>',
                'markerName' => '<string>',
            ],
            'recordMarkerFailedEventAttributes' => [
                'cause' => 'OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
                'markerName' => '<string>',
            ],
            'requestCancelActivityTaskFailedEventAttributes' => [
                'activityId' => '<string>',
                'cause' => 'ACTIVITY_ID_UNKNOWN|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'requestCancelExternalWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION|REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED|OPERATION_NOT_PERMITTED',
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'initiatedEventId' => <integer>,
                'runId' => '<string>',
                'workflowId' => '<string>',
            ],
            'requestCancelExternalWorkflowExecutionInitiatedEventAttributes' => [
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'runId' => '<string>',
                'workflowId' => '<string>',
            ],
            'scheduleActivityTaskFailedEventAttributes' => [
                'activityId' => '<string>',
                'activityType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
                'cause' => 'ACTIVITY_TYPE_DEPRECATED|ACTIVITY_TYPE_DOES_NOT_EXIST|ACTIVITY_ID_ALREADY_IN_USE|OPEN_ACTIVITIES_LIMIT_EXCEEDED|ACTIVITY_CREATION_RATE_EXCEEDED|DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED|DEFAULT_TASK_LIST_UNDEFINED|DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED|DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED|DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'scheduleLambdaFunctionFailedEventAttributes' => [
                'cause' => 'ID_ALREADY_IN_USE|OPEN_LAMBDA_FUNCTIONS_LIMIT_EXCEEDED|LAMBDA_FUNCTION_CREATION_RATE_EXCEEDED|LAMBDA_SERVICE_NOT_AVAILABLE_IN_REGION',
                'decisionTaskCompletedEventId' => <integer>,
                'id' => '<string>',
                'name' => '<string>',
            ],
            'signalExternalWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION|SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED|OPERATION_NOT_PERMITTED',
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'initiatedEventId' => <integer>,
                'runId' => '<string>',
                'workflowId' => '<string>',
            ],
            'signalExternalWorkflowExecutionInitiatedEventAttributes' => [
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'input' => '<string>',
                'runId' => '<string>',
                'signalName' => '<string>',
                'workflowId' => '<string>',
            ],
            'startChildWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'WORKFLOW_TYPE_DOES_NOT_EXIST|WORKFLOW_TYPE_DEPRECATED|OPEN_CHILDREN_LIMIT_EXCEEDED|OPEN_WORKFLOWS_LIMIT_EXCEEDED|CHILD_CREATION_RATE_EXCEEDED|WORKFLOW_ALREADY_RUNNING|DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED|DEFAULT_TASK_LIST_UNDEFINED|DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED|DEFAULT_CHILD_POLICY_UNDEFINED|OPERATION_NOT_PERMITTED',
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'initiatedEventId' => <integer>,
                'workflowId' => '<string>',
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'startChildWorkflowExecutionInitiatedEventAttributes' => [
                'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'executionStartToCloseTimeout' => '<string>',
                'input' => '<string>',
                'lambdaRole' => '<string>',
                'tagList' => ['<string>', ...],
                'taskList' => [
                    'name' => '<string>',
                ],
                'taskPriority' => '<string>',
                'taskStartToCloseTimeout' => '<string>',
                'workflowId' => '<string>',
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'startLambdaFunctionFailedEventAttributes' => [
                'cause' => 'ASSUME_ROLE_FAILED',
                'message' => '<string>',
                'scheduledEventId' => <integer>,
            ],
            'startTimerFailedEventAttributes' => [
                'cause' => 'TIMER_ID_ALREADY_IN_USE|OPEN_TIMERS_LIMIT_EXCEEDED|TIMER_CREATION_RATE_EXCEEDED|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
                'timerId' => '<string>',
            ],
            'timerCanceledEventAttributes' => [
                'decisionTaskCompletedEventId' => <integer>,
                'startedEventId' => <integer>,
                'timerId' => '<string>',
            ],
            'timerFiredEventAttributes' => [
                'startedEventId' => <integer>,
                'timerId' => '<string>',
            ],
            'timerStartedEventAttributes' => [
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'startToFireTimeout' => '<string>',
                'timerId' => '<string>',
            ],
            'workflowExecutionCancelRequestedEventAttributes' => [
                'cause' => 'CHILD_POLICY_APPLIED',
                'externalInitiatedEventId' => <integer>,
                'externalWorkflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
            ],
            'workflowExecutionCanceledEventAttributes' => [
                'decisionTaskCompletedEventId' => <integer>,
                'details' => '<string>',
            ],
            'workflowExecutionCompletedEventAttributes' => [
                'decisionTaskCompletedEventId' => <integer>,
                'result' => '<string>',
            ],
            'workflowExecutionContinuedAsNewEventAttributes' => [
                'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
                'decisionTaskCompletedEventId' => <integer>,
                'executionStartToCloseTimeout' => '<string>',
                'input' => '<string>',
                'lambdaRole' => '<string>',
                'newExecutionRunId' => '<string>',
                'tagList' => ['<string>', ...],
                'taskList' => [
                    'name' => '<string>',
                ],
                'taskPriority' => '<string>',
                'taskStartToCloseTimeout' => '<string>',
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'workflowExecutionFailedEventAttributes' => [
                'decisionTaskCompletedEventId' => <integer>,
                'details' => '<string>',
                'reason' => '<string>',
            ],
            'workflowExecutionSignaledEventAttributes' => [
                'externalInitiatedEventId' => <integer>,
                'externalWorkflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'input' => '<string>',
                'signalName' => '<string>',
            ],
            'workflowExecutionStartedEventAttributes' => [
                'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
                'continuedExecutionRunId' => '<string>',
                'executionStartToCloseTimeout' => '<string>',
                'input' => '<string>',
                'lambdaRole' => '<string>',
                'parentInitiatedEventId' => <integer>,
                'parentWorkflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'tagList' => ['<string>', ...],
                'taskList' => [
                    'name' => '<string>',
                ],
                'taskPriority' => '<string>',
                'taskStartToCloseTimeout' => '<string>',
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'workflowExecutionTerminatedEventAttributes' => [
                'cause' => 'CHILD_POLICY_APPLIED|EVENT_LIMIT_EXCEEDED|OPERATOR_INITIATED',
                'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
                'details' => '<string>',
                'reason' => '<string>',
            ],
            'workflowExecutionTimedOutEventAttributes' => [
                'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
                'timeoutType' => 'START_TO_CLOSE',
            ],
        ],
        // ...
    ],
    'nextPageToken' => '<string>',
]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

ListActivityTypes

$result = $client->listActivityTypes([/* ... */]);
$promise = $client->listActivityTypesAsync([/* ... */]);

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->listActivityTypes([
    'domain' => '<string>', // REQUIRED
    'maximumPageSize' => <integer>,
    'name' => '<string>',
    'nextPageToken' => '<string>',
    'registrationStatus' => 'REGISTERED|DEPRECATED', // REQUIRED
    'reverseOrder' => true || false,
]);

Parameter Details

Result Syntax

[
    'nextPageToken' => '<string>',
    'typeInfos' => [
        [
            'activityType' => [
                'name' => '<string>',
                'version' => '<string>',
            ],
            'creationDate' => <DateTime>,
            'deprecationDate' => <DateTime>,
            'description' => '<string>',
            'status' => 'REGISTERED|DEPRECATED',
        ],
        // ...
    ],
]

Result Details

Errors

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

ListClosedWorkflowExecutions

$result = $client->listClosedWorkflowExecutions([/* ... */]);
$promise = $client->listClosedWorkflowExecutionsAsync([/* ... */]);

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->listClosedWorkflowExecutions([
    'closeStatusFilter' => [
        'status' => 'COMPLETED|FAILED|CANCELED|TERMINATED|CONTINUED_AS_NEW|TIMED_OUT', // REQUIRED
    ],
    'closeTimeFilter' => [
        'latestDate' => <integer || string || DateTime>,
        'oldestDate' => <integer || string || DateTime>, // REQUIRED
    ],
    'domain' => '<string>', // REQUIRED
    'executionFilter' => [
        'workflowId' => '<string>', // REQUIRED
    ],
    'maximumPageSize' => <integer>,
    'nextPageToken' => '<string>',
    'reverseOrder' => true || false,
    'startTimeFilter' => [
        'latestDate' => <integer || string || DateTime>,
        'oldestDate' => <integer || string || DateTime>, // REQUIRED
    ],
    'tagFilter' => [
        'tag' => '<string>', // REQUIRED
    ],
    'typeFilter' => [
        'name' => '<string>', // REQUIRED
        'version' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'executionInfos' => [
        [
            'cancelRequested' => true || false,
            'closeStatus' => 'COMPLETED|FAILED|CANCELED|TERMINATED|CONTINUED_AS_NEW|TIMED_OUT',
            'closeTimestamp' => <DateTime>,
            'execution' => [
                'runId' => '<string>',
                'workflowId' => '<string>',
            ],
            'executionStatus' => 'OPEN|CLOSED',
            'parent' => [
                'runId' => '<string>',
                'workflowId' => '<string>',
            ],
            'startTimestamp' => <DateTime>,
            'tagList' => ['<string>', ...],
            'workflowType' => [
                'name' => '<string>',
                'version' => '<string>',
            ],
        ],
        // ...
    ],
    'nextPageToken' => '<string>',
]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

ListDomains

$result = $client->listDomains([/* ... */]);
$promise = $client->listDomainsAsync([/* ... */]);

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.

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->listDomains([
    'maximumPageSize' => <integer>,
    'nextPageToken' => '<string>',
    'registrationStatus' => 'REGISTERED|DEPRECATED', // REQUIRED
    'reverseOrder' => true || false,
]);

Parameter Details

Result Syntax

[
    'domainInfos' => [
        [
            'arn' => '<string>',
            'description' => '<string>',
            'name' => '<string>',
            'status' => 'REGISTERED|DEPRECATED',
        ],
        // ...
    ],
    'nextPageToken' => '<string>',
]

Result Details

Errors

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

ListOpenWorkflowExecutions

$result = $client->listOpenWorkflowExecutions([/* ... */]);
$promise = $client->listOpenWorkflowExecutionsAsync([/* ... */]);

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->listOpenWorkflowExecutions([
    'domain' => '<string>', // REQUIRED
    'executionFilter' => [
        'workflowId' => '<string>', // REQUIRED
    ],
    'maximumPageSize' => <integer>,
    'nextPageToken' => '<string>',
    'reverseOrder' => true || false,
    'startTimeFilter' => [ // REQUIRED
        'latestDate' => <integer || string || DateTime>,
        'oldestDate' => <integer || string || DateTime>, // REQUIRED
    ],
    'tagFilter' => [
        'tag' => '<string>', // REQUIRED
    ],
    'typeFilter' => [
        'name' => '<string>', // REQUIRED
        'version' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'executionInfos' => [
        [
            'cancelRequested' => true || false,
            'closeStatus' => 'COMPLETED|FAILED|CANCELED|TERMINATED|CONTINUED_AS_NEW|TIMED_OUT',
            'closeTimestamp' => <DateTime>,
            'execution' => [
                'runId' => '<string>',
                'workflowId' => '<string>',
            ],
            'executionStatus' => 'OPEN|CLOSED',
            'parent' => [
                'runId' => '<string>',
                'workflowId' => '<string>',
            ],
            'startTimestamp' => <DateTime>,
            'tagList' => ['<string>', ...],
            'workflowType' => [
                'name' => '<string>',
                'version' => '<string>',
            ],
        ],
        // ...
    ],
    'nextPageToken' => '<string>',
]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

List tags for a given domain.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

LimitExceededFault:

Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

ListWorkflowTypes

$result = $client->listWorkflowTypes([/* ... */]);
$promise = $client->listWorkflowTypesAsync([/* ... */]);

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->listWorkflowTypes([
    'domain' => '<string>', // REQUIRED
    'maximumPageSize' => <integer>,
    'name' => '<string>',
    'nextPageToken' => '<string>',
    'registrationStatus' => 'REGISTERED|DEPRECATED', // REQUIRED
    'reverseOrder' => true || false,
]);

Parameter Details

Result Syntax

[
    'nextPageToken' => '<string>',
    'typeInfos' => [
        [
            'creationDate' => <DateTime>,
            'deprecationDate' => <DateTime>,
            'description' => '<string>',
            'status' => 'REGISTERED|DEPRECATED',
            'workflowType' => [
                'name' => '<string>',
                'version' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

PollForActivityTask

$result = $client->pollForActivityTask([/* ... */]);
$promise = $client->pollForActivityTaskAsync([/* ... */]);

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.

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->pollForActivityTask([
    'domain' => '<string>', // REQUIRED
    'identity' => '<string>',
    'taskList' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'activityId' => '<string>',
    'activityType' => [
        'name' => '<string>',
        'version' => '<string>',
    ],
    'input' => '<string>',
    'startedEventId' => <integer>,
    'taskToken' => '<string>',
    'workflowExecution' => [
        'runId' => '<string>',
        'workflowId' => '<string>',
    ],
]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

LimitExceededFault:

Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.

PollForDecisionTask

$result = $client->pollForDecisionTask([/* ... */]);
$promise = $client->pollForDecisionTaskAsync([/* ... */]);

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.

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->pollForDecisionTask([
    'domain' => '<string>', // REQUIRED
    'identity' => '<string>',
    'maximumPageSize' => <integer>,
    'nextPageToken' => '<string>',
    'reverseOrder' => true || false,
    'startAtPreviousStartedEvent' => true || false,
    'taskList' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'events' => [
        [
            'activityTaskCancelRequestedEventAttributes' => [
                'activityId' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'activityTaskCanceledEventAttributes' => [
                'details' => '<string>',
                'latestCancelRequestedEventId' => <integer>,
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
            ],
            'activityTaskCompletedEventAttributes' => [
                'result' => '<string>',
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
            ],
            'activityTaskFailedEventAttributes' => [
                'details' => '<string>',
                'reason' => '<string>',
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
            ],
            'activityTaskScheduledEventAttributes' => [
                'activityId' => '<string>',
                'activityType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'heartbeatTimeout' => '<string>',
                'input' => '<string>',
                'scheduleToCloseTimeout' => '<string>',
                'scheduleToStartTimeout' => '<string>',
                'startToCloseTimeout' => '<string>',
                'taskList' => [
                    'name' => '<string>',
                ],
                'taskPriority' => '<string>',
            ],
            'activityTaskStartedEventAttributes' => [
                'identity' => '<string>',
                'scheduledEventId' => <integer>,
            ],
            'activityTaskTimedOutEventAttributes' => [
                'details' => '<string>',
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
                'timeoutType' => 'START_TO_CLOSE|SCHEDULE_TO_START|SCHEDULE_TO_CLOSE|HEARTBEAT',
            ],
            'cancelTimerFailedEventAttributes' => [
                'cause' => 'TIMER_ID_UNKNOWN|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
                'timerId' => '<string>',
            ],
            'cancelWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'UNHANDLED_DECISION|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'childWorkflowExecutionCanceledEventAttributes' => [
                'details' => '<string>',
                'initiatedEventId' => <integer>,
                'startedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'childWorkflowExecutionCompletedEventAttributes' => [
                'initiatedEventId' => <integer>,
                'result' => '<string>',
                'startedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'childWorkflowExecutionFailedEventAttributes' => [
                'details' => '<string>',
                'initiatedEventId' => <integer>,
                'reason' => '<string>',
                'startedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'childWorkflowExecutionStartedEventAttributes' => [
                'initiatedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'childWorkflowExecutionTerminatedEventAttributes' => [
                'initiatedEventId' => <integer>,
                'startedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'childWorkflowExecutionTimedOutEventAttributes' => [
                'initiatedEventId' => <integer>,
                'startedEventId' => <integer>,
                'timeoutType' => 'START_TO_CLOSE',
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'completeWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'UNHANDLED_DECISION|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'continueAsNewWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'UNHANDLED_DECISION|WORKFLOW_TYPE_DEPRECATED|WORKFLOW_TYPE_DOES_NOT_EXIST|DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED|DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED|DEFAULT_TASK_LIST_UNDEFINED|DEFAULT_CHILD_POLICY_UNDEFINED|CONTINUE_AS_NEW_WORKFLOW_EXECUTION_RATE_EXCEEDED|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'decisionTaskCompletedEventAttributes' => [
                'executionContext' => '<string>',
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
                'taskList' => [
                    'name' => '<string>',
                ],
                'taskListScheduleToStartTimeout' => '<string>',
            ],
            'decisionTaskScheduledEventAttributes' => [
                'scheduleToStartTimeout' => '<string>',
                'startToCloseTimeout' => '<string>',
                'taskList' => [
                    'name' => '<string>',
                ],
                'taskPriority' => '<string>',
            ],
            'decisionTaskStartedEventAttributes' => [
                'identity' => '<string>',
                'scheduledEventId' => <integer>,
            ],
            'decisionTaskTimedOutEventAttributes' => [
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
                'timeoutType' => 'START_TO_CLOSE|SCHEDULE_TO_START',
            ],
            'eventId' => <integer>,
            'eventTimestamp' => <DateTime>,
            'eventType' => 'WorkflowExecutionStarted|WorkflowExecutionCancelRequested|WorkflowExecutionCompleted|CompleteWorkflowExecutionFailed|WorkflowExecutionFailed|FailWorkflowExecutionFailed|WorkflowExecutionTimedOut|WorkflowExecutionCanceled|CancelWorkflowExecutionFailed|WorkflowExecutionContinuedAsNew|ContinueAsNewWorkflowExecutionFailed|WorkflowExecutionTerminated|DecisionTaskScheduled|DecisionTaskStarted|DecisionTaskCompleted|DecisionTaskTimedOut|ActivityTaskScheduled|ScheduleActivityTaskFailed|ActivityTaskStarted|ActivityTaskCompleted|ActivityTaskFailed|ActivityTaskTimedOut|ActivityTaskCanceled|ActivityTaskCancelRequested|RequestCancelActivityTaskFailed|WorkflowExecutionSignaled|MarkerRecorded|RecordMarkerFailed|TimerStarted|StartTimerFailed|TimerFired|TimerCanceled|CancelTimerFailed|StartChildWorkflowExecutionInitiated|StartChildWorkflowExecutionFailed|ChildWorkflowExecutionStarted|ChildWorkflowExecutionCompleted|ChildWorkflowExecutionFailed|ChildWorkflowExecutionTimedOut|ChildWorkflowExecutionCanceled|ChildWorkflowExecutionTerminated|SignalExternalWorkflowExecutionInitiated|SignalExternalWorkflowExecutionFailed|ExternalWorkflowExecutionSignaled|RequestCancelExternalWorkflowExecutionInitiated|RequestCancelExternalWorkflowExecutionFailed|ExternalWorkflowExecutionCancelRequested|LambdaFunctionScheduled|LambdaFunctionStarted|LambdaFunctionCompleted|LambdaFunctionFailed|LambdaFunctionTimedOut|ScheduleLambdaFunctionFailed|StartLambdaFunctionFailed',
            'externalWorkflowExecutionCancelRequestedEventAttributes' => [
                'initiatedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
            ],
            'externalWorkflowExecutionSignaledEventAttributes' => [
                'initiatedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
            ],
            'failWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'UNHANDLED_DECISION|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'lambdaFunctionCompletedEventAttributes' => [
                'result' => '<string>',
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
            ],
            'lambdaFunctionFailedEventAttributes' => [
                'details' => '<string>',
                'reason' => '<string>',
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
            ],
            'lambdaFunctionScheduledEventAttributes' => [
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'id' => '<string>',
                'input' => '<string>',
                'name' => '<string>',
                'startToCloseTimeout' => '<string>',
            ],
            'lambdaFunctionStartedEventAttributes' => [
                'scheduledEventId' => <integer>,
            ],
            'lambdaFunctionTimedOutEventAttributes' => [
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
                'timeoutType' => 'START_TO_CLOSE',
            ],
            'markerRecordedEventAttributes' => [
                'decisionTaskCompletedEventId' => <integer>,
                'details' => '<string>',
                'markerName' => '<string>',
            ],
            'recordMarkerFailedEventAttributes' => [
                'cause' => 'OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
                'markerName' => '<string>',
            ],
            'requestCancelActivityTaskFailedEventAttributes' => [
                'activityId' => '<string>',
                'cause' => 'ACTIVITY_ID_UNKNOWN|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'requestCancelExternalWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION|REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED|OPERATION_NOT_PERMITTED',
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'initiatedEventId' => <integer>,
                'runId' => '<string>',
                'workflowId' => '<string>',
            ],
            'requestCancelExternalWorkflowExecutionInitiatedEventAttributes' => [
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'runId' => '<string>',
                'workflowId' => '<string>',
            ],
            'scheduleActivityTaskFailedEventAttributes' => [
                'activityId' => '<string>',
                'activityType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
                'cause' => 'ACTIVITY_TYPE_DEPRECATED|ACTIVITY_TYPE_DOES_NOT_EXIST|ACTIVITY_ID_ALREADY_IN_USE|OPEN_ACTIVITIES_LIMIT_EXCEEDED|ACTIVITY_CREATION_RATE_EXCEEDED|DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED|DEFAULT_TASK_LIST_UNDEFINED|DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED|DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED|DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'scheduleLambdaFunctionFailedEventAttributes' => [
                'cause' => 'ID_ALREADY_IN_USE|OPEN_LAMBDA_FUNCTIONS_LIMIT_EXCEEDED|LAMBDA_FUNCTION_CREATION_RATE_EXCEEDED|LAMBDA_SERVICE_NOT_AVAILABLE_IN_REGION',
                'decisionTaskCompletedEventId' => <integer>,
                'id' => '<string>',
                'name' => '<string>',
            ],
            'signalExternalWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION|SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED|OPERATION_NOT_PERMITTED',
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'initiatedEventId' => <integer>,
                'runId' => '<string>',
                'workflowId' => '<string>',
            ],
            'signalExternalWorkflowExecutionInitiatedEventAttributes' => [
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'input' => '<string>',
                'runId' => '<string>',
                'signalName' => '<string>',
                'workflowId' => '<string>',
            ],
            'startChildWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'WORKFLOW_TYPE_DOES_NOT_EXIST|WORKFLOW_TYPE_DEPRECATED|OPEN_CHILDREN_LIMIT_EXCEEDED|OPEN_WORKFLOWS_LIMIT_EXCEEDED|CHILD_CREATION_RATE_EXCEEDED|WORKFLOW_ALREADY_RUNNING|DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED|DEFAULT_TASK_LIST_UNDEFINED|DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED|DEFAULT_CHILD_POLICY_UNDEFINED|OPERATION_NOT_PERMITTED',
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'initiatedEventId' => <integer>,
                'workflowId' => '<string>',
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'startChildWorkflowExecutionInitiatedEventAttributes' => [
                'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'executionStartToCloseTimeout' => '<string>',
                'input' => '<string>',
                'lambdaRole' => '<string>',
                'tagList' => ['<string>', ...],
                'taskList' => [
                    'name' => '<string>',
                ],
                'taskPriority' => '<string>',
                'taskStartToCloseTimeout' => '<string>',
                'workflowId' => '<string>',
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'startLambdaFunctionFailedEventAttributes' => [
                'cause' => 'ASSUME_ROLE_FAILED',
                'message' => '<string>',
                'scheduledEventId' => <integer>,
            ],
            'startTimerFailedEventAttributes' => [
                'cause' => 'TIMER_ID_ALREADY_IN_USE|OPEN_TIMERS_LIMIT_EXCEEDED|TIMER_CREATION_RATE_EXCEEDED|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
                'timerId' => '<string>',
            ],
            'timerCanceledEventAttributes' => [
                'decisionTaskCompletedEventId' => <integer>,
                'startedEventId' => <integer>,
                'timerId' => '<string>',
            ],
            'timerFiredEventAttributes' => [
                'startedEventId' => <integer>,
                'timerId' => '<string>',
            ],
            'timerStartedEventAttributes' => [
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'startToFireTimeout' => '<string>',
                'timerId' => '<string>',
            ],
            'workflowExecutionCancelRequestedEventAttributes' => [
                'cause' => 'CHILD_POLICY_APPLIED',
                'externalInitiatedEventId' => <integer>,
                'externalWorkflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
            ],
            'workflowExecutionCanceledEventAttributes' => [
                'decisionTaskCompletedEventId' => <integer>,
                'details' => '<string>',
            ],
            'workflowExecutionCompletedEventAttributes' => [
                'decisionTaskCompletedEventId' => <integer>,
                'result' => '<string>',
            ],
            'workflowExecutionContinuedAsNewEventAttributes' => [
                'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
                'decisionTaskCompletedEventId' => <integer>,
                'executionStartToCloseTimeout' => '<string>',
                'input' => '<string>',
                'lambdaRole' => '<string>',
                'newExecutionRunId' => '<string>',
                'tagList' => ['<string>', ...],
                'taskList' => [
                    'name' => '<string>',
                ],
                'taskPriority' => '<string>',
                'taskStartToCloseTimeout' => '<string>',
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'workflowExecutionFailedEventAttributes' => [
                'decisionTaskCompletedEventId' => <integer>,
                'details' => '<string>',
                'reason' => '<string>',
            ],
            'workflowExecutionSignaledEventAttributes' => [
                'externalInitiatedEventId' => <integer>,
                'externalWorkflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'input' => '<string>',
                'signalName' => '<string>',
            ],
            'workflowExecutionStartedEventAttributes' => [
                'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
                'continuedExecutionRunId' => '<string>',
                'executionStartToCloseTimeout' => '<string>',
                'input' => '<string>',
                'lambdaRole' => '<string>',
                'parentInitiatedEventId' => <integer>,
                'parentWorkflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'tagList' => ['<string>', ...],
                'taskList' => [
                    'name' => '<string>',
                ],
                'taskPriority' => '<string>',
                'taskStartToCloseTimeout' => '<string>',
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'workflowExecutionTerminatedEventAttributes' => [
                'cause' => 'CHILD_POLICY_APPLIED|EVENT_LIMIT_EXCEEDED|OPERATOR_INITIATED',
                'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
                'details' => '<string>',
                'reason' => '<string>',
            ],
            'workflowExecutionTimedOutEventAttributes' => [
                'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
                'timeoutType' => 'START_TO_CLOSE',
            ],
        ],
        // ...
    ],
    'nextPageToken' => '<string>',
    'previousStartedEventId' => <integer>,
    'startedEventId' => <integer>,
    'taskToken' => '<string>',
    'workflowExecution' => [
        'runId' => '<string>',
        'workflowId' => '<string>',
    ],
    'workflowType' => [
        'name' => '<string>',
        'version' => '<string>',
    ],
]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

LimitExceededFault:

Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.

RecordActivityTaskHeartbeat

$result = $client->recordActivityTaskHeartbeat([/* ... */]);
$promise = $client->recordActivityTaskHeartbeatAsync([/* ... */]);

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.

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->recordActivityTaskHeartbeat([
    'details' => '<string>',
    'taskToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'cancelRequested' => true || false,
]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

RegisterActivityType

$result = $client->registerActivityType([/* ... */]);
$promise = $client->registerActivityTypeAsync([/* ... */]);

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

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->registerActivityType([
    'defaultTaskHeartbeatTimeout' => '<string>',
    'defaultTaskList' => [
        'name' => '<string>', // REQUIRED
    ],
    'defaultTaskPriority' => '<string>',
    'defaultTaskScheduleToCloseTimeout' => '<string>',
    'defaultTaskScheduleToStartTimeout' => '<string>',
    'defaultTaskStartToCloseTimeout' => '<string>',
    'description' => '<string>',
    'domain' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'version' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

TypeAlreadyExistsFault:

Returned if the type already exists in the specified domain. You may get this fault if you are registering a type that is either already registered or deprecated, or if you undeprecate a type that is currently registered.

LimitExceededFault:

Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

RegisterDomain

$result = $client->registerDomain([/* ... */]);
$promise = $client->registerDomainAsync([/* ... */]);

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->registerDomain([
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>',
        ],
        // ...
    ],
    'workflowExecutionRetentionPeriodInDays' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

DomainAlreadyExistsFault:

Returned if the domain already exists. You may get this fault if you are registering a domain that is either already registered or deprecated, or if you undeprecate a domain that is currently registered.

LimitExceededFault:

Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

TooManyTagsFault:

You've exceeded the number of tags allowed for a domain.

RegisterWorkflowType

$result = $client->registerWorkflowType([/* ... */]);
$promise = $client->registerWorkflowTypeAsync([/* ... */]);

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.

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->registerWorkflowType([
    'defaultChildPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
    'defaultExecutionStartToCloseTimeout' => '<string>',
    'defaultLambdaRole' => '<string>',
    'defaultTaskList' => [
        'name' => '<string>', // REQUIRED
    ],
    'defaultTaskPriority' => '<string>',
    'defaultTaskStartToCloseTimeout' => '<string>',
    'description' => '<string>',
    'domain' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'version' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

TypeAlreadyExistsFault:

Returned if the type already exists in the specified domain. You may get this fault if you are registering a type that is either already registered or deprecated, or if you undeprecate a type that is currently registered.

LimitExceededFault:

Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

RequestCancelWorkflowExecution

$result = $client->requestCancelWorkflowExecution([/* ... */]);
$promise = $client->requestCancelWorkflowExecutionAsync([/* ... */]);

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.

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->requestCancelWorkflowExecution([
    'domain' => '<string>', // REQUIRED
    'runId' => '<string>',
    'workflowId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

RespondActivityTaskCanceled

$result = $client->respondActivityTaskCanceled([/* ... */]);
$promise = $client->respondActivityTaskCanceledAsync([/* ... */]);

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.

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.

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->respondActivityTaskCanceled([
    'details' => '<string>',
    'taskToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

RespondActivityTaskCompleted

$result = $client->respondActivityTaskCompleted([/* ... */]);
$promise = $client->respondActivityTaskCompletedAsync([/* ... */]);

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.

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.

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->respondActivityTaskCompleted([
    'result' => '<string>',
    'taskToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

RespondActivityTaskFailed

$result = $client->respondActivityTaskFailed([/* ... */]);
$promise = $client->respondActivityTaskFailedAsync([/* ... */]);

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.

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.

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->respondActivityTaskFailed([
    'details' => '<string>',
    'reason' => '<string>',
    'taskToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

RespondDecisionTaskCompleted

$result = $client->respondDecisionTaskCompleted([/* ... */]);
$promise = $client->respondDecisionTaskCompletedAsync([/* ... */]);

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->respondDecisionTaskCompleted([
    'decisions' => [
        [
            'cancelTimerDecisionAttributes' => [
                'timerId' => '<string>', // REQUIRED
            ],
            'cancelWorkflowExecutionDecisionAttributes' => [
                'details' => '<string>',
            ],
            'completeWorkflowExecutionDecisionAttributes' => [
                'result' => '<string>',
            ],
            'continueAsNewWorkflowExecutionDecisionAttributes' => [
                'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
                'executionStartToCloseTimeout' => '<string>',
                'input' => '<string>',
                'lambdaRole' => '<string>',
                'tagList' => ['<string>', ...],
                'taskList' => [
                    'name' => '<string>', // REQUIRED
                ],
                'taskPriority' => '<string>',
                'taskStartToCloseTimeout' => '<string>',
                'workflowTypeVersion' => '<string>',
            ],
            'decisionType' => 'ScheduleActivityTask|RequestCancelActivityTask|CompleteWorkflowExecution|FailWorkflowExecution|CancelWorkflowExecution|ContinueAsNewWorkflowExecution|RecordMarker|StartTimer|CancelTimer|SignalExternalWorkflowExecution|RequestCancelExternalWorkflowExecution|StartChildWorkflowExecution|ScheduleLambdaFunction', // REQUIRED
            'failWorkflowExecutionDecisionAttributes' => [
                'details' => '<string>',
                'reason' => '<string>',
            ],
            'recordMarkerDecisionAttributes' => [
                'details' => '<string>',
                'markerName' => '<string>', // REQUIRED
            ],
            'requestCancelActivityTaskDecisionAttributes' => [
                'activityId' => '<string>', // REQUIRED
            ],
            'requestCancelExternalWorkflowExecutionDecisionAttributes' => [
                'control' => '<string>',
                'runId' => '<string>',
                'workflowId' => '<string>', // REQUIRED
            ],
            'scheduleActivityTaskDecisionAttributes' => [
                'activityId' => '<string>', // REQUIRED
                'activityType' => [ // REQUIRED
                    'name' => '<string>', // REQUIRED
                    'version' => '<string>', // REQUIRED
                ],
                'control' => '<string>',
                'heartbeatTimeout' => '<string>',
                'input' => '<string>',
                'scheduleToCloseTimeout' => '<string>',
                'scheduleToStartTimeout' => '<string>',
                'startToCloseTimeout' => '<string>',
                'taskList' => [
                    'name' => '<string>', // REQUIRED
                ],
                'taskPriority' => '<string>',
            ],
            'scheduleLambdaFunctionDecisionAttributes' => [
                'control' => '<string>',
                'id' => '<string>', // REQUIRED
                'input' => '<string>',
                'name' => '<string>', // REQUIRED
                'startToCloseTimeout' => '<string>',
            ],
            'signalExternalWorkflowExecutionDecisionAttributes' => [
                'control' => '<string>',
                'input' => '<string>',
                'runId' => '<string>',
                'signalName' => '<string>', // REQUIRED
                'workflowId' => '<string>', // REQUIRED
            ],
            'startChildWorkflowExecutionDecisionAttributes' => [
                'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
                'control' => '<string>',
                'executionStartToCloseTimeout' => '<string>',
                'input' => '<string>',
                'lambdaRole' => '<string>',
                'tagList' => ['<string>', ...],
                'taskList' => [
                    'name' => '<string>', // REQUIRED
                ],
                'taskPriority' => '<string>',
                'taskStartToCloseTimeout' => '<string>',
                'workflowId' => '<string>', // REQUIRED
                'workflowType' => [ // REQUIRED
                    'name' => '<string>', // REQUIRED
                    'version' => '<string>', // REQUIRED
                ],
            ],
            'startTimerDecisionAttributes' => [
                'control' => '<string>',
                'startToFireTimeout' => '<string>', // REQUIRED
                'timerId' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'executionContext' => '<string>',
    'taskList' => [
        'name' => '<string>', // REQUIRED
    ],
    'taskListScheduleToStartTimeout' => '<string>',
    'taskToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

SignalWorkflowExecution

$result = $client->signalWorkflowExecution([/* ... */]);
$promise = $client->signalWorkflowExecutionAsync([/* ... */]);

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).

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->signalWorkflowExecution([
    'domain' => '<string>', // REQUIRED
    'input' => '<string>',
    'runId' => '<string>',
    'signalName' => '<string>', // REQUIRED
    'workflowId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

StartWorkflowExecution

$result = $client->startWorkflowExecution([/* ... */]);
$promise = $client->startWorkflowExecutionAsync([/* ... */]);

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->startWorkflowExecution([
    'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
    'domain' => '<string>', // REQUIRED
    'executionStartToCloseTimeout' => '<string>',
    'input' => '<string>',
    'lambdaRole' => '<string>',
    'tagList' => ['<string>', ...],
    'taskList' => [
        'name' => '<string>', // REQUIRED
    ],
    'taskPriority' => '<string>',
    'taskStartToCloseTimeout' => '<string>',
    'workflowId' => '<string>', // REQUIRED
    'workflowType' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
        'version' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'runId' => '<string>',
]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

TypeDeprecatedFault:

Returned when the specified activity or workflow type was already deprecated.

WorkflowExecutionAlreadyStartedFault:

Returned by StartWorkflowExecution when an open execution with the same workflowId is already running in the specified domain.

LimitExceededFault:

Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

DefaultUndefinedFault:

The StartWorkflowExecution API action was called without the required parameters set.

Some workflow execution parameters, such as the decision taskList, must be set to start the execution. However, these parameters might have been set as defaults when the workflow type was registered. In this case, you can omit these parameters from the StartWorkflowExecution call and Amazon SWF uses the values defined in the workflow type.

If these parameters aren't set and no default parameters were defined in the workflow type, this error is displayed.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Add a tag to a Amazon SWF domain.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => [ // REQUIRED
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

TooManyTagsFault:

You've exceeded the number of tags allowed for a domain.

LimitExceededFault:

Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

TerminateWorkflowExecution

$result = $client->terminateWorkflowExecution([/* ... */]);
$promise = $client->terminateWorkflowExecutionAsync([/* ... */]);

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.

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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->terminateWorkflowExecution([
    'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
    'details' => '<string>',
    'domain' => '<string>', // REQUIRED
    'reason' => '<string>',
    'runId' => '<string>',
    'workflowId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

UndeprecateActivityType

$result = $client->undeprecateActivityType([/* ... */]);
$promise = $client->undeprecateActivityTypeAsync([/* ... */]);

Undeprecates a previously deprecated activity type. After an activity type has been undeprecated, you can create new tasks of that activity 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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->undeprecateActivityType([
    'activityType' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
        'version' => '<string>', // REQUIRED
    ],
    'domain' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

TypeAlreadyExistsFault:

Returned if the type already exists in the specified domain. You may get this fault if you are registering a type that is either already registered or deprecated, or if you undeprecate a type that is currently registered.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

UndeprecateDomain

$result = $client->undeprecateDomain([/* ... */]);
$promise = $client->undeprecateDomainAsync([/* ... */]);

Undeprecates a previously deprecated domain. After a domain has been undeprecated it can be used to create new workflow executions or register new 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.

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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->undeprecateDomain([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

DomainAlreadyExistsFault:

Returned if the domain already exists. You may get this fault if you are registering a domain that is either already registered or deprecated, or if you undeprecate a domain that is currently registered.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

UndeprecateWorkflowType

$result = $client->undeprecateWorkflowType([/* ... */]);
$promise = $client->undeprecateWorkflowTypeAsync([/* ... */]);

Undeprecates a previously deprecated workflow type. After a workflow type has been undeprecated, you can create new executions of that 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.

  • workflowType.name: String constraint. The key is swf:workflowType.name.

  • workflowType.version: String constraint. The key is swf:workflowType.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 in the Amazon SWF Developer Guide.

Parameter Syntax

$result = $client->undeprecateWorkflowType([
    'domain' => '<string>', // REQUIRED
    'workflowType' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
        'version' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

TypeAlreadyExistsFault:

Returned if the type already exists in the specified domain. You may get this fault if you are registering a type that is either already registered or deprecated, or if you undeprecate a type that is currently registered.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Remove a tag from a Amazon SWF domain.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnknownResourceFault:

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

LimitExceededFault:

Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.