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 |
Returns a list of profiling groups. The profiling groups are returned as ProfilingGroupDescription objects.
Synopsis
- data ListProfilingGroups = ListProfilingGroups' {}
- newListProfilingGroups :: ListProfilingGroups
- listProfilingGroups_includeDescription :: Lens' ListProfilingGroups (Maybe Bool)
- listProfilingGroups_nextToken :: Lens' ListProfilingGroups (Maybe Text)
- listProfilingGroups_maxResults :: Lens' ListProfilingGroups (Maybe Natural)
- data ListProfilingGroupsResponse = ListProfilingGroupsResponse' {}
- newListProfilingGroupsResponse :: Int -> ListProfilingGroupsResponse
- listProfilingGroupsResponse_nextToken :: Lens' ListProfilingGroupsResponse (Maybe Text)
- listProfilingGroupsResponse_profilingGroups :: Lens' ListProfilingGroupsResponse (Maybe [ProfilingGroupDescription])
- listProfilingGroupsResponse_httpStatus :: Lens' ListProfilingGroupsResponse Int
- listProfilingGroupsResponse_profilingGroupNames :: Lens' ListProfilingGroupsResponse [Text]
Creating a Request
data ListProfilingGroups Source #
The structure representing the listProfilingGroupsRequest.
See: newListProfilingGroups
smart constructor.
ListProfilingGroups' | |
|
Instances
newListProfilingGroups :: ListProfilingGroups Source #
Create a value of ListProfilingGroups
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:includeDescription:ListProfilingGroups'
, listProfilingGroups_includeDescription
- A Boolean
value indicating whether to include a description. If
true
, then a list of
ProfilingGroupDescription
objects that contain detailed information about profiling groups is
returned. If false
, then a list of profiling group names is returned.
$sel:nextToken:ListProfilingGroups'
, listProfilingGroups_nextToken
- The nextToken
value returned from a previous paginated
ListProfilingGroups
request where maxResults
was used and the
results exceeded the value of that parameter. Pagination continues from
the end of the previous results that returned the nextToken
value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
$sel:maxResults:ListProfilingGroups'
, listProfilingGroups_maxResults
- The maximum number of profiling groups results returned by
ListProfilingGroups
in paginated output. When this parameter is used,
ListProfilingGroups
only returns maxResults
results in a single page
along with a nextToken
response element. The remaining results of the
initial request can be seen by sending another ListProfilingGroups
request with the returned nextToken
value.
Request Lenses
listProfilingGroups_includeDescription :: Lens' ListProfilingGroups (Maybe Bool) Source #
A Boolean
value indicating whether to include a description. If
true
, then a list of
ProfilingGroupDescription
objects that contain detailed information about profiling groups is
returned. If false
, then a list of profiling group names is returned.
listProfilingGroups_nextToken :: Lens' ListProfilingGroups (Maybe Text) Source #
The nextToken
value returned from a previous paginated
ListProfilingGroups
request where maxResults
was used and the
results exceeded the value of that parameter. Pagination continues from
the end of the previous results that returned the nextToken
value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
listProfilingGroups_maxResults :: Lens' ListProfilingGroups (Maybe Natural) Source #
The maximum number of profiling groups results returned by
ListProfilingGroups
in paginated output. When this parameter is used,
ListProfilingGroups
only returns maxResults
results in a single page
along with a nextToken
response element. The remaining results of the
initial request can be seen by sending another ListProfilingGroups
request with the returned nextToken
value.
Destructuring the Response
data ListProfilingGroupsResponse Source #
The structure representing the listProfilingGroupsResponse.
See: newListProfilingGroupsResponse
smart constructor.
ListProfilingGroupsResponse' | |
|
Instances
newListProfilingGroupsResponse Source #
Create a value of ListProfilingGroupsResponse
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:ListProfilingGroups'
, listProfilingGroupsResponse_nextToken
- The nextToken
value to include in a future ListProfilingGroups
request. When the results of a ListProfilingGroups
request exceed
maxResults
, this value can be used to retrieve the next page of
results. This value is null
when there are no more results to return.
$sel:profilingGroups:ListProfilingGroupsResponse'
, listProfilingGroupsResponse_profilingGroups
- A returned list
ProfilingGroupDescription
objects. A list of
ProfilingGroupDescription
objects is returned only if includeDescription
is true
, otherwise a
list of profiling group names is returned.
$sel:httpStatus:ListProfilingGroupsResponse'
, listProfilingGroupsResponse_httpStatus
- The response's http status code.
$sel:profilingGroupNames:ListProfilingGroupsResponse'
, listProfilingGroupsResponse_profilingGroupNames
- A returned list of profiling group names. A list of the names is
returned only if includeDescription
is false
, otherwise a list of
ProfilingGroupDescription
objects is returned.
Response Lenses
listProfilingGroupsResponse_nextToken :: Lens' ListProfilingGroupsResponse (Maybe Text) Source #
The nextToken
value to include in a future ListProfilingGroups
request. When the results of a ListProfilingGroups
request exceed
maxResults
, this value can be used to retrieve the next page of
results. This value is null
when there are no more results to return.
listProfilingGroupsResponse_profilingGroups :: Lens' ListProfilingGroupsResponse (Maybe [ProfilingGroupDescription]) Source #
A returned list
ProfilingGroupDescription
objects. A list of
ProfilingGroupDescription
objects is returned only if includeDescription
is true
, otherwise a
list of profiling group names is returned.
listProfilingGroupsResponse_httpStatus :: Lens' ListProfilingGroupsResponse Int Source #
The response's http status code.
listProfilingGroupsResponse_profilingGroupNames :: Lens' ListProfilingGroupsResponse [Text] Source #
A returned list of profiling group names. A list of the names is
returned only if includeDescription
is false
, otherwise a list of
ProfilingGroupDescription
objects is returned.