blib/lib/Paws/Kendra/ListDataSourceSyncJobs.pm untested

filter: Statementstmt 0.0% 0 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 17 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Kendra::ListDataSourceSyncJobs;
3 use Moose;
4 has Id => (is => 'ro', isa => 'Str', required => 1);
5 has IndexId => (is => 'ro', isa => 'Str', required => 1);
6 has MaxResults => (is => 'ro', isa => 'Int');
7 has NextToken => (is => 'ro', isa => 'Str');
8 has StartTimeFilter => (is => 'ro', isa => 'Paws::Kendra::TimeRange');
9 has StatusFilter => (is => 'ro', isa => 'Str');
10  
11 use MooseX::ClassAttribute;
12  
13 class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListDataSourceSyncJobs');
14 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Kendra::ListDataSourceSyncJobsResponse');
15 class_has _result_key => (isa => 'Str', is => 'ro');
16 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::Kendra::ListDataSourceSyncJobs - Arguments for method ListDataSourceSyncJobs on L<Paws::Kendra>
23  
24 =head1 DESCRIPTION
25  
26 This class represents the parameters used for calling the method ListDataSourceSyncJobs on the
27 L<AWSKendraFrontendService|Paws::Kendra> service. Use the attributes of this class
28 as arguments to method ListDataSourceSyncJobs.
29  
30 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListDataSourceSyncJobs.
31  
32 =head1 SYNOPSIS
33  
34 my $kendra = Paws->service('Kendra');
35 my $ListDataSourceSyncJobsResponse = $kendra->ListDataSourceSyncJobs(
36 Id => 'MyDataSourceId',
37 IndexId => 'MyIndexId',
38 MaxResults => 1, # OPTIONAL
39 NextToken => 'MyNextToken', # OPTIONAL
40 StartTimeFilter => {
41 EndTime => '1970-01-01T01:00:00', # OPTIONAL
42 StartTime => '1970-01-01T01:00:00', # OPTIONAL
43 }, # OPTIONAL
44 StatusFilter => 'FAILED', # OPTIONAL
45 );
46  
47 # Results:
48 my $History = $ListDataSourceSyncJobsResponse->History;
49 my $NextToken = $ListDataSourceSyncJobsResponse->NextToken;
50  
51 # Returns a L<Paws::Kendra::ListDataSourceSyncJobsResponse> object.
52  
53 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.
54 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kendra/ListDataSourceSyncJobs>
55  
56 =head1 ATTRIBUTES
57  
58  
59 =head2 B<REQUIRED> Id => Str
60  
61 The identifier of the data source.
62  
63  
64  
65 =head2 B<REQUIRED> IndexId => Str
66  
67 The identifier of the index that contains the data source.
68  
69  
70  
71 =head2 MaxResults => Int
72  
73 The maximum number of synchronization jobs to return in the response.
74 If there are fewer results in the list, this response contains only the
75 actual results.
76  
77  
78  
79 =head2 NextToken => Str
80  
81 If the result of the previous request to C<GetDataSourceSyncJobHistory>
82 was truncated, include the C<NextToken> to fetch the next set of jobs.
83  
84  
85  
86 =head2 StartTimeFilter => L<Paws::Kendra::TimeRange>
87  
88 When specified, the synchronization jobs returned in the list are
89 limited to jobs between the specified dates.
90  
91  
92  
93 =head2 StatusFilter => Str
94  
95 When specified, only returns synchronization jobs with the C<Status>
96 field equal to the specified status.
97  
98 Valid values are: C<"FAILED">, C<"SUCCEEDED">, C<"SYNCING">, C<"INCOMPLETE">, C<"STOPPING">, C<"ABORTED">, C<"SYNCING_INDEXING">
99  
100  
101 =head1 SEE ALSO
102  
103 This class forms part of L<Paws>, documenting arguments for method ListDataSourceSyncJobs in L<Paws::Kendra>
104  
105 =head1 BUGS and CONTRIBUTIONS
106  
107 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
108  
109 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
110  
111 =cut
112