Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ChimeSDKMessaging.DeleteChannelMessage

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

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 Source #

See: newDeleteChannelMessage smart constructor.

Constructors

DeleteChannelMessage'
Fields 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

Instances details

Eq DeleteChannelMessage Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage Methods (==) :: DeleteChannelMessage -> DeleteChannelMessage -> Bool # (/=) :: DeleteChannelMessage -> DeleteChannelMessage -> Bool #
Read DeleteChannelMessage Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage Methods readsPrec :: Int -> ReadS DeleteChannelMessage # readList :: ReadS [DeleteChannelMessage] # readPrec :: ReadPrec DeleteChannelMessage # readListPrec :: ReadPrec [DeleteChannelMessage] #
Show DeleteChannelMessage Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage Methods showsPrec :: Int -> DeleteChannelMessage -> ShowS # show :: DeleteChannelMessage -> String # showList :: [DeleteChannelMessage] -> ShowS #
Generic DeleteChannelMessage Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage Associated Types type Rep DeleteChannelMessage :: Type -> Type # Methods from :: DeleteChannelMessage -> Rep DeleteChannelMessage x # to :: Rep DeleteChannelMessage x -> DeleteChannelMessage #
NFData DeleteChannelMessage Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage Methods rnf :: DeleteChannelMessage -> () #
Hashable DeleteChannelMessage Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage Methods hashWithSalt :: Int -> DeleteChannelMessage -> Int # hash :: DeleteChannelMessage -> Int #
AWSRequest DeleteChannelMessage Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage Associated Types type AWSResponse DeleteChannelMessage # Methods request :: DeleteChannelMessage -> Request DeleteChannelMessage # response :: MonadResource m => Logger -> Service -> Proxy DeleteChannelMessage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteChannelMessage))) #
ToHeaders DeleteChannelMessage Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage Methods toHeaders :: DeleteChannelMessage -> [Header] #
ToPath DeleteChannelMessage Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage Methods toPath :: DeleteChannelMessage -> ByteString #
ToQuery DeleteChannelMessage Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage Methods toQuery :: DeleteChannelMessage -> QueryString #
type Rep DeleteChannelMessage Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage type Rep DeleteChannelMessage = D1 ('MetaData "DeleteChannelMessage" "Amazonka.ChimeSDKMessaging.DeleteChannelMessage" "libZSservicesZSamazonka-chime-sdk-messagingZSamazonka-chime-sdk-messaging" 'False) (C1 ('MetaCons "DeleteChannelMessage'" 'PrefixI 'True) (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))))
type AWSResponse DeleteChannelMessage Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage type AWSResponse DeleteChannelMessage = DeleteChannelMessageResponse

newDeleteChannelMessage Source #

Arguments

:: Text	`$sel:channelArn:DeleteChannelMessage'`
-> Text	`$sel:messageId: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:

$sel:channelArn:DeleteChannelMessage', deleteChannelMessage_channelArn - The ARN of the channel.

$sel:messageId: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_channelArn :: Lens' DeleteChannelMessage Text Source #

The ARN of the channel.

deleteChannelMessage_messageId :: Lens' DeleteChannelMessage Text Source #

The ID of the message being deleted.

deleteChannelMessage_chimeBearer :: Lens' DeleteChannelMessage Text Source #

The AppInstanceUserArn of the user that makes the API call.

Destructuring the Response

data DeleteChannelMessageResponse Source #

See: newDeleteChannelMessageResponse smart constructor.

Constructors

DeleteChannelMessageResponse'

Instances

Instances details

Eq DeleteChannelMessageResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage Methods (==) :: DeleteChannelMessageResponse -> DeleteChannelMessageResponse -> Bool # (/=) :: DeleteChannelMessageResponse -> DeleteChannelMessageResponse -> Bool #
Read DeleteChannelMessageResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage Methods readsPrec :: Int -> ReadS DeleteChannelMessageResponse # readList :: ReadS [DeleteChannelMessageResponse] # readPrec :: ReadPrec DeleteChannelMessageResponse # readListPrec :: ReadPrec [DeleteChannelMessageResponse] #
Show DeleteChannelMessageResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage Methods showsPrec :: Int -> DeleteChannelMessageResponse -> ShowS # show :: DeleteChannelMessageResponse -> String # showList :: [DeleteChannelMessageResponse] -> ShowS #
Generic DeleteChannelMessageResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage Associated Types type Rep DeleteChannelMessageResponse :: Type -> Type # Methods from :: DeleteChannelMessageResponse -> Rep DeleteChannelMessageResponse x # to :: Rep DeleteChannelMessageResponse x -> DeleteChannelMessageResponse #
NFData DeleteChannelMessageResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage Methods rnf :: DeleteChannelMessageResponse -> () #
type Rep DeleteChannelMessageResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMessage type Rep DeleteChannelMessageResponse = D1 ('MetaData "DeleteChannelMessageResponse" "Amazonka.ChimeSDKMessaging.DeleteChannelMessage" "libZSservicesZSamazonka-chime-sdk-messagingZSamazonka-chime-sdk-messaging" 'False) (C1 ('MetaCons "DeleteChannelMessageResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteChannelMessageResponse :: DeleteChannelMessageResponse Source #

Create a value of DeleteChannelMessageResponse with all optional fields omitted.

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