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

filter: Statementstmt 0.0% 0 / 17 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 19 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Kendra::CreateFaq;
3 use Moose;
4 has ClientToken => (is => 'ro', isa => 'Str');
5 has Description => (is => 'ro', isa => 'Str');
6 has FileFormat => (is => 'ro', isa => 'Str');
7 has IndexId => (is => 'ro', isa => 'Str', required => 1);
8 has Name => (is => 'ro', isa => 'Str', required => 1);
9 has RoleArn => (is => 'ro', isa => 'Str', required => 1);
10 has S3Path => (is => 'ro', isa => 'Paws::Kendra::S3Path', required => 1);
11 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Kendra::Tag]');
12  
13 use MooseX::ClassAttribute;
14  
15 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateFaq');
16 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Kendra::CreateFaqResponse');
17 class_has _result_key => (isa => 'Str', is => 'ro');
18 1;
19  
20 ### main pod documentation begin ###
21  
22 =head1 NAME
23  
24 Paws::Kendra::CreateFaq - Arguments for method CreateFaq on L<Paws::Kendra>
25  
26 =head1 DESCRIPTION
27  
28 This class represents the parameters used for calling the method CreateFaq on the
29 L<AWSKendraFrontendService|Paws::Kendra> service. Use the attributes of this class
30 as arguments to method CreateFaq.
31  
32 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateFaq.
33  
34 =head1 SYNOPSIS
35  
36 my $kendra = Paws->service('Kendra');
37 my $CreateFaqResponse = $kendra->CreateFaq(
38 IndexId => 'MyIndexId',
39 Name => 'MyFaqName',
40 RoleArn => 'MyRoleArn',
41 S3Path => {
42 Bucket => 'MyS3BucketName', # min: 3, max: 63
43 Key => 'MyS3ObjectKey', # min: 1, max: 1024
44  
45 },
46 ClientToken => 'MyClientTokenName', # OPTIONAL
47 Description => 'MyDescription', # OPTIONAL
48 FileFormat => 'CSV', # OPTIONAL
49 Tags => [
50 {
51 Key => 'MyTagKey', # min: 1, max: 128
52 Value => 'MyTagValue', # max: 256
53  
54 },
55 ...
56 ], # OPTIONAL
57 );
58  
59 # Results:
60 my $Id = $CreateFaqResponse->Id;
61  
62 # Returns a L<Paws::Kendra::CreateFaqResponse> object.
63  
64 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.
65 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kendra/CreateFaq>
66  
67 =head1 ATTRIBUTES
68  
69  
70 =head2 ClientToken => Str
71  
72 A token that you provide to identify the request to create a FAQ.
73 Multiple calls to the C<CreateFaqRequest> operation with the same
74 client token will create only one FAQ.
75  
76  
77  
78 =head2 Description => Str
79  
80 A description of the FAQ.
81  
82  
83  
84 =head2 FileFormat => Str
85  
86 The format of the input file. You can choose between a basic CSV
87 format, a CSV format that includes customs attributes in a header, and
88 a JSON format that includes custom attributes.
89  
90 The format must match the format of the file stored in the S3 bucket
91 identified in the C<S3Path> parameter.
92  
93 For more information, see Adding questions and answers
94 (https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html).
95  
96 Valid values are: C<"CSV">, C<"CSV_WITH_HEADER">, C<"JSON">
97  
98 =head2 B<REQUIRED> IndexId => Str
99  
100 The identifier of the index that contains the FAQ.
101  
102  
103  
104 =head2 B<REQUIRED> Name => Str
105  
106 The name that should be associated with the FAQ.
107  
108  
109  
110 =head2 B<REQUIRED> RoleArn => Str
111  
112 The Amazon Resource Name (ARN) of a role with permission to access the
113 S3 bucket that contains the FAQs. For more information, see IAM Roles
114 for Amazon Kendra
115 (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
116  
117  
118  
119 =head2 B<REQUIRED> S3Path => L<Paws::Kendra::S3Path>
120  
121 The S3 location of the FAQ input data.
122  
123  
124  
125 =head2 Tags => ArrayRef[L<Paws::Kendra::Tag>]
126  
127 A list of key-value pairs that identify the FAQ. You can use the tags
128 to identify and organize your resources and to control access to
129 resources.
130  
131  
132  
133  
134 =head1 SEE ALSO
135  
136 This class forms part of L<Paws>, documenting arguments for method CreateFaq in L<Paws::Kendra>
137  
138 =head1 BUGS and CONTRIBUTIONS
139  
140 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
141  
142 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
143  
144 =cut
145