| 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.DescribeChannelMembership
Description
Returns the full details of a user's channel membership.
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 DescribeChannelMembership = DescribeChannelMembership' {
- channelArn :: Text
- memberArn :: Text
- chimeBearer :: Text
- newDescribeChannelMembership :: Text -> Text -> Text -> DescribeChannelMembership
- describeChannelMembership_channelArn :: Lens' DescribeChannelMembership Text
- describeChannelMembership_memberArn :: Lens' DescribeChannelMembership Text
- describeChannelMembership_chimeBearer :: Lens' DescribeChannelMembership Text
- data DescribeChannelMembershipResponse = DescribeChannelMembershipResponse' {}
- newDescribeChannelMembershipResponse :: Int -> DescribeChannelMembershipResponse
- describeChannelMembershipResponse_channelMembership :: Lens' DescribeChannelMembershipResponse (Maybe ChannelMembership)
- describeChannelMembershipResponse_httpStatus :: Lens' DescribeChannelMembershipResponse Int
Creating a Request
data DescribeChannelMembership Source #
See: newDescribeChannelMembership smart constructor.
Constructors
| DescribeChannelMembership' | |
Fields
| |
Instances
newDescribeChannelMembership Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> DescribeChannelMembership |
Create a value of DescribeChannelMembership 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:DescribeChannelMembership', describeChannelMembership_channelArn - The ARN of the channel.
$sel:memberArn:DescribeChannelMembership', describeChannelMembership_memberArn - The ARN of the member.
$sel:chimeBearer:DescribeChannelMembership', describeChannelMembership_chimeBearer - The AppInstanceUserArn of the user that makes the API call.
Request Lenses
describeChannelMembership_channelArn :: Lens' DescribeChannelMembership Text Source #
The ARN of the channel.
describeChannelMembership_memberArn :: Lens' DescribeChannelMembership Text Source #
The ARN of the member.
describeChannelMembership_chimeBearer :: Lens' DescribeChannelMembership Text Source #
The AppInstanceUserArn of the user that makes the API call.
Destructuring the Response
data DescribeChannelMembershipResponse Source #
See: newDescribeChannelMembershipResponse smart constructor.
Constructors
| DescribeChannelMembershipResponse' | |
Fields
| |
Instances
newDescribeChannelMembershipResponse Source #
Arguments
| :: Int | |
| -> DescribeChannelMembershipResponse |
Create a value of DescribeChannelMembershipResponse 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:channelMembership:DescribeChannelMembershipResponse', describeChannelMembershipResponse_channelMembership - The details of the membership.
$sel:httpStatus:DescribeChannelMembershipResponse', describeChannelMembershipResponse_httpStatus - The response's http status code.
Response Lenses
describeChannelMembershipResponse_channelMembership :: Lens' DescribeChannelMembershipResponse (Maybe ChannelMembership) Source #
The details of the membership.
describeChannelMembershipResponse_httpStatus :: Lens' DescribeChannelMembershipResponse Int Source #
The response's http status code.