Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
Synopsis
- 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]
- dwrsResponseStatus :: 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:
dwDirectoryId
- The ID of the directory. In addition, you can optionally specify a specific directory user (seeUserName
). 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 theCreateWorkspaces
operation is asynchronous, the identifier it returns is not immediately available. If you immediately callDescribeWorkspaces
with this identifier, no information is returned.dwUserName
- The name of the directory user. You must specify this parameter withDirectoryId
.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 Source #
See: describeWorkspaces
smart constructor.
Instances
Request Lenses
dwDirectoryId :: Lens' DescribeWorkspaces (Maybe Text) Source #
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)) Source #
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) Source #
The name of the directory user. You must specify this parameter with DirectoryId
.
dwBundleId :: Lens' DescribeWorkspaces (Maybe Text) Source #
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) Source #
The token for the next set of results. (You received this token from a previous 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:
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. BecauseCreateWorkspaces
is an asynchronous operation, some of the returned information could be incomplete.dwrsResponseStatus
- -- | The response status code.
data DescribeWorkspacesResponse Source #
See: describeWorkspacesResponse
smart constructor.
Instances
Response Lenses
dwrsNextToken :: Lens' DescribeWorkspacesResponse (Maybe Text) Source #
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] Source #
Information about the WorkSpaces. Because CreateWorkspaces
is an asynchronous operation, some of the returned information could be incomplete.
dwrsResponseStatus :: Lens' DescribeWorkspacesResponse Int Source #
- - | The response status code.