| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.RedshiftServerLess.ListWorkgroups
Description
Returns information about a list of specified workgroups.
This operation returns paginated results.
Synopsis
- data ListWorkgroups = ListWorkgroups' {}
- newListWorkgroups :: ListWorkgroups
- listWorkgroups_maxResults :: Lens' ListWorkgroups (Maybe Natural)
- listWorkgroups_nextToken :: Lens' ListWorkgroups (Maybe Text)
- data ListWorkgroupsResponse = ListWorkgroupsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- workgroups :: [Workgroup]
- newListWorkgroupsResponse :: Int -> ListWorkgroupsResponse
- listWorkgroupsResponse_nextToken :: Lens' ListWorkgroupsResponse (Maybe Text)
- listWorkgroupsResponse_httpStatus :: Lens' ListWorkgroupsResponse Int
- listWorkgroupsResponse_workgroups :: Lens' ListWorkgroupsResponse [Workgroup]
Creating a Request
data ListWorkgroups Source #
See: newListWorkgroups smart constructor.
Constructors
| ListWorkgroups' | |
Fields
| |
Instances
newListWorkgroups :: ListWorkgroups Source #
Create a value of ListWorkgroups 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:maxResults:ListWorkgroups', listWorkgroups_maxResults - An optional parameter that specifies the maximum number of results to
return. You can use nextToken to display the next page of results.
ListWorkgroups, listWorkgroups_nextToken - If your initial ListWorkgroups operation returns a nextToken, you can
include the returned nextToken in following ListNamespaces operations,
which returns results in the next page.
Request Lenses
listWorkgroups_maxResults :: Lens' ListWorkgroups (Maybe Natural) Source #
An optional parameter that specifies the maximum number of results to
return. You can use nextToken to display the next page of results.
listWorkgroups_nextToken :: Lens' ListWorkgroups (Maybe Text) Source #
If your initial ListWorkgroups operation returns a nextToken, you can
include the returned nextToken in following ListNamespaces operations,
which returns results in the next page.
Destructuring the Response
data ListWorkgroupsResponse Source #
See: newListWorkgroupsResponse smart constructor.
Constructors
| ListWorkgroupsResponse' | |
Fields
| |
Instances
newListWorkgroupsResponse Source #
Create a value of ListWorkgroupsResponse 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:
ListWorkgroups, listWorkgroupsResponse_nextToken - If nextToken is returned, there are more results available. The value
of nextToken is a unique pagination token for each page. To retrieve
the next page, make the call again using the returned token.
$sel:httpStatus:ListWorkgroupsResponse', listWorkgroupsResponse_httpStatus - The response's http status code.
$sel:workgroups:ListWorkgroupsResponse', listWorkgroupsResponse_workgroups - The returned array of workgroups.
Response Lenses
listWorkgroupsResponse_nextToken :: Lens' ListWorkgroupsResponse (Maybe Text) Source #
If nextToken is returned, there are more results available. The value
of nextToken is a unique pagination token for each page. To retrieve
the next page, make the call again using the returned token.
listWorkgroupsResponse_httpStatus :: Lens' ListWorkgroupsResponse Int Source #
The response's http status code.
listWorkgroupsResponse_workgroups :: Lens' ListWorkgroupsResponse [Workgroup] Source #
The returned array of workgroups.