Class: Aws::Kinesis::Types::DeregisterStreamConsumerInput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kinesis/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#consumer_arn ⇒ String

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.

Returns:

  • (String) 


286
287
288
289
290
291
292
 
# File 'lib/aws-sdk-kinesis/types.rb', line 286

class DeregisterStreamConsumerInput < Struct.new(
  :stream_arn,
  :consumer_name,
  :consumer_arn)
  SENSITIVE = []
  include Aws::Structure
end

#consumer_name ⇒ String

The name that you gave to the consumer.

Returns:

  • (String) 


286
287
288
289
290
291
292
 
# File 'lib/aws-sdk-kinesis/types.rb', line 286

class DeregisterStreamConsumerInput < Struct.new(
  :stream_arn,
  :consumer_name,
  :consumer_arn)
  SENSITIVE = []
  include Aws::Structure
end

#stream_arn ⇒ String

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].

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams

Returns:

  • (String) 


286
287
288
289
290
291
292
 
# File 'lib/aws-sdk-kinesis/types.rb', line 286

class DeregisterStreamConsumerInput < Struct.new(
  :stream_arn,
  :consumer_name,
  :consumer_arn)
  SENSITIVE = []
  include Aws::Structure
end