create_media_capture_pipeline
async
¶
create_media_capture_pipeline(
source_type: MediaPipelineSourceType,
source_arn: Arn,
sink_type: MediaPipelineSinkType,
sink_arn: Arn,
*,
config_overrides: Optional[AsyncChimeSDKMediaPipelinesClientConfig] = None,
client_request_token: Optional[ClientRequestToken] = None,
chime_sdk_meeting_configuration: Optional[ChimeSdkMeetingConfiguration] = None,
sse_aws_key_management_params: Optional[SseAwsKeyManagementParams] = None,
sink_iam_role_arn: Optional[Arn] = None,
tags: Optional[TagList] = None,
) -> CreateMediaCapturePipelineResponse
Creates a media pipeline.
Parameters:
-
source_type(MediaPipelineSourceType) –Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.
-
source_arn(Arn) –ARN of the source from which the media artifacts are captured.
-
sink_type(MediaPipelineSinkType) –Destination type to which the media artifacts are saved. You must use an S3 bucket.
-
sink_arn(Arn) –The ARN of the sink type.
-
client_request_token(Optional[ClientRequestToken], default:None) –The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media pipeline request.
-
chime_sdk_meeting_configuration(Optional[ChimeSdkMeetingConfiguration], default:None) –The configuration for a specified media pipeline.
SourceTypemust beChimeSdkMeeting. -
sse_aws_key_management_params(Optional[SseAwsKeyManagementParams], default:None) –An object that contains server side encryption parameters to be used by media capture pipeline. The parameters can also be used by media concatenation pipeline taking media capture pipeline as a media source.
-
sink_iam_role_arn(Optional[Arn], default:None) –The Amazon Resource Name (ARN) of the sink role to be used with
AwsKmsKeyIdinSseAwsKeyManagementParams. Can only interact withS3Bucketsink type. The role must belong to the caller’s account and be able to act on behalf of the caller during the API call. All minimum policy permissions requirements for the caller to perform sink-related actions are the same forSinkIamRoleArn.Additionally, the role must have permission to
kms:GenerateDataKeyusing KMS key supplied asAwsKmsKeyIdinSseAwsKeyManagementParams. If media concatenation will be required later, the role must also have permission tokms:Decryptfor the same KMS key. -
tags(Optional[TagList], default:None) –The tag key-value pairs.
Raises:
-
BadRequestException–The input parameters don't match the service's restrictions.
-
ForbiddenException–The client is permanently forbidden from making the request.
-
ResourceLimitExceededException–The request exceeds the resource limit.
-
ServiceFailureException–The service encountered an unexpected error.
-
ServiceUnavailableException–The service is currently unavailable.
-
ThrottledClientException–The client exceeded its request rate limit.
-
UnauthorizedClientException–The client is not currently authorized to make the request.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_chime_sdk_media_pipelines/_services/async_chime_sdk_media_pipelines.py
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 | |