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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a room that allows clients to connect and pass messages.

Synopsis

data CreateRoom = CreateRoom' {
- loggingConfigurationIdentifiers :: Maybe [Text]
- maximumMessageLength :: Maybe Natural
- maximumMessageRatePerSecond :: Maybe Natural
- messageReviewHandler :: Maybe MessageReviewHandler
- name :: Maybe Text
- tags :: Maybe (HashMap Text Text)
}
newCreateRoom :: CreateRoom
createRoom_loggingConfigurationIdentifiers :: Lens' CreateRoom (Maybe [Text])
createRoom_maximumMessageLength :: Lens' CreateRoom (Maybe Natural)
createRoom_maximumMessageRatePerSecond :: Lens' CreateRoom (Maybe Natural)
createRoom_messageReviewHandler :: Lens' CreateRoom (Maybe MessageReviewHandler)
createRoom_name :: Lens' CreateRoom (Maybe Text)
createRoom_tags :: Lens' CreateRoom (Maybe (HashMap Text Text))
data CreateRoomResponse = CreateRoomResponse' {
- 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
}
newCreateRoomResponse :: Int -> CreateRoomResponse
createRoomResponse_arn :: Lens' CreateRoomResponse (Maybe Text)
createRoomResponse_createTime :: Lens' CreateRoomResponse (Maybe UTCTime)
createRoomResponse_id :: Lens' CreateRoomResponse (Maybe Text)
createRoomResponse_loggingConfigurationIdentifiers :: Lens' CreateRoomResponse (Maybe [Text])
createRoomResponse_maximumMessageLength :: Lens' CreateRoomResponse (Maybe Natural)
createRoomResponse_maximumMessageRatePerSecond :: Lens' CreateRoomResponse (Maybe Natural)
createRoomResponse_messageReviewHandler :: Lens' CreateRoomResponse (Maybe MessageReviewHandler)
createRoomResponse_name :: Lens' CreateRoomResponse (Maybe Text)
createRoomResponse_tags :: Lens' CreateRoomResponse (Maybe (HashMap Text Text))
createRoomResponse_updateTime :: Lens' CreateRoomResponse (Maybe UTCTime)
createRoomResponse_httpStatus :: Lens' CreateRoomResponse Int

Creating a Request

data CreateRoom Source #

See: newCreateRoom smart constructor.

Constructors

CreateRoom'

Fields

loggingConfigurationIdentifiers :: Maybe [Text]
Array of logging-configuration identifiers 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 to attach to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented there.

Instances

Instances details

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

newCreateRoom :: CreateRoom Source #

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

CreateRoom, createRoom_loggingConfigurationIdentifiers - Array of logging-configuration identifiers attached to the room.

CreateRoom, createRoom_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.

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

CreateRoom, createRoom_messageReviewHandler - Configuration information for optional review of messages.

CreateRoom, createRoom_name - Room name. The value does not need to be unique.

CreateRoom, createRoom_tags - Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented there.

Request Lenses

createRoom_loggingConfigurationIdentifiers :: Lens' CreateRoom (Maybe [Text]) Source #

Array of logging-configuration identifiers attached to the room.

createRoom_maximumMessageLength :: Lens' CreateRoom (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.

createRoom_maximumMessageRatePerSecond :: Lens' CreateRoom (Maybe Natural) Source #

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

createRoom_messageReviewHandler :: Lens' CreateRoom (Maybe MessageReviewHandler) Source #

Configuration information for optional review of messages.

createRoom_name :: Lens' CreateRoom (Maybe Text) Source #

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

createRoom_tags :: Lens' CreateRoom (Maybe (HashMap Text Text)) Source #

Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented there.

Destructuring the Response

data CreateRoomResponse Source #

See: newCreateRoomResponse smart constructor.

Constructors

CreateRoomResponse'

Fields

arn :: Maybe Text
Room ARN, assigned by the system.
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, from the request (if specified).
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 CreateRoomResponse Source #
Instance details Defined in Amazonka.IVSChat.CreateRoom Associated Types type Rep CreateRoomResponse :: Type -> Type # Methods from :: CreateRoomResponse -> Rep CreateRoomResponse x # to :: Rep CreateRoomResponse x -> CreateRoomResponse #
Read CreateRoomResponse Source #
Instance details Defined in Amazonka.IVSChat.CreateRoom Methods readsPrec :: Int -> ReadS CreateRoomResponse # readList :: ReadS [CreateRoomResponse] # readPrec :: ReadPrec CreateRoomResponse # readListPrec :: ReadPrec [CreateRoomResponse] #
Show CreateRoomResponse Source #
Instance details Defined in Amazonka.IVSChat.CreateRoom Methods showsPrec :: Int -> CreateRoomResponse -> ShowS # show :: CreateRoomResponse -> String # showList :: [CreateRoomResponse] -> ShowS #
NFData CreateRoomResponse Source #
Instance details Defined in Amazonka.IVSChat.CreateRoom Methods rnf :: CreateRoomResponse -> () #
Eq CreateRoomResponse Source #
Instance details Defined in Amazonka.IVSChat.CreateRoom Methods (==) :: CreateRoomResponse -> CreateRoomResponse -> Bool # (/=) :: CreateRoomResponse -> CreateRoomResponse -> Bool #
type Rep CreateRoomResponse Source #
Instance details Defined in Amazonka.IVSChat.CreateRoom type Rep CreateRoomResponse = D1 ('MetaData "CreateRoomResponse" "Amazonka.IVSChat.CreateRoom" "amazonka-ivschat-2.0-AB4QlCKEEGt4izEWjWKMb2" 'False) (C1 ('MetaCons "CreateRoomResponse'" '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))))))

newCreateRoomResponse Source #

Arguments

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

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

CreateRoomResponse, createRoomResponse_arn - Room ARN, assigned by the system.

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

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

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

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

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

CreateRoom, createRoomResponse_messageReviewHandler - Configuration information for optional review of messages.

CreateRoom, createRoomResponse_name - Room name, from the request (if specified).

CreateRoom, createRoomResponse_tags - Tags attached to the resource, from the request (if specified).

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

$sel:httpStatus:CreateRoomResponse', createRoomResponse_httpStatus - The response's http status code.

Response Lenses

createRoomResponse_arn :: Lens' CreateRoomResponse (Maybe Text) Source #

Room ARN, assigned by the system.

createRoomResponse_createTime :: Lens' CreateRoomResponse (Maybe UTCTime) Source #

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

createRoomResponse_id :: Lens' CreateRoomResponse (Maybe Text) Source #

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

createRoomResponse_loggingConfigurationIdentifiers :: Lens' CreateRoomResponse (Maybe [Text]) Source #

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

createRoomResponse_maximumMessageLength :: Lens' CreateRoomResponse (Maybe Natural) Source #

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

createRoomResponse_maximumMessageRatePerSecond :: Lens' CreateRoomResponse (Maybe Natural) Source #

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

createRoomResponse_messageReviewHandler :: Lens' CreateRoomResponse (Maybe MessageReviewHandler) Source #

Configuration information for optional review of messages.

createRoomResponse_name :: Lens' CreateRoomResponse (Maybe Text) Source #

Room name, from the request (if specified).

createRoomResponse_tags :: Lens' CreateRoomResponse (Maybe (HashMap Text Text)) Source #

Tags attached to the resource, from the request (if specified).

createRoomResponse_updateTime :: Lens' CreateRoomResponse (Maybe UTCTime) Source #

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

createRoomResponse_httpStatus :: Lens' CreateRoomResponse Int Source #

The response's http status code.