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 |
- Service Configuration
- Errors
- ChatTokenCapability
- CreateLoggingConfigurationState
- FallbackResult
- LoggingConfigurationState
- UpdateLoggingConfigurationState
- CloudWatchLogsDestinationConfiguration
- DestinationConfiguration
- FirehoseDestinationConfiguration
- LoggingConfigurationSummary
- MessageReviewHandler
- RoomSummary
- S3DestinationConfiguration
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
- 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' {
- logGroupName :: Text
- newCloudWatchLogsDestinationConfiguration :: Text -> CloudWatchLogsDestinationConfiguration
- cloudWatchLogsDestinationConfiguration_logGroupName :: Lens' CloudWatchLogsDestinationConfiguration Text
- data DestinationConfiguration = DestinationConfiguration' {}
- newDestinationConfiguration :: DestinationConfiguration
- destinationConfiguration_cloudWatchLogs :: Lens' DestinationConfiguration (Maybe CloudWatchLogsDestinationConfiguration)
- destinationConfiguration_firehose :: Lens' DestinationConfiguration (Maybe FirehoseDestinationConfiguration)
- destinationConfiguration_s3 :: Lens' DestinationConfiguration (Maybe S3DestinationConfiguration)
- data FirehoseDestinationConfiguration = FirehoseDestinationConfiguration' {}
- newFirehoseDestinationConfiguration :: Text -> FirehoseDestinationConfiguration
- firehoseDestinationConfiguration_deliveryStreamName :: Lens' FirehoseDestinationConfiguration Text
- data LoggingConfigurationSummary = LoggingConfigurationSummary' {}
- newLoggingConfigurationSummary :: LoggingConfigurationSummary
- 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)
- data MessageReviewHandler = MessageReviewHandler' {}
- newMessageReviewHandler :: MessageReviewHandler
- messageReviewHandler_fallbackResult :: Lens' MessageReviewHandler (Maybe FallbackResult)
- messageReviewHandler_uri :: Lens' MessageReviewHandler (Maybe Text)
- data RoomSummary = RoomSummary' {}
- newRoomSummary :: RoomSummary
- 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)
- data S3DestinationConfiguration = S3DestinationConfiguration' {
- bucketName :: Text
- newS3DestinationConfiguration :: Text -> S3DestinationConfiguration
- s3DestinationConfiguration_bucketName :: Lens' S3DestinationConfiguration Text
Service Configuration
defaultService :: Service Source #
API version 2020-07-14
of the Amazon Interactive Video Service Chat SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
_ConflictException :: AsError a => Fold a ServiceError Source #
_InternalServerException :: AsError a => Fold a ServiceError Source #
_PendingVerification :: AsError a => Fold a ServiceError Source #
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
_ThrottlingException :: AsError a => Fold a ServiceError Source #
_ValidationException :: AsError a => Fold a ServiceError Source #
ChatTokenCapability
newtype ChatTokenCapability Source #
pattern ChatTokenCapability_DELETE_MESSAGE :: ChatTokenCapability | |
pattern ChatTokenCapability_DISCONNECT_USER :: ChatTokenCapability | |
pattern ChatTokenCapability_SEND_MESSAGE :: ChatTokenCapability |
Instances
CreateLoggingConfigurationState
newtype CreateLoggingConfigurationState Source #
Instances
FallbackResult
newtype FallbackResult Source #
pattern FallbackResult_ALLOW :: FallbackResult | |
pattern FallbackResult_DENY :: FallbackResult |
Instances
LoggingConfigurationState
newtype LoggingConfigurationState Source #
Instances
UpdateLoggingConfigurationState
newtype UpdateLoggingConfigurationState Source #
Instances
CloudWatchLogsDestinationConfiguration
data CloudWatchLogsDestinationConfiguration Source #
Specifies a CloudWatch Logs location where chat logs will be stored.
See: newCloudWatchLogsDestinationConfiguration
smart constructor.
CloudWatchLogsDestinationConfiguration' | |
|
Instances
FromJSON CloudWatchLogsDestinationConfiguration Source # | |
ToJSON CloudWatchLogsDestinationConfiguration Source # | |
Generic CloudWatchLogsDestinationConfiguration Source # | |
Read CloudWatchLogsDestinationConfiguration Source # | |
Show CloudWatchLogsDestinationConfiguration Source # | |
NFData CloudWatchLogsDestinationConfiguration Source # | |
Eq CloudWatchLogsDestinationConfiguration Source # | |
Hashable CloudWatchLogsDestinationConfiguration Source # | |
type Rep CloudWatchLogsDestinationConfiguration Source # | |
Defined in Amazonka.IVSChat.Types.CloudWatchLogsDestinationConfiguration type Rep CloudWatchLogsDestinationConfiguration = D1 ('MetaData "CloudWatchLogsDestinationConfiguration" "Amazonka.IVSChat.Types.CloudWatchLogsDestinationConfiguration" "amazonka-ivschat-2.0-AB4QlCKEEGt4izEWjWKMb2" 'False) (C1 ('MetaCons "CloudWatchLogsDestinationConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "logGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
newCloudWatchLogsDestinationConfiguration Source #
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.
cloudWatchLogsDestinationConfiguration_logGroupName :: Lens' CloudWatchLogsDestinationConfiguration Text Source #
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.
DestinationConfiguration' | |
|
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.
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
data FirehoseDestinationConfiguration Source #
Specifies a Kinesis Firehose location where chat logs will be stored.
See: newFirehoseDestinationConfiguration
smart constructor.
FirehoseDestinationConfiguration' | |
|
Instances
newFirehoseDestinationConfiguration Source #
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.
firehoseDestinationConfiguration_deliveryStreamName :: Lens' FirehoseDestinationConfiguration Text Source #
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.
LoggingConfigurationSummary' | |
|
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.
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
data MessageReviewHandler Source #
Configuration information for optional message review.
See: newMessageReviewHandler
smart constructor.
MessageReviewHandler' | |
|
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.
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
data RoomSummary Source #
Summary information about a room.
See: newRoomSummary
smart constructor.
RoomSummary' | |
|
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/.
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
data S3DestinationConfiguration Source #
Specifies an S3 location where chat logs will be stored.
See: newS3DestinationConfiguration
smart constructor.
S3DestinationConfiguration' | |
|
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.
s3DestinationConfiguration_bucketName :: Lens' S3DestinationConfiguration Text Source #
Name of the Amazon S3 bucket where chat activity will be logged.