aws_sdk_ivsrealtime/client/
disconnect_participant.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 [`DisconnectParticipant`](crate::operation::disconnect_participant::builders::DisconnectParticipantFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`stage_arn(impl Into<String>)`](crate::operation::disconnect_participant::builders::DisconnectParticipantFluentBuilder::stage_arn) / [`set_stage_arn(Option<String>)`](crate::operation::disconnect_participant::builders::DisconnectParticipantFluentBuilder::set_stage_arn):<br>required: **true**<br><p>ARN of the stage to which the participant is attached.</p><br>
7    ///   - [`participant_id(impl Into<String>)`](crate::operation::disconnect_participant::builders::DisconnectParticipantFluentBuilder::participant_id) / [`set_participant_id(Option<String>)`](crate::operation::disconnect_participant::builders::DisconnectParticipantFluentBuilder::set_participant_id):<br>required: **true**<br><p>Identifier of the participant to be disconnected. IVS assigns this; it is returned by <code>CreateParticipantToken</code> (for streams using WebRTC ingest) or <code>CreateIngestConfiguration</code> (for streams using RTMP ingest).</p><br>
8    ///   - [`reason(impl Into<String>)`](crate::operation::disconnect_participant::builders::DisconnectParticipantFluentBuilder::reason) / [`set_reason(Option<String>)`](crate::operation::disconnect_participant::builders::DisconnectParticipantFluentBuilder::set_reason):<br>required: **false**<br><p>Description of why this participant is being disconnected.</p><br>
9    /// - On success, responds with [`DisconnectParticipantOutput`](crate::operation::disconnect_participant::DisconnectParticipantOutput)
10    /// - On failure, responds with [`SdkError<DisconnectParticipantError>`](crate::operation::disconnect_participant::DisconnectParticipantError)
11    pub fn disconnect_participant(&self) -> crate::operation::disconnect_participant::builders::DisconnectParticipantFluentBuilder {
12        crate::operation::disconnect_participant::builders::DisconnectParticipantFluentBuilder::new(self.handle.clone())
13    }
14}
aws_sdk_ivsrealtime/client/disconnect_participant.rs

aws_sdk_ivsrealtime/client/
disconnect_participant.rs
