Actions, resources, and condition keys for AWS Data Pipeline

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

References:

• Learn how to configure this service.

• View a list of the API operations available for this service.

• Learn how to secure this service and its resources by using IAM permission policies.

Actions defined by AWS Data Pipeline

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 of the Actions table indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") to which the policy applies 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. If the action has one or more required resources, the caller must have permission to use the action with those resources. Required resources are indicated in the table with an asterisk (*). If you limit resource access with the Resource element in an IAM policy, you must include an ARN or pattern for each required resource type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one of the optional resource types.

The Condition keys column of the Actions table includes keys that you can specify in a policy statement's Condition element. For more information on the condition keys that are associated with resources for the service, see the Condition keys column of the Resource types table.

Note

Resource condition keys are listed in the Resource types table. You can find a link to the resource type that applies to an action in the Resource types (*required) column of the Actions table. The resource type in the Resource types table includes the Condition keys column, which are the resource condition keys that apply to an action in the Actions table.

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

Actions	Description	Access level	Resource types (*required)	Condition keys	Dependent actions
ActivatePipeline	Grants permission to validate the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails	Write	pipeline*
				datapipeline:PipelineCreator datapipeline:Tag datapipeline:workerGroup
AddTags	Grants permission to add or modify tags for the specified pipeline	Tagging	pipeline*
				datapipeline:PipelineCreator datapipeline:Tag aws:TagKeys aws:RequestTag/${TagKey}
CreatePipeline	Grants permission to create a new, empty pipeline	Write		aws:RequestTag/${TagKey} aws:TagKeys datapipeline:Tag	datapipeline:AddTags
DeactivatePipeline	Grants permission to Deactivate the specified running pipeline	Write	pipeline*
				datapipeline:PipelineCreator datapipeline:Tag datapipeline:workerGroup
DeletePipeline	Grants permission to delete a pipeline, its pipeline definition, and its run history	Write	pipeline*
				datapipeline:PipelineCreator datapipeline:Tag
DescribeObjects	Grants permission to get the object definitions for a set of objects associated with the pipeline	Read	pipeline*
				datapipeline:PipelineCreator datapipeline:Tag
DescribePipelines	Grants permission to retrieves metadata about one or more pipelines	Read	pipeline*
				datapipeline:PipelineCreator datapipeline:Tag
EvaluateExpression	Grants permission to task runners to call EvaluateExpression, to evaluate a string in the context of the specified object	Read	pipeline*
				datapipeline:PipelineCreator datapipeline:Tag
GetAccountLimits [permission only]	Grants permission to call GetAccountLimits	List
GetPipelineDefinition	Grants permission to gets the definition of the specified pipeline	Read	pipeline*
				datapipeline:PipelineCreator datapipeline:Tag datapipeline:workerGroup
ListPipelines	Grants permission to list the pipeline identifiers for all active pipelines that you have permission to access	List
PollForTask	Grants permission to task runners to call PollForTask, to receive a task to perform from AWS Data Pipeline	Write		datapipeline:workerGroup
PutAccountLimits [permission only]	Grants permission to call PutAccountLimits	Write
PutPipelineDefinition	Grants permission to add tasks, schedules, and preconditions to the specified pipeline	Write	pipeline*
				datapipeline:PipelineCreator datapipeline:Tag datapipeline:workerGroup
QueryObjects	Grants permission to query the specified pipeline for the names of objects that match the specified set of conditions	Read	pipeline*
				datapipeline:PipelineCreator datapipeline:Tag
RemoveTags	Grants permission to remove existing tags from the specified pipeline	Tagging	pipeline*
				datapipeline:PipelineCreator datapipeline:Tag aws:TagKeys aws:RequestTag/${TagKey}
ReportTaskProgress	Grants permission to task runners to call ReportTaskProgress, when they are assigned a task to acknowledge that it has the task	Write	pipeline*
ReportTaskRunnerHeartbeat	Grants permission to task runners to call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational	Write
SetStatus	Grants permission to requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline	Write	pipeline*
				datapipeline:PipelineCreator datapipeline:Tag
SetTaskStatus	Grants permission to task runners to call SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide information about the final status	Write	pipeline*
ValidatePipelineDefinition	Grants permission to validate the specified pipeline definition to ensure that it is well formed and can be run without error	Read	pipeline*
				datapipeline:PipelineCreator datapipeline:Tag datapipeline:workerGroup

Resource types defined by AWS Data Pipeline

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 Resource types table. For details about the columns in the following table, see Resource types table.

Resource types	ARN	Condition keys
pipeline	arn:${Partition}:datapipeline:${Region}:${Account}:pipeline/${PipelineId}	aws:ResourceTag/${TagKey}

Condition keys for AWS Data Pipeline

AWS Data Pipeline 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 the presence of tag key-value pairs in the request	String
aws:ResourceTag/${TagKey}	Filters access by tag key-value pairs attached to the resource	String
aws:TagKeys	Filters access by the presence of tag keys in the request	ArrayOfString
datapipeline:PipelineCreator	Filters access by the IAM user that created the pipeline	ArrayOfString
datapipeline:Tag	Filters access by customer-specified key/value pair that can be attached to a resource	ArrayOfString
datapipeline:workerGroup	Filters access by the name of a worker group for which a Task Runner retrieves work	ArrayOfString