Network.AWS.DirectoryService.DescribeDirectories

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.

Creating a Request

describeDirectories :: DescribeDirectories

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:

• ddNextToken - The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories . Pass null if this is the first call.
• ddDirectoryIds - 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 - 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.

data DescribeDirectories

Contains the inputs for the DescribeDirectories operation.

See: describeDirectories smart constructor.

Instances

Eq DescribeDirectories

Methods

(==) :: DescribeDirectories -> DescribeDirectories -> Bool

(/=) :: DescribeDirectories -> DescribeDirectories -> Bool

Data DescribeDirectories

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

Methods

readsPrec :: Int -> ReadS DescribeDirectories

readList :: ReadS [DescribeDirectories]

readPrec :: ReadPrec DescribeDirectories

readListPrec :: ReadPrec [DescribeDirectories]

Show DescribeDirectories

Methods

showsPrec :: Int -> DescribeDirectories -> ShowS

show :: DescribeDirectories -> String

showList :: [DescribeDirectories] -> ShowS

Generic DescribeDirectories

Associated Types

type Rep DescribeDirectories :: * -> *

Methods

from :: DescribeDirectories -> Rep DescribeDirectories x

to :: Rep DescribeDirectories x -> DescribeDirectories

Hashable DescribeDirectories

Methods

hashWithSalt :: Int -> DescribeDirectories -> Int

hash :: DescribeDirectories -> Int

ToJSON DescribeDirectories

Methods

toJSON :: DescribeDirectories -> Value

toEncoding :: DescribeDirectories -> Encoding

toJSONList :: [DescribeDirectories] -> Value

toEncodingList :: [DescribeDirectories] -> Encoding

NFData DescribeDirectories

Methods

rnf :: DescribeDirectories -> ()

AWSRequest DescribeDirectories

Associated Types

type Rs DescribeDirectories :: *

Methods

request :: DescribeDirectories -> Request DescribeDirectories

response :: MonadResource m => Logger -> Service -> Proxy * DescribeDirectories -> ClientResponse -> m (Response DescribeDirectories)

ToPath DescribeDirectories

Methods

toPath :: DescribeDirectories -> ByteString

ToHeaders DescribeDirectories

Methods

toHeaders :: DescribeDirectories -> [Header]

ToQuery DescribeDirectories

Methods

toQuery :: DescribeDirectories -> QueryString

type Rep DescribeDirectories

type Rep DescribeDirectories = D1 (MetaData "DescribeDirectories" "Network.AWS.DirectoryService.DescribeDirectories" "amazonka-ds-1.4.5-24h2k11yeH0J6s1sLl4Gzu" 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

type Rs DescribeDirectories = DescribeDirectoriesResponse

Request Lenses

ddNextToken :: Lens' DescribeDirectories (Maybe Text)

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

ddDirectoryIds :: Lens' DescribeDirectories [Text]

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)

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

Arguments

:: Int

ddrsResponseStatus

-> DescribeDirectoriesResponse

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:

• ddrsDirectoryDescriptions - 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 - 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.
• ddrsResponseStatus - -- | The response status code.

data DescribeDirectoriesResponse

Contains the results of the DescribeDirectories operation.

See: describeDirectoriesResponse smart constructor.

Instances

Eq DescribeDirectoriesResponse

Methods

(==) :: DescribeDirectoriesResponse -> DescribeDirectoriesResponse -> Bool

(/=) :: DescribeDirectoriesResponse -> DescribeDirectoriesResponse -> Bool

Data DescribeDirectoriesResponse

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

Methods

readsPrec :: Int -> ReadS DescribeDirectoriesResponse

readList :: ReadS [DescribeDirectoriesResponse]

readPrec :: ReadPrec DescribeDirectoriesResponse

readListPrec :: ReadPrec [DescribeDirectoriesResponse]

Show DescribeDirectoriesResponse

Methods

showsPrec :: Int -> DescribeDirectoriesResponse -> ShowS

show :: DescribeDirectoriesResponse -> String

showList :: [DescribeDirectoriesResponse] -> ShowS

Generic DescribeDirectoriesResponse

Associated Types

type Rep DescribeDirectoriesResponse :: * -> *

Methods

from :: DescribeDirectoriesResponse -> Rep DescribeDirectoriesResponse x

to :: Rep DescribeDirectoriesResponse x -> DescribeDirectoriesResponse

NFData DescribeDirectoriesResponse

Methods

rnf :: DescribeDirectoriesResponse -> ()

type Rep DescribeDirectoriesResponse

type Rep DescribeDirectoriesResponse = D1 (MetaData "DescribeDirectoriesResponse" "Network.AWS.DirectoryService.DescribeDirectories" "amazonka-ds-1.4.5-24h2k11yeH0J6s1sLl4Gzu" 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 DecidedUnpack) (Rec0 Int)))))

Response Lenses

ddrsDirectoryDescriptions :: Lens' DescribeDirectoriesResponse [DirectoryDescription]

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)

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.

ddrsResponseStatus :: Lens' DescribeDirectoriesResponse Int

• - | The response status code.