amazonka-ds-1.4.2: Amazon Directory Service 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.DirectoryService.DescribeDirectories

Contents

Description

Obtains information about the directories that belong to this account.

You can retrieve information about specific directories by passing the directory identifiers in the DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned.

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

You can also specify a maximum number of return results with the Limit parameter.

Synopsis

Creating a Request

describeDirectories :: DescribeDirectories Source #

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

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

data DescribeDirectories Source #

Contains the inputs for the DescribeDirectories operation.

See: describeDirectories smart constructor.

Instances

Eq DescribeDirectories Source # 
Data DescribeDirectories Source # 

Methods

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

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

toConstr :: DescribeDirectories -> Constr #

dataTypeOf :: DescribeDirectories -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeDirectories Source # 
Show DescribeDirectories Source # 
Generic DescribeDirectories Source # 
ToJSON DescribeDirectories Source # 
Hashable DescribeDirectories Source # 
NFData DescribeDirectories Source # 

Methods

rnf :: DescribeDirectories -> () #

AWSRequest DescribeDirectories Source # 
ToPath DescribeDirectories Source # 
ToHeaders DescribeDirectories Source # 
ToQuery DescribeDirectories Source # 
type Rep DescribeDirectories Source # 
type Rep DescribeDirectories = D1 (MetaData "DescribeDirectories" "Network.AWS.DirectoryService.DescribeDirectories" "amazonka-ds-1.4.2-2tRF9IzMLvvBblYyr4EnMC" False) (C1 (MetaCons "DescribeDirectories'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ddNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ddDirectoryIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_ddLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))))))
type Rs DescribeDirectories Source # 

Request Lenses

ddNextToken :: Lens' DescribeDirectories (Maybe Text) Source #

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

ddDirectoryIds :: Lens' DescribeDirectories [Text] Source #

A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.

An empty list results in an InvalidParameterException being thrown.

ddLimit :: Lens' DescribeDirectories (Maybe Natural) Source #

The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

Destructuring the Response

describeDirectoriesResponse Source #

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

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

data DescribeDirectoriesResponse Source #

Contains the results of the DescribeDirectories operation.

See: describeDirectoriesResponse smart constructor.

Instances

Eq DescribeDirectoriesResponse Source # 
Data DescribeDirectoriesResponse Source # 

Methods

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

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

toConstr :: DescribeDirectoriesResponse -> Constr #

dataTypeOf :: DescribeDirectoriesResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeDirectoriesResponse Source # 
Show DescribeDirectoriesResponse Source # 
Generic DescribeDirectoriesResponse Source # 
NFData DescribeDirectoriesResponse Source # 
type Rep DescribeDirectoriesResponse Source # 
type Rep DescribeDirectoriesResponse = D1 (MetaData "DescribeDirectoriesResponse" "Network.AWS.DirectoryService.DescribeDirectories" "amazonka-ds-1.4.2-2tRF9IzMLvvBblYyr4EnMC" False) (C1 (MetaCons "DescribeDirectoriesResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ddrsDirectoryDescriptions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [DirectoryDescription]))) ((:*:) (S1 (MetaSel (Just Symbol "_ddrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ddrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

ddrsDirectoryDescriptions :: Lens' DescribeDirectoriesResponse [DirectoryDescription] Source #

The list of DirectoryDescription objects that were retrieved.

It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

ddrsNextToken :: Lens' DescribeDirectoriesResponse (Maybe Text) Source #

If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeDirectories to retrieve the next set of items.