| 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.AlexaBusiness.SearchSkillGroups
Description
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
This operation returns paginated results.
Synopsis
- data SearchSkillGroups = SearchSkillGroups' {}
- newSearchSkillGroups :: SearchSkillGroups
- searchSkillGroups_filters :: Lens' SearchSkillGroups (Maybe [Filter])
- searchSkillGroups_maxResults :: Lens' SearchSkillGroups (Maybe Natural)
- searchSkillGroups_nextToken :: Lens' SearchSkillGroups (Maybe Text)
- searchSkillGroups_sortCriteria :: Lens' SearchSkillGroups (Maybe [Sort])
- data SearchSkillGroupsResponse = SearchSkillGroupsResponse' {
- nextToken :: Maybe Text
- skillGroups :: Maybe [SkillGroupData]
- totalCount :: Maybe Int
- httpStatus :: Int
- newSearchSkillGroupsResponse :: Int -> SearchSkillGroupsResponse
- searchSkillGroupsResponse_nextToken :: Lens' SearchSkillGroupsResponse (Maybe Text)
- searchSkillGroupsResponse_skillGroups :: Lens' SearchSkillGroupsResponse (Maybe [SkillGroupData])
- searchSkillGroupsResponse_totalCount :: Lens' SearchSkillGroupsResponse (Maybe Int)
- searchSkillGroupsResponse_httpStatus :: Lens' SearchSkillGroupsResponse Int
Creating a Request
data SearchSkillGroups Source #
See: newSearchSkillGroups smart constructor.
Constructors
| SearchSkillGroups' | |
Fields
| |
Instances
newSearchSkillGroups :: SearchSkillGroups Source #
Create a value of SearchSkillGroups 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:filters:SearchSkillGroups', searchSkillGroups_filters - The filters to use to list a specified set of skill groups. The
supported filter key is SkillGroupName.
$sel:maxResults:SearchSkillGroups', searchSkillGroups_maxResults - The maximum number of results to include in the response. If more
results exist than the specified MaxResults value, a token is included
in the response so that the remaining results can be retrieved.
SearchSkillGroups, searchSkillGroups_nextToken - An optional token returned from a prior request. Use this token for
pagination of results from this action. If this parameter is specified,
the response includes only results beyond the token, up to the value
specified by MaxResults. Required.
$sel:sortCriteria:SearchSkillGroups', searchSkillGroups_sortCriteria - The sort order to use in listing the specified set of skill groups. The
supported sort key is SkillGroupName.
Request Lenses
searchSkillGroups_filters :: Lens' SearchSkillGroups (Maybe [Filter]) Source #
The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName.
searchSkillGroups_maxResults :: Lens' SearchSkillGroups (Maybe Natural) Source #
The maximum number of results to include in the response. If more
results exist than the specified MaxResults value, a token is included
in the response so that the remaining results can be retrieved.
searchSkillGroups_nextToken :: Lens' SearchSkillGroups (Maybe Text) Source #
An optional token returned from a prior request. Use this token for
pagination of results from this action. If this parameter is specified,
the response includes only results beyond the token, up to the value
specified by MaxResults. Required.
searchSkillGroups_sortCriteria :: Lens' SearchSkillGroups (Maybe [Sort]) Source #
The sort order to use in listing the specified set of skill groups. The supported sort key is SkillGroupName.
Destructuring the Response
data SearchSkillGroupsResponse Source #
See: newSearchSkillGroupsResponse smart constructor.
Constructors
| SearchSkillGroupsResponse' | |
Fields
| |
Instances
newSearchSkillGroupsResponse Source #
Create a value of SearchSkillGroupsResponse 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:
SearchSkillGroups, searchSkillGroupsResponse_nextToken - The token returned to indicate that there is more data available.
$sel:skillGroups:SearchSkillGroupsResponse', searchSkillGroupsResponse_skillGroups - The skill groups that meet the filter criteria, in sort order.
$sel:totalCount:SearchSkillGroupsResponse', searchSkillGroupsResponse_totalCount - The total number of skill groups returned.
$sel:httpStatus:SearchSkillGroupsResponse', searchSkillGroupsResponse_httpStatus - The response's http status code.
Response Lenses
searchSkillGroupsResponse_nextToken :: Lens' SearchSkillGroupsResponse (Maybe Text) Source #
The token returned to indicate that there is more data available.
searchSkillGroupsResponse_skillGroups :: Lens' SearchSkillGroupsResponse (Maybe [SkillGroupData]) Source #
The skill groups that meet the filter criteria, in sort order.
searchSkillGroupsResponse_totalCount :: Lens' SearchSkillGroupsResponse (Maybe Int) Source #
The total number of skill groups returned.
searchSkillGroupsResponse_httpStatus :: Lens' SearchSkillGroupsResponse Int Source #
The response's http status code.