deregister_stream_consumer¶
Operation¶
deregister_stream_consumer
¶
deregister_stream_consumer(request: DeregisterStreamConsumerInput | DeregisterStreamConsumerInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeregisterStreamConsumerInputDict]) -> DeregisterStreamConsumerOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeregisterStreamConsumerInput | DeregisterStreamConsumerInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DeregisterStreamConsumerInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeregisterStreamConsumerOutput
|
An instance of |
deregister_stream_consumer
async
¶
deregister_stream_consumer(request: DeregisterStreamConsumerInput | DeregisterStreamConsumerInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeregisterStreamConsumerInputDict]) -> DeregisterStreamConsumerOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeregisterStreamConsumerInput | DeregisterStreamConsumerInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DeregisterStreamConsumerInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeregisterStreamConsumerOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DeregisterStreamConsumerInputDict
¶
Bases: TypedDict
Dictionary form of DeregisterStreamConsumerInput.
Attributes¶
consumer_arn
instance-attribute
¶
consumer_arn: str | None
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.
consumer_name
instance-attribute
¶
consumer_name: str | None
The name that you gave to the consumer.
stream_arn
instance-attribute
¶
stream_arn: str | None
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.
DeregisterStreamConsumerInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeregisterStreamConsumerInput structure.
Attributes¶
consumer_arn
class-attribute
instance-attribute
¶
consumer_arn: str | None = ...
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.
consumer_name
class-attribute
instance-attribute
¶
consumer_name: str | None = ...
The name that you gave to the consumer.
stream_arn
class-attribute
instance-attribute
¶
stream_arn: str | None = ...
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.
Output¶
DeregisterStreamConsumerOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeregisterStreamConsumerOutput structure.