| 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.DescribeChannel
Description
Returns the full details of a channel in an Amazon Chime AppInstance.
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 DescribeChannel = DescribeChannel' {
- channelArn :: Text
- chimeBearer :: Text
- newDescribeChannel :: Text -> Text -> DescribeChannel
- describeChannel_channelArn :: Lens' DescribeChannel Text
- describeChannel_chimeBearer :: Lens' DescribeChannel Text
- data DescribeChannelResponse = DescribeChannelResponse' {
- channel :: Maybe Channel
- httpStatus :: Int
- newDescribeChannelResponse :: Int -> DescribeChannelResponse
- describeChannelResponse_channel :: Lens' DescribeChannelResponse (Maybe Channel)
- describeChannelResponse_httpStatus :: Lens' DescribeChannelResponse Int
Creating a Request
data DescribeChannel Source #
See: newDescribeChannel smart constructor.
Constructors
| DescribeChannel' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DescribeChannel |
Create a value of DescribeChannel 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:DescribeChannel', describeChannel_channelArn - The ARN of the channel.
$sel:chimeBearer:DescribeChannel', describeChannel_chimeBearer - The AppInstanceUserArn of the user that makes the API call.
Request Lenses
describeChannel_channelArn :: Lens' DescribeChannel Text Source #
The ARN of the channel.
describeChannel_chimeBearer :: Lens' DescribeChannel Text Source #
The AppInstanceUserArn of the user that makes the API call.
Destructuring the Response
data DescribeChannelResponse Source #
See: newDescribeChannelResponse smart constructor.
Constructors
| DescribeChannelResponse' | |
Fields
| |
Instances
newDescribeChannelResponse Source #
Create a value of DescribeChannelResponse 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:channel:DescribeChannelResponse', describeChannelResponse_channel - The channel details.
$sel:httpStatus:DescribeChannelResponse', describeChannelResponse_httpStatus - The response's http status code.
Response Lenses
describeChannelResponse_channel :: Lens' DescribeChannelResponse (Maybe Channel) Source #
The channel details.
describeChannelResponse_httpStatus :: Lens' DescribeChannelResponse Int Source #
The response's http status code.