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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates a room’s configuration.

Synopsis

data UpdateRoom = UpdateRoom' {
- loggingConfigurationIdentifiers :: Maybe [Text]
- maximumMessageLength :: Maybe Natural
- maximumMessageRatePerSecond :: Maybe Natural
- messageReviewHandler :: Maybe MessageReviewHandler
- name :: Maybe Text
- identifier :: Text
}
newUpdateRoom :: Text -> UpdateRoom
updateRoom_loggingConfigurationIdentifiers :: Lens' UpdateRoom (Maybe [Text])
updateRoom_maximumMessageLength :: Lens' UpdateRoom (Maybe Natural)
updateRoom_maximumMessageRatePerSecond :: Lens' UpdateRoom (Maybe Natural)
updateRoom_messageReviewHandler :: Lens' UpdateRoom (Maybe MessageReviewHandler)
updateRoom_name :: Lens' UpdateRoom (Maybe Text)
updateRoom_identifier :: Lens' UpdateRoom Text
data UpdateRoomResponse = UpdateRoomResponse' {
- 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
}
newUpdateRoomResponse :: Int -> UpdateRoomResponse
updateRoomResponse_arn :: Lens' UpdateRoomResponse (Maybe Text)
updateRoomResponse_createTime :: Lens' UpdateRoomResponse (Maybe UTCTime)
updateRoomResponse_id :: Lens' UpdateRoomResponse (Maybe Text)
updateRoomResponse_loggingConfigurationIdentifiers :: Lens' UpdateRoomResponse (Maybe [Text])
updateRoomResponse_maximumMessageLength :: Lens' UpdateRoomResponse (Maybe Natural)
updateRoomResponse_maximumMessageRatePerSecond :: Lens' UpdateRoomResponse (Maybe Natural)
updateRoomResponse_messageReviewHandler :: Lens' UpdateRoomResponse (Maybe MessageReviewHandler)
updateRoomResponse_name :: Lens' UpdateRoomResponse (Maybe Text)
updateRoomResponse_tags :: Lens' UpdateRoomResponse (Maybe (HashMap Text Text))
updateRoomResponse_updateTime :: Lens' UpdateRoomResponse (Maybe UTCTime)
updateRoomResponse_httpStatus :: Lens' UpdateRoomResponse Int

Creating a Request

data UpdateRoom Source #

See: newUpdateRoom smart constructor.

Constructors

UpdateRoom'

Fields

loggingConfigurationIdentifiers :: Maybe [Text]
Array of logging-configuration identifiers attached to the room.
maximumMessageLength :: Maybe Natural
The 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. Specify an empty uri string to disassociate a message review handler from the specified room.
name :: Maybe Text
Room name. The value does not need to be unique.
identifier :: Text
Identifier of the room to be updated. Currently this must be an ARN.

Instances

Instances details

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

newUpdateRoom Source #

Arguments

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

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

UpdateRoom, updateRoom_loggingConfigurationIdentifiers - Array of logging-configuration identifiers attached to the room.

UpdateRoom, updateRoom_maximumMessageLength - The 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.

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

UpdateRoom, updateRoom_messageReviewHandler - Configuration information for optional review of messages. Specify an empty uri string to disassociate a message review handler from the specified room.

UpdateRoom, updateRoom_name - Room name. The value does not need to be unique.

$sel:identifier:UpdateRoom', updateRoom_identifier - Identifier of the room to be updated. Currently this must be an ARN.

Request Lenses

updateRoom_loggingConfigurationIdentifiers :: Lens' UpdateRoom (Maybe [Text]) Source #

Array of logging-configuration identifiers attached to the room.

updateRoom_maximumMessageLength :: Lens' UpdateRoom (Maybe Natural) Source #

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

updateRoom_maximumMessageRatePerSecond :: Lens' UpdateRoom (Maybe Natural) Source #

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

updateRoom_messageReviewHandler :: Lens' UpdateRoom (Maybe MessageReviewHandler) Source #

Configuration information for optional review of messages. Specify an empty uri string to disassociate a message review handler from the specified room.

updateRoom_name :: Lens' UpdateRoom (Maybe Text) Source #

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

updateRoom_identifier :: Lens' UpdateRoom Text Source #

Identifier of the room to be updated. Currently this must be an ARN.

Destructuring the Response

data UpdateRoomResponse Source #

See: newUpdateRoomResponse smart constructor.

Constructors

UpdateRoomResponse'

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, from the request (if specified).
maximumMessageLength :: Maybe Natural
Maximum number of characters in a single message, from the request (if specified).
maximumMessageRatePerSecond :: Maybe Natural
Maximum number of messages per second that can be sent to the room (by all clients), from the request (if specified).
messageReviewHandler :: Maybe MessageReviewHandler
Configuration information for optional review of messages.
name :: Maybe Text
Room name, from the request (if specified).
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 UpdateRoomResponse Source #
Instance details Defined in Amazonka.IVSChat.UpdateRoom Associated Types type Rep UpdateRoomResponse :: Type -> Type # Methods from :: UpdateRoomResponse -> Rep UpdateRoomResponse x # to :: Rep UpdateRoomResponse x -> UpdateRoomResponse #
Read UpdateRoomResponse Source #
Instance details Defined in Amazonka.IVSChat.UpdateRoom Methods readsPrec :: Int -> ReadS UpdateRoomResponse # readList :: ReadS [UpdateRoomResponse] # readPrec :: ReadPrec UpdateRoomResponse # readListPrec :: ReadPrec [UpdateRoomResponse] #
Show UpdateRoomResponse Source #
Instance details Defined in Amazonka.IVSChat.UpdateRoom Methods showsPrec :: Int -> UpdateRoomResponse -> ShowS # show :: UpdateRoomResponse -> String # showList :: [UpdateRoomResponse] -> ShowS #
NFData UpdateRoomResponse Source #
Instance details Defined in Amazonka.IVSChat.UpdateRoom Methods rnf :: UpdateRoomResponse -> () #
Eq UpdateRoomResponse Source #
Instance details Defined in Amazonka.IVSChat.UpdateRoom Methods (==) :: UpdateRoomResponse -> UpdateRoomResponse -> Bool # (/=) :: UpdateRoomResponse -> UpdateRoomResponse -> Bool #
type Rep UpdateRoomResponse Source #
Instance details Defined in Amazonka.IVSChat.UpdateRoom type Rep UpdateRoomResponse = D1 ('MetaData "UpdateRoomResponse" "Amazonka.IVSChat.UpdateRoom" "amazonka-ivschat-2.0-AB4QlCKEEGt4izEWjWKMb2" 'False) (C1 ('MetaCons "UpdateRoomResponse'" '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))))))

newUpdateRoomResponse Source #

Arguments

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

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

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

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

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

UpdateRoom, updateRoomResponse_loggingConfigurationIdentifiers - Array of logging configurations attached to the room, from the request (if specified).

UpdateRoom, updateRoomResponse_maximumMessageLength - Maximum number of characters in a single message, from the request (if specified).

UpdateRoom, updateRoomResponse_maximumMessageRatePerSecond - Maximum number of messages per second that can be sent to the room (by all clients), from the request (if specified).

UpdateRoom, updateRoomResponse_messageReviewHandler - Configuration information for optional review of messages.

UpdateRoom, updateRoomResponse_name - Room name, from the request (if specified).

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

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

$sel:httpStatus:UpdateRoomResponse', updateRoomResponse_httpStatus - The response's http status code.

Response Lenses

updateRoomResponse_arn :: Lens' UpdateRoomResponse (Maybe Text) Source #

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

updateRoomResponse_createTime :: Lens' UpdateRoomResponse (Maybe UTCTime) Source #

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

updateRoomResponse_id :: Lens' UpdateRoomResponse (Maybe Text) Source #

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

updateRoomResponse_loggingConfigurationIdentifiers :: Lens' UpdateRoomResponse (Maybe [Text]) Source #

Array of logging configurations attached to the room, from the request (if specified).

updateRoomResponse_maximumMessageLength :: Lens' UpdateRoomResponse (Maybe Natural) Source #

Maximum number of characters in a single message, from the request (if specified).

updateRoomResponse_maximumMessageRatePerSecond :: Lens' UpdateRoomResponse (Maybe Natural) Source #

Maximum number of messages per second that can be sent to the room (by all clients), from the request (if specified).

updateRoomResponse_messageReviewHandler :: Lens' UpdateRoomResponse (Maybe MessageReviewHandler) Source #

Configuration information for optional review of messages.

updateRoomResponse_name :: Lens' UpdateRoomResponse (Maybe Text) Source #

Room name, from the request (if specified).

updateRoomResponse_tags :: Lens' UpdateRoomResponse (Maybe (HashMap Text Text)) Source #

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

updateRoomResponse_updateTime :: Lens' UpdateRoomResponse (Maybe UTCTime) Source #

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

updateRoomResponse_httpStatus :: Lens' UpdateRoomResponse Int Source #

The response's http status code.