| 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.Athena.ListWorkGroups
Description
Lists available workgroups for the account.
Synopsis
- data ListWorkGroups = ListWorkGroups' {}
- newListWorkGroups :: ListWorkGroups
- listWorkGroups_nextToken :: Lens' ListWorkGroups (Maybe Text)
- listWorkGroups_maxResults :: Lens' ListWorkGroups (Maybe Natural)
- data ListWorkGroupsResponse = ListWorkGroupsResponse' {
- nextToken :: Maybe Text
- workGroups :: Maybe [WorkGroupSummary]
- httpStatus :: Int
- newListWorkGroupsResponse :: Int -> ListWorkGroupsResponse
- listWorkGroupsResponse_nextToken :: Lens' ListWorkGroupsResponse (Maybe Text)
- listWorkGroupsResponse_workGroups :: Lens' ListWorkGroupsResponse (Maybe [WorkGroupSummary])
- listWorkGroupsResponse_httpStatus :: Lens' ListWorkGroupsResponse Int
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:nextToken:ListWorkGroups', listWorkGroups_nextToken - A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken from the response object of the
previous page call.
$sel:maxResults:ListWorkGroups', listWorkGroups_maxResults - The maximum number of workgroups to return in this request.
Request Lenses
listWorkGroups_nextToken :: Lens' ListWorkGroups (Maybe Text) Source #
A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken from the response object of the
previous page call.
listWorkGroups_maxResults :: Lens' ListWorkGroups (Maybe Natural) Source #
The maximum number of workgroups to return in this request.
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:
$sel:nextToken:ListWorkGroups', listWorkGroupsResponse_nextToken - A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken from the response object of the
previous page call.
$sel:workGroups:ListWorkGroupsResponse', listWorkGroupsResponse_workGroups - A list of WorkGroupSummary objects that include the names, descriptions,
creation times, and states for each workgroup.
$sel:httpStatus:ListWorkGroupsResponse', listWorkGroupsResponse_httpStatus - The response's http status code.
Response Lenses
listWorkGroupsResponse_nextToken :: Lens' ListWorkGroupsResponse (Maybe Text) Source #
A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken from the response object of the
previous page call.
listWorkGroupsResponse_workGroups :: Lens' ListWorkGroupsResponse (Maybe [WorkGroupSummary]) Source #
A list of WorkGroupSummary objects that include the names, descriptions, creation times, and states for each workgroup.
listWorkGroupsResponse_httpStatus :: Lens' ListWorkGroupsResponse Int Source #
The response's http status code.