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 |
Provides a list of Call Analytics categories, including all rules that make up each category.
To get detailed information about a specific Call Analytics category, use the operation.
Synopsis
- data ListCallAnalyticsCategories = ListCallAnalyticsCategories' {}
- newListCallAnalyticsCategories :: ListCallAnalyticsCategories
- listCallAnalyticsCategories_maxResults :: Lens' ListCallAnalyticsCategories (Maybe Natural)
- listCallAnalyticsCategories_nextToken :: Lens' ListCallAnalyticsCategories (Maybe Text)
- data ListCallAnalyticsCategoriesResponse = ListCallAnalyticsCategoriesResponse' {
- categories :: Maybe [CategoryProperties]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListCallAnalyticsCategoriesResponse :: Int -> ListCallAnalyticsCategoriesResponse
- listCallAnalyticsCategoriesResponse_categories :: Lens' ListCallAnalyticsCategoriesResponse (Maybe [CategoryProperties])
- listCallAnalyticsCategoriesResponse_nextToken :: Lens' ListCallAnalyticsCategoriesResponse (Maybe Text)
- listCallAnalyticsCategoriesResponse_httpStatus :: Lens' ListCallAnalyticsCategoriesResponse Int
Creating a Request
data ListCallAnalyticsCategories Source #
See: newListCallAnalyticsCategories
smart constructor.
ListCallAnalyticsCategories' | |
|
Instances
newListCallAnalyticsCategories :: ListCallAnalyticsCategories Source #
Create a value of ListCallAnalyticsCategories
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:ListCallAnalyticsCategories'
, listCallAnalyticsCategories_maxResults
- The maximum number of Call Analytics categories to return in each page
of results. If there are fewer results than the value that you specify,
only the actual results are returned. If you don't specify a value, a
default of 5 is used.
ListCallAnalyticsCategories
, listCallAnalyticsCategories_nextToken
- If your ListCallAnalyticsCategories
request returns more results than
can be displayed, NextToken
is displayed in the response with an
associated string. To get the next page of results, copy this string and
repeat your request, including NextToken
with the value of the copied
string. Repeat as needed to view all your results.
Request Lenses
listCallAnalyticsCategories_maxResults :: Lens' ListCallAnalyticsCategories (Maybe Natural) Source #
The maximum number of Call Analytics categories to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
listCallAnalyticsCategories_nextToken :: Lens' ListCallAnalyticsCategories (Maybe Text) Source #
If your ListCallAnalyticsCategories
request returns more results than
can be displayed, NextToken
is displayed in the response with an
associated string. To get the next page of results, copy this string and
repeat your request, including NextToken
with the value of the copied
string. Repeat as needed to view all your results.
Destructuring the Response
data ListCallAnalyticsCategoriesResponse Source #
See: newListCallAnalyticsCategoriesResponse
smart constructor.
ListCallAnalyticsCategoriesResponse' | |
|
Instances
newListCallAnalyticsCategoriesResponse Source #
Create a value of ListCallAnalyticsCategoriesResponse
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:categories:ListCallAnalyticsCategoriesResponse'
, listCallAnalyticsCategoriesResponse_categories
- Provides detailed information about your Call Analytics categories,
including all the rules associated with each category.
ListCallAnalyticsCategories
, listCallAnalyticsCategoriesResponse_nextToken
- If NextToken
is present in your response, it indicates that not all
results are displayed. To view the next set of results, copy the string
associated with the NextToken
parameter in your results output, then
run your request again including NextToken
with the value of the
copied string. Repeat as needed to view all your results.
$sel:httpStatus:ListCallAnalyticsCategoriesResponse'
, listCallAnalyticsCategoriesResponse_httpStatus
- The response's http status code.
Response Lenses
listCallAnalyticsCategoriesResponse_categories :: Lens' ListCallAnalyticsCategoriesResponse (Maybe [CategoryProperties]) Source #
Provides detailed information about your Call Analytics categories, including all the rules associated with each category.
listCallAnalyticsCategoriesResponse_nextToken :: Lens' ListCallAnalyticsCategoriesResponse (Maybe Text) Source #
If NextToken
is present in your response, it indicates that not all
results are displayed. To view the next set of results, copy the string
associated with the NextToken
parameter in your results output, then
run your request again including NextToken
with the value of the
copied string. Repeat as needed to view all your results.
listCallAnalyticsCategoriesResponse_httpStatus :: Lens' ListCallAnalyticsCategoriesResponse Int Source #
The response's http status code.