CreateActivity

$result = $client->createActivity([/* ... */]);
$promise = $client->createActivityAsync([/* ... */]);

Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity.

Parameter Syntax

$result = $client->createActivity([
    'encryptionConfiguration' => [
        'kmsDataKeyReusePeriodSeconds' => <integer>,
        'kmsKeyId' => '<string>',
        'type' => 'AWS_OWNED_KEY|CUSTOMER_MANAGED_KMS_KEY', // REQUIRED
    ],
    'name' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'activityArn' => '<string>',
    'creationDate' => <DateTime>,
]

Result Details

Errors

ActivityLimitExceeded:

The maximum number of activities has been reached. Existing activities must be deleted before a new activity can be created.

ActivityAlreadyExists:

Activity already exists. EncryptionConfiguration may not be updated.

InvalidName:

The provided name is not valid.

TooManyTags:

You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step Functions Developer Guide.

InvalidEncryptionConfiguration:

Received when encryptionConfiguration is specified but various conditions exist which make the configuration invalid. For example, if type is set to CUSTOMER_MANAGED_KMS_KEY, but kmsKeyId is null, or kmsDataKeyReusePeriodSeconds is not between 60 and 900, or the KMS key is not symmetric or inactive.

KmsAccessDeniedException:

Either your KMS key policy or API caller does not have the required permissions.

KmsThrottlingException:

Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.

CreateStateMachine

$result = $client->createStateMachine([/* ... */]);
$promise = $client->createStateMachineAsync([/* ... */]);

Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language in the Step Functions User Guide.

If you set the publish parameter of this API action to true, it publishes version 1 as the first revision of the state machine.

For additional control over security, you can encrypt your data using a customer-managed key for Step Functions state machines. You can configure a symmetric KMS key and data key reuse period when creating or updating a State Machine. The execution history and state machine definition will be encrypted with the key applied to the State Machine.

Parameter Syntax

$result = $client->createStateMachine([
    'definition' => '<string>', // REQUIRED
    'encryptionConfiguration' => [
        'kmsDataKeyReusePeriodSeconds' => <integer>,
        'kmsKeyId' => '<string>',
        'type' => 'AWS_OWNED_KEY|CUSTOMER_MANAGED_KMS_KEY', // REQUIRED
    ],
    'loggingConfiguration' => [
        'destinations' => [
            [
                'cloudWatchLogsLogGroup' => [
                    'logGroupArn' => '<string>',
                ],
            ],
            // ...
        ],
        'includeExecutionData' => true || false,
        'level' => 'ALL|ERROR|FATAL|OFF',
    ],
    'name' => '<string>', // REQUIRED
    'publish' => true || false,
    'roleArn' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'tracingConfiguration' => [
        'enabled' => true || false,
    ],
    'type' => 'STANDARD|EXPRESS',
    'versionDescription' => '<string>',
]);

Parameter Details

Result Syntax

[
    'creationDate' => <DateTime>,
    'stateMachineArn' => '<string>',
    'stateMachineVersionArn' => '<string>',
]

Result Details

Errors

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

InvalidDefinition:

The provided Amazon States Language definition is not valid.

InvalidName:

The provided name is not valid.

InvalidLoggingConfiguration:

Configuration is not valid.

InvalidTracingConfiguration:

Your tracingConfiguration key does not match, or enabled has not been set to true or false.

StateMachineAlreadyExists:

A state machine with the same name but a different definition or role ARN already exists.

StateMachineDeleting:

The specified state machine is being deleted.

StateMachineLimitExceeded:

The maximum number of state machines has been reached. Existing state machines must be deleted before a new state machine can be created.

StateMachineTypeNotSupported:

State machine type is not supported.

TooManyTags:

You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step Functions Developer Guide.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

ConflictException:

Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

HTTP Status Code: 409

InvalidEncryptionConfiguration:

Received when encryptionConfiguration is specified but various conditions exist which make the configuration invalid. For example, if type is set to CUSTOMER_MANAGED_KMS_KEY, but kmsKeyId is null, or kmsDataKeyReusePeriodSeconds is not between 60 and 900, or the KMS key is not symmetric or inactive.

KmsAccessDeniedException:

Either your KMS key policy or API caller does not have the required permissions.

KmsThrottlingException:

Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.

CreateStateMachineAlias

$result = $client->createStateMachineAlias([/* ... */]);
$promise = $client->createStateMachineAliasAsync([/* ... */]);

Creates an alias for a state machine that points to one or two versions of the same state machine. You can set your application to call StartExecution with an alias and update the version the alias uses without changing the client's code.

You can also map an alias to split StartExecution requests between two versions of a state machine. To do this, add a second RoutingConfig object in the routingConfiguration parameter. You must also specify the percentage of execution run requests each version should receive in both RoutingConfig objects. Step Functions randomly chooses which version runs a given execution based on the percentage you specify.

To create an alias that points to a single version, specify a single RoutingConfig object with a weight set to 100.

You can create up to 100 aliases for each state machine. You must delete unused aliases using the DeleteStateMachineAlias API action.

CreateStateMachineAlias is an idempotent API. Step Functions bases the idempotency check on the stateMachineArn, description, name, and routingConfiguration parameters. Requests that contain the same values for these parameters return a successful idempotent response without creating a duplicate resource.

Related operations:

• DescribeStateMachineAlias

• ListStateMachineAliases

• UpdateStateMachineAlias

• DeleteStateMachineAlias

Parameter Syntax

$result = $client->createStateMachineAlias([
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'routingConfiguration' => [ // REQUIRED
        [
            'stateMachineVersionArn' => '<string>', // REQUIRED
            'weight' => <integer>, // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'creationDate' => <DateTime>,
    'stateMachineAliasArn' => '<string>',
]

Result Details

Errors

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

InvalidName:

The provided name is not valid.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

StateMachineDeleting:

The specified state machine is being deleted.

ResourceNotFound:

Could not find the referenced resource.

ConflictException:

Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

HTTP Status Code: 409

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

HTTP Status Code: 402

DeleteActivity

$result = $client->deleteActivity([/* ... */]);
$promise = $client->deleteActivityAsync([/* ... */]);

Deletes an activity.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

DeleteStateMachine

$result = $client->deleteStateMachine([/* ... */]);
$promise = $client->deleteStateMachineAsync([/* ... */]);

Deletes a state machine. This is an asynchronous operation. It sets the state machine's status to DELETING and begins the deletion process. A state machine is deleted only when all its executions are completed. On the next state transition, the state machine's executions are terminated.

A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

The following are some examples of qualified and unqualified state machine ARNs:

• The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine.

  arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel

  If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException.

• The following unqualified state machine ARN refers to a state machine named myStateMachine.

  arn:partition:states:region:account-id:stateMachine:myStateMachine

This API action also deletes all versions and aliases associated with a state machine.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

DeleteStateMachineAlias

$result = $client->deleteStateMachineAlias([/* ... */]);
$promise = $client->deleteStateMachineAliasAsync([/* ... */]);

Deletes a state machine alias.

After you delete a state machine alias, you can't use it to start executions. When you delete a state machine alias, Step Functions doesn't delete the state machine versions that alias references.

Related operations:

• CreateStateMachineAlias

• DescribeStateMachineAlias

• ListStateMachineAliases

• UpdateStateMachineAlias

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

ResourceNotFound:

Could not find the referenced resource.

ConflictException:

Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

HTTP Status Code: 409

DeleteStateMachineVersion

$result = $client->deleteStateMachineVersion([/* ... */]);
$promise = $client->deleteStateMachineVersionAsync([/* ... */]);

Deletes a state machine version. After you delete a version, you can't call StartExecution using that version's ARN or use the version with a state machine alias.

Related operations:

• PublishStateMachineVersion

• ListStateMachineVersions

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

ConflictException:

Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

HTTP Status Code: 409

DescribeActivity

$result = $client->describeActivity([/* ... */]);
$promise = $client->describeActivityAsync([/* ... */]);

Describes an activity.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'activityArn' => '<string>',
    'creationDate' => <DateTime>,
    'encryptionConfiguration' => [
        'kmsDataKeyReusePeriodSeconds' => <integer>,
        'kmsKeyId' => '<string>',
        'type' => 'AWS_OWNED_KEY|CUSTOMER_MANAGED_KMS_KEY',
    ],
    'name' => '<string>',
]

Result Details

Errors

ActivityDoesNotExist:

The specified activity does not exist.

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

DescribeExecution

$result = $client->describeExecution([/* ... */]);
$promise = $client->describeExecutionAsync([/* ... */]);

Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. If you've redriven an execution, you can use this API action to return information about the redrives of that execution. In addition, you can use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was dispatched by a Map Run.

If you specify a version or alias ARN when you call the StartExecution API action, DescribeExecution returns that ARN.

Executions of an EXPRESS state machine aren't supported by DescribeExecution unless a Map Run dispatched them.

Parameter Syntax

$result = $client->describeExecution([
    'executionArn' => '<string>', // REQUIRED
    'includedData' => 'ALL_DATA|METADATA_ONLY',
]);

Parameter Details

Result Syntax

[
    'cause' => '<string>',
    'error' => '<string>',
    'executionArn' => '<string>',
    'input' => '<string>',
    'inputDetails' => [
        'included' => true || false,
    ],
    'mapRunArn' => '<string>',
    'name' => '<string>',
    'output' => '<string>',
    'outputDetails' => [
        'included' => true || false,
    ],
    'redriveCount' => <integer>,
    'redriveDate' => <DateTime>,
    'redriveStatus' => 'REDRIVABLE|NOT_REDRIVABLE|REDRIVABLE_BY_MAP_RUN',
    'redriveStatusReason' => '<string>',
    'startDate' => <DateTime>,
    'stateMachineAliasArn' => '<string>',
    'stateMachineArn' => '<string>',
    'stateMachineVersionArn' => '<string>',
    'status' => 'RUNNING|SUCCEEDED|FAILED|TIMED_OUT|ABORTED|PENDING_REDRIVE',
    'stopDate' => <DateTime>,
    'traceHeader' => '<string>',
]

Result Details

Errors

ExecutionDoesNotExist:

The specified execution does not exist.

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

KmsAccessDeniedException:

Either your KMS key policy or API caller does not have the required permissions.

KmsInvalidStateException:

The KMS key is not in valid state, for example: Disabled or Deleted.

KmsThrottlingException:

Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.

DescribeMapRun

$result = $client->describeMapRun([/* ... */]);
$promise = $client->describeMapRunAsync([/* ... */]);

Provides information about a Map Run's configuration, progress, and results. If you've redriven a Map Run, this API action also returns information about the redrives of that Map Run. For more information, see Examining Map Run in the Step Functions Developer Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'executionArn' => '<string>',
    'executionCounts' => [
        'aborted' => <integer>,
        'failed' => <integer>,
        'failuresNotRedrivable' => <integer>,
        'pending' => <integer>,
        'pendingRedrive' => <integer>,
        'resultsWritten' => <integer>,
        'running' => <integer>,
        'succeeded' => <integer>,
        'timedOut' => <integer>,
        'total' => <integer>,
    ],
    'itemCounts' => [
        'aborted' => <integer>,
        'failed' => <integer>,
        'failuresNotRedrivable' => <integer>,
        'pending' => <integer>,
        'pendingRedrive' => <integer>,
        'resultsWritten' => <integer>,
        'running' => <integer>,
        'succeeded' => <integer>,
        'timedOut' => <integer>,
        'total' => <integer>,
    ],
    'mapRunArn' => '<string>',
    'maxConcurrency' => <integer>,
    'redriveCount' => <integer>,
    'redriveDate' => <DateTime>,
    'startDate' => <DateTime>,
    'status' => 'RUNNING|SUCCEEDED|FAILED|ABORTED',
    'stopDate' => <DateTime>,
    'toleratedFailureCount' => <integer>,
    'toleratedFailurePercentage' => <float>,
]

Result Details

Errors

ResourceNotFound:

Could not find the referenced resource.

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

DescribeStateMachine

$result = $client->describeStateMachine([/* ... */]);
$promise = $client->describeStateMachineAsync([/* ... */]);

Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration.

A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

The following are some examples of qualified and unqualified state machine ARNs:

• The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine.

  arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel

  If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException.

• The following qualified state machine ARN refers to an alias named PROD.

  arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>

  If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.

• The following unqualified state machine ARN refers to a state machine named myStateMachine.

  arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>

This API action returns the details for a state machine version if the stateMachineArn you specify is a state machine version ARN.

Parameter Syntax

$result = $client->describeStateMachine([
    'includedData' => 'ALL_DATA|METADATA_ONLY',
    'stateMachineArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'creationDate' => <DateTime>,
    'definition' => '<string>',
    'description' => '<string>',
    'encryptionConfiguration' => [
        'kmsDataKeyReusePeriodSeconds' => <integer>,
        'kmsKeyId' => '<string>',
        'type' => 'AWS_OWNED_KEY|CUSTOMER_MANAGED_KMS_KEY',
    ],
    'label' => '<string>',
    'loggingConfiguration' => [
        'destinations' => [
            [
                'cloudWatchLogsLogGroup' => [
                    'logGroupArn' => '<string>',
                ],
            ],
            // ...
        ],
        'includeExecutionData' => true || false,
        'level' => 'ALL|ERROR|FATAL|OFF',
    ],
    'name' => '<string>',
    'revisionId' => '<string>',
    'roleArn' => '<string>',
    'stateMachineArn' => '<string>',
    'status' => 'ACTIVE|DELETING',
    'tracingConfiguration' => [
        'enabled' => true || false,
    ],
    'type' => 'STANDARD|EXPRESS',
    'variableReferences' => [
        '<StateName>' => ['<string>', ...],
        // ...
    ],
]

Result Details

Errors

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

StateMachineDoesNotExist:

The specified state machine does not exist.

KmsAccessDeniedException:

Either your KMS key policy or API caller does not have the required permissions.

KmsInvalidStateException:

The KMS key is not in valid state, for example: Disabled or Deleted.

KmsThrottlingException:

Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.

DescribeStateMachineAlias

$result = $client->describeStateMachineAlias([/* ... */]);
$promise = $client->describeStateMachineAliasAsync([/* ... */]);

Returns details about a state machine alias.

Related operations:

• CreateStateMachineAlias

• ListStateMachineAliases

• UpdateStateMachineAlias

• DeleteStateMachineAlias

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'creationDate' => <DateTime>,
    'description' => '<string>',
    'name' => '<string>',
    'routingConfiguration' => [
        [
            'stateMachineVersionArn' => '<string>',
            'weight' => <integer>,
        ],
        // ...
    ],
    'stateMachineAliasArn' => '<string>',
    'updateDate' => <DateTime>,
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

ResourceNotFound:

Could not find the referenced resource.

DescribeStateMachineForExecution

$result = $client->describeStateMachineForExecution([/* ... */]);
$promise = $client->describeStateMachineForExecutionAsync([/* ... */]);

Provides information about a state machine's definition, its execution role ARN, and configuration. If a Map Run dispatched the execution, this action returns the Map Run Amazon Resource Name (ARN) in the response. The state machine returned is the state machine associated with the Map Run.

This API action is not supported by EXPRESS state machines.

Parameter Syntax

$result = $client->describeStateMachineForExecution([
    'executionArn' => '<string>', // REQUIRED
    'includedData' => 'ALL_DATA|METADATA_ONLY',
]);

Parameter Details

Result Syntax

[
    'definition' => '<string>',
    'encryptionConfiguration' => [
        'kmsDataKeyReusePeriodSeconds' => <integer>,
        'kmsKeyId' => '<string>',
        'type' => 'AWS_OWNED_KEY|CUSTOMER_MANAGED_KMS_KEY',
    ],
    'label' => '<string>',
    'loggingConfiguration' => [
        'destinations' => [
            [
                'cloudWatchLogsLogGroup' => [
                    'logGroupArn' => '<string>',
                ],
            ],
            // ...
        ],
        'includeExecutionData' => true || false,
        'level' => 'ALL|ERROR|FATAL|OFF',
    ],
    'mapRunArn' => '<string>',
    'name' => '<string>',
    'revisionId' => '<string>',
    'roleArn' => '<string>',
    'stateMachineArn' => '<string>',
    'tracingConfiguration' => [
        'enabled' => true || false,
    ],
    'updateDate' => <DateTime>,
    'variableReferences' => [
        '<StateName>' => ['<string>', ...],
        // ...
    ],
]

Result Details

Errors

ExecutionDoesNotExist:

The specified execution does not exist.

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

KmsAccessDeniedException:

Either your KMS key policy or API caller does not have the required permissions.

KmsInvalidStateException:

The KMS key is not in valid state, for example: Disabled or Deleted.

KmsThrottlingException:

Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.

GetActivityTask

$result = $client->getActivityTask([/* ... */]);
$promise = $client->getActivityTaskAsync([/* ... */]);

Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string.

Parameter Syntax

$result = $client->getActivityTask([
    'activityArn' => '<string>', // REQUIRED
    'workerName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'input' => '<string>',
    'taskToken' => '<string>',
]

Result Details

Errors

ActivityDoesNotExist:

The specified activity does not exist.

ActivityWorkerLimitExceeded:

The maximum number of workers concurrently polling for activity tasks has been reached.

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

KmsAccessDeniedException:

Either your KMS key policy or API caller does not have the required permissions.

KmsInvalidStateException:

The KMS key is not in valid state, for example: Disabled or Deleted.

KmsThrottlingException:

Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.

GetExecutionHistory

$result = $client->getExecutionHistory([/* ... */]);
$promise = $client->getExecutionHistoryAsync([/* ... */]);

Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

This API action is not supported by EXPRESS state machines.

Parameter Syntax

$result = $client->getExecutionHistory([
    'executionArn' => '<string>', // REQUIRED
    'includeExecutionData' => true || false,
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'reverseOrder' => true || false,
]);

Parameter Details

Result Syntax

[
    'events' => [
        [
            'activityFailedEventDetails' => [
                'cause' => '<string>',
                'error' => '<string>',
            ],
            'activityScheduleFailedEventDetails' => [
                'cause' => '<string>',
                'error' => '<string>',
            ],
            'activityScheduledEventDetails' => [
                'heartbeatInSeconds' => <integer>,
                'input' => '<string>',
                'inputDetails' => [
                    'truncated' => true || false,
                ],
                'resource' => '<string>',
                'timeoutInSeconds' => <integer>,
            ],
            'activityStartedEventDetails' => [
                'workerName' => '<string>',
            ],
            'activitySucceededEventDetails' => [
                'output' => '<string>',
                'outputDetails' => [
                    'truncated' => true || false,
                ],
            ],
            'activityTimedOutEventDetails' => [
                'cause' => '<string>',
                'error' => '<string>',
            ],
            'evaluationFailedEventDetails' => [
                'cause' => '<string>',
                'error' => '<string>',
                'location' => '<string>',
                'state' => '<string>',
            ],
            'executionAbortedEventDetails' => [
                'cause' => '<string>',
                'error' => '<string>',
            ],
            'executionFailedEventDetails' => [
                'cause' => '<string>',
                'error' => '<string>',
            ],
            'executionRedrivenEventDetails' => [
                'redriveCount' => <integer>,
            ],
            'executionStartedEventDetails' => [
                'input' => '<string>',
                'inputDetails' => [
                    'truncated' => true || false,
                ],
                'roleArn' => '<string>',
                'stateMachineAliasArn' => '<string>',
                'stateMachineVersionArn' => '<string>',
            ],
            'executionSucceededEventDetails' => [
                'output' => '<string>',
                'outputDetails' => [
                    'truncated' => true || false,
                ],
            ],
            'executionTimedOutEventDetails' => [
                'cause' => '<string>',
                'error' => '<string>',
            ],
            'id' => <integer>,
            'lambdaFunctionFailedEventDetails' => [
                'cause' => '<string>',
                'error' => '<string>',
            ],
            'lambdaFunctionScheduleFailedEventDetails' => [
                'cause' => '<string>',
                'error' => '<string>',
            ],
            'lambdaFunctionScheduledEventDetails' => [
                'input' => '<string>',
                'inputDetails' => [
                    'truncated' => true || false,
                ],
                'resource' => '<string>',
                'taskCredentials' => [
                    'roleArn' => '<string>',
                ],
                'timeoutInSeconds' => <integer>,
            ],
            'lambdaFunctionStartFailedEventDetails' => [
                'cause' => '<string>',
                'error' => '<string>',
            ],
            'lambdaFunctionSucceededEventDetails' => [
                'output' => '<string>',
                'outputDetails' => [
                    'truncated' => true || false,
                ],
            ],
            'lambdaFunctionTimedOutEventDetails' => [
                'cause' => '<string>',
                'error' => '<string>',
            ],
            'mapIterationAbortedEventDetails' => [
                'index' => <integer>,
                'name' => '<string>',
            ],
            'mapIterationFailedEventDetails' => [
                'index' => <integer>,
                'name' => '<string>',
            ],
            'mapIterationStartedEventDetails' => [
                'index' => <integer>,
                'name' => '<string>',
            ],
            'mapIterationSucceededEventDetails' => [
                'index' => <integer>,
                'name' => '<string>',
            ],
            'mapRunFailedEventDetails' => [
                'cause' => '<string>',
                'error' => '<string>',
            ],
            'mapRunRedrivenEventDetails' => [
                'mapRunArn' => '<string>',
                'redriveCount' => <integer>,
            ],
            'mapRunStartedEventDetails' => [
                'mapRunArn' => '<string>',
            ],
            'mapStateStartedEventDetails' => [
                'length' => <integer>,
            ],
            'previousEventId' => <integer>,
            'stateEnteredEventDetails' => [
                'input' => '<string>',
                'inputDetails' => [
                    'truncated' => true || false,
                ],
                'name' => '<string>',
            ],
            'stateExitedEventDetails' => [
                'assignedVariables' => ['<string>', ...],
                'assignedVariablesDetails' => [
                    'truncated' => true || false,
                ],
                'name' => '<string>',
                'output' => '<string>',
                'outputDetails' => [
                    'truncated' => true || false,
                ],
            ],
            'taskFailedEventDetails' => [
                'cause' => '<string>',
                'error' => '<string>',
                'resource' => '<string>',
                'resourceType' => '<string>',
            ],
            'taskScheduledEventDetails' => [
                'heartbeatInSeconds' => <integer>,
                'parameters' => '<string>',
                'region' => '<string>',
                'resource' => '<string>',
                'resourceType' => '<string>',
                'taskCredentials' => [
                    'roleArn' => '<string>',
                ],
                'timeoutInSeconds' => <integer>,
            ],
            'taskStartFailedEventDetails' => [
                'cause' => '<string>',
                'error' => '<string>',
                'resource' => '<string>',
                'resourceType' => '<string>',
            ],
            'taskStartedEventDetails' => [
                'resource' => '<string>',
                'resourceType' => '<string>',
            ],
            'taskSubmitFailedEventDetails' => [
                'cause' => '<string>',
                'error' => '<string>',
                'resource' => '<string>',
                'resourceType' => '<string>',
            ],
            'taskSubmittedEventDetails' => [
                'output' => '<string>',
                'outputDetails' => [
                    'truncated' => true || false,
                ],
                'resource' => '<string>',
                'resourceType' => '<string>',
            ],
            'taskSucceededEventDetails' => [
                'output' => '<string>',
                'outputDetails' => [
                    'truncated' => true || false,
                ],
                'resource' => '<string>',
                'resourceType' => '<string>',
            ],
            'taskTimedOutEventDetails' => [
                'cause' => '<string>',
                'error' => '<string>',
                'resource' => '<string>',
                'resourceType' => '<string>',
            ],
            'timestamp' => <DateTime>,
            'type' => 'ActivityFailed|ActivityScheduled|ActivityScheduleFailed|ActivityStarted|ActivitySucceeded|ActivityTimedOut|ChoiceStateEntered|ChoiceStateExited|ExecutionAborted|ExecutionFailed|ExecutionStarted|ExecutionSucceeded|ExecutionTimedOut|FailStateEntered|LambdaFunctionFailed|LambdaFunctionScheduled|LambdaFunctionScheduleFailed|LambdaFunctionStarted|LambdaFunctionStartFailed|LambdaFunctionSucceeded|LambdaFunctionTimedOut|MapIterationAborted|MapIterationFailed|MapIterationStarted|MapIterationSucceeded|MapStateAborted|MapStateEntered|MapStateExited|MapStateFailed|MapStateStarted|MapStateSucceeded|ParallelStateAborted|ParallelStateEntered|ParallelStateExited|ParallelStateFailed|ParallelStateStarted|ParallelStateSucceeded|PassStateEntered|PassStateExited|SucceedStateEntered|SucceedStateExited|TaskFailed|TaskScheduled|TaskStarted|TaskStartFailed|TaskStateAborted|TaskStateEntered|TaskStateExited|TaskSubmitFailed|TaskSubmitted|TaskSucceeded|TaskTimedOut|WaitStateAborted|WaitStateEntered|WaitStateExited|MapRunAborted|MapRunFailed|MapRunStarted|MapRunSucceeded|ExecutionRedriven|MapRunRedriven|EvaluationFailed',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ExecutionDoesNotExist:

The specified execution does not exist.

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

InvalidToken:

The provided token is not valid.

KmsAccessDeniedException:

Either your KMS key policy or API caller does not have the required permissions.

KmsInvalidStateException:

The KMS key is not in valid state, for example: Disabled or Deleted.

KmsThrottlingException:

Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.

ListActivities

$result = $client->listActivities([/* ... */]);
$promise = $client->listActivitiesAsync([/* ... */]);

Lists the existing activities.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Parameter Syntax

$result = $client->listActivities([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'activities' => [
        [
            'activityArn' => '<string>',
            'creationDate' => <DateTime>,
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidToken:

The provided token is not valid.

ListExecutions

$result = $client->listExecutions([/* ... */]);
$promise = $client->listExecutionsAsync([/* ... */]);

Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN. Using this API action, you can also list all redriven executions.

You can also provide a state machine alias ARN or version ARN to list the executions associated with a specific alias or version.

Results are sorted by time, with the most recent execution first.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

This API action is not supported by EXPRESS state machines.

Parameter Syntax

$result = $client->listExecutions([
    'mapRunArn' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'redriveFilter' => 'REDRIVEN|NOT_REDRIVEN',
    'stateMachineArn' => '<string>',
    'statusFilter' => 'RUNNING|SUCCEEDED|FAILED|TIMED_OUT|ABORTED|PENDING_REDRIVE',
]);

Parameter Details

Result Syntax

[
    'executions' => [
        [
            'executionArn' => '<string>',
            'itemCount' => <integer>,
            'mapRunArn' => '<string>',
            'name' => '<string>',
            'redriveCount' => <integer>,
            'redriveDate' => <DateTime>,
            'startDate' => <DateTime>,
            'stateMachineAliasArn' => '<string>',
            'stateMachineArn' => '<string>',
            'stateMachineVersionArn' => '<string>',
            'status' => 'RUNNING|SUCCEEDED|FAILED|TIMED_OUT|ABORTED|PENDING_REDRIVE',
            'stopDate' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

InvalidToken:

The provided token is not valid.

StateMachineDoesNotExist:

The specified state machine does not exist.

StateMachineTypeNotSupported:

State machine type is not supported.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFound:

Could not find the referenced resource.

ListMapRuns

$result = $client->listMapRuns([/* ... */]);
$promise = $client->listMapRunsAsync([/* ... */]);

Lists all Map Runs that were started by a given state machine execution. Use this API action to obtain Map Run ARNs, and then call DescribeMapRun to obtain more information, if needed.

Parameter Syntax

$result = $client->listMapRuns([
    'executionArn' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'mapRuns' => [
        [
            'executionArn' => '<string>',
            'mapRunArn' => '<string>',
            'startDate' => <DateTime>,
            'stateMachineArn' => '<string>',
            'stopDate' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ExecutionDoesNotExist:

The specified execution does not exist.

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

InvalidToken:

The provided token is not valid.

ListStateMachineAliases

$result = $client->listStateMachineAliases([/* ... */]);
$promise = $client->listStateMachineAliasesAsync([/* ... */]);

Lists aliases for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first.

To list aliases that reference a state machine version, you can specify the version ARN in the stateMachineArn parameter.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Related operations:

• CreateStateMachineAlias

• DescribeStateMachineAlias

• UpdateStateMachineAlias

• DeleteStateMachineAlias

Parameter Syntax

$result = $client->listStateMachineAliases([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'stateMachineArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'stateMachineAliases' => [
        [
            'creationDate' => <DateTime>,
            'stateMachineAliasArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

InvalidToken:

The provided token is not valid.

ResourceNotFound:

Could not find the referenced resource.

StateMachineDoesNotExist:

The specified state machine does not exist.

StateMachineDeleting:

The specified state machine is being deleted.

ListStateMachineVersions

$result = $client->listStateMachineVersions([/* ... */]);
$promise = $client->listStateMachineVersionsAsync([/* ... */]);

Lists versions for the specified state machine Amazon Resource Name (ARN).

The results are sorted in descending order of the version creation time.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Related operations:

• PublishStateMachineVersion

• DeleteStateMachineVersion

Parameter Syntax

$result = $client->listStateMachineVersions([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'stateMachineArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'stateMachineVersions' => [
        [
            'creationDate' => <DateTime>,
            'stateMachineVersionArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

InvalidToken:

The provided token is not valid.

ListStateMachines

$result = $client->listStateMachines([/* ... */]);
$promise = $client->listStateMachinesAsync([/* ... */]);

Lists the existing state machines.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Parameter Syntax

$result = $client->listStateMachines([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'stateMachines' => [
        [
            'creationDate' => <DateTime>,
            'name' => '<string>',
            'stateMachineArn' => '<string>',
            'type' => 'STANDARD|EXPRESS',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidToken:

The provided token is not valid.

ListTagsForResource

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

List tags for a given resource.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

ResourceNotFound:

Could not find the referenced resource.

PublishStateMachineVersion

$result = $client->publishStateMachineVersion([/* ... */]);
$promise = $client->publishStateMachineVersionAsync([/* ... */]);

Creates a version from the current revision of a state machine. Use versions to create immutable snapshots of your state machine. You can start executions from versions either directly or with an alias. To create an alias, use CreateStateMachineAlias.

You can publish up to 1000 versions for each state machine. You must manually delete unused versions using the DeleteStateMachineVersion API action.

PublishStateMachineVersion is an idempotent API. It doesn't create a duplicate state machine version if it already exists for the current revision. Step Functions bases PublishStateMachineVersion's idempotency check on the stateMachineArn, name, and revisionId parameters. Requests with the same parameters return a successful idempotent response. If you don't specify a revisionId, Step Functions checks for a previously published version of the state machine's current revision.

Related operations:

• DeleteStateMachineVersion

• ListStateMachineVersions

Parameter Syntax

$result = $client->publishStateMachineVersion([
    'description' => '<string>',
    'revisionId' => '<string>',
    'stateMachineArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'creationDate' => <DateTime>,
    'stateMachineVersionArn' => '<string>',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

StateMachineDeleting:

The specified state machine is being deleted.

StateMachineDoesNotExist:

The specified state machine does not exist.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

HTTP Status Code: 402

ConflictException:

Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

HTTP Status Code: 409

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

RedriveExecution

$result = $client->redriveExecution([/* ... */]);
$promise = $client->redriveExecutionAsync([/* ... */]);

Restarts unsuccessful executions of Standard workflows that didn't complete successfully in the last 14 days. These include failed, aborted, or timed out executions. When you redrive an execution, it continues the failed execution from the unsuccessful step and uses the same input. Step Functions preserves the results and execution history of the successful steps, and doesn't rerun these steps when you redrive an execution. Redriven executions use the same state machine definition and execution ARN as the original execution attempt.

For workflows that include an Inline Map or Parallel state, RedriveExecution API action reschedules and redrives only the iterations and branches that failed or aborted.

To redrive a workflow that includes a Distributed Map state whose Map Run failed, you must redrive the parent workflow. The parent workflow redrives all the unsuccessful states, including a failed Map Run. If a Map Run was not started in the original execution attempt, the redriven parent workflow starts the Map Run.

You can redrive executions if your original execution meets the following conditions:

• The execution status isn't SUCCEEDED.

• Your workflow execution has not exceeded the redrivable period of 14 days. Redrivable period refers to the time during which you can redrive a given execution. This period starts from the day a state machine completes its execution.

• The workflow execution has not exceeded the maximum open time of one year. For more information about state machine quotas, see Quotas related to state machine executions.

• The execution event history count is less than 24,999. Redriven executions append their event history to the existing event history. Make sure your workflow execution contains less than 24,999 events to accommodate the ExecutionRedriven history event and at least one other history event.

Parameter Syntax

$result = $client->redriveExecution([
    'clientToken' => '<string>',
    'executionArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'redriveDate' => <DateTime>,
]

Result Details

Errors

ExecutionDoesNotExist:

The specified execution does not exist.

ExecutionNotRedrivable:

The execution Amazon Resource Name (ARN) that you specified for executionArn cannot be redriven.

ExecutionLimitExceeded:

The maximum number of running executions has been reached. Running executions must end or be stopped before a new execution can be started.

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

SendTaskFailure

$result = $client->sendTaskFailure([/* ... */]);
$promise = $client->sendTaskFailureAsync([/* ... */]);

Used by activity workers, Task states using the callback pattern, and optionally Task states using the job run pattern to report that the task identified by the taskToken failed.

For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role.

A caller can mark a task as fail without using any KMS permissions in the execution role if the caller provides a null value for both error and cause fields because no data needs to be encrypted.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

TaskDoesNotExist:

The activity does not exist.

InvalidToken:

The provided token is not valid.

TaskTimedOut:

The task token has either expired or the task associated with the token has already been closed.

KmsAccessDeniedException:

Either your KMS key policy or API caller does not have the required permissions.

KmsInvalidStateException:

The KMS key is not in valid state, for example: Disabled or Deleted.

KmsThrottlingException:

Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.

SendTaskHeartbeat

$result = $client->sendTaskHeartbeat([/* ... */]);
$promise = $client->sendTaskHeartbeatAsync([/* ... */]);

Used by activity workers and Task states using the callback pattern, and optionally Task states using the job run pattern to report to Step Functions that the task represented by the specified taskToken is still making progress. This action resets the Heartbeat clock. The Heartbeat threshold is specified in the state machine's Amazon States Language definition (HeartbeatSeconds). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut entry for activities, or a TaskTimedOut entry for tasks using the job run or callback pattern.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

TaskDoesNotExist:

The activity does not exist.

InvalidToken:

The provided token is not valid.

TaskTimedOut:

The task token has either expired or the task associated with the token has already been closed.

SendTaskSuccess

$result = $client->sendTaskSuccess([/* ... */]);
$promise = $client->sendTaskSuccessAsync([/* ... */]);

Used by activity workers, Task states using the callback pattern, and optionally Task states using the job run pattern to report that the task identified by the taskToken completed successfully.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

TaskDoesNotExist:

The activity does not exist.

InvalidOutput:

The provided JSON output data is not valid.

InvalidToken:

The provided token is not valid.

TaskTimedOut:

The task token has either expired or the task associated with the token has already been closed.

KmsAccessDeniedException:

Either your KMS key policy or API caller does not have the required permissions.

KmsInvalidStateException:

The KMS key is not in valid state, for example: Disabled or Deleted.

KmsThrottlingException:

Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.

StartExecution

$result = $client->startExecution([/* ... */]);
$promise = $client->startExecutionAsync([/* ... */]);

Starts a state machine execution.

A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

The following are some examples of qualified and unqualified state machine ARNs:

• The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine.

  arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel

  If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException.

• The following qualified state machine ARN refers to an alias named PROD.

  arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>

  If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.

• The following unqualified state machine ARN refers to a state machine named myStateMachine.

  arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>

If you start an execution with an unqualified state machine ARN, Step Functions uses the latest revision of the state machine for the execution.

To start executions of a state machine version, call StartExecution and provide the version ARN or the ARN of an alias that points to the version.

Parameter Syntax

$result = $client->startExecution([
    'input' => '<string>',
    'name' => '<string>',
    'stateMachineArn' => '<string>', // REQUIRED
    'traceHeader' => '<string>',
]);

Parameter Details

Result Syntax

[
    'executionArn' => '<string>',
    'startDate' => <DateTime>,
]

Result Details

Errors

ExecutionLimitExceeded:

The maximum number of running executions has been reached. Running executions must end or be stopped before a new execution can be started.

ExecutionAlreadyExists:

The execution has the same name as another execution (but a different input).

Executions with the same name and input are considered idempotent.

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

InvalidExecutionInput:

The provided JSON input data is not valid.

InvalidName:

The provided name is not valid.

StateMachineDoesNotExist:

The specified state machine does not exist.

StateMachineDeleting:

The specified state machine is being deleted.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

KmsAccessDeniedException:

Either your KMS key policy or API caller does not have the required permissions.

KmsInvalidStateException:

The KMS key is not in valid state, for example: Disabled or Deleted.

KmsThrottlingException:

Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.

StartSyncExecution

$result = $client->startSyncExecution([/* ... */]);
$promise = $client->startSyncExecutionAsync([/* ... */]);

Starts a Synchronous Express state machine execution. StartSyncExecution is not available for STANDARD workflows.

Parameter Syntax

$result = $client->startSyncExecution([
    'includedData' => 'ALL_DATA|METADATA_ONLY',
    'input' => '<string>',
    'name' => '<string>',
    'stateMachineArn' => '<string>', // REQUIRED
    'traceHeader' => '<string>',
]);

Parameter Details

Result Syntax

[
    'billingDetails' => [
        'billedDurationInMilliseconds' => <integer>,
        'billedMemoryUsedInMB' => <integer>,
    ],
    'cause' => '<string>',
    'error' => '<string>',
    'executionArn' => '<string>',
    'input' => '<string>',
    'inputDetails' => [
        'included' => true || false,
    ],
    'name' => '<string>',
    'output' => '<string>',
    'outputDetails' => [
        'included' => true || false,
    ],
    'startDate' => <DateTime>,
    'stateMachineArn' => '<string>',
    'status' => 'SUCCEEDED|FAILED|TIMED_OUT',
    'stopDate' => <DateTime>,
    'traceHeader' => '<string>',
]

Result Details

Errors

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

InvalidExecutionInput:

The provided JSON input data is not valid.

InvalidName:

The provided name is not valid.

StateMachineDoesNotExist:

The specified state machine does not exist.

StateMachineDeleting:

The specified state machine is being deleted.

StateMachineTypeNotSupported:

State machine type is not supported.

KmsAccessDeniedException:

Either your KMS key policy or API caller does not have the required permissions.

KmsInvalidStateException:

The KMS key is not in valid state, for example: Disabled or Deleted.

KmsThrottlingException:

Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.

StopExecution

$result = $client->stopExecution([/* ... */]);
$promise = $client->stopExecutionAsync([/* ... */]);

Stops an execution.

This API action is not supported by EXPRESS state machines.

For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role.

A caller can stop an execution without using any KMS permissions in the execution role if the caller provides a null value for both error and cause fields because no data needs to be encrypted.

Parameter Syntax

$result = $client->stopExecution([
    'cause' => '<string>',
    'error' => '<string>',
    'executionArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'stopDate' => <DateTime>,
]

Result Details

Errors

ExecutionDoesNotExist:

The specified execution does not exist.

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

KmsAccessDeniedException:

Either your KMS key policy or API caller does not have the required permissions.

KmsInvalidStateException:

The KMS key is not in valid state, for example: Disabled or Deleted.

KmsThrottlingException:

Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.

TagResource

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

Add a tag to a Step Functions resource.

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

ResourceNotFound:

Could not find the referenced resource.

TooManyTags:

You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step Functions Developer Guide.

TestState

$result = $client->testState([/* ... */]);
$promise = $client->testStateAsync([/* ... */]);

Accepts the definition of a single state and executes it. You can test a state without creating a state machine or updating an existing state machine. Using this API, you can test the following:

• A state's input and output processing data flow

• An Amazon Web Services service integration request and response

• An HTTP Task request and response

You can call this API on only one state at a time. The states that you can test include the following:

• All Task types except Activity

• Pass

• Wait

• Choice

• Succeed

• Fail

The TestState API assumes an IAM role which must contain the required IAM permissions for the resources your state is accessing. For information about the permissions a state might need, see IAM permissions to test a state.

The TestState API can run for up to five minutes. If the execution of a state exceeds this duration, it fails with the States.Timeout error.

TestState doesn't support Activity tasks, .sync or .waitForTaskToken service integration patterns, Parallel, or Map states.

Parameter Syntax

$result = $client->testState([
    'definition' => '<string>', // REQUIRED
    'input' => '<string>',
    'inspectionLevel' => 'INFO|DEBUG|TRACE',
    'revealSecrets' => true || false,
    'roleArn' => '<string>',
    'variables' => '<string>',
]);

Parameter Details

Result Syntax

[
    'cause' => '<string>',
    'error' => '<string>',
    'inspectionData' => [
        'afterArguments' => '<string>',
        'afterInputPath' => '<string>',
        'afterParameters' => '<string>',
        'afterResultPath' => '<string>',
        'afterResultSelector' => '<string>',
        'input' => '<string>',
        'request' => [
            'body' => '<string>',
            'headers' => '<string>',
            'method' => '<string>',
            'protocol' => '<string>',
            'url' => '<string>',
        ],
        'response' => [
            'body' => '<string>',
            'headers' => '<string>',
            'protocol' => '<string>',
            'statusCode' => '<string>',
            'statusMessage' => '<string>',
        ],
        'result' => '<string>',
        'variables' => '<string>',
    ],
    'nextState' => '<string>',
    'output' => '<string>',
    'status' => 'SUCCEEDED|FAILED|RETRIABLE|CAUGHT_ERROR',
]

Result Details

Errors

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

InvalidDefinition:

The provided Amazon States Language definition is not valid.

InvalidExecutionInput:

The provided JSON input data is not valid.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

UntagResource

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

Remove a tag from a Step Functions resource

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

ResourceNotFound:

Could not find the referenced resource.

UpdateMapRun

$result = $client->updateMapRun([/* ... */]);
$promise = $client->updateMapRunAsync([/* ... */]);

Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure.

Parameter Syntax

$result = $client->updateMapRun([
    'mapRunArn' => '<string>', // REQUIRED
    'maxConcurrency' => <integer>,
    'toleratedFailureCount' => <integer>,
    'toleratedFailurePercentage' => <float>,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFound:

Could not find the referenced resource.

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

UpdateStateMachine

$result = $client->updateStateMachine([/* ... */]);
$promise = $client->updateStateMachineAsync([/* ... */]);

Updates an existing state machine by modifying its definition, roleArn, loggingConfiguration, or EncryptionConfiguration. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error.

A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.

A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

The following are some examples of qualified and unqualified state machine ARNs:

• The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine.

  arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel

  If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException.

• The following qualified state machine ARN refers to an alias named PROD.

  arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>

  If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.

• The following unqualified state machine ARN refers to a state machine named myStateMachine.

  arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>

After you update your state machine, you can set the publish parameter to true in the same action to publish a new version. This way, you can opt-in to strict versioning of your state machine.

Parameter Syntax

$result = $client->updateStateMachine([
    'definition' => '<string>',
    'encryptionConfiguration' => [
        'kmsDataKeyReusePeriodSeconds' => <integer>,
        'kmsKeyId' => '<string>',
        'type' => 'AWS_OWNED_KEY|CUSTOMER_MANAGED_KMS_KEY', // REQUIRED
    ],
    'loggingConfiguration' => [
        'destinations' => [
            [
                'cloudWatchLogsLogGroup' => [
                    'logGroupArn' => '<string>',
                ],
            ],
            // ...
        ],
        'includeExecutionData' => true || false,
        'level' => 'ALL|ERROR|FATAL|OFF',
    ],
    'publish' => true || false,
    'roleArn' => '<string>',
    'stateMachineArn' => '<string>', // REQUIRED
    'tracingConfiguration' => [
        'enabled' => true || false,
    ],
    'versionDescription' => '<string>',
]);

Parameter Details

Result Syntax

[
    'revisionId' => '<string>',
    'stateMachineVersionArn' => '<string>',
    'updateDate' => <DateTime>,
]

Result Details

Errors

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

InvalidDefinition:

The provided Amazon States Language definition is not valid.

InvalidLoggingConfiguration:

Configuration is not valid.

InvalidTracingConfiguration:

Your tracingConfiguration key does not match, or enabled has not been set to true or false.

MissingRequiredParameter:

Request is missing a required parameter. This error occurs if both definition and roleArn are not specified.

StateMachineDeleting:

The specified state machine is being deleted.

StateMachineDoesNotExist:

The specified state machine does not exist.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

HTTP Status Code: 402

ConflictException:

Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

HTTP Status Code: 409

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

InvalidEncryptionConfiguration:

Received when encryptionConfiguration is specified but various conditions exist which make the configuration invalid. For example, if type is set to CUSTOMER_MANAGED_KMS_KEY, but kmsKeyId is null, or kmsDataKeyReusePeriodSeconds is not between 60 and 900, or the KMS key is not symmetric or inactive.

KmsAccessDeniedException:

Either your KMS key policy or API caller does not have the required permissions.

KmsThrottlingException:

Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.

UpdateStateMachineAlias

$result = $client->updateStateMachineAlias([/* ... */]);
$promise = $client->updateStateMachineAliasAsync([/* ... */]);

Updates the configuration of an existing state machine alias by modifying its description or routingConfiguration.

You must specify at least one of the description or routingConfiguration parameters to update a state machine alias.

Related operations:

• CreateStateMachineAlias

• DescribeStateMachineAlias

• ListStateMachineAliases

• DeleteStateMachineAlias

Parameter Syntax

$result = $client->updateStateMachineAlias([
    'description' => '<string>',
    'routingConfiguration' => [
        [
            'stateMachineVersionArn' => '<string>', // REQUIRED
            'weight' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'stateMachineAliasArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'updateDate' => <DateTime>,
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

InvalidArn:

The provided Amazon Resource Name (ARN) is not valid.

ResourceNotFound:

Could not find the referenced resource.

ConflictException:

Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

HTTP Status Code: 409

StateMachineDeleting:

The specified state machine is being deleted.

ValidateStateMachineDefinition

$result = $client->validateStateMachineDefinition([/* ... */]);
$promise = $client->validateStateMachineDefinitionAsync([/* ... */]);

Validates the syntax of a state machine definition specified in Amazon States Language (ASL), a JSON-based, structured language.

You can validate that a state machine definition is correct without creating a state machine resource.

Suggested uses for ValidateStateMachineDefinition:

• Integrate automated checks into your code review or Continuous Integration (CI) process to check state machine definitions before starting deployments.

• Run validation from a Git pre-commit hook to verify the definition before committing to your source repository.

Validation will look for problems in your state machine definition and return a result and a list of diagnostic elements.

The result value will be OK when your workflow definition can be successfully created or updated. Note the result can be OK even when diagnostic warnings are present in the response. The result value will be FAIL when the workflow definition contains errors that would prevent you from creating or updating your state machine.

The list of ValidateStateMachineDefinitionDiagnostic data elements can contain zero or more WARNING and/or ERROR elements.

Parameter Syntax

$result = $client->validateStateMachineDefinition([
    'definition' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'severity' => 'ERROR|WARNING',
    'type' => 'STANDARD|EXPRESS',
]);

Parameter Details

Result Syntax

[
    'diagnostics' => [
        [
            'code' => '<string>',
            'location' => '<string>',
            'message' => '<string>',
            'severity' => 'ERROR|WARNING',
        ],
        // ...
    ],
    'result' => 'OK|FAIL',
    'truncated' => true || false,
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.