blib/lib/Paws/IAM/GetGroup.pm

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