amazonka-workspaces-1.4.4: 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.DescribeWorkspaces

Contents

Description

Obtains information about the specified WorkSpaces.

Only one of the filter parameters, such as BundleId, DirectoryId, or WorkspaceIds, can be specified at a time.

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

describeWorkspaces :: DescribeWorkspaces Source #

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

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

data DescribeWorkspaces Source #

Contains the inputs for the DescribeWorkspaces operation.

See: describeWorkspaces smart constructor.

Instances

Eq DescribeWorkspaces Source # 
Data DescribeWorkspaces Source # 

Methods

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

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

toConstr :: DescribeWorkspaces -> Constr #

dataTypeOf :: DescribeWorkspaces -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeWorkspaces Source # 
Show DescribeWorkspaces Source # 
Generic DescribeWorkspaces Source # 
Hashable DescribeWorkspaces Source # 
NFData DescribeWorkspaces Source # 

Methods

rnf :: DescribeWorkspaces -> () #

AWSRequest DescribeWorkspaces Source # 
ToPath DescribeWorkspaces Source # 
ToHeaders DescribeWorkspaces Source # 
ToQuery DescribeWorkspaces Source # 
ToJSON DescribeWorkspaces Source # 
type Rep DescribeWorkspaces Source # 
type Rep DescribeWorkspaces = D1 (MetaData "DescribeWorkspaces" "Network.AWS.WorkSpaces.DescribeWorkspaces" "amazonka-workspaces-1.4.4-IQnza0NWtgfKfbbLfSFOLb" False) (C1 (MetaCons "DescribeWorkspaces'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dwDirectoryId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dwWorkspaceIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (List1 Text)))) (S1 (MetaSel (Just Symbol "_dwUserName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_dwBundleId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dwNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dwLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))))))
type Rs DescribeWorkspaces Source # 

Request Lenses

dwDirectoryId :: Lens' DescribeWorkspaces (Maybe Text) Source #

Specifies the directory identifier to which to limit the WorkSpaces. Optionally, you can specify a specific directory user with the UserName parameter. This parameter cannot be combined with any other filter parameter.

dwWorkspaceIds :: Lens' DescribeWorkspaces (Maybe (NonEmpty Text)) Source #

An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information. This parameter cannot be combined with any other filter parameter.

Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.

dwUserName :: Lens' DescribeWorkspaces (Maybe Text) Source #

Used with the DirectoryId parameter to specify the directory user for whom to obtain the WorkSpace.

dwBundleId :: Lens' DescribeWorkspaces (Maybe Text) Source #

The identifier of a bundle to obtain the WorkSpaces for. All WorkSpaces that are created from this bundle will be retrieved. This parameter cannot be combined with any other filter parameter.

dwNextToken :: Lens' DescribeWorkspaces (Maybe Text) Source #

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

dwLimit :: Lens' DescribeWorkspaces (Maybe Natural) Source #

The maximum number of items to return.

Destructuring the Response

describeWorkspacesResponse Source #

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

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

data DescribeWorkspacesResponse Source #

Contains the results for the DescribeWorkspaces operation.

See: describeWorkspacesResponse smart constructor.

Instances

Eq DescribeWorkspacesResponse Source # 
Data DescribeWorkspacesResponse Source # 

Methods

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

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

toConstr :: DescribeWorkspacesResponse -> Constr #

dataTypeOf :: DescribeWorkspacesResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeWorkspacesResponse Source # 
Show DescribeWorkspacesResponse Source # 
Generic DescribeWorkspacesResponse Source # 
NFData DescribeWorkspacesResponse Source # 
type Rep DescribeWorkspacesResponse Source # 
type Rep DescribeWorkspacesResponse = D1 (MetaData "DescribeWorkspacesResponse" "Network.AWS.WorkSpaces.DescribeWorkspaces" "amazonka-workspaces-1.4.4-IQnza0NWtgfKfbbLfSFOLb" False) (C1 (MetaCons "DescribeWorkspacesResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dwrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dwrsWorkspaces") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Workspace]))) (S1 (MetaSel (Just Symbol "_dwrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

dwrsNextToken :: Lens' DescribeWorkspacesResponse (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.

dwrsWorkspaces :: Lens' DescribeWorkspacesResponse [Workspace] Source #

An array of structures that contain the information about the WorkSpaces.

Because the CreateWorkspaces operation is asynchronous, some of this information may be incomplete for a newly-created WorkSpace.