Actions, resources, and condition keys for AWS SQL Workbench
AWS SQL Workbench (service prefix:
sqlworkbench
) 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 AWS SQL Workbench
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 Actions table .
Actions | Description | Access level | Resource types (*required) | Condition keys | Dependent actions |
---|---|---|---|---|---|
AssociateConnectionWithChart [permission only] | Grants permission to associate connection to a chart | Write | |||
AssociateConnectionWithTab [permission only] | Grants permission to associate connection to a tab | Write | |||
AssociateQueryWithTab [permission only] | Grants permission to associate query to a tab | Write | |||
BatchDeleteFolder [permission only] | Grants permission to delete folders on your account | Write | |||
CreateAccount [permission only] | Grants permission to create SQLWorkbench account | Write | |||
CreateChart [permission only] | Grants permission to create new saved chart on your account | Write | |||
CreateConnection [permission only] | Grants permission to create a new connection on your account | Write | |||
CreateFolder [permission only] | Grants permission to create folder on your account | Write | |||
CreateSavedQuery [permission only] | Grants permission to create a new saved query on your account | Write | |||
DeleteChart [permission only] | Grants permission to remove charts on your account | Write | |||
DeleteConnection [permission only] | Grants permission to remove connections on your account | Write | |||
DeleteSavedQuery [permission only] | Grants permission to remove saved queries on your account | Write | |||
DeleteTab [permission only] | Grants permission to remove a tab on your account | Write | |||
DriverExecute [permission only] | Grants permission to execute a query in your redshift cluster | Write | |||
GenerateSession [permission only] | Grants permission to generate a new session on your account | Write | |||
GetAccountInfo [permission only] | Grants permission to get account info | Read | |||
GetAccountSettings [permission only] | Grants permission to get account settings | Read | |||
GetChart [permission only] | Grants permission to get charts on your account | Read | |||
GetConnection [permission only] | Grants permission to get connections on your account | Read | |||
GetSavedQuery [permission only] | Grants permission to get saved query on your account | Read | |||
GetUserInfo [permission only] | Grants permission to get user info | Read | |||
GetUserWorkspaceSettings [permission only] | Grants permission to get workspace settings on your account | Read | |||
ListConnections [permission only] | Grants permission to list the connections on your account | List | |||
ListDatabases [permission only] | Grants permission to list databases of your redshift cluster | List | |||
ListFiles [permission only] | Grants permission to list files and folders | List | |||
ListRedshiftClusters [permission only] | Grants permission to list redshift clusters on your account | List | |||
ListSampleDatabases [permission only] | Grants permission to list sample databases | Read | |||
ListSavedQueryVersions [permission only] | Grants permission to list versions of saved query on your account | List | |||
ListTabs [permission only] | Grants permission to list tabs on your account | List | |||
ListTaggedResources [permission only] | Grants permission to list tagged resources | Read | |||
ListTagsForResource [permission only] | Grants permission to list the tags of an sqlworkbench resource | Read | |||
PutTab [permission only] | Grants permission to create or update a tab on your account | Write | |||
PutUserWorkspaceSettings [permission only] | Grants permission to update workspace settings on your account | Write | |||
TagResource [permission only] | Grants permission to tag an sqlworkbench resource | Tagging | |||
UntagResource [permission only] | Grants permission to untag an sqlworkbench resource | Tagging | |||
UpdateAccountExportSettings [permission only] | Grants permission to update account-wide export settings | Write | |||
UpdateAccountGeneralSettings [permission only] | Grants permission to update general account-wide settings | Write | |||
UpdateChart [permission only] | Grants permission to update a chart on your account | Write | |||
UpdateConnection [permission only] | Grants permission to update a connection on your account | Write | |||
UpdateFileFolder [permission only] | Grants permission to move files on your account | Write | |||
UpdateFolder [permission only] | Grants permission to update a folder's name and details on your account | Write | |||
UpdateSavedQuery [permission only] | Grants permission to update a saved query on your account | Write | |||
Resource types defined by AWS SQL Workbench
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
Resource types table
.
Resource types | ARN | Condition keys |
---|---|---|
connection |
arn:$
{
Partition}:sqlworkbench:$
{
Region}:$
{
Account}:connection/$
{
ResourceId}
|
|
query |
arn:$
{
Partition}:sqlworkbench:$
{
Region}:$
{
Account}:query/$
{
ResourceId}
|
|
chart |
arn:$
{
Partition}:sqlworkbench:$
{
Region}:$
{
Account}:chart/$
{
ResourceId}
|
Condition keys for AWS SQL Workbench
AWS SQL Workbench 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 tags that are passed in the request | String |
aws:ResourceTag/${TagKey} | Filters access by the tags that are associated with the resource | String |
aws:TagKeys | Filters access by the tag keys that are passed in the request | ArrayOfString |