amazonka-workspaces-1.4.5: Amazon WorkSpaces SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.WorkSpaces.DescribeWorkspaceDirectories

Contents

Description

Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

Synopsis

Creating a Request

describeWorkspaceDirectories :: DescribeWorkspaceDirectories Source #

Creates a value of DescribeWorkspaceDirectories with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • dwdNextToken - The NextToken value from a previous call to this operation. Pass null if this is the first call.
  • dwdDirectoryIds - An array of strings that contains the directory identifiers to retrieve information for. If this member is null, all directories are retrieved.

data DescribeWorkspaceDirectories Source #

Contains the inputs for the DescribeWorkspaceDirectories operation.

See: describeWorkspaceDirectories smart constructor.

Instances

Eq DescribeWorkspaceDirectories Source # 
Data DescribeWorkspaceDirectories Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeWorkspaceDirectories -> c DescribeWorkspaceDirectories #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeWorkspaceDirectories #

toConstr :: DescribeWorkspaceDirectories -> Constr #

dataTypeOf :: DescribeWorkspaceDirectories -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeWorkspaceDirectories) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeWorkspaceDirectories) #

gmapT :: (forall b. Data b => b -> b) -> DescribeWorkspaceDirectories -> DescribeWorkspaceDirectories #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeWorkspaceDirectories -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeWorkspaceDirectories -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeWorkspaceDirectories -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeWorkspaceDirectories -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeWorkspaceDirectories -> m DescribeWorkspaceDirectories #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeWorkspaceDirectories -> m DescribeWorkspaceDirectories #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeWorkspaceDirectories -> m DescribeWorkspaceDirectories #

Read DescribeWorkspaceDirectories Source # 
Show DescribeWorkspaceDirectories Source # 
Generic DescribeWorkspaceDirectories Source # 
Hashable DescribeWorkspaceDirectories Source # 
ToJSON DescribeWorkspaceDirectories Source # 
NFData DescribeWorkspaceDirectories Source # 
AWSRequest DescribeWorkspaceDirectories Source # 
ToPath DescribeWorkspaceDirectories Source # 
ToHeaders DescribeWorkspaceDirectories Source # 
ToQuery DescribeWorkspaceDirectories Source # 
type Rep DescribeWorkspaceDirectories Source # 
type Rep DescribeWorkspaceDirectories = D1 (MetaData "DescribeWorkspaceDirectories" "Network.AWS.WorkSpaces.DescribeWorkspaceDirectories" "amazonka-workspaces-1.4.5-4DD1G7CeACD22Zx40RVwZt" False) (C1 (MetaCons "DescribeWorkspaceDirectories'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dwdNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dwdDirectoryIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (List1 Text))))))
type Rs DescribeWorkspaceDirectories Source # 

Request Lenses

dwdNextToken :: Lens' DescribeWorkspaceDirectories (Maybe Text) Source #

The NextToken value from a previous call to this operation. Pass null if this is the first call.

dwdDirectoryIds :: Lens' DescribeWorkspaceDirectories (Maybe (NonEmpty Text)) Source #

An array of strings that contains the directory identifiers to retrieve information for. If this member is null, all directories are retrieved.

Destructuring the Response

describeWorkspaceDirectoriesResponse Source #

Creates a value of DescribeWorkspaceDirectoriesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • dwdrsDirectories - An array of structures that contain information about the directories.
  • dwdrsNextToken - If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to this operation to retrieve the next set of items. This token is valid for one day and must be used within that time frame.
  • dwdrsResponseStatus - -- | The response status code.

data DescribeWorkspaceDirectoriesResponse Source #

Contains the results of the DescribeWorkspaceDirectories operation.

See: describeWorkspaceDirectoriesResponse smart constructor.

Instances

Eq DescribeWorkspaceDirectoriesResponse Source # 
Data DescribeWorkspaceDirectoriesResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeWorkspaceDirectoriesResponse -> c DescribeWorkspaceDirectoriesResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeWorkspaceDirectoriesResponse #

toConstr :: DescribeWorkspaceDirectoriesResponse -> Constr #

dataTypeOf :: DescribeWorkspaceDirectoriesResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeWorkspaceDirectoriesResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeWorkspaceDirectoriesResponse) #

gmapT :: (forall b. Data b => b -> b) -> DescribeWorkspaceDirectoriesResponse -> DescribeWorkspaceDirectoriesResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeWorkspaceDirectoriesResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeWorkspaceDirectoriesResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeWorkspaceDirectoriesResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeWorkspaceDirectoriesResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeWorkspaceDirectoriesResponse -> m DescribeWorkspaceDirectoriesResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeWorkspaceDirectoriesResponse -> m DescribeWorkspaceDirectoriesResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeWorkspaceDirectoriesResponse -> m DescribeWorkspaceDirectoriesResponse #

Read DescribeWorkspaceDirectoriesResponse Source # 
Show DescribeWorkspaceDirectoriesResponse Source # 
Generic DescribeWorkspaceDirectoriesResponse Source # 
NFData DescribeWorkspaceDirectoriesResponse Source # 
type Rep DescribeWorkspaceDirectoriesResponse Source # 
type Rep DescribeWorkspaceDirectoriesResponse = D1 (MetaData "DescribeWorkspaceDirectoriesResponse" "Network.AWS.WorkSpaces.DescribeWorkspaceDirectories" "amazonka-workspaces-1.4.5-4DD1G7CeACD22Zx40RVwZt" False) (C1 (MetaCons "DescribeWorkspaceDirectoriesResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dwdrsDirectories") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [WorkspaceDirectory]))) ((:*:) (S1 (MetaSel (Just Symbol "_dwdrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dwdrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

dwdrsDirectories :: Lens' DescribeWorkspaceDirectoriesResponse [WorkspaceDirectory] Source #

An array of structures that contain information about the directories.

dwdrsNextToken :: Lens' DescribeWorkspaceDirectoriesResponse (Maybe Text) Source #

If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to this operation to retrieve the next set of items. This token is valid for one day and must be used within that time frame.