« blib/lib/Paws/Kinesis/ListStreamConsumers.pm
↑ Summary
blib/lib/Paws/Kinesis/ListStreamsOutput.pm »
| 1 | |||
| 2 | package Paws::Kinesis::ListStreamConsumersOutput; | ||
| 3 | use Moose; | ||
| 4 | has Consumers => (is => 'ro', isa => 'ArrayRef[Paws::Kinesis::Consumer]'); | ||
| 5 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 6 | |||
| 7 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::Kinesis::ListStreamConsumersOutput | ||
| 14 | |||
| 15 | =head1 ATTRIBUTES | ||
| 16 | |||
| 17 | |||
| 18 | =head2 Consumers => ArrayRef[L<Paws::Kinesis::Consumer>] | ||
| 19 | |||
| 20 | An array of JSON objects. Each object represents one registered | ||
| 21 | consumer. | ||
| 22 | |||
| 23 | |||
| 24 | =head2 NextToken => Str | ||
| 25 | |||
| 26 | When the number of consumers that are registered with the data stream | ||
| 27 | is greater than the default value for the C<MaxResults> parameter, or | ||
| 28 | if you explicitly specify a value for C<MaxResults> that is less than | ||
| 29 | the number of registered consumers, the response includes a pagination | ||
| 30 | token named C<NextToken>. You can specify this C<NextToken> value in a | ||
| 31 | subsequent call to C<ListStreamConsumers> to list the next set of | ||
| 32 | registered consumers. For more information about the use of this | ||
| 33 | pagination token when calling the C<ListStreamConsumers> operation, see | ||
| 34 | ListStreamConsumersInput$NextToken. | ||
| 35 | |||
| 36 | Tokens expire after 300 seconds. When you obtain a value for | ||
| 37 | C<NextToken> in the response to a call to C<ListStreamConsumers>, you | ||
| 38 | have 300 seconds to use that value. If you specify an expired token in | ||
| 39 | a call to C<ListStreamConsumers>, you get C<ExpiredNextTokenException>. | ||
| 40 | |||
| 41 | |||
| 42 | =head2 _request_id => Str | ||
| 43 | |||
| 44 | |||
| 45 | =cut | ||
| 46 | |||
| 47 | 1; |