Actions, resources, and condition keys for AWS Step Functions - Service Authorization Reference

Actions, resources, and condition keys for AWS Step Functions

AWS Step Functions (service prefix: states) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.

References:

Actions defined by AWS Step Functions

You can specify the following actions in the Action element of an IAM policy statement. Use policies to grant permissions to perform an operation in AWS. When you use an action in a policy, you usually allow or deny access to the API operation or CLI command with the same name. However, in some cases, a single action controls access to more than one operation. Alternatively, some operations require several different actions.

The Resource types column indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") in the Resource element of your policy statement. If the column includes a resource type, then you can specify an ARN of that type in a statement with that action. Required resources are indicated in the table with an asterisk (*). If you specify a resource-level permission ARN in a statement using this action, then it must be of this type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one but not the other.

For details about the columns in the following table, see Actions table.

Actions Description Access level Resource types (*required) Condition keys Dependent actions
CreateActivity Grants permission to create an activity Write

activity*

aws:RequestTag/${TagKey}

aws:TagKeys

CreateStateMachine Grants permission to create a state machine Write

statemachine*

aws:RequestTag/${TagKey}

aws:TagKeys

DeleteActivity Grants permission to delete an activity Write

activity*

DeleteStateMachine Grants permission to delete a state machine Write

statemachine*

DescribeActivity Grants permission to describe an activity Read

activity*

DescribeExecution Grants permission to describe an execution Read

execution*

DescribeStateMachine Grants permission to describe a state machine Read

statemachine*

DescribeStateMachineForExecution Grants permission to describe the state machine for an execution Read

execution*

GetActivityTask Grants permission to be used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine Write

activity*

GetExecutionHistory Grants permission to return the history of the specified execution as a list of events Read

execution*

ListActivities Grants permission to list the existing activities List
ListExecutions Grants permission to list the executions of a state machine Read

statemachine*

ListStateMachines Grants permission to lists the existing state machines List
ListTagsForResource Grants permission to list tags for an AWS Step Functions resource Read

activity

statemachine

SendTaskFailure Grants permission to report that the task identified by the taskToken failed Write
SendTaskHeartbeat Grants permission to report to the service that the task represented by the specified taskToken is still making progress Write
SendTaskSuccess Grants permission to report that the task identified by the taskToken completed successfully Write
StartExecution Grants permission to start a state machine execution Write

statemachine*

StartSyncExecution Grants permission to start a Synchronous Express state machine execution Write

statemachine*

StopExecution Grants permission to stop an execution Write

execution*

TagResource Grants permission to tag an AWS Step Functions resource Tagging

activity

statemachine

aws:TagKeys

aws:RequestTag/${TagKey}

UntagResource Grants permission to remove a tag from an AWS Step Functions resource Tagging

activity

statemachine

aws:TagKeys

UpdateStateMachine Grants permission to update a state machine Write

statemachine*

aws:RequestTag/${TagKey}

aws:TagKeys

Resource types defined by AWS Step Functions

The following resource types are defined by this service and can be used in the Resource element of IAM permission policy statements. Each action in the Actions table identifies the resource types that can be specified with that action. A resource type can also define which condition keys you can include in a policy. These keys are displayed in the last column of the table. For details about the columns in the following table, see Resource types table.

Resource types ARN Condition keys
activity arn:${Partition}:states:${Region}:${Account}:activity:${ActivityName}

aws:ResourceTag/${TagKey}

execution arn:${Partition}:states:${Region}:${Account}:execution:${StateMachineName}:${ExecutionId}
statemachine arn:${Partition}:states:${Region}:${Account}:stateMachine:${StateMachineName}

aws:ResourceTag/${TagKey}

Condition keys for AWS Step Functions

AWS Step Functions defines the following condition keys that can be used in the Condition element of an IAM policy. You can use these keys to further refine the conditions under which the policy statement applies. For details about the columns in the following table, see Condition keys table.

To view the global condition keys that are available to all services, see Available global condition keys.

Condition keys Description Type
aws:RequestTag/${TagKey} Filters access by a tag key and value pair that is allowed in the request String
aws:ResourceTag/${TagKey} Filters access by a tag key and value pair of a resource String
aws:TagKeys Filters access by a list of tag keys that are allowed in the request String