DisassociateChannelFlowCommand

Suggest an Edit

Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop going through the channel flow processor.

Only administrators or channel moderators can disassociate a channel flow.

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 Syntax

Use a bare-bones client and the command you need to make an API call.

import { ChimeSDKMessagingClient, DisassociateChannelFlowCommand } from "@aws-sdk/client-chime-sdk-messaging"; // ES Modules import
// const { ChimeSDKMessagingClient, DisassociateChannelFlowCommand } = require("@aws-sdk/client-chime-sdk-messaging"); // CommonJS import
const client = new ChimeSDKMessagingClient(config);
const input = { // DisassociateChannelFlowRequest
  ChannelArn: "STRING_VALUE", // required
  ChannelFlowArn: "STRING_VALUE", // required
  ChimeBearer: "STRING_VALUE", // required
};
const command = new DisassociateChannelFlowCommand(input);
const response = await client.send(command);
// {};

DisassociateChannelFlowCommand Input

See DisassociateChannelFlowCommandInput for more details

Parameter
Type
Description
ChannelArn
Required
string | undefined

The ARN of the channel.

ChannelFlowArn
Required
string | undefined

The ARN of the channel flow.

ChimeBearer
Required
string | undefined

The AppInstanceUserArn of the user making the API call.

DisassociateChannelFlowCommand Output

See DisassociateChannelFlowCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

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.

NotFoundException
client

One or more of the resources in the request does not exist in the system.

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.