Network.AWS.WorkSpaces.DescribeWorkspaces

Describes the specified WorkSpaces.

You can filter the results using bundle ID, directory ID, or owner, but you can specify only one filter at a time.

This operation returns paginated results.

Creating a Request

describeWorkspaces :: DescribeWorkspaces

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:

• dwDirectoryId - The ID of the directory. In addition, you can optionally specify a specific directory user (see UserName ). This parameter cannot be combined with any other filter.
• dwWorkspaceIds - The IDs of the WorkSpaces. This parameter cannot be combined with any other filter. 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 - The name of the directory user. You must specify this parameter with DirectoryId .
• dwBundleId - The ID of the bundle. All WorkSpaces that are created from this bundle are retrieved. This parameter cannot be combined with any other filter.
• dwNextToken - The token for the next set of results. (You received this token from a previous call.)
• dwLimit - The maximum number of items to return.

data DescribeWorkspaces

See: describeWorkspaces smart constructor.

Instances

Eq DescribeWorkspaces

Methods

(==) :: DescribeWorkspaces -> DescribeWorkspaces -> Bool

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

Data DescribeWorkspaces

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

Methods

readsPrec :: Int -> ReadS DescribeWorkspaces

readList :: ReadS [DescribeWorkspaces]

readPrec :: ReadPrec DescribeWorkspaces

readListPrec :: ReadPrec [DescribeWorkspaces]

Show DescribeWorkspaces

Methods

showsPrec :: Int -> DescribeWorkspaces -> ShowS

show :: DescribeWorkspaces -> String

showList :: [DescribeWorkspaces] -> ShowS

Generic DescribeWorkspaces

Associated Types

type Rep DescribeWorkspaces :: * -> *

Methods

from :: DescribeWorkspaces -> Rep DescribeWorkspaces x

to :: Rep DescribeWorkspaces x -> DescribeWorkspaces

Hashable DescribeWorkspaces

Methods

hashWithSalt :: Int -> DescribeWorkspaces -> Int

hash :: DescribeWorkspaces -> Int

ToJSON DescribeWorkspaces

Methods

toJSON :: DescribeWorkspaces -> Value

toEncoding :: DescribeWorkspaces -> Encoding

toJSONList :: [DescribeWorkspaces] -> Value

toEncodingList :: [DescribeWorkspaces] -> Encoding

NFData DescribeWorkspaces

Methods

rnf :: DescribeWorkspaces -> ()

AWSPager DescribeWorkspaces

Methods

page :: DescribeWorkspaces -> Rs DescribeWorkspaces -> Maybe DescribeWorkspaces

AWSRequest DescribeWorkspaces

Associated Types

type Rs DescribeWorkspaces :: *

Methods

request :: DescribeWorkspaces -> Request DescribeWorkspaces

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeWorkspaces -> ClientResponse -> m (Response DescribeWorkspaces)

ToHeaders DescribeWorkspaces

Methods

toHeaders :: DescribeWorkspaces -> [Header]

ToPath DescribeWorkspaces

Methods

toPath :: DescribeWorkspaces -> ByteString

ToQuery DescribeWorkspaces

Methods

toQuery :: DescribeWorkspaces -> QueryString

type Rep DescribeWorkspaces

type Rep DescribeWorkspaces = D1 * (MetaData "DescribeWorkspaces" "Network.AWS.WorkSpaces.DescribeWorkspaces" "amazonka-workspaces-1.6.0-AwHYwyt6ovyA3XlaTDhfeV" 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

type Rs DescribeWorkspaces = DescribeWorkspacesResponse

Request Lenses

dwDirectoryId :: Lens' DescribeWorkspaces (Maybe Text)

The ID of the directory. In addition, you can optionally specify a specific directory user (see UserName ). This parameter cannot be combined with any other filter.

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

The IDs of the WorkSpaces. This parameter cannot be combined with any other filter. 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)

The name of the directory user. You must specify this parameter with DirectoryId .

dwBundleId :: Lens' DescribeWorkspaces (Maybe Text)

The ID of the bundle. All WorkSpaces that are created from this bundle are retrieved. This parameter cannot be combined with any other filter.

dwNextToken :: Lens' DescribeWorkspaces (Maybe Text)

The token for the next set of results. (You received this token from a previous call.)

dwLimit :: Lens' DescribeWorkspaces (Maybe Natural)

The maximum number of items to return.

Destructuring the Response

describeWorkspacesResponse

Arguments

:: Int

dwrsResponseStatus

-> DescribeWorkspacesResponse

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:

• dwrsNextToken - The token to use to retrieve the next set of results, or null if there are no more results available. This token is valid for one day and must be used within that time frame.
• dwrsWorkspaces - Information about the WorkSpaces. Because CreateWorkspaces is an asynchronous operation, some of the returned information could be incomplete.
• dwrsResponseStatus - -- | The response status code.

data DescribeWorkspacesResponse

See: describeWorkspacesResponse smart constructor.

Instances

Eq DescribeWorkspacesResponse

Methods

(==) :: DescribeWorkspacesResponse -> DescribeWorkspacesResponse -> Bool

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

Data DescribeWorkspacesResponse

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

Methods

readsPrec :: Int -> ReadS DescribeWorkspacesResponse

readList :: ReadS [DescribeWorkspacesResponse]

readPrec :: ReadPrec DescribeWorkspacesResponse

readListPrec :: ReadPrec [DescribeWorkspacesResponse]

Show DescribeWorkspacesResponse

Methods

showsPrec :: Int -> DescribeWorkspacesResponse -> ShowS

show :: DescribeWorkspacesResponse -> String

showList :: [DescribeWorkspacesResponse] -> ShowS

Generic DescribeWorkspacesResponse

Associated Types

type Rep DescribeWorkspacesResponse :: * -> *

Methods

from :: DescribeWorkspacesResponse -> Rep DescribeWorkspacesResponse x

to :: Rep DescribeWorkspacesResponse x -> DescribeWorkspacesResponse

NFData DescribeWorkspacesResponse

Methods

rnf :: DescribeWorkspacesResponse -> ()

type Rep DescribeWorkspacesResponse

type Rep DescribeWorkspacesResponse = D1 * (MetaData "DescribeWorkspacesResponse" "Network.AWS.WorkSpaces.DescribeWorkspaces" "amazonka-workspaces-1.6.0-AwHYwyt6ovyA3XlaTDhfeV" 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 DecidedStrict) (Rec0 * Int)))))

Response Lenses

dwrsNextToken :: Lens' DescribeWorkspacesResponse (Maybe Text)

The token to use to retrieve the next set of results, or null if there are no more results available. This token is valid for one day and must be used within that time frame.

dwrsWorkspaces :: Lens' DescribeWorkspacesResponse [Workspace]

Information about the WorkSpaces. Because CreateWorkspaces is an asynchronous operation, some of the returned information could be incomplete.

dwrsResponseStatus :: Lens' DescribeWorkspacesResponse Int

• - | The response status code.