-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
api.go
11213 lines (9808 loc) · 394 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 (
"fmt"
"time"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/awsutil"
"github.com/aws/aws-sdk-go/aws/request"
"github.com/aws/aws-sdk-go/private/protocol"
"github.com/aws/aws-sdk-go/private/protocol/jsonrpc"
)
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:
//
// - Form data (key-value pairs). 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.
//
// - Lines and words of text. A LINE Block object contains one or more WORD
// Block objects. All lines and words that are detected in the document are
// returned (including text that doesn't have a relationship with the value
// of FeatureTypes).
//
// - Signatures. A SIGNATURE Block object contains the location information
// of a signature in a document. If used in conjunction with forms or tables,
// a signature can be given a Key-Value pairing or be detected in the cell
// of a table.
//
// - Query. A QUERY Block object contains the query text, alias and link
// to the associated Query results block object.
//
// - Query Result. A QUERY_RESULT Block object contains the answer to the
// query and an ID that connects it to the query asked. This Block also contains
// a confidence score.
//
// Selection elements such as check boxes and option buttons (radio buttons)
// can be detected in form data and in tables. A SELECTION_ELEMENT Block object
// contains information about a selection element, including the selection status.
//
// 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 Types:
//
// - 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.
//
// - InvalidS3ObjectException
// Amazon Textract is unable to access the S3 object that's specified in the
// request. for more information, Configure Access to Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)
// For troubleshooting information, see Troubleshooting Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
//
// - UnsupportedDocumentException
// The format of the input document isn't supported. Documents for operations
// can be in PNG, JPEG, PDF, or TIFF format.
//
// - DocumentTooLargeException
// The document can't be processed because it's too large. The maximum document
// size for synchronous operations 10 MB. The maximum document size for asynchronous
// operations is 500 MB for PDF files.
//
// - BadDocumentException
// Amazon Textract isn't able to read the document. For more information on
// the document limits in Amazon Textract, see limits.
//
// - AccessDeniedException
// You aren't authorized to perform the action. Use the Amazon Resource Name
// (ARN) of an authorized user or IAM role to perform the operation.
//
// - ProvisionedThroughputExceededException
// The number of requests exceeded your throughput limit. If you want to increase
// this limit, contact Amazon Textract.
//
// - InternalServerError
// Amazon Textract experienced a service issue. Try your call again.
//
// - ThrottlingException
// Amazon Textract is temporarily unable to process the request. Try your call
// again.
//
// - HumanLoopQuotaExceededException
// Indicates you have exceeded the maximum number of active human in the loop
// workflows available
//
// 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 opAnalyzeExpense = "AnalyzeExpense"
// AnalyzeExpenseRequest generates a "aws/request.Request" representing the
// client's request for the AnalyzeExpense 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 AnalyzeExpense for more information on using the AnalyzeExpense
// 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 AnalyzeExpenseRequest method.
// req, resp := client.AnalyzeExpenseRequest(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/AnalyzeExpense
func (c *Textract) AnalyzeExpenseRequest(input *AnalyzeExpenseInput) (req *request.Request, output *AnalyzeExpenseOutput) {
op := &request.Operation{
Name: opAnalyzeExpense,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &AnalyzeExpenseInput{}
}
output = &AnalyzeExpenseOutput{}
req = c.newRequest(op, input, output)
return
}
// AnalyzeExpense API operation for Amazon Textract.
//
// AnalyzeExpense synchronously analyzes an input document for financially related
// relationships between text.
//
// Information is returned as ExpenseDocuments and seperated as follows:
//
// - LineItemGroups- A data set containing LineItems which store information
// about the lines of text, such as an item purchased and its price on a
// receipt.
//
// - SummaryFields- Contains all other information a receipt, such as header
// information or the vendors name.
//
// 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 AnalyzeExpense for usage and error information.
//
// Returned Error Types:
//
// - 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.
//
// - InvalidS3ObjectException
// Amazon Textract is unable to access the S3 object that's specified in the
// request. for more information, Configure Access to Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)
// For troubleshooting information, see Troubleshooting Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
//
// - UnsupportedDocumentException
// The format of the input document isn't supported. Documents for operations
// can be in PNG, JPEG, PDF, or TIFF format.
//
// - DocumentTooLargeException
// The document can't be processed because it's too large. The maximum document
// size for synchronous operations 10 MB. The maximum document size for asynchronous
// operations is 500 MB for PDF files.
//
// - BadDocumentException
// Amazon Textract isn't able to read the document. For more information on
// the document limits in Amazon Textract, see limits.
//
// - AccessDeniedException
// You aren't authorized to perform the action. Use the Amazon Resource Name
// (ARN) of an authorized user or IAM role to perform the operation.
//
// - ProvisionedThroughputExceededException
// The number of requests exceeded your throughput limit. If you want to increase
// this limit, contact Amazon Textract.
//
// - InternalServerError
// Amazon Textract experienced a service issue. Try your call again.
//
// - 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/AnalyzeExpense
func (c *Textract) AnalyzeExpense(input *AnalyzeExpenseInput) (*AnalyzeExpenseOutput, error) {
req, out := c.AnalyzeExpenseRequest(input)
return out, req.Send()
}
// AnalyzeExpenseWithContext is the same as AnalyzeExpense with the addition of
// the ability to pass a context and additional request options.
//
// See AnalyzeExpense 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) AnalyzeExpenseWithContext(ctx aws.Context, input *AnalyzeExpenseInput, opts ...request.Option) (*AnalyzeExpenseOutput, error) {
req, out := c.AnalyzeExpenseRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opAnalyzeID = "AnalyzeID"
// AnalyzeIDRequest generates a "aws/request.Request" representing the
// client's request for the AnalyzeID 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 AnalyzeID for more information on using the AnalyzeID
// 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 AnalyzeIDRequest method.
// req, resp := client.AnalyzeIDRequest(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/AnalyzeID
func (c *Textract) AnalyzeIDRequest(input *AnalyzeIDInput) (req *request.Request, output *AnalyzeIDOutput) {
op := &request.Operation{
Name: opAnalyzeID,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &AnalyzeIDInput{}
}
output = &AnalyzeIDOutput{}
req = c.newRequest(op, input, output)
return
}
// AnalyzeID API operation for Amazon Textract.
//
// Analyzes identity documents for relevant information. This information is
// extracted and returned as IdentityDocumentFields, which records both the
// normalized field and value of the extracted text. Unlike other Amazon Textract
// operations, AnalyzeID doesn't return any Geometry data.
//
// 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 AnalyzeID for usage and error information.
//
// Returned Error Types:
//
// - 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.
//
// - InvalidS3ObjectException
// Amazon Textract is unable to access the S3 object that's specified in the
// request. for more information, Configure Access to Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)
// For troubleshooting information, see Troubleshooting Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
//
// - UnsupportedDocumentException
// The format of the input document isn't supported. Documents for operations
// can be in PNG, JPEG, PDF, or TIFF format.
//
// - DocumentTooLargeException
// The document can't be processed because it's too large. The maximum document
// size for synchronous operations 10 MB. The maximum document size for asynchronous
// operations is 500 MB for PDF files.
//
// - BadDocumentException
// Amazon Textract isn't able to read the document. For more information on
// the document limits in Amazon Textract, see limits.
//
// - AccessDeniedException
// You aren't authorized to perform the action. Use the Amazon Resource Name
// (ARN) of an authorized user or IAM role to perform the operation.
//
// - ProvisionedThroughputExceededException
// The number of requests exceeded your throughput limit. If you want to increase
// this limit, contact Amazon Textract.
//
// - InternalServerError
// Amazon Textract experienced a service issue. Try your call again.
//
// - 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/AnalyzeID
func (c *Textract) AnalyzeID(input *AnalyzeIDInput) (*AnalyzeIDOutput, error) {
req, out := c.AnalyzeIDRequest(input)
return out, req.Send()
}
// AnalyzeIDWithContext is the same as AnalyzeID with the addition of
// the ability to pass a context and additional request options.
//
// See AnalyzeID 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) AnalyzeIDWithContext(ctx aws.Context, input *AnalyzeIDInput, opts ...request.Option) (*AnalyzeIDOutput, error) {
req, out := c.AnalyzeIDRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opCreateAdapter = "CreateAdapter"
// CreateAdapterRequest generates a "aws/request.Request" representing the
// client's request for the CreateAdapter 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 CreateAdapter for more information on using the CreateAdapter
// 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 CreateAdapterRequest method.
// req, resp := client.CreateAdapterRequest(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/CreateAdapter
func (c *Textract) CreateAdapterRequest(input *CreateAdapterInput) (req *request.Request, output *CreateAdapterOutput) {
op := &request.Operation{
Name: opCreateAdapter,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &CreateAdapterInput{}
}
output = &CreateAdapterOutput{}
req = c.newRequest(op, input, output)
return
}
// CreateAdapter API operation for Amazon Textract.
//
// Creates an adapter, which can be fine-tuned for enhanced performance on user
// provided documents. Takes an AdapterName and FeatureType. Currently the only
// supported feature type is QUERIES. You can also provide a Description, Tags,
// and a ClientRequestToken. You can choose whether or not the adapter should
// be AutoUpdated with the AutoUpdate argument. By default, AutoUpdate is set
// to DISABLED.
//
// 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 CreateAdapter for usage and error information.
//
// Returned Error Types:
//
// - 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.
//
// - AccessDeniedException
// You aren't authorized to perform the action. Use the Amazon Resource Name
// (ARN) of an authorized user or IAM role to perform the operation.
//
// - ConflictException
// Updating or deleting a resource can cause an inconsistent state.
//
// - ProvisionedThroughputExceededException
// The number of requests exceeded your throughput limit. If you want to increase
// this limit, contact Amazon Textract.
//
// - InternalServerError
// Amazon Textract experienced a service issue. Try your call again.
//
// - 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.
//
// - ThrottlingException
// Amazon Textract is temporarily unable to process the request. Try your call
// again.
//
// - 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.
//
// - ValidationException
// Indicates that a request was not valid. Check request for proper formatting.
//
// - ServiceQuotaExceededException
// Returned when a request cannot be completed as it would exceed a maximum
// service quota.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/CreateAdapter
func (c *Textract) CreateAdapter(input *CreateAdapterInput) (*CreateAdapterOutput, error) {
req, out := c.CreateAdapterRequest(input)
return out, req.Send()
}
// CreateAdapterWithContext is the same as CreateAdapter with the addition of
// the ability to pass a context and additional request options.
//
// See CreateAdapter 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) CreateAdapterWithContext(ctx aws.Context, input *CreateAdapterInput, opts ...request.Option) (*CreateAdapterOutput, error) {
req, out := c.CreateAdapterRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opCreateAdapterVersion = "CreateAdapterVersion"
// CreateAdapterVersionRequest generates a "aws/request.Request" representing the
// client's request for the CreateAdapterVersion 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 CreateAdapterVersion for more information on using the CreateAdapterVersion
// 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 CreateAdapterVersionRequest method.
// req, resp := client.CreateAdapterVersionRequest(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/CreateAdapterVersion
func (c *Textract) CreateAdapterVersionRequest(input *CreateAdapterVersionInput) (req *request.Request, output *CreateAdapterVersionOutput) {
op := &request.Operation{
Name: opCreateAdapterVersion,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &CreateAdapterVersionInput{}
}
output = &CreateAdapterVersionOutput{}
req = c.newRequest(op, input, output)
return
}
// CreateAdapterVersion API operation for Amazon Textract.
//
// Creates a new version of an adapter. Operates on a provided AdapterId and
// a specified dataset provided via the DatasetConfig argument. Requires that
// you specify an Amazon S3 bucket with the OutputConfig argument. You can provide
// an optional KMSKeyId, an optional ClientRequestToken, and optional tags.
//
// 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 CreateAdapterVersion for usage and error information.
//
// Returned Error Types:
//
// - 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.
//
// - InvalidS3ObjectException
// Amazon Textract is unable to access the S3 object that's specified in the
// request. for more information, Configure Access to Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)
// For troubleshooting information, see Troubleshooting Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
//
// - InvalidKMSKeyException
// Indicates you do not have decrypt permissions with the KMS key entered, or
// the KMS key was entered incorrectly.
//
// - AccessDeniedException
// You aren't authorized to perform the action. Use the Amazon Resource Name
// (ARN) of an authorized user or IAM role to perform the operation.
//
// - ProvisionedThroughputExceededException
// The number of requests exceeded your throughput limit. If you want to increase
// this limit, contact Amazon Textract.
//
// - InternalServerError
// Amazon Textract experienced a service issue. Try your call again.
//
// - 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.
//
// - ThrottlingException
// Amazon Textract is temporarily unable to process the request. Try your call
// again.
//
// - 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.
//
// - ValidationException
// Indicates that a request was not valid. Check request for proper formatting.
//
// - ServiceQuotaExceededException
// Returned when a request cannot be completed as it would exceed a maximum
// service quota.
//
// - ResourceNotFoundException
// Returned when an operation tried to access a nonexistent resource.
//
// - ConflictException
// Updating or deleting a resource can cause an inconsistent state.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/CreateAdapterVersion
func (c *Textract) CreateAdapterVersion(input *CreateAdapterVersionInput) (*CreateAdapterVersionOutput, error) {
req, out := c.CreateAdapterVersionRequest(input)
return out, req.Send()
}
// CreateAdapterVersionWithContext is the same as CreateAdapterVersion with the addition of
// the ability to pass a context and additional request options.
//
// See CreateAdapterVersion 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) CreateAdapterVersionWithContext(ctx aws.Context, input *CreateAdapterVersionInput, opts ...request.Option) (*CreateAdapterVersionOutput, error) {
req, out := c.CreateAdapterVersionRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDeleteAdapter = "DeleteAdapter"
// DeleteAdapterRequest generates a "aws/request.Request" representing the
// client's request for the DeleteAdapter 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 DeleteAdapter for more information on using the DeleteAdapter
// 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 DeleteAdapterRequest method.
// req, resp := client.DeleteAdapterRequest(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/DeleteAdapter
func (c *Textract) DeleteAdapterRequest(input *DeleteAdapterInput) (req *request.Request, output *DeleteAdapterOutput) {
op := &request.Operation{
Name: opDeleteAdapter,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DeleteAdapterInput{}
}
output = &DeleteAdapterOutput{}
req = c.newRequest(op, input, output)
req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
return
}
// DeleteAdapter API operation for Amazon Textract.
//
// Deletes an Amazon Textract adapter. Takes an AdapterId and deletes the adapter
// specified by the ID.
//
// 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 DeleteAdapter for usage and error information.
//
// Returned Error Types:
//
// - 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.
//
// - AccessDeniedException
// You aren't authorized to perform the action. Use the Amazon Resource Name
// (ARN) of an authorized user or IAM role to perform the operation.
//
// - ConflictException
// Updating or deleting a resource can cause an inconsistent state.
//
// - ProvisionedThroughputExceededException
// The number of requests exceeded your throughput limit. If you want to increase
// this limit, contact Amazon Textract.
//
// - InternalServerError
// Amazon Textract experienced a service issue. Try your call again.
//
// - ThrottlingException
// Amazon Textract is temporarily unable to process the request. Try your call
// again.
//
// - ValidationException
// Indicates that a request was not valid. Check request for proper formatting.
//
// - ResourceNotFoundException
// Returned when an operation tried to access a nonexistent resource.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/DeleteAdapter
func (c *Textract) DeleteAdapter(input *DeleteAdapterInput) (*DeleteAdapterOutput, error) {
req, out := c.DeleteAdapterRequest(input)
return out, req.Send()
}
// DeleteAdapterWithContext is the same as DeleteAdapter with the addition of
// the ability to pass a context and additional request options.
//
// See DeleteAdapter 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) DeleteAdapterWithContext(ctx aws.Context, input *DeleteAdapterInput, opts ...request.Option) (*DeleteAdapterOutput, error) {
req, out := c.DeleteAdapterRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDeleteAdapterVersion = "DeleteAdapterVersion"
// DeleteAdapterVersionRequest generates a "aws/request.Request" representing the
// client's request for the DeleteAdapterVersion 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 DeleteAdapterVersion for more information on using the DeleteAdapterVersion
// 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 DeleteAdapterVersionRequest method.
// req, resp := client.DeleteAdapterVersionRequest(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/DeleteAdapterVersion
func (c *Textract) DeleteAdapterVersionRequest(input *DeleteAdapterVersionInput) (req *request.Request, output *DeleteAdapterVersionOutput) {
op := &request.Operation{
Name: opDeleteAdapterVersion,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DeleteAdapterVersionInput{}
}
output = &DeleteAdapterVersionOutput{}
req = c.newRequest(op, input, output)
req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
return
}
// DeleteAdapterVersion API operation for Amazon Textract.
//
// Deletes an Amazon Textract adapter version. Requires that you specify both
// an AdapterId and a AdapterVersion. Deletes the adapter version specified
// by the AdapterId and the AdapterVersion.
//
// 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 DeleteAdapterVersion for usage and error information.
//
// Returned Error Types:
//
// - 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.
//
// - AccessDeniedException
// You aren't authorized to perform the action. Use the Amazon Resource Name
// (ARN) of an authorized user or IAM role to perform the operation.
//
// - ConflictException
// Updating or deleting a resource can cause an inconsistent state.
//
// - ProvisionedThroughputExceededException
// The number of requests exceeded your throughput limit. If you want to increase
// this limit, contact Amazon Textract.
//
// - InternalServerError
// Amazon Textract experienced a service issue. Try your call again.
//
// - ThrottlingException
// Amazon Textract is temporarily unable to process the request. Try your call
// again.
//
// - ValidationException
// Indicates that a request was not valid. Check request for proper formatting.
//
// - ResourceNotFoundException
// Returned when an operation tried to access a nonexistent resource.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/DeleteAdapterVersion
func (c *Textract) DeleteAdapterVersion(input *DeleteAdapterVersionInput) (*DeleteAdapterVersionOutput, error) {
req, out := c.DeleteAdapterVersionRequest(input)
return out, req.Send()
}
// DeleteAdapterVersionWithContext is the same as DeleteAdapterVersion with the addition of
// the ability to pass a context and additional request options.
//
// See DeleteAdapterVersion 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) DeleteAdapterVersionWithContext(ctx aws.Context, input *DeleteAdapterVersionInput, opts ...request.Option) (*DeleteAdapterVersionOutput, error) {
req, out := c.DeleteAdapterVersionRequest(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 in
// one of the following image formats: JPEG, PNG, PDF, or TIFF. 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 Types:
//
// - 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.
//
// - InvalidS3ObjectException
// Amazon Textract is unable to access the S3 object that's specified in the
// request. for more information, Configure Access to Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)
// For troubleshooting information, see Troubleshooting Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
//
// - UnsupportedDocumentException
// The format of the input document isn't supported. Documents for operations
// can be in PNG, JPEG, PDF, or TIFF format.
//
// - DocumentTooLargeException
// The document can't be processed because it's too large. The maximum document
// size for synchronous operations 10 MB. The maximum document size for asynchronous
// operations is 500 MB for PDF files.
//
// - BadDocumentException
// Amazon Textract isn't able to read the document. For more information on
// the document limits in Amazon Textract, see limits.
//
// - AccessDeniedException
// You aren't authorized to perform the action. Use the Amazon Resource Name
// (ARN) of an authorized user or IAM role to perform the operation.
//
// - ProvisionedThroughputExceededException
// The number of requests exceeded your throughput limit. If you want to increase
// this limit, contact Amazon Textract.
//
// - InternalServerError
// Amazon Textract experienced a service issue. Try your call again.
//
// - ThrottlingException
// Amazon Textract is temporarily unable to process the request. Try your call
// again.
//