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.ChimeSDKMessaging.GetChannelMessageStatus

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets message status for a specified messageId. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to retrieving message status if the event was not received because a client wasn't connected to a websocket.

Messages can have any one of these statuses.

SENT: Message processed successfully
PENDING: Ongoing processing
FAILED: Processing failed
DENIED: Messasge denied by the processor

This API does not return statuses for denied messages, because we don't store them once the processor denies them.
Only the message sender can invoke this API.
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

Creating a Request

data GetChannelMessageStatus Source #

See: newGetChannelMessageStatus smart constructor.

Constructors

GetChannelMessageStatus'
Fields subChannelId :: Maybe Text The ID of the SubChannel in the request. Only required when getting message status in a SubChannel that the user belongs to. channelArn :: Text The ARN of the channel messageId :: Text The ID of the message. chimeBearer :: Text The `AppInstanceUserArn` of the user making the API call.

Instances

Instances details

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

newGetChannelMessageStatus Source #

Arguments

:: Text	`GetChannelMessageStatus`
-> Text	`GetChannelMessageStatus`
-> Text	`$sel:chimeBearer:GetChannelMessageStatus'`
-> GetChannelMessageStatus

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

GetChannelMessageStatus, getChannelMessageStatus_subChannelId - The ID of the SubChannel in the request.

Only required when getting message status in a SubChannel that the user belongs to.

GetChannelMessageStatus, getChannelMessageStatus_channelArn - The ARN of the channel

GetChannelMessageStatus, getChannelMessageStatus_messageId - The ID of the message.

$sel:chimeBearer:GetChannelMessageStatus', getChannelMessageStatus_chimeBearer - The AppInstanceUserArn of the user making the API call.

Request Lenses

getChannelMessageStatus_subChannelId :: Lens' GetChannelMessageStatus (Maybe Text) Source #

The ID of the SubChannel in the request.

Only required when getting message status in a SubChannel that the user belongs to.

getChannelMessageStatus_channelArn :: Lens' GetChannelMessageStatus Text Source #

The ARN of the channel

getChannelMessageStatus_messageId :: Lens' GetChannelMessageStatus Text Source #

The ID of the message.

getChannelMessageStatus_chimeBearer :: Lens' GetChannelMessageStatus Text Source #

The AppInstanceUserArn of the user making the API call.

Destructuring the Response

data GetChannelMessageStatusResponse Source #

See: newGetChannelMessageStatusResponse smart constructor.

Constructors

GetChannelMessageStatusResponse'
Fields status :: Maybe ChannelMessageStatusStructure The message status and details. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetChannelMessageStatusResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.GetChannelMessageStatus Associated Types type Rep GetChannelMessageStatusResponse :: Type -> Type # Methods from :: GetChannelMessageStatusResponse -> Rep GetChannelMessageStatusResponse x # to :: Rep GetChannelMessageStatusResponse x -> GetChannelMessageStatusResponse #
Read GetChannelMessageStatusResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.GetChannelMessageStatus Methods readsPrec :: Int -> ReadS GetChannelMessageStatusResponse # readList :: ReadS [GetChannelMessageStatusResponse] # readPrec :: ReadPrec GetChannelMessageStatusResponse # readListPrec :: ReadPrec [GetChannelMessageStatusResponse] #
Show GetChannelMessageStatusResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.GetChannelMessageStatus Methods showsPrec :: Int -> GetChannelMessageStatusResponse -> ShowS # show :: GetChannelMessageStatusResponse -> String # showList :: [GetChannelMessageStatusResponse] -> ShowS #
NFData GetChannelMessageStatusResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.GetChannelMessageStatus Methods rnf :: GetChannelMessageStatusResponse -> () #
Eq GetChannelMessageStatusResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.GetChannelMessageStatus Methods (==) :: GetChannelMessageStatusResponse -> GetChannelMessageStatusResponse -> Bool # (/=) :: GetChannelMessageStatusResponse -> GetChannelMessageStatusResponse -> Bool #
type Rep GetChannelMessageStatusResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.GetChannelMessageStatus type Rep GetChannelMessageStatusResponse = D1 ('MetaData "GetChannelMessageStatusResponse" "Amazonka.ChimeSDKMessaging.GetChannelMessageStatus" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "GetChannelMessageStatusResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelMessageStatusStructure)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetChannelMessageStatusResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetChannelMessageStatusResponse'`
-> GetChannelMessageStatusResponse

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

GetChannelMessageStatusResponse, getChannelMessageStatusResponse_status - The message status and details.

$sel:httpStatus:GetChannelMessageStatusResponse', getChannelMessageStatusResponse_httpStatus - The response's http status code.

Response Lenses

getChannelMessageStatusResponse_status :: Lens' GetChannelMessageStatusResponse (Maybe ChannelMessageStatusStructure) Source #

The message status and details.

getChannelMessageStatusResponse_httpStatus :: Lens' GetChannelMessageStatusResponse Int Source #

The response's http status code.