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 |
Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.
The x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value in
the header.
Synopsis
- data RedactChannelMessage = RedactChannelMessage' {
- subChannelId :: Maybe Text
- channelArn :: Text
- messageId :: Text
- chimeBearer :: Text
- newRedactChannelMessage :: Text -> Text -> Text -> RedactChannelMessage
- redactChannelMessage_subChannelId :: Lens' RedactChannelMessage (Maybe Text)
- redactChannelMessage_channelArn :: Lens' RedactChannelMessage Text
- redactChannelMessage_messageId :: Lens' RedactChannelMessage Text
- redactChannelMessage_chimeBearer :: Lens' RedactChannelMessage Text
- data RedactChannelMessageResponse = RedactChannelMessageResponse' {
- channelArn :: Maybe Text
- messageId :: Maybe Text
- subChannelId :: Maybe Text
- httpStatus :: Int
- newRedactChannelMessageResponse :: Int -> RedactChannelMessageResponse
- redactChannelMessageResponse_channelArn :: Lens' RedactChannelMessageResponse (Maybe Text)
- redactChannelMessageResponse_messageId :: Lens' RedactChannelMessageResponse (Maybe Text)
- redactChannelMessageResponse_subChannelId :: Lens' RedactChannelMessageResponse (Maybe Text)
- redactChannelMessageResponse_httpStatus :: Lens' RedactChannelMessageResponse Int
Creating a Request
data RedactChannelMessage Source #
See: newRedactChannelMessage
smart constructor.
RedactChannelMessage' | |
|
Instances
newRedactChannelMessage Source #
:: Text | |
-> Text | |
-> Text | |
-> RedactChannelMessage |
Create a value of RedactChannelMessage
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:
RedactChannelMessage
, redactChannelMessage_subChannelId
- The ID of the SubChannel in the request.
RedactChannelMessage
, redactChannelMessage_channelArn
- The ARN of the channel containing the messages that you want to redact.
RedactChannelMessage
, redactChannelMessage_messageId
- The ID of the message being redacted.
$sel:chimeBearer:RedactChannelMessage'
, redactChannelMessage_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
Request Lenses
redactChannelMessage_subChannelId :: Lens' RedactChannelMessage (Maybe Text) Source #
The ID of the SubChannel in the request.
redactChannelMessage_channelArn :: Lens' RedactChannelMessage Text Source #
The ARN of the channel containing the messages that you want to redact.
redactChannelMessage_messageId :: Lens' RedactChannelMessage Text Source #
The ID of the message being redacted.
redactChannelMessage_chimeBearer :: Lens' RedactChannelMessage Text Source #
The AppInstanceUserArn
of the user that makes the API call.
Destructuring the Response
data RedactChannelMessageResponse Source #
See: newRedactChannelMessageResponse
smart constructor.
RedactChannelMessageResponse' | |
|
Instances
newRedactChannelMessageResponse Source #
Create a value of RedactChannelMessageResponse
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:
RedactChannelMessage
, redactChannelMessageResponse_channelArn
- The ARN of the channel containing the messages that you want to redact.
RedactChannelMessage
, redactChannelMessageResponse_messageId
- The ID of the message being redacted.
RedactChannelMessage
, redactChannelMessageResponse_subChannelId
- The ID of the SubChannel in the response.
Only required when redacting messages in a SubChannel that the user belongs to.
$sel:httpStatus:RedactChannelMessageResponse'
, redactChannelMessageResponse_httpStatus
- The response's http status code.
Response Lenses
redactChannelMessageResponse_channelArn :: Lens' RedactChannelMessageResponse (Maybe Text) Source #
The ARN of the channel containing the messages that you want to redact.
redactChannelMessageResponse_messageId :: Lens' RedactChannelMessageResponse (Maybe Text) Source #
The ID of the message being redacted.
redactChannelMessageResponse_subChannelId :: Lens' RedactChannelMessageResponse (Maybe Text) Source #
The ID of the SubChannel in the response.
Only required when redacting messages in a SubChannel that the user belongs to.
redactChannelMessageResponse_httpStatus :: Lens' RedactChannelMessageResponse Int Source #
The response's http status code.