aws_sdk_chimesdkmediapipelines/client/create_media_capture_pipeline.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`CreateMediaCapturePipeline`](crate::operation::create_media_capture_pipeline::builders::CreateMediaCapturePipelineFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`source_type(MediaPipelineSourceType)`](crate::operation::create_media_capture_pipeline::builders::CreateMediaCapturePipelineFluentBuilder::source_type) / [`set_source_type(Option<MediaPipelineSourceType>)`](crate::operation::create_media_capture_pipeline::builders::CreateMediaCapturePipelineFluentBuilder::set_source_type):<br>required: **true**<br><p>Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.</p><br>
7 /// - [`source_arn(impl Into<String>)`](crate::operation::create_media_capture_pipeline::builders::CreateMediaCapturePipelineFluentBuilder::source_arn) / [`set_source_arn(Option<String>)`](crate::operation::create_media_capture_pipeline::builders::CreateMediaCapturePipelineFluentBuilder::set_source_arn):<br>required: **true**<br><p>ARN of the source from which the media artifacts are captured.</p><br>
8 /// - [`sink_type(MediaPipelineSinkType)`](crate::operation::create_media_capture_pipeline::builders::CreateMediaCapturePipelineFluentBuilder::sink_type) / [`set_sink_type(Option<MediaPipelineSinkType>)`](crate::operation::create_media_capture_pipeline::builders::CreateMediaCapturePipelineFluentBuilder::set_sink_type):<br>required: **true**<br><p>Destination type to which the media artifacts are saved. You must use an S3 bucket.</p><br>
9 /// - [`sink_arn(impl Into<String>)`](crate::operation::create_media_capture_pipeline::builders::CreateMediaCapturePipelineFluentBuilder::sink_arn) / [`set_sink_arn(Option<String>)`](crate::operation::create_media_capture_pipeline::builders::CreateMediaCapturePipelineFluentBuilder::set_sink_arn):<br>required: **true**<br><p>The ARN of the sink type.</p><br>
10 /// - [`client_request_token(impl Into<String>)`](crate::operation::create_media_capture_pipeline::builders::CreateMediaCapturePipelineFluentBuilder::client_request_token) / [`set_client_request_token(Option<String>)`](crate::operation::create_media_capture_pipeline::builders::CreateMediaCapturePipelineFluentBuilder::set_client_request_token):<br>required: **false**<br><p>The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media pipeline request.</p><br>
11 /// - [`chime_sdk_meeting_configuration(ChimeSdkMeetingConfiguration)`](crate::operation::create_media_capture_pipeline::builders::CreateMediaCapturePipelineFluentBuilder::chime_sdk_meeting_configuration) / [`set_chime_sdk_meeting_configuration(Option<ChimeSdkMeetingConfiguration>)`](crate::operation::create_media_capture_pipeline::builders::CreateMediaCapturePipelineFluentBuilder::set_chime_sdk_meeting_configuration):<br>required: **false**<br><p>The configuration for a specified media pipeline. <code>SourceType</code> must be <code>ChimeSdkMeeting</code>.</p><br>
12 /// - [`sse_aws_key_management_params(SseAwsKeyManagementParams)`](crate::operation::create_media_capture_pipeline::builders::CreateMediaCapturePipelineFluentBuilder::sse_aws_key_management_params) / [`set_sse_aws_key_management_params(Option<SseAwsKeyManagementParams>)`](crate::operation::create_media_capture_pipeline::builders::CreateMediaCapturePipelineFluentBuilder::set_sse_aws_key_management_params):<br>required: **false**<br><p>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.</p><br>
13 /// - [`sink_iam_role_arn(impl Into<String>)`](crate::operation::create_media_capture_pipeline::builders::CreateMediaCapturePipelineFluentBuilder::sink_iam_role_arn) / [`set_sink_iam_role_arn(Option<String>)`](crate::operation::create_media_capture_pipeline::builders::CreateMediaCapturePipelineFluentBuilder::set_sink_iam_role_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the sink role to be used with <code>AwsKmsKeyId</code> in <code>SseAwsKeyManagementParams</code>. Can only interact with <code>S3Bucket</code> sink 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 for <code>SinkIamRoleArn</code>.</p> <p>Additionally, the role must have permission to <code>kms:GenerateDataKey</code> using KMS key supplied as <code>AwsKmsKeyId</code> in <code>SseAwsKeyManagementParams</code>. If media concatenation will be required later, the role must also have permission to <code>kms:Decrypt</code> for the same KMS key.</p><br>
14 /// - [`tags(Tag)`](crate::operation::create_media_capture_pipeline::builders::CreateMediaCapturePipelineFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_media_capture_pipeline::builders::CreateMediaCapturePipelineFluentBuilder::set_tags):<br>required: **false**<br><p>The tag key-value pairs.</p><br>
15 /// - On success, responds with [`CreateMediaCapturePipelineOutput`](crate::operation::create_media_capture_pipeline::CreateMediaCapturePipelineOutput) with field(s):
16 /// - [`media_capture_pipeline(Option<MediaCapturePipeline>)`](crate::operation::create_media_capture_pipeline::CreateMediaCapturePipelineOutput::media_capture_pipeline): <p>A media pipeline object, the ID, source type, source ARN, sink type, and sink ARN of a media pipeline object.</p>
17 /// - On failure, responds with [`SdkError<CreateMediaCapturePipelineError>`](crate::operation::create_media_capture_pipeline::CreateMediaCapturePipelineError)
18 pub fn create_media_capture_pipeline(
19 &self,
20 ) -> crate::operation::create_media_capture_pipeline::builders::CreateMediaCapturePipelineFluentBuilder {
21 crate::operation::create_media_capture_pipeline::builders::CreateMediaCapturePipelineFluentBuilder::new(self.handle.clone())
22 }
23}