/AWS1/IF_KNS=>DEREGISTERSTREAMCONSUMER()

About DeregisterStreamConsumer

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.

Method Signature

METHODS /AWS1/IF_KNS~DEREGISTERSTREAMCONSUMER
  IMPORTING
    !IV_STREAMARN TYPE /AWS1/KNSSTREAMARN OPTIONAL
    !IV_CONSUMERNAME TYPE /AWS1/KNSCONSUMERNAME OPTIONAL
    !IV_CONSUMERARN TYPE /AWS1/KNSCONSUMERARN OPTIONAL
    !IV_STREAMID TYPE /AWS1/KNSSTREAMID OPTIONAL
  RAISING
    /AWS1/CX_KNSINVALIDARGUMENTEX
    /AWS1/CX_KNSLIMITEXCEEDEDEX
    /AWS1/CX_KNSRESOURCENOTFOUNDEX
    /AWS1/CX_KNSCLIENTEXC
    /AWS1/CX_KNSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_streamarn TYPE /AWS1/KNSSTREAMARN /AWS1/KNSSTREAMARN

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.

iv_consumername TYPE /AWS1/KNSCONSUMERNAME /AWS1/KNSCONSUMERNAME

The name that you gave to the consumer.

iv_consumerarn TYPE /AWS1/KNSCONSUMERARN /AWS1/KNSCONSUMERARN

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.

iv_streamid TYPE /AWS1/KNSSTREAMID /AWS1/KNSSTREAMID

Not Implemented. Reserved for future use.

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

lo_client->deregisterstreamconsumer(
  iv_consumerarn = |string|
  iv_consumername = |string|
  iv_streamarn = |string|
  iv_streamid = |string|
).