Container for the parameters to the DeregisterStreamConsumer operation. 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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.Kinesis.AmazonKinesisRequest
Amazon.Kinesis.Model.DeregisterStreamConsumerRequest
Namespace: Amazon.Kinesis.Model
Assembly: AWSSDK.Kinesis.dll
Version: 3.x.y.z
Syntax
public class DeregisterStreamConsumerRequest : AmazonKinesisRequest IAmazonWebServiceRequest
The DeregisterStreamConsumerRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
DeregisterStreamConsumerRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
ConsumerARN | System.String |
Gets and sets the property ConsumerARN. The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the 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 ARN. |
|
|
ConsumerName | System.String |
Gets and sets the property ConsumerName. The name that you gave to the consumer. |
|
|
StreamARN | System.String |
Gets and sets the property StreamARN. The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5