| 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.DescribeChannelBan
Description
Returns the full details of a channel ban.
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 DescribeChannelBan = DescribeChannelBan' {
- channelArn :: Text
- memberArn :: Text
- chimeBearer :: Text
- newDescribeChannelBan :: Text -> Text -> Text -> DescribeChannelBan
- describeChannelBan_channelArn :: Lens' DescribeChannelBan Text
- describeChannelBan_memberArn :: Lens' DescribeChannelBan Text
- describeChannelBan_chimeBearer :: Lens' DescribeChannelBan Text
- data DescribeChannelBanResponse = DescribeChannelBanResponse' {}
- newDescribeChannelBanResponse :: Int -> DescribeChannelBanResponse
- describeChannelBanResponse_channelBan :: Lens' DescribeChannelBanResponse (Maybe ChannelBan)
- describeChannelBanResponse_httpStatus :: Lens' DescribeChannelBanResponse Int
Creating a Request
data DescribeChannelBan Source #
See: newDescribeChannelBan smart constructor.
Constructors
| DescribeChannelBan' | |
Fields
| |
Instances
newDescribeChannelBan Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> DescribeChannelBan |
Create a value of DescribeChannelBan 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:DescribeChannelBan', describeChannelBan_channelArn - The ARN of the channel from which the user is banned.
$sel:memberArn:DescribeChannelBan', describeChannelBan_memberArn - The ARN of the member being banned.
$sel:chimeBearer:DescribeChannelBan', describeChannelBan_chimeBearer - The AppInstanceUserArn of the user that makes the API call.
Request Lenses
describeChannelBan_channelArn :: Lens' DescribeChannelBan Text Source #
The ARN of the channel from which the user is banned.
describeChannelBan_memberArn :: Lens' DescribeChannelBan Text Source #
The ARN of the member being banned.
describeChannelBan_chimeBearer :: Lens' DescribeChannelBan Text Source #
The AppInstanceUserArn of the user that makes the API call.
Destructuring the Response
data DescribeChannelBanResponse Source #
See: newDescribeChannelBanResponse smart constructor.
Constructors
| DescribeChannelBanResponse' | |
Fields
| |
Instances
newDescribeChannelBanResponse Source #
Create a value of DescribeChannelBanResponse 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:channelBan:DescribeChannelBanResponse', describeChannelBanResponse_channelBan - The details of the ban.
$sel:httpStatus:DescribeChannelBanResponse', describeChannelBanResponse_httpStatus - The response's http status code.
Response Lenses
describeChannelBanResponse_channelBan :: Lens' DescribeChannelBanResponse (Maybe ChannelBan) Source #
The details of the ban.
describeChannelBanResponse_httpStatus :: Lens' DescribeChannelBanResponse Int Source #
The response's http status code.