« blib/lib/Paws/IVS/ImportPlaybackKeyPairResponse.pm
↑ Summary
blib/lib/Paws/IVS/ListChannelsResponse.pm »
| 1 | |||
| 2 | package Paws::IVS::ListChannels; | ||
| 3 | use Moose; | ||
| 4 | has FilterByName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'filterByName'); | ||
| 5 | has FilterByRecordingConfigurationArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'filterByRecordingConfigurationArn'); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults'); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListChannels'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/ListChannels'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IVS::ListChannelsResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::IVS::ListChannels - Arguments for method ListChannels on L<Paws::IVS> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method ListChannels on the | ||
| 26 | L<Amazon Interactive Video Service|Paws::IVS> service. Use the attributes of this class | ||
| 27 | as arguments to method ListChannels. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListChannels. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $ivs = Paws->service('IVS'); | ||
| 34 | my $ListChannelsResponse = $ivs->ListChannels( | ||
| 35 | FilterByName => 'MyChannelName', # OPTIONAL | ||
| 36 | FilterByRecordingConfigurationArn => | ||
| 37 | 'MyChannelRecordingConfigurationArn', # OPTIONAL | ||
| 38 | MaxResults => 1, # OPTIONAL | ||
| 39 | NextToken => 'MyPaginationToken', # OPTIONAL | ||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $Channels = $ListChannelsResponse->Channels; | ||
| 44 | my $NextToken = $ListChannelsResponse->NextToken; | ||
| 45 | |||
| 46 | # Returns a L<Paws::IVS::ListChannelsResponse> 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/ivs/ListChannels> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 FilterByName => Str | ||
| 55 | |||
| 56 | Filters the channel list to match the specified name. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 FilterByRecordingConfigurationArn => Str | ||
| 61 | |||
| 62 | Filters the channel list to match the specified recording-configuration | ||
| 63 | ARN. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 MaxResults => Int | ||
| 68 | |||
| 69 | Maximum number of channels to return. Default: 50. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 NextToken => Str | ||
| 74 | |||
| 75 | The first channel to retrieve. This is used for pagination; see the | ||
| 76 | C<nextToken> response field. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head1 SEE ALSO | ||
| 82 | |||
| 83 | This class forms part of L<Paws>, documenting arguments for method ListChannels in L<Paws::IVS> | ||
| 84 | |||
| 85 | =head1 BUGS and CONTRIBUTIONS | ||
| 86 | |||
| 87 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 88 | |||
| 89 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 90 | |||
| 91 | =cut | ||
| 92 |