UpdateCallAnalyticsCategory - Transcribe

UpdateCallAnalyticsCategory

Updates the specified Call Analytics category with new rules. Note that the UpdateCallAnalyticsCategory operation overwrites all existing rules contained in the specified category. You cannot append additional rules onto an existing category.

To create a new category, see CreateCallAnalyticsCategory.

Request Syntax

{ "CategoryName": "string", "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" } } ] }

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.

CategoryName

The name of the Call Analytics category you want to update. Category names are case sensitive.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^[0-9a-zA-Z._-]+

Required: Yes

Rules

The rules used for the updated Call Analytics category. The rules you provide in this field replace the ones that are currently being used in the specified category.

Type: Array of Rule objects

Array Members: Minimum number of 1 item. Maximum number of 20 items.

Required: Yes

Response Syntax

{ "CategoryProperties": { "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" } } ] } }

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.

CategoryProperties

Provides you with the properties of the Call Analytics category you specified in your UpdateCallAnalyticsCategory request.

Type: CategoryProperties object

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. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

HTTP Status Code: 400

ConflictException

A resource already exists with this name. Resource names must be unique within an AWS account.

HTTP Status Code: 400

InternalFailureException

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

HTTP Status Code: 500

LimitExceededException

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

HTTP Status Code: 400

NotFoundException

We can't find the requested resource. Check that the specified name is correct and try your request again.

HTTP Status Code: 400

See Also

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