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.GetRoom

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the specified room.

Synopsis

data GetRoom = GetRoom' {
- identifier :: Text
}
newGetRoom :: Text -> GetRoom
getRoom_identifier :: Lens' GetRoom Text
data GetRoomResponse = GetRoomResponse' {
- arn :: Maybe Text
- createTime :: Maybe ISO8601
- id :: Maybe Text
- loggingConfigurationIdentifiers :: Maybe [Text]
- maximumMessageLength :: Maybe Natural
- maximumMessageRatePerSecond :: Maybe Natural
- messageReviewHandler :: Maybe MessageReviewHandler
- name :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- updateTime :: Maybe ISO8601
- httpStatus :: Int
}
newGetRoomResponse :: Int -> GetRoomResponse
getRoomResponse_arn :: Lens' GetRoomResponse (Maybe Text)
getRoomResponse_createTime :: Lens' GetRoomResponse (Maybe UTCTime)
getRoomResponse_id :: Lens' GetRoomResponse (Maybe Text)
getRoomResponse_loggingConfigurationIdentifiers :: Lens' GetRoomResponse (Maybe [Text])
getRoomResponse_maximumMessageLength :: Lens' GetRoomResponse (Maybe Natural)
getRoomResponse_maximumMessageRatePerSecond :: Lens' GetRoomResponse (Maybe Natural)
getRoomResponse_messageReviewHandler :: Lens' GetRoomResponse (Maybe MessageReviewHandler)
getRoomResponse_name :: Lens' GetRoomResponse (Maybe Text)
getRoomResponse_tags :: Lens' GetRoomResponse (Maybe (HashMap Text Text))
getRoomResponse_updateTime :: Lens' GetRoomResponse (Maybe UTCTime)
getRoomResponse_httpStatus :: Lens' GetRoomResponse Int

Creating a Request

data GetRoom Source #

See: newGetRoom smart constructor.

Constructors

GetRoom'
Fields identifier :: Text Identifier of the room for which the configuration is to be retrieved. Currently this must be an ARN.

Instances

Instances details

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

newGetRoom Source #

Arguments

:: Text	`$sel:identifier:GetRoom'`
-> GetRoom

Create a value of GetRoom 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:identifier:GetRoom', getRoom_identifier - Identifier of the room for which the configuration is to be retrieved. Currently this must be an ARN.

Request Lenses

getRoom_identifier :: Lens' GetRoom Text Source #

Identifier of the room for which the configuration is to be retrieved. Currently this must be an ARN.

Destructuring the Response

data GetRoomResponse Source #

See: newGetRoomResponse smart constructor.

Constructors

GetRoomResponse'

Fields

arn :: Maybe Text
Room ARN, from the request (if identifier was an ARN).
createTime :: Maybe ISO8601
Time when the room was created. This is an ISO 8601 timestamp; /note that this is returned as a string/.
id :: Maybe Text
Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
loggingConfigurationIdentifiers :: Maybe [Text]
Array of logging configurations attached to the room.
maximumMessageLength :: Maybe Natural
Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.
maximumMessageRatePerSecond :: Maybe Natural
Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.
messageReviewHandler :: Maybe MessageReviewHandler
Configuration information for optional review of messages.
name :: Maybe Text
Room name. The value does not need to be unique.
tags :: Maybe (HashMap Text Text)
Tags attached to the resource. Array of maps, each of the form string:string (key:value).
updateTime :: Maybe ISO8601
Time of the room’s last update. This is an ISO 8601 timestamp; /note that this is returned as a string/.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetRoomResponse Source #
Instance details Defined in Amazonka.IVSChat.GetRoom Associated Types type Rep GetRoomResponse :: Type -> Type # Methods from :: GetRoomResponse -> Rep GetRoomResponse x # to :: Rep GetRoomResponse x -> GetRoomResponse #
Read GetRoomResponse Source #
Instance details Defined in Amazonka.IVSChat.GetRoom Methods readsPrec :: Int -> ReadS GetRoomResponse # readList :: ReadS [GetRoomResponse] # readPrec :: ReadPrec GetRoomResponse # readListPrec :: ReadPrec [GetRoomResponse] #
Show GetRoomResponse Source #
Instance details Defined in Amazonka.IVSChat.GetRoom Methods showsPrec :: Int -> GetRoomResponse -> ShowS # show :: GetRoomResponse -> String # showList :: [GetRoomResponse] -> ShowS #
NFData GetRoomResponse Source #
Instance details Defined in Amazonka.IVSChat.GetRoom Methods rnf :: GetRoomResponse -> () #
Eq GetRoomResponse Source #
Instance details Defined in Amazonka.IVSChat.GetRoom Methods (==) :: GetRoomResponse -> GetRoomResponse -> Bool # (/=) :: GetRoomResponse -> GetRoomResponse -> Bool #
type Rep GetRoomResponse Source #
Instance details Defined in Amazonka.IVSChat.GetRoom type Rep GetRoomResponse = D1 ('MetaData "GetRoomResponse" "Amazonka.IVSChat.GetRoom" "amazonka-ivschat-2.0-AB4QlCKEEGt4izEWjWKMb2" 'False) (C1 ('MetaCons "GetRoomResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "createTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "loggingConfigurationIdentifiers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "maximumMessageLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))) :: ((S1 ('MetaSel ('Just "maximumMessageRatePerSecond") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "messageReviewHandler") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MessageReviewHandler)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "updateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetRoomResponse Source #

Arguments

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

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

GetRoomResponse, getRoomResponse_arn - Room ARN, from the request (if identifier was an ARN).

GetRoomResponse, getRoomResponse_createTime - Time when the room was created. This is an ISO 8601 timestamp; /note that this is returned as a string/.

GetRoomResponse, getRoomResponse_id - Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.

GetRoomResponse, getRoomResponse_loggingConfigurationIdentifiers - Array of logging configurations attached to the room.

$sel:maximumMessageLength:GetRoomResponse', getRoomResponse_maximumMessageLength - Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.

$sel:maximumMessageRatePerSecond:GetRoomResponse', getRoomResponse_maximumMessageRatePerSecond - Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.

GetRoomResponse, getRoomResponse_messageReviewHandler - Configuration information for optional review of messages.

GetRoomResponse, getRoomResponse_name - Room name. The value does not need to be unique.

GetRoomResponse, getRoomResponse_tags - Tags attached to the resource. Array of maps, each of the form string:string (key:value).

GetRoomResponse, getRoomResponse_updateTime - Time of the room’s last update. This is an ISO 8601 timestamp; /note that this is returned as a string/.

$sel:httpStatus:GetRoomResponse', getRoomResponse_httpStatus - The response's http status code.

Response Lenses

getRoomResponse_arn :: Lens' GetRoomResponse (Maybe Text) Source #

Room ARN, from the request (if identifier was an ARN).

getRoomResponse_createTime :: Lens' GetRoomResponse (Maybe UTCTime) Source #

Time when the room was created. This is an ISO 8601 timestamp; /note that this is returned as a string/.

getRoomResponse_id :: Lens' GetRoomResponse (Maybe Text) Source #

Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.

getRoomResponse_loggingConfigurationIdentifiers :: Lens' GetRoomResponse (Maybe [Text]) Source #

Array of logging configurations attached to the room.

getRoomResponse_maximumMessageLength :: Lens' GetRoomResponse (Maybe Natural) Source #

Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.

getRoomResponse_maximumMessageRatePerSecond :: Lens' GetRoomResponse (Maybe Natural) Source #

Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.

getRoomResponse_messageReviewHandler :: Lens' GetRoomResponse (Maybe MessageReviewHandler) Source #

Configuration information for optional review of messages.

getRoomResponse_name :: Lens' GetRoomResponse (Maybe Text) Source #

Room name. The value does not need to be unique.

getRoomResponse_tags :: Lens' GetRoomResponse (Maybe (HashMap Text Text)) Source #

Tags attached to the resource. Array of maps, each of the form string:string (key:value).

getRoomResponse_updateTime :: Lens' GetRoomResponse (Maybe UTCTime) Source #

Time of the room’s last update. This is an ISO 8601 timestamp; /note that this is returned as a string/.

getRoomResponse_httpStatus :: Lens' GetRoomResponse Int Source #

The response's http status code.