You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Kinesis::Types::ListStreamConsumersOutput

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#consumersArray<Types::Consumer>

An array of JSON objects. Each object represents one registered consumer.

Returns:



1144
1145
1146
1147
1148
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 1144

class ListStreamConsumersOutput < Struct.new(
  :consumers,
  :next_token)
  include Aws::Structure
end

#next_tokenString

When the number of consumers that are registered with the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of registered consumers, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListStreamConsumers to list the next set of registered consumers. For more information about the use of this pagination token when calling the ListStreamConsumers operation, see ListStreamConsumersInput$NextToken.

Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListStreamConsumers, you have 300 seconds to use that value. If you specify an expired token in a call to ListStreamConsumers, you get ExpiredNextTokenException.

Returns:

  • (String)


1144
1145
1146
1147
1148
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 1144

class ListStreamConsumersOutput < Struct.new(
  :consumers,
  :next_token)
  include Aws::Structure
end