| 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.DeleteChannelMembership
Description
Removes a member from a channel.
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 DeleteChannelMembership = DeleteChannelMembership' {
- subChannelId :: Maybe Text
- channelArn :: Text
- memberArn :: Text
- chimeBearer :: Text
- newDeleteChannelMembership :: Text -> Text -> Text -> DeleteChannelMembership
- deleteChannelMembership_subChannelId :: Lens' DeleteChannelMembership (Maybe Text)
- deleteChannelMembership_channelArn :: Lens' DeleteChannelMembership Text
- deleteChannelMembership_memberArn :: Lens' DeleteChannelMembership Text
- deleteChannelMembership_chimeBearer :: Lens' DeleteChannelMembership Text
- data DeleteChannelMembershipResponse = DeleteChannelMembershipResponse' {
- newDeleteChannelMembershipResponse :: DeleteChannelMembershipResponse
Creating a Request
data DeleteChannelMembership Source #
See: newDeleteChannelMembership smart constructor.
Constructors
| DeleteChannelMembership' | |
Fields
| |
Instances
newDeleteChannelMembership Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> DeleteChannelMembership |
Create a value of DeleteChannelMembership 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:
DeleteChannelMembership, deleteChannelMembership_subChannelId - The ID of the SubChannel in the request.
Only for use by moderators.
DeleteChannelMembership, deleteChannelMembership_channelArn - The ARN of the channel from which you want to remove the user.
DeleteChannelMembership, deleteChannelMembership_memberArn - The AppInstanceUserArn of the member that you're removing from the
channel.
$sel:chimeBearer:DeleteChannelMembership', deleteChannelMembership_chimeBearer - The AppInstanceUserArn of the user that makes the API call.
Request Lenses
deleteChannelMembership_subChannelId :: Lens' DeleteChannelMembership (Maybe Text) Source #
The ID of the SubChannel in the request.
Only for use by moderators.
deleteChannelMembership_channelArn :: Lens' DeleteChannelMembership Text Source #
The ARN of the channel from which you want to remove the user.
deleteChannelMembership_memberArn :: Lens' DeleteChannelMembership Text Source #
The AppInstanceUserArn of the member that you're removing from the
channel.
deleteChannelMembership_chimeBearer :: Lens' DeleteChannelMembership Text Source #
The AppInstanceUserArn of the user that makes the API call.
Destructuring the Response
data DeleteChannelMembershipResponse Source #
See: newDeleteChannelMembershipResponse smart constructor.
Constructors
| DeleteChannelMembershipResponse' | |
Instances
| Generic DeleteChannelMembershipResponse Source # | |
Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMembership Associated Types type Rep DeleteChannelMembershipResponse :: Type -> Type # | |
| Read DeleteChannelMembershipResponse Source # | |
| Show DeleteChannelMembershipResponse Source # | |
Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMembership Methods showsPrec :: Int -> DeleteChannelMembershipResponse -> ShowS # | |
| NFData DeleteChannelMembershipResponse Source # | |
Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMembership Methods rnf :: DeleteChannelMembershipResponse -> () # | |
| Eq DeleteChannelMembershipResponse Source # | |
| type Rep DeleteChannelMembershipResponse Source # | |
newDeleteChannelMembershipResponse :: DeleteChannelMembershipResponse Source #
Create a value of DeleteChannelMembershipResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.