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 |
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
See: newGetRoom
smart constructor.
GetRoom' | |
|
Instances
ToJSON GetRoom Source # | |
Defined in Amazonka.IVSChat.GetRoom | |
ToHeaders GetRoom Source # | |
Defined in Amazonka.IVSChat.GetRoom | |
ToPath GetRoom Source # | |
Defined in Amazonka.IVSChat.GetRoom toPath :: GetRoom -> ByteString # | |
ToQuery GetRoom Source # | |
Defined in Amazonka.IVSChat.GetRoom toQuery :: GetRoom -> QueryString # | |
AWSRequest GetRoom Source # | |
Defined in Amazonka.IVSChat.GetRoom type AWSResponse GetRoom # 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 # | |
Read GetRoom Source # | |
Show GetRoom Source # | |
NFData GetRoom Source # | |
Defined in Amazonka.IVSChat.GetRoom | |
Eq GetRoom Source # | |
Hashable GetRoom Source # | |
Defined in Amazonka.IVSChat.GetRoom | |
type AWSResponse GetRoom Source # | |
Defined in Amazonka.IVSChat.GetRoom | |
type Rep GetRoom Source # | |
Defined in Amazonka.IVSChat.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.
GetRoomResponse' | |
|
Instances
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.