Amazonka.IVSChat.DisconnectUser

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

Creating a Request

data DisconnectUser

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

ToJSON DisconnectUser

Defined in Amazonka.IVSChat.DisconnectUser

Methods

toJSON :: DisconnectUser -> Value

toEncoding :: DisconnectUser -> Encoding

toJSONList :: [DisconnectUser] -> Value

toEncodingList :: [DisconnectUser] -> Encoding

ToHeaders DisconnectUser

Defined in Amazonka.IVSChat.DisconnectUser

Methods

toHeaders :: DisconnectUser -> [Header]

ToPath DisconnectUser

Defined in Amazonka.IVSChat.DisconnectUser

Methods

toPath :: DisconnectUser -> ByteString

ToQuery DisconnectUser

Defined in Amazonka.IVSChat.DisconnectUser

Methods

toQuery :: DisconnectUser -> QueryString

AWSRequest DisconnectUser

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

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

Defined in Amazonka.IVSChat.DisconnectUser

Methods

readsPrec :: Int -> ReadS DisconnectUser

readList :: ReadS [DisconnectUser]

readPrec :: ReadPrec DisconnectUser

readListPrec :: ReadPrec [DisconnectUser]

Show DisconnectUser

Defined in Amazonka.IVSChat.DisconnectUser

Methods

showsPrec :: Int -> DisconnectUser -> ShowS

show :: DisconnectUser -> String

showList :: [DisconnectUser] -> ShowS

NFData DisconnectUser

Defined in Amazonka.IVSChat.DisconnectUser

Methods

rnf :: DisconnectUser -> ()

Eq DisconnectUser

Defined in Amazonka.IVSChat.DisconnectUser

Methods

(==) :: DisconnectUser -> DisconnectUser -> Bool

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

Hashable DisconnectUser

Defined in Amazonka.IVSChat.DisconnectUser

Methods

hashWithSalt :: Int -> DisconnectUser -> Int

hash :: DisconnectUser -> Int

type AWSResponse DisconnectUser

Defined in Amazonka.IVSChat.DisconnectUser

type AWSResponse DisconnectUser = DisconnectUserResponse

type Rep DisconnectUser

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

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)

Reason for disconnecting the user.

disconnectUser_roomIdentifier :: Lens' DisconnectUser Text

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

disconnectUser_userId :: Lens' DisconnectUser Text

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

Destructuring the Response

data DisconnectUserResponse

See: newDisconnectUserResponse smart constructor.

Constructors

DisconnectUserResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic DisconnectUserResponse

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

Defined in Amazonka.IVSChat.DisconnectUser

Methods

readsPrec :: Int -> ReadS DisconnectUserResponse

readList :: ReadS [DisconnectUserResponse]

readPrec :: ReadPrec DisconnectUserResponse

readListPrec :: ReadPrec [DisconnectUserResponse]

Show DisconnectUserResponse

Defined in Amazonka.IVSChat.DisconnectUser

Methods

showsPrec :: Int -> DisconnectUserResponse -> ShowS

show :: DisconnectUserResponse -> String

showList :: [DisconnectUserResponse] -> ShowS

NFData DisconnectUserResponse

Defined in Amazonka.IVSChat.DisconnectUser

Methods

rnf :: DisconnectUserResponse -> ()

Eq DisconnectUserResponse

Defined in Amazonka.IVSChat.DisconnectUser

Methods

(==) :: DisconnectUserResponse -> DisconnectUserResponse -> Bool

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

type Rep DisconnectUserResponse

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

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

The response's http status code.