« blib/lib/Paws/Chime/BatchCreateAttendeeResponse.pm
↑ Summary
blib/lib/Paws/Chime/BatchCreateChannelMembershipError.pm »
| 1 | |||
| 2 | package Paws::Chime::BatchCreateChannelMembership; | ||
| 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 MemberArns => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 7 | has Type => (is => 'ro', isa => 'Str'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'BatchCreateChannelMembership'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/channels/{channelArn}/memberships?operation=batch-create'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Chime::BatchCreateChannelMembershipResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Chime::BatchCreateChannelMembership - Arguments for method BatchCreateChannelMembership on L<Paws::Chime> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method BatchCreateChannelMembership on the | ||
| 26 | L<Amazon Chime|Paws::Chime> service. Use the attributes of this class | ||
| 27 | as arguments to method BatchCreateChannelMembership. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to BatchCreateChannelMembership. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $chime = Paws->service('Chime'); | ||
| 34 | my $BatchCreateChannelMembershipResponse = | ||
| 35 | $chime->BatchCreateChannelMembership( | ||
| 36 | ChannelArn => 'MyChimeArn', | ||
| 37 | MemberArns => [ | ||
| 38 | 'MyChimeArn', ... # min: 5, max: 1600 | ||
| 39 | ], | ||
| 40 | ChimeBearer => 'MyChimeArn', # OPTIONAL | ||
| 41 | Type => 'DEFAULT', # OPTIONAL | ||
| 42 | ); | ||
| 43 | |||
| 44 | # Results: | ||
| 45 | my $BatchChannelMemberships = | ||
| 46 | $BatchCreateChannelMembershipResponse->BatchChannelMemberships; | ||
| 47 | my $Errors = $BatchCreateChannelMembershipResponse->Errors; | ||
| 48 | |||
| 49 | # Returns a L<Paws::Chime::BatchCreateChannelMembershipResponse> 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/BatchCreateChannelMembership> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> ChannelArn => Str | ||
| 58 | |||
| 59 | The ARN of the channel to which you're adding users. | ||
| 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 B<REQUIRED> MemberArns => ArrayRef[Str|Undef] | ||
| 70 | |||
| 71 | The ARNs of the members you want to add to the channel. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 Type => Str | ||
| 76 | |||
| 77 | The membership type of a user, C<DEFAULT> or C<HIDDEN>. Default members | ||
| 78 | are always returned as part of C<ListChannelMemberships>. Hidden | ||
| 79 | members are only returned if the type filter in | ||
| 80 | C<ListChannelMemberships> equals C<HIDDEN>. Otherwise hidden members | ||
| 81 | are not returned. This is only supported by moderators. | ||
| 82 | |||
| 83 | Valid values are: C<"DEFAULT">, C<"HIDDEN"> | ||
| 84 | |||
| 85 | |||
| 86 | =head1 SEE ALSO | ||
| 87 | |||
| 88 | This class forms part of L<Paws>, documenting arguments for method BatchCreateChannelMembership in L<Paws::Chime> | ||
| 89 | |||
| 90 | =head1 BUGS and CONTRIBUTIONS | ||
| 91 | |||
| 92 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 93 | |||
| 94 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 95 | |||
| 96 | =cut | ||
| 97 |