| 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
Description
Derived from API version 2020-07-14 of the AWS service descriptions, licensed under Apache 2.0.
Introduction
The Amazon IVS Chat control-plane API enables you to create and manage Amazon IVS Chat resources. You also need to integrate with the Amazon IVS Chat Messaging API, to enable users to interact with chat rooms in real time.
The API is an AWS regional service. For a list of supported regions and Amazon IVS Chat HTTPS service endpoints, see the Amazon IVS Chat information on the Amazon IVS page in the AWS General Reference.
Notes on terminology:
- You create service applications using the Amazon IVS Chat API. We refer to these as applications.
- You create front-end client applications (browser and Android/iOS apps) using the Amazon IVS Chat Messaging API. We refer to these as clients.
Resources
The following resources are part of Amazon IVS Chat:
- LoggingConfiguration — A configuration that allows customers to store and record sent messages in a chat room. See the Logging Configuration endpoints for more information.
- Room — The central Amazon IVS Chat resource through which clients connect to and exchange chat messages. See the Room endpoints for more information.
Tagging
A tag is a metadata label that you assign to an AWS resource. A tag
comprises a key and a value, both set by you. For example, you might
set a tag as topic:nature to label a particular video category. See
Tagging AWS Resources
for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS Chat has no
service-specific constraints beyond what is documented there.
Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
The Amazon IVS Chat API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Room.
At most 50 tags can be applied to a resource.
API Access Security
Your Amazon IVS Chat applications (service applications and clients) must be authenticated and authorized to access Amazon IVS Chat resources. Note the differences between these concepts:
- Authentication is about verifying identity. Requests to the Amazon IVS Chat API must be signed to verify your identity.
- Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS Chat API requests.
Users (viewers) connect to a room using secure access tokens that you create using the CreateChatToken endpoint through the AWS SDK. You call CreateChatToken for every user’s chat session, passing identity and authorization information about the user.
Signing API Requests
HTTP API requests must be signed with an AWS SigV4 signature using your AWS security credentials. The AWS Command Line Interface (CLI) and the AWS SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS Chat HTTP API directly, it’s your responsibility to sign the requests.
You generate a signature using valid AWS credentials for an IAM role
that has permission to perform the requested action. For example,
DeleteMessage requests must be made using an IAM role that has the
ivschat:DeleteMessage permission.
For more information:
- Authentication and generating signatures — See Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon Web Services General Reference.
- Managing Amazon IVS permissions — See Identity and Access Management on the Security page of the Amazon IVS User Guide.
Amazon Resource Names (ARNs)
ARNs uniquely identify AWS resources. An ARN is required when you need to specify a resource unambiguously across all of AWS, such as in IAM policies and API calls. For more information, see Amazon Resource Names in the AWS General Reference.
Messaging Endpoints
- DeleteMessage — Sends an event to a specific room which directs
clients to delete a specific message; that is, unrender it from view
and delete it from the client’s chat history. This event’s
EventNameisaws:DELETE_MESSAGE. This replicates the DeleteMessage WebSocket operation in the Amazon IVS Chat Messaging API. - DisconnectUser — Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.
- SendEvent — Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.
Chat Token Endpoint
- CreateChatToken — Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room. When the token is used to connect to chat, the connection is valid for the session duration specified in the request. The token becomes invalid at the token-expiration timestamp included in the response.
Room Endpoints
- CreateRoom — Creates a room that allows clients to connect and pass messages.
- DeleteRoom — Deletes the specified room.
- GetRoom — Gets the specified room.
- ListRooms — Gets summary information about all your rooms in the AWS region where the API request is processed.
- UpdateRoom — Updates a room’s configuration.
Logging Configuration Endpoints
- CreateLoggingConfiguration — Creates a logging configuration that allows clients to store and record sent messages.
- DeleteLoggingConfiguration — Deletes the specified logging configuration.
- GetLoggingConfiguration — Gets the specified logging configuration.
- ListLoggingConfigurations — Gets summary information about all your logging configurations in the AWS region where the API request is processed.
- UpdateLoggingConfiguration — Updates a specified logging configuration.
Tags Endpoints
- ListTagsForResource — Gets information about AWS tags for the specified ARN.
- TagResource — Adds or updates tags for the AWS resource with the specified ARN.
- UntagResource — Removes tags from the resource with the specified ARN.
All the above are HTTP operations. There is a separate messaging API for managing Chat resources; see the Amazon IVS Chat Messaging API Reference.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _PendingVerification :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data CreateChatToken = CreateChatToken' (Maybe (HashMap Text Text)) (Maybe [ChatTokenCapability]) (Maybe Natural) Text Text
- newCreateChatToken :: Text -> Text -> CreateChatToken
- data CreateChatTokenResponse = CreateChatTokenResponse' (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) Int
- newCreateChatTokenResponse :: Int -> CreateChatTokenResponse
- data CreateLoggingConfiguration = CreateLoggingConfiguration' (Maybe Text) (Maybe (HashMap Text Text)) DestinationConfiguration
- newCreateLoggingConfiguration :: DestinationConfiguration -> CreateLoggingConfiguration
- data CreateLoggingConfigurationResponse = CreateLoggingConfigurationResponse' (Maybe Text) (Maybe ISO8601) (Maybe DestinationConfiguration) (Maybe Text) (Maybe Text) (Maybe CreateLoggingConfigurationState) (Maybe (HashMap Text Text)) (Maybe ISO8601) Int
- newCreateLoggingConfigurationResponse :: Int -> CreateLoggingConfigurationResponse
- data CreateRoom = CreateRoom' (Maybe [Text]) (Maybe Natural) (Maybe Natural) (Maybe MessageReviewHandler) (Maybe Text) (Maybe (HashMap Text Text))
- newCreateRoom :: CreateRoom
- data CreateRoomResponse = CreateRoomResponse' (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe [Text]) (Maybe Natural) (Maybe Natural) (Maybe MessageReviewHandler) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe ISO8601) Int
- newCreateRoomResponse :: Int -> CreateRoomResponse
- data DeleteLoggingConfiguration = DeleteLoggingConfiguration' Text
- newDeleteLoggingConfiguration :: Text -> DeleteLoggingConfiguration
- data DeleteLoggingConfigurationResponse = DeleteLoggingConfigurationResponse' {
- newDeleteLoggingConfigurationResponse :: DeleteLoggingConfigurationResponse
- data DeleteMessage = DeleteMessage' (Maybe Text) Text Text
- newDeleteMessage :: Text -> Text -> DeleteMessage
- data DeleteMessageResponse = DeleteMessageResponse' (Maybe Text) Int
- newDeleteMessageResponse :: Int -> DeleteMessageResponse
- data DeleteRoom = DeleteRoom' Text
- newDeleteRoom :: Text -> DeleteRoom
- data DeleteRoomResponse = DeleteRoomResponse' {
- newDeleteRoomResponse :: DeleteRoomResponse
- data DisconnectUser = DisconnectUser' (Maybe Text) Text Text
- newDisconnectUser :: Text -> Text -> DisconnectUser
- data DisconnectUserResponse = DisconnectUserResponse' Int
- newDisconnectUserResponse :: Int -> DisconnectUserResponse
- data GetLoggingConfiguration = GetLoggingConfiguration' Text
- newGetLoggingConfiguration :: Text -> GetLoggingConfiguration
- data GetLoggingConfigurationResponse = GetLoggingConfigurationResponse' (Maybe Text) (Maybe ISO8601) (Maybe DestinationConfiguration) (Maybe Text) (Maybe Text) (Maybe LoggingConfigurationState) (Maybe (HashMap Text Text)) (Maybe ISO8601) Int
- newGetLoggingConfigurationResponse :: Int -> GetLoggingConfigurationResponse
- data GetRoom = GetRoom' Text
- newGetRoom :: Text -> GetRoom
- data GetRoomResponse = GetRoomResponse' (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe [Text]) (Maybe Natural) (Maybe Natural) (Maybe MessageReviewHandler) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe ISO8601) Int
- newGetRoomResponse :: Int -> GetRoomResponse
- data ListLoggingConfigurations = ListLoggingConfigurations' (Maybe Natural) (Maybe Text)
- newListLoggingConfigurations :: ListLoggingConfigurations
- data ListLoggingConfigurationsResponse = ListLoggingConfigurationsResponse' (Maybe Text) Int [LoggingConfigurationSummary]
- newListLoggingConfigurationsResponse :: Int -> ListLoggingConfigurationsResponse
- data ListRooms = ListRooms' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text)
- newListRooms :: ListRooms
- data ListRoomsResponse = ListRoomsResponse' (Maybe Text) Int [RoomSummary]
- newListRoomsResponse :: Int -> ListRoomsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' Int (HashMap Text Text)
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data SendEvent = SendEvent' (Maybe (HashMap Text Text)) Text Text
- newSendEvent :: Text -> Text -> SendEvent
- data SendEventResponse = SendEventResponse' (Maybe Text) Int
- newSendEventResponse :: Int -> SendEventResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateLoggingConfiguration = UpdateLoggingConfiguration' (Maybe DestinationConfiguration) (Maybe Text) Text
- newUpdateLoggingConfiguration :: Text -> UpdateLoggingConfiguration
- data UpdateLoggingConfigurationResponse = UpdateLoggingConfigurationResponse' (Maybe Text) (Maybe ISO8601) (Maybe DestinationConfiguration) (Maybe Text) (Maybe Text) (Maybe UpdateLoggingConfigurationState) (Maybe (HashMap Text Text)) (Maybe ISO8601) Int
- newUpdateLoggingConfigurationResponse :: Int -> UpdateLoggingConfigurationResponse
- data UpdateRoom = UpdateRoom' (Maybe [Text]) (Maybe Natural) (Maybe Natural) (Maybe MessageReviewHandler) (Maybe Text) Text
- newUpdateRoom :: Text -> UpdateRoom
- data UpdateRoomResponse = UpdateRoomResponse' (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe [Text]) (Maybe Natural) (Maybe Natural) (Maybe MessageReviewHandler) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe ISO8601) Int
- newUpdateRoomResponse :: Int -> UpdateRoomResponse
- newtype ChatTokenCapability where
- newtype CreateLoggingConfigurationState where
- newtype FallbackResult where
- FallbackResult' { }
- pattern FallbackResult_ALLOW :: FallbackResult
- pattern FallbackResult_DENY :: FallbackResult
- newtype LoggingConfigurationState where
- LoggingConfigurationState' { }
- pattern LoggingConfigurationState_ACTIVE :: LoggingConfigurationState
- pattern LoggingConfigurationState_CREATE_FAILED :: LoggingConfigurationState
- pattern LoggingConfigurationState_CREATING :: LoggingConfigurationState
- pattern LoggingConfigurationState_DELETE_FAILED :: LoggingConfigurationState
- pattern LoggingConfigurationState_DELETING :: LoggingConfigurationState
- pattern LoggingConfigurationState_UPDATE_FAILED :: LoggingConfigurationState
- pattern LoggingConfigurationState_UPDATING :: LoggingConfigurationState
- newtype UpdateLoggingConfigurationState where
- data CloudWatchLogsDestinationConfiguration = CloudWatchLogsDestinationConfiguration' Text
- newCloudWatchLogsDestinationConfiguration :: Text -> CloudWatchLogsDestinationConfiguration
- data DestinationConfiguration = DestinationConfiguration' (Maybe CloudWatchLogsDestinationConfiguration) (Maybe FirehoseDestinationConfiguration) (Maybe S3DestinationConfiguration)
- newDestinationConfiguration :: DestinationConfiguration
- data FirehoseDestinationConfiguration = FirehoseDestinationConfiguration' Text
- newFirehoseDestinationConfiguration :: Text -> FirehoseDestinationConfiguration
- data LoggingConfigurationSummary = LoggingConfigurationSummary' (Maybe Text) (Maybe ISO8601) (Maybe DestinationConfiguration) (Maybe Text) (Maybe Text) (Maybe LoggingConfigurationState) (Maybe (HashMap Text Text)) (Maybe ISO8601)
- newLoggingConfigurationSummary :: LoggingConfigurationSummary
- data MessageReviewHandler = MessageReviewHandler' (Maybe FallbackResult) (Maybe Text)
- newMessageReviewHandler :: MessageReviewHandler
- data RoomSummary = RoomSummary' (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe [Text]) (Maybe MessageReviewHandler) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe ISO8601)
- newRoomSummary :: RoomSummary
- data S3DestinationConfiguration = S3DestinationConfiguration' Text
- newS3DestinationConfiguration :: Text -> S3DestinationConfiguration
Service Configuration
defaultService :: Service Source #
API version 2020-07-14 of the Amazon Interactive Video Service Chat SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by IVSChat.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
PendingVerification
_PendingVerification :: AsError a => Fold a ServiceError Source #
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateChatToken
data CreateChatToken Source #
See: newCreateChatToken smart constructor.
Constructors
| CreateChatToken' (Maybe (HashMap Text Text)) (Maybe [ChatTokenCapability]) (Maybe Natural) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateChatToken |
Create a value of CreateChatToken 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:attributes:CreateChatToken', createChatToken_attributes - 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.
$sel:capabilities:CreateChatToken', createChatToken_capabilities - 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).
$sel:sessionDurationInMinutes:CreateChatToken', createChatToken_sessionDurationInMinutes - Session duration (in minutes), after which the session expires. Default:
60 (1 hour).
$sel:roomIdentifier:CreateChatToken', createChatToken_roomIdentifier - Identifier of the room that the client is trying to access. Currently
this must be an ARN.
$sel:userId:CreateChatToken', createChatToken_userId - Application-provided ID that uniquely identifies the user associated
with this token. This can be any UTF-8 encoded text.
data CreateChatTokenResponse Source #
See: newCreateChatTokenResponse smart constructor.
Instances
newCreateChatTokenResponse Source #
Create a value of CreateChatTokenResponse 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:sessionExpirationTime:CreateChatTokenResponse', createChatTokenResponse_sessionExpirationTime - 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.
$sel:token:CreateChatTokenResponse', createChatTokenResponse_token - The issued client token, encrypted.
$sel:tokenExpirationTime:CreateChatTokenResponse', createChatTokenResponse_tokenExpirationTime - 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/.
$sel:httpStatus:CreateChatTokenResponse', createChatTokenResponse_httpStatus - The response's http status code.
CreateLoggingConfiguration
data CreateLoggingConfiguration Source #
See: newCreateLoggingConfiguration smart constructor.
Constructors
| CreateLoggingConfiguration' (Maybe Text) (Maybe (HashMap Text Text)) DestinationConfiguration |
Instances
newCreateLoggingConfiguration Source #
Create a value of CreateLoggingConfiguration 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:
CreateLoggingConfiguration, createLoggingConfiguration_name - Logging-configuration name. The value does not need to be unique.
CreateLoggingConfiguration, createLoggingConfiguration_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 on tags
beyond what is documented there.
CreateLoggingConfiguration, createLoggingConfiguration_destinationConfiguration - 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.
data CreateLoggingConfigurationResponse Source #
See: newCreateLoggingConfigurationResponse smart constructor.
Constructors
Instances
newCreateLoggingConfigurationResponse Source #
Arguments
| :: Int | |
| -> CreateLoggingConfigurationResponse |
Create a value of CreateLoggingConfigurationResponse 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:
CreateLoggingConfigurationResponse, createLoggingConfigurationResponse_arn - Logging-configuration ARN, assigned by the system.
CreateLoggingConfigurationResponse, createLoggingConfigurationResponse_createTime - Time when the logging configuration was created. This is an ISO 8601
timestamp; note that this is returned as a string.
CreateLoggingConfiguration, createLoggingConfigurationResponse_destinationConfiguration - 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, createLoggingConfigurationResponse_id - Logging-configuration ID, generated by the system. This is a relative
identifier, the part of the ARN that uniquely identifies the logging
configuration.
CreateLoggingConfiguration, createLoggingConfigurationResponse_name - Logging-configuration name, from the request (if specified).
CreateLoggingConfigurationResponse, createLoggingConfigurationResponse_state - The state of the logging configuration. When the state is ACTIVE, the
configuration is ready to log chat content.
CreateLoggingConfiguration, createLoggingConfigurationResponse_tags - Tags attached to the resource, from the request (if specified). Array of
maps, each of the form string:string (key:value).
CreateLoggingConfigurationResponse, createLoggingConfigurationResponse_updateTime - Time of the logging configuration’s last update. This is an ISO 8601
timestamp; note that this is returned as a string.
$sel:httpStatus:CreateLoggingConfigurationResponse', createLoggingConfigurationResponse_httpStatus - The response's http status code.
CreateRoom
data CreateRoom Source #
See: newCreateRoom smart constructor.
Constructors
| CreateRoom' (Maybe [Text]) (Maybe Natural) (Maybe Natural) (Maybe MessageReviewHandler) (Maybe Text) (Maybe (HashMap Text Text)) |
Instances
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.
data CreateRoomResponse Source #
See: newCreateRoomResponse smart constructor.
Constructors
| CreateRoomResponse' (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe [Text]) (Maybe Natural) (Maybe Natural) (Maybe MessageReviewHandler) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe ISO8601) Int |
Instances
newCreateRoomResponse Source #
Arguments
| :: Int | |
| -> 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.
DeleteLoggingConfiguration
data DeleteLoggingConfiguration Source #
See: newDeleteLoggingConfiguration smart constructor.
Constructors
| DeleteLoggingConfiguration' Text |
Instances
newDeleteLoggingConfiguration Source #
Create a value of DeleteLoggingConfiguration 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:DeleteLoggingConfiguration', deleteLoggingConfiguration_identifier - Identifier of the logging configuration to be deleted.
data DeleteLoggingConfigurationResponse Source #
See: newDeleteLoggingConfigurationResponse smart constructor.
Constructors
| DeleteLoggingConfigurationResponse' | |
Instances
| Generic DeleteLoggingConfigurationResponse Source # | |
Defined in Amazonka.IVSChat.DeleteLoggingConfiguration Associated Types type Rep DeleteLoggingConfigurationResponse :: Type -> Type # | |
| Read DeleteLoggingConfigurationResponse Source # | |
Defined in Amazonka.IVSChat.DeleteLoggingConfiguration | |
| Show DeleteLoggingConfigurationResponse Source # | |
Defined in Amazonka.IVSChat.DeleteLoggingConfiguration Methods showsPrec :: Int -> DeleteLoggingConfigurationResponse -> ShowS # | |
| NFData DeleteLoggingConfigurationResponse Source # | |
Defined in Amazonka.IVSChat.DeleteLoggingConfiguration Methods rnf :: DeleteLoggingConfigurationResponse -> () # | |
| Eq DeleteLoggingConfigurationResponse Source # | |
| type Rep DeleteLoggingConfigurationResponse Source # | |
Defined in Amazonka.IVSChat.DeleteLoggingConfiguration | |
newDeleteLoggingConfigurationResponse :: DeleteLoggingConfigurationResponse Source #
Create a value of DeleteLoggingConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteMessage
data DeleteMessage Source #
See: newDeleteMessage smart constructor.
Constructors
| DeleteMessage' (Maybe Text) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteMessage |
Create a value of DeleteMessage 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:reason:DeleteMessage', deleteMessage_reason - Reason for deleting the message.
DeleteMessage, deleteMessage_id - ID of the message to be deleted. This is the Id field in the received
message (see
Message (Subscribe)
in the Chat Messaging API).
$sel:roomIdentifier:DeleteMessage', deleteMessage_roomIdentifier - Identifier of the room where the message should be deleted. Currently
this must be an ARN.
data DeleteMessageResponse Source #
See: newDeleteMessageResponse smart constructor.
Constructors
| DeleteMessageResponse' (Maybe Text) Int |
Instances
newDeleteMessageResponse Source #
Create a value of DeleteMessageResponse 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:
DeleteMessage, deleteMessageResponse_id - Operation identifier, generated by Amazon IVS Chat.
$sel:httpStatus:DeleteMessageResponse', deleteMessageResponse_httpStatus - The response's http status code.
DeleteRoom
data DeleteRoom Source #
See: newDeleteRoom smart constructor.
Constructors
| DeleteRoom' Text |
Instances
Arguments
| :: Text | |
| -> DeleteRoom |
Create a value of DeleteRoom 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:DeleteRoom', deleteRoom_identifier - Identifier of the room to be deleted. Currently this must be an ARN.
data DeleteRoomResponse Source #
See: newDeleteRoomResponse smart constructor.
Constructors
| DeleteRoomResponse' | |
Instances
| Generic DeleteRoomResponse Source # | |
Defined in Amazonka.IVSChat.DeleteRoom Associated Types type Rep DeleteRoomResponse :: Type -> Type # Methods from :: DeleteRoomResponse -> Rep DeleteRoomResponse x # to :: Rep DeleteRoomResponse x -> DeleteRoomResponse # | |
| Read DeleteRoomResponse Source # | |
Defined in Amazonka.IVSChat.DeleteRoom Methods readsPrec :: Int -> ReadS DeleteRoomResponse # readList :: ReadS [DeleteRoomResponse] # | |
| Show DeleteRoomResponse Source # | |
Defined in Amazonka.IVSChat.DeleteRoom Methods showsPrec :: Int -> DeleteRoomResponse -> ShowS # show :: DeleteRoomResponse -> String # showList :: [DeleteRoomResponse] -> ShowS # | |
| NFData DeleteRoomResponse Source # | |
Defined in Amazonka.IVSChat.DeleteRoom Methods rnf :: DeleteRoomResponse -> () # | |
| Eq DeleteRoomResponse Source # | |
Defined in Amazonka.IVSChat.DeleteRoom Methods (==) :: DeleteRoomResponse -> DeleteRoomResponse -> Bool # (/=) :: DeleteRoomResponse -> DeleteRoomResponse -> Bool # | |
| type Rep DeleteRoomResponse Source # | |
newDeleteRoomResponse :: DeleteRoomResponse Source #
Create a value of DeleteRoomResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DisconnectUser
data DisconnectUser Source #
See: newDisconnectUser smart constructor.
Constructors
| DisconnectUser' (Maybe Text) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DisconnectUser |
Create a value of DisconnectUser 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:reason:DisconnectUser', disconnectUser_reason - Reason for disconnecting the user.
$sel:roomIdentifier:DisconnectUser', disconnectUser_roomIdentifier - Identifier of the room from which the user's clients should be
disconnected. Currently this must be an ARN.
$sel:userId:DisconnectUser', disconnectUser_userId - ID of the user (connection) to disconnect from the room.
data DisconnectUserResponse Source #
See: newDisconnectUserResponse smart constructor.
Constructors
| DisconnectUserResponse' Int |
Instances
newDisconnectUserResponse Source #
Create a value of DisconnectUserResponse 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:httpStatus:DisconnectUserResponse', disconnectUserResponse_httpStatus - The response's http status code.
GetLoggingConfiguration
data GetLoggingConfiguration Source #
See: newGetLoggingConfiguration smart constructor.
Constructors
| GetLoggingConfiguration' Text |
Instances
newGetLoggingConfiguration Source #
Create a value of GetLoggingConfiguration 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:GetLoggingConfiguration', getLoggingConfiguration_identifier - Identifier of the logging configuration to be retrieved.
data GetLoggingConfigurationResponse Source #
See: newGetLoggingConfigurationResponse smart constructor.
Constructors
Instances
newGetLoggingConfigurationResponse Source #
Create a value of GetLoggingConfigurationResponse 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:
GetLoggingConfigurationResponse, getLoggingConfigurationResponse_arn - Logging-configuration ARN, from the request (if identifier was an
ARN).
GetLoggingConfigurationResponse, getLoggingConfigurationResponse_createTime - Time when the logging configuration was created. This is an ISO 8601
timestamp; note that this is returned as a string.
GetLoggingConfigurationResponse, getLoggingConfigurationResponse_destinationConfiguration - 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, getLoggingConfigurationResponse_id - Logging-configuration ID, generated by the system. This is a relative
identifier, the part of the ARN that uniquely identifies the logging
configuration.
GetLoggingConfigurationResponse, getLoggingConfigurationResponse_name - Logging-configuration name. This value does not need to be unique.
GetLoggingConfigurationResponse, getLoggingConfigurationResponse_state - The state of the logging configuration. When the state is ACTIVE, the
configuration is ready to log chat content.
GetLoggingConfigurationResponse, getLoggingConfigurationResponse_tags - Tags attached to the resource. Array of maps, each of the form
string:string (key:value).
GetLoggingConfigurationResponse, getLoggingConfigurationResponse_updateTime - Time of the logging configuration’s last update. This is an ISO 8601
timestamp; note that this is returned as a string.
$sel:httpStatus:GetLoggingConfigurationResponse', getLoggingConfigurationResponse_httpStatus - The response's http status code.
GetRoom
See: newGetRoom smart constructor.
Instances
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.
data GetRoomResponse Source #
See: newGetRoomResponse smart constructor.
Constructors
| GetRoomResponse' (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe [Text]) (Maybe Natural) (Maybe Natural) (Maybe MessageReviewHandler) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe ISO8601) Int |
Instances
Arguments
| :: Int | |
| -> GetRoomResponse |
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.
ListLoggingConfigurations
data ListLoggingConfigurations Source #
See: newListLoggingConfigurations smart constructor.
Constructors
| ListLoggingConfigurations' (Maybe Natural) (Maybe Text) |
Instances
newListLoggingConfigurations :: ListLoggingConfigurations Source #
Create a value of ListLoggingConfigurations 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:maxResults:ListLoggingConfigurations', listLoggingConfigurations_maxResults - Maximum number of logging configurations to return. Default: 50.
ListLoggingConfigurations, listLoggingConfigurations_nextToken - The first logging configurations to retrieve. This is used for
pagination; see the nextToken response field.
data ListLoggingConfigurationsResponse Source #
See: newListLoggingConfigurationsResponse smart constructor.
Constructors
| ListLoggingConfigurationsResponse' (Maybe Text) Int [LoggingConfigurationSummary] |
Instances
newListLoggingConfigurationsResponse Source #
Arguments
| :: Int | |
| -> ListLoggingConfigurationsResponse |
Create a value of ListLoggingConfigurationsResponse 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:
ListLoggingConfigurations, listLoggingConfigurationsResponse_nextToken - If there are more logging configurations than maxResults, use
nextToken in the request to get the next set.
$sel:httpStatus:ListLoggingConfigurationsResponse', listLoggingConfigurationsResponse_httpStatus - The response's http status code.
$sel:loggingConfigurations:ListLoggingConfigurationsResponse', listLoggingConfigurationsResponse_loggingConfigurations - List of the matching logging configurations (summary information only).
There is only one type of destination (cloudWatchLogs, firehose, or
s3) in a destinationConfiguration.
ListRooms
See: newListRooms smart constructor.
Instances
newListRooms :: ListRooms Source #
Create a value of ListRooms 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:loggingConfigurationIdentifier:ListRooms', listRooms_loggingConfigurationIdentifier - Logging-configuration identifier.
$sel:maxResults:ListRooms', listRooms_maxResults - Maximum number of rooms to return. Default: 50.
$sel:messageReviewHandlerUri:ListRooms', listRooms_messageReviewHandlerUri - Filters the list to match the specified message review handler URI.
ListRooms, listRooms_name - Filters the list to match the specified room name.
ListRooms, listRooms_nextToken - The first room to retrieve. This is used for pagination; see the
nextToken response field.
data ListRoomsResponse Source #
See: newListRoomsResponse smart constructor.
Constructors
| ListRoomsResponse' (Maybe Text) Int [RoomSummary] |
Instances
Arguments
| :: Int | |
| -> ListRoomsResponse |
Create a value of ListRoomsResponse 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:
ListRooms, listRoomsResponse_nextToken - If there are more rooms than maxResults, use nextToken in the
request to get the next set.
$sel:httpStatus:ListRoomsResponse', listRoomsResponse_httpStatus - The response's http status code.
$sel:rooms:ListRoomsResponse', listRoomsResponse_rooms - List of the matching rooms (summary information only).
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The ARN of the resource to be retrieved. The ARN must be URL-encoded.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Constructors
| ListTagsForResourceResponse' Int (HashMap Text Text) |
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
ListTagsForResourceResponse, listTagsForResourceResponse_tags - Tags attached to the resource. Array of maps, each of the form
string:string (key:value).
SendEvent
See: newSendEvent smart constructor.
Instances
Create a value of SendEvent 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:attributes:SendEvent', sendEvent_attributes - Application-defined metadata to attach to the event sent to clients. The
maximum length of the metadata is 1 KB total.
$sel:eventName:SendEvent', sendEvent_eventName - Application-defined name of the event to send to clients.
$sel:roomIdentifier:SendEvent', sendEvent_roomIdentifier - Identifier of the room to which the event will be sent. Currently this
must be an ARN.
data SendEventResponse Source #
See: newSendEventResponse smart constructor.
Constructors
| SendEventResponse' (Maybe Text) Int |
Instances
Arguments
| :: Int | |
| -> SendEventResponse |
Create a value of SendEventResponse 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:
SendEventResponse, sendEventResponse_id - An identifier generated by Amazon IVS Chat. This identifier must be used
in subsequent operations for this message, such as DeleteMessage.
$sel:httpStatus:SendEventResponse', sendEventResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text (HashMap Text Text) |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource 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:resourceArn:TagResource', tagResource_resourceArn - The ARN of the resource to be tagged. The ARN must be URL-encoded.
TagResource, tagResource_tags - 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.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse 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:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource 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:resourceArn:UntagResource', untagResource_resourceArn - The ARN of the resource to be untagged. The ARN must be URL-encoded.
$sel:tagKeys:UntagResource', untagResource_tagKeys - 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.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse 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:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateLoggingConfiguration
data UpdateLoggingConfiguration Source #
See: newUpdateLoggingConfiguration smart constructor.
Constructors
| UpdateLoggingConfiguration' (Maybe DestinationConfiguration) (Maybe Text) Text |
Instances
newUpdateLoggingConfiguration Source #
Create a value of UpdateLoggingConfiguration 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:
UpdateLoggingConfiguration, updateLoggingConfiguration_destinationConfiguration - 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, updateLoggingConfiguration_name - Logging-configuration name. The value does not need to be unique.
$sel:identifier:UpdateLoggingConfiguration', updateLoggingConfiguration_identifier - Identifier of the logging configuration to be updated.
data UpdateLoggingConfigurationResponse Source #
See: newUpdateLoggingConfigurationResponse smart constructor.
Constructors
Instances
newUpdateLoggingConfigurationResponse Source #
Arguments
| :: Int | |
| -> UpdateLoggingConfigurationResponse |
Create a value of UpdateLoggingConfigurationResponse 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:
UpdateLoggingConfigurationResponse, updateLoggingConfigurationResponse_arn - Logging-configuration ARN, from the request (if identifier was an
ARN).
UpdateLoggingConfigurationResponse, updateLoggingConfigurationResponse_createTime - Time when the logging configuration was created. This is an ISO 8601
timestamp; note that this is returned as a string.
UpdateLoggingConfiguration, updateLoggingConfigurationResponse_destinationConfiguration - 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, updateLoggingConfigurationResponse_id - Logging-configuration ID, generated by the system. This is a relative
identifier, the part of the ARN that uniquely identifies the room.
UpdateLoggingConfiguration, updateLoggingConfigurationResponse_name - Logging-configuration name, from the request (if specified).
UpdateLoggingConfigurationResponse, updateLoggingConfigurationResponse_state - The state of the logging configuration. When the state is ACTIVE, the
configuration is ready to log chat content.
UpdateLoggingConfigurationResponse, updateLoggingConfigurationResponse_tags - Tags attached to the resource. Array of maps, each of the form
string:string (key:value).
UpdateLoggingConfigurationResponse, updateLoggingConfigurationResponse_updateTime - Time of the logging configuration’s last update. This is an ISO 8601
timestamp; note that this is returned as a string.
$sel:httpStatus:UpdateLoggingConfigurationResponse', updateLoggingConfigurationResponse_httpStatus - The response's http status code.
UpdateRoom
data UpdateRoom Source #
See: newUpdateRoom smart constructor.
Constructors
| UpdateRoom' (Maybe [Text]) (Maybe Natural) (Maybe Natural) (Maybe MessageReviewHandler) (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> 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.
data UpdateRoomResponse Source #
See: newUpdateRoomResponse smart constructor.
Constructors
| UpdateRoomResponse' (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe [Text]) (Maybe Natural) (Maybe Natural) (Maybe MessageReviewHandler) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe ISO8601) Int |
Instances
newUpdateRoomResponse Source #
Arguments
| :: Int | |
| -> 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.
Types
ChatTokenCapability
newtype ChatTokenCapability Source #
Constructors
| ChatTokenCapability' | |
Fields | |
Bundled Patterns
| pattern ChatTokenCapability_DELETE_MESSAGE :: ChatTokenCapability | |
| pattern ChatTokenCapability_DISCONNECT_USER :: ChatTokenCapability | |
| pattern ChatTokenCapability_SEND_MESSAGE :: ChatTokenCapability |
Instances
CreateLoggingConfigurationState
newtype CreateLoggingConfigurationState Source #
Constructors
| CreateLoggingConfigurationState' | |
Fields | |
Bundled Patterns
| pattern CreateLoggingConfigurationState_ACTIVE :: CreateLoggingConfigurationState |
Instances
FallbackResult
newtype FallbackResult Source #
Constructors
| FallbackResult' | |
Fields | |
Bundled Patterns
| pattern FallbackResult_ALLOW :: FallbackResult | |
| pattern FallbackResult_DENY :: FallbackResult |
Instances
LoggingConfigurationState
newtype LoggingConfigurationState Source #
Constructors
| LoggingConfigurationState' | |
Fields | |
Bundled Patterns
Instances
UpdateLoggingConfigurationState
newtype UpdateLoggingConfigurationState Source #
Constructors
| UpdateLoggingConfigurationState' | |
Fields | |
Bundled Patterns
| pattern UpdateLoggingConfigurationState_ACTIVE :: UpdateLoggingConfigurationState |
Instances
CloudWatchLogsDestinationConfiguration
data CloudWatchLogsDestinationConfiguration Source #
Specifies a CloudWatch Logs location where chat logs will be stored.
See: newCloudWatchLogsDestinationConfiguration smart constructor.
Constructors
| CloudWatchLogsDestinationConfiguration' Text |
Instances
newCloudWatchLogsDestinationConfiguration Source #
Arguments
| :: Text | |
| -> CloudWatchLogsDestinationConfiguration |
Create a value of CloudWatchLogsDestinationConfiguration 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:logGroupName:CloudWatchLogsDestinationConfiguration', cloudWatchLogsDestinationConfiguration_logGroupName - Name of the Amazon Cloudwatch Logs destination where chat activity will
be logged.
DestinationConfiguration
data DestinationConfiguration Source #
A complex type that describes a location where chat logs will be stored. Each member represents the configuration of one log destination. For logging, you define only one type of destination (for CloudWatch Logs, Kinesis Firehose, or S3).
See: newDestinationConfiguration smart constructor.
Constructors
| DestinationConfiguration' (Maybe CloudWatchLogsDestinationConfiguration) (Maybe FirehoseDestinationConfiguration) (Maybe S3DestinationConfiguration) |
Instances
newDestinationConfiguration :: DestinationConfiguration Source #
Create a value of DestinationConfiguration 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:cloudWatchLogs:DestinationConfiguration', destinationConfiguration_cloudWatchLogs - An Amazon CloudWatch Logs destination configuration where chat activity
will be logged.
$sel:firehose:DestinationConfiguration', destinationConfiguration_firehose - An Amazon Kinesis Data Firehose destination configuration where chat
activity will be logged.
$sel:s3:DestinationConfiguration', destinationConfiguration_s3 - An Amazon S3 destination configuration where chat activity will be
logged.
FirehoseDestinationConfiguration
data FirehoseDestinationConfiguration Source #
Specifies a Kinesis Firehose location where chat logs will be stored.
See: newFirehoseDestinationConfiguration smart constructor.
Constructors
| FirehoseDestinationConfiguration' Text |
Instances
newFirehoseDestinationConfiguration Source #
Arguments
| :: Text | |
| -> FirehoseDestinationConfiguration |
Create a value of FirehoseDestinationConfiguration 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:deliveryStreamName:FirehoseDestinationConfiguration', firehoseDestinationConfiguration_deliveryStreamName - Name of the Amazon Kinesis Firehose delivery stream where chat activity
will be logged.
LoggingConfigurationSummary
data LoggingConfigurationSummary Source #
Summary information about a logging configuration.
See: newLoggingConfigurationSummary smart constructor.
Constructors
| LoggingConfigurationSummary' (Maybe Text) (Maybe ISO8601) (Maybe DestinationConfiguration) (Maybe Text) (Maybe Text) (Maybe LoggingConfigurationState) (Maybe (HashMap Text Text)) (Maybe ISO8601) |
Instances
newLoggingConfigurationSummary :: LoggingConfigurationSummary Source #
Create a value of LoggingConfigurationSummary 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:arn:LoggingConfigurationSummary', loggingConfigurationSummary_arn - Logging-configuration ARN.
$sel:createTime:LoggingConfigurationSummary', loggingConfigurationSummary_createTime - Time when the logging configuration was created. This is an ISO 8601
timestamp; note that this is returned as a string.
$sel:destinationConfiguration:LoggingConfigurationSummary', loggingConfigurationSummary_destinationConfiguration - A complex type that contains a destination configuration for where chat
content will be logged.
$sel:id:LoggingConfigurationSummary', loggingConfigurationSummary_id - Logging-configuration ID, generated by the system. This is a relative
identifier, the part of the ARN that uniquely identifies the room.
$sel:name:LoggingConfigurationSummary', loggingConfigurationSummary_name - Logging-configuration name. The value does not need to be unique.
$sel:state:LoggingConfigurationSummary', loggingConfigurationSummary_state - The state of the logging configuration. When this is ACTIVE, the
configuration is ready for logging chat content.
$sel:tags:LoggingConfigurationSummary', loggingConfigurationSummary_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 on tags
beyond what is documented there.
$sel:updateTime:LoggingConfigurationSummary', loggingConfigurationSummary_updateTime - Time of the logging configuration’s last update. This is an ISO 8601
timestamp; note that this is returned as a string.
MessageReviewHandler
data MessageReviewHandler Source #
Configuration information for optional message review.
See: newMessageReviewHandler smart constructor.
Constructors
| MessageReviewHandler' (Maybe FallbackResult) (Maybe Text) |
Instances
newMessageReviewHandler :: MessageReviewHandler Source #
Create a value of MessageReviewHandler 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:fallbackResult:MessageReviewHandler', messageReviewHandler_fallbackResult - 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.
$sel:uri:MessageReviewHandler', messageReviewHandler_uri - Identifier of the message review handler. Currently this must be an ARN
of a lambda function.
RoomSummary
data RoomSummary Source #
Summary information about a room.
See: newRoomSummary smart constructor.
Constructors
| RoomSummary' (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe [Text]) (Maybe MessageReviewHandler) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe ISO8601) |
Instances
newRoomSummary :: RoomSummary Source #
Create a value of RoomSummary 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:arn:RoomSummary', roomSummary_arn - Room ARN.
$sel:createTime:RoomSummary', roomSummary_createTime - Time when the room was created. This is an ISO 8601 timestamp; /note
that this is returned as a string/.
$sel:id:RoomSummary', roomSummary_id - Room ID, generated by the system. This is a relative identifier, the
part of the ARN that uniquely identifies the room.
$sel:loggingConfigurationIdentifiers:RoomSummary', roomSummary_loggingConfigurationIdentifiers - List of logging-configuration identifiers attached to the room.
$sel:messageReviewHandler:RoomSummary', roomSummary_messageReviewHandler - Configuration information for optional review of messages.
$sel:name:RoomSummary', roomSummary_name - Room name. The value does not need to be unique.
$sel:tags:RoomSummary', roomSummary_tags - 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.
$sel:updateTime:RoomSummary', roomSummary_updateTime - Time of the room’s last update. This is an ISO 8601 timestamp; /note
that this is returned as a string/.
S3DestinationConfiguration
data S3DestinationConfiguration Source #
Specifies an S3 location where chat logs will be stored.
See: newS3DestinationConfiguration smart constructor.
Constructors
| S3DestinationConfiguration' Text |
Instances
newS3DestinationConfiguration Source #
Create a value of S3DestinationConfiguration 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:bucketName:S3DestinationConfiguration', s3DestinationConfiguration_bucketName - Name of the Amazon S3 bucket where chat activity will be logged.