blib/lib/Paws/WorkDocs/DescribeGroups.pm untested

filter: Statementstmt 0.0% 0 / 20 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 22 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::WorkDocs::DescribeGroups;
3 use Moose;
4 has AuthenticationToken => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'Authentication');
5 has Limit => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'limit');
6 has Marker => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'marker');
7 has OrganizationId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'organizationId');
8 has SearchQuery => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'searchQuery', required => 1);
9  
10 use MooseX::ClassAttribute;
11  
12 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeGroups');
13 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/api/v1/groups');
14 class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET');
15 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WorkDocs::DescribeGroupsResponse');
16 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::WorkDocs::DescribeGroups - Arguments for method DescribeGroups on L<Paws::WorkDocs>
23  
24 =head1 DESCRIPTION
25  
26 This class represents the parameters used for calling the method DescribeGroups on the
27 L<Amazon WorkDocs|Paws::WorkDocs> service. Use the attributes of this class
28 as arguments to method DescribeGroups.
29  
30 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeGroups.
31  
32 =head1 SYNOPSIS
33  
34 my $workdocs = Paws->service('WorkDocs');
35 my $DescribeGroupsResponse = $workdocs->DescribeGroups(
36 SearchQuery => 'MySearchQueryType',
37 AuthenticationToken => 'MyAuthenticationHeaderType', # OPTIONAL
38 Limit => 1, # OPTIONAL
39 Marker => 'MyMarkerType', # OPTIONAL
40 OrganizationId => 'MyIdType', # OPTIONAL
41 );
42  
43 # Results:
44 my $Groups = $DescribeGroupsResponse->Groups;
45 my $Marker = $DescribeGroupsResponse->Marker;
46  
47 # Returns a L<Paws::WorkDocs::DescribeGroupsResponse> 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/workdocs/DescribeGroups>
51  
52 =head1 ATTRIBUTES
53  
54  
55 =head2 AuthenticationToken => Str
56  
57 Amazon WorkDocs authentication token. Not required when using AWS
58 administrator credentials to access the API.
59  
60  
61  
62 =head2 Limit => Int
63  
64 The maximum number of items to return with this call.
65  
66  
67  
68 =head2 Marker => Str
69  
70 The marker for the next set of results. (You received this marker from
71 a previous call.)
72  
73  
74  
75 =head2 OrganizationId => Str
76  
77 The ID of the organization.
78  
79  
80  
81 =head2 B<REQUIRED> SearchQuery => Str
82  
83 A query to describe groups by group name.
84  
85  
86  
87  
88 =head1 SEE ALSO
89  
90 This class forms part of L<Paws>, documenting arguments for method DescribeGroups in L<Paws::WorkDocs>
91  
92 =head1 BUGS and CONTRIBUTIONS
93  
94 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
95  
96 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
97  
98 =cut
99