Skip to content

Commit 2028122

Browse files
author
awstools
committed
feat(client-chime-sdk-media-pipelines): Added Amazon Transcribe multi language identification to Chime SDK call analytics. Enabling customers sending single stream audio to generate call recordings using Chime SDK call analytics
1 parent d3a5651 commit 2028122

8 files changed

+81
-27
lines changed

Diff for: clients/client-chime-sdk-media-pipelines/src/commands/CreateMediaInsightsPipelineConfigurationCommand.ts

+2
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,7 @@ export interface CreateMediaInsightsPipelineConfigurationCommandOutput
116116
* LanguageModelName: "STRING_VALUE",
117117
* FilterPartialResults: true || false,
118118
* IdentifyLanguage: true || false,
119+
* IdentifyMultipleLanguages: true || false,
119120
* LanguageOptions: "STRING_VALUE",
120121
* PreferredLanguage: "en-US" || "en-GB" || "es-US" || "fr-CA" || "fr-FR" || "en-AU" || "it-IT" || "de-DE" || "pt-BR",
121122
* VocabularyNames: "STRING_VALUE",
@@ -223,6 +224,7 @@ export interface CreateMediaInsightsPipelineConfigurationCommandOutput
223224
* // LanguageModelName: "STRING_VALUE",
224225
* // FilterPartialResults: true || false,
225226
* // IdentifyLanguage: true || false,
227+
* // IdentifyMultipleLanguages: true || false,
226228
* // LanguageOptions: "STRING_VALUE",
227229
* // PreferredLanguage: "en-US" || "en-GB" || "es-US" || "fr-CA" || "fr-FR" || "en-AU" || "it-IT" || "de-DE" || "pt-BR",
228230
* // VocabularyNames: "STRING_VALUE",

Diff for: clients/client-chime-sdk-media-pipelines/src/commands/CreateMediaPipelineKinesisVideoStreamPoolCommand.ts

+16-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,22 @@ export interface CreateMediaPipelineKinesisVideoStreamPoolCommandOutput
4343
__MetadataBearer {}
4444

4545
/**
46-
* <p>Creates an Kinesis video stream pool for the media pipeline.</p>
46+
* <p>Creates an Amazon Kinesis Video Stream pool for use with media stream
47+
* pipelines.</p>
48+
* <note>
49+
* <p>If a meeting uses an opt-in Region as its
50+
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeeting.html#chimesdk-meeting-chime_CreateMeeting-request-MediaRegion">MediaRegion</a>,
51+
* the KVS stream must be in that same Region. For example, if a meeting uses the <code>af-south-1</code> Region, the KVS stream must also be in <code>af-south-1</code>. However, if the meeting uses a
52+
* Region that AWS turns on by default, the KVS stream can be in any available Region, including an opt-in Region. For example, if the meeting uses <code>ca-central-1</code>, the KVS stream can be in
53+
* <code>eu-west-2</code>, <code>us-east-1</code>, <code>af-south-1</code>, or any other Region that the Amazon Chime SDK supports.</p>
54+
* <p>To learn which AWS Region a meeting uses, call the <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_GetMeeting.html">GetMeeting</a> API and
55+
* use the <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeeting.html#chimesdk-meeting-chime_CreateMeeting-request-MediaRegion">MediaRegion</a>
56+
* parameter from the response.</p>
57+
* <p>For more information about opt-in Regions, refer to <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/sdk-available-regions.html">Available Regions</a> in the
58+
* <i>Amazon Chime SDK Developer Guide</i>, and
59+
* <a href="https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-regions.html#rande-manage-enable.html">Specify which AWS Regions your account can use</a>,
60+
* in the <i>AWS Account Management Reference Guide</i>.</p>
61+
* </note>
4762
* @example
4863
* Use a bare-bones client and the command you need to make an API call.
4964
* ```javascript

Diff for: clients/client-chime-sdk-media-pipelines/src/commands/DeleteMediaPipelineKinesisVideoStreamPoolCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ export interface DeleteMediaPipelineKinesisVideoStreamPoolCommandInput
3636
export interface DeleteMediaPipelineKinesisVideoStreamPoolCommandOutput extends __MetadataBearer {}
3737

3838
/**
39-
* <p>Deletes an Kinesis video stream pool.</p>
39+
* <p>Deletes an Amazon Kinesis Video Stream pool.</p>
4040
* @example
4141
* Use a bare-bones client and the command you need to make an API call.
4242
* ```javascript

Diff for: clients/client-chime-sdk-media-pipelines/src/commands/GetMediaInsightsPipelineConfigurationCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,7 @@ export interface GetMediaInsightsPipelineConfigurationCommandOutput
121121
* // LanguageModelName: "STRING_VALUE",
122122
* // FilterPartialResults: true || false,
123123
* // IdentifyLanguage: true || false,
124+
* // IdentifyMultipleLanguages: true || false,
124125
* // LanguageOptions: "STRING_VALUE",
125126
* // PreferredLanguage: "en-US" || "en-GB" || "es-US" || "fr-CA" || "fr-FR" || "en-AU" || "it-IT" || "de-DE" || "pt-BR",
126127
* // VocabularyNames: "STRING_VALUE",

Diff for: clients/client-chime-sdk-media-pipelines/src/commands/UpdateMediaInsightsPipelineConfigurationCommand.ts

+2
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,7 @@ export interface UpdateMediaInsightsPipelineConfigurationCommandOutput
115115
* LanguageModelName: "STRING_VALUE",
116116
* FilterPartialResults: true || false,
117117
* IdentifyLanguage: true || false,
118+
* IdentifyMultipleLanguages: true || false,
118119
* LanguageOptions: "STRING_VALUE",
119120
* PreferredLanguage: "en-US" || "en-GB" || "es-US" || "fr-CA" || "fr-FR" || "en-AU" || "it-IT" || "de-DE" || "pt-BR",
120121
* VocabularyNames: "STRING_VALUE",
@@ -215,6 +216,7 @@ export interface UpdateMediaInsightsPipelineConfigurationCommandOutput
215216
* // LanguageModelName: "STRING_VALUE",
216217
* // FilterPartialResults: true || false,
217218
* // IdentifyLanguage: true || false,
219+
* // IdentifyMultipleLanguages: true || false,
218220
* // LanguageOptions: "STRING_VALUE",
219221
* // PreferredLanguage: "en-US" || "en-GB" || "es-US" || "fr-CA" || "fr-FR" || "en-AU" || "it-IT" || "de-DE" || "pt-BR",
220222
* // VocabularyNames: "STRING_VALUE",

Diff for: clients/client-chime-sdk-media-pipelines/src/commands/UpdateMediaPipelineKinesisVideoStreamPoolCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ export interface UpdateMediaPipelineKinesisVideoStreamPoolCommandOutput
4242
__MetadataBearer {}
4343

4444
/**
45-
* <p>Updates an Kinesis video stream pool in a media pipeline.</p>
45+
* <p>Updates an Amazon Kinesis Video Stream pool in a media pipeline.</p>
4646
* @example
4747
* Use a bare-bones client and the command you need to make an API call.
4848
* ```javascript

Diff for: clients/client-chime-sdk-media-pipelines/src/models/models_0.ts

+36-9
Original file line numberDiff line numberDiff line change
@@ -268,6 +268,10 @@ export interface AmazonTranscribeCallAnalyticsProcessorConfiguration {
268268

269269
/**
270270
* <p>A structure that contains the configuration settings for an Amazon Transcribe processor.</p>
271+
* <note>
272+
* <p>Calls to this API must include a <code>LanguageCode</code>, <code>IdentifyLanguage</code>, or <code>IdentifyMultipleLanguages</code> parameter.
273+
* If you include more than one of those parameters, your transcription job fails.</p>
274+
* </note>
271275
* @public
272276
*/
273277
export interface AmazonTranscribeProcessorConfiguration {
@@ -386,6 +390,12 @@ export interface AmazonTranscribeProcessorConfiguration {
386390
*/
387391
IdentifyLanguage?: boolean;
388392

393+
/**
394+
* <p>Turns language identification on or off for multiple languages.</p>
395+
* @public
396+
*/
397+
IdentifyMultipleLanguages?: boolean;
398+
389399
/**
390400
* <p>The language options for the transcription, such as automatic language detection.</p>
391401
* @public
@@ -2849,6 +2859,20 @@ export class ConflictException extends __BaseException {
28492859

28502860
/**
28512861
* <p>The configuration of an Kinesis video stream.</p>
2862+
* <note>
2863+
* <p>If a meeting uses an opt-in Region as its
2864+
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeeting.html#chimesdk-meeting-chime_CreateMeeting-request-MediaRegion">MediaRegion</a>,
2865+
* the KVS stream must be in that same Region. For example, if a meeting uses the <code>af-south-1</code> Region, the KVS stream must also be in <code>af-south-1</code>. However, if the meeting uses a
2866+
* Region that AWS turns on by default, the KVS stream can be in any available Region, including an opt-in Region. For example, if the meeting uses <code>ca-central-1</code>, the KVS stream can be in
2867+
* <code>eu-west-2</code>, <code>us-east-1</code>, <code>af-south-1</code>, or any other Region that the Amazon Chime SDK supports.</p>
2868+
* <p>To learn which AWS Region a meeting uses, call the <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_GetMeeting.html">GetMeeting</a> API and
2869+
* use the <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeeting.html#chimesdk-meeting-chime_CreateMeeting-request-MediaRegion">MediaRegion</a>
2870+
* parameter from the response.</p>
2871+
* <p>For more information about opt-in Regions, refer to <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/sdk-available-regions.html">Available Regions</a> in the
2872+
* <i>Amazon Chime SDK Developer Guide</i>, and
2873+
* <a href="https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-regions.html#rande-manage-enable.html">Specify which AWS Regions your account can use</a>,
2874+
* in the <i>AWS Account Management Reference Guide</i>.</p>
2875+
* </note>
28522876
* @public
28532877
*/
28542878
export interface KinesisVideoStreamConfiguration {
@@ -2870,13 +2894,13 @@ export interface KinesisVideoStreamConfiguration {
28702894
*/
28712895
export interface CreateMediaPipelineKinesisVideoStreamPoolRequest {
28722896
/**
2873-
* <p>The configuration settings for the video stream.</p>
2897+
* <p>The configuration settings for the stream.</p>
28742898
* @public
28752899
*/
28762900
StreamConfiguration: KinesisVideoStreamConfiguration | undefined;
28772901

28782902
/**
2879-
* <p>The name of the video stream pool.</p>
2903+
* <p>The name of the pool.</p>
28802904
* @public
28812905
*/
28822906
PoolName: string | undefined;
@@ -2888,7 +2912,7 @@ export interface CreateMediaPipelineKinesisVideoStreamPoolRequest {
28882912
ClientRequestToken?: string;
28892913

28902914
/**
2891-
* <p>The tags assigned to the video stream pool.</p>
2915+
* <p>The tags assigned to the stream pool.</p>
28922916
* @public
28932917
*/
28942918
Tags?: Tag[];
@@ -2971,7 +2995,10 @@ export interface KinesisVideoStreamPoolConfiguration {
29712995
*/
29722996
export interface CreateMediaPipelineKinesisVideoStreamPoolResponse {
29732997
/**
2974-
* <p>The configuration for the Kinesis video stream pool.</p>
2998+
* <p>The configuration for applying the streams to the pool.</p>
2999+
* <note>
3000+
* <p></p>
3001+
* </note>
29753002
* @public
29763003
*/
29773004
KinesisVideoStreamPoolConfiguration?: KinesisVideoStreamPoolConfiguration;
@@ -3011,7 +3038,7 @@ export type MediaStreamPipelineSinkType =
30113038
*/
30123039
export interface MediaStreamSink {
30133040
/**
3014-
* <p>The ARN of the media stream sink.</p>
3041+
* <p>The ARN of the Kinesis Video Stream pool returned by the <a>CreateMediaPipelineKinesisVideoStreamPool</a> API.</p>
30153042
* @public
30163043
*/
30173044
SinkArn: string | undefined;
@@ -3047,7 +3074,7 @@ export interface MediaStreamSource {
30473074
SourceType: MediaPipelineSourceType | undefined;
30483075

30493076
/**
3050-
* <p>The ARN of the media stream source. </p>
3077+
* <p>The ARN of the meeting.</p>
30513078
* @public
30523079
*/
30533080
SourceArn: string | undefined;
@@ -3179,7 +3206,7 @@ export interface DeleteMediaPipelineRequest {
31793206
*/
31803207
export interface DeleteMediaPipelineKinesisVideoStreamPoolRequest {
31813208
/**
3182-
* <p>The ID of the pool being deleted.</p>
3209+
* <p>The unique identifier of the requested resource. Valid values include the name and ARN of the media pipeline Kinesis Video Stream pool.</p>
31833210
* @public
31843211
*/
31853212
Identifier: string | undefined;
@@ -3292,7 +3319,7 @@ export interface GetMediaPipelineResponse {
32923319
*/
32933320
export interface GetMediaPipelineKinesisVideoStreamPoolRequest {
32943321
/**
3295-
* <p>The ID of the video stream pool.</p>
3322+
* <p>The unique identifier of the requested resource. Valid values include the name and ARN of the media pipeline Kinesis Video Stream pool.</p>
32963323
* @public
32973324
*/
32983325
Identifier: string | undefined;
@@ -3971,7 +3998,7 @@ export interface KinesisVideoStreamConfigurationUpdate {
39713998
*/
39723999
export interface UpdateMediaPipelineKinesisVideoStreamPoolRequest {
39734000
/**
3974-
* <p>The ID of the video stream pool.</p>
4001+
* <p>The unique identifier of the requested resource. Valid values include the name and ARN of the media pipeline Kinesis Video Stream pool.</p>
39754002
* @public
39764003
*/
39774004
Identifier: string | undefined;

0 commit comments

Comments
 (0)