Amazonka.ChimeSDKMessaging.GetChannelMessage

Gets the full details of a channel message.

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 GetChannelMessage

See: newGetChannelMessage smart constructor.

Constructors

GetChannelMessage'

Fields

• subChannelId :: Maybe Text

  The ID of the SubChannel in the request.

  Only required when getting messages 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 that makes the API call.

Instances

ToHeaders GetChannelMessage

Defined in Amazonka.ChimeSDKMessaging.GetChannelMessage

Methods

toHeaders :: GetChannelMessage -> [Header]

ToPath GetChannelMessage

Defined in Amazonka.ChimeSDKMessaging.GetChannelMessage

Methods

toPath :: GetChannelMessage -> ByteString

ToQuery GetChannelMessage

Defined in Amazonka.ChimeSDKMessaging.GetChannelMessage

Methods

toQuery :: GetChannelMessage -> QueryString

AWSRequest GetChannelMessage

Defined in Amazonka.ChimeSDKMessaging.GetChannelMessage

Associated Types

type AWSResponse GetChannelMessage

Methods

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

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

Generic GetChannelMessage

Defined in Amazonka.ChimeSDKMessaging.GetChannelMessage

Associated Types

type Rep GetChannelMessage :: Type -> Type

Methods

from :: GetChannelMessage -> Rep GetChannelMessage x

to :: Rep GetChannelMessage x -> GetChannelMessage

Read GetChannelMessage

Defined in Amazonka.ChimeSDKMessaging.GetChannelMessage

Methods

readsPrec :: Int -> ReadS GetChannelMessage

readList :: ReadS [GetChannelMessage]

readPrec :: ReadPrec GetChannelMessage

readListPrec :: ReadPrec [GetChannelMessage]

Show GetChannelMessage

Defined in Amazonka.ChimeSDKMessaging.GetChannelMessage

Methods

showsPrec :: Int -> GetChannelMessage -> ShowS

show :: GetChannelMessage -> String

showList :: [GetChannelMessage] -> ShowS

NFData GetChannelMessage

Defined in Amazonka.ChimeSDKMessaging.GetChannelMessage

Methods

rnf :: GetChannelMessage -> ()

Eq GetChannelMessage

Defined in Amazonka.ChimeSDKMessaging.GetChannelMessage

Methods

(==) :: GetChannelMessage -> GetChannelMessage -> Bool

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

Hashable GetChannelMessage

Defined in Amazonka.ChimeSDKMessaging.GetChannelMessage

Methods

hashWithSalt :: Int -> GetChannelMessage -> Int

hash :: GetChannelMessage -> Int

type AWSResponse GetChannelMessage

Defined in Amazonka.ChimeSDKMessaging.GetChannelMessage

type AWSResponse GetChannelMessage = GetChannelMessageResponse

type Rep GetChannelMessage

Defined in Amazonka.ChimeSDKMessaging.GetChannelMessage

type Rep GetChannelMessage = D1 ('MetaData "GetChannelMessage" "Amazonka.ChimeSDKMessaging.GetChannelMessage" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "GetChannelMessage'" '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))))

newGetChannelMessage

Arguments

:: Text

GetChannelMessage

-> Text

GetChannelMessage

-> Text

$sel:chimeBearer:GetChannelMessage'

-> GetChannelMessage

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

GetChannelMessage, getChannelMessage_subChannelId - The ID of the SubChannel in the request.

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

GetChannelMessage, getChannelMessage_channelArn - The ARN of the channel.

GetChannelMessage, getChannelMessage_messageId - The ID of the message.

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

Request Lenses

getChannelMessage_subChannelId :: Lens' GetChannelMessage (Maybe Text)

The ID of the SubChannel in the request.

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

getChannelMessage_channelArn :: Lens' GetChannelMessage Text

The ARN of the channel.

getChannelMessage_messageId :: Lens' GetChannelMessage Text

The ID of the message.

getChannelMessage_chimeBearer :: Lens' GetChannelMessage Text

The AppInstanceUserArn of the user that makes the API call.

Destructuring the Response

data GetChannelMessageResponse

See: newGetChannelMessageResponse smart constructor.

Constructors

GetChannelMessageResponse'

Fields

• channelMessage :: Maybe ChannelMessage

  The details of and content in the message.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetChannelMessageResponse

Defined in Amazonka.ChimeSDKMessaging.GetChannelMessage

Associated Types

type Rep GetChannelMessageResponse :: Type -> Type

Methods

from :: GetChannelMessageResponse -> Rep GetChannelMessageResponse x

to :: Rep GetChannelMessageResponse x -> GetChannelMessageResponse

Show GetChannelMessageResponse

Defined in Amazonka.ChimeSDKMessaging.GetChannelMessage

Methods

showsPrec :: Int -> GetChannelMessageResponse -> ShowS

show :: GetChannelMessageResponse -> String

showList :: [GetChannelMessageResponse] -> ShowS

NFData GetChannelMessageResponse

Defined in Amazonka.ChimeSDKMessaging.GetChannelMessage

Methods

rnf :: GetChannelMessageResponse -> ()

Eq GetChannelMessageResponse

Defined in Amazonka.ChimeSDKMessaging.GetChannelMessage

Methods

(==) :: GetChannelMessageResponse -> GetChannelMessageResponse -> Bool

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

type Rep GetChannelMessageResponse

Defined in Amazonka.ChimeSDKMessaging.GetChannelMessage

type Rep GetChannelMessageResponse = D1 ('MetaData "GetChannelMessageResponse" "Amazonka.ChimeSDKMessaging.GetChannelMessage" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "GetChannelMessageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channelMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelMessage)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetChannelMessageResponse

Arguments

:: Int

$sel:httpStatus:GetChannelMessageResponse'

-> GetChannelMessageResponse

Create a value of GetChannelMessageResponse 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:channelMessage:GetChannelMessageResponse', getChannelMessageResponse_channelMessage - The details of and content in the message.

$sel:httpStatus:GetChannelMessageResponse', getChannelMessageResponse_httpStatus - The response's http status code.

Response Lenses

getChannelMessageResponse_channelMessage :: Lens' GetChannelMessageResponse (Maybe ChannelMessage)

The details of and content in the message.

getChannelMessageResponse_httpStatus :: Lens' GetChannelMessageResponse Int

The response's http status code.