Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
See: AWS API Reference for DescribeWorkspaces.
- describeWorkspaces :: DescribeWorkspaces
- data DescribeWorkspaces
- dwDirectoryId :: Lens' DescribeWorkspaces (Maybe Text)
- dwWorkspaceIds :: Lens' DescribeWorkspaces (Maybe (NonEmpty Text))
- dwUserName :: Lens' DescribeWorkspaces (Maybe Text)
- dwBundleId :: Lens' DescribeWorkspaces (Maybe Text)
- dwNextToken :: Lens' DescribeWorkspaces (Maybe Text)
- dwLimit :: Lens' DescribeWorkspaces (Maybe Natural)
- describeWorkspacesResponse :: Int -> DescribeWorkspacesResponse
- data DescribeWorkspacesResponse
- dwrsNextToken :: Lens' DescribeWorkspacesResponse (Maybe Text)
- dwrsWorkspaces :: Lens' DescribeWorkspacesResponse [Workspace]
- dwrsStatus :: Lens' DescribeWorkspacesResponse Int
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.
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 returned by CreateWorkspaces is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information will be returned.
dwUserName :: Lens' DescribeWorkspaces (Maybe Text) Source
Used with the DirectoryId
parameter to specify the directory user for
which 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.
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.
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 timeframe.
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.
dwrsStatus :: Lens' DescribeWorkspacesResponse Int Source
The response status code.