blib/lib/Paws/Textract/StartDocumentTextDetection.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::Textract::StartDocumentTextDetection;
3 use Moose;
4 has ClientRequestToken => (is => 'ro', isa => 'Str');
5 has DocumentLocation => (is => 'ro', isa => 'Paws::Textract::DocumentLocation', required => 1);
6 has JobTag => (is => 'ro', isa => 'Str');
7 has KMSKeyId => (is => 'ro', isa => 'Str');
8 has NotificationChannel => (is => 'ro', isa => 'Paws::Textract::NotificationChannel');
9 has OutputConfig => (is => 'ro', isa => 'Paws::Textract::OutputConfig');
10  
11 use MooseX::ClassAttribute;
12  
13 class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartDocumentTextDetection');
14 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Textract::StartDocumentTextDetectionResponse');
15 class_has _result_key => (isa => 'Str', is => 'ro');
16 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::Textract::StartDocumentTextDetection - Arguments for method StartDocumentTextDetection on L<Paws::Textract>
23  
24 =head1 DESCRIPTION
25  
26 This class represents the parameters used for calling the method StartDocumentTextDetection on the
27 L<Amazon Textract|Paws::Textract> service. Use the attributes of this class
28 as arguments to method StartDocumentTextDetection.
29  
30 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartDocumentTextDetection.
31  
32 =head1 SYNOPSIS
33  
34 my $textract = Paws->service('Textract');
35 my $StartDocumentTextDetectionResponse =
36 $textract->StartDocumentTextDetection(
37 DocumentLocation => {
38 S3Object => {
39 Bucket => 'MyS3Bucket', # min: 3, max: 255; OPTIONAL
40 Name => 'MyS3ObjectName', # min: 1, max: 1024; OPTIONAL
41 Version => 'MyS3ObjectVersion', # min: 1, max: 1024; OPTIONAL
42 }, # OPTIONAL
43 },
44 ClientRequestToken => 'MyClientRequestToken', # OPTIONAL
45 JobTag => 'MyJobTag', # OPTIONAL
46 KMSKeyId => 'MyKMSKeyId', # OPTIONAL
47 NotificationChannel => {
48 RoleArn => 'MyRoleArn', # min: 20, max: 2048
49 SNSTopicArn => 'MySNSTopicArn', # min: 20, max: 1024
50  
51 }, # OPTIONAL
52 OutputConfig => {
53 S3Bucket => 'MyS3Bucket', # min: 3, max: 255; OPTIONAL
54 S3Prefix => 'MyS3ObjectName', # min: 1, max: 1024; OPTIONAL
55 }, # OPTIONAL
56 );
57  
58 # Results:
59 my $JobId = $StartDocumentTextDetectionResponse->JobId;
60  
61 # Returns a L<Paws::Textract::StartDocumentTextDetectionResponse> object.
62  
63 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.
64 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/textract/StartDocumentTextDetection>
65  
66 =head1 ATTRIBUTES
67  
68  
69 =head2 ClientRequestToken => Str
70  
71 The idempotent token that's used to identify the start request. If you
72 use the same token with multiple C<StartDocumentTextDetection>
73 requests, the same C<JobId> is returned. Use C<ClientRequestToken> to
74 prevent the same job from being accidentally started more than once.
75 For more information, see Calling Amazon Textract Asynchronous
76 Operations
77 (https://docs.aws.amazon.com/textract/latest/dg/api-async.html).
78  
79  
80  
81 =head2 B<REQUIRED> DocumentLocation => L<Paws::Textract::DocumentLocation>
82  
83 The location of the document to be processed.
84  
85  
86  
87 =head2 JobTag => Str
88  
89 An identifier that you specify that's included in the completion
90 notification published to the Amazon SNS topic. For example, you can
91 use C<JobTag> to identify the type of document that the completion
92 notification corresponds to (such as a tax form or a receipt).
93  
94  
95  
96 =head2 KMSKeyId => Str
97  
98 The KMS key used to encrypt the inference results. This can be in
99 either Key ID or Key Alias format. When a KMS key is provided, the KMS
100 key will be used for server-side encryption of the objects in the
101 customer bucket. When this parameter is not enabled, the result will be
102 encrypted server side,using SSE-S3.
103  
104  
105  
106 =head2 NotificationChannel => L<Paws::Textract::NotificationChannel>
107  
108 The Amazon SNS topic ARN that you want Amazon Textract to publish the
109 completion status of the operation to.
110  
111  
112  
113 =head2 OutputConfig => L<Paws::Textract::OutputConfig>
114  
115 Sets if the output will go to a customer defined bucket. By default
116 Amazon Textract will save the results internally to be accessed with
117 the GetDocumentTextDetection operation.
118  
119  
120  
121  
122 =head1 SEE ALSO
123  
124 This class forms part of L<Paws>, documenting arguments for method StartDocumentTextDetection in L<Paws::Textract>
125  
126 =head1 BUGS and CONTRIBUTIONS
127  
128 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
129  
130 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
131  
132 =cut
133