Actions, resources, and condition keys for Amazon Redshift Data API
Amazon Redshift Data API (service prefix: redshift-data) 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 Amazon Redshift Data API
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 |
|---|---|---|---|---|---|
| BatchExecuteStatement | Grants permission to execute multiple queries under a single connection | Write | |||
| CancelStatement | Grants permission to cancel a running query | Write | |||
| DescribeStatement | Grants permission to retrieve detailed information about a statement execution | Read | |||
| DescribeTable | Grants permission to retrieve metadata about a particular table | Read | |||
| ExecuteStatement | Grants permission to execute a query | Write | |||
| GetStagingBucketLocation | Grants permission to get staging bucket location for a given managed workgroup | Read | |||
| GetStatementResult | Grants permission to fetch the result of a query | Read | |||
| ListDatabases | Grants permission to list databases for a given cluster | Read | |||
| ListSchemas | Grants permission to list schemas for a given cluster | Read | |||
| ListStatements | Grants permission to list queries for a given principal | List | |||
| ListTables | Grants permission to list tables for a given cluster | List | |||
Resource types defined by Amazon Redshift Data API
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 |
|---|---|---|
| cluster |
arn:${Partition}:redshift:${Region}:${Account}:cluster:${ClusterName}
|
|
| workgroup |
arn:${Partition}:redshift-serverless:${Region}:${Account}:workgroup/${WorkgroupId}
|
|
| managed-workgroup |
arn:${Partition}:redshift-serverless:${Region}:${Account}:managed-workgroup/${ManagedWorkgroupId}
|
Condition keys for Amazon Redshift Data API
Amazon Redshift Data API 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:ResourceTag/${TagKey} | Filters access by tag-value associated with the resource | String |
| redshift-data:glue-catalog-arn | Filters access by glue catalog arn | ARN |
| redshift-data:session-owner-iam-userid | Filters access by session owner iam userid | String |
| redshift-data:statement-owner-iam-userid | Filters access by statement owner iam userid | String |
