ListCallAnalyticsCategories - Amazon Transcribe

ListCallAnalyticsCategories

Provides more information about the call analytics categories that you've created. You can use the information in this list to find a specific category. You can then use the GetCallAnalyticsCategory operation to get more information about it.

Request Syntax

{ "MaxResults": number, "NextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxResults

The maximum number of categories to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

When included, NextTokenfetches the next set of categories if the result of the previous request was truncated.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .+

Required: No

Response Syntax

{ "Categories": [ { "CategoryName": "string", "CreateTime": number, "LastUpdateTime": number, "Rules": [ { "InterruptionFilter": { "AbsoluteTimeRange": { "EndTime": number, "First": number, "Last": number, "StartTime": number }, "Negate": boolean, "ParticipantRole": "string", "RelativeTimeRange": { "EndPercentage": number, "First": number, "Last": number, "StartPercentage": number }, "Threshold": number }, "NonTalkTimeFilter": { "AbsoluteTimeRange": { "EndTime": number, "First": number, "Last": number, "StartTime": number }, "Negate": boolean, "RelativeTimeRange": { "EndPercentage": number, "First": number, "Last": number, "StartPercentage": number }, "Threshold": number }, "SentimentFilter": { "AbsoluteTimeRange": { "EndTime": number, "First": number, "Last": number, "StartTime": number }, "Negate": boolean, "ParticipantRole": "string", "RelativeTimeRange": { "EndPercentage": number, "First": number, "Last": number, "StartPercentage": number }, "Sentiments": [ "string" ] }, "TranscriptFilter": { "AbsoluteTimeRange": { "EndTime": number, "First": number, "Last": number, "StartTime": number }, "Negate": boolean, "ParticipantRole": "string", "RelativeTimeRange": { "EndPercentage": number, "First": number, "Last": number, "StartPercentage": number }, "Targets": [ "string" ], "TranscriptFilterType": "string" } } ] } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Categories

A list of objects containing information about analytics categories.

Type: Array of CategoryProperties objects

NextToken

The ListCallAnalyticsCategories operation returns a page of jobs at a time. The maximum size of the list is set by the MaxResults parameter. If there are more categories in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the ListCallAnalyticsCategories operation to return the next page of analytics categories.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .+

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

HTTP Status Code: 400

InternalFailureException

There was an internal error. Check the error message and try your request again.

HTTP Status Code: 500

LimitExceededException

Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: