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 |
Returns a list of the groups that the specified canary is associated with. The canary that you specify must be in the current Region.
Synopsis
- data ListAssociatedGroups = ListAssociatedGroups' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- resourceArn :: Text
- newListAssociatedGroups :: Text -> ListAssociatedGroups
- listAssociatedGroups_maxResults :: Lens' ListAssociatedGroups (Maybe Natural)
- listAssociatedGroups_nextToken :: Lens' ListAssociatedGroups (Maybe Text)
- listAssociatedGroups_resourceArn :: Lens' ListAssociatedGroups Text
- data ListAssociatedGroupsResponse = ListAssociatedGroupsResponse' {
- groups :: Maybe [GroupSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListAssociatedGroupsResponse :: Int -> ListAssociatedGroupsResponse
- listAssociatedGroupsResponse_groups :: Lens' ListAssociatedGroupsResponse (Maybe [GroupSummary])
- listAssociatedGroupsResponse_nextToken :: Lens' ListAssociatedGroupsResponse (Maybe Text)
- listAssociatedGroupsResponse_httpStatus :: Lens' ListAssociatedGroupsResponse Int
Creating a Request
data ListAssociatedGroups Source #
See: newListAssociatedGroups
smart constructor.
ListAssociatedGroups' | |
|
Instances
newListAssociatedGroups Source #
Create a value of ListAssociatedGroups
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:ListAssociatedGroups'
, listAssociatedGroups_maxResults
- Specify this parameter to limit how many groups are returned each time
you use the ListAssociatedGroups
operation. If you omit this
parameter, the default of 20 is used.
ListAssociatedGroups
, listAssociatedGroups_nextToken
- A token that indicates that there is more data available. You can use
this token in a subsequent operation to retrieve the next set of
results.
$sel:resourceArn:ListAssociatedGroups'
, listAssociatedGroups_resourceArn
- The ARN of the canary that you want to view groups for.
Request Lenses
listAssociatedGroups_maxResults :: Lens' ListAssociatedGroups (Maybe Natural) Source #
Specify this parameter to limit how many groups are returned each time
you use the ListAssociatedGroups
operation. If you omit this
parameter, the default of 20 is used.
listAssociatedGroups_nextToken :: Lens' ListAssociatedGroups (Maybe Text) Source #
A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.
listAssociatedGroups_resourceArn :: Lens' ListAssociatedGroups Text Source #
The ARN of the canary that you want to view groups for.
Destructuring the Response
data ListAssociatedGroupsResponse Source #
See: newListAssociatedGroupsResponse
smart constructor.
ListAssociatedGroupsResponse' | |
|
Instances
newListAssociatedGroupsResponse Source #
Create a value of ListAssociatedGroupsResponse
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:groups:ListAssociatedGroupsResponse'
, listAssociatedGroupsResponse_groups
- An array of structures that contain information about the groups that
this canary is associated with.
ListAssociatedGroups
, listAssociatedGroupsResponse_nextToken
- A token that indicates that there is more data available. You can use
this token in a subsequent ListAssociatedGroups
operation to retrieve
the next set of results.
$sel:httpStatus:ListAssociatedGroupsResponse'
, listAssociatedGroupsResponse_httpStatus
- The response's http status code.
Response Lenses
listAssociatedGroupsResponse_groups :: Lens' ListAssociatedGroupsResponse (Maybe [GroupSummary]) Source #
An array of structures that contain information about the groups that this canary is associated with.
listAssociatedGroupsResponse_nextToken :: Lens' ListAssociatedGroupsResponse (Maybe Text) Source #
A token that indicates that there is more data available. You can use
this token in a subsequent ListAssociatedGroups
operation to retrieve
the next set of results.
listAssociatedGroupsResponse_httpStatus :: Lens' ListAssociatedGroupsResponse Int Source #
The response's http status code.