amazonka-chime-2.0: Amazon Chime SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Chime.Types.Attendee

Description

 
Synopsis

Documentation

data Attendee Source #

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

Instances

Instances details
FromJSON Attendee Source # 
Instance details

Defined in Amazonka.Chime.Types.Attendee

Generic Attendee Source # 
Instance details

Defined in Amazonka.Chime.Types.Attendee

Associated Types

type Rep Attendee :: Type -> Type #

Methods

from :: Attendee -> Rep Attendee x #

to :: Rep Attendee x -> Attendee #

Show Attendee Source # 
Instance details

Defined in Amazonka.Chime.Types.Attendee

NFData Attendee Source # 
Instance details

Defined in Amazonka.Chime.Types.Attendee

Methods

rnf :: Attendee -> () #

Eq Attendee Source # 
Instance details

Defined in Amazonka.Chime.Types.Attendee

Hashable Attendee Source # 
Instance details

Defined in Amazonka.Chime.Types.Attendee

Methods

hashWithSalt :: Int -> Attendee -> Int #

hash :: Attendee -> Int #

type Rep Attendee Source # 
Instance details

Defined in Amazonka.Chime.Types.Attendee

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

newAttendee :: Attendee Source #

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: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) Source #

The Amazon Chime SDK attendee ID.

attendee_externalUserId :: Lens' Attendee (Maybe Text) Source #

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) Source #

The join token used by the Amazon Chime SDK attendee.