amazonka-chime-sdk-meetings-2.0: Amazon Chime SDK Meetings 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.ChimeSdkMeetings.CreateAttendee

Description

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.

Synopsis

Creating a Request

data CreateAttendee Source #

See: newCreateAttendee smart constructor.

Constructors

CreateAttendee' 

Fields

  • capabilities :: Maybe AttendeeCapabilities

    The capabilities (audio, video, or content) that you want to grant an attendee. If you don't specify capabilities, all users have send and receive capabilities on all media channels by default.

    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.
  • meetingId :: Text

    The unique ID of the meeting.

  • externalUserId :: Sensitive Text

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

Instances

Instances details
ToJSON CreateAttendee Source # 
Instance details

Defined in Amazonka.ChimeSdkMeetings.CreateAttendee

Methods

toJSON :: CreateAttendee -> Value #

toEncoding :: CreateAttendee -> Encoding #

toJSONList :: [CreateAttendee] -> Value #

toEncodingList :: [CreateAttendee] -> Encoding #

ToHeaders CreateAttendee Source # 
Instance details

Defined in Amazonka.ChimeSdkMeetings.CreateAttendee

Methods

toHeaders :: CreateAttendee -> [Header] #

ToPath CreateAttendee Source # 
Instance details

Defined in Amazonka.ChimeSdkMeetings.CreateAttendee

Methods

toPath :: CreateAttendee -> ByteString #

ToQuery CreateAttendee Source # 
Instance details

Defined in Amazonka.ChimeSdkMeetings.CreateAttendee

Methods

toQuery :: CreateAttendee -> QueryString #

AWSRequest CreateAttendee Source # 
Instance details

Defined in Amazonka.ChimeSdkMeetings.CreateAttendee

Associated Types

type AWSResponse CreateAttendee #

Methods

request :: (Service -> Service) -> CreateAttendee -> Request CreateAttendee #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateAttendee -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateAttendee))) #

Generic CreateAttendee Source # 
Instance details

Defined in Amazonka.ChimeSdkMeetings.CreateAttendee

Associated Types

type Rep CreateAttendee :: Type -> Type #

Methods

from :: CreateAttendee -> Rep CreateAttendee x #

to :: Rep CreateAttendee x -> CreateAttendee #

Show CreateAttendee Source # 
Instance details

Defined in Amazonka.ChimeSdkMeetings.CreateAttendee

Methods

showsPrec :: Int -> CreateAttendee -> ShowS #

show :: CreateAttendee -> String #

showList :: [CreateAttendee] -> ShowS #

NFData CreateAttendee Source # 
Instance details

Defined in Amazonka.ChimeSdkMeetings.CreateAttendee

Methods

rnf :: CreateAttendee -> () #

Eq CreateAttendee Source # 
Instance details

Defined in Amazonka.ChimeSdkMeetings.CreateAttendee

Methods

(==) :: CreateAttendee -> CreateAttendee -> Bool #

(/=) :: CreateAttendee -> CreateAttendee -> Bool #

Hashable CreateAttendee Source # 
Instance details

Defined in Amazonka.ChimeSdkMeetings.CreateAttendee

Methods

hashWithSalt :: Int -> CreateAttendee -> Int #

hash :: CreateAttendee -> Int #

type AWSResponse CreateAttendee Source # 
Instance details

Defined in Amazonka.ChimeSdkMeetings.CreateAttendee

type AWSResponse CreateAttendee = CreateAttendeeResponse
type Rep CreateAttendee Source # 
Instance details

Defined in Amazonka.ChimeSdkMeetings.CreateAttendee

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

newCreateAttendee Source #

Arguments

:: Text

CreateAttendee

-> Text

CreateAttendee

-> CreateAttendee 

Create a value of CreateAttendee 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:

CreateAttendee, createAttendee_capabilities - The capabilities (audio, video, or content) that you want to grant an attendee. If you don't specify capabilities, all users have send and receive capabilities on all media channels by default.

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.

CreateAttendee, createAttendee_meetingId - The unique ID of the meeting.

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

Request Lenses

createAttendee_capabilities :: Lens' CreateAttendee (Maybe AttendeeCapabilities) Source #

The capabilities (audio, video, or content) that you want to grant an attendee. If you don't specify capabilities, all users have send and receive capabilities on all media channels by default.

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.

createAttendee_meetingId :: Lens' CreateAttendee Text Source #

The unique ID of the meeting.

createAttendee_externalUserId :: Lens' CreateAttendee Text Source #

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

Destructuring the Response

data CreateAttendeeResponse Source #

See: newCreateAttendeeResponse smart constructor.

Constructors

CreateAttendeeResponse' 

Fields

Instances

Instances details
Generic CreateAttendeeResponse Source # 
Instance details

Defined in Amazonka.ChimeSdkMeetings.CreateAttendee

Associated Types

type Rep CreateAttendeeResponse :: Type -> Type #

Methods

from :: CreateAttendeeResponse -> Rep CreateAttendeeResponse x #

to :: Rep CreateAttendeeResponse x -> CreateAttendeeResponse #

Show CreateAttendeeResponse Source # 
Instance details

Defined in Amazonka.ChimeSdkMeetings.CreateAttendee

Methods

showsPrec :: Int -> CreateAttendeeResponse -> ShowS #

show :: CreateAttendeeResponse -> String #

showList :: [CreateAttendeeResponse] -> ShowS #

NFData CreateAttendeeResponse Source # 
Instance details

Defined in Amazonka.ChimeSdkMeetings.CreateAttendee

Methods

rnf :: CreateAttendeeResponse -> () #

Eq CreateAttendeeResponse Source # 
Instance details

Defined in Amazonka.ChimeSdkMeetings.CreateAttendee

Methods

(==) :: CreateAttendeeResponse -> CreateAttendeeResponse -> Bool #

(/=) :: CreateAttendeeResponse -> CreateAttendeeResponse -> Bool #

type Rep CreateAttendeeResponse Source # 
Instance details

Defined in Amazonka.ChimeSdkMeetings.CreateAttendee

type Rep CreateAttendeeResponse = D1 ('MetaData "CreateAttendeeResponse" "Amazonka.ChimeSdkMeetings.CreateAttendee" "amazonka-chime-sdk-meetings-2.0-BH1YehHiRGe8LBGen60xi" 'False) (C1 ('MetaCons "CreateAttendeeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attendee") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Attendee)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateAttendeeResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateAttendeeResponse'

-> CreateAttendeeResponse 

Create a value of CreateAttendeeResponse 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:CreateAttendeeResponse', createAttendeeResponse_attendee - The attendee information, including attendee ID and join token.

$sel:httpStatus:CreateAttendeeResponse', createAttendeeResponse_httpStatus - The response's http status code.

Response Lenses

createAttendeeResponse_attendee :: Lens' CreateAttendeeResponse (Maybe Attendee) Source #

The attendee information, including attendee ID and join token.

createAttendeeResponse_httpStatus :: Lens' CreateAttendeeResponse Int Source #

The response's http status code.