|
4 | 4 | "apiVersion": "2021-07-15", |
5 | 5 | "endpointPrefix": "media-pipelines-chime", |
6 | 6 | "protocol": "rest-json", |
| 7 | + "protocols": [ |
| 8 | + "rest-json" |
| 9 | + ], |
7 | 10 | "serviceFullName": "Amazon Chime SDK Media Pipelines", |
8 | 11 | "serviceId": "Chime SDK Media Pipelines", |
9 | 12 | "signatureVersion": "v4", |
10 | 13 | "signingName": "chime", |
11 | | - "uid": "chime-sdk-media-pipelines-2021-07-15" |
| 14 | + "uid": "chime-sdk-media-pipelines-2021-07-15", |
| 15 | + "auth": [ |
| 16 | + "aws.auth#sigv4" |
| 17 | + ] |
12 | 18 | }, |
13 | 19 | "operations": { |
14 | 20 | "CreateMediaCapturePipeline": { |
|
246 | 252 | "shape": "ServiceFailureException" |
247 | 253 | } |
248 | 254 | ], |
249 | | - "documentation": "<p>Creates an Kinesis video stream pool for the media pipeline.</p>" |
| 255 | + "documentation": "<p>Creates an Amazon Kinesis Video Stream pool for use with media stream pipelines.</p> <note> <p>If a meeting uses an opt-in Region as its <a href=\"https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeeting.html#chimesdk-meeting-chime_CreateMeeting-request-MediaRegion\">MediaRegion</a>, 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 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 <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> <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 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> parameter from the response.</p> <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 <i>Amazon Chime SDK Developer Guide</i>, and <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>, in the <i>AWS Account Management Reference Guide</i>.</p> </note>" |
250 | 256 | }, |
251 | 257 | "CreateMediaStreamPipeline": { |
252 | 258 | "name": "CreateMediaStreamPipeline", |
|
436 | 442 | "shape": "ServiceFailureException" |
437 | 443 | } |
438 | 444 | ], |
439 | | - "documentation": "<p>Deletes an Kinesis video stream pool.</p>" |
| 445 | + "documentation": "<p>Deletes an Amazon Kinesis Video Stream pool.</p>" |
440 | 446 | }, |
441 | 447 | "GetMediaCapturePipeline": { |
442 | 448 | "name": "GetMediaCapturePipeline", |
|
1208 | 1214 | "shape": "ServiceFailureException" |
1209 | 1215 | } |
1210 | 1216 | ], |
1211 | | - "documentation": "<p>Updates an Kinesis video stream pool in a media pipeline.</p>" |
| 1217 | + "documentation": "<p>Updates an Amazon Kinesis Video Stream pool in a media pipeline.</p>" |
1212 | 1218 | } |
1213 | 1219 | }, |
1214 | 1220 | "shapes": { |
|
1353 | 1359 | "shape": "Boolean", |
1354 | 1360 | "documentation": "<p>Turns language identification on or off.</p>" |
1355 | 1361 | }, |
| 1362 | + "IdentifyMultipleLanguages": { |
| 1363 | + "shape": "Boolean", |
| 1364 | + "documentation": "<p>Turns language identification on or off for multiple languages.</p>" |
| 1365 | + }, |
1356 | 1366 | "LanguageOptions": { |
1357 | 1367 | "shape": "LanguageOptions", |
1358 | 1368 | "documentation": "<p>The language options for the transcription, such as automatic language detection.</p>" |
|
1370 | 1380 | "documentation": "<p>The names of the custom vocabulary filter or filters using during transcription.</p>" |
1371 | 1381 | } |
1372 | 1382 | }, |
1373 | | - "documentation": "<p>A structure that contains the configuration settings for an Amazon Transcribe processor.</p>" |
| 1383 | + "documentation": "<p>A structure that contains the configuration settings for an Amazon Transcribe processor.</p> <note> <p>Calls to this API must include a <code>LanguageCode</code>, <code>IdentifyLanguage</code>, or <code>IdentifyMultipleLanguages</code> parameter. If you include more than one of those parameters, your transcription job fails.</p> </note>" |
1374 | 1384 | }, |
1375 | 1385 | "Arn": { |
1376 | 1386 | "type": "string", |
|
2053 | 2063 | "members": { |
2054 | 2064 | "StreamConfiguration": { |
2055 | 2065 | "shape": "KinesisVideoStreamConfiguration", |
2056 | | - "documentation": "<p>The configuration settings for the video stream.</p>" |
| 2066 | + "documentation": "<p>The configuration settings for the stream.</p>" |
2057 | 2067 | }, |
2058 | 2068 | "PoolName": { |
2059 | 2069 | "shape": "KinesisVideoStreamPoolName", |
2060 | | - "documentation": "<p>The name of the video stream pool.</p>" |
| 2070 | + "documentation": "<p>The name of the pool.</p>" |
2061 | 2071 | }, |
2062 | 2072 | "ClientRequestToken": { |
2063 | 2073 | "shape": "ClientRequestToken", |
|
2066 | 2076 | }, |
2067 | 2077 | "Tags": { |
2068 | 2078 | "shape": "TagList", |
2069 | | - "documentation": "<p>The tags assigned to the video stream pool.</p>" |
| 2079 | + "documentation": "<p>The tags assigned to the stream pool.</p>" |
2070 | 2080 | } |
2071 | 2081 | } |
2072 | 2082 | }, |
|
2075 | 2085 | "members": { |
2076 | 2086 | "KinesisVideoStreamPoolConfiguration": { |
2077 | 2087 | "shape": "KinesisVideoStreamPoolConfiguration", |
2078 | | - "documentation": "<p>The configuration for the Kinesis video stream pool.</p>" |
| 2088 | + "documentation": "<p>The configuration for applying the streams to the pool.</p> <note> <p/> </note>" |
2079 | 2089 | } |
2080 | 2090 | } |
2081 | 2091 | }, |
|
2171 | 2181 | "members": { |
2172 | 2182 | "Identifier": { |
2173 | 2183 | "shape": "NonEmptyString", |
2174 | | - "documentation": "<p>The ID of the pool being deleted.</p>", |
| 2184 | + "documentation": "<p>The unique identifier of the requested resource. Valid values include the name and ARN of the media pipeline Kinesis Video Stream pool.</p>", |
2175 | 2185 | "location": "uri", |
2176 | 2186 | "locationName": "identifier" |
2177 | 2187 | } |
|
2289 | 2299 | "members": { |
2290 | 2300 | "Identifier": { |
2291 | 2301 | "shape": "NonEmptyString", |
2292 | | - "documentation": "<p>The ID of the video stream pool.</p>", |
| 2302 | + "documentation": "<p>The unique identifier of the requested resource. Valid values include the name and ARN of the media pipeline Kinesis Video Stream pool.</p>", |
2293 | 2303 | "location": "uri", |
2294 | 2304 | "locationName": "identifier" |
2295 | 2305 | } |
|
2554 | 2564 | "documentation": "<p>The amount of time that data is retained.</p>" |
2555 | 2565 | } |
2556 | 2566 | }, |
2557 | | - "documentation": "<p>The configuration of an Kinesis video stream.</p>" |
| 2567 | + "documentation": "<p>The configuration of an Kinesis video stream.</p> <note> <p>If a meeting uses an opt-in Region as its <a href=\"https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeeting.html#chimesdk-meeting-chime_CreateMeeting-request-MediaRegion\">MediaRegion</a>, 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 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 <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> <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 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> parameter from the response.</p> <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 <i>Amazon Chime SDK Developer Guide</i>, and <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>, in the <i>AWS Account Management Reference Guide</i>.</p> </note>" |
2558 | 2568 | }, |
2559 | 2569 | "KinesisVideoStreamConfigurationUpdate": { |
2560 | 2570 | "type": "structure", |
|
3502 | 3512 | "members": { |
3503 | 3513 | "SinkArn": { |
3504 | 3514 | "shape": "Arn", |
3505 | | - "documentation": "<p>The ARN of the media stream sink.</p>" |
| 3515 | + "documentation": "<p>The ARN of the Kinesis Video Stream pool returned by the <a>CreateMediaPipelineKinesisVideoStreamPool</a> API.</p>" |
3506 | 3516 | }, |
3507 | 3517 | "SinkType": { |
3508 | 3518 | "shape": "MediaStreamPipelineSinkType", |
|
3540 | 3550 | }, |
3541 | 3551 | "SourceArn": { |
3542 | 3552 | "shape": "Arn", |
3543 | | - "documentation": "<p>The ARN of the media stream source. </p>" |
| 3553 | + "documentation": "<p>The ARN of the meeting.</p>" |
3544 | 3554 | } |
3545 | 3555 | }, |
3546 | 3556 | "documentation": "<p>Structure that contains the settings for media stream sources.</p>" |
|
3732 | 3742 | "shape": "RecordingStreamConfiguration" |
3733 | 3743 | }, |
3734 | 3744 | "max": 2, |
3735 | | - "min": 2 |
| 3745 | + "min": 1 |
3736 | 3746 | }, |
3737 | 3747 | "ReservedStreamCapacity": { |
3738 | 3748 | "type": "integer", |
|
4276 | 4286 | "members": { |
4277 | 4287 | "Identifier": { |
4278 | 4288 | "shape": "NonEmptyString", |
4279 | | - "documentation": "<p>The ID of the video stream pool.</p>", |
| 4289 | + "documentation": "<p>The unique identifier of the requested resource. Valid values include the name and ARN of the media pipeline Kinesis Video Stream pool.</p>", |
4280 | 4290 | "location": "uri", |
4281 | 4291 | "locationName": "identifier" |
4282 | 4292 | }, |
|
0 commit comments