Actions, resources, and condition keys for Amazon Athena
Amazon Athena (service prefix:
athena
) 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 Athena
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 |
---|---|---|---|---|---|
BatchGetNamedQuery | Grants permissions to get information about one or more named queries | Read | |||
BatchGetQueryExecution | Grants permissions to get information about one or more query executions | Read | |||
CreateDataCatalog | Grants permissions to create a datacatalog | Write | |||
CreateNamedQuery | Grants permissions to create a named query | Write | |||
CreatePreparedStatement | Grants permissions to create a prepared statement. | Write | |||
CreateWorkGroup | Grants permissions to create a workgroup | Write | |||
DeleteDataCatalog | Grants permissions to delete a datacatalog | Write | |||
DeleteNamedQuery | Grants permissions to delete a named query specified | Write | |||
DeletePreparedStatement | Grants permissions to delete a prepared statement specified. | Write | |||
DeleteWorkGroup | Grants permissions to delete a workgroup | Write | |||
GetDataCatalog | Grants permissions to get a datacatalog | Read | |||
GetDatabase | Grants permissions to get a database for a given datacatalog | Read | |||
GetNamedQuery | Grants permissions to get information about the specified named query | Read | |||
GetPreparedStatement | Grants permissions to get information about the specified prepared statement. | Read | |||
GetQueryExecution | Grants permissions to get information about the specified query execution | Read | |||
GetQueryResults | Grants permissions to get the query results | Read | |||
GetQueryResultsStream | Grants permissions to get the query results stream | Read | |||
GetTableMetadata | Grants permissions to get a metadata about a table for a given datacatalog | Read | |||
GetWorkGroup | Grants permissions to get a workgroup | Read | |||
ListDataCatalogs | Grants permissions to return a list of datacatalogs for the specified AWS account | List | |||
ListDatabases | Grants permissions to return a list of databases for a given datacatalog | List | |||
ListEngineVersions | Grants permissions to return a list of athena engine versions for the specified AWS account | Read | |||
ListNamedQueries | Grants permissions to return a list of named queries in Amazon Athena for the specified AWS account | List | |||
ListPreparedStatements | Grants permissions to return a list of prepared statements for the specified workgroup. | List | |||
ListQueryExecutions | Grants permissions to return a list of query executions for the specified AWS account | Read | |||
ListTableMetadata | Grants permissions to return a list of table metadata in a database for a given datacatalog | Read | |||
ListTagsForResource | Grants permissions to return a list of tags for a resource | Read | |||
ListWorkGroups | Grants permissions to return a list of workgroups for the specified AWS account | List | |||
StartQueryExecution | Grants permissions to start a query execution using an SQL query provided as a string | Write | |||
StopQueryExecution | Grants permissions to stop the specified query execution | Write | |||
TagResource | Grants permissions to add a tag to a resource | Tagging | |||
UntagResource | Grants permissions to remove a tag from a resource | Tagging | |||
UpdateDataCatalog | Grants permissions to update a datacatalog | Write | |||
UpdatePreparedStatement | Grants permissions to update a prepared statement. | Write | |||
UpdateWorkGroup | Grants permissions to update a workgroup | Write |
Resource types defined by Amazon Athena
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
The resource types table
.
Resource types | ARN | Condition keys |
---|---|---|
datacatalog |
arn:$
{
Partition}:athena:$
{
Region}:$
{
Account}:datacatalog/$
{
DataCatalogName}
|
|
workgroup |
arn:$
{
Partition}:athena:$
{
Region}:$
{
Account}:workgroup/$
{
WorkGroupName}
|
Condition keys for Amazon Athena
Amazon Athena 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 |
---|---|---|
aws:RequestTag/${TagKey} | Filters actions based on the presence of tag key-value pairs in the request | String |
aws:ResourceTag/${TagKey} | Filters actions based on tag key-value pairs attached to the resource | String |
aws:TagKeys | Filters actions based on the presence of tag keys in the request | String |