| Copyright | (c) 2013-2021 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 |
Amazonka.AMP.ListWorkspaces
Description
Lists all AMP workspaces, including workspaces being created or deleted.
This operation returns paginated results.
Synopsis
- data ListWorkspaces = ListWorkspaces' {}
- newListWorkspaces :: ListWorkspaces
- listWorkspaces_alias :: Lens' ListWorkspaces (Maybe Text)
- listWorkspaces_nextToken :: Lens' ListWorkspaces (Maybe Text)
- listWorkspaces_maxResults :: Lens' ListWorkspaces (Maybe Natural)
- data ListWorkspacesResponse = ListWorkspacesResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- workspaces :: [WorkspaceSummary]
- newListWorkspacesResponse :: Int -> ListWorkspacesResponse
- listWorkspacesResponse_nextToken :: Lens' ListWorkspacesResponse (Maybe Text)
- listWorkspacesResponse_httpStatus :: Lens' ListWorkspacesResponse Int
- listWorkspacesResponse_workspaces :: Lens' ListWorkspacesResponse [WorkspaceSummary]
Creating a Request
data ListWorkspaces Source #
Represents the input of a ListWorkspaces operation.
See: newListWorkspaces smart constructor.
Constructors
| ListWorkspaces' | |
Fields
| |
Instances
newListWorkspaces :: ListWorkspaces Source #
Create a value of ListWorkspaces with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:alias:ListWorkspaces', listWorkspaces_alias - Optional filter for workspace alias. Only the workspaces with aliases
that begin with this value will be returned.
$sel:nextToken:ListWorkspaces', listWorkspaces_nextToken - Pagination token to request the next page in a paginated list. This
token is obtained from the output of the previous ListWorkspaces
request.
$sel:maxResults:ListWorkspaces', listWorkspaces_maxResults - Maximum results to return in response (default=100, maximum=1000).
Request Lenses
listWorkspaces_alias :: Lens' ListWorkspaces (Maybe Text) Source #
Optional filter for workspace alias. Only the workspaces with aliases that begin with this value will be returned.
listWorkspaces_nextToken :: Lens' ListWorkspaces (Maybe Text) Source #
Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListWorkspaces request.
listWorkspaces_maxResults :: Lens' ListWorkspaces (Maybe Natural) Source #
Maximum results to return in response (default=100, maximum=1000).
Destructuring the Response
data ListWorkspacesResponse Source #
Represents the output of a ListWorkspaces operation.
See: newListWorkspacesResponse smart constructor.
Constructors
| ListWorkspacesResponse' | |
Fields
| |
Instances
newListWorkspacesResponse Source #
Create a value of ListWorkspacesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListWorkspaces', listWorkspacesResponse_nextToken - Pagination token to use when requesting the next page in this list.
$sel:httpStatus:ListWorkspacesResponse', listWorkspacesResponse_httpStatus - The response's http status code.
$sel:workspaces:ListWorkspacesResponse', listWorkspacesResponse_workspaces - The list of existing workspaces, including those undergoing creation or
deletion.
Response Lenses
listWorkspacesResponse_nextToken :: Lens' ListWorkspacesResponse (Maybe Text) Source #
Pagination token to use when requesting the next page in this list.
listWorkspacesResponse_httpStatus :: Lens' ListWorkspacesResponse Int Source #
The response's http status code.
listWorkspacesResponse_workspaces :: Lens' ListWorkspacesResponse [WorkspaceSummary] Source #
The list of existing workspaces, including those undergoing creation or deletion.