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 { PutChannelMembershipPreferencesRequest, PutChannelMembershipPreferencesResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link PutChannelMembershipPreferencesCommand}. */ export interface PutChannelMembershipPreferencesCommandInput extends PutChannelMembershipPreferencesRequest { } /** * @public * * The output of {@link PutChannelMembershipPreferencesCommand}. */ export interface PutChannelMembershipPreferencesCommandOutput extends PutChannelMembershipPreferencesResponse, __MetadataBearer { } declare const PutChannelMembershipPreferencesCommand_base: { new (input: PutChannelMembershipPreferencesCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: PutChannelMembershipPreferencesCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Sets the membership preferences of an AppInstanceUser or AppInstanceBot * for the specified channel. The user or bot must be a member of the channel. Only the user or bot who owns the * membership can set preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't set * preferences for other users. Banned users or bots can't set membership preferences for the channel from * which they are banned.

* *

The x-amz-chime-bearer request header is mandatory. Use the ARN of an * 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, PutChannelMembershipPreferencesCommand } from "@aws-sdk/client-chime-sdk-messaging"; // ES Modules import * // const { ChimeSDKMessagingClient, PutChannelMembershipPreferencesCommand } = 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 = { // PutChannelMembershipPreferencesRequest * ChannelArn: "STRING_VALUE", // required * MemberArn: "STRING_VALUE", // required * ChimeBearer: "STRING_VALUE", // required * Preferences: { // ChannelMembershipPreferences * PushNotifications: { // PushNotificationPreferences * AllowNotifications: "ALL" || "NONE" || "FILTERED", // required * FilterRule: "STRING_VALUE", * }, * }, * }; * const command = new PutChannelMembershipPreferencesCommand(input); * const response = await client.send(command); * // { // PutChannelMembershipPreferencesResponse * // ChannelArn: "STRING_VALUE", * // Member: { // Identity * // Arn: "STRING_VALUE", * // Name: "STRING_VALUE", * // }, * // Preferences: { // ChannelMembershipPreferences * // PushNotifications: { // PushNotificationPreferences * // AllowNotifications: "ALL" || "NONE" || "FILTERED", // required * // FilterRule: "STRING_VALUE", * // }, * // }, * // }; * * ``` * * @param PutChannelMembershipPreferencesCommandInput - {@link PutChannelMembershipPreferencesCommandInput} * @returns {@link PutChannelMembershipPreferencesCommandOutput} * @see {@link PutChannelMembershipPreferencesCommandInput} for command's `input` shape. * @see {@link PutChannelMembershipPreferencesCommandOutput} 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 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 PutChannelMembershipPreferencesCommand extends PutChannelMembershipPreferencesCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: PutChannelMembershipPreferencesRequest; output: PutChannelMembershipPreferencesResponse; }; sdk: { input: PutChannelMembershipPreferencesCommandInput; output: PutChannelMembershipPreferencesCommandOutput; }; }; }