Amazonka.ChimeSDKMessaging.DeleteChannelMessage

Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage.

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.

Creating a Request

data DeleteChannelMessage

See: newDeleteChannelMessage smart constructor.

Constructors

DeleteChannelMessage'

Fields

• subChannelId :: Maybe Text

  The ID of the SubChannel in the request.

  Only required when deleting messages in a SubChannel that the user belongs to.

• channelArn :: Text

  The ARN of the channel.

• messageId :: Text

  The ID of the message being deleted.

• chimeBearer :: Text

  The AppInstanceUserArn of the user that makes the API call.

Instances

ToHeaders DeleteChannelMessage

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage

Methods

toHeaders :: DeleteChannelMessage -> [Header]

ToPath DeleteChannelMessage

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage

Methods

toPath :: DeleteChannelMessage -> ByteString

ToQuery DeleteChannelMessage

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage

Methods

toQuery :: DeleteChannelMessage -> QueryString

AWSRequest DeleteChannelMessage

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage

Associated Types

type AWSResponse DeleteChannelMessage

Methods

request :: (Service -> Service) -> DeleteChannelMessage -> Request DeleteChannelMessage

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteChannelMessage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteChannelMessage)))

Generic DeleteChannelMessage

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage

Associated Types

type Rep DeleteChannelMessage :: Type -> Type

Methods

from :: DeleteChannelMessage -> Rep DeleteChannelMessage x

to :: Rep DeleteChannelMessage x -> DeleteChannelMessage

Read DeleteChannelMessage

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage

Methods

readsPrec :: Int -> ReadS DeleteChannelMessage

readList :: ReadS [DeleteChannelMessage]

readPrec :: ReadPrec DeleteChannelMessage

readListPrec :: ReadPrec [DeleteChannelMessage]

Show DeleteChannelMessage

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage

Methods

showsPrec :: Int -> DeleteChannelMessage -> ShowS

show :: DeleteChannelMessage -> String

showList :: [DeleteChannelMessage] -> ShowS

NFData DeleteChannelMessage

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage

Methods

rnf :: DeleteChannelMessage -> ()

Eq DeleteChannelMessage

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage

Methods

(==) :: DeleteChannelMessage -> DeleteChannelMessage -> Bool

(/=) :: DeleteChannelMessage -> DeleteChannelMessage -> Bool

Hashable DeleteChannelMessage

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage

Methods

hashWithSalt :: Int -> DeleteChannelMessage -> Int

hash :: DeleteChannelMessage -> Int

type AWSResponse DeleteChannelMessage

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage

type AWSResponse DeleteChannelMessage = DeleteChannelMessageResponse

type Rep DeleteChannelMessage

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage

type Rep DeleteChannelMessage = D1 ('MetaData "DeleteChannelMessage" "Amazonka.ChimeSDKMessaging.DeleteChannelMessage" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "DeleteChannelMessage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "subChannelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "messageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "chimeBearer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDeleteChannelMessage

Arguments

:: Text

DeleteChannelMessage

-> Text

DeleteChannelMessage

-> Text

$sel:chimeBearer:DeleteChannelMessage'

-> DeleteChannelMessage

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

DeleteChannelMessage, deleteChannelMessage_subChannelId - The ID of the SubChannel in the request.

Only required when deleting messages in a SubChannel that the user belongs to.

DeleteChannelMessage, deleteChannelMessage_channelArn - The ARN of the channel.

DeleteChannelMessage, deleteChannelMessage_messageId - The ID of the message being deleted.

$sel:chimeBearer:DeleteChannelMessage', deleteChannelMessage_chimeBearer - The AppInstanceUserArn of the user that makes the API call.

Request Lenses

deleteChannelMessage_subChannelId :: Lens' DeleteChannelMessage (Maybe Text)

The ID of the SubChannel in the request.

Only required when deleting messages in a SubChannel that the user belongs to.

deleteChannelMessage_channelArn :: Lens' DeleteChannelMessage Text

The ARN of the channel.

deleteChannelMessage_messageId :: Lens' DeleteChannelMessage Text

The ID of the message being deleted.

deleteChannelMessage_chimeBearer :: Lens' DeleteChannelMessage Text

The AppInstanceUserArn of the user that makes the API call.

Destructuring the Response

data DeleteChannelMessageResponse

See: newDeleteChannelMessageResponse smart constructor.

Constructors

DeleteChannelMessageResponse'

Instances

Generic DeleteChannelMessageResponse

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage

Associated Types

type Rep DeleteChannelMessageResponse :: Type -> Type

Methods

from :: DeleteChannelMessageResponse -> Rep DeleteChannelMessageResponse x

to :: Rep DeleteChannelMessageResponse x -> DeleteChannelMessageResponse

Read DeleteChannelMessageResponse

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage

Methods

readsPrec :: Int -> ReadS DeleteChannelMessageResponse

readList :: ReadS [DeleteChannelMessageResponse]

readPrec :: ReadPrec DeleteChannelMessageResponse

readListPrec :: ReadPrec [DeleteChannelMessageResponse]

Show DeleteChannelMessageResponse

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage

Methods

showsPrec :: Int -> DeleteChannelMessageResponse -> ShowS

show :: DeleteChannelMessageResponse -> String

showList :: [DeleteChannelMessageResponse] -> ShowS

NFData DeleteChannelMessageResponse

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage

Methods

rnf :: DeleteChannelMessageResponse -> ()

Eq DeleteChannelMessageResponse

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage

Methods

(==) :: DeleteChannelMessageResponse -> DeleteChannelMessageResponse -> Bool

(/=) :: DeleteChannelMessageResponse -> DeleteChannelMessageResponse -> Bool

type Rep DeleteChannelMessageResponse

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage

type Rep DeleteChannelMessageResponse = D1 ('MetaData "DeleteChannelMessageResponse" "Amazonka.ChimeSDKMessaging.DeleteChannelMessage" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "DeleteChannelMessageResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteChannelMessageResponse :: DeleteChannelMessageResponse

Create a value of DeleteChannelMessageResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.