« blib/lib/Paws/Chime/ListChannelBansResponse.pm
↑ Summary
blib/lib/Paws/Chime/ListChannelMembershipsForAppInstanceUser.pm »
| 1 | |||
| 2 | package Paws::Chime::ListChannelMemberships; | ||
| 3 | use Moose; | ||
| 4 | has ChannelArn => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'channelArn', 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 Type => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'type'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListChannelMemberships'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/channels/{channelArn}/memberships'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Chime::ListChannelMembershipsResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::Chime::ListChannelMemberships - Arguments for method ListChannelMemberships on L<Paws::Chime> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method ListChannelMemberships on the | ||
| 27 | L<Amazon Chime|Paws::Chime> service. Use the attributes of this class | ||
| 28 | as arguments to method ListChannelMemberships. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListChannelMemberships. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $chime = Paws->service('Chime'); | ||
| 35 | my $ListChannelMembershipsResponse = $chime->ListChannelMemberships( | ||
| 36 | ChannelArn => 'MyChimeArn', | ||
| 37 | ChimeBearer => 'MyChimeArn', # OPTIONAL | ||
| 38 | MaxResults => 1, # OPTIONAL | ||
| 39 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 40 | Type => 'DEFAULT', # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $ChannelArn = $ListChannelMembershipsResponse->ChannelArn; | ||
| 45 | my $ChannelMemberships = | ||
| 46 | $ListChannelMembershipsResponse->ChannelMemberships; | ||
| 47 | my $NextToken = $ListChannelMembershipsResponse->NextToken; | ||
| 48 | |||
| 49 | # Returns a L<Paws::Chime::ListChannelMembershipsResponse> object. | ||
| 50 | |||
| 51 | 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. | ||
| 52 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/chime/ListChannelMemberships> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> ChannelArn => Str | ||
| 58 | |||
| 59 | The maximum number of channel memberships that you want returned. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 ChimeBearer => Str | ||
| 64 | |||
| 65 | The C<AppInstanceUserArn> of the user that makes the API call. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 MaxResults => Int | ||
| 70 | |||
| 71 | The maximum number of channel memberships that you want returned. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 NextToken => Str | ||
| 76 | |||
| 77 | The token passed by previous API calls until all requested channel | ||
| 78 | memberships are returned. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 Type => Str | ||
| 83 | |||
| 84 | The membership type of a user, C<DEFAULT> or C<HIDDEN>. Default members | ||
| 85 | are always returned as part of C<ListChannelMemberships>. Hidden | ||
| 86 | members are only returned if the type filter in | ||
| 87 | C<ListChannelMemberships> equals C<HIDDEN>. Otherwise hidden members | ||
| 88 | are not returned. | ||
| 89 | |||
| 90 | Valid values are: C<"DEFAULT">, C<"HIDDEN"> | ||
| 91 | |||
| 92 | |||
| 93 | =head1 SEE ALSO | ||
| 94 | |||
| 95 | This class forms part of L<Paws>, documenting arguments for method ListChannelMemberships in L<Paws::Chime> | ||
| 96 | |||
| 97 | =head1 BUGS and CONTRIBUTIONS | ||
| 98 | |||
| 99 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 100 | |||
| 101 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 102 | |||
| 103 | =cut | ||
| 104 |