Actions Permission-only actions Resource types Condition keys

Actions, resources, and condition keys for Amazon SQL Workbench

Amazon SQL Workbench (service prefix: sqlworkbench) 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

Actions defined by Amazon SQL Workbench
Permission-only actions for Amazon SQL Workbench
Resource types defined by Amazon SQL Workbench
Condition keys for Amazon SQL Workbench

Actions defined by Amazon SQL Workbench

Amazon SQL Workbench has no API operations that can be used in the Actions element of an IAM policy statement.

Permission-only actions for Amazon SQL Workbench

The following actions are defined by Amazon SQL Workbench but are not directly invocable through any API operation. They can only be used in IAM policy statements to grant or deny permissions.

Actions	Description	Resource types (*required)	Condition keys	Access level
AssociateConnectionWithChart	Grants permission to associate connection to a chart	chart*	aws:ResourceTag/${TagKey}	Write
AssociateConnectionWithChart	Grants permission to associate connection to a chart	connection*	aws:ResourceTag/${TagKey}	Write
AssociateConnectionWithTab	Grants permission to associate connection to a tab	connection*	aws:ResourceTag/${TagKey}	Write
AssociateNotebookWithTab	Grants permission to associate notebook to a tab	notebook*	aws:ResourceTag/${TagKey}	Write
AssociateQueryWithTab	Grants permission to associate query to a tab	query*	aws:ResourceTag/${TagKey}	Write
BatchDeleteFolder	Grants permission to delete folders on your account			Write
BatchGetNotebookCell	Grants permission to get notebook cells content on your account	notebook*	aws:ResourceTag/${TagKey}	Read
CreateAccount	Grants permission to create SQLWorkbench account			Write
CreateChart	Grants permission to create new saved chart on your account	chart*	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Write
CreateConnection	Grants permission to create a new connection on your account	connection*	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Write
CreateFolder	Grants permission to create folder on your account			Write
CreateNotebook	Grants permission to create a new notebook on your account	notebook*	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Write
CreateNotebookCell	Grants permission to create a notebook cell on your account	notebook*	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Write
CreateNotebookFromVersion	Grants permission to create a new notebook from a notebook version on your account	notebook*	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Write
CreateNotebookVersion	Grants permission to create a notebook version on your account	notebook*	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Write
CreateSavedQuery	Grants permission to create a new saved query on your account	query*	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Write
DeleteChart	Grants permission to remove charts on your account	chart*	aws:ResourceTag/${TagKey}	Write
DeleteConnection	Grants permission to remove connections on your account	connection*	aws:ResourceTag/${TagKey}	Write
DeleteNotebook	Grants permission to remove notebooks on your account	notebook*	aws:ResourceTag/${TagKey}	Write
DeleteNotebookCell	Grants permission to remove notebooks cells on your account	notebook*	aws:ResourceTag/${TagKey}	Write
DeleteNotebookVersion	Grants permission to remove notebooks cells on your account	notebook*	aws:ResourceTag/${TagKey}	Write
DeleteQCustomContext	Grants permission to delete account-wide custom context			Write
DeleteSavedQuery	Grants permission to remove saved queries on your account	query*	aws:ResourceTag/${TagKey}	Write
DeleteSqlGenerationContext	Grants permission to delete sql generation context			Write
DeleteTab	Grants permission to remove a tab on your account			Write
DriverExecute	Grants permission to execute a query in your redshift cluster	connection*	aws:ResourceTag/${TagKey}	Write
DuplicateNotebook	Grants permission to create a new notebook by duplicating an existing one on your account	notebook*	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Write
ExportNotebook	Grants permission to export a notebook on your account	notebook*	aws:ResourceTag/${TagKey}	Read
GenerateSession	Grants permission to generate a new session on your account			Write
GetAccountInfo	Grants permission to get account info			Read
GetAccountSettings	Grants permission to get account settings			Read
GetAutocompletionMetadata	Grants permission to get database structure metadata for auto-completion			Read
GetAutocompletionResource	Grants permission to get database structure information for auto-completion			Read
GetChart	Grants permission to get charts on your account	chart*	aws:ResourceTag/${TagKey}	Read
GetConnection	Grants permission to get connections on your account	connection*	aws:ResourceTag/${TagKey}	Read
GetNotebook	Grants permission to get notebook metadata on your account	notebook*	aws:ResourceTag/${TagKey}	Read
GetNotebookVersion	Grants permission to get the content of a notebook version on your account	notebook*	aws:ResourceTag/${TagKey}	Read
GetQCustomContext	Grants permission to get account-wide custom context			Read
GetQSqlPromptQuotas	Grants permission to get Q generative SQL maximum prompt quotas			Read
GetQSqlRecommendations	Grants permission to get text to SQL recommendations			Read
GetQueryExecutionHistory	Grants permission to get the query execution history on your account			Read
GetSavedQuery	Grants permission to get saved query on your account	query*	aws:ResourceTag/${TagKey}	Read
GetSchemaInference	Grants permission to get the columns and data types inferred from a file			Read
GetSqlGenerationContext	Grants permission to get sql generation context			Read
GetSqlRecommendations	Grants permission to get text to SQL recommendations			Read
GetUserInfo	Grants permission to get user info			Read
GetUserWorkspaceSettings	Grants permission to get workspace settings on your account			Read
ImportNotebook	Grants permission to import a notebook on your account	notebook*	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Write
ListConnections	Grants permission to list the connections on your account			List
ListDatabases	Grants permission to list databases of your redshift cluster			List
ListFiles	Grants permission to list files and folders			List
ListNotebookVersions	Grants permission to get notebook versions metadata on your account	notebook*	aws:ResourceTag/${TagKey}	List
ListNotebooks	Grants permission to list the notebooks on your account			List
ListQueryExecutionHistory	Grants permission to list the query execution history on your account			List
ListRedshiftClusters	Grants permission to list redshift clusters on your account			List
ListSampleDatabases	Grants permission to list sample databases			Read
ListSavedQueryVersions	Grants permission to list versions of saved query on your account	query*	aws:ResourceTag/${TagKey}	List
ListTabs	Grants permission to list tabs on your account			List
ListTaggedResources	Grants permission to list tagged resources			Read
ListTagsForResource	Grants permission to list the tags of an sqlworkbench resource	chart	aws:ResourceTag/${TagKey}	Read
		connection	aws:ResourceTag/${TagKey}
		notebook	aws:ResourceTag/${TagKey}
		query	aws:ResourceTag/${TagKey}
PassAccountSettings	Grants permission to provide account settings with the request			Write
PutQCustomContext	Grants permission to update account-wide custom context			Write
PutSqlGenerationContext	Grants permission to update sql generation context			Write
PutTab	Grants permission to create or update a tab on your account			Write
PutUserWorkspaceSettings	Grants permission to update workspace settings on your account			Write
RestoreNotebookVersion	Grants permission to restore a notebook on your account to a version	notebook*	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Write
TagResource	Grants permission to tag an sqlworkbench resource	chart	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Tagging, Write
		connection	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys
		notebook	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys
		query	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys
UntagResource	Grants permission to untag an sqlworkbench resource	chart	aws:ResourceTag/${TagKey} aws:TagKeys	Tagging, Write
		connection	aws:ResourceTag/${TagKey} aws:TagKeys
		notebook	aws:ResourceTag/${TagKey} aws:TagKeys
		query	aws:ResourceTag/${TagKey} aws:TagKeys
UpdateAccountConnectionSettings	Grants permission to update account-wide connection settings			Write
UpdateAccountExportSettings	Grants permission to update account-wide export settings			Write
UpdateAccountGeneralSettings	Grants permission to update account-wide general settings			Write
UpdateAccountQSqlSettings	Grants permission to update account-wide text to SQL settings			Write
UpdateChart	Grants permission to update a chart on your account	chart*	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Write
UpdateConnection	Grants permission to update a connection on your account	connection*	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Write
UpdateFileFolder	Grants permission to move files on your account	chart	aws:ResourceTag/${TagKey}	Write
UpdateFileFolder	Grants permission to move files on your account	query	aws:ResourceTag/${TagKey}	Write
UpdateFolder	Grants permission to update a folder's name and details on your account			Write
UpdateNotebook	Grants permission to update a notebook metadata on your account	notebook*	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Write
UpdateNotebookCellContent	Grants permission to update a notebook cell content on your account	notebook*	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Write
UpdateNotebookCellLayout	Grants permission to update a notebook cell layout on your account	notebook*	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Write
UpdateSavedQuery	Grants permission to update a saved query on your account	query*	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Write

Resource types defined by Amazon SQL Workbench

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
chart	arn:${Partition}:sqlworkbench:${Region}:${Account}:chart/${ResourceId}	aws:ResourceTag/${TagKey}
connection	arn:${Partition}:sqlworkbench:${Region}:${Account}:connection/${ResourceId}	aws:ResourceTag/${TagKey}
notebook	arn:${Partition}:sqlworkbench:${Region}:${Account}:notebook/${ResourceId}	aws:ResourceTag/${TagKey}
query	arn:${Partition}:sqlworkbench:${Region}:${Account}:query/${ResourceId}	aws:ResourceTag/${TagKey}

Condition keys for Amazon SQL Workbench

Amazon SQL Workbench defines the following condition keys that can be used in the Condition element of an IAM policy.

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

Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Amazon Snowball (snowball)

Amazon Step Functions (states)