/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Kinesis::ListStreamConsumers

NAME

Paws::Kinesis::ListStreamConsumers - Arguments for method ListStreamConsumers on Paws::Kinesis

DESCRIPTION

This class represents the parameters used for calling the method ListStreamConsumers on the Amazon Kinesis service. Use the attributes of this class as arguments to method ListStreamConsumers.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListStreamConsumers.

SYNOPSIS

my $kinesis = Paws->service('Kinesis');
my $ListStreamConsumersOutput = $kinesis->ListStreamConsumers(
  StreamARN               => 'MyStreamARN',
  MaxResults              => 1,                        # OPTIONAL
  NextToken               => 'MyNextToken',            # OPTIONAL
  StreamCreationTimestamp => '1970-01-01T01:00:00',    # OPTIONAL
);

# Results:
my $Consumers = $ListStreamConsumersOutput->Consumers;
my $NextToken = $ListStreamConsumersOutput->NextToken;

# Returns a L<Paws::Kinesis::ListStreamConsumersOutput> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/kinesis/ListStreamConsumers

ATTRIBUTES

MaxResults => Int

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

NextToken => Str

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.

REQUIRED StreamARN => Str

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 (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams).

StreamCreationTimestamp => Str

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.

SEE ALSO

This class forms part of Paws, documenting arguments for method ListStreamConsumers in Paws::Kinesis

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues