« blib/lib/Paws/Chime/ListChannelModeratorsResponse.pm
↑ Summary
blib/lib/Paws/Chime/ListChannelsModeratedByAppInstanceUser.pm »
| 1 | |||
| 2 | package Paws::Chime::ListChannels; | ||
| 3 | use Moose; | ||
| 4 | has AppInstanceArn => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'app-instance-arn', required => 1); | ||
| 5 | has ChimeBearer => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-chime-bearer'); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'max-results'); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'next-token'); | ||
| 8 | has Privacy => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'privacy'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListChannels'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/channels'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Chime::ListChannelsResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::Chime::ListChannels - Arguments for method ListChannels on L<Paws::Chime> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method ListChannels on the | ||
| 27 | L<Amazon Chime|Paws::Chime> service. Use the attributes of this class | ||
| 28 | as arguments to method ListChannels. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListChannels. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $chime = Paws->service('Chime'); | ||
| 35 | my $ListChannelsResponse = $chime->ListChannels( | ||
| 36 | AppInstanceArn => 'MyChimeArn', | ||
| 37 | ChimeBearer => 'MyChimeArn', # OPTIONAL | ||
| 38 | MaxResults => 1, # OPTIONAL | ||
| 39 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 40 | Privacy => 'PUBLIC', # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $Channels = $ListChannelsResponse->Channels; | ||
| 45 | my $NextToken = $ListChannelsResponse->NextToken; | ||
| 46 | |||
| 47 | # Returns a L<Paws::Chime::ListChannelsResponse> 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/chime/ListChannels> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> AppInstanceArn => Str | ||
| 56 | |||
| 57 | The ARN of the C<AppInstance>. | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head2 ChimeBearer => Str | ||
| 62 | |||
| 63 | The C<AppInstanceUserArn> of the user that makes the API call. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 MaxResults => Int | ||
| 68 | |||
| 69 | The maximum number of channels that you want to return. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 NextToken => Str | ||
| 74 | |||
| 75 | The token passed by previous API calls until all requested channels are | ||
| 76 | returned. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 Privacy => Str | ||
| 81 | |||
| 82 | The privacy setting. C<PUBLIC> retrieves all the public channels. | ||
| 83 | C<PRIVATE> retrieves private channels. Only an C<AppInstanceAdmin> can | ||
| 84 | retrieve private channels. | ||
| 85 | |||
| 86 | Valid values are: C<"PUBLIC">, C<"PRIVATE"> | ||
| 87 | |||
| 88 | |||
| 89 | =head1 SEE ALSO | ||
| 90 | |||
| 91 | This class forms part of L<Paws>, documenting arguments for method ListChannels in L<Paws::Chime> | ||
| 92 | |||
| 93 | =head1 BUGS and CONTRIBUTIONS | ||
| 94 | |||
| 95 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 96 | |||
| 97 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 98 | |||
| 99 | =cut | ||
| 100 |