AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Disconnects a specified participant from a specified stage. If the participant is publishing using an IngestConfiguration, DisconnectParticipant also updates the stageArn in the IngestConfiguration to be an empty string.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDisconnectParticipant and EndDisconnectParticipant.

Namespace: Amazon.IVSRealTime
Assembly: AWSSDK.IVSRealTime.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<DisconnectParticipantResponse> DisconnectParticipantAsync(
         DisconnectParticipantRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.IVSRealTime.Model.DisconnectParticipantRequest

Container for the necessary parameters to execute the DisconnectParticipant service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the DisconnectParticipant service method, as returned by IVSRealTime.

Exceptions

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also