Amazonka.ChimeSDKMessaging.DeleteChannelMembership

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.

Creating a Request

data DeleteChannelMembership

See: newDeleteChannelMembership smart constructor.

Constructors

DeleteChannelMembership'

Fields

• subChannelId :: Maybe Text

  The ID of the SubChannel in the request.

  Only for use by moderators.

• channelArn :: Text

  The ARN of the channel from which you want to remove the user.

• memberArn :: Text

  The AppInstanceUserArn of the member that you're removing from the channel.

• chimeBearer :: Text

  The AppInstanceUserArn of the user that makes the API call.

Instances

ToHeaders DeleteChannelMembership

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMembership

Methods

toHeaders :: DeleteChannelMembership -> [Header]

ToPath DeleteChannelMembership

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMembership

Methods

toPath :: DeleteChannelMembership -> ByteString

ToQuery DeleteChannelMembership

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMembership

Methods

toQuery :: DeleteChannelMembership -> QueryString

AWSRequest DeleteChannelMembership

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMembership

Associated Types

type AWSResponse DeleteChannelMembership

Methods

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

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

Generic DeleteChannelMembership

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMembership

Associated Types

type Rep DeleteChannelMembership :: Type -> Type

Methods

from :: DeleteChannelMembership -> Rep DeleteChannelMembership x

to :: Rep DeleteChannelMembership x -> DeleteChannelMembership

Read DeleteChannelMembership

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMembership

Methods

readsPrec :: Int -> ReadS DeleteChannelMembership

readList :: ReadS [DeleteChannelMembership]

readPrec :: ReadPrec DeleteChannelMembership

readListPrec :: ReadPrec [DeleteChannelMembership]

Show DeleteChannelMembership

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMembership

Methods

showsPrec :: Int -> DeleteChannelMembership -> ShowS

show :: DeleteChannelMembership -> String

showList :: [DeleteChannelMembership] -> ShowS

NFData DeleteChannelMembership

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMembership

Methods

rnf :: DeleteChannelMembership -> ()

Eq DeleteChannelMembership

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMembership

Methods

(==) :: DeleteChannelMembership -> DeleteChannelMembership -> Bool

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

Hashable DeleteChannelMembership

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMembership

Methods

hashWithSalt :: Int -> DeleteChannelMembership -> Int

hash :: DeleteChannelMembership -> Int

type AWSResponse DeleteChannelMembership

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMembership

type AWSResponse DeleteChannelMembership = DeleteChannelMembershipResponse

type Rep DeleteChannelMembership

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMembership

type Rep DeleteChannelMembership = D1 ('MetaData "DeleteChannelMembership" "Amazonka.ChimeSDKMessaging.DeleteChannelMembership" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "DeleteChannelMembership'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "subChannelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "memberArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "chimeBearer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDeleteChannelMembership

Arguments

:: Text

DeleteChannelMembership

-> Text

DeleteChannelMembership

-> Text

$sel:chimeBearer:DeleteChannelMembership'

-> 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)

The ID of the SubChannel in the request.

Only for use by moderators.

deleteChannelMembership_channelArn :: Lens' DeleteChannelMembership Text

The ARN of the channel from which you want to remove the user.

deleteChannelMembership_memberArn :: Lens' DeleteChannelMembership Text

The AppInstanceUserArn of the member that you're removing from the channel.

deleteChannelMembership_chimeBearer :: Lens' DeleteChannelMembership Text

The AppInstanceUserArn of the user that makes the API call.

Destructuring the Response

data DeleteChannelMembershipResponse

See: newDeleteChannelMembershipResponse smart constructor.

Constructors

DeleteChannelMembershipResponse'

Instances

Generic DeleteChannelMembershipResponse

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMembership

Associated Types

type Rep DeleteChannelMembershipResponse :: Type -> Type

Methods

from :: DeleteChannelMembershipResponse -> Rep DeleteChannelMembershipResponse x

to :: Rep DeleteChannelMembershipResponse x -> DeleteChannelMembershipResponse

Read DeleteChannelMembershipResponse

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMembership

Methods

readsPrec :: Int -> ReadS DeleteChannelMembershipResponse

readList :: ReadS [DeleteChannelMembershipResponse]

readPrec :: ReadPrec DeleteChannelMembershipResponse

readListPrec :: ReadPrec [DeleteChannelMembershipResponse]

Show DeleteChannelMembershipResponse

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMembership

Methods

showsPrec :: Int -> DeleteChannelMembershipResponse -> ShowS

show :: DeleteChannelMembershipResponse -> String

showList :: [DeleteChannelMembershipResponse] -> ShowS

NFData DeleteChannelMembershipResponse

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMembership

Methods

rnf :: DeleteChannelMembershipResponse -> ()

Eq DeleteChannelMembershipResponse

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMembership

Methods

(==) :: DeleteChannelMembershipResponse -> DeleteChannelMembershipResponse -> Bool

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

type Rep DeleteChannelMembershipResponse

Defined in Amazonka.ChimeSDKMessaging.DeleteChannelMembership

type Rep DeleteChannelMembershipResponse = D1 ('MetaData "DeleteChannelMembershipResponse" "Amazonka.ChimeSDKMessaging.DeleteChannelMembership" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "DeleteChannelMembershipResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteChannelMembershipResponse :: DeleteChannelMembershipResponse

Create a value of DeleteChannelMembershipResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.