Skip to content

Commit c23e188

Browse files
author
awstools
committed
feat(client-transcribe): This update provides tagging support for Transcribe's Call Analytics Jobs and Call Analytics Categories.
1 parent ae86950 commit c23e188

File tree

9 files changed

+133
-27
lines changed

9 files changed

+133
-27
lines changed

‎clients/client-transcribe/src/commands/CreateCallAnalyticsCategoryCommand.ts‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,12 @@ export interface CreateCallAnalyticsCategoryCommandOutput
130130
* },
131131
* },
132132
* ],
133+
* Tags: [ // TagList
134+
* { // Tag
135+
* Key: "STRING_VALUE", // required
136+
* Value: "STRING_VALUE", // required
137+
* },
138+
* ],
133139
* InputType: "REAL_TIME" || "POST_CALL",
134140
* };
135141
* const command = new CreateCallAnalyticsCategoryCommand(input);
@@ -215,6 +221,12 @@ export interface CreateCallAnalyticsCategoryCommandOutput
215221
* // ],
216222
* // CreateTime: new Date("TIMESTAMP"),
217223
* // LastUpdateTime: new Date("TIMESTAMP"),
224+
* // Tags: [ // TagList
225+
* // { // Tag
226+
* // Key: "STRING_VALUE", // required
227+
* // Value: "STRING_VALUE", // required
228+
* // },
229+
* // ],
218230
* // InputType: "REAL_TIME" || "POST_CALL",
219231
* // },
220232
* // };

‎clients/client-transcribe/src/commands/GetCallAnalyticsCategoryCommand.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,12 @@ export interface GetCallAnalyticsCategoryCommandOutput extends GetCallAnalyticsC
122122
* // ],
123123
* // CreateTime: new Date("TIMESTAMP"),
124124
* // LastUpdateTime: new Date("TIMESTAMP"),
125+
* // Tags: [ // TagList
126+
* // { // Tag
127+
* // Key: "STRING_VALUE", // required
128+
* // Value: "STRING_VALUE", // required
129+
* // },
130+
* // ],
125131
* // InputType: "REAL_TIME" || "POST_CALL",
126132
* // },
127133
* // };

‎clients/client-transcribe/src/commands/GetCallAnalyticsJobCommand.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,12 @@ export interface GetCallAnalyticsJobCommandOutput extends GetCallAnalyticsJobRes
113113
* // ParticipantRole: "AGENT" || "CUSTOMER",
114114
* // },
115115
* // ],
116+
* // Tags: [ // TagList
117+
* // { // Tag
118+
* // Key: "STRING_VALUE", // required
119+
* // Value: "STRING_VALUE", // required
120+
* // },
121+
* // ],
116122
* // },
117123
* // };
118124
*

‎clients/client-transcribe/src/commands/ListCallAnalyticsCategoriesCommand.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,12 @@ export interface ListCallAnalyticsCategoriesCommandOutput
128128
* // ],
129129
* // CreateTime: new Date("TIMESTAMP"),
130130
* // LastUpdateTime: new Date("TIMESTAMP"),
131+
* // Tags: [ // TagList
132+
* // { // Tag
133+
* // Key: "STRING_VALUE", // required
134+
* // Value: "STRING_VALUE", // required
135+
* // },
136+
* // ],
131137
* // InputType: "REAL_TIME" || "POST_CALL",
132138
* // },
133139
* // ],

‎clients/client-transcribe/src/commands/StartCallAnalyticsJobCommand.ts‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,12 @@ export interface StartCallAnalyticsJobCommandOutput extends StartCallAnalyticsJo
120120
* GenerateAbstractiveSummary: true || false, // required
121121
* },
122122
* },
123+
* Tags: [ // TagList
124+
* { // Tag
125+
* Key: "STRING_VALUE", // required
126+
* Value: "STRING_VALUE", // required
127+
* },
128+
* ],
123129
* ChannelDefinitions: [ // ChannelDefinitions
124130
* { // ChannelDefinition
125131
* ChannelId: Number("int"),
@@ -191,6 +197,12 @@ export interface StartCallAnalyticsJobCommandOutput extends StartCallAnalyticsJo
191197
* // ParticipantRole: "AGENT" || "CUSTOMER",
192198
* // },
193199
* // ],
200+
* // Tags: [ // TagList
201+
* // { // Tag
202+
* // Key: "STRING_VALUE", // required
203+
* // Value: "STRING_VALUE", // required
204+
* // },
205+
* // ],
194206
* // },
195207
* // };
196208
*

‎clients/client-transcribe/src/commands/UpdateCallAnalyticsCategoryCommand.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,12 @@ export interface UpdateCallAnalyticsCategoryCommandOutput
204204
* // ],
205205
* // CreateTime: new Date("TIMESTAMP"),
206206
* // LastUpdateTime: new Date("TIMESTAMP"),
207+
* // Tags: [ // TagList
208+
* // { // Tag
209+
* // Key: "STRING_VALUE", // required
210+
* // Value: "STRING_VALUE", // required
211+
* // },
212+
* // ],
207213
* // InputType: "REAL_TIME" || "POST_CALL",
208214
* // },
209215
* // };

‎clients/client-transcribe/src/models/models_0.ts‎

Lines changed: 59 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -702,6 +702,33 @@ export interface CallAnalyticsJobSettings {
702702
Summarization?: Summarization | undefined;
703703
}
704704

705+
/**
706+
* <p>Adds metadata, in the form of a key:value pair, to the specified resource.</p>
707+
* <p>For example, you could add the tag <code>Department:Sales</code> to a resource to
708+
* indicate that it pertains to your organization's sales department. You can also use tags
709+
* for tag-based access control.</p>
710+
* <p>To learn more about tagging, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging resources</a>.</p>
711+
* @public
712+
*/
713+
export interface Tag {
714+
/**
715+
* <p>The first part of a key:value pair that forms a tag associated with a given resource.
716+
* For example, in the tag <code>Department:Sales</code>, the key is 'Department'.</p>
717+
* @public
718+
*/
719+
Key: string | undefined;
720+
721+
/**
722+
* <p>The second part of a key:value pair that forms a tag associated with a given resource.
723+
* For example, in the tag <code>Department:Sales</code>, the value is 'Sales'.</p>
724+
* <p>Note that you can set the value of a tag to an empty string, but you can't set the
725+
* value of a tag to null. Omitting the tag value is the same as using an empty
726+
* string.</p>
727+
* @public
728+
*/
729+
Value: string | undefined;
730+
}
731+
705732
/**
706733
* <p>Provides you with the Amazon S3 URI you can use to access your
707734
* transcript.</p>
@@ -936,6 +963,13 @@ export interface CallAnalyticsJob {
936963
* @public
937964
*/
938965
ChannelDefinitions?: ChannelDefinition[] | undefined;
966+
967+
/**
968+
* <p>The tags, each in the form of a key:value pair, assigned to the specified
969+
* call analytics job.</p>
970+
* @public
971+
*/
972+
Tags?: Tag[] | undefined;
939973
}
940974

941975
/**
@@ -1479,6 +1513,13 @@ export interface CategoryProperties {
14791513
*/
14801514
LastUpdateTime?: Date | undefined;
14811515

1516+
/**
1517+
* <p>The tags, each in the form of a key:value pair, assigned to the specified
1518+
* call analytics category.</p>
1519+
* @public
1520+
*/
1521+
Tags?: Tag[] | undefined;
1522+
14821523
/**
14831524
* <p>The input type associated with the specified category. <code>POST_CALL</code>
14841525
* refers to a category that is applied to batch transcriptions; <code>REAL_TIME</code>
@@ -1553,6 +1594,15 @@ export interface CreateCallAnalyticsCategoryRequest {
15531594
*/
15541595
Rules: Rule[] | undefined;
15551596

1597+
/**
1598+
* <p>Adds one or more custom tags, each in the form of a key:value pair, to a new
1599+
* call analytics category at the time you start this new job.</p>
1600+
* <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
1601+
* resources</a>.</p>
1602+
* @public
1603+
*/
1604+
Tags?: Tag[] | undefined;
1605+
15561606
/**
15571607
* <p>Choose whether you want to create a real-time or a post-call category for your Call
15581608
* Analytics transcription.</p>
@@ -1670,33 +1720,6 @@ export interface InputDataConfig {
16701720
DataAccessRoleArn: string | undefined;
16711721
}
16721722

1673-
/**
1674-
* <p>Adds metadata, in the form of a key:value pair, to the specified resource.</p>
1675-
* <p>For example, you could add the tag <code>Department:Sales</code> to a resource to
1676-
* indicate that it pertains to your organization's sales department. You can also use tags
1677-
* for tag-based access control.</p>
1678-
* <p>To learn more about tagging, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging resources</a>.</p>
1679-
* @public
1680-
*/
1681-
export interface Tag {
1682-
/**
1683-
* <p>The first part of a key:value pair that forms a tag associated with a given resource.
1684-
* For example, in the tag <code>Department:Sales</code>, the key is 'Department'.</p>
1685-
* @public
1686-
*/
1687-
Key: string | undefined;
1688-
1689-
/**
1690-
* <p>The second part of a key:value pair that forms a tag associated with a given resource.
1691-
* For example, in the tag <code>Department:Sales</code>, the value is 'Sales'.</p>
1692-
* <p>Note that you can set the value of a tag to an empty string, but you can't set the
1693-
* value of a tag to null. Omitting the tag value is the same as using an empty
1694-
* string.</p>
1695-
* @public
1696-
*/
1697-
Value: string | undefined;
1698-
}
1699-
17001723
/**
17011724
* @public
17021725
*/
@@ -4944,6 +4967,15 @@ export interface StartCallAnalyticsJobRequest {
49444967
*/
49454968
Settings?: CallAnalyticsJobSettings | undefined;
49464969

4970+
/**
4971+
* <p>Adds one or more custom tags, each in the form of a key:value pair, to a new
4972+
* call analytics job at the time you start this new job.</p>
4973+
* <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
4974+
* resources</a>.</p>
4975+
* @public
4976+
*/
4977+
Tags?: Tag[] | undefined;
4978+
49474979
/**
49484980
* <p>Makes it possible to specify which speaker is on which channel. For example, if your
49494981
* agent is the first participant to speak, you would set <code>ChannelId</code> to

‎clients/client-transcribe/src/protocols/Aws_json1_1.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1985,6 +1985,7 @@ const de_CallAnalyticsJob = (output: any, context: __SerdeContext): CallAnalytic
19851985
MediaSampleRateHertz: __expectInt32,
19861986
Settings: _json,
19871987
StartTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
1988+
Tags: _json,
19881989
Transcript: _json,
19891990
}) as any;
19901991
};
@@ -2035,6 +2036,7 @@ const de_CategoryProperties = (output: any, context: __SerdeContext): CategoryPr
20352036
InputType: __expectString,
20362037
LastUpdateTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
20372038
Rules: _json,
2039+
Tags: _json,
20382040
}) as any;
20392041
};
20402042

‎codegen/sdk-codegen/aws-models/transcribe.json‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,12 @@
247247
"traits": {
248248
"smithy.api#documentation": "<p>Indicates which speaker is on which channel.</p>"
249249
}
250+
},
251+
"Tags": {
252+
"target": "com.amazonaws.transcribe#TagList",
253+
"traits": {
254+
"smithy.api#documentation": "<p>The tags, each in the form of a key:value pair, assigned to the specified\n call analytics job.</p>"
255+
}
250256
}
251257
},
252258
"traits": {
@@ -507,6 +513,12 @@
507513
"smithy.api#documentation": "<p>The date and time the specified Call Analytics category was last updated.</p>\n <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For\n example, <code>2022-05-05T12:45:32.691000-07:00</code> represents 12:45 PM UTC-7 on May\n 5, 2022.</p>"
508514
}
509515
},
516+
"Tags": {
517+
"target": "com.amazonaws.transcribe#TagList",
518+
"traits": {
519+
"smithy.api#documentation": "<p>The tags, each in the form of a key:value pair, assigned to the specified\n call analytics category.</p>"
520+
}
521+
},
510522
"InputType": {
511523
"target": "com.amazonaws.transcribe#InputType",
512524
"traits": {
@@ -657,6 +669,12 @@
657669
"smithy.api#required": {}
658670
}
659671
},
672+
"Tags": {
673+
"target": "com.amazonaws.transcribe#TagList",
674+
"traits": {
675+
"smithy.api#documentation": "<p>Adds one or more custom tags, each in the form of a key:value pair, to a new\n call analytics category at the time you start this new job.</p>\n <p>To learn more about using tags with Amazon Transcribe, refer to <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html\">Tagging\n resources</a>.</p>"
676+
}
677+
},
660678
"InputType": {
661679
"target": "com.amazonaws.transcribe#InputType",
662680
"traits": {
@@ -5275,6 +5293,12 @@
52755293
"smithy.api#documentation": "<p>Specify additional optional settings in your request, including content redaction; allows you to apply custom language models,\n vocabulary filters, and custom vocabularies to your Call Analytics job.</p>"
52765294
}
52775295
},
5296+
"Tags": {
5297+
"target": "com.amazonaws.transcribe#TagList",
5298+
"traits": {
5299+
"smithy.api#documentation": "<p>Adds one or more custom tags, each in the form of a key:value pair, to a new\n call analytics job at the time you start this new job.</p>\n <p>To learn more about using tags with Amazon Transcribe, refer to <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html\">Tagging\n resources</a>.</p>"
5300+
}
5301+
},
52785302
"ChannelDefinitions": {
52795303
"target": "com.amazonaws.transcribe#ChannelDefinitions",
52805304
"traits": {

0 commit comments

Comments
 (0)