« blib/lib/Paws/Kinesis/StreamDescriptionSummary.pm
↑ Summary
blib/lib/Paws/Kinesis/SubscribeToShardEvent.pm »
| 1 | |||
| 2 | package Paws::Kinesis::SubscribeToShard; | ||
| 3 | use Moose; | ||
| 4 | has ConsumerARN => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has ShardId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has StartingPosition => (is => 'ro', isa => 'Paws::Kinesis::StartingPosition', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SubscribeToShard'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Kinesis::SubscribeToShardOutput'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::Kinesis::SubscribeToShard - Arguments for method SubscribeToShard on L<Paws::Kinesis> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method SubscribeToShard on the | ||
| 24 | L<Amazon Kinesis|Paws::Kinesis> service. Use the attributes of this class | ||
| 25 | as arguments to method SubscribeToShard. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SubscribeToShard. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $kinesis = Paws->service('Kinesis'); | ||
| 32 | my $SubscribeToShardOutput = $kinesis->SubscribeToShard( | ||
| 33 | ConsumerARN => 'MyConsumerARN', | ||
| 34 | ShardId => 'MyShardId', | ||
| 35 | StartingPosition => { | ||
| 36 | Type => 'AT_SEQUENCE_NUMBER' | ||
| 37 | , # values: AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST, AT_TIMESTAMP | ||
| 38 | SequenceNumber => 'MySequenceNumber', # OPTIONAL | ||
| 39 | Timestamp => '1970-01-01T01:00:00', # OPTIONAL | ||
| 40 | }, | ||
| 41 | |||
| 42 | ); | ||
| 43 | |||
| 44 | # Results: | ||
| 45 | my $EventStream = $SubscribeToShardOutput->EventStream; | ||
| 46 | |||
| 47 | # Returns a L<Paws::Kinesis::SubscribeToShardOutput> object. | ||
| 48 | |||
| 49 | 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. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kinesis/SubscribeToShard> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> ConsumerARN => Str | ||
| 56 | |||
| 57 | For this parameter, use the value you obtained when you called | ||
| 58 | RegisterStreamConsumer. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> ShardId => Str | ||
| 63 | |||
| 64 | The ID of the shard you want to subscribe to. To see a list of all the | ||
| 65 | shards for a given stream, use ListShards. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> StartingPosition => L<Paws::Kinesis::StartingPosition> | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head1 SEE ALSO | ||
| 77 | |||
| 78 | This class forms part of L<Paws>, documenting arguments for method SubscribeToShard in L<Paws::Kinesis> | ||
| 79 | |||
| 80 | =head1 BUGS and CONTRIBUTIONS | ||
| 81 | |||
| 82 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 83 | |||
| 84 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 85 | |||
| 86 | =cut | ||
| 87 |