Actions, resources, and condition keys for Amazon Redshift Data API
Amazon Redshift Data API (service prefix: redshift-data) provides the following
service-specific operations, resources, actions, and condition 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.
-
View the programmatic service authorization reference
for this service.
Topics
API operations defined by Amazon Redshift Data API
The following table maps API operations to the IAM actions they authorize. Only condition keys that have static values for the given API and action are listed; for the full set of condition keys supported by each action, see the Actions table.
| Operation | IAM action | Condition key | Possible value(s) | Access level |
|---|---|---|---|---|
|
BatchExecuteStatement |
Write |
|||
|
CancelStatement |
Write |
|||
|
DescribeStatement |
Read |
|||
|
DescribeTable |
Read |
|||
|
ExecuteStatement |
Write |
|||
|
GetStatementResult |
Read |
|||
|
GetStatementResultV2 |
Read |
|||
|
ListDatabases |
Read |
|||
|
ListSchemas |
Read |
|||
|
ListStatements |
List |
|||
|
ListTables |
List |
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 Amazon. 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.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
Grants permission to execute multiple queries under a single connection |
Write |
|||
Grants permission to cancel a running query |
Write |
|||
Grants permission to retrieve detailed information about a statement execution |
Read |
|||
Grants permission to retrieve metadata about a particular table |
Read |
|||
Grants permission to execute a query |
Write |
|||
Grants permission to get staging bucket location for a given managed workgroup |
Read |
|||
Grants permission to fetch the result of a query |
Read |
|||
Grants permission to list databases for a given cluster |
Read |
|||
Grants permission to list schemas for a given cluster |
Read |
|||
Grants permission to list queries for a given principal |
List |
|||
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.
| Resource types | ARN | Condition keys |
|---|---|---|
arn:${Partition}:redshift:${Region}:${Account}:cluster:${ClusterName} |
||
arn:${Partition}:redshift-serverless:${Region}:${Account}:managed-workgroup/${ManagedWorkgroupId} |
||
arn:${Partition}:redshift-serverless:${Region}:${Account}:workgroup/${WorkgroupId} |
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.
| Condition keys | Description | Type |
|---|---|---|
Filters access by tag-value associated with the resource |
String |
|
Filters access by glue catalog arn |
ARN |
|
Filters access by session owner iam userid |
String |
|
Filters access by statement owner iam userid |
String |