« blib/lib/Paws/KinesisVideo/ListSignalingChannelsOutput.pm
↑ Summary
blib/lib/Paws/KinesisVideo/ListStreamsOutput.pm »
| 1 | |||
| 2 | package Paws::KinesisVideo::ListStreams; | ||
| 3 | use Moose; | ||
| 4 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 5 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 6 | has StreamNameCondition => (is => 'ro', isa => 'Paws::KinesisVideo::StreamNameCondition'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListStreams'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/listStreams'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::KinesisVideo::ListStreamsOutput'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::KinesisVideo::ListStreams - Arguments for method ListStreams on L<Paws::KinesisVideo> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method ListStreams on the | ||
| 25 | L<Amazon Kinesis Video Streams|Paws::KinesisVideo> service. Use the attributes of this class | ||
| 26 | as arguments to method ListStreams. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListStreams. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $kinesisvideo = Paws->service('KinesisVideo'); | ||
| 33 | my $ListStreamsOutput = $kinesisvideo->ListStreams( | ||
| 34 | MaxResults => 1, # OPTIONAL | ||
| 35 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 36 | StreamNameCondition => { | ||
| 37 | ComparisonOperator => 'BEGINS_WITH', # values: BEGINS_WITH; OPTIONAL | ||
| 38 | ComparisonValue => 'MyStreamName', # min: 1, max: 256; OPTIONAL | ||
| 39 | }, # OPTIONAL | ||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $NextToken = $ListStreamsOutput->NextToken; | ||
| 44 | my $StreamInfoList = $ListStreamsOutput->StreamInfoList; | ||
| 45 | |||
| 46 | # Returns a L<Paws::KinesisVideo::ListStreamsOutput> object. | ||
| 47 | |||
| 48 | 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. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo/ListStreams> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 MaxResults => Int | ||
| 55 | |||
| 56 | The maximum number of streams to return in the response. The default is | ||
| 57 | 10,000. | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head2 NextToken => Str | ||
| 62 | |||
| 63 | If you specify this parameter, when the result of a C<ListStreams> | ||
| 64 | operation is truncated, the call returns the C<NextToken> in the | ||
| 65 | response. To get another batch of streams, provide this token in your | ||
| 66 | next request. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 StreamNameCondition => L<Paws::KinesisVideo::StreamNameCondition> | ||
| 71 | |||
| 72 | Optional: Returns only streams that satisfy a specific condition. | ||
| 73 | Currently, you can specify only the prefix of a stream name as a | ||
| 74 | condition. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head1 SEE ALSO | ||
| 80 | |||
| 81 | This class forms part of L<Paws>, documenting arguments for method ListStreams in L<Paws::KinesisVideo> | ||
| 82 | |||
| 83 | =head1 BUGS and CONTRIBUTIONS | ||
| 84 | |||
| 85 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 86 | |||
| 87 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 88 | |||
| 89 | =cut | ||
| 90 |