- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeleteChannelCommand
Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.
The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUserArn
or AppInstanceBot
that makes the API call as the value in the header.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ChimeSDKMessagingClient, DeleteChannelCommand } from "@aws-sdk/client-chime-sdk-messaging"; // ES Modules import
// const { ChimeSDKMessagingClient, DeleteChannelCommand } = require("@aws-sdk/client-chime-sdk-messaging"); // CommonJS import
const client = new ChimeSDKMessagingClient(config);
const input = { // DeleteChannelRequest
ChannelArn: "STRING_VALUE", // required
ChimeBearer: "STRING_VALUE", // required
};
const command = new DeleteChannelCommand(input);
const response = await client.send(command);
// {};
DeleteChannelCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
ChannelArn Required | string | undefined | The ARN of the channel being deleted. |
ChimeBearer Required | string | undefined | The ARN of the |
DeleteChannelCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
BadRequestException | client | The input parameters don't match the service's restrictions. |
ConflictException | client | The request could not be processed because of conflict in the current state of the resource. |
ForbiddenException | client | The client is permanently forbidden from making the request. |
ServiceFailureException | server | The service encountered an unexpected error. |
ServiceUnavailableException | server | The service is currently unavailable. |
ThrottledClientException | client | The client exceeded its request rate limit. |
UnauthorizedClientException | client | The client is not currently authorized to make the request. |
ChimeSDKMessagingServiceException | Base exception class for all service exceptions from ChimeSDKMessaging service. |