libZSservicesZSamazonka-chime-sdk-messagingZSamazonka-chime-sdk-messaging
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ChimeSDKMessaging.CreateChannelBan

Description

Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels.

If you ban a user who is already part of a channel, that user is automatically kicked from the 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

Creating a Request

data CreateChannelBan Source #

See: newCreateChannelBan smart constructor.

Constructors

CreateChannelBan' 

Fields

Instances

Instances details
Eq CreateChannelBan Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

Read CreateChannelBan Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

Show CreateChannelBan Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

Generic CreateChannelBan Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

Associated Types

type Rep CreateChannelBan :: Type -> Type #

NFData CreateChannelBan Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

Methods

rnf :: CreateChannelBan -> () #

Hashable CreateChannelBan Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

ToJSON CreateChannelBan Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

AWSRequest CreateChannelBan Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

Associated Types

type AWSResponse CreateChannelBan #

ToHeaders CreateChannelBan Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

ToPath CreateChannelBan Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

ToQuery CreateChannelBan Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

type Rep CreateChannelBan Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

type Rep CreateChannelBan = D1 ('MetaData "CreateChannelBan" "Amazonka.ChimeSDKMessaging.CreateChannelBan" "libZSservicesZSamazonka-chime-sdk-messagingZSamazonka-chime-sdk-messaging" 'False) (C1 ('MetaCons "CreateChannelBan'" 'PrefixI 'True) (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))))
type AWSResponse CreateChannelBan Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

newCreateChannelBan Source #

Create a value of CreateChannelBan 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:CreateChannelBan', createChannelBan_channelArn - The ARN of the ban request.

$sel:memberArn:CreateChannelBan', createChannelBan_memberArn - The ARN of the member being banned.

$sel:chimeBearer:CreateChannelBan', createChannelBan_chimeBearer - The AppInstanceUserArn of the user that makes the API call.

Request Lenses

createChannelBan_memberArn :: Lens' CreateChannelBan Text Source #

The ARN of the member being banned.

createChannelBan_chimeBearer :: Lens' CreateChannelBan Text Source #

The AppInstanceUserArn of the user that makes the API call.

Destructuring the Response

data CreateChannelBanResponse Source #

See: newCreateChannelBanResponse smart constructor.

Constructors

CreateChannelBanResponse' 

Fields

Instances

Instances details
Eq CreateChannelBanResponse Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

Show CreateChannelBanResponse Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

Generic CreateChannelBanResponse Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

Associated Types

type Rep CreateChannelBanResponse :: Type -> Type #

NFData CreateChannelBanResponse Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

type Rep CreateChannelBanResponse Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

type Rep CreateChannelBanResponse = D1 ('MetaData "CreateChannelBanResponse" "Amazonka.ChimeSDKMessaging.CreateChannelBan" "libZSservicesZSamazonka-chime-sdk-messagingZSamazonka-chime-sdk-messaging" 'False) (C1 ('MetaCons "CreateChannelBanResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "member") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Identity)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateChannelBanResponse Source #

Create a value of CreateChannelBanResponse 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:CreateChannelBan', createChannelBanResponse_channelArn - The ARN of the response to the ban request.

$sel:member:CreateChannelBanResponse', createChannelBanResponse_member - The ChannelArn and BannedIdentity of the member in the ban response.

$sel:httpStatus:CreateChannelBanResponse', createChannelBanResponse_httpStatus - The response's http status code.

Response Lenses

createChannelBanResponse_channelArn :: Lens' CreateChannelBanResponse (Maybe Text) Source #

The ARN of the response to the ban request.

createChannelBanResponse_member :: Lens' CreateChannelBanResponse (Maybe Identity) Source #

The ChannelArn and BannedIdentity of the member in the ban response.