/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the chime-sdk-meetings-2021-07-15.normal.json service model. */ using System; using System.Threading; using System.Threading.Tasks; using System.Collections.Generic; using Amazon.Runtime; using Amazon.ChimeSDKMeetings.Model; namespace Amazon.ChimeSDKMeetings { /// /// Interface for accessing ChimeSDKMeetings /// /// The Amazon Chime SDK meetings APIs in this section allow software developers to create /// Amazon Chime SDK meetings, set the AWS Regions for meetings, create and manage users, /// and send and receive meeting notifications. For more information about the meeting /// APIs, see Amazon /// Chime SDK meetings. /// public partial interface IAmazonChimeSDKMeetings : IAmazonService, IDisposable { #if AWS_ASYNC_ENUMERABLES_API /// /// Paginators for the service /// IChimeSDKMeetingsPaginatorFactory Paginators { get; } #endif #region BatchCreateAttendee /// /// Creates up to 100 attendees for an active Amazon Chime SDK meeting. For more information /// about the Amazon Chime SDK, see Using /// the Amazon Chime SDK in the Amazon Chime Developer Guide. /// /// Container for the necessary parameters to execute the BatchCreateAttendee service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the BatchCreateAttendee service method, as returned by ChimeSDKMeetings. /// /// The input parameters don't match the service's restrictions. /// /// /// The client is permanently forbidden from making the request. /// /// /// The request exceeds the resource limit. /// /// /// One or more of the resources in the request does not exist in the system. /// /// /// The service encountered an unexpected error. /// /// /// The service is currently unavailable. /// /// /// The number of customer requests exceeds the request rate limit. /// /// /// The user isn't authorized to request a resource. /// /// /// The request was well-formed but was unable to be followed due to semantic errors. /// /// REST API Reference for BatchCreateAttendee Operation Task BatchCreateAttendeeAsync(BatchCreateAttendeeRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region BatchUpdateAttendeeCapabilitiesExcept /// /// Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds /// table. /// /// /// /// You use the capabilities with a set of values that control what the capabilities can /// do, such as SendReceive data. For more information about those values, /// see . /// /// /// /// When using capabilities, be aware of these corner cases: /// /// /// /// Container for the necessary parameters to execute the BatchUpdateAttendeeCapabilitiesExcept service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the BatchUpdateAttendeeCapabilitiesExcept service method, as returned by ChimeSDKMeetings. /// /// The input parameters don't match the service's restrictions. /// /// /// Multiple instances of the same request have been made simultaneously. /// /// /// The client is permanently forbidden from making the request. /// /// /// One or more of the resources in the request does not exist in the system. /// /// /// The service is currently unavailable. /// /// /// The user isn't authorized to request a resource. /// /// REST API Reference for BatchUpdateAttendeeCapabilitiesExcept Operation Task BatchUpdateAttendeeCapabilitiesExceptAsync(BatchUpdateAttendeeCapabilitiesExceptRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateAttendee /// /// Creates a new attendee for an active Amazon Chime SDK meeting. For more information /// about the Amazon Chime SDK, see Using /// the Amazon Chime SDK in the Amazon Chime Developer Guide. /// /// Container for the necessary parameters to execute the CreateAttendee service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateAttendee service method, as returned by ChimeSDKMeetings. /// /// The input parameters don't match the service's restrictions. /// /// /// The client is permanently forbidden from making the request. /// /// /// The request exceeds the resource limit. /// /// /// One or more of the resources in the request does not exist in the system. /// /// /// The service encountered an unexpected error. /// /// /// The service is currently unavailable. /// /// /// The number of customer requests exceeds the request rate limit. /// /// /// The user isn't authorized to request a resource. /// /// /// The request was well-formed but was unable to be followed due to semantic errors. /// /// REST API Reference for CreateAttendee Operation Task CreateAttendeeAsync(CreateAttendeeRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateMeeting /// /// Creates a new Amazon Chime SDK meeting in the specified media Region with no initial /// attendees. For more information about specifying media Regions, see Amazon /// Chime SDK Media Regions in the Amazon Chime Developer Guide. For more information /// about the Amazon Chime SDK, see Using /// the Amazon Chime SDK in the Amazon Chime Developer Guide. /// /// Container for the necessary parameters to execute the CreateMeeting service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateMeeting service method, as returned by ChimeSDKMeetings. /// /// The input parameters don't match the service's restrictions. /// /// /// The client is permanently forbidden from making the request. /// /// /// The request exceeds the resource limit. /// /// /// The service encountered an unexpected error. /// /// /// The service is currently unavailable. /// /// /// The number of customer requests exceeds the request rate limit. /// /// /// The user isn't authorized to request a resource. /// /// REST API Reference for CreateMeeting Operation Task CreateMeetingAsync(CreateMeetingRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateMeetingWithAttendees /// /// Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. /// For more information about specifying media Regions, see Amazon /// Chime SDK Media Regions in the Amazon Chime Developer Guide. For more information /// about the Amazon Chime SDK, see Using /// the Amazon Chime SDK in the Amazon Chime Developer Guide. /// /// Container for the necessary parameters to execute the CreateMeetingWithAttendees service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateMeetingWithAttendees service method, as returned by ChimeSDKMeetings. /// /// The input parameters don't match the service's restrictions. /// /// /// The client is permanently forbidden from making the request. /// /// /// The request exceeds the resource limit. /// /// /// The service encountered an unexpected error. /// /// /// The service is currently unavailable. /// /// /// The number of customer requests exceeds the request rate limit. /// /// /// The user isn't authorized to request a resource. /// /// REST API Reference for CreateMeetingWithAttendees Operation Task CreateMeetingWithAttendeesAsync(CreateMeetingWithAttendeesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteAttendee /// /// Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their /// JoinToken. Attendees are automatically deleted when a Amazon Chime SDK /// meeting is deleted. For more information about the Amazon Chime SDK, see Using /// the Amazon Chime SDK in the Amazon Chime Developer Guide. /// /// Container for the necessary parameters to execute the DeleteAttendee service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteAttendee service method, as returned by ChimeSDKMeetings. /// /// The input parameters don't match the service's restrictions. /// /// /// The client is permanently forbidden from making the request. /// /// /// One or more of the resources in the request does not exist in the system. /// /// /// The service encountered an unexpected error. /// /// /// The service is currently unavailable. /// /// /// The number of customer requests exceeds the request rate limit. /// /// /// The user isn't authorized to request a resource. /// /// REST API Reference for DeleteAttendee Operation Task DeleteAttendeeAsync(DeleteAttendeeRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteMeeting /// /// Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, /// disconnects all clients, and prevents new clients from joining the meeting. For more /// information about the Amazon Chime SDK, see Using /// the Amazon Chime SDK in the Amazon Chime Developer Guide. /// /// Container for the necessary parameters to execute the DeleteMeeting service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteMeeting service method, as returned by ChimeSDKMeetings. /// /// The input parameters don't match the service's restrictions. /// /// /// The client is permanently forbidden from making the request. /// /// /// One or more of the resources in the request does not exist in the system. /// /// /// The service encountered an unexpected error. /// /// /// The service is currently unavailable. /// /// /// The number of customer requests exceeds the request rate limit. /// /// /// The user isn't authorized to request a resource. /// /// REST API Reference for DeleteMeeting Operation Task DeleteMeetingAsync(DeleteMeetingRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetAttendee /// /// Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee /// ID. For more information about the Amazon Chime SDK, see Using /// the Amazon Chime SDK in the Amazon Chime Developer Guide. /// /// Container for the necessary parameters to execute the GetAttendee service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetAttendee service method, as returned by ChimeSDKMeetings. /// /// The input parameters don't match the service's restrictions. /// /// /// The client is permanently forbidden from making the request. /// /// /// One or more of the resources in the request does not exist in the system. /// /// /// The service encountered an unexpected error. /// /// /// The service is currently unavailable. /// /// /// The number of customer requests exceeds the request rate limit. /// /// /// The user isn't authorized to request a resource. /// /// REST API Reference for GetAttendee Operation Task GetAttendeeAsync(GetAttendeeRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetMeeting /// /// Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information /// about the Amazon Chime SDK, see Using /// the Amazon Chime SDK in the Amazon Chime Developer Guide. /// /// Container for the necessary parameters to execute the GetMeeting service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetMeeting service method, as returned by ChimeSDKMeetings. /// /// The input parameters don't match the service's restrictions. /// /// /// The client is permanently forbidden from making the request. /// /// /// One or more of the resources in the request does not exist in the system. /// /// /// The service encountered an unexpected error. /// /// /// The service is currently unavailable. /// /// /// The number of customer requests exceeds the request rate limit. /// /// /// The user isn't authorized to request a resource. /// /// REST API Reference for GetMeeting Operation Task GetMeetingAsync(GetMeetingRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListAttendees /// /// Lists the attendees for the specified Amazon Chime SDK meeting. For more information /// about the Amazon Chime SDK, see Using /// the Amazon Chime SDK in the Amazon Chime Developer Guide. /// /// Container for the necessary parameters to execute the ListAttendees service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListAttendees service method, as returned by ChimeSDKMeetings. /// /// The input parameters don't match the service's restrictions. /// /// /// The client is permanently forbidden from making the request. /// /// /// One or more of the resources in the request does not exist in the system. /// /// /// The service encountered an unexpected error. /// /// /// The service is currently unavailable. /// /// /// The number of customer requests exceeds the request rate limit. /// /// /// The user isn't authorized to request a resource. /// /// REST API Reference for ListAttendees Operation Task ListAttendeesAsync(ListAttendeesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListTagsForResource /// /// Returns a list of the tags available for the specified resource. /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListTagsForResource service method, as returned by ChimeSDKMeetings. /// /// The resource that you want to tag couldn't be found. /// /// REST API Reference for ListTagsForResource Operation Task ListTagsForResourceAsync(ListTagsForResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region StartMeetingTranscription /// /// Starts transcription for the specified meetingId. For more information, /// refer to /// Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer /// Guide. /// /// /// /// If you specify an invalid configuration, a TranscriptFailed event will /// be sent with the contents of the BadRequestException generated by Amazon /// Transcribe. For more information on each parameter and which combinations are valid, /// refer to the StartStreamTranscription /// API in the Amazon Transcribe Developer Guide. /// /// /// /// Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon /// Transcribe is subject to the AWS Service /// Terms, including the terms specific to the AWS Machine Learning and Artificial /// Intelligence Services. /// /// /// /// Container for the necessary parameters to execute the StartMeetingTranscription service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the StartMeetingTranscription service method, as returned by ChimeSDKMeetings. /// /// The input parameters don't match the service's restrictions. /// /// /// The client is permanently forbidden from making the request. /// /// /// The request exceeds the resource limit. /// /// /// One or more of the resources in the request does not exist in the system. /// /// /// The service encountered an unexpected error. /// /// /// The service is currently unavailable. /// /// /// The number of customer requests exceeds the request rate limit. /// /// /// The user isn't authorized to request a resource. /// /// /// The request was well-formed but was unable to be followed due to semantic errors. /// /// REST API Reference for StartMeetingTranscription Operation Task StartMeetingTranscriptionAsync(StartMeetingTranscriptionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region StopMeetingTranscription /// /// Stops transcription for the specified meetingId. For more information, /// refer to /// Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer /// Guide. /// /// /// /// Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon /// Transcribe is subject to the AWS Service /// Terms, including the terms specific to the AWS Machine Learning and Artificial /// Intelligence Services. /// /// /// /// Container for the necessary parameters to execute the StopMeetingTranscription service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the StopMeetingTranscription service method, as returned by ChimeSDKMeetings. /// /// The input parameters don't match the service's restrictions. /// /// /// The client is permanently forbidden from making the request. /// /// /// One or more of the resources in the request does not exist in the system. /// /// /// The service encountered an unexpected error. /// /// /// The service is currently unavailable. /// /// /// The number of customer requests exceeds the request rate limit. /// /// /// The user isn't authorized to request a resource. /// /// /// The request was well-formed but was unable to be followed due to semantic errors. /// /// REST API Reference for StopMeetingTranscription Operation Task StopMeetingTranscriptionAsync(StopMeetingTranscriptionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region TagResource /// /// The resource that supports tags. /// /// Container for the necessary parameters to execute the TagResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the TagResource service method, as returned by ChimeSDKMeetings. /// /// The input parameters don't match the service's restrictions. /// /// /// The resource that you want to tag couldn't be found. /// /// /// Too many tags were added to the specified resource. /// /// REST API Reference for TagResource Operation Task TagResourceAsync(TagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UntagResource /// /// Removes the specified tags from the specified resources. When you specify a tag key, /// the action removes both that key and its associated value. The operation succeeds /// even if you attempt to remove tags from a resource that were already removed. Note /// the following: /// ///
  • /// /// To remove tags from a resource, you need the necessary permissions for the service /// that the resource belongs to as well as permissions for removing tags. For more information, /// see the documentation for the service whose resource you want to untag. /// ///
  • /// /// You can only tag resources that are located in the specified AWS Region for the calling /// AWS account. /// ///
/// /// Minimum permissions /// /// /// /// In addition to the tag:UntagResources permission required by this operation, /// you must also have the remove tags permission defined by the service that created /// the resource. For example, to remove the tags from an Amazon EC2 instance using the /// UntagResources operation, you must have both of the following permissions: /// /// /// /// tag:UntagResource /// /// /// /// ChimeSDKMeetings:DeleteTags /// /// /// Container for the necessary parameters to execute the UntagResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UntagResource service method, as returned by ChimeSDKMeetings. /// /// The input parameters don't match the service's restrictions. /// /// /// The resource that you want to tag couldn't be found. /// /// REST API Reference for UntagResource Operation Task UntagResourceAsync(UntagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateAttendeeCapabilities /// /// The capabilities that you want to update. /// /// /// /// You use the capabilities with a set of values that control what the capabilities can /// do, such as SendReceive data. For more information about those values, /// see . /// /// /// /// When using capabilities, be aware of these corner cases: /// ///
  • /// /// You can't set content capabilities to SendReceive or Receive /// unless you also set video capabilities to SendReceive or /// Receive. If you don't set the video capability to receive, /// the response will contain an HTTP 400 Bad Request status code. However, you can set /// your video capability to receive and you set your content /// capability to not receive. /// ///
  • /// /// When you change an audio capability from None or Receive /// to Send or SendReceive , and if the attendee left their /// microphone unmuted, audio will flow from the attendee to the other meeting participants. /// ///
  • /// /// When you change a video or content capability from None /// or Receive to Send or SendReceive , and if /// the attendee turned on their video or content streams, remote attendees can receive /// those streams, but only after media renegotiation between the client and the Amazon /// Chime back-end server. /// ///
/// /// Container for the necessary parameters to execute the UpdateAttendeeCapabilities service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateAttendeeCapabilities service method, as returned by ChimeSDKMeetings. /// /// The input parameters don't match the service's restrictions. /// /// /// Multiple instances of the same request have been made simultaneously. /// /// /// The client is permanently forbidden from making the request. /// /// /// One or more of the resources in the request does not exist in the system. /// /// /// The service is currently unavailable. /// /// /// The user isn't authorized to request a resource. /// /// REST API Reference for UpdateAttendeeCapabilities Operation Task UpdateAttendeeCapabilitiesAsync(UpdateAttendeeCapabilitiesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion } }