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