« blib/lib/Paws/Kinesis/ListShardsOutput.pm
↑ Summary
blib/lib/Paws/Kinesis/ListStreamConsumersOutput.pm »
| 1 | |||
| 2 | package Paws::Kinesis::ListStreamConsumers; | ||
| 3 | use Moose; | ||
| 4 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 5 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 6 | has StreamARN => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has StreamCreationTimestamp => (is => 'ro', isa => 'Str'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListStreamConsumers'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Kinesis::ListStreamConsumersOutput'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Kinesis::ListStreamConsumers - Arguments for method ListStreamConsumers on L<Paws::Kinesis> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method ListStreamConsumers on the | ||
| 25 | L<Amazon Kinesis|Paws::Kinesis> service. Use the attributes of this class | ||
| 26 | as arguments to method ListStreamConsumers. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListStreamConsumers. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $kinesis = Paws->service('Kinesis'); | ||
| 33 | my $ListStreamConsumersOutput = $kinesis->ListStreamConsumers( | ||
| 34 | StreamARN => 'MyStreamARN', | ||
| 35 | MaxResults => 1, # OPTIONAL | ||
| 36 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 37 | StreamCreationTimestamp => '1970-01-01T01:00:00', # OPTIONAL | ||
| 38 | ); | ||
| 39 | |||
| 40 | # Results: | ||
| 41 | my $Consumers = $ListStreamConsumersOutput->Consumers; | ||
| 42 | my $NextToken = $ListStreamConsumersOutput->NextToken; | ||
| 43 | |||
| 44 | # Returns a L<Paws::Kinesis::ListStreamConsumersOutput> object. | ||
| 45 | |||
| 46 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 47 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kinesis/ListStreamConsumers> | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 MaxResults => Int | ||
| 53 | |||
| 54 | The maximum number of consumers that you want a single call of | ||
| 55 | C<ListStreamConsumers> to return. | ||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | =head2 NextToken => Str | ||
| 60 | |||
| 61 | When the number of consumers that are registered with the data stream | ||
| 62 | is greater than the default value for the C<MaxResults> parameter, or | ||
| 63 | if you explicitly specify a value for C<MaxResults> that is less than | ||
| 64 | the number of consumers that are registered with the data stream, the | ||
| 65 | response includes a pagination token named C<NextToken>. You can | ||
| 66 | specify this C<NextToken> value in a subsequent call to | ||
| 67 | C<ListStreamConsumers> to list the next set of registered consumers. | ||
| 68 | |||
| 69 | Don't specify C<StreamName> or C<StreamCreationTimestamp> if you | ||
| 70 | specify C<NextToken> because the latter unambiguously identifies the | ||
| 71 | stream. | ||
| 72 | |||
| 73 | You can optionally specify a value for the C<MaxResults> parameter when | ||
| 74 | you specify C<NextToken>. If you specify a C<MaxResults> value that is | ||
| 75 | less than the number of consumers that the operation returns if you | ||
| 76 | don't specify C<MaxResults>, the response will contain a new | ||
| 77 | C<NextToken> value. You can use the new C<NextToken> value in a | ||
| 78 | subsequent call to the C<ListStreamConsumers> operation to list the | ||
| 79 | next set of consumers. | ||
| 80 | |||
| 81 | Tokens expire after 300 seconds. When you obtain a value for | ||
| 82 | C<NextToken> in the response to a call to C<ListStreamConsumers>, you | ||
| 83 | have 300 seconds to use that value. If you specify an expired token in | ||
| 84 | a call to C<ListStreamConsumers>, you get C<ExpiredNextTokenException>. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 B<REQUIRED> StreamARN => Str | ||
| 89 | |||
| 90 | The ARN of the Kinesis data stream for which you want to list the | ||
| 91 | registered consumers. For more information, see Amazon Resource Names | ||
| 92 | (ARNs) and AWS Service Namespaces | ||
| 93 | (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams). | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 StreamCreationTimestamp => Str | ||
| 98 | |||
| 99 | Specify this input parameter to distinguish data streams that have the | ||
| 100 | same name. For example, if you create a data stream and then delete it, | ||
| 101 | and you later create another data stream with the same name, you can | ||
| 102 | use this input parameter to specify which of the two streams you want | ||
| 103 | to list the consumers for. | ||
| 104 | |||
| 105 | You can't specify this parameter if you specify the NextToken | ||
| 106 | parameter. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head1 SEE ALSO | ||
| 112 | |||
| 113 | This class forms part of L<Paws>, documenting arguments for method ListStreamConsumers in L<Paws::Kinesis> | ||
| 114 | |||
| 115 | =head1 BUGS and CONTRIBUTIONS | ||
| 116 | |||
| 117 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 118 | |||
| 119 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 120 | |||
| 121 | =cut | ||
| 122 |