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.IVSChat.DisconnectUser

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.

Synopsis

Creating a Request

data DisconnectUser Source #

See: newDisconnectUser smart constructor.

Constructors

DisconnectUser'
Fields reason :: Maybe Text Reason for disconnecting the user. roomIdentifier :: Text Identifier of the room from which the user's clients should be disconnected. Currently this must be an ARN. userId :: Text ID of the user (connection) to disconnect from the room.

Instances

Instances details

ToJSON DisconnectUser Source #
Instance details Defined in Amazonka.IVSChat.DisconnectUser Methods toJSON :: DisconnectUser -> Value # toEncoding :: DisconnectUser -> Encoding # toJSONList :: [DisconnectUser] -> Value # toEncodingList :: [DisconnectUser] -> Encoding #
ToHeaders DisconnectUser Source #
Instance details Defined in Amazonka.IVSChat.DisconnectUser Methods toHeaders :: DisconnectUser -> [Header] #
ToPath DisconnectUser Source #
Instance details Defined in Amazonka.IVSChat.DisconnectUser Methods toPath :: DisconnectUser -> ByteString #
ToQuery DisconnectUser Source #
Instance details Defined in Amazonka.IVSChat.DisconnectUser Methods toQuery :: DisconnectUser -> QueryString #
AWSRequest DisconnectUser Source #
Instance details Defined in Amazonka.IVSChat.DisconnectUser Associated Types type AWSResponse DisconnectUser # Methods request :: (Service -> Service) -> DisconnectUser -> Request DisconnectUser # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DisconnectUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DisconnectUser))) #
Generic DisconnectUser Source #
Instance details Defined in Amazonka.IVSChat.DisconnectUser Associated Types type Rep DisconnectUser :: Type -> Type # Methods from :: DisconnectUser -> Rep DisconnectUser x # to :: Rep DisconnectUser x -> DisconnectUser #
Read DisconnectUser Source #
Instance details Defined in Amazonka.IVSChat.DisconnectUser Methods readsPrec :: Int -> ReadS DisconnectUser # readList :: ReadS [DisconnectUser] # readPrec :: ReadPrec DisconnectUser # readListPrec :: ReadPrec [DisconnectUser] #
Show DisconnectUser Source #
Instance details Defined in Amazonka.IVSChat.DisconnectUser Methods showsPrec :: Int -> DisconnectUser -> ShowS # show :: DisconnectUser -> String # showList :: [DisconnectUser] -> ShowS #
NFData DisconnectUser Source #
Instance details Defined in Amazonka.IVSChat.DisconnectUser Methods rnf :: DisconnectUser -> () #
Eq DisconnectUser Source #
Instance details Defined in Amazonka.IVSChat.DisconnectUser Methods (==) :: DisconnectUser -> DisconnectUser -> Bool # (/=) :: DisconnectUser -> DisconnectUser -> Bool #
Hashable DisconnectUser Source #
Instance details Defined in Amazonka.IVSChat.DisconnectUser Methods hashWithSalt :: Int -> DisconnectUser -> Int # hash :: DisconnectUser -> Int #
type AWSResponse DisconnectUser Source #
Instance details Defined in Amazonka.IVSChat.DisconnectUser type AWSResponse DisconnectUser = DisconnectUserResponse
type Rep DisconnectUser Source #
Instance details Defined in Amazonka.IVSChat.DisconnectUser type Rep DisconnectUser = D1 ('MetaData "DisconnectUser" "Amazonka.IVSChat.DisconnectUser" "amazonka-ivschat-2.0-AB4QlCKEEGt4izEWjWKMb2" 'False) (C1 ('MetaCons "DisconnectUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "roomIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDisconnectUser Source #

Arguments

:: Text	`$sel:roomIdentifier:DisconnectUser'`
-> Text	`$sel:userId:DisconnectUser'`
-> DisconnectUser

Create a value of DisconnectUser 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:reason:DisconnectUser', disconnectUser_reason - Reason for disconnecting the user.

$sel:roomIdentifier:DisconnectUser', disconnectUser_roomIdentifier - Identifier of the room from which the user's clients should be disconnected. Currently this must be an ARN.

$sel:userId:DisconnectUser', disconnectUser_userId - ID of the user (connection) to disconnect from the room.

Request Lenses

disconnectUser_reason :: Lens' DisconnectUser (Maybe Text) Source #

Reason for disconnecting the user.

disconnectUser_roomIdentifier :: Lens' DisconnectUser Text Source #

Identifier of the room from which the user's clients should be disconnected. Currently this must be an ARN.

disconnectUser_userId :: Lens' DisconnectUser Text Source #

ID of the user (connection) to disconnect from the room.

Destructuring the Response

data DisconnectUserResponse Source #

See: newDisconnectUserResponse smart constructor.

Constructors

DisconnectUserResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DisconnectUserResponse Source #
Instance details Defined in Amazonka.IVSChat.DisconnectUser Associated Types type Rep DisconnectUserResponse :: Type -> Type # Methods from :: DisconnectUserResponse -> Rep DisconnectUserResponse x # to :: Rep DisconnectUserResponse x -> DisconnectUserResponse #
Read DisconnectUserResponse Source #
Instance details Defined in Amazonka.IVSChat.DisconnectUser Methods readsPrec :: Int -> ReadS DisconnectUserResponse # readList :: ReadS [DisconnectUserResponse] # readPrec :: ReadPrec DisconnectUserResponse # readListPrec :: ReadPrec [DisconnectUserResponse] #
Show DisconnectUserResponse Source #
Instance details Defined in Amazonka.IVSChat.DisconnectUser Methods showsPrec :: Int -> DisconnectUserResponse -> ShowS # show :: DisconnectUserResponse -> String # showList :: [DisconnectUserResponse] -> ShowS #
NFData DisconnectUserResponse Source #
Instance details Defined in Amazonka.IVSChat.DisconnectUser Methods rnf :: DisconnectUserResponse -> () #
Eq DisconnectUserResponse Source #
Instance details Defined in Amazonka.IVSChat.DisconnectUser Methods (==) :: DisconnectUserResponse -> DisconnectUserResponse -> Bool # (/=) :: DisconnectUserResponse -> DisconnectUserResponse -> Bool #
type Rep DisconnectUserResponse Source #
Instance details Defined in Amazonka.IVSChat.DisconnectUser type Rep DisconnectUserResponse = D1 ('MetaData "DisconnectUserResponse" "Amazonka.IVSChat.DisconnectUser" "amazonka-ivschat-2.0-AB4QlCKEEGt4izEWjWKMb2" 'False) (C1 ('MetaCons "DisconnectUserResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDisconnectUserResponse Source #

Arguments

:: Int	`$sel:httpStatus:DisconnectUserResponse'`
-> DisconnectUserResponse

Create a value of DisconnectUserResponse 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:httpStatus:DisconnectUserResponse', disconnectUserResponse_httpStatus - The response's http status code.

Response Lenses

disconnectUserResponse_httpStatus :: Lens' DisconnectUserResponse Int Source #

The response's http status code.