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 |
Updates a room’s configuration.
Synopsis
- data UpdateRoom = UpdateRoom' {}
- 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.
UpdateRoom' | |
|
Instances
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.
UpdateRoomResponse' | |
|
Instances
newUpdateRoomResponse Source #
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.