amazonka-transcribe-2.0: Amazon Transcribe Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Transcribe.ListCallAnalyticsCategories

Description

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

Creating a Request

data ListCallAnalyticsCategories Source #

See: newListCallAnalyticsCategories smart constructor.

Constructors

ListCallAnalyticsCategories' 

Fields

  • maxResults :: Maybe Natural

    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.

  • nextToken :: Maybe Text

    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.

Instances

Instances details
ToJSON ListCallAnalyticsCategories Source # 
Instance details

Defined in Amazonka.Transcribe.ListCallAnalyticsCategories

ToHeaders ListCallAnalyticsCategories Source # 
Instance details

Defined in Amazonka.Transcribe.ListCallAnalyticsCategories

ToPath ListCallAnalyticsCategories Source # 
Instance details

Defined in Amazonka.Transcribe.ListCallAnalyticsCategories

ToQuery ListCallAnalyticsCategories Source # 
Instance details

Defined in Amazonka.Transcribe.ListCallAnalyticsCategories

AWSRequest ListCallAnalyticsCategories Source # 
Instance details

Defined in Amazonka.Transcribe.ListCallAnalyticsCategories

Generic ListCallAnalyticsCategories Source # 
Instance details

Defined in Amazonka.Transcribe.ListCallAnalyticsCategories

Associated Types

type Rep ListCallAnalyticsCategories :: Type -> Type #

Read ListCallAnalyticsCategories Source # 
Instance details

Defined in Amazonka.Transcribe.ListCallAnalyticsCategories

Show ListCallAnalyticsCategories Source # 
Instance details

Defined in Amazonka.Transcribe.ListCallAnalyticsCategories

NFData ListCallAnalyticsCategories Source # 
Instance details

Defined in Amazonka.Transcribe.ListCallAnalyticsCategories

Eq ListCallAnalyticsCategories Source # 
Instance details

Defined in Amazonka.Transcribe.ListCallAnalyticsCategories

Hashable ListCallAnalyticsCategories Source # 
Instance details

Defined in Amazonka.Transcribe.ListCallAnalyticsCategories

type AWSResponse ListCallAnalyticsCategories Source # 
Instance details

Defined in Amazonka.Transcribe.ListCallAnalyticsCategories

type Rep ListCallAnalyticsCategories Source # 
Instance details

Defined in Amazonka.Transcribe.ListCallAnalyticsCategories

type Rep ListCallAnalyticsCategories = D1 ('MetaData "ListCallAnalyticsCategories" "Amazonka.Transcribe.ListCallAnalyticsCategories" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "ListCallAnalyticsCategories'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

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 #

Constructors

ListCallAnalyticsCategoriesResponse' 

Fields

  • categories :: Maybe [CategoryProperties]

    Provides detailed information about your Call Analytics categories, including all the rules associated with each category.

  • nextToken :: Maybe Text

    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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListCallAnalyticsCategoriesResponse Source # 
Instance details

Defined in Amazonka.Transcribe.ListCallAnalyticsCategories

Read ListCallAnalyticsCategoriesResponse Source # 
Instance details

Defined in Amazonka.Transcribe.ListCallAnalyticsCategories

Show ListCallAnalyticsCategoriesResponse Source # 
Instance details

Defined in Amazonka.Transcribe.ListCallAnalyticsCategories

NFData ListCallAnalyticsCategoriesResponse Source # 
Instance details

Defined in Amazonka.Transcribe.ListCallAnalyticsCategories

Eq ListCallAnalyticsCategoriesResponse Source # 
Instance details

Defined in Amazonka.Transcribe.ListCallAnalyticsCategories

type Rep ListCallAnalyticsCategoriesResponse Source # 
Instance details

Defined in Amazonka.Transcribe.ListCallAnalyticsCategories

type Rep ListCallAnalyticsCategoriesResponse = D1 ('MetaData "ListCallAnalyticsCategoriesResponse" "Amazonka.Transcribe.ListCallAnalyticsCategories" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "ListCallAnalyticsCategoriesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "categories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CategoryProperties])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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.