AWS Identity and Access Management
User Guide

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

Actions, Resources, and Condition Keys for Amazon WorkSpaces

Amazon WorkSpaces (service prefix: workspaces) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.

References:

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 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 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
AssociateIpGroups Associates the specified IP access control group with the specified directory. Write
AuthorizeIpRules Adds one or more rules to the specified IP access control group. Write

workspaceipgroup*

CreateIpGroup Creates an IP access control group. Write
CreateTags Creates tags for a WorkSpace. Tagging
CreateWorkspaces Creates one or more WorkSpaces. Write

directoryid*

workspacebundle*

DeleteIpGroup Deletes the specified IP access control group. Write

workspaceipgroup*

DeleteTags Deletes tags from a Workspace. Write
DeleteWorkspaceImage Deletes the specified workspace image. Write
DescribeAccount Retrieves a list that describes the configuration of bring your own license (BYOL) for the specified account. List
DescribeAccountModifications Retrieves a list that describes modifications to the configuration of bring your own license (BYOL) for the specified account. List
DescribeClientProperties Describe client properties about the specified resources. List

directoryid*

DescribeIpGroups Retrieves information about the IP access control groups of your account in the region. List

workspaceipgroup*

DescribeTags Describes tags for a WorkSpace. List
DescribeWorkspaceBundles Obtains information about the WorkSpace bundles that are available to your account in the specified region. List

workspacebundle*

DescribeWorkspaceDirectories Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account. List
DescribeWorkspaceImages Retrieves a list that describes one or more specified images. List
DescribeWorkspaces Obtains information about the specified WorkSpaces. List
DescribeWorkspacesConnectionStatus Describes the connection status of a specified WorkSpace. Read
DisassociateIpGroups Disassociates the specified IP access control group from the specified directory. Write
ImportWorkspaceImage Import a licensed EC2 image to into Amazon WorkSpaces. Write
ListAvailableManagementCidrRanges List available CIDR ranges for a CIDR range constraint. List
ModifyAccount Modify the configuration of bring your own license (BYOL) for the specified account. Write
ModifyClientProperties Modify the client properties of a specified resource. Write

directoryid*

ModifyWorkspaceProperties Modifies the WorkSpace properties, including the running mode and AutoStop time. Write

workspaceid*

ModifyWorkspaceState Modify the state of specified WorkSpaces. Write

workspaceid*

RebootWorkspaces Reboots the specified WorkSpaces. Write

workspaceid*

RebuildWorkspaces Rebuilds the specified WorkSpaces. Write

workspaceid*

RevokeIpRules Removes one or more rules from the specified IP access control group. Write

workspaceipgroup*

StartWorkspaces Starts the specified WorkSpaces. Write

workspaceid*

StopWorkspaces Stops the specified WorkSpaces. Write

workspaceid*

TerminateWorkspaces Terminates the specified WorkSpaces. Write

workspaceid*

UpdateRulesOfIpGroup Replaces the current rules of the specified IP access control group with the specified rules. Write

workspaceipgroup*

Resources 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. 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
workspacebundle arn:${Partition}:workspaces:${Region}:${Account}:workspacebundle/${BundleId}
workspaceipgroup arn:${Partition}:workspaces:${Region}:${Account}:workspaceipgroup/${GroupId}
directoryid arn:${Partition}:workspaces:${Region}:${Account}:directory/${DirectoryId}
workspaceid arn:${Partition}:workspaces:${Region}:${Account}:workspace/${WorkspaceId}

Condition Keys for Amazon WorkSpaces

WorkSpaces has no service-specific context keys that can be used in the Condition element of policy statements. For the list of the global context keys that are available to all services, see Available Keys for Conditions in the IAM Policy Reference.