You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Kinesis::Types::ListStreamConsumersInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::Kinesis::Types::ListStreamConsumersInput
- Defined in:
- (unknown)
Overview
When passing ListStreamConsumersInput as input to an Aws::Client method, you can use a vanilla Hash:
{
stream_arn: "StreamARN", # required
next_token: "NextToken",
max_results: 1,
stream_creation_timestamp: Time.now,
}
Instance Attribute Summary collapse
-
#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 forMaxResults
that is less than the number of consumers that are registered with the data stream, the response includes a pagination token namedNextToken
. -
#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.
#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.
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
.
#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 AWS Service Namespaces.
#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.