Kafka / Client / delete_channel

delete_channel¶

Kafka.Client.delete_channel(**kwargs)¶

Deletes the channel specified by channelArn from the cluster specified by clusterArn. The channel transitions through DELETING and is removed when the asynchronous delete completes.

Request Syntax

response = client.delete_channel(
    ChannelArn='string',
    ClusterArn='string'
)

Parameters:

ChannelArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) that uniquely identifies the channel.
ClusterArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Return type:

dict

Returns:

Response Syntax

{
    'ChannelArn': 'string',
    'ClusterOperationArn': 'string'
}

Response Structure

(dict) –

Successful response.
- ChannelArn (string) –
  
  The Amazon Resource Name (ARN) that uniquely identifies the channel.
- ClusterOperationArn (string) –
  
  The Amazon Resource Name (ARN) of the cluster operation.

Exceptions

Kafka.Client.exceptions.BadRequestException
Kafka.Client.exceptions.UnauthorizedException
Kafka.Client.exceptions.InternalServerErrorException
Kafka.Client.exceptions.ForbiddenException
Kafka.Client.exceptions.NotFoundException
Kafka.Client.exceptions.ServiceUnavailableException
Kafka.Client.exceptions.TooManyRequestsException