« blib/lib/Paws/IAM/ListGroupPoliciesResponse.pm
↑ Summary
blib/lib/Paws/IAM/ListGroupsForUserResponse.pm »
| 1 | |||
| 2 | package Paws::IAM::ListGroupsForUser; | ||
| 3 | use Moose; | ||
| 4 | has Marker => (is => 'ro', isa => 'Str'); | ||
| 5 | has MaxItems => (is => 'ro', isa => 'Int'); | ||
| 6 | has UserName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListGroupsForUser'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IAM::ListGroupsForUserResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'ListGroupsForUserResult'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::IAM::ListGroupsForUser - Arguments for method ListGroupsForUser on L<Paws::IAM> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method ListGroupsForUser on the | ||
| 24 | L<AWS Identity and Access Management|Paws::IAM> service. Use the attributes of this class | ||
| 25 | as arguments to method ListGroupsForUser. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListGroupsForUser. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $iam = Paws->service('IAM'); | ||
| 32 | # To list the groups that an IAM user belongs to | ||
| 33 | # The following command displays the groups that the IAM user named Bob belongs | ||
| 34 | # to. | ||
| 35 | my $ListGroupsForUserResponse = | ||
| 36 | $iam->ListGroupsForUser( 'UserName' => 'Bob' ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $Groups = $ListGroupsForUserResponse->Groups; | ||
| 40 | |||
| 41 | # Returns a L<Paws::IAM::ListGroupsForUserResponse> object. | ||
| 42 | |||
| 43 | 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. | ||
| 44 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iam/ListGroupsForUser> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 Marker => Str | ||
| 50 | |||
| 51 | Use this parameter only when paginating results and only after you | ||
| 52 | receive a response indicating that the results are truncated. Set it to | ||
| 53 | the value of the C<Marker> element in the response that you received to | ||
| 54 | indicate where the next call should start. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 MaxItems => Int | ||
| 59 | |||
| 60 | Use this only when paginating results to indicate the maximum number of | ||
| 61 | items you want in the response. If additional items exist beyond the | ||
| 62 | maximum you specify, the C<IsTruncated> response element is C<true>. | ||
| 63 | |||
| 64 | If you do not include this parameter, the number of items defaults to | ||
| 65 | 100. Note that IAM might return fewer results, even when there are more | ||
| 66 | results available. In that case, the C<IsTruncated> response element | ||
| 67 | returns C<true>, and C<Marker> contains a value to include in the | ||
| 68 | subsequent call that tells the service where to continue from. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 B<REQUIRED> UserName => Str | ||
| 73 | |||
| 74 | The name of the user to list groups for. | ||
| 75 | |||
| 76 | This parameter allows (through its regex pattern | ||
| 77 | (http://wikipedia.org/wiki/regex)) a string of characters consisting of | ||
| 78 | upper and lowercase alphanumeric characters with no spaces. You can | ||
| 79 | also include any of the following characters: _+=,.@- | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head1 SEE ALSO | ||
| 85 | |||
| 86 | This class forms part of L<Paws>, documenting arguments for method ListGroupsForUser in L<Paws::IAM> | ||
| 87 | |||
| 88 | =head1 BUGS and CONTRIBUTIONS | ||
| 89 | |||
| 90 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 91 | |||
| 92 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 93 | |||
| 94 | =cut | ||
| 95 |