Amazonka.ChimeSdkMeetings.Types.Attendee

Documentation

data Attendee

An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken. The JoinToken allows a client to authenticate and join as the specified attendee. The JoinToken expires when the meeting ends, or when DeleteAttendee is called. After that, the attendee is unable to join the meeting.

We recommend securely transferring each JoinToken from your server application to the client so that no other client has access to the token except for the one authorized to represent the attendee.

See: newAttendee smart constructor.

Constructors

Attendee'

Fields

• attendeeId :: Maybe Text

  The Amazon Chime SDK attendee ID.

• capabilities :: Maybe AttendeeCapabilities

  The capabilities assigned to an attendee: audio, video, or content.

  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 attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.
• externalUserId :: Maybe (Sensitive Text)

  The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

• joinToken :: Maybe (Sensitive Text)

  The join token used by the Amazon Chime SDK attendee.

Instances

FromJSON Attendee

Defined in Amazonka.ChimeSdkMeetings.Types.Attendee

Methods

parseJSON :: Value -> Parser Attendee

parseJSONList :: Value -> Parser [Attendee]

Generic Attendee

Defined in Amazonka.ChimeSdkMeetings.Types.Attendee

Associated Types

type Rep Attendee :: Type -> Type

Methods

from :: Attendee -> Rep Attendee x

to :: Rep Attendee x -> Attendee

Show Attendee

Defined in Amazonka.ChimeSdkMeetings.Types.Attendee

Methods

showsPrec :: Int -> Attendee -> ShowS

show :: Attendee -> String

showList :: [Attendee] -> ShowS

NFData Attendee

Defined in Amazonka.ChimeSdkMeetings.Types.Attendee

Methods

rnf :: Attendee -> ()

Eq Attendee

Defined in Amazonka.ChimeSdkMeetings.Types.Attendee

Methods

(==) :: Attendee -> Attendee -> Bool

(/=) :: Attendee -> Attendee -> Bool

Hashable Attendee

Defined in Amazonka.ChimeSdkMeetings.Types.Attendee

Methods

hashWithSalt :: Int -> Attendee -> Int

hash :: Attendee -> Int

type Rep Attendee

Defined in Amazonka.ChimeSdkMeetings.Types.Attendee

type Rep Attendee = D1 ('MetaData "Attendee" "Amazonka.ChimeSdkMeetings.Types.Attendee" "amazonka-chime-sdk-meetings-2.0-BH1YehHiRGe8LBGen60xi" 'False) (C1 ('MetaCons "Attendee'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "attendeeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "capabilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttendeeCapabilities))) :*: (S1 ('MetaSel ('Just "externalUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "joinToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))))

newAttendee :: Attendee

Create a value of Attendee 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:attendeeId:Attendee', attendee_attendeeId - The Amazon Chime SDK attendee ID.

$sel:capabilities:Attendee', attendee_capabilities - The capabilities assigned to an attendee: audio, video, or content.

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 attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

$sel:externalUserId:Attendee', attendee_externalUserId - The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

$sel:joinToken:Attendee', attendee_joinToken - The join token used by the Amazon Chime SDK attendee.

attendee_attendeeId :: Lens' Attendee (Maybe Text)

The Amazon Chime SDK attendee ID.

attendee_capabilities :: Lens' Attendee (Maybe AttendeeCapabilities)

The capabilities assigned to an attendee: audio, video, or content.

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 attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

attendee_externalUserId :: Lens' Attendee (Maybe Text)

The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

attendee_joinToken :: Lens' Attendee (Maybe Text)

The join token used by the Amazon Chime SDK attendee.