The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $kinesis = Paws->service('Kinesis');
    my $DescribeStreamConsumerOutput = $kinesis->DescribeStreamConsumer(
      ConsumerARN  => 'MyConsumerARN',     # OPTIONAL
      ConsumerName => 'MyConsumerName',    # OPTIONAL
      StreamARN    => 'MyStreamARN',       # OPTIONAL
    );

    # Results:
    my $ConsumerDescription =
      $DescribeStreamConsumerOutput->ConsumerDescription;

    # Returns a L<Paws::Kinesis::DescribeStreamConsumerOutput> 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/DescribeStreamConsumer

ATTRIBUTES

ConsumerARN => Str

The ARN returned by Kinesis Data Streams when you registered the consumer.

ConsumerName => Str

The name that you gave to the consumer.

StreamARN => Str

The ARN of the Kinesis data stream that the consumer is registered with. 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).

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeStreamConsumer 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