AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
To deregister a consumer, provide its ARN. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its name and ARN.
This operation has a limit of five transactions per second per stream.
For .NET Core this operation is only available in asynchronous form. Please refer to DeregisterStreamConsumerAsync.
Namespace: Amazon.Kinesis
Assembly: AWSSDK.Kinesis.dll
Version: 3.x.y.z
public virtual DeregisterStreamConsumerResponse DeregisterStreamConsumer( DeregisterStreamConsumerRequest request )
Container for the necessary parameters to execute the DeregisterStreamConsumer service method.
| Exception | Condition |
|---|---|
| InvalidArgumentException | A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. |
| LimitExceededException | The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed. |
| ResourceNotFoundException | The requested resource could not be found. The stream might not be specified correctly. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5