import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient"; import type { CreateChannelBanRequest, CreateChannelBanResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link CreateChannelBanCommand}. */ export interface CreateChannelBanCommandInput extends CreateChannelBanRequest { } /** * @public * * The output of {@link CreateChannelBanCommand}. */ export interface CreateChannelBanCommandOutput extends CreateChannelBanResponse, __MetadataBearer { } declare const CreateChannelBanCommand_base: { new (input: CreateChannelBanCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: CreateChannelBanCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

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 * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

*
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ChimeSDKMessagingClient, CreateChannelBanCommand } from "@aws-sdk/client-chime-sdk-messaging"; // ES Modules import * // const { ChimeSDKMessagingClient, CreateChannelBanCommand } = require("@aws-sdk/client-chime-sdk-messaging"); // CommonJS import * // import type { ChimeSDKMessagingClientConfig } from "@aws-sdk/client-chime-sdk-messaging"; * const config = {}; // type is ChimeSDKMessagingClientConfig * const client = new ChimeSDKMessagingClient(config); * const input = { // CreateChannelBanRequest * ChannelArn: "STRING_VALUE", // required * MemberArn: "STRING_VALUE", // required * ChimeBearer: "STRING_VALUE", // required * }; * const command = new CreateChannelBanCommand(input); * const response = await client.send(command); * // { // CreateChannelBanResponse * // ChannelArn: "STRING_VALUE", * // Member: { // Identity * // Arn: "STRING_VALUE", * // Name: "STRING_VALUE", * // }, * // }; * * ``` * * @param CreateChannelBanCommandInput - {@link CreateChannelBanCommandInput} * @returns {@link CreateChannelBanCommandOutput} * @see {@link CreateChannelBanCommandInput} for command's `input` shape. * @see {@link CreateChannelBanCommandOutput} for command's `response` shape. * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape. * * @throws {@link BadRequestException} (client fault) *

The input parameters don't match the service's restrictions.

* * @throws {@link ConflictException} (client fault) *

The request could not be processed because of conflict in the current state of the * resource.

* * @throws {@link ForbiddenException} (client fault) *

The client is permanently forbidden from making the request.

* * @throws {@link ResourceLimitExceededException} (client fault) *

The request exceeds the resource limit.

* * @throws {@link ServiceFailureException} (server fault) *

The service encountered an unexpected error.

* * @throws {@link ServiceUnavailableException} (server fault) *

The service is currently unavailable.

* * @throws {@link ThrottledClientException} (client fault) *

The client exceeded its request rate limit.

* * @throws {@link UnauthorizedClientException} (client fault) *

The client is not currently authorized to make the request.

* * @throws {@link ChimeSDKMessagingServiceException} *

Base exception class for all service exceptions from ChimeSDKMessaging service.

* * * @public */ export declare class CreateChannelBanCommand extends CreateChannelBanCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreateChannelBanRequest; output: CreateChannelBanResponse; }; sdk: { input: CreateChannelBanCommandInput; output: CreateChannelBanCommandOutput; }; }; }