Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.WorkSpaces.RegisterWorkspaceDirectory

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Synopsis

Creating a Request

data RegisterWorkspaceDirectory Source #

See: newRegisterWorkspaceDirectory smart constructor.

Constructors

RegisterWorkspaceDirectory'

Fields

subnetIds :: Maybe [Text]
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.
enableSelfService :: Maybe Bool
Indicates whether self-service capabilities are enabled or disabled.
tenancy :: Maybe 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.
tags :: Maybe [Tag]
The tags associated with the directory.
directoryId :: Text
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.
enableWorkDocs :: Bool
Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set EnableWorkDocs to disabled, and try again.

Instances

Instances details

Eq RegisterWorkspaceDirectory Source #
Instance details Defined in Amazonka.WorkSpaces.RegisterWorkspaceDirectory Methods (==) :: RegisterWorkspaceDirectory -> RegisterWorkspaceDirectory -> Bool # (/=) :: RegisterWorkspaceDirectory -> RegisterWorkspaceDirectory -> Bool #
Read RegisterWorkspaceDirectory Source #
Instance details Defined in Amazonka.WorkSpaces.RegisterWorkspaceDirectory Methods readsPrec :: Int -> ReadS RegisterWorkspaceDirectory # readList :: ReadS [RegisterWorkspaceDirectory] # readPrec :: ReadPrec RegisterWorkspaceDirectory # readListPrec :: ReadPrec [RegisterWorkspaceDirectory] #
Show RegisterWorkspaceDirectory Source #
Instance details Defined in Amazonka.WorkSpaces.RegisterWorkspaceDirectory Methods showsPrec :: Int -> RegisterWorkspaceDirectory -> ShowS # show :: RegisterWorkspaceDirectory -> String # showList :: [RegisterWorkspaceDirectory] -> ShowS #
Generic RegisterWorkspaceDirectory Source #
Instance details Defined in Amazonka.WorkSpaces.RegisterWorkspaceDirectory Associated Types type Rep RegisterWorkspaceDirectory :: Type -> Type # Methods from :: RegisterWorkspaceDirectory -> Rep RegisterWorkspaceDirectory x # to :: Rep RegisterWorkspaceDirectory x -> RegisterWorkspaceDirectory #
NFData RegisterWorkspaceDirectory Source #
Instance details Defined in Amazonka.WorkSpaces.RegisterWorkspaceDirectory Methods rnf :: RegisterWorkspaceDirectory -> () #
Hashable RegisterWorkspaceDirectory Source #
Instance details Defined in Amazonka.WorkSpaces.RegisterWorkspaceDirectory Methods hashWithSalt :: Int -> RegisterWorkspaceDirectory -> Int # hash :: RegisterWorkspaceDirectory -> Int #
ToJSON RegisterWorkspaceDirectory Source #
Instance details Defined in Amazonka.WorkSpaces.RegisterWorkspaceDirectory Methods toJSON :: RegisterWorkspaceDirectory -> Value # toEncoding :: RegisterWorkspaceDirectory -> Encoding # toJSONList :: [RegisterWorkspaceDirectory] -> Value # toEncodingList :: [RegisterWorkspaceDirectory] -> Encoding #
AWSRequest RegisterWorkspaceDirectory Source #
Instance details Defined in Amazonka.WorkSpaces.RegisterWorkspaceDirectory Associated Types type AWSResponse RegisterWorkspaceDirectory # Methods request :: RegisterWorkspaceDirectory -> Request RegisterWorkspaceDirectory # response :: MonadResource m => Logger -> Service -> Proxy RegisterWorkspaceDirectory -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RegisterWorkspaceDirectory))) #
ToHeaders RegisterWorkspaceDirectory Source #
Instance details Defined in Amazonka.WorkSpaces.RegisterWorkspaceDirectory Methods toHeaders :: RegisterWorkspaceDirectory -> [Header] #
ToPath RegisterWorkspaceDirectory Source #
Instance details Defined in Amazonka.WorkSpaces.RegisterWorkspaceDirectory Methods toPath :: RegisterWorkspaceDirectory -> ByteString #
ToQuery RegisterWorkspaceDirectory Source #
Instance details Defined in Amazonka.WorkSpaces.RegisterWorkspaceDirectory Methods toQuery :: RegisterWorkspaceDirectory -> QueryString #
type Rep RegisterWorkspaceDirectory Source #
Instance details Defined in Amazonka.WorkSpaces.RegisterWorkspaceDirectory type Rep RegisterWorkspaceDirectory = D1 ('MetaData "RegisterWorkspaceDirectory" "Amazonka.WorkSpaces.RegisterWorkspaceDirectory" "libZSservicesZSamazonka-workspacesZSamazonka-workspaces" 'False) (C1 ('MetaCons "RegisterWorkspaceDirectory'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "enableSelfService") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "tenancy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Tenancy)))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: (S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "enableWorkDocs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))
type AWSResponse RegisterWorkspaceDirectory Source #
Instance details Defined in Amazonka.WorkSpaces.RegisterWorkspaceDirectory type AWSResponse RegisterWorkspaceDirectory = RegisterWorkspaceDirectoryResponse

newRegisterWorkspaceDirectory Source #

Arguments

:: Text	`$sel:directoryId:RegisterWorkspaceDirectory'`
-> Bool	`$sel:enableWorkDocs:RegisterWorkspaceDirectory'`
-> RegisterWorkspaceDirectory

Create a value of RegisterWorkspaceDirectory with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:subnetIds:RegisterWorkspaceDirectory', registerWorkspaceDirectory_subnetIds - 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.

$sel:enableSelfService:RegisterWorkspaceDirectory', registerWorkspaceDirectory_enableSelfService - Indicates whether self-service capabilities are enabled or disabled.

$sel:tenancy:RegisterWorkspaceDirectory', registerWorkspaceDirectory_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.

$sel:tags:RegisterWorkspaceDirectory', registerWorkspaceDirectory_tags - The tags associated with the directory.

$sel:directoryId:RegisterWorkspaceDirectory', registerWorkspaceDirectory_directoryId - 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.

$sel:enableWorkDocs:RegisterWorkspaceDirectory', registerWorkspaceDirectory_enableWorkDocs - Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set EnableWorkDocs to disabled, and try again.

Request Lenses

registerWorkspaceDirectory_subnetIds :: Lens' RegisterWorkspaceDirectory (Maybe [Text]) Source #

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.

registerWorkspaceDirectory_enableSelfService :: Lens' RegisterWorkspaceDirectory (Maybe Bool) Source #

Indicates whether self-service capabilities are enabled or disabled.

registerWorkspaceDirectory_tenancy :: Lens' RegisterWorkspaceDirectory (Maybe Tenancy) Source #

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.

registerWorkspaceDirectory_tags :: Lens' RegisterWorkspaceDirectory (Maybe [Tag]) Source #

The tags associated with the directory.

registerWorkspaceDirectory_directoryId :: Lens' RegisterWorkspaceDirectory Text Source #

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.

registerWorkspaceDirectory_enableWorkDocs :: Lens' RegisterWorkspaceDirectory Bool Source #

Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set EnableWorkDocs to disabled, and try again.

Destructuring the Response

data RegisterWorkspaceDirectoryResponse Source #

See: newRegisterWorkspaceDirectoryResponse smart constructor.

Constructors

RegisterWorkspaceDirectoryResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Eq RegisterWorkspaceDirectoryResponse Source #
Instance details Defined in Amazonka.WorkSpaces.RegisterWorkspaceDirectory Methods (==) :: RegisterWorkspaceDirectoryResponse -> RegisterWorkspaceDirectoryResponse -> Bool # (/=) :: RegisterWorkspaceDirectoryResponse -> RegisterWorkspaceDirectoryResponse -> Bool #
Read RegisterWorkspaceDirectoryResponse Source #
Instance details Defined in Amazonka.WorkSpaces.RegisterWorkspaceDirectory Methods readsPrec :: Int -> ReadS RegisterWorkspaceDirectoryResponse # readList :: ReadS [RegisterWorkspaceDirectoryResponse] # readPrec :: ReadPrec RegisterWorkspaceDirectoryResponse # readListPrec :: ReadPrec [RegisterWorkspaceDirectoryResponse] #
Show RegisterWorkspaceDirectoryResponse Source #
Instance details Defined in Amazonka.WorkSpaces.RegisterWorkspaceDirectory Methods showsPrec :: Int -> RegisterWorkspaceDirectoryResponse -> ShowS # show :: RegisterWorkspaceDirectoryResponse -> String # showList :: [RegisterWorkspaceDirectoryResponse] -> ShowS #
Generic RegisterWorkspaceDirectoryResponse Source #
Instance details Defined in Amazonka.WorkSpaces.RegisterWorkspaceDirectory Associated Types type Rep RegisterWorkspaceDirectoryResponse :: Type -> Type # Methods from :: RegisterWorkspaceDirectoryResponse -> Rep RegisterWorkspaceDirectoryResponse x # to :: Rep RegisterWorkspaceDirectoryResponse x -> RegisterWorkspaceDirectoryResponse #
NFData RegisterWorkspaceDirectoryResponse Source #
Instance details Defined in Amazonka.WorkSpaces.RegisterWorkspaceDirectory Methods rnf :: RegisterWorkspaceDirectoryResponse -> () #
type Rep RegisterWorkspaceDirectoryResponse Source #
Instance details Defined in Amazonka.WorkSpaces.RegisterWorkspaceDirectory type Rep RegisterWorkspaceDirectoryResponse = D1 ('MetaData "RegisterWorkspaceDirectoryResponse" "Amazonka.WorkSpaces.RegisterWorkspaceDirectory" "libZSservicesZSamazonka-workspacesZSamazonka-workspaces" 'False) (C1 ('MetaCons "RegisterWorkspaceDirectoryResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRegisterWorkspaceDirectoryResponse Source #

Arguments

:: Int	`$sel:httpStatus:RegisterWorkspaceDirectoryResponse'`
-> RegisterWorkspaceDirectoryResponse

Create a value of RegisterWorkspaceDirectoryResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:RegisterWorkspaceDirectoryResponse', registerWorkspaceDirectoryResponse_httpStatus - The response's http status code.

Response Lenses

registerWorkspaceDirectoryResponse_httpStatus :: Lens' RegisterWorkspaceDirectoryResponse Int Source #

The response's http status code.