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

NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $kinesis = Paws->service('Kinesis');
my $ListShardsOutput = $kinesis->ListShards(
  ExclusiveStartShardId => 'MyShardId',      # OPTIONAL
  MaxResults            => 1,                # OPTIONAL
  NextToken             => 'MyNextToken',    # OPTIONAL
  ShardFilter           => {
    Type => 'AFTER_SHARD_ID'
    , # values: AFTER_SHARD_ID, AT_TRIM_HORIZON, FROM_TRIM_HORIZON, AT_LATEST, AT_TIMESTAMP, FROM_TIMESTAMP
    ShardId   => 'MyShardId',              # min: 1, max: 128
    Timestamp => '1970-01-01T01:00:00',    # OPTIONAL
  },    # OPTIONAL
  StreamCreationTimestamp => '1970-01-01T01:00:00',    # OPTIONAL
  StreamName              => 'MyStreamName',           # OPTIONAL
);

# Results:
my $NextToken = $ListShardsOutput->NextToken;
my $Shards    = $ListShardsOutput->Shards;

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

ATTRIBUTES

ExclusiveStartShardId => Str

Specify this parameter to indicate that you want to list the shards starting with the shard whose ID immediately follows ExclusiveStartShardId.

If you don't specify this parameter, the default behavior is for ListShards to list the shards starting with the first one in the stream.

You cannot specify this parameter if you specify NextToken.

MaxResults => Int

The maximum number of shards to return in a single call to ListShards. The minimum value you can specify for this parameter is 1, and the maximum is 10,000, which is also the default.

When the number of shards to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListShards to list the next set of shards.

NextToken => Str

When the number of shards in 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 shards in the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListShards to list the next set of shards.

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 shards 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 ListShards operation.

Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListShards, you have 300 seconds to use that value. If you specify an expired token in a call to ListShards, you get ExpiredNextTokenException.

ShardFilter => Paws::Kinesis::ShardFilter

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 shards for.

You cannot specify this parameter if you specify the NextToken parameter.

StreamName => Str

The name of the data stream whose shards you want to list.

You cannot specify this parameter if you specify the NextToken parameter.

SEE ALSO

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