Amazonka.ChimeSDKMessaging.CreateChannelBan

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.

Creating a Request

data CreateChannelBan

See: newCreateChannelBan smart constructor.

Constructors

CreateChannelBan'

Fields

• channelArn :: Text

  The ARN of the ban request.

• memberArn :: Text

  The AppInstanceUserArn of the member being banned.

• chimeBearer :: Text

  The AppInstanceUserArn of the user that makes the API call.

Instances

ToJSON CreateChannelBan

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

Methods

toJSON :: CreateChannelBan -> Value

toEncoding :: CreateChannelBan -> Encoding

toJSONList :: [CreateChannelBan] -> Value

toEncodingList :: [CreateChannelBan] -> Encoding

ToHeaders CreateChannelBan

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

Methods

toHeaders :: CreateChannelBan -> [Header]

ToPath CreateChannelBan

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

Methods

toPath :: CreateChannelBan -> ByteString

ToQuery CreateChannelBan

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

Methods

toQuery :: CreateChannelBan -> QueryString

AWSRequest CreateChannelBan

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

Associated Types

type AWSResponse CreateChannelBan

Methods

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

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

Generic CreateChannelBan

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

Associated Types

type Rep CreateChannelBan :: Type -> Type

Methods

from :: CreateChannelBan -> Rep CreateChannelBan x

to :: Rep CreateChannelBan x -> CreateChannelBan

Read CreateChannelBan

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

Methods

readsPrec :: Int -> ReadS CreateChannelBan

readList :: ReadS [CreateChannelBan]

readPrec :: ReadPrec CreateChannelBan

readListPrec :: ReadPrec [CreateChannelBan]

Show CreateChannelBan

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

Methods

showsPrec :: Int -> CreateChannelBan -> ShowS

show :: CreateChannelBan -> String

showList :: [CreateChannelBan] -> ShowS

NFData CreateChannelBan

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

Methods

rnf :: CreateChannelBan -> ()

Eq CreateChannelBan

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

Methods

(==) :: CreateChannelBan -> CreateChannelBan -> Bool

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

Hashable CreateChannelBan

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

Methods

hashWithSalt :: Int -> CreateChannelBan -> Int

hash :: CreateChannelBan -> Int

type AWSResponse CreateChannelBan

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

type AWSResponse CreateChannelBan = CreateChannelBanResponse

type Rep CreateChannelBan

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

type Rep CreateChannelBan = D1 ('MetaData "CreateChannelBan" "Amazonka.ChimeSDKMessaging.CreateChannelBan" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" '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))))

newCreateChannelBan

Arguments

:: Text

CreateChannelBan

-> Text

CreateChannelBan

-> Text

$sel:chimeBearer:CreateChannelBan'

-> CreateChannelBan

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:

CreateChannelBan, createChannelBan_channelArn - The ARN of the ban request.

CreateChannelBan, createChannelBan_memberArn - The AppInstanceUserArn of the member being banned.

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

Request Lenses

createChannelBan_channelArn :: Lens' CreateChannelBan Text

The ARN of the ban request.

createChannelBan_memberArn :: Lens' CreateChannelBan Text

The AppInstanceUserArn of the member being banned.

createChannelBan_chimeBearer :: Lens' CreateChannelBan Text

The AppInstanceUserArn of the user that makes the API call.

Destructuring the Response

data CreateChannelBanResponse

See: newCreateChannelBanResponse smart constructor.

Constructors

CreateChannelBanResponse'

Fields

• channelArn :: Maybe Text

  The ARN of the response to the ban request.

• member :: Maybe Identity

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateChannelBanResponse

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

Associated Types

type Rep CreateChannelBanResponse :: Type -> Type

Methods

from :: CreateChannelBanResponse -> Rep CreateChannelBanResponse x

to :: Rep CreateChannelBanResponse x -> CreateChannelBanResponse

Show CreateChannelBanResponse

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

Methods

showsPrec :: Int -> CreateChannelBanResponse -> ShowS

show :: CreateChannelBanResponse -> String

showList :: [CreateChannelBanResponse] -> ShowS

NFData CreateChannelBanResponse

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

Methods

rnf :: CreateChannelBanResponse -> ()

Eq CreateChannelBanResponse

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

Methods

(==) :: CreateChannelBanResponse -> CreateChannelBanResponse -> Bool

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

type Rep CreateChannelBanResponse

Defined in Amazonka.ChimeSDKMessaging.CreateChannelBan

type Rep CreateChannelBanResponse = D1 ('MetaData "CreateChannelBanResponse" "Amazonka.ChimeSDKMessaging.CreateChannelBan" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" '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

Arguments

:: Int

$sel:httpStatus:CreateChannelBanResponse'

-> CreateChannelBanResponse

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:

CreateChannelBan, createChannelBanResponse_channelArn - The ARN of the response to the ban request.

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)

The ARN of the response to the ban request.

createChannelBanResponse_member :: Lens' CreateChannelBanResponse (Maybe Identity)

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

createChannelBanResponse_httpStatus :: Lens' CreateChannelBanResponse Int

The response's http status code.