aws workspaces
Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows or Amazon Linux desktops for your users, known as WorkSpaces. AWS CLI reference
91 commands Its page in the AWS CLI reference
Commands
accept-account-link-invitationAccepts the account link invitation.associate-connection-aliasAssociates the specified connection alias with the specified directory to enable cross-Region redirection.associate-ip-groupsAssociates the specified IP access control group with the specified directory.associate-workspace-applicationAssociates the specified application to the specified WorkSpace.authorize-ip-rulesAdds one or more rules to the specified IP access control group.copy-workspace-imageCopies the specified image from the specified Region to the current Region.create-account-link-invitationCreates the account link invitation.create-connect-client-add-inCreates a client-add-in for Connect Customer within a directory.create-connection-aliasCreates the specified connection alias for use with cross-Region redirection.create-ip-groupCreates an IP access control group.create-standby-workspacesCreates a standby WorkSpace in a secondary Region.create-tagsCreates the specified tags for the specified WorkSpaces resource.create-updated-workspace-imageCreates a new updated WorkSpace image based on the specified source image.create-workspace-bundleCreates the specified WorkSpace bundle.create-workspace-imageCreates a new WorkSpace image from an existing WorkSpace.create-workspacesCreates one or more WorkSpaces.create-workspaces-poolEnd of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools.delete-account-link-invitationDeletes the account link invitation.delete-client-brandingDeletes customized client branding.delete-connect-client-add-inDeletes a client-add-in for Connect Customer that is configured within a directory.delete-connection-aliasDeletes the specified connection alias.delete-ip-groupDeletes the specified IP access control group.delete-tagsDeletes the specified tags from the specified WorkSpaces resource.delete-workspace-bundleDeletes the specified WorkSpace bundle.delete-workspace-imageDeletes the specified image from your account.deploy-workspace-applicationsDeploys associated applications to the specified WorkSpacederegister-workspace-directoryDeregisters the specified directory.describe-accountRetrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.describe-account-modificationsRetrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.describe-application-associationsDescribes the associations between the application and the specified associated resources.describe-applicationsDescribes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.describe-bundle-associationsDescribes the associations between the applications and the specified bundle.describe-client-brandingDescribes the specified client branding.describe-client-propertiesRetrieves a list that describes one or more specified Amazon WorkSpaces clients.describe-connect-client-add-insRetrieves a list of Connect Customer client add-ins that have been created.describe-connection-alias-permissionsDescribes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias.describe-connection-aliasesRetrieves a list that describes the connection aliases used for cross-Region redirection.describe-custom-workspace-image-importRetrieves information about a WorkSpace BYOL image being imported via ImportCustomWorkspaceImage.describe-image-associationsDescribes the associations between the applications and the specified image.describe-ip-groupsDescribes one or more of your IP access control groups.describe-tagsDescribes the specified tags for the specified WorkSpaces resource.describe-workspace-associationsDescribes the associations betweens applications and the specified WorkSpace.describe-workspace-bundlesRetrieves a list that describes the available WorkSpace bundles.describe-workspace-directoriesDescribes the available directories that are registered with Amazon WorkSpaces.describe-workspace-image-permissionsDescribes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.describe-workspace-imagesRetrieves a list that describes one or more specified images, if the image identifiers are provided.describe-workspace-snapshotsDescribes the snapshots for the specified WorkSpace.describe-workspacesDescribes the specified WorkSpaces.describe-workspaces-connection-statusDescribes the connection status of the specified WorkSpaces.describe-workspaces-pool-sessionsEnd of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools.describe-workspaces-poolsEnd of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools.disassociate-connection-aliasDisassociates a connection alias from a directory.disassociate-ip-groupsDisassociates the specified IP access control group from the specified directory.disassociate-workspace-applicationDisassociates the specified application from a WorkSpace.get-account-linkRetrieves account link information.import-client-brandingImports client branding.import-custom-workspace-imageImports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces using EC2 Image Builder.import-workspace-imageImports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces.list-account-linksLists all account links.list-available-management-cidr-rangesRetrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL).migrate-workspaceMigrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.modify-accountModifies the configuration of Bring Your Own License (BYOL) for the specified account.modify-certificate-based-auth-propertiesModifies the properties of the certificate-based authentication you want to use with your WorkSpaces.modify-client-propertiesModifies the properties of the specified Amazon WorkSpaces clients.modify-endpoint-encryption-modeModifies the endpoint encryption mode that allows you to configure the specified directory between Standard TLS and FIPS 140-2 validated mode.modify-saml-propertiesModifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.modify-selfservice-permissionsModifies the self-service WorkSpace management capabilities for your users.modify-streaming-propertiesModifies the specified streaming properties.modify-workspace-access-propertiesSpecifies which devices and operating systems users can use to access their WorkSpaces.modify-workspace-creation-propertiesModify the default properties used to create WorkSpaces.modify-workspace-propertiesModifies the specified WorkSpace properties.modify-workspace-stateSets the state of the specified WorkSpace.reboot-workspacesReboots the specified WorkSpaces.rebuild-workspacesRebuilds the specified WorkSpace.register-workspace-directoryRegisters the specified directory.reject-account-link-invitationRejects the account link invitation.restore-workspaceRestores the specified WorkSpace to its last known healthy state.revoke-ip-rulesRemoves one or more rules from the specified IP access control group.start-workspacesStarts the specified WorkSpaces.start-workspaces-poolEnd of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools.stop-workspacesStops the specified WorkSpaces.stop-workspaces-poolEnd of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools.terminate-workspacesTerminates the specified WorkSpaces.terminate-workspaces-poolEnd of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools.terminate-workspaces-pool-sessionEnd of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools.update-connect-client-add-inUpdates a Connect Customer client add-in.update-connection-alias-permissionShares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory.update-rules-of-ip-groupReplaces the current rules of the specified IP access control group with the specified rules.update-workspace-bundleUpdates a WorkSpace bundle with a new image.update-workspace-image-permissionShares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that account has permission to copy the image.update-workspaces-poolEnd of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools.