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 |
The capabilties 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 toSendReceive
orReceive
unless you also setvideo
capabilities toSendReceive
orReceive
. If you don't set thevideo
capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set yourvideo
capability to receive and you set yourcontent
capability to not receive. - When you change an
audio
capability fromNone
orReceive
toSend
orSendReceive
, and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants. - When you change a
video
orcontent
capability fromNone
orReceive
toSend
orSendReceive
, 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 UpdateAttendeeCapabilities = UpdateAttendeeCapabilities' {}
- newUpdateAttendeeCapabilities :: Text -> Text -> AttendeeCapabilities -> UpdateAttendeeCapabilities
- updateAttendeeCapabilities_meetingId :: Lens' UpdateAttendeeCapabilities Text
- updateAttendeeCapabilities_attendeeId :: Lens' UpdateAttendeeCapabilities Text
- updateAttendeeCapabilities_capabilities :: Lens' UpdateAttendeeCapabilities AttendeeCapabilities
- data UpdateAttendeeCapabilitiesResponse = UpdateAttendeeCapabilitiesResponse' {
- attendee :: Maybe Attendee
- httpStatus :: Int
- newUpdateAttendeeCapabilitiesResponse :: Int -> UpdateAttendeeCapabilitiesResponse
- updateAttendeeCapabilitiesResponse_attendee :: Lens' UpdateAttendeeCapabilitiesResponse (Maybe Attendee)
- updateAttendeeCapabilitiesResponse_httpStatus :: Lens' UpdateAttendeeCapabilitiesResponse Int
Creating a Request
data UpdateAttendeeCapabilities Source #
See: newUpdateAttendeeCapabilities
smart constructor.
UpdateAttendeeCapabilities' | |
|
Instances
newUpdateAttendeeCapabilities Source #
Create a value of UpdateAttendeeCapabilities
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:
UpdateAttendeeCapabilities
, updateAttendeeCapabilities_meetingId
- The ID of the meeting associated with the update request.
UpdateAttendeeCapabilities
, updateAttendeeCapabilities_attendeeId
- The ID of the attendee associated with the update request.
UpdateAttendeeCapabilities
, updateAttendeeCapabilities_capabilities
- The capabilties that you want to update.
Request Lenses
updateAttendeeCapabilities_meetingId :: Lens' UpdateAttendeeCapabilities Text Source #
The ID of the meeting associated with the update request.
updateAttendeeCapabilities_attendeeId :: Lens' UpdateAttendeeCapabilities Text Source #
The ID of the attendee associated with the update request.
updateAttendeeCapabilities_capabilities :: Lens' UpdateAttendeeCapabilities AttendeeCapabilities Source #
The capabilties that you want to update.
Destructuring the Response
data UpdateAttendeeCapabilitiesResponse Source #
See: newUpdateAttendeeCapabilitiesResponse
smart constructor.
UpdateAttendeeCapabilitiesResponse' | |
|
Instances
newUpdateAttendeeCapabilitiesResponse Source #
Create a value of UpdateAttendeeCapabilitiesResponse
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:
$sel:attendee:UpdateAttendeeCapabilitiesResponse'
, updateAttendeeCapabilitiesResponse_attendee
- The updated attendee data.
$sel:httpStatus:UpdateAttendeeCapabilitiesResponse'
, updateAttendeeCapabilitiesResponse_httpStatus
- The response's http status code.
Response Lenses
updateAttendeeCapabilitiesResponse_attendee :: Lens' UpdateAttendeeCapabilitiesResponse (Maybe Attendee) Source #
The updated attendee data.
updateAttendeeCapabilitiesResponse_httpStatus :: Lens' UpdateAttendeeCapabilitiesResponse Int Source #
The response's http status code.