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

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

Overview

Note:

When making an API call, you may pass DeregisterStreamConsumerInput data as a hash:

{
  stream_arn: "StreamARN",
  consumer_name: "ConsumerName",
  consumer_arn: "ConsumerARN",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#consumer_arnString

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)


266
267
268
269
270
271
272
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 266

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

#consumer_nameString

The name that you gave to the consumer.

Returns:

  • (String)


266
267
268
269
270
271
272
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 266

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

#stream_arnString

The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Returns:

  • (String)


266
267
268
269
270
271
272
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 266

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