Actions, resources, and condition keys for Amazon WorkSpaces
Amazon WorkSpaces (service prefix: workspaces) 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 WorkSpaces
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 |
|---|---|---|---|---|
|
AcceptAccountLinkInvitation |
Write |
|||
|
AssociateConnectionAlias |
Write |
|||
|
AssociateIpGroups |
Write |
|||
|
AssociateWorkspaceApplication |
Write |
|||
|
AuthorizeIpRules |
Write |
|||
Write |
||||
|
CopyWorkspaceImage |
Write |
|||
Tagging, Write |
||||
List |
||||
|
CreateAccountLinkInvitation |
Write |
|||
|
CreateConnectClientAddIn |
Write |
|||
|
CreateConnectionAlias |
Write |
|||
Tagging, Write |
||||
|
CreateIpGroup |
Write |
|||
Tagging, Write |
||||
|
CreateStandbyWorkspaces |
Write |
|||
Tagging, Write |
||||
List |
||||
|
CreateTags |
Tagging, Write |
|||
|
CreateUpdatedWorkspaceImage |
Tagging, Write |
|||
Write |
||||
|
CreateWorkspaceBundle |
Tagging, Write |
|||
Write |
||||
|
CreateWorkspaceImage |
Tagging, Write |
|||
Write |
||||
|
CreateWorkspaces |
Tagging, Write |
|||
Write |
||||
|
CreateWorkspacesPool |
Tagging, Write |
|||
Write |
||||
|
DeleteAccountLinkInvitation |
Write |
|||
|
DeleteClientBranding |
Write |
|||
|
DeleteConnectClientAddIn |
Write |
|||
|
DeleteConnectionAlias |
Write |
|||
|
DeleteIpGroup |
Write |
|||
|
DeleteTags |
Tagging, Write |
|||
|
DeleteWorkspaceBundle |
Write |
|||
|
DeleteWorkspaceImage |
Write |
|||
|
DeployWorkspaceApplications |
Write |
|||
|
DeregisterWorkspaceDirectory |
Write |
|||
|
DescribeAccount |
Read |
|||
|
DescribeAccountModifications |
Read |
|||
|
DescribeApplicationAssociations |
List |
|||
|
DescribeApplications |
List |
|||
|
DescribeBundleAssociations |
List |
|||
|
DescribeClientBranding |
Read |
|||
|
DescribeClientProperties |
List |
|||
|
DescribeConnectClientAddIns |
List |
|||
|
DescribeConnectionAliasPermissions |
Read |
|||
|
DescribeConnectionAliases |
Read |
|||
|
DescribeCustomWorkspaceImageImport |
Read |
|||
|
DescribeImageAssociations |
List |
|||
|
DescribeIpGroups |
Read |
|||
|
DescribeTags |
Read |
|||
|
DescribeWorkspaceAssociations |
List |
|||
|
DescribeWorkspaceBundles |
List |
|||
|
DescribeWorkspaceDirectories |
Read |
|||
|
DescribeWorkspaceImagePermissions |
Read |
|||
|
DescribeWorkspaceImages |
List |
|||
|
DescribeWorkspaceSnapshots |
List |
|||
|
DescribeWorkspaces |
List |
|||
|
DescribeWorkspacesConnectionStatus |
Read |
|||
|
DescribeWorkspacesPoolSessions |
List |
|||
|
DescribeWorkspacesPools |
List |
|||
|
DisassociateConnectionAlias |
Write |
|||
|
DisassociateIpGroups |
Write |
|||
|
DisassociateWorkspaceApplication |
Write |
|||
|
GetAccountLink |
Read |
|||
|
ImportClientBranding |
Write |
|||
|
ImportCustomWorkspaceImage |
Tagging, Write |
|||
Write |
||||
|
ImportWorkspaceImage |
Tagging, Write |
|||
Write |
||||
|
ListAccountLinks |
List |
|||
|
ListAvailableManagementCidrRanges |
List |
|||
|
MigrateWorkspace |
Write |
|||
|
ModifyAccount |
Write |
|||
|
ModifyCertificateBasedAuthProperties |
Write |
|||
|
ModifyClientProperties |
Write |
|||
|
ModifyEndpointEncryptionMode |
Write |
|||
|
ModifySamlProperties |
Write |
|||
|
ModifySelfservicePermissions |
Permissions management, Write |
|||
|
ModifyStreamingProperties |
Write |
|||
|
ModifyWorkspaceAccessProperties |
Write |
|||
|
ModifyWorkspaceCreationProperties |
Write |
|||
iam:PassedToService |
workspaces.amazonaws.com |
Write |
||
|
ModifyWorkspaceProperties |
Write |
|||
|
ModifyWorkspaceState |
Write |
|||
|
RebootWorkspaces |
Write |
|||
|
RebuildWorkspaces |
Write |
|||
|
RegisterWorkspaceDirectory |
Tagging, Write |
|||
Write |
||||
|
RejectAccountLinkInvitation |
Write |
|||
|
RestoreWorkspace |
Write |
|||
|
RevokeIpRules |
Write |
|||
Write |
||||
|
StartWorkspaces |
Write |
|||
|
StartWorkspacesPool |
Write |
|||
|
StopWorkspaces |
Write |
|||
|
StopWorkspacesPool |
Write |
|||
|
TerminateWorkspaces |
Write |
|||
|
TerminateWorkspacesPool |
Write |
|||
|
TerminateWorkspacesPoolSession |
Write |
|||
|
UpdateConnectClientAddIn |
Write |
|||
|
UpdateConnectionAliasPermission |
Permissions management, Write |
|||
|
UpdateRulesOfIpGroup |
Write |
|||
Write |
||||
Write |
||||
|
UpdateWorkspaceBundle |
Write |
|||
|
UpdateWorkspaceImagePermission |
Permissions management, Write |
|||
|
UpdateWorkspacesPool |
Write |
Actions defined by Amazon WorkSpaces
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 accept invitations from other Amazon accounts to share the same configuration for WorkSpaces BYOL |
Write |
|||
Grants permission to associate connection aliases with directories |
Write |
|||
Grants permission to associate IP access control groups with directories |
Write |
|||
Grants permission to associate a workspace application with a WorkSpace |
Write |
|||
Grants permission to add rules to IP access control groups |
Write |
|||
Grants permission to copy a WorkSpace image |
Write |
|||
Grants permission to invite other Amazon accounts to share the same configuration for WorkSpaces BYOL |
Write |
|||
Grants permission to create an Amazon Connect client add-in within a directory |
Write |
|||
Grants permission to create connection aliases for use with cross-Region redirection |
Write |
|||
Grants permission to create IP access control groups |
Write |
|||
Grants permission to create one or more Standby WorkSpaces |
Write |
|||
Grants permission to create tags for WorkSpaces resources |
Tagging, Write |
|||
Grants permission to create an updated WorkSpace image |
Write |
|||
Grants permission to create a WorkSpace bundle |
Write |
|||
Grants permission to create a new WorkSpace image |
Write |
|||
Grants permission to create one or more WorkSpaces |
Write |
|||
Grants permission to create a WorkSpaces Pool |
Write |
|||
Grants permission to delete invitations to other Amazon accounts to share the same configuration for WorkSpaces BYOL |
Write |
|||
Grants permission to delete Amazon WorkSpaces Client branding data within a directory |
Write |
|||
Grants permission to delete an Amazon Connect client add-in that is configured within a directory |
Write |
|||
Grants permission to delete connection aliases |
Write |
|||
Grants permission to delete IP access control groups |
Write |
|||
Grants permission to delete tags from WorkSpaces resources |
Tagging, Write |
|||
Grants permission to delete WorkSpace bundles |
Write |
|||
Grants permission to delete WorkSpace images |
Write |
|||
Grants permission to deploy all pending workspace applications on a WorkSpace |
Write |
|||
Grants permission to deregister directories from use with Amazon WorkSpaces |
Write |
|||
Grants permission to retrieve the configuration of Bring Your Own License (BYOL) for WorkSpaces accounts |
Read |
|||
Grants permission to retrieve modifications to the configuration of Bring Your Own License (BYOL) for WorkSpaces accounts |
Read |
|||
Grants permission to retrieve information about resources associated with a WorkSpace application |
List |
|||
Grants permission to obtain information about WorkSpace applications |
List |
|||
Grants permission to retrieve information about resources associated with a WorkSpace bundle |
List |
|||
Grants permission to retrieve Amazon WorkSpaces Client branding data within a directory |
Read |
|||
Grants permission to retrieve information about WorkSpaces clients |
List |
|||
Grants permission to retrieve a list of Amazon Connect client add-ins that have been created |
List |
|||
Grants permission to retrieve the permissions that the owners of connection aliases have granted to other Amazon accounts for connection aliases |
Read |
|||
Grants permission to retrieve a list that describes the connection aliases used for cross-Region redirection |
Read |
|||
Grants permission to retrieve information about WorkSpace BYOL image import task |
Read |
|||
Grants permission to retrieve information about resources associated with a WorkSpace image |
List |
|||
Grants permission to retrieve information about IP access control groups |
Read |
|||
Grants permission to describe the tags for WorkSpaces resources |
Read |
|||
Grants permission to retrieve information about resources associated with a WorkSpace |
List |
|||
Grants permission to obtain information about WorkSpace bundles |
List |
|||
Grants permission to retrieve information about directories that are registered with WorkSpaces |
Read |
|||
Grants permission to retrieve information about WorkSpace image permissions |
Read |
|||
Grants permission to retrieve information about WorkSpace images |
List |
|||
Grants permission to retrieve information about WorkSpace snapshots |
List |
|||
Grants permission to obtain information about WorkSpaces |
List |
|||
Grants permission to obtain the connection status of WorkSpaces |
Read |
|||
Grants permission to retrieve information about the sessions of a WorkSpaces Pool |
List |
|||
Grants permission to retrieve information about WorkSpaces Pools |
List |
|||
Grants permission to disassociate connection aliases from directories |
Write |
|||
Grants permission to disassociate IP access control groups from directories |
Write |
|||
Grants permission to disassociate a workspace application from a WorkSpace |
Write |
|||
Grants permission to retrieve a link with another Amazon Account for sharing configuration for WorkSpaces BYOL |
Read |
|||
Grants permission to import Amazon WorkSpaces Client branding data within a directory |
Write |
|||
Grants permission to import Bring Your Own License (BYOL) images into Amazon WorkSpaces |
Write |
|||
Grants permission to import Bring Your Own License (BYOL) images into Amazon WorkSpaces |
Write |
|||
Grants permission to retrieve links with the Amazon Account(s) that share your configuration for WorkSpaces BYOL |
List |
|||
Grants permission to list the available CIDR ranges for enabling Bring Your Own License (BYOL) for WorkSpaces accounts |
List |
|||
Grants permission to migrate WorkSpaces |
Write |
|||
Grants permission to modify the configuration of Bring Your Own License (BYOL) for WorkSpaces accounts |
Write |
|||
Grants permission to modify the certificate-based authorization properties of a directory |
Write |
|||
Grants permission to modify the properties of WorkSpaces clients |
Write |
|||
Grants permission to configure the specified directory between Standard TLS and FIPS 140-2 validated mode |
Write |
|||
Grants permission to modify the SAML properties of a directory |
Write |
|||
Grants permission to modify the self-service WorkSpace management capabilities for your users |
Permissions management, Write |
|||
Grants permission to modify the streaming properties |
Write |
|||
Grants permission to specify which devices and operating systems users can use to access their WorkSpaces |
Write |
|||
Grants permission to modify the default properties used to create WorkSpaces |
Write |
|||
Grants permission to modify WorkSpace properties, including the running mode and the AutoStop period |
Write |
|||
Grants permission to modify the state of WorkSpaces |
Write |
|||
Grants permission to reboot WorkSpaces |
Write |
|||
Grants permission to rebuild WorkSpaces |
Write |
|||
Grants permission to register directories for use with Amazon WorkSpaces |
Write |
|||
Grants permission to reject invitations from other Amazon accounts to share the same configuration for WorkSpaces BYOL |
Write |
|||
Grants permission to restore WorkSpaces |
Write |
|||
Grants permission to remove rules from IP access control groups |
Write |
|||
Grants permission to start AutoStop WorkSpaces |
Write |
|||
Grants permission to start a WorkSpaces Pool |
Write |
|||
Grants permission to stop AutoStop WorkSpaces |
Write |
|||
Grants permission to stop a WorkSpaces Pool |
Write |
|||
Grants permission to federated users to sign in by using their existing credentials and stream their workspace |
Write |
|||
Grants permission to terminate WorkSpaces |
Write |
|||
Grants permission to terminate a WorkSpaces Pool |
Write |
|||
Grants permission to terminate a WorkSpaces Pool session |
Write |
|||
Grants permission to update an Amazon Connect client add-in. Use this action to update the name and endpoint URL of an Amazon Connect client add-in |
Write |
|||
Grants permission to share or unshare connection aliases with other accounts |
Permissions management, Write |
|||
Grants permission to replace rules for IP access control groups |
Write |
|||
Grants permission to update the WorkSpace images used in WorkSpace bundles |
Write |
|||
Grants permission to share or unshare WorkSpace images with other accounts by specifying whether other accounts have permission to copy the image |
Permissions management, Write |
|||
Grants permission to update the WorkSpaces pool |
Write |
Permission-only actions for Amazon WorkSpaces
The following actions are defined by Amazon WorkSpaces 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 |
|---|---|---|---|---|
Grants permission to create a root client certificate |
Write |
|||
Grants permission to delete root client certificate |
Write |
|||
Grants permission to retrieve information about consent agreement to BYOL minimum requirements |
Read |
|||
Grants permission to directory management actions while managing and provisioning workspaces |
List |
|||
Grants permission to get troubleshooting recommendations |
Read |
|||
Grants permission to invoke troubleshooting investigation |
Read |
|||
Grants permission to list troubleshooting recommendations |
Read |
|||
Grants permission to update the consent agreement to BYOL minimum requirements |
Write |
|||
Grants permission to update a root client certificate |
Write |
Resource types defined by Amazon WorkSpaces
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}:workspaces:${Region}:${Account}:workspacecertificate/${CertificateId} |
||
arn:${Partition}:workspaces:${Region}:${Account}:connectionalias/${ConnectionAliasId} |
||
arn:${Partition}:workspaces:${Region}:${Account}:directory/${DirectoryId} |
||
arn:${Partition}:workspaces:${Region}:${Account}:workspaceapplication/${WorkSpaceApplicationId} |
||
arn:${Partition}:workspaces:${Region}:${Account}:workspacebundle/${BundleId} |
||
arn:${Partition}:workspaces:${Region}:${Account}:workspace/${WorkspaceId} |
||
arn:${Partition}:workspaces:${Region}:${Account}:workspaceimage/${ImageId} |
||
arn:${Partition}:workspaces:${Region}:${Account}:workspaceipgroup/${GroupId} |
||
arn:${Partition}:workspaces:${Region}:${Account}:workspacespool/${PoolId} |
Condition keys for Amazon WorkSpaces
Amazon WorkSpaces defines the following condition keys that can be used in the
Condition element of an IAM policy.
| Condition keys | Description | Type |
|---|---|---|
Filters access based on the tags that are passed in the request |
String |
|
Filters access based on the tags associated with the resource |
String |
|
Filters access based on the tag keys that are passed in the request |
ArrayOfString |
|
Filters access by the ID of the Workspaces user |
String |