Network.AWS.WorkSpaces.DescribeWorkspaceDirectories

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.

This operation returns paginated results.

Creating a Request

describeWorkspaceDirectories :: DescribeWorkspaceDirectories

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

Contains the inputs for the DescribeWorkspaceDirectories operation.

See: describeWorkspaceDirectories smart constructor.

Instances

Eq DescribeWorkspaceDirectories

Methods

(==) :: DescribeWorkspaceDirectories -> DescribeWorkspaceDirectories -> Bool

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

Data DescribeWorkspaceDirectories

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

Methods

readsPrec :: Int -> ReadS DescribeWorkspaceDirectories

readList :: ReadS [DescribeWorkspaceDirectories]

readPrec :: ReadPrec DescribeWorkspaceDirectories

readListPrec :: ReadPrec [DescribeWorkspaceDirectories]

Show DescribeWorkspaceDirectories

Methods

showsPrec :: Int -> DescribeWorkspaceDirectories -> ShowS

show :: DescribeWorkspaceDirectories -> String

showList :: [DescribeWorkspaceDirectories] -> ShowS

Generic DescribeWorkspaceDirectories

Associated Types

type Rep DescribeWorkspaceDirectories :: * -> *

Methods

from :: DescribeWorkspaceDirectories -> Rep DescribeWorkspaceDirectories x

to :: Rep DescribeWorkspaceDirectories x -> DescribeWorkspaceDirectories

Hashable DescribeWorkspaceDirectories

Methods

hashWithSalt :: Int -> DescribeWorkspaceDirectories -> Int

hash :: DescribeWorkspaceDirectories -> Int

ToJSON DescribeWorkspaceDirectories

Methods

toJSON :: DescribeWorkspaceDirectories -> Value

toEncoding :: DescribeWorkspaceDirectories -> Encoding

toJSONList :: [DescribeWorkspaceDirectories] -> Value

toEncodingList :: [DescribeWorkspaceDirectories] -> Encoding

NFData DescribeWorkspaceDirectories

Methods

rnf :: DescribeWorkspaceDirectories -> ()

AWSPager DescribeWorkspaceDirectories

Methods

page :: DescribeWorkspaceDirectories -> Rs DescribeWorkspaceDirectories -> Maybe DescribeWorkspaceDirectories

AWSRequest DescribeWorkspaceDirectories

Associated Types

type Rs DescribeWorkspaceDirectories :: *

Methods

request :: DescribeWorkspaceDirectories -> Request DescribeWorkspaceDirectories

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

ToQuery DescribeWorkspaceDirectories

Methods

toQuery :: DescribeWorkspaceDirectories -> QueryString

ToPath DescribeWorkspaceDirectories

Methods

toPath :: DescribeWorkspaceDirectories -> ByteString

ToHeaders DescribeWorkspaceDirectories

Methods

toHeaders :: DescribeWorkspaceDirectories -> [Header]

type Rep DescribeWorkspaceDirectories

type Rep DescribeWorkspaceDirectories = D1 (MetaData "DescribeWorkspaceDirectories" "Network.AWS.WorkSpaces.DescribeWorkspaceDirectories" "amazonka-workspaces-1.5.0-DPq63Qf3dJX7iA35T3v3IB" 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

type Rs DescribeWorkspaceDirectories = DescribeWorkspaceDirectoriesResponse

Request Lenses

dwdNextToken :: Lens' DescribeWorkspaceDirectories (Maybe Text)

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

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

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

Arguments

:: Int

dwdrsResponseStatus

-> DescribeWorkspaceDirectoriesResponse

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

Contains the results of the DescribeWorkspaceDirectories operation.

See: describeWorkspaceDirectoriesResponse smart constructor.

Instances

Eq DescribeWorkspaceDirectoriesResponse

Methods

(==) :: DescribeWorkspaceDirectoriesResponse -> DescribeWorkspaceDirectoriesResponse -> Bool

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

Data DescribeWorkspaceDirectoriesResponse

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

Methods

readsPrec :: Int -> ReadS DescribeWorkspaceDirectoriesResponse

readList :: ReadS [DescribeWorkspaceDirectoriesResponse]

readPrec :: ReadPrec DescribeWorkspaceDirectoriesResponse

readListPrec :: ReadPrec [DescribeWorkspaceDirectoriesResponse]

Show DescribeWorkspaceDirectoriesResponse

Methods

showsPrec :: Int -> DescribeWorkspaceDirectoriesResponse -> ShowS

show :: DescribeWorkspaceDirectoriesResponse -> String

showList :: [DescribeWorkspaceDirectoriesResponse] -> ShowS

Generic DescribeWorkspaceDirectoriesResponse

Associated Types

type Rep DescribeWorkspaceDirectoriesResponse :: * -> *

Methods

from :: DescribeWorkspaceDirectoriesResponse -> Rep DescribeWorkspaceDirectoriesResponse x

to :: Rep DescribeWorkspaceDirectoriesResponse x -> DescribeWorkspaceDirectoriesResponse

NFData DescribeWorkspaceDirectoriesResponse

Methods

rnf :: DescribeWorkspaceDirectoriesResponse -> ()

type Rep DescribeWorkspaceDirectoriesResponse

type Rep DescribeWorkspaceDirectoriesResponse = D1 (MetaData "DescribeWorkspaceDirectoriesResponse" "Network.AWS.WorkSpaces.DescribeWorkspaceDirectories" "amazonka-workspaces-1.5.0-DPq63Qf3dJX7iA35T3v3IB" 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 DecidedStrict) (Rec0 Int)))))

Response Lenses

dwdrsDirectories :: Lens' DescribeWorkspaceDirectoriesResponse [WorkspaceDirectory]

An array of structures that contain information about the directories.

dwdrsNextToken :: Lens' DescribeWorkspaceDirectoriesResponse (Maybe Text)

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 :: Lens' DescribeWorkspaceDirectoriesResponse Int

• - | The response status code.