call_analytics_categories

Creates, updates, deletes, gets or lists a call_analytics_categories resource.

Overview

Name	call_analytics_categories
Type	Resource
Id	aws.transcribe.call_analytics_categories

Fields

The following fields are returned by SELECT queries:

get_call_analytics_category

Name	Datatype	Description
category_name	string	The name of the Call Analytics category. Category names are case sensitive and must be unique within an Amazon Web Services account. (pattern: <code>^[0-9a-zA-Z._-]+</code>)
create_time	string (date-time)	The date and time the specified Call Analytics category was created. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
input_type	string	The input type associated with the specified category. POST_CALL refers to a category that is applied to batch transcriptions; REAL_TIME refers to a category that is applied to streaming transcriptions. (REAL_TIME, POST_CALL)
last_update_time	string (date-time)	The date and time the specified Call Analytics category was last updated. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-05T12:45:32.691000-07:00 represents 12:45 PM UTC-7 on May 5, 2022.
rules	array	The rules used to define a Call Analytics category. Each category can have between 1 and 20 rules.
tags	array	The tags, each in the form of a key:value pair, assigned to the specified call analytics category.

list_call_analytics_categories

Name	Datatype	Description
categories	array	Provides detailed information about your Call Analytics categories, including all the rules associated with each category.
next_token	string	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. (pattern: <code>.+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_call_analytics_category	select	region		Provides information about the specified Call Analytics category. To get a list of your Call Analytics categories, use the operation.
list_call_analytics_categories	select	region		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.
create_call_analytics_category	insert	region, CategoryName, Rules		Creates a new Call Analytics category. All categories are automatically applied to your Call Analytics transcriptions. Note that in order to apply categories to your transcriptions, you must create them before submitting your transcription request, as categories cannot be applied retroactively. When creating a new category, you can use the InputType parameter to label the category as a POST_CALL or a REAL_TIME category. POST_CALL categories can only be applied to post-call transcriptions and REAL_TIME categories can only be applied to real-time transcriptions. If you do not include InputType, your category is created as a POST_CALL category by default. Call Analytics categories are composed of rules. For each category, you must create between 1 and 20 rules. Rules can include these parameters: , , , and . To update an existing category, see . To learn more about Call Analytics categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions.
update_call_analytics_category	update	region, CategoryName, Rules		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 .
delete_call_analytics_category	delete	region		Deletes a Call Analytics category. To use this operation, specify the name of the category you want to delete using CategoryName. Category names are case sensitive.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_call_analytics_category

Provides information about the specified Call Analytics category. To get a list of your Call Analytics categories, use the operation.

SELECT
category_name,
create_time,
input_type,
last_update_time,
rules,
tags
FROM aws.transcribe.call_analytics_categories
WHERE region = '{{ region }}' -- required
;

list_call_analytics_categories

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.

SELECT
categories,
next_token
FROM aws.transcribe.call_analytics_categories
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_call_analytics_category

Creates a new Call Analytics category. All categories are automatically applied to your Call Analytics transcriptions. Note that in order to apply categories to your transcriptions, you must create them before submitting your transcription request, as categories cannot be applied retroactively. When creating a new category, you can use the InputType parameter to label the category as a POST_CALL or a REAL_TIME category. POST_CALL categories can only be applied to post-call transcriptions and REAL_TIME categories can only be applied to real-time transcriptions. If you do not include InputType, your category is created as a POST_CALL category by default. Call Analytics categories are composed of rules. For each category, you must create between 1 and 20 rules. Rules can include these parameters: , , , and . To update an existing category, see . To learn more about Call Analytics categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions.

INSERT INTO aws.transcribe.call_analytics_categories (
CategoryName,
Rules,
Tags,
InputType,
region
)
SELECT 
'{{ CategoryName }}' /* required */,
'{{ Rules }}' /* required */,
'{{ Tags }}',
'{{ InputType }}',
'{{ region }}'
RETURNING
category_properties
;

Manifest

# Description fields are for documentation purposes
- name: call_analytics_categories
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the call_analytics_categories resource.
  - name: CategoryName
    value: "{{ CategoryName }}"
    description: |
      A unique name, chosen by you, for your Call Analytics category. It's helpful to use a detailed naming system that will make sense to you in the future. For example, it's better to use sentiment-positive-last30seconds for a category over a generic name like test-category. Category names are case sensitive.
  - name: Rules
    description: |
      Rules define a Call Analytics category. When creating a new category, you must create between 1 and 20 rules for that category. For each rule, you specify a filter you want applied to the attributes of a call. For example, you can choose a sentiment filter that detects if a customer's sentiment was positive during the last 30 seconds of the call.
    value:
      - NonTalkTimeFilter:
          Threshold: {{ Threshold }}
          AbsoluteTimeRange:
            StartTime: {{ StartTime }}
            EndTime: {{ EndTime }}
            First: {{ First }}
            Last: {{ Last }}
          RelativeTimeRange:
            StartPercentage: {{ StartPercentage }}
            EndPercentage: {{ EndPercentage }}
            First: {{ First }}
            Last: {{ Last }}
          Negate: {{ Negate }}
        InterruptionFilter:
          Threshold: {{ Threshold }}
          ParticipantRole: "{{ ParticipantRole }}"
          AbsoluteTimeRange:
            StartTime: {{ StartTime }}
            EndTime: {{ EndTime }}
            First: {{ First }}
            Last: {{ Last }}
          RelativeTimeRange:
            StartPercentage: {{ StartPercentage }}
            EndPercentage: {{ EndPercentage }}
            First: {{ First }}
            Last: {{ Last }}
          Negate: {{ Negate }}
        TranscriptFilter:
          TranscriptFilterType: "{{ TranscriptFilterType }}"
          AbsoluteTimeRange:
            StartTime: {{ StartTime }}
            EndTime: {{ EndTime }}
            First: {{ First }}
            Last: {{ Last }}
          RelativeTimeRange:
            StartPercentage: {{ StartPercentage }}
            EndPercentage: {{ EndPercentage }}
            First: {{ First }}
            Last: {{ Last }}
          ParticipantRole: "{{ ParticipantRole }}"
          Negate: {{ Negate }}
          Targets:
            - "{{ Targets }}"
        SentimentFilter:
          Sentiments:
            - "{{ Sentiments }}"
          AbsoluteTimeRange:
            StartTime: {{ StartTime }}
            EndTime: {{ EndTime }}
            First: {{ First }}
            Last: {{ Last }}
          RelativeTimeRange:
            StartPercentage: {{ StartPercentage }}
            EndPercentage: {{ EndPercentage }}
            First: {{ First }}
            Last: {{ Last }}
          ParticipantRole: "{{ ParticipantRole }}"
          Negate: {{ Negate }}
  - name: Tags
    description: |
      Adds one or more custom tags, each in the form of a key:value pair, to a new call analytics category at the time you start this new job. To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: InputType
    value: "{{ InputType }}"
    description: |
      Choose whether you want to create a real-time or a post-call category for your Call Analytics transcription. Specifying POST_CALL assigns your category to post-call transcriptions; categories with this input type cannot be applied to streaming (real-time) transcriptions. Specifying REAL_TIME assigns your category to streaming transcriptions; categories with this input type cannot be applied to post-call transcriptions. If you do not include InputType, your category is created as a post-call category by default.
    valid_values: ['REAL_TIME', 'POST_CALL']

UPDATE examples

update_call_analytics_category

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 .

UPDATE aws.transcribe.call_analytics_categories
SET 
CategoryName = '{{ CategoryName }}',
Rules = '{{ Rules }}',
InputType = '{{ InputType }}'
WHERE 
region = '{{ region }}' --required
AND CategoryName = '{{ CategoryName }}' --required
AND Rules = '{{ Rules }}' --required
RETURNING
category_properties;

DELETE examples

delete_call_analytics_category

Deletes a Call Analytics category. To use this operation, specify the name of the category you want to delete using CategoryName. Category names are case sensitive.

DELETE FROM aws.transcribe.call_analytics_categories
WHERE region = '{{ region }}' --required
;