NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $kinesis = Paws->service('Kinesis');
    my $DescribeStreamOutput = $kinesis->DescribeStream(
      StreamName            => 'MyStreamName',
      ExclusiveStartShardId => 'MyShardId',      # OPTIONAL
      Limit                 => 1,                # OPTIONAL
    );

    # Results:
    my $StreamDescription = $DescribeStreamOutput->StreamDescription;

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

ATTRIBUTES

ExclusiveStartShardId => Str

The shard ID of the shard to start with.

Limit => Int

The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 shards are returned.

REQUIRED StreamName => Str

The name of the stream to describe.

SEE ALSO

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