| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.ChimeSdkMeetings.BatchUpdateAttendeeCapabilitiesExcept
Description
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:
- You can't set
contentcapabilities toSendReceiveorReceiveunless you also setvideocapabilities toSendReceiveorReceive. If you don't set thevideocapability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set yourvideocapability to receive and you set yourcontentcapability to not receive. - When you change an
audiocapability fromNoneorReceivetoSendorSendReceive, and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants. - When you change a
videoorcontentcapability fromNoneorReceivetoSendorSendReceive, and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.
Synopsis
- data BatchUpdateAttendeeCapabilitiesExcept = BatchUpdateAttendeeCapabilitiesExcept' {}
- newBatchUpdateAttendeeCapabilitiesExcept :: Text -> NonEmpty AttendeeIdItem -> AttendeeCapabilities -> BatchUpdateAttendeeCapabilitiesExcept
- batchUpdateAttendeeCapabilitiesExcept_meetingId :: Lens' BatchUpdateAttendeeCapabilitiesExcept Text
- batchUpdateAttendeeCapabilitiesExcept_excludedAttendeeIds :: Lens' BatchUpdateAttendeeCapabilitiesExcept (NonEmpty AttendeeIdItem)
- batchUpdateAttendeeCapabilitiesExcept_capabilities :: Lens' BatchUpdateAttendeeCapabilitiesExcept AttendeeCapabilities
- data BatchUpdateAttendeeCapabilitiesExceptResponse = BatchUpdateAttendeeCapabilitiesExceptResponse' {
- newBatchUpdateAttendeeCapabilitiesExceptResponse :: BatchUpdateAttendeeCapabilitiesExceptResponse
Creating a Request
data BatchUpdateAttendeeCapabilitiesExcept Source #
See: newBatchUpdateAttendeeCapabilitiesExcept smart constructor.
Constructors
| BatchUpdateAttendeeCapabilitiesExcept' | |
Fields
| |
Instances
newBatchUpdateAttendeeCapabilitiesExcept Source #
Arguments
| :: Text | |
| -> NonEmpty AttendeeIdItem |
|
| -> AttendeeCapabilities | |
| -> BatchUpdateAttendeeCapabilitiesExcept |
Create a value of BatchUpdateAttendeeCapabilitiesExcept with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
BatchUpdateAttendeeCapabilitiesExcept, batchUpdateAttendeeCapabilitiesExcept_meetingId - The ID of the meeting associated with the update request.
$sel:excludedAttendeeIds:BatchUpdateAttendeeCapabilitiesExcept', batchUpdateAttendeeCapabilitiesExcept_excludedAttendeeIds - The AttendeeIDs that you want to exclude from one or more
capabilities.
BatchUpdateAttendeeCapabilitiesExcept, batchUpdateAttendeeCapabilitiesExcept_capabilities - The capabilities (audio, video, or content) that you want to
update.
Request Lenses
batchUpdateAttendeeCapabilitiesExcept_meetingId :: Lens' BatchUpdateAttendeeCapabilitiesExcept Text Source #
The ID of the meeting associated with the update request.
batchUpdateAttendeeCapabilitiesExcept_excludedAttendeeIds :: Lens' BatchUpdateAttendeeCapabilitiesExcept (NonEmpty AttendeeIdItem) Source #
The AttendeeIDs that you want to exclude from one or more
capabilities.
batchUpdateAttendeeCapabilitiesExcept_capabilities :: Lens' BatchUpdateAttendeeCapabilitiesExcept AttendeeCapabilities Source #
The capabilities (audio, video, or content) that you want to
update.
Destructuring the Response
data BatchUpdateAttendeeCapabilitiesExceptResponse Source #
See: newBatchUpdateAttendeeCapabilitiesExceptResponse smart constructor.
Constructors
| BatchUpdateAttendeeCapabilitiesExceptResponse' | |
Instances
newBatchUpdateAttendeeCapabilitiesExceptResponse :: BatchUpdateAttendeeCapabilitiesExceptResponse Source #
Create a value of BatchUpdateAttendeeCapabilitiesExceptResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.