Class: Aws::Kinesis::Types::ListStreamConsumersInput

Inherits:

Struct

• Object
• Struct
• Aws::Kinesis::Types::ListStreamConsumersInput

Includes:

Structure

Defined in:

lib/aws-sdk-kinesis/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #max_results ⇒ Integer

  The maximum number of consumers that you want a single call of ‘ListStreamConsumers` to return.

• #next_token ⇒ String

  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 consumers that are registered with the data stream, the response includes a pagination token named `NextToken`.

• #stream_arn ⇒ String

  The ARN of the Kinesis data stream for which you want to list the registered consumers.

• #stream_creation_timestamp ⇒ Time

  Specify this input parameter to distinguish data streams that have the same name.

Instance Attribute Details

#max_results ⇒ Integer

The maximum number of consumers that you want a single call of ‘ListStreamConsumers` to return. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.

Returns:

• (Integer)

# File 'lib/aws-sdk-kinesis/types.rb', line 1226

class ListStreamConsumersInput < Struct.new(
  :stream_arn,
  :next_token,
  :max_results,
  :stream_creation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

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 consumers that are registered with the data stream, 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.

Don’t specify ‘StreamName` or `StreamCreationTimestamp` if you specify `NextToken` because the latter unambiguously identifies the stream.

You can optionally specify a value for the ‘MaxResults` parameter when you specify `NextToken`. If you specify a `MaxResults` value that is less than the number of consumers that the operation returns if you don’t specify ‘MaxResults`, the response will contain a new `NextToken` value. You can use the new `NextToken` value in a subsequent call to the `ListStreamConsumers` operation to list the next set of consumers.

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)

# File 'lib/aws-sdk-kinesis/types.rb', line 1226

class ListStreamConsumersInput < Struct.new(
  :stream_arn,
  :next_token,
  :max_results,
  :stream_creation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#stream_arn ⇒ String

The ARN of the Kinesis data stream for which you want to list the registered consumers. 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)

# File 'lib/aws-sdk-kinesis/types.rb', line 1226

class ListStreamConsumersInput < Struct.new(
  :stream_arn,
  :next_token,
  :max_results,
  :stream_creation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#stream_creation_timestamp ⇒ Time

Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the consumers for.

You can’t specify this parameter if you specify the NextToken parameter.

Returns:

• (Time)

# File 'lib/aws-sdk-kinesis/types.rb', line 1226

class ListStreamConsumersInput < Struct.new(
  :stream_arn,
  :next_token,
  :max_results,
  :stream_creation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end