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 |
Synopsis
- createChatToken_attributes :: Lens' CreateChatToken (Maybe (HashMap Text Text))
- createChatToken_capabilities :: Lens' CreateChatToken (Maybe [ChatTokenCapability])
- createChatToken_sessionDurationInMinutes :: Lens' CreateChatToken (Maybe Natural)
- createChatToken_roomIdentifier :: Lens' CreateChatToken Text
- createChatToken_userId :: Lens' CreateChatToken Text
- createChatTokenResponse_sessionExpirationTime :: Lens' CreateChatTokenResponse (Maybe UTCTime)
- createChatTokenResponse_token :: Lens' CreateChatTokenResponse (Maybe Text)
- createChatTokenResponse_tokenExpirationTime :: Lens' CreateChatTokenResponse (Maybe UTCTime)
- createChatTokenResponse_httpStatus :: Lens' CreateChatTokenResponse Int
- createLoggingConfiguration_name :: Lens' CreateLoggingConfiguration (Maybe Text)
- createLoggingConfiguration_tags :: Lens' CreateLoggingConfiguration (Maybe (HashMap Text Text))
- createLoggingConfiguration_destinationConfiguration :: Lens' CreateLoggingConfiguration DestinationConfiguration
- createLoggingConfigurationResponse_arn :: Lens' CreateLoggingConfigurationResponse (Maybe Text)
- createLoggingConfigurationResponse_createTime :: Lens' CreateLoggingConfigurationResponse (Maybe UTCTime)
- createLoggingConfigurationResponse_destinationConfiguration :: Lens' CreateLoggingConfigurationResponse (Maybe DestinationConfiguration)
- createLoggingConfigurationResponse_id :: Lens' CreateLoggingConfigurationResponse (Maybe Text)
- createLoggingConfigurationResponse_name :: Lens' CreateLoggingConfigurationResponse (Maybe Text)
- createLoggingConfigurationResponse_state :: Lens' CreateLoggingConfigurationResponse (Maybe CreateLoggingConfigurationState)
- createLoggingConfigurationResponse_tags :: Lens' CreateLoggingConfigurationResponse (Maybe (HashMap Text Text))
- createLoggingConfigurationResponse_updateTime :: Lens' CreateLoggingConfigurationResponse (Maybe UTCTime)
- createLoggingConfigurationResponse_httpStatus :: Lens' CreateLoggingConfigurationResponse Int
- 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))
- 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
- deleteLoggingConfiguration_identifier :: Lens' DeleteLoggingConfiguration Text
- deleteMessage_reason :: Lens' DeleteMessage (Maybe Text)
- deleteMessage_id :: Lens' DeleteMessage Text
- deleteMessage_roomIdentifier :: Lens' DeleteMessage Text
- deleteMessageResponse_id :: Lens' DeleteMessageResponse (Maybe Text)
- deleteMessageResponse_httpStatus :: Lens' DeleteMessageResponse Int
- deleteRoom_identifier :: Lens' DeleteRoom Text
- disconnectUser_reason :: Lens' DisconnectUser (Maybe Text)
- disconnectUser_roomIdentifier :: Lens' DisconnectUser Text
- disconnectUser_userId :: Lens' DisconnectUser Text
- disconnectUserResponse_httpStatus :: Lens' DisconnectUserResponse Int
- getLoggingConfiguration_identifier :: Lens' GetLoggingConfiguration Text
- getLoggingConfigurationResponse_arn :: Lens' GetLoggingConfigurationResponse (Maybe Text)
- getLoggingConfigurationResponse_createTime :: Lens' GetLoggingConfigurationResponse (Maybe UTCTime)
- getLoggingConfigurationResponse_destinationConfiguration :: Lens' GetLoggingConfigurationResponse (Maybe DestinationConfiguration)
- getLoggingConfigurationResponse_id :: Lens' GetLoggingConfigurationResponse (Maybe Text)
- getLoggingConfigurationResponse_name :: Lens' GetLoggingConfigurationResponse (Maybe Text)
- getLoggingConfigurationResponse_state :: Lens' GetLoggingConfigurationResponse (Maybe LoggingConfigurationState)
- getLoggingConfigurationResponse_tags :: Lens' GetLoggingConfigurationResponse (Maybe (HashMap Text Text))
- getLoggingConfigurationResponse_updateTime :: Lens' GetLoggingConfigurationResponse (Maybe UTCTime)
- getLoggingConfigurationResponse_httpStatus :: Lens' GetLoggingConfigurationResponse Int
- getRoom_identifier :: Lens' GetRoom Text
- 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
- listLoggingConfigurations_maxResults :: Lens' ListLoggingConfigurations (Maybe Natural)
- listLoggingConfigurations_nextToken :: Lens' ListLoggingConfigurations (Maybe Text)
- listLoggingConfigurationsResponse_nextToken :: Lens' ListLoggingConfigurationsResponse (Maybe Text)
- listLoggingConfigurationsResponse_httpStatus :: Lens' ListLoggingConfigurationsResponse Int
- listLoggingConfigurationsResponse_loggingConfigurations :: Lens' ListLoggingConfigurationsResponse [LoggingConfigurationSummary]
- listRooms_loggingConfigurationIdentifier :: Lens' ListRooms (Maybe Text)
- listRooms_maxResults :: Lens' ListRooms (Maybe Natural)
- listRooms_messageReviewHandlerUri :: Lens' ListRooms (Maybe Text)
- listRooms_name :: Lens' ListRooms (Maybe Text)
- listRooms_nextToken :: Lens' ListRooms (Maybe Text)
- listRoomsResponse_nextToken :: Lens' ListRoomsResponse (Maybe Text)
- listRoomsResponse_httpStatus :: Lens' ListRoomsResponse Int
- listRoomsResponse_rooms :: Lens' ListRoomsResponse [RoomSummary]
- listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (HashMap Text Text)
- sendEvent_attributes :: Lens' SendEvent (Maybe (HashMap Text Text))
- sendEvent_eventName :: Lens' SendEvent Text
- sendEvent_roomIdentifier :: Lens' SendEvent Text
- sendEventResponse_id :: Lens' SendEventResponse (Maybe Text)
- sendEventResponse_httpStatus :: Lens' SendEventResponse Int
- tagResource_resourceArn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource (HashMap Text Text)
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
- untagResource_resourceArn :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource [Text]
- untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
- updateLoggingConfiguration_destinationConfiguration :: Lens' UpdateLoggingConfiguration (Maybe DestinationConfiguration)
- updateLoggingConfiguration_name :: Lens' UpdateLoggingConfiguration (Maybe Text)
- updateLoggingConfiguration_identifier :: Lens' UpdateLoggingConfiguration Text
- updateLoggingConfigurationResponse_arn :: Lens' UpdateLoggingConfigurationResponse (Maybe Text)
- updateLoggingConfigurationResponse_createTime :: Lens' UpdateLoggingConfigurationResponse (Maybe UTCTime)
- updateLoggingConfigurationResponse_destinationConfiguration :: Lens' UpdateLoggingConfigurationResponse (Maybe DestinationConfiguration)
- updateLoggingConfigurationResponse_id :: Lens' UpdateLoggingConfigurationResponse (Maybe Text)
- updateLoggingConfigurationResponse_name :: Lens' UpdateLoggingConfigurationResponse (Maybe Text)
- updateLoggingConfigurationResponse_state :: Lens' UpdateLoggingConfigurationResponse (Maybe UpdateLoggingConfigurationState)
- updateLoggingConfigurationResponse_tags :: Lens' UpdateLoggingConfigurationResponse (Maybe (HashMap Text Text))
- updateLoggingConfigurationResponse_updateTime :: Lens' UpdateLoggingConfigurationResponse (Maybe UTCTime)
- updateLoggingConfigurationResponse_httpStatus :: Lens' UpdateLoggingConfigurationResponse Int
- 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
- 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
- cloudWatchLogsDestinationConfiguration_logGroupName :: Lens' CloudWatchLogsDestinationConfiguration Text
- destinationConfiguration_cloudWatchLogs :: Lens' DestinationConfiguration (Maybe CloudWatchLogsDestinationConfiguration)
- destinationConfiguration_firehose :: Lens' DestinationConfiguration (Maybe FirehoseDestinationConfiguration)
- destinationConfiguration_s3 :: Lens' DestinationConfiguration (Maybe S3DestinationConfiguration)
- firehoseDestinationConfiguration_deliveryStreamName :: Lens' FirehoseDestinationConfiguration Text
- loggingConfigurationSummary_arn :: Lens' LoggingConfigurationSummary (Maybe Text)
- loggingConfigurationSummary_createTime :: Lens' LoggingConfigurationSummary (Maybe UTCTime)
- loggingConfigurationSummary_destinationConfiguration :: Lens' LoggingConfigurationSummary (Maybe DestinationConfiguration)
- loggingConfigurationSummary_id :: Lens' LoggingConfigurationSummary (Maybe Text)
- loggingConfigurationSummary_name :: Lens' LoggingConfigurationSummary (Maybe Text)
- loggingConfigurationSummary_state :: Lens' LoggingConfigurationSummary (Maybe LoggingConfigurationState)
- loggingConfigurationSummary_tags :: Lens' LoggingConfigurationSummary (Maybe (HashMap Text Text))
- loggingConfigurationSummary_updateTime :: Lens' LoggingConfigurationSummary (Maybe UTCTime)
- messageReviewHandler_fallbackResult :: Lens' MessageReviewHandler (Maybe FallbackResult)
- messageReviewHandler_uri :: Lens' MessageReviewHandler (Maybe Text)
- roomSummary_arn :: Lens' RoomSummary (Maybe Text)
- roomSummary_createTime :: Lens' RoomSummary (Maybe UTCTime)
- roomSummary_id :: Lens' RoomSummary (Maybe Text)
- roomSummary_loggingConfigurationIdentifiers :: Lens' RoomSummary (Maybe [Text])
- roomSummary_messageReviewHandler :: Lens' RoomSummary (Maybe MessageReviewHandler)
- roomSummary_name :: Lens' RoomSummary (Maybe Text)
- roomSummary_tags :: Lens' RoomSummary (Maybe (HashMap Text Text))
- roomSummary_updateTime :: Lens' RoomSummary (Maybe UTCTime)
- s3DestinationConfiguration_bucketName :: Lens' S3DestinationConfiguration Text
Operations
CreateChatToken
createChatToken_attributes :: Lens' CreateChatToken (Maybe (HashMap Text Text)) Source #
Application-provided attributes to encode into the token and attach to a chat session. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.
createChatToken_capabilities :: Lens' CreateChatToken (Maybe [ChatTokenCapability]) Source #
Set of capabilities that the user is allowed to perform in the room. Default: None (the capability to view messages is implicitly included in all requests).
createChatToken_sessionDurationInMinutes :: Lens' CreateChatToken (Maybe Natural) Source #
Session duration (in minutes), after which the session expires. Default: 60 (1 hour).
createChatToken_roomIdentifier :: Lens' CreateChatToken Text Source #
Identifier of the room that the client is trying to access. Currently this must be an ARN.
createChatToken_userId :: Lens' CreateChatToken Text Source #
Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.
createChatTokenResponse_sessionExpirationTime :: Lens' CreateChatTokenResponse (Maybe UTCTime) Source #
Time after which an end user's session is no longer valid. This is an ISO 8601 timestamp; note that this is returned as a string.
createChatTokenResponse_token :: Lens' CreateChatTokenResponse (Maybe Text) Source #
The issued client token, encrypted.
createChatTokenResponse_tokenExpirationTime :: Lens' CreateChatTokenResponse (Maybe UTCTime) Source #
Time after which the token is no longer valid and cannot be used to connect to a room. This is an ISO 8601 timestamp; /note that this is returned as a string/.
createChatTokenResponse_httpStatus :: Lens' CreateChatTokenResponse Int Source #
The response's http status code.
CreateLoggingConfiguration
createLoggingConfiguration_name :: Lens' CreateLoggingConfiguration (Maybe Text) Source #
Logging-configuration name. The value does not need to be unique.
createLoggingConfiguration_tags :: Lens' CreateLoggingConfiguration (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 on tags
beyond what is documented there.
createLoggingConfiguration_destinationConfiguration :: Lens' CreateLoggingConfiguration DestinationConfiguration Source #
A complex type that contains a destination configuration for where chat
content will be logged. There can be only one type of destination
(cloudWatchLogs
, firehose
, or s3
) in a destinationConfiguration
.
createLoggingConfigurationResponse_arn :: Lens' CreateLoggingConfigurationResponse (Maybe Text) Source #
Logging-configuration ARN, assigned by the system.
createLoggingConfigurationResponse_createTime :: Lens' CreateLoggingConfigurationResponse (Maybe UTCTime) Source #
Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.
createLoggingConfigurationResponse_destinationConfiguration :: Lens' CreateLoggingConfigurationResponse (Maybe DestinationConfiguration) Source #
A complex type that contains a destination configuration for where chat
content will be logged, from the request. There is only one type of
destination (cloudWatchLogs
, firehose
, or s3
) in a
destinationConfiguration
.
createLoggingConfigurationResponse_id :: Lens' CreateLoggingConfigurationResponse (Maybe Text) Source #
Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the logging configuration.
createLoggingConfigurationResponse_name :: Lens' CreateLoggingConfigurationResponse (Maybe Text) Source #
Logging-configuration name, from the request (if specified).
createLoggingConfigurationResponse_state :: Lens' CreateLoggingConfigurationResponse (Maybe CreateLoggingConfigurationState) Source #
The state of the logging configuration. When the state is ACTIVE
, the
configuration is ready to log chat content.
createLoggingConfigurationResponse_tags :: Lens' CreateLoggingConfigurationResponse (Maybe (HashMap Text Text)) Source #
Tags attached to the resource, from the request (if specified). Array of
maps, each of the form string:string (key:value)
.
createLoggingConfigurationResponse_updateTime :: Lens' CreateLoggingConfigurationResponse (Maybe UTCTime) Source #
Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
createLoggingConfigurationResponse_httpStatus :: Lens' CreateLoggingConfigurationResponse Int Source #
The response's http status code.
CreateRoom
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.
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.
DeleteLoggingConfiguration
deleteLoggingConfiguration_identifier :: Lens' DeleteLoggingConfiguration Text Source #
Identifier of the logging configuration to be deleted.
DeleteMessage
deleteMessage_reason :: Lens' DeleteMessage (Maybe Text) Source #
Reason for deleting the message.
deleteMessage_id :: Lens' DeleteMessage Text Source #
ID of the message to be deleted. This is the Id
field in the received
message (see
Message (Subscribe)
in the Chat Messaging API).
deleteMessage_roomIdentifier :: Lens' DeleteMessage Text Source #
Identifier of the room where the message should be deleted. Currently this must be an ARN.
deleteMessageResponse_id :: Lens' DeleteMessageResponse (Maybe Text) Source #
Operation identifier, generated by Amazon IVS Chat.
deleteMessageResponse_httpStatus :: Lens' DeleteMessageResponse Int Source #
The response's http status code.
DeleteRoom
deleteRoom_identifier :: Lens' DeleteRoom Text Source #
Identifier of the room to be deleted. Currently this must be an ARN.
DisconnectUser
disconnectUser_reason :: Lens' DisconnectUser (Maybe Text) Source #
Reason for disconnecting the user.
disconnectUser_roomIdentifier :: Lens' DisconnectUser Text Source #
Identifier of the room from which the user's clients should be disconnected. Currently this must be an ARN.
disconnectUser_userId :: Lens' DisconnectUser Text Source #
ID of the user (connection) to disconnect from the room.
disconnectUserResponse_httpStatus :: Lens' DisconnectUserResponse Int Source #
The response's http status code.
GetLoggingConfiguration
getLoggingConfiguration_identifier :: Lens' GetLoggingConfiguration Text Source #
Identifier of the logging configuration to be retrieved.
getLoggingConfigurationResponse_arn :: Lens' GetLoggingConfigurationResponse (Maybe Text) Source #
Logging-configuration ARN, from the request (if identifier
was an
ARN).
getLoggingConfigurationResponse_createTime :: Lens' GetLoggingConfigurationResponse (Maybe UTCTime) Source #
Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.
getLoggingConfigurationResponse_destinationConfiguration :: Lens' GetLoggingConfigurationResponse (Maybe DestinationConfiguration) Source #
A complex type that contains a destination configuration for where chat
content will be logged. There is only one type of destination
(cloudWatchLogs
, firehose
, or s3
) in a destinationConfiguration
.
getLoggingConfigurationResponse_id :: Lens' GetLoggingConfigurationResponse (Maybe Text) Source #
Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the logging configuration.
getLoggingConfigurationResponse_name :: Lens' GetLoggingConfigurationResponse (Maybe Text) Source #
Logging-configuration name. This value does not need to be unique.
getLoggingConfigurationResponse_state :: Lens' GetLoggingConfigurationResponse (Maybe LoggingConfigurationState) Source #
The state of the logging configuration. When the state is ACTIVE
, the
configuration is ready to log chat content.
getLoggingConfigurationResponse_tags :: Lens' GetLoggingConfigurationResponse (Maybe (HashMap Text Text)) Source #
Tags attached to the resource. Array of maps, each of the form
string:string (key:value)
.
getLoggingConfigurationResponse_updateTime :: Lens' GetLoggingConfigurationResponse (Maybe UTCTime) Source #
Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
getLoggingConfigurationResponse_httpStatus :: Lens' GetLoggingConfigurationResponse Int Source #
The response's http status code.
GetRoom
getRoom_identifier :: Lens' GetRoom Text Source #
Identifier of the room for which the configuration is to be retrieved. Currently this must be an ARN.
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.
ListLoggingConfigurations
listLoggingConfigurations_maxResults :: Lens' ListLoggingConfigurations (Maybe Natural) Source #
Maximum number of logging configurations to return. Default: 50.
listLoggingConfigurations_nextToken :: Lens' ListLoggingConfigurations (Maybe Text) Source #
The first logging configurations to retrieve. This is used for
pagination; see the nextToken
response field.
listLoggingConfigurationsResponse_nextToken :: Lens' ListLoggingConfigurationsResponse (Maybe Text) Source #
If there are more logging configurations than maxResults
, use
nextToken
in the request to get the next set.
listLoggingConfigurationsResponse_httpStatus :: Lens' ListLoggingConfigurationsResponse Int Source #
The response's http status code.
listLoggingConfigurationsResponse_loggingConfigurations :: Lens' ListLoggingConfigurationsResponse [LoggingConfigurationSummary] Source #
List of the matching logging configurations (summary information only).
There is only one type of destination (cloudWatchLogs
, firehose
, or
s3
) in a destinationConfiguration
.
ListRooms
listRooms_loggingConfigurationIdentifier :: Lens' ListRooms (Maybe Text) Source #
Logging-configuration identifier.
listRooms_maxResults :: Lens' ListRooms (Maybe Natural) Source #
Maximum number of rooms to return. Default: 50.
listRooms_messageReviewHandlerUri :: Lens' ListRooms (Maybe Text) Source #
Filters the list to match the specified message review handler URI.
listRooms_name :: Lens' ListRooms (Maybe Text) Source #
Filters the list to match the specified room name.
listRooms_nextToken :: Lens' ListRooms (Maybe Text) Source #
The first room to retrieve. This is used for pagination; see the
nextToken
response field.
listRoomsResponse_nextToken :: Lens' ListRoomsResponse (Maybe Text) Source #
If there are more rooms than maxResults
, use nextToken
in the
request to get the next set.
listRoomsResponse_httpStatus :: Lens' ListRoomsResponse Int Source #
The response's http status code.
listRoomsResponse_rooms :: Lens' ListRoomsResponse [RoomSummary] Source #
List of the matching rooms (summary information only).
ListTagsForResource
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #
The ARN of the resource to be retrieved. The ARN must be URL-encoded.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (HashMap Text Text) Source #
Tags attached to the resource. Array of maps, each of the form
string:string (key:value)
.
SendEvent
sendEvent_attributes :: Lens' SendEvent (Maybe (HashMap Text Text)) Source #
Application-defined metadata to attach to the event sent to clients. The maximum length of the metadata is 1 KB total.
sendEvent_eventName :: Lens' SendEvent Text Source #
Application-defined name of the event to send to clients.
sendEvent_roomIdentifier :: Lens' SendEvent Text Source #
Identifier of the room to which the event will be sent. Currently this must be an ARN.
sendEventResponse_id :: Lens' SendEventResponse (Maybe Text) Source #
An identifier generated by Amazon IVS Chat. This identifier must be used in subsequent operations for this message, such as DeleteMessage.
sendEventResponse_httpStatus :: Lens' SendEventResponse Int Source #
The response's http status code.
TagResource
tagResource_resourceArn :: Lens' TagResource Text Source #
The ARN of the resource to be tagged. The ARN must be URL-encoded.
tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #
Array of tags to be added or updated. 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.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.
UntagResource
untagResource_resourceArn :: Lens' UntagResource Text Source #
The ARN of the resource to be untagged. The ARN must be URL-encoded.
untagResource_tagKeys :: Lens' UntagResource [Text] Source #
Array of tags to be removed. 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.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #
The response's http status code.
UpdateLoggingConfiguration
updateLoggingConfiguration_destinationConfiguration :: Lens' UpdateLoggingConfiguration (Maybe DestinationConfiguration) Source #
A complex type that contains a destination configuration for where chat
content will be logged. There can be only one type of destination
(cloudWatchLogs
, firehose
, or s3
) in a destinationConfiguration
.
updateLoggingConfiguration_name :: Lens' UpdateLoggingConfiguration (Maybe Text) Source #
Logging-configuration name. The value does not need to be unique.
updateLoggingConfiguration_identifier :: Lens' UpdateLoggingConfiguration Text Source #
Identifier of the logging configuration to be updated.
updateLoggingConfigurationResponse_arn :: Lens' UpdateLoggingConfigurationResponse (Maybe Text) Source #
Logging-configuration ARN, from the request (if identifier
was an
ARN).
updateLoggingConfigurationResponse_createTime :: Lens' UpdateLoggingConfigurationResponse (Maybe UTCTime) Source #
Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.
updateLoggingConfigurationResponse_destinationConfiguration :: Lens' UpdateLoggingConfigurationResponse (Maybe DestinationConfiguration) Source #
A complex type that contains a destination configuration for where chat
content will be logged, from the request. There is only one type of
destination (cloudWatchLogs
, firehose
, or s3
) in a
destinationConfiguration
.
updateLoggingConfigurationResponse_id :: Lens' UpdateLoggingConfigurationResponse (Maybe Text) Source #
Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
updateLoggingConfigurationResponse_name :: Lens' UpdateLoggingConfigurationResponse (Maybe Text) Source #
Logging-configuration name, from the request (if specified).
updateLoggingConfigurationResponse_state :: Lens' UpdateLoggingConfigurationResponse (Maybe UpdateLoggingConfigurationState) Source #
The state of the logging configuration. When the state is ACTIVE
, the
configuration is ready to log chat content.
updateLoggingConfigurationResponse_tags :: Lens' UpdateLoggingConfigurationResponse (Maybe (HashMap Text Text)) Source #
Tags attached to the resource. Array of maps, each of the form
string:string (key:value)
.
updateLoggingConfigurationResponse_updateTime :: Lens' UpdateLoggingConfigurationResponse (Maybe UTCTime) Source #
Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
updateLoggingConfigurationResponse_httpStatus :: Lens' UpdateLoggingConfigurationResponse Int Source #
The response's http status code.
UpdateRoom
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.
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.
Types
CloudWatchLogsDestinationConfiguration
cloudWatchLogsDestinationConfiguration_logGroupName :: Lens' CloudWatchLogsDestinationConfiguration Text Source #
Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.
DestinationConfiguration
destinationConfiguration_cloudWatchLogs :: Lens' DestinationConfiguration (Maybe CloudWatchLogsDestinationConfiguration) Source #
An Amazon CloudWatch Logs destination configuration where chat activity will be logged.
destinationConfiguration_firehose :: Lens' DestinationConfiguration (Maybe FirehoseDestinationConfiguration) Source #
An Amazon Kinesis Data Firehose destination configuration where chat activity will be logged.
destinationConfiguration_s3 :: Lens' DestinationConfiguration (Maybe S3DestinationConfiguration) Source #
An Amazon S3 destination configuration where chat activity will be logged.
FirehoseDestinationConfiguration
firehoseDestinationConfiguration_deliveryStreamName :: Lens' FirehoseDestinationConfiguration Text Source #
Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged.
LoggingConfigurationSummary
loggingConfigurationSummary_arn :: Lens' LoggingConfigurationSummary (Maybe Text) Source #
Logging-configuration ARN.
loggingConfigurationSummary_createTime :: Lens' LoggingConfigurationSummary (Maybe UTCTime) Source #
Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.
loggingConfigurationSummary_destinationConfiguration :: Lens' LoggingConfigurationSummary (Maybe DestinationConfiguration) Source #
A complex type that contains a destination configuration for where chat content will be logged.
loggingConfigurationSummary_id :: Lens' LoggingConfigurationSummary (Maybe Text) Source #
Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
loggingConfigurationSummary_name :: Lens' LoggingConfigurationSummary (Maybe Text) Source #
Logging-configuration name. The value does not need to be unique.
loggingConfigurationSummary_state :: Lens' LoggingConfigurationSummary (Maybe LoggingConfigurationState) Source #
The state of the logging configuration. When this is ACTIVE
, the
configuration is ready for logging chat content.
loggingConfigurationSummary_tags :: Lens' LoggingConfigurationSummary (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 on tags
beyond what is documented there.
loggingConfigurationSummary_updateTime :: Lens' LoggingConfigurationSummary (Maybe UTCTime) Source #
Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
MessageReviewHandler
messageReviewHandler_fallbackResult :: Lens' MessageReviewHandler (Maybe FallbackResult) Source #
Specifies the fallback behavior (whether the message is allowed or
denied) if the handler does not return a valid response, encounters an
error, or times out. (For the timeout period, see
Service Quotas.)
If allowed, the message is delivered with returned content to all users
connected to the room. If denied, the message is not delivered to any
user. Default: ALLOW
.
messageReviewHandler_uri :: Lens' MessageReviewHandler (Maybe Text) Source #
Identifier of the message review handler. Currently this must be an ARN of a lambda function.
RoomSummary
roomSummary_arn :: Lens' RoomSummary (Maybe Text) Source #
Room ARN.
roomSummary_createTime :: Lens' RoomSummary (Maybe UTCTime) Source #
Time when the room was created. This is an ISO 8601 timestamp; /note that this is returned as a string/.
roomSummary_id :: Lens' RoomSummary (Maybe Text) Source #
Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
roomSummary_loggingConfigurationIdentifiers :: Lens' RoomSummary (Maybe [Text]) Source #
List of logging-configuration identifiers attached to the room.
roomSummary_messageReviewHandler :: Lens' RoomSummary (Maybe MessageReviewHandler) Source #
Configuration information for optional review of messages.
roomSummary_name :: Lens' RoomSummary (Maybe Text) Source #
Room name. The value does not need to be unique.
roomSummary_tags :: Lens' RoomSummary (Maybe (HashMap Text Text)) Source #
Tags attached 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.
roomSummary_updateTime :: Lens' RoomSummary (Maybe UTCTime) Source #
Time of the room’s last update. This is an ISO 8601 timestamp; /note that this is returned as a string/.
S3DestinationConfiguration
s3DestinationConfiguration_bucketName :: Lens' S3DestinationConfiguration Text Source #
Name of the Amazon S3 bucket where chat activity will be logged.