« blib/lib/Paws/Kinesis/ListStreamsOutput.pm
↑ Summary
blib/lib/Paws/Kinesis/ListTagsForStreamOutput.pm »
| 1 | |||
| 2 | package Paws::Kinesis::ListTagsForStream; | ||
| 3 | use Moose; | ||
| 4 | has ExclusiveStartTagKey => (is => 'ro', isa => 'Str'); | ||
| 5 | has Limit => (is => 'ro', isa => 'Int'); | ||
| 6 | has StreamName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListTagsForStream'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Kinesis::ListTagsForStreamOutput'); | ||
| 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::ListTagsForStream - Arguments for method ListTagsForStream on L<Paws::Kinesis> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method ListTagsForStream on the | ||
| 24 | L<Amazon Kinesis|Paws::Kinesis> service. Use the attributes of this class | ||
| 25 | as arguments to method ListTagsForStream. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListTagsForStream. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $kinesis = Paws->service('Kinesis'); | ||
| 32 | my $ListTagsForStreamOutput = $kinesis->ListTagsForStream( | ||
| 33 | StreamName => 'MyStreamName', | ||
| 34 | ExclusiveStartTagKey => 'MyTagKey', # OPTIONAL | ||
| 35 | Limit => 1, # OPTIONAL | ||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $HasMoreTags = $ListTagsForStreamOutput->HasMoreTags; | ||
| 40 | my $Tags = $ListTagsForStreamOutput->Tags; | ||
| 41 | |||
| 42 | # Returns a L<Paws::Kinesis::ListTagsForStreamOutput> object. | ||
| 43 | |||
| 44 | 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. | ||
| 45 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kinesis/ListTagsForStream> | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 ExclusiveStartTagKey => Str | ||
| 51 | |||
| 52 | The key to use as the starting point for the list of tags. If this | ||
| 53 | parameter is set, C<ListTagsForStream> gets all tags that occur after | ||
| 54 | C<ExclusiveStartTagKey>. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 Limit => Int | ||
| 59 | |||
| 60 | The number of tags to return. If this number is less than the total | ||
| 61 | number of tags associated with the stream, C<HasMoreTags> is set to | ||
| 62 | C<true>. To list additional tags, set C<ExclusiveStartTagKey> to the | ||
| 63 | last key in the response. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> StreamName => Str | ||
| 68 | |||
| 69 | The name of the stream. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head1 SEE ALSO | ||
| 75 | |||
| 76 | This class forms part of L<Paws>, documenting arguments for method ListTagsForStream in L<Paws::Kinesis> | ||
| 77 | |||
| 78 | =head1 BUGS and CONTRIBUTIONS | ||
| 79 | |||
| 80 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 81 | |||
| 82 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 83 | |||
| 84 | =cut | ||
| 85 |