AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon WorkSpaces RegisterWorkspaceDirectory API operation.

Syntax

Register-WKSWorkspaceDirectory
-DirectoryId <String>
-MicrosoftEntraConfig_ApplicationConfigSecretArn <String>
-ActiveDirectoryConfig_DomainName <String>
-EnableSelfService <Boolean>
-IdcInstanceArn <String>
-ActiveDirectoryConfig_ServiceAccountSecretArn <String>
-SubnetId <String[]>
-Tag <Tag[]>
-Tenancy <Tenancy>
-MicrosoftEntraConfig_TenantId <String>
-UserIdentityType <UserIdentityType>
-WorkspaceDirectoryDescription <String>
-WorkspaceDirectoryName <String>
-WorkspaceType <WorkspaceType>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonWorkSpacesConfig>

Description

Registers the specified directory. This operation is asynchronous and returns before the WorkSpace directory is registered. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.

Parameters

-ActiveDirectoryConfig_DomainName <String>
The name of the domain.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ActiveDirectoryConfig_ServiceAccountSecretArn <String>
Indicates the secret ARN on the service account.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonWorkSpacesConfig>
Amazon.PowerShell.Cmdlets.WKS.AmazonWorkSpacesClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DirectoryId <String>
The identifier of the directory. You cannot register a directory if it does not have a status of Active. If the directory does not have a status of Active, you will receive an InvalidResourceStateException error. If you have already registered the maximum number of directories that you can register with Amazon WorkSpaces, you will receive a ResourceLimitExceededException error. Deregister directories that you are not using for WorkSpaces, and try again.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-EnableSelfService <Boolean>
Indicates whether self-service capabilities are enabled or disabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IdcInstanceArn <String>
The Amazon Resource Name (ARN) of the identity center instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MicrosoftEntraConfig_ApplicationConfigSecretArn <String>
The Amazon Resource Name (ARN) of the application config.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MicrosoftEntraConfig_TenantId <String>
The identifier of the tenant.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the DirectoryId parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkSpaces.Model.RegisterWorkspaceDirectoryResponse). Specifying the name of a property of type Amazon.WorkSpaces.Model.RegisterWorkspaceDirectoryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SubnetId <String[]>
The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the subnets are in supported Availability Zones. The subnets must also be in separate Availability Zones. If these conditions are not met, you will receive an OperationNotSupportedException error.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSubnetIds
-Tag <Tag[]>
The tags associated with the directory.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-Tenancy <Tenancy>
Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own License (BYOL) images, this value must be set to DEDICATED and your Amazon Web Services account must be enabled for BYOL. If your account has not been enabled for BYOL, you will receive an InvalidParameterValuesException error. For more information about BYOL images, see Bring Your Own Windows Desktop Images.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UserIdentityType <UserIdentityType>
The type of identity management the user is using.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WorkspaceDirectoryDescription <String>
Description of the directory to register.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WorkspaceDirectoryName <String>
The name of the directory to register.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WorkspaceType <WorkspaceType>
Indicates whether the directory's WorkSpace type is personal or pools.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.WorkSpaces.Model.RegisterWorkspaceDirectoryResponse
This cmdlet returns an Amazon.WorkSpaces.Model.RegisterWorkspaceDirectoryResponse object containing multiple properties.

Examples

Example 1

Register-WKSWorkspaceDirectory -DirectoryId d-123412a123 -EnableWorkDoc $false
This sample registers the specified directory for Workspaces Service
Administration Guide
Developer Guide
Service API Reference
User Guide
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z