NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $kinesis = Paws->service('Kinesis');
    my $SubscribeToShardOutput = $kinesis->SubscribeToShard(
      ConsumerARN      => 'MyConsumerARN',
      ShardId          => 'MyShardId',
      StartingPosition => {
        Type => 'AT_SEQUENCE_NUMBER'
        , # values: AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST, AT_TIMESTAMP
        SequenceNumber => 'MySequenceNumber',       # OPTIONAL
        Timestamp      => '1970-01-01T01:00:00',    # OPTIONAL
      },

    );

    # Results:
    my $EventStream = $SubscribeToShardOutput->EventStream;

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

ATTRIBUTES

REQUIRED ConsumerARN => Str

For this parameter, use the value you obtained when you called RegisterStreamConsumer.

REQUIRED ShardId => Str

The ID of the shard you want to subscribe to. To see a list of all the shards for a given stream, use ListShards.

REQUIRED StartingPosition => Paws::Kinesis::StartingPosition

SEE ALSO

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