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 groups specified by query.
Synopsis
- describeGroups :: Text -> DescribeGroups
- data DescribeGroups
- dgAuthenticationToken :: Lens' DescribeGroups (Maybe Text)
- dgMarker :: Lens' DescribeGroups (Maybe Text)
- dgLimit :: Lens' DescribeGroups (Maybe Natural)
- dgOrganizationId :: Lens' DescribeGroups (Maybe Text)
- dgSearchQuery :: Lens' DescribeGroups Text
- describeGroupsResponse :: Int -> DescribeGroupsResponse
- data DescribeGroupsResponse
- dgrsGroups :: Lens' DescribeGroupsResponse [GroupMetadata]
- dgrsMarker :: Lens' DescribeGroupsResponse (Maybe Text)
- dgrsResponseStatus :: Lens' DescribeGroupsResponse Int
Creating a Request
Creates a value of DescribeGroups
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dgAuthenticationToken
- Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.dgMarker
- The marker for the next set of results. (You received this marker from a previous call.)dgLimit
- The maximum number of items to return with this call.dgOrganizationId
- The ID of the organization.dgSearchQuery
- A query to describe groups by group name.
data DescribeGroups Source #
See: describeGroups
smart constructor.
Instances
Request Lenses
dgAuthenticationToken :: Lens' DescribeGroups (Maybe Text) Source #
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
dgMarker :: Lens' DescribeGroups (Maybe Text) Source #
The marker for the next set of results. (You received this marker from a previous call.)
dgLimit :: Lens' DescribeGroups (Maybe Natural) Source #
The maximum number of items to return with this call.
dgOrganizationId :: Lens' DescribeGroups (Maybe Text) Source #
The ID of the organization.
dgSearchQuery :: Lens' DescribeGroups Text Source #
A query to describe groups by group name.
Destructuring the Response
describeGroupsResponse Source #
Creates a value of DescribeGroupsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dgrsGroups
- The list of groups.dgrsMarker
- The marker to use when requesting the next set of results. If there are no additional results, the string is empty.dgrsResponseStatus
- -- | The response status code.
data DescribeGroupsResponse Source #
See: describeGroupsResponse
smart constructor.
Instances
Response Lenses
dgrsGroups :: Lens' DescribeGroupsResponse [GroupMetadata] Source #
The list of groups.
dgrsMarker :: Lens' DescribeGroupsResponse (Maybe Text) Source #
The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
dgrsResponseStatus :: Lens' DescribeGroupsResponse Int Source #
- - | The response status code.