Actions, resources, and condition keys for Data Pipeline - Service Authorization Reference

# Actions, resources, and condition keys for Data Pipeline

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.

Topics

- Actions defined by Data Pipeline
- Resource types defined by Data Pipeline
- Condition keys for Data Pipeline

## Actions defined by 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 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 The actions table .

Actions | Description | Access level | Resource types (*required) | Condition keys | Dependent actions
--- | --- | --- | --- | --- | ---
ActivatePipeline | Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails. | Write |  | datapipeline:PipelineCreator datapipeline:Tag datapipeline:workerGroup |
AddTags | Adds or modifies tags for the specified pipeline. | Tagging |  | datapipeline:PipelineCreator datapipeline:Tag |
CreatePipeline | Creates a new, empty pipeline. | Write |  | datapipeline:Tag |
DeactivatePipeline | Deactivates the specified running pipeline. | Write |  | datapipeline:PipelineCreator datapipeline:Tag datapipeline:workerGroup |
DeletePipeline | Deletes a pipeline, its pipeline definition, and its run history. | Write |  | datapipeline:PipelineCreator datapipeline:Tag |
DescribeObjects | Gets the object definitions for a set of objects associated with the pipeline. | Read |  | datapipeline:PipelineCreator datapipeline:Tag |
DescribePipelines | Retrieves metadata about one or more pipelines. | List |  | datapipeline:PipelineCreator datapipeline:Tag |
EvaluateExpression | Task runners call EvaluateExpression to evaluate a string in the context of the specified object. | Read |  | datapipeline:PipelineCreator datapipeline:Tag |
GetAccountLimits | Description for GetAccountLimits | List |  |  |
GetPipelineDefinition | Gets the definition of the specified pipeline. | Read |  | datapipeline:PipelineCreator datapipeline:Tag datapipeline:workerGroup |
ListPipelines | Lists the pipeline identifiers for all active pipelines that you have permission to access. | List |  |  |
PollForTask | Task runners call PollForTask to receive a task to perform from AWS Data Pipeline. | Write |  | datapipeline:workerGroup |
PutAccountLimits | Description for PutAccountLimits | Write |  |  |
PutPipelineDefinition | Adds tasks, schedules, and preconditions to the specified pipeline. | Write |  | datapipeline:PipelineCreator datapipeline:Tag datapipeline:workerGroup |
QueryObjects | Queries the specified pipeline for the names of objects that match the specified set of conditions. | Read |  | datapipeline:PipelineCreator datapipeline:Tag |
RemoveTags | Removes existing tags from the specified pipeline. | Tagging |  | datapipeline:PipelineCreator datapipeline:Tag |
ReportTaskProgress | Task runners call ReportTaskProgress when assigned a task to acknowledge that it has the task. | Write |  |  |
ReportTaskRunnerHeartbeat | Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. | Write |  |  |
SetStatus | Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline. | Write |  | datapipeline:PipelineCreator datapipeline:Tag |
SetTaskStatus | Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide information about the final status. | Write |  |  |
ValidatePipelineDefinition | Validates the specified pipeline definition to ensure that it is well formed and can be run without error. | Read |  | datapipeline:PipelineCreator datapipeline:Tag datapipeline:workerGroup |

## Resource types defined by Data Pipeline

Data Pipeline does not support specifying a resource ARN in the `Resource` element of an IAM policy statement. To allow access to Data Pipeline, specify `“Resource”: “*”` in your policy.

## Condition keys for Data Pipeline

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 The condition keys table .

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

Condition keys | Description | Type
--- | --- | ---
datapipeline:PipelineCreator | The IAM user that created the pipeline. | ARN
datapipeline:Tag | A customer-specified key/value pair that can be attached to a resource. | ARN
datapipeline:workerGroup | The name of a worker group for which a Task Runner retrieves work. | ARN

Did this page help you? - Yes

Thanks for letting us know we're doing a good job!

If you've got a moment, please tell us what we did right so we can do more of it.

Did this page help you? - No

Thanks for letting us know this page needs work. We're sorry we let you down.

If you've got a moment, please tell us how we can make the documentation better.