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

filter: Statementstmt 0.0% 0 / 30 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 32 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::WorkDocs::DescribeActivities;
3 use Moose;
4 has ActivityTypes => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'activityTypes');
5 has AuthenticationToken => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'Authentication');
6 has EndTime => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'endTime');
7 has IncludeIndirectActivities => (is => 'ro', isa => 'Bool', traits => ['ParamInQuery'], query_name => 'includeIndirectActivities');
8 has Limit => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'limit');
9 has Marker => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'marker');
10 has OrganizationId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'organizationId');
11 has ResourceId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'resourceId');
12 has StartTime => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'startTime');
13 has UserId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'userId');
14  
15 use MooseX::ClassAttribute;
16  
17 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeActivities');
18 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/api/v1/activities');
19 class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET');
20 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WorkDocs::DescribeActivitiesResponse');
21 1;
22  
23 ### main pod documentation begin ###
24  
25 =head1 NAME
26  
27 Paws::WorkDocs::DescribeActivities - Arguments for method DescribeActivities on L<Paws::WorkDocs>
28  
29 =head1 DESCRIPTION
30  
31 This class represents the parameters used for calling the method DescribeActivities on the
32 L<Amazon WorkDocs|Paws::WorkDocs> service. Use the attributes of this class
33 as arguments to method DescribeActivities.
34  
35 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeActivities.
36  
37 =head1 SYNOPSIS
38  
39 my $workdocs = Paws->service('WorkDocs');
40 my $DescribeActivitiesResponse = $workdocs->DescribeActivities(
41 ActivityTypes => 'MyActivityNamesFilterType', # OPTIONAL
42 AuthenticationToken => 'MyAuthenticationHeaderType', # OPTIONAL
43 EndTime => '1970-01-01T01:00:00', # OPTIONAL
44 IncludeIndirectActivities => 1, # OPTIONAL
45 Limit => 1, # OPTIONAL
46 Marker => 'MyMarkerType', # OPTIONAL
47 OrganizationId => 'MyIdType', # OPTIONAL
48 ResourceId => 'MyIdType', # OPTIONAL
49 StartTime => '1970-01-01T01:00:00', # OPTIONAL
50 UserId => 'MyIdType', # OPTIONAL
51 );
52  
53 # Results:
54 my $Marker = $DescribeActivitiesResponse->Marker;
55 my $UserActivities = $DescribeActivitiesResponse->UserActivities;
56  
57 # Returns a L<Paws::WorkDocs::DescribeActivitiesResponse> object.
58  
59 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.
60 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/workdocs/DescribeActivities>
61  
62 =head1 ATTRIBUTES
63  
64  
65 =head2 ActivityTypes => Str
66  
67 Specifies which activity types to include in the response. If this
68 field is left empty, all activity types are returned.
69  
70  
71  
72 =head2 AuthenticationToken => Str
73  
74 Amazon WorkDocs authentication token. Not required when using AWS
75 administrator credentials to access the API.
76  
77  
78  
79 =head2 EndTime => Str
80  
81 The timestamp that determines the end time of the activities. The
82 response includes the activities performed before the specified
83 timestamp.
84  
85  
86  
87 =head2 IncludeIndirectActivities => Bool
88  
89 Includes indirect activities. An indirect activity results from a
90 direct activity performed on a parent resource. For example, sharing a
91 parent folder (the direct activity) shares all of the subfolders and
92 documents within the parent folder (the indirect activity).
93  
94  
95  
96 =head2 Limit => Int
97  
98 The maximum number of items to return.
99  
100  
101  
102 =head2 Marker => Str
103  
104 The marker for the next set of results.
105  
106  
107  
108 =head2 OrganizationId => Str
109  
110 The ID of the organization. This is a mandatory parameter when using
111 administrative API (SigV4) requests.
112  
113  
114  
115 =head2 ResourceId => Str
116  
117 The document or folder ID for which to describe activity types.
118  
119  
120  
121 =head2 StartTime => Str
122  
123 The timestamp that determines the starting time of the activities. The
124 response includes the activities performed after the specified
125 timestamp.
126  
127  
128  
129 =head2 UserId => Str
130  
131 The ID of the user who performed the action. The response includes
132 activities pertaining to this user. This is an optional parameter and
133 is only applicable for administrative API (SigV4) requests.
134  
135  
136  
137  
138 =head1 SEE ALSO
139  
140 This class forms part of L<Paws>, documenting arguments for method DescribeActivities in L<Paws::WorkDocs>
141  
142 =head1 BUGS and CONTRIBUTIONS
143  
144 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
145  
146 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
147  
148 =cut
149