/
api.go
2288 lines (2002 loc) · 81.9 KB
/
api.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package textract
import (
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/awsutil"
"github.com/aws/aws-sdk-go/aws/request"
)
const opAnalyzeDocument = "AnalyzeDocument"
// AnalyzeDocumentRequest generates a "aws/request.Request" representing the
// client's request for the AnalyzeDocument operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See AnalyzeDocument for more information on using the AnalyzeDocument
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
//
// // Example sending a request using the AnalyzeDocumentRequest method.
// req, resp := client.AnalyzeDocumentRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/AnalyzeDocument
func (c *Textract) AnalyzeDocumentRequest(input *AnalyzeDocumentInput) (req *request.Request, output *AnalyzeDocumentOutput) {
op := &request.Operation{
Name: opAnalyzeDocument,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &AnalyzeDocumentInput{}
}
output = &AnalyzeDocumentOutput{}
req = c.newRequest(op, input, output)
return
}
// AnalyzeDocument API operation for Amazon Textract.
//
// Analyzes an input document for relationships between detected items.
//
// The types of information returned are as follows:
//
// * Words and lines that are related to nearby lines and words. The related
// information is returned in two Block objects each of type KEY_VALUE_SET:
// a KEY Block object and a VALUE Block object. For example, Name: Ana Silva
// Carolina contains a key and value. Name: is the key. Ana Silva Carolina
// is the value.
//
// * Table and table cell data. A TABLE Block object contains information
// about a detected table. A CELL Block object is returned for each cell
// in a table.
//
// * Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT
// Block object contains information about a selectable element.
//
// * Lines and words of text. A LINE Block object contains one or more WORD
// Block objects.
//
// You can choose which type of analysis to perform by specifying the FeatureTypes
// list.
//
// The output is returned in a list of BLOCK objects.
//
// AnalyzeDocument is a synchronous operation. To analyze documents asynchronously,
// use StartDocumentAnalysis.
//
// For more information, see Document Text Analysis (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html).
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Textract's
// API operation AnalyzeDocument for usage and error information.
//
// Returned Error Codes:
// * ErrCodeInvalidParameterException "InvalidParameterException"
// An input parameter violated a constraint. For example, in synchronous operations,
// an InvalidParameterException exception occurs when neither of the S3Object
// or Bytes values are supplied in the Document request parameter. Validate
// your parameter before calling the API operation again.
//
// * ErrCodeInvalidS3ObjectException "InvalidS3ObjectException"
// Amazon Textract is unable to access the S3 object that's specified in the
// request.
//
// * ErrCodeUnsupportedDocumentException "UnsupportedDocumentException"
// The format of the input document isn't supported. Amazon Textract supports
// documents that are .png or .jpg format.
//
// * ErrCodeDocumentTooLargeException "DocumentTooLargeException"
// The document can't be processed because it's too large. The maximum document
// size for synchronous operations 5 MB. The maximum document size for asynchronous
// operations is 500 MB for PDF format files.
//
// * ErrCodeBadDocumentException "BadDocumentException"
// Amazon Textract isn't able to read the document.
//
// * ErrCodeAccessDeniedException "AccessDeniedException"
// You aren't authorized to perform the action.
//
// * ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException"
// The number of requests exceeded your throughput limit. If you want to increase
// this limit, contact Amazon Textract.
//
// * ErrCodeInternalServerError "InternalServerError"
// Amazon Textract experienced a service issue. Try your call again.
//
// * ErrCodeThrottlingException "ThrottlingException"
// Amazon Textract is temporarily unable to process the request. Try your call
// again.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/AnalyzeDocument
func (c *Textract) AnalyzeDocument(input *AnalyzeDocumentInput) (*AnalyzeDocumentOutput, error) {
req, out := c.AnalyzeDocumentRequest(input)
return out, req.Send()
}
// AnalyzeDocumentWithContext is the same as AnalyzeDocument with the addition of
// the ability to pass a context and additional request options.
//
// See AnalyzeDocument for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *Textract) AnalyzeDocumentWithContext(ctx aws.Context, input *AnalyzeDocumentInput, opts ...request.Option) (*AnalyzeDocumentOutput, error) {
req, out := c.AnalyzeDocumentRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDetectDocumentText = "DetectDocumentText"
// DetectDocumentTextRequest generates a "aws/request.Request" representing the
// client's request for the DetectDocumentText operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DetectDocumentText for more information on using the DetectDocumentText
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
//
// // Example sending a request using the DetectDocumentTextRequest method.
// req, resp := client.DetectDocumentTextRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/DetectDocumentText
func (c *Textract) DetectDocumentTextRequest(input *DetectDocumentTextInput) (req *request.Request, output *DetectDocumentTextOutput) {
op := &request.Operation{
Name: opDetectDocumentText,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DetectDocumentTextInput{}
}
output = &DetectDocumentTextOutput{}
req = c.newRequest(op, input, output)
return
}
// DetectDocumentText API operation for Amazon Textract.
//
// Detects text in the input document. Amazon Textract can detect lines of text
// and the words that make up a line of text. The input document must be an
// image in JPG or PNG format. DetectDocumentText returns the detected text
// in an array of Block objects.
//
// Each document page has as an associated Block of type PAGE. Each PAGE Block
// object is the parent of LINE Block objects that represent the lines of detected
// text on a page. A LINE Block object is a parent for each word that makes
// up the line. Words are represented by Block objects of type WORD.
//
// DetectDocumentText is a synchronous operation. To analyze documents asynchronously,
// use StartDocumentTextDetection.
//
// For more information, see Document Text Detection (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html).
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Textract's
// API operation DetectDocumentText for usage and error information.
//
// Returned Error Codes:
// * ErrCodeInvalidParameterException "InvalidParameterException"
// An input parameter violated a constraint. For example, in synchronous operations,
// an InvalidParameterException exception occurs when neither of the S3Object
// or Bytes values are supplied in the Document request parameter. Validate
// your parameter before calling the API operation again.
//
// * ErrCodeInvalidS3ObjectException "InvalidS3ObjectException"
// Amazon Textract is unable to access the S3 object that's specified in the
// request.
//
// * ErrCodeUnsupportedDocumentException "UnsupportedDocumentException"
// The format of the input document isn't supported. Amazon Textract supports
// documents that are .png or .jpg format.
//
// * ErrCodeDocumentTooLargeException "DocumentTooLargeException"
// The document can't be processed because it's too large. The maximum document
// size for synchronous operations 5 MB. The maximum document size for asynchronous
// operations is 500 MB for PDF format files.
//
// * ErrCodeBadDocumentException "BadDocumentException"
// Amazon Textract isn't able to read the document.
//
// * ErrCodeAccessDeniedException "AccessDeniedException"
// You aren't authorized to perform the action.
//
// * ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException"
// The number of requests exceeded your throughput limit. If you want to increase
// this limit, contact Amazon Textract.
//
// * ErrCodeInternalServerError "InternalServerError"
// Amazon Textract experienced a service issue. Try your call again.
//
// * ErrCodeThrottlingException "ThrottlingException"
// Amazon Textract is temporarily unable to process the request. Try your call
// again.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/DetectDocumentText
func (c *Textract) DetectDocumentText(input *DetectDocumentTextInput) (*DetectDocumentTextOutput, error) {
req, out := c.DetectDocumentTextRequest(input)
return out, req.Send()
}
// DetectDocumentTextWithContext is the same as DetectDocumentText with the addition of
// the ability to pass a context and additional request options.
//
// See DetectDocumentText for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *Textract) DetectDocumentTextWithContext(ctx aws.Context, input *DetectDocumentTextInput, opts ...request.Option) (*DetectDocumentTextOutput, error) {
req, out := c.DetectDocumentTextRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opGetDocumentAnalysis = "GetDocumentAnalysis"
// GetDocumentAnalysisRequest generates a "aws/request.Request" representing the
// client's request for the GetDocumentAnalysis operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See GetDocumentAnalysis for more information on using the GetDocumentAnalysis
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
//
// // Example sending a request using the GetDocumentAnalysisRequest method.
// req, resp := client.GetDocumentAnalysisRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/GetDocumentAnalysis
func (c *Textract) GetDocumentAnalysisRequest(input *GetDocumentAnalysisInput) (req *request.Request, output *GetDocumentAnalysisOutput) {
op := &request.Operation{
Name: opGetDocumentAnalysis,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &GetDocumentAnalysisInput{}
}
output = &GetDocumentAnalysisOutput{}
req = c.newRequest(op, input, output)
return
}
// GetDocumentAnalysis API operation for Amazon Textract.
//
// Gets the results for an Amazon Textract asynchronous operation that analyzes
// text in a document.
//
// You start asynchronous text analysis by calling StartDocumentAnalysis, which
// returns a job identifier (JobId). When the text analysis operation finishes,
// Amazon Textract publishes a completion status to the Amazon Simple Notification
// Service (Amazon SNS) topic that's registered in the initial call to StartDocumentAnalysis.
// To get the results of the text-detection operation, first check that the
// status value published to the Amazon SNS topic is SUCCEEDED. If so, call
// GetDocumentAnalysis, and pass the job identifier (JobId) from the initial
// call to StartDocumentAnalysis.
//
// GetDocumentAnalysis returns an array of Block objects. The following types
// of information are returned:
//
// * Words and lines that are related to nearby lines and words. The related
// information is returned in two Block objects each of type KEY_VALUE_SET:
// a KEY Block object and a VALUE Block object. For example, Name: Ana Silva
// Carolina contains a key and value. Name: is the key. Ana Silva Carolina
// is the value.
//
// * Table and table cell data. A TABLE Block object contains information
// about a detected table. A CELL Block object is returned for each cell
// in a table.
//
// * Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT
// Block object contains information about a selectable element.
//
// * Lines and words of text. A LINE Block object contains one or more WORD
// Block objects.
//
// Use the MaxResults parameter to limit the number of blocks returned. If there
// are more results than specified in MaxResults, the value of NextToken in
// the operation response contains a pagination token for getting the next set
// of results. To get the next page of results, call GetDocumentAnalysis, and
// populate the NextToken request parameter with the token value that's returned
// from the previous call to GetDocumentAnalysis.
//
// For more information, see Document Text Analysis (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html).
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Textract's
// API operation GetDocumentAnalysis for usage and error information.
//
// Returned Error Codes:
// * ErrCodeInvalidParameterException "InvalidParameterException"
// An input parameter violated a constraint. For example, in synchronous operations,
// an InvalidParameterException exception occurs when neither of the S3Object
// or Bytes values are supplied in the Document request parameter. Validate
// your parameter before calling the API operation again.
//
// * ErrCodeAccessDeniedException "AccessDeniedException"
// You aren't authorized to perform the action.
//
// * ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException"
// The number of requests exceeded your throughput limit. If you want to increase
// this limit, contact Amazon Textract.
//
// * ErrCodeInvalidJobIdException "InvalidJobIdException"
// An invalid job identifier was passed to GetDocumentAnalysis or to GetDocumentAnalysis.
//
// * ErrCodeInternalServerError "InternalServerError"
// Amazon Textract experienced a service issue. Try your call again.
//
// * ErrCodeThrottlingException "ThrottlingException"
// Amazon Textract is temporarily unable to process the request. Try your call
// again.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/GetDocumentAnalysis
func (c *Textract) GetDocumentAnalysis(input *GetDocumentAnalysisInput) (*GetDocumentAnalysisOutput, error) {
req, out := c.GetDocumentAnalysisRequest(input)
return out, req.Send()
}
// GetDocumentAnalysisWithContext is the same as GetDocumentAnalysis with the addition of
// the ability to pass a context and additional request options.
//
// See GetDocumentAnalysis for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *Textract) GetDocumentAnalysisWithContext(ctx aws.Context, input *GetDocumentAnalysisInput, opts ...request.Option) (*GetDocumentAnalysisOutput, error) {
req, out := c.GetDocumentAnalysisRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opGetDocumentTextDetection = "GetDocumentTextDetection"
// GetDocumentTextDetectionRequest generates a "aws/request.Request" representing the
// client's request for the GetDocumentTextDetection operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See GetDocumentTextDetection for more information on using the GetDocumentTextDetection
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
//
// // Example sending a request using the GetDocumentTextDetectionRequest method.
// req, resp := client.GetDocumentTextDetectionRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/GetDocumentTextDetection
func (c *Textract) GetDocumentTextDetectionRequest(input *GetDocumentTextDetectionInput) (req *request.Request, output *GetDocumentTextDetectionOutput) {
op := &request.Operation{
Name: opGetDocumentTextDetection,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &GetDocumentTextDetectionInput{}
}
output = &GetDocumentTextDetectionOutput{}
req = c.newRequest(op, input, output)
return
}
// GetDocumentTextDetection API operation for Amazon Textract.
//
// Gets the results for an Amazon Textract asynchronous operation that detects
// text in a document. Amazon Textract can detect lines of text and the words
// that make up a line of text.
//
// You start asynchronous text detection by calling StartDocumentTextDetection,
// which returns a job identifier (JobId). When the text detection operation
// finishes, Amazon Textract publishes a completion status to the Amazon Simple
// Notification Service (Amazon SNS) topic that's registered in the initial
// call to StartDocumentTextDetection. To get the results of the text-detection
// operation, first check that the status value published to the Amazon SNS
// topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job
// identifier (JobId) from the initial call to StartDocumentTextDetection.
//
// GetDocumentTextDetection returns an array of Block objects.
//
// Each document page has as an associated Block of type PAGE. Each PAGE Block
// object is the parent of LINE Block objects that represent the lines of detected
// text on a page. A LINE Block object is a parent for each word that makes
// up the line. Words are represented by Block objects of type WORD.
//
// Use the MaxResults parameter to limit the number of blocks that are returned.
// If there are more results than specified in MaxResults, the value of NextToken
// in the operation response contains a pagination token for getting the next
// set of results. To get the next page of results, call GetDocumentTextDetection,
// and populate the NextToken request parameter with the token value that's
// returned from the previous call to GetDocumentTextDetection.
//
// For more information, see Document Text Detection (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html).
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Textract's
// API operation GetDocumentTextDetection for usage and error information.
//
// Returned Error Codes:
// * ErrCodeInvalidParameterException "InvalidParameterException"
// An input parameter violated a constraint. For example, in synchronous operations,
// an InvalidParameterException exception occurs when neither of the S3Object
// or Bytes values are supplied in the Document request parameter. Validate
// your parameter before calling the API operation again.
//
// * ErrCodeAccessDeniedException "AccessDeniedException"
// You aren't authorized to perform the action.
//
// * ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException"
// The number of requests exceeded your throughput limit. If you want to increase
// this limit, contact Amazon Textract.
//
// * ErrCodeInvalidJobIdException "InvalidJobIdException"
// An invalid job identifier was passed to GetDocumentAnalysis or to GetDocumentAnalysis.
//
// * ErrCodeInternalServerError "InternalServerError"
// Amazon Textract experienced a service issue. Try your call again.
//
// * ErrCodeThrottlingException "ThrottlingException"
// Amazon Textract is temporarily unable to process the request. Try your call
// again.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/GetDocumentTextDetection
func (c *Textract) GetDocumentTextDetection(input *GetDocumentTextDetectionInput) (*GetDocumentTextDetectionOutput, error) {
req, out := c.GetDocumentTextDetectionRequest(input)
return out, req.Send()
}
// GetDocumentTextDetectionWithContext is the same as GetDocumentTextDetection with the addition of
// the ability to pass a context and additional request options.
//
// See GetDocumentTextDetection for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *Textract) GetDocumentTextDetectionWithContext(ctx aws.Context, input *GetDocumentTextDetectionInput, opts ...request.Option) (*GetDocumentTextDetectionOutput, error) {
req, out := c.GetDocumentTextDetectionRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opStartDocumentAnalysis = "StartDocumentAnalysis"
// StartDocumentAnalysisRequest generates a "aws/request.Request" representing the
// client's request for the StartDocumentAnalysis operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See StartDocumentAnalysis for more information on using the StartDocumentAnalysis
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
//
// // Example sending a request using the StartDocumentAnalysisRequest method.
// req, resp := client.StartDocumentAnalysisRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/StartDocumentAnalysis
func (c *Textract) StartDocumentAnalysisRequest(input *StartDocumentAnalysisInput) (req *request.Request, output *StartDocumentAnalysisOutput) {
op := &request.Operation{
Name: opStartDocumentAnalysis,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &StartDocumentAnalysisInput{}
}
output = &StartDocumentAnalysisOutput{}
req = c.newRequest(op, input, output)
return
}
// StartDocumentAnalysis API operation for Amazon Textract.
//
// Starts asynchronous analysis of an input document for relationships between
// detected items such as key and value pairs, tables, and selection elements.
//
// StartDocumentAnalysis can analyze text in documents that are in JPG, PNG,
// and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation
// to specify the bucket name and file name of the document.
//
// StartDocumentAnalysis returns a job identifier (JobId) that you use to get
// the results of the operation. When text analysis is finished, Amazon Textract
// publishes a completion status to the Amazon Simple Notification Service (Amazon
// SNS) topic that you specify in NotificationChannel. To get the results of
// the text analysis operation, first check that the status value published
// to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and
// pass the job identifier (JobId) from the initial call to StartDocumentAnalysis.
//
// For more information, see Document Text Analysis (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html).
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Textract's
// API operation StartDocumentAnalysis for usage and error information.
//
// Returned Error Codes:
// * ErrCodeInvalidParameterException "InvalidParameterException"
// An input parameter violated a constraint. For example, in synchronous operations,
// an InvalidParameterException exception occurs when neither of the S3Object
// or Bytes values are supplied in the Document request parameter. Validate
// your parameter before calling the API operation again.
//
// * ErrCodeInvalidS3ObjectException "InvalidS3ObjectException"
// Amazon Textract is unable to access the S3 object that's specified in the
// request.
//
// * ErrCodeUnsupportedDocumentException "UnsupportedDocumentException"
// The format of the input document isn't supported. Amazon Textract supports
// documents that are .png or .jpg format.
//
// * ErrCodeDocumentTooLargeException "DocumentTooLargeException"
// The document can't be processed because it's too large. The maximum document
// size for synchronous operations 5 MB. The maximum document size for asynchronous
// operations is 500 MB for PDF format files.
//
// * ErrCodeBadDocumentException "BadDocumentException"
// Amazon Textract isn't able to read the document.
//
// * ErrCodeAccessDeniedException "AccessDeniedException"
// You aren't authorized to perform the action.
//
// * ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException"
// The number of requests exceeded your throughput limit. If you want to increase
// this limit, contact Amazon Textract.
//
// * ErrCodeInternalServerError "InternalServerError"
// Amazon Textract experienced a service issue. Try your call again.
//
// * ErrCodeIdempotentParameterMismatchException "IdempotentParameterMismatchException"
// A ClientRequestToken input parameter was reused with an operation, but at
// least one of the other input parameters is different from the previous call
// to the operation.
//
// * ErrCodeThrottlingException "ThrottlingException"
// Amazon Textract is temporarily unable to process the request. Try your call
// again.
//
// * ErrCodeLimitExceededException "LimitExceededException"
// An Amazon Textract service limit was exceeded. For example, if you start
// too many asynchronous jobs concurrently, calls to start operations (StartDocumentTextDetection,
// for example) raise a LimitExceededException exception (HTTP status code:
// 400) until the number of concurrently running jobs is below the Amazon Textract
// service limit.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/StartDocumentAnalysis
func (c *Textract) StartDocumentAnalysis(input *StartDocumentAnalysisInput) (*StartDocumentAnalysisOutput, error) {
req, out := c.StartDocumentAnalysisRequest(input)
return out, req.Send()
}
// StartDocumentAnalysisWithContext is the same as StartDocumentAnalysis with the addition of
// the ability to pass a context and additional request options.
//
// See StartDocumentAnalysis for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *Textract) StartDocumentAnalysisWithContext(ctx aws.Context, input *StartDocumentAnalysisInput, opts ...request.Option) (*StartDocumentAnalysisOutput, error) {
req, out := c.StartDocumentAnalysisRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opStartDocumentTextDetection = "StartDocumentTextDetection"
// StartDocumentTextDetectionRequest generates a "aws/request.Request" representing the
// client's request for the StartDocumentTextDetection operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See StartDocumentTextDetection for more information on using the StartDocumentTextDetection
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
//
// // Example sending a request using the StartDocumentTextDetectionRequest method.
// req, resp := client.StartDocumentTextDetectionRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/StartDocumentTextDetection
func (c *Textract) StartDocumentTextDetectionRequest(input *StartDocumentTextDetectionInput) (req *request.Request, output *StartDocumentTextDetectionOutput) {
op := &request.Operation{
Name: opStartDocumentTextDetection,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &StartDocumentTextDetectionInput{}
}
output = &StartDocumentTextDetectionOutput{}
req = c.newRequest(op, input, output)
return
}
// StartDocumentTextDetection API operation for Amazon Textract.
//
// Starts the asynchronous detection of text in a document. Amazon Textract
// can detect lines of text and the words that make up a line of text.
//
// StartDocumentTextDetection can analyze text in documents that are in JPG,
// PNG, and PDF format. The documents are stored in an Amazon S3 bucket. Use
// DocumentLocation to specify the bucket name and file name of the document.
//
// StartTextDetection returns a job identifier (JobId) that you use to get the
// results of the operation. When text detection is finished, Amazon Textract
// publishes a completion status to the Amazon Simple Notification Service (Amazon
// SNS) topic that you specify in NotificationChannel. To get the results of
// the text detection operation, first check that the status value published
// to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection,
// and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection.
//
// For more information, see Document Text Detection (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html).
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Textract's
// API operation StartDocumentTextDetection for usage and error information.
//
// Returned Error Codes:
// * ErrCodeInvalidParameterException "InvalidParameterException"
// An input parameter violated a constraint. For example, in synchronous operations,
// an InvalidParameterException exception occurs when neither of the S3Object
// or Bytes values are supplied in the Document request parameter. Validate
// your parameter before calling the API operation again.
//
// * ErrCodeInvalidS3ObjectException "InvalidS3ObjectException"
// Amazon Textract is unable to access the S3 object that's specified in the
// request.
//
// * ErrCodeUnsupportedDocumentException "UnsupportedDocumentException"
// The format of the input document isn't supported. Amazon Textract supports
// documents that are .png or .jpg format.
//
// * ErrCodeDocumentTooLargeException "DocumentTooLargeException"
// The document can't be processed because it's too large. The maximum document
// size for synchronous operations 5 MB. The maximum document size for asynchronous
// operations is 500 MB for PDF format files.
//
// * ErrCodeBadDocumentException "BadDocumentException"
// Amazon Textract isn't able to read the document.
//
// * ErrCodeAccessDeniedException "AccessDeniedException"
// You aren't authorized to perform the action.
//
// * ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException"
// The number of requests exceeded your throughput limit. If you want to increase
// this limit, contact Amazon Textract.
//
// * ErrCodeInternalServerError "InternalServerError"
// Amazon Textract experienced a service issue. Try your call again.
//
// * ErrCodeIdempotentParameterMismatchException "IdempotentParameterMismatchException"
// A ClientRequestToken input parameter was reused with an operation, but at
// least one of the other input parameters is different from the previous call
// to the operation.
//
// * ErrCodeThrottlingException "ThrottlingException"
// Amazon Textract is temporarily unable to process the request. Try your call
// again.
//
// * ErrCodeLimitExceededException "LimitExceededException"
// An Amazon Textract service limit was exceeded. For example, if you start
// too many asynchronous jobs concurrently, calls to start operations (StartDocumentTextDetection,
// for example) raise a LimitExceededException exception (HTTP status code:
// 400) until the number of concurrently running jobs is below the Amazon Textract
// service limit.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/StartDocumentTextDetection
func (c *Textract) StartDocumentTextDetection(input *StartDocumentTextDetectionInput) (*StartDocumentTextDetectionOutput, error) {
req, out := c.StartDocumentTextDetectionRequest(input)
return out, req.Send()
}
// StartDocumentTextDetectionWithContext is the same as StartDocumentTextDetection with the addition of
// the ability to pass a context and additional request options.
//
// See StartDocumentTextDetection for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *Textract) StartDocumentTextDetectionWithContext(ctx aws.Context, input *StartDocumentTextDetectionInput, opts ...request.Option) (*StartDocumentTextDetectionOutput, error) {
req, out := c.StartDocumentTextDetectionRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
type AnalyzeDocumentInput struct {
_ struct{} `type:"structure"`
// The input document as base64-encoded bytes or an Amazon S3 object. If you
// use the AWS CLI to call Amazon Textract operations, you can't pass image
// bytes. The document must be an image in JPG or PNG format.
//
// If you are using an AWS SDK to call Amazon Textract, you might not need to
// base64-encode image bytes passed using the Bytes field.
//
// Document is a required field
Document *Document `type:"structure" required:"true"`
// A list of the types of analysis to perform. Add TABLES to the list to return
// information about the tables detected in the input document. Add FORMS to
// return detected fields and the associated text. To perform both types of
// analysis, add TABLES and FORMS to FeatureTypes.
//
// FeatureTypes is a required field
FeatureTypes []*string `type:"list" required:"true"`
}
// String returns the string representation
func (s AnalyzeDocumentInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s AnalyzeDocumentInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *AnalyzeDocumentInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "AnalyzeDocumentInput"}
if s.Document == nil {
invalidParams.Add(request.NewErrParamRequired("Document"))
}
if s.FeatureTypes == nil {
invalidParams.Add(request.NewErrParamRequired("FeatureTypes"))
}
if s.Document != nil {
if err := s.Document.Validate(); err != nil {
invalidParams.AddNested("Document", err.(request.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetDocument sets the Document field's value.
func (s *AnalyzeDocumentInput) SetDocument(v *Document) *AnalyzeDocumentInput {
s.Document = v
return s
}
// SetFeatureTypes sets the FeatureTypes field's value.
func (s *AnalyzeDocumentInput) SetFeatureTypes(v []*string) *AnalyzeDocumentInput {
s.FeatureTypes = v
return s
}
type AnalyzeDocumentOutput struct {
_ struct{} `type:"structure"`
// The text that's detected and analyzed by AnalyzeDocument.
Blocks []*Block `type:"list"`
// Metadata about the analyzed document. An example is the number of pages.
DocumentMetadata *DocumentMetadata `type:"structure"`
}
// String returns the string representation
func (s AnalyzeDocumentOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s AnalyzeDocumentOutput) GoString() string {
return s.String()
}
// SetBlocks sets the Blocks field's value.
func (s *AnalyzeDocumentOutput) SetBlocks(v []*Block) *AnalyzeDocumentOutput {
s.Blocks = v
return s
}
// SetDocumentMetadata sets the DocumentMetadata field's value.
func (s *AnalyzeDocumentOutput) SetDocumentMetadata(v *DocumentMetadata) *AnalyzeDocumentOutput {
s.DocumentMetadata = v
return s
}
// A Block represents items that are recognized in a document within a group
// of pixels close to each other. The information returned in a Block depends
// on the type of operation. In document-text detection (for example DetectDocumentText),
// you get information about the detected words and lines of text. In text analysis
// (for example AnalyzeDocument), you can also get information about the fields,
// tables and selection elements that are detected in the document.
//
// An array of Block objects is returned by both synchronous and asynchronous
// operations. In synchronous operations, such as DetectDocumentText, the array
// of Block objects is the entire set of results. In asynchronous operations,
// such as GetDocumentAnalysis, the array is returned over one or more responses.
//
// For more information, see How Amazon Textract Works (https://docs.aws.amazon.com/textract/latest/dg/how-it-works.html).
type Block struct {
_ struct{} `type:"structure"`
// The type of text that's recognized in a block. In text-detection operations,
// the following types are returned:
//
// * PAGE - Contains a list of the LINE Block objects that are detected on
// a document page.
//
// * WORD - A word detected on a document page. A word is one or more ISO
// basic Latin script characters that aren't separated by spaces.
//
// * LINE - A string of tab-delimited, contiguous words that's detected on
// a document page.
//
// In text analysis operations, the following types are returned:
//
// * PAGE - Contains a list of child Block objects that are detected on a
// document page.
//
// * KEY_VALUE_SET - Stores the KEY and VALUE Block objects for a field that's
// detected on a document page. Use the EntityType field to determine if
// a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.
//
// * WORD - A word detected on a document page. A word is one or more ISO
// basic Latin script characters that aren't separated by spaces that's detected
// on a document page.
//
// * LINE - A string of tab-delimited, contiguous words that's detected on
// a document page.
//
// * TABLE - A table that's detected on a document page. A table is any grid-based
// information with 2 or more rows or columns with a cell span of 1 row and
// 1 column each.
//
// * CELL - A cell within a detected table. The cell is the parent of the
// block that contains the text in the cell.
//
// * SELECTION_ELEMENT - A selectable element such as a radio button or checkbox
// that's detected on a document page. Use the value of SelectionStatus to
// determine the status of the selection element.
BlockType *string `type:"string" enum:"BlockType"`
// The column in which a table cell appears. The first column position is 1.
// ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.
ColumnIndex *int64 `type:"integer"`
// The number of columns that a table cell spans. ColumnSpan isn't returned
// by DetectDocumentText and GetDocumentTextDetection.
ColumnSpan *int64 `type:"integer"`
// The confidence that Amazon Textract has in the accuracy of the recognized
// text and the accuracy of the geometry points around the recognized text.
Confidence *float64 `type:"float"`
// The type of entity. The following can be returned:
//
// * KEY - An identifier for a field on the document.
//
// * VALUE - The field text.
//
// EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.
EntityTypes []*string `type:"list"`
// The location of the recognized text on the image. It includes an axis-aligned,
// coarse bounding box that surrounds the text, and a finer-grain polygon for
// more accurate spatial information.
Geometry *Geometry `type:"structure"`
// The identifier for the recognized text. The identifier is only unique for
// a single operation.
Id *string `type:"string"`
// The page in which a block was detected. Page is returned by asynchronous